You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

327 lines
13 KiB

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