RTC Wake-up functions

RTC Wake-up functions. More...

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wake up timer.
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wake up timer with interrupt.
uint32_t	HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Deactivates wake up timer counter.
uint32_t	HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Gets wake up timer counter.
void	HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
	This function handles Wake Up Timer interrupt request.
__weak void	HAL_RTCEx_WakeUpTimerEventCallback (RTC_HandleTypeDef *hrtc)
	Wake Up Timer callback.
HAL_StatusTypeDef	HAL_RTCEx_PollForWakeUpTimerEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	This function handles Wake Up Timer Polling.

---

Detailed Description

RTC Wake-up functions.

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

---

Function Documentation

uint32_t HAL_RTCEx_DeactivateWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Deactivates wake up timer counter.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

HAL

status

Definition at line 942 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_DISABLE, __HAL_RTC_WAKEUPTIMER_DISABLE_IT, __HAL_RTC_WAKEUPTIMER_GET_FLAG, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, HAL_GetTick(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_FLAG_WUTWF, RTC_IT_WUT, RTC_TIMEOUT_VALUE, and RTC_HandleTypeDef::State.

uint32_t HAL_RTCEx_GetWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Gets wake up timer counter.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

Counter

value

Definition at line 997 of file stm32f4xx_hal_rtc_ex.c.

References RTC_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

This function handles Wake Up Timer Polling.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
Timeout	Timeout duration

Return values:

HAL

status

Definition at line 1053 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG, __HAL_RTC_WAKEUPTIMER_GET_FLAG, HAL_GetTick(), HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_FLAG_WUTF, and RTC_HandleTypeDef::State.

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

Sets wake up timer.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock

Return values:

HAL

status

Definition at line 751 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_DISABLE, __HAL_RTC_WAKEUPTIMER_ENABLE, __HAL_RTC_WAKEUPTIMER_GET_FLAG, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_GetTick(), HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_HandleTypeDef::Instance, IS_RTC_WAKEUP_CLOCK, IS_RTC_WAKEUP_COUNTER, RTC_FLAG_WUTWF, RTC_TIMEOUT_VALUE, and RTC_HandleTypeDef::State.

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

Sets wake up timer with interrupt.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock

Return values:

HAL

status

Definition at line 842 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG, __HAL_RTC_WAKEUPTIMER_DISABLE, __HAL_RTC_WAKEUPTIMER_ENABLE, __HAL_RTC_WAKEUPTIMER_ENABLE_IT, __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT, __HAL_RTC_WAKEUPTIMER_GET_FLAG, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, HAL_RTC_STATE_BUSY, HAL_RTC_STATE_READY, HAL_RTC_STATE_TIMEOUT, RTC_HandleTypeDef::Instance, IS_RTC_WAKEUP_CLOCK, IS_RTC_WAKEUP_COUNTER, RTC_EXTI_LINE_WAKEUPTIMER_EVENT, RTC_FLAG_WUTF, RTC_FLAG_WUTWF, RTC_IT_WUT, RTC_TIMEOUT_VALUE, and RTC_HandleTypeDef::State.

void HAL_RTCEx_WakeUpTimerEventCallback

(

RTC_HandleTypeDef *

hrtc

)

Wake Up Timer callback.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

None

Definition at line 1037 of file stm32f4xx_hal_rtc_ex.c.

Referenced by HAL_RTCEx_WakeUpTimerIRQHandler().

void HAL_RTCEx_WakeUpTimerIRQHandler

(

RTC_HandleTypeDef *

hrtc

)

This function handles Wake Up Timer interrupt request.

Parameters:

hrtc	pointer to a RTC_HandleTypeDef structure that contains the configuration information for RTC.

Return values:

None

Definition at line 1009 of file stm32f4xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG, __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG, __HAL_RTC_WAKEUPTIMER_GET_IT, HAL_RTC_STATE_READY, HAL_RTCEx_WakeUpTimerEventCallback(), RTC_HandleTypeDef::Instance, RTC_FLAG_WUTF, RTC_IT_WUT, and RTC_HandleTypeDef::State.