stm32f4xx_hal_lptim.h 33 KB

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