STM32F4xx HAL Documentation
Hardware Abstraction Layer for STM32F4 familiy
Loading...
Searching...
No Matches
Collaboration diagram for RTCEx WakeUp Timer:

Macros

#define __HAL_RTC_WAKEUPTIMER_ENABLE(__HANDLE__)
 Enable the RTC WakeUp Timer peripheral.
 
#define __HAL_RTC_WAKEUPTIMER_DISABLE(__HANDLE__)
 Disable the RTC Wakeup Timer peripheral.
 
#define __HAL_RTC_WAKEUPTIMER_ENABLE_IT(__HANDLE__, __INTERRUPT__)
 Enable the RTC Wakeup Timer interrupt.
 
#define __HAL_RTC_WAKEUPTIMER_DISABLE_IT(__HANDLE__, __INTERRUPT__)
 Disable the RTC Wakeup Timer interrupt.
 
#define __HAL_RTC_WAKEUPTIMER_GET_IT(__HANDLE__, __INTERRUPT__)
 Check whether the specified RTC Wakeup Timer interrupt has occurred or not.
 
#define __HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)
 Check whether the specified RTC Wakeup timer interrupt has been enabled or not.
 
#define __HAL_RTC_WAKEUPTIMER_GET_FLAG(__HANDLE__, __FLAG__)
 Get the selected RTC Wakeup Timer's flag status.
 
#define __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(__HANDLE__, __FLAG__)
 Clear the RTC Wakeup timer's pending flags.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT()
 Enable interrupt on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_IT()
 Disable interrupt on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_EVENT()
 Enable event on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_EVENT()
 Disable event on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE()
 Enable falling edge trigger on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE()
 Disable falling edge trigger on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE()
 Enable rising edge trigger on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE()
 Disable rising edge trigger on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE()
 Enable rising & falling edge trigger on the RTC Wakeup Timer associated EXTI line.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE()
 Disable rising & falling edge trigger on the RTC Wakeup Timer associated EXTI line. This parameter can be:
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_GET_FLAG()
 Check whether the RTC Wakeup Timer associated EXTI line interrupt flag is set or not.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG()
 Clear the RTC Wakeup Timer associated EXTI line flag.
 
#define __HAL_RTC_WAKEUPTIMER_EXTI_GENERATE_SWIT()
 Generate a Software interrupt on the RTC Wakeup Timer associated EXTI line.
 

Detailed Description

Macro Definition Documentation

◆ __HAL_RTC_WAKEUPTIMER_ENABLE

#define __HAL_RTC_WAKEUPTIMER_ENABLE ( __HANDLE__)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->CR |= (RTC_CR_WUTE))

Enable the RTC WakeUp Timer peripheral.

Parameters
__HANDLE__specifies the RTC handle.
Return values
None

Definition at line 337 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ __HAL_RTC_WAKEUPTIMER_DISABLE

#define __HAL_RTC_WAKEUPTIMER_DISABLE ( __HANDLE__)

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->CR &= ~(RTC_CR_WUTE))

Disable the RTC Wakeup Timer peripheral.

Parameters
__HANDLE__specifies the RTC handle.
Return values
None

Definition at line 344 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ __HAL_RTC_WAKEUPTIMER_ENABLE_IT

#define __HAL_RTC_WAKEUPTIMER_ENABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->CR |= (__INTERRUPT__))

Enable the RTC Wakeup Timer interrupt.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Wakeup Timer interrupt sources to be enabled or disabled. This parameter can be:
  • RTC_IT_WUT: Wakeup Timer interrupt
Return values
None

Definition at line 354 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), HAL_ResumeTick(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ __HAL_RTC_WAKEUPTIMER_DISABLE_IT

#define __HAL_RTC_WAKEUPTIMER_DISABLE_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))

Disable the RTC Wakeup Timer interrupt.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Wakeup Timer interrupt sources to be enabled or disabled. This parameter can be:
  • RTC_IT_WUT: Wakeup Timer interrupt
Return values
None

Definition at line 364 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), HAL_RTCEx_DeactivateWakeUpTimer(), and HAL_SuspendTick().

◆ __HAL_RTC_WAKEUPTIMER_GET_IT

#define __HAL_RTC_WAKEUPTIMER_GET_IT ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((((__HANDLE__)->Instance->ISR) & ((__INTERRUPT__) >> 4U)) != 0U) ? 1U : 0U)

