tmk_core/tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32F4/stm32f4xx_hal_gpio.h

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