LPTIM Exported Functions

Functions
void	HAL_LPTIM_InitDefault (LPTIM_HandleTypeDef *hlptim)
	Set default setting for the LPTIM. More...
HAL_StatusTypeDef	HAL_LPTIM_Init (LPTIM_HandleTypeDef *hlptim)
	Initializes the LPTIM according to the specified parameters in the LPTIM_InitTypeDef and creates the associated handle. More...
HAL_StatusTypeDef	HAL_LPTIM_DeInit (LPTIM_HandleTypeDef *hlptim)
	DeInitializes the LPTIM peripheral. More...
void	HAL_LPTIM_MspInit (LPTIM_HandleTypeDef *hlptim)
	Initializes the LPTIM MSP. More...
void	HAL_LPTIM_MspDeInit (LPTIM_HandleTypeDef *hlptim)
	DeInitializes LPTIM MSP. More...
HAL_StatusTypeDef	HAL_LPTIM_PWM_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse, uint32_t psc_reg)
	Starts the LPTIM PWM generation. More...
HAL_StatusTypeDef	HAL_LPTIM_PWM_Stop (LPTIM_HandleTypeDef *hlptim)
	Stops the LPTIM PWM generation. More...
HAL_StatusTypeDef	HAL_LPTIM_PWM_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Starts the LPTIM PWM generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_PWM_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stops the LPTIM PWM generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Starts the LPTIM One pulse generation. More...
HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Stop (LPTIM_HandleTypeDef *hlptim)
	Stops the LPTIM One pulse generation. More...
HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Starts the LPTIM One pulse generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stops the LPTIM One pulse generation in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Starts the LPTIM in Set once mode. More...
HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Stop (LPTIM_HandleTypeDef *hlptim)
	Stops the LPTIM Set once mode. More...
HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Starts the LPTIM Set once mode in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stops the LPTIM Set once mode in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
	Starts the Timeout function. The first trigger event will start the timer, any successive trigger event will reset the counter and the timer restarts. More...
HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Stop (LPTIM_HandleTypeDef *hlptim)
	Stops the Timeout function. More...
HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
	Starts the Timeout function in interrupt mode. The first trigger event will start the timer, any successive trigger event will reset the counter and the timer restarts. More...
HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stops the Timeout function in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_Counter_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
	Starts the Counter mode. More...
HAL_StatusTypeDef	HAL_LPTIM_Counter_Stop (LPTIM_HandleTypeDef *hlptim)
	Stops the Counter mode. More...
HAL_StatusTypeDef	HAL_LPTIM_Counter_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
	Starts the Counter mode in interrupt mode. More...
HAL_StatusTypeDef	HAL_LPTIM_Counter_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stops the Counter mode in interrupt mode. More...
uint32_t	HAL_LPTIM_ReadCounter (LPTIM_HandleTypeDef *hlptim)
	This function returns the current counter value. More...
uint32_t	HAL_LPTIM_ReadAutoReload (LPTIM_HandleTypeDef *hlptim)
	This function return the current Autoreload (Period) value. More...
uint32_t	HAL_LPTIM_ReadCompare (LPTIM_HandleTypeDef *hlptim)
	This function return the current Compare (Pulse) value. More...
void	HAL_LPTIM_IRQHandler (LPTIM_HandleTypeDef *hlptim)
	This function handles LPTIM interrupt request. More...
void	HAL_LPTIM_CompareMatchCallback (LPTIM_HandleTypeDef *hlptim)
	Compare match callback in non blocking mode. More...
void	HAL_LPTIM_AutoReloadMatchCallback (LPTIM_HandleTypeDef *hlptim)
	Autoreload match callback in non blocking mode. More...
void	HAL_LPTIM_TriggerCallback (LPTIM_HandleTypeDef *hlptim)
	Trigger detected callback in non blocking mode. More...
void	HAL_LPTIM_OutCompareCallback (LPTIM_HandleTypeDef *hlptim)
	Ouput compare callback in non blocking mode. More...
void	HAL_LPTIM_UpdateEventCallback (LPTIM_HandleTypeDef *hlptim)
	Update event callback in non blocking mode. More...
void	HAL_LPTIM_CompareWriteCallback (LPTIM_HandleTypeDef *hlptim)
	Compare write callback in non blocking mode. More...
void	HAL_LPTIM_AutoReloadWriteCallback (LPTIM_HandleTypeDef *hlptim)
	Autoreload write callback in non blocking mode. More...
void	HAL_LPTIM_OverFlowWakeUpCallback (LPTIM_HandleTypeDef *hlptim)
	Autoreload Overflow wakeup callback in non blocking mode. More...
void	HAL_LPTIM_DirectionUpCallback (LPTIM_HandleTypeDef *hlptim)
	Direction counter changed from Down to Up callback in non blocking mode. More...
void	HAL_LPTIM_DirectionDownCallback (LPTIM_HandleTypeDef *hlptim)
	Direction counter changed from Up to Down callback in non blocking mode. More...
HAL_LPTIM_StateTypeDef	HAL_LPTIM_GetState (LPTIM_HandleTypeDef *hlptim)
	Returns the LPTIM state. More...

Detailed Description

Function Documentation

HAL_LPTIM_AutoReloadMatchCallback()

void HAL_LPTIM_AutoReloadMatchCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Autoreload match callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_AutoReloadWriteCallback()

void HAL_LPTIM_AutoReloadWriteCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Autoreload write callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_CompareMatchCallback()

