您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符
 
 

802 行
34 KiB

  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_hal_lptim.h
  4. * @author MCD Application Team
  5. * @brief Header file of LPTIM 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. /* Define to prevent recursive inclusion -------------------------------------*/
  19. #ifndef STM32F4xx_HAL_LPTIM_H
  20. #define STM32F4xx_HAL_LPTIM_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32f4xx_hal_def.h"
  26. /** @addtogroup STM32F4xx_HAL_Driver
  27. * @{
  28. */
  29. #if defined (LPTIM1)
  30. /** @addtogroup LPTIM
  31. * @{
  32. */
  33. /* Exported types ------------------------------------------------------------*/
  34. /** @defgroup LPTIM_Exported_Types LPTIM Exported Types
  35. * @{
  36. */
  37. #define LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT EXTI_IMR_MR23 /*!< External interrupt line 23 Connected to the LPTIM EXTI Line */
  38. /**
  39. * @brief LPTIM Clock configuration definition
  40. */
  41. typedef struct
  42. {
  43. uint32_t Source; /*!< Selects the clock source.
  44. This parameter can be a value of @ref LPTIM_Clock_Source */
  45. uint32_t Prescaler; /*!< Specifies the counter clock Prescaler.
  46. This parameter can be a value of @ref LPTIM_Clock_Prescaler */
  47. } LPTIM_ClockConfigTypeDef;
  48. /**
  49. * @brief LPTIM Clock configuration definition
  50. */
  51. typedef struct
  52. {
  53. uint32_t Polarity; /*!< Selects the polarity of the active edge for the counter unit
  54. if the ULPTIM input is selected.
  55. Note: This parameter is used only when Ultra low power clock source is used.
  56. Note: If the polarity is configured on 'both edges', an auxiliary clock
  57. (one of the Low power oscillator) must be active.
  58. This parameter can be a value of @ref LPTIM_Clock_Polarity */
  59. uint32_t SampleTime; /*!< Selects the clock sampling time to configure the clock glitch filter.
  60. Note: This parameter is used only when Ultra low power clock source is used.
  61. This parameter can be a value of @ref LPTIM_Clock_Sample_Time */
  62. } LPTIM_ULPClockConfigTypeDef;
  63. /**
  64. * @brief LPTIM Trigger configuration definition
  65. */
  66. typedef struct
  67. {
  68. uint32_t Source; /*!< Selects the Trigger source.
  69. This parameter can be a value of @ref LPTIM_Trigger_Source */
  70. uint32_t ActiveEdge; /*!< Selects the Trigger active edge.
  71. Note: This parameter is used only when an external trigger is used.
  72. This parameter can be a value of @ref LPTIM_External_Trigger_Polarity */
  73. uint32_t SampleTime; /*!< Selects the trigger sampling time to configure the clock glitch filter.
  74. Note: This parameter is used only when an external trigger is used.
  75. This parameter can be a value of @ref LPTIM_Trigger_Sample_Time */
  76. } LPTIM_TriggerConfigTypeDef;
  77. /**
  78. * @brief LPTIM Initialization Structure definition
  79. */
  80. typedef struct
  81. {
  82. LPTIM_ClockConfigTypeDef Clock; /*!< Specifies the clock parameters */
  83. LPTIM_ULPClockConfigTypeDef UltraLowPowerClock; /*!< Specifies the Ultra Low Power clock parameters */
  84. LPTIM_TriggerConfigTypeDef Trigger; /*!< Specifies the Trigger parameters */
  85. uint32_t OutputPolarity; /*!< Specifies the Output polarity.
  86. This parameter can be a value of @ref LPTIM_Output_Polarity */
  87. uint32_t UpdateMode; /*!< Specifies whether the update of the autoreload and the compare
  88. values is done immediately or after the end of current period.
  89. This parameter can be a value of @ref LPTIM_Updating_Mode */
  90. uint32_t CounterSource; /*!< Specifies whether the counter is incremented each internal event
  91. or each external event.
  92. This parameter can be a value of @ref LPTIM_Counter_Source */
  93. } LPTIM_InitTypeDef;
  94. /**
  95. * @brief HAL LPTIM State structure definition
  96. */
  97. typedef enum
  98. {
  99. HAL_LPTIM_STATE_RESET = 0x00U, /*!< Peripheral not yet initialized or disabled */
  100. HAL_LPTIM_STATE_READY = 0x01U, /*!< Peripheral Initialized and ready for use */
  101. HAL_LPTIM_STATE_BUSY = 0x02U, /*!< An internal process is ongoing */
  102. HAL_LPTIM_STATE_TIMEOUT = 0x03U, /*!< Timeout state */
  103. HAL_LPTIM_STATE_ERROR = 0x04U /*!< Internal Process is ongoing */
  104. } HAL_LPTIM_StateTypeDef;
  105. /**
  106. * @brief LPTIM handle Structure definition
  107. */
  108. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  109. typedef struct __LPTIM_HandleTypeDef
  110. #else
  111. typedef struct
  112. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  113. {
  114. LPTIM_TypeDef *Instance; /*!< Register base address */
  115. LPTIM_InitTypeDef Init; /*!< LPTIM required parameters */
  116. HAL_StatusTypeDef Status; /*!< LPTIM peripheral status */
  117. HAL_LockTypeDef Lock; /*!< LPTIM locking object */
  118. __IO HAL_LPTIM_StateTypeDef State; /*!< LPTIM peripheral state */
  119. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  120. void (* MspInitCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< LPTIM Base Msp Init Callback */
  121. void (* MspDeInitCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< LPTIM Base Msp DeInit Callback */
  122. void (* CompareMatchCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Compare match Callback */
  123. void (* AutoReloadMatchCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Auto-reload match Callback */
  124. void (* TriggerCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< External trigger event detection Callback */
  125. void (* CompareWriteCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Compare register write complete Callback */
  126. void (* AutoReloadWriteCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Auto-reload register write complete Callback */
  127. void (* DirectionUpCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Up-counting direction change Callback */
  128. void (* DirectionDownCallback)(struct __LPTIM_HandleTypeDef *hlptim); /*!< Down-counting direction change Callback */
  129. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  130. } LPTIM_HandleTypeDef;
  131. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  132. /**
  133. * @brief HAL LPTIM Callback ID enumeration definition
  134. */
  135. typedef enum
  136. {
  137. HAL_LPTIM_MSPINIT_CB_ID = 0x00U, /*!< LPTIM Base Msp Init Callback ID */
  138. HAL_LPTIM_MSPDEINIT_CB_ID = 0x01U, /*!< LPTIM Base Msp DeInit Callback ID */
  139. HAL_LPTIM_COMPARE_MATCH_CB_ID = 0x02U, /*!< Compare match Callback ID */
  140. HAL_LPTIM_AUTORELOAD_MATCH_CB_ID = 0x03U, /*!< Auto-reload match Callback ID */
  141. HAL_LPTIM_TRIGGER_CB_ID = 0x04U, /*!< External trigger event detection Callback ID */
  142. HAL_LPTIM_COMPARE_WRITE_CB_ID = 0x05U, /*!< Compare register write complete Callback ID */
  143. HAL_LPTIM_AUTORELOAD_WRITE_CB_ID = 0x06U, /*!< Auto-reload register write complete Callback ID */
  144. HAL_LPTIM_DIRECTION_UP_CB_ID = 0x07U, /*!< Up-counting direction change Callback ID */
  145. HAL_LPTIM_DIRECTION_DOWN_CB_ID = 0x08U, /*!< Down-counting direction change Callback ID */
  146. } HAL_LPTIM_CallbackIDTypeDef;
  147. /**
  148. * @brief HAL TIM Callback pointer definition
  149. */
  150. typedef void (*pLPTIM_CallbackTypeDef)(LPTIM_HandleTypeDef *hlptim); /*!< pointer to the LPTIM callback function */
  151. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  152. /**
  153. * @}
  154. */
  155. /* Exported constants --------------------------------------------------------*/
  156. /** @defgroup LPTIM_Exported_Constants LPTIM Exported Constants
  157. * @{
  158. */
  159. /** @defgroup LPTIM_Clock_Source LPTIM Clock Source
  160. * @{
  161. */
  162. #define LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC 0x00000000U
  163. #define LPTIM_CLOCKSOURCE_ULPTIM LPTIM_CFGR_CKSEL
  164. /**
  165. * @}
  166. */
  167. /** @defgroup LPTIM_Clock_Prescaler LPTIM Clock Prescaler
  168. * @{
  169. */
  170. #define LPTIM_PRESCALER_DIV1 0x00000000U
  171. #define LPTIM_PRESCALER_DIV2 LPTIM_CFGR_PRESC_0
  172. #define LPTIM_PRESCALER_DIV4 LPTIM_CFGR_PRESC_1
  173. #define LPTIM_PRESCALER_DIV8 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_1)
  174. #define LPTIM_PRESCALER_DIV16 LPTIM_CFGR_PRESC_2
  175. #define LPTIM_PRESCALER_DIV32 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_2)
  176. #define LPTIM_PRESCALER_DIV64 (LPTIM_CFGR_PRESC_1 | LPTIM_CFGR_PRESC_2)
  177. #define LPTIM_PRESCALER_DIV128 LPTIM_CFGR_PRESC
  178. /**
  179. * @}
  180. */
  181. /** @defgroup LPTIM_Output_Polarity LPTIM Output Polarity
  182. * @{
  183. */
  184. #define LPTIM_OUTPUTPOLARITY_HIGH 0x00000000U
  185. #define LPTIM_OUTPUTPOLARITY_LOW LPTIM_CFGR_WAVPOL
  186. /**
  187. * @}
  188. */
  189. /** @defgroup LPTIM_Clock_Sample_Time LPTIM Clock Sample Time
  190. * @{
  191. */
  192. #define LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION 0x00000000U
  193. #define LPTIM_CLOCKSAMPLETIME_2TRANSITIONS LPTIM_CFGR_CKFLT_0
  194. #define LPTIM_CLOCKSAMPLETIME_4TRANSITIONS LPTIM_CFGR_CKFLT_1
  195. #define LPTIM_CLOCKSAMPLETIME_8TRANSITIONS LPTIM_CFGR_CKFLT
  196. /**
  197. * @}
  198. */
  199. /** @defgroup LPTIM_Clock_Polarity LPTIM Clock Polarity
  200. * @{
  201. */
  202. #define LPTIM_CLOCKPOLARITY_RISING 0x00000000U
  203. #define LPTIM_CLOCKPOLARITY_FALLING LPTIM_CFGR_CKPOL_0
  204. #define LPTIM_CLOCKPOLARITY_RISING_FALLING LPTIM_CFGR_CKPOL_1
  205. /**
  206. * @}
  207. */
  208. /** @defgroup LPTIM_Trigger_Source LPTIM Trigger Source
  209. * @{
  210. */
  211. #define LPTIM_TRIGSOURCE_SOFTWARE 0x0000FFFFU
  212. #define LPTIM_TRIGSOURCE_0 0x00000000U
  213. #define LPTIM_TRIGSOURCE_1 LPTIM_CFGR_TRIGSEL_0
  214. #define LPTIM_TRIGSOURCE_2 LPTIM_CFGR_TRIGSEL_1
  215. #define LPTIM_TRIGSOURCE_3 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_1)
  216. #define LPTIM_TRIGSOURCE_4 LPTIM_CFGR_TRIGSEL_2
  217. #define LPTIM_TRIGSOURCE_5 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_2)
  218. /**
  219. * @}
  220. */
  221. /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity
  222. * @{
  223. */
  224. #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0
  225. #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1
  226. #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN
  227. /**
  228. * @}
  229. */
  230. /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time
  231. * @{
  232. */
  233. #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U
  234. #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0
  235. #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1
  236. #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT
  237. /**
  238. * @}
  239. */
  240. /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode
  241. * @{
  242. */
  243. #define LPTIM_UPDATE_IMMEDIATE 0x00000000U
  244. #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD
  245. /**
  246. * @}
  247. */
  248. /** @defgroup LPTIM_Counter_Source LPTIM Counter Source
  249. * @{
  250. */
  251. #define LPTIM_COUNTERSOURCE_INTERNAL 0x00000000U
  252. #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE
  253. /**
  254. * @}
  255. */
  256. /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition
  257. * @{
  258. */
  259. #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN
  260. #define LPTIM_FLAG_UP LPTIM_ISR_UP
  261. #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK
  262. #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK
  263. #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG
  264. #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM
  265. #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM
  266. /**
  267. * @}
  268. */
  269. /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition
  270. * @{
  271. */
  272. #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE
  273. #define LPTIM_IT_UP LPTIM_IER_UPIE
  274. #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE
  275. #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE
  276. #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE
  277. #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE
  278. #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE
  279. /**
  280. * @}
  281. */
  282. /** @defgroup LPTIM_Option Register Definition
  283. * @{
  284. */
  285. #define LPTIM_OP_PAD_AF 0x00000000U
  286. #define LPTIM_OP_PAD_PA4 LPTIM_OR_LPT_IN1_RMP_0
  287. #define LPTIM_OP_PAD_PB9 LPTIM_OR_LPT_IN1_RMP_1
  288. #define LPTIM_OP_TIM_DAC LPTIM_OR_LPT_IN1_RMP
  289. /**
  290. * @}
  291. */
  292. /**
  293. * @}
  294. */
  295. /* Exported macros -----------------------------------------------------------*/
  296. /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros
  297. * @{
  298. */
  299. /** @brief Reset LPTIM handle state.
  300. * @param __HANDLE__ LPTIM handle
  301. * @retval None
  302. */
  303. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  304. #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) do { \
  305. (__HANDLE__)->State = HAL_LPTIM_STATE_RESET; \
  306. (__HANDLE__)->MspInitCallback = NULL; \
  307. (__HANDLE__)->MspDeInitCallback = NULL; \
  308. } while(0)
  309. #else
  310. #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET)
  311. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  312. /**
  313. * @brief Enable the LPTIM peripheral.
  314. * @param __HANDLE__ LPTIM handle
  315. * @retval None
  316. */
  317. #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))
  318. /**
  319. * @brief Disable the LPTIM peripheral.
  320. * @param __HANDLE__ LPTIM handle
  321. * @note The following sequence is required to solve LPTIM disable HW limitation.
  322. * Please check Errata Sheet ES0335 for more details under "MCU may remain
  323. * stuck in LPTIM interrupt when entering Stop mode" section.
  324. * @retval None
  325. */
  326. #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__)
  327. /**
  328. * @brief Start the LPTIM peripheral in Continuous mode.
  329. * @param __HANDLE__ LPTIM handle
  330. * @retval None
  331. */
  332. #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)
  333. /**
  334. * @brief Start the LPTIM peripheral in single mode.
  335. * @param __HANDLE__ LPTIM handle
  336. * @retval None
  337. */
  338. #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)
  339. /**
  340. * @brief Write the passed parameter in the Autoreload register.
  341. * @param __HANDLE__ LPTIM handle
  342. * @param __VALUE__ Autoreload value
  343. * @retval None
  344. */
  345. #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__))
  346. /**
  347. * @brief Write the passed parameter in the Compare register.
  348. * @param __HANDLE__ LPTIM handle
  349. * @param __VALUE__ Compare value
  350. * @retval None
  351. */
  352. #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__))
  353. /**
  354. * @brief Check whether the specified LPTIM flag is set or not.
  355. * @param __HANDLE__ LPTIM handle
  356. * @param __FLAG__ LPTIM flag to check
  357. * This parameter can be a value of:
  358. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  359. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  360. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  361. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  362. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  363. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  364. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  365. * @retval The state of the specified flag (SET or RESET).
  366. */
  367. #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))
  368. /**
  369. * @brief Clear the specified LPTIM flag.
  370. * @param __HANDLE__ LPTIM handle.
  371. * @param __FLAG__ LPTIM flag to clear.
  372. * This parameter can be a value of:
  373. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  374. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  375. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  376. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  377. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  378. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  379. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  380. * @retval None.
  381. */
  382. #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  383. /**
  384. * @brief Enable the specified LPTIM interrupt.
  385. * @param __HANDLE__ LPTIM handle.
  386. * @param __INTERRUPT__ LPTIM interrupt to set.
  387. * This parameter can be a value of:
  388. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  389. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  390. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  391. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  392. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  393. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  394. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  395. * @retval None.
  396. */
  397. #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  398. /**
  399. * @brief Disable the specified LPTIM interrupt.
  400. * @param __HANDLE__ LPTIM handle.
  401. * @param __INTERRUPT__ LPTIM interrupt to set.
  402. * This parameter can be a value of:
  403. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  404. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  405. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  406. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  407. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  408. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  409. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  410. * @retval None.
  411. */
  412. #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
  413. /**
  414. * @brief Check whether the specified LPTIM interrupt source is enabled or not.
  415. * @param __HANDLE__ LPTIM handle.
  416. * @param __INTERRUPT__ LPTIM interrupt to check.
  417. * This parameter can be a value of:
  418. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  419. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  420. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  421. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  422. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  423. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  424. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  425. * @retval Interrupt status.
  426. */
  427. #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  428. /** @brief LPTIM Option Register
  429. * @param __HANDLE__ LPTIM handle
  430. * @param __VALUE__ This parameter can be a value of :
  431. * @arg LPTIM_OP_PAD_AF
  432. * @arg LPTIM_OP_PAD_PA4
  433. * @arg LPTIM_OP_PAD_PB9
  434. * @arg LPTIM_OP_TIM_DAC
  435. * @retval None
  436. */
  437. #define __HAL_LPTIM_OPTR_CONFIG(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->OR = (__VALUE__))
  438. /**
  439. * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line.
  440. * @retval None
  441. */
  442. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  443. /**
  444. * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line.
  445. * @retval None
  446. */
  447. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  448. /**
  449. * @brief Enable event on the LPTIM Wake-up Timer associated Exti line.
  450. * @retval None.
  451. */
  452. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  453. /**
  454. * @brief Disable event on the LPTIM Wake-up Timer associated Exti line.
  455. * @retval None.
  456. */
  457. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  458. /**
  459. * @brief Enable falling edge trigger on the LPTIM Wake-up Timer associated Exti line.
  460. * @retval None.
  461. */
  462. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE() (EXTI->FTSR |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  463. /**
  464. * @brief Disable falling edge trigger on the LPTIM Wake-up Timer associated Exti line.
  465. * @retval None.
  466. */
  467. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE() (EXTI->FTSR &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  468. /**
  469. * @brief Enable rising edge trigger on the LPTIM Wake-up Timer associated Exti line.
  470. * @retval None.
  471. */
  472. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE() (EXTI->RTSR |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  473. /**
  474. * @brief Disable rising edge trigger on the LPTIM Wake-up Timer associated Exti line.
  475. * @retval None.
  476. */
  477. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE() (EXTI->RTSR &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  478. /**
  479. * @brief Enable rising & falling edge trigger on the LPTIM Wake-up Timer associated Exti line.
  480. * @retval None.
  481. */
  482. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE() do{__HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE();\
  483. __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE();\
  484. }while(0)
  485. /**
  486. * @brief Disable rising & falling edge trigger on the LPTIM Wake-up Timer associated Exti line.
  487. * @retval None.
  488. */
  489. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE() do{__HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE();\
  490. __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE();\
  491. }while(0)
  492. /**
  493. * @brief Check whether the LPTIM Wake-up Timer associated Exti line interrupt flag is set or not.
  494. * @retval Line Status.
  495. */
  496. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_GET_FLAG() (EXTI->PR & LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  497. /**
  498. * @brief Clear the LPTIM Wake-up Timer associated Exti line flag.
  499. * @retval None.
  500. */
  501. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_CLEAR_FLAG() (EXTI->PR = LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  502. /**
  503. * @brief Generate a Software interrupt on the LPTIM Wake-up Timer associated Exti line.
  504. * @retval None.
  505. */
  506. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_GENERATE_SWIT() (EXTI->SWIER |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  507. /**
  508. * @}
  509. */
  510. /* Exported functions --------------------------------------------------------*/
  511. /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
  512. * @{
  513. */
  514. /* Initialization/de-initialization functions ********************************/
  515. HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim);
  516. HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim);
  517. /* MSP functions *************************************************************/
  518. void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim);
  519. void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim);
  520. /* Start/Stop operation functions *********************************************/
  521. /* ################################# PWM Mode ################################*/
  522. /* Blocking mode: Polling */
  523. HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  524. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim);
  525. /* Non-Blocking mode: Interrupt */
  526. HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  527. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  528. /* ############################# One Pulse Mode ##############################*/
  529. /* Blocking mode: Polling */
  530. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  531. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim);
  532. /* Non-Blocking mode: Interrupt */
  533. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  534. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  535. /* ############################## Set once Mode ##############################*/
  536. /* Blocking mode: Polling */
  537. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  538. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim);
  539. /* Non-Blocking mode: Interrupt */
  540. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  541. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  542. /* ############################### Encoder Mode ##############################*/
  543. /* Blocking mode: Polling */
  544. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  545. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim);
  546. /* Non-Blocking mode: Interrupt */
  547. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  548. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  549. /* ############################# Time out Mode ##############################*/
  550. /* Blocking mode: Polling */
  551. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  552. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim);
  553. /* Non-Blocking mode: Interrupt */
  554. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  555. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  556. /* ############################## Counter Mode ###############################*/
  557. /* Blocking mode: Polling */
  558. HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  559. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim);
  560. /* Non-Blocking mode: Interrupt */
  561. HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  562. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  563. /* Reading operation functions ************************************************/
  564. uint32_t HAL_LPTIM_ReadCounter(LPTIM_HandleTypeDef *hlptim);
  565. uint32_t HAL_LPTIM_ReadAutoReload(LPTIM_HandleTypeDef *hlptim);
  566. uint32_t HAL_LPTIM_ReadCompare(LPTIM_HandleTypeDef *hlptim);
  567. /* LPTIM IRQ functions *******************************************************/
  568. void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim);
  569. /* CallBack functions ********************************************************/
  570. void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim);
  571. void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim);
  572. void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim);
  573. void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim);
  574. void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim);
  575. void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim);
  576. void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim);
  577. /* Callbacks Register/UnRegister functions ***********************************/
  578. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  579. HAL_StatusTypeDef HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID, pLPTIM_CallbackTypeDef pCallback);
  580. HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID);
  581. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  582. /* Peripheral State functions ************************************************/
  583. HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim);
  584. /**
  585. * @}
  586. */
  587. /* Private types -------------------------------------------------------------*/
  588. /** @defgroup LPTIM_Private_Types LPTIM Private Types
  589. * @{
  590. */
  591. /**
  592. * @}
  593. */
  594. /* Private variables ---------------------------------------------------------*/
  595. /** @defgroup LPTIM_Private_Variables LPTIM Private Variables
  596. * @{
  597. */
  598. /**
  599. * @}
  600. */
  601. /* Private constants ---------------------------------------------------------*/
  602. /** @defgroup LPTIM_Private_Constants LPTIM Private Constants
  603. * @{
  604. */
  605. /**
  606. * @}
  607. */
  608. /* Private macros ------------------------------------------------------------*/
  609. /** @defgroup LPTIM_Private_Macros LPTIM Private Macros
  610. * @{
  611. */
  612. #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \
  613. ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC))
  614. #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \
  615. ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \
  616. ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \
  617. ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \
  618. ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \
  619. ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \
  620. ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \
  621. ((__PRESCALER__) == LPTIM_PRESCALER_DIV128))
  622. #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1)
  623. #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \
  624. ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH))
  625. #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \
  626. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \
  627. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \
  628. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS))
  629. #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \
  630. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \
  631. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING))
  632. #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \
  633. ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \
  634. ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \
  635. ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \
  636. ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \
  637. ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \
  638. ((__TRIG__) == LPTIM_TRIGSOURCE_5))
  639. #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \
  640. ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \
  641. ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING ))
  642. #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \
  643. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \
  644. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \
  645. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS ))
  646. #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \
  647. ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD))
  648. #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \
  649. ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL))
  650. #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((__AUTORELOAD__) <= 0x0000FFFFUL)
  651. #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL)
  652. #define IS_LPTIM_PERIOD(__PERIOD__) ((__PERIOD__) <= 0x0000FFFFUL)
  653. #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL)
  654. /**
  655. * @}
  656. */
  657. /* Private functions ---------------------------------------------------------*/
  658. /** @defgroup LPTIM_Private_Functions LPTIM Private Functions
  659. * @{
  660. */
  661. void LPTIM_Disable(LPTIM_HandleTypeDef *lptim);
  662. /**
  663. * @}
  664. */
  665. /**
  666. * @}
  667. */
  668. #endif /* LPTIM1 */
  669. /**
  670. * @}
  671. */
  672. #ifdef __cplusplus
  673. }
  674. #endif
  675. #endif /* STM32F4xx_HAL_LPTIM_H */
  676. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/