1 /** 2 ****************************************************************************** 3 * @file stm32wbaxx_hal_exti.h 4 * @author MCD Application Team 5 * @brief Header file of EXTI HAL module. 6 ****************************************************************************** 7 * @attention 8 * 9 * Copyright (c) 2022 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 STM32WBAxx_HAL_EXTI_H 21 #define STM32WBAxx_HAL_EXTI_H 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 /* Includes ------------------------------------------------------------------*/ 28 #include "stm32wbaxx_hal_def.h" 29 30 /** @addtogroup STM32WBAxx_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 #if defined(COMP1) 108 #define EXTI_LINE_17 (EXTI_CONFIG | EXTI_REG1 | 0x11U) 109 #endif /* COMP1 */ 110 #if defined(COMP2) 111 #define EXTI_LINE_18 (EXTI_CONFIG | EXTI_REG1 | 0x12U) 112 #endif /* COMP2 */ 113 /** 114 * @} 115 */ 116 117 /** @defgroup EXTI_Mode EXTI Mode 118 * @{ 119 */ 120 #define EXTI_MODE_NONE 0x00000000U 121 #define EXTI_MODE_INTERRUPT 0x00000001U 122 #define EXTI_MODE_EVENT 0x00000002U 123 /** 124 * @} 125 */ 126 127 /** @defgroup EXTI_Trigger EXTI Trigger 128 * @{ 129 */ 130 #define EXTI_TRIGGER_NONE 0x00000000U 131 #define EXTI_TRIGGER_RISING 0x00000001U 132 #define EXTI_TRIGGER_FALLING 0x00000002U 133 #define EXTI_TRIGGER_RISING_FALLING (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING) 134 /** 135 * @} 136 */ 137 138 /** @defgroup EXTI_GPIOSel EXTI GPIOSel 139 * @brief 140 * @{ 141 */ 142 #define EXTI_GPIOA 0x00000000U 143 #define EXTI_GPIOB 0x00000001U 144 #define EXTI_GPIOC 0x00000002U 145 #define EXTI_GPIOH 0x00000007U 146 /** 147 * @} 148 */ 149 150 #if defined(EXTI_SECCFGR1_SEC0) 151 /** @defgroup EXTI_Line_attributes EXTI line attributes 152 * @brief EXTI line secure or non-secure and privileged or non-privileged attributes 153 * @note secure and non-secure attributes are only available from secure state when the system 154 * implement the security (TZEN=1) 155 * @{ 156 */ 157 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 158 #define EXTI_LINE_SEC (EXTI_LINE_ATTR_SEC_MASK | 0x00000001U) /*!< Secure line attribute */ 159 #define EXTI_LINE_NSEC (EXTI_LINE_ATTR_SEC_MASK | 0x00000000U) /*!< Non-secure line attribute */ 160 #endif /* __ARM_FEATURE_CMSE */ 161 #define EXTI_LINE_PRIV (EXTI_LINE_ATTR_PRIV_MASK | 0x00000002U) /*!< Privileged line attribute */ 162 #define EXTI_LINE_NPRIV (EXTI_LINE_ATTR_PRIV_MASK | 0x00000000U) /*!< Non-privileged line attribute */ 163 /** 164 * @} 165 */ 166 #endif /* #if defined(EXTI_SECCFGR1_SEC0) */ 167 168 /** 169 * @} 170 */ 171 172 /* Exported macro ------------------------------------------------------------*/ 173 /* Private constants --------------------------------------------------------*/ 174 /** @defgroup EXTI_Private_Constants EXTI Private Constants 175 * @{ 176 */ 177 /** 178 * @brief EXTI Line property definition 179 */ 180 #define EXTI_PROPERTY_SHIFT 24U 181 #define EXTI_DIRECT (0x01U << EXTI_PROPERTY_SHIFT) 182 #define EXTI_CONFIG (0x02U << EXTI_PROPERTY_SHIFT) 183 #define EXTI_GPIO ((0x04U << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG) 184 #define EXTI_RESERVED (0x08U << EXTI_PROPERTY_SHIFT) 185 #define EXTI_PROPERTY_MASK (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO) 186 187 /** 188 * @brief EXTI Register and bit usage 189 */ 190 #define EXTI_REG_SHIFT 16U 191 #define EXTI_REG1 (0x00U << EXTI_REG_SHIFT) 192 #define EXTI_REG2 (0x01U << EXTI_REG_SHIFT) 193 #define EXTI_REG_MASK (EXTI_REG1 | EXTI_REG2) 194 #define EXTI_PIN_MASK 0x0000001FU 195 196 /** 197 * @brief EXTI Mask for interrupt & event mode 198 */ 199 #define EXTI_MODE_MASK (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT) 200 201 /** 202 * @brief EXTI Mask for trigger possibilities 203 */ 204 #define EXTI_TRIGGER_MASK (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING) 205 206 /** 207 * @brief EXTI Line number 208 */ 209 #define EXTI_LINE_NB 18U 210 211 #if defined(EXTI_SECCFGR1_SEC0) 212 /** 213 * @brief EXTI Mask for secure & privilege attributes 214 */ 215 #define EXTI_LINE_ATTR_SEC_MASK 0x100U 216 #define EXTI_LINE_ATTR_PRIV_MASK 0x200U 217 /** 218 * @} 219 */ 220 #endif /* #if defined(EXTI_SECCFGR1_SEC0) */ 221 222 /* Private macros ------------------------------------------------------------*/ 223 /** @defgroup EXTI_Private_Macros EXTI Private Macros 224 * @{ 225 */ 226 #define IS_EXTI_LINE(__LINE__) ((((__LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_REG_MASK | EXTI_PIN_MASK)) == 0x00U) && \ 227 ((((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT) || \ 228 (((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG) || \ 229 (((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO)) && \ 230 (((__LINE__) & (EXTI_REG_MASK | EXTI_PIN_MASK)) < \ 231 (((EXTI_LINE_NB / 32U) << EXTI_REG_SHIFT) | (EXTI_LINE_NB % 32U)))) 232 233 #define IS_EXTI_MODE(__LINE__) ((((__LINE__) & EXTI_MODE_MASK) != 0x00U) && \ 234 (((__LINE__) & ~EXTI_MODE_MASK) == 0x00U)) 235 236 #define IS_EXTI_TRIGGER(__LINE__) (((__LINE__) & ~EXTI_TRIGGER_MASK) == 0x00U) 237 238 #define IS_EXTI_PENDING_EDGE(__LINE__) (((__LINE__) == EXTI_TRIGGER_RISING) || \ 239 ((__LINE__) == EXTI_TRIGGER_FALLING)) 240 241 #define IS_EXTI_CONFIG_LINE(__LINE__) (((__LINE__) & EXTI_CONFIG) != 0x00U) 242 243 #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \ 244 ((__PORT__) == EXTI_GPIOB) || \ 245 ((__PORT__) == EXTI_GPIOC) || \ 246 ((__PORT__) == EXTI_GPIOH)) 247 248 #define IS_EXTI_GPIO_PIN(__PIN__) ((__PIN__) < 16U) 249 250 #if defined(EXTI_SECCFGR1_SEC0) 251 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 252 253 #define IS_EXTI_LINE_ATTRIBUTES(__ATTRIBUTES__) (((((__ATTRIBUTES__) & EXTI_LINE_SEC) == EXTI_LINE_SEC) || \ 254 (((__ATTRIBUTES__) & EXTI_LINE_NSEC) == EXTI_LINE_NSEC) || \ 255 (((__ATTRIBUTES__) & EXTI_LINE_PRIV) == EXTI_LINE_PRIV) || \ 256 (((__ATTRIBUTES__) & EXTI_LINE_NPRIV) == EXTI_LINE_NPRIV)) && \ 257 (((__ATTRIBUTES__) & ~(EXTI_LINE_SEC|EXTI_LINE_NSEC|EXTI_LINE_PRIV|EXTI_LINE_NPRIV)) == 0U)) 258 259 #else 260 261 #define IS_EXTI_LINE_ATTRIBUTES(__ATTRIBUTES__) (((((__ATTRIBUTES__) & EXTI_LINE_PRIV) == EXTI_LINE_PRIV) || \ 262 (((__ATTRIBUTES__) & EXTI_LINE_NPRIV) == EXTI_LINE_NPRIV)) && \ 263 (((__ATTRIBUTES__) & ~(EXTI_LINE_PRIV|EXTI_LINE_NPRIV)) == 0U)) 264 265 #endif /* __ARM_FEATURE_CMSE */ 266 #endif /* #if defined(EXTI_SECCFGR1_SEC0) */ 267 268 /** 269 * @} 270 */ 271 272 273 /* Exported functions --------------------------------------------------------*/ 274 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions 275 * @brief EXTI Exported Functions 276 * @{ 277 */ 278 279 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions 280 * @brief Configuration functions 281 * @{ 282 */ 283 /* Configuration functions ****************************************************/ 284 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig); 285 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig); 286 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(const EXTI_HandleTypeDef *hexti); 287 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, void (*pPendingCbfn)(void)); 288 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine); 289 /** 290 * @} 291 */ 292 293 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions 294 * @brief IO operation functions 295 * @{ 296 */ 297 /* IO operation functions *****************************************************/ 298 void HAL_EXTI_IRQHandler(const EXTI_HandleTypeDef *hexti); 299 uint32_t HAL_EXTI_GetPending(const EXTI_HandleTypeDef *hexti, uint32_t Edge); 300 void HAL_EXTI_ClearPending(const EXTI_HandleTypeDef *hexti, uint32_t Edge); 301 void HAL_EXTI_GenerateSWI(const EXTI_HandleTypeDef *hexti); 302 303 /** 304 * @} 305 */ 306 307 /** @addtogroup EXTI_Exported_Functions_Group3 EXTI line attributes management functions 308 * @{ 309 */ 310 311 #if defined(EXTI_SECCFGR1_SEC0) 312 /* EXTI line attributes management functions **********************************/ 313 void HAL_EXTI_ConfigLineAttributes(uint32_t ExtiLine, uint32_t LineAttributes); 314 HAL_StatusTypeDef HAL_EXTI_GetConfigLineAttributes(uint32_t ExtiLine, uint32_t *pLineAttributes); 315 #endif /* #if defined(EXTI_SECCFGR1_SEC0) */ 316 #if defined (__ARM_FEATURE_CMSE) && (__ARM_FEATURE_CMSE == 3U) 317 void HAL_EXTI_LockAttributes(void); 318 uint32_t HAL_EXTI_GetLockAttributes(void); 319 #endif /* __ARM_FEATURE_CMSE */ 320 321 /** 322 * @} 323 */ 324 325 /** 326 * @} 327 */ 328 329 /** 330 * @} 331 */ 332 333 /** 334 * @} 335 */ 336 337 /** 338 * @} 339 */ 340 341 #ifdef __cplusplus 342 } 343 #endif 344 345 #endif /* STM32WBAxx_HAL_EXTI_H */ 346 347