void HAL_LPTIM_CompareMatchCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Compare match callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_CompareWriteCallback()

void HAL_LPTIM_CompareWriteCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Compare write callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_Counter_Start()

HAL_StatusTypeDef HAL_LPTIM_Counter_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period
	)

Starts the Counter mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_Counter_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period
	)

Starts the Counter mode in interrupt mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_Counter_Stop()

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the Counter mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_Counter_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the Counter mode in interrupt mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_DeInit()

HAL_StatusTypeDef HAL_LPTIM_DeInit

(

LPTIM_HandleTypeDef *

hlptim

)

DeInitializes the LPTIM peripheral.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_DirectionDownCallback()

void HAL_LPTIM_DirectionDownCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Direction counter changed from Up to Down callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_DirectionUpCallback()

void HAL_LPTIM_DirectionUpCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Direction counter changed from Down to Up callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_GetState()

HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState

(

LPTIM_HandleTypeDef *

hlptim

)

Returns the LPTIM state.

Parameters

hlptim

LPTIM handle

Return values

HAL

state

HAL_LPTIM_Init()

HAL_StatusTypeDef HAL_LPTIM_Init

(

LPTIM_HandleTypeDef *

hlptim

)

Initializes the LPTIM according to the specified parameters in the LPTIM_InitTypeDef and creates the associated handle.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_InitDefault()

void HAL_LPTIM_InitDefault

(

LPTIM_HandleTypeDef *

hlptim

)

Set default setting for the LPTIM.

Parameters

hlptim

LPTIM handle

HAL_LPTIM_IRQHandler()

void HAL_LPTIM_IRQHandler

(

LPTIM_HandleTypeDef *

hlptim

)

This function handles LPTIM interrupt request.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_MspDeInit()

void HAL_LPTIM_MspDeInit

(

LPTIM_HandleTypeDef *

hlptim

)

DeInitializes LPTIM MSP.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_MspInit()

void HAL_LPTIM_MspInit

(

LPTIM_HandleTypeDef *

hlptim

)

Initializes the LPTIM MSP.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_OnePulse_Start()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Pulse
	)

Starts the LPTIM One pulse generation.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_OnePulse_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Pulse
	)

Starts the LPTIM One pulse generation in interrupt mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_OnePulse_Stop()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the LPTIM One pulse generation.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_OnePulse_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the LPTIM One pulse generation in interrupt mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_OutCompareCallback()

void HAL_LPTIM_OutCompareCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Ouput compare callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_OverFlowWakeUpCallback()

void HAL_LPTIM_OverFlowWakeUpCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Autoreload Overflow wakeup callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_PWM_Start()

HAL_StatusTypeDef HAL_LPTIM_PWM_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Pulse,
		uint32_t	psc_reg
	)

Starts the LPTIM PWM generation.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x000000 and 0xFFFFFF.
psc_reg	Prescale value

Return values

HAL

status

HAL_LPTIM_PWM_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Pulse
	)

Starts the LPTIM PWM generation in interrupt mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF
Pulse	Specifies the compare value. This parameter must be a value between 0x000000 and 0xFFFFFF

Return values

HAL

status

HAL_LPTIM_PWM_Stop()

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the LPTIM PWM generation.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_PWM_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the LPTIM PWM generation in interrupt mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_ReadAutoReload()

uint32_t HAL_LPTIM_ReadAutoReload

(

LPTIM_HandleTypeDef *

hlptim

)

This function return the current Autoreload (Period) value.

Parameters

hlptim

LPTIM handle

Return values

Autoreload

value.

HAL_LPTIM_ReadCompare()

uint32_t HAL_LPTIM_ReadCompare

(

LPTIM_HandleTypeDef *

hlptim

)

This function return the current Compare (Pulse) value.

Parameters

hlptim

LPTIM handle

Return values

Compare

value.

HAL_LPTIM_ReadCounter()

uint32_t HAL_LPTIM_ReadCounter

(

LPTIM_HandleTypeDef *

hlptim

)

This function returns the current counter value.

Parameters

hlptim

LPTIM handle

Return values

Counter

value.

HAL_LPTIM_SetOnce_Start()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Pulse
	)

Starts the LPTIM in Set once mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_SetOnce_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Pulse
	)

Starts the LPTIM Set once mode in interrupt mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_SetOnce_Stop()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the LPTIM Set once mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_SetOnce_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the LPTIM Set once mode in interrupt mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_TimeOut_Start()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Timeout
	)

Starts the Timeout function. The first trigger event will start the timer, any successive trigger event will reset the counter and the timer restarts.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Timeout	Specifies the TimeOut value to rest the counter. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_TimeOut_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period,
		uint32_t	Timeout
	)

Starts the Timeout function in interrupt mode. The first trigger event will start the timer, any successive trigger event will reset the counter and the timer restarts.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x000000 and 0xFFFFFF.
Timeout	Specifies the TimeOut value to rest the counter. This parameter must be a value between 0x000000 and 0xFFFFFF.

Return values

HAL

status

HAL_LPTIM_TimeOut_Stop()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the Timeout function.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_TimeOut_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT

(

LPTIM_HandleTypeDef *

hlptim

)

Stops the Timeout function in interrupt mode.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

HAL_LPTIM_TriggerCallback()

void HAL_LPTIM_TriggerCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Trigger detected callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

HAL_LPTIM_UpdateEventCallback()

void HAL_LPTIM_UpdateEventCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Update event callback in non blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None