LPTIM Exported Functions

Modules
	Initialization/de-initialization functions
	Initialization and Configuration functions.
	LPTIM Start-Stop operation functions
	Start-Stop operation functions.
	LPTIM Read operation functions
	Read operation functions.
	LPTIM IRQ handler and callbacks
	LPTIM IRQ handler.
	Peripheral State functions
	Peripheral State functions.

Functions
HAL_StatusTypeDef	HAL_LPTIM_Init (LPTIM_HandleTypeDef *hlptim)
	Initialize the LPTIM according to the specified parameters in the LPTIM_InitTypeDef and initialize the associated handle. More...
HAL_StatusTypeDef	HAL_LPTIM_DeInit (LPTIM_HandleTypeDef *hlptim)
	DeInitialize the LPTIM peripheral. More...
void	HAL_LPTIM_MspInit (LPTIM_HandleTypeDef *hlptim)
	Initialize the LPTIM MSP. More...
void	HAL_LPTIM_MspDeInit (LPTIM_HandleTypeDef *hlptim)
	DeInitialize LPTIM MSP. More...
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...
uint32_t	HAL_LPTIM_ReadCounter (LPTIM_HandleTypeDef *hlptim)
	Return the current counter value. More...
uint32_t	HAL_LPTIM_ReadAutoReload (LPTIM_HandleTypeDef *hlptim)
	Return the current Autoreload (Period) value. More...
uint32_t	HAL_LPTIM_ReadCompare (LPTIM_HandleTypeDef *hlptim)
	Return the current Compare (Pulse) value. More...
void	HAL_LPTIM_IRQHandler (LPTIM_HandleTypeDef *hlptim)
	Handle 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_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_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...
void	HAL_LPTIM_UpdateEventCallback (LPTIM_HandleTypeDef *hlptim)
	Repetition counter underflowed (or contains zero) and LPTIM counter overflowed callback in non-blocking mode. More...
void	HAL_LPTIM_RepCounterWriteCallback (LPTIM_HandleTypeDef *hlptim)
	Successful APB bus write to repetition counter register callback in non-blocking mode. More...
HAL_StatusTypeDef	HAL_LPTIM_RegisterCallback (LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID, pLPTIM_CallbackTypeDef pCallback)
	Register a User LPTIM callback to be used instead of the weak predefined callback. More...
HAL_StatusTypeDef	HAL_LPTIM_UnRegisterCallback (LPTIM_HandleTypeDef *lphtim, HAL_LPTIM_CallbackIDTypeDef CallbackID)
	Unregister a LPTIM callback LLPTIM callback is redirected to the weak predefined callback. More...
HAL_LPTIM_StateTypeDef	HAL_LPTIM_GetState (LPTIM_HandleTypeDef *hlptim)
	Return the LPTIM handle 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

Definition at line 1801 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_AutoReloadMatchCallback could be implemented in the user file
   */
}

HAL_LPTIM_AutoReloadWriteCallback()

void HAL_LPTIM_AutoReloadWriteCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Autoreload write callback in non-blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 1846 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_AutoReloadWriteCallback could be implemented in the user file
   */
}

HAL_LPTIM_CompareMatchCallback()

void HAL_LPTIM_CompareMatchCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Compare match callback in non-blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 1786 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_CompareMatchCallback could be implemented in the user file
   */
}

HAL_LPTIM_CompareWriteCallback()

void HAL_LPTIM_CompareWriteCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Compare write callback in non-blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 1831 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_CompareWriteCallback could be implemented in the user file
   */
}

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 0x0000 and 0xFFFF.

Return values

HAL

status

Definition at line 1362 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* If clock source is not ULPTIM clock and counter source is external, then it must not be prescaled */
  if ((hlptim->Init.Clock.Source != LPTIM_CLOCKSOURCE_ULPTIM) && (hlptim->Init.CounterSource == LPTIM_COUNTERSOURCE_EXTERNAL))
  {
    /* Check if clock is prescaled */
    assert_param(IS_LPTIM_CLOCK_PRESCALERDIV1(hlptim->Init.Clock.Prescaler));
    /* Set clock prescaler to 0 */
    hlptim->Instance->CFGR &= ~LPTIM_CFGR_PRESC;
  }

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 0x0000 and 0xFFFF.

Return values

HAL

status

