tool/mbed/mbed-sdk/libraries/mbed/targets/cmsis/TARGET_STM/TARGET_STM32L0/stm32l0xx_hal_gpio.h

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