stm32f0xx_hal_gpio.h 14 KB

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