RTC Exported Macros

Macros
#define	__HAL_RTC_RESET_HANDLE_STATE(__HANDLE__)   ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
	Reset RTC handle state. More...
#define	__HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__)
	Disable the write protection for RTC registers. More...
#define	__HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__)
	Enable the write protection for RTC registers. More...
#define	__HAL_RTC_IS_CALENDAR_INITIALIZED(__HANDLE__)   (((((__HANDLE__)->Instance->ISR) & (RTC_FLAG_INITS)) == RTC_FLAG_INITS) ? 1U : 0U)
	Check whether the RTC Calendar is initialized. More...
#define	__HAL_RTC_DAYLIGHT_SAVING_TIME_ADD1H(__HANDLE__, __BKP__)
	Add 1 hour (summer time change). More...
#define	__HAL_RTC_DAYLIGHT_SAVING_TIME_SUB1H(__HANDLE__, __BKP__)
	Subtract 1 hour (winter time change). More...
#define	__HAL_RTC_ALARMA_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))
	Enable the RTC ALARMA peripheral. More...
#define	__HAL_RTC_ALARMA_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))
	Disable the RTC ALARMA peripheral. More...
#define	__HAL_RTC_ALARMB_ENABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRBE))
	Enable the RTC ALARMB peripheral. More...
#define	__HAL_RTC_ALARMB_DISABLE(__HANDLE__)   ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRBE))
	Disable the RTC ALARMB peripheral. More...
#define	__HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
	Enable the RTC Alarm interrupt. More...
#define	__HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)   ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
	Disable the RTC Alarm interrupt. More...
#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. More...
#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. More...
#define	__HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)   (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U) ? 1U : 0U)
	Get the selected RTC Alarm's flag status. More...
#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. More...
#define	__HAL_RTC_ALARM_EXTI_ENABLE_IT()   (EXTI->IMR1 |= RTC_EXTI_LINE_ALARM_EVENT)
	Enable interrupt on the RTC Alarm associated Exti line. More...
#define	__HAL_RTC_ALARM_EXTI_DISABLE_IT()   (EXTI->IMR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))
	Disable interrupt on the RTC Alarm associated Exti line. More...
#define	__HAL_RTC_ALARM_EXTI_ENABLE_EVENT()   (EXTI->EMR1 |= RTC_EXTI_LINE_ALARM_EVENT)
	Enable event on the RTC Alarm associated Exti line. More...
#define	__HAL_RTC_ALARM_EXTI_DISABLE_EVENT()   (EXTI->EMR1 &= ~(RTC_EXTI_LINE_ALARM_EVENT))
	Disable event on the RTC Alarm associated Exti line. More...
#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. More...
#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. More...
#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. More...
#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. More...
#define	__HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE()
	Enable rising & falling edge trigger on the RTC Alarm associated Exti line. More...
#define	__HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE()
	Disable rising & falling edge trigger on the RTC Alarm associated Exti line. More...
#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. More...
#define	__HAL_RTC_ALARM_EXTI_CLEAR_FLAG()   (EXTI->PR1 = (RTC_EXTI_LINE_ALARM_EVENT))
	Clear the RTC Alarm associated Exti line flag. More...
#define	__HAL_RTC_ALARM_EXTI_GENERATE_SWIT()   (EXTI->SWIER1 |= RTC_EXTI_LINE_ALARM_EVENT)
	Generate a Software interrupt on RTC Alarm associated Exti line. More...

Detailed Description

Macro Definition Documentation

__HAL_RTC_ALARM_CLEAR_FLAG

#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

__HAL_RTC_ALARM_DISABLE_IT

#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

__HAL_RTC_ALARM_ENABLE_IT

#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

__HAL_RTC_ALARM_EXTI_CLEAR_FLAG

#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.

__HAL_RTC_ALARM_EXTI_DISABLE_EVENT

#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.

__HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE

#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

__HAL_RTC_ALARM_EXTI_DISABLE_IT

#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

__HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE

#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

__HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE

#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

__HAL_RTC_ALARM_EXTI_ENABLE_EVENT

#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.

__HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE

#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

__HAL_RTC_ALARM_EXTI_ENABLE_IT

#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

__HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE

#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

__HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE

#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

__HAL_RTC_ALARM_EXTI_GENERATE_SWIT

#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

__HAL_RTC_ALARM_EXTI_GET_FLAG

#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.

__HAL_RTC_ALARM_GET_FLAG

#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

__HAL_RTC_ALARM_GET_IT

#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

__HAL_RTC_ALARM_GET_IT_SOURCE

#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

__HAL_RTC_ALARMA_DISABLE

#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

__HAL_RTC_ALARMA_ENABLE

#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

__HAL_RTC_ALARMB_DISABLE

#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

__HAL_RTC_ALARMB_ENABLE

#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

__HAL_RTC_DAYLIGHT_SAVING_TIME_ADD1H

#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).

Parameters

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

Return values

None

__HAL_RTC_DAYLIGHT_SAVING_TIME_SUB1H

#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).

Parameters

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

Return values

None

__HAL_RTC_IS_CALENDAR_INITIALIZED

#define __HAL_RTC_IS_CALENDAR_INITIALIZED

(

__HANDLE__

)

(((((__HANDLE__)->Instance->ISR) & (RTC_FLAG_INITS)) == RTC_FLAG_INITS) ? 1U : 0U)

Check whether the RTC Calendar is initialized.

Parameters

__HANDLE__

specifies the RTC handle.

Return values

None

__HAL_RTC_RESET_HANDLE_STATE

#define __HAL_RTC_RESET_HANDLE_STATE

(

__HANDLE__

)

((__HANDLE__)->State = HAL_RTC_STATE_RESET)

Reset RTC handle state.

Parameters

__HANDLE__

RTC handle.

Return values

None

__HAL_RTC_WRITEPROTECTION_DISABLE

#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

__HAL_RTC_WRITEPROTECTION_ENABLE

#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