RTC Wakeup functions

RTC Wakeup functions. More...

Collaboration diagram for RTC Wakeup functions:

Functions
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wakeup timer. More...
HAL_StatusTypeDef	HAL_RTCEx_SetWakeUpTimer_IT (RTC_HandleTypeDef *hrtc, uint32_t WakeUpCounter, uint32_t WakeUpClock)
	Sets wakeup timer with interrupt. More...
HAL_StatusTypeDef	HAL_RTCEx_DeactivateWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Deactivates wakeup timer counter. More...
uint32_t	HAL_RTCEx_GetWakeUpTimer (RTC_HandleTypeDef *hrtc)
	Gets wakeup timer counter. More...
void	HAL_RTCEx_WakeUpTimerIRQHandler (RTC_HandleTypeDef *hrtc)
	Handles Wakeup Timer interrupt request. More...
void	HAL_RTCEx_WakeUpTimerEventCallback (RTC_HandleTypeDef *hrtc)
	Wakeup Timer callback. More...
HAL_StatusTypeDef	HAL_RTCEx_PollForWakeUpTimerEvent (RTC_HandleTypeDef *hrtc, uint32_t Timeout)
	Handles Wakeup Timer Polling. More...

Detailed Description

RTC Wakeup functions.

 ===============================================================================
                        ##### RTC Wakeup functions #####
 ===============================================================================

 [..] This section provides functions allowing to configure Wakeup feature

Function Documentation

HAL_RTCEx_DeactivateWakeUpTimer()

HAL_StatusTypeDef HAL_RTCEx_DeactivateWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Deactivates wakeup timer counter.

Parameters

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

Return values

HAL

status

Definition at line 1062 of file stm32f4xx_hal_rtc_ex.c.

HAL_RTCEx_GetWakeUpTimer()

uint32_t HAL_RTCEx_GetWakeUpTimer

(

RTC_HandleTypeDef *

hrtc

)

Gets wakeup timer counter.

Parameters

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

Return values

Counter

value

Definition at line 1117 of file stm32f4xx_hal_rtc_ex.c.

HAL_RTCEx_PollForWakeUpTimerEvent()

HAL_StatusTypeDef HAL_RTCEx_PollForWakeUpTimerEvent	(	RTC_HandleTypeDef *	hrtc,
		uint32_t	Timeout
	)

Handles Wakeup 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 1180 of file stm32f4xx_hal_rtc_ex.c.

HAL_RTCEx_SetWakeUpTimer()

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

Sets wakeup timer.

Parameters

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

Return values

HAL

status

Definition at line 865 of file stm32f4xx_hal_rtc_ex.c.

HAL_RTCEx_SetWakeUpTimer_IT()

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

Sets wakeup timer with interrupt.

Parameters

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

Return values

HAL

status

Definition at line 961 of file stm32f4xx_hal_rtc_ex.c.

HAL_RTCEx_WakeUpTimerEventCallback()

__weak void HAL_RTCEx_WakeUpTimerEventCallback

(

RTC_HandleTypeDef *

hrtc

)

Wakeup Timer callback.

Parameters

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

Return values

None

Definition at line 1163 of file stm32f4xx_hal_rtc_ex.c.

HAL_RTCEx_WakeUpTimerIRQHandler()

void HAL_RTCEx_WakeUpTimerIRQHandler

(

RTC_HandleTypeDef *

hrtc

)

Handles Wakeup Timer interrupt request.

Note

Unlike alarm interrupt line (shared by Alarms A and B) or tamper interrupt line (shared by timestamp and tampers) wakeup timer interrupt line is exclusive to the wakeup timer. There is no need in this case to check on the interrupt enable status via __HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE().

Parameters

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

Return values

None

Definition at line 1134 of file stm32f4xx_hal_rtc_ex.c.