Collaboration diagram for LPTIM Exported Macros:

Macros
#define	__HAL_LPTIM_RESET_HANDLE_STATE(__HANDLE__)
	Reset LPTIM handle state.

#define	__HAL_LPTIM_ENABLE(__HANDLE__)
	Enable the LPTIM peripheral.

#define	__HAL_LPTIM_DISABLE(__HANDLE__)
	Disable the LPTIM peripheral.

#define	__HAL_LPTIM_START_CONTINUOUS(__HANDLE__)
	Start the LPTIM peripheral in Continuous mode.

#define	__HAL_LPTIM_START_SINGLE(__HANDLE__)
	Start the LPTIM peripheral in single mode.

#define	__HAL_LPTIM_AUTORELOAD_SET(__HANDLE__, __VALUE__)
	Write the passed parameter in the Autoreload register.

#define	__HAL_LPTIM_COMPARE_SET(__HANDLE__, __VALUE__)
	Write the passed parameter in the Compare register.

#define	__HAL_LPTIM_GET_FLAG(__HANDLE__, __FLAG__)
	Check whether the specified LPTIM flag is set or not.

#define	__HAL_LPTIM_CLEAR_FLAG(__HANDLE__, __FLAG__)
	Clear the specified LPTIM flag.

#define	__HAL_LPTIM_ENABLE_IT(__HANDLE__, __INTERRUPT__)
	Enable the specified LPTIM interrupt.

#define	__HAL_LPTIM_DISABLE_IT(__HANDLE__, __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_OPTR_CONFIG(__HANDLE__, __VALUE__)
	LPTIM Option Register.

#define	__HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT()
	Enable interrupt on the LPTIM Wake-up Timer associated Exti line.

#define	__HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT()
	Disable interrupt on the LPTIM Wake-up Timer associated Exti line.

#define	__HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT()
	Enable event on the LPTIM Wake-up Timer associated Exti line.

#define	__HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT()
	Disable event on the LPTIM Wake-up Timer associated Exti line.

Detailed Description

Macro Definition Documentation

◆ __HAL_LPTIM_RESET_HANDLE_STATE

#define __HAL_LPTIM_RESET_HANDLE_STATE ( __HANDLE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__HANDLE__)->State = HAL_LPTIM_STATE_RESET)

HAL_LPTIM_STATE_RESET

@ HAL_LPTIM_STATE_RESET

Definition stm32f4xx_hal_lptim.h:122

Reset LPTIM handle state.

Parameters

__HANDLE__ LPTIM handle

Return values

None

Definition at line 363 of file stm32f4xx_hal_lptim.h.

◆ __HAL_LPTIM_ENABLE

#define __HAL_LPTIM_ENABLE ( __HANDLE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__HANDLE__)->Instance->CR |= (LPTIM_CR_ENABLE))

Enable the LPTIM peripheral.

Parameters

__HANDLE__ LPTIM handle

Return values

None

Definition at line 371 of file stm32f4xx_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().

◆ __HAL_LPTIM_DISABLE

#define __HAL_LPTIM_DISABLE ( __HANDLE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

LPTIM_Disable(__HANDLE__)

LPTIM_Disable

void LPTIM_Disable(LPTIM_HandleTypeDef *hlptim)

Disable LPTIM HW instance.

Definition stm32f4xx_hal_lptim.c:2355

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 383 of file stm32f4xx_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_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().

◆ __HAL_LPTIM_START_CONTINUOUS

#define __HAL_LPTIM_START_CONTINUOUS ( __HANDLE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__HANDLE__)->Instance->CR |= LPTIM_CR_CNTSTRT)

Start the LPTIM peripheral in Continuous mode.

Parameters

__HANDLE__ LPTIM handle

Return values

None

Definition at line 390 of file stm32f4xx_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().

◆ __HAL_LPTIM_START_SINGLE

#define __HAL_LPTIM_START_SINGLE ( __HANDLE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__HANDLE__)->Instance->CR |= LPTIM_CR_SNGSTRT)

Start the LPTIM peripheral in single mode.

Parameters

__HANDLE__ LPTIM handle

Return values

None

Definition at line 396 of file stm32f4xx_hal_lptim.h.

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

◆ __HAL_LPTIM_AUTORELOAD_SET