Definition at line 1434 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Enable EXTI Line interrupt on the LPTIM Wake-up Timer */
  __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT();

  /* If clock source is not ULPTIM clock and counter source is external, then it must not be prescaled */
  if ((hlptim->Init.Clock.Source != LPTIM_CLOCKSOURCE_ULPTIM) && (hlptim->Init.CounterSource == LPTIM_COUNTERSOURCE_EXTERNAL))
  {
    /* Check if clock is prescaled */
    assert_param(IS_LPTIM_CLOCK_PRESCALERDIV1(hlptim->Init.Clock.Prescaler));
    /* Set clock prescaler to 0 */
    hlptim->Instance->CFGR &= ~LPTIM_CFGR_PRESC;
  }

  /* Enable Autoreload write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Enable Autoreload match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARRM);

#if defined(LPTIM_RCR_REP)
  /* Enable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_ENABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

 #if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1409 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1498 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable EXTI Line interrupt on the LPTIM Wake-up Timer */
  __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT();

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Disable Autoreload write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Disable Autoreload match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARRM);

#if defined(LPTIM_RCR_REP)
  /* Disable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_DISABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_LPTIM_DeInit()

HAL_StatusTypeDef HAL_LPTIM_DeInit

(

LPTIM_HandleTypeDef *

hlptim

)

DeInitialize the LPTIM peripheral.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

Definition at line 345 of file stm32l4xx_hal_lptim.c.

{
  /* Check the LPTIM handle allocation */
  if (hlptim == NULL)
  {
    return HAL_ERROR;
  }

  /* Change the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the LPTIM Peripheral Clock */
  __HAL_LPTIM_DISABLE(hlptim);

#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
  if (hlptim->MspDeInitCallback == NULL)
  {
    hlptim->MspDeInitCallback = HAL_LPTIM_MspDeInit;
  }

  /* DeInit the low level hardware: CLOCK, NVIC.*/
  hlptim->MspDeInitCallback(hlptim);
#else
  /* DeInit the low level hardware: CLOCK, NVIC.*/
  HAL_LPTIM_MspDeInit(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */

  /* Change the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_RESET;

  /* Release Lock */
  __HAL_UNLOCK(hlptim);

  /* Return function status */
  return HAL_OK;
}

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

Definition at line 1876 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_DirectionDownCallback could be implemented in the user file
   */
}

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

Definition at line 1861 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_DirectionUpCallback could be implemented in the user file
   */
}

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 0x0000 and 0xFFFF.

Return values

HAL

status

Definition at line 1043 of file stm32l4xx_hal_lptim.c.

