Subversion Repositories FuelGauge

Rev

Rev 2 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /**
  2.   ******************************************************************************
  3.   * @file    stm32f0xx_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) 2016 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 __STM32F0xx_HAL_GPIO_H
  22. #define __STM32F0xx_HAL_GPIO_H
  23.  
  24. #ifdef __cplusplus
  25.  extern "C" {
  26. #endif
  27.  
  28. /* Includes ------------------------------------------------------------------*/
  29. #include "stm32f0xx_hal_def.h"
  30.  
  31. /** @addtogroup STM32F0xx_HAL_Driver
  32.   * @{
  33.   */
  34.  
  35. /** @addtogroup GPIO
  36.   * @{
  37.   */
  38.  
  39. /* Exported types ------------------------------------------------------------*/
  40.  
  41. /** @defgroup GPIO_Exported_Types GPIO Exported Types
  42.   * @{
  43.   */
  44. /**
  45.   * @brief   GPIO Init structure definition  
  46.   */
  47. typedef struct
  48. {
  49.   uint32_t Pin;       /*!< Specifies the GPIO pins to be configured.
  50.                            This parameter can be any value of @ref GPIO_pins */
  51.  
  52.   uint32_t Mode;      /*!< Specifies the operating mode for the selected pins.
  53.                            This parameter can be a value of @ref GPIO_mode */
  54.  
  55.   uint32_t Pull;      /*!< Specifies the Pull-up or Pull-Down activation for the selected pins.
  56.                            This parameter can be a value of @ref GPIO_pull */
  57.  
  58.   uint32_t Speed;     /*!< Specifies the speed for the selected pins.
  59.                            This parameter can be a value of @ref GPIO_speed */
  60.  
  61.   uint32_t Alternate;  /*!< Peripheral to be connected to the selected pins
  62.                             This parameter can be a value of @ref GPIOEx_Alternate_function_selection */
  63. }GPIO_InitTypeDef;
  64.  
  65. /**
  66.   * @brief  GPIO Bit SET and Bit RESET enumeration
  67.   */
  68. typedef enum
  69. {
  70.   GPIO_PIN_RESET = 0U,
  71.   GPIO_PIN_SET
  72. }GPIO_PinState;
  73. /**
  74.   * @}
  75.   */
  76.  
  77. /* Exported constants --------------------------------------------------------*/
  78. /** @defgroup GPIO_Exported_Constants GPIO Exported Constants
  79.   * @{
  80.   */
  81. /** @defgroup GPIO_pins GPIO pins
  82.   * @{
  83.   */
  84. #define GPIO_PIN_0                 ((uint16_t)0x0001U)  /* Pin 0 selected    */
  85. #define GPIO_PIN_1                 ((uint16_t)0x0002U)  /* Pin 1 selected    */
  86. #define GPIO_PIN_2                 ((uint16_t)0x0004U)  /* Pin 2 selected    */
  87. #define GPIO_PIN_3                 ((uint16_t)0x0008U)  /* Pin 3 selected    */
  88. #define GPIO_PIN_4                 ((uint16_t)0x0010U)  /* Pin 4 selected    */
  89. #define GPIO_PIN_5                 ((uint16_t)0x0020U)  /* Pin 5 selected    */
  90. #define GPIO_PIN_6                 ((uint16_t)0x0040U)  /* Pin 6 selected    */
  91. #define GPIO_PIN_7                 ((uint16_t)0x0080U)  /* Pin 7 selected    */
  92. #define GPIO_PIN_8                 ((uint16_t)0x0100U)  /* Pin 8 selected    */
  93. #define GPIO_PIN_9                 ((uint16_t)0x0200U)  /* Pin 9 selected    */
  94. #define GPIO_PIN_10                ((uint16_t)0x0400U)  /* Pin 10 selected   */
  95. #define GPIO_PIN_11                ((uint16_t)0x0800U)  /* Pin 11 selected   */
  96. #define GPIO_PIN_12                ((uint16_t)0x1000U)  /* Pin 12 selected   */
  97. #define GPIO_PIN_13                ((uint16_t)0x2000U)  /* Pin 13 selected   */
  98. #define GPIO_PIN_14                ((uint16_t)0x4000U)  /* Pin 14 selected   */
  99. #define GPIO_PIN_15                ((uint16_t)0x8000U)  /* Pin 15 selected   */
  100. #define GPIO_PIN_All               ((uint16_t)0xFFFFU)  /* All pins selected */
  101.  
  102. #define GPIO_PIN_MASK              (0x0000FFFFU) /* PIN mask for assert test */
  103. /**
  104.   * @}
  105.   */
  106.  
  107. /** @defgroup GPIO_mode GPIO mode
  108.   * @brief GPIO Configuration Mode
  109.   *        Elements values convention: 0x00WX00YZ
  110.   *           - W  : EXTI trigger detection on 3 bits
  111.   *           - X  : EXTI mode (IT or Event) on 2 bits
  112.   *           - Y  : Output type (Push Pull or Open Drain) on 1 bit
  113.   *           - Z  : GPIO mode (Input, Output, Alternate or Analog) on 2 bits
  114.   * @{
  115.   */
  116. #define  GPIO_MODE_INPUT                        MODE_INPUT                                                  /*!< Input Floating Mode                   */
  117. #define  GPIO_MODE_OUTPUT_PP                    (MODE_OUTPUT | OUTPUT_PP)                                   /*!< Output Push Pull Mode                 */
  118. #define  GPIO_MODE_OUTPUT_OD                    (MODE_OUTPUT | OUTPUT_OD)                                   /*!< Output Open Drain Mode                */
  119. #define  GPIO_MODE_AF_PP                        (MODE_AF | OUTPUT_PP)                                       /*!< Alternate Function Push Pull Mode     */
  120. #define  GPIO_MODE_AF_OD                        (MODE_AF | OUTPUT_OD)                                       /*!< Alternate Function Open Drain Mode    */
  121.  
  122. #define  GPIO_MODE_ANALOG                       MODE_ANALOG                                                 /*!< Analog Mode  */
  123.    
  124. #define  GPIO_MODE_IT_RISING                    (MODE_INPUT | EXTI_IT | TRIGGER_RISING)                     /*!< External Interrupt Mode with Rising edge trigger detection          */
  125. #define  GPIO_MODE_IT_FALLING                   (MODE_INPUT | EXTI_IT | TRIGGER_FALLING)                    /*!< External Interrupt Mode with Falling edge trigger detection         */
  126. #define  GPIO_MODE_IT_RISING_FALLING            (MODE_INPUT | EXTI_IT | TRIGGER_RISING | TRIGGER_FALLING)   /*!< External Interrupt Mode with Rising/Falling edge trigger detection  */
  127.  
  128. #define  GPIO_MODE_EVT_RISING                   (MODE_INPUT | EXTI_EVT | TRIGGER_RISING)                     /*!< External Event Mode with Rising edge trigger detection             */
  129. #define  GPIO_MODE_EVT_FALLING                  (MODE_INPUT | EXTI_EVT | TRIGGER_FALLING)                    /*!< External Event Mode with Falling edge trigger detection            */
  130. #define  GPIO_MODE_EVT_RISING_FALLING           (MODE_INPUT | EXTI_EVT | TRIGGER_RISING | TRIGGER_FALLING)   /*!< External Event Mode with Rising/Falling edge trigger detection     *//**
  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 2 MHz, please refer to the product datasheet */
  139. #define  GPIO_SPEED_FREQ_MEDIUM   (0x00000001U)  /*!< range  4 MHz to 10 MHz, please refer to the product datasheet */
  140. #define  GPIO_SPEED_FREQ_HIGH     (0x00000003U)  /*!< range 10 MHz to 50 MHz, please refer to the product datasheet */
  141. /**
  142.   * @}
  143.   */
  144.  
  145.  /** @defgroup GPIO_pull GPIO pull
  146.    * @brief GPIO Pull-Up or Pull-Down Activation
  147.    * @{
  148.    */  
  149. #define  GPIO_NOPULL        (0x00000000U)   /*!< No Pull-up or Pull-down activation  */
  150. #define  GPIO_PULLUP        (0x00000001U)   /*!< Pull-up activation                  */
  151. #define  GPIO_PULLDOWN      (0x00000002U)   /*!< Pull-down activation                */
  152. /**
  153.   * @}
  154.   */
  155.  
  156. /**
  157.   * @}
  158.   */
  159.  
  160. /* Exported macro ------------------------------------------------------------*/
  161. /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
  162.   * @{
  163.   */
  164.  
  165. /**
  166.   * @brief  Check whether the specified EXTI line flag is set or not.
  167.   * @param  __EXTI_LINE__ specifies the EXTI line flag to check.
  168.   *         This parameter can be GPIO_PIN_x where x can be(0..15)
  169.   * @retval The new state of __EXTI_LINE__ (SET or RESET).
  170.   */
  171. #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
  172.  
  173. /**
  174.   * @brief  Clear the EXTI's line pending flags.
  175.   * @param  __EXTI_LINE__ specifies the EXTI lines flags to clear.
  176.   *         This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
  177.   * @retval None
  178.   */
  179. #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
  180.  
  181. /**
  182.   * @brief  Check whether the specified EXTI line is asserted or not.
  183.   * @param  __EXTI_LINE__ specifies the EXTI line to check.
  184.   *          This parameter can be GPIO_PIN_x where x can be(0..15)
  185.   * @retval The new state of __EXTI_LINE__ (SET or RESET).
  186.   */
  187. #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
  188.  
  189. /**
  190.   * @brief  Clear the EXTI's line pending bits.
  191.   * @param  __EXTI_LINE__ specifies the EXTI lines to clear.
  192.   *          This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
  193.   * @retval None
  194.   */
  195. #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
  196.  
  197. /**
  198.   * @brief  Generate a Software interrupt on selected EXTI line.
  199.   * @param  __EXTI_LINE__ specifies the EXTI line to check.
  200.   *          This parameter can be GPIO_PIN_x where x can be(0..15)
  201.   * @retval None
  202.   */
  203. #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
  204.  
  205. /**
  206.   * @}
  207.   */
  208.  
  209. /* Private macros ------------------------------------------------------------*/
  210. /** @defgroup GPIO_Private_Constants GPIO Private Constants
  211.   * @{
  212.   */
  213. #define GPIO_MODE_Pos                           0U
  214. #define GPIO_MODE                               (0x3UL << GPIO_MODE_Pos)
  215. #define MODE_INPUT                              (0x0UL << GPIO_MODE_Pos)
  216. #define MODE_OUTPUT                             (0x1UL << GPIO_MODE_Pos)
  217. #define MODE_AF                                 (0x2UL << GPIO_MODE_Pos)
  218. #define MODE_ANALOG                             (0x3UL << GPIO_MODE_Pos)
  219. #define OUTPUT_TYPE_Pos                         4U
  220. #define OUTPUT_TYPE                             (0x1UL << OUTPUT_TYPE_Pos)
  221. #define OUTPUT_PP                               (0x0UL << OUTPUT_TYPE_Pos)
  222. #define OUTPUT_OD                               (0x1UL << OUTPUT_TYPE_Pos)
  223. #define EXTI_MODE_Pos                           16U
  224. #define EXTI_MODE                               (0x3UL << EXTI_MODE_Pos)
  225. #define EXTI_IT                                 (0x1UL << EXTI_MODE_Pos)
  226. #define EXTI_EVT                                (0x2UL << EXTI_MODE_Pos)
  227. #define TRIGGER_MODE_Pos                        20U
  228. #define TRIGGER_MODE                            (0x7UL << TRIGGER_MODE_Pos)
  229. #define TRIGGER_RISING                          (0x1UL << TRIGGER_MODE_Pos)
  230. #define TRIGGER_FALLING                         (0x2UL << TRIGGER_MODE_Pos)
  231. /**
  232.   * @}
  233.   */
  234.  
  235. /** @addtogroup GPIO_Private_Macros GPIO Private Macros
  236.   * @{
  237.   */
  238. #define IS_GPIO_PIN_ACTION(ACTION)  (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
  239.  
  240. #define IS_GPIO_PIN(__PIN__)        (((((uint32_t)__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\
  241.                                      ((((uint32_t)__PIN__) & ~GPIO_PIN_MASK) == 0x00U))
  242.  
  243. #define IS_GPIO_MODE(__MODE__)      (((__MODE__) == GPIO_MODE_INPUT)              ||\
  244.                                      ((__MODE__) == GPIO_MODE_OUTPUT_PP)          ||\
  245.                                      ((__MODE__) == GPIO_MODE_OUTPUT_OD)          ||\
  246.                                      ((__MODE__) == GPIO_MODE_AF_PP)              ||\
  247.                                      ((__MODE__) == GPIO_MODE_AF_OD)              ||\
  248.                                      ((__MODE__) == GPIO_MODE_IT_RISING)          ||\
  249.                                      ((__MODE__) == GPIO_MODE_IT_FALLING)         ||\
  250.                                      ((__MODE__) == GPIO_MODE_IT_RISING_FALLING)  ||\
  251.                                      ((__MODE__) == GPIO_MODE_EVT_RISING)         ||\
  252.                                      ((__MODE__) == GPIO_MODE_EVT_FALLING)        ||\
  253.                                      ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\
  254.                                      ((__MODE__) == GPIO_MODE_ANALOG))
  255.  
  256. #define IS_GPIO_SPEED(__SPEED__)    (((__SPEED__) == GPIO_SPEED_FREQ_LOW)    ||\
  257.                                      ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\
  258.                                      ((__SPEED__) == GPIO_SPEED_FREQ_HIGH))
  259.  
  260. #define IS_GPIO_PULL(__PULL__)      (((__PULL__) == GPIO_NOPULL)   ||\
  261.                                      ((__PULL__) == GPIO_PULLUP)   || \
  262.                                      ((__PULL__) == GPIO_PULLDOWN))
  263. /**
  264.   * @}
  265.   */
  266.  
  267. /* Include GPIO HAL Extended module */
  268. #include "stm32f0xx_hal_gpio_ex.h"
  269.  
  270. /* Exported functions --------------------------------------------------------*/
  271. /** @addtogroup GPIO_Exported_Functions GPIO Exported Functions
  272.   * @{
  273.   */
  274.  
  275. /** @addtogroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions
  276.  *  @brief    Initialization and Configuration functions
  277.  * @{
  278.  */
  279.      
  280. /* Initialization and de-initialization functions *****************************/
  281. void              HAL_GPIO_Init(GPIO_TypeDef  *GPIOx, GPIO_InitTypeDef *GPIO_Init);
  282. void              HAL_GPIO_DeInit(GPIO_TypeDef  *GPIOx, uint32_t GPIO_Pin);
  283.  
  284. /**
  285.   * @}
  286.   */
  287.  
  288. /** @addtogroup GPIO_Exported_Functions_Group2 IO operation functions
  289.  * @{
  290.  */
  291.    
  292. /* IO operation functions *****************************************************/
  293. GPIO_PinState     HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
  294. void              HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
  295. void              HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
  296. HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
  297. void              HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
  298. void              HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
  299.  
  300. /**
  301.   * @}
  302.   */
  303.  
  304. /**
  305.   * @}
  306.   */
  307.  
  308. /**
  309.   * @}
  310.   */
  311.  
  312. /**
  313.   * @}
  314.   */  
  315.  
  316. #ifdef __cplusplus
  317. }
  318. #endif
  319.  
  320. #endif /* __STM32F0xx_HAL_GPIO_H */
  321.  
  322. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
  323.