Start-Stop operation functions. More...

Collaboration diagram for LPTIM Start-Stop operation functions:

Functions
HAL_StatusTypeDef	HAL_LPTIM_PWM_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Start the LPTIM PWM generation. More...

HAL_StatusTypeDef	HAL_LPTIM_PWM_Stop (LPTIM_HandleTypeDef *hlptim)
	Stop the LPTIM PWM generation. More...

HAL_StatusTypeDef	HAL_LPTIM_PWM_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Start the LPTIM PWM generation in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_PWM_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stop the LPTIM PWM generation in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Start the LPTIM One pulse generation. More...

HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Stop (LPTIM_HandleTypeDef *hlptim)
	Stop the LPTIM One pulse generation. More...

HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Start the LPTIM One pulse generation in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_OnePulse_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stop the LPTIM One pulse generation in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Start the LPTIM in Set once mode. More...

HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Stop (LPTIM_HandleTypeDef *hlptim)
	Stop the LPTIM Set once mode. More...

HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
	Start the LPTIM Set once mode in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_SetOnce_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stop the LPTIM Set once mode in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_Encoder_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
	Start the Encoder interface. More...

HAL_StatusTypeDef	HAL_LPTIM_Encoder_Stop (LPTIM_HandleTypeDef *hlptim)
	Stop the Encoder interface. More...

HAL_StatusTypeDef	HAL_LPTIM_Encoder_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
	Start the Encoder interface in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_Encoder_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stop the Encoder interface in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
	Start the Timeout function. More...

HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Stop (LPTIM_HandleTypeDef *hlptim)
	Stop the Timeout function. More...

HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
	Start the Timeout function in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_TimeOut_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stop the Timeout function in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_Counter_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
	Start the Counter mode. More...

HAL_StatusTypeDef	HAL_LPTIM_Counter_Stop (LPTIM_HandleTypeDef *hlptim)
	Stop the Counter mode. More...

HAL_StatusTypeDef	HAL_LPTIM_Counter_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
	Start the Counter mode in interrupt mode. More...

HAL_StatusTypeDef	HAL_LPTIM_Counter_Stop_IT (LPTIM_HandleTypeDef *hlptim)
	Stop the Counter mode in interrupt mode. More...

Detailed Description

Start-Stop operation functions.

  ==============================================================================
                ##### LPTIM Start Stop operation functions #####
  ==============================================================================
    [..]  This section provides functions allowing to:
      (+) Start the PWM mode.
      (+) Stop the PWM mode.
      (+) Start the One pulse mode.
      (+) Stop the One pulse mode.
      (+) Start the Set once mode.
      (+) Stop the Set once mode.
      (+) Start the Encoder mode.
      (+) Stop the Encoder mode.
      (+) Start the Timeout mode.
      (+) Stop the Timeout mode.
      (+) Start the Counter mode.
      (+) Stop the Counter mode.

Function Documentation

◆ HAL_LPTIM_Counter_Start()

HAL_StatusTypeDef HAL_LPTIM_Counter_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period
	)

Start the Counter mode.

Parameters

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

Return values

HAL status

Definition at line 1544 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Counter_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period
	)

Start the Counter mode in interrupt mode.

Parameters

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

Return values

HAL status

Definition at line 1623 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Counter_Stop()

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop ( LPTIM_HandleTypeDef * hlptim )

Stop the Counter mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1593 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Counter_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT ( LPTIM_HandleTypeDef * hlptim )

Stop the Counter mode in interrupt mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1696 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Encoder_Start()

HAL_StatusTypeDef HAL_LPTIM_Encoder_Start	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period
	)

Start the Encoder interface.

Parameters

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

Return values

HAL status

Definition at line 1120 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Encoder_Start_IT()

HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT	(	LPTIM_HandleTypeDef *	hlptim,
		uint32_t	Period
	)

Start the Encoder interface in interrupt mode.

Parameters

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

Return values

HAL status

Definition at line 1212 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Encoder_Stop()

HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop ( LPTIM_HandleTypeDef * hlptim )

Stop the Encoder interface.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1179 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_Encoder_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT ( LPTIM_HandleTypeDef * hlptim )

Stop the Encoder interface in interrupt mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1289 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_OnePulse_Start()

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