{
  uint32_t          tmpcfgr;

  /* Check the parameters */
  assert_param(IS_LPTIM_ENCODER_INTERFACE_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(hlptim->Init.Clock.Source == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC);
  assert_param(hlptim->Init.Clock.Prescaler == LPTIM_PRESCALER_DIV1);
  assert_param(IS_LPTIM_CLOCK_POLARITY(hlptim->Init.UltraLowPowerClock.Polarity));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Get the LPTIMx CFGR value */
  tmpcfgr = hlptim->Instance->CFGR;

  /* Clear CKPOL bits */
  tmpcfgr &= (uint32_t)(~LPTIM_CFGR_CKPOL);

  /* Set Input polarity */
  tmpcfgr |=  hlptim->Init.UltraLowPowerClock.Polarity;

  /* Write to LPTIMx CFGR */
  hlptim->Instance->CFGR = tmpcfgr;

  /* Set ENC bit to enable the encoder interface */
  hlptim->Instance->CFGR |= LPTIM_CFGR_ENC;

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1121 of file stm32l4xx_hal_lptim.c.

{
  uint32_t          tmpcfgr;

  /* Check the parameters */
  assert_param(IS_LPTIM_ENCODER_INTERFACE_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(hlptim->Init.Clock.Source == LPTIM_CLOCKSOURCE_APBCLOCK_LPOSC);
  assert_param(hlptim->Init.Clock.Prescaler == LPTIM_PRESCALER_DIV1);
  assert_param(IS_LPTIM_CLOCK_POLARITY(hlptim->Init.UltraLowPowerClock.Polarity));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Configure edge sensitivity for encoder mode */
  /* Get the LPTIMx CFGR value */
  tmpcfgr = hlptim->Instance->CFGR;

  /* Clear CKPOL bits */
  tmpcfgr &= (uint32_t)(~LPTIM_CFGR_CKPOL);

  /* Set Input polarity */
  tmpcfgr |=  hlptim->Init.UltraLowPowerClock.Polarity;

  /* Write to LPTIMx CFGR */
  hlptim->Instance->CFGR = tmpcfgr;

  /* Set ENC bit to enable the encoder interface */
  hlptim->Instance->CFGR |= LPTIM_CFGR_ENC;

  /* Enable "switch to down direction" interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_DOWN);

  /* Enable "switch to up direction" interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_UP);

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1093 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_ENCODER_INTERFACE_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Reset ENC bit to disable the encoder interface */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_ENC;

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1178 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_ENCODER_INTERFACE_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Reset ENC bit to disable the encoder interface */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_ENC;

  /* Disable "switch to down direction" interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_DOWN);

  /* Disable "switch to up direction" interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_UP);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_LPTIM_GetState()

HAL_LPTIM_StateTypeDef HAL_LPTIM_GetState

(

LPTIM_HandleTypeDef *

hlptim

)

Return the LPTIM handle state.

Parameters

hlptim

LPTIM handle

Return values

HAL

state

Definition at line 2171 of file stm32l4xx_hal_lptim.c.

{
  /* Return LPTIM handle state */
  return hlptim->State;
}

HAL_LPTIM_Init()

HAL_StatusTypeDef HAL_LPTIM_Init

(

LPTIM_HandleTypeDef *

hlptim

)

Initialize the LPTIM according to the specified parameters in the LPTIM_InitTypeDef and initialize the associated handle.

Parameters

hlptim

LPTIM handle

Return values

HAL

status

Definition at line 215 of file stm32l4xx_hal_lptim.c.

{
  uint32_t tmpcfgr;

  /* Check the LPTIM handle allocation */
  if (hlptim == NULL)
  {
    return HAL_ERROR;
  }

  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  assert_param(IS_LPTIM_CLOCK_SOURCE(hlptim->Init.Clock.Source));
  assert_param(IS_LPTIM_CLOCK_PRESCALER(hlptim->Init.Clock.Prescaler));
  if ((hlptim->Init.Clock.Source) == LPTIM_CLOCKSOURCE_ULPTIM)
  {
    assert_param(IS_LPTIM_CLOCK_POLARITY(hlptim->Init.UltraLowPowerClock.Polarity));
    assert_param(IS_LPTIM_CLOCK_SAMPLE_TIME(hlptim->Init.UltraLowPowerClock.SampleTime));
  }
  assert_param(IS_LPTIM_TRG_SOURCE(hlptim->Init.Trigger.Source));
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    assert_param(IS_LPTIM_TRIG_SAMPLE_TIME(hlptim->Init.Trigger.SampleTime));
    assert_param(IS_LPTIM_EXT_TRG_POLARITY(hlptim->Init.Trigger.ActiveEdge));
  }
  assert_param(IS_LPTIM_OUTPUT_POLARITY(hlptim->Init.OutputPolarity));
  assert_param(IS_LPTIM_UPDATE_MODE(hlptim->Init.UpdateMode));
  assert_param(IS_LPTIM_COUNTER_SOURCE(hlptim->Init.CounterSource));

#if defined(LPTIM_RCR_REP)
  assert_param(IS_LPTIM_REPETITION(hlptim->Init.RepetitionCounter));
#endif

  if (hlptim->State == HAL_LPTIM_STATE_RESET)
  {
    /* Allocate lock resource and initialize it */
    hlptim->Lock = HAL_UNLOCKED;

#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
    /* Reset interrupt callbacks to legacy weak callbacks */
    LPTIM_ResetCallback(hlptim);

    if (hlptim->MspInitCallback == NULL)
    {
      hlptim->MspInitCallback = HAL_LPTIM_MspInit;
    }

    /* Init the low level hardware : GPIO, CLOCK, NVIC */
    hlptim->MspInitCallback(hlptim);
#else
    /* Init the low level hardware : GPIO, CLOCK, NVIC */
    HAL_LPTIM_MspInit(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
  }

  /* Change the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Get the LPTIMx CFGR value */
  tmpcfgr = hlptim->Instance->CFGR;

  if (((hlptim->Init.Clock.Source) == LPTIM_CLOCKSOURCE_ULPTIM) || ((hlptim->Init.CounterSource) == LPTIM_COUNTERSOURCE_EXTERNAL))
  {
    tmpcfgr &= (uint32_t)(~(LPTIM_CFGR_CKPOL | LPTIM_CFGR_CKFLT));
  }
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    tmpcfgr &= (uint32_t)(~(LPTIM_CFGR_TRGFLT | LPTIM_CFGR_TRIGSEL));
  }

  /* Clear CKSEL, CKPOL, PRESC, TRIGEN, TRGFLT, WAVPOL, PRELOAD & COUNTMODE bits */
  tmpcfgr &= (uint32_t)(~(LPTIM_CFGR_CKSEL | LPTIM_CFGR_CKPOL | LPTIM_CFGR_TRIGEN | LPTIM_CFGR_PRELOAD |
                          LPTIM_CFGR_WAVPOL | LPTIM_CFGR_PRESC | LPTIM_CFGR_COUNTMODE));

  /* Set initialization parameters */
  tmpcfgr |= (hlptim->Init.Clock.Source    |
              hlptim->Init.Clock.Prescaler |
              hlptim->Init.OutputPolarity  |
              hlptim->Init.UpdateMode      |
              hlptim->Init.CounterSource);

  if (((hlptim->Init.Clock.Source) == LPTIM_CLOCKSOURCE_ULPTIM) || ((hlptim->Init.CounterSource) == LPTIM_COUNTERSOURCE_EXTERNAL))
  {
    tmpcfgr |= (hlptim->Init.UltraLowPowerClock.Polarity |
                hlptim->Init.UltraLowPowerClock.SampleTime);
  }

  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Enable External trigger and set the trigger source */
    tmpcfgr |= (hlptim->Init.Trigger.Source     |
                hlptim->Init.Trigger.ActiveEdge |
                hlptim->Init.Trigger.SampleTime);
  }

  /* Write to LPTIMx CFGR */
  hlptim->Instance->CFGR = tmpcfgr;

  /* Configure LPTIM input sources */
  if (hlptim->Instance == LPTIM1)
  {
    /* Check LPTIM Input1 and Input2 sources */
    assert_param(IS_LPTIM_INPUT1_SOURCE(hlptim->Instance, hlptim->Init.Input1Source));
    assert_param(IS_LPTIM_INPUT2_SOURCE(hlptim->Instance, hlptim->Init.Input2Source));

    /* Configure LPTIM Input1 and Input2 sources */
    hlptim->Instance->OR = (hlptim->Init.Input1Source | hlptim->Init.Input2Source);
  }
  else
  {
    /* Check LPTIM2 Input1 source */
    assert_param(IS_LPTIM_INPUT1_SOURCE(hlptim->Instance, hlptim->Init.Input1Source));

    /* Configure LPTIM2 Input1 source */
    hlptim->Instance->OR = hlptim->Init.Input1Source;
  }

  /* Change the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_LPTIM_IRQHandler()

void HAL_LPTIM_IRQHandler

(

LPTIM_HandleTypeDef *

hlptim

)

Handle LPTIM interrupt request.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 1622 of file stm32l4xx_hal_lptim.c.

{
  /* Compare match interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_CMPM) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_CMPM) != RESET)
    {
      /* Clear Compare match flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_CMPM);

      /* Compare match Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->CompareMatchCallback(hlptim);
#else
      HAL_LPTIM_CompareMatchCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

  /* Autoreload match interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_ARRM) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_ARRM) != RESET)
    {
      /* Clear Autoreload match flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_ARRM);

      /* Autoreload match Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->AutoReloadMatchCallback(hlptim);
#else
      HAL_LPTIM_AutoReloadMatchCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

  /* Trigger detected interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_EXTTRIG) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_EXTTRIG) != RESET)
    {
      /* Clear Trigger detected flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_EXTTRIG);

      /* Trigger detected callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->TriggerCallback(hlptim);
#else
      HAL_LPTIM_TriggerCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

  /* Compare write interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_CMPOK) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_CMPOK) != RESET)
    {
      /* Clear Compare write flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_CMPOK);

      /* Compare write Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->CompareWriteCallback(hlptim);
#else
      HAL_LPTIM_CompareWriteCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

  /* Autoreload write interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_ARROK) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_ARROK) != RESET)
    {
      /* Clear Autoreload write flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_ARROK);

      /* Autoreload write Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->AutoReloadWriteCallback(hlptim);
#else
      HAL_LPTIM_AutoReloadWriteCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

  /* Direction counter changed from Down to Up interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_UP) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_UP) != RESET)
    {
      /* Clear Direction counter changed from Down to Up flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_UP);

      /* Direction counter changed from Down to Up Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->DirectionUpCallback(hlptim);
#else
      HAL_LPTIM_DirectionUpCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

  /* Direction counter changed from Up to Down interrupt */
  if (__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_DOWN) != RESET)
  {
    if (__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_DOWN) != RESET)
    {
      /* Clear Direction counter changed from Up to Down flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_DOWN);

      /* Direction counter changed from Up to Down Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->DirectionDownCallback(hlptim);
#else
      HAL_LPTIM_DirectionDownCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */
    }
  }

