1 /** 2 ****************************************************************************** 3 * @file stm32f4xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2017 STMicroelectronics. 10 * All rights reserved. 11 * 12 * This software is licensed under terms that can be found in the LICENSE file 13 * in the root directory of this software component. 14 * If no LICENSE file comes with this software, it is provided AS-IS. 15 * 16 ****************************************************************************** 17 */ 18 19 /* Define to prevent recursive inclusion -------------------------------------*/ 20 #ifndef __STM32F4xx_HAL_GPIO_H 21 #define __STM32F4xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32f4xx_hal_def.h" 29 30 /** @addtogroup STM32F4xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @addtogroup GPIO 35 * @{ 36 */ 37 38 /* Exported types ------------------------------------------------------------*/ 39 /** @defgroup GPIO_Exported_Types GPIO Exported Types 40 * @{ 41 */ 42 43 /** 44 * @brief GPIO Init structure definition 45 */ 46 typedef struct 47 { 48 uint32_t Pin; /*!< Specifies the GPIO pins to be configured. 49 This parameter can be any value of @ref GPIO_pins_define */ 50 51 uint32_t Mode; /*!< Specifies the operating mode for the selected pins. 52 This parameter can be a value of @ref GPIO_mode_define */ 53 54 uint32_t Pull; /*!< Specifies the Pull-up or Pull-Down activation for the selected pins. 55 This parameter can be a value of @ref GPIO_pull_define */ 56 57 uint32_t Speed; /*!< Specifies the speed for the selected pins. 58 This parameter can be a value of @ref GPIO_speed_define */ 59 60 uint32_t Alternate; /*!< Peripheral to be connected to the selected pins. 61 This parameter can be a value of @ref GPIO_Alternate_function_selection */ 62 }GPIO_InitTypeDef; 63 64 /** 65 * @brief GPIO Bit SET and Bit RESET enumeration 66 */ 67 typedef enum 68 { 69 GPIO_PIN_RESET = 0, 70 GPIO_PIN_SET 71 }GPIO_PinState; 72 /** 73 * @} 74 */ 75 76 /* Exported constants --------------------------------------------------------*/ 77 78 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants 79 * @{ 80 */ 81 82 /** @defgroup GPIO_pins_define GPIO pins define 83 * @{ 84 */ 85 #define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */ 86 #define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */ 87 #define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */ 88 #define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */ 89 #define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */ 90 #define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */ 91 #define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */ 92 #define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */ 93 #define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */ 94 #define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */ 95 #define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */ 96 #define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */ 97 #define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */ 98 #define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */ 99 #define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */ 100 #define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */ 101 #define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */ 102 103 #define GPIO_PIN_MASK 0x0000FFFFU /* PIN mask for assert test */ 104 /** 105 * @} 106 */ 107 108 /** @defgroup GPIO_mode_define GPIO mode define 109 * @brief GPIO Configuration Mode 110 * Elements values convention: 0x00WX00YZ 111 * - W : EXTI trigger detection on 3 bits 112 * - X : EXTI mode (IT or Event) on 2 bits 113 * - Y : Output type (Push Pull or Open Drain) on 1 bit 114 * - Z : GPIO mode (Input, Output, Alternate or Analog) on 2 bits 115 * @{ 116 */ 117 #define GPIO_MODE_INPUT MODE_INPUT /*!< Input Floating Mode */ 118 #define GPIO_MODE_OUTPUT_PP (MODE_OUTPUT | OUTPUT_PP) /*!< Output Push Pull Mode */ 119 #define GPIO_MODE_OUTPUT_OD (MODE_OUTPUT | OUTPUT_OD) /*!< Output Open Drain Mode */ 120 #define GPIO_MODE_AF_PP (MODE_AF | OUTPUT_PP) /*!< Alternate Function Push Pull Mode */ 121 #define GPIO_MODE_AF_OD (MODE_AF | OUTPUT_OD) /*!< Alternate Function Open Drain Mode */ 122 123 #define GPIO_MODE_ANALOG MODE_ANALOG /*!< Analog Mode */ 124 125 #define GPIO_MODE_IT_RISING (MODE_INPUT | EXTI_IT | TRIGGER_RISING) /*!< External Interrupt Mode with Rising edge trigger detection */ 126 #define GPIO_MODE_IT_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_FALLING) /*!< External Interrupt Mode with Falling edge trigger detection */ 127 #define GPIO_MODE_IT_RISING_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 128 129 #define GPIO_MODE_EVT_RISING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING) /*!< External Event Mode with Rising edge trigger detection */ 130 #define GPIO_MODE_EVT_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING) /*!< External Event Mode with Falling edge trigger detection */ 131 #define GPIO_MODE_EVT_RISING_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Event Mode with Rising/Falling edge trigger detection */ 132 133 /** 134 * @} 135 */ 136 137 /** @defgroup GPIO_speed_define GPIO speed define 138 * @brief GPIO Output Maximum frequency 139 * @{ 140 */ 141 #define GPIO_SPEED_FREQ_LOW 0x00000000U /*!< IO works at 2 MHz, please refer to the product datasheet */ 142 #define GPIO_SPEED_FREQ_MEDIUM 0x00000001U /*!< range 12,5 MHz to 50 MHz, please refer to the product datasheet */ 143 #define GPIO_SPEED_FREQ_HIGH 0x00000002U /*!< range 25 MHz to 100 MHz, please refer to the product datasheet */ 144 #define GPIO_SPEED_FREQ_VERY_HIGH 0x00000003U /*!< range 50 MHz to 200 MHz, please refer to the product datasheet */ 145 /** 146 * @} 147 */ 148 149 /** @defgroup GPIO_pull_define GPIO pull define 150 * @brief GPIO Pull-Up or Pull-Down Activation 151 * @{ 152 */ 153 #define GPIO_NOPULL 0x00000000U /*!< No Pull-up or Pull-down activation */ 154 #define GPIO_PULLUP 0x00000001U /*!< Pull-up activation */ 155 #define GPIO_PULLDOWN 0x00000002U /*!< Pull-down activation */ 156 /** 157 * @} 158 */ 159 160 /** 161 * @} 162 */ 163 164 /* Exported macro ------------------------------------------------------------*/ 165 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 166 * @{ 167 */ 168 169 /** 170 * @brief Checks whether the specified EXTI line flag is set or not. 171 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 172 * This parameter can be GPIO_PIN_x where x can be(0..15) 173 * @retval The new state of __EXTI_LINE__ (SET or RESET). 174 */ 175 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 176 177 /** 178 * @brief Clears the EXTI's line pending flags. 179 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 180 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 181 * @retval None 182 */ 183 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 184 185 /** 186 * @brief Checks whether the specified EXTI line is asserted or not. 187 * @param __EXTI_LINE__ specifies the EXTI line to check. 188 * This parameter can be GPIO_PIN_x where x can be(0..15) 189 * @retval The new state of __EXTI_LINE__ (SET or RESET). 190 */ 191 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 192 193 /** 194 * @brief Clears the EXTI's line pending bits. 195 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 196 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 197 * @retval None 198 */ 199 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 200 201 /** 202 * @brief Generates a Software interrupt on selected EXTI line. 203 * @param __EXTI_LINE__ specifies the EXTI line to check. 204 * This parameter can be GPIO_PIN_x where x can be(0..15) 205 * @retval None 206 */ 207 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__)) 208 /** 209 * @} 210 */ 211 212 /* Include GPIO HAL Extension module */ 213 #include "stm32f4xx_hal_gpio_ex.h" 214 215 /* Exported functions --------------------------------------------------------*/ 216 /** @addtogroup GPIO_Exported_Functions 217 * @{ 218 */ 219 220 /** @addtogroup GPIO_Exported_Functions_Group1 221 * @{ 222 */ 223 /* Initialization and de-initialization functions *****************************/ 224 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 225 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 226 /** 227 * @} 228 */ 229 230 /** @addtogroup GPIO_Exported_Functions_Group2 231 * @{ 232 */ 233 /* IO operation functions *****************************************************/ 234 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 235 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 236 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 237 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 238 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 239 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); 240 241 /** 242 * @} 243 */ 244 245 /** 246 * @} 247 */ 248 /* Private types -------------------------------------------------------------*/ 249 /* Private variables ---------------------------------------------------------*/ 250 /* Private constants ---------------------------------------------------------*/ 251 /** @defgroup GPIO_Private_Constants GPIO Private Constants 252 * @{ 253 */ 254 #define GPIO_MODE_Pos 0U 255 #define GPIO_MODE (0x3UL << GPIO_MODE_Pos) 256 #define MODE_INPUT (0x0UL << GPIO_MODE_Pos) 257 #define MODE_OUTPUT (0x1UL << GPIO_MODE_Pos) 258 #define MODE_AF (0x2UL << GPIO_MODE_Pos) 259 #define MODE_ANALOG (0x3UL << GPIO_MODE_Pos) 260 #define OUTPUT_TYPE_Pos 4U 261 #define OUTPUT_TYPE (0x1UL << OUTPUT_TYPE_Pos) 262 #define OUTPUT_PP (0x0UL << OUTPUT_TYPE_Pos) 263 #define OUTPUT_OD (0x1UL << OUTPUT_TYPE_Pos) 264 #define EXTI_MODE_Pos 16U 265 #define EXTI_MODE (0x3UL << EXTI_MODE_Pos) 266 #define EXTI_IT (0x1UL << EXTI_MODE_Pos) 267 #define EXTI_EVT (0x2UL << EXTI_MODE_Pos) 268 #define TRIGGER_MODE_Pos 20U 269 #define TRIGGER_MODE (0x7UL << TRIGGER_MODE_Pos) 270 #define TRIGGER_RISING (0x1UL << TRIGGER_MODE_Pos) 271 #define TRIGGER_FALLING (0x2UL << TRIGGER_MODE_Pos) 272 273 /** 274 * @} 275 */ 276 277 /* Private macros ------------------------------------------------------------*/ 278 /** @defgroup GPIO_Private_Macros GPIO Private Macros 279 * @{ 280 */ 281 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 282 #define IS_GPIO_PIN(PIN) (((((uint32_t)PIN) & GPIO_PIN_MASK ) != 0x00U) && ((((uint32_t)PIN) & ~GPIO_PIN_MASK) == 0x00U)) 283 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\ 284 ((MODE) == GPIO_MODE_OUTPUT_PP) ||\ 285 ((MODE) == GPIO_MODE_OUTPUT_OD) ||\ 286 ((MODE) == GPIO_MODE_AF_PP) ||\ 287 ((MODE) == GPIO_MODE_AF_OD) ||\ 288 ((MODE) == GPIO_MODE_IT_RISING) ||\ 289 ((MODE) == GPIO_MODE_IT_FALLING) ||\ 290 ((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\ 291 ((MODE) == GPIO_MODE_EVT_RISING) ||\ 292 ((MODE) == GPIO_MODE_EVT_FALLING) ||\ 293 ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\ 294 ((MODE) == GPIO_MODE_ANALOG)) 295 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_FREQ_LOW) || ((SPEED) == GPIO_SPEED_FREQ_MEDIUM) || \ 296 ((SPEED) == GPIO_SPEED_FREQ_HIGH) || ((SPEED) == GPIO_SPEED_FREQ_VERY_HIGH)) 297 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \ 298 ((PULL) == GPIO_PULLDOWN)) 299 /** 300 * @} 301 */ 302 303 /* Private functions ---------------------------------------------------------*/ 304 /** @defgroup GPIO_Private_Functions GPIO Private Functions 305 * @{ 306 */ 307 308 /** 309 * @} 310 */ 311 312 /** 313 * @} 314 */ 315 316 /** 317 * @} 318 */ 319 320 #ifdef __cplusplus 321 } 322 #endif 323 324 #endif /* __STM32F4xx_HAL_GPIO_H */ 325 326
