1 /** 2 ****************************************************************************** 3 * @file stm32f2xx_hal_exti.h 4 * @author MCD Application Team 5 * @brief Header file of EXTI 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 STM32F2xx_HAL_EXTI_H 21 #define STM32F2xx_HAL_EXTI_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32f2xx_hal_def.h" 29 30 /** @addtogroup STM32F2xx_HAL_Driver 31 * @{ 32 */ 33 34 /** @defgroup EXTI EXTI 35 * @brief EXTI HAL module driver 36 * @{ 37 */ 38 39 /* Exported types ------------------------------------------------------------*/ 40 41 /** @defgroup EXTI_Exported_Types EXTI Exported Types 42 * @{ 43 */ 44 45 /** 46 * @brief HAL EXTI common Callback ID enumeration definition 47 */ 48 typedef enum 49 { 50 HAL_EXTI_COMMON_CB_ID = 0x00U 51 } EXTI_CallbackIDTypeDef; 52 53 /** 54 * @brief EXTI Handle structure definition 55 */ 56 typedef struct 57 { 58 uint32_t Line; /*!< Exti line number */ 59 void (* PendingCallback)(void); /*!< Exti pending callback */ 60 } EXTI_HandleTypeDef; 61 62 /** 63 * @brief EXTI Configuration structure definition 64 */ 65 typedef struct 66 { 67 uint32_t Line; /*!< The Exti line to be configured. This parameter 68 can be a value of @ref EXTI_Line */ 69 uint32_t Mode; /*!< The Exit Mode to be configured for a core. 70 This parameter can be a combination of @ref EXTI_Mode */ 71 uint32_t Trigger; /*!< The Exti Trigger to be configured. This parameter 72 can be a value of @ref EXTI_Trigger */ 73 uint32_t GPIOSel; /*!< The Exti GPIO multiplexer selection to be configured. 74 This parameter is only possible for line 0 to 15. It 75 can be a value of @ref EXTI_GPIOSel */ 76 } EXTI_ConfigTypeDef; 77 78 /** 79 * @} 80 */ 81 82 /* Exported constants --------------------------------------------------------*/ 83 /** @defgroup EXTI_Exported_Constants EXTI Exported Constants 84 * @{ 85 */ 86 87 /** @defgroup EXTI_Line EXTI Line 88 * @{ 89 */ 90 #define EXTI_LINE_0 (EXTI_GPIO | 0x00u) /*!< External interrupt line 0 */ 91 #define EXTI_LINE_1 (EXTI_GPIO | 0x01u) /*!< External interrupt line 1 */ 92 #define EXTI_LINE_2 (EXTI_GPIO | 0x02u) /*!< External interrupt line 2 */ 93 #define EXTI_LINE_3 (EXTI_GPIO | 0x03u) /*!< External interrupt line 3 */ 94 #define EXTI_LINE_4 (EXTI_GPIO | 0x04u) /*!< External interrupt line 4 */ 95 #define EXTI_LINE_5 (EXTI_GPIO | 0x05u) /*!< External interrupt line 5 */ 96 #define EXTI_LINE_6 (EXTI_GPIO | 0x06u) /*!< External interrupt line 6 */ 97 #define EXTI_LINE_7 (EXTI_GPIO | 0x07u) /*!< External interrupt line 7 */ 98 #define EXTI_LINE_8 (EXTI_GPIO | 0x08u) /*!< External interrupt line 8 */ 99 #define EXTI_LINE_9 (EXTI_GPIO | 0x09u) /*!< External interrupt line 9 */ 100 #define EXTI_LINE_10 (EXTI_GPIO | 0x0Au) /*!< External interrupt line 10 */ 101 #define EXTI_LINE_11 (EXTI_GPIO | 0x0Bu) /*!< External interrupt line 11 */ 102 #define EXTI_LINE_12 (EXTI_GPIO | 0x0Cu) /*!< External interrupt line 12 */ 103 #define EXTI_LINE_13 (EXTI_GPIO | 0x0Du) /*!< External interrupt line 13 */ 104 #define EXTI_LINE_14 (EXTI_GPIO | 0x0Eu) /*!< External interrupt line 14 */ 105 #define EXTI_LINE_15 (EXTI_GPIO | 0x0Fu) /*!< External interrupt line 15 */ 106 #define EXTI_LINE_16 (EXTI_CONFIG | 0x10u) /*!< External interrupt line 16 Connected to the PVD Output */ 107 #define EXTI_LINE_17 (EXTI_CONFIG | 0x11u) /*!< External interrupt line 17 Connected to the RTC Alarm event */ 108 #define EXTI_LINE_18 (EXTI_CONFIG | 0x12u) /*!< External interrupt line 18 Connected to the USB OTG FS Wakeup from suspend event */ 109 #define EXTI_LINE_19 (EXTI_CONFIG | 0x13u) /*!< External interrupt line 19 Connected to the Ethernet Wakeup event */ 110 #define EXTI_LINE_20 (EXTI_CONFIG | 0x14u) /*!< External interrupt line 20 Connected to the USB OTG HS (configured in FS) Wakeup event */ 111 #define EXTI_LINE_21 (EXTI_CONFIG | 0x15u) /*!< External interrupt line 21 Connected to the RTC Tamper and Time Stamp events */ 112 #define EXTI_LINE_22 (EXTI_CONFIG | 0x16u) /*!< External interrupt line 22 Connected to the RTC Wakeup event */ 113 114 /** 115 * @} 116 */ 117 118 /** @defgroup EXTI_Mode EXTI Mode 119 * @{ 120 */ 121 #define EXTI_MODE_NONE 0x00000000u 122 #define EXTI_MODE_INTERRUPT 0x00000001u 123 #define EXTI_MODE_EVENT 0x00000002u 124 /** 125 * @} 126 */ 127 128 /** @defgroup EXTI_Trigger EXTI Trigger 129 * @{ 130 */ 131 #define EXTI_TRIGGER_NONE 0x00000000u 132 #define EXTI_TRIGGER_RISING 0x00000001u 133 #define EXTI_TRIGGER_FALLING 0x00000002u 134 #define EXTI_TRIGGER_RISING_FALLING (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING) 135 /** 136 * @} 137 */ 138 139 /** @defgroup EXTI_GPIOSel EXTI GPIOSel 140 * @brief 141 * @{ 142 */ 143 #define EXTI_GPIOA 0x00000000u 144 #define EXTI_GPIOB 0x00000001u 145 #define EXTI_GPIOC 0x00000002u 146 #define EXTI_GPIOD 0x00000003u 147 #define EXTI_GPIOE 0x00000004u 148 #define EXTI_GPIOF 0x00000005u 149 #define EXTI_GPIOG 0x00000006u 150 #define EXTI_GPIOH 0x00000007u 151 #define EXTI_GPIOI 0x00000008u 152 /** 153 * @} 154 */ 155 156 /** 157 * @} 158 */ 159 160 /* Exported macro ------------------------------------------------------------*/ 161 /** @defgroup EXTI_Exported_Macros EXTI Exported Macros 162 * @{ 163 */ 164 165 /** 166 * @} 167 */ 168 169 /* Private constants --------------------------------------------------------*/ 170 /** @defgroup EXTI_Private_Constants EXTI Private Constants 171 * @{ 172 */ 173 /** 174 * @brief EXTI Line property definition 175 */ 176 #define EXTI_PROPERTY_SHIFT 24u 177 #define EXTI_CONFIG (0x02uL << EXTI_PROPERTY_SHIFT) 178 #define EXTI_GPIO ((0x04uL << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG) 179 #define EXTI_PROPERTY_MASK (EXTI_CONFIG | EXTI_GPIO) 180 181 /** 182 * @brief EXTI bit usage 183 */ 184 #define EXTI_PIN_MASK 0x0000001Fu 185 186 /** 187 * @brief EXTI Mask for interrupt & event mode 188 */ 189 #define EXTI_MODE_MASK (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT) 190 191 /** 192 * @brief EXTI Mask for trigger possibilities 193 */ 194 #define EXTI_TRIGGER_MASK (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING) 195 196 /** 197 * @brief EXTI Line number 198 */ 199 #define EXTI_LINE_NB 23uL 200 201 /** 202 * @} 203 */ 204 205 /* Private macros ------------------------------------------------------------*/ 206 /** @defgroup EXTI_Private_Macros EXTI Private Macros 207 * @{ 208 */ 209 #define IS_EXTI_LINE(__EXTI_LINE__) ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_PIN_MASK)) == 0x00u) && \ 210 ((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG) || \ 211 (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO)) && \ 212 (((__EXTI_LINE__) & EXTI_PIN_MASK) < EXTI_LINE_NB)) 213 214 #define IS_EXTI_MODE(__EXTI_LINE__) ((((__EXTI_LINE__) & EXTI_MODE_MASK) != 0x00u) && \ 215 (((__EXTI_LINE__) & ~EXTI_MODE_MASK) == 0x00u)) 216 217 #define IS_EXTI_TRIGGER(__EXTI_LINE__) (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00u) 218 219 #define IS_EXTI_PENDING_EDGE(__EXTI_LINE__) ((__EXTI_LINE__) == EXTI_TRIGGER_RISING_FALLING) 220 221 #define IS_EXTI_CONFIG_LINE(__EXTI_LINE__) (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00u) 222 223 #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \ 224 ((__PORT__) == EXTI_GPIOB) || \ 225 ((__PORT__) == EXTI_GPIOC) || \ 226 ((__PORT__) == EXTI_GPIOD) || \ 227 ((__PORT__) == EXTI_GPIOE) || \ 228 ((__PORT__) == EXTI_GPIOF) || \ 229 ((__PORT__) == EXTI_GPIOG) || \ 230 ((__PORT__) == EXTI_GPIOH) || \ 231 ((__PORT__) == EXTI_GPIOI)) 232 233 #define IS_EXTI_GPIO_PIN(__PIN__) ((__PIN__) < 16u) 234 235 /** 236 * @} 237 */ 238 239 240 /* Exported functions --------------------------------------------------------*/ 241 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions 242 * @brief EXTI Exported Functions 243 * @{ 244 */ 245 246 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions 247 * @brief Configuration functions 248 * @{ 249 */ 250 /* Configuration functions ****************************************************/ 251 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig); 252 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig); 253 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti); 254 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, void (*pPendingCbfn)(void)); 255 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine); 256 /** 257 * @} 258 */ 259 260 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions 261 * @brief IO operation functions 262 * @{ 263 */ 264 /* IO operation functions *****************************************************/ 265 void HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti); 266 uint32_t HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge); 267 void HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge); 268 void HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti); 269 270 /** 271 * @} 272 */ 273 274 /** 275 * @} 276 */ 277 278 /** 279 * @} 280 */ 281 282 /** 283 * @} 284 */ 285 286 #ifdef __cplusplus 287 } 288 #endif 289 290 #endif /* STM32F2xx_HAL_EXTI_H */ 291 292