STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
LPTIM Start-Stop operation functions

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.
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM PWM generation.
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM PWM generation in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM PWM generation in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM One pulse generation.
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM One pulse generation.
 
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.
 
HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM One pulse generation in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Pulse)
 Start the LPTIM in Set once mode.
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM Set once mode.
 
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.
 
HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the LPTIM Set once mode in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Encoder interface.
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the Encoder interface.
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Encoder interface in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the Encoder interface in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
 Start the Timeout function.
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the Timeout function.
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period, uint32_t Timeout)
 Start the Timeout function in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the Timeout function in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Start (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Counter mode.
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Stop (LPTIM_HandleTypeDef *hlptim)
 Stop the Counter mode.
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Start_IT (LPTIM_HandleTypeDef *hlptim, uint32_t Period)
 Start the Counter mode in interrupt mode.
 
HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT (LPTIM_HandleTypeDef *hlptim)
 Stop the Counter mode in interrupt mode.
 

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_PWM_Start()

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

#include <stm32f4xx_hal_lptim.h>

Start the LPTIM PWM generation.

Parameters
hlptimLPTIM handle
PeriodSpecifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
PulseSpecifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values
HALstatus

Definition at line 452 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_AUTORELOAD_SET, __HAL_LPTIM_CLEAR_FLAG, __HAL_LPTIM_COMPARE_SET, __HAL_LPTIM_ENABLE, __HAL_LPTIM_START_CONTINUOUS, assert_param, HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, IS_LPTIM_PERIOD, IS_LPTIM_PULSE, LPTIM_FLAG_ARROK, LPTIM_FLAG_CMPOK, LPTIM_WaitForFlag(), and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_PWM_Stop()

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop ( LPTIM_HandleTypeDef * hlptim)

#include <stm32f4xx_hal_lptim.h>

Stop the LPTIM PWM generation.

Parameters
hlptimLPTIM handle
Return values
HALstatus

Definition at line 507 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_DISABLE, assert_param, HAL_LPTIM_GetState(), HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_LPTIM_STATE_TIMEOUT, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_PWM_Start_IT()

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

◆ HAL_LPTIM_PWM_Stop_IT()

◆ HAL_LPTIM_OnePulse_Start()

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

#include <stm32f4xx_hal_lptim.h>

Start the LPTIM One pulse generation.

Parameters
hlptimLPTIM handle
PeriodSpecifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
PulseSpecifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values
HALstatus

Definition at line 675 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_AUTORELOAD_SET, __HAL_LPTIM_CLEAR_FLAG, __HAL_LPTIM_COMPARE_SET, __HAL_LPTIM_ENABLE, __HAL_LPTIM_START_SINGLE, assert_param, HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, IS_LPTIM_PERIOD, IS_LPTIM_PULSE, LPTIM_FLAG_ARROK, LPTIM_FLAG_CMPOK, LPTIM_WaitForFlag(), and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_OnePulse_Stop()

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop ( LPTIM_HandleTypeDef * hlptim)

#include <stm32f4xx_hal_lptim.h>

Stop the LPTIM One pulse generation.

Parameters
hlptimLPTIM handle
Return values
HALstatus

Definition at line 730 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_DISABLE, assert_param, HAL_LPTIM_GetState(), HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_LPTIM_STATE_TIMEOUT, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_OnePulse_Start_IT()

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

◆ HAL_LPTIM_OnePulse_Stop_IT()

◆ HAL_LPTIM_SetOnce_Start()

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

#include <stm32f4xx_hal_lptim.h>

Start the LPTIM in Set once mode.

Parameters
hlptimLPTIM handle
PeriodSpecifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
PulseSpecifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values
HALstatus

Definition at line 899 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_AUTORELOAD_SET, __HAL_LPTIM_CLEAR_FLAG, __HAL_LPTIM_COMPARE_SET, __HAL_LPTIM_ENABLE, __HAL_LPTIM_START_SINGLE, assert_param, HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, IS_LPTIM_PERIOD, IS_LPTIM_PULSE, LPTIM_FLAG_ARROK, LPTIM_FLAG_CMPOK, LPTIM_WaitForFlag(), and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_SetOnce_Stop()

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop ( LPTIM_HandleTypeDef * hlptim)

#include <stm32f4xx_hal_lptim.h>

Stop the LPTIM Set once mode.

Parameters
hlptimLPTIM handle
Return values
HALstatus

Definition at line 954 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_DISABLE, assert_param, HAL_LPTIM_GetState(), HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_LPTIM_STATE_TIMEOUT, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_SetOnce_Start_IT()

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

◆ HAL_LPTIM_SetOnce_Stop_IT()

◆ HAL_LPTIM_Encoder_Start()

◆ HAL_LPTIM_Encoder_Stop()

HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop ( LPTIM_HandleTypeDef * hlptim)

#include <stm32f4xx_hal_lptim.h>

Stop the Encoder interface.

Parameters
hlptimLPTIM handle
Return values
HALstatus

Definition at line 1179 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_DISABLE, assert_param, HAL_LPTIM_GetState(), HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_LPTIM_STATE_TIMEOUT, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_Encoder_Start_IT()

◆ HAL_LPTIM_Encoder_Stop_IT()

HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT ( LPTIM_HandleTypeDef * hlptim)

◆ HAL_LPTIM_TimeOut_Start()

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

#include <stm32f4xx_hal_lptim.h>

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
hlptimLPTIM handle
PeriodSpecifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
TimeoutSpecifies the TimeOut value to reset the counter. This parameter must be a value between 0x0000 and 0xFFFF.
Return values
HALstatus

Definition at line 1332 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_AUTORELOAD_SET, __HAL_LPTIM_CLEAR_FLAG, __HAL_LPTIM_COMPARE_SET, __HAL_LPTIM_ENABLE, __HAL_LPTIM_START_CONTINUOUS, assert_param, HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, IS_LPTIM_PERIOD, IS_LPTIM_PULSE, LPTIM_FLAG_ARROK, LPTIM_FLAG_CMPOK, LPTIM_WaitForFlag(), and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_TimeOut_Stop()

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop ( LPTIM_HandleTypeDef * hlptim)

#include <stm32f4xx_hal_lptim.h>

Stop the Timeout function.

Parameters
hlptimLPTIM handle
Return values
HALstatus

Definition at line 1387 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_DISABLE, assert_param, HAL_LPTIM_GetState(), HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_LPTIM_STATE_TIMEOUT, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_TimeOut_Start_IT()

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

#include <stm32f4xx_hal_lptim.h>

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
hlptimLPTIM handle
PeriodSpecifies the Autoreload value. This parameter must be a value between 0x0001 and 0xFFFF.
TimeoutSpecifies the TimeOut value to reset the counter. This parameter must be a value between 0x0000 and 0xFFFF.
Return values
HALstatus

Definition at line 1424 of file stm32f4xx_hal_lptim.c.

References __HAL_LPTIM_AUTORELOAD_SET, __HAL_LPTIM_CLEAR_FLAG, __HAL_LPTIM_COMPARE_SET, __HAL_LPTIM_DISABLE, __HAL_LPTIM_ENABLE, __HAL_LPTIM_ENABLE_IT, __HAL_LPTIM_START_CONTINUOUS, __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT, assert_param, HAL_LPTIM_GetState(), HAL_LPTIM_STATE_BUSY, HAL_LPTIM_STATE_READY, HAL_LPTIM_STATE_TIMEOUT, HAL_OK, HAL_TIMEOUT, LPTIM_HandleTypeDef::Instance, IS_LPTIM_PERIOD, IS_LPTIM_PULSE, LPTIM_FLAG_ARROK, LPTIM_FLAG_CMPOK, LPTIM_IT_CMPM, LPTIM_WaitForFlag(), and LPTIM_HandleTypeDef::State.

◆ HAL_LPTIM_TimeOut_Stop_IT()

◆ HAL_LPTIM_Counter_Start()

◆ HAL_LPTIM_Counter_Stop()

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop ( LPTIM_HandleTypeDef * hlptim)

◆ HAL_LPTIM_Counter_Start_IT()

◆ HAL_LPTIM_Counter_Stop_IT()