1 /**
2   ******************************************************************************
3   * @file    stm32c0xx_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 STM32C0xx_HAL_EXTI_H
21 #define STM32C0xx_HAL_EXTI_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32c0xx_hal_def.h"
29 
30 /** @addtogroup STM32C0xx_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_RESERVED | EXTI_REG1 | 0x10U)
107 #define EXTI_LINE_17                        (EXTI_RESERVED | EXTI_REG1 | 0x11U)
108 #define EXTI_LINE_18                        (EXTI_RESERVED | EXTI_REG1 | 0x12U)
109 #define EXTI_LINE_19                        (EXTI_DIRECT   | EXTI_REG1 | 0x13U)
110 #define EXTI_LINE_20                        (EXTI_RESERVED | EXTI_REG1 | 0x14U)
111 #define EXTI_LINE_21                        (EXTI_RESERVED | EXTI_REG1 | 0x15U)
112 #define EXTI_LINE_22                        (EXTI_RESERVED | EXTI_REG1 | 0x16U)
113 #define EXTI_LINE_23                        (EXTI_DIRECT   | EXTI_REG1 | 0x17U)
114 #define EXTI_LINE_24                        (EXTI_RESERVED | EXTI_REG1 | 0x18U)
115 #define EXTI_LINE_25                        (EXTI_DIRECT   | EXTI_REG1 | 0x19U)
116 #define EXTI_LINE_26                        (EXTI_RESERVED | EXTI_REG1 | 0x1AU)
117 #define EXTI_LINE_27                        (EXTI_RESERVED | EXTI_REG1 | 0x1BU)
118 #define EXTI_LINE_28                        (EXTI_RESERVED | EXTI_REG1 | 0x1CU)
119 #define EXTI_LINE_29                        (EXTI_RESERVED | EXTI_REG1 | 0x1DU)
120 #define EXTI_LINE_30                        (EXTI_RESERVED | EXTI_REG1 | 0x1EU)
121 #define EXTI_LINE_31                        (EXTI_DIRECT   | EXTI_REG1 | 0x1FU)
122 #if defined(EXTI_IMR2_IM36)
123 #define EXTI_LINE_32                        (EXTI_RESERVED | EXTI_REG2 | 0x00U)
124 #define EXTI_LINE_33                        (EXTI_RESERVED | EXTI_REG2 | 0x01U)
125 #define EXTI_LINE_34                        (EXTI_CONFIG   | EXTI_REG2 | 0x02U)
126 #define EXTI_LINE_35                        (EXTI_RESERVED | EXTI_REG2 | 0x03U)
127 #define EXTI_LINE_36                        (EXTI_DIRECT   | EXTI_REG2 | 0x04U)
128 #endif /* EXTI_IMR2_IM36 */
129 /**
130   * @}
131   */
132 
133 /** @defgroup EXTI_Mode  EXTI Mode
134   * @{
135   */
136 #define EXTI_MODE_NONE                      0x00000000u
137 #define EXTI_MODE_INTERRUPT                 0x00000001u
138 #define EXTI_MODE_EVENT                     0x00000002u
139 /**
140   * @}
141   */
142 
143 /** @defgroup EXTI_Trigger  EXTI Trigger
144   * @{
145   */
146 #define EXTI_TRIGGER_NONE                   0x00000000u
147 #define EXTI_TRIGGER_RISING                 0x00000001u
148 #define EXTI_TRIGGER_FALLING                0x00000002u
149 #define EXTI_TRIGGER_RISING_FALLING         (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
150 /**
151   * @}
152   */
153 
154 /** @defgroup EXTI_GPIOSel  EXTI GPIOSel
155   * @brief
156   * @{
157   */
158 #define EXTI_GPIOA                          0x00000000u
159 #define EXTI_GPIOB                          0x00000001u
160 #define EXTI_GPIOC                          0x00000002u
161 #if defined(GPIOD)
162 #define EXTI_GPIOD                          0x00000003u
163 #endif /* GPIOD */
164 #define EXTI_GPIOF                          0x00000005u
165 /**
166   * @}
167   */
168 
169 /**
170   * @}
171   */
172 
173 /* Exported macro ------------------------------------------------------------*/
174 /** @defgroup EXTI_Exported_Macros EXTI Exported Macros
175   * @{
176   */
177 
178 /**
179   * @}
180   */
181 
182 /* Private constants --------------------------------------------------------*/
183 /** @defgroup EXTI_Private_Constants EXTI Private Constants
184   * @{
185   */
186 /**
187   * @brief  EXTI Line property definition
188   */
189 #define EXTI_PROPERTY_SHIFT                  24u
190 #define EXTI_DIRECT                         (0x01uL << EXTI_PROPERTY_SHIFT)
191 #define EXTI_CONFIG                         (0x02uL << EXTI_PROPERTY_SHIFT)
192 #define EXTI_GPIO                           ((0x04uL << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG)
193 #define EXTI_RESERVED                       (0x08uL << EXTI_PROPERTY_SHIFT)
194 #define EXTI_PROPERTY_MASK                  (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO)
195 
196 /**
197   * @brief  EXTI Register and bit usage
198   */
199 #define EXTI_REG_SHIFT                      16u
200 #define EXTI_REG1                           (0x00uL << EXTI_REG_SHIFT)
201 #define EXTI_REG2                           (0x01uL << EXTI_REG_SHIFT)
202 #define EXTI_REG_MASK                       (EXTI_REG1 | EXTI_REG2)
203 #define EXTI_PIN_MASK                       0x0000001Fu
204 
205 /**
206   * @brief  EXTI Mask for interrupt & event mode
207   */
208 #define EXTI_MODE_MASK                      (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
209 
210 /**
211   * @brief  EXTI Mask for trigger possibilities
212   */
213 #define EXTI_TRIGGER_MASK                   (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
214 
215 /**
216   * @brief  EXTI Line number
217   */
218 #if defined(EXTI_IMR2_IM36)
219 #define EXTI_LINE_NB                        37uL
220 #else
221 #define EXTI_LINE_NB                        32uL
222 #endif /* EXTI_IMR2_IM36 */
223 /**
224   * @}
225   */
226 
227 /* Private macros ------------------------------------------------------------*/
228 /** @defgroup EXTI_Private_Macros EXTI Private Macros
229   * @{
230   */
231 #define IS_EXTI_LINE(__EXTI_LINE__)   ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | \
232                                                              EXTI_REG_MASK | EXTI_PIN_MASK)) == 0x00U)  \
233                                        &&((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT)  || \
234                                           (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG)   || \
235                                           (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO))    && \
236                                        (((__EXTI_LINE__) & (EXTI_REG_MASK | EXTI_PIN_MASK))      < \
237                                         (((EXTI_LINE_NB / 32U) << EXTI_REG_SHIFT) | (EXTI_LINE_NB % 32U))))
238 
239 #define IS_EXTI_MODE(__EXTI_LINE__)     ((((__EXTI_LINE__) & EXTI_MODE_MASK) != 0x00U) && \
240                                          (((__EXTI_LINE__) & ~EXTI_MODE_MASK) == 0x00U))
241 
242 #define IS_EXTI_TRIGGER(__EXTI_LINE__)       (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00U)
243 
244 #define IS_EXTI_PENDING_EDGE(__EXTI_LINE__)  (((__EXTI_LINE__) == EXTI_TRIGGER_RISING) || \
245                                               ((__EXTI_LINE__) == EXTI_TRIGGER_FALLING))
246 
247 #define IS_EXTI_CONFIG_LINE(__EXTI_LINE__)   (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00U)
248 #if defined(GPIOD)
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_GPIOF))
254 #else
255 #define IS_EXTI_GPIO_PORT(__PORT__)     (((__PORT__) == EXTI_GPIOA) || \
256                                          ((__PORT__) == EXTI_GPIOB) || \
257                                          ((__PORT__) == EXTI_GPIOC) || \
258                                          ((__PORT__) == EXTI_GPIOF))
259 #endif /* GPIOD */
260 #define IS_EXTI_GPIO_PIN(__PIN__)       ((__PIN__) < 16u)
261 
262 /**
263   * @}
264   */
265 
266 
267 /* Exported functions --------------------------------------------------------*/
268 /** @defgroup EXTI_Exported_Functions EXTI Exported Functions
269   * @brief    EXTI Exported Functions
270   * @{
271   */
272 
273 /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
274   * @brief    Configuration functions
275   * @{
276   */
277 /* Configuration functions ****************************************************/
278 HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
279 HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
280 HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(const EXTI_HandleTypeDef *hexti);
281 HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID,
282                                             void (*pPendingCbfn)(void));
283 HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine);
284 /**
285   * @}
286   */
287 
288 /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
289   * @brief    IO operation functions
290   * @{
291   */
292 /* IO operation functions *****************************************************/
293 void              HAL_EXTI_IRQHandler(const EXTI_HandleTypeDef *hexti);
294 uint32_t          HAL_EXTI_GetPending(const EXTI_HandleTypeDef *hexti, uint32_t Edge);
295 void              HAL_EXTI_ClearPending(const EXTI_HandleTypeDef *hexti, uint32_t Edge);
296 void              HAL_EXTI_GenerateSWI(const EXTI_HandleTypeDef *hexti);
297 
298 /**
299   * @}
300   */
301 
302 /**
303   * @}
304   */
305 
306 /**
307   * @}
308   */
309 
310 /**
311   * @}
312   */
313 
314 #ifdef __cplusplus
315 }
316 #endif
317 
318 #endif /* STM32C0xx_HAL_EXTI_H */
319