Defines
#define	__HAL_RTC_RESET_HANDLE_STATE(__HANDLE__)
	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_DAYLIGHT_SAVING_TIME_ADD1H(__HANDLE__, __BKP__)
	Add 1 hour (summer time change).
#define	__HAL_RTC_DAYLIGHT_SAVING_TIME_SUB1H(__HANDLE__, __BKP__)
	Subtract 1 hour (winter time change).
#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__ >> 4)) != 0U)? 1U : 0U)
	Check whether the specified RTC Alarm interrupt has occurred or not.
#define	__HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != 0U) ? 1U : 0U)
	Check whether the specified RTC Alarm interrupt has been enabled or not.
#define	__HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U) ? 1U : 0U)
	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_EXTI_ENABLE_IT() (EXTI->IMR1 \|= RTC_EXTI_LINE_ALARM_EVENT)
	Enable interrupt on the RTC Alarm associated Exti line.
#define	__HAL_RTC_ALARM_EXTI_DISABLE_IT() (EXTI->IMR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))
	Disable interrupt on the RTC Alarm associated Exti line.
#define	__HAL_RTC_ALARM_EXTI_ENABLE_EVENT() (EXTI->EMR1 \|= RTC_EXTI_LINE_ALARM_EVENT)
	Enable event on the RTC Alarm associated Exti line.
#define	__HAL_RTC_ALARM_EXTI_DISABLE_EVENT() (EXTI->EMR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))
	Disable event on the RTC Alarm associated Exti line.
#define	__HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE() (EXTI->FTSR1 \|= 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->FTSR1 &= ~(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->RTSR1 \|= 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->RTSR1 &= ~(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->PR1 & 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->PR1 = RTC_EXTI_LINE_ALARM_EVENT)
	Clear the RTC Alarm associated Exti line flag.
#define	__HAL_RTC_ALARM_EXTI_GENERATE_SWIT() (EXTI->SWIER1 \|= 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 clear. This parameter can be: RTC_FLAG_ALRAF RTC_FLAG_ALRBF

Return values:

None

Definition at line 797 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler(), HAL_RTC_PollForAlarmAEvent(), HAL_RTC_SetAlarm(), 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 729 of file stm32l4xx_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 718 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG ( ) (EXTI->PR1 = RTC_EXTI_LINE_ALARM_EVENT)

Clear the RTC Alarm associated Exti line flag.

Return values:

None

Definition at line 876 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler().

#define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT ( ) (EXTI->EMR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))

Disable event on the RTC Alarm associated Exti line.

Return values:

None.

Definition at line 822 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE ( ) (EXTI->FTSR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))

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

Return values:

None

Definition at line 834 of file stm32l4xx_hal_rtc.h.

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

Disable interrupt on the RTC Alarm associated Exti line.

Return values:

None

Definition at line 810 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE ( ) (EXTI->RTSR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))

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

Return values:

None

Definition at line 846 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE ( )

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 861 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT ( ) (EXTI->EMR1 |= RTC_EXTI_LINE_ALARM_EVENT)

Enable event on the RTC Alarm associated Exti line.

Return values:

None.

Definition at line 816 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE ( ) (EXTI->FTSR1 |= RTC_EXTI_LINE_ALARM_EVENT)

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

Return values:

None

Definition at line 828 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_ENABLE_IT ( ) (EXTI->IMR1 |= RTC_EXTI_LINE_ALARM_EVENT)

Enable interrupt on the RTC Alarm associated Exti line.

Return values:

None

Definition at line 804 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE ( ) (EXTI->RTSR1 |= RTC_EXTI_LINE_ALARM_EVENT)

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

Return values:

None

Definition at line 840 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE ( )

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 852 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT ( ) (EXTI->SWIER1 |= RTC_EXTI_LINE_ALARM_EVENT)

Generate a Software interrupt on RTC Alarm associated Exti line.

Return values:

None

Definition at line 882 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_GET_FLAG ( ) (EXTI->PR1 & RTC_EXTI_LINE_ALARM_EVENT)

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

Return values:

Line Status.

Definition at line 870 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_GET_FLAG	(	__HANDLE__,
		__FLAG__
	)	(((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U) ? 1U : 0U)

Get the selected RTC Alarm's flag status.

Parameters:

__HANDLE__	specifies the RTC handle.
__FLAG__	specifies the RTC Alarm Flag sources to check. This parameter can be: RTC_FLAG_ALRAF RTC_FLAG_ALRBF RTC_FLAG_ALRAWF RTC_FLAG_ALRBWF

Return values:

None

Definition at line 781 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler(), 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__ >> 4)) != 0U)? 1U : 0U)

Check whether the specified RTC Alarm interrupt has occurred 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 743 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_ALARM_GET_IT_SOURCE	(	__HANDLE__,
		__INTERRUPT__
	)	(((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != 0U) ? 1U : 0U)

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 754 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler().

#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 693 of file stm32l4xx_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 686 of file stm32l4xx_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 707 of file stm32l4xx_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 700 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().

#define __HAL_RTC_DAYLIGHT_SAVING_TIME_ADD1H	(	__HANDLE__,
		__BKP__
	)

