tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3XX/stm32f30x_gpio.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f30x_gpio.h
   4   * @author  MCD Application Team
   5   * @version V1.1.0
   6   * @date    27-February-2014
   7   * @brief   This file contains all the functions prototypes for the GPIO
   8   *          firmware library.
   9   ******************************************************************************
  10   * @attention
  11   *
  12   * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
  13   *
  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.
  24   *
  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.
  35   *
  36   ******************************************************************************
  37   */
  38
  39 /* Define to prevent recursive inclusion -------------------------------------*/
  40 #ifndef __STM32F30x_GPIO_H
  41 #define __STM32F30x_GPIO_H
  42
  43 #ifdef __cplusplus
  44  extern "C" {
  45 #endif
  46
  47 /* Includes ------------------------------------------------------------------*/
  48 #include "stm32f30x.h"
  49
  50 /** @addtogroup STM32F30x_StdPeriph_Driver
  51   * @{
  52   */
  53
  54 /** @addtogroup GPIO
  55   * @{
  56   */
  57
  58 /* Exported types ------------------------------------------------------------*/
  59
  60 #define IS_GPIO_ALL_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
  61                                     ((PERIPH) == GPIOB) || \
  62                                     ((PERIPH) == GPIOC) || \
  63                                     ((PERIPH) == GPIOD) || \
  64                                     ((PERIPH) == GPIOE) || \
  65                                     ((PERIPH) == GPIOF))
  66
  67 #define IS_GPIO_LIST_PERIPH(PERIPH) (((PERIPH) == GPIOA) || \
  68                                      ((PERIPH) == GPIOB) || \
  69                                      ((PERIPH) == GPIOD))
  70 /** @defgroup Configuration_Mode_enumeration
  71   * @{
  72   */
  73 typedef enum
  74 {
  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      */
  79 }GPIOMode_TypeDef;
  80
  81 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_Mode_IN)|| ((MODE) == GPIO_Mode_OUT) || \
  82                             ((MODE) == GPIO_Mode_AF)|| ((MODE) == GPIO_Mode_AN))
  83 /**
  84   * @}
  85   */
  86
  87 /** @defgroup Output_type_enumeration
  88   * @{
  89   */
  90 typedef enum
  91 {
  92   GPIO_OType_PP = 0x00,
  93   GPIO_OType_OD = 0x01
  94 }GPIOOType_TypeDef;
  95
  96 #define IS_GPIO_OTYPE(OTYPE) (((OTYPE) == GPIO_OType_PP) || ((OTYPE) == GPIO_OType_OD))
  97
  98 /**
  99   * @}
 100   */
 101
 102 /** @defgroup Output_Maximum_frequency_enumeration
 103   * @{
 104   */
 105 typedef enum
 106 {
 107   GPIO_Speed_Level_1  = 0x01, /*!< Fast Speed     */
 108   GPIO_Speed_Level_2  = 0x02, /*!< Meduim Speed   */
 109   GPIO_Speed_Level_3  = 0x03  /*!< High Speed     */
 110 }GPIOSpeed_TypeDef;
 111
 112 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_Speed_Level_1) || ((SPEED) == GPIO_Speed_Level_2) || \
 113                               ((SPEED) == GPIO_Speed_Level_3))
 114 /**
 115   * @}
 116   */
 117
 118 /** @defgroup Configuration_Pull-Up_Pull-Down_enumeration
 119   * @{
 120   */
 121 typedef enum
 122 {
 123   GPIO_PuPd_NOPULL = 0x00,
 124   GPIO_PuPd_UP     = 0x01,
 125   GPIO_PuPd_DOWN   = 0x02
 126 }GPIOPuPd_TypeDef;
 127
 128 #define IS_GPIO_PUPD(PUPD) (((PUPD) == GPIO_PuPd_NOPULL) || ((PUPD) == GPIO_PuPd_UP) || \
 129                             ((PUPD) == GPIO_PuPd_DOWN))
 130 /**
 131   * @}
 132   */
 133
 134 /** @defgroup Bit_SET_and_Bit_RESET_enumeration
 135   * @{
 136   */
 137 typedef enum
 138 {
 139   Bit_RESET = 0,
 140   Bit_SET
 141 }BitAction;
 142
 143 #define IS_GPIO_BIT_ACTION(ACTION) (((ACTION) == Bit_RESET) || ((ACTION) == Bit_SET))
 144 /**
 145   * @}
 146   */
 147
 148 /**
 149   * @brief  GPIO Init structure definition
 150   */
 151 typedef struct
 152 {
 153   uint32_t GPIO_Pin;              /*!< Specifies the GPIO pins to be configured.
 154                                        This parameter can be any value of @ref GPIO_pins_define */
 155
 156   GPIOMode_TypeDef GPIO_Mode;     /*!< Specifies the operating mode for the selected pins.
 157                                        This parameter can be a value of @ref GPIOMode_TypeDef   */
 158
 159   GPIOSpeed_TypeDef GPIO_Speed;   /*!< Specifies the speed for the selected pins.
 160                                        This parameter can be a value of @ref GPIOSpeed_TypeDef  */
 161
 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  */
 164
 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   */
 167 }GPIO_InitTypeDef;
 168
 169 /* Exported constants --------------------------------------------------------*/
 170
 171 /** @defgroup GPIO_Exported_Constants
 172   * @{
 173   */
 174
 175 /** @defgroup GPIO_pins_define
 176   * @{
 177   */
 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 */
 195
 196 #define IS_GPIO_PIN(PIN) ((PIN) != (uint16_t)0x00)
 197
 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))
 214
 215 /**
 216   * @}
 217   */
 218
 219 /** @defgroup GPIO_Pin_sources
 220   * @{
 221   */
 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)
 238
 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))
 255 /**
 256   * @}
 257   */
 258
 259 /** @defgroup GPIO_Alternate_function_selection_define
 260   * @{
 261   */
 262
 263 /**
 264   * @brief  AF 0 selection
 265   */
 266 #define GPIO_AF_0            ((uint8_t)0x00) /* JTCK-SWCLK, JTDI, JTDO/TRACESW0, JTMS-SWDAT,
 267                                                 MCO, NJTRST, TRACED, TRACECK */
 268 /**
 269   * @brief  AF 1 selection
 270   */
 271 #define GPIO_AF_1            ((uint8_t)0x01) /*  OUT, TIM2, TIM15, TIM16, TIM17 */
 272
 273 /**
 274   * @brief  AF 2 selection
 275   */
 276 #define GPIO_AF_2            ((uint8_t)0x02) /* COMP1_OUT, TIM1, TIM2, TIM3, TIM4, TIM8, TIM15, TIM16 */
 277
 278 /**
 279   * @brief  AF 3 selection
 280   */
 281 #define GPIO_AF_3            ((uint8_t)0x03) /* COMP7_OUT, TIM8, TIM15, Touch, HRTIM1 */
 282
 283 /**
 284   * @brief  AF 4 selection
 285   */
 286 #define GPIO_AF_4            ((uint8_t)0x04) /* I2C1, I2C2, TIM1, TIM8, TIM16, TIM17 */
 287
 288 /**
 289   * @brief  AF 5 selection
 290   */
 291 #define GPIO_AF_5            ((uint8_t)0x05) /* IR_OUT, I2S2, I2S3, SPI1, SPI2, TIM8, USART4, USART5 */
 292
 293 /**
 294   * @brief  AF 6 selection
 295   */
 296 #define GPIO_AF_6            ((uint8_t)0x06) /*  IR_OUT, I2S2, I2S3, SPI2, SPI3, TIM1, TIM8 */
 297
 298 /**
 299   * @brief  AF 7 selection
 300   */
 301 #define GPIO_AF_7            ((uint8_t)0x07) /* AOP2_OUT, CAN, COMP3_OUT, COMP5_OUT, COMP6_OUT,
 302                                                 USART1, USART2, USART3 */
 303
 304 /**
 305   * @brief  AF 8 selection
 306   */
 307 #define GPIO_AF_8            ((uint8_t)0x08) /* COMP1_OUT, COMP2_OUT, COMP3_OUT, COMP4_OUT,
 308                                                 COMP5_OUT, COMP6_OUT */
 309
 310 /**
 311   * @brief  AF 9 selection
 312   */
 313 #define GPIO_AF_9            ((uint8_t)0x09) /* AOP4_OUT, CAN, TIM1, TIM8, TIM15 */
 314
 315 /**
 316   * @brief  AF 10 selection
 317   */
 318 #define GPIO_AF_10            ((uint8_t)0x0A) /* AOP1_OUT, AOP3_OUT, TIM2, TIM3, TIM4, TIM8, TIM17 */
 319
 320 /**
 321   * @brief  AF 11 selection
 322   */
 323 #define GPIO_AF_11            ((uint8_t)0x0B) /* TIM1, TIM8 */
 324
 325 /**
 326    * @brief  AF 12 selection
 327    */
 328 #define GPIO_AF_12            ((uint8_t)0x0C) /* TIM1, HRTIM1 */
 329
 330 /**
 331    * @brief  AF 13 selection
 332    */
 333 #define GPIO_AF_13            ((uint8_t)0x0D) /* HRTIM1, AOP2_OUT */
 334
 335 /**
 336   * @brief  AF 14 selection
 337   */
 338 #define GPIO_AF_14            ((uint8_t)0x0E) /* USBDM, USBDP */
 339
 340 /**
 341   * @brief  AF 15 selection
 342   */
 343 #define GPIO_AF_15            ((uint8_t)0x0F) /* OUT */
 344
 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))
 353
 354 /**
 355   * @}
 356   */
 357
 358 /** @defgroup GPIO_Speed_Legacy
 359   * @{
 360   */
 361
 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   */
 365
 366 /**
 367   * @}
 368   */
 369
 370 /**
 371   * @}
 372   */
 373
 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);
 378
 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);
 383
 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);
 393
 394 /* GPIO Alternate functions configuration functions ***************************/
 395 void GPIO_PinAFConfig(GPIO_TypeDef* GPIOx, uint16_t GPIO_PinSource, uint8_t GPIO_AF);
 396
 397 #ifdef __cplusplus
 398 }
 399 #endif
 400
 401 #endif /* __STM32F30x_GPIO_H */
 402 /**
 403   * @}
 404   */
 405
 406 /**
 407   * @}
 408   */
 409
 410 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/