1 /** 2 ****************************************************************************** 3 * @file stm32c0xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2022 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 STM32C0xx_HAL_GPIO_H 21 #define STM32C0xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32c0xx_hal_def.h" 29 30 /** @addtogroup STM32C0xx_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: 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) 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 /** 169 * @} 170 */ 171 172 /* Exported macro ------------------------------------------------------------*/ 173 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 174 * @{ 175 */ 176 177 /** 178 * @brief Check whether the specified EXTI line is rising edge asserted or not. 179 * @param __EXTI_LINE__ specifies the EXTI line to check. 180 * This parameter can be GPIO_PIN_x where x can be(0..15) 181 * @retval The new state of __EXTI_LINE__ (SET or RESET). 182 */ 183 #define __HAL_GPIO_EXTI_GET_RISING_IT(__EXTI_LINE__) (EXTI->RPR1 & (__EXTI_LINE__)) 184 185 /** 186 * @brief Clear the EXTI line rising pending bits. 187 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 188 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 189 * @retval None 190 */ 191 #define __HAL_GPIO_EXTI_CLEAR_RISING_IT(__EXTI_LINE__) (EXTI->RPR1 = (__EXTI_LINE__)) 192 193 /** 194 * @brief Check whether the specified EXTI line is falling edge asserted or not. 195 * @param __EXTI_LINE__ specifies the EXTI line to check. 196 * This parameter can be GPIO_PIN_x where x can be(0..15) 197 * @retval The new state of __EXTI_LINE__ (SET or RESET). 198 */ 199 #define __HAL_GPIO_EXTI_GET_FALLING_IT(__EXTI_LINE__) (EXTI->FPR1 & (__EXTI_LINE__)) 200 201 /** 202 * @brief Clear the EXTI line falling pending bits. 203 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 204 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 205 * @retval None 206 */ 207 #define __HAL_GPIO_EXTI_CLEAR_FALLING_IT(__EXTI_LINE__) (EXTI->FPR1 = (__EXTI_LINE__)) 208 209 /** 210 * @brief Check whether the specified EXTI line is asserted or not. 211 * @param __EXTI_LINE__ specifies the EXTI line to check. 212 * This parameter can be GPIO_PIN_x where x can be(0..15) 213 * @retval The new state of __EXTI_LINE__ (SET or RESET). 214 */ 215 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (__HAL_GPIO_EXTI_GET_RISING_IT(__EXTI_LINE__) || \ 216 __HAL_GPIO_EXTI_GET_FALLING_IT(__EXTI_LINE__)) 217 218 /** 219 * @brief Clear the EXTI's line pending bits. 220 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 221 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 222 * @retval None 223 */ 224 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) \ 225 do { \ 226 __HAL_GPIO_EXTI_CLEAR_RISING_IT(__EXTI_LINE__); \ 227 __HAL_GPIO_EXTI_CLEAR_FALLING_IT(__EXTI_LINE__); \ 228 } while(0) 229 230 231 /** 232 * @brief Generate a Software interrupt on selected EXTI line. 233 * @param __EXTI_LINE__ specifies the EXTI line to check. 234 * This parameter can be GPIO_PIN_x where x can be(0..15) 235 * @retval None 236 */ 237 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER1 |= (__EXTI_LINE__)) 238 239 /** 240 * @brief Check whether the specified EXTI line flag is set or not. 241 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 242 * This parameter can be GPIO_PIN_x where x can be(0..15) 243 * @retval The new state of __EXTI_LINE__ (SET or RESET). 244 */ 245 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) 246 247 /** 248 * @brief Clear the EXTI line pending flags. 249 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 250 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 251 * @retval None 252 */ 253 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) 254 255 /** 256 * @} 257 */ 258 259 /* Private macros ------------------------------------------------------------*/ 260 /** @defgroup GPIO_Private_Macros GPIO Private Macros 261 * @{ 262 */ 263 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 264 265 #define IS_GPIO_COMMON_PIN(__RESETMASK__, __SETMASK__) \ 266 (((uint32_t)(__RESETMASK__) & (uint32_t)(__SETMASK__)) == 0x00u) 267 268 #define IS_GPIO_PIN(__PIN__) ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00u) &&\ 269 (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00u)) 270 271 #define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\ 272 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\ 273 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\ 274 ((__MODE__) == GPIO_MODE_AF_PP) ||\ 275 ((__MODE__) == GPIO_MODE_AF_OD) ||\ 276 ((__MODE__) == GPIO_MODE_IT_RISING) ||\ 277 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\ 278 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\ 279 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\ 280 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\ 281 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\ 282 ((__MODE__) == GPIO_MODE_ANALOG)) 283 284 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\ 285 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\ 286 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH) ||\ 287 ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH)) 288 289 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\ 290 ((__PULL__) == GPIO_PULLUP) || \ 291 ((__PULL__) == GPIO_PULLDOWN)) 292 /** 293 * @} 294 */ 295 296 /* Include GPIO HAL Extended module */ 297 #include "stm32c0xx_hal_gpio_ex.h" 298 299 /* Exported functions --------------------------------------------------------*/ 300 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions 301 * @brief GPIO Exported Functions 302 * @{ 303 */ 304 305 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions 306 * @brief Initialization and Configuration functions 307 * @{ 308 */ 309 310 /* Initialization and de-initialization functions *****************************/ 311 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, const GPIO_InitTypeDef *pGPIO_Init); 312 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 313 314 /** 315 * @} 316 */ 317 318 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions 319 * @brief IO operation functions 320 * @{ 321 */ 322 323 /* IO operation functions *****************************************************/ 324 GPIO_PinState HAL_GPIO_ReadPin(const GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 325 void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 326 void HAL_GPIO_WriteMultipleStatePin(GPIO_TypeDef *GPIOx, uint16_t PinReset, uint16_t PinSet); 327 void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 328 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 329 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 330 void HAL_GPIO_EXTI_Rising_Callback(uint16_t GPIO_Pin); 331 void HAL_GPIO_EXTI_Falling_Callback(uint16_t GPIO_Pin); 332 333 /** 334 * @} 335 */ 336 337 /** 338 * @} 339 */ 340 341 /** 342 * @} 343 */ 344 345 /** 346 * @} 347 */ 348 349 #ifdef __cplusplus 350 } 351 #endif 352 353 #endif /* STM32C0xx_HAL_GPIO_H */ 354 355