#define __HAL_LPTIM_AUTORELOAD_SET	(		__HANDLE__,
			__VALUE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__HANDLE__)->Instance->ARR = (__VALUE__))

Write the passed parameter in the Autoreload register.

Parameters

__HANDLE__	LPTIM handle
__VALUE__	Autoreload value This parameter must be a value between Min_Data = 0x0001 and Max_Data = 0xFFFF.

Return values

None

Note: The ARR register can only be modified when the LPTIM instance is enabled.

Definition at line 406 of file stm32f4xx_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().

◆ __HAL_LPTIM_COMPARE_SET

#define __HAL_LPTIM_COMPARE_SET	(		__HANDLE__,
			__VALUE__ )

#include <stm32f4xx_hal_lptim.h>

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 415 of file stm32f4xx_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().

◆ __HAL_LPTIM_GET_FLAG

#define __HAL_LPTIM_GET_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_lptim.h>

Value:

(((__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_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

The	state of the specified flag (SET or RESET).

Definition at line 431 of file stm32f4xx_hal_lptim.h.

Referenced by HAL_LPTIM_IRQHandler(), and LPTIM_WaitForFlag().

◆ __HAL_LPTIM_CLEAR_FLAG

#define __HAL_LPTIM_CLEAR_FLAG	(		__HANDLE__,
			__FLAG__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__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_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 447 of file stm32f4xx_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_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().

◆ __HAL_LPTIM_ENABLE_IT

#define __HAL_LPTIM_ENABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__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_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 464 of file stm32f4xx_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().

◆ __HAL_LPTIM_DISABLE_IT

#define __HAL_LPTIM_DISABLE_IT	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__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_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 481 of file stm32f4xx_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().

◆ __HAL_LPTIM_GET_IT_SOURCE

#define __HAL_LPTIM_GET_IT_SOURCE	(		__HANDLE__,
			__INTERRUPT__ )

#include <stm32f4xx_hal_lptim.h>

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_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

Interrupt status.

Definition at line 498 of file stm32f4xx_hal_lptim.h.

Referenced by HAL_LPTIM_IRQHandler().

◆ __HAL_LPTIM_OPTR_CONFIG

#define __HAL_LPTIM_OPTR_CONFIG	(		__HANDLE__,
			__VALUE__ )

#include <stm32f4xx_hal_lptim.h>

Value:

((__HANDLE__)->Instance->OR = (__VALUE__))

LPTIM Option Register.

Parameters

__HANDLE__	LPTIM handle
__VALUE__	This parameter can be a value of : LPTIM_OP_PAD_AF LPTIM_OP_PAD_PA4 LPTIM_OP_PAD_PB9 LPTIM_OP_TIM_DAC

Return values

None

Definition at line 510 of file stm32f4xx_hal_lptim.h.

◆ __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT

#define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT ( )

#include <stm32f4xx_hal_lptim.h>

Value:

(EXTI->IMR\

|= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)

LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT

#define LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT

Definition stm32f4xx_hal_lptim.h:44

Enable interrupt on the LPTIM Wake-up Timer associated Exti line.

Return values

None

Definition at line 517 of file stm32f4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Start_IT(), and HAL_LPTIM_TimeOut_Start_IT().

◆ __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT

#define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT ( )

#include <stm32f4xx_hal_lptim.h>

Value:

(EXTI->IMR\

&= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))

Disable interrupt on the LPTIM Wake-up Timer associated Exti line.

Return values

None

Definition at line 524 of file stm32f4xx_hal_lptim.h.

Referenced by HAL_LPTIM_Counter_Stop_IT(), and HAL_LPTIM_TimeOut_Stop_IT().

◆ __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT

#define __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_EVENT ( )

#include <stm32f4xx_hal_lptim.h>

Value:

(EXTI->EMR\

|= LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT)

Enable event on the LPTIM Wake-up Timer associated Exti line.

Return values

None.

Definition at line 531 of file stm32f4xx_hal_lptim.h.

◆ __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT

#define __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_EVENT ( )

#include <stm32f4xx_hal_lptim.h>

Value:

(EXTI->EMR\

&= ~(LPTIM_EXTI_LINE_WAKEUPTIMER_EVENT))

Disable event on the LPTIM Wake-up Timer associated Exti line.

Return values

None.

Definition at line 538 of file stm32f4xx_hal_lptim.h.