|
38
|
1 /**
|
|
|
2 ******************************************************************************
|
|
|
3 * @file stm32f4xx_hal_gpio.h
|
|
|
4 * @author MCD Application Team
|
|
|
5 * @version V1.2.0
|
|
|
6 * @date 26-December-2014
|
|
|
7 * @brief Header file of GPIO HAL module.
|
|
|
8 ******************************************************************************
|
|
|
9 * @attention
|
|
|
10 *
|
|
|
11 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
|
|
|
12 *
|
|
|
13 * Redistribution and use in source and binary forms, with or without modification,
|
|
|
14 * are permitted provided that the following conditions are met:
|
|
|
15 * 1. Redistributions of source code must retain the above copyright notice,
|
|
|
16 * this list of conditions and the following disclaimer.
|
|
|
17 * 2. Redistributions in binary form must reproduce the above copyright notice,
|
|
|
18 * this list of conditions and the following disclaimer in the documentation
|
|
|
19 * and/or other materials provided with the distribution.
|
|
|
20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
|
|
|
21 * may be used to endorse or promote products derived from this software
|
|
|
22 * without specific prior written permission.
|
|
|
23 *
|
|
|
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
|
25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
|
27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
|
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
|
30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
|
31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
|
32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
|
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
34 *
|
|
|
35 ******************************************************************************
|
|
|
36 */
|
|
|
37
|
|
|
38 /* Define to prevent recursive inclusion -------------------------------------*/
|
|
|
39 #ifndef __STM32F4xx_HAL_GPIO_H
|
|
|
40 #define __STM32F4xx_HAL_GPIO_H
|
|
|
41
|
|
|
42 #ifdef __cplusplus
|
|
|
43 extern "C" {
|
|
|
44 #endif
|
|
|
45
|
|
|
46 /* Includes ------------------------------------------------------------------*/
|
|
|
47 #include "stm32f4xx_hal_def.h"
|
|
|
48
|
|
|
49 /** @addtogroup STM32F4xx_HAL_Driver
|
|
|
50 * @{
|
|
|
51 */
|
|
|
52
|
|
|
53 /** @addtogroup GPIO
|
|
|
54 * @{
|
|
|
55 */
|
|
|
56
|
|
|
57 /* Exported types ------------------------------------------------------------*/
|
|
|
58 /** @defgroup GPIO_Exported_Types GPIO Exported Types
|
|
|
59 * @{
|
|
|
60 */
|
|
|
61
|
|
|
62 /**
|
|
|
63 * @brief GPIO Init structure definition
|
|
|
64 */
|
|
|
65 typedef struct
|
|
|
66 {
|
|
|
67 uint32_t Pin; /*!< Specifies the GPIO pins to be configured.
|
|
|
68 This parameter can be any value of @ref GPIO_pins_define */
|
|
|
69
|
|
|
70 uint32_t Mode; /*!< Specifies the operating mode for the selected pins.
|
|
|
71 This parameter can be a value of @ref GPIO_mode_define */
|
|
|
72
|
|
|
73 uint32_t Pull; /*!< Specifies the Pull-up or Pull-Down activation for the selected pins.
|
|
|
74 This parameter can be a value of @ref GPIO_pull_define */
|
|
|
75
|
|
|
76 uint32_t Speed; /*!< Specifies the speed for the selected pins.
|
|
|
77 This parameter can be a value of @ref GPIO_speed_define */
|
|
|
78
|
|
|
79 uint32_t Alternate; /*!< Peripheral to be connected to the selected pins.
|
|
|
80 This parameter can be a value of @ref GPIO_Alternate_function_selection */
|
|
|
81 }GPIO_InitTypeDef;
|
|
|
82
|
|
|
83 /**
|
|
|
84 * @brief GPIO Bit SET and Bit RESET enumeration
|
|
|
85 */
|
|
|
86 typedef enum
|
|
|
87 {
|
|
|
88 GPIO_PIN_RESET = 0,
|
|
|
89 GPIO_PIN_SET
|
|
|
90 }GPIO_PinState;
|
|
|
91 /**
|
|
|
92 * @}
|
|
|
93 */
|
|
|
94
|
|
|
95 /* Exported constants --------------------------------------------------------*/
|
|
|
96
|
|
|
97 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants
|
|
|
98 * @{
|
|
|
99 */
|
|
|
100
|
|
|
101 /** @defgroup GPIO_pins_define GPIO pins define
|
|
|
102 * @{
|
|
|
103 */
|
|
|
104 #define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */
|
|
|
105 #define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */
|
|
|
106 #define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */
|
|
|
107 #define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */
|
|
|
108 #define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */
|
|
|
109 #define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */
|
|
|
110 #define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */
|
|
|
111 #define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */
|
|
|
112 #define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */
|
|
|
113 #define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */
|
|
|
114 #define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */
|
|
|
115 #define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */
|
|
|
116 #define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */
|
|
|
117 #define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */
|
|
|
118 #define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */
|
|
|
119 #define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */
|
|
|
120 #define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */
|
|
|
121
|
|
|
122 #define GPIO_PIN_MASK ((uint32_t)0x0000FFFF) /* PIN mask for assert test */
|
|
|
123 /**
|
|
|
124 * @}
|
|
|
125 */
|
|
|
126
|
|
|
127 /** @defgroup GPIO_mode_define GPIO mode define
|
|
|
128 * @brief GPIO Configuration Mode
|
|
|
129 * Elements values convention: 0xX0yz00YZ
|
|
|
130 * - X : GPIO mode or EXTI Mode
|
|
|
131 * - y : External IT or Event trigger detection
|
|
|
132 * - z : IO configuration on External IT or Event
|
|
|
133 * - Y : Output type (Push Pull or Open Drain)
|
|
|
134 * - Z : IO Direction mode (Input, Output, Alternate or Analog)
|
|
|
135 * @{
|
|
|
136 */
|
|
|
137 #define GPIO_MODE_INPUT ((uint32_t)0x00000000) /*!< Input Floating Mode */
|
|
|
138 #define GPIO_MODE_OUTPUT_PP ((uint32_t)0x00000001) /*!< Output Push Pull Mode */
|
|
|
139 #define GPIO_MODE_OUTPUT_OD ((uint32_t)0x00000011) /*!< Output Open Drain Mode */
|
|
|
140 #define GPIO_MODE_AF_PP ((uint32_t)0x00000002) /*!< Alternate Function Push Pull Mode */
|
|
|
141 #define GPIO_MODE_AF_OD ((uint32_t)0x00000012) /*!< Alternate Function Open Drain Mode */
|
|
|
142
|
|
|
143 #define GPIO_MODE_ANALOG ((uint32_t)0x00000003) /*!< Analog Mode */
|
|
|
144
|
|
|
145 #define GPIO_MODE_IT_RISING ((uint32_t)0x10110000) /*!< External Interrupt Mode with Rising edge trigger detection */
|
|
|
146 #define GPIO_MODE_IT_FALLING ((uint32_t)0x10210000) /*!< External Interrupt Mode with Falling edge trigger detection */
|
|
|
147 #define GPIO_MODE_IT_RISING_FALLING ((uint32_t)0x10310000) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
|
|
|
148
|
|
|
149 #define GPIO_MODE_EVT_RISING ((uint32_t)0x10120000) /*!< External Event Mode with Rising edge trigger detection */
|
|
|
150 #define GPIO_MODE_EVT_FALLING ((uint32_t)0x10220000) /*!< External Event Mode with Falling edge trigger detection */
|
|
|
151 #define GPIO_MODE_EVT_RISING_FALLING ((uint32_t)0x10320000) /*!< External Event Mode with Rising/Falling edge trigger detection */
|
|
|
152 /**
|
|
|
153 * @}
|
|
|
154 */
|
|
|
155
|
|
|
156 /** @defgroup GPIO_speed_define GPIO speed define
|
|
|
157 * @brief GPIO Output Maximum frequency
|
|
|
158 * @{
|
|
|
159 */
|
|
|
160 #define GPIO_SPEED_LOW ((uint32_t)0x00000000) /*!< Low speed */
|
|
|
161 #define GPIO_SPEED_MEDIUM ((uint32_t)0x00000001) /*!< Medium speed */
|
|
|
162 #define GPIO_SPEED_FAST ((uint32_t)0x00000002) /*!< Fast speed */
|
|
|
163 #define GPIO_SPEED_HIGH ((uint32_t)0x00000003) /*!< High speed */
|
|
|
164 /**
|
|
|
165 * @}
|
|
|
166 */
|
|
|
167
|
|
|
168 /** @defgroup GPIO_pull_define GPIO pull define
|
|
|
169 * @brief GPIO Pull-Up or Pull-Down Activation
|
|
|
170 * @{
|
|
|
171 */
|
|
|
172 #define GPIO_NOPULL ((uint32_t)0x00000000) /*!< No Pull-up or Pull-down activation */
|
|
|
173 #define GPIO_PULLUP ((uint32_t)0x00000001) /*!< Pull-up activation */
|
|
|
174 #define GPIO_PULLDOWN ((uint32_t)0x00000002) /*!< Pull-down activation */
|
|
|
175 /**
|
|
|
176 * @}
|
|
|
177 */
|
|
|
178
|
|
|
179 /**
|
|
|
180 * @}
|
|
|
181 */
|
|
|
182
|
|
|
183 /* Exported macro ------------------------------------------------------------*/
|
|
|
184 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
|
|
|
185 * @{
|
|
|
186 */
|
|
|
187
|
|
|
188 /**
|
|
|
189 * @brief Checks whether the specified EXTI line flag is set or not.
|
|
|
190 * @param __EXTI_LINE__: specifies the EXTI line flag to check.
|
|
|
191 * This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
|
192 * @retval The new state of __EXTI_LINE__ (SET or RESET).
|
|
|
193 */
|
|
|
194 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
|
|
|
195
|
|
|
196 /**
|
|
|
197 * @brief Clears the EXTI's line pending flags.
|
|
|
198 * @param __EXTI_LINE__: specifies the EXTI lines flags to clear.
|
|
|
199 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
|
|
|
200 * @retval None
|
|
|
201 */
|
|
|
202 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
|
|
|
203
|
|
|
204 /**
|
|
|
205 * @brief Checks whether the specified EXTI line is asserted or not.
|
|
|
206 * @param __EXTI_LINE__: specifies the EXTI line to check.
|
|
|
207 * This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
|
208 * @retval The new state of __EXTI_LINE__ (SET or RESET).
|
|
|
209 */
|
|
|
210 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
|
|
|
211
|
|
|
212 /**
|
|
|
213 * @brief Clears the EXTI's line pending bits.
|
|
|
214 * @param __EXTI_LINE__: specifies the EXTI lines to clear.
|
|
|
215 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
|
|
|
216 * @retval None
|
|
|
217 */
|
|
|
218 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
|
|
|
219
|
|
|
220 /**
|
|
|
221 * @brief Generates a Software interrupt on selected EXTI line.
|
|
|
222 * @param __EXTI_LINE__: specifies the EXTI line to check.
|
|
|
223 * This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
|
224 * @retval None
|
|
|
225 */
|
|
|
226 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
|
|
|
227 /**
|
|
|
228 * @}
|
|
|
229 */
|
|
|
230
|
|
|
231 /* Include GPIO HAL Extension module */
|
|
|
232 #include "stm32f4xx_hal_gpio_ex.h"
|
|
|
233
|
|
|
234 /* Exported functions --------------------------------------------------------*/
|
|
|
235 /** @addtogroup GPIO_Exported_Functions
|
|
|
236 * @{
|
|
|
237 */
|
|
|
238
|
|
|
239 /** @addtogroup GPIO_Exported_Functions_Group1
|
|
|
240 * @{
|
|
|
241 */
|
|
|
242 /* Initialization and de-initialization functions *****************************/
|
|
|
243 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init);
|
|
|
244 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin);
|
|
|
245 /**
|
|
|
246 * @}
|
|
|
247 */
|
|
|
248
|
|
|
249 /** @addtogroup GPIO_Exported_Functions_Group2
|
|
|
250 * @{
|
|
|
251 */
|
|
|
252 /* IO operation functions *****************************************************/
|
|
|
253 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
|
|
|
254 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
|
|
|
255 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
|
|
|
256 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
|
|
|
257 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
|
|
|
258 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
|
|
|
259
|
|
|
260 /**
|
|
|
261 * @}
|
|
|
262 */
|
|
|
263
|
|
|
264 /**
|
|
|
265 * @}
|
|
|
266 */
|
|
|
267 /* Private types -------------------------------------------------------------*/
|
|
|
268 /* Private variables ---------------------------------------------------------*/
|
|
|
269 /* Private constants ---------------------------------------------------------*/
|
|
|
270 /** @defgroup GPIO_Private_Constants GPIO Private Constants
|
|
|
271 * @{
|
|
|
272 */
|
|
|
273
|
|
|
274 /**
|
|
|
275 * @}
|
|
|
276 */
|
|
|
277
|
|
|
278 /* Private macros ------------------------------------------------------------*/
|
|
|
279 /** @defgroup GPIO_Private_Macros GPIO Private Macros
|
|
|
280 * @{
|
|
|
281 */
|
|
|
282 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
|
|
|
283 #define IS_GPIO_PIN(PIN) (((PIN) & GPIO_PIN_MASK ) != (uint32_t)0x00)
|
|
|
284 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT) ||\
|
|
|
285 ((MODE) == GPIO_MODE_OUTPUT_PP) ||\
|
|
|
286 ((MODE) == GPIO_MODE_OUTPUT_OD) ||\
|
|
|
287 ((MODE) == GPIO_MODE_AF_PP) ||\
|
|
|
288 ((MODE) == GPIO_MODE_AF_OD) ||\
|
|
|
289 ((MODE) == GPIO_MODE_IT_RISING) ||\
|
|
|
290 ((MODE) == GPIO_MODE_IT_FALLING) ||\
|
|
|
291 ((MODE) == GPIO_MODE_IT_RISING_FALLING) ||\
|
|
|
292 ((MODE) == GPIO_MODE_EVT_RISING) ||\
|
|
|
293 ((MODE) == GPIO_MODE_EVT_FALLING) ||\
|
|
|
294 ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\
|
|
|
295 ((MODE) == GPIO_MODE_ANALOG))
|
|
|
296 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_LOW) || ((SPEED) == GPIO_SPEED_MEDIUM) || \
|
|
|
297 ((SPEED) == GPIO_SPEED_FAST) || ((SPEED) == GPIO_SPEED_HIGH))
|
|
|
298 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \
|
|
|
299 ((PULL) == GPIO_PULLDOWN))
|
|
|
300 /**
|
|
|
301 * @}
|
|
|
302 */
|
|
|
303
|
|
|
304 /* Private functions ---------------------------------------------------------*/
|
|
|
305 /** @defgroup GPIO_Private_Functions GPIO Private Functions
|
|
|
306 * @{
|
|
|
307 */
|
|
|
308
|
|
|
309 /**
|
|
|
310 * @}
|
|
|
311 */
|
|
|
312
|
|
|
313 /**
|
|
|
314 * @}
|
|
|
315 */
|
|
|
316
|
|
|
317 /**
|
|
|
318 * @}
|
|
|
319 */
|
|
|
320
|
|
|
321 #ifdef __cplusplus
|
|
|
322 }
|
|
|
323 #endif
|
|
|
324
|
|
|
325 #endif /* __STM32F4xx_HAL_GPIO_H */
|
|
|
326
|
|
|
327 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
