| 
    STM32F479xx HAL User Manual
   
    
   
   | 
  
  
  
 
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_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 __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.
| __HANDLE__ | specifies the RTC handle. | 
| __FLAG__ | specifies the RTC Alarm Flag sources to be enabled or disabled. This parameter can be: 
  | 
| None | 
Definition at line 570 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.
| __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: 
  | 
| None | 
Definition at line 535 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.
| __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: 
  | 
| None | 
Definition at line 524 of file stm32f4xx_hal_rtc.h.
Referenced by HAL_RTC_SetAlarm_IT().
| #define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG | ( | ) | (EXTI->PR = RTC_EXTI_LINE_ALARM_EVENT) | 
Clear the RTC Alarm associated Exti line flag.
| None. | 
Definition at line 658 of file stm32f4xx_hal_rtc.h.
Referenced by HAL_RTC_AlarmIRQHandler().
| #define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT | ( | ) | (EXTI->EMR &= ~(RTC_EXTI_LINE_ALARM_EVENT)) | 
Disable event on the RTC Alarm associated Exti line.
| None. | 
Definition at line 606 of file stm32f4xx_hal_rtc.h.
| #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.
| None. | 
Definition at line 618 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.
| None | 
Definition at line 594 of file stm32f4xx_hal_rtc.h.
| #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.
| None. | 
Definition at line 630 of file stm32f4xx_hal_rtc.h.
| #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE | ( | ) | 
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.
| None. | 
Definition at line 644 of file stm32f4xx_hal_rtc.h.
| #define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT | ( | ) | (EXTI->EMR |= RTC_EXTI_LINE_ALARM_EVENT) | 
Enable event on the RTC Alarm associated Exti line.
| None. | 
Definition at line 600 of file stm32f4xx_hal_rtc.h.
| #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.
| None. | 
Definition at line 612 of file stm32f4xx_hal_rtc.h.
| #define __HAL_RTC_ALARM_EXTI_ENABLE_IT | ( | ) | (EXTI->IMR |= RTC_EXTI_LINE_ALARM_EVENT) | 
Enable interrupt on the RTC Alarm associated Exti line.
| None | 
Definition at line 588 of file stm32f4xx_hal_rtc.h.
Referenced by HAL_RTC_SetAlarm_IT().
| #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.
| None. | 
Definition at line 624 of file stm32f4xx_hal_rtc.h.
| #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE | ( | ) | 
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.
| None. | 
Definition at line 636 of file stm32f4xx_hal_rtc.h.
| #define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT | ( | ) | (EXTI->SWIER |= RTC_EXTI_LINE_ALARM_EVENT) | 
Generate a Software interrupt on RTC Alarm associated Exti line.
| None. | 
Definition at line 664 of file stm32f4xx_hal_rtc.h.
| #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.
| Line | Status. | 
Definition at line 652 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.
| __HANDLE__ | specifies the RTC handle. | 
| __FLAG__ | specifies the RTC Alarm Flag to check. This parameter can be: 
  | 
| None | 
Definition at line 559 of file stm32f4xx_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__)>> 4U)) != RESET)? SET : RESET) | 
Check whether the specified RTC Alarm interrupt has occurred or not.
| __HANDLE__ | specifies the RTC handle. | 
| __INTERRUPT__ | specifies the RTC Alarm interrupt to check. This parameter can be: 
  | 
| None | 
Definition at line 546 of file stm32f4xx_hal_rtc.h.
| #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.
| __HANDLE__ | specifies the RTC handle. | 
| __INTERRUPT__ | specifies the RTC Alarm interrupt sources to check. This parameter can be: 
  | 
| None | 
Definition at line 582 of file stm32f4xx_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.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 499 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.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 492 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.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 513 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.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 506 of file stm32f4xx_hal_rtc.h.
Referenced by HAL_RTC_SetAlarm(), and HAL_RTC_SetAlarm_IT().
| #define __HAL_RTC_RESET_HANDLE_STATE | ( | __HANDLE__ | ) | 
do{\ (__HANDLE__)->State = HAL_RTC_STATE_RESET;\ (__HANDLE__)->MspInitCallback = NULL;\ (__HANDLE__)->MspDeInitCallback = NULL;\ }while(0u)
Reset RTC handle state.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 457 of file stm32f4xx_hal_rtc.h.
| #define __HAL_RTC_WRITEPROTECTION_DISABLE | ( | __HANDLE__ | ) | 
do{ \ (__HANDLE__)->Instance->WPR = 0xCAU; \ (__HANDLE__)->Instance->WPR = 0x53U; \ } while(0U)
Disable the write protection for RTC registers.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 471 of file stm32f4xx_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_DeactivateCoarseCalib(), HAL_RTCEx_DeactivateRefClock(), HAL_RTCEx_DeactivateTimeStamp(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_DisableBypassShadow(), HAL_RTCEx_EnableBypassShadow(), HAL_RTCEx_SetCalibrationOutPut(), HAL_RTCEx_SetCoarseCalib(), 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__ | ) | 
do{ \ (__HANDLE__)->Instance->WPR = 0xFFU; \ } while(0U)
Enable the write protection for RTC registers.
| __HANDLE__ | specifies the RTC handle. | 
| None | 
Definition at line 482 of file stm32f4xx_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_DeactivateCoarseCalib(), HAL_RTCEx_DeactivateRefClock(), HAL_RTCEx_DeactivateTimeStamp(), HAL_RTCEx_DeactivateWakeUpTimer(), HAL_RTCEx_DisableBypassShadow(), HAL_RTCEx_EnableBypassShadow(), HAL_RTCEx_SetCalibrationOutPut(), HAL_RTCEx_SetCoarseCalib(), HAL_RTCEx_SetRefClock(), HAL_RTCEx_SetSmoothCalib(), HAL_RTCEx_SetSynchroShift(), HAL_RTCEx_SetTimeStamp(), HAL_RTCEx_SetTimeStamp_IT(), HAL_RTCEx_SetWakeUpTimer(), and HAL_RTCEx_SetWakeUpTimer_IT().
 1.7.6.1