1 /** 2 ****************************************************************************** 3 * @file stm32f2xx_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 __STM32F2xx_HAL_GPIO_H 21 #define __STM32F2xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32f2xx_hal_def.h" 29 30 /** @addtogroup STM32F2xx_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 = 0U, 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 /** @defgroup GPIO_speed_define GPIO speed define 137 * @brief GPIO Output Maximum frequency 138 * @{ 139 */ 140 #define GPIO_SPEED_FREQ_LOW 0x00000000U /*!< IO works at 2 MHz, please refer to the product datasheet */ 141 #define GPIO_SPEED_FREQ_MEDIUM 0x00000001U /*!< range 12,5 MHz to 50 MHz, please refer to the product datasheet */ 142 #define GPIO_SPEED_FREQ_HIGH 0x00000002U /*!< range 25 MHz to 100 MHz, please refer to the product datasheet */ 143 #define GPIO_SPEED_FREQ_VERY_HIGH 0x00000003U /*!< range 50 MHz to 200 MHz, please refer to the product datasheet */ 144 /** 145 * @} 146 */ 147 148 /** @defgroup GPIO_pull_define GPIO pull define 149 * @brief GPIO Pull-Up or Pull-Down Activation 150 * @{ 151 */ 152 #define GPIO_NOPULL 0x00000000U /*!< No Pull-up or Pull-down activation */ 153 #define GPIO_PULLUP 0x00000001U /*!< Pull-up activation */ 154 #define GPIO_PULLDOWN 0x00000002U /*!< Pull-down activation */ 155 /** 156 * @} 157 */ 158 159 /** 160 * @} 161 */ 162 163 /* Exported macro ------------------------------------------------------------*/ 164 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 165 * @{ 166 */ 167 168 /** 169 * @brief Checks whether the specified EXTI line flag is set or not. 170 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 171 * This parameter can be GPIO_PIN_x where x can be(0..15) 172 * @retval The new state of __EXTI_LINE__ (SET or RESET). 173 */ 174 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 175 176 /** 177 * @brief Clears the EXTI's line pending flags. 178 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 179 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 180 * @retval None 181 */ 182 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 183 184 /** 185 * @brief Checks whether the specified EXTI line is asserted or not. 186 * @param __EXTI_LINE__ specifies the EXTI line to check. 187 * This parameter can be GPIO_PIN_x where x can be(0..15) 188 * @retval The new state of __EXTI_LINE__ (SET or RESET). 189 */ 190 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 191 192 /** 193 * @brief Clears the EXTI's line pending bits. 194 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 195 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 196 * @retval None 197 */ 198 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 199 200 /** 201 * @brief Generates a Software interrupt on selected EXTI line. 202 * @param __EXTI_LINE__ specifies the EXTI line to check. 203 * This parameter can be GPIO_PIN_x where x can be(0..15) 204 * @retval None 205 */ 206 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__)) 207 /** 208 * @} 209 */ 210 211 /* Include GPIO HAL Extension module */ 212 #include "stm32f2xx_hal_gpio_ex.h" 213 214 /* Exported functions --------------------------------------------------------*/ 215 /** @addtogroup GPIO_Exported_Functions 216 * @{ 217 */ 218 219 /** @addtogroup GPIO_Exported_Functions_Group1 220 * @{ 221 */ 222 /* Initialization and de-initialization functions *****************************/ 223 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 224 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 225 /** 226 * @} 227 */ 228 229 /** @addtogroup GPIO_Exported_Functions_Group2 230 * @{ 231 */ 232 /* IO operation functions *****************************************************/ 233 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 234 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 235 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 236 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 237 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 238 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); 239 240 /** 241 * @} 242 */ 243 244 /** 245 * @} 246 */ 247 /* Private types -------------------------------------------------------------*/ 248 /* Private variables ---------------------------------------------------------*/ 249 /* Private constants ---------------------------------------------------------*/ 250 /** @defgroup GPIO_Private_Constants GPIO Private Constants 251 * @{ 252 */ 253 #define GPIO_MODE_Pos 0U 254 #define GPIO_MODE (0x3UL << GPIO_MODE_Pos) 255 #define MODE_INPUT (0x0UL << GPIO_MODE_Pos) 256 #define MODE_OUTPUT (0x1UL << GPIO_MODE_Pos) 257 #define MODE_AF (0x2UL << GPIO_MODE_Pos) 258 #define MODE_ANALOG (0x3UL << GPIO_MODE_Pos) 259 #define OUTPUT_TYPE_Pos 4U 260 #define OUTPUT_TYPE (0x1UL << OUTPUT_TYPE_Pos) 261 #define OUTPUT_PP (0x0UL << OUTPUT_TYPE_Pos) 262 #define OUTPUT_OD (0x1UL << OUTPUT_TYPE_Pos) 263 #define EXTI_MODE_Pos 16U 264 #define EXTI_MODE (0x3UL << EXTI_MODE_Pos) 265 #define EXTI_IT (0x1UL << EXTI_MODE_Pos) 266 #define EXTI_EVT (0x2UL << EXTI_MODE_Pos) 267 #define TRIGGER_MODE_Pos 20U 268 #define TRIGGER_MODE (0x7UL << TRIGGER_MODE_Pos) 269 #define TRIGGER_RISING (0x1UL << TRIGGER_MODE_Pos) 270 #define TRIGGER_FALLING (0x2UL << TRIGGER_MODE_Pos) 271 /** 272 * @} 273 */ 274 275 /* Private macros ------------------------------------------------------------*/ 276 /** @defgroup GPIO_Private_Macros GPIO Private Macros 277 * @{ 278 */ 279 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 280 #define IS_GPIO_PIN(PIN) (((((uint32_t)PIN) & GPIO_PIN_MASK ) != 0x00U) && ((((uint32_t)PIN) & ~GPIO_PIN_MASK) == 0x00U)) 281 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\ 282 ((MODE) == GPIO_MODE_OUTPUT_PP) ||\ 283 ((MODE) == GPIO_MODE_OUTPUT_OD) ||\ 284 ((MODE) == GPIO_MODE_AF_PP) ||\ 285 ((MODE) == GPIO_MODE_AF_OD) ||\ 286 ((MODE) == GPIO_MODE_IT_RISING) ||\ 287 ((MODE) == GPIO_MODE_IT_FALLING) ||\ 288 ((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\ 289 ((MODE) == GPIO_MODE_EVT_RISING) ||\ 290 ((MODE) == GPIO_MODE_EVT_FALLING) ||\ 291 ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\ 292 ((MODE) == GPIO_MODE_ANALOG)) 293 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_FREQ_LOW) || ((SPEED) == GPIO_SPEED_FREQ_MEDIUM) || \ 294 ((SPEED) == GPIO_SPEED_FREQ_HIGH) || ((SPEED) == GPIO_SPEED_FREQ_VERY_HIGH)) 295 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \ 296 ((PULL) == GPIO_PULLDOWN)) 297 /** 298 * @} 299 */ 300 301 /* Private functions ---------------------------------------------------------*/ 302 /** @defgroup GPIO_Private_Functions GPIO Private Functions 303 * @{ 304 */ 305 306 /** 307 * @} 308 */ 309 310 /** 311 * @} 312 */ 313 314 /** 315 * @} 316 */ 317 318 #ifdef __cplusplus 319 } 320 #endif 321 322 #endif /* __STM32F2xx_HAL_GPIO_H */ 323 324
