lib/main/STM32G4/Drivers/STM32G4xx_HAL_Driver/Inc/stm32g4xx_hal_gpio.h

   1 /**
   2   ******************************************************************************
   3   * @file    stm32g4xx_hal_gpio.h
   4   * @author  MCD Application Team
   5   * @brief   Header file of GPIO HAL module.
   6   ******************************************************************************
   7   * @attention
   8   *
   9   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
  10   * All rights reserved.</center></h2>
  11   *
  12   * This software component is licensed by ST under BSD 3-Clause license,
  13   * the "License"; You may not use this file except in compliance with the
  14   * License. You may obtain a copy of the License at:
  15   *                        opensource.org/licenses/BSD-3-Clause
  16   *
  17   ******************************************************************************
  18   */
  19
  20 /* Define to prevent recursive inclusion -------------------------------------*/
  21 #ifndef STM32G4xx_HAL_GPIO_H
  22 #define STM32G4xx_HAL_GPIO_H
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif
  27
  28 /* Includes ------------------------------------------------------------------*/
  29 #include "stm32g4xx_hal_def.h"
  30
  31 /** @addtogroup STM32G4xx_HAL_Driver
  32   * @{
  33   */
  34
  35 /** @defgroup GPIO GPIO
  36   * @brief GPIO HAL module driver
  37   * @{
  38   */
  39
  40 /* Exported types ------------------------------------------------------------*/
  41
  42 /** @defgroup GPIO_Exported_Types GPIO Exported Types
  43   * @{
  44   */
  45 /**
  46   * @brief   GPIO Init structure definition
  47   */
  48 typedef struct
  49 {
  50   uint32_t Pin;        /*!< Specifies the GPIO pins to be configured.
  51                            This parameter can be any value of @ref GPIO_pins */
  52
  53   uint32_t Mode;       /*!< Specifies the operating mode for the selected pins.
  54                            This parameter can be a value of @ref GPIO_mode */
  55
  56   uint32_t Pull;       /*!< Specifies the Pull-up or Pull-Down activation for the selected pins.
  57                            This parameter can be a value of @ref GPIO_pull */
  58
  59   uint32_t Speed;      /*!< Specifies the speed for the selected pins.
  60                            This parameter can be a value of @ref GPIO_speed */
  61
  62   uint32_t Alternate;  /*!< Peripheral to be connected to the selected pins
  63                             This parameter can be a value of @ref GPIOEx_Alternate_function_selection */
  64 } GPIO_InitTypeDef;
  65
  66 /**
  67   * @brief  GPIO Bit SET and Bit RESET enumeration
  68   */
  69 typedef enum
  70 {
  71   GPIO_PIN_RESET = 0U,
  72   GPIO_PIN_SET
  73 } GPIO_PinState;
  74 /**
  75   * @}
  76   */
  77
  78 /* Exported constants --------------------------------------------------------*/
  79 /** @defgroup GPIO_Exported_Constants GPIO Exported Constants
  80   * @{
  81   */
  82 /** @defgroup GPIO_pins GPIO pins
  83   * @{
  84   */
  85 #define GPIO_PIN_0                 ((uint16_t)0x0001)  /* Pin 0 selected    */
  86 #define GPIO_PIN_1                 ((uint16_t)0x0002)  /* Pin 1 selected    */
  87 #define GPIO_PIN_2                 ((uint16_t)0x0004)  /* Pin 2 selected    */
  88 #define GPIO_PIN_3                 ((uint16_t)0x0008)  /* Pin 3 selected    */
  89 #define GPIO_PIN_4                 ((uint16_t)0x0010)  /* Pin 4 selected    */
  90 #define GPIO_PIN_5                 ((uint16_t)0x0020)  /* Pin 5 selected    */
  91 #define GPIO_PIN_6                 ((uint16_t)0x0040)  /* Pin 6 selected    */
  92 #define GPIO_PIN_7                 ((uint16_t)0x0080)  /* Pin 7 selected    */
  93 #define GPIO_PIN_8                 ((uint16_t)0x0100)  /* Pin 8 selected    */
  94 #define GPIO_PIN_9                 ((uint16_t)0x0200)  /* Pin 9 selected    */
  95 #define GPIO_PIN_10                ((uint16_t)0x0400)  /* Pin 10 selected   */
  96 #define GPIO_PIN_11                ((uint16_t)0x0800)  /* Pin 11 selected   */
  97 #define GPIO_PIN_12                ((uint16_t)0x1000)  /* Pin 12 selected   */
  98 #define GPIO_PIN_13                ((uint16_t)0x2000)  /* Pin 13 selected   */
  99 #define GPIO_PIN_14                ((uint16_t)0x4000)  /* Pin 14 selected   */
 100 #define GPIO_PIN_15                ((uint16_t)0x8000)  /* Pin 15 selected   */
 101 #define GPIO_PIN_All               ((uint16_t)0xFFFF)  /* All pins selected */
 102
 103 #define GPIO_PIN_MASK              (0x0000FFFFU) /* PIN mask for assert test */
 104 /**
 105   * @}
 106   */
 107
 108 /** @defgroup GPIO_mode GPIO mode
 109   * @brief GPIO Configuration Mode
 110   *        Elements values convention: 0xX0yz00YZ
 111   *           - X  : GPIO mode or EXTI Mode
 112   *           - y  : External IT or Event trigger detection
 113   *           - z  : IO configuration on External IT or Event
 114   *           - Y  : Output type (Push Pull or Open Drain)
 115   *           - Z  : IO Direction mode (Input, Output, Alternate or Analog)
 116   * @{
 117   */
 118 #define  GPIO_MODE_INPUT                        (0x00000000U)   /*!< Input Floating Mode                   */
 119 #define  GPIO_MODE_OUTPUT_PP                    (0x00000001U)   /*!< Output Push Pull Mode                 */
 120 #define  GPIO_MODE_OUTPUT_OD                    (0x00000011U)   /*!< Output Open Drain Mode                */
 121 #define  GPIO_MODE_AF_PP                        (0x00000002U)   /*!< Alternate Function Push Pull Mode     */
 122 #define  GPIO_MODE_AF_OD                        (0x00000012U)   /*!< Alternate Function Open Drain Mode    */
 123 #define  GPIO_MODE_ANALOG                       (0x00000003U)   /*!< Analog Mode  */
 124 #define  GPIO_MODE_IT_RISING                    (0x10110000U)   /*!< External Interrupt Mode with Rising edge trigger detection          */
 125 #define  GPIO_MODE_IT_FALLING                   (0x10210000U)   /*!< External Interrupt Mode with Falling edge trigger detection         */
 126 #define  GPIO_MODE_IT_RISING_FALLING            (0x10310000U)   /*!< External Interrupt Mode with Rising/Falling edge trigger detection  */
 127 #define  GPIO_MODE_EVT_RISING                   (0x10120000U)   /*!< External Event Mode with Rising edge trigger detection              */
 128 #define  GPIO_MODE_EVT_FALLING                  (0x10220000U)   /*!< External Event Mode with Falling edge trigger detection             */
 129 #define  GPIO_MODE_EVT_RISING_FALLING           (0x10320000U)   /*!< External Event Mode with Rising/Falling edge trigger detection      */
 130 /**
 131   * @}
 132   */
 133
 134 /** @defgroup GPIO_speed GPIO speed
 135   * @brief GPIO Output Maximum frequency
 136   * @{
 137   */
 138 #define  GPIO_SPEED_FREQ_LOW        (0x00000000U)   /*!< range up to 5 MHz, please refer to the product datasheet */
 139 #define  GPIO_SPEED_FREQ_MEDIUM     (0x00000001U)   /*!< range  5 MHz to 25 MHz, please refer to the product datasheet */
 140 #define  GPIO_SPEED_FREQ_HIGH       (0x00000002U)   /*!< range 25 MHz to 50 MHz, please refer to the product datasheet */
 141 #define  GPIO_SPEED_FREQ_VERY_HIGH  (0x00000003U)   /*!< range 50 MHz to 120 MHz, please refer to the product datasheet */
 142 /**
 143   * @}
 144   */
 145
 146 /** @defgroup GPIO_pull GPIO pull
 147   * @brief GPIO Pull-Up or Pull-Down Activation
 148   * @{
 149   */
 150 #define  GPIO_NOPULL        (0x00000000U)   /*!< No Pull-up or Pull-down activation  */
 151 #define  GPIO_PULLUP        (0x00000001U)   /*!< Pull-up activation                  */
 152 #define  GPIO_PULLDOWN      (0x00000002U)   /*!< Pull-down activation                */
 153 /**
 154   * @}
 155   */
 156
 157 /**
 158   * @}
 159   */
 160
 161 /* Exported macro ------------------------------------------------------------*/
 162 /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
 163   * @{
 164   */
 165
 166 /**
 167   * @brief  Check whether the specified EXTI line flag is set or not.
 168   * @param  __EXTI_LINE__ specifies the EXTI line flag to check.
 169   *         This parameter can be GPIO_PIN_x where x can be(0..15)
 170   * @retval The new state of __EXTI_LINE__ (SET or RESET).
 171   */
 172 #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__)       (EXTI->PR1 & (__EXTI_LINE__))
 173
 174 /**
 175   * @brief  Clear the EXTI's line pending flags.
 176   * @param  __EXTI_LINE__ specifies the EXTI lines flags to clear.
 177   *         This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
 178   * @retval None
 179   */
 180 #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__)     (EXTI->PR1 = (__EXTI_LINE__))
 181
 182 /**
 183   * @brief  Check whether the specified EXTI line is asserted or not.
 184   * @param  __EXTI_LINE__ specifies the EXTI line to check.
 185   *          This parameter can be GPIO_PIN_x where x can be(0..15)
 186   * @retval The new state of __EXTI_LINE__ (SET or RESET).
 187   */
 188 #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__)         (EXTI->PR1 & (__EXTI_LINE__))
 189
 190 /**
 191   * @brief  Clear the EXTI's line pending bits.
 192   * @param  __EXTI_LINE__ specifies the EXTI lines to clear.
 193   *          This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
 194   * @retval None
 195   */
 196 #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__)       (EXTI->PR1 = (__EXTI_LINE__))
 197
 198 /**
 199   * @brief  Generate a Software interrupt on selected EXTI line.
 200   * @param  __EXTI_LINE__ specifies the EXTI line to check.
 201   *          This parameter can be GPIO_PIN_x where x can be(0..15)
 202   * @retval None
 203   */
 204 #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__)  (EXTI->SWIER1 |= (__EXTI_LINE__))
 205
 206 /**
 207   * @}
 208   */
 209
 210 /* Private macros ------------------------------------------------------------*/
 211 /** @defgroup GPIO_Private_Macros GPIO Private Macros
 212   * @{
 213   */
 214 #define IS_GPIO_PIN_ACTION(ACTION)  (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
 215
 216 #define IS_GPIO_PIN(__PIN__)        ((((__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\
 217                                      (((__PIN__) & ~GPIO_PIN_MASK) == 0x00U))
 218
 219 #define IS_GPIO_MODE(__MODE__)      (((__MODE__) == GPIO_MODE_INPUT)              ||\
 220                                      ((__MODE__) == GPIO_MODE_OUTPUT_PP)          ||\
 221                                      ((__MODE__) == GPIO_MODE_OUTPUT_OD)          ||\
 222                                      ((__MODE__) == GPIO_MODE_AF_PP)              ||\
 223                                      ((__MODE__) == GPIO_MODE_AF_OD)              ||\
 224                                      ((__MODE__) == GPIO_MODE_IT_RISING)          ||\
 225                                      ((__MODE__) == GPIO_MODE_IT_FALLING)         ||\
 226                                      ((__MODE__) == GPIO_MODE_IT_RISING_FALLING)  ||\
 227                                      ((__MODE__) == GPIO_MODE_EVT_RISING)         ||\
 228                                      ((__MODE__) == GPIO_MODE_EVT_FALLING)        ||\
 229                                      ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\
 230                                      ((__MODE__) == GPIO_MODE_ANALOG))
 231
 232 #define IS_GPIO_SPEED(__SPEED__)    (((__SPEED__) == GPIO_SPEED_FREQ_LOW)       ||\
 233                                      ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM)    ||\
 234                                      ((__SPEED__) == GPIO_SPEED_FREQ_HIGH)      ||\
 235                                      ((__SPEED__) == GPIO_SPEED_FREQ_VERY_HIGH))
 236
 237 #define IS_GPIO_PULL(__PULL__)      (((__PULL__) == GPIO_NOPULL)   ||\
 238                                      ((__PULL__) == GPIO_PULLUP)   || \
 239                                      ((__PULL__) == GPIO_PULLDOWN))
 240 /**
 241   * @}
 242   */
 243
 244 /* Include GPIO HAL Extended module */
 245 #include "stm32g4xx_hal_gpio_ex.h"
 246
 247 /* Exported functions --------------------------------------------------------*/
 248 /** @defgroup GPIO_Exported_Functions GPIO Exported Functions
 249   *  @brief    GPIO Exported Functions
 250   * @{
 251   */
 252
 253 /** @defgroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions
 254   *  @brief    Initialization and Configuration functions
 255   * @{
 256   */
 257
 258 /* Initialization and de-initialization functions *****************************/
 259 void              HAL_GPIO_Init(GPIO_TypeDef  *GPIOx, GPIO_InitTypeDef *GPIO_Init);
 260 void              HAL_GPIO_DeInit(GPIO_TypeDef  *GPIOx, uint32_t GPIO_Pin);
 261
 262 /**
 263   * @}
 264   */
 265
 266 /** @defgroup GPIO_Exported_Functions_Group2 IO operation functions
 267   *  @brief    IO operation functions
 268   * @{
 269   */
 270
 271 /* IO operation functions *****************************************************/
 272 GPIO_PinState     HAL_GPIO_ReadPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
 273 void              HAL_GPIO_WritePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
 274 void              HAL_GPIO_TogglePin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
 275 HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef *GPIOx, uint16_t GPIO_Pin);
 276 void              HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
 277 void              HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
 278
 279 /**
 280   * @}
 281   */
 282
 283 /**
 284   * @}
 285   */
 286
 287 /**
 288   * @}
 289   */
 290
 291 /**
 292   * @}
 293   */
 294
 295 #ifdef __cplusplus
 296 }
 297 #endif
 298
 299 #endif /* STM32G4xx_HAL_GPIO_H */
 300
 301 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/