Eric Lewiston / STM32L4xx_HAL_Driver

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   BSP OneHopeOnePrayer FINAL_AUDIO_RECORD AudioDemo

Fork of STM32L4xx_HAL_Driver by Senior Design: Sound Monitor

Embed: (wiki syntax)

« Back to documentation index

LPTIM Start-Stop operation functions
Functions

LPTIM Start-Stop operation functions
[LPTIM Exported Functions]

Start-Stop operation functions. More...

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_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 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 1204 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 1268 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop ( LPTIM_HandleTypeDef *  hlptim )

Stop the Counter mode.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 1243 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_Counter_Stop_IT ( LPTIM_HandleTypeDef *  hlptim )

Stop the Counter mode in interrupt mode.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 1313 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 873 of file stm32l4xx_hal_lptim.c.

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:
HALstatus

Definition at line 960 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop ( LPTIM_HandleTypeDef *  hlptim )

Stop the Encoder interface.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 932 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_Encoder_Stop_IT ( LPTIM_HandleTypeDef *  hlptim )

Stop the Encoder interface in interrupt mode.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 1026 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Pulse: Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 543 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Pulse: Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 607 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_OnePulse_Stop ( LPTIM_HandleTypeDef *  hlptim )

Stop the LPTIM One pulse generation.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 580 of file stm32l4xx_hal_lptim.c.

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:
HALstatus

Definition at line 663 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Pulse: Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 377 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF
Pulse: Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF
Return values:
HALstatus

Definition at line 441 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop ( LPTIM_HandleTypeDef *  hlptim )

Stop the LPTIM PWM generation.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 414 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_PWM_Stop_IT ( LPTIM_HandleTypeDef *  hlptim )

Stop the LPTIM PWM generation in interrupt mode.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 497 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Pulse: Specifies the compare value. This parameter must be a value between 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 709 of file stm32l4xx_hal_lptim.c.

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:
HALstatus

Definition at line 773 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_SetOnce_Stop ( LPTIM_HandleTypeDef *  hlptim )

Stop the LPTIM Set once mode.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 746 of file stm32l4xx_hal_lptim.c.

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:
HALstatus

Definition at line 829 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Timeout: Specifies the TimeOut value to rest the counter. This parameter must be a value between 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 1064 of file stm32l4xx_hal_lptim.c.

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 0x0000 and 0xFFFF.
Timeout: Specifies the TimeOut value to rest the counter. This parameter must be a value between 0x0000 and 0xFFFF.
Return values:
HALstatus

Definition at line 1133 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop ( LPTIM_HandleTypeDef *  hlptim )

Stop the Timeout function.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 1101 of file stm32l4xx_hal_lptim.c.

HAL_StatusTypeDef HAL_LPTIM_TimeOut_Stop_IT ( LPTIM_HandleTypeDef *  hlptim )

Stop the Timeout function in interrupt mode.

Parameters:
hlptim: LPTIM handle
Return values:
HALstatus

Definition at line 1173 of file stm32l4xx_hal_lptim.c.

Generated on Tue Jul 12 2022 11:35:30 by  doxygen 1.7.2