#if defined(LPTIM_RCR_REP)
  /* Repetition counter underflowed (or contains zero) and the LPTIM counter
     overflowed */
  if(__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_UPDATE) != RESET)
  {
    if(__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_UPDATE) != RESET)
    {
      /* Clear update event flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_UPDATE);

      /* Update event Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->UpdateEventCallback(hlptim);
#else
      HAL_LPTIM_UpdateEventCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */      
    }
  }

  /* Successful APB bus write to repetition counter register */
  if(__HAL_LPTIM_GET_FLAG(hlptim, LPTIM_FLAG_REPOK) != RESET)
  {
    if(__HAL_LPTIM_GET_IT_SOURCE(hlptim, LPTIM_IT_REPOK) != RESET)
    {
      /* Clear successful APB bus write to repetition counter flag */
      __HAL_LPTIM_CLEAR_FLAG(hlptim, LPTIM_FLAG_REPOK);

      /* Successful APB bus write to repetition counter Callback */
#if (USE_HAL_LPTIM_REGISTER_CALLBACKS == 1)
      hlptim->RepCounterWriteCallback(hlptim);
#else
      HAL_LPTIM_RepCounterWriteCallback(hlptim);
#endif /* USE_HAL_LPTIM_REGISTER_CALLBACKS */      
    }
  }
