stm32l4xx_hal_lptim.h 30 KB

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