STM32F10x Standard Peripherals Library  3.5.0
/opt/STM32F10x_StdPeriph_Lib_V3.5.0/Libraries/STM32F10x_StdPeriph_Driver/inc/stm32f10x_gpio.h
Go to the documentation of this file.
00001 
00023 /* Define to prevent recursive inclusion -------------------------------------*/
00024 #ifndef __STM32F10x_GPIO_H
00025 #define __STM32F10x_GPIO_H
00026 
00027 #ifdef __cplusplus
00028  extern "C" {
00029 #endif
00030 
00031 /* Includes ------------------------------------------------------------------*/
00032 #include "stm32f10x.h"
00033 
00046 #define IS_GPIO_ALL_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
00047                                     ((PERIPH) == GPIOB) || \
00048                                     ((PERIPH) == GPIOC) || \
00049                                     ((PERIPH) == GPIOD) || \
00050                                     ((PERIPH) == GPIOE) || \
00051                                     ((PERIPH) == GPIOF) || \
00052                                     ((PERIPH) == GPIOG))
00053                                      
00058 typedef enum
00059 { 
00060   GPIO_Speed_10MHz = 1,
00061   GPIO_Speed_2MHz, 
00062   GPIO_Speed_50MHz
00063 }GPIOSpeed_TypeDef;
00064 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_Speed_10MHz) || ((SPEED) == GPIO_Speed_2MHz) || \
00065                               ((SPEED) == GPIO_Speed_50MHz))
00066 
00071 typedef enum
00072 { GPIO_Mode_AIN = 0x0,
00073   GPIO_Mode_IN_FLOATING = 0x04,
00074   GPIO_Mode_IPD = 0x28,
00075   GPIO_Mode_IPU = 0x48,
00076   GPIO_Mode_Out_OD = 0x14,
00077   GPIO_Mode_Out_PP = 0x10,
00078   GPIO_Mode_AF_OD = 0x1C,
00079   GPIO_Mode_AF_PP = 0x18
00080 }GPIOMode_TypeDef;
00081 
00082 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_Mode_AIN) || ((MODE) == GPIO_Mode_IN_FLOATING) || \
00083                             ((MODE) == GPIO_Mode_IPD) || ((MODE) == GPIO_Mode_IPU) || \
00084                             ((MODE) == GPIO_Mode_Out_OD) || ((MODE) == GPIO_Mode_Out_PP) || \
00085                             ((MODE) == GPIO_Mode_AF_OD) || ((MODE) == GPIO_Mode_AF_PP))
00086 
00091 typedef struct
00092 {
00093   uint16_t GPIO_Pin;             
00096   GPIOSpeed_TypeDef GPIO_Speed;  
00099   GPIOMode_TypeDef GPIO_Mode;    
00101 }GPIO_InitTypeDef;
00102 
00103 
00108 typedef enum
00109 { Bit_RESET = 0,
00110   Bit_SET
00111 }BitAction;
00112 
00113 #define IS_GPIO_BIT_ACTION(ACTION) (((ACTION) == Bit_RESET) || ((ACTION) == Bit_SET))
00114 
00127 #define GPIO_Pin_0                 ((uint16_t)0x0001)  
00128 #define GPIO_Pin_1                 ((uint16_t)0x0002)  
00129 #define GPIO_Pin_2                 ((uint16_t)0x0004)  
00130 #define GPIO_Pin_3                 ((uint16_t)0x0008)  
00131 #define GPIO_Pin_4                 ((uint16_t)0x0010)  
00132 #define GPIO_Pin_5                 ((uint16_t)0x0020)  
00133 #define GPIO_Pin_6                 ((uint16_t)0x0040)  
00134 #define GPIO_Pin_7                 ((uint16_t)0x0080)  
00135 #define GPIO_Pin_8                 ((uint16_t)0x0100)  
00136 #define GPIO_Pin_9                 ((uint16_t)0x0200)  
00137 #define GPIO_Pin_10                ((uint16_t)0x0400)  
00138 #define GPIO_Pin_11                ((uint16_t)0x0800)  
00139 #define GPIO_Pin_12                ((uint16_t)0x1000)  
00140 #define GPIO_Pin_13                ((uint16_t)0x2000)  
00141 #define GPIO_Pin_14                ((uint16_t)0x4000)  
00142 #define GPIO_Pin_15                ((uint16_t)0x8000)  
00143 #define GPIO_Pin_All               ((uint16_t)0xFFFF)  
00145 #define IS_GPIO_PIN(PIN) ((((PIN) & (uint16_t)0x00) == 0x00) && ((PIN) != (uint16_t)0x00))
00146 
00147 #define IS_GET_GPIO_PIN(PIN) (((PIN) == GPIO_Pin_0) || \
00148                               ((PIN) == GPIO_Pin_1) || \
00149                               ((PIN) == GPIO_Pin_2) || \
00150                               ((PIN) == GPIO_Pin_3) || \
00151                               ((PIN) == GPIO_Pin_4) || \
00152                               ((PIN) == GPIO_Pin_5) || \
00153                               ((PIN) == GPIO_Pin_6) || \
00154                               ((PIN) == GPIO_Pin_7) || \
00155                               ((PIN) == GPIO_Pin_8) || \
00156                               ((PIN) == GPIO_Pin_9) || \
00157                               ((PIN) == GPIO_Pin_10) || \
00158                               ((PIN) == GPIO_Pin_11) || \
00159                               ((PIN) == GPIO_Pin_12) || \
00160                               ((PIN) == GPIO_Pin_13) || \
00161                               ((PIN) == GPIO_Pin_14) || \
00162                               ((PIN) == GPIO_Pin_15))
00163 
00172 #define GPIO_Remap_SPI1             ((uint32_t)0x00000001)  
00173 #define GPIO_Remap_I2C1             ((uint32_t)0x00000002)  
00174 #define GPIO_Remap_USART1           ((uint32_t)0x00000004)  
00175 #define GPIO_Remap_USART2           ((uint32_t)0x00000008)  
00176 #define GPIO_PartialRemap_USART3    ((uint32_t)0x00140010)  
00177 #define GPIO_FullRemap_USART3       ((uint32_t)0x00140030)  
00178 #define GPIO_PartialRemap_TIM1      ((uint32_t)0x00160040)  
00179 #define GPIO_FullRemap_TIM1         ((uint32_t)0x001600C0)  
00180 #define GPIO_PartialRemap1_TIM2     ((uint32_t)0x00180100)  
00181 #define GPIO_PartialRemap2_TIM2     ((uint32_t)0x00180200)  
00182 #define GPIO_FullRemap_TIM2         ((uint32_t)0x00180300)  
00183 #define GPIO_PartialRemap_TIM3      ((uint32_t)0x001A0800)  
00184 #define GPIO_FullRemap_TIM3         ((uint32_t)0x001A0C00)  
00185 #define GPIO_Remap_TIM4             ((uint32_t)0x00001000)  
00186 #define GPIO_Remap1_CAN1            ((uint32_t)0x001D4000)  
00187 #define GPIO_Remap2_CAN1            ((uint32_t)0x001D6000)  
00188 #define GPIO_Remap_PD01             ((uint32_t)0x00008000)  
00189 #define GPIO_Remap_TIM5CH4_LSI      ((uint32_t)0x00200001)  
00190 #define GPIO_Remap_ADC1_ETRGINJ     ((uint32_t)0x00200002)  
00191 #define GPIO_Remap_ADC1_ETRGREG     ((uint32_t)0x00200004)  
00192 #define GPIO_Remap_ADC2_ETRGINJ     ((uint32_t)0x00200008)  
00193 #define GPIO_Remap_ADC2_ETRGREG     ((uint32_t)0x00200010)  
00194 #define GPIO_Remap_ETH              ((uint32_t)0x00200020)  
00195 #define GPIO_Remap_CAN2             ((uint32_t)0x00200040)  
00196 #define GPIO_Remap_SWJ_NoJTRST      ((uint32_t)0x00300100)  
00197 #define GPIO_Remap_SWJ_JTAGDisable  ((uint32_t)0x00300200)  
00198 #define GPIO_Remap_SWJ_Disable      ((uint32_t)0x00300400)  
00199 #define GPIO_Remap_SPI3             ((uint32_t)0x00201100)  
00200 #define GPIO_Remap_TIM2ITR1_PTP_SOF ((uint32_t)0x00202000)  
00203 #define GPIO_Remap_PTP_PPS          ((uint32_t)0x00204000)  
00205 #define GPIO_Remap_TIM15            ((uint32_t)0x80000001)  
00206 #define GPIO_Remap_TIM16            ((uint32_t)0x80000002)  
00207 #define GPIO_Remap_TIM17            ((uint32_t)0x80000004)  
00208 #define GPIO_Remap_CEC              ((uint32_t)0x80000008)  
00209 #define GPIO_Remap_TIM1_DMA         ((uint32_t)0x80000010)  
00211 #define GPIO_Remap_TIM9             ((uint32_t)0x80000020)  
00212 #define GPIO_Remap_TIM10            ((uint32_t)0x80000040)  
00213 #define GPIO_Remap_TIM11            ((uint32_t)0x80000080)  
00214 #define GPIO_Remap_TIM13            ((uint32_t)0x80000100)  
00215 #define GPIO_Remap_TIM14            ((uint32_t)0x80000200)  
00216 #define GPIO_Remap_FSMC_NADV        ((uint32_t)0x80000400)  
00218 #define GPIO_Remap_TIM67_DAC_DMA    ((uint32_t)0x80000800)  
00219 #define GPIO_Remap_TIM12            ((uint32_t)0x80001000)  
00220 #define GPIO_Remap_MISC             ((uint32_t)0x80002000)  
00223 #define IS_GPIO_REMAP(REMAP) (((REMAP) == GPIO_Remap_SPI1) || ((REMAP) == GPIO_Remap_I2C1) || \
00224                               ((REMAP) == GPIO_Remap_USART1) || ((REMAP) == GPIO_Remap_USART2) || \
00225                               ((REMAP) == GPIO_PartialRemap_USART3) || ((REMAP) == GPIO_FullRemap_USART3) || \
00226                               ((REMAP) == GPIO_PartialRemap_TIM1) || ((REMAP) == GPIO_FullRemap_TIM1) || \
00227                               ((REMAP) == GPIO_PartialRemap1_TIM2) || ((REMAP) == GPIO_PartialRemap2_TIM2) || \
00228                               ((REMAP) == GPIO_FullRemap_TIM2) || ((REMAP) == GPIO_PartialRemap_TIM3) || \
00229                               ((REMAP) == GPIO_FullRemap_TIM3) || ((REMAP) == GPIO_Remap_TIM4) || \
00230                               ((REMAP) == GPIO_Remap1_CAN1) || ((REMAP) == GPIO_Remap2_CAN1) || \
00231                               ((REMAP) == GPIO_Remap_PD01) || ((REMAP) == GPIO_Remap_TIM5CH4_LSI) || \
00232                               ((REMAP) == GPIO_Remap_ADC1_ETRGINJ) ||((REMAP) == GPIO_Remap_ADC1_ETRGREG) || \
00233                               ((REMAP) == GPIO_Remap_ADC2_ETRGINJ) ||((REMAP) == GPIO_Remap_ADC2_ETRGREG) || \
00234                               ((REMAP) == GPIO_Remap_ETH) ||((REMAP) == GPIO_Remap_CAN2) || \
00235                               ((REMAP) == GPIO_Remap_SWJ_NoJTRST) || ((REMAP) == GPIO_Remap_SWJ_JTAGDisable) || \
00236                               ((REMAP) == GPIO_Remap_SWJ_Disable)|| ((REMAP) == GPIO_Remap_SPI3) || \
00237                               ((REMAP) == GPIO_Remap_TIM2ITR1_PTP_SOF) || ((REMAP) == GPIO_Remap_PTP_PPS) || \
00238                               ((REMAP) == GPIO_Remap_TIM15) || ((REMAP) == GPIO_Remap_TIM16) || \
00239                               ((REMAP) == GPIO_Remap_TIM17) || ((REMAP) == GPIO_Remap_CEC) || \
00240                               ((REMAP) == GPIO_Remap_TIM1_DMA) || ((REMAP) == GPIO_Remap_TIM9) || \
00241                               ((REMAP) == GPIO_Remap_TIM10) || ((REMAP) == GPIO_Remap_TIM11) || \
00242                               ((REMAP) == GPIO_Remap_TIM13) || ((REMAP) == GPIO_Remap_TIM14) || \
00243                               ((REMAP) == GPIO_Remap_FSMC_NADV) || ((REMAP) == GPIO_Remap_TIM67_DAC_DMA) || \
00244                               ((REMAP) == GPIO_Remap_TIM12) || ((REMAP) == GPIO_Remap_MISC))
00245                               
00254 #define GPIO_PortSourceGPIOA       ((uint8_t)0x00)
00255 #define GPIO_PortSourceGPIOB       ((uint8_t)0x01)
00256 #define GPIO_PortSourceGPIOC       ((uint8_t)0x02)
00257 #define GPIO_PortSourceGPIOD       ((uint8_t)0x03)
00258 #define GPIO_PortSourceGPIOE       ((uint8_t)0x04)
00259 #define GPIO_PortSourceGPIOF       ((uint8_t)0x05)
00260 #define GPIO_PortSourceGPIOG       ((uint8_t)0x06)
00261 #define IS_GPIO_EVENTOUT_PORT_SOURCE(PORTSOURCE) (((PORTSOURCE) == GPIO_PortSourceGPIOA) || \
00262                                                   ((PORTSOURCE) == GPIO_PortSourceGPIOB) || \
00263                                                   ((PORTSOURCE) == GPIO_PortSourceGPIOC) || \
00264                                                   ((PORTSOURCE) == GPIO_PortSourceGPIOD) || \
00265                                                   ((PORTSOURCE) == GPIO_PortSourceGPIOE))
00266 
00267 #define IS_GPIO_EXTI_PORT_SOURCE(PORTSOURCE) (((PORTSOURCE) == GPIO_PortSourceGPIOA) || \
00268                                               ((PORTSOURCE) == GPIO_PortSourceGPIOB) || \
00269                                               ((PORTSOURCE) == GPIO_PortSourceGPIOC) || \
00270                                               ((PORTSOURCE) == GPIO_PortSourceGPIOD) || \
00271                                               ((PORTSOURCE) == GPIO_PortSourceGPIOE) || \
00272                                               ((PORTSOURCE) == GPIO_PortSourceGPIOF) || \
00273                                               ((PORTSOURCE) == GPIO_PortSourceGPIOG))
00274 
00283 #define GPIO_PinSource0            ((uint8_t)0x00)
00284 #define GPIO_PinSource1            ((uint8_t)0x01)
00285 #define GPIO_PinSource2            ((uint8_t)0x02)
00286 #define GPIO_PinSource3            ((uint8_t)0x03)
00287 #define GPIO_PinSource4            ((uint8_t)0x04)
00288 #define GPIO_PinSource5            ((uint8_t)0x05)
00289 #define GPIO_PinSource6            ((uint8_t)0x06)
00290 #define GPIO_PinSource7            ((uint8_t)0x07)
00291 #define GPIO_PinSource8            ((uint8_t)0x08)
00292 #define GPIO_PinSource9            ((uint8_t)0x09)
00293 #define GPIO_PinSource10           ((uint8_t)0x0A)
00294 #define GPIO_PinSource11           ((uint8_t)0x0B)
00295 #define GPIO_PinSource12           ((uint8_t)0x0C)
00296 #define GPIO_PinSource13           ((uint8_t)0x0D)
00297 #define GPIO_PinSource14           ((uint8_t)0x0E)
00298 #define GPIO_PinSource15           ((uint8_t)0x0F)
00299 
00300 #define IS_GPIO_PIN_SOURCE(PINSOURCE) (((PINSOURCE) == GPIO_PinSource0) || \
00301                                        ((PINSOURCE) == GPIO_PinSource1) || \
00302                                        ((PINSOURCE) == GPIO_PinSource2) || \
00303                                        ((PINSOURCE) == GPIO_PinSource3) || \
00304                                        ((PINSOURCE) == GPIO_PinSource4) || \
00305                                        ((PINSOURCE) == GPIO_PinSource5) || \
00306                                        ((PINSOURCE) == GPIO_PinSource6) || \
00307                                        ((PINSOURCE) == GPIO_PinSource7) || \
00308                                        ((PINSOURCE) == GPIO_PinSource8) || \
00309                                        ((PINSOURCE) == GPIO_PinSource9) || \
00310                                        ((PINSOURCE) == GPIO_PinSource10) || \
00311                                        ((PINSOURCE) == GPIO_PinSource11) || \
00312                                        ((PINSOURCE) == GPIO_PinSource12) || \
00313                                        ((PINSOURCE) == GPIO_PinSource13) || \
00314                                        ((PINSOURCE) == GPIO_PinSource14) || \
00315                                        ((PINSOURCE) == GPIO_PinSource15))
00316 
00324 #define GPIO_ETH_MediaInterface_MII    ((u32)0x00000000) 
00325 #define GPIO_ETH_MediaInterface_RMII   ((u32)0x00000001)                                       
00326 
00327 #define IS_GPIO_ETH_MEDIA_INTERFACE(INTERFACE) (((INTERFACE) == GPIO_ETH_MediaInterface_MII) || \
00328                                                 ((INTERFACE) == GPIO_ETH_MediaInterface_RMII))
00329 
00349 void GPIO_DeInit(GPIO_TypeDef* GPIOx);
00350 void GPIO_AFIODeInit(void);
00351 void GPIO_Init(GPIO_TypeDef* GPIOx, GPIO_InitTypeDef* GPIO_InitStruct);
00352 void GPIO_StructInit(GPIO_InitTypeDef* GPIO_InitStruct);
00353 uint8_t GPIO_ReadInputDataBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
00354 uint16_t GPIO_ReadInputData(GPIO_TypeDef* GPIOx);
00355 uint8_t GPIO_ReadOutputDataBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
00356 uint16_t GPIO_ReadOutputData(GPIO_TypeDef* GPIOx);
00357 void GPIO_SetBits(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
00358 void GPIO_ResetBits(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
00359 void GPIO_WriteBit(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, BitAction BitVal);
00360 void GPIO_Write(GPIO_TypeDef* GPIOx, uint16_t PortVal);
00361 void GPIO_PinLockConfig(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
00362 void GPIO_EventOutputConfig(uint8_t GPIO_PortSource, uint8_t GPIO_PinSource);
00363 void GPIO_EventOutputCmd(FunctionalState NewState);
00364 void GPIO_PinRemapConfig(uint32_t GPIO_Remap, FunctionalState NewState);
00365 void GPIO_EXTILineConfig(uint8_t GPIO_PortSource, uint8_t GPIO_PinSource);
00366 void GPIO_ETH_MediaInterfaceConfig(uint32_t GPIO_ETH_MediaInterface);
00367 
00368 #ifdef __cplusplus
00369 }
00370 #endif
00371 
00372 #endif /* __STM32F10x_GPIO_H */
00373 
00385 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/