Subversion Repositories FuelGauge

Rev

Go to most recent revision | 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: 0xX0yz00YZ
  110.   *           - X  : GPIO mode or EXTI Mode
  111.   *           - y  : External IT or Event trigger detection
  112.   *           - z  : IO configuration on External IT or Event
  113.   *           - Y  : Output type (Push Pull or Open Drain)
  114.   *           - Z  : IO Direction mode (Input, Output, Alternate or Analog)
  115.   * @{
  116.   */
  117. #define  GPIO_MODE_INPUT                        (0x00000000U)   /*!< Input Floating Mode                   */
  118. #define  GPIO_MODE_OUTPUT_PP                    (0x00000001U)   /*!< Output Push Pull Mode                 */
  119. #define  GPIO_MODE_OUTPUT_OD                    (0x00000011U)   /*!< Output Open Drain Mode                */
  120. #define  GPIO_MODE_AF_PP                        (0x00000002U)   /*!< Alternate Function Push Pull Mode     */
  121. #define  GPIO_MODE_AF_OD                        (0x00000012U)   /*!< Alternate Function Open Drain Mode    */
  122. #define  GPIO_MODE_ANALOG                       (0x00000003U)   /*!< Analog Mode  */  
  123. #define  GPIO_MODE_IT_RISING                    (0x10110000U)   /*!< External Interrupt Mode with Rising edge trigger detection          */
  124. #define  GPIO_MODE_IT_FALLING                   (0x10210000U)   /*!< External Interrupt Mode with Falling edge trigger detection         */
  125. #define  GPIO_MODE_IT_RISING_FALLING            (0x10310000U)   /*!< External Interrupt Mode with Rising/Falling edge trigger detection  */
  126. #define  GPIO_MODE_EVT_RISING                   (0x10120000U)   /*!< External Event Mode with Rising edge trigger detection               */
  127. #define  GPIO_MODE_EVT_FALLING                  (0x10220000U)   /*!< External Event Mode with Falling edge trigger detection              */
  128. #define  GPIO_MODE_EVT_RISING_FALLING           (0x10320000U)   /*!< External Event Mode with Rising/Falling edge trigger detection       */
  129. /**
  130.   * @}
  131.   */
  132.                                                          
  133. /** @defgroup GPIO_speed GPIO speed
  134.   * @brief GPIO Output Maximum frequency
  135.   * @{
  136.   */  
  137. #define  GPIO_SPEED_FREQ_LOW      (0x00000000U)  /*!< range up to 2 MHz, please refer to the product datasheet */
  138. #define  GPIO_SPEED_FREQ_MEDIUM   (0x00000001U)  /*!< range  4 MHz to 10 MHz, please refer to the product datasheet */
  139. #define  GPIO_SPEED_FREQ_HIGH     (0x00000003U)  /*!< range 10 MHz to 50 MHz, please refer to the product datasheet */
  140. /**
  141.   * @}
  142.   */
  143.  
  144.  /** @defgroup GPIO_pull GPIO pull
  145.    * @brief GPIO Pull-Up or Pull-Down Activation
  146.    * @{
  147.    */  
  148. #define  GPIO_NOPULL        (0x00000000U)   /*!< No Pull-up or Pull-down activation  */
  149. #define  GPIO_PULLUP        (0x00000001U)   /*!< Pull-up activation                  */
  150. #define  GPIO_PULLDOWN      (0x00000002U)   /*!< Pull-down activation                */
  151. /**
  152.   * @}
  153.   */
  154.  
  155. /**
  156.   * @}
  157.   */
  158.  
  159. /* Exported macro ------------------------------------------------------------*/
  160. /** @defgroup GPIO_Exported_Macros GPIO Exported Macros
  161.   * @{
  162.   */
  163.  
  164. /**
  165.   * @brief  Check whether the specified EXTI line flag is set or not.
  166.   * @param  __EXTI_LINE__ specifies the EXTI line flag to check.
  167.   *         This parameter can be GPIO_PIN_x where x can be(0..15)
  168.   * @retval The new state of __EXTI_LINE__ (SET or RESET).
  169.   */
  170. #define __HAL_GPIO_EXTI_GET_FLAG(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
  171.  
  172. /**
  173.   * @brief  Clear the EXTI's line pending flags.
  174.   * @param  __EXTI_LINE__ specifies the EXTI lines flags to clear.
  175.   *         This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
  176.   * @retval None
  177.   */
  178. #define __HAL_GPIO_EXTI_CLEAR_FLAG(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
  179.  
  180. /**
  181.   * @brief  Check whether the specified EXTI line is asserted or not.
  182.   * @param  __EXTI_LINE__ specifies the EXTI line to check.
  183.   *          This parameter can be GPIO_PIN_x where x can be(0..15)
  184.   * @retval The new state of __EXTI_LINE__ (SET or RESET).
  185.   */
  186. #define __HAL_GPIO_EXTI_GET_IT(__EXTI_LINE__) (EXTI->PR & (__EXTI_LINE__))
  187.  
  188. /**
  189.   * @brief  Clear the EXTI's line pending bits.
  190.   * @param  __EXTI_LINE__ specifies the EXTI lines to clear.
  191.   *          This parameter can be any combination of GPIO_PIN_x where x can be (0..15)
  192.   * @retval None
  193.   */
  194. #define __HAL_GPIO_EXTI_CLEAR_IT(__EXTI_LINE__) (EXTI->PR = (__EXTI_LINE__))
  195.  
  196. /**
  197.   * @brief  Generate a Software interrupt on selected EXTI line.
  198.   * @param  __EXTI_LINE__ specifies the EXTI line to check.
  199.   *          This parameter can be GPIO_PIN_x where x can be(0..15)
  200.   * @retval None
  201.   */
  202. #define __HAL_GPIO_EXTI_GENERATE_SWIT(__EXTI_LINE__) (EXTI->SWIER |= (__EXTI_LINE__))
  203.  
  204. /**
  205.   * @}
  206.   */
  207.  
  208. /* Private macros ------------------------------------------------------------*/
  209. /** @addtogroup GPIO_Private_Macros GPIO Private Macros
  210.   * @{
  211.   */
  212. #define IS_GPIO_PIN_ACTION(ACTION)  (((ACTION) == GPIO_PIN_RESET) || ((ACTION) == GPIO_PIN_SET))
  213.  
  214. #define IS_GPIO_PIN(__PIN__)        (((((uint32_t)__PIN__) & GPIO_PIN_MASK) != 0x00U) &&\
  215.                                      ((((uint32_t)__PIN__) & ~GPIO_PIN_MASK) == 0x00U))
  216.  
  217. #define IS_GPIO_MODE(__MODE__)      (((__MODE__) == GPIO_MODE_INPUT)              ||\
  218.                                      ((__MODE__) == GPIO_MODE_OUTPUT_PP)          ||\
  219.                                      ((__MODE__) == GPIO_MODE_OUTPUT_OD)          ||\
  220.                                      ((__MODE__) == GPIO_MODE_AF_PP)              ||\
  221.                                      ((__MODE__) == GPIO_MODE_AF_OD)              ||\
  222.                                      ((__MODE__) == GPIO_MODE_IT_RISING)          ||\
  223.                                      ((__MODE__) == GPIO_MODE_IT_FALLING)         ||\
  224.                                      ((__MODE__) == GPIO_MODE_IT_RISING_FALLING)  ||\
  225.                                      ((__MODE__) == GPIO_MODE_EVT_RISING)         ||\
  226.                                      ((__MODE__) == GPIO_MODE_EVT_FALLING)        ||\
  227.                                      ((__MODE__) == GPIO_MODE_EVT_RISING_FALLING) ||\
  228.                                      ((__MODE__) == GPIO_MODE_ANALOG))
  229.  
  230. #define IS_GPIO_SPEED(__SPEED__)    (((__SPEED__) == GPIO_SPEED_FREQ_LOW)    ||\
  231.                                      ((__SPEED__) == GPIO_SPEED_FREQ_MEDIUM) ||\
  232.                                      ((__SPEED__) == GPIO_SPEED_FREQ_HIGH))
  233.  
  234. #define IS_GPIO_PULL(__PULL__)      (((__PULL__) == GPIO_NOPULL)   ||\
  235.                                      ((__PULL__) == GPIO_PULLUP)   || \
  236.                                      ((__PULL__) == GPIO_PULLDOWN))
  237. /**
  238.   * @}
  239.   */
  240.  
  241. /* Include GPIO HAL Extended module */
  242. #include "stm32f0xx_hal_gpio_ex.h"
  243.  
  244. /* Exported functions --------------------------------------------------------*/
  245. /** @addtogroup GPIO_Exported_Functions GPIO Exported Functions
  246.   * @{
  247.   */
  248.  
  249. /** @addtogroup GPIO_Exported_Functions_Group1 Initialization/de-initialization functions
  250.  *  @brief    Initialization and Configuration functions
  251.  * @{
  252.  */
  253.      
  254. /* Initialization and de-initialization functions *****************************/
  255. void              HAL_GPIO_Init(GPIO_TypeDef  *GPIOx, GPIO_InitTypeDef *GPIO_Init);
  256. void              HAL_GPIO_DeInit(GPIO_TypeDef  *GPIOx, uint32_t GPIO_Pin);
  257.  
  258. /**
  259.   * @}
  260.   */
  261.  
  262. /** @addtogroup GPIO_Exported_Functions_Group2 IO operation functions
  263.  * @{
  264.  */
  265.    
  266. /* IO operation functions *****************************************************/
  267. GPIO_PinState     HAL_GPIO_ReadPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
  268. void              HAL_GPIO_WritePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin, GPIO_PinState PinState);
  269. void              HAL_GPIO_TogglePin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
  270. HAL_StatusTypeDef HAL_GPIO_LockPin(GPIO_TypeDef* GPIOx, uint16_t GPIO_Pin);
  271. void              HAL_GPIO_EXTI_IRQHandler(uint16_t GPIO_Pin);
  272. void              HAL_GPIO_EXTI_Callback(uint16_t GPIO_Pin);
  273.  
  274. /**
  275.   * @}
  276.   */
  277.  
  278. /**
  279.   * @}
  280.   */
  281.  
  282. /**
  283.   * @}
  284.   */
  285.  
  286. /**
  287.   * @}
  288.   */  
  289.  
  290. #ifdef __cplusplus
  291. }
  292. #endif
  293.  
  294. #endif /* __STM32F0xx_HAL_GPIO_H */
  295.  
  296. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
  297.