1 /**
2   ******************************************************************************
3   * @file    stm32u0xx_hal_exti.h
4   * @author  MCD Application Team
5   * @brief   Header file of EXTI HAL module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2023 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 STM32U0xx_HAL_EXTI_H
21 #define STM32U0xx_HAL_EXTI_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32u0xx_hal_def.h"
29 
30 /** @addtogroup STM32U0xx_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   * @brief  EXTI Handle structure definition
53   */
54 typedef struct
55 {
56   uint32_t Line;                    /*!<  Exti line number */
57   void (* RisingCallback)(void);    /*!<  Exti rising callback */
58   void (* FallingCallback)(void);   /*!<  Exti falling callback */
59 } EXTI_HandleTypeDef;
60 
61 /**
62   * @brief  EXTI Configuration structure definition
63   */
64 typedef struct
65 {
66   uint32_t Line;      /*!< The Exti line to be configured. This parameter
67                            can be a value of @ref EXTI_Line */
68   uint32_t Mode;      /*!< The Exit Mode to be configured for a core.
69                            This parameter can be a combination of @ref EXTI_Mode */
70   uint32_t Trigger;   /*!< The Exti Trigger to be configured. This parameter
71                            can be a value of @ref EXTI_Trigger */
72   uint32_t GPIOSel;   /*!< The Exti GPIO multiplexer selection to be configured.
73                            This parameter is only possible for line 0 to 15. It
74                            can be a value of @ref EXTI_GPIOSel */
75 } EXTI_ConfigTypeDef;
76 
77 /**
78   * @}
79   */
80 
81 /* Exported constants --------------------------------------------------------*/
82 /** @defgroup EXTI_Exported_Constants EXTI Exported Constants
83   * @{
84   */
85 
86 /** @defgroup EXTI_Line  EXTI Line
87   * @{
88   */
89 #define EXTI_LINE_0                         (EXTI_GPIO     | EXTI_REG1 | 0x00U)
90 #define EXTI_LINE_1                         (EXTI_GPIO     | EXTI_REG1 | 0x01U)
91 #define EXTI_LINE_2                         (EXTI_GPIO     | EXTI_REG1 | 0x02U)
92 #define EXTI_LINE_3                         (EXTI_GPIO     | EXTI_REG1 | 0x03U)
93 #define EXTI_LINE_4                         (EXTI_GPIO     | EXTI_REG1 | 0x04U)
94 #define EXTI_LINE_5                         (EXTI_GPIO     | EXTI_REG1 | 0x05U)
95 #define EXTI_LINE_6                         (EXTI_GPIO     | EXTI_REG1 | 0x06U)
96 #define EXTI_LINE_7                         (EXTI_GPIO     | EXTI_REG1 | 0x07U)
97 #define EXTI_LINE_8                         (EXTI_GPIO     | EXTI_REG1 | 0x08U)
98 #define EXTI_LINE_9                         (EXTI_GPIO     | EXTI_REG1 | 0x09U)
99 #define EXTI_LINE_10                        (EXTI_GPIO     | EXTI_REG1 | 0x0AU)
100 #define EXTI_LINE_11                        (EXTI_GPIO     | EXTI_REG1 | 0x0BU)
101 #define EXTI_LINE_12                        (EXTI_GPIO     | EXTI_REG1 | 0x0CU)
102 #define EXTI_LINE_13                        (EXTI_GPIO     | EXTI_REG1 | 0x0DU)
103 #define EXTI_LINE_14                        (EXTI_GPIO     | EXTI_REG1 | 0x0EU)
104 #define EXTI_LINE_15                        (EXTI_GPIO     | EXTI_REG1 | 0x0FU)
105 #define EXTI_LINE_16                        (EXTI_CONFIG   | EXTI_REG1 | 0x10U)
106 #define EXTI_LINE_17                        (EXTI_CONFIG   | EXTI_REG1 | 0x11U)
107 #if defined(EXTI_IMR1_IM18)
108 #define EXTI_LINE_18                        (EXTI_CONFIG   | EXTI_REG1 | 0x12U)
109 #endif /* EXTI_IMR1_IM18 */
110 #if defined(EXTI_IMR1_IM19)
111 #define EXTI_LINE_19                        (EXTI_CONFIG   | EXTI_REG1 | 0x13U)
112 #endif /* EXTI_IMR1_IM19 */
113 #define EXTI_LINE_20                        (EXTI_CONFIG   | EXTI_REG1 | 0x14U)
114 #define EXTI_LINE_21                        (EXTI_CONFIG   | EXTI_REG1 | 0x15U)
115 #if defined(EXTI_IMR1_IM22)
116 #define EXTI_LINE_22                        (EXTI_DIRECT   | EXTI_REG1 | 0x16U)
117 #endif /* EXTI_IMR1_IM22 */
118 #define EXTI_LINE_23                        (EXTI_DIRECT   | EXTI_REG1 | 0x17U)
119 #define EXTI_LINE_24                        (EXTI_DIRECT   | EXTI_REG1 | 0x18U)
120 #define EXTI_LINE_25                        (EXTI_DIRECT   | EXTI_REG1 | 0x19U)
121 #if defined(EXTI_IMR1_IM26)
122 #define EXTI_LINE_26                        (EXTI_DIRECT   | EXTI_REG1 | 0x1AU)
123 #endif /* EXTI_IMR1_IM26 */
124 #define EXTI_LINE_27                        (EXTI_DIRECT   | EXTI_REG1 | 0x1BU)
125 #define EXTI_LINE_28                        (EXTI_DIRECT   | EXTI_REG1 | 0x1CU)
126 #define EXTI_LINE_29                        (EXTI_DIRECT   | EXTI_REG1 | 0x1DU)
127 #define EXTI_LINE_30                        (EXTI_DIRECT   | EXTI_REG1 | 0x1EU)
128 #define EXTI_LINE_31                        (EXTI_DIRECT   | EXTI_REG1 | 0x1FU)
129 #if defined(EXTI_IMR2_IM32)
130 #define EXTI_LINE_32                        (EXTI_DIRECT   | EXTI_REG2 | 0x00U)
131 #endif /* EXTI_IMR2_IM32 */
132 #define EXTI_LINE_33                        (EXTI_DIRECT   | EXTI_REG2 | 0x01U)
133 #define EXTI_LINE_34                        (EXTI_DIRECT   | EXTI_REG2 | 0x02U)
134 #define EXTI_LINE_35                        (EXTI_DIRECT   | EXTI_REG2 | 0x03U)
135 #if defined(EXTI_IMR2_IM36)
136 #define EXTI_LINE_36                        (EXTI_DIRECT   | EXTI_REG2 | 0x04U)
137 #endif /* EXTI_IMR2_IM36 */
138 #define EXTI_LINE_37                        (EXTI_DIRECT   | EXTI_REG2 | 0x05U)
139 /**
140   * @}
141   */
142 
143 /** @defgroup EXTI_Mode  EXTI Mode
144   * @{
145   */
146 #define EXTI_MODE_NONE                      0x00000000U
147 #define EXTI_MODE_INTERRUPT                 0x00000001U
148 #define EXTI_MODE_EVENT                     0x00000002U
149 /**
150   * @}
151   */
152 
153 /** @defgroup EXTI_Trigger  EXTI Trigger
154   * @{
155   */
156 #define EXTI_TRIGGER_NONE                   0x00000000U
157 #define EXTI_TRIGGER_RISING                 0x00000001U
158 #define EXTI_TRIGGER_FALLING                0x00000002U
159 #define EXTI_TRIGGER_RISING_FALLING         (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
160 /**
161   * @}
162   */
163 
164 /** @defgroup EXTI_GPIOSel  EXTI GPIOSel
165   * @brief
166   * @{
167   */
168 #define EXTI_GPIOA                          0x00000000U
169 #define EXTI_GPIOB                          0x00000001U
170 #define EXTI_GPIOC                          0x00000002U
171 #define EXTI_GPIOD                          0x00000003U
172 #if defined(GPIOE)
173 #define EXTI_GPIOE                          0x00000004U
174 #endif /* GPIOE */
175 #define EXTI_GPIOF                          0x00000005U
176 /**
177   * @}
178   */
179 
180 /**
181   * @}
182   */
183 
184 /* Exported macro ------------------------------------------------------------*/
185 /** @defgroup EXTI_Exported_Macros EXTI Exported Macros
186   * @{
187   */
188 
189 /**
190   * @}
191   */
192 
193 /* Private constants --------------------------------------------------------*/
194 /** @defgroup EXTI_Private_Constants EXTI Private Constants
195   * @{
196   */
197 /**
198   * @brief  EXTI Line property definition
199   */
200 #define EXTI_PROPERTY_SHIFT                  24U
201 #define EXTI_DIRECT                         (0x01U << EXTI_PROPERTY_SHIFT)
202 #define EXTI_CONFIG                         (0x02U << EXTI_PROPERTY_SHIFT)
203 #define EXTI_GPIO                           ((0x04U << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG)
204 #define EXTI_RESERVED                       (0x08U << EXTI_PROPERTY_SHIFT)
205 #define EXTI_PROPERTY_MASK                  (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO)
206 
207 /**
208   * @brief  EXTI Register and bit usage
209   */
210 #define EXTI_REG_SHIFT                      16U
211 #define EXTI_REG1                           (0x00U << EXTI_REG_SHIFT)
212 #define EXTI_REG2                           (0x01U << EXTI_REG_SHIFT)
213 #define EXTI_REG_MASK                       (EXTI_REG1 | EXTI_REG2)
214 #define EXTI_PIN_MASK                       0x0000001FU
215 
216 /**
217   * @brief  EXTI Mask for interrupt & event mode
218   */
219 #define EXTI_MODE_MASK                      (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
220 
221 /**
222   * @brief  EXTI Mask for trigger possibilities
223   */
224 #define EXTI_TRIGGER_MASK                   (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
225 
226 /**
227   * @brief  EXTI Line number
228   */
229 #define EXTI_LINE_NB                        38U
230 
231 /**
232   * @}
233   */
234 
235 /* Private macros ------------------------------------------------------------*/
236 /** @defgroup EXTI_Private_Macros EXTI Private Macros
237   * @{
238   */
239 #define IS_EXTI_LINE(__LINE__)    ((((__LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_REG_MASK | EXTI_PIN_MASK)) == 0x00U) && \
240                                    ((((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT)   || \
241                                     (((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG)   || \
242                                     (((__LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO))    && \
243                                    (((__LINE__) & (EXTI_REG_MASK | EXTI_PIN_MASK))      <   \
244                                     (((EXTI_LINE_NB / 32) << EXTI_REG_SHIFT) | (EXTI_LINE_NB % 32))))
245 
246 #define IS_EXTI_MODE(__LINE__)          ((((__LINE__) & EXTI_MODE_MASK) != 0x00U) && \
247                                          (((__LINE__) & ~EXTI_MODE_MASK) == 0x00U))
248 
249 #define IS_EXTI_TRIGGER(__LINE__)       (((__LINE__) & ~EXTI_TRIGGER_MASK) == 0x00U)
250 
251 #define IS_EXTI_PENDING_EDGE(__LINE__)  (((__LINE__) == EXTI_TRIGGER_RISING) || \
252                                          ((__LINE__) == EXTI_TRIGGER_FALLING))
253 
254 #define IS_EXTI_CONFIG_LINE(__LINE__)   (((__LINE__) & EXTI_CONFIG) != 0x00U)
255 #if defined(GPIOE)
256 #define IS_EXTI_GPIO_PORT(__PORT__)     (((__PORT__) == EXTI_GPIOA) || \
257                                          ((__PORT__) == EXTI_GPIOB) || \
258                                          ((__PORT__) == EXTI_GPIOC) || \
259                                          ((__PORT__) == EXTI_GPIOD) || \
260                                          ((__PORT__) == EXTI_GPIOE) || \
261                                          ((__PORT__) == EXTI_GPIOF))
262 #else
263 #define IS_EXTI_GPIO_PORT(__PORT__)     (((__PORT__) == EXTI_GPIOA) || \
264                                          ((__PORT__) == EXTI_GPIOB) || \
265                                          ((__PORT__) == EXTI_GPIOC) || \
266                                          ((__PORT__) == EXTI_GPIOD) || \
267                                          ((__PORT__) == EXTI_GPIOF))
268 #endif /* GPIOE */
269 #define IS_EXTI_GPIO_PIN(__PIN__)       ((__PIN__) < 16U)
270 
271 /**
272   * @}
273   */
274 
275 /* Exported functions --------------------------------------------------------*/
276 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions
277   * @brief    EXTI Exported Functions
278   * @{
279   */
280 
281 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
282   * @brief    Configuration functions
283   * @{
284   */
285 /* Configuration functions ****************************************************/
286 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
287 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
288 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti);
289 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID,
290                                             void (*pPendingCbfn)(void));
291 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine);
292 /**
293   * @}
294   */
295 
296 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
297   * @brief    IO operation functions
298   * @{
299   */
300 /* IO operation functions *****************************************************/
301 void              HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti);
302 uint32_t          HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
303 void              HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
304 void              HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti);
305 
306 /**
307   * @}
308   */
309 
310 /**
311   * @}
312   */
313 
314 /**
315   * @}
316   */
317 
318 /**
319   * @}
320   */
321 
322 #ifdef __cplusplus
323 }
324 #endif
325 
326 #endif /* STM32U0xx_HAL_EXTI_H */
327