Start the LPTIM One pulse generation.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.

Return values

HAL status

Definition at line 675 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_OnePulse_Start_IT()

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

Start the LPTIM One pulse generation in interrupt mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.

Return values

HAL status

Definition at line 762 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_OnePulse_Stop()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop ( LPTIM_HandleTypeDef * hlptim )

Stop the LPTIM One pulse generation.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 730 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_OnePulse_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT ( LPTIM_HandleTypeDef * hlptim )

Stop the LPTIM One pulse generation in interrupt mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 847 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_PWM_Start()

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

Start the LPTIM PWM generation.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.

Return values

HAL status

Definition at line 452 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_PWM_Start_IT()

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

Start the LPTIM PWM generation in interrupt mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF
Pulse	Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF

Return values

HAL status

Definition at line 539 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_PWM_Stop()

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop ( LPTIM_HandleTypeDef * hlptim )

Stop the LPTIM PWM generation.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 507 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_PWM_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT ( LPTIM_HandleTypeDef * hlptim )

Stop the LPTIM PWM generation in interrupt mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 624 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_SetOnce_Start()

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

Start the LPTIM in Set once mode.

Parameters

hlptim	LPTIM handle
Period	Specifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
Pulse	Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.

Return values

HAL status

Definition at line 899 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_SetOnce_Start_IT()

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

Start the LPTIM Set once mode in interrupt mode.

Parameters

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

Return values

HAL status

Definition at line 986 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_SetOnce_Stop()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop ( LPTIM_HandleTypeDef * hlptim )

Stop the LPTIM Set once mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 954 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_SetOnce_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT ( LPTIM_HandleTypeDef * hlptim )

Stop the LPTIM Set once mode in interrupt mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1071 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_TimeOut_Start()

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

Start the Timeout function.

Note: 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 0x0001 and 0xFFFF.
Timeout	Specifies the TimeOut value to reset the counter. This parameter must be a value between 0x0000 and 0xFFFF.

Return values

HAL status

Definition at line 1332 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_TimeOut_Start_IT()

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

Start the Timeout function in interrupt mode.

Note: 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 0x0001 and 0xFFFF.
Timeout	Specifies the TimeOut value to reset the counter. This parameter must be a value between 0x0000 and 0xFFFF.

Return values

HAL status

Definition at line 1424 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_TimeOut_Stop()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop ( LPTIM_HandleTypeDef * hlptim )

Stop the Timeout function.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1387 of file stm32f4xx_hal_lptim.c.

◆ HAL_LPTIM_TimeOut_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT ( LPTIM_HandleTypeDef * hlptim )

Stop the Timeout function in interrupt mode.

Parameters

hlptim LPTIM handle

Return values

HAL status

Definition at line 1500 of file stm32f4xx_hal_lptim.c.

Functions

Detailed Description

Function Documentation

◆ HAL_LPTIM_Counter_Start()

◆ HAL_LPTIM_Counter_Start_IT()

◆ HAL_LPTIM_Counter_Stop()

◆ HAL_LPTIM_Counter_Stop_IT()

◆ HAL_LPTIM_Encoder_Start()

◆ HAL_LPTIM_Encoder_Start_IT()

◆ HAL_LPTIM_Encoder_Stop()

◆ HAL_LPTIM_Encoder_Stop_IT()

◆ HAL_LPTIM_OnePulse_Start()

◆ HAL_LPTIM_OnePulse_Start_IT()

◆ HAL_LPTIM_OnePulse_Stop()

◆ HAL_LPTIM_OnePulse_Stop_IT()

◆ HAL_LPTIM_PWM_Start()

◆ HAL_LPTIM_PWM_Start_IT()

◆ HAL_LPTIM_PWM_Stop()

◆ HAL_LPTIM_PWM_Stop_IT()

◆ HAL_LPTIM_SetOnce_Start()

◆ HAL_LPTIM_SetOnce_Start_IT()

◆ HAL_LPTIM_SetOnce_Stop()

◆ HAL_LPTIM_SetOnce_Stop_IT()

◆ HAL_LPTIM_TimeOut_Start()

◆ HAL_LPTIM_TimeOut_Start_IT()

◆ HAL_LPTIM_TimeOut_Stop()

◆ HAL_LPTIM_TimeOut_Stop_IT()