stm32l0xx_hal_exti.h 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. /**
  2. ******************************************************************************
  3. * @file stm32l0xx_ll_exti.h
  4. * @author MCD Application Team
  5. * @brief Header file of EXTI LL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2020 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 __STM32L0xx_HAL_EXTI_H
  20. #define __STM32L0xx_HAL_EXTI_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32l0xx.h"
  26. /** @addtogroup STM32L0xx_HAL_Driver
  27. * @{
  28. */
  29. /** @defgroup EXTI EXTI
  30. * @brief EXTI HAL module driver
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /* Exported types ------------------------------------------------------------*/
  35. /** @defgroup EXTI_Exported_Types EXTI Exported Types
  36. * @{
  37. */
  38. typedef enum
  39. {
  40. HAL_EXTI_COMMON_CB_ID = 0x00U,
  41. HAL_EXTI_RISING_CB_ID = 0x01U,
  42. HAL_EXTI_FALLING_CB_ID = 0x02U,
  43. } EXTI_CallbackIDTypeDef;
  44. /**
  45. * @brief EXTI Handle structure definition
  46. */
  47. typedef struct
  48. {
  49. uint32_t Line; /*!< Exti line number */
  50. void (* PendingCallback)(void); /*!< Exti pending callback */
  51. } EXTI_HandleTypeDef;
  52. /**
  53. * @brief EXTI Configuration structure definition
  54. */
  55. typedef struct
  56. {
  57. uint32_t Line; /*!< The Exti line to be configured. This parameter
  58. can be a value of @ref EXTI_Line */
  59. uint32_t Mode; /*!< The Exit Mode to be configured for a core.
  60. This parameter can be a combination of @ref EXTI_Mode */
  61. uint32_t Trigger; /*!< The Exti Trigger to be configured. This parameter
  62. can be a value of @ref EXTI_Trigger */
  63. uint32_t GPIOSel; /*!< The Exti GPIO multiplexer selection to be configured.
  64. This parameter is only possible for line 0 to 15. It
  65. can be a value of @ref EXTI_GPIOSel */
  66. } EXTI_ConfigTypeDef;
  67. /**
  68. * @}
  69. */
  70. /* Exported constants --------------------------------------------------------*/
  71. /** @defgroup EXTI_Exported_Constants EXTI Exported Constants
  72. * @{
  73. */
  74. /** @defgroup EXTI_Line EXTI Line
  75. * @{
  76. */
  77. #define EXTI_LINE_0 (EXTI_GPIO | 0x00u) /*!< External interrupt line 0 */
  78. #define EXTI_LINE_1 (EXTI_GPIO | 0x01u) /*!< External interrupt line 1 */
  79. #define EXTI_LINE_2 (EXTI_GPIO | 0x02u) /*!< External interrupt line 2 */
  80. #define EXTI_LINE_3 (EXTI_GPIO | 0x03u) /*!< External interrupt line 3 */
  81. #define EXTI_LINE_4 (EXTI_GPIO | 0x04u) /*!< External interrupt line 4 */
  82. #define EXTI_LINE_5 (EXTI_GPIO | 0x05u) /*!< External interrupt line 5 */
  83. #define EXTI_LINE_6 (EXTI_GPIO | 0x06u) /*!< External interrupt line 6 */
  84. #define EXTI_LINE_7 (EXTI_GPIO | 0x07u) /*!< External interrupt line 7 */
  85. #define EXTI_LINE_8 (EXTI_GPIO | 0x08u) /*!< External interrupt line 8 */
  86. #define EXTI_LINE_9 (EXTI_GPIO | 0x09u) /*!< External interrupt line 9 */
  87. #define EXTI_LINE_10 (EXTI_GPIO | 0x0Au) /*!< External interrupt line 10 */
  88. #define EXTI_LINE_11 (EXTI_GPIO | 0x0Bu) /*!< External interrupt line 11 */
  89. #define EXTI_LINE_12 (EXTI_GPIO | 0x0Cu) /*!< External interrupt line 12 */
  90. #define EXTI_LINE_13 (EXTI_GPIO | 0x0Du) /*!< External interrupt line 13 */
  91. #define EXTI_LINE_14 (EXTI_GPIO | 0x0Eu) /*!< External interrupt line 14 */
  92. #define EXTI_LINE_15 (EXTI_GPIO | 0x0Fu) /*!< External interrupt line 15 */
  93. #if defined(EXTI_IMR_IM16)
  94. #define EXTI_LINE_16 (EXTI_CONFIG | 0x10u) /*!< External interrupt line 16 Connected to the PVD Output */
  95. #else
  96. #define EXTI_LINE_16 (EXTI_RESERVED | 0x10u) /*!< No interrupt supported in this line */
  97. #endif /* EXTI_IMR_IM16 */
  98. #define EXTI_LINE_17 (EXTI_CONFIG | 0x11u) /*!< External interrupt line 17 Connected to the RTC Alarm event */
  99. #if defined(EXTI_IMR_IM18)
  100. #define EXTI_LINE_18 (EXTI_DIRECT | 0x12u) /*!< External interrupt line 18 Connected to the USB Wakeup from suspend event */
  101. #else
  102. #define EXTI_LINE_18 (EXTI_RESERVED | 0x12u) /*!< No interrupt supported in this line */
  103. #endif /* EXTI_IMR_IM18 */
  104. #define EXTI_LINE_19 (EXTI_CONFIG | 0x13u) /*!< External interrupt line 19 Connected to the RTC Tamper and Time Stamp events or CSS_LSE */
  105. #define EXTI_LINE_20 (EXTI_CONFIG | 0x14u) /*!< External interrupt line 20 Connected to the RTC wakeup timer */
  106. #if defined(EXTI_IMR_IM21)
  107. #define EXTI_LINE_21 (EXTI_CONFIG | 0x15u) /*!< External interrupt line 21 Connected to the Comparator 1 output */
  108. #else
  109. #define EXTI_LINE_21 (EXTI_RESERVED | 0x15u) /*!< No interrupt supported in this line */
  110. #endif /* EXTI_IMR_IM21 */
  111. #if defined(EXTI_IMR_IM22)
  112. #define EXTI_LINE_22 (EXTI_CONFIG | 0x16u) /*!< External interrupt line 22 Connected to the Comparator 2 output */
  113. #else
  114. #define EXTI_LINE_22 (EXTI_RESERVED | 0x16u) /*!< No interrupt supported in this line */
  115. #endif /* EXTI_IMR_IM22 */
  116. #define EXTI_LINE_23 (EXTI_DIRECT | 0x17u) /*!< External interrupt line 23 Connected to the internal I2C1 wakeup event */
  117. #if defined(EXTI_IMR_IM24)
  118. #define EXTI_LINE_24 (EXTI_DIRECT | 0x18u) /*!< External interrupt line 24 Connected to the internal I2C3 wakeup event */
  119. #else
  120. #define EXTI_LINE_24 (EXTI_RESERVED | 0x18u) /*!< No interrupt supported in this line */
  121. #endif /* EXTI_IMR_IM24 */
  122. #if defined(EXTI_IMR_IM25)
  123. #define EXTI_LINE_25 (EXTI_DIRECT | 0x19u) /*!< External interrupt line 25 Connected to the internal USART1 wakeup event */
  124. #else
  125. #define EXTI_LINE_25 (EXTI_RESERVED | 0x19u) /*!< No interrupt supported in this line */
  126. #endif /* EXTI_IMR_IM25 */
  127. #define EXTI_LINE_26 (EXTI_DIRECT | 0x1Au) /*!< External interrupt line 26 Connected to the internal USART2 wakeup event */
  128. #define EXTI_LINE_27 (EXTI_RESERVED | 0x1Bu) /*!< No interrupt supported in this line */
  129. #define EXTI_LINE_28 (EXTI_DIRECT | 0x1Cu) /*!< External interrupt line 28 Connected to the LPUART1 Wakeup event */
  130. #define EXTI_LINE_29 (EXTI_DIRECT | 0x1Du) /*!< External interrupt line 29 Connected to the LPTIM1 Wakeup event */
  131. /**
  132. * @}
  133. */
  134. /** @defgroup EXTI_Mode EXTI Mode
  135. * @{
  136. */
  137. #define EXTI_MODE_NONE 0x00000000u
  138. #define EXTI_MODE_INTERRUPT 0x00000001u
  139. #define EXTI_MODE_EVENT 0x00000002u
  140. /**
  141. * @}
  142. */
  143. /** @defgroup EXTI_Trigger EXTI Trigger
  144. * @{
  145. */
  146. #define EXTI_TRIGGER_NONE 0x00000000u
  147. #define EXTI_TRIGGER_RISING 0x00000001u
  148. #define EXTI_TRIGGER_FALLING 0x00000002u
  149. #define EXTI_TRIGGER_RISING_FALLING (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
  150. /**
  151. * @}
  152. */
  153. /** @defgroup EXTI_GPIOSel EXTI GPIOSel
  154. * @brief
  155. * @{
  156. */
  157. #define EXTI_GPIOA 0x00000000u
  158. #define EXTI_GPIOB 0x00000001u
  159. #define EXTI_GPIOC 0x00000002u
  160. #if defined (GPIOD)
  161. #define EXTI_GPIOD 0x00000003u
  162. #endif /* GPIOD*/
  163. #if defined (GPIOE)
  164. #define EXTI_GPIOE 0x00000004u
  165. #endif /* GPIOE*/
  166. #if defined (GPIOH)
  167. #define EXTI_GPIOH 0x00000007u
  168. #endif /* GPIOH*/
  169. /**
  170. * @}
  171. */
  172. /**
  173. * @}
  174. */
  175. /* Exported macro ------------------------------------------------------------*/
  176. /** @defgroup EXTI_Exported_Macros EXTI Exported Macros
  177. * @{
  178. */
  179. /**
  180. * @}
  181. */
  182. /* Private constants --------------------------------------------------------*/
  183. /** @defgroup EXTI_Private_Constants EXTI Private Constants
  184. * @{
  185. */
  186. /**
  187. * @brief EXTI Line property definition
  188. */
  189. #define EXTI_PROPERTY_SHIFT 24u
  190. #define EXTI_DIRECT (0x01uL << EXTI_PROPERTY_SHIFT)
  191. #define EXTI_CONFIG (0x02uL << EXTI_PROPERTY_SHIFT)
  192. #define EXTI_GPIO ((0x04uL << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG)
  193. #define EXTI_RESERVED (0x08uL << EXTI_PROPERTY_SHIFT)
  194. #define EXTI_PROPERTY_MASK (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO)
  195. /**
  196. * @brief EXTI bit usage
  197. */
  198. #define EXTI_PIN_MASK 0x0000001Fu
  199. /**
  200. * @brief EXTI Mask for interrupt & event mode
  201. */
  202. #define EXTI_MODE_MASK (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
  203. /**
  204. * @brief EXTI Mask for trigger possibilities
  205. */
  206. #define EXTI_TRIGGER_MASK (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
  207. /**
  208. * @brief EXTI Line number
  209. */
  210. #define EXTI_LINE_NB 30u
  211. /**
  212. * @}
  213. */
  214. /* Private macros ------------------------------------------------------------*/
  215. /** @defgroup EXTI_Private_Macros EXTI Private Macros
  216. * @{
  217. */
  218. #define IS_EXTI_LINE(__EXTI_LINE__) ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_PIN_MASK)) == 0x00u) && \
  219. ((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG) || \
  220. (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO)) && \
  221. (((__EXTI_LINE__) & EXTI_PIN_MASK) < EXTI_LINE_NB))
  222. #define IS_EXTI_MODE(__EXTI_LINE__) ((((__EXTI_LINE__) & EXTI_MODE_MASK) != 0x00u) && \
  223. (((__EXTI_LINE__) & ~EXTI_MODE_MASK) == 0x00u))
  224. #define IS_EXTI_TRIGGER(__EXTI_LINE__) (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00u)
  225. #define IS_EXTI_PENDING_EDGE(__EXTI_LINE__) ((__EXTI_LINE__) == EXTI_TRIGGER_RISING_FALLING)
  226. #define IS_EXTI_CONFIG_LINE(__EXTI_LINE__) (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00u)
  227. #if !defined (GPIOH)
  228. #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \
  229. ((__PORT__) == EXTI_GPIOB) || \
  230. ((__PORT__) == EXTI_GPIOC))
  231. #elif !defined (GPIOD)
  232. #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \
  233. ((__PORT__) == EXTI_GPIOB) || \
  234. ((__PORT__) == EXTI_GPIOC) || \
  235. ((__PORT__) == EXTI_GPIOH))
  236. #elif !defined (GPIOE)
  237. #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \
  238. ((__PORT__) == EXTI_GPIOB) || \
  239. ((__PORT__) == EXTI_GPIOC) || \
  240. ((__PORT__) == EXTI_GPIOD) || \
  241. ((__PORT__) == EXTI_GPIOH))
  242. #else
  243. #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \
  244. ((__PORT__) == EXTI_GPIOB) || \
  245. ((__PORT__) == EXTI_GPIOC) || \
  246. ((__PORT__) == EXTI_GPIOD) || \
  247. ((__PORT__) == EXTI_GPIOE) || \
  248. ((__PORT__) == EXTI_GPIOH))
  249. #endif /* GPIOH */
  250. #define IS_EXTI_GPIO_PIN(__PIN__) ((__PIN__) < 16u)
  251. /**
  252. * @}
  253. */
  254. /* Exported functions --------------------------------------------------------*/
  255. /** @defgroup EXTI_Exported_Functions EXTI Exported Functions
  256. * @brief EXTI Exported Functions
  257. * @{
  258. */
  259. /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
  260. * @brief Configuration functions
  261. * @{
  262. */
  263. /* Configuration functions ****************************************************/
  264. HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
  265. HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
  266. HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti);
  267. HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, void (*pPendingCbfn)(void));
  268. HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine);
  269. /**
  270. * @}
  271. */
  272. /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
  273. * @brief IO operation functions
  274. * @{
  275. */
  276. /* IO operation functions *****************************************************/
  277. void HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti);
  278. uint32_t HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
  279. void HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
  280. void HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti);
  281. /**
  282. * @}
  283. */
  284. /**
  285. * @}
  286. */
  287. /**
  288. * @}
  289. */
  290. /**
  291. * @}
  292. */
  293. #ifdef __cplusplus
  294. }
  295. #endif
  296. #endif /* STM32L0xx_HAL_EXTI_H */