1 /**
2   ******************************************************************************
3   * @file    stm32wlxx_hal_exti.h
4   * @author  MCD Application Team
5   * @brief   Header file of EXTI HAL module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2020 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 STM32WLxx_HAL_EXTI_H
21 #define STM32WLxx_HAL_EXTI_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32wlxx_hal_def.h"
29 
30 /** @addtogroup STM32WLxx_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 } EXTI_CallbackIDTypeDef;
48 
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     | EXTI_EVENT | EXTI_REG1 | 0x00u)
88 #define EXTI_LINE_1                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x01u)
89 #define EXTI_LINE_2                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x02u)
90 #define EXTI_LINE_3                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x03u)
91 #define EXTI_LINE_4                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x04u)
92 #define EXTI_LINE_5                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x05u)
93 #define EXTI_LINE_6                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x06u)
94 #define EXTI_LINE_7                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x07u)
95 #define EXTI_LINE_8                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x08u)
96 #define EXTI_LINE_9                         (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x09u)
97 #define EXTI_LINE_10                        (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x0Au)
98 #define EXTI_LINE_11                        (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x0Bu)
99 #define EXTI_LINE_12                        (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x0Cu)
100 #define EXTI_LINE_13                        (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x0Du)
101 #define EXTI_LINE_14                        (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x0Eu)
102 #define EXTI_LINE_15                        (EXTI_GPIO     | EXTI_EVENT | EXTI_REG1 | 0x0Fu)
103 #define EXTI_LINE_16                        (EXTI_CONFIG   |              EXTI_REG1 | 0x10u)
104 #define EXTI_LINE_17                        (EXTI_DIRECT   | EXTI_EVENT | EXTI_REG1 | 0x11u)
105 #define EXTI_LINE_18                        (EXTI_DIRECT   | EXTI_EVENT | EXTI_REG1 | 0x12u)
106 #define EXTI_LINE_19                        (EXTI_DIRECT   | EXTI_EVENT | EXTI_REG1 | 0x13u)
107 #define EXTI_LINE_20                        (EXTI_DIRECT   | EXTI_EVENT | EXTI_REG1 | 0x14u)
108 #define EXTI_LINE_21                        (EXTI_CONFIG   | EXTI_EVENT | EXTI_REG1 | 0x15u)
109 #define EXTI_LINE_22                        (EXTI_CONFIG   | EXTI_EVENT | EXTI_REG1 | 0x16u)
110 #define EXTI_LINE_23                        (EXTI_DIRECT   |              EXTI_REG1 | 0x17u)
111 #define EXTI_LINE_24                        (EXTI_DIRECT   |              EXTI_REG1 | 0x18u)
112 #define EXTI_LINE_25                        (EXTI_DIRECT   |              EXTI_REG1 | 0x19u)
113 #define EXTI_LINE_26                        (EXTI_DIRECT   |              EXTI_REG1 | 0x1Au)
114 #define EXTI_LINE_27                        (EXTI_DIRECT   |              EXTI_REG1 | 0x1Bu)
115 #define EXTI_LINE_28                        (EXTI_DIRECT   |              EXTI_REG1 | 0x1Cu)
116 #define EXTI_LINE_29                        (EXTI_DIRECT   |              EXTI_REG1 | 0x1Du)
117 #define EXTI_LINE_30                        (EXTI_DIRECT   |              EXTI_REG1 | 0x1Eu)
118 #define EXTI_LINE_31                        (EXTI_DIRECT   |              EXTI_REG1 | 0x1Fu)
119 #define EXTI_LINE_32                        (EXTI_RESERVED |              EXTI_REG2 | 0x00u)
120 #define EXTI_LINE_33                        (EXTI_RESERVED |              EXTI_REG2 | 0x01u)
121 #define EXTI_LINE_34                        (EXTI_CONFIG   |              EXTI_REG2 | 0x02u)
122 #define EXTI_LINE_35                        (EXTI_RESERVED |              EXTI_REG2 | 0x03u)
123 #if defined (DUAL_CORE)
124 #define EXTI_LINE_36                        (EXTI_DIRECT   |              EXTI_REG2 | 0x04u)
125 #define EXTI_LINE_37                        (EXTI_DIRECT   |              EXTI_REG2 | 0x05u)
126 #else
127 #define EXTI_LINE_36                        (EXTI_RESERVED |              EXTI_REG2 | 0x04u)
128 #define EXTI_LINE_37                        (EXTI_RESERVED |              EXTI_REG2 | 0x05u)
129 #endif /* DUAL_CORE */
130 #define EXTI_LINE_38                        (EXTI_DIRECT   |              EXTI_REG2 | 0x06u)
131 #if defined (DUAL_CORE)
132 #define EXTI_LINE_39                        (EXTI_DIRECT   |              EXTI_REG2 | 0x07u)
133 #define EXTI_LINE_40                        (EXTI_CONFIG   | EXTI_EVENT | EXTI_REG2 | 0x08u)
134 #define EXTI_LINE_41                        (EXTI_CONFIG   | EXTI_EVENT | EXTI_REG2 | 0x09u)
135 #else
136 #define EXTI_LINE_39                        (EXTI_RESERVED |              EXTI_REG2 | 0x07u)
137 #define EXTI_LINE_40                        (EXTI_RESERVED |              EXTI_REG2 | 0x08u)
138 #define EXTI_LINE_41                        (EXTI_RESERVED |              EXTI_REG2 | 0x09u)
139 #endif /* DUAL_CORE */
140 #define EXTI_LINE_42                        (EXTI_DIRECT   |              EXTI_REG2 | 0x0Au)
141 #define EXTI_LINE_43                        (EXTI_DIRECT   |              EXTI_REG2 | 0x0Bu)
142 #define EXTI_LINE_44                        (EXTI_DIRECT   |              EXTI_REG2 | 0x0Cu)
143 #define EXTI_LINE_45                        (EXTI_CONFIG   |              EXTI_REG2 | 0x0Du)
144 #define EXTI_LINE_46                        (EXTI_DIRECT   |              EXTI_REG2 | 0x0Eu)
145 /**
146   * @}
147   */
148 
149 /** @defgroup EXTI_Mode  EXTI Mode
150   * @{
151   */
152 #define EXTI_MODE_NONE                      0x00000000u
153 #define EXTI_MODE_INTERRUPT                 0x00000001u
154 #define EXTI_MODE_EVENT                     0x00000002u
155 /**
156   * @}
157   */
158 
159 /** @defgroup EXTI_Trigger  EXTI Trigger
160   * @{
161   */
162 #define EXTI_TRIGGER_NONE                   0x00000000u
163 #define EXTI_TRIGGER_RISING                 0x00000001u
164 #define EXTI_TRIGGER_FALLING                0x00000002u
165 #define EXTI_TRIGGER_RISING_FALLING         (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
166 /**
167   * @}
168   */
169 
170 /** @defgroup EXTI_GPIOSel  EXTI GPIOSel
171   * @brief
172   * @{
173   */
174 #define EXTI_GPIOA                          0x00000000u
175 #define EXTI_GPIOB                          0x00000001u
176 #define EXTI_GPIOC                          0x00000002u
177 #define EXTI_GPIOH                          0x00000007u
178 /**
179   * @}
180   */
181 
182 /**
183   * @}
184   */
185 
186 /* Exported macro ------------------------------------------------------------*/
187 /** @defgroup EXTI_Exported_Macros EXTI Exported Macros
188   * @{
189   */
190 
191 /**
192   * @}
193   */
194 
195 /* Private constants --------------------------------------------------------*/
196 /** @defgroup EXTI_Private_Constants EXTI Private Constants
197   * @{
198   */
199 /**
200   * @brief  EXTI Line property definition
201   */
202 #define EXTI_PROPERTY_SHIFT                 24u
203 #define EXTI_DIRECT                         (0x01uL << EXTI_PROPERTY_SHIFT)
204 #define EXTI_CONFIG                         (0x02uL << EXTI_PROPERTY_SHIFT)
205 #define EXTI_GPIO                           ((0x04uL << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG)
206 #define EXTI_RESERVED                       (0x08uL << EXTI_PROPERTY_SHIFT)
207 #define EXTI_PROPERTY_MASK                  (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO)
208 
209 /**
210   * @brief  EXTI Event presence definition
211   */
212 #define EXTI_EVENT_PRESENCE_SHIFT           28u
213 #define EXTI_EVENT_PRESENCE_MASK           (0x01uL << EXTI_EVENT_PRESENCE_SHIFT)
214 #define EXTI_EVENT                          EXTI_EVENT_PRESENCE_MASK
215 
216 /**
217   * @brief  EXTI Register and bit usage
218   */
219 #define EXTI_REG_SHIFT                      16u
220 #define EXTI_REG1                           (0x00uL << EXTI_REG_SHIFT)
221 #define EXTI_REG2                           (0x01uL << EXTI_REG_SHIFT)
222 #define EXTI_REG_MASK                       (EXTI_REG1 | EXTI_REG2)
223 #define EXTI_PIN_MASK                       0x0000001Fu
224 
225 /**
226   * @brief  EXTI Mask for interrupt & event mode
227   */
228 #define EXTI_MODE_MASK                      (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
229 
230 /**
231   * @brief  EXTI Mask for trigger possibilities
232   */
233 #define EXTI_TRIGGER_MASK                   (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
234 
235 /**
236   * @brief  EXTI Line number
237   */
238 #define EXTI_LINE_NB                        47uL
239 
240 /**
241   * @}
242   */
243 
244 /* Private macros ------------------------------------------------------------*/
245 /** @defgroup EXTI_Private_Macros EXTI Private Macros
246   * @{
247   */
248 #define IS_EXTI_LINE(__EXTI_LINE__)          ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_EVENT_PRESENCE_MASK | EXTI_REG_MASK | EXTI_PIN_MASK)) == 0x00u) && \
249                                               ((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT)   || \
250                                                (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG)   || \
251                                                (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO))    && \
252                                               (((__EXTI_LINE__) & (EXTI_REG_MASK | EXTI_PIN_MASK))      < \
253                                                (((EXTI_LINE_NB / 32u) << EXTI_REG_SHIFT) | (EXTI_LINE_NB % 32u))))
254 
255 #define IS_EXTI_MODE(__EXTI_LINE__)          ((((__EXTI_LINE__) & EXTI_MODE_MASK) != 0x00u) && \
256                                               (((__EXTI_LINE__) & ~EXTI_MODE_MASK) == 0x00u))
257 
258 #define IS_EXTI_TRIGGER(__EXTI_LINE__)       (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00u)
259 
260 #define IS_EXTI_PENDING_EDGE(__EXTI_LINE__)  ((__EXTI_LINE__) == EXTI_TRIGGER_RISING_FALLING)
261 
262 #define IS_EXTI_CONFIG_LINE(__EXTI_LINE__)   (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00u)
263 
264 #define IS_EXTI_EVENT_PRESENT(__EXTI_LINE__) (((__EXTI_LINE__) & EXTI_EVENT) != 0x00u)
265 
266 #define IS_EXTI_GPIO_PORT(__PORT__)     (((__PORT__) == EXTI_GPIOA) || \
267                                          ((__PORT__) == EXTI_GPIOB) || \
268                                          ((__PORT__) == EXTI_GPIOC) || \
269                                          ((__PORT__) == EXTI_GPIOH))
270 
271 #define IS_EXTI_GPIO_PIN(__PIN__)       ((__PIN__) < 16u)
272 /**
273   * @}
274   */
275 
276 
277 /* Exported functions --------------------------------------------------------*/
278 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions
279   * @brief    EXTI Exported Functions
280   * @{
281   */
282 
283 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
284   * @brief    Configuration functions
285   * @{
286   */
287 /* Configuration functions ****************************************************/
288 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
289 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
290 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti);
291 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, void (*pPendingCbfn)(void));
292 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine);
293 /**
294   * @}
295   */
296 
297 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
298   * @brief    IO operation functions
299   * @{
300   */
301 /* IO operation functions *****************************************************/
302 void              HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti);
303 uint32_t          HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
304 void              HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
305 void              HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti);
306 
307 /**
308   * @}
309   */
310 
311 /**
312   * @}
313   */
314 
315 /**
316   * @}
317   */
318 
319 /**
320   * @}
321   */
322 
323 #ifdef __cplusplus
324 }
325 #endif
326 
327 #endif /* STM32WLxx_HAL_EXTI_H */
328