STM32F103xB HAL User Manual
Defines
RTC Exported Macros
RTC

Defines

#define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__)
 Reset RTC handle state.
#define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__)   SET_BIT((__HANDLE__)->Instance->CRL, RTC_CRL_CNF)
 Disable the write protection for RTC registers.
#define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__)   CLEAR_BIT((__HANDLE__)->Instance->CRL, RTC_CRL_CNF)
 Enable the write protection for RTC registers.
#define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)   SET_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
 Enable the RTC Alarm interrupt.
#define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)   CLEAR_BIT((__HANDLE__)->Instance->CRH, (__INTERRUPT__))
 Disable the RTC Alarm interrupt.
#define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)   ((((((__HANDLE__)->Instance->CRH)& ((__INTERRUPT__)))) != RESET)? SET : RESET)
 Check whether the specified RTC Alarm interrupt has been enabled or not.
#define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)   (((((__HANDLE__)->Instance->CRL) & (__FLAG__)) != RESET)? SET : RESET)
 Get the selected RTC Alarm's flag status.
#define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__)   (((((__HANDLE__)->Instance->CRL) & (__INTERRUPT__)) != RESET)? SET : RESET)
 Check whether the specified RTC Alarm interrupt has occurred or not.
#define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)   ((__HANDLE__)->Instance->CRL) &= ~(__FLAG__)
 Clear the RTC Alarm's pending flags.
#define __HAL_RTC_ALARM_EXTI_ENABLE_IT()   SET_BIT(EXTI->IMR, RTC_EXTI_LINE_ALARM_EVENT)
 Enable interrupt on ALARM Exti Line 17.
#define __HAL_RTC_ALARM_EXTI_DISABLE_IT()   CLEAR_BIT(EXTI->IMR, RTC_EXTI_LINE_ALARM_EVENT)
 Disable interrupt on ALARM Exti Line 17.
#define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT()   SET_BIT(EXTI->EMR, RTC_EXTI_LINE_ALARM_EVENT)
 Enable event on ALARM Exti Line 17.
#define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT()   CLEAR_BIT(EXTI->EMR, RTC_EXTI_LINE_ALARM_EVENT)
 Disable event on ALARM Exti Line 17.
#define __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE()   SET_BIT(EXTI->FTSR, RTC_EXTI_LINE_ALARM_EVENT)
 ALARM EXTI line configuration: set falling edge trigger.
#define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE()   CLEAR_BIT(EXTI->FTSR, RTC_EXTI_LINE_ALARM_EVENT)
 Disable the ALARM Extended Interrupt Falling Trigger.
#define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE()   SET_BIT(EXTI->RTSR, RTC_EXTI_LINE_ALARM_EVENT)
 ALARM EXTI line configuration: set rising edge trigger.
#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE()   CLEAR_BIT(EXTI->RTSR, RTC_EXTI_LINE_ALARM_EVENT)
 Disable the ALARM Extended Interrupt Rising Trigger.
#define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE()
 ALARM EXTI line configuration: set rising & falling edge trigger.
#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE()
 Disable the ALARM Extended Interrupt Rising & Falling Trigger.
#define __HAL_RTC_ALARM_EXTI_GET_FLAG()   (EXTI->PR & (RTC_EXTI_LINE_ALARM_EVENT))
 Check whether the specified ALARM EXTI interrupt flag is set or not.
#define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG()   (EXTI->PR = (RTC_EXTI_LINE_ALARM_EVENT))
 Clear the ALARM EXTI flag.
#define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT()   SET_BIT(EXTI->SWIER, RTC_EXTI_LINE_ALARM_EVENT)
 Generate a Software interrupt on selected EXTI line.

Define Documentation

#define __HAL_RTC_ALARM_CLEAR_FLAG (   __HANDLE__,
  __FLAG__ 
)    ((__HANDLE__)->Instance->CRL) &= ~(__FLAG__)

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
Return values:
None

Definition at line 421 of file stm32f1xx_hal_rtc.h.

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

#define __HAL_RTC_ALARM_DISABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    CLEAR_BIT((__HANDLE__)->Instance->CRH, (__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
Return values:
None

Definition at line 381 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm().