#endif
}

HAL_LPTIM_MspDeInit()

void HAL_LPTIM_MspDeInit

(

LPTIM_HandleTypeDef *

hlptim

)

DeInitialize LPTIM MSP.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 402 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_MspDeInit could be implemented in the user file
   */
}

HAL_LPTIM_MspInit()

void HAL_LPTIM_MspInit

(

LPTIM_HandleTypeDef *

hlptim

)

Initialize the LPTIM MSP.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 387 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_MspInit could be implemented in the user file
   */
}

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 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 649 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Pulse));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Reset WAVE bit to set one pulse mode */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_WAVE;

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the pulse value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Pulse);

  /* Start timer in single (one shot) mode */
  __HAL_LPTIM_START_SINGLE(hlptim);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 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 721 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Pulse));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Reset WAVE bit to set one pulse mode */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_WAVE;

  /* Enable Autoreload write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Enable Compare write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPOK);

  /* Enable Autoreload match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARRM);

  /* Enable Compare match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* If external trigger source is used, then enable external trigger interrupt */
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Enable external trigger interrupt */
    __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_EXTTRIG);
  }

#if defined(LPTIM_RCR_REP)
  /* Enable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_ENABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the pulse value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Pulse);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_SINGLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 694 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 793 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Disable Autoreload write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Disable Compare write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPOK);

  /* Disable Autoreload match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARRM);

  /* Disable Compare match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* If external trigger source is used, then disable external trigger interrupt */
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Disable external trigger interrupt */
    __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_EXTTRIG);
  }

#if defined(LPTIM_RCR_REP)
  /* Disable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_DISABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 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 451 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Pulse));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Reset WAVE bit to set PWM mode */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_WAVE;

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the pulse value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Pulse);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 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 523 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Pulse));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Reset WAVE bit to set PWM mode */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_WAVE;

  /* Enable Autoreload write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Enable Compare write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPOK);

  /* Enable Autoreload match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARRM);

  /* Enable Compare match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* If external trigger source is used, then enable external trigger interrupt */
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Enable external trigger interrupt */
    __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_EXTTRIG);
  }

#if defined(LPTIM_RCR_REP)
  /* Enable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_ENABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif
  
  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the pulse value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Pulse);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 496 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 595 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Disable Autoreload write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Disable Compare write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPOK);

  /* Disable Autoreload match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARRM);

  /* Disable Compare match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* If external trigger source is used, then disable external trigger interrupt */
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Disable external trigger interrupt */
    __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_EXTTRIG);
  }

