lib/main/STM32F1/Drivers/STM32F1xx_HAL_Driver/Inc/stm32f1xx_hal_gpio.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32f1xx_hal_gpio.h
   4   * @author  MCD Application Team
   5   * @version V1.1.1
   6   * @date    12-May-2017
   7   * @brief   Header file of GPIO HAL module.
   8   ******************************************************************************
   9   * @attention
  10   *
  11   * <h2><center>&copy; COPYRIGHT(c) 2016 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 __STM32F1xx_HAL_GPIO_H
  40 #define __STM32F1xx_HAL_GPIO_H
  41
  42 #ifdef __cplusplus
  43  extern "C" {
  44 #endif
  45
  46 /* Includes ------------------------------------------------------------------*/
  47 #include "stm32f1xx_hal_def.h"
  48
  49 /** @addtogroup STM32F1xx_HAL_Driver
  50   * @{
  51   */
  52
  53 /** @addtogroup GPIO
  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 }GPIO_InitTypeDef;
  79
  80 /**
  81   * @brief  GPIO Bit SET and Bit RESET enumeration
  82   */
  83 typedef enum
  84 {
  85   GPIO_PIN_RESET = 0U,
  86   GPIO_PIN_SET
  87 }GPIO_PinState;
  88 /**
  89   * @}
  90   */
  91
  92 /* Exported constants --------------------------------------------------------*/
  93
  94 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants
  95   * @{
  96   */
  97
  98 /** @defgroup GPIO_pins_define GPIO pins define
  99   * @{
 100   */
 101 #define GPIO_PIN_0                 ((uint16_t)0x0001)  /* Pin 0 selected    */
 102 #define GPIO_PIN_1                 ((uint16_t)0x0002)  /* Pin 1 selected    */
 103 #define GPIO_PIN_2                 ((uint16_t)0x0004)  /* Pin 2 selected    */
 104 #define GPIO_PIN_3                 ((uint16_t)0x0008)  /* Pin 3 selected    */
 105 #define GPIO_PIN_4                 ((uint16_t)0x0010)  /* Pin 4 selected    */
 106 #define GPIO_PIN_5                 ((uint16_t)0x0020)  /* Pin 5 selected    */
 107 #define GPIO_PIN_6                 ((uint16_t)0x0040)  /* Pin 6 selected    */
 108 #define GPIO_PIN_7                 ((uint16_t)0x0080)  /* Pin 7 selected    */
 109 #define GPIO_PIN_8                 ((uint16_t)0x0100)  /* Pin 8 selected    */
 110 #define GPIO_PIN_9                 ((uint16_t)0x0200)  /* Pin 9 selected    */
 111 #define GPIO_PIN_10                ((uint16_t)0x0400)  /* Pin 10 selected   */
 112 #define GPIO_PIN_11                ((uint16_t)0x0800)  /* Pin 11 selected   */
 113 #define GPIO_PIN_12                ((uint16_t)0x1000)  /* Pin 12 selected   */
 114 #define GPIO_PIN_13                ((uint16_t)0x2000)  /* Pin 13 selected   */
 115 #define GPIO_PIN_14                ((uint16_t)0x4000)  /* Pin 14 selected   */
 116 #define GPIO_PIN_15                ((uint16_t)0x8000)  /* Pin 15 selected   */
 117 #define GPIO_PIN_All               ((uint16_t)0xFFFF)  /* All pins selected */
 118
 119 #define GPIO_PIN_MASK              0x0000FFFFU /* PIN mask for assert test */
 120 /**
 121   * @}
 122   */
 123
 124 /** @defgroup GPIO_mode_define 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                        0x00000000U   /*!< Input Floating Mode                   */
 135 #define  GPIO_MODE_OUTPUT_PP                    0x00000001U   /*!< Output Push Pull Mode                 */
 136 #define  GPIO_MODE_OUTPUT_OD                    0x00000011U   /*!< Output Open Drain Mode                */
 137 #define  GPIO_MODE_AF_PP                        0x00000002U   /*!< Alternate Function Push Pull Mode     */
 138 #define  GPIO_MODE_AF_OD                        0x00000012U   /*!< Alternate Function Open Drain Mode    */
 139 #define  GPIO_MODE_AF_INPUT                     GPIO_MODE_INPUT          /*!< Alternate Function Input Mode         */
 140
 141 #define  GPIO_MODE_ANALOG                       0x00000003U   /*!< Analog Mode  */
 142
 143 #define  GPIO_MODE_IT_RISING                    0x10110000U   /*!< External Interrupt Mode with Rising edge trigger detection          */
 144 #define  GPIO_MODE_IT_FALLING                   0x10210000U   /*!< External Interrupt Mode with Falling edge trigger detection         */
 145 #define  GPIO_MODE_IT_RISING_FALLING            0x10310000U   /*!< External Interrupt Mode with Rising/Falling edge trigger detection  */
 146
 147 #define  GPIO_MODE_EVT_RISING                   0x10120000U   /*!< External Event Mode with Rising edge trigger detection               */
 148 #define  GPIO_MODE_EVT_FALLING                  0x10220000U   /*!< External Event Mode with Falling edge trigger detection              */
 149 #define  GPIO_MODE_EVT_RISING_FALLING           0x10320000U   /*!< External Event Mode with Rising/Falling edge trigger detection       */
 150
 151 /**
 152   * @}
 153   */
 154
 155 /** @defgroup GPIO_speed_define  GPIO speed define
 156   * @brief GPIO Output Maximum frequency
 157   * @{
 158   */
 159 #define  GPIO_SPEED_FREQ_LOW              (GPIO_CRL_MODE0_1) /*!< Low speed */
 160 #define  GPIO_SPEED_FREQ_MEDIUM           (GPIO_CRL_MODE0_0) /*!< Medium speed */
 161 #define  GPIO_SPEED_FREQ_HIGH             (GPIO_CRL_MODE0)   /*!< High speed */
 162
 163 /**
 164   * @}
 165   */
 166
 167  /** @defgroup GPIO_pull_define GPIO pull define
 168    * @brief GPIO Pull-Up or Pull-Down Activation
 169    * @{
 170    */
 171 #define  GPIO_NOPULL        0x00000000U   /*!< No Pull-up or Pull-down activation  */
 172 #define  GPIO_PULLUP        0x00000001U   /*!< Pull-up activation                  */
 173 #define  GPIO_PULLDOWN      0x00000002U   /*!< Pull-down activation                */
 174 /**
 175   * @}
 176   */
 177
 178 /**
 179   * @}
 180   */
 181
 182 /* Exported macro ------------------------------------------------------------*/
 183 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
 184   * @{
 185   */
 186
 187 /**
 188   * @brief  Checks whether the specified EXTI line flag is set or not.
 189   * @param  __EXTI_LINE__: specifies the EXTI line flag to check.
 190   *         This parameter can be GPIO_PIN_x where x can be(0..15)
 191   * @retval The new state of __EXTI_LINE__ (SET or RESET).
 192   */
 193 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
 194
 195 /**
 196   * @brief  Clears the EXTI's line pending flags.
 197   * @param  __EXTI_LINE__: specifies the EXTI lines flags to clear.
 198   *         This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
 199   * @retval None
 200   */
 201 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
 202
 203 /**
 204   * @brief  Checks whether the specified EXTI line is asserted or not.
 205   * @param  __EXTI_LINE__: specifies the EXTI line to check.
 206   *          This parameter can be GPIO_PIN_x where x can be(0..15)
 207   * @retval The new state of __EXTI_LINE__ (SET or RESET).
 208   */
 209 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
 210
 211 /**
 212   * @brief  Clears the EXTI's line pending bits.
 213   * @param  __EXTI_LINE__: specifies the EXTI lines to clear.
 214   *          This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
 215   * @retval None
 216   */
 217 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
 218
 219 /**
 220   * @brief  Generates a Software interrupt on selected EXTI line.
 221   * @param  __EXTI_LINE__: specifies the EXTI line to check.
 222   *          This parameter can be GPIO_PIN_x where x can be(0..15)
 223   * @retval None
 224   */
 225 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
 226 /**
 227   * @}
 228   */
 229
 230 /* Include GPIO HAL Extension module */
 231 #include "stm32f1xx_hal_gpio_ex.h"
 232
 233 /* Exported functions --------------------------------------------------------*/
 234 /** @addtogroup GPIO_Exported_Functions
 235   * @{
 236   */
 237
 238 /** @addtogroup GPIO_Exported_Functions_Group1
 239   * @{
 240   */
 241 /* Initialization and de-initialization functions *****************************/
 242 void  HAL_GPIO_Init(GPIO_TypeDef  *GPIOx, GPIO_InitTypeDef *GPIO_Init);
 243 void  HAL_GPIO_DeInit(GPIO_TypeDef  *GPIOx, uint32_t GPIO_Pin);
 244 /**
 245   * @}
 246   */
 247
 248 /** @addtogroup GPIO_Exported_Functions_Group2
 249   * @{
 250   */
 251 /* IO operation functions *****************************************************/
 252 GPIO_PinState HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
 253 void HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
 254 void HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
 255 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
 256 void HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
 257 void HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
 258
 259 /**
 260   * @}
 261   */
 262
 263 /**
 264   * @}
 265   */
 266 /* Private types -------------------------------------------------------------*/
 267 /* Private variables ---------------------------------------------------------*/
 268 /* Private constants ---------------------------------------------------------*/
 269 /** @defgroup GPIO_Private_Constants GPIO Private Constants
 270   * @{
 271   */
 272
 273 /**
 274   * @}
 275   */
 276
 277 /* Private macros ------------------------------------------------------------*/
 278 /** @defgroup GPIO_Private_Macros GPIO Private Macros
 279   * @{
 280   */
 281 #define IS_GPIO_PIN_ACTION(ACTION) (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
 282 #define IS_GPIO_PIN(PIN)           ((((PIN) & GPIO_PIN_MASK ) != 0x00U) && (((PIN) & ~GPIO_PIN_MASK) == 0x00U))
 283 #define IS_GPIO_MODE(MODE) (((MODE) == GPIO_MODE_INPUT)              ||\
 284                             ((MODE) == GPIO_MODE_OUTPUT_PP)          ||\
 285                             ((MODE) == GPIO_MODE_OUTPUT_OD)          ||\
 286                             ((MODE) == GPIO_MODE_AF_PP)              ||\
 287                             ((MODE) == GPIO_MODE_AF_OD)              ||\
 288                             ((MODE) == GPIO_MODE_IT_RISING)          ||\
 289                             ((MODE) == GPIO_MODE_IT_FALLING)         ||\
 290                             ((MODE) == GPIO_MODE_IT_RISING_FALLING)  ||\
 291                             ((MODE) == GPIO_MODE_EVT_RISING)         ||\
 292                             ((MODE) == GPIO_MODE_EVT_FALLING)        ||\
 293                             ((MODE) == GPIO_MODE_EVT_RISING_FALLING) ||\
 294                             ((MODE) == GPIO_MODE_ANALOG))
 295 #define IS_GPIO_SPEED(SPEED) (((SPEED) == GPIO_SPEED_FREQ_LOW) || \
 296                               ((SPEED) == GPIO_SPEED_FREQ_MEDIUM) || ((SPEED) == GPIO_SPEED_FREQ_HIGH))
 297 #define IS_GPIO_PULL(PULL) (((PULL) == GPIO_NOPULL) || ((PULL) == GPIO_PULLUP) || \
 298                             ((PULL) == GPIO_PULLDOWN))
 299 /**
 300   * @}
 301   */
 302
 303 /* Private functions ---------------------------------------------------------*/
 304 /** @defgroup GPIO_Private_Functions GPIO Private Functions
 305   * @{
 306   */
 307
 308 /**
 309   * @}
 310   */
 311
 312 /**
 313   * @}
 314   */
 315
 316 /**
 317   * @}
 318   */
 319
 320 #ifdef __cplusplus
 321 }
 322 #endif
 323
 324 #endif /* __STM32F1xx_HAL_GPIO_H */
 325
 326 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/