1 /** 2 ****************************************************************************** 3 * @file stm32l5xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2019 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 STM32L5xx_HAL_GPIO_H 21 #define STM32L5xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32l5xx_hal_def.h" 29 30 /** @addtogroup STM32L5xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @defgroup GPIO GPIO 35 * @brief GPIO HAL module driver 36 * @{ 37 */ 38 39 /* Exported types ------------------------------------------------------------*/ 40 41 /** @defgroup GPIO_Exported_Types GPIO Exported Types 42 * @{ 43 */ 44 /** 45 * @brief GPIO Init structure definition 46 */ 47 typedef struct 48 { 49 uint32_t Pin; /*!< Specifies the GPIO pins to be configured. 50 This parameter can be any value of @ref GPIO_pins */ 51 52 uint32_t Mode; /*!< Specifies the operating mode for the selected pins. 53 This parameter can be a value of @ref GPIO_mode */ 54 55 uint32_t Pull; /*!< Specifies the Pull-up or Pull-Down activation for the selected pins. 56 This parameter can be a value of @ref GPIO_pull */ 57 58 uint32_t Speed; /*!< Specifies the speed for the selected pins. 59 This parameter can be a value of @ref GPIO_speed */ 60 61 uint32_t Alternate; /*!< Peripheral to be connected to the selected pins 62 This parameter can be a value of @ref GPIOEx_Alternate_function_selection */ 63 } GPIO_InitTypeDef; 64 65 /** 66 * @brief GPIO Bit SET and Bit RESET enumeration 67 */ 68 typedef enum 69 { 70 GPIO_PIN_RESET = 0U, 71 GPIO_PIN_SET 72 } GPIO_PinState; 73 /** 74 * @} 75 */ 76 77 /* Exported constants --------------------------------------------------------*/ 78 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants 79 * @{ 80 */ 81 /** @defgroup GPIO_pins GPIO pins 82 * @{ 83 */ 84 #define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */ 85 #define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */ 86 #define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */ 87 #define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */ 88 #define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */ 89 #define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */ 90 #define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */ 91 #define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */ 92 #define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */ 93 #define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */ 94 #define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */ 95 #define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */ 96 #define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */ 97 #define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */ 98 #define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */ 99 #define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */ 100 #define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */ 101 102 #define GPIO_PIN_MASK (0x0000FFFFU) /* PIN mask for assert test */ 103 /** 104 * @} 105 */ 106 107 /** @defgroup GPIO_mode GPIO mode 108 * @brief GPIO Configuration Mode 109 * Elements values convention: 0x00WX00YZ 110 * - W : EXTI trigger detection on 3 bits 111 * - X : EXTI mode (IT or Event) on 2 bits 112 * - Y : Output type (Push Pull or Open Drain) on 1 bit 113 * - Z : GPIO mode (Input, Output, Alternate or Analog) on 2 bits 114 * @{ 115 */ 116 #define GPIO_MODE_INPUT MODE_INPUT /*!< Input Floating Mode */ 117 #define GPIO_MODE_OUTPUT_PP (MODE_OUTPUT | OUTPUT_PP) /*!< Output Push Pull Mode */ 118 #define GPIO_MODE_OUTPUT_OD (MODE_OUTPUT | OUTPUT_OD) /*!< Output Open Drain Mode */ 119 #define GPIO_MODE_AF_PP (MODE_AF | OUTPUT_PP) /*!< Alternate Function Push Pull Mode */ 120 #define GPIO_MODE_AF_OD (MODE_AF | OUTPUT_OD) /*!< Alternate Function Open Drain Mode */ 121 #define GPIO_MODE_ANALOG MODE_ANALOG /*!< Analog Mode */ 122 #define GPIO_MODE_IT_RISING (MODE_INPUT | EXTI_IT | TRIGGER_RISING) /*!< External Interrupt Mode with Rising edge trigger detection */ 123 #define GPIO_MODE_IT_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_FALLING) /*!< External Interrupt Mode with Falling edge trigger detection */ 124 #define GPIO_MODE_IT_RISING_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 125 #define GPIO_MODE_EVT_RISING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING) /*!< External Event Mode with Rising edge trigger detection */ 126 #define GPIO_MODE_EVT_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING) /*!< External Event Mode with Falling edge trigger detection */ 127 #define GPIO_MODE_EVT_RISING_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Event Mode with Rising/Falling edge trigger detection */ 128 129 /** 130 * @} 131 */ 132 133 /** @defgroup GPIO_speed GPIO speed 134 * @brief GPIO Output Maximum frequency 135 * @{ 136 */ 137 #define GPIO_SPEED_FREQ_LOW 0x00000000u /*!< Low speed */ 138 #define GPIO_SPEED_FREQ_MEDIUM 0x00000001u /*!< Medium speed */ 139 #define GPIO_SPEED_FREQ_HIGH 0x00000002u /*!< High speed */ 140 #define GPIO_SPEED_FREQ_VERY_HIGH 0x00000003u /*!< Very high speed */ 141 /** 142 * @} 143 */ 144 145 /** @defgroup GPIO_pull GPIO pull 146 * @brief GPIO Pull-Up or Pull-Down Activation 147 * @{ 148 */ 149 #define GPIO_NOPULL 0x00000000u /*!< No Pull-up or Pull-down activation */ 150 #define GPIO_PULLUP 0x00000001u /*!< Pull-up activation */ 151 #define GPIO_PULLDOWN 0x00000002u /*!< Pull-down activation */ 152 /** 153 * @} 154 */ 155 156 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 157 158 /** @defgroup GPIO_attributes GPIO attributes 159 * @brief GPIO pin secure or non-secure attributes 160 * @{ 161 */ 162 #define GPIO_PIN_SEC (0x00000001U) /*!< Secure pin attribute */ 163 #define GPIO_PIN_NSEC (0x00000000U) /*!< Non-secure pin attribute */ 164 /** 165 * @} 166 */ 167 168 #endif /* __ARM_FEATURE_CMSE */ 169 /** 170 * @} 171 */ 172 173 /* Exported macro ------------------------------------------------------------*/ 174 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 175 * @{ 176 */ 177 178 /** 179 * @brief Check whether the specified EXTI line is rising edge asserted or not. 180 * @param __EXTI_LINE__ specifies the EXTI line to check. 181 * This parameter can be GPIO_PIN_x where x can be(0..15) 182 * @retval The new state of __EXTI_LINE__ (SET or RESET). 183 */ 184 #define __HAL_GPIO_EXTI_GET_RISING_IT(__EXTI_LINE__) (EXTI->RPR1 & (__EXTI_LINE__)) 185 186 /** 187 * @brief Clear the EXTI line rising pending bits. 188 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 189 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 190 * @retval None 191 */ 192 #define __HAL_GPIO_EXTI_CLEAR_RISING_IT(__EXTI_LINE__) (EXTI->RPR1 = (__EXTI_LINE__)) 193 194 /** 195 * @brief Check whether the specified EXTI line is falling edge asserted or not. 196 * @param __EXTI_LINE__ specifies the EXTI line to check. 197 * This parameter can be GPIO_PIN_x where x can be(0..15) 198 * @retval The new state of __EXTI_LINE__ (SET or RESET). 199 */ 200 #define __HAL_GPIO_EXTI_GET_FALLING_IT(__EXTI_LINE__) (EXTI->FPR1 & (__EXTI_LINE__)) 201 202 /** 203 * @brief Clear the EXTI line falling pending bits. 204 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 205 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 206 * @retval None 207 */ 208 #define __HAL_GPIO_EXTI_CLEAR_FALLING_IT(__EXTI_LINE__) (EXTI->FPR1 = (__EXTI_LINE__)) 209 210 /** 211 * @brief Check whether the specified EXTI line is asserted or not. 212 * @param __EXTI_LINE__ specifies the EXTI line to check. 213 * This parameter can be GPIO_PIN_x where x can be(0..15) 214 * @retval The new state of __EXTI_LINE__ (SET or RESET). 215 */ 216 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (__HAL_GPIO_EXTI_GET_RISING_IT(__EXTI_LINE__) || \ 217 __HAL_GPIO_EXTI_GET_FALLING_IT(__EXTI_LINE__)) 218 219 /** 220 * @brief Clear the EXTI line pending bits. 221 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 222 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 223 * @retval None 224 */ 225 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) \ 226 do { \ 227 __HAL_GPIO_EXTI_CLEAR_RISING_IT(__EXTI_LINE__); \ 228 __HAL_GPIO_EXTI_CLEAR_FALLING_IT(__EXTI_LINE__); \ 229 } while(0) 230 231 232 /** 233 * @brief Generate a Software interrupt on selected EXTI line(s). 234 * @param __EXTI_LINE__ specifies the EXTI line to set. 235 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 236 * @retval None 237 */ 238 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER1 = (__EXTI_LINE__)) 239 240 /** 241 * @brief Check whether the specified EXTI line flag is set or not. 242 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 243 * This parameter can be GPIO_PIN_x where x can be(0..15) 244 * @retval The new state of __EXTI_LINE__ (SET or RESET). 245 */ 246 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) 247 248 /** 249 * @brief Clear the EXTI line pending flags. 250 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 251 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 252 * @retval None 253 */ 254 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) 255 256 /** 257 * @} 258 */ 259 260 /* Private macros ------------------------------------------------------------*/ 261 /** @defgroup GPIO_Private_Constants GPIO Private Constants 262 * @{ 263 */ 264 #define GPIO_MODE_Pos 0u 265 #define GPIO_MODE (0x3uL << GPIO_MODE_Pos) 266 #define MODE_INPUT (0x0uL << GPIO_MODE_Pos) 267 #define MODE_OUTPUT (0x1uL << GPIO_MODE_Pos) 268 #define MODE_AF (0x2uL << GPIO_MODE_Pos) 269 #define MODE_ANALOG (0x3uL << GPIO_MODE_Pos) 270 #define OUTPUT_TYPE_Pos 4u 271 #define OUTPUT_TYPE (0x1uL << OUTPUT_TYPE_Pos) 272 #define OUTPUT_PP (0x0uL << OUTPUT_TYPE_Pos) 273 #define OUTPUT_OD (0x1uL << OUTPUT_TYPE_Pos) 274 #define EXTI_MODE_Pos 16u 275 #define EXTI_MODE (0x3uL << EXTI_MODE_Pos) 276 #define EXTI_IT (0x1uL << EXTI_MODE_Pos) 277 #define EXTI_EVT (0x2uL << EXTI_MODE_Pos) 278 #define TRIGGER_MODE_Pos 20u 279 #define TRIGGER_MODE (0x7uL << TRIGGER_MODE_Pos) 280 #define TRIGGER_RISING (0x1uL << TRIGGER_MODE_Pos) 281 #define TRIGGER_FALLING (0x2uL << TRIGGER_MODE_Pos) 282 283 /** 284 * @} 285 */ 286 287 /** @defgroup GPIO_Private_Macros GPIO Private Macros 288 * @{ 289 */ 290 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 291 292 #define IS_GPIO_PIN(__PIN__) ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\ 293 (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00U)) 294 295 #define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\ 296 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\ 297 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\ 298 ((__MODE__) == GPIO_MODE_AF_PP) ||\ 299 ((__MODE__) == GPIO_MODE_AF_OD) ||\ 300 ((__MODE__) == GPIO_MODE_IT_RISING) ||\ 301 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\ 302 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\ 303 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\ 304 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\ 305 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\ 306 ((__MODE__) == GPIO_MODE_ANALOG)) 307 308 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\ 309 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\ 310 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH) ||\ 311 ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH)) 312 313 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\ 314 ((__PULL__) == GPIO_PULLUP) || \ 315 ((__PULL__) == GPIO_PULLDOWN)) 316 317 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 318 319 #define IS_GPIO_PIN_ATTRIBUTES(__ATTRIBUTES__) (((__ATTRIBUTES__) == GPIO_PIN_SEC) ||\ 320 ((__ATTRIBUTES__) == GPIO_PIN_NSEC)) 321 322 #endif /* __ARM_FEATURE_CMSE */ 323 324 /** 325 * @} 326 */ 327 328 /* Include GPIO HAL Extended module */ 329 #include "stm32l5xx_hal_gpio_ex.h" 330 331 /* Exported functions --------------------------------------------------------*/ 332 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions 333 * @brief GPIO Exported Functions 334 * @{ 335 */ 336 337 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions 338 * @brief Initialization and Configuration functions 339 * @{ 340 */ 341 342 /* Initialization and de-initialization functions *****************************/ 343 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 344 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 345 346 /** 347 * @} 348 */ 349 350 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions 351 * @brief IO operation functions 352 * @{ 353 */ 354 355 /* IO operation functions *****************************************************/ 356 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 357 void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 358 void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 359 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 360 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 361 void HAL_GPIO_EXTI_Rising_Callback(uint16_t GPIO_Pin); 362 void HAL_GPIO_EXTI_Falling_Callback(uint16_t GPIO_Pin); 363 364 /** 365 * @} 366 */ 367 368 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 369 370 /** @defgroup GPIO_Exported_Functions_Group3 IO attributes management functions 371 * @{ 372 */ 373 374 /* IO attributes management functions *****************************************/ 375 void HAL_GPIO_ConfigPinAttributes(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, uint32_t PinAttributes); 376 HAL_StatusTypeDef HAL_GPIO_GetConfigPinAttributes(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, uint32_t *pPinAttributes); 377 378 /** 379 * @} 380 */ 381 382 #endif /* __ARM_FEATURE_CMSE */ 383 384 /** 385 * @} 386 */ 387 388 /** 389 * @} 390 */ 391 392 /** 393 * @} 394 */ 395 396 #ifdef __cplusplus 397 } 398 #endif 399 400 #endif /* STM32L5xx_HAL_GPIO_H */ 401 402
