Extended RTC Wake-up functions

RTC Wake-up functions. More...

Modules
	Extended Peripheral Control functions

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Set wake up timer. More...
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock, uint32_t WakeUpAutoClr) HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT(RTC_HandleTypeDef *hrtc
	Set wake up timer with interrupt. More...
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
HAL_StatusTypeDef	HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Deactivate wake up timer counter. More...
uint32_t	HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Get wake up timer counter. More...
void	HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
	Handle Wake Up Timer interrupt request. More...
void	HAL_RTCEx_WakeUpTimerEventCallback (RTC_HandleTypeDef *hrtc)
HAL_StatusTypeDef	HAL_RTCEx_PollForWakeUpTimerEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	assert_param (IS_RTC_WAKEUP_CLOCK(WakeUpClock))
	assert_param (IS_RTC_WAKEUP_COUNTER(WakeUpCounter))
	assert_param (WakeUpAutoClr<=WakeUpCounter)
	__HAL_LOCK (hrtc)
	__HAL_RTC_WRITEPROTECTION_DISABLE (hrtc)
	CLEAR_BIT (hrtc->Instance->CR, RTC_CR_WUTE)
	__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG (hrtc, RTC_FLAG_WUTF)
	if (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_INITF)==0U)
	MODIFY_REG (hrtc->Instance->CR, RTC_CR_WUCKSEL,(uint32_t) WakeUpClock)
	if (WakeUpAutoClr !=0u)
	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT ()
	__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE ()
	__HAL_RTC_WAKEUPTIMER_ENABLE_IT (hrtc, RTC_IT_WUT)
	__HAL_RTC_WAKEUPTIMER_ENABLE (hrtc)
	__HAL_RTC_WRITEPROTECTION_ENABLE (hrtc)
	__HAL_UNLOCK (hrtc)

Variables
HAL_StatusTypeDef uint32_t	WakeUpCounter
HAL_StatusTypeDef uint32_t uint32_t	WakeUpClock
hrtc	State = HAL_RTC_STATE_BUSY
hrtc Instance	WUTR = (uint32_t)(WakeUpCounter | (WakeUpAutoClr << RTC_WUTR_WUTOCLR_Pos))
	else
return	HAL_OK

Detailed Description

RTC Wake-up functions.

 ===============================================================================
                        ##### RTC Wake-up functions #####
 ===============================================================================

 [..] This section provides functions allowing to configure Wake-up feature

Function Documentation

__HAL_LOCK()

__HAL_LOCK

(

hrtc

)

__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG()

__HAL_RTC_WAKEUPTIMER_CLEAR_FLAG	(	hrtc	,
		RTC_FLAG_WUTF
	)

__HAL_RTC_WAKEUPTIMER_ENABLE()

__HAL_RTC_WAKEUPTIMER_ENABLE

(

hrtc

)

__HAL_RTC_WAKEUPTIMER_ENABLE_IT()

__HAL_RTC_WAKEUPTIMER_ENABLE_IT	(	hrtc	,
		RTC_IT_WUT
	)

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT()

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT

(

)

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE()

__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE

(

)

__HAL_RTC_WRITEPROTECTION_DISABLE()

__HAL_RTC_WRITEPROTECTION_DISABLE

(

hrtc

)

__HAL_RTC_WRITEPROTECTION_ENABLE()

__HAL_RTC_WRITEPROTECTION_ENABLE

(

hrtc

)

__HAL_UNLOCK()

__HAL_UNLOCK

(

hrtc

)

assert_param() [1/3]

assert_param

(

IS_RTC_WAKEUP_CLOCK(WakeUpClock)

)

assert_param() [2/3]

assert_param

(

IS_RTC_WAKEUP_COUNTER(WakeUpCounter)

)

assert_param() [3/3]

assert_param

(

WakeUpAutoClr<=

WakeUpCounter

)

CLEAR_BIT()

CLEAR_BIT	(	hrtc->Instance->	CR,
		RTC_CR_WUTE
	)

HAL_RTCEx_DeactivateWakeUpTimer()

HAL_StatusTypeDef HAL_RTCEx_DeactivateWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Deactivate wake up timer counter.

Parameters

hrtc	RTC handle

Return values

HAL

status

Definition at line 893 of file stm32l4xx_hal_rtc_ex.c.

