STM32L443xx HAL User Manual
Defines
LPTIM Exported Macros
LPTIM

Defines

#define __HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__)
 Reset LPTIM handle state.
#define __HAL_LPTIM_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))
 Enable the LPTIM peripheral.
#define __HAL_LPTIM_DISABLE(__HANDLE__)   LPTIM_Disable(__HANDLE__)
 Disable the LPTIM peripheral.
#define __HAL_LPTIM_START_CONTINUOUS(__HANDLE__)   ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)
 Start the LPTIM peripheral in Continuous mode.
#define __HAL_LPTIM_START_SINGLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)
 Start the LPTIM peripheral in single mode.
#define __HAL_LPTIM_AUTORELOAD_SET(__HANDLE__, __VALUE__)   ((__HANDLE__)->Instance->ARR = (__VALUE__))
 Write the passed parameter in the Autoreload register.
#define __HAL_LPTIM_COMPARE_SET(__HANDLE__, __VALUE__)   ((__HANDLE__)->Instance->CMP = (__VALUE__))
 Write the passed parameter in the Compare register.
#define __HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__)   (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))
 Check whether the specified LPTIM flag is set or not.
#define __HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ICR = (__FLAG__))
 Clear the specified LPTIM flag.
#define __HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))
 Enable the specified LPTIM interrupt.
#define __HAL_LPTIM_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))
 Disable the specified LPTIM interrupt.
#define __HAL_LPTIM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified LPTIM interrupt source is enabled or not.
#define __HAL_LPTIM_LPTIM1_EXTI_ENABLE_IT()   (EXTI->IMR2 |= LPTIM_EXTI_LINE_LPTIM1)
 Enable the LPTIM1 EXTI line in interrupt mode.
#define __HAL_LPTIM_LPTIM1_EXTI_DISABLE_IT()
 Disable the LPTIM1 EXTI line in interrupt mode.
#define __HAL_LPTIM_LPTIM1_EXTI_ENABLE_EVENT()   (EXTI->EMR2 |= LPTIM_EXTI_LINE_LPTIM1)
 Enable the LPTIM1 EXTI line in event mode.
#define __HAL_LPTIM_LPTIM1_EXTI_DISABLE_EVENT()
 Disable the LPTIM1 EXTI line in event mode.
#define __HAL_LPTIM_LPTIM2_EXTI_ENABLE_IT()   (EXTI->IMR2 |= LPTIM_EXTI_LINE_LPTIM2)
 Enable the LPTIM2 EXTI line in interrupt mode.
#define __HAL_LPTIM_LPTIM2_EXTI_DISABLE_IT()
 Disable the LPTIM2 EXTI line in interrupt mode.
#define __HAL_LPTIM_LPTIM2_EXTI_ENABLE_EVENT()   (EXTI->EMR2 |= LPTIM_EXTI_LINE_LPTIM2)
 Enable the LPTIM2 EXTI line in event mode.
#define __HAL_LPTIM_LPTIM2_EXTI_DISABLE_EVENT()
 Disable the LPTIM2 EXTI line in event mode.

Define Documentation

#define __HAL_LPTIM_AUTORELOAD_SET (   __HANDLE__,
  __VALUE__ 
)    ((__HANDLE__)->Instance->ARR = (__VALUE__))

Write the passed parameter in the Autoreload register.

Parameters:
__HANDLE__LPTIM handle
__VALUE__Autoreload value
Return values:
None
Note:
The ARR register can only be modified when the LPTIM instance is enabled.

