STM32F439xx HAL User Manual
Defines
RTC Exported Macros
RTC

Defines

#define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
 Reset RTC handle state.
#define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__)
 Disable the write protection for RTC registers.
#define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__)
 Enable the write protection for RTC registers.
#define __HAL_RTC_ALARMA_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))
 Enable the RTC ALARMA peripheral.
#define __HAL_RTC_ALARMA_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))
 Disable the RTC ALARMA peripheral.
#define __HAL_RTC_ALARMB_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRBE))
 Enable the RTC ALARMB peripheral.
#define __HAL_RTC_ALARMB_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRBE))
 Disable the RTC ALARMB peripheral.
#define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
 Enable the RTC Alarm interrupt.
#define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
 Disable the RTC Alarm interrupt.
#define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__)   (((((__HANDLE__)->Instance->ISR)& ((__INTERRUPT__)>> 4U)) != RESET)? SET : RESET)
 Check whether the specified RTC Alarm interrupt has occurred or not.
#define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)   (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != RESET)? SET : RESET)
 Get the selected RTC Alarm's flag status.
#define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))
 Clear the RTC Alarm's pending flags.
#define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   (((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != RESET) ? SET : RESET)
 Check whether the specified RTC Alarm interrupt has been enabled or not.
#define __HAL_RTC_ALARM_EXTI_ENABLE_IT()   (EXTI->IMR |= RTC_EXTI_LINE_ALARM_EVENT)
 Enable interrupt on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_DISABLE_IT()   (EXTI->IMR &= ~(RTC_EXTI_LINE_ALARM_EVENT))
 Disable interrupt on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT()   (EXTI->EMR |= RTC_EXTI_LINE_ALARM_EVENT)
 Enable event on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT()   (EXTI->EMR &= ~(RTC_EXTI_LINE_ALARM_EVENT))
 Disable event on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE()   (EXTI->FTSR |= RTC_EXTI_LINE_ALARM_EVENT)
 Enable falling edge trigger on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE()   (EXTI->FTSR &= ~(RTC_EXTI_LINE_ALARM_EVENT))
 Disable falling edge trigger on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE()   (EXTI->RTSR |= RTC_EXTI_LINE_ALARM_EVENT)
 Enable rising edge trigger on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE()   (EXTI->RTSR &= ~(RTC_EXTI_LINE_ALARM_EVENT))
 Disable rising edge trigger on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE()
 Enable rising & falling edge trigger on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE()
 Disable rising & falling edge trigger on the RTC Alarm associated Exti line.
#define __HAL_RTC_ALARM_EXTI_GET_FLAG()   (EXTI->PR & RTC_EXTI_LINE_ALARM_EVENT)
 Check whether the RTC Alarm associated Exti line interrupt flag is set or not.
#define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG()   (EXTI->PR = RTC_EXTI_LINE_ALARM_EVENT)
 Clear the RTC Alarm associated Exti line flag.
#define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT()   (EXTI->SWIER |= RTC_EXTI_LINE_ALARM_EVENT)
 Generate a Software interrupt on RTC Alarm associated Exti line.

Define Documentation

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

Clear the RTC Alarm's pending flags.

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

Definition at line 534 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler(), HAL_RTC_PollForAlarmAEvent(), HAL_RTC_SetAlarm_IT(), and HAL_RTCEx_PollForAlarmBEvent().

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

Disable the RTC Alarm interrupt.

Parameters:
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Alarm interrupt sources to be enabled or disabled. This parameter can be any combination of the following values:
  • RTC_IT_ALRA: Alarm A interrupt
  • RTC_IT_ALRB: Alarm B interrupt
Return values:
None

Definition at line 499 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), and HAL_RTC_SetAlarm().

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

Enable the RTC Alarm interrupt.

Parameters:
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Alarm interrupt sources to be enabled or disabled. This parameter can be any combination of the following values:
  • RTC_IT_ALRA: Alarm A interrupt
  • RTC_IT_ALRB: Alarm B interrupt
