stm32g0xx_hal_exti.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387
  1. /**
  2. ******************************************************************************
  3. * @file stm32g0xx_hal_exti.h
  4. * @author MCD Application Team
  5. * @brief Header file of EXTI HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2018 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 STM32G0xx_HAL_EXTI_H
  20. #define STM32G0xx_HAL_EXTI_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32g0xx_hal_def.h"
  26. /** @addtogroup STM32G0xx_HAL_Driver
  27. * @{
  28. */
  29. /** @defgroup EXTI EXTI
  30. * @brief EXTI HAL module driver
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup EXTI_Exported_Types EXTI Exported Types
  35. * @{
  36. */
  37. typedef enum
  38. {
  39. HAL_EXTI_COMMON_CB_ID = 0x00U,
  40. HAL_EXTI_RISING_CB_ID = 0x01U,
  41. HAL_EXTI_FALLING_CB_ID = 0x02U,
  42. } EXTI_CallbackIDTypeDef;
  43. /**
  44. * @brief EXTI Handle structure definition
  45. */
  46. typedef struct
  47. {
  48. uint32_t Line; /*!< Exti line number */
  49. void (* RisingCallback)(void); /*!< Exti rising callback */
  50. void (* FallingCallback)(void); /*!< Exti falling 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 | EXTI_REG1 | 0x00u)
  78. #define EXTI_LINE_1 (EXTI_GPIO | EXTI_REG1 | 0x01u)
  79. #define EXTI_LINE_2 (EXTI_GPIO | EXTI_REG1 | 0x02u)
  80. #define EXTI_LINE_3 (EXTI_GPIO | EXTI_REG1 | 0x03u)
  81. #define EXTI_LINE_4 (EXTI_GPIO | EXTI_REG1 | 0x04u)
  82. #define EXTI_LINE_5 (EXTI_GPIO | EXTI_REG1 | 0x05u)
  83. #define EXTI_LINE_6 (EXTI_GPIO | EXTI_REG1 | 0x06u)
  84. #define EXTI_LINE_7 (EXTI_GPIO | EXTI_REG1 | 0x07u)
  85. #define EXTI_LINE_8 (EXTI_GPIO | EXTI_REG1 | 0x08u)
  86. #define EXTI_LINE_9 (EXTI_GPIO | EXTI_REG1 | 0x09u)
  87. #define EXTI_LINE_10 (EXTI_GPIO | EXTI_REG1 | 0x0Au)
  88. #define EXTI_LINE_11 (EXTI_GPIO | EXTI_REG1 | 0x0Bu)
  89. #define EXTI_LINE_12 (EXTI_GPIO | EXTI_REG1 | 0x0Cu)
  90. #define EXTI_LINE_13 (EXTI_GPIO | EXTI_REG1 | 0x0Du)
  91. #define EXTI_LINE_14 (EXTI_GPIO | EXTI_REG1 | 0x0Eu)
  92. #define EXTI_LINE_15 (EXTI_GPIO | EXTI_REG1 | 0x0Fu)
  93. #define EXTI_LINE_16 (EXTI_CONFIG | EXTI_REG1 | 0x10u)
  94. #if defined(COMP1)
  95. #define EXTI_LINE_17 (EXTI_CONFIG | EXTI_REG1 | 0x11u)
  96. #else
  97. #define EXTI_LINE_17 (EXTI_RESERVED | EXTI_REG1 | 0x11u)
  98. #endif /* COMP1 */
  99. #if defined(COMP2)
  100. #define EXTI_LINE_18 (EXTI_CONFIG | EXTI_REG1 | 0x12u)
  101. #else
  102. #define EXTI_LINE_18 (EXTI_RESERVED | EXTI_REG1 | 0x12u)
  103. #endif /* COMP2 */
  104. #define EXTI_LINE_19 (EXTI_DIRECT | EXTI_REG1 | 0x13u)
  105. #if defined(COMP3)
  106. #define EXTI_LINE_20 (EXTI_CONFIG | EXTI_REG1 | 0x14u)
  107. #else
  108. #define EXTI_LINE_20 (EXTI_RESERVED | EXTI_REG1 | 0x14u)
  109. #endif /* COMP3 */
  110. #define EXTI_LINE_21 (EXTI_DIRECT | EXTI_REG1 | 0x15u)
  111. #if defined(RCC_CCIPR_I2C2SEL)
  112. #define EXTI_LINE_22 (EXTI_DIRECT | EXTI_REG1 | 0x16u)
  113. #else
  114. #define EXTI_LINE_22 (EXTI_RESERVED | EXTI_REG1 | 0x16u)
  115. #endif /* RCC_CCIPR_I2C2SEL */
  116. #define EXTI_LINE_23 (EXTI_DIRECT | EXTI_REG1 | 0x17u)
  117. #if defined(RCC_CCIPR_USART3SEL)
  118. #define EXTI_LINE_24 (EXTI_DIRECT | EXTI_REG1 | 0x18u)
  119. #else
  120. #define EXTI_LINE_24 (EXTI_RESERVED | EXTI_REG1 | 0x18u)
  121. #endif /* RCC_CCIPR_USART3SEL */
  122. #define EXTI_LINE_25 (EXTI_DIRECT | EXTI_REG1 | 0x19u)
  123. #if defined(RCC_CCIPR_USART2SEL)
  124. #define EXTI_LINE_26 (EXTI_DIRECT | EXTI_REG1 | 0x1Au)
  125. #else
  126. #define EXTI_LINE_26 (EXTI_RESERVED | EXTI_REG1 | 0x1Au)
  127. #endif /* RCC_CCIPR_USART2SEL */
  128. #if defined(CEC)
  129. #define EXTI_LINE_27 (EXTI_DIRECT | EXTI_REG1 | 0x1Bu)
  130. #else
  131. #define EXTI_LINE_27 (EXTI_RESERVED | EXTI_REG1 | 0x1Bu)
  132. #endif /* CEC */
  133. #if defined(LPUART1)
  134. #define EXTI_LINE_28 (EXTI_DIRECT | EXTI_REG1 | 0x1Cu)
  135. #else
  136. #define EXTI_LINE_28 (EXTI_RESERVED | EXTI_REG1 | 0x1Cu)
  137. #endif /* LPUART1 */
  138. #if defined(LPTIM1)
  139. #define EXTI_LINE_29 (EXTI_DIRECT | EXTI_REG1 | 0x1Du)
  140. #else
  141. #define EXTI_LINE_29 (EXTI_RESERVED | EXTI_REG1 | 0x1Du)
  142. #endif /* LPTIM1 */
  143. #if defined(LPTIM2)
  144. #define EXTI_LINE_30 (EXTI_DIRECT | EXTI_REG1 | 0x1Eu)
  145. #else
  146. #define EXTI_LINE_30 (EXTI_RESERVED | EXTI_REG1 | 0x1Eu)
  147. #endif /* LPTIM2 */
  148. #define EXTI_LINE_31 (EXTI_DIRECT | EXTI_REG1 | 0x1Fu)
  149. #if defined(UCPD1)
  150. #define EXTI_LINE_32 (EXTI_DIRECT | EXTI_REG2 | 0x00u)
  151. #else
  152. #define EXTI_LINE_32 (EXTI_RESERVED | EXTI_REG2 | 0x00u)
  153. #endif /* UCPD1 */
  154. #if defined(UCPD2)
  155. #define EXTI_LINE_33 (EXTI_DIRECT | EXTI_REG2 | 0x01u)
  156. #else
  157. #define EXTI_LINE_33 (EXTI_RESERVED | EXTI_REG2 | 0x01u)
  158. #endif /* UCPD2 */
  159. #if defined(STM32G0C1xx) || defined(STM32G0B1xx)
  160. #define EXTI_LINE_34 (EXTI_CONFIG | EXTI_REG2 | 0x02u)
  161. #else
  162. #define EXTI_LINE_34 (EXTI_RESERVED | EXTI_REG2 | 0x02u)
  163. #endif /* STM32G0C1xx || STM32G0B1xx */
  164. #if defined(LPUART2)
  165. #define EXTI_LINE_35 (EXTI_DIRECT | EXTI_REG2 | 0x03u)
  166. #else
  167. #define EXTI_LINE_35 (EXTI_RESERVED | EXTI_REG2 | 0x03u)
  168. #endif /* LPUART2 */
  169. #if defined(STM32G0C1xx) || defined(STM32G0B1xx) || defined(STM32G0B0xx)
  170. #define EXTI_LINE_36 (EXTI_DIRECT | EXTI_REG2 | 0x04u)
  171. #endif /* STM32G0C1xx || STM32G0B1xx || STM32G0B0xx */
  172. /**
  173. * @}
  174. */
  175. /** @defgroup EXTI_Mode EXTI Mode
  176. * @{
  177. */
  178. #define EXTI_MODE_NONE 0x00000000u
  179. #define EXTI_MODE_INTERRUPT 0x00000001u
  180. #define EXTI_MODE_EVENT 0x00000002u
  181. /**
  182. * @}
  183. */
  184. /** @defgroup EXTI_Trigger EXTI Trigger
  185. * @{
  186. */
  187. #define EXTI_TRIGGER_NONE 0x00000000u
  188. #define EXTI_TRIGGER_RISING 0x00000001u
  189. #define EXTI_TRIGGER_FALLING 0x00000002u
  190. #define EXTI_TRIGGER_RISING_FALLING (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
  191. /**
  192. * @}
  193. */
  194. /** @defgroup EXTI_GPIOSel EXTI GPIOSel
  195. * @brief
  196. * @{
  197. */
  198. #define EXTI_GPIOA 0x00000000u
  199. #define EXTI_GPIOB 0x00000001u
  200. #define EXTI_GPIOC 0x00000002u
  201. #define EXTI_GPIOD 0x00000003u
  202. #if defined(GPIOE)
  203. #define EXTI_GPIOE 0x00000004u
  204. #endif /* GPIOE */
  205. #define EXTI_GPIOF 0x00000005u
  206. /**
  207. * @}
  208. */
  209. /**
  210. * @}
  211. */
  212. /* Exported macro ------------------------------------------------------------*/
  213. /** @defgroup EXTI_Exported_Macros EXTI Exported Macros
  214. * @{
  215. */
  216. /**
  217. * @}
  218. */
  219. /* Private constants --------------------------------------------------------*/
  220. /** @defgroup EXTI_Private_Constants EXTI Private Constants
  221. * @{
  222. */
  223. /**
  224. * @brief EXTI Line property definition
  225. */
  226. #define EXTI_PROPERTY_SHIFT 24u
  227. #define EXTI_DIRECT (0x01uL << EXTI_PROPERTY_SHIFT)
  228. #define EXTI_CONFIG (0x02uL << EXTI_PROPERTY_SHIFT)
  229. #define EXTI_GPIO ((0x04uL << EXTI_PROPERTY_SHIFT) | EXTI_CONFIG)
  230. #define EXTI_RESERVED (0x08uL << EXTI_PROPERTY_SHIFT)
  231. #define EXTI_PROPERTY_MASK (EXTI_DIRECT | EXTI_CONFIG | EXTI_GPIO)
  232. /**
  233. * @brief EXTI Register and bit usage
  234. */
  235. #define EXTI_REG_SHIFT 16u
  236. #define EXTI_REG1 (0x00uL << EXTI_REG_SHIFT)
  237. #define EXTI_REG2 (0x01uL << EXTI_REG_SHIFT)
  238. #define EXTI_REG_MASK (EXTI_REG1 | EXTI_REG2)
  239. #define EXTI_PIN_MASK 0x0000001Fu
  240. /**
  241. * @brief EXTI Mask for interrupt & event mode
  242. */
  243. #define EXTI_MODE_MASK (EXTI_MODE_EVENT | EXTI_MODE_INTERRUPT)
  244. /**
  245. * @brief EXTI Mask for trigger possibilities
  246. */
  247. #define EXTI_TRIGGER_MASK (EXTI_TRIGGER_RISING | EXTI_TRIGGER_FALLING)
  248. /**
  249. * @brief EXTI Line number
  250. */
  251. #if defined(STM32G0C1xx) || defined(STM32G0B1xx)
  252. #define EXTI_LINE_NB 37uL
  253. #elif defined(STM32G0B0xx)
  254. #define EXTI_LINE_NB 37uL
  255. #elif defined(STM32G081xx) || defined(STM32G071xx)
  256. #define EXTI_LINE_NB 34uL
  257. #elif defined(STM32G070xx)
  258. #define EXTI_LINE_NB 34uL
  259. #elif defined(STM32G041xx) || defined(STM32G031xx)
  260. #define EXTI_LINE_NB 32uL
  261. #else
  262. #define EXTI_LINE_NB 32uL
  263. #endif /* STM32G0C1xx || STM32G0B1xx */
  264. /**
  265. * @}
  266. */
  267. /* Private macros ------------------------------------------------------------*/
  268. /** @defgroup EXTI_Private_Macros EXTI Private Macros
  269. * @{
  270. */
  271. #define IS_EXTI_LINE(__EXTI_LINE__) ((((__EXTI_LINE__) & ~(EXTI_PROPERTY_MASK | EXTI_REG_MASK | EXTI_PIN_MASK)) == 0x00u) && \
  272. ((((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_DIRECT) || \
  273. (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_CONFIG) || \
  274. (((__EXTI_LINE__) & EXTI_PROPERTY_MASK) == EXTI_GPIO)) && \
  275. (((__EXTI_LINE__) & (EXTI_REG_MASK | EXTI_PIN_MASK)) < \
  276. (((EXTI_LINE_NB / 32u) << EXTI_REG_SHIFT) | (EXTI_LINE_NB % 32u))))
  277. #define IS_EXTI_MODE(__MODE__) ((((__MODE__) & EXTI_MODE_MASK) != 0x00u) && \
  278. (((__MODE__) & ~EXTI_MODE_MASK) == 0x00u))
  279. #define IS_EXTI_TRIGGER(__EXTI_LINE__) (((__EXTI_LINE__) & ~EXTI_TRIGGER_MASK) == 0x00u)
  280. #define IS_EXTI_PENDING_EDGE(__EXTI_LINE__) (((__EXTI_LINE__) == EXTI_TRIGGER_RISING) || \
  281. ((__EXTI_LINE__) == EXTI_TRIGGER_FALLING))
  282. #define IS_EXTI_CONFIG_LINE(__EXTI_LINE__) (((__EXTI_LINE__) & EXTI_CONFIG) != 0x00u)
  283. #if defined(GPIOE)
  284. #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \
  285. ((__PORT__) == EXTI_GPIOB) || \
  286. ((__PORT__) == EXTI_GPIOC) || \
  287. ((__PORT__) == EXTI_GPIOD) || \
  288. ((__PORT__) == EXTI_GPIOE) || \
  289. ((__PORT__) == EXTI_GPIOF))
  290. #else
  291. #define IS_EXTI_GPIO_PORT(__PORT__) (((__PORT__) == EXTI_GPIOA) || \
  292. ((__PORT__) == EXTI_GPIOB) || \
  293. ((__PORT__) == EXTI_GPIOC) || \
  294. ((__PORT__) == EXTI_GPIOD) || \
  295. ((__PORT__) == EXTI_GPIOF))
  296. #endif /* GPIOE */
  297. #define IS_EXTI_GPIO_PIN(__PIN__) ((__PIN__) < 16u)
  298. /**
  299. * @}
  300. */
  301. /* Exported functions --------------------------------------------------------*/
  302. /** @defgroup EXTI_Exported_Functions EXTI Exported Functions
  303. * @brief EXTI Exported Functions
  304. * @{
  305. */
  306. /** @defgroup EXTI_Exported_Functions_Group1 Configuration functions
  307. * @brief Configuration functions
  308. * @{
  309. */
  310. /* Configuration functions ****************************************************/
  311. HAL_StatusTypeDef HAL_EXTI_SetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
  312. HAL_StatusTypeDef HAL_EXTI_GetConfigLine(EXTI_HandleTypeDef *hexti, EXTI_ConfigTypeDef *pExtiConfig);
  313. HAL_StatusTypeDef HAL_EXTI_ClearConfigLine(EXTI_HandleTypeDef *hexti);
  314. HAL_StatusTypeDef HAL_EXTI_RegisterCallback(EXTI_HandleTypeDef *hexti, EXTI_CallbackIDTypeDef CallbackID, void (*pPendingCbfn)(void));
  315. HAL_StatusTypeDef HAL_EXTI_GetHandle(EXTI_HandleTypeDef *hexti, uint32_t ExtiLine);
  316. /**
  317. * @}
  318. */
  319. /** @defgroup EXTI_Exported_Functions_Group2 IO operation functions
  320. * @brief IO operation functions
  321. * @{
  322. */
  323. /* IO operation functions *****************************************************/
  324. void HAL_EXTI_IRQHandler(EXTI_HandleTypeDef *hexti);
  325. uint32_t HAL_EXTI_GetPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
  326. void HAL_EXTI_ClearPending(EXTI_HandleTypeDef *hexti, uint32_t Edge);
  327. void HAL_EXTI_GenerateSWI(EXTI_HandleTypeDef *hexti);
  328. /**
  329. * @}
  330. */
  331. /**
  332. * @}
  333. */
  334. /**
  335. * @}
  336. */
  337. /**
  338. * @}
  339. */
  340. #ifdef __cplusplus
  341. }
  342. #endif
  343. #endif /* STM32G0xx_HAL_EXTI_H */