1 /** 2 ****************************************************************************** 3 * @file stm32u5xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2021 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 STM32U5xx_HAL_GPIO_H 21 #define STM32U5xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32u5xx_hal_def.h" 29 30 /** @addtogroup STM32U5xx_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 a 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) 85 #define GPIO_PIN_1 ((uint16_t)0x0002) 86 #define GPIO_PIN_2 ((uint16_t)0x0004) 87 #define GPIO_PIN_3 ((uint16_t)0x0008) 88 #define GPIO_PIN_4 ((uint16_t)0x0010) 89 #define GPIO_PIN_5 ((uint16_t)0x0020) 90 #define GPIO_PIN_6 ((uint16_t)0x0040) 91 #define GPIO_PIN_7 ((uint16_t)0x0080) 92 #define GPIO_PIN_8 ((uint16_t)0x0100) 93 #define GPIO_PIN_9 ((uint16_t)0x0200) 94 #define GPIO_PIN_10 ((uint16_t)0x0400) 95 #define GPIO_PIN_11 ((uint16_t)0x0800) 96 #define GPIO_PIN_12 ((uint16_t)0x1000) 97 #define GPIO_PIN_13 ((uint16_t)0x2000) 98 #define GPIO_PIN_14 ((uint16_t)0x4000) 99 #define GPIO_PIN_15 ((uint16_t)0x8000) 100 #define GPIO_PIN_ALL ((uint16_t)0xFFFF) 101 102 #define GPIO_PIN_MASK (0x0000FFFFU) 103 /** 104 * @} 105 */ 106 107 /** @defgroup GPIO_mode GPIO mode 108 * @brief GPIO Configuration Mode 109 * Elements values convention: 0xX0yz00YZ 110 * - X : GPIO mode or EXTI Mode 111 * - y : External IT or Event trigger detection 112 * - z : IO configuration on External IT or Event 113 * - Y : Output type (Push Pull or Open Drain) 114 * - Z : IO Direction mode (Input, Output, (Alternate or Analog) not applicable in case of LPGPIO) 115 * @{ 116 */ 117 /*!< Input Floating Mode */ 118 #define GPIO_MODE_INPUT (0x00000000U) 119 /*!< Output Push Pull Mode */ 120 #define GPIO_MODE_OUTPUT_PP (0x00000001U) 121 /*!< Output Open Drain Mode */ 122 #define GPIO_MODE_OUTPUT_OD (0x00000011U) 123 /*!< Alternate Function Push Pull Mode */ 124 #define GPIO_MODE_AF_PP (0x00000002U) 125 /*!< Alternate Function Open Drain Mode */ 126 #define GPIO_MODE_AF_OD (0x00000012U) 127 /*!< Analog Mode */ 128 #define GPIO_MODE_ANALOG (0x00000003U) 129 /*!< External Interrupt Mode with Rising edge trigger detection */ 130 #define GPIO_MODE_IT_RISING (0x10110000U) 131 /*!< External Interrupt Mode with Falling edge trigger detection */ 132 #define GPIO_MODE_IT_FALLING (0x10210000U) 133 /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 134 #define GPIO_MODE_IT_RISING_FALLING (0x10310000U) 135 /*!< External Event Mode with Rising edge trigger detection */ 136 #define GPIO_MODE_EVT_RISING (0x10120000U) 137 /*!< External Event Mode with Falling edge trigger detection */ 138 #define GPIO_MODE_EVT_FALLING (0x10220000U) 139 /*!< External Event Mode with Rising/Falling edge trigger detection */ 140 #define GPIO_MODE_EVT_RISING_FALLING (0x10320000U) 141 /** 142 * @} 143 */ 144 145 /** @defgroup GPIO_speed GPIO speed 146 * @brief GPIO Output Maximum frequency 147 * @{ 148 */ 149 #define GPIO_SPEED_FREQ_LOW (0x00000000U) /*!< Low speed */ 150 #define GPIO_SPEED_FREQ_MEDIUM (0x00000001U) /*!< Medium speed */ 151 #define GPIO_SPEED_FREQ_HIGH (0x00000002U) /*!< High speed */ 152 #define GPIO_SPEED_FREQ_VERY_HIGH (0x00000003U) /*!< Very-high speed */ 153 /** 154 * @} 155 */ 156 157 /** @defgroup GPIO_pull GPIO pull 158 * @brief GPIO Pull-Up or Pull-Down Activation 159 * @{ 160 */ 161 #define GPIO_NOPULL (0x00000000U) /*!< No Pull-up or Pull-down activation */ 162 #define GPIO_PULLUP (0x00000001U) /*!< Pull-up activation */ 163 #define GPIO_PULLDOWN (0x00000002U) /*!< Pull-down activation */ 164 /** 165 * @} 166 */ 167 168 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 169 170 /** @defgroup GPIO_attributes GPIO attributes 171 * @brief GPIO pin secure or non-secure attributes 172 * @{ 173 */ 174 #define GPIO_PIN_SEC (0x00000001U) /*!< Secure pin attribute */ 175 #define GPIO_PIN_NSEC (0x00000000U) /*!< Non-secure pin attribute */ 176 /** 177 * @} 178 */ 179 180 #endif /* __ARM_FEATURE_CMSE */ 181 /** 182 * @} 183 */ 184 185 /* Exported macro ------------------------------------------------------------*/ 186 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 187 * @{ 188 */ 189 190 /** 191 * @brief Check whether the specified EXTI line is rising edge asserted or not. 192 * @param __EXTI_LINE__: specifies the EXTI line to check. 193 * This parameter can be GPIO_PIN_x where x can be(0..15) 194 * @retval The new state of __EXTI_LINE__ (SET or RESET). 195 */ 196 #define __HAL_GPIO_EXTI_GET_RISING_IT(__EXTI_LINE__) (EXTI->RPR1 & (__EXTI_LINE__)) 197 198 /** 199 * @brief Clear the EXTI's line rising pending bits. 200 * @param __EXTI_LINE__: specifies the EXTI lines to clear. 201 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 202 * @retval None 203 */ 204 #define __HAL_GPIO_EXTI_CLEAR_RISING_IT(__EXTI_LINE__) (EXTI->RPR1 = (__EXTI_LINE__)) 205 206 /** 207 * @brief Check whether the specified EXTI line is falling edge asserted or not. 208 * @param __EXTI_LINE__: specifies the EXTI line to check. 209 * This parameter can be GPIO_PIN_x where x can be(0..15) 210 * @retval The new state of __EXTI_LINE__ (SET or RESET). 211 */ 212 #define __HAL_GPIO_EXTI_GET_FALLING_IT(__EXTI_LINE__) (EXTI->FPR1 & (__EXTI_LINE__)) 213 214 /** 215 * @brief Clear the EXTI's line falling pending bits. 216 * @param __EXTI_LINE__: specifies the EXTI lines to clear. 217 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 218 * @retval None 219 */ 220 #define __HAL_GPIO_EXTI_CLEAR_FALLING_IT(__EXTI_LINE__) (EXTI->FPR1 = (__EXTI_LINE__)) 221 222 /** 223 * @brief Check whether the specified EXTI line is asserted or not. 224 * @param __EXTI_LINE__: specifies the EXTI line to check. 225 * This parameter can be GPIO_PIN_x where x can be(0..15) 226 * @retval The new state of __EXTI_LINE__ (SET or RESET). 227 */ 228 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (__HAL_GPIO_EXTI_GET_RISING_IT(__EXTI_LINE__) || \ 229 __HAL_GPIO_EXTI_GET_FALLING_IT(__EXTI_LINE__)) 230 231 /** 232 * @brief Clear the EXTI's line pending bits. 233 * @param __EXTI_LINE__: specifies the EXTI lines to clear. 234 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 235 * @retval None 236 */ 237 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) \ 238 do { \ 239 __HAL_GPIO_EXTI_CLEAR_RISING_IT(__EXTI_LINE__); \ 240 __HAL_GPIO_EXTI_CLEAR_FALLING_IT(__EXTI_LINE__); \ 241 } while(0) 242 243 244 /** 245 * @brief Generate a Software interrupt on selected EXTI line(s). 246 * @param __EXTI_LINE__: specifies the EXTI line to set. 247 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 248 * @retval None 249 */ 250 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER1 = (__EXTI_LINE__)) 251 252 /** 253 * @brief Check whether the specified EXTI line flag is set or not. 254 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 255 * This parameter can be GPIO_PIN_x where x can be(0..15) 256 * @retval The new state of __EXTI_LINE__ (SET or RESET). 257 */ 258 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) 259 260 /** 261 * @brief Clear the EXTI line pending flags. 262 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 263 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 264 * @retval None 265 */ 266 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) 267 268 /** 269 * @} 270 */ 271 272 /* Private macros ------------------------------------------------------------*/ 273 /** @defgroup GPIO_Private_Macros GPIO Private Macros 274 * @{ 275 */ 276 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 277 278 #define IS_GPIO_PIN(__PIN__) ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\ 279 (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00U)) 280 281 #define IS_GPIO_SINGLE_PIN(__PIN__) (((__PIN__) == GPIO_PIN_0) ||\ 282 ((__PIN__) == GPIO_PIN_1) ||\ 283 ((__PIN__) == GPIO_PIN_2) ||\ 284 ((__PIN__) == GPIO_PIN_3) ||\ 285 ((__PIN__) == GPIO_PIN_4) ||\ 286 ((__PIN__) == GPIO_PIN_5) ||\ 287 ((__PIN__) == GPIO_PIN_6) ||\ 288 ((__PIN__) == GPIO_PIN_7) ||\ 289 ((__PIN__) == GPIO_PIN_8) ||\ 290 ((__PIN__) == GPIO_PIN_9) ||\ 291 ((__PIN__) == GPIO_PIN_10) ||\ 292 ((__PIN__) == GPIO_PIN_11) ||\ 293 ((__PIN__) == GPIO_PIN_12) ||\ 294 ((__PIN__) == GPIO_PIN_13) ||\ 295 ((__PIN__) == GPIO_PIN_14) ||\ 296 ((__PIN__) == GPIO_PIN_15)) 297 298 #define IS_GPIO_COMMON_PIN(__RESETMASK__, __SETMASK__) \ 299 (((uint32_t)(__RESETMASK__) & (uint32_t)(__SETMASK__)) == 0x00u) 300 301 #define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\ 302 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\ 303 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\ 304 ((__MODE__) == GPIO_MODE_AF_PP) ||\ 305 ((__MODE__) == GPIO_MODE_AF_OD) ||\ 306 ((__MODE__) == GPIO_MODE_IT_RISING) ||\ 307 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\ 308 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\ 309 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\ 310 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\ 311 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\ 312 ((__MODE__) == GPIO_MODE_ANALOG)) 313 314 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\ 315 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\ 316 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH) ||\ 317 ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH)) 318 319 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\ 320 ((__PULL__) == GPIO_PULLUP) || \ 321 ((__PULL__) == GPIO_PULLDOWN)) 322 323 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 324 325 #define IS_GPIO_PIN_ATTRIBUTES(__ATTRIBUTES__) (((__ATTRIBUTES__) == GPIO_PIN_SEC) ||\ 326 ((__ATTRIBUTES__) == GPIO_PIN_NSEC)) 327 328 #endif /* __ARM_FEATURE_CMSE */ 329 330 /** 331 * @} 332 */ 333 334 /* Include GPIO HAL Extended module */ 335 #include "stm32u5xx_hal_gpio_ex.h" 336 337 /* Exported functions --------------------------------------------------------*/ 338 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions 339 * @brief GPIO Exported Functions 340 * @{ 341 */ 342 343 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions 344 * @brief Initialization and Configuration functions 345 * @{ 346 */ 347 348 /* Initialization and de-initialization functions *****************************/ 349 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, const GPIO_InitTypeDef *pGPIO_Init); 350 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 351 352 /** 353 * @} 354 */ 355 356 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions 357 * @brief IO operation functions 358 * @{ 359 */ 360 361 /* IO operation functions *****************************************************/ 362 GPIO_PinState HAL_GPIO_ReadPin(const GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 363 void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 364 void HAL_GPIO_WriteMultipleStatePin(GPIO_TypeDef *GPIOx, uint16_t PinReset, uint16_t PinSet); 365 void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 366 void HAL_GPIO_EnableHighSPeedLowVoltage(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 367 void HAL_GPIO_DisableHighSPeedLowVoltage(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 368 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 369 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 370 void HAL_GPIO_EXTI_Rising_Callback(uint16_t GPIO_Pin); 371 void HAL_GPIO_EXTI_Falling_Callback(uint16_t GPIO_Pin); 372 373 /** 374 * @} 375 */ 376 377 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 378 379 /** @defgroup GPIO_Exported_Functions_Group3 IO attributes management functions 380 * @{ 381 */ 382 383 /* IO attributes management functions *****************************************/ 384 void HAL_GPIO_ConfigPinAttributes(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, uint32_t PinAttributes); 385 HAL_StatusTypeDef HAL_GPIO_GetConfigPinAttributes(const GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, 386 uint32_t *pPinAttributes); 387 388 /** 389 * @} 390 */ 391 392 #endif /* __ARM_FEATURE_CMSE */ 393 394 /** 395 * @} 396 */ 397 398 /** 399 * @} 400 */ 401 402 /** 403 * @} 404 */ 405 406 #ifdef __cplusplus 407 } 408 #endif 409 410 #endif /* STM32U5xx_HAL_GPIO_H */ 411