Return values:
None

Definition at line 488 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

Clear the RTC Alarm associated Exti line flag.

Return values:
None.

Definition at line 622 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler().

Disable event on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 570 of file stm32f4xx_hal_rtc.h.

Disable falling edge trigger on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 582 of file stm32f4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_DISABLE_IT ( )    (EXTI->IMR &= ~(RTC_EXTI_LINE_ALARM_EVENT))

Disable interrupt on the RTC Alarm associated Exti line.

Return values:
None

Definition at line 558 of file stm32f4xx_hal_rtc.h.

Disable rising edge trigger on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 594 of file stm32f4xx_hal_rtc.h.

Value:
do { __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE();\
                                                                __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE();\
                                                              } while(0U)

Disable rising & falling edge trigger on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 608 of file stm32f4xx_hal_rtc.h.

Enable event on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 564 of file stm32f4xx_hal_rtc.h.

Enable falling edge trigger on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 576 of file stm32f4xx_hal_rtc.h.

Enable interrupt on the RTC Alarm associated Exti line.

Return values:
None

Definition at line 552 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

Enable rising edge trigger on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 588 of file stm32f4xx_hal_rtc.h.

Value:
do { __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE(); \
                                                               __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE();\
                                                             } while(0U)

Enable rising & falling edge trigger on the RTC Alarm associated Exti line.

Return values:
None.

Definition at line 600 of file stm32f4xx_hal_rtc.h.

Generate a Software interrupt on RTC Alarm associated Exti line.

Return values:
None.

Definition at line 628 of file stm32f4xx_hal_rtc.h.

Check whether the RTC Alarm associated Exti line interrupt flag is set or not.

Return values:
LineStatus.

Definition at line 616 of file stm32f4xx_hal_rtc.h.

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

Get the selected RTC Alarm's flag status.

Parameters:
__HANDLE__specifies the RTC handle.
__FLAG__specifies the RTC Alarm Flag to check. This parameter can be:
  • RTC_FLAG_ALRAF
  • RTC_FLAG_ALRBF
  • RTC_FLAG_ALRAWF
  • RTC_FLAG_ALRBWF
Return values:
None

Definition at line 523 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), HAL_RTC_PollForAlarmAEvent(), HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), and HAL_RTCEx_PollForAlarmBEvent().

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

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

Parameters:
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Alarm interrupt to check. This parameter can be:
  • RTC_IT_ALRA: Alarm A interrupt
  • RTC_IT_ALRB: Alarm B interrupt
Return values:
None

Definition at line 510 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler().

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

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

Parameters:
__HANDLE__specifies the RTC handle.
__INTERRUPT__specifies the RTC Alarm interrupt sources to check. This parameter can be:
  • RTC_IT_ALRA: Alarm A interrupt
  • RTC_IT_ALRB: Alarm B interrupt
Return values:
None

Definition at line 546 of file stm32f4xx_hal_rtc.h.

#define __HAL_RTC_ALARMA_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))

Disable the RTC ALARMA peripheral.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 463 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_ALARMA_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))

Enable the RTC ALARMA peripheral.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 456 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_ALARMB_DISABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRBE))

Disable the RTC ALARMB peripheral.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 477 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_ALARMB_ENABLE (   __HANDLE__)    ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRBE))

Enable the RTC ALARMB peripheral.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 470 of file stm32f4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_RESET_HANDLE_STATE (   __HANDLE__)    ((__HANDLE__)->State = HAL_RTC_STATE_RESET)

Reset RTC handle state.

Parameters:
__HANDLE__specifies the RTC handle.
Return values:
None

Definition at line 428 of file stm32f4xx_hal_rtc.h.

#define __HAL_RTC_WRITEPROTECTION_DISABLE (   __HANDLE__)
#define __HAL_RTC_WRITEPROTECTION_ENABLE (   __HANDLE__)