tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F3/stm32f3xx_hal_gpio.h

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