{
  uint32_t tickstart;

  /* Process Locked */
  __HAL_LOCK(hrtc);

  hrtc->State = HAL_RTC_STATE_BUSY;

  /* Disable the write protection for RTC registers */
  __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);

  /* Disable the Wakeup Timer */
  __HAL_RTC_WAKEUPTIMER_DISABLE(hrtc);

  /* In case of interrupt mode is used, the interrupt source must disabled */
  __HAL_RTC_WAKEUPTIMER_DISABLE_IT(hrtc, RTC_IT_WUT);

  tickstart = HAL_GetTick();
  /* Wait till RTC WUTWF flag is set and if Time out is reached exit */
  while (__HAL_RTC_WAKEUPTIMER_GET_FLAG(hrtc, RTC_FLAG_WUTWF) == 0U)
  {
    if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
    {
      /* Enable the write protection for RTC registers */
      __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);

      hrtc->State = HAL_RTC_STATE_TIMEOUT;

      /* Process Unlocked */
      __HAL_UNLOCK(hrtc);

      return HAL_TIMEOUT;
    }
  }

  /* Enable the write protection for RTC registers */
  __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);

  hrtc->State = HAL_RTC_STATE_READY;

  /* Process Unlocked */
  __HAL_UNLOCK(hrtc);

  return HAL_OK;
}

HAL_RTCEx_GetWakeUpTimer()

uint32_t HAL_RTCEx_GetWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Get wake up timer counter.

Parameters

hrtc	RTC handle

Return values

Counter

value

Definition at line 945 of file stm32l4xx_hal_rtc_ex.c.

{
  /* Get the counter value */
  return ((uint32_t)(hrtc->Instance->WUTR & RTC_WUTR_WUT));
}

HAL_RTCEx_PollForWakeUpTimerEvent()

HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

HAL_RTCEx_SetWakeUpTimer()

HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	WakeUpCounter,
		uint32_t	WakeUpClock
	)

Set wake up timer.

Parameters

hrtc	RTC handle
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock

Return values

HAL

status

Definition at line 699 of file stm32l4xx_hal_rtc_ex.c.

{
  uint32_t tickstart;

  /* Check the parameters */
  assert_param(IS_RTC_WAKEUP_CLOCK(WakeUpClock));
  assert_param(IS_RTC_WAKEUP_COUNTER(WakeUpCounter));

  /* Process Locked */
  __HAL_LOCK(hrtc);

  hrtc->State = HAL_RTC_STATE_BUSY;

  /* Disable the write protection for RTC registers */
  __HAL_RTC_WRITEPROTECTION_DISABLE(hrtc);

  /* Clear WUTE in RTC_CR to disable the wakeup timer */
  CLEAR_BIT(hrtc->Instance->CR, RTC_CR_WUTE);

  /* Poll WUTWF until it is set in RTC_ICSR to make sure the access to wakeup autoreload
     counter and to WUCKSEL[2:0] bits is allowed. This step must be skipped in
     calendar initialization mode. */
#if defined(STM32L412xx) || defined(STM32L422xx)
  if (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_INITF) == 0U)
#else
  if (READ_BIT(hrtc->Instance->ISR, RTC_ISR_INITF) == 0U)
#endif
  {
    tickstart = HAL_GetTick();
#if defined(STM32L412xx) || defined(STM32L422xx)
    while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_WUTWF) == 0U)
#else
    while (READ_BIT(hrtc->Instance->ISR, RTC_ISR_WUTWF) == 0U)
#endif
    {
      if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
      {
        /* Enable the write protection for RTC registers */
        __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);

        hrtc->State = HAL_RTC_STATE_TIMEOUT;

        /* Process Unlocked */
        __HAL_UNLOCK(hrtc);

        return HAL_TIMEOUT;
      }
    }
  }

  /* Configure the clock source */
  MODIFY_REG(hrtc->Instance->CR, RTC_CR_WUCKSEL, (uint32_t)WakeUpClock);

  /* Configure the Wakeup Timer counter */
  WRITE_REG(hrtc->Instance->WUTR, (uint32_t)WakeUpCounter);

  /* Enable the Wakeup Timer */
  SET_BIT(hrtc->Instance->CR, RTC_CR_WUTE);

  /* Enable the write protection for RTC registers */
  __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);

  hrtc->State = HAL_RTC_STATE_READY;

  /* Process Unlocked */
  __HAL_UNLOCK(hrtc);

  return HAL_OK;
}

