Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 
 
 
 

328 rader
14 KiB

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