#if defined(LPTIM_RCR_REP)
  /* Disable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_DISABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_LPTIM_ReadAutoReload()

uint32_t HAL_LPTIM_ReadAutoReload

(

LPTIM_HandleTypeDef *

hlptim

)

Return the current Autoreload (Period) value.

Parameters

hlptim

LPTIM handle

Return values

Autoreload

value.

Definition at line 1570 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  return (hlptim->Instance->ARR);
}

HAL_LPTIM_ReadCompare()

uint32_t HAL_LPTIM_ReadCompare

(

LPTIM_HandleTypeDef *

hlptim

)

Return the current Compare (Pulse) value.

Parameters

hlptim

LPTIM handle

Return values

Compare

value.

Definition at line 1583 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  return (hlptim->Instance->CMP);
}

HAL_LPTIM_ReadCounter()

uint32_t HAL_LPTIM_ReadCounter

(

LPTIM_HandleTypeDef *

hlptim

)

Return the current counter value.

Parameters

hlptim

LPTIM handle

Return values

Counter

value.

Definition at line 1557 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  return (hlptim->Instance->CNT);
}

HAL_LPTIM_RegisterCallback()

HAL_StatusTypeDef HAL_LPTIM_RegisterCallback	(	LPTIM_HandleTypeDef *	hlptim,
		HAL_LPTIM_CallbackIDTypeDef	CallbackID,
		pLPTIM_CallbackTypeDef	pCallback
	)

Register a User LPTIM callback to be used instead of the weak predefined callback.

Parameters

hlptim	LPTIM handle
CallbackID	ID of the callback to be registered This parameter can be one of the following values: HAL_LPTIM_MSPINIT_CB_ID LPTIM Base Msp Init Callback ID HAL_LPTIM_MSPDEINIT_CB_ID LPTIM Base Msp DeInit Callback ID HAL_LPTIM_COMPARE_MATCH_CB_ID Compare match Callback ID HAL_LPTIM_AUTORELOAD_MATCH_CB_ID Auto-reload match Callback ID HAL_LPTIM_TRIGGER_CB_ID External trigger event detection Callback ID HAL_LPTIM_COMPARE_WRITE_CB_ID Compare register write complete Callback ID HAL_LPTIM_AUTORELOAD_WRITE_CB_ID Auto-reload register write complete Callback ID HAL_LPTIM_DIRECTION_UP_CB_ID Up-counting direction change Callback ID HAL_LPTIM_DIRECTION_DOWN_CB_ID Down-counting direction change Callback ID
pCallback	pointer to the callback function

Return values

status

Definition at line 1936 of file stm32l4xx_hal_lptim.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  if (pCallback == NULL)
  {
    return HAL_ERROR;
  }

  /* Process locked */
  __HAL_LOCK(hlptim);

  if (hlptim->State == HAL_LPTIM_STATE_READY)
  {
    switch (CallbackID)
    {
      case HAL_LPTIM_MSPINIT_CB_ID :
        hlptim->MspInitCallback = pCallback;
        break;

      case HAL_LPTIM_MSPDEINIT_CB_ID :
        hlptim->MspDeInitCallback = pCallback;
        break;

      case HAL_LPTIM_COMPARE_MATCH_CB_ID :
        hlptim->CompareMatchCallback = pCallback;
        break;

      case HAL_LPTIM_AUTORELOAD_MATCH_CB_ID :
        hlptim->AutoReloadMatchCallback = pCallback;
        break;

      case HAL_LPTIM_TRIGGER_CB_ID :
        hlptim->TriggerCallback = pCallback;
        break;

      case HAL_LPTIM_COMPARE_WRITE_CB_ID :
        hlptim->CompareWriteCallback = pCallback;
        break;

      case HAL_LPTIM_AUTORELOAD_WRITE_CB_ID :
        hlptim->AutoReloadWriteCallback = pCallback;
        break;

      case HAL_LPTIM_DIRECTION_UP_CB_ID :
        hlptim->DirectionUpCallback = pCallback;
        break;

      case HAL_LPTIM_DIRECTION_DOWN_CB_ID :
        hlptim->DirectionDownCallback = pCallback;
        break;

#if defined(LPTIM_RCR_REP)
      case HAL_LPTIM_UPDATE_EVENT_CB_ID :
        hlptim->UpdateEventCallback = pCallback;
        break;

      case HAL_LPTIM_REPETITION_WRITE_CB_ID :
        hlptim->RepCounterWriteCallback = pCallback;
        break;
#endif /* LPTIM_RCR_REP */

      default :
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else if (hlptim->State == HAL_LPTIM_STATE_RESET)
  {
    switch (CallbackID)
    {
      case HAL_LPTIM_MSPINIT_CB_ID :
        hlptim->MspInitCallback = pCallback;
        break;

      case HAL_LPTIM_MSPDEINIT_CB_ID :
        hlptim->MspDeInitCallback = pCallback;
        break;

      default :
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else
  {
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hlptim);

  return status;
}

HAL_LPTIM_RepCounterWriteCallback()

void HAL_LPTIM_RepCounterWriteCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Successful APB bus write to repetition counter register callback in non-blocking mode.

Parameters

hlptim

: LPTIM handle

Return values

None

Definition at line 1907 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_RepCounterWriteCallback could be implemented in the user file
   */
}

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 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 847 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Pulse));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Set WAVE bit to enable the set once mode */
  hlptim->Instance->CFGR |= LPTIM_CFGR_WAVE;

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the pulse value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Pulse);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_SINGLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 919 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Pulse));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Set WAVE bit to enable the set once mode */
  hlptim->Instance->CFGR |= LPTIM_CFGR_WAVE;

  /* Enable Autoreload write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Enable Compare write complete interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPOK);

  /* Enable Autoreload match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_ARRM);

  /* Enable Compare match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* If external trigger source is used, then enable external trigger interrupt */
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Enable external trigger interrupt */
    __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_EXTTRIG);
  }

#if defined(LPTIM_RCR_REP)
  /* Enable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_ENABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the pulse value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Pulse);

#if defined(LPTIM_RCR_REP)
  /* Load the repetition value in the repetition counter */
  if (hlptim->Init.RepetitionCounter != 0)
  {
    __HAL_LPTIM_REPETITIONCOUNTER_SET(hlptim, hlptim->Init.RepetitionCounter);
  }
