1 /** 2 ****************************************************************************** 3 * @file stm32g4xx_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 STM32G4xx_HAL_GPIO_H 21 #define STM32G4xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32g4xx_hal_def.h" 29 30 /** @addtogroup STM32G4xx_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 122 #define GPIO_MODE_ANALOG MODE_ANALOG /*!< Analog Mode */ 123 124 #define GPIO_MODE_IT_RISING (MODE_INPUT | EXTI_IT | TRIGGER_RISING) /*!< External Interrupt Mode with Rising edge trigger detection */ 125 #define GPIO_MODE_IT_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_FALLING) /*!< External Interrupt Mode with Falling edge trigger detection */ 126 #define GPIO_MODE_IT_RISING_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 127 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 | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Event Mode with Rising/Falling edge trigger detection */ 131 /** 132 * @} 133 */ 134 135 /** @defgroup GPIO_speed GPIO speed 136 * @brief GPIO Output Maximum frequency 137 * @{ 138 */ 139 #define GPIO_SPEED_FREQ_LOW (0x00000000U) /*!< range up to 5 MHz, please refer to the product datasheet */ 140 #define GPIO_SPEED_FREQ_MEDIUM (0x00000001U) /*!< range 5 MHz to 25 MHz, please refer to the product datasheet */ 141 #define GPIO_SPEED_FREQ_HIGH (0x00000002U) /*!< range 25 MHz to 50 MHz, please refer to the product datasheet */ 142 #define GPIO_SPEED_FREQ_VERY_HIGH (0x00000003U) /*!< range 50 MHz to 120 MHz, please refer to the product datasheet */ 143 /** 144 * @} 145 */ 146 147 /** @defgroup GPIO_pull GPIO pull 148 * @brief GPIO Pull-Up or Pull-Down Activation 149 * @{ 150 */ 151 #define GPIO_NOPULL (0x00000000U) /*!< No Pull-up or Pull-down activation */ 152 #define GPIO_PULLUP (0x00000001U) /*!< Pull-up activation */ 153 #define GPIO_PULLDOWN (0x00000002U) /*!< Pull-down activation */ 154 /** 155 * @} 156 */ 157 158 /** 159 * @} 160 */ 161 162 /* Exported macro ------------------------------------------------------------*/ 163 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 164 * @{ 165 */ 166 167 /** 168 * @brief Check whether the specified EXTI line flag is set or not. 169 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 170 * This parameter can be GPIO_PIN_x where x can be(0..15) 171 * @retval The new state of __EXTI_LINE__ (SET or RESET). 172 */ 173 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR1 & (__EXTI_LINE__)) 174 175 /** 176 * @brief Clear the EXTI's line pending flags. 177 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 178 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 179 * @retval None 180 */ 181 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR1 = (__EXTI_LINE__)) 182 183 /** 184 * @brief Check whether the specified EXTI line is asserted or not. 185 * @param __EXTI_LINE__ specifies the EXTI line to check. 186 * This parameter can be GPIO_PIN_x where x can be(0..15) 187 * @retval The new state of __EXTI_LINE__ (SET or RESET). 188 */ 189 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR1 & (__EXTI_LINE__)) 190 191 /** 192 * @brief Clear the EXTI's line pending bits. 193 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 194 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 195 * @retval None 196 */ 197 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR1 = (__EXTI_LINE__)) 198 199 /** 200 * @brief Generate a Software interrupt on selected EXTI line. 201 * @param __EXTI_LINE__ specifies the EXTI line to check. 202 * This parameter can be GPIO_PIN_x where x can be(0..15) 203 * @retval None 204 */ 205 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER1 |= (__EXTI_LINE__)) 206 207 /** 208 * @} 209 */ 210 211 /* Private macros ------------------------------------------------------------*/ 212 /** @defgroup GPIO_Private_Constants GPIO Private Constants 213 * @{ 214 */ 215 #define GPIO_MODE_Pos 0U 216 #define GPIO_MODE (0x3UL << GPIO_MODE_Pos) 217 #define MODE_INPUT (0x0UL << GPIO_MODE_Pos) 218 #define MODE_OUTPUT (0x1UL << GPIO_MODE_Pos) 219 #define MODE_AF (0x2UL << GPIO_MODE_Pos) 220 #define MODE_ANALOG (0x3UL << GPIO_MODE_Pos) 221 #define OUTPUT_TYPE_Pos 4U 222 #define OUTPUT_TYPE (0x1UL << OUTPUT_TYPE_Pos) 223 #define OUTPUT_PP (0x0UL << OUTPUT_TYPE_Pos) 224 #define OUTPUT_OD (0x1UL << OUTPUT_TYPE_Pos) 225 #define EXTI_MODE_Pos 16U 226 #define EXTI_MODE (0x3UL << EXTI_MODE_Pos) 227 #define EXTI_IT (0x1UL << EXTI_MODE_Pos) 228 #define EXTI_EVT (0x2UL << EXTI_MODE_Pos) 229 #define TRIGGER_MODE_Pos 20U 230 #define TRIGGER_MODE (0x7UL << TRIGGER_MODE_Pos) 231 #define TRIGGER_RISING (0x1UL << TRIGGER_MODE_Pos) 232 #define TRIGGER_FALLING (0x2UL << TRIGGER_MODE_Pos) 233 /** 234 * @} 235 */ 236 237 /** @defgroup GPIO_Private_Macros GPIO Private Macros 238 * @{ 239 */ 240 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 241 242 #define IS_GPIO_PIN(__PIN__) ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\ 243 (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00U)) 244 245 #define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\ 246 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\ 247 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\ 248 ((__MODE__) == GPIO_MODE_AF_PP) ||\ 249 ((__MODE__) == GPIO_MODE_AF_OD) ||\ 250 ((__MODE__) == GPIO_MODE_IT_RISING) ||\ 251 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\ 252 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\ 253 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\ 254 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\ 255 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\ 256 ((__MODE__) == GPIO_MODE_ANALOG)) 257 258 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\ 259 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\ 260 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH) ||\ 261 ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH)) 262 263 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\ 264 ((__PULL__) == GPIO_PULLUP) || \ 265 ((__PULL__) == GPIO_PULLDOWN)) 266 /** 267 * @} 268 */ 269 270 /* Include GPIO HAL Extended module */ 271 #include "stm32g4xx_hal_gpio_ex.h" 272 273 /* Exported functions --------------------------------------------------------*/ 274 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions 275 * @brief GPIO Exported Functions 276 * @{ 277 */ 278 279 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions 280 * @brief Initialization and Configuration functions 281 * @{ 282 */ 283 284 /* Initialization and de-initialization functions *****************************/ 285 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 286 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 287 288 /** 289 * @} 290 */ 291 292 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions 293 * @brief IO operation functions 294 * @{ 295 */ 296 297 /* IO operation functions *****************************************************/ 298 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 299 void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 300 void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 301 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 302 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 303 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); 304 305 /** 306 * @} 307 */ 308 309 /** 310 * @} 311 */ 312 313 /** 314 * @} 315 */ 316 317 /** 318 * @} 319 */ 320 321 #ifdef __cplusplus 322 } 323 #endif 324 325 #endif /* STM32G4xx_HAL_GPIO_H */ 326 327