Definition at line 472 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start(), HAL_LPTIM_Counter_Start_IT(), HAL_LPTIM_Encoder_Start(), HAL_LPTIM_Encoder_Start_IT(), HAL_LPTIM_OnePulse_Start(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_PWM_Start(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_SetOnce_Start(), HAL_LPTIM_SetOnce_Start_IT(), HAL_LPTIM_TimeOut_Start(), and HAL_LPTIM_TimeOut_Start_IT().

#define __HAL_LPTIM_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((__HANDLE__)->Instance->ICR = (__FLAG__))

Clear the specified LPTIM flag.

Parameters:
__HANDLE__LPTIM handle.
__FLAG__LPTIM flag to clear. This parameter can be a value of:
  • LPTIM_FLAG_REPOK : Repetition register update OK Flag (when available).
  • LPTIM_FLAG_UPDATE : Update event Flag (when available).
  • LPTIM_FLAG_DOWN : Counter direction change up Flag.
  • LPTIM_FLAG_UP : Counter direction change down to up Flag.
  • LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  • LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  • LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  • LPTIM_FLAG_ARRM : Autoreload match Flag.
  • LPTIM_FLAG_CMPM : Compare match Flag.
Return values:
None.

Definition at line 535 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start(), HAL_LPTIM_Counter_Start_IT(), HAL_LPTIM_Encoder_Start(), HAL_LPTIM_Encoder_Start_IT(), HAL_LPTIM_Init(), HAL_LPTIM_IRQHandler(), HAL_LPTIM_OnePulse_Start(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_PWM_Start(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_SetOnce_Start(), HAL_LPTIM_SetOnce_Start_IT(), HAL_LPTIM_TimeOut_Start(), HAL_LPTIM_TimeOut_Start_IT(), and LPTIM_Disable().

#define __HAL_LPTIM_COMPARE_SET (   __HANDLE__,
  __VALUE__ 
)    ((__HANDLE__)->Instance->CMP = (__VALUE__))

Write the passed parameter in the Compare register.

Parameters:
__HANDLE__LPTIM handle
__VALUE__Compare value
Return values:
None
Note:
The CMP register can only be modified when the LPTIM instance is enabled.

Definition at line 481 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_OnePulse_Start(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_PWM_Start(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_SetOnce_Start(), HAL_LPTIM_SetOnce_Start_IT(), HAL_LPTIM_TimeOut_Start(), and HAL_LPTIM_TimeOut_Start_IT().

#define __HAL_LPTIM_DISABLE (   __HANDLE__)    LPTIM_Disable(__HANDLE__)

Disable the LPTIM peripheral.

Parameters:
__HANDLE__LPTIM handle
Note:
The following sequence is required to solve LPTIM disable HW limitation. Please check Errata Sheet ES0335 for more details under "MCU may remain stuck in LPTIM interrupt when entering Stop mode" section.
Please call HAL_LPTIM_GetState() after a call to __HAL_LPTIM_DISABLE to check for TIMEOUT.
Return values:
None

Definition at line 432 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start_IT(), HAL_LPTIM_Counter_Stop(), HAL_LPTIM_Counter_Stop_IT(), HAL_LPTIM_DeInit(), HAL_LPTIM_Encoder_Start_IT(), HAL_LPTIM_Encoder_Stop(), HAL_LPTIM_Encoder_Stop_IT(), HAL_LPTIM_Init(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_OnePulse_Stop(), HAL_LPTIM_OnePulse_Stop_IT(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_PWM_Stop(), HAL_LPTIM_PWM_Stop_IT(), HAL_LPTIM_SetOnce_Start_IT(), HAL_LPTIM_SetOnce_Stop(), HAL_LPTIM_SetOnce_Stop_IT(), HAL_LPTIM_TimeOut_Start_IT(), HAL_LPTIM_TimeOut_Stop(), and HAL_LPTIM_TimeOut_Stop_IT().

#define __HAL_LPTIM_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__HANDLE__)->Instance->IER &= (~(__INTERRUPT__)))

Disable the specified LPTIM interrupt.

Parameters:
__HANDLE__LPTIM handle.
__INTERRUPT__LPTIM interrupt to set. This parameter can be a value of:
  • LPTIM_IT_REPOK : Repetition register update OK Interrupt (when available).
  • LPTIM_IT_UPDATE : Update event register Interrupt (when available).
  • LPTIM_IT_DOWN : Counter direction change up Interrupt.
  • LPTIM_IT_UP : Counter direction change down to up Interrupt.
  • LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  • LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  • LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  • LPTIM_IT_ARRM : Autoreload match Interrupt.
  • LPTIM_IT_CMPM : Compare match Interrupt.
Return values:
None.
Note:
The LPTIM interrupts can only be disabled when the LPTIM instance is disabled.

Definition at line 573 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Stop_IT(), HAL_LPTIM_Encoder_Stop_IT(), HAL_LPTIM_OnePulse_Stop_IT(), HAL_LPTIM_PWM_Stop_IT(), HAL_LPTIM_SetOnce_Stop_IT(), and HAL_LPTIM_TimeOut_Stop_IT().

#define __HAL_LPTIM_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))

Enable the LPTIM peripheral.

Parameters:
__HANDLE__LPTIM handle
Return values:
None

Definition at line 420 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start(), HAL_LPTIM_Counter_Start_IT(), HAL_LPTIM_Encoder_Start(), HAL_LPTIM_Encoder_Start_IT(), HAL_LPTIM_Init(), HAL_LPTIM_OnePulse_Start(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_PWM_Start(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_SetOnce_Start(), HAL_LPTIM_SetOnce_Start_IT(), HAL_LPTIM_TimeOut_Start(), and HAL_LPTIM_TimeOut_Start_IT().

#define __HAL_LPTIM_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__HANDLE__)->Instance->IER |= (__INTERRUPT__))

Enable the specified LPTIM interrupt.

Parameters:
__HANDLE__LPTIM handle.
__INTERRUPT__LPTIM interrupt to set. This parameter can be a value of:
  • LPTIM_IT_REPOK : Repetition register update OK Interrupt (when available).
  • LPTIM_IT_UPDATE : Update event register Interrupt (when available).
  • LPTIM_IT_DOWN : Counter direction change up Interrupt.
  • LPTIM_IT_UP : Counter direction change down to up Interrupt.
  • LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  • LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  • LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  • LPTIM_IT_ARRM : Autoreload match Interrupt.
  • LPTIM_IT_CMPM : Compare match Interrupt.
Return values:
None.
Note:
The LPTIM interrupts can only be enabled when the LPTIM instance is disabled.

Definition at line 554 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start_IT(), HAL_LPTIM_Encoder_Start_IT(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_SetOnce_Start_IT(), and HAL_LPTIM_TimeOut_Start_IT().

#define __HAL_LPTIM_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    (((__HANDLE__)->Instance->ISR &(__FLAG__)) == (__FLAG__))

Check whether the specified LPTIM flag is set or not.

Parameters:
__HANDLE__LPTIM handle
__FLAG__LPTIM flag to check This parameter can be a value of:
  • LPTIM_FLAG_REPOK : Repetition register update OK Flag (when available).
  • LPTIM_FLAG_UPDATE : Update event Flag (when available).
  • LPTIM_FLAG_DOWN : Counter direction change up Flag.
  • LPTIM_FLAG_UP : Counter direction change down to up Flag.
  • LPTIM_FLAG_ARROK : Autoreload register update OK Flag.
  • LPTIM_FLAG_CMPOK : Compare register update OK Flag.
  • LPTIM_FLAG_EXTTRIG : External trigger edge event Flag.
  • LPTIM_FLAG_ARRM : Autoreload match Flag.
  • LPTIM_FLAG_CMPM : Compare match Flag.
Return values:
Thestate of the specified flag (SET or RESET).

Definition at line 517 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_IRQHandler(), and LPTIM_WaitForFlag().

#define __HAL_LPTIM_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)
Value:
((((__HANDLE__)->Instance->IER\
                                                                & (__INTERRUPT__)) == (__INTERRUPT__)) ? SET : RESET)

Check whether the specified LPTIM interrupt source is enabled or not.

Parameters:
__HANDLE__LPTIM handle.
__INTERRUPT__LPTIM interrupt to check. This parameter can be a value of:
  • LPTIM_IT_REPOK : Repetition register update OK Interrupt (when available).
  • LPTIM_IT_UPDATE : Update event register Interrupt (when available).
  • LPTIM_IT_DOWN : Counter direction change up Interrupt.
  • LPTIM_IT_UP : Counter direction change down to up Interrupt.
  • LPTIM_IT_ARROK : Autoreload register update OK Interrupt.
  • LPTIM_IT_CMPOK : Compare register update OK Interrupt.
  • LPTIM_IT_EXTTRIG : External trigger edge event Interrupt.
  • LPTIM_IT_ARRM : Autoreload match Interrupt.
  • LPTIM_IT_CMPM : Compare match Interrupt.
Return values:
Interruptstatus.

Definition at line 592 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_IRQHandler().

#define __HAL_LPTIM_LPTIM1_EXTI_DISABLE_EVENT ( )
Value:
(EXTI->EMR2\
                                                        &= ~(LPTIM_EXTI_LINE_LPTIM1))

Disable the LPTIM1 EXTI line in event mode.

Return values:
None

Definition at line 619 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM1_EXTI_DISABLE_IT ( )
Value:
(EXTI->IMR2\
                                                        &= ~(LPTIM_EXTI_LINE_LPTIM1))

Disable the LPTIM1 EXTI line in interrupt mode.

Return values:
None

Definition at line 605 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM1_EXTI_ENABLE_EVENT ( )    (EXTI->EMR2 |= LPTIM_EXTI_LINE_LPTIM1)

Enable the LPTIM1 EXTI line in event mode.

Return values:
None

Definition at line 613 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM1_EXTI_ENABLE_IT ( )    (EXTI->IMR2 |= LPTIM_EXTI_LINE_LPTIM1)

Enable the LPTIM1 EXTI line in interrupt mode.

Return values:
None

Definition at line 599 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM2_EXTI_DISABLE_EVENT ( )
Value:
(EXTI->EMR2\
                                                        &= ~(LPTIM_EXTI_LINE_LPTIM2))

Disable the LPTIM2 EXTI line in event mode.

Return values:
None

Definition at line 646 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM2_EXTI_DISABLE_IT ( )
Value:
(EXTI->IMR2\
                                                        &= ~(LPTIM_EXTI_LINE_LPTIM2))

Disable the LPTIM2 EXTI line in interrupt mode.

Return values:
None

Definition at line 632 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM2_EXTI_ENABLE_EVENT ( )    (EXTI->EMR2 |= LPTIM_EXTI_LINE_LPTIM2)

Enable the LPTIM2 EXTI line in event mode.

Return values:
None

Definition at line 640 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_LPTIM2_EXTI_ENABLE_IT ( )    (EXTI->IMR2 |= LPTIM_EXTI_LINE_LPTIM2)

Enable the LPTIM2 EXTI line in interrupt mode.

Return values:
None

Definition at line 626 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_RESET_HANDLE_STATE (   __HANDLE__)
Value:
do {                                                        \
                                                        (__HANDLE__)->State             = HAL_LPTIM_STATE_RESET; \
                                                        (__HANDLE__)->MspInitCallback   = NULL;                  \
                                                        (__HANDLE__)->MspDeInitCallback = NULL;                  \
                                                      } while(0)

Reset LPTIM handle state.

Parameters:
__HANDLE__LPTIM handle
Return values:
None

Definition at line 406 of file stm32l4xx_hal_lptim.h.

#define __HAL_LPTIM_START_CONTINUOUS (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)

Start the LPTIM peripheral in Continuous mode.

Parameters:
__HANDLE__LPTIM handle
Return values:
None

Definition at line 439 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start(), HAL_LPTIM_Counter_Start_IT(), HAL_LPTIM_Encoder_Start(), HAL_LPTIM_Encoder_Start_IT(), HAL_LPTIM_PWM_Start(), HAL_LPTIM_PWM_Start_IT(), HAL_LPTIM_TimeOut_Start(), and HAL_LPTIM_TimeOut_Start_IT().

#define __HAL_LPTIM_START_SINGLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)

Start the LPTIM peripheral in single mode.

Parameters:
__HANDLE__LPTIM handle
Return values:
None

Definition at line 445 of file stm32l4xx_hal_lptim.h.

Referenced by HAL_LPTIM_OnePulse_Start(), HAL_LPTIM_OnePulse_Start_IT(), HAL_LPTIM_SetOnce_Start(), and HAL_LPTIM_SetOnce_Start_IT().

Generated on Fri Nov 26 2021 00:46:00 for STM32L443xx HAL User Manual by   doxygen 1.7.6.1