STM32F439xx HAL User Manual
Defines
RTC WakeUp Timer
RTCEx Exported Macros

Defines

#define __HAL_RTC_WAKEUPTIMER_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= (RTC_CR_WUTE))
 Enable the RTC WakeUp Timer peripheral.
#define __HAL_RTC_WAKEUPTIMER_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(RTC_CR_WUTE))
 Disable the RTC Wake-up Timer peripheral.
#define __HAL_RTC_WAKEUPTIMER_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
 Enable the RTC WakeUpTimer interrupt.
#define __HAL_RTC_WAKEUPTIMER_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
 Disable the RTC WakeUpTimer interrupt.
#define __HAL_RTC_WAKEUPTIMER_GET_IT(__HANDLE__, __INTERRUPT__)   (((((__HANDLE__)->Instance->ISR) & ((__INTERRUPT__)>> 4U)) != RESET)? SET : RESET)
 Check whether the specified RTC WakeUpTimer interrupt has occurred or not.
#define __HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   (((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != RESET) ? SET : RESET)
 Check whether the specified RTC Wake Up timer interrupt has been enabled or not.
#define __HAL_RTC_WAKEUPTIMER_GET_FLAG(__HANDLE__, __FLAG__)   (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != RESET)? SET : RESET)
 Get the selected RTC WakeUpTimer's flag status.
#define __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))
 Clear the RTC Wake Up timer's pending flags.
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_IT()   (EXTI->IMR |= RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Enable interrupt on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_IT()   (EXTI->IMR &= ~(RTC_EXTI_LINE_WAKEUPTIMER_EVENT))
 Disable interrupt on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_EVENT()   (EXTI->EMR |= RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Enable event on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_EVENT()   (EXTI->EMR &= ~(RTC_EXTI_LINE_WAKEUPTIMER_EVENT))
 Disable event on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_FALLING_EDGE()   (EXTI->FTSR |= RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Enable falling edge trigger on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_FALLING_EDGE()   (EXTI->FTSR &= ~(RTC_EXTI_LINE_WAKEUPTIMER_EVENT))
 Disable falling edge trigger on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_EDGE()   (EXTI->RTSR |= RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Enable rising edge trigger on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_EDGE()   (EXTI->RTSR &= ~(RTC_EXTI_LINE_WAKEUPTIMER_EVENT))
 Disable rising edge trigger on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_ENABLE_RISING_FALLING_EDGE()
 Enable rising & falling edge trigger on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_DISABLE_RISING_FALLING_EDGE()
 Disable rising & falling edge trigger on the RTC Wake-up Timer associated Exti line.
#define __HAL_RTC_WAKEUPTIMER_EXTI_GET_FLAG()   (EXTI->PR & RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Check whether the RTC Wake-up Timer associated Exti line interrupt flag is set or not.
#define __HAL_RTC_WAKEUPTIMER_EXTI_CLEAR_FLAG()   (EXTI->PR = RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Clear the RTC Wake-up Timer associated Exti line flag.
#define __HAL_RTC_WAKEUPTIMER_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= RTC_EXTI_LINE_WAKEUPTIMER_EVENT)
 Generate a Software interrupt on the RTC Wake-up Timer associated Exti line.

Define Documentation

#define __HAL_RTC_WAKEUPTIMER_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))

Clear the RTC Wake Up timer's pending flags.

Parameters:
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC Tamper Flag sources to be enabled or disabled. This parameter can be:
  • RTC_FLAG_WUTF
Return values:
None

Definition at line 406 of file stm32f4xx_hal_rtc_ex.h.

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

#define __HAL_RTC_WAKEUPTIMER_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR &= ~(RTC_CR_WUTE))

Disable the RTC Wake-up Timer peripheral.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 345 of file stm32f4xx_hal_rtc_ex.h.

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

#define __HAL_RTC_WAKEUPTIMER_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))

Disable the RTC WakeUpTimer interrupt.

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

Definition at line 365 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_DeactivateWakeUpTimer().

#define __HAL_RTC_WAKEUPTIMER_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= (RTC_CR_WUTE))

Enable the RTC WakeUp Timer peripheral.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 338 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

#define __HAL_RTC_WAKEUPTIMER_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))

Enable the RTC WakeUpTimer interrupt.

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

Definition at line 355 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetWakeUpTimer_IT().

Clear the RTC Wake-up Timer associated Exti line flag.

Return values:
None.

Definition at line 483 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_WakeUpTimerIRQHandler().

Disable event on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 430 of file stm32f4xx_hal_rtc_ex.h.

Disable falling edge trigger on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 442 of file stm32f4xx_hal_rtc_ex.h.

Disable interrupt on the RTC Wake-up Timer associated Exti line.

Return values:
None

Definition at line 418 of file stm32f4xx_hal_rtc_ex.h.

Disable rising edge trigger on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 454 of file 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 Wake-up Timer associated Exti line.

This parameter can be:

Return values:
None.

Definition at line 469 of file stm32f4xx_hal_rtc_ex.h.

Enable event on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 424 of file stm32f4xx_hal_rtc_ex.h.

Enable falling edge trigger on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 436 of file stm32f4xx_hal_rtc_ex.h.

Enable interrupt on the RTC Wake-up Timer associated Exti line.

Return values:
None

Definition at line 412 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_SetWakeUpTimer_IT().

Enable rising edge trigger on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 448 of file 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 Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 460 of file stm32f4xx_hal_rtc_ex.h.

Generate a Software interrupt on the RTC Wake-up Timer associated Exti line.

Return values:
None.

Definition at line 489 of file stm32f4xx_hal_rtc_ex.h.

Check whether the RTC Wake-up Timer associated Exti line interrupt flag is set or not.

Return values:
LineStatus.

Definition at line 477 of file stm32f4xx_hal_rtc_ex.h.

#define __HAL_RTC_WAKEUPTIMER_GET_FLAG (   __HANDLE__,
  __FLAG__ 
)    (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != RESET)? SET : RESET)

Get the selected RTC WakeUpTimer's flag status.

Parameters:
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC WakeUpTimer Flag to check. This parameter can be:
  • RTC_FLAG_WUTF
  • RTC_FLAG_WUTWF
Return values:
None

Definition at line 396 of file stm32f4xx_hal_rtc_ex.h.

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

#define __HAL_RTC_WAKEUPTIMER_GET_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (((((__HANDLE__)->Instance->ISR) & ((__INTERRUPT__)>> 4U)) != RESET)? SET : RESET)

Check whether the specified RTC WakeUpTimer interrupt has occurred or not.

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

Definition at line 375 of file stm32f4xx_hal_rtc_ex.h.

Referenced by HAL_RTCEx_WakeUpTimerIRQHandler().

#define __HAL_RTC_WAKEUPTIMER_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)    (((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != RESET) ? SET : RESET)

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

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

Definition at line 385 of file stm32f4xx_hal_rtc_ex.h.