Value:

do {                                                              \
                            __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__);                \
                            SET_BIT((__HANDLE__)->Instance->CR, RTC_CR_ADD1H);            \
                            MODIFY_REG((__HANDLE__)->Instance->CR, RTC_CR_BKP , (__BKP__)); \
                            __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__);                 \
                        } while(0u);

Add 1 hour (summer time change).

Note:: This interface is deprecated. To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions

Parameters:

__HANDLE__	specifies the RTC handle.
__BKP__	Backup This parameter can be: RTC_STOREOPERATION_RESET RTC_STOREOPERATION_SET

Return values:

None

Definition at line 654 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_DAYLIGHT_SAVING_TIME_SUB1H	(	__HANDLE__,
		__BKP__
	)

Value:

do {                                                              \
                            __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__);                \
                            SET_BIT((__HANDLE__)->Instance->CR, RTC_CR_SUB1H);            \
                            MODIFY_REG((__HANDLE__)->Instance->CR, RTC_CR_BKP , (__BKP__)); \
                            __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__);                 \
                        } while(0u);

Subtract 1 hour (winter time change).

Note:: This interface is deprecated. To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions

Parameters:

__HANDLE__	specifies the RTC handle.
__BKP__	Backup This parameter can be: RTC_STOREOPERATION_RESET RTC_STOREOPERATION_SET

Return values:

None

Definition at line 673 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_RESET_HANDLE_STATE ( __HANDLE__ )

Value:

do{\
                                                      (__HANDLE__)->State = HAL_RTC_STATE_RESET;\
                                                      (__HANDLE__)->MspInitCallback = NULL;\
                                                      (__HANDLE__)->MspDeInitCallback = NULL;\
                                                     }while(0u)

Reset RTC handle state.

Parameters:

__HANDLE__ RTC handle.

Return values:

None

Definition at line 613 of file stm32l4xx_hal_rtc.h.

#define __HAL_RTC_WRITEPROTECTION_DISABLE ( __HANDLE__ )

Value:

do{                                       \
                            (__HANDLE__)->Instance->WPR = 0xCAU;   \
                            (__HANDLE__)->Instance->WPR = 0x53U;   \
                          } while(0u)

Disable the write protection for RTC registers.

Parameters:

__HANDLE__ specifies the RTC handle.

Return values:

None

Definition at line 627 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), HAL_RTC_DeInit(), HAL_RTC_DST_Add1Hour(), HAL_RTC_DST_ClearStoreOperation(), HAL_RTC_DST_SetStoreOperation(), HAL_RTC_DST_Sub1Hour(), HAL_RTC_Init(), HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), HAL_RTC_SetDate(), HAL_RTC_SetTime(), HAL_RTCEx_DeactivateCalibrationOutPut(), HAL_RTCEx_DeactivateInternalTimeStamp(), HAL_RTCEx_DeactivateRefClock(), HAL_RTCEx_DeactivateTimeStamp(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_DisableBypassShadow(), HAL_RTCEx_EnableBypassShadow(), HAL_RTCEx_SetCalibrationOutPut(), HAL_RTCEx_SetInternalTimeStamp(), HAL_RTCEx_SetRefClock(), HAL_RTCEx_SetSmoothCalib(), HAL_RTCEx_SetSynchroShift(), HAL_RTCEx_SetTimeStamp(), HAL_RTCEx_SetTimeStamp_IT(), HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

#define __HAL_RTC_WRITEPROTECTION_ENABLE ( __HANDLE__ )

Value:

do{                                       \
                            (__HANDLE__)->Instance->WPR = 0xFFU;   \
                          } while(0u)

Enable the write protection for RTC registers.

Parameters:

__HANDLE__ specifies the RTC handle.

Return values:

None

Definition at line 638 of file stm32l4xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm(), HAL_RTC_DeInit(), HAL_RTC_DST_Add1Hour(), HAL_RTC_DST_ClearStoreOperation(), HAL_RTC_DST_SetStoreOperation(), HAL_RTC_DST_Sub1Hour(), HAL_RTC_Init(), HAL_RTC_SetAlarm(), HAL_RTC_SetAlarm_IT(), HAL_RTC_SetDate(), HAL_RTC_SetTime(), HAL_RTCEx_DeactivateCalibrationOutPut(), HAL_RTCEx_DeactivateInternalTimeStamp(), HAL_RTCEx_DeactivateRefClock(), HAL_RTCEx_DeactivateTimeStamp(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_DisableBypassShadow(), HAL_RTCEx_EnableBypassShadow(), HAL_RTCEx_SetCalibrationOutPut(), HAL_RTCEx_SetInternalTimeStamp(), HAL_RTCEx_SetRefClock(), HAL_RTCEx_SetSmoothCalib(), HAL_RTCEx_SetSynchroShift(), HAL_RTCEx_SetTimeStamp(), HAL_RTCEx_SetTimeStamp_IT(), HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().

Defines

Define Documentation