#define __HAL_RTC_ALARM_ENABLE_IT (   __HANDLE__,
  __INTERRUPT__ 
)    SET_BIT((__HANDLE__)->Instance->CRH, (__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
Return values:
None

Definition at line 371 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

Clear the ALARM EXTI flag.

Return values:
None.

Definition at line 506 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler().

#define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT ( )    CLEAR_BIT(EXTI->EMR, RTC_EXTI_LINE_ALARM_EVENT)

Disable event on ALARM Exti Line 17.

Return values:
None.

Definition at line 445 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE ( )    CLEAR_BIT(EXTI->FTSR, RTC_EXTI_LINE_ALARM_EVENT)

Disable the ALARM Extended Interrupt Falling Trigger.

Return values:
None.

Definition at line 459 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_DISABLE_IT ( )    CLEAR_BIT(EXTI->IMR, RTC_EXTI_LINE_ALARM_EVENT)

Disable interrupt on ALARM Exti Line 17.

Return values:
None.

Definition at line 433 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_DeactivateAlarm().

#define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE ( )    CLEAR_BIT(EXTI->RTSR, RTC_EXTI_LINE_ALARM_EVENT)

Disable the ALARM Extended Interrupt Rising Trigger.

This parameter can be:

Return values:
None.

Definition at line 473 of file stm32f1xx_hal_rtc.h.

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

Disable the ALARM Extended Interrupt Rising & Falling Trigger.

This parameter can be:

Return values:
None.

Definition at line 490 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT ( )    SET_BIT(EXTI->EMR, RTC_EXTI_LINE_ALARM_EVENT)

Enable event on ALARM Exti Line 17.

Return values:
None.

Definition at line 439 of file stm32f1xx_hal_rtc.h.

ALARM EXTI line configuration: set falling edge trigger.

Return values:
None.

Definition at line 452 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_ENABLE_IT ( )    SET_BIT(EXTI->IMR, RTC_EXTI_LINE_ALARM_EVENT)

Enable interrupt on ALARM Exti Line 17.

Return values:
None.

Definition at line 427 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

ALARM EXTI line configuration: set rising edge trigger.

Return values:
None.

Definition at line 466 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_SetAlarm_IT().

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

ALARM EXTI line configuration: set rising & falling edge trigger.

Return values:
None.

Definition at line 479 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT ( )    SET_BIT(EXTI->SWIER, RTC_EXTI_LINE_ALARM_EVENT)

Generate a Software interrupt on selected EXTI line.

Return values:
None.

Definition at line 512 of file stm32f1xx_hal_rtc.h.

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

Check whether the specified ALARM EXTI interrupt flag is set or not.

Return values:
EXTIALARM Line Status.

Definition at line 500 of file stm32f1xx_hal_rtc.h.

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

Get the selected RTC Alarm's flag status.

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
Return values:
None

Definition at line 401 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler(), and HAL_RTC_PollForAlarmAEvent().

#define __HAL_RTC_ALARM_GET_IT (   __HANDLE__,
  __INTERRUPT__ 
)    (((((__HANDLE__)->Instance->CRL) & (__INTERRUPT__)) != 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 sources to check. This parameter can be:
  • RTC_IT_ALRA: Alarm A interrupt
Return values:
None

Definition at line 411 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_ALARM_GET_IT_SOURCE (   __HANDLE__,
  __INTERRUPT__ 
)    ((((((__HANDLE__)->Instance->CRH)& ((__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 be checked This parameter can be:
  • RTC_IT_ALRA: Alarm A interrupt
Return values:
None

Definition at line 391 of file stm32f1xx_hal_rtc.h.

Referenced by HAL_RTC_AlarmIRQHandler().

#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 340 of file stm32f1xx_hal_rtc.h.

#define __HAL_RTC_WRITEPROTECTION_DISABLE (   __HANDLE__)    SET_BIT((__HANDLE__)->Instance->CRL, RTC_CRL_CNF)

Disable the write protection for RTC registers.

Parameters:
__HANDLE__,:specifies the RTC handle.
Return values:
None

Definition at line 354 of file stm32f1xx_hal_rtc.h.

Referenced by RTC_EnterInitMode().

#define __HAL_RTC_WRITEPROTECTION_ENABLE (   __HANDLE__)    CLEAR_BIT((__HANDLE__)->Instance->CRL, RTC_CRL_CNF)

Enable the write protection for RTC registers.

Parameters:
__HANDLE__,:specifies the RTC handle.
Return values:
None

Definition at line 361 of file stm32f1xx_hal_rtc.h.

Referenced by RTC_ExitInitMode().