HAL_RTCEx_SetWakeUpTimer_IT() [1/2]

HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	WakeUpCounter,
		uint32_t	WakeUpClock,
		uint32_t	WakeUpAutoClr
	)

Set wake up timer with interrupt.

Parameters

hrtc	RTC handle
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock
WakeUpAutoClr	Wake up auto clear value (look at WUTOCLR in reference manual) Only available for STM32L412xx and STM32L422xx No effect if WakeUpAutoClr is set to zero This feature is meaningful in case of Low power mode to avoid any RTC software execution after Wake Up. That is why when WakeUpAutoClr is set, EXTI is configured as EVENT instead of Interrupt to avoid useless IRQ handler execution.

Return values

HAL

status

HAL_RTCEx_SetWakeUpTimer_IT() [2/2]

HAL_StatusTypeDef HAL_RTCEx_SetWakeUpTimer_IT	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	WakeUpCounter,
		uint32_t	WakeUpClock
	)

HAL_RTCEx_WakeUpTimerEventCallback()

void HAL_RTCEx_WakeUpTimerEventCallback

(

RTC_HandleTypeDef *

hrtc

)

HAL_RTCEx_WakeUpTimerIRQHandler()

void HAL_RTCEx_WakeUpTimerIRQHandler

(

RTC_HandleTypeDef *

hrtc

)

Handle Wake Up Timer interrupt request.

Parameters

hrtc	RTC handle

Return values

None

Wake Up Timer callback.

Parameters

hrtc	RTC handle

Return values

None

Handle Wake Up Timer Polling.

Parameters

hrtc	RTC handle
Timeout	Timeout duration

Return values

HAL

status

Definition at line 956 of file stm32l4xx_hal_rtc_ex.c.

if() [1/2]

if

(

READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_INITF)

= = 0U

)

Definition at line 815 of file stm32l4xx_hal_rtc_ex.c.

  {
    tickstart = HAL_GetTick();
#if defined(STM32L412xx) || defined(STM32L422xx)
    while (READ_BIT(hrtc->Instance->ICSR, RTC_ICSR_WUTWF) == 0U)
#else
    while (READ_BIT(hrtc->Instance->ISR, RTC_ISR_WUTWF) == 0U)
#endif
    {
      if ((HAL_GetTick() - tickstart) > RTC_TIMEOUT_VALUE)
      {
        /* Enable the write protection for RTC registers */
        __HAL_RTC_WRITEPROTECTION_ENABLE(hrtc);

        hrtc->State = HAL_RTC_STATE_TIMEOUT;

        /* Process Unlocked */
        __HAL_UNLOCK(hrtc);

        return HAL_TIMEOUT;
      }
    }
  }

if() [2/2]

if

(

WakeUpAutoClr !

= 0u

)

Definition at line 855 of file stm32l4xx_hal_rtc_ex.c.

  {
    /* RTC WakeUpTimer EXTI Configuration: Event configuration */
    __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_EVENT();
  }

MODIFY_REG()

MODIFY_REG	(	hrtc->Instance->	CR,
		RTC_CR_WUCKSEL	,
		(uint32_t)	WakeUpClock
	)

Variable Documentation

else

else

Initial value:

{
    
    __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT()

Definition at line 861 of file stm32l4xx_hal_rtc_ex.c.

HAL_OK

return HAL_OK

Definition at line 885 of file stm32l4xx_hal_rtc_ex.c.

State

hrtc State = HAL_RTC_STATE_BUSY

Definition at line 800 of file stm32l4xx_hal_rtc_ex.c.

WakeUpClock

HAL_StatusTypeDef uint32_t uint32_t WakeUpClock

Initial value:

{
  uint32_t tickstart

Definition at line 786 of file stm32l4xx_hal_rtc_ex.c.

WakeUpCounter

HAL_StatusTypeDef uint32_t WakeUpCounter

Definition at line 784 of file stm32l4xx_hal_rtc_ex.c.

WUTR

hrtc Instance WUTR = (uint32_t)(WakeUpCounter | (WakeUpAutoClr << RTC_WUTR_WUTOCLR_Pos))

Definition at line 844 of file stm32l4xx_hal_rtc_ex.c.