1 /** 2 ****************************************************************************** 3 * @file stm32l1xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2017 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 __STM32L1xx_HAL_GPIO_H 21 #define __STM32L1xx_HAL_GPIO_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32l1xx_hal_def.h" 29 30 /** @addtogroup STM32L1xx_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 = 0, 71 GPIO_PIN_SET 72 } GPIO_PinState; 73 /** 74 * @} 75 */ 76 77 /* Exported constants --------------------------------------------------------*/ 78 79 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants 80 * @{ 81 */ 82 83 84 /** @defgroup GPIO_pins GPIO pins 85 * @{ 86 */ 87 #define GPIO_PIN_0 ((uint16_t)0x0001U) /* Pin 0 selected */ 88 #define GPIO_PIN_1 ((uint16_t)0x0002U) /* Pin 1 selected */ 89 #define GPIO_PIN_2 ((uint16_t)0x0004U) /* Pin 2 selected */ 90 #define GPIO_PIN_3 ((uint16_t)0x0008U) /* Pin 3 selected */ 91 #define GPIO_PIN_4 ((uint16_t)0x0010U) /* Pin 4 selected */ 92 #define GPIO_PIN_5 ((uint16_t)0x0020U) /* Pin 5 selected */ 93 #define GPIO_PIN_6 ((uint16_t)0x0040U) /* Pin 6 selected */ 94 #define GPIO_PIN_7 ((uint16_t)0x0080U) /* Pin 7 selected */ 95 #define GPIO_PIN_8 ((uint16_t)0x0100U) /* Pin 8 selected */ 96 #define GPIO_PIN_9 ((uint16_t)0x0200U) /* Pin 9 selected */ 97 #define GPIO_PIN_10 ((uint16_t)0x0400U) /* Pin 10 selected */ 98 #define GPIO_PIN_11 ((uint16_t)0x0800U) /* Pin 11 selected */ 99 #define GPIO_PIN_12 ((uint16_t)0x1000U) /* Pin 12 selected */ 100 #define GPIO_PIN_13 ((uint16_t)0x2000U) /* Pin 13 selected */ 101 #define GPIO_PIN_14 ((uint16_t)0x4000U) /* Pin 14 selected */ 102 #define GPIO_PIN_15 ((uint16_t)0x8000U) /* Pin 15 selected */ 103 #define GPIO_PIN_All ((uint16_t)0xFFFFU) /* All pins selected */ 104 105 #define GPIO_PIN_MASK (0x0000FFFFU) /* PIN mask for assert test */ 106 /** 107 * @} 108 */ 109 110 /** @defgroup GPIO_mode GPIO mode 111 * @brief GPIO Configuration Mode 112 * Elements values convention: 0x00WX00YZ 113 * - W : EXTI trigger detection on 3 bits 114 * - X : EXTI mode (IT or Event) on 2 bits 115 * - Y : Output type (Push Pull or Open Drain) on 1 bit 116 * - Z : GPIO mode (Input, Output, Alternate or Analog) on 2 bits 117 * @{ 118 */ 119 #define GPIO_MODE_INPUT MODE_INPUT /*!< Input Floating Mode */ 120 #define GPIO_MODE_OUTPUT_PP (MODE_OUTPUT | OUTPUT_PP) /*!< Output Push Pull Mode */ 121 #define GPIO_MODE_OUTPUT_OD (MODE_OUTPUT | OUTPUT_OD) /*!< Output Open Drain Mode */ 122 #define GPIO_MODE_AF_PP (MODE_AF | OUTPUT_PP) /*!< Alternate Function Push Pull Mode */ 123 #define GPIO_MODE_AF_OD (MODE_AF | OUTPUT_OD) /*!< Alternate Function Open Drain Mode */ 124 125 #define GPIO_MODE_ANALOG MODE_ANALOG /*!< Analog Mode */ 126 127 #define GPIO_MODE_IT_RISING (MODE_INPUT | EXTI_IT | TRIGGER_RISING) /*!< External Interrupt Mode with Rising edge trigger detection */ 128 #define GPIO_MODE_IT_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_FALLING) /*!< External Interrupt Mode with Falling edge trigger detection */ 129 #define GPIO_MODE_IT_RISING_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 130 131 #define GPIO_MODE_EVT_RISING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING) /*!< External Event Mode with Rising edge trigger detection */ 132 #define GPIO_MODE_EVT_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING) /*!< External Event Mode with Falling edge trigger detection */ 133 #define GPIO_MODE_EVT_RISING_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING | TRIGGER_FALLING) /*!< External Event Mode with Rising/Falling edge trigger detection */ 134 135 /** 136 * @} 137 */ 138 139 /** @defgroup GPIO_speed GPIO speed 140 * @brief GPIO Output Maximum frequency 141 * @{ 142 */ 143 #define GPIO_SPEED_FREQ_LOW (0x00000000U) /*!< max: 400 KHz, please refer to the product datasheet */ 144 #define GPIO_SPEED_FREQ_MEDIUM (0x00000001U) /*!< max: 1 MHz to 2 MHz, please refer to the product datasheet */ 145 #define GPIO_SPEED_FREQ_HIGH (0x00000002U) /*!< max: 2 MHz to 10 MHz, please refer to the product datasheet */ 146 #define GPIO_SPEED_FREQ_VERY_HIGH (0x00000003U) /*!< max: 8 MHz to 50 MHz, please refer to the product datasheet */ 147 148 /** 149 * @} 150 */ 151 152 /** @defgroup GPIO_pull GPIO pull 153 * @brief GPIO Pull-Up or Pull-Down Activation 154 * @{ 155 */ 156 #define GPIO_NOPULL (0x00000000U) /*!< No Pull-up or Pull-down activation */ 157 #define GPIO_PULLUP (0x00000001U) /*!< Pull-up activation */ 158 #define GPIO_PULLDOWN (0x00000002U) /*!< Pull-down activation */ 159 160 /** 161 * @} 162 */ 163 164 /** 165 * @} 166 */ 167 168 /* Private constants ---------------------------------------------------------*/ 169 /** @defgroup GPIO_Private_Constants GPIO Private Constants 170 * @{ 171 */ 172 #define GPIO_MODE_Pos 0U 173 #define GPIO_MODE (0x3UL << GPIO_MODE_Pos) 174 #define MODE_INPUT (0x0UL << GPIO_MODE_Pos) 175 #define MODE_OUTPUT (0x1UL << GPIO_MODE_Pos) 176 #define MODE_AF (0x2UL << GPIO_MODE_Pos) 177 #define MODE_ANALOG (0x3UL << GPIO_MODE_Pos) 178 #define OUTPUT_TYPE_Pos 4U 179 #define OUTPUT_TYPE (0x1UL << OUTPUT_TYPE_Pos) 180 #define OUTPUT_PP (0x0UL << OUTPUT_TYPE_Pos) 181 #define OUTPUT_OD (0x1UL << OUTPUT_TYPE_Pos) 182 #define EXTI_MODE_Pos 16U 183 #define EXTI_MODE (0x3UL << EXTI_MODE_Pos) 184 #define EXTI_IT (0x1UL << EXTI_MODE_Pos) 185 #define EXTI_EVT (0x2UL << EXTI_MODE_Pos) 186 #define TRIGGER_MODE_Pos 20U 187 #define TRIGGER_MODE (0x7UL << TRIGGER_MODE_Pos) 188 #define TRIGGER_RISING (0x1UL << TRIGGER_MODE_Pos) 189 #define TRIGGER_FALLING (0x2UL << TRIGGER_MODE_Pos) 190 /** 191 * @} 192 */ 193 194 /* Private macros --------------------------------------------------------*/ 195 /** @defgroup GPIO_Private_Macros GPIO Private Macros 196 * @{ 197 */ 198 199 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 200 201 #define IS_GPIO_PIN(__PIN__) ((((uint32_t)(__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\ 202 (((uint32_t)(__PIN__) & ~GPIO_PIN_MASK) == 0x00U)) 203 204 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \ 205 ((PULL) == GPIO_PULLDOWN)) 206 207 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_FREQ_LOW) || ((SPEED) == GPIO_SPEED_FREQ_MEDIUM) || \ 208 ((SPEED) == GPIO_SPEED_FREQ_HIGH) || ((SPEED) == GPIO_SPEED_FREQ_VERY_HIGH)) 209 210 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\ 211 ((MODE) == GPIO_MODE_OUTPUT_PP) ||\ 212 ((MODE) == GPIO_MODE_OUTPUT_OD) ||\ 213 ((MODE) == GPIO_MODE_AF_PP) ||\ 214 ((MODE) == GPIO_MODE_AF_OD) ||\ 215 ((MODE) == GPIO_MODE_IT_RISING) ||\ 216 ((MODE) == GPIO_MODE_IT_FALLING) ||\ 217 ((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\ 218 ((MODE) == GPIO_MODE_EVT_RISING) ||\ 219 ((MODE) == GPIO_MODE_EVT_FALLING) ||\ 220 ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\ 221 ((MODE) == GPIO_MODE_ANALOG)) 222 223 /** 224 * @} 225 */ 226 227 /* Exported macro ------------------------------------------------------------*/ 228 229 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 230 * @{ 231 */ 232 233 /** 234 * @brief Checks whether the specified EXTI line flag is set or not. 235 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 236 * This parameter can be GPIO_PIN_x where x can be(0..15) 237 * @retval The new state of __EXTI_LINE__ (SET or RESET). 238 */ 239 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 240 241 /** 242 * @brief Clears the EXTI's line pending flags. 243 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 244 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 245 * @retval None 246 */ 247 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 248 249 /** 250 * @brief Checks whether the specified EXTI line is asserted or not. 251 * @param __EXTI_LINE__ specifies the EXTI line to check. 252 * This parameter can be GPIO_PIN_x where x can be(0..15) 253 * @retval The new state of __EXTI_LINE__ (SET or RESET). 254 */ 255 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 256 257 /** 258 * @brief Clears the EXTI's line pending bits. 259 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 260 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 261 * @retval None 262 */ 263 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 264 265 /** 266 * @brief Generates a Software interrupt on selected EXTI line. 267 * @param __EXTI_LINE__ specifies the EXTI line to check. 268 * This parameter can be GPIO_PIN_x where x can be(0..15) 269 * @retval None 270 */ 271 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__)) 272 273 /** 274 * @} 275 */ 276 277 /* Include GPIO HAL Extension module */ 278 #include "stm32l1xx_hal_gpio_ex.h" 279 280 /* Exported functions --------------------------------------------------------*/ 281 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions 282 * @brief GPIO Exported Functions 283 * @{ 284 */ 285 286 /** @defgroup GPIO_Exported_Functions_Group1 Initialization and Configuration functions 287 * @brief Initialization and Configuration functions 288 * @{ 289 */ 290 291 /* Initialization and de-initialization functions *****************************/ 292 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 293 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 294 295 /** 296 * @} 297 */ 298 299 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions 300 * @brief IO operation functions 301 * @{ 302 */ 303 304 /* IO operation functions *****************************************************/ 305 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 306 void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 307 void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 308 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin); 309 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 310 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); 311 312 /** 313 * @} 314 */ 315 316 /** 317 * @} 318 */ 319 320 /** 321 * @} 322 */ 323 324 /** 325 * @} 326 */ 327 328 #ifdef __cplusplus 329 } 330 #endif 331 332 #endif /* __STM32L1xx_HAL_GPIO_H */ 333 334
