stm32f7xx_hal_lptim.h 28 KB

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