1 /** 2 ****************************************************************************** 3 * @file stm32f0xx_hal_gpio.h 4 * @author MCD Application Team 5 * @brief Header file of GPIO HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> 10 * 11 * Redistribution and use in source and binary forms, with or without modification, 12 * are permitted provided that the following conditions are met: 13 * 1. Redistributions of source code must retain the above copyright notice, 14 * this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 * 33 ****************************************************************************** 34 */ 35 36 /* Define to prevent recursive inclusion -------------------------------------*/ 37 #ifndef __STM32F0xx_HAL_GPIO_H 38 #define __STM32F0xx_HAL_GPIO_H 39 40 #ifdef __cplusplus 41 extern "C" { 42 #endif 43 44 /* Includes ------------------------------------------------------------------*/ 45 #include "stm32f0xx_hal_def.h" 46 47 /** @addtogroup STM32F0xx_HAL_Driver 48 * @{ 49 */ 50 51 /** @addtogroup GPIO 52 * @{ 53 */ 54 55 /* Exported types ------------------------------------------------------------*/ 56 57 /** @defgroup GPIO_Exported_Types GPIO Exported Types 58 * @{ 59 */ 60 /** 61 * @brief GPIO Init structure definition 62 */ 63 typedef struct 64 { 65 uint32_t Pin; /*!< Specifies the GPIO pins to be configured. 66 This parameter can be any value of @ref GPIO_pins */ 67 68 uint32_t Mode; /*!< Specifies the operating mode for the selected pins. 69 This parameter can be a value of @ref GPIO_mode */ 70 71 uint32_t Pull; /*!< Specifies the Pull-up or Pull-Down activation for the selected pins. 72 This parameter can be a value of @ref GPIO_pull */ 73 74 uint32_t Speed; /*!< Specifies the speed for the selected pins. 75 This parameter can be a value of @ref GPIO_speed */ 76 77 uint32_t Alternate; /*!< Peripheral to be connected to the selected pins 78 This parameter can be a value of @ref GPIOEx_Alternate_function_selection */ 79 }GPIO_InitTypeDef; 80 81 /** 82 * @brief GPIO Bit SET and Bit RESET enumeration 83 */ 84 typedef enum 85 { 86 GPIO_PIN_RESET = 0U, 87 GPIO_PIN_SET 88 }GPIO_PinState; 89 /** 90 * @} 91 */ 92 93 /* Exported constants --------------------------------------------------------*/ 94 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants 95 * @{ 96 */ 97 /** @defgroup GPIO_pins GPIO pins 98 * @{ 99 */ 100 #define GPIO_PIN_0 ((uint16_t)0x0001U) /* Pin 0 selected */ 101 #define GPIO_PIN_1 ((uint16_t)0x0002U) /* Pin 1 selected */ 102 #define GPIO_PIN_2 ((uint16_t)0x0004U) /* Pin 2 selected */ 103 #define GPIO_PIN_3 ((uint16_t)0x0008U) /* Pin 3 selected */ 104 #define GPIO_PIN_4 ((uint16_t)0x0010U) /* Pin 4 selected */ 105 #define GPIO_PIN_5 ((uint16_t)0x0020U) /* Pin 5 selected */ 106 #define GPIO_PIN_6 ((uint16_t)0x0040U) /* Pin 6 selected */ 107 #define GPIO_PIN_7 ((uint16_t)0x0080U) /* Pin 7 selected */ 108 #define GPIO_PIN_8 ((uint16_t)0x0100U) /* Pin 8 selected */ 109 #define GPIO_PIN_9 ((uint16_t)0x0200U) /* Pin 9 selected */ 110 #define GPIO_PIN_10 ((uint16_t)0x0400U) /* Pin 10 selected */ 111 #define GPIO_PIN_11 ((uint16_t)0x0800U) /* Pin 11 selected */ 112 #define GPIO_PIN_12 ((uint16_t)0x1000U) /* Pin 12 selected */ 113 #define GPIO_PIN_13 ((uint16_t)0x2000U) /* Pin 13 selected */ 114 #define GPIO_PIN_14 ((uint16_t)0x4000U) /* Pin 14 selected */ 115 #define GPIO_PIN_15 ((uint16_t)0x8000U) /* Pin 15 selected */ 116 #define GPIO_PIN_All ((uint16_t)0xFFFFU) /* All pins selected */ 117 118 #define GPIO_PIN_MASK (0x0000FFFFU) /* PIN mask for assert test */ 119 /** 120 * @} 121 */ 122 123 /** @defgroup GPIO_mode GPIO mode 124 * @brief GPIO Configuration Mode 125 * Elements values convention: 0xX0yz00YZ 126 * - X : GPIO mode or EXTI Mode 127 * - y : External IT or Event trigger detection 128 * - z : IO configuration on External IT or Event 129 * - Y : Output type (Push Pull or Open Drain) 130 * - Z : IO Direction mode (Input, Output, Alternate or Analog) 131 * @{ 132 */ 133 #define GPIO_MODE_INPUT (0x00000000U) /*!< Input Floating Mode */ 134 #define GPIO_MODE_OUTPUT_PP (0x00000001U) /*!< Output Push Pull Mode */ 135 #define GPIO_MODE_OUTPUT_OD (0x00000011U) /*!< Output Open Drain Mode */ 136 #define GPIO_MODE_AF_PP (0x00000002U) /*!< Alternate Function Push Pull Mode */ 137 #define GPIO_MODE_AF_OD (0x00000012U) /*!< Alternate Function Open Drain Mode */ 138 #define GPIO_MODE_ANALOG (0x00000003U) /*!< Analog Mode */ 139 #define GPIO_MODE_IT_RISING (0x10110000U) /*!< External Interrupt Mode with Rising edge trigger detection */ 140 #define GPIO_MODE_IT_FALLING (0x10210000U) /*!< External Interrupt Mode with Falling edge trigger detection */ 141 #define GPIO_MODE_IT_RISING_FALLING (0x10310000U) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */ 142 #define GPIO_MODE_EVT_RISING (0x10120000U) /*!< External Event Mode with Rising edge trigger detection */ 143 #define GPIO_MODE_EVT_FALLING (0x10220000U) /*!< External Event Mode with Falling edge trigger detection */ 144 #define GPIO_MODE_EVT_RISING_FALLING (0x10320000U) /*!< External Event Mode with Rising/Falling edge trigger detection */ 145 /** 146 * @} 147 */ 148 149 /** @defgroup GPIO_speed GPIO speed 150 * @brief GPIO Output Maximum frequency 151 * @{ 152 */ 153 #define GPIO_SPEED_FREQ_LOW (0x00000000U) /*!< range up to 2 MHz, please refer to the product datasheet */ 154 #define GPIO_SPEED_FREQ_MEDIUM (0x00000001U) /*!< range 4 MHz to 10 MHz, please refer to the product datasheet */ 155 #define GPIO_SPEED_FREQ_HIGH (0x00000003U) /*!< range 10 MHz to 50 MHz, please refer to the product datasheet */ 156 /** 157 * @} 158 */ 159 160 /** @defgroup GPIO_pull GPIO pull 161 * @brief GPIO Pull-Up or Pull-Down Activation 162 * @{ 163 */ 164 #define GPIO_NOPULL (0x00000000U) /*!< No Pull-up or Pull-down activation */ 165 #define GPIO_PULLUP (0x00000001U) /*!< Pull-up activation */ 166 #define GPIO_PULLDOWN (0x00000002U) /*!< Pull-down activation */ 167 /** 168 * @} 169 */ 170 171 /** 172 * @} 173 */ 174 175 /* Exported macro ------------------------------------------------------------*/ 176 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros 177 * @{ 178 */ 179 180 /** 181 * @brief Check whether the specified EXTI line flag is set or not. 182 * @param __EXTI_LINE__ specifies the EXTI line flag to check. 183 * This parameter can be GPIO_PIN_x where x can be(0..15) 184 * @retval The new state of __EXTI_LINE__ (SET or RESET). 185 */ 186 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 187 188 /** 189 * @brief Clear the EXTI's line pending flags. 190 * @param __EXTI_LINE__ specifies the EXTI lines flags to clear. 191 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 192 * @retval None 193 */ 194 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 195 196 /** 197 * @brief Check whether the specified EXTI line is asserted or not. 198 * @param __EXTI_LINE__ specifies the EXTI line to check. 199 * This parameter can be GPIO_PIN_x where x can be(0..15) 200 * @retval The new state of __EXTI_LINE__ (SET or RESET). 201 */ 202 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__)) 203 204 /** 205 * @brief Clear the EXTI's line pending bits. 206 * @param __EXTI_LINE__ specifies the EXTI lines to clear. 207 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15) 208 * @retval None 209 */ 210 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__)) 211 212 /** 213 * @brief Generate a Software interrupt on selected EXTI line. 214 * @param __EXTI_LINE__ specifies the EXTI line to check. 215 * This parameter can be GPIO_PIN_x where x can be(0..15) 216 * @retval None 217 */ 218 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__)) 219 220 /** 221 * @} 222 */ 223 224 /* Private macros ------------------------------------------------------------*/ 225 /** @addtogroup GPIO_Private_Macros GPIO Private Macros 226 * @{ 227 */ 228 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET)) 229 230 #define IS_GPIO_PIN(__PIN__) ((((__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\ 231 (((__PIN__) & ~GPIO_PIN_MASK) == 0x00U)) 232 233 #define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\ 234 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\ 235 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\ 236 ((__MODE__) == GPIO_MODE_AF_PP) ||\ 237 ((__MODE__) == GPIO_MODE_AF_OD) ||\ 238 ((__MODE__) == GPIO_MODE_IT_RISING) ||\ 239 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\ 240 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\ 241 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\ 242 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\ 243 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\ 244 ((__MODE__) == GPIO_MODE_ANALOG)) 245 246 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\ 247 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\ 248 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH)) 249 250 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\ 251 ((__PULL__) == GPIO_PULLUP) || \ 252 ((__PULL__) == GPIO_PULLDOWN)) 253 /** 254 * @} 255 */ 256 257 /* Include GPIO HAL Extended module */ 258 #include "stm32f0xx_hal_gpio_ex.h" 259 260 /* Exported functions --------------------------------------------------------*/ 261 /** @addtogroup GPIO_Exported_Functions GPIO Exported Functions 262 * @{ 263 */ 264 265 /** @addtogroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions 266 * @brief Initialization and Configuration functions 267 * @{ 268 */ 269 270 /* Initialization and de-initialization functions *****************************/ 271 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init); 272 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin); 273 274 /** 275 * @} 276 */ 277 278 /** @addtogroup GPIO_Exported_Functions_Group2 IO operation functions 279 * @{ 280 */ 281 282 /* IO operation functions *****************************************************/ 283 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 284 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState); 285 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 286 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin); 287 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin); 288 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin); 289 290 /** 291 * @} 292 */ 293 294 /** 295 * @} 296 */ 297 298 /** 299 * @} 300 */ 301 302 /** 303 * @} 304 */ 305 306 #ifdef __cplusplus 307 } 308 #endif 309 310 #endif /* __STM32F0xx_HAL_GPIO_H */ 311 312 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/ 313