#endif

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_SINGLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 892 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 991 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Disable Autoreload write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARROK);

  /* Disable Compare write complete interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPOK);

  /* Disable Autoreload match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_ARRM);

  /* Disable Compare match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* If external trigger source is used, then disable external trigger interrupt */
  if ((hlptim->Init.Trigger.Source) != LPTIM_TRIGSOURCE_SOFTWARE)
  {
    /* Disable external trigger interrupt */
    __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_EXTTRIG);
  }

#if defined(LPTIM_RCR_REP)
  /* Disable the update event and the repetition register update OK interrupts */
  if ((hlptim->Init.RepetitionCounter) !=  0)
  {
    __HAL_LPTIM_DISABLE_IT(hlptim, (LPTIM_IT_UPDATE | LPTIM_IT_REPOK));
  }
#endif

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 0x0000 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 1216 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Timeout));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Set TIMOUT bit to enable the timeout function */
  hlptim->Instance->CFGR |= LPTIM_CFGR_TIMOUT;

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the Timeout value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Timeout);

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 0x0000 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 1285 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));
  assert_param(IS_LPTIM_PERIOD(Period));
  assert_param(IS_LPTIM_PULSE(Timeout));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Enable EXTI Line interrupt on the LPTIM Wake-up Timer */
  __HAL_LPTIM_WAKEUPTIMER_EXTI_ENABLE_IT();

  /* Set TIMOUT bit to enable the timeout function */
  hlptim->Instance->CFGR |= LPTIM_CFGR_TIMOUT;

  /* Enable Compare match interrupt */
  __HAL_LPTIM_ENABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* Enable the Peripheral */
  __HAL_LPTIM_ENABLE(hlptim);

  /* Load the period value in the autoreload register */
  __HAL_LPTIM_AUTORELOAD_SET(hlptim, Period);

  /* Load the Timeout value in the compare register */
  __HAL_LPTIM_COMPARE_SET(hlptim, Timeout);

  /* Start timer in continuous mode */
  __HAL_LPTIM_START_CONTINUOUS(hlptim);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1253 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Reset TIMOUT bit to enable the timeout function */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_TIMOUT;

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

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 1328 of file stm32l4xx_hal_lptim.c.

{
  /* Check the parameters */
  assert_param(IS_LPTIM_INSTANCE(hlptim->Instance));

  /* Set the LPTIM state */
  hlptim->State = HAL_LPTIM_STATE_BUSY;

  /* Disable EXTI Line interrupt on the LPTIM Wake-up Timer */
  __HAL_LPTIM_WAKEUPTIMER_EXTI_DISABLE_IT();

  /* Disable the Peripheral */
  __HAL_LPTIM_DISABLE(hlptim);

  /* Reset TIMOUT bit to enable the timeout function */
  hlptim->Instance->CFGR &= ~LPTIM_CFGR_TIMOUT;

  /* Disable Compare match interrupt */
  __HAL_LPTIM_DISABLE_IT(hlptim, LPTIM_IT_CMPM);

  /* Change the TIM state*/
  hlptim->State = HAL_LPTIM_STATE_READY;

  /* Return function status */
  return HAL_OK;
}

HAL_LPTIM_TriggerCallback()

void HAL_LPTIM_TriggerCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Trigger detected callback in non-blocking mode.

Parameters

hlptim

LPTIM handle

Return values

None

Definition at line 1816 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_TriggerCallback could be implemented in the user file
   */
}

HAL_LPTIM_UnRegisterCallback()

HAL_StatusTypeDef HAL_LPTIM_UnRegisterCallback	(	LPTIM_HandleTypeDef *	hlptim,
		HAL_LPTIM_CallbackIDTypeDef	CallbackID
	)

Unregister a LPTIM callback LLPTIM callback is redirected to the weak predefined callback.

Parameters

hlptim

LPTIM handle

CallbackID

ID of the callback to be unregistered This parameter can be one of the following values: HAL_LPTIM_MSPINIT_CB_ID LPTIM Base Msp Init Callback ID HAL_LPTIM_MSPDEINIT_CB_ID LPTIM Base Msp DeInit Callback ID HAL_LPTIM_COMPARE_MATCH_CB_ID Compare match Callback ID HAL_LPTIM_AUTORELOAD_MATCH_CB_ID Auto-reload match Callback ID HAL_LPTIM_TRIGGER_CB_ID External trigger event detection Callback ID HAL_LPTIM_COMPARE_WRITE_CB_ID Compare register write complete Callback ID HAL_LPTIM_AUTORELOAD_WRITE_CB_ID Auto-reload register write complete Callback ID HAL_LPTIM_DIRECTION_UP_CB_ID Up-counting direction change Callback ID HAL_LPTIM_DIRECTION_DOWN_CB_ID Down-counting direction change Callback ID

