stm32f0xx_hal_exti.h 14 KB

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