2 ******************************************************************************
3 * @file stm32f30x_gpio.h
4 * @author MCD Application Team
6 * @date 27-February-2014
7 * @brief This file contains all the functions prototypes for the GPIO
9 ******************************************************************************
12 * <h2><center>© COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
14 * Redistribution and use in source and binary forms, with or without modification,
15 * are permitted provided that the following conditions are met:
16 * 1. Redistributions of source code must retain the above copyright notice,
17 * this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright notice,
19 * this list of conditions and the following disclaimer in the documentation
20 * and/or other materials provided with the distribution.
21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 ******************************************************************************
39 /* Define to prevent recursive inclusion -------------------------------------*/
40 #ifndef __STM32F30x_GPIO_H
41 #define __STM32F30x_GPIO_H
47 /* Includes ------------------------------------------------------------------*/
48 #include "stm32f30x.h"
50 /** @addtogroup STM32F30x_StdPeriph_Driver
58 /* Exported types ------------------------------------------------------------*/
60 #define IS_GPIO_ALL_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
61 ((PERIPH) == GPIOB) || \
62 ((PERIPH) == GPIOC) || \
63 ((PERIPH) == GPIOD) || \
64 ((PERIPH) == GPIOE) || \
67 #define IS_GPIO_LIST_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
68 ((PERIPH) == GPIOB) || \
70 /** @defgroup Configuration_Mode_enumeration
75 GPIO_Mode_IN = 0x00, /*!< GPIO Input Mode */
76 GPIO_Mode_OUT = 0x01, /*!< GPIO Output Mode */
77 GPIO_Mode_AF = 0x02, /*!< GPIO Alternate function Mode */
78 GPIO_Mode_AN = 0x03 /*!< GPIO Analog In/Out Mode */
81 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_Mode_IN)|| ((MODE) == GPIO_Mode_OUT) || \
82 ((MODE) == GPIO_Mode_AF)|| ((MODE) == GPIO_Mode_AN))
87 /** @defgroup Output_type_enumeration
96 #define IS_GPIO_OTYPE(OTYPE) (((OTYPE) == GPIO_OType_PP) || ((OTYPE) == GPIO_OType_OD))
102 /** @defgroup Output_Maximum_frequency_enumeration
107 GPIO_Speed_Level_1 = 0x01, /*!< Fast Speed */
108 GPIO_Speed_Level_2 = 0x02, /*!< Meduim Speed */
109 GPIO_Speed_Level_3 = 0x03 /*!< High Speed */
112 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_Speed_Level_1) || ((SPEED) == GPIO_Speed_Level_2) || \
113 ((SPEED) == GPIO_Speed_Level_3))
118 /** @defgroup Configuration_Pull-Up_Pull-Down_enumeration
123 GPIO_PuPd_NOPULL = 0x00,
125 GPIO_PuPd_DOWN = 0x02
128 #define IS_GPIO_PUPD(PUPD) (((PUPD) == GPIO_PuPd_NOPULL) || ((PUPD) == GPIO_PuPd_UP) || \
129 ((PUPD) == GPIO_PuPd_DOWN))
134 /** @defgroup Bit_SET_and_Bit_RESET_enumeration
143 #define IS_GPIO_BIT_ACTION(ACTION) (((ACTION) == Bit_RESET) || ((ACTION) == Bit_SET))
149 * @brief GPIO Init structure definition
153 uint32_t GPIO_Pin; /*!< Specifies the GPIO pins to be configured.
154 This parameter can be any value of @ref GPIO_pins_define */
156 GPIOMode_TypeDef GPIO_Mode; /*!< Specifies the operating mode for the selected pins.
157 This parameter can be a value of @ref GPIOMode_TypeDef */
159 GPIOSpeed_TypeDef GPIO_Speed; /*!< Specifies the speed for the selected pins.
160 This parameter can be a value of @ref GPIOSpeed_TypeDef */
162 GPIOOType_TypeDef GPIO_OType; /*!< Specifies the operating output type for the selected pins.
163 This parameter can be a value of @ref GPIOOType_TypeDef */
165 GPIOPuPd_TypeDef GPIO_PuPd; /*!< Specifies the operating Pull-up/Pull down for the selected pins.
166 This parameter can be a value of @ref GPIOPuPd_TypeDef */
169 /* Exported constants --------------------------------------------------------*/
171 /** @defgroup GPIO_Exported_Constants
175 /** @defgroup GPIO_pins_define
178 #define GPIO_Pin_0 ((uint16_t)0x0001) /*!< Pin 0 selected */
179 #define GPIO_Pin_1 ((uint16_t)0x0002) /*!< Pin 1 selected */
180 #define GPIO_Pin_2 ((uint16_t)0x0004) /*!< Pin 2 selected */
181 #define GPIO_Pin_3 ((uint16_t)0x0008) /*!< Pin 3 selected */
182 #define GPIO_Pin_4 ((uint16_t)0x0010) /*!< Pin 4 selected */
183 #define GPIO_Pin_5 ((uint16_t)0x0020) /*!< Pin 5 selected */
184 #define GPIO_Pin_6 ((uint16_t)0x0040) /*!< Pin 6 selected */
185 #define GPIO_Pin_7 ((uint16_t)0x0080) /*!< Pin 7 selected */
186 #define GPIO_Pin_8 ((uint16_t)0x0100) /*!< Pin 8 selected */
187 #define GPIO_Pin_9 ((uint16_t)0x0200) /*!< Pin 9 selected */
188 #define GPIO_Pin_10 ((uint16_t)0x0400) /*!< Pin 10 selected */
189 #define GPIO_Pin_11 ((uint16_t)0x0800) /*!< Pin 11 selected */
190 #define GPIO_Pin_12 ((uint16_t)0x1000) /*!< Pin 12 selected */
191 #define GPIO_Pin_13 ((uint16_t)0x2000) /*!< Pin 13 selected */
192 #define GPIO_Pin_14 ((uint16_t)0x4000) /*!< Pin 14 selected */
193 #define GPIO_Pin_15 ((uint16_t)0x8000) /*!< Pin 15 selected */
194 #define GPIO_Pin_All ((uint16_t)0xFFFF) /*!< All pins selected */
196 #define IS_GPIO_PIN(PIN) ((PIN) != (uint16_t)0x00)
198 #define IS_GET_GPIO_PIN(PIN) (((PIN) == GPIO_Pin_0) || \
199 ((PIN) == GPIO_Pin_1) || \
200 ((PIN) == GPIO_Pin_2) || \
201 ((PIN) == GPIO_Pin_3) || \
202 ((PIN) == GPIO_Pin_4) || \
203 ((PIN) == GPIO_Pin_5) || \
204 ((PIN) == GPIO_Pin_6) || \
205 ((PIN) == GPIO_Pin_7) || \
206 ((PIN) == GPIO_Pin_8) || \
207 ((PIN) == GPIO_Pin_9) || \
208 ((PIN) == GPIO_Pin_10) || \
209 ((PIN) == GPIO_Pin_11) || \
210 ((PIN) == GPIO_Pin_12) || \
211 ((PIN) == GPIO_Pin_13) || \
212 ((PIN) == GPIO_Pin_14) || \
213 ((PIN) == GPIO_Pin_15))
219 /** @defgroup GPIO_Pin_sources
222 #define GPIO_PinSource0 ((uint8_t)0x00)
223 #define GPIO_PinSource1 ((uint8_t)0x01)
224 #define GPIO_PinSource2 ((uint8_t)0x02)
225 #define GPIO_PinSource3 ((uint8_t)0x03)
226 #define GPIO_PinSource4 ((uint8_t)0x04)
227 #define GPIO_PinSource5 ((uint8_t)0x05)
228 #define GPIO_PinSource6 ((uint8_t)0x06)
229 #define GPIO_PinSource7 ((uint8_t)0x07)
230 #define GPIO_PinSource8 ((uint8_t)0x08)
231 #define GPIO_PinSource9 ((uint8_t)0x09)
232 #define GPIO_PinSource10 ((uint8_t)0x0A)
233 #define GPIO_PinSource11 ((uint8_t)0x0B)
234 #define GPIO_PinSource12 ((uint8_t)0x0C)
235 #define GPIO_PinSource13 ((uint8_t)0x0D)
236 #define GPIO_PinSource14 ((uint8_t)0x0E)
237 #define GPIO_PinSource15 ((uint8_t)0x0F)
239 #define IS_GPIO_PIN_SOURCE(PINSOURCE) (((PINSOURCE) == GPIO_PinSource0) || \
240 ((PINSOURCE) == GPIO_PinSource1) || \
241 ((PINSOURCE) == GPIO_PinSource2) || \
242 ((PINSOURCE) == GPIO_PinSource3) || \
243 ((PINSOURCE) == GPIO_PinSource4) || \
244 ((PINSOURCE) == GPIO_PinSource5) || \
245 ((PINSOURCE) == GPIO_PinSource6) || \
246 ((PINSOURCE) == GPIO_PinSource7) || \
247 ((PINSOURCE) == GPIO_PinSource8) || \
248 ((PINSOURCE) == GPIO_PinSource9) || \
249 ((PINSOURCE) == GPIO_PinSource10) || \
250 ((PINSOURCE) == GPIO_PinSource11) || \
251 ((PINSOURCE) == GPIO_PinSource12) || \
252 ((PINSOURCE) == GPIO_PinSource13) || \
253 ((PINSOURCE) == GPIO_PinSource14) || \
254 ((PINSOURCE) == GPIO_PinSource15))
259 /** @defgroup GPIO_Alternate_function_selection_define
264 * @brief AF 0 selection
266 #define GPIO_AF_0 ((uint8_t)0x00) /* JTCK-SWCLK, JTDI, JTDO/TRACESW0, JTMS-SWDAT,
267 MCO, NJTRST, TRACED, TRACECK */
269 * @brief AF 1 selection
271 #define GPIO_AF_1 ((uint8_t)0x01) /* OUT, TIM2, TIM15, TIM16, TIM17 */
274 * @brief AF 2 selection
276 #define GPIO_AF_2 ((uint8_t)0x02) /* COMP1_OUT, TIM1, TIM2, TIM3, TIM4, TIM8, TIM15, TIM16 */
279 * @brief AF 3 selection
281 #define GPIO_AF_3 ((uint8_t)0x03) /* COMP7_OUT, TIM8, TIM15, Touch, HRTIM1 */
284 * @brief AF 4 selection
286 #define GPIO_AF_4 ((uint8_t)0x04) /* I2C1, I2C2, TIM1, TIM8, TIM16, TIM17 */
289 * @brief AF 5 selection
291 #define GPIO_AF_5 ((uint8_t)0x05) /* IR_OUT, I2S2, I2S3, SPI1, SPI2, TIM8, USART4, USART5 */
294 * @brief AF 6 selection
296 #define GPIO_AF_6 ((uint8_t)0x06) /* IR_OUT, I2S2, I2S3, SPI2, SPI3, TIM1, TIM8 */
299 * @brief AF 7 selection
301 #define GPIO_AF_7 ((uint8_t)0x07) /* AOP2_OUT, CAN, COMP3_OUT, COMP5_OUT, COMP6_OUT,
302 USART1, USART2, USART3 */
305 * @brief AF 8 selection
307 #define GPIO_AF_8 ((uint8_t)0x08) /* COMP1_OUT, COMP2_OUT, COMP3_OUT, COMP4_OUT,
308 COMP5_OUT, COMP6_OUT */
311 * @brief AF 9 selection
313 #define GPIO_AF_9 ((uint8_t)0x09) /* AOP4_OUT, CAN, TIM1, TIM8, TIM15 */
316 * @brief AF 10 selection
318 #define GPIO_AF_10 ((uint8_t)0x0A) /* AOP1_OUT, AOP3_OUT, TIM2, TIM3, TIM4, TIM8, TIM17 */
321 * @brief AF 11 selection
323 #define GPIO_AF_11 ((uint8_t)0x0B) /* TIM1, TIM8 */
326 * @brief AF 12 selection
328 #define GPIO_AF_12 ((uint8_t)0x0C) /* TIM1, HRTIM1 */
331 * @brief AF 13 selection
333 #define GPIO_AF_13 ((uint8_t)0x0D) /* HRTIM1, AOP2_OUT */
336 * @brief AF 14 selection
338 #define GPIO_AF_14 ((uint8_t)0x0E) /* USBDM, USBDP */
341 * @brief AF 15 selection
343 #define GPIO_AF_15 ((uint8_t)0x0F) /* OUT */
345 #define IS_GPIO_AF(AF) (((AF) == GPIO_AF_0)||((AF) == GPIO_AF_1)||\
346 ((AF) == GPIO_AF_2)||((AF) == GPIO_AF_3)||\
347 ((AF) == GPIO_AF_4)||((AF) == GPIO_AF_5)||\
348 ((AF) == GPIO_AF_6)||((AF) == GPIO_AF_7)||\
349 ((AF) == GPIO_AF_8)||((AF) == GPIO_AF_9)||\
350 ((AF) == GPIO_AF_10)||((AF) == GPIO_AF_11)||\
351 ((AF) == GPIO_AF_12)||((AF) == GPIO_AF_13)||\
352 ((AF) == GPIO_AF_14)||((AF) == GPIO_AF_15))
358 /** @defgroup GPIO_Speed_Legacy
362 #define GPIO_Speed_10MHz GPIO_Speed_Level_1 /*!< Fast Speed:10MHz */
363 #define GPIO_Speed_2MHz GPIO_Speed_Level_2 /*!< Medium Speed:2MHz */
364 #define GPIO_Speed_50MHz GPIO_Speed_Level_3 /*!< High Speed:50MHz */
374 /* Exported macro ------------------------------------------------------------*/
375 /* Exported functions ------------------------------------------------------- */
376 /* Function used to set the GPIO configuration to the default reset state *****/
377 void GPIO_DeInit(GPIO_TypeDef* GPIOx);
379 /* Initialization and Configuration functions *********************************/
380 void GPIO_Init(GPIO_TypeDef* GPIOx, GPIO_InitTypeDef* GPIO_InitStruct);
381 void GPIO_StructInit(GPIO_InitTypeDef* GPIO_InitStruct);
382 void GPIO_PinLockConfig(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
384 /* GPIO Read and Write functions **********************************************/
385 uint8_t GPIO_ReadInputDataBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
386 uint16_t GPIO_ReadInputData(GPIO_TypeDef* GPIOx);
387 uint8_t GPIO_ReadOutputDataBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
388 uint16_t GPIO_ReadOutputData(GPIO_TypeDef* GPIOx);
389 void GPIO_SetBits(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
390 void GPIO_ResetBits(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
391 void GPIO_WriteBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, BitAction BitVal);
392 void GPIO_Write(GPIO_TypeDef* GPIOx, uint16_t PortVal);
394 /* GPIO Alternate functions configuration functions ***************************/
395 void GPIO_PinAFConfig(GPIO_TypeDef* GPIOx, uint16_t GPIO_PinSource, uint8_t GPIO_AF);
401 #endif /* __STM32F30x_GPIO_H */
410 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/