1 /** 2 ****************************************************************************** 3 * @file stm32wb0x_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2024 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 STM32WB0x_HAL_GPIO_H 21 #define STM32WB0x_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32wb0x_hal_def.h" 29 30 /** @addtogroup STM32WB0x_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 ((uint32_t)0x0000FFFF) /* PIN mask for assert test */ 103 /** 104 * @} 105 */ 106 107 /** @defgroup GPIO_mode GPIO mode 108 * @brief GPIO Configuration Mode 109 * Elements values convention: 0x0TWX00YZ 110 * - T : IO configuration on External IT Edge/Level 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 #define GPIO_MODE_ANALOG MODE_ANALOG /*!< Analog Mode */ 123 #define GPIO_MODE_IT_RISING (MODE_INPUT | EXTI_IT | TRIGGER_RISING) /*!< External Interrupt Mode with Rising edge trigger detection */ 124 #define GPIO_MODE_IT_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_FALLING) /*!< External Interrupt Mode with Falling edge trigger detection */ 125 #define GPIO_MODE_IT_RISING_FALLING (MODE_INPUT | EXTI_IT | EDGE_SELECTION_BOTH) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 126 #define GPIO_MODE_IT_LEVEL_HIGH (MODE_INPUT | EXTI_IT | DETECTION_TYPE_LEVEL | EDGE_HIGH) /*!< External Interrupt Mode with High level trigger detection */ 127 #define GPIO_MODE_IT_LEVEL_LOW (MODE_INPUT | EXTI_IT | DETECTION_TYPE_LEVEL) /*!< External Interrupt Mode with Low level trigger detection */ 128 #define GPIO_MODE_EVT_RISING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING) /*!< External Event Mode with Rising edge trigger detection */ 129 #define GPIO_MODE_EVT_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING) /*!< External Event Mode with Falling edge trigger detection */ 130 #define GPIO_MODE_EVT_RISING_FALLING (MODE_INPUT | EXTI_EVT | EDGE_SELECTION_BOTH) /*!< External Event Mode with Rising/Falling edge trigger detection */ 131 #define GPIO_MODE_EVT_LEVEL_HIGH (MODE_INPUT | EXTI_EVT | DETECTION_TYPE_LEVEL | EDGE_HIGH) /*!< External Event Mode with High level trigger detection */ 132 #define GPIO_MODE_EVT_LEVEL_LOW (MODE_INPUT | EXTI_EVT | DETECTION_TYPE_LEVEL) /*!< External Event Mode with Low level trigger detection */ 133 134 /** 135 * @} 136 */ 137 138 /** @defgroup GPIO_speed GPIO speed 139 * @brief GPIO Output Maximum frequency 140 * @{ 141 */ 142 #define GPIO_SPEED_FREQ_LOW 0x00000000u /*!< Low speed */ 143 #define GPIO_SPEED_FREQ_MEDIUM 0x00000001u /*!< Medium speed */ 144 #define GPIO_SPEED_FREQ_HIGH 0x00000002u /*!< High speed */ 145 #define GPIO_SPEED_FREQ_VERY_HIGH 0x00000003u /*!< Very high speed */ 146 /** 147 * @} 148 */ 149 150 /** @defgroup GPIO_pull GPIO pull 151 * @brief GPIO Pull-Up or Pull-Down Activation 152 * @{ 153 */ 154 #define GPIO_NOPULL 0x00000000u /*!< No Pull-up or Pull-down activation */ 155 #define GPIO_PULLUP 0x00000001u /*!< Pull-up activation */ 156 #define GPIO_PULLDOWN 0x00000002u /*!< Pull-down activation */ 157 /** 158 * @} 159 */ 160 161 /** 162 * @} 163 */ 164 165 /* Exported macro ------------------------------------------------------------*/ 166 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 167 * @{ 168 */ 169 170 /** 171 * @brief Check whether the specified EXTI line flag is set or not. 172 * @param __EXTI_PORT__ specifies the EXTI port to check. 173 This parameter can be GPIOA or GPIOB. 174 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 175 * This parameter can be GPIO_PIN_x where x can be(0..15) 176 * @retval The new state of __EXTI_LINE__ (SET or RESET). 177 */ 178 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_PORT__, __EXTI_LINE__) ((((uint32_t)__EXTI_PORT__) == ((uint32_t)GPIOA)) ? (SYSCFG->IO_ISCR & (__EXTI_LINE__)) : (SYSCFG->IO_ISCR & ((__EXTI_LINE__) << 16))) 179 180 /** 181 * @brief Clear the EXTI's line pending flags. 182 * @param __EXTI_PORT__ specifies the EXTI port to check. 183 This parameter can be GPIOA or GPIOB. 184 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 185 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 186 * @retval None 187 */ 188 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_PORT__, __EXTI_LINE__) ((((uint32_t)__EXTI_PORT__) == ((uint32_t)GPIOA)) ? (SYSCFG->IO_ISCR = (__EXTI_LINE__)) : (SYSCFG->IO_ISCR = ((__EXTI_LINE__) << 16))) 189 190 /** 191 * @brief Check whether the specified EXTI line is asserted or not. 192 * @param __EXTI_PORT__ specifies the EXTI port to check. 193 This parameter can be GPIOA or GPIOB. 194 * @param __EXTI_LINE__ specifies the EXTI line to check. 195 * This parameter can be GPIO_PIN_x where x can be(0..15) 196 * @retval The new state of __EXTI_LINE__ (SET or RESET). 197 */ 198 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_PORT__, __EXTI_LINE__) ((((uint32_t)__EXTI_PORT__) == ((uint32_t)GPIOA)) ? (SYSCFG->IO_ISCR & (__EXTI_LINE__)) : (SYSCFG->IO_ISCR & ((__EXTI_LINE__) << 16))) 199 200 /** 201 * @brief Clear the EXTI's line pending bits. 202 * @param __EXTI_PORT__ specifies the EXTI port to check. 203 This parameter can be GPIOA or GPIOB. 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_IT(__EXTI_PORT__, __EXTI_LINE__) ((((uint32_t)__EXTI_PORT__) == ((uint32_t)GPIOA)) ? (SYSCFG->IO_ISCR = (__EXTI_LINE__)) : (SYSCFG->IO_ISCR = ((__EXTI_LINE__) << 16))) 209 210 /** 211 * @} 212 */ 213 214 /* Private macros ------------------------------------------------------------*/ 215 /** @defgroup GPIO_Private_Constants GPIO Private Constants 216 * @{ 217 */ 218 #define GPIO_MODE_Pos 0u 219 #define GPIO_MODE (0x3uL << GPIO_MODE_Pos) 220 #define MODE_INPUT (0x0uL << GPIO_MODE_Pos) 221 #define MODE_OUTPUT (0x1uL << GPIO_MODE_Pos) 222 #define MODE_AF (0x2uL << GPIO_MODE_Pos) 223 #define MODE_ANALOG (0x3uL << GPIO_MODE_Pos) 224 #define OUTPUT_TYPE_Pos 4u 225 #define OUTPUT_TYPE (0x1uL << OUTPUT_TYPE_Pos) 226 #define OUTPUT_PP (0x0uL << OUTPUT_TYPE_Pos) 227 #define OUTPUT_OD (0x1uL << OUTPUT_TYPE_Pos) 228 #define EXTI_MODE_Pos 16u 229 #define EXTI_MODE (0x3uL << EXTI_MODE_Pos) 230 #define EXTI_IT (0x1uL << EXTI_MODE_Pos) 231 #define EXTI_EVT (0x2uL << EXTI_MODE_Pos) 232 #define DETECTION_TYPE_Pos 18u 233 #define DETECTION_TYPE (0x1uL << DETECTION_TYPE_Pos) 234 #define DETECTION_TYPE_EDGE (0x0uL << DETECTION_TYPE_Pos) 235 #define DETECTION_TYPE_LEVEL (0x1uL << DETECTION_TYPE_Pos) 236 #define EDGE_SELECTION_Pos 20u 237 #define EDGE_SELECTION (0x1uL << EDGE_SELECTION_Pos) 238 #define EDGE_SELECTION_SINGLE (0x0uL << EDGE_SELECTION_Pos) 239 #define EDGE_SELECTION_BOTH (0x1uL << EDGE_SELECTION_Pos) 240 #define TRIGGER_MODE_Pos 22u 241 #define TRIGGER_MODE (0x1uL << TRIGGER_MODE_Pos) 242 #define TRIGGER_RISING (0x1uL << TRIGGER_MODE_Pos) 243 #define TRIGGER_FALLING (0x0uL << TRIGGER_MODE_Pos) 244 #define EDGE_LEVEL_Pos 24u 245 #define EDGE_LEVEL (0x1uL << EDGE_LEVEL_Pos) 246 #define EDGE_LOW (0x0uL << EDGE_LEVEL_Pos) 247 #define EDGE_HIGH (0x1uL << EDGE_LEVEL_Pos) 248 /** 249 * @} 250 */ 251 252 /** @defgroup GPIO_Private_Macros GPIO Private Macros 253 * @{ 254 */ 255 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 256 257 #define IS_GPIO_PIN(__PIN__) ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00u) &&\ 258 (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00u)) 259 260 #define IS_GPIO_COMMON_PIN(__RESETMASK__, __SETMASK__) \ 261 (((uint32_t)(__RESETMASK__) & (uint32_t)(__SETMASK__)) == 0x00u) 262 263 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_IT_LEVEL_HIGH) ||\ 273 ((__MODE__) == GPIO_MODE_IT_LEVEL_LOW) ||\ 274 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\ 275 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\ 276 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\ 277 ((__MODE__) == GPIO_MODE_EVT_LEVEL_HIGH) ||\ 278 ((__MODE__) == GPIO_MODE_EVT_LEVEL_LOW) ||\ 279 ((__MODE__) == GPIO_MODE_ANALOG)) 280 281 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\ 282 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\ 283 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH) ||\ 284 ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH)) 285 286 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\ 287 ((__PULL__) == GPIO_PULLUP) || \ 288 ((__PULL__) == GPIO_PULLDOWN)) 289 /** 290 * @} 291 */ 292 293 /* Include GPIO HAL Extended module */ 294 #include "stm32wb0x_hal_gpio_ex.h" 295 296 /* Exported functions --------------------------------------------------------*/ 297 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions 298 * @brief GPIO Exported Functions 299 * @{ 300 */ 301 302 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions 303 * @brief Initialization and Configuration functions 304 * @{ 305 */ 306 307 /* Initialization and de-initialization functions *****************************/ 308 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 309 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 310 311 /** 312 * @} 313 */ 314 315 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions 316 * @brief IO operation functions 317 * @{ 318 */ 319 320 /* IO operation functions *****************************************************/ 321 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 322 void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 323 void HAL_GPIO_WriteMultipleStatePin(GPIO_TypeDef *GPIOx, uint16_t PinReset, uint16_t PinSet); 324 void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 325 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 326 void HAL_GPIO_EXTI_IRQHandler(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 327 void HAL_GPIO_EXTI_Callback(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 328 329 /** 330 * @} 331 */ 332 333 /** 334 * @} 335 */ 336 337 /** 338 * @} 339 */ 340 341 /** 342 * @} 343 */ 344 345 #ifdef __cplusplus 346 } 347 #endif 348 349 #endif /* STM32WB0x_HAL_GPIO_H */ 350