Check whether the specified RTC Wakeup Timer interrupt has occurred or not.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Wakeup Timer interrupt to check. This parameter can be:
  • RTC_IT_WUT: Wakeup Timer interrupt
Return values
None

Definition at line 374 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE

#define __HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE ( __HANDLE__,
__INTERRUPT__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != 0U) ? 1U : 0U)

Check whether the specified RTC Wakeup timer interrupt has been enabled or not.

Parameters
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Wakeup timer interrupt sources to check. This parameter can be:
  • RTC_IT_WUT: WakeUpTimer interrupt
Return values
None

Definition at line 384 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_GET_FLAG

#define __HAL_RTC_WAKEUPTIMER_GET_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U)? 1U : 0U)

Get the selected RTC Wakeup Timer's flag status.

Parameters
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC Wakeup Timer flag to check. This parameter can be:
  • RTC_FLAG_WUTF: Wakeup Timer interrupt flag
  • RTC_FLAG_WUTWF: Wakeup Timer 'write allowed' flag
Return values
None

Definition at line 395 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_PollForWakeUpTimerEvent(), HAL_RTCEx_SetWakeUpTimer(), HAL_RTCEx_SetWakeUpTimer_IT(), and HAL_RTCEx_WakeUpTimerIRQHandler().

◆ __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG

#define __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG ( __HANDLE__,
__FLAG__ )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))

Clear the RTC Wakeup timer's pending flags.

Parameters
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC Wakeup Timer Flag to clear. This parameter can be:
  • RTC_FLAG_WUTF: Wakeup Timer interrupt Flag
Return values
None

Definition at line 405 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), HAL_RTCEx_PollForWakeUpTimerEvent(), HAL_RTCEx_SetWakeUpTimer(), HAL_RTCEx_SetWakeUpTimer_IT(), and HAL_RTCEx_WakeUpTimerIRQHandler().

◆ __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT

#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
#define RTC_EXTI_LINE_WAKEUPTIMER_EVENT

Enable interrupt on the RTC Wakeup Timer associated EXTI line.

Return values
None

Definition at line 411 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_IT

#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_IT ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(EXTI->IMR &= ~RTC_EXTI_LINE_WAKEUPTIMER_EVENT)

Disable interrupt on the RTC Wakeup Timer associated EXTI line.

Return values
None

Definition at line 417 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_EVENT

#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_EVENT ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

Enable event on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 423 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_EVENT

#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_EVENT ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(EXTI->EMR &= ~RTC_EXTI_LINE_WAKEUPTIMER_EVENT)

Disable event on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 429 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE

#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

Enable falling edge trigger on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 435 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE

#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(EXTI->FTSR &= ~RTC_EXTI_LINE_WAKEUPTIMER_EVENT)

Disable falling edge trigger on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 441 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE

#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

Enable rising edge trigger on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 447 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_InitTick(), and HAL_RTCEx_SetWakeUpTimer_IT().

◆ __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE

#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
(EXTI->RTSR &= ~RTC_EXTI_LINE_WAKEUPTIMER_EVENT)

Disable rising edge trigger on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 453 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE

#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
do { \
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE(); \
__HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE(); \
} while(0U)

Enable rising & falling edge trigger on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 459 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE

#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:
do { \
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE(); \
__HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE(); \
} while(0U)

Disable rising & falling edge trigger on the RTC Wakeup Timer associated EXTI line. This parameter can be:

Return values
None.

Definition at line 469 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_GET_FLAG

#define __HAL_RTC_WAKEUPTIMER_EXTI_GET_FLAG ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

Check whether the RTC Wakeup Timer associated EXTI line interrupt flag is set or not.

Return values
LineStatus.

Definition at line 478 of file stm32f4xx_hal_rtc_ex.h.

◆ __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG

#define __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

Clear the RTC Wakeup Timer associated EXTI line flag.

Return values
None.

Definition at line 484 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_WakeUpTimerIRQHandler().

◆ __HAL_RTC_WAKEUPTIMER_EXTI_GENERATE_SWIT

#define __HAL_RTC_WAKEUPTIMER_EXTI_GENERATE_SWIT ( )

#include <stm32f4xx_hal_rtc_ex.h>

Value:

Generate a Software interrupt on the RTC Wakeup Timer associated EXTI line.

Return values
None.

Definition at line 490 of file stm32f4xx_hal_rtc_ex.h.