Drivers/STM32F1xx_HAL_Driver/Inc/stm32f1xx_hal_gpio.h (11876B)
1 /** 2 ****************************************************************************** 3 * @file stm32f1xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2016 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 STM32F1xx_HAL_GPIO_H 21 #define STM32F1xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32f1xx_hal_def.h" 29 30 /** @addtogroup STM32F1xx_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 } GPIO_InitTypeDef; 60 61 /** 62 * @brief GPIO Bit SET and Bit RESET enumeration 63 */ 64 typedef enum 65 { 66 GPIO_PIN_RESET = 0u, 67 GPIO_PIN_SET 68 } GPIO_PinState; 69 /** 70 * @} 71 */ 72 73 /* Exported constants --------------------------------------------------------*/ 74 75 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants 76 * @{ 77 */ 78 79 /** @defgroup GPIO_pins_define GPIO pins define 80 * @{ 81 */ 82 #define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */ 83 #define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */ 84 #define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */ 85 #define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */ 86 #define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */ 87 #define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */ 88 #define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */ 89 #define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */ 90 #define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */ 91 #define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */ 92 #define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */ 93 #define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */ 94 #define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */ 95 #define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */ 96 #define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */ 97 #define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */ 98 #define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */ 99 100 #define GPIO_PIN_MASK 0x0000FFFFu /* PIN mask for assert test */ 101 /** 102 * @} 103 */ 104 105 /** @defgroup GPIO_mode_define GPIO mode define 106 * @brief GPIO Configuration Mode 107 * Elements values convention: 0xX0yz00YZ 108 * - X : GPIO mode or EXTI Mode 109 * - y : External IT or Event trigger detection 110 * - z : IO configuration on External IT or Event 111 * - Y : Output type (Push Pull or Open Drain) 112 * - Z : IO Direction mode (Input, Output, Alternate or Analog) 113 * @{ 114 */ 115 #define GPIO_MODE_INPUT 0x00000000u /*!< Input Floating Mode */ 116 #define GPIO_MODE_OUTPUT_PP 0x00000001u /*!< Output Push Pull Mode */ 117 #define GPIO_MODE_OUTPUT_OD 0x00000011u /*!< Output Open Drain Mode */ 118 #define GPIO_MODE_AF_PP 0x00000002u /*!< Alternate Function Push Pull Mode */ 119 #define GPIO_MODE_AF_OD 0x00000012u /*!< Alternate Function Open Drain Mode */ 120 #define GPIO_MODE_AF_INPUT GPIO_MODE_INPUT /*!< Alternate Function Input Mode */ 121 122 #define GPIO_MODE_ANALOG 0x00000003u /*!< Analog Mode */ 123 124 #define GPIO_MODE_IT_RISING 0x10110000u /*!< External Interrupt Mode with Rising edge trigger detection */ 125 #define GPIO_MODE_IT_FALLING 0x10210000u /*!< External Interrupt Mode with Falling edge trigger detection */ 126 #define GPIO_MODE_IT_RISING_FALLING 0x10310000u /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 127 128 #define GPIO_MODE_EVT_RISING 0x10120000u /*!< External Event Mode with Rising edge trigger detection */ 129 #define GPIO_MODE_EVT_FALLING 0x10220000u /*!< External Event Mode with Falling edge trigger detection */ 130 #define GPIO_MODE_EVT_RISING_FALLING 0x10320000u /*!< External Event Mode with Rising/Falling edge trigger detection */ 131 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 (GPIO_CRL_MODE0_1) /*!< Low speed */ 141 #define GPIO_SPEED_FREQ_MEDIUM (GPIO_CRL_MODE0_0) /*!< Medium speed */ 142 #define GPIO_SPEED_FREQ_HIGH (GPIO_CRL_MODE0) /*!< High speed */ 143 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 "stm32f1xx_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 254 /** 255 * @} 256 */ 257 258 /* Private macros ------------------------------------------------------------*/ 259 /** @defgroup GPIO_Private_Macros GPIO Private Macros 260 * @{ 261 */ 262 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 263 #define IS_GPIO_PIN(PIN) (((((uint32_t)PIN) & GPIO_PIN_MASK ) != 0x00u) && ((((uint32_t)PIN) & ~GPIO_PIN_MASK) == 0x00u)) 264 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\ 265 ((MODE) == GPIO_MODE_OUTPUT_PP) ||\ 266 ((MODE) == GPIO_MODE_OUTPUT_OD) ||\ 267 ((MODE) == GPIO_MODE_AF_PP) ||\ 268 ((MODE) == GPIO_MODE_AF_OD) ||\ 269 ((MODE) == GPIO_MODE_IT_RISING) ||\ 270 ((MODE) == GPIO_MODE_IT_FALLING) ||\ 271 ((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\ 272 ((MODE) == GPIO_MODE_EVT_RISING) ||\ 273 ((MODE) == GPIO_MODE_EVT_FALLING) ||\ 274 ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\ 275 ((MODE) == GPIO_MODE_ANALOG)) 276 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_FREQ_LOW) || \ 277 ((SPEED) == GPIO_SPEED_FREQ_MEDIUM) || ((SPEED) == GPIO_SPEED_FREQ_HIGH)) 278 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \ 279 ((PULL) == GPIO_PULLDOWN)) 280 /** 281 * @} 282 */ 283 284 /* Private functions ---------------------------------------------------------*/ 285 /** @defgroup GPIO_Private_Functions GPIO Private Functions 286 * @{ 287 */ 288 289 /** 290 * @} 291 */ 292 293 /** 294 * @} 295 */ 296 297 /** 298 * @} 299 */ 300 301 #ifdef __cplusplus 302 } 303 #endif 304 305 #endif /* STM32F1xx_HAL_GPIO_H */ 306