1 /** 2 ****************************************************************************** 3 * @file stm32u5xx_hal_exti.h 4 * @author MCD Application Team 5 * @brief Header file of EXTI HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2021 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 STM32U5xx_HAL_EXTI_H 21 #define STM32U5xx_HAL_EXTI_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32u5xx_hal_def.h" 29 30 /** @addtogroup STM32U5xx_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 typedef enum 45 { 46 HAL_EXTI_COMMON_CB_ID = 0x00U, 47 HAL_EXTI_RISING_CB_ID = 0x01U, 48 HAL_EXTI_FALLING_CB_ID = 0x02U, 49 } EXTI_CallbackIDTypeDef; 50 51 52 /** 53 * @brief EXTI Handle structure definition 54 */ 55 typedef struct 56 { 57 uint32_t Line; /*!< Exti line number */ 58 void (* RisingCallback)(void); /*!< Exti rising callback */ 59 void (* FallingCallback)(void); /*!< Exti falling 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 | EXTI_REG1 | 0x00U) 91 #define EXTI_LINE_1 (EXTI_GPIO | EXTI_REG1 | 0x01U) 92 #define EXTI_LINE_2 (EXTI_GPIO | EXTI_REG1 | 0x02U) 93 #define EXTI_LINE_3 (EXTI_GPIO | EXTI_REG1 | 0x03U) 94 #define EXTI_LINE_4 (EXTI_GPIO | EXTI_REG1 | 0x04U) 95 #define EXTI_LINE_5 (EXTI_GPIO | EXTI_REG1 | 0x05U) 96 #define EXTI_LINE_6 (EXTI_GPIO | EXTI_REG1 | 0x06U) 97 #define EXTI_LINE_7 (EXTI_GPIO | EXTI_REG1 | 0x07U) 98 #define EXTI_LINE_8 (EXTI_GPIO | EXTI_REG1 | 0x08U) 99 #define EXTI_LINE_9 (EXTI_GPIO | EXTI_REG1 | 0x09U) 100 #define EXTI_LINE_10 (EXTI_GPIO | EXTI_REG1 | 0x0AU) 101 #define EXTI_LINE_11 (EXTI_GPIO | EXTI_REG1 | 0x0BU) 102 #define EXTI_LINE_12 (EXTI_GPIO | EXTI_REG1 | 0x0CU) 103 #define EXTI_LINE_13 (EXTI_GPIO | EXTI_REG1 | 0x0DU) 104 #define EXTI_LINE_14 (EXTI_GPIO | EXTI_REG1 | 0x0EU) 105 #define EXTI_LINE_15 (EXTI_GPIO | EXTI_REG1 | 0x0FU) 106 #define EXTI_LINE_16 (EXTI_CONFIG | EXTI_REG1 | 0x10U) 107 #define EXTI_LINE_17 (EXTI_CONFIG | EXTI_REG1 | 0x11U) 108 #if defined(EXTI_IMR1_IM18) 109 #define EXTI_LINE_18 (EXTI_CONFIG | EXTI_REG1 | 0x12U) 110 #endif /* EXTI_IMR1_IM18 */ 111 #define EXTI_LINE_19 (EXTI_CONFIG | EXTI_REG1 | 0x13U) 112 #define EXTI_LINE_20 (EXTI_CONFIG | EXTI_REG1 | 0x14U) 113 #define EXTI_LINE_21 (EXTI_CONFIG | EXTI_REG1 | 0x15U) 114 #define EXTI_LINE_22 (EXTI_CONFIG | EXTI_REG1 | 0x16U) 115 #define EXTI_LINE_23 (EXTI_CONFIG | EXTI_REG1 | 0x17U) 116 #if defined(EXTI_IMR1_IM24) 117 #define EXTI_LINE_24 (EXTI_CONFIG | EXTI_REG1 | 0x18U) 118 #endif /* EXTI_IMR1_IM24 */ 119 #if defined(EXTI_IMR1_IM25) 120 #define EXTI_LINE_25 (EXTI_CONFIG | EXTI_REG1 | 0x19U) 121 #endif /* EXTI_IMR1_IM25 */ 122 /** 123 * @} 124 */ 125 126 /** @defgroup EXTI_Mode EXTI Mode 127 * @{ 128 */ 129 #define EXTI_MODE_NONE 0x00000000U 130 #define EXTI_MODE_INTERRUPT 0x00000001U 131 #define EXTI_MODE_EVENT 0x00000002U 132 /** 133 * @} 134 */ 135 136 /** @defgroup EXTI_Trigger EXTI Trigger 137 * @{ 138 */ 139 #define EXTI_TRIGGER_NONE 0x00000000U 140 #define EXTI_TRIGGER_RISING 0x00000001U 141 #define EXTI_TRIGGER_FALLING 0x00000002U 142 #define EXTI_TRIGGER_RISING_FALLING (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING) 143 /** 144 * @} 145 */ 146 147 /** @defgroup EXTI_GPIOSel EXTI GPIOSel 148 * @brief 149 * @{ 150 */ 151 #define EXTI_GPIOA 0x00000000U 152 #define EXTI_GPIOB 0x00000001U 153 #define EXTI_GPIOC 0x00000002U 154 #define EXTI_GPIOD 0x00000003U 155 #define EXTI_GPIOE 0x00000004U 156 #if defined(GPIOF) 157 #define EXTI_GPIOF 0x00000005U 158 #endif /* GPIOF */ 159 #define EXTI_GPIOG 0x00000006U 160 #define EXTI_GPIOH 0x00000007U 161 #if defined(GPIOI) 162 #define EXTI_GPIOI 0x00000008U 163 #endif /* GPIOI */ 164 #if defined(GPIOJ) 165 #define EXTI_GPIOJ 0x00000009U 166 #endif /* GPIOJ */ 167 168 /** 169 * @} 170 */ 171 172 /** @defgroup EXTI_Line_attributes EXTI line attributes 173 * @brief EXTI line secure or non-secure and privileged or non-privileged attributes 174 * @note secure and non-secure attributes are only available from secure state when the system 175 * implement the security (TZEN=1) 176 * @{ 177 */ 178 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 179 /*!< Secure line attribute */ 180 #define EXTI_LINE_SEC (EXTI_LINE_ATTR_SEC_MASK | 0x00000001U) 181 /*!< Non-secure line attribute */ 182 #define EXTI_LINE_NSEC (EXTI_LINE_ATTR_SEC_MASK | 0x00000000U) 183 #endif /* __ARM_FEATURE_CMSE */ 184 /*!< Privileged line attribute */ 185 #define EXTI_LINE_PRIV (EXTI_LINE_ATTR_PRIV_MASK | 0x00000002U) 186 /*!< Non-privileged line attribute */ 187 #define EXTI_LINE_NPRIV (EXTI_LINE_ATTR_PRIV_MASK | 0x00000000U) 188 /** 189 * @} 190 */ 191 192 /** 193 * @} 194 */ 195 196 /* Exported macro ------------------------------------------------------------*/ 197 /* Private constants --------------------------------------------------------*/ 198 /** @defgroup EXTI_Private_Constants EXTI Private Constants 199 * @{ 200 */ 201 /** 202 * @brief EXTI Line property definition 203 */ 204 #define EXTI_PROPERTY_SHIFT 24U 205 #define EXTI_DIRECT (0x01U << EXTI_PROPERTY_SHIFT) 206 #define EXTI_CONFIG (0x02U << EXTI_PROPERTY_SHIFT) 207 #define EXTI_GPIO ((0x04U << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG) 208 #define EXTI_RESERVED (0x08U << EXTI_PROPERTY_SHIFT) 209 #define EXTI_PROPERTY_MASK (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO) 210 211 /** 212 * @brief EXTI Register and bit usage 213 */ 214 #define EXTI_REG_SHIFT 16U 215 #define EXTI_REG1 (0x00U << EXTI_REG_SHIFT) 216 #define EXTI_REG2 (0x01U << EXTI_REG_SHIFT) 217 #define EXTI_REG_MASK (EXTI_REG1 | EXTI_REG2) 218 #define EXTI_PIN_MASK 0x0000001FU 219 220 /** 221 * @brief EXTI Mask for interrupt & event mode 222 */ 223 #define EXTI_MODE_MASK (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT) 224 225 /** 226 * @brief EXTI Mask for trigger possibilities 227 */ 228 #define EXTI_TRIGGER_MASK (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING) 229 230 /** 231 * @brief EXTI Line number 232 */ 233 #if defined(EXTI_IMR1_IM24) && defined(EXTI_IMR1_IM25) 234 #define EXTI_LINE_NB 26U 235 #else 236 #define EXTI_LINE_NB 24U 237 #endif /* defined(EXTI_IMR1_IM24) && defined(EXTI_IMR1_IM25) */ 238 239 /** 240 * @brief EXTI Mask for secure & privilege attributes 241 */ 242 #define EXTI_LINE_ATTR_SEC_MASK 0x100U 243 #define EXTI_LINE_ATTR_PRIV_MASK 0x200U 244 /** 245 * @} 246 */ 247 248 /* Private macros ------------------------------------------------------------*/ 249 /** @defgroup EXTI_Private_Macros EXTI Private Macros 250 * @{ 251 */ 252 #define IS_EXTI_LINE(__EXTI_LINE__) ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | \ 253 EXTI_REG_MASK | EXTI_PIN_MASK)) == 0x00U) \ 254 &&((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT) || \ 255 (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG) || \ 256 (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO)) && \ 257 (((__EXTI_LINE__) & (EXTI_REG_MASK | EXTI_PIN_MASK)) < \ 258 (((EXTI_LINE_NB / 32U) << EXTI_REG_SHIFT) | (EXTI_LINE_NB % 32U)))) 259 260 #define IS_EXTI_MODE(__EXTI_LINE__) ((((__EXTI_LINE__) & EXTI_MODE_MASK) != 0x00U) && \ 261 (((__EXTI_LINE__) & ~EXTI_MODE_MASK) == 0x00U)) 262 263 #define IS_EXTI_TRIGGER(__EXTI_LINE__) (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00U) 264 265 #define IS_EXTI_PENDING_EDGE(__EXTI_LINE__) (((__EXTI_LINE__) == EXTI_TRIGGER_RISING) || \ 266 ((__EXTI_LINE__) == EXTI_TRIGGER_FALLING)) 267 268 #define IS_EXTI_CONFIG_LINE(__EXTI_LINE__) (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00U) 269 270 #if defined(GPIOJ) 271 #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \ 272 ((__PORT__) == EXTI_GPIOB) || \ 273 ((__PORT__) == EXTI_GPIOC) || \ 274 ((__PORT__) == EXTI_GPIOD) || \ 275 ((__PORT__) == EXTI_GPIOE) || \ 276 ((__PORT__) == EXTI_GPIOF) || \ 277 ((__PORT__) == EXTI_GPIOG) || \ 278 ((__PORT__) == EXTI_GPIOH) || \ 279 ((__PORT__) == EXTI_GPIOI) || \ 280 ((__PORT__) == EXTI_GPIOJ)) 281 #elif defined(GPIOF) && defined (GPIOI) 282 #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \ 283 ((__PORT__) == EXTI_GPIOB) || \ 284 ((__PORT__) == EXTI_GPIOC) || \ 285 ((__PORT__) == EXTI_GPIOD) || \ 286 ((__PORT__) == EXTI_GPIOE) || \ 287 ((__PORT__) == EXTI_GPIOF) || \ 288 ((__PORT__) == EXTI_GPIOG) || \ 289 ((__PORT__) == EXTI_GPIOH) || \ 290 ((__PORT__) == EXTI_GPIOI)) 291 #else 292 #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \ 293 ((__PORT__) == EXTI_GPIOB) || \ 294 ((__PORT__) == EXTI_GPIOC) || \ 295 ((__PORT__) == EXTI_GPIOD) || \ 296 ((__PORT__) == EXTI_GPIOE) || \ 297 ((__PORT__) == EXTI_GPIOG) || \ 298 ((__PORT__) == EXTI_GPIOH)) 299 #endif /* GPIOJ */ 300 301 #define IS_EXTI_GPIO_PIN(__PIN__) ((__PIN__) < 16U) 302 303 304 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 305 306 #define IS_EXTI_LINE_ATTRIBUTES(__ATTRIBUTES__) (((((__ATTRIBUTES__) & EXTI_LINE_SEC) == EXTI_LINE_SEC) || \ 307 (((__ATTRIBUTES__) & EXTI_LINE_NSEC) == EXTI_LINE_NSEC) || \ 308 (((__ATTRIBUTES__) & EXTI_LINE_PRIV) == EXTI_LINE_PRIV) || \ 309 (((__ATTRIBUTES__) & EXTI_LINE_NPRIV) == EXTI_LINE_NPRIV)) && \ 310 (((__ATTRIBUTES__) & ~(EXTI_LINE_SEC|EXTI_LINE_NSEC|EXTI_LINE_PRIV| \ 311 EXTI_LINE_NPRIV)) == 0U)) 312 313 #else 314 315 #define IS_EXTI_LINE_ATTRIBUTES(__ATTRIBUTES__) (((((__ATTRIBUTES__) & EXTI_LINE_PRIV) == EXTI_LINE_PRIV) || \ 316 (((__ATTRIBUTES__) & EXTI_LINE_NPRIV) == EXTI_LINE_NPRIV)) && \ 317 (((__ATTRIBUTES__) & ~(EXTI_LINE_PRIV|EXTI_LINE_NPRIV)) == 0U)) 318 319 #endif /* __ARM_FEATURE_CMSE */ 320 321 /** 322 * @} 323 */ 324 325 326 /* Exported functions --------------------------------------------------------*/ 327 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions 328 * @brief EXTI Exported Functions 329 * @{ 330 */ 331 332 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions 333 * @brief Configuration functions 334 * @{ 335 */ 336 /* Configuration functions ****************************************************/ 337 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig); 338 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig); 339 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(const EXTI_HandleTypeDef *hexti); 340 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, 341 void (*pPendingCbfn)(void)); 342 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine); 343 /** 344 * @} 345 */ 346 347 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions 348 * @brief IO operation functions 349 * @{ 350 */ 351 /* IO operation functions *****************************************************/ 352 void HAL_EXTI_IRQHandler(const EXTI_HandleTypeDef *hexti); 353 uint32_t HAL_EXTI_GetPending(const EXTI_HandleTypeDef *hexti, uint32_t Edge); 354 void HAL_EXTI_ClearPending(const EXTI_HandleTypeDef *hexti, uint32_t Edge); 355 void HAL_EXTI_GenerateSWI(const EXTI_HandleTypeDef *hexti); 356 357 /** 358 * @} 359 */ 360 361 /** @addtogroup EXTI_Exported_Functions_Group3 EXTI line attributes management functions 362 * @{ 363 */ 364 365 /* EXTI line attributes management functions **********************************/ 366 void HAL_EXTI_ConfigLineAttributes(uint32_t ExtiLine, uint32_t LineAttributes); 367 HAL_StatusTypeDef HAL_EXTI_GetConfigLineAttributes(uint32_t ExtiLine, uint32_t *pLineAttributes); 368 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 369 void HAL_EXTI_LockAttributes(void); 370 uint32_t HAL_EXTI_GetLockAttributes(void); 371 #endif /* __ARM_FEATURE_CMSE */ 372 373 /** 374 * @} 375 */ 376 377 /** 378 * @} 379 */ 380 381 /** 382 * @} 383 */ 384 385 /** 386 * @} 387 */ 388 389 #ifdef __cplusplus 390 } 391 #endif 392 393 #endif /* STM32U5xx_HAL_EXTI_H */ 394