Return values

status

Definition at line 2053 of file stm32l4xx_hal_lptim.c.

{
  HAL_StatusTypeDef status = HAL_OK;

  /* Process locked */
  __HAL_LOCK(hlptim);

  if (hlptim->State == HAL_LPTIM_STATE_READY)
  {
    switch (CallbackID)
    {
      case HAL_LPTIM_MSPINIT_CB_ID :
        hlptim->MspInitCallback = HAL_LPTIM_MspInit;                          /* Legacy weak MspInit Callback */
        break;

      case HAL_LPTIM_MSPDEINIT_CB_ID :
        hlptim->MspDeInitCallback = HAL_LPTIM_MspDeInit;                       /* Legacy weak Msp DeInit Callback */
        break;

      case HAL_LPTIM_COMPARE_MATCH_CB_ID :
        hlptim->CompareMatchCallback = HAL_LPTIM_CompareMatchCallback;         /* Legacy weak Compare match Callback */
        break;

      case HAL_LPTIM_AUTORELOAD_MATCH_CB_ID :
        hlptim->AutoReloadMatchCallback = HAL_LPTIM_AutoReloadMatchCallback;   /* Legacy weak Auto-reload match Callback */
        break;

      case HAL_LPTIM_TRIGGER_CB_ID :
        hlptim->TriggerCallback = HAL_LPTIM_TriggerCallback;                   /* Legacy weak External trigger event detection Callback */
        break;

      case HAL_LPTIM_COMPARE_WRITE_CB_ID :
        hlptim->CompareWriteCallback = HAL_LPTIM_CompareWriteCallback;         /* Legacy weak Compare register write complete Callback */
        break;

      case HAL_LPTIM_AUTORELOAD_WRITE_CB_ID :
        hlptim->AutoReloadWriteCallback = HAL_LPTIM_AutoReloadWriteCallback;   /* Legacy weak Auto-reload register write complete Callback */
        break;

      case HAL_LPTIM_DIRECTION_UP_CB_ID :
        hlptim->DirectionUpCallback = HAL_LPTIM_DirectionUpCallback;           /* Legacy weak Up-counting direction change Callback */
        break;

      case HAL_LPTIM_DIRECTION_DOWN_CB_ID :
        hlptim->DirectionDownCallback = HAL_LPTIM_DirectionDownCallback;       /* Legacy weak Down-counting direction change Callback */
        break;

#if defined(LPTIM_RCR_REP)
      case HAL_LPTIM_UPDATE_EVENT_CB_ID :
        hlptim->UpdateEventCallback = HAL_LPTIM_UpdateEventCallback;           /* Legacy weak Update Event Callback */
        break;

      case HAL_LPTIM_REPETITION_WRITE_CB_ID :
        hlptim->RepCounterWriteCallback = HAL_LPTIM_RepCounterWriteCallback;   /* Legacy weak Repetition counter successful write Callback */
        break;
#endif /* LPTIM_RCR_REP */

      default :
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else if (hlptim->State == HAL_LPTIM_STATE_RESET)
  {
    switch (CallbackID)
    {
      case HAL_LPTIM_MSPINIT_CB_ID :
        hlptim->MspInitCallback = HAL_LPTIM_MspInit;                           /* Legacy weak MspInit Callback */
        break;

      case HAL_LPTIM_MSPDEINIT_CB_ID :
        hlptim->MspDeInitCallback = HAL_LPTIM_MspDeInit;                        /* Legacy weak Msp DeInit Callback */
        break;

      default :
        /* Return error status */
        status =  HAL_ERROR;
        break;
    }
  }
  else
  {
    /* Return error status */
    status =  HAL_ERROR;
  }

  /* Release Lock */
  __HAL_UNLOCK(hlptim);

  return status;
}

HAL_LPTIM_UpdateEventCallback()

void HAL_LPTIM_UpdateEventCallback

(

LPTIM_HandleTypeDef *

hlptim

)

Repetition counter underflowed (or contains zero) and LPTIM counter overflowed callback in non-blocking mode.

Parameters

hlptim

: LPTIM handle

Return values

None

Definition at line 1892 of file stm32l4xx_hal_lptim.c.

{
  /* Prevent unused argument(s) compilation warning */
  UNUSED(hlptim);

  /* NOTE : This function should not be modified, when the callback is needed,
            the HAL_LPTIM_UpdateEventCallback could be implemented in the user file
   */
}