My Project
Loading...
Searching...
No Matches
stm32f3xx_hal_gpio.h
Go to the documentation of this file.
1
19/* Define to prevent recursive inclusion -------------------------------------*/
20#ifndef __STM32F3xx_HAL_GPIO_H
21#define __STM32F3xx_HAL_GPIO_H
22
23#ifdef __cplusplus
24 extern "C" {
25#endif
26
27/* Includes ------------------------------------------------------------------*/
28#include "stm32f3xx_hal_def.h"
29
38/* Exported types ------------------------------------------------------------*/
39
46typedef struct
47{
48 uint32_t Pin;
51 uint32_t Mode;
54 uint32_t Pull;
57 uint32_t Speed;
60 uint32_t Alternate;
62}GPIO_InitTypeDef;
63
67typedef enum
68{
69 GPIO_PIN_RESET = 0U,
70 GPIO_PIN_SET
71}GPIO_PinState;
76/* Exported constants --------------------------------------------------------*/
83#define GPIO_PIN_0 ((uint16_t)0x0001U) /* Pin 0 selected */
84#define GPIO_PIN_1 ((uint16_t)0x0002U) /* Pin 1 selected */
85#define GPIO_PIN_2 ((uint16_t)0x0004U) /* Pin 2 selected */
86#define GPIO_PIN_3 ((uint16_t)0x0008U) /* Pin 3 selected */
87#define GPIO_PIN_4 ((uint16_t)0x0010U) /* Pin 4 selected */
88#define GPIO_PIN_5 ((uint16_t)0x0020U) /* Pin 5 selected */
89#define GPIO_PIN_6 ((uint16_t)0x0040U) /* Pin 6 selected */
90#define GPIO_PIN_7 ((uint16_t)0x0080U) /* Pin 7 selected */
91#define GPIO_PIN_8 ((uint16_t)0x0100U) /* Pin 8 selected */
92#define GPIO_PIN_9 ((uint16_t)0x0200U) /* Pin 9 selected */
93#define GPIO_PIN_10 ((uint16_t)0x0400U) /* Pin 10 selected */
94#define GPIO_PIN_11 ((uint16_t)0x0800U) /* Pin 11 selected */
95#define GPIO_PIN_12 ((uint16_t)0x1000U) /* Pin 12 selected */
96#define GPIO_PIN_13 ((uint16_t)0x2000U) /* Pin 13 selected */
97#define GPIO_PIN_14 ((uint16_t)0x4000U) /* Pin 14 selected */
98#define GPIO_PIN_15 ((uint16_t)0x8000U) /* Pin 15 selected */
99#define GPIO_PIN_All ((uint16_t)0xFFFFU) /* All pins selected */
100
101#define GPIO_PIN_MASK (0x0000FFFFU) /* PIN mask for assert test */
115#define GPIO_MODE_INPUT MODE_INPUT
116#define GPIO_MODE_OUTPUT_PP (MODE_OUTPUT | OUTPUT_PP)
117#define GPIO_MODE_OUTPUT_OD (MODE_OUTPUT | OUTPUT_OD)
118#define GPIO_MODE_AF_PP (MODE_AF | OUTPUT_PP)
119#define GPIO_MODE_AF_OD (MODE_AF | OUTPUT_OD)
121#define GPIO_MODE_ANALOG MODE_ANALOG
123#define GPIO_MODE_IT_RISING (MODE_INPUT | EXTI_IT | TRIGGER_RISING)
124#define GPIO_MODE_IT_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_FALLING)
125#define GPIO_MODE_IT_RISING_FALLING (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING)
127#define GPIO_MODE_EVT_RISING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING)
128#define GPIO_MODE_EVT_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING)
129#define GPIO_MODE_EVT_RISING_FALLING (MODE_INPUT | EXTI_EVT | TRIGGER_RISING | TRIGGER_FALLING)
138#define GPIO_SPEED_FREQ_LOW (0x00000000U)
139#define GPIO_SPEED_FREQ_MEDIUM (0x00000001U)
140#define GPIO_SPEED_FREQ_HIGH (0x00000003U)
149#define GPIO_NOPULL (0x00000000U)
150#define GPIO_PULLUP (0x00000001U)
151#define GPIO_PULLDOWN (0x00000002U)
160/* Exported macro ------------------------------------------------------------*/
171#define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
172
179#define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
180
187#define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
188
195#define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
196
203#define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
204
209/* Private macros ------------------------------------------------------------*/
213#define GPIO_MODE_Pos 0u
214#define GPIO_MODE (0x3uL << GPIO_MODE_Pos)
215#define MODE_INPUT (0x0uL << GPIO_MODE_Pos)
216#define MODE_OUTPUT (0x1uL << GPIO_MODE_Pos)
217#define MODE_AF (0x2uL << GPIO_MODE_Pos)
218#define MODE_ANALOG (0x3uL << GPIO_MODE_Pos)
219#define OUTPUT_TYPE_Pos 4u
220#define OUTPUT_TYPE (0x1uL << OUTPUT_TYPE_Pos)
221#define OUTPUT_PP (0x0uL << OUTPUT_TYPE_Pos)
222#define OUTPUT_OD (0x1uL << OUTPUT_TYPE_Pos)
223#define EXTI_MODE_Pos 16u
224#define EXTI_MODE (0x3uL << EXTI_MODE_Pos)
225#define EXTI_IT (0x1uL << EXTI_MODE_Pos)
226#define EXTI_EVT (0x2uL << EXTI_MODE_Pos)
227#define TRIGGER_MODE_Pos 20u
228#define TRIGGER_MODE (0x7uL << TRIGGER_MODE_Pos)
229#define TRIGGER_RISING (0x1uL << TRIGGER_MODE_Pos)
230#define TRIGGER_FALLING (0x2uL << TRIGGER_MODE_Pos)
231#define TRIGGER_LEVEL (0x4uL << TRIGGER_MODE_Pos)
239#define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
240
241#define IS_GPIO_PIN(__PIN__) (((((uint32_t)__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\
242 ((((uint32_t)__PIN__) & ~GPIO_PIN_MASK) == 0x00U))
243
244#define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\
245 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\
246 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\
247 ((__MODE__) == GPIO_MODE_AF_PP) ||\
248 ((__MODE__) == GPIO_MODE_AF_OD) ||\
249 ((__MODE__) == GPIO_MODE_IT_RISING) ||\
250 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\
251 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\
252 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\
253 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\
254 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\
255 ((__MODE__) == GPIO_MODE_ANALOG))
256
257#define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\
258 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\
259 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH))
260
261#define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\
262 ((__PULL__) == GPIO_PULLUP) || \
263 ((__PULL__) == GPIO_PULLDOWN))
268/* Include GPIO HAL Extended module */
269#include "stm32f3xx_hal_gpio_ex.h"
270
271/* Exported functions --------------------------------------------------------*/
281/* Initialization and de-initialization functions *****************************/
282void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init);
283void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin);
284
293/* IO operation functions *****************************************************/
294GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
295void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
296void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
297HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
298void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
299void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
300
317#ifdef __cplusplus
318}
319#endif
320
321#endif /* __STM32F3xx_HAL_GPIO_H */
322
323
HAL_GPIO_Init
void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init)
HAL_GPIO_DeInit
void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin)
HAL_GPIO_EXTI_Callback
void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin)
HAL_GPIO_EXTI_IRQHandler
void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin)
HAL_GPIO_LockPin
HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
HAL_GPIO_ReadPin
GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
HAL_GPIO_WritePin
void HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState)
HAL_GPIO_TogglePin
void HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin)
GPIO_PinState
GPIO_PinState
GPIO Bit SET and Bit RESET enumeration.
Definition: stm32f3xx_hal_gpio.h:68
GPIO_PIN_SET
@ GPIO_PIN_SET
Definition: stm32f3xx_hal_gpio.h:70
GPIO_PIN_RESET
@ GPIO_PIN_RESET
Definition: stm32f3xx_hal_gpio.h:69
stm32f3xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_StatusTypeDef
HAL_StatusTypeDef
HAL Status structures definition
Definition: stm32f3xx_hal_def.h:39
stm32f3xx_hal_gpio_ex.h
Header file of GPIO HAL Extended module.
GPIO_InitTypeDef
GPIO Init structure definition.
Definition: stm32f3xx_hal_gpio.h:47
GPIO_InitTypeDef::Mode
uint32_t Mode
Definition: stm32f3xx_hal_gpio.h:51
GPIO_InitTypeDef::Alternate
uint32_t Alternate
Definition: stm32f3xx_hal_gpio.h:60
GPIO_InitTypeDef::Pull
uint32_t Pull
Definition: stm32f3xx_hal_gpio.h:54
GPIO_InitTypeDef::Pin
uint32_t Pin
Definition: stm32f3xx_hal_gpio.h:48
GPIO_InitTypeDef::Speed
uint32_t Speed
Definition: stm32f3xx_hal_gpio.h:57
GPIO_TypeDef
General Purpose I/O.
Definition: stm32f303xe.h:475