stm32l4xx_hal_lptim.h 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702
  1. /**
  2. ******************************************************************************
  3. * @file stm32l4xx_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) 2017 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. /* Define to prevent recursive inclusion -------------------------------------*/
  36. #ifndef __STM32L4xx_HAL_LPTIM_H
  37. #define __STM32L4xx_HAL_LPTIM_H
  38. #ifdef __cplusplus
  39. extern "C" {
  40. #endif
  41. /* Includes ------------------------------------------------------------------*/
  42. #include "stm32l4xx_hal_def.h"
  43. /** @addtogroup STM32L4xx_HAL_Driver
  44. * @{
  45. */
  46. /** @addtogroup LPTIM
  47. * @{
  48. */
  49. /* Exported types ------------------------------------------------------------*/
  50. /** @defgroup LPTIM_Exported_Types LPTIM Exported Types
  51. * @{
  52. */
  53. /**
  54. * @brief LPTIM Clock configuration definition
  55. */
  56. typedef struct
  57. {
  58. uint32_t Source; /*!< Selects the clock source.
  59. This parameter can be a value of @ref LPTIM_Clock_Source */
  60. uint32_t Prescaler; /*!< Specifies the counter clock Prescaler.
  61. This parameter can be a value of @ref LPTIM_Clock_Prescaler */
  62. }LPTIM_ClockConfigTypeDef;
  63. /**
  64. * @brief LPTIM Clock configuration definition
  65. */
  66. typedef struct
  67. {
  68. uint32_t Polarity; /*!< Selects the polarity of the active edge for the counter unit
  69. if the ULPTIM input is selected.
  70. Note: This parameter is used only when Ultra low power clock source is used.
  71. Note: If the polarity is configured on 'both edges', an auxiliary clock
  72. (one of the Low power oscillator) must be active.
  73. This parameter can be a value of @ref LPTIM_Clock_Polarity */
  74. uint32_t SampleTime; /*!< Selects the clock sampling time to configure the clock glitch filter.
  75. Note: This parameter is used only when Ultra low power clock source is used.
  76. This parameter can be a value of @ref LPTIM_Clock_Sample_Time */
  77. }LPTIM_ULPClockConfigTypeDef;
  78. /**
  79. * @brief LPTIM Trigger configuration definition
  80. */
  81. typedef struct
  82. {
  83. uint32_t Source; /*!< Selects the Trigger source.
  84. This parameter can be a value of @ref LPTIM_Trigger_Source */
  85. uint32_t ActiveEdge; /*!< Selects the Trigger active edge.
  86. Note: This parameter is used only when an external trigger is used.
  87. This parameter can be a value of @ref LPTIM_External_Trigger_Polarity */
  88. uint32_t SampleTime; /*!< Selects the trigger sampling time to configure the clock glitch filter.
  89. Note: This parameter is used only when an external trigger is used.
  90. This parameter can be a value of @ref LPTIM_Trigger_Sample_Time */
  91. }LPTIM_TriggerConfigTypeDef;
  92. /**
  93. * @brief LPTIM Initialization Structure definition
  94. */
  95. typedef struct
  96. {
  97. LPTIM_ClockConfigTypeDef Clock; /*!< Specifies the clock parameters */
  98. LPTIM_ULPClockConfigTypeDef UltraLowPowerClock; /*!< Specifies the Ultra Low Power clock parameters */
  99. LPTIM_TriggerConfigTypeDef Trigger; /*!< Specifies the Trigger parameters */
  100. uint32_t OutputPolarity; /*!< Specifies the Output polarity.
  101. This parameter can be a value of @ref LPTIM_Output_Polarity */
  102. uint32_t UpdateMode; /*!< Specifies whether the update of the autoreload and the compare
  103. values is done immediately or after the end of current period.
  104. This parameter can be a value of @ref LPTIM_Updating_Mode */
  105. uint32_t CounterSource; /*!< Specifies whether the counter is incremented each internal event
  106. or each external event.
  107. This parameter can be a value of @ref LPTIM_Counter_Source */
  108. uint32_t Input1Source; /*!< Specifies source selected for input1 (GPIO or comparator output).
  109. This parameter can be a value of @ref LPTIM_Input1_Source */
  110. uint32_t Input2Source; /*!< Specifies source selected for input2 (GPIO or comparator output).
  111. Note: This parameter is used only for encoder feature so is used only
  112. for LPTIM1 instance.
  113. This parameter can be a value of @ref LPTIM_Input2_Source */
  114. }LPTIM_InitTypeDef;
  115. /**
  116. * @brief HAL LPTIM State structure definition
  117. */
  118. typedef enum __HAL_LPTIM_StateTypeDef
  119. {
  120. HAL_LPTIM_STATE_RESET = 0x00, /*!< Peripheral not yet initialized or disabled */
  121. HAL_LPTIM_STATE_READY = 0x01, /*!< Peripheral Initialized and ready for use */
  122. HAL_LPTIM_STATE_BUSY = 0x02, /*!< An internal process is ongoing */
  123. HAL_LPTIM_STATE_TIMEOUT = 0x03, /*!< Timeout state */
  124. HAL_LPTIM_STATE_ERROR = 0x04 /*!< Internal Process is ongoing */
  125. }HAL_LPTIM_StateTypeDef;
  126. /**
  127. * @brief LPTIM handle Structure definition
  128. */
  129. typedef struct
  130. {
  131. LPTIM_TypeDef *Instance; /*!< Register base address */
  132. LPTIM_InitTypeDef Init; /*!< LPTIM required parameters */
  133. HAL_StatusTypeDef Status; /*!< LPTIM peripheral status */
  134. HAL_LockTypeDef Lock; /*!< LPTIM locking object */
  135. __IO HAL_LPTIM_StateTypeDef State; /*!< LPTIM peripheral state */
  136. }LPTIM_HandleTypeDef;
  137. /**
  138. * @}
  139. */
  140. /* Exported constants --------------------------------------------------------*/
  141. /** @defgroup LPTIM_Exported_Constants LPTIM Exported Constants
  142. * @{
  143. */
  144. /** @defgroup LPTIM_Clock_Source LPTIM Clock Source
  145. * @{
  146. */
  147. #define LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC ((uint32_t)0x00)
  148. #define LPTIM_CLOCKSOURCE_ULPTIM LPTIM_CFGR_CKSEL
  149. /**
  150. * @}
  151. */
  152. /** @defgroup LPTIM_Clock_Prescaler LPTIM Clock Prescaler
  153. * @{
  154. */
  155. #define LPTIM_PRESCALER_DIV1 ((uint32_t)0x000000)
  156. #define LPTIM_PRESCALER_DIV2 LPTIM_CFGR_PRESC_0
  157. #define LPTIM_PRESCALER_DIV4 LPTIM_CFGR_PRESC_1
  158. #define LPTIM_PRESCALER_DIV8 ((uint32_t)(LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_1))
  159. #define LPTIM_PRESCALER_DIV16 LPTIM_CFGR_PRESC_2
  160. #define LPTIM_PRESCALER_DIV32 ((uint32_t)(LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_2))
  161. #define LPTIM_PRESCALER_DIV64 ((uint32_t)(LPTIM_CFGR_PRESC_1 | LPTIM_CFGR_PRESC_2))
  162. #define LPTIM_PRESCALER_DIV128 ((uint32_t)LPTIM_CFGR_PRESC)
  163. /**
  164. * @}
  165. */
  166. /** @defgroup LPTIM_Output_Polarity LPTIM Output Polarity
  167. * @{
  168. */
  169. #define LPTIM_OUTPUTPOLARITY_HIGH ((uint32_t)0x00000000)
  170. #define LPTIM_OUTPUTPOLARITY_LOW (LPTIM_CFGR_WAVPOL)
  171. /**
  172. * @}
  173. */
  174. /** @defgroup LPTIM_Clock_Sample_Time LPTIM Clock Sample Time
  175. * @{
  176. */
  177. #define LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION ((uint32_t)0x00000000)
  178. #define LPTIM_CLOCKSAMPLETIME_2TRANSITIONS LPTIM_CFGR_CKFLT_0
  179. #define LPTIM_CLOCKSAMPLETIME_4TRANSITIONS LPTIM_CFGR_CKFLT_1
  180. #define LPTIM_CLOCKSAMPLETIME_8TRANSITIONS LPTIM_CFGR_CKFLT
  181. /**
  182. * @}
  183. */
  184. /** @defgroup LPTIM_Clock_Polarity LPTIM Clock Polarity
  185. * @{
  186. */
  187. #define LPTIM_CLOCKPOLARITY_RISING ((uint32_t)0x00000000)
  188. #define LPTIM_CLOCKPOLARITY_FALLING LPTIM_CFGR_CKPOL_0
  189. #define LPTIM_CLOCKPOLARITY_RISING_FALLING LPTIM_CFGR_CKPOL_1
  190. /**
  191. * @}
  192. */
  193. /** @defgroup LPTIM_Trigger_Source LPTIM Trigger Source
  194. * @{
  195. */
  196. #define LPTIM_TRIGSOURCE_SOFTWARE ((uint32_t)0x0000FFFF)
  197. #define LPTIM_TRIGSOURCE_0 ((uint32_t)0x00000000)
  198. #define LPTIM_TRIGSOURCE_1 ((uint32_t)LPTIM_CFGR_TRIGSEL_0)
  199. #define LPTIM_TRIGSOURCE_2 LPTIM_CFGR_TRIGSEL_1
  200. #define LPTIM_TRIGSOURCE_3 ((uint32_t)LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_1)
  201. #define LPTIM_TRIGSOURCE_4 LPTIM_CFGR_TRIGSEL_2
  202. #define LPTIM_TRIGSOURCE_5 ((uint32_t)LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_2)
  203. #define LPTIM_TRIGSOURCE_6 ((uint32_t)LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_2)
  204. #define LPTIM_TRIGSOURCE_7 LPTIM_CFGR_TRIGSEL
  205. /**
  206. * @}
  207. */
  208. /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity
  209. * @{
  210. */
  211. #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0
  212. #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1
  213. #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN
  214. /**
  215. * @}
  216. */
  217. /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time
  218. * @{
  219. */
  220. #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION ((uint32_t)0x00000000)
  221. #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0
  222. #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1
  223. #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT
  224. /**
  225. * @}
  226. */
  227. /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode
  228. * @{
  229. */
  230. #define LPTIM_UPDATE_IMMEDIATE ((uint32_t)0x00000000)
  231. #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD
  232. /**
  233. * @}
  234. */
  235. /** @defgroup LPTIM_Counter_Source LPTIM Counter Source
  236. * @{
  237. */
  238. #define LPTIM_COUNTERSOURCE_INTERNAL ((uint32_t)0x00000000)
  239. #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE
  240. /**
  241. * @}
  242. */
  243. /** @defgroup LPTIM_Input1_Source LPTIM Input1 Source
  244. * @{
  245. */
  246. #define LPTIM_INPUT1SOURCE_GPIO ((uint32_t)0x00000000) /*!< For LPTIM1 and LPTIM2 */
  247. #define LPTIM_INPUT1SOURCE_COMP1 LPTIM_OR_OR_0 /*!< For LPTIM1 and LPTIM2 */
  248. #define LPTIM_INPUT1SOURCE_COMP2 LPTIM_OR_OR_1 /*!< For LPTIM2 */
  249. #define LPTIM_INPUT1SOURCE_COMP1_COMP2 LPTIM_OR_OR /*!< For LPTIM2 */
  250. /**
  251. * @}
  252. */
  253. /** @defgroup LPTIM_Input2_Source LPTIM Input2 Source
  254. * @{
  255. */
  256. #define LPTIM_INPUT2SOURCE_GPIO ((uint32_t)0x00000000) /*!< For LPTIM1 */
  257. #define LPTIM_INPUT2SOURCE_COMP2 LPTIM_OR_OR_1 /*!< For LPTIM1 */
  258. /**
  259. * @}
  260. */
  261. /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition
  262. * @{
  263. */
  264. #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN
  265. #define LPTIM_FLAG_UP LPTIM_ISR_UP
  266. #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK
  267. #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK
  268. #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG
  269. #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM
  270. #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM
  271. /**
  272. * @}
  273. */
  274. /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition
  275. * @{
  276. */
  277. #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE
  278. #define LPTIM_IT_UP LPTIM_IER_UPIE
  279. #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE
  280. #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE
  281. #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE
  282. #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE
  283. #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE
  284. /**
  285. * @}
  286. */
  287. /**
  288. * @}
  289. */
  290. /* Exported macros -----------------------------------------------------------*/
  291. /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros
  292. * @{
  293. */
  294. /** @brief Reset LPTIM handle state.
  295. * @param __HANDLE__: LPTIM handle
  296. * @retval None
  297. */
  298. #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET)
  299. /**
  300. * @brief Enable the LPTIM peripheral.
  301. * @param __HANDLE__: LPTIM handle
  302. * @retval None
  303. */
  304. #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))
  305. /**
  306. * @brief Disable the LPTIM peripheral.
  307. * @param __HANDLE__: LPTIM handle
  308. * @retval None
  309. */
  310. #define __HAL_LPTIM_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(LPTIM_CR_ENABLE))
  311. /**
  312. * @brief Start the LPTIM peripheral in Continuous or in single mode.
  313. * @param __HANDLE__: DMA handle
  314. * @retval None
  315. */
  316. #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)
  317. #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)
  318. /**
  319. * @brief Write the passed parameter in the Autoreload register.
  320. * @param __HANDLE__: LPTIM handle
  321. * @param __VALUE__: Autoreload value
  322. * @retval None
  323. */
  324. #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__))
  325. /**
  326. * @brief Write the passed parameter in the Compare register.
  327. * @param __HANDLE__: LPTIM handle
  328. * @param __VALUE__: Compare value
  329. * @retval None
  330. */
  331. #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__))
  332. /**
  333. * @brief Check whether the specified LPTIM flag is set or not.
  334. * @param __HANDLE__: LPTIM handle
  335. * @param __FLAG__: LPTIM flag to check
  336. * This parameter can be a value of:
  337. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  338. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  339. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  340. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  341. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  342. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  343. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  344. * @retval The state of the specified flag (SET or RESET).
  345. */
  346. #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))
  347. /**
  348. * @brief Clear the specified LPTIM flag.
  349. * @param __HANDLE__: LPTIM handle.
  350. * @param __FLAG__: LPTIM flag to clear.
  351. * This parameter can be a value of:
  352. * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
  353. * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
  354. * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  355. * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  356. * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  357. * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
  358. * @arg LPTIM_FLAG_CMPM : Compare match Flag.
  359. * @retval None
  360. */
  361. #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
  362. /**
  363. * @brief Enable the specified LPTIM interrupt.
  364. * @param __HANDLE__: LPTIM handle.
  365. * @param __INTERRUPT__: LPTIM interrupt to set.
  366. * This parameter can be a value of:
  367. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  368. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  369. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  370. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  371. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  372. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  373. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  374. * @retval None
  375. */
  376. #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
  377. /**
  378. * @brief Disable the specified LPTIM interrupt.
  379. * @param __HANDLE__: LPTIM handle.
  380. * @param __INTERRUPT__: LPTIM interrupt to set.
  381. * This parameter can be a value of:
  382. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  383. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  384. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  385. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  386. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  387. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  388. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  389. * @retval None
  390. */
  391. #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
  392. /**
  393. * @brief Check whether the specified LPTIM interrupt source is enabled or not.
  394. * @param __HANDLE__: LPTIM handle.
  395. * @param __INTERRUPT__: LPTIM interrupt to check.
  396. * This parameter can be a value of:
  397. * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
  398. * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
  399. * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  400. * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  401. * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  402. * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
  403. * @arg LPTIM_IT_CMPM : Compare match Interrupt.
  404. * @retval Interrupt status.
  405. */
  406. #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
  407. /**
  408. * @}
  409. */
  410. /* Exported functions --------------------------------------------------------*/
  411. /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
  412. * @{
  413. */
  414. /* Initialization/de-initialization functions ********************************/
  415. HAL_StatusTypeDef HAL_LPTIM_Init(LPTIM_HandleTypeDef *hlptim);
  416. HAL_StatusTypeDef HAL_LPTIM_DeInit(LPTIM_HandleTypeDef *hlptim);
  417. /* MSP functions *************************************************************/
  418. void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef *hlptim);
  419. void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef *hlptim);
  420. /* Start/Stop operation functions *********************************************/
  421. /* ################################# PWM Mode ################################*/
  422. /* Blocking mode: Polling */
  423. HAL_StatusTypeDef HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  424. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef *hlptim);
  425. /* Non-Blocking mode: Interrupt */
  426. HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  427. HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  428. /* ############################# One Pulse Mode ##############################*/
  429. /* Blocking mode: Polling */
  430. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  431. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef *hlptim);
  432. /* Non-Blocking mode: Interrupt */
  433. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  434. HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  435. /* ############################## Set once Mode ##############################*/
  436. /* Blocking mode: Polling */
  437. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  438. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef *hlptim);
  439. /* Non-Blocking mode: Interrupt */
  440. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse);
  441. HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  442. /* ############################### Encoder Mode ##############################*/
  443. /* Blocking mode: Polling */
  444. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  445. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef *hlptim);
  446. /* Non-Blocking mode: Interrupt */
  447. HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  448. HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  449. /* ############################# Time out Mode ##############################*/
  450. /* Blocking mode: Polling */
  451. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  452. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef *hlptim);
  453. /* Non-Blocking mode: Interrupt */
  454. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout);
  455. HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  456. /* ############################## Counter Mode ###############################*/
  457. /* Blocking mode: Polling */
  458. HAL_StatusTypeDef HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  459. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef *hlptim);
  460. /* Non-Blocking mode: Interrupt */
  461. HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef *hlptim, uint32_t Period);
  462. HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef *hlptim);
  463. /* Reading operation functions ************************************************/
  464. uint32_t HAL_LPTIM_ReadCounter(LPTIM_HandleTypeDef *hlptim);
  465. uint32_t HAL_LPTIM_ReadAutoReload(LPTIM_HandleTypeDef *hlptim);
  466. uint32_t HAL_LPTIM_ReadCompare(LPTIM_HandleTypeDef *hlptim);
  467. /* LPTIM IRQ functions *******************************************************/
  468. void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef *hlptim);
  469. /* CallBack functions ********************************************************/
  470. void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef *hlptim);
  471. void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef *hlptim);
  472. void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef *hlptim);
  473. void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef *hlptim);
  474. void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef *hlptim);
  475. void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef *hlptim);
  476. void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef *hlptim);
  477. /* Peripheral State functions ************************************************/
  478. HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState(LPTIM_HandleTypeDef *hlptim);
  479. /**
  480. * @}
  481. */
  482. /* Private types -------------------------------------------------------------*/
  483. /** @defgroup LPTIM_Private_Types LPTIM Private Types
  484. * @{
  485. */
  486. /**
  487. * @}
  488. */
  489. /* Private variables ---------------------------------------------------------*/
  490. /** @defgroup LPTIM_Private_Variables LPTIM Private Variables
  491. * @{
  492. */
  493. /**
  494. * @}
  495. */
  496. /* Private constants ---------------------------------------------------------*/
  497. /** @defgroup LPTIM_Private_Constants LPTIM Private Constants
  498. * @{
  499. */
  500. /**
  501. * @}
  502. */
  503. /* Private macros ------------------------------------------------------------*/
  504. /** @defgroup LPTIM_Private_Macros LPTIM Private Macros
  505. * @{
  506. */
  507. #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \
  508. ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC))
  509. #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \
  510. ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \
  511. ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \
  512. ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \
  513. ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \
  514. ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \
  515. ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \
  516. ((__PRESCALER__) == LPTIM_PRESCALER_DIV128))
  517. #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1)
  518. #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \
  519. ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH))
  520. #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \
  521. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \
  522. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \
  523. ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS))
  524. #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \
  525. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \
  526. ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING))
  527. #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \
  528. ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \
  529. ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \
  530. ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \
  531. ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \
  532. ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \
  533. ((__TRIG__) == LPTIM_TRIGSOURCE_5) || \
  534. ((__TRIG__) == LPTIM_TRIGSOURCE_6) || \
  535. ((__TRIG__) == LPTIM_TRIGSOURCE_7))
  536. #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \
  537. ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \
  538. ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING ))
  539. #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \
  540. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \
  541. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \
  542. ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS ))
  543. #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \
  544. ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD))
  545. #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \
  546. ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL))
  547. #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((__AUTORELOAD__) <= 0x0000FFFF)
  548. #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFF)
  549. #define IS_LPTIM_PERIOD(__PERIOD__) ((__PERIOD__) <= 0x0000FFFF)
  550. #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFF)
  551. #define IS_LPTIM_INPUT1_SOURCE(__INSTANCE__, __SOURCE__) \
  552. ((((__INSTANCE__) == LPTIM1) && \
  553. (((__SOURCE__) == LPTIM_INPUT1SOURCE_GPIO) || \
  554. ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP1))) \
  555. || \
  556. (((__INSTANCE__) == LPTIM2) && \
  557. (((__SOURCE__) == LPTIM_INPUT1SOURCE_GPIO) || \
  558. ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP1) || \
  559. ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP2) || \
  560. ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP1_COMP2))))
  561. #define IS_LPTIM_INPUT2_SOURCE(__INSTANCE__, __SOURCE__) \
  562. (((__INSTANCE__) == LPTIM1) && \
  563. (((__SOURCE__) == LPTIM_INPUT2SOURCE_GPIO) || \
  564. ((__SOURCE__) == LPTIM_INPUT2SOURCE_COMP2)))
  565. /**
  566. * @}
  567. */
  568. /* Private functions ---------------------------------------------------------*/
  569. /** @defgroup LPTIM_Private_Functions LPTIM Private Functions
  570. * @{
  571. */
  572. /**
  573. * @}
  574. */
  575. /**
  576. * @}
  577. */
  578. /**
  579. * @}
  580. */
  581. #ifdef __cplusplus
  582. }
  583. #endif
  584. #endif /* __STM32L4xx_HAL_LPTIM_H */
  585. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/