stm32f4xx_hal_lptim.h 32 KB

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