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