2 ******************************************************************************
3 * @file stm32g4xx_hal_lptim.h
4 * @author MCD Application Team
5 * @brief Header file of LPTIM HAL module.
6 ******************************************************************************
9 * <h2><center>© Copyright (c) 2017 STMicroelectronics.
10 * All rights reserved.</center></h2>
12 * This software component is licensed by ST under BSD 3-Clause license,
13 * the "License"; You may not use this file except in compliance with the
14 * License. You may obtain a copy of the License at:
15 * opensource.org/licenses/BSD-3-Clause
16 * ******************************************************************************
19 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32G4xx_HAL_LPTIM_H
21 #define STM32G4xx_HAL_LPTIM_H
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32g4xx_hal_def.h"
30 /** @addtogroup STM32G4xx_HAL_Driver
40 /* Exported types ------------------------------------------------------------*/
41 /** @defgroup LPTIM_Exported_Types LPTIM Exported Types
44 #define LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT EXTI_IMR2_IM37 /*!< External interrupt line 37 Connected to the LPTIM EXTI Line */
47 * @brief LPTIM Clock configuration definition
51 uint32_t Source
; /*!< Selects the clock source.
52 This parameter can be a value of @ref LPTIM_Clock_Source */
54 uint32_t Prescaler
; /*!< Specifies the counter clock Prescaler.
55 This parameter can be a value of @ref LPTIM_Clock_Prescaler */
57 } LPTIM_ClockConfigTypeDef
;
60 * @brief LPTIM Clock configuration definition
64 uint32_t Polarity
; /*!< Selects the polarity of the active edge for the counter unit
65 if the ULPTIM input is selected.
66 Note: This parameter is used only when Ultra low power clock source is used.
67 Note: If the polarity is configured on 'both edges', an auxiliary clock
68 (one of the Low power oscillator) must be active.
69 This parameter can be a value of @ref LPTIM_Clock_Polarity */
71 uint32_t SampleTime
; /*!< Selects the clock sampling time to configure the clock glitch filter.
72 Note: This parameter is used only when Ultra low power clock source is used.
73 This parameter can be a value of @ref LPTIM_Clock_Sample_Time */
75 } LPTIM_ULPClockConfigTypeDef
;
78 * @brief LPTIM Trigger configuration definition
82 uint32_t Source
; /*!< Selects the Trigger source.
83 This parameter can be a value of @ref LPTIM_Trigger_Source */
85 uint32_t ActiveEdge
; /*!< Selects the Trigger active edge.
86 Note: This parameter is used only when an external trigger is used.
87 This parameter can be a value of @ref LPTIM_External_Trigger_Polarity */
89 uint32_t SampleTime
; /*!< Selects the trigger sampling time to configure the clock glitch filter.
90 Note: This parameter is used only when an external trigger is used.
91 This parameter can be a value of @ref LPTIM_Trigger_Sample_Time */
92 } LPTIM_TriggerConfigTypeDef
;
95 * @brief LPTIM Initialization Structure definition
99 LPTIM_ClockConfigTypeDef Clock
; /*!< Specifies the clock parameters */
101 LPTIM_ULPClockConfigTypeDef UltraLowPowerClock
; /*!< Specifies the Ultra Low Power clock parameters */
103 LPTIM_TriggerConfigTypeDef Trigger
; /*!< Specifies the Trigger parameters */
105 uint32_t OutputPolarity
; /*!< Specifies the Output polarity.
106 This parameter can be a value of @ref LPTIM_Output_Polarity */
108 uint32_t UpdateMode
; /*!< Specifies whether the update of the autoreload and the compare
109 values is done immediately or after the end of current period.
110 This parameter can be a value of @ref LPTIM_Updating_Mode */
112 uint32_t CounterSource
; /*!< Specifies whether the counter is incremented each internal event
113 or each external event.
114 This parameter can be a value of @ref LPTIM_Counter_Source */
116 uint32_t Input1Source
; /*!< Specifies source selected for input1 (GPIO or comparator output).
117 This parameter can be a value of @ref LPTIM_Input1_Source */
119 uint32_t Input2Source
; /*!< Specifies source selected for input2 (GPIO or comparator output).
120 Note: This parameter is used only for encoder feature so is used only
122 This parameter can be a value of @ref LPTIM_Input2_Source */
126 * @brief HAL LPTIM State structure definition
130 HAL_LPTIM_STATE_RESET
= 0x00U
, /*!< Peripheral not yet initialized or disabled */
131 HAL_LPTIM_STATE_READY
= 0x01U
, /*!< Peripheral Initialized and ready for use */
132 HAL_LPTIM_STATE_BUSY
= 0x02U
, /*!< An internal process is ongoing */
133 HAL_LPTIM_STATE_TIMEOUT
= 0x03U
, /*!< Timeout state */
134 HAL_LPTIM_STATE_ERROR
= 0x04U
/*!< Internal Process is ongoing */
135 } HAL_LPTIM_StateTypeDef
;
138 * @brief LPTIM handle Structure definition
140 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
141 typedef struct __LPTIM_HandleTypeDef
144 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
146 LPTIM_TypeDef
*Instance
; /*!< Register base address */
148 LPTIM_InitTypeDef Init
; /*!< LPTIM required parameters */
150 HAL_StatusTypeDef Status
; /*!< LPTIM peripheral status */
152 HAL_LockTypeDef Lock
; /*!< LPTIM locking object */
154 __IO HAL_LPTIM_StateTypeDef State
; /*!< LPTIM peripheral state */
156 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
157 void (* MspInitCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< LPTIM Base Msp Init Callback */
158 void (* MspDeInitCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< LPTIM Base Msp DeInit Callback */
159 void (* CompareMatchCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< Compare match Callback */
160 void (* AutoReloadMatchCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< Auto-reload match Callback */
161 void (* TriggerCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< External trigger event detection Callback */
162 void (* CompareWriteCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< Compare register write complete Callback */
163 void (* AutoReloadWriteCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< Auto-reload register write complete Callback */
164 void (* DirectionUpCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< Up-counting direction change Callback */
165 void (* DirectionDownCallback
)(struct __LPTIM_HandleTypeDef
*hlptim
); /*!< Down-counting direction change Callback */
166 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
167 } LPTIM_HandleTypeDef
;
169 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
171 * @brief HAL LPTIM Callback ID enumeration definition
175 HAL_LPTIM_MSPINIT_CB_ID
= 0x00U
, /*!< LPTIM Base Msp Init Callback ID */
176 HAL_LPTIM_MSPDEINIT_CB_ID
= 0x01U
, /*!< LPTIM Base Msp DeInit Callback ID */
177 HAL_LPTIM_COMPARE_MATCH_CB_ID
= 0x02U
, /*!< Compare match Callback ID */
178 HAL_LPTIM_AUTORELOAD_MATCH_CB_ID
= 0x03U
, /*!< Auto-reload match Callback ID */
179 HAL_LPTIM_TRIGGER_CB_ID
= 0x04U
, /*!< External trigger event detection Callback ID */
180 HAL_LPTIM_COMPARE_WRITE_CB_ID
= 0x05U
, /*!< Compare register write complete Callback ID */
181 HAL_LPTIM_AUTORELOAD_WRITE_CB_ID
= 0x06U
, /*!< Auto-reload register write complete Callback ID */
182 HAL_LPTIM_DIRECTION_UP_CB_ID
= 0x07U
, /*!< Up-counting direction change Callback ID */
183 HAL_LPTIM_DIRECTION_DOWN_CB_ID
= 0x08U
, /*!< Down-counting direction change Callback ID */
184 } HAL_LPTIM_CallbackIDTypeDef
;
187 * @brief HAL TIM Callback pointer definition
189 typedef void (*pLPTIM_CallbackTypeDef
)(LPTIM_HandleTypeDef
*hlptim
); /*!< pointer to the LPTIM callback function */
191 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
196 /* Exported constants --------------------------------------------------------*/
197 /** @defgroup LPTIM_Exported_Constants LPTIM Exported Constants
201 /** @defgroup LPTIM_Clock_Source LPTIM Clock Source
204 #define LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC 0x00000000U
205 #define LPTIM_CLOCKSOURCE_ULPTIM LPTIM_CFGR_CKSEL
210 /** @defgroup LPTIM_Clock_Prescaler LPTIM Clock Prescaler
213 #define LPTIM_PRESCALER_DIV1 0x00000000U
214 #define LPTIM_PRESCALER_DIV2 LPTIM_CFGR_PRESC_0
215 #define LPTIM_PRESCALER_DIV4 LPTIM_CFGR_PRESC_1
216 #define LPTIM_PRESCALER_DIV8 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_1)
217 #define LPTIM_PRESCALER_DIV16 LPTIM_CFGR_PRESC_2
218 #define LPTIM_PRESCALER_DIV32 (LPTIM_CFGR_PRESC_0 | LPTIM_CFGR_PRESC_2)
219 #define LPTIM_PRESCALER_DIV64 (LPTIM_CFGR_PRESC_1 | LPTIM_CFGR_PRESC_2)
220 #define LPTIM_PRESCALER_DIV128 LPTIM_CFGR_PRESC
225 /** @defgroup LPTIM_Output_Polarity LPTIM Output Polarity
229 #define LPTIM_OUTPUTPOLARITY_HIGH 0x00000000U
230 #define LPTIM_OUTPUTPOLARITY_LOW LPTIM_CFGR_WAVPOL
235 /** @defgroup LPTIM_Clock_Sample_Time LPTIM Clock Sample Time
238 #define LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION 0x00000000U
239 #define LPTIM_CLOCKSAMPLETIME_2TRANSITIONS LPTIM_CFGR_CKFLT_0
240 #define LPTIM_CLOCKSAMPLETIME_4TRANSITIONS LPTIM_CFGR_CKFLT_1
241 #define LPTIM_CLOCKSAMPLETIME_8TRANSITIONS LPTIM_CFGR_CKFLT
246 /** @defgroup LPTIM_Clock_Polarity LPTIM Clock Polarity
249 #define LPTIM_CLOCKPOLARITY_RISING 0x00000000U
250 #define LPTIM_CLOCKPOLARITY_FALLING LPTIM_CFGR_CKPOL_0
251 #define LPTIM_CLOCKPOLARITY_RISING_FALLING LPTIM_CFGR_CKPOL_1
256 /** @defgroup LPTIM_Trigger_Source LPTIM Trigger Source
259 #define LPTIM_TRIGSOURCE_SOFTWARE 0x0000FFFFU
260 #define LPTIM_TRIGSOURCE_0 0x00000000U
261 #define LPTIM_TRIGSOURCE_1 LPTIM_CFGR_TRIGSEL_0
262 #define LPTIM_TRIGSOURCE_2 LPTIM_CFGR_TRIGSEL_1
263 #define LPTIM_TRIGSOURCE_3 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_1)
264 #define LPTIM_TRIGSOURCE_4 LPTIM_CFGR_TRIGSEL_2
265 #define LPTIM_TRIGSOURCE_5 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_2)
266 #define LPTIM_TRIGSOURCE_6 (LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_2)
267 #define LPTIM_TRIGSOURCE_7 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_2)
268 #define LPTIM_TRIGSOURCE_8 LPTIM_CFGR_TRIGSEL_3
269 #define LPTIM_TRIGSOURCE_9 (LPTIM_CFGR_TRIGSEL_0 | LPTIM_CFGR_TRIGSEL_3)
270 #define LPTIM_TRIGSOURCE_10 (LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_3)
271 #define LPTIM_TRIGSOURCE_11 (LPTIM_CFGR_TRIGSEL_0 |LPTIM_CFGR_TRIGSEL_1 | LPTIM_CFGR_TRIGSEL_3)
272 #define LPTIM_TRIGSOURCE_12 (LPTIM_CFGR_TRIGSEL_2 | LPTIM_CFGR_TRIGSEL_3)
277 /** @defgroup LPTIM_External_Trigger_Polarity LPTIM External Trigger Polarity
280 #define LPTIM_ACTIVEEDGE_RISING LPTIM_CFGR_TRIGEN_0
281 #define LPTIM_ACTIVEEDGE_FALLING LPTIM_CFGR_TRIGEN_1
282 #define LPTIM_ACTIVEEDGE_RISING_FALLING LPTIM_CFGR_TRIGEN
287 /** @defgroup LPTIM_Trigger_Sample_Time LPTIM Trigger Sample Time
290 #define LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION 0x00000000U
291 #define LPTIM_TRIGSAMPLETIME_2TRANSITIONS LPTIM_CFGR_TRGFLT_0
292 #define LPTIM_TRIGSAMPLETIME_4TRANSITIONS LPTIM_CFGR_TRGFLT_1
293 #define LPTIM_TRIGSAMPLETIME_8TRANSITIONS LPTIM_CFGR_TRGFLT
298 /** @defgroup LPTIM_Updating_Mode LPTIM Updating Mode
302 #define LPTIM_UPDATE_IMMEDIATE 0x00000000U
303 #define LPTIM_UPDATE_ENDOFPERIOD LPTIM_CFGR_PRELOAD
308 /** @defgroup LPTIM_Counter_Source LPTIM Counter Source
312 #define LPTIM_COUNTERSOURCE_INTERNAL 0x00000000U
313 #define LPTIM_COUNTERSOURCE_EXTERNAL LPTIM_CFGR_COUNTMODE
318 /** @defgroup LPTIM_Input1_Source LPTIM Input1 Source
322 #define LPTIM_INPUT1SOURCE_GPIO 0x00000000U
323 #define LPTIM_INPUT1SOURCE_COMP1 LPTIM_OR_IN1_0
324 #define LPTIM_INPUT1SOURCE_COMP3 (LPTIM_OR_IN1_1 | LPTIM_OR_IN1_0)
326 #define LPTIM_INPUT1SOURCE_COMP5 (LPTIM_OR_IN1_2 | LPTIM_OR_IN1_0)
329 #define LPTIM_INPUT1SOURCE_COMP7 (LPTIM_OR_IN1_2 | LPTIM_OR_IN1_1 | LPTIM_OR_IN1_0)
335 /** @defgroup LPTIM_Input2_Source LPTIM Input2 Source
339 #define LPTIM_INPUT2SOURCE_GPIO 0x00000000U
340 #define LPTIM_INPUT2SOURCE_COMP2 LPTIM_OR_IN2_0
341 #define LPTIM_INPUT2SOURCE_COMP4 (LPTIM_OR_IN2_1 | LPTIM_OR_IN2_0)
343 #define LPTIM_INPUT2SOURCE_COMP6 (LPTIM_OR_IN2_2 | LPTIM_OR_IN2_0)
349 /** @defgroup LPTIM_Flag_Definition LPTIM Flags Definition
353 #define LPTIM_FLAG_DOWN LPTIM_ISR_DOWN
354 #define LPTIM_FLAG_UP LPTIM_ISR_UP
355 #define LPTIM_FLAG_ARROK LPTIM_ISR_ARROK
356 #define LPTIM_FLAG_CMPOK LPTIM_ISR_CMPOK
357 #define LPTIM_FLAG_EXTTRIG LPTIM_ISR_EXTTRIG
358 #define LPTIM_FLAG_ARRM LPTIM_ISR_ARRM
359 #define LPTIM_FLAG_CMPM LPTIM_ISR_CMPM
364 /** @defgroup LPTIM_Interrupts_Definition LPTIM Interrupts Definition
367 #define LPTIM_IT_DOWN LPTIM_IER_DOWNIE
368 #define LPTIM_IT_UP LPTIM_IER_UPIE
369 #define LPTIM_IT_ARROK LPTIM_IER_ARROKIE
370 #define LPTIM_IT_CMPOK LPTIM_IER_CMPOKIE
371 #define LPTIM_IT_EXTTRIG LPTIM_IER_EXTTRIGIE
372 #define LPTIM_IT_ARRM LPTIM_IER_ARRMIE
373 #define LPTIM_IT_CMPM LPTIM_IER_CMPMIE
382 /* Exported macros -----------------------------------------------------------*/
383 /** @defgroup LPTIM_Exported_Macros LPTIM Exported Macros
387 /** @brief Reset LPTIM handle state.
388 * @param __HANDLE__ LPTIM handle
391 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
392 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) do { \
393 (__HANDLE__)->State = HAL_LPTIM_STATE_RESET; \
394 (__HANDLE__)->MspInitCallback = NULL; \
395 (__HANDLE__)->MspDeInitCallback = NULL; \
398 #define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_LPTIM_STATE_RESET)
399 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
402 * @brief Enable the LPTIM peripheral.
403 * @param __HANDLE__ LPTIM handle
406 #define __HAL_LPTIM_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))
409 * @brief Disable the LPTIM peripheral.
410 * @param __HANDLE__ LPTIM handle
411 * @note The following sequence is required to solve LPTIM disable HW limitation.
412 * Please check Errata Sheet ES0335 for more details under "MCU may remain
413 * stuck in LPTIM interrupt when entering Stop mode" section.
416 #define __HAL_LPTIM_DISABLE(__HANDLE__) LPTIM_Disable(__HANDLE__)
419 * @brief Start the LPTIM peripheral in Continuous mode.
420 * @param __HANDLE__ LPTIM handle
423 #define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)
425 * @brief Start the LPTIM peripheral in single mode.
426 * @param __HANDLE__ LPTIM handle
429 #define __HAL_LPTIM_START_SINGLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)
432 * @brief Reset the LPTIM Counter register in synchronous mode.
433 * @param __HANDLE__ LPTIM handle
436 #define __HAL_LPTIM_RESET_COUNTER(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_COUNTRST)
439 * @brief Reset after read of the LPTIM Counter register in asynchronous mode.
440 * @param __HANDLE__ LPTIM handle
443 #define __HAL_LPTIM_RESET_COUNTER_AFTERREAD(__HANDLE__) ((__HANDLE__)->Instance->CR |= LPTIM_CR_RSTARE)
446 * @brief Write the passed parameter in the Autoreload register.
447 * @param __HANDLE__ LPTIM handle
448 * @param __VALUE__ Autoreload value
451 #define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->ARR = (__VALUE__))
454 * @brief Write the passed parameter in the Compare register.
455 * @param __HANDLE__ LPTIM handle
456 * @param __VALUE__ Compare value
459 #define __HAL_LPTIM_COMPARE_SET(__HANDLE__ , __VALUE__) ((__HANDLE__)->Instance->CMP = (__VALUE__))
462 * @brief Check whether the specified LPTIM flag is set or not.
463 * @param __HANDLE__ LPTIM handle
464 * @param __FLAG__ LPTIM flag to check
465 * This parameter can be a value of:
466 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
467 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
468 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
469 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
470 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
471 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
472 * @arg LPTIM_FLAG_CMPM : Compare match Flag.
473 * @retval The state of the specified flag (SET or RESET).
475 #define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__) (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))
478 * @brief Clear the specified LPTIM flag.
479 * @param __HANDLE__ LPTIM handle.
480 * @param __FLAG__ LPTIM flag to clear.
481 * This parameter can be a value of:
482 * @arg LPTIM_FLAG_DOWN : Counter direction change up Flag.
483 * @arg LPTIM_FLAG_UP : Counter direction change down to up Flag.
484 * @arg LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
485 * @arg LPTIM_FLAG_CMPOK : Compare register update OK Flag.
486 * @arg LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
487 * @arg LPTIM_FLAG_ARRM : Autoreload match Flag.
488 * @arg LPTIM_FLAG_CMPM : Compare match Flag.
491 #define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ICR = (__FLAG__))
494 * @brief Enable the specified LPTIM interrupt.
495 * @param __HANDLE__ LPTIM handle.
496 * @param __INTERRUPT__ LPTIM interrupt to set.
497 * This parameter can be a value of:
498 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
499 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
500 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
501 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
502 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
503 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
504 * @arg LPTIM_IT_CMPM : Compare match Interrupt.
507 #define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
510 * @brief Disable the specified LPTIM interrupt.
511 * @param __HANDLE__ LPTIM handle.
512 * @param __INTERRUPT__ LPTIM interrupt to set.
513 * This parameter can be a value of:
514 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
515 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
516 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
517 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
518 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
519 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
520 * @arg LPTIM_IT_CMPM : Compare match Interrupt.
523 #define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
526 * @brief Check whether the specified LPTIM interrupt source is enabled or not.
527 * @param __HANDLE__ LPTIM handle.
528 * @param __INTERRUPT__ LPTIM interrupt to check.
529 * This parameter can be a value of:
530 * @arg LPTIM_IT_DOWN : Counter direction change up Interrupt.
531 * @arg LPTIM_IT_UP : Counter direction change down to up Interrupt.
532 * @arg LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
533 * @arg LPTIM_IT_CMPOK : Compare register update OK Interrupt.
534 * @arg LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
535 * @arg LPTIM_IT_ARRM : Autoreload match Interrupt.
536 * @arg LPTIM_IT_CMPM : Compare match Interrupt.
537 * @retval Interrupt status.
540 #define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) ((((__HANDLE__)->Instance->IER & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)
543 * @brief Enable interrupt on the LPTIM Wake-up Timer associated Exti line.
546 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT() (EXTI->IMR2 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
549 * @brief Disable interrupt on the LPTIM Wake-up Timer associated Exti line.
552 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT() (EXTI->IMR2 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
555 * @brief Enable event on the LPTIM Wake-up Timer associated Exti line.
558 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT() (EXTI->EMR2 |= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)
561 * @brief Disable event on the LPTIM Wake-up Timer associated Exti line.
564 #define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT() (EXTI->EMR2 &= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))
570 /* Exported functions --------------------------------------------------------*/
571 /** @defgroup LPTIM_Exported_Functions LPTIM Exported Functions
575 /* Initialization/de-initialization functions ********************************/
576 HAL_StatusTypeDef
HAL_LPTIM_Init(LPTIM_HandleTypeDef
*hlptim
);
577 HAL_StatusTypeDef
HAL_LPTIM_DeInit(LPTIM_HandleTypeDef
*hlptim
);
579 /* MSP functions *************************************************************/
580 void HAL_LPTIM_MspInit(LPTIM_HandleTypeDef
*hlptim
);
581 void HAL_LPTIM_MspDeInit(LPTIM_HandleTypeDef
*hlptim
);
583 /* Start/Stop operation functions *********************************************/
584 /* ################################# PWM Mode ################################*/
585 /* Blocking mode: Polling */
586 HAL_StatusTypeDef
HAL_LPTIM_PWM_Start(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Pulse
);
587 HAL_StatusTypeDef
HAL_LPTIM_PWM_Stop(LPTIM_HandleTypeDef
*hlptim
);
588 /* Non-Blocking mode: Interrupt */
589 HAL_StatusTypeDef
HAL_LPTIM_PWM_Start_IT(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Pulse
);
590 HAL_StatusTypeDef
HAL_LPTIM_PWM_Stop_IT(LPTIM_HandleTypeDef
*hlptim
);
592 /* ############################# One Pulse Mode ##############################*/
593 /* Blocking mode: Polling */
594 HAL_StatusTypeDef
HAL_LPTIM_OnePulse_Start(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Pulse
);
595 HAL_StatusTypeDef
HAL_LPTIM_OnePulse_Stop(LPTIM_HandleTypeDef
*hlptim
);
596 /* Non-Blocking mode: Interrupt */
597 HAL_StatusTypeDef
HAL_LPTIM_OnePulse_Start_IT(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Pulse
);
598 HAL_StatusTypeDef
HAL_LPTIM_OnePulse_Stop_IT(LPTIM_HandleTypeDef
*hlptim
);
600 /* ############################## Set once Mode ##############################*/
601 /* Blocking mode: Polling */
602 HAL_StatusTypeDef
HAL_LPTIM_SetOnce_Start(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Pulse
);
603 HAL_StatusTypeDef
HAL_LPTIM_SetOnce_Stop(LPTIM_HandleTypeDef
*hlptim
);
604 /* Non-Blocking mode: Interrupt */
605 HAL_StatusTypeDef
HAL_LPTIM_SetOnce_Start_IT(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Pulse
);
606 HAL_StatusTypeDef
HAL_LPTIM_SetOnce_Stop_IT(LPTIM_HandleTypeDef
*hlptim
);
608 /* ############################### Encoder Mode ##############################*/
609 /* Blocking mode: Polling */
610 HAL_StatusTypeDef
HAL_LPTIM_Encoder_Start(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
);
611 HAL_StatusTypeDef
HAL_LPTIM_Encoder_Stop(LPTIM_HandleTypeDef
*hlptim
);
612 /* Non-Blocking mode: Interrupt */
613 HAL_StatusTypeDef
HAL_LPTIM_Encoder_Start_IT(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
);
614 HAL_StatusTypeDef
HAL_LPTIM_Encoder_Stop_IT(LPTIM_HandleTypeDef
*hlptim
);
616 /* ############################# Time out Mode ##############################*/
617 /* Blocking mode: Polling */
618 HAL_StatusTypeDef
HAL_LPTIM_TimeOut_Start(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Timeout
);
619 HAL_StatusTypeDef
HAL_LPTIM_TimeOut_Stop(LPTIM_HandleTypeDef
*hlptim
);
620 /* Non-Blocking mode: Interrupt */
621 HAL_StatusTypeDef
HAL_LPTIM_TimeOut_Start_IT(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
, uint32_t Timeout
);
622 HAL_StatusTypeDef
HAL_LPTIM_TimeOut_Stop_IT(LPTIM_HandleTypeDef
*hlptim
);
624 /* ############################## Counter Mode ###############################*/
625 /* Blocking mode: Polling */
626 HAL_StatusTypeDef
HAL_LPTIM_Counter_Start(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
);
627 HAL_StatusTypeDef
HAL_LPTIM_Counter_Stop(LPTIM_HandleTypeDef
*hlptim
);
628 /* Non-Blocking mode: Interrupt */
629 HAL_StatusTypeDef
HAL_LPTIM_Counter_Start_IT(LPTIM_HandleTypeDef
*hlptim
, uint32_t Period
);
630 HAL_StatusTypeDef
HAL_LPTIM_Counter_Stop_IT(LPTIM_HandleTypeDef
*hlptim
);
632 /* Reading operation functions ************************************************/
633 uint32_t HAL_LPTIM_ReadCounter(LPTIM_HandleTypeDef
*hlptim
);
634 uint32_t HAL_LPTIM_ReadAutoReload(LPTIM_HandleTypeDef
*hlptim
);
635 uint32_t HAL_LPTIM_ReadCompare(LPTIM_HandleTypeDef
*hlptim
);
637 /* LPTIM IRQ functions *******************************************************/
638 void HAL_LPTIM_IRQHandler(LPTIM_HandleTypeDef
*hlptim
);
640 /* CallBack functions ********************************************************/
641 void HAL_LPTIM_CompareMatchCallback(LPTIM_HandleTypeDef
*hlptim
);
642 void HAL_LPTIM_AutoReloadMatchCallback(LPTIM_HandleTypeDef
*hlptim
);
643 void HAL_LPTIM_TriggerCallback(LPTIM_HandleTypeDef
*hlptim
);
644 void HAL_LPTIM_CompareWriteCallback(LPTIM_HandleTypeDef
*hlptim
);
645 void HAL_LPTIM_AutoReloadWriteCallback(LPTIM_HandleTypeDef
*hlptim
);
646 void HAL_LPTIM_DirectionUpCallback(LPTIM_HandleTypeDef
*hlptim
);
647 void HAL_LPTIM_DirectionDownCallback(LPTIM_HandleTypeDef
*hlptim
);
649 /* Callbacks Register/UnRegister functions ***********************************/
650 #if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
651 HAL_StatusTypeDef
HAL_LPTIM_RegisterCallback(LPTIM_HandleTypeDef
*lphtim
, HAL_LPTIM_CallbackIDTypeDef CallbackID
, pLPTIM_CallbackTypeDef pCallback
);
652 HAL_StatusTypeDef
HAL_LPTIM_UnRegisterCallback(LPTIM_HandleTypeDef
*lphtim
, HAL_LPTIM_CallbackIDTypeDef CallbackID
);
653 #endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
655 /* Peripheral State functions ************************************************/
656 HAL_LPTIM_StateTypeDef
HAL_LPTIM_GetState(LPTIM_HandleTypeDef
*hlptim
);
662 /* Private types -------------------------------------------------------------*/
663 /** @defgroup LPTIM_Private_Types LPTIM Private Types
671 /* Private variables ---------------------------------------------------------*/
672 /** @defgroup LPTIM_Private_Variables LPTIM Private Variables
680 /* Private constants ---------------------------------------------------------*/
681 /** @defgroup LPTIM_Private_Constants LPTIM Private Constants
689 /* Private macros ------------------------------------------------------------*/
690 /** @defgroup LPTIM_Private_Macros LPTIM Private Macros
694 #define IS_LPTIM_CLOCK_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_CLOCKSOURCE_ULPTIM) || \
695 ((__SOURCE__) == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC))
698 #define IS_LPTIM_CLOCK_PRESCALER(__PRESCALER__) (((__PRESCALER__) == LPTIM_PRESCALER_DIV1 ) || \
699 ((__PRESCALER__) == LPTIM_PRESCALER_DIV2 ) || \
700 ((__PRESCALER__) == LPTIM_PRESCALER_DIV4 ) || \
701 ((__PRESCALER__) == LPTIM_PRESCALER_DIV8 ) || \
702 ((__PRESCALER__) == LPTIM_PRESCALER_DIV16 ) || \
703 ((__PRESCALER__) == LPTIM_PRESCALER_DIV32 ) || \
704 ((__PRESCALER__) == LPTIM_PRESCALER_DIV64 ) || \
705 ((__PRESCALER__) == LPTIM_PRESCALER_DIV128))
707 #define IS_LPTIM_CLOCK_PRESCALERDIV1(__PRESCALER__) ((__PRESCALER__) == LPTIM_PRESCALER_DIV1)
709 #define IS_LPTIM_OUTPUT_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_OUTPUTPOLARITY_LOW ) || \
710 ((__POLARITY__) == LPTIM_OUTPUTPOLARITY_HIGH))
712 #define IS_LPTIM_CLOCK_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_DIRECTTRANSITION) || \
713 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_2TRANSITIONS) || \
714 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_4TRANSITIONS) || \
715 ((__SAMPLETIME__) == LPTIM_CLOCKSAMPLETIME_8TRANSITIONS))
717 #define IS_LPTIM_CLOCK_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING) || \
718 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_FALLING) || \
719 ((__POLARITY__) == LPTIM_CLOCKPOLARITY_RISING_FALLING))
721 #if defined(STM32G473xx) || defined(STM32G474xx) || defined(STM32G484xx)
722 #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \
723 ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \
724 ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \
725 ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \
726 ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \
727 ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \
728 ((__TRIG__) == LPTIM_TRIGSOURCE_5) || \
729 ((__TRIG__) == LPTIM_TRIGSOURCE_6) || \
730 ((__TRIG__) == LPTIM_TRIGSOURCE_7) || \
731 ((__TRIG__) == LPTIM_TRIGSOURCE_8) || \
732 ((__TRIG__) == LPTIM_TRIGSOURCE_9) || \
733 ((__TRIG__) == LPTIM_TRIGSOURCE_10)|| \
734 ((__TRIG__) == LPTIM_TRIGSOURCE_11)|| \
735 ((__TRIG__) == LPTIM_TRIGSOURCE_12))
737 #define IS_LPTIM_TRG_SOURCE(__TRIG__) (((__TRIG__) == LPTIM_TRIGSOURCE_SOFTWARE) || \
738 ((__TRIG__) == LPTIM_TRIGSOURCE_0) || \
739 ((__TRIG__) == LPTIM_TRIGSOURCE_1) || \
740 ((__TRIG__) == LPTIM_TRIGSOURCE_2) || \
741 ((__TRIG__) == LPTIM_TRIGSOURCE_3) || \
742 ((__TRIG__) == LPTIM_TRIGSOURCE_4) || \
743 ((__TRIG__) == LPTIM_TRIGSOURCE_5) || \
744 ((__TRIG__) == LPTIM_TRIGSOURCE_6) || \
745 ((__TRIG__) == LPTIM_TRIGSOURCE_7) || \
746 ((__TRIG__) == LPTIM_TRIGSOURCE_8) || \
747 ((__TRIG__) == LPTIM_TRIGSOURCE_9))
748 #endif /* STM32G473xx || STM32G474xx || STM32G484xx */
750 #define IS_LPTIM_EXT_TRG_POLARITY(__POLARITY__) (((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING ) || \
751 ((__POLARITY__) == LPTIM_ACTIVEEDGE_FALLING ) || \
752 ((__POLARITY__) == LPTIM_ACTIVEEDGE_RISING_FALLING ))
754 #define IS_LPTIM_TRIG_SAMPLE_TIME(__SAMPLETIME__) (((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_DIRECTTRANSITION) || \
755 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_2TRANSITIONS ) || \
756 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_4TRANSITIONS ) || \
757 ((__SAMPLETIME__) == LPTIM_TRIGSAMPLETIME_8TRANSITIONS ))
759 #define IS_LPTIM_UPDATE_MODE(__MODE__) (((__MODE__) == LPTIM_UPDATE_IMMEDIATE) || \
760 ((__MODE__) == LPTIM_UPDATE_ENDOFPERIOD))
762 #define IS_LPTIM_COUNTER_SOURCE(__SOURCE__) (((__SOURCE__) == LPTIM_COUNTERSOURCE_INTERNAL) || \
763 ((__SOURCE__) == LPTIM_COUNTERSOURCE_EXTERNAL))
765 #define IS_LPTIM_AUTORELOAD(__AUTORELOAD__) ((__AUTORELOAD__) <= 0x0000FFFFUL)
767 #define IS_LPTIM_COMPARE(__COMPARE__) ((__COMPARE__) <= 0x0000FFFFUL)
769 #define IS_LPTIM_PERIOD(__PERIOD__) ((__PERIOD__) <= 0x0000FFFFUL)
771 #define IS_LPTIM_PULSE(__PULSE__) ((__PULSE__) <= 0x0000FFFFUL)
773 #if defined(COMP5) && defined(COMP6) && defined(COMP7)
774 #define IS_LPTIM_INPUT1_SOURCE(__INSTANCE__, __SOURCE__) \
775 ((((__INSTANCE__) == LPTIM1) && \
776 (((__SOURCE__) == LPTIM_INPUT1SOURCE_GPIO) || \
777 ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP1) || \
778 ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP3) || \
779 ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP5) || \
780 ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP7))))
782 #define IS_LPTIM_INPUT2_SOURCE(__INSTANCE__, __SOURCE__) \
783 (((__INSTANCE__) == LPTIM1) && \
784 (((__SOURCE__) == LPTIM_INPUT2SOURCE_GPIO) || \
785 ((__SOURCE__) == LPTIM_INPUT2SOURCE_COMP2) || \
786 ((__SOURCE__) == LPTIM_INPUT2SOURCE_COMP4) || \
787 ((__SOURCE__) == LPTIM_INPUT2SOURCE_COMP6)))
789 #define IS_LPTIM_INPUT1_SOURCE(__INSTANCE__, __SOURCE__) \
790 ((((__INSTANCE__) == LPTIM1) && \
791 (((__SOURCE__) == LPTIM_INPUT1SOURCE_GPIO) || \
792 ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP1) || \
793 ((__SOURCE__) == LPTIM_INPUT1SOURCE_COMP3))))
795 #define IS_LPTIM_INPUT2_SOURCE(__INSTANCE__, __SOURCE__) \
796 (((__INSTANCE__) == LPTIM1) && \
797 (((__SOURCE__) == LPTIM_INPUT2SOURCE_GPIO) || \
798 ((__SOURCE__) == LPTIM_INPUT2SOURCE_COMP2) || \
799 ((__SOURCE__) == LPTIM_INPUT2SOURCE_COMP4)))
800 #endif /* COMP5 && COMP6 && COMP7 */
806 /* Private functions ---------------------------------------------------------*/
807 /** @defgroup LPTIM_Private_Functions LPTIM Private Functions
810 void LPTIM_Disable(LPTIM_HandleTypeDef
*lptim
);
828 #endif /* STM32G4xx_HAL_LPTIM_H */
830 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/