VSF Documented
sthal_exti.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2024 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __ST_HAL_EXTI_H__
19#define __ST_HAL_EXTI_H__
20
21#ifdef __cplusplus
22extern "C" {
23#endif
24
25#if (VSF_HAL_USE_GPIO == ENABLED) && defined(HAL_EXTI_MODULE_ENABLED)
26
27/*============================ INCLUDES ======================================*/
28
29#include "sthal_def.h"
30
31/*============================ MACROS ========================================*/
32
33#define EXTI_LINE_0 (EXTI_GPIO | 0x00u)
34#define EXTI_LINE_1 (EXTI_GPIO | 0x01u)
35#define EXTI_LINE_2 (EXTI_GPIO | 0x02u)
36#define EXTI_LINE_3 (EXTI_GPIO | 0x03u)
37#define EXTI_LINE_4 (EXTI_GPIO | 0x04u)
38#define EXTI_LINE_5 (EXTI_GPIO | 0x05u)
39#define EXTI_LINE_6 (EXTI_GPIO | 0x06u)
40#define EXTI_LINE_7 (EXTI_GPIO | 0x07u)
41#define EXTI_LINE_8 (EXTI_GPIO | 0x08u)
42#define EXTI_LINE_9 (EXTI_GPIO | 0x09u)
43#define EXTI_LINE_10 (EXTI_GPIO | 0x0Au)
44#define EXTI_LINE_11 (EXTI_GPIO | 0x0Bu)
45#define EXTI_LINE_12 (EXTI_GPIO | 0x0Cu)
46#define EXTI_LINE_13 (EXTI_GPIO | 0x0Du)
47#define EXTI_LINE_14 (EXTI_GPIO | 0x0Eu)
48#define EXTI_LINE_15 (EXTI_GPIO | 0x0Fu)
49#define EXTI_LINE_16 (EXTI_CONFIG | 0x10u)
50#define EXTI_LINE_17 (EXTI_CONFIG | 0x11u)
51#if defined(EXTI_IMR_IM18)
52# define EXTI_LINE_18 (EXTI_CONFIG | 0x12u)
53#else
54# define EXTI_LINE_18 (EXTI_RESERVED | 0x12u)
55#endif
56#if defined(EXTI_IMR_IM19)
57# define EXTI_LINE_19 (EXTI_CONFIG | 0x13u)
58#else
59# define EXTI_LINE_19 (EXTI_RESERVED | 0x13u)
60#endif
61#if defined(EXTI_IMR_IM20)
62# define EXTI_LINE_20 (EXTI_CONFIG | 0x14u)
63#else
64# define EXTI_LINE_20 (EXTI_RESERVED | 0x14u)
65#endif
66#define EXTI_LINE_21 (EXTI_CONFIG | 0x15u)
67#define EXTI_LINE_22 (EXTI_CONFIG | 0x16u)
68#if defined(EXTI_IMR_IM23)
69# define EXTI_LINE_23 (EXTI_CONFIG | 0x17u)
70#endif
71
72#define EXTI_MODE_NONE 0x00000000u
73#define EXTI_MODE_INTERRUPT 0x00000001u
74#define EXTI_MODE_EVENT 0x00000002u
75
76#define EXTI_TRIGGER_NONE 0x00000000u
77#define EXTI_TRIGGER_RISING 0x00000001u
78#define EXTI_TRIGGER_FALLING 0x00000002u
79#define EXTI_TRIGGER_RISING_FALLING (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
80
81#define EXTI_GPIOA 0x00000000u
82#define EXTI_GPIOB 0x00000001u
83#define EXTI_GPIOC 0x00000002u
84#if defined(GPIOD)
85# define EXTI_GPIOD 0x00000003u
86#endif
87#if defined(GPIOE)
88# define EXTI_GPIOE 0x00000004u
89#endif
90#if defined(GPIOF)
91# define EXTI_GPIOF 0x00000005u
92#endif
93#if defined(GPIOG)
94# define EXTI_GPIOG 0x00000006u
95#endif
96#if defined(GPIOH)
97# define EXTI_GPIOH 0x00000007u
98#endif
99#if defined(GPIOI)
100# define EXTI_GPIOI 0x00000008u
101#endif
102#if defined(GPIOJ)
103# define EXTI_GPIOJ 0x00000009u
104#endif
105#if defined(GPIOK)
106# define EXTI_GPIOK 0x0000000Au
107#endif
108
109#define EXTI_PROPERTY_SHIFT 24u
110#define EXTI_CONFIG (0x02uL << EXTI_PROPERTY_SHIFT)
111#define EXTI_GPIO ((0x04uL << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG)
112#define EXTI_RESERVED (0x08uL << EXTI_PROPERTY_SHIFT)
113#define EXTI_PROPERTY_MASK (EXTI_CONFIG | EXTI_GPIO)
114
115#define EXTI_PIN_MASK 0x0000001Fu
116
117#define EXTI_MODE_MASK (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
118
119#define EXTI_TRIGGER_MASK (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
120
121#if defined(EXTI_IMR_IM23)
122# define EXTI_LINE_NB 24UL
123#else
124# define EXTI_LINE_NB 23UL
125#endif
126
127#define IS_EXTI_LINE(__EXTI_LINE__) \
128 ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_PIN_MASK)) == 0x00u) && \
129 ((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG) || \
130 (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO)) && \
131 (((__EXTI_LINE__) & EXTI_PIN_MASK) < EXTI_LINE_NB))
132
133#define IS_EXTI_MODE(__EXTI_LINE__) \
134 ((((__EXTI_LINE__) & EXTI_MODE_MASK) != 0x00u) && \
135 (((__EXTI_LINE__) & ~EXTI_MODE_MASK) == 0x00u))
136
137#define IS_EXTI_TRIGGER(__EXTI_LINE__) \
138 (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00u)
139
140#define IS_EXTI_PENDING_EDGE(__EXTI_LINE__) \
141 ((__EXTI_LINE__) == EXTI_TRIGGER_RISING_FALLING)
142
143#define IS_EXTI_CONFIG_LINE(__EXTI_LINE__) \
144 (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00u)
145
146#if !defined(GPIOD)
147# define IS_EXTI_GPIO_PORT(__PORT__) \
148 (((__PORT__) == EXTI_GPIOA) || ((__PORT__) == EXTI_GPIOB) || \
149 ((__PORT__) == EXTI_GPIOC) || ((__PORT__) == EXTI_GPIOH))
150#elif !defined(GPIOE)
151# define IS_EXTI_GPIO_PORT(__PORT__) \
152 (((__PORT__) == EXTI_GPIOA) || ((__PORT__) == EXTI_GPIOB) || \
153 ((__PORT__) == EXTI_GPIOC) || ((__PORT__) == EXTI_GPIOD) || \
154 ((__PORT__) == EXTI_GPIOH))
155#elif !defined(GPIOF)
156# define IS_EXTI_GPIO_PORT(__PORT__) \
157 (((__PORT__) == EXTI_GPIOA) || ((__PORT__) == EXTI_GPIOB) || \
158 ((__PORT__) == EXTI_GPIOC) || ((__PORT__) == EXTI_GPIOD) || \
159 ((__PORT__) == EXTI_GPIOE) || ((__PORT__) == EXTI_GPIOH))
160#elif !defined(GPIOI)
161# define IS_EXTI_GPIO_PORT(__PORT__) \
162 (((__PORT__) == EXTI_GPIOA) || ((__PORT__) == EXTI_GPIOB) || \
163 ((__PORT__) == EXTI_GPIOC) || ((__PORT__) == EXTI_GPIOD) || \
164 ((__PORT__) == EXTI_GPIOE) || ((__PORT__) == EXTI_GPIOF) || \
165 ((__PORT__) == EXTI_GPIOG) || ((__PORT__) == EXTI_GPIOH))
166#elif !defined(GPIOJ)
167# define IS_EXTI_GPIO_PORT(__PORT__) \
168 (((__PORT__) == EXTI_GPIOA) || ((__PORT__) == EXTI_GPIOB) || \
169 ((__PORT__) == EXTI_GPIOC) || ((__PORT__) == EXTI_GPIOD) || \
170 ((__PORT__) == EXTI_GPIOE) || ((__PORT__) == EXTI_GPIOF) || \
171 ((__PORT__) == EXTI_GPIOG) || ((__PORT__) == EXTI_GPIOH) || \
172 ((__PORT__) == EXTI_GPIOI))
173#else
174# define IS_EXTI_GPIO_PORT(__PORT__) \
175 (((__PORT__) == EXTI_GPIOA) || ((__PORT__) == EXTI_GPIOB) || \
176 ((__PORT__) == EXTI_GPIOC) || ((__PORT__) == EXTI_GPIOD) || \
177 ((__PORT__) == EXTI_GPIOE) || ((__PORT__) == EXTI_GPIOF) || \
178 ((__PORT__) == EXTI_GPIOG) || ((__PORT__) == EXTI_GPIOH) || \
179 ((__PORT__) == EXTI_GPIOI) || ((__PORT__) == EXTI_GPIOJ) || \
180 ((__PORT__) == EXTI_GPIOK))
181#endif
182
183#define IS_EXTI_GPIO_PIN(__PIN__) ((__PIN__) < 16U)
184
185/*============================ MACROFIED FUNCTIONS ===========================*/
186/*============================ TYPES =========================================*/
187
188typedef enum {
189 HAL_EXTI_COMMON_CB_ID = 0x00U
190} EXTI_CallbackIDTypeDef;
191
192typedef struct {
193 uint32_t Line;
194 void (*PendingCallback)(void);
195} EXTI_HandleTypeDef;
196
197typedef struct {
198 uint32_t Line;
199 uint32_t Mode;
200 uint32_t Trigger;
201 uint32_t GPIOSel;
202} EXTI_ConfigTypeDef;
203
204/*============================ GLOBAL VARIABLES ==============================*/
205/*============================ PROTOTYPES ====================================*/
206
207HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti,
208 EXTI_ConfigTypeDef *pExtiConfig);
209HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti,
210 EXTI_ConfigTypeDef *pExtiConfig);
211HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti);
212HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti,
213 EXTI_CallbackIDTypeDef CallbackID,
214 void (*pPendingCbfn)(void));
215HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti,
216 uint32_t ExtiLine);
217
218void HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti);
219uint32_t HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
220void HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
221void HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti);
222
223#endif /* (VSF_HAL_USE_USART == ENABLED) && defined(HAL_EXTI_MODULE_ENABLED) */
224
225#ifdef __cplusplus
226}
227#endif
228
229#endif
uint32_t
unsigned uint32_t
Definition stdint.h:9
sthal_def.h
HAL_StatusTypeDef
HAL_StatusTypeDef
Definition sthal_def.h:61
Generated from commit: vsfteam/vsf@0c4049f