You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

726 lines
31 KiB

  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. * <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 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. * @retval None
  317. */
  318. #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__)
  319. /**
  320. * @brief Start the LPTIM peripheral in Continuous mode.
  321. * @param __HANDLE__ LPTIM handle
  322. * @retval None
  323. */
  324. #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)
  325. /**
  326. * @brief Start the LPTIM peripheral in single mode.
  327. * @param __HANDLE__ LPTIM handle
  328. * @retval None
  329. */
  330. #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)
  331. /**
  332. * @brief Write the passed parameter in the Autoreload register.
  333. * @param __HANDLE__ LPTIM handle
  334. * @param __VALUE__ Autoreload value
  335. * @retval None
  336. */
  337. #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__))
  338. /**
  339. * @brief Write the passed parameter in the Compare register.
  340. * @param __HANDLE__ LPTIM handle
  341. * @param __VALUE__ Compare value
  342. * @retval None
  343. */
  344. #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__))
  345. /**
  346. * @brief Check whether the specified LPTIM flag is set or not.
  347. * @param __HANDLE__ LPTIM handle
  348. * @param __FLAG__ LPTIM flag to check
  349. * This parameter can be a value of:
  350. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  351. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  352. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  353. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  354. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  355. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  356. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  357. * @retval The state of the specified flag (SET or RESET).
  358. */
  359. #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))
  360. /**
  361. * @brief Clear the specified LPTIM flag.
  362. * @param __HANDLE__ LPTIM handle.
  363. * @param __FLAG__ LPTIM flag to clear.
  364. * This parameter can be a value of:
  365. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  366. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  367. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  368. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  369. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  370. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  371. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  372. * @retval None.
  373. */
  374. #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  375. /**
  376. * @brief Enable the specified LPTIM interrupt.
  377. * @param __HANDLE__ LPTIM handle.
  378. * @param __INTERRUPT__ LPTIM interrupt to set.
  379. * This parameter can be a value of:
  380. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  381. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  382. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  383. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  384. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  385. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  386. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  387. * @retval None.
  388. */
  389. #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  390. /**
  391. * @brief Disable the specified LPTIM interrupt.
  392. * @param __HANDLE__ LPTIM handle.
  393. * @param __INTERRUPT__ LPTIM interrupt to set.
  394. * This parameter can be a value of:
  395. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  396. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  397. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  398. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  399. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  400. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  401. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  402. * @retval None.
  403. */
  404. #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
  405. /**
  406. * @brief Check whether the specified LPTIM interrupt source is enabled or not.
  407. * @param __HANDLE__ LPTIM handle.
  408. * @param __INTERRUPT__ LPTIM interrupt to check.
  409. * This parameter can be a value of:
  410. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  411. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  412. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  413. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  414. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  415. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  416. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  417. * @retval Interrupt status.
  418. */
  419. #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  420. /**
  421. * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line.
  422. * @retval None
  423. */
  424. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  425. /**
  426. * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line.
  427. * @retval None
  428. */
  429. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  430. /**
  431. * @brief Enable event on the LPTIM Wake-up Timer associated Exti line.
  432. * @retval None.
  433. */
  434. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
  435. /**
  436. * @brief Disable event on the LPTIM Wake-up Timer associated Exti line.
  437. * @retval None.
  438. */
  439. #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
  440. /**
  441. * @}
  442. */
  443. /* Exported functions --------------------------------------------------------*/
  444. /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
  445. * @{
  446. */
  447. /* Initialization/de-initialization functions ********************************/
  448. HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim);
  449. HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim);
  450. /* MSP functions *************************************************************/
  451. void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim);
  452. void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim);
  453. /* Start/Stop operation functions *********************************************/
  454. /* ################################# PWM Mode ################################*/
  455. /* Blocking mode: Polling */
  456. HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  457. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim);
  458. /* Non-Blocking mode: Interrupt */
  459. HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  460. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  461. /* ############################# One Pulse Mode ##############################*/
  462. /* Blocking mode: Polling */
  463. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  464. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim);
  465. /* Non-Blocking mode: Interrupt */
  466. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  467. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  468. /* ############################## Set once Mode ##############################*/
  469. /* Blocking mode: Polling */
  470. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  471. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim);
  472. /* Non-Blocking mode: Interrupt */
  473. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  474. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  475. /* ############################### Encoder Mode ##############################*/
  476. /* Blocking mode: Polling */
  477. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  478. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim);
  479. /* Non-Blocking mode: Interrupt */
  480. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  481. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  482. /* ############################# Time out Mode ##############################*/
  483. /* Blocking mode: Polling */
  484. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  485. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim);
  486. /* Non-Blocking mode: Interrupt */
  487. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  488. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  489. /* ############################## Counter Mode ###############################*/
  490. /* Blocking mode: Polling */
  491. HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  492. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim);
  493. /* Non-Blocking mode: Interrupt */
  494. HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  495. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  496. /* Reading operation functions ************************************************/
  497. uint32_t HAL_LPTIM_ReadCounter(LPTIM_HandleTypeDef *hlptim);
  498. uint32_t HAL_LPTIM_ReadAutoReload(LPTIM_HandleTypeDef *hlptim);
  499. uint32_t HAL_LPTIM_ReadCompare(LPTIM_HandleTypeDef *hlptim);
  500. /* LPTIM IRQ functions *******************************************************/
  501. void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim);
  502. /* CallBack functions ********************************************************/
  503. void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim);
  504. void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim);
  505. void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim);
  506. void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim);
  507. void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim);
  508. void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim);
  509. void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim);
  510. /* Callbacks Register/UnRegister functions ***********************************/
  511. #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  512. HAL_StatusTypeDef HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID, pLPTIM_CallbackTypeDef pCallback);
  513. HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID);
  514. #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  515. /* Peripheral State functions ************************************************/
  516. HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim);
  517. /**
  518. * @}
  519. */
  520. /* Private types -------------------------------------------------------------*/
  521. /** @defgroup LPTIM_Private_Types LPTIM Private Types
  522. * @{
  523. */
  524. /**
  525. * @}
  526. */
  527. /* Private variables ---------------------------------------------------------*/
  528. /** @defgroup LPTIM_Private_Variables LPTIM Private Variables
  529. * @{
  530. */
  531. /**
  532. * @}
  533. */
  534. /* Private constants ---------------------------------------------------------*/
  535. /** @defgroup LPTIM_Private_Constants LPTIM Private Constants
  536. * @{
  537. */
  538. /**
  539. * @}
  540. */
  541. /* Private macros ------------------------------------------------------------*/
  542. /** @defgroup LPTIM_Private_Macros LPTIM Private Macros
  543. * @{
  544. */
  545. #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \
  546. ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC))
  547. #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \
  548. ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \
  549. ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \
  550. ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \
  551. ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \
  552. ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \
  553. ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \
  554. ((__PRESCALER__) == LPTIM_PRESCALER_DIV128))
  555. #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1)
  556. #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \
  557. ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH))
  558. #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \
  559. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \
  560. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \
  561. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS))
  562. #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \
  563. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \
  564. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING))
  565. #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \
  566. ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \
  567. ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \
  568. ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \
  569. ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \
  570. ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \
  571. ((__TRIG__) == LPTIM_TRIGSOURCE_5) || \
  572. ((__TRIG__) == LPTIM_TRIGSOURCE_6) || \
  573. ((__TRIG__) == LPTIM_TRIGSOURCE_7))
  574. #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \
  575. ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \
  576. ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING ))
  577. #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \
  578. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \
  579. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \
  580. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS ))
  581. #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \
  582. ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD))
  583. #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \
  584. ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL))
  585. #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((__AUTORELOAD__) <= 0x0000FFFFUL)
  586. #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL)
  587. #define IS_LPTIM_PERIOD(__PERIOD__) ((__PERIOD__) <= 0x0000FFFFUL)
  588. #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL)
  589. /**
  590. * @}
  591. */
  592. /* Private functions ---------------------------------------------------------*/
  593. /** @defgroup LPTIM_Private_Functions LPTIM Private Functions
  594. * @{
  595. */
  596. void LPTIM_Disable(LPTIM_HandleTypeDef *lptim);
  597. /**
  598. * @}
  599. */
  600. /**
  601. * @}
  602. */
  603. #endif /* LPTIM1 */
  604. /**
  605. * @}
  606. */
  607. #ifdef __cplusplus
  608. }
  609. #endif
  610. #endif /* STM32L0xx_HAL_LPTIM_H */
  611. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/