Extended RTC Wake-up functions

RTC Wake-up functions. More...

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Set wake up timer.
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Set wake up timer with interrupt.
HAL_StatusTypeDef	HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Deactivate wake up timer counter.
uint32_t	HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Get wake up timer counter.
void	HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
	Handle 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)
	Handle 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

HAL_StatusTypeDef HAL_RTCEx_DeactivateWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Deactivate wake up timer counter.

Parameters:

hrtc	RTC handle

Return values:

HAL

status

Definition at line 2176 of file stm32h7xx_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_HandleTypeDef::Instance, RTC_FLAG_WUTWF, RTC_IT_WUT, RTC_TIMEOUT_VALUE, and __RTC_HandleTypeDef::State.

uint32_t HAL_RTCEx_GetWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Get wake up timer counter.

Parameters:

hrtc	RTC handle

Return values:

Counter

value

Definition at line 2233 of file stm32h7xx_hal_rtc_ex.c.

References __RTC_HandleTypeDef::Instance.

HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

Handle Wake Up Timer Polling.

Parameters:

hrtc	RTC handle
Timeout	Timeout duration

Return values:

HAL

status

Definition at line 2319 of file stm32h7xx_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
	)

Set wake up timer.

Parameters:

hrtc	RTC handle
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock

Return values:

HAL

status

Definition at line 1991 of file stm32h7xx_hal_rtc_ex.c.

References __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
	)

Set wake up timer with interrupt.

Parameters:

hrtc	RTC handle
WakeUpCounter	Wake up counter
WakeUpClock	Wake up clock

Return values:

HAL

status

Definition at line 2074 of file stm32h7xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_ENABLE, __HAL_RTC_WAKEUPTIMER_ENABLE_IT, __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT, __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE, __HAL_RTC_WAKEUPTIMER_GET_FLAG, __HAL_RTC_WRITEPROTECTION_DISABLE, __HAL_RTC_WRITEPROTECTION_ENABLE, assert_param, CM7_CPUID, HAL_GetCurrentCPUID(), 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_IT_WUT, RTC_TIMEOUT_VALUE, and __RTC_HandleTypeDef::State.

void HAL_RTCEx_WakeUpTimerEventCallback

(

RTC_HandleTypeDef *

hrtc

)

Wake Up Timer callback.

Parameters:

hrtc	RTC handle

Return values:

None

Definition at line 2302 of file stm32h7xx_hal_rtc_ex.c.

Referenced by HAL_RTC_Init(), HAL_RTC_UnRegisterCallback(), and HAL_RTCEx_WakeUpTimerIRQHandler().

void HAL_RTCEx_WakeUpTimerIRQHandler

(

RTC_HandleTypeDef *

hrtc

)

Handle Wake Up Timer interrupt request.

Parameters:

hrtc	RTC handle

Return values:

None

Definition at line 2244 of file stm32h7xx_hal_rtc_ex.c.

References __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG, __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG, __HAL_RTC_WAKEUPTIMER_GET_FLAG, CM7_CPUID, HAL_GetCurrentCPUID(), HAL_RTC_STATE_READY, HAL_RTCEx_WakeUpTimerEventCallback(), __RTC_HandleTypeDef::Instance, RTC_FLAG_WUTF, __RTC_HandleTypeDef::State, and __RTC_HandleTypeDef::WakeUpTimerEventCallback.