STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_hal_rtc.h
Go to the documentation of this file.
1 
19 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32F4xx_HAL_RTC_H
21 #define STM32F4xx_HAL_RTC_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 
29 #include "stm32f4xx_hal_def.h"
30 
39 /* Exported types ------------------------------------------------------------*/
40 
48 typedef enum
49 {
50  HAL_RTC_STATE_RESET = 0x00U,
51  HAL_RTC_STATE_READY = 0x01U,
52  HAL_RTC_STATE_BUSY = 0x02U,
53  HAL_RTC_STATE_TIMEOUT = 0x03U,
54  HAL_RTC_STATE_ERROR = 0x04U
55 } HAL_RTCStateTypeDef;
56 
60 typedef struct
61 {
62  uint32_t HourFormat;
65  uint32_t AsynchPrediv;
68  uint32_t SynchPrediv;
71  uint32_t OutPut;
74  uint32_t OutPutPolarity;
77  uint32_t OutPutType;
79 } RTC_InitTypeDef;
80 
84 typedef struct
85 {
86  uint8_t Hours;
90  uint8_t Minutes;
93  uint8_t Seconds;
96  uint8_t TimeFormat;
99  uint32_t SubSeconds;
103  uint32_t SecondFraction;
109  uint32_t DayLightSaving;
112  uint32_t StoreOperation;
114 } RTC_TimeTypeDef;
115 
119 typedef struct
120 {
121  uint8_t WeekDay;
124  uint8_t Month;
127  uint8_t Date;
130  uint8_t Year;
133 } RTC_DateTypeDef;
134 
138 typedef struct
139 {
140  RTC_TimeTypeDef AlarmTime;
142  uint32_t AlarmMask;
145  uint32_t AlarmSubSecondMask;
148  uint32_t AlarmDateWeekDaySel;
151  uint8_t AlarmDateWeekDay;
155  uint32_t Alarm;
157 } RTC_AlarmTypeDef;
158 
162 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
163 typedef struct __RTC_HandleTypeDef
164 #else
165 typedef struct
166 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
167 {
168  RTC_TypeDef *Instance;
170  RTC_InitTypeDef Init;
172  HAL_LockTypeDef Lock;
174  __IO HAL_RTCStateTypeDef State;
176 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
177  void (* AlarmAEventCallback) (struct __RTC_HandleTypeDef *hrtc);
179  void (* AlarmBEventCallback) (struct __RTC_HandleTypeDef *hrtc);
181  void (* TimeStampEventCallback) (struct __RTC_HandleTypeDef *hrtc);
183  void (* WakeUpTimerEventCallback) (struct __RTC_HandleTypeDef *hrtc);
185  void (* Tamper1EventCallback) (struct __RTC_HandleTypeDef *hrtc);
187 #if defined(RTC_TAMPER2_SUPPORT)
188  void (* Tamper2EventCallback) (struct __RTC_HandleTypeDef *hrtc);
189 #endif /* RTC_TAMPER2_SUPPORT */
190 
191  void (* MspInitCallback) (struct __RTC_HandleTypeDef *hrtc);
193  void (* MspDeInitCallback) (struct __RTC_HandleTypeDef *hrtc);
195 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
196 
197 } RTC_HandleTypeDef;
198 
199 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
203 typedef enum
204 {
205  HAL_RTC_ALARM_A_EVENT_CB_ID = 0x00U,
206  HAL_RTC_ALARM_B_EVENT_CB_ID = 0x01U,
207  HAL_RTC_TIMESTAMP_EVENT_CB_ID = 0x02U,
208  HAL_RTC_WAKEUPTIMER_EVENT_CB_ID = 0x03U,
209  HAL_RTC_TAMPER1_EVENT_CB_ID = 0x04U,
210 #if defined(RTC_TAMPER2_SUPPORT)
211  HAL_RTC_TAMPER2_EVENT_CB_ID = 0x05U,
212 #endif /* RTC_TAMPER2_SUPPORT */
213  HAL_RTC_MSPINIT_CB_ID = 0x0EU,
214  HAL_RTC_MSPDEINIT_CB_ID = 0x0FU
215 } HAL_RTC_CallbackIDTypeDef;
216 
220 typedef void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc);
221 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
222 
227 /* Exported constants --------------------------------------------------------*/
228 
236 #define RTC_HOURFORMAT_24 0x00000000U
237 #define RTC_HOURFORMAT_12 RTC_CR_FMT
245 #define RTC_OUTPUT_DISABLE 0x00000000U
246 #define RTC_OUTPUT_ALARMA RTC_CR_OSEL_0
247 #define RTC_OUTPUT_ALARMB RTC_CR_OSEL_1
248 #define RTC_OUTPUT_WAKEUP RTC_CR_OSEL
256 #define RTC_OUTPUT_POLARITY_HIGH 0x00000000U
257 #define RTC_OUTPUT_POLARITY_LOW RTC_CR_POL
265 #define RTC_OUTPUT_TYPE_OPENDRAIN 0x00000000U
266 #define RTC_OUTPUT_TYPE_PUSHPULL RTC_TAFCR_ALARMOUTTYPE
274 #define RTC_HOURFORMAT12_AM ((uint8_t)0x00)
275 #define RTC_HOURFORMAT12_PM ((uint8_t)0x01)
283 #define RTC_DAYLIGHTSAVING_SUB1H RTC_CR_SUB1H
284 #define RTC_DAYLIGHTSAVING_ADD1H RTC_CR_ADD1H
285 #define RTC_DAYLIGHTSAVING_NONE 0x00000000U
293 #define RTC_STOREOPERATION_RESET 0x00000000U
294 #define RTC_STOREOPERATION_SET RTC_CR_BKP
302 #define RTC_FORMAT_BIN 0x00000000U
303 #define RTC_FORMAT_BCD 0x00000001U
311 #define RTC_MONTH_JANUARY ((uint8_t)0x01)
312 #define RTC_MONTH_FEBRUARY ((uint8_t)0x02)
313 #define RTC_MONTH_MARCH ((uint8_t)0x03)
314 #define RTC_MONTH_APRIL ((uint8_t)0x04)
315 #define RTC_MONTH_MAY ((uint8_t)0x05)
316 #define RTC_MONTH_JUNE ((uint8_t)0x06)
317 #define RTC_MONTH_JULY ((uint8_t)0x07)
318 #define RTC_MONTH_AUGUST ((uint8_t)0x08)
319 #define RTC_MONTH_SEPTEMBER ((uint8_t)0x09)
320 #define RTC_MONTH_OCTOBER ((uint8_t)0x10)
321 #define RTC_MONTH_NOVEMBER ((uint8_t)0x11)
322 #define RTC_MONTH_DECEMBER ((uint8_t)0x12)
330 #define RTC_WEEKDAY_MONDAY ((uint8_t)0x01)
331 #define RTC_WEEKDAY_TUESDAY ((uint8_t)0x02)
332 #define RTC_WEEKDAY_WEDNESDAY ((uint8_t)0x03)
333 #define RTC_WEEKDAY_THURSDAY ((uint8_t)0x04)
334 #define RTC_WEEKDAY_FRIDAY ((uint8_t)0x05)
335 #define RTC_WEEKDAY_SATURDAY ((uint8_t)0x06)
336 #define RTC_WEEKDAY_SUNDAY ((uint8_t)0x07)
344 #define RTC_ALARMDATEWEEKDAYSEL_DATE 0x00000000U
345 #define RTC_ALARMDATEWEEKDAYSEL_WEEKDAY RTC_ALRMAR_WDSEL
353 #define RTC_ALARMMASK_NONE 0x00000000U
354 #define RTC_ALARMMASK_DATEWEEKDAY RTC_ALRMAR_MSK4
355 #define RTC_ALARMMASK_HOURS RTC_ALRMAR_MSK3
356 #define RTC_ALARMMASK_MINUTES RTC_ALRMAR_MSK2
357 #define RTC_ALARMMASK_SECONDS RTC_ALRMAR_MSK1
358 #define RTC_ALARMMASK_ALL (RTC_ALARMMASK_DATEWEEKDAY | \
359  RTC_ALARMMASK_HOURS | \
360  RTC_ALARMMASK_MINUTES | \
361  RTC_ALARMMASK_SECONDS)
369 #define RTC_ALARM_A RTC_CR_ALRAE
370 #define RTC_ALARM_B RTC_CR_ALRBE
379 #define RTC_ALARMSUBSECONDMASK_ALL 0x00000000U
381 #define RTC_ALARMSUBSECONDMASK_SS14_1 RTC_ALRMASSR_MASKSS_0
383 #define RTC_ALARMSUBSECONDMASK_SS14_2 RTC_ALRMASSR_MASKSS_1
385 #define RTC_ALARMSUBSECONDMASK_SS14_3 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1)
387 #define RTC_ALARMSUBSECONDMASK_SS14_4 RTC_ALRMASSR_MASKSS_2
389 #define RTC_ALARMSUBSECONDMASK_SS14_5 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2)
391 #define RTC_ALARMSUBSECONDMASK_SS14_6 (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2)
393 #define RTC_ALARMSUBSECONDMASK_SS14_7 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2)
395 #define RTC_ALARMSUBSECONDMASK_SS14_8 RTC_ALRMASSR_MASKSS_3
397 #define RTC_ALARMSUBSECONDMASK_SS14_9 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_3)
399 #define RTC_ALARMSUBSECONDMASK_SS14_10 (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3)
401 #define RTC_ALARMSUBSECONDMASK_SS14_11 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3)
403 #define RTC_ALARMSUBSECONDMASK_SS14_12 (RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)
405 #define RTC_ALARMSUBSECONDMASK_SS14_13 (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)
407 #define RTC_ALARMSUBSECONDMASK_SS14 (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)
409 #define RTC_ALARMSUBSECONDMASK_NONE RTC_ALRMASSR_MASKSS
417 #define RTC_IT_TS RTC_CR_TSIE
418 #define RTC_IT_WUT RTC_CR_WUTIE
419 #define RTC_IT_ALRB RTC_CR_ALRBIE
420 #define RTC_IT_ALRA RTC_CR_ALRAIE
428 #define RTC_FLAG_RECALPF RTC_ISR_RECALPF
429 #if defined(RTC_TAMPER2_SUPPORT)
430 #define RTC_FLAG_TAMP2F RTC_ISR_TAMP2F
431 #endif /* RTC_TAMPER2_SUPPORT */
432 #define RTC_FLAG_TAMP1F RTC_ISR_TAMP1F
433 #define RTC_FLAG_TSOVF RTC_ISR_TSOVF
434 #define RTC_FLAG_TSF RTC_ISR_TSF
435 #define RTC_FLAG_WUTF RTC_ISR_WUTF
436 #define RTC_FLAG_ALRBF RTC_ISR_ALRBF
437 #define RTC_FLAG_ALRAF RTC_ISR_ALRAF
438 #define RTC_FLAG_INITF RTC_ISR_INITF
439 #define RTC_FLAG_RSF RTC_ISR_RSF
440 #define RTC_FLAG_INITS RTC_ISR_INITS
441 #define RTC_FLAG_SHPF RTC_ISR_SHPF
442 #define RTC_FLAG_WUTWF RTC_ISR_WUTWF
443 #define RTC_FLAG_ALRBWF RTC_ISR_ALRBWF
444 #define RTC_FLAG_ALRAWF RTC_ISR_ALRAWF
453 /* Exported macros -----------------------------------------------------------*/
454 
463 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
464 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) do { \
465  (__HANDLE__)->State = HAL_RTC_STATE_RESET; \
466  (__HANDLE__)->MspInitCallback = NULL; \
467  (__HANDLE__)->MspDeInitCallback = NULL; \
468  } while(0U)
469 #else
470 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
471 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
472 
478 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__) do { \
479  (__HANDLE__)->Instance->WPR = 0xCAU; \
480  (__HANDLE__)->Instance->WPR = 0x53U; \
481  } while(0U)
482 
488 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__) do { \
489  (__HANDLE__)->Instance->WPR = 0xFFU; \
490  } while(0U)
491 
497 #define __HAL_RTC_IS_CALENDAR_INITIALIZED(__HANDLE__) (((((__HANDLE__)->Instance->ISR) & (RTC_FLAG_INITS)) == RTC_FLAG_INITS) ? 1U : 0U)
498 
504 #define __HAL_RTC_ALARMA_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))
505 
511 #define __HAL_RTC_ALARMA_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))
512 
518 #define __HAL_RTC_ALARMB_ENABLE(__HANDLE__) ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRBE))
519 
525 #define __HAL_RTC_ALARMB_DISABLE(__HANDLE__) ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRBE))
526 
536 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
537 
547 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__) ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
548 
558 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__) (((((__HANDLE__)->Instance->ISR) & ((__INTERRUPT__) >> 4U)) != 0U) ? 1U : 0U)
559 
571 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__) (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U) ? 1U : 0U)
572 
582 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__) ((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))
583 
593 #define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__) (((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != 0U) ? 1U : 0U)
594 
599 #define __HAL_RTC_ALARM_EXTI_ENABLE_IT() (EXTI->IMR |= RTC_EXTI_LINE_ALARM_EVENT)
600 
605 #define __HAL_RTC_ALARM_EXTI_DISABLE_IT() (EXTI->IMR &= ~RTC_EXTI_LINE_ALARM_EVENT)
606 
611 #define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT() (EXTI->EMR |= RTC_EXTI_LINE_ALARM_EVENT)
612 
617 #define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT() (EXTI->EMR &= ~RTC_EXTI_LINE_ALARM_EVENT)
618 
623 #define __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE() (EXTI->FTSR |= RTC_EXTI_LINE_ALARM_EVENT)
624 
629 #define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE() (EXTI->FTSR &= ~RTC_EXTI_LINE_ALARM_EVENT)
630 
635 #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE() (EXTI->RTSR |= RTC_EXTI_LINE_ALARM_EVENT)
636 
641 #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE() (EXTI->RTSR &= ~RTC_EXTI_LINE_ALARM_EVENT)
642 
647 #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE() do { \
648  __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE(); \
649  __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE(); \
650  } while(0U)
651 
656 #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE() do { \
657  __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE(); \
658  __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE(); \
659  } while(0U)
660 
665 #define __HAL_RTC_ALARM_EXTI_GET_FLAG() (EXTI->PR & RTC_EXTI_LINE_ALARM_EVENT)
666 
671 #define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG() (EXTI->PR = RTC_EXTI_LINE_ALARM_EVENT)
672 
677 #define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT() (EXTI->SWIER |= RTC_EXTI_LINE_ALARM_EVENT)
682 /* Include RTC HAL Extended module */
683 #include "stm32f4xx_hal_rtc_ex.h"
684 
685 /* Exported functions --------------------------------------------------------*/
686 
694 /* Initialization and de-initialization functions ****************************/
695 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);
696 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc);
697 void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc);
698 void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc);
699 
700 /* Callbacks Register/UnRegister functions ***********************************/
701 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
702 HAL_StatusTypeDef HAL_RTC_RegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback);
703 HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID);
704 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
712 /* RTC Time and Date functions ************************************************/
713 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
714 HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
715 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
716 HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
724 /* RTC Alarm functions ********************************************************/
725 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
726 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
727 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm);
728 HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format);
729 void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc);
730 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout);
731 void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc);
739 /* Peripheral Control functions ***********************************************/
740 HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc);
741 
742 /* RTC Daylight Saving Time functions *****************************************/
743 void HAL_RTC_DST_Add1Hour(RTC_HandleTypeDef *hrtc);
744 void HAL_RTC_DST_Sub1Hour(RTC_HandleTypeDef *hrtc);
745 void HAL_RTC_DST_SetStoreOperation(RTC_HandleTypeDef *hrtc);
746 void HAL_RTC_DST_ClearStoreOperation(RTC_HandleTypeDef *hrtc);
747 uint32_t HAL_RTC_DST_ReadStoreOperation(RTC_HandleTypeDef *hrtc);
755 /* Peripheral State functions *************************************************/
756 HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc);
765 /* Private types -------------------------------------------------------------*/
766 /* Private variables ---------------------------------------------------------*/
767 /* Private constants ---------------------------------------------------------*/
768 
772 /* Masks Definition */
773 #define RTC_TR_RESERVED_MASK ((uint32_t)(RTC_TR_HT | RTC_TR_HU | \
774  RTC_TR_MNT | RTC_TR_MNU | \
775  RTC_TR_ST | RTC_TR_SU | \
776  RTC_TR_PM))
777 #define RTC_DR_RESERVED_MASK ((uint32_t)(RTC_DR_YT | RTC_DR_YU | \
778  RTC_DR_MT | RTC_DR_MU | \
779  RTC_DR_DT | RTC_DR_DU | \
780  RTC_DR_WDU))
781 #define RTC_ISR_RESERVED_MASK ((uint32_t)(RTC_FLAGS_MASK | RTC_ISR_INIT))
782 #define RTC_INIT_MASK 0xFFFFFFFFU
783 #define RTC_RSF_MASK ((uint32_t)~(RTC_ISR_INIT | RTC_ISR_RSF))
784 #define RTC_FLAGS_MASK ((uint32_t)(RTC_FLAG_INITF | RTC_FLAG_INITS | \
785  RTC_FLAG_ALRAF | RTC_FLAG_ALRAWF | \
786  RTC_FLAG_ALRBF | RTC_FLAG_ALRBWF | \
787  RTC_FLAG_WUTF | RTC_FLAG_WUTWF | \
788  RTC_FLAG_RECALPF | RTC_FLAG_SHPF | \
789  RTC_FLAG_TSF | RTC_FLAG_TSOVF | \
790  RTC_FLAG_RSF | RTC_TAMPER_FLAGS_MASK))
791 
792 #define RTC_TIMEOUT_VALUE 1000U
793 
794 #define RTC_EXTI_LINE_ALARM_EVENT EXTI_IMR_MR17
799 /* Private macros ------------------------------------------------------------*/
800 
808 #define IS_RTC_HOUR_FORMAT(FORMAT) (((FORMAT) == RTC_HOURFORMAT_12) || \
809  ((FORMAT) == RTC_HOURFORMAT_24))
810 
811 #define IS_RTC_OUTPUT(OUTPUT) (((OUTPUT) == RTC_OUTPUT_DISABLE) || \
812  ((OUTPUT) == RTC_OUTPUT_ALARMA) || \
813  ((OUTPUT) == RTC_OUTPUT_ALARMB) || \
814  ((OUTPUT) == RTC_OUTPUT_WAKEUP))
815 
816 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \
817  ((POL) == RTC_OUTPUT_POLARITY_LOW))
818 
819 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \
820  ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL))
821 
822 #define IS_RTC_ASYNCH_PREDIV(PREDIV) ((PREDIV) <= 0x7FU)
823 #define IS_RTC_SYNCH_PREDIV(PREDIV) ((PREDIV) <= 0x7FFFU)
824 
825 #define IS_RTC_HOUR12(HOUR) (((HOUR) > 0U) && ((HOUR) <= 12U))
826 #define IS_RTC_HOUR24(HOUR) ((HOUR) <= 23U)
827 #define IS_RTC_MINUTES(MINUTES) ((MINUTES) <= 59U)
828 #define IS_RTC_SECONDS(SECONDS) ((SECONDS) <= 59U)
829 
830 #define IS_RTC_HOURFORMAT12(PM) (((PM) == RTC_HOURFORMAT12_AM) || \
831  ((PM) == RTC_HOURFORMAT12_PM))
832 
833 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \
834  ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \
835  ((SAVE) == RTC_DAYLIGHTSAVING_NONE))
836 
837 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_STOREOPERATION_RESET) || \
838  ((OPERATION) == RTC_STOREOPERATION_SET))
839 
840 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_FORMAT_BIN) || ((FORMAT) == RTC_FORMAT_BCD))
841 
842 #define IS_RTC_YEAR(YEAR) ((YEAR) <= 99U)
843 #define IS_RTC_MONTH(MONTH) (((MONTH) >= 1U) && ((MONTH) <= 12U))
844 #define IS_RTC_DATE(DATE) (((DATE) >= 1U) && ((DATE) <= 31U))
845 
846 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY) || \
847  ((WEEKDAY) == RTC_WEEKDAY_TUESDAY) || \
848  ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
849  ((WEEKDAY) == RTC_WEEKDAY_THURSDAY) || \
850  ((WEEKDAY) == RTC_WEEKDAY_FRIDAY) || \
851  ((WEEKDAY) == RTC_WEEKDAY_SATURDAY) || \
852  ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
853 
854 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) > 0U) && ((DATE) <= 31U))
855 
856 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY) || \
857  ((WEEKDAY) == RTC_WEEKDAY_TUESDAY) || \
858  ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
859  ((WEEKDAY) == RTC_WEEKDAY_THURSDAY) || \
860  ((WEEKDAY) == RTC_WEEKDAY_FRIDAY) || \
861  ((WEEKDAY) == RTC_WEEKDAY_SATURDAY) || \
862  ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
863 
864 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \
865  ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY))
866 
867 #define IS_RTC_ALARM_MASK(MASK) (((MASK) & ((uint32_t)~RTC_ALARMMASK_ALL)) == 0U)
868 
869 #define IS_RTC_ALARM(ALARM) (((ALARM) == RTC_ALARM_A) || ((ALARM) == RTC_ALARM_B))
870 
871 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= RTC_ALRMASSR_SS)
872 
873 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK) (((MASK) == RTC_ALARMSUBSECONDMASK_ALL) || \
874  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_1) || \
875  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_2) || \
876  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_3) || \
877  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_4) || \
878  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_5) || \
879  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_6) || \
880  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_7) || \
881  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_8) || \
882  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_9) || \
883  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_10) || \
884  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_11) || \
885  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_12) || \
886  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_13) || \
887  ((MASK) == RTC_ALARMSUBSECONDMASK_SS14) || \
888  ((MASK) == RTC_ALARMSUBSECONDMASK_NONE))
897 /* Private functions ---------------------------------------------------------*/
898 
902 HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc);
903 HAL_StatusTypeDef RTC_ExitInitMode(RTC_HandleTypeDef *hrtc);
904 uint8_t RTC_ByteToBcd2(uint8_t number);
905 uint8_t RTC_Bcd2ToByte(uint8_t number);
918 #ifdef __cplusplus
919 }
920 #endif
921 
922 #endif /* STM32F4xx_HAL_RTC_H */
endif::Init
RTC_InitTypeDef Init
Definition: stm32f4xx_hal_rtc.h:170
endif::Instance
RTC_TypeDef * Instance
Definition: stm32f4xx_hal_rtc.h:168
endif::State
__IO HAL_RTCStateTypeDef State
Definition: stm32f4xx_hal_rtc.h:174
endif
ADC handle Structure definition.
Definition: stm32f4xx_hal_adc.h:197
HAL_RTC_DeInit
HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc)
DeInitializes the RTC peripheral.
Definition: stm32f4xx_hal_rtc.c:363
HAL_RTC_MspDeInit
void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc)
DeInitializes the RTC MSP.
Definition: stm32f4xx_hal_rtc.c:657
HAL_RTC_Init
HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc)
Initializes the RTC peripheral.
Definition: stm32f4xx_hal_rtc.c:249
HAL_RTC_MspInit
void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc)
Initializes the RTC MSP.
Definition: stm32f4xx_hal_rtc.c:641
HAL_RTC_UnRegisterCallback
HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID)
Unregisters an RTC Callback RTC callback is redirected to the weak predefined callback.
Definition: stm32f4xx_hal_rtc.c:553
HAL_RTC_RegisterCallback
HAL_StatusTypeDef HAL_RTC_RegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback)
Registers a User RTC Callback To be used instead of the weak predefined callback.
Definition: stm32f4xx_hal_rtc.c:449
HAL_RTC_GetDate
HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
Gets RTC current date.
Definition: stm32f4xx_hal_rtc.c:946
HAL_RTC_SetDate
HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format)
Sets RTC current date.
Definition: stm32f4xx_hal_rtc.c:857
HAL_RTC_GetTime
HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
Gets RTC current time.
Definition: stm32f4xx_hal_rtc.c:812
HAL_RTC_SetTime
HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format)
Sets RTC current time.
Definition: stm32f4xx_hal_rtc.c:698
HAL_RTC_AlarmAEventCallback
void HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc)
Alarm A callback.
Definition: stm32f4xx_hal_rtc.c:1595
HAL_RTC_DeactivateAlarm
HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm)
Deactivates the specified RTC Alarm.
Definition: stm32f4xx_hal_rtc.c:1395
HAL_RTC_GetAlarm
HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format)
Gets the RTC Alarm value and masks.
Definition: stm32f4xx_hal_rtc.c:1493
HAL_RTC_SetAlarm_IT
HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
Sets the specified RTC Alarm with Interrupt.
Definition: stm32f4xx_hal_rtc.c:1201
HAL_RTC_AlarmIRQHandler
void HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc)
Handles Alarm interrupt request.
Definition: stm32f4xx_hal_rtc.c:1544
HAL_RTC_PollForAlarmAEvent
HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout)
Handles Alarm A Polling request.
Definition: stm32f4xx_hal_rtc.c:1612
HAL_RTC_SetAlarm
HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format)
Sets the specified RTC Alarm.
Definition: stm32f4xx_hal_rtc.c:1004
HAL_RTC_DST_Add1Hour
void HAL_RTC_DST_Add1Hour(RTC_HandleTypeDef *hrtc)
Daylight Saving Time, adds one hour to the calendar in one single operation without going through the...
Definition: stm32f4xx_hal_rtc.c:1705
HAL_RTC_WaitForSynchro
HAL_StatusTypeDef HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc)
Waits until the RTC Time and Date registers (RTC_TR and RTC_DR) are synchronized with RTC APB clock.
Definition: stm32f4xx_hal_rtc.c:1676
HAL_RTC_DST_Sub1Hour
void HAL_RTC_DST_Sub1Hour(RTC_HandleTypeDef *hrtc)
Daylight Saving Time, subtracts one hour from the calendar in one single operation without going thro...
Definition: stm32f4xx_hal_rtc.c:1719
HAL_RTC_DST_ReadStoreOperation
uint32_t HAL_RTC_DST_ReadStoreOperation(RTC_HandleTypeDef *hrtc)
Daylight Saving Time, reads the store operation bit.
Definition: stm32f4xx_hal_rtc.c:1758
HAL_RTC_DST_ClearStoreOperation
void HAL_RTC_DST_ClearStoreOperation(RTC_HandleTypeDef *hrtc)
Daylight Saving Time, clears the store operation bit.
Definition: stm32f4xx_hal_rtc.c:1746
HAL_RTC_DST_SetStoreOperation
void HAL_RTC_DST_SetStoreOperation(RTC_HandleTypeDef *hrtc)
Daylight Saving Time, sets the store operation bit.
Definition: stm32f4xx_hal_rtc.c:1733
HAL_RTC_GetState
HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc)
Returns the RTC state.
Definition: stm32f4xx_hal_rtc.c:1787
RTC_AlarmTypeDef::AlarmDateWeekDay
uint8_t AlarmDateWeekDay
Definition: stm32f4xx_hal_rtc.h:151
RTC_InitTypeDef::OutPutPolarity
uint32_t OutPutPolarity
Definition: stm32f4xx_hal_rtc.h:74
RTC_AlarmTypeDef::AlarmTime
RTC_TimeTypeDef AlarmTime
Definition: stm32f4xx_hal_rtc.h:140
RTC_DateTypeDef::Year
uint8_t Year
Definition: stm32f4xx_hal_rtc.h:130
RTC_TimeTypeDef::Seconds
uint8_t Seconds
Definition: stm32f4xx_hal_rtc.h:93
RTC_InitTypeDef::OutPutType
uint32_t OutPutType
Definition: stm32f4xx_hal_rtc.h:77
RTC_AlarmTypeDef::Alarm
uint32_t Alarm
Definition: stm32f4xx_hal_rtc.h:155
RTC_TimeTypeDef::Minutes
uint8_t Minutes
Definition: stm32f4xx_hal_rtc.h:90
RTC_AlarmTypeDef::AlarmDateWeekDaySel
uint32_t AlarmDateWeekDaySel
Definition: stm32f4xx_hal_rtc.h:148
RTC_DateTypeDef::Month
uint8_t Month
Definition: stm32f4xx_hal_rtc.h:124
RTC_DateTypeDef::Date
uint8_t Date
Definition: stm32f4xx_hal_rtc.h:127
RTC_AlarmTypeDef::AlarmMask
uint32_t AlarmMask
Definition: stm32f4xx_hal_rtc.h:142
RTC_TimeTypeDef::TimeFormat
uint8_t TimeFormat
Definition: stm32f4xx_hal_rtc.h:96
RTC_TimeTypeDef::StoreOperation
uint32_t StoreOperation
Definition: stm32f4xx_hal_rtc.h:112
RTC_InitTypeDef::AsynchPrediv
uint32_t AsynchPrediv
Definition: stm32f4xx_hal_rtc.h:65
RTC_InitTypeDef::HourFormat
uint32_t HourFormat
Definition: stm32f4xx_hal_rtc.h:62
RTC_AlarmTypeDef::AlarmSubSecondMask
uint32_t AlarmSubSecondMask
Definition: stm32f4xx_hal_rtc.h:145
RTC_TimeTypeDef::SecondFraction
uint32_t SecondFraction
Definition: stm32f4xx_hal_rtc.h:103
RTC_InitTypeDef::SynchPrediv
uint32_t SynchPrediv
Definition: stm32f4xx_hal_rtc.h:68
RTC_TimeTypeDef::DayLightSaving
uint32_t DayLightSaving
Definition: stm32f4xx_hal_rtc.h:109
RTC_InitTypeDef::OutPut
uint32_t OutPut
Definition: stm32f4xx_hal_rtc.h:71
RTC_TimeTypeDef::SubSeconds
uint32_t SubSeconds
Definition: stm32f4xx_hal_rtc.h:99
RTC_TimeTypeDef::Hours
uint8_t Hours
Definition: stm32f4xx_hal_rtc.h:86
RTC_DateTypeDef::WeekDay
uint8_t WeekDay
Definition: stm32f4xx_hal_rtc.h:121
HAL_RTCStateTypeDef
HAL_RTCStateTypeDef
HAL State structures definition.
Definition: stm32f4xx_hal_rtc.h:49
RTC_HandleTypeDef
struct __RTC_HandleTypeDef else typedef struct endif RTC_HandleTypeDef
RTC Handle Structure definition.
pRTC_CallbackTypeDef
void(* pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc)
HAL RTC Callback pointer definition.
Definition: stm32f4xx_hal_rtc.h:220
HAL_RTC_CallbackIDTypeDef
HAL_RTC_CallbackIDTypeDef
HAL RTC Callback ID enumeration definition.
Definition: stm32f4xx_hal_rtc.h:204
HAL_RTC_STATE_TIMEOUT
@ HAL_RTC_STATE_TIMEOUT
Definition: stm32f4xx_hal_rtc.h:53
HAL_RTC_STATE_ERROR
@ HAL_RTC_STATE_ERROR
Definition: stm32f4xx_hal_rtc.h:54
HAL_RTC_STATE_READY
@ HAL_RTC_STATE_READY
Definition: stm32f4xx_hal_rtc.h:51
HAL_RTC_STATE_BUSY
@ HAL_RTC_STATE_BUSY
Definition: stm32f4xx_hal_rtc.h:52
HAL_RTC_STATE_RESET
@ HAL_RTC_STATE_RESET
Definition: stm32f4xx_hal_rtc.h:50
HAL_RTC_MSPINIT_CB_ID
@ HAL_RTC_MSPINIT_CB_ID
Definition: stm32f4xx_hal_rtc.h:213
HAL_RTC_ALARM_B_EVENT_CB_ID
@ HAL_RTC_ALARM_B_EVENT_CB_ID
Definition: stm32f4xx_hal_rtc.h:206
HAL_RTC_TAMPER2_EVENT_CB_ID
@ HAL_RTC_TAMPER2_EVENT_CB_ID
Definition: stm32f4xx_hal_rtc.h:211
HAL_RTC_WAKEUPTIMER_EVENT_CB_ID
@ HAL_RTC_WAKEUPTIMER_EVENT_CB_ID
Definition: stm32f4xx_hal_rtc.h:208
HAL_RTC_ALARM_A_EVENT_CB_ID
@ HAL_RTC_ALARM_A_EVENT_CB_ID
Definition: stm32f4xx_hal_rtc.h:205
HAL_RTC_MSPDEINIT_CB_ID
@ HAL_RTC_MSPDEINIT_CB_ID
Definition: stm32f4xx_hal_rtc.h:214
HAL_RTC_TIMESTAMP_EVENT_CB_ID
@ HAL_RTC_TIMESTAMP_EVENT_CB_ID
Definition: stm32f4xx_hal_rtc.h:207
HAL_RTC_TAMPER1_EVENT_CB_ID
@ HAL_RTC_TAMPER1_EVENT_CB_ID
Definition: stm32f4xx_hal_rtc.h:209
RTC_AlarmTypeDef
RTC Alarm structure definition.
Definition: stm32f4xx_hal_rtc.h:139
RTC_DateTypeDef
RTC Date structure definition.
Definition: stm32f4xx_hal_rtc.h:120
RTC_InitTypeDef
RTC Configuration Structure definition.
Definition: stm32f4xx_hal_rtc.h:61
RTC_TimeTypeDef
RTC Time structure definition.
Definition: stm32f4xx_hal_rtc.h:85
RTC_ByteToBcd2
uint8_t RTC_ByteToBcd2(uint8_t number)
Converts a 2-digit number from decimal to BCD format.
Definition: stm32f4xx_hal_rtc.c:1874
RTC_ExitInitMode
HAL_StatusTypeDef RTC_ExitInitMode(RTC_HandleTypeDef *hrtc)
Exits the RTC Initialization mode.
Definition: stm32f4xx_hal_rtc.c:1848
RTC_EnterInitMode
HAL_StatusTypeDef RTC_EnterInitMode(RTC_HandleTypeDef *hrtc)
Enters the RTC Initialization mode.
Definition: stm32f4xx_hal_rtc.c:1813
RTC_Bcd2ToByte
uint8_t RTC_Bcd2ToByte(uint8_t number)
Converts a 2-digit number from BCD to decimal format.
Definition: stm32f4xx_hal_rtc.c:1892
stm32f4xx_hal_def.h
This file contains HAL common defines, enumeration, macros and structures definitions.
HAL_LockTypeDef
HAL_LockTypeDef
HAL Lock structures definition
Definition: stm32f4xx_hal_def.h:50
stm32f4xx_hal_rtc_ex.h
Header file of RTC HAL Extended module.