|
0
|
1 /**
|
|
|
2 ******************************************************************************
|
|
|
3 * @file stm32l4xx_hal_gpio.h
|
|
|
4 * @author MCD Application Team
|
|
|
5 * @version V1.6.0
|
|
|
6 * @date 28-October-2016
|
|
|
7 * @brief Header file of GPIO HAL module.
|
|
|
8 ******************************************************************************
|
|
|
9 * @attention
|
|
|
10 *
|
|
|
11 * <h2><center>© COPYRIGHT(c) 2016 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 __STM32L4xx_HAL_GPIO_H
|
|
|
40 #define __STM32L4xx_HAL_GPIO_H
|
|
|
41
|
|
|
42 #ifdef __cplusplus
|
|
|
43 extern "C" {
|
|
|
44 #endif
|
|
|
45
|
|
|
46 /* Includes ------------------------------------------------------------------*/
|
|
|
47 #include "stm32l4xx_hal_def.h"
|
|
|
48
|
|
|
49 /** @addtogroup STM32L4xx_HAL_Driver
|
|
|
50 * @{
|
|
|
51 */
|
|
|
52
|
|
|
53 /** @addtogroup GPIO
|
|
|
54 * @{
|
|
|
55 */
|
|
|
56
|
|
|
57 /* Exported types ------------------------------------------------------------*/
|
|
|
58
|
|
|
59 /** @defgroup GPIO_Exported_Types GPIO Exported Types
|
|
|
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 */
|
|
|
69
|
|
|
70 uint32_t Mode; /*!< Specifies the operating mode for the selected pins.
|
|
|
71 This parameter can be a value of @ref GPIO_mode */
|
|
|
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 */
|
|
|
75
|
|
|
76 uint32_t Speed; /*!< Specifies the speed for the selected pins.
|
|
|
77 This parameter can be a value of @ref GPIO_speed */
|
|
|
78
|
|
|
79 uint32_t Alternate; /*!< Peripheral to be connected to the selected pins
|
|
|
80 This parameter can be a value of @ref GPIOEx_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 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants
|
|
|
97 * @{
|
|
|
98 */
|
|
|
99 /** @defgroup GPIO_pins GPIO pins
|
|
|
100 * @{
|
|
|
101 */
|
|
|
102 #define GPIO_PIN_0 ((uint16_t)0x0001) /* Pin 0 selected */
|
|
|
103 #define GPIO_PIN_1 ((uint16_t)0x0002) /* Pin 1 selected */
|
|
|
104 #define GPIO_PIN_2 ((uint16_t)0x0004) /* Pin 2 selected */
|
|
|
105 #define GPIO_PIN_3 ((uint16_t)0x0008) /* Pin 3 selected */
|
|
|
106 #define GPIO_PIN_4 ((uint16_t)0x0010) /* Pin 4 selected */
|
|
|
107 #define GPIO_PIN_5 ((uint16_t)0x0020) /* Pin 5 selected */
|
|
|
108 #define GPIO_PIN_6 ((uint16_t)0x0040) /* Pin 6 selected */
|
|
|
109 #define GPIO_PIN_7 ((uint16_t)0x0080) /* Pin 7 selected */
|
|
|
110 #define GPIO_PIN_8 ((uint16_t)0x0100) /* Pin 8 selected */
|
|
|
111 #define GPIO_PIN_9 ((uint16_t)0x0200) /* Pin 9 selected */
|
|
|
112 #define GPIO_PIN_10 ((uint16_t)0x0400) /* Pin 10 selected */
|
|
|
113 #define GPIO_PIN_11 ((uint16_t)0x0800) /* Pin 11 selected */
|
|
|
114 #define GPIO_PIN_12 ((uint16_t)0x1000) /* Pin 12 selected */
|
|
|
115 #define GPIO_PIN_13 ((uint16_t)0x2000) /* Pin 13 selected */
|
|
|
116 #define GPIO_PIN_14 ((uint16_t)0x4000) /* Pin 14 selected */
|
|
|
117 #define GPIO_PIN_15 ((uint16_t)0x8000) /* Pin 15 selected */
|
|
|
118 #define GPIO_PIN_All ((uint16_t)0xFFFF) /* All pins selected */
|
|
|
119
|
|
|
120 #define GPIO_PIN_MASK ((uint32_t)0x0000FFFF) /* PIN mask for assert test */
|
|
|
121 /**
|
|
|
122 * @}
|
|
|
123 */
|
|
|
124
|
|
|
125 /** @defgroup GPIO_mode GPIO mode
|
|
|
126 * @brief GPIO Configuration Mode
|
|
|
127 * Elements values convention: 0xX0yz00YZ
|
|
|
128 * - X : GPIO mode or EXTI Mode
|
|
|
129 * - y : External IT or Event trigger detection
|
|
|
130 * - z : IO configuration on External IT or Event
|
|
|
131 * - Y : Output type (Push Pull or Open Drain)
|
|
|
132 * - Z : IO Direction mode (Input, Output, Alternate or Analog)
|
|
|
133 * @{
|
|
|
134 */
|
|
|
135 #define GPIO_MODE_INPUT ((uint32_t)0x00000000) /*!< Input Floating Mode */
|
|
|
136 #define GPIO_MODE_OUTPUT_PP ((uint32_t)0x00000001) /*!< Output Push Pull Mode */
|
|
|
137 #define GPIO_MODE_OUTPUT_OD ((uint32_t)0x00000011) /*!< Output Open Drain Mode */
|
|
|
138 #define GPIO_MODE_AF_PP ((uint32_t)0x00000002) /*!< Alternate Function Push Pull Mode */
|
|
|
139 #define GPIO_MODE_AF_OD ((uint32_t)0x00000012) /*!< Alternate Function Open Drain Mode */
|
|
|
140 #define GPIO_MODE_ANALOG ((uint32_t)0x00000003) /*!< Analog Mode */
|
|
|
141 #define GPIO_MODE_ANALOG_ADC_CONTROL ((uint32_t)0x0000000B) /*!< Analog Mode for ADC conversion */
|
|
|
142 #define GPIO_MODE_IT_RISING ((uint32_t)0x10110000) /*!< External Interrupt Mode with Rising edge trigger detection */
|
|
|
143 #define GPIO_MODE_IT_FALLING ((uint32_t)0x10210000) /*!< External Interrupt Mode with Falling edge trigger detection */
|
|
|
144 #define GPIO_MODE_IT_RISING_FALLING ((uint32_t)0x10310000) /*!< External Interrupt Mode with Rising/Falling edge trigger detection */
|
|
|
145 #define GPIO_MODE_EVT_RISING ((uint32_t)0x10120000) /*!< External Event Mode with Rising edge trigger detection */
|
|
|
146 #define GPIO_MODE_EVT_FALLING ((uint32_t)0x10220000) /*!< External Event Mode with Falling edge trigger detection */
|
|
|
147 #define GPIO_MODE_EVT_RISING_FALLING ((uint32_t)0x10320000) /*!< External Event Mode with Rising/Falling edge trigger detection */
|
|
|
148 /**
|
|
|
149 * @}
|
|
|
150 */
|
|
|
151
|
|
|
152 /** @defgroup GPIO_speed GPIO speed
|
|
|
153 * @brief GPIO Output Maximum frequency
|
|
|
154 * @{
|
|
|
155 */
|
|
|
156 #define GPIO_SPEED_FREQ_LOW ((uint32_t)0x00000000) /*!< range up to 5 MHz, please refer to the product datasheet */
|
|
|
157 #define GPIO_SPEED_FREQ_MEDIUM ((uint32_t)0x00000001) /*!< range 5 MHz to 25 MHz, please refer to the product datasheet */
|
|
|
158 #define GPIO_SPEED_FREQ_HIGH ((uint32_t)0x00000002) /*!< range 25 MHz to 50 MHz, please refer to the product datasheet */
|
|
|
159 #define GPIO_SPEED_FREQ_VERY_HIGH ((uint32_t)0x00000003) /*!< range 50 MHz to 80 MHz, please refer to the product datasheet */
|
|
|
160 /**
|
|
|
161 * @}
|
|
|
162 */
|
|
|
163
|
|
|
164 /** @defgroup GPIO_pull GPIO pull
|
|
|
165 * @brief GPIO Pull-Up or Pull-Down Activation
|
|
|
166 * @{
|
|
|
167 */
|
|
|
168 #define GPIO_NOPULL ((uint32_t)0x00000000) /*!< No Pull-up or Pull-down activation */
|
|
|
169 #define GPIO_PULLUP ((uint32_t)0x00000001) /*!< Pull-up activation */
|
|
|
170 #define GPIO_PULLDOWN ((uint32_t)0x00000002) /*!< Pull-down activation */
|
|
|
171 /**
|
|
|
172 * @}
|
|
|
173 */
|
|
|
174
|
|
|
175 /**
|
|
|
176 * @}
|
|
|
177 */
|
|
|
178
|
|
|
179 /* Exported macro ------------------------------------------------------------*/
|
|
|
180 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
|
|
|
181 * @{
|
|
|
182 */
|
|
|
183
|
|
|
184 /**
|
|
|
185 * @brief Check whether the specified EXTI line flag is set or not.
|
|
|
186 * @param __EXTI_LINE__: specifies the EXTI line flag to check.
|
|
|
187 * This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
|
188 * @retval The new state of __EXTI_LINE__ (SET or RESET).
|
|
|
189 */
|
|
|
190 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR1 & (__EXTI_LINE__))
|
|
|
191
|
|
|
192 /**
|
|
|
193 * @brief Clear the EXTI's line pending flags.
|
|
|
194 * @param __EXTI_LINE__: specifies the EXTI lines flags to clear.
|
|
|
195 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
|
|
|
196 * @retval None
|
|
|
197 */
|
|
|
198 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR1 = (__EXTI_LINE__))
|
|
|
199
|
|
|
200 /**
|
|
|
201 * @brief Check whether the specified EXTI line is asserted or not.
|
|
|
202 * @param __EXTI_LINE__: specifies the EXTI line to check.
|
|
|
203 * This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
|
204 * @retval The new state of __EXTI_LINE__ (SET or RESET).
|
|
|
205 */
|
|
|
206 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR1 & (__EXTI_LINE__))
|
|
|
207
|
|
|
208 /**
|
|
|
209 * @brief Clear the EXTI's line pending bits.
|
|
|
210 * @param __EXTI_LINE__: specifies the EXTI lines to clear.
|
|
|
211 * This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
|
|
|
212 * @retval None
|
|
|
213 */
|
|
|
214 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR1 = (__EXTI_LINE__))
|
|
|
215
|
|
|
216 /**
|
|
|
217 * @brief Generate a Software interrupt on selected EXTI line.
|
|
|
218 * @param __EXTI_LINE__: specifies the EXTI line to check.
|
|
|
219 * This parameter can be GPIO_PIN_x where x can be(0..15)
|
|
|
220 * @retval None
|
|
|
221 */
|
|
|
222 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER1 |= (__EXTI_LINE__))
|
|
|
223
|
|
|
224 /**
|
|
|
225 * @}
|
|
|
226 */
|
|
|
227
|
|
|
228 /* Private macros ------------------------------------------------------------*/
|
|
|
229 /** @addtogroup GPIO_Private_Macros GPIO Private Macros
|
|
|
230 * @{
|
|
|
231 */
|
|
|
232 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
|
|
|
233
|
|
|
234 #define IS_GPIO_PIN(__PIN__) ((((__PIN__) & GPIO_PIN_MASK) != (uint32_t)0x00) &&\
|
|
|
235 (((__PIN__) & ~GPIO_PIN_MASK) == (uint32_t)0x00))
|
|
|
236
|
|
|
237 #define IS_GPIO_MODE(__MODE__) (((__MODE__) == GPIO_MODE_INPUT) ||\
|
|
|
238 ((__MODE__) == GPIO_MODE_OUTPUT_PP) ||\
|
|
|
239 ((__MODE__) == GPIO_MODE_OUTPUT_OD) ||\
|
|
|
240 ((__MODE__) == GPIO_MODE_AF_PP) ||\
|
|
|
241 ((__MODE__) == GPIO_MODE_AF_OD) ||\
|
|
|
242 ((__MODE__) == GPIO_MODE_IT_RISING) ||\
|
|
|
243 ((__MODE__) == GPIO_MODE_IT_FALLING) ||\
|
|
|
244 ((__MODE__) == GPIO_MODE_IT_RISING_FALLING) ||\
|
|
|
245 ((__MODE__) == GPIO_MODE_EVT_RISING) ||\
|
|
|
246 ((__MODE__) == GPIO_MODE_EVT_FALLING) ||\
|
|
|
247 ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\
|
|
|
248 ((__MODE__) == GPIO_MODE_ANALOG) ||\
|
|
|
249 ((__MODE__) == GPIO_MODE_ANALOG_ADC_CONTROL))
|
|
|
250
|
|
|
251 #define IS_GPIO_SPEED(__SPEED__) (((__SPEED__) == GPIO_SPEED_FREQ_LOW) ||\
|
|
|
252 ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\
|
|
|
253 ((__SPEED__) == GPIO_SPEED_FREQ_HIGH) ||\
|
|
|
254 ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH))
|
|
|
255
|
|
|
256 #define IS_GPIO_PULL(__PULL__) (((__PULL__) == GPIO_NOPULL) ||\
|
|
|
257 ((__PULL__) == GPIO_PULLUP) || \
|
|
|
258 ((__PULL__) == GPIO_PULLDOWN))
|
|
|
259 /**
|
|
|
260 * @}
|
|
|
261 */
|
|
|
262
|
|
|
263 /* Include GPIO HAL Extended module */
|
|
|
264 #include "stm32l4xx_hal_gpio_ex.h"
|
|
|
265
|
|
|
266 /* Exported functions --------------------------------------------------------*/
|
|
|
267 /** @addtogroup GPIO_Exported_Functions GPIO Exported Functions
|
|
|
268 * @{
|
|
|
269 */
|
|
|
270
|
|
|
271 /** @addtogroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions
|
|
|
272 * @brief Initialization and Configuration functions
|
|
|
273 * @{
|
|
|
274 */
|
|
|
275
|
|
|
276 /* Initialization and de-initialization functions *****************************/
|
|
|
277 void HAL_GPIO_Init(GPIO_TypeDef *GPIOx, GPIO_InitTypeDef *GPIO_Init);
|
|
|
278 void HAL_GPIO_DeInit(GPIO_TypeDef *GPIOx, uint32_t GPIO_Pin);
|
|
|
279
|
|
|
280 /**
|
|
|
281 * @}
|
|
|
282 */
|
|
|
283
|
|
|
284 /** @addtogroup GPIO_Exported_Functions_Group2 IO operation functions
|
|
|
285 * @{
|
|
|
286 */
|
|
|
287
|
|
|
288 /* IO operation functions *****************************************************/
|
|
|
289 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
|
|
|
290 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
|
|
|
291 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
|
|
|
292 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
|
|
|
293 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
|
|
|
294 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
|
|
|
295
|
|
|
296 /**
|
|
|
297 * @}
|
|
|
298 */
|
|
|
299
|
|
|
300 /**
|
|
|
301 * @}
|
|
|
302 */
|
|
|
303
|
|
|
304 /**
|
|
|
305 * @}
|
|
|
306 */
|
|
|
307
|
|
|
308 /**
|
|
|
309 * @}
|
|
|
310 */
|
|
|
311
|
|
|
312 #ifdef __cplusplus
|
|
|
313 }
|
|
|
314 #endif
|
|
|
315
|
|
|
316 #endif /* __STM32L4xx_HAL_GPIO_H */
|
|
|
317
|
|
|
318 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
|
