stm32l0xx_hal_lptim.h 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771
  1. /**
  2. ******************************************************************************
  3. * @file stm32l0xx_hal_lptim.h
  4. * @author MCD Application Team
  5. * @brief Header file of LPTIM HAL module.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * Copyright (c) 2016 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_LPTIM_H
  20. #define STM32L0xx_HAL_LPTIM_H
  21. #ifdef __cplusplus
  22. extern "C" {
  23. #endif
  24. /* Includes ------------------------------------------------------------------*/
  25. #include "stm32l0xx_hal_def.h"
  26. /** @addtogroup STM32L0xx_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_IM29 /*!< External interrupt line 29 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. #define LPTIM_TRIGSOURCE_6 (LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_2)
  219. #define LPTIM_TRIGSOURCE_7 LPTIM_CFGR_TRIGSEL
  220. /**
  221. * @}
  222. */
  223. /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity
  224. * @{
  225. */
  226. #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0
  227. #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1
  228. #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN
  229. /**
  230. * @}
  231. */
  232. /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time
  233. * @{
  234. */
  235. #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U
  236. #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0
  237. #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1
  238. #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT
  239. /**
  240. * @}
  241. */
  242. /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode
  243. * @{
  244. */
  245. #define LPTIM_UPDATE_IMMEDIATE 0x00000000U
  246. #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD
  247. /**
  248. * @}
  249. */
  250. /** @defgroup LPTIM_Counter_Source LPTIM Counter Source
  251. * @{
  252. */
  253. #define LPTIM_COUNTERSOURCE_INTERNAL 0x00000000U
  254. #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE
  255. /**
  256. * @}
  257. */
  258. /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition
  259. * @{
  260. */
  261. #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN
  262. #define LPTIM_FLAG_UP LPTIM_ISR_UP
  263. #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK
  264. #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK
  265. #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG
  266. #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM
  267. #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM
  268. /**
  269. * @}
  270. */
  271. /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition
  272. * @{
  273. */
  274. #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE
  275. #define LPTIM_IT_UP LPTIM_IER_UPIE
  276. #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE
  277. #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE
  278. #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE
  279. #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE
  280. #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE
  281. /**
  282. * @}
  283. */
  284. /**
  285. * @}
  286. */
  287. /* Exported macros -----------------------------------------------------------*/
  288. /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros
  289. * @{
  290. */
  291. /** @brief Reset LPTIM handle state.
  292. * @param __HANDLE__ LPTIM handle
  293. * @retval None
  294. */
  295. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  296. #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) do { \
  297. (__HANDLE__)->State = HAL_LPTIM_STATE_RESET; \
  298. (__HANDLE__)->MspInitCallback = NULL; \
  299. (__HANDLE__)->MspDeInitCallback = NULL; \
  300. } while(0)
  301. #else
  302. #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET)
  303. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  304. /**
  305. * @brief Enable the LPTIM peripheral.
  306. * @param __HANDLE__ LPTIM handle
  307. * @retval None
  308. */
  309. #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))
  310. /**
  311. * @brief Disable the LPTIM peripheral.
  312. * @param __HANDLE__ LPTIM handle
  313. * @note The following sequence is required to solve LPTIM disable HW limitation.
  314. * Please check Errata Sheet ES0335 for more details under "MCU may remain
  315. * stuck in LPTIM interrupt when entering Stop mode" section.
  316. * @note Please call @ref HAL_LPTIM_GetState() after a call to __HAL_LPTIM_DISABLE to
  317. * check for TIMEOUT.
  318. * @retval None
  319. */
  320. #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__)
  321. /**
  322. * @brief Start the LPTIM peripheral in Continuous mode.
  323. * @param __HANDLE__ LPTIM handle
  324. * @retval None
  325. */
  326. #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)
  327. /**
  328. * @brief Start the LPTIM peripheral in single mode.
  329. * @param __HANDLE__ LPTIM handle
  330. * @retval None
  331. */
  332. #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)
  333. /**
  334. * @brief Write the passed parameter in the Autoreload register.
  335. * @param __HANDLE__ LPTIM handle
  336. * @param __VALUE__ Autoreload value
  337. * @retval None
  338. * @note The ARR register can only be modified when the LPTIM instance is enabled.
  339. */
  340. #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__))
  341. /**
  342. * @brief Write the passed parameter in the Compare register.
  343. * @param __HANDLE__ LPTIM handle
  344. * @param __VALUE__ Compare value
  345. * @retval None
  346. * @note The CMP register can only be modified when the LPTIM instance is enabled.
  347. */
  348. #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__))
  349. /**
  350. * @brief Check whether the specified LPTIM flag is set or not.
  351. * @param __HANDLE__ LPTIM handle
  352. * @param __FLAG__ LPTIM flag to check
  353. * This parameter can be a value of:
  354. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  355. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  356. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  357. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  358. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  359. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  360. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  361. * @retval The state of the specified flag (SET or RESET).
  362. */
  363. #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))
  364. /**
  365. * @brief Clear the specified LPTIM flag.
  366. * @param __HANDLE__ LPTIM handle.
  367. * @param __FLAG__ LPTIM flag to clear.
  368. * This parameter can be a value of:
  369. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  370. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  371. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  372. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  373. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  374. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  375. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  376. * @retval None.
  377. */
  378. #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  379. /**
  380. * @brief Enable the specified LPTIM interrupt.
  381. * @param __HANDLE__ LPTIM handle.
  382. * @param __INTERRUPT__ LPTIM interrupt to set.
  383. * This parameter can be a value of:
  384. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  385. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  386. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  387. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  388. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  389. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  390. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  391. * @retval None.
  392. * @note The LPTIM interrupts can only be enabled when the LPTIM instance is disabled.
  393. */
  394. #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  395. /**
  396. * @brief Disable the specified LPTIM interrupt.
  397. * @param __HANDLE__ LPTIM handle.
  398. * @param __INTERRUPT__ LPTIM interrupt to set.
  399. * This parameter can be a value of:
  400. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  401. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  402. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  403. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  404. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  405. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  406. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  407. * @retval None.
  408. * @note The LPTIM interrupts can only be disabled when the LPTIM instance is disabled.
  409. */
  410. #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
  411. /**
  412. * @brief Check whether the specified LPTIM interrupt source is enabled or not.
  413. * @param __HANDLE__ LPTIM handle.
  414. * @param __INTERRUPT__ LPTIM interrupt to check.
  415. * This parameter can be a value of:
  416. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  417. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  418. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  419. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  420. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  421. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  422. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  423. * @retval Interrupt status.
  424. */
  425. #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER\
  426. & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  427. /**
  428. * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line.
  429. * @retval None
  430. */
  431. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR\
  432. |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  433. /**
  434. * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line.
  435. * @retval None
  436. */
  437. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR\
  438. &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  439. /**
  440. * @brief Enable event on the LPTIM Wake-up Timer associated Exti line.
  441. * @retval None.
  442. */
  443. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR\
  444. |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  445. /**
  446. * @brief Disable event on the LPTIM Wake-up Timer associated Exti line.
  447. * @retval None.
  448. */
  449. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR\
  450. &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  451. /**
  452. * @}
  453. */
  454. /* Exported functions --------------------------------------------------------*/
  455. /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
  456. * @{
  457. */
  458. /** @addtogroup LPTIM_Exported_Functions_Group1
  459. * @brief Initialization and Configuration functions.
  460. * @{
  461. */
  462. /* Initialization/de-initialization functions ********************************/
  463. HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim);
  464. HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim);
  465. /* MSP functions *************************************************************/
  466. void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim);
  467. void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim);
  468. /**
  469. * @}
  470. */
  471. /** @addtogroup LPTIM_Exported_Functions_Group2
  472. * @brief Start-Stop operation functions.
  473. * @{
  474. */
  475. /* Start/Stop operation functions *********************************************/
  476. /* ################################# PWM Mode ################################*/
  477. /* Blocking mode: Polling */
  478. HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  479. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim);
  480. /* Non-Blocking mode: Interrupt */
  481. HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  482. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  483. /* ############################# One Pulse Mode ##############################*/
  484. /* Blocking mode: Polling */
  485. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  486. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim);
  487. /* Non-Blocking mode: Interrupt */
  488. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  489. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  490. /* ############################## Set once Mode ##############################*/
  491. /* Blocking mode: Polling */
  492. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  493. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim);
  494. /* Non-Blocking mode: Interrupt */
  495. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  496. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  497. /* ############################### Encoder Mode ##############################*/
  498. /* Blocking mode: Polling */
  499. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  500. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim);
  501. /* Non-Blocking mode: Interrupt */
  502. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  503. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  504. /* ############################# Time out Mode ##############################*/
  505. /* Blocking mode: Polling */
  506. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  507. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim);
  508. /* Non-Blocking mode: Interrupt */
  509. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  510. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  511. /* ############################## Counter Mode ###############################*/
  512. /* Blocking mode: Polling */
  513. HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  514. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim);
  515. /* Non-Blocking mode: Interrupt */
  516. HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  517. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  518. /**
  519. * @}
  520. */
  521. /** @addtogroup LPTIM_Exported_Functions_Group3
  522. * @brief Read operation functions.
  523. * @{
  524. */
  525. /* Reading operation functions ************************************************/
  526. uint32_t HAL_LPTIM_ReadCounter(const LPTIM_HandleTypeDef *hlptim);
  527. uint32_t HAL_LPTIM_ReadAutoReload(const LPTIM_HandleTypeDef *hlptim);
  528. uint32_t HAL_LPTIM_ReadCompare(const LPTIM_HandleTypeDef *hlptim);
  529. /**
  530. * @}
  531. */
  532. /** @addtogroup LPTIM_Exported_Functions_Group4
  533. * @brief LPTIM IRQ handler and callback functions.
  534. * @{
  535. */
  536. /* LPTIM IRQ functions *******************************************************/
  537. void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim);
  538. /* CallBack functions ********************************************************/
  539. void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim);
  540. void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim);
  541. void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim);
  542. void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim);
  543. void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim);
  544. void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim);
  545. void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim);
  546. /* Callbacks Register/UnRegister functions ***********************************/
  547. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  548. HAL_StatusTypeDef HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID,
  549. pLPTIM_CallbackTypeDef pCallback);
  550. HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID);
  551. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  552. /**
  553. * @}
  554. */
  555. /** @addtogroup LPTIM_Group5
  556. * @brief Peripheral State functions.
  557. * @{
  558. */
  559. /* Peripheral State functions ************************************************/
  560. HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(const LPTIM_HandleTypeDef *hlptim);
  561. /**
  562. * @}
  563. */
  564. /**
  565. * @}
  566. */
  567. /* Private types -------------------------------------------------------------*/
  568. /** @defgroup LPTIM_Private_Types LPTIM Private Types
  569. * @{
  570. */
  571. /**
  572. * @}
  573. */
  574. /* Private variables ---------------------------------------------------------*/
  575. /** @defgroup LPTIM_Private_Variables LPTIM Private Variables
  576. * @{
  577. */
  578. /**
  579. * @}
  580. */
  581. /* Private constants ---------------------------------------------------------*/
  582. /** @defgroup LPTIM_Private_Constants LPTIM Private Constants
  583. * @{
  584. */
  585. /**
  586. * @}
  587. */
  588. /* Private macros ------------------------------------------------------------*/
  589. /** @defgroup LPTIM_Private_Macros LPTIM Private Macros
  590. * @{
  591. */
  592. #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \
  593. ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC))
  594. #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \
  595. ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \
  596. ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \
  597. ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \
  598. ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \
  599. ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \
  600. ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \
  601. ((__PRESCALER__) == LPTIM_PRESCALER_DIV128))
  602. #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1)
  603. #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \
  604. ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH))
  605. #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \
  606. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \
  607. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \
  608. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS))
  609. #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \
  610. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \
  611. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING))
  612. #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \
  613. ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \
  614. ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \
  615. ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \
  616. ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \
  617. ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \
  618. ((__TRIG__) == LPTIM_TRIGSOURCE_5) || \
  619. ((__TRIG__) == LPTIM_TRIGSOURCE_6) || \
  620. ((__TRIG__) == LPTIM_TRIGSOURCE_7))
  621. #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \
  622. ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \
  623. ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING ))
  624. #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \
  625. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \
  626. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \
  627. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS ))
  628. #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \
  629. ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD))
  630. #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \
  631. ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL))
  632. #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((0x00000001UL <= (__AUTORELOAD__)) &&\
  633. ((__AUTORELOAD__) <= 0x0000FFFFUL))
  634. #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL)
  635. #define IS_LPTIM_PERIOD(__PERIOD__) ((0x00000001UL <= (__PERIOD__)) &&\
  636. ((__PERIOD__) <= 0x0000FFFFUL))
  637. #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL)
  638. /**
  639. * @}
  640. */
  641. /* Private functions ---------------------------------------------------------*/
  642. /** @defgroup LPTIM_Private_Functions LPTIM Private Functions
  643. * @{
  644. */
  645. void LPTIM_Disable(LPTIM_HandleTypeDef *hlptim);
  646. /**
  647. * @}
  648. */
  649. /**
  650. * @}
  651. */
  652. #endif /* LPTIM1 */
  653. /**
  654. * @}
  655. */
  656. #ifdef __cplusplus
  657. }
  658. #endif
  659. #endif /* STM32L0xx_HAL_LPTIM_H */