1 /**
2   ******************************************************************************
3   * @file    stm32h7rsxx_hal_rtc.h
4   * @author  MCD Application Team
5   * @brief   Header file of RTC HAL module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2022 STMicroelectronics.
10   * All rights reserved.
11   *
12   * This software is licensed under terms that can be found in the LICENSE file
13   * in the root directory of this software component.
14   * If no LICENSE file comes with this software, it is provided AS-IS.
15   *
16   ******************************************************************************
17   */
18 
19 /* Define to prevent recursive inclusion -------------------------------------*/
20 #ifndef STM32H7RSxx_HAL_RTC_H
21 #define STM32H7RSxx_HAL_RTC_H
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
27 /* Includes ------------------------------------------------------------------*/
28 #include "stm32h7rsxx_hal_def.h"
29 
30 /** @addtogroup STM32H7RSxx_HAL_Driver
31   * @{
32   */
33 
34 /** @defgroup RTC RTC
35   * @{
36   */
37 
38 /* Exported types ------------------------------------------------------------*/
39 /** @defgroup RTC_Exported_Types RTC Exported Types
40   * @{
41   */
42 
43 /**
44   * @brief  HAL State structures definition
45   */
46 typedef enum
47 {
48   HAL_RTC_STATE_RESET             = 0x00U,  /*!< RTC not yet initialized or disabled */
49   HAL_RTC_STATE_READY             = 0x01U,  /*!< RTC initialized and ready for use   */
50   HAL_RTC_STATE_BUSY              = 0x02U,  /*!< RTC process is ongoing              */
51   HAL_RTC_STATE_TIMEOUT           = 0x03U,  /*!< RTC timeout state                   */
52   HAL_RTC_STATE_ERROR             = 0x04U   /*!< RTC error state                     */
53 
54 } HAL_RTCStateTypeDef;
55 
56 /**
57   * @brief  RTC Configuration Structure definition
58   */
59 typedef struct
60 {
61   uint32_t HourFormat;        /*!< Specifies the RTC Hour Format.
62                                  This parameter can be a value of @ref RTC_Hour_Formats */
63 
64   uint32_t AsynchPrediv;      /*!< Specifies the RTC Asynchronous Predivider value.
65                                  This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7F */
66 
67   uint32_t SynchPrediv;       /*!< Specifies the RTC Synchronous Predivider value.
68                                  This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7FFF */
69 
70   uint32_t OutPut;            /*!< Specifies which signal will be routed to the RTC output.
71                                  This parameter can be a value of @ref RTCEx_Output_selection_Definitions */
72 
73   uint32_t OutPutRemap;       /*!< Specifies the remap for RTC output.
74                                  This parameter can be a value of @ref  RTC_Output_ALARM_OUT_Remap */
75 
76   uint32_t OutPutPolarity;    /*!< Specifies the polarity of the output signal.
77                                  This parameter can be a value of @ref RTC_Output_Polarity_Definitions */
78 
79   uint32_t OutPutType;        /*!< Specifies the RTC Output Pin mode.
80                                  This parameter can be a value of @ref RTC_Output_Type_ALARM_OUT */
81 
82   uint32_t OutPutPullUp;      /*!< Specifies the RTC Output Pull-Up mode.
83                                  This parameter can be a value of @ref RTC_Output_PullUp_ALARM_OUT */
84 
85   uint32_t BinMode;           /*!< Specifies the RTC binary mode.
86                                  This parameter can be a value of @ref RTCEx_Binary_Mode */
87 
88   uint32_t BinMixBcdU;        /*!< Specifies the BCD calendar update if and only if BinMode = RTC_BINARY_MIX.
89                                  This parameter can be a value of @ref RTCEx_Binary_mix_BCDU */
90 } RTC_InitTypeDef;
91 
92 /**
93   * @brief  RTC Time structure definition
94   */
95 typedef struct
96 {
97   uint8_t Hours;            /*!< Specifies the RTC Time Hour.
98                                  This parameter must be a number between:
99                                  Min_Data = 0 and Max_Data = 12 if the RTC_HOURFORMAT_12 is selected.
100                                  This parameter must be a number between:
101                                  Min_Data = 0 and Max_Data = 23 if the RTC_HOURFORMAT_24 is selected */
102 
103   uint8_t Minutes;          /*!< Specifies the RTC Time Minutes.
104                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
105 
106   uint8_t Seconds;          /*!< Specifies the RTC Time Seconds.
107                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
108 
109   uint8_t TimeFormat;       /*!< Specifies the RTC AM/PM Time.
110                                  This parameter can be a value of @ref RTC_AM_PM_Definitions */
111 
112   uint32_t SubSeconds;      /*!< Specifies the RTC_SSR RTC Sub Second register content.
113                                  This field is not used by HAL_RTC_SetTime.
114                                  If the free running 32 bit counter is not activated (mode binary none)
115                                     - This parameter corresponds to a time unit range
116                                  between [0-1] Second with [1 Sec / SecondFraction +1] granularity
117                                  else
118                                     - This parameter corresponds to the free running 32 bit counter. */
119 
120   uint32_t SecondFraction;  /*!< Specifies the range or granularity of Sub Second register content
121                                  corresponding to Synchronous pre-scaler factor value (PREDIV_S)
122                                  This parameter corresponds to a time unit range between [0-1] Second
123                                  with [1 Sec / SecondFraction +1] granularity.
124                                  This field will be used only by HAL_RTC_GetTime function */
125 
126   uint32_t DayLightSaving;  /*!< This interface is deprecated.
127                                  To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions */
128 
129   uint32_t StoreOperation;  /*!< This interface is deprecated.
130                                  To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions */
131 } RTC_TimeTypeDef;
132 
133 /**
134   * @brief  RTC Date structure definition
135   */
136 typedef struct
137 {
138   uint8_t WeekDay;  /*!< Specifies the RTC Date WeekDay.
139                          This parameter can be a value of @ref RTC_WeekDay_Definitions */
140 
141   uint8_t Month;    /*!< Specifies the RTC Date Month (in BCD format).
142                          This parameter can be a value of @ref RTC_Month_Date_Definitions */
143 
144   uint8_t Date;     /*!< Specifies the RTC Date.
145                          This parameter must be a number between Min_Data = 1 and Max_Data = 31 */
146 
147   uint8_t Year;     /*!< Specifies the RTC Date Year.
148                          This parameter must be a number between Min_Data = 0 and Max_Data = 99 */
149 } RTC_DateTypeDef;
150 
151 /**
152   * @brief  RTC Alarm structure definition
153   */
154 typedef struct
155 {
156   RTC_TimeTypeDef AlarmTime;     /*!< Specifies the RTC Alarm Time members */
157 
158   uint32_t AlarmMask;            /*!< Specifies the RTC Alarm Masks.
159                                       This parameter can be a value of @ref RTC_AlarmMask_Definitions */
160 
161   uint32_t AlarmSubSecondMask;   /*!< Specifies the RTC Alarm SubSeconds Masks.
162                                       if Binary mode is RTC_BINARY_ONLY or is RTC_BINARY_MIX
163                                         This parameter can be a value of
164                                         @ref RTCEx_Alarm_Sub_Seconds_binary_Masks_Definitions
165                                       else if Binary mode is RTC_BINARY_NONE
166                                         This parameter can be a value of
167                                         @ref RTC_Alarm_Sub_Seconds_BCD_Masks_Definitions */
168 
169   uint32_t BinaryAutoClr;        /*!< Clear synchronously counter (RTC_SSR) on binary alarm.
170                                       RTC_ALARMSUBSECONDBIN_AUTOCLR_YES must only be used if Binary mode
171                                        is RTC_BINARY_ONLY
172                                       This parameter can be a value of
173                                       @ref RTCEx_Alarm_Sub_Seconds_binary_Clear_Definitions */
174 
175   uint32_t AlarmDateWeekDaySel;  /*!< Specifies the RTC Alarm is on Date or WeekDay.
176                                      This parameter can be a value of @ref RTC_AlarmDateWeekDay_Definitions */
177 
178   uint8_t AlarmDateWeekDay;      /*!< Specifies the RTC Alarm Date/WeekDay.
179                                       If the Alarm Date is selected, this parameter must be set to a value
180                                        in the 1-31 range.
181                                       If the Alarm WeekDay is selected, this parameter can be a value of
182                                       @ref RTC_WeekDay_Definitions */
183 
184   uint32_t FlagAutoClr;          /*!< Specifies the alarm trigger generation. This feature is meaningful
185                                       to avoid any RTC software execution after configuration.
186                                       This parameter can be a value of @ref RTC_ALARM_Flag_AutoClear_Definitions */
187 
188   uint32_t Alarm;                /*!< Specifies the alarm.
189                                       This parameter can be a value of @ref RTC_Alarms_Definitions */
190 } RTC_AlarmTypeDef;
191 
192 /**
193   * @brief  RTC Handle Structure definition
194   */
195 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
196 typedef struct __RTC_HandleTypeDef
197 #else
198 typedef struct
199 #endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */
200 {
201   RTC_TypeDef               *Instance;  /*!< Legacy register base address. Not used anymore, the driver directly uses cmsis base address */
202 
203   RTC_InitTypeDef           Init;       /*!< RTC required parameters  */
204 
205   HAL_LockTypeDef           Lock;       /*!< RTC locking object       */
206 
207   __IO HAL_RTCStateTypeDef  State;      /*!< Time communication state */
208 
209 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
210   void (* AlarmAEventCallback)(struct __RTC_HandleTypeDef *hrtc);            /*!< RTC Alarm A Event callback            */
211   void (* AlarmBEventCallback)(struct __RTC_HandleTypeDef *hrtc);            /*!< RTC Alarm B Event callback            */
212   void (* TimeStampEventCallback)(struct __RTC_HandleTypeDef *hrtc);         /*!< RTC TimeStamp Event callback          */
213   void (* WakeUpTimerEventCallback)(struct __RTC_HandleTypeDef *hrtc);       /*!< RTC WakeUpTimer Event callback        */
214   void (* SSRUEventCallback)(struct __RTC_HandleTypeDef *hrtc);              /*!< RTC SSRU Event callback               */
215   void (* Tamper1EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 1 Event callback           */
216   void (* Tamper2EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 2 Event callback           */
217   void (* Tamper3EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 3 Event callback           */
218   void (* Tamper4EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 4 Event callback           */
219   void (* Tamper5EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 5 Event callback           */
220   void (* Tamper6EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 6 Event callback           */
221   void (* Tamper7EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 7 Event callback           */
222   void (* Tamper8EventCallback)(struct __RTC_HandleTypeDef *hrtc);           /*!< RTC Tamper 8 Event callback           */
223   void (* InternalTamper1EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 1 Event callback  */
224   void (* InternalTamper2EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 2 Event callback  */
225   void (* InternalTamper3EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 3 Event callback  */
226   void (* InternalTamper4EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 4 Event callback  */
227   void (* InternalTamper5EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 5 Event callback  */
228   void (* InternalTamper6EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 6 Event callback  */
229   void (* InternalTamper7EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 7 Event callback  */
230   void (* InternalTamper8EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 8 Event callback  */
231   void (* InternalTamper9EventCallback)(struct __RTC_HandleTypeDef *hrtc);   /*!< RTC Internal Tamper 9 Event callback  */
232   void (* InternalTamper11EventCallback)(struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Internal Tamper 11 Event callback */
233   void (* InternalTamper15EventCallback)(struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Internal Tamper 15 Event callback */
234   void (* MspInitCallback)(struct __RTC_HandleTypeDef *hrtc);                /*!< RTC Msp Init callback                 */
235   void (* MspDeInitCallback)(struct __RTC_HandleTypeDef *hrtc);              /*!< RTC Msp DeInit callback               */
236 
237 #endif /* (USE_HAL_RTC_REGISTER_CALLBACKS) */
238 
239 } RTC_HandleTypeDef;
240 
241 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
242 /**
243   * @brief  HAL RTC Callback ID enumeration definition
244   */
245 typedef enum
246 {
247   HAL_RTC_ALARM_A_EVENT_CB_ID           = 0U,   /*!< RTC Alarm A Event Callback ID      */
248   HAL_RTC_ALARM_B_EVENT_CB_ID           = 1U,   /*!< RTC Alarm B Event Callback ID      */
249   HAL_RTC_TIMESTAMP_EVENT_CB_ID         = 2U,   /*!< RTC TimeStamp Event Callback ID    */
250   HAL_RTC_WAKEUPTIMER_EVENT_CB_ID       = 3U,   /*!< RTC WakeUp Timer Event Callback ID */
251   HAL_RTC_SSRU_EVENT_CB_ID              = 4U,   /*!< RTC SSRU Event Callback ID         */
252   HAL_RTC_TAMPER1_EVENT_CB_ID           = 5U,   /*!< RTC Tamper 1 Callback ID           */
253   HAL_RTC_TAMPER2_EVENT_CB_ID           = 6U,   /*!< RTC Tamper 2 Callback ID           */
254   HAL_RTC_TAMPER3_EVENT_CB_ID           = 7U,   /*!< RTC Tamper 3 Callback ID           */
255   HAL_RTC_TAMPER4_EVENT_CB_ID           = 8U,   /*!< RTC Tamper 4 Callback ID           */
256   HAL_RTC_TAMPER5_EVENT_CB_ID           = 9U,   /*!< RTC Tamper 5 Callback ID           */
257   HAL_RTC_TAMPER6_EVENT_CB_ID           = 10U,  /*!< RTC Tamper 6 Callback ID           */
258   HAL_RTC_TAMPER7_EVENT_CB_ID           = 11U,  /*!< RTC Tamper 7 Callback ID           */
259   HAL_RTC_TAMPER8_EVENT_CB_ID           = 12U,  /*!< RTC Tamper 8 Callback ID           */
260   HAL_RTC_INTERNAL_TAMPER1_EVENT_CB_ID  = 13U,  /*!< RTC Internal Tamper 1 Callback ID  */
261   HAL_RTC_INTERNAL_TAMPER2_EVENT_CB_ID  = 14U,  /*!< RTC Internal Tamper 2 Callback ID  */
262   HAL_RTC_INTERNAL_TAMPER3_EVENT_CB_ID  = 15U,  /*!< RTC Internal Tamper 3 Callback ID  */
263   HAL_RTC_INTERNAL_TAMPER4_EVENT_CB_ID  = 16U,  /*!< RTC Internal Tamper 4 Callback ID  */
264   HAL_RTC_INTERNAL_TAMPER5_EVENT_CB_ID  = 17U,  /*!< RTC Internal Tamper 5 Callback ID  */
265   HAL_RTC_INTERNAL_TAMPER6_EVENT_CB_ID  = 18U,  /*!< RTC Internal Tamper 6 Callback ID  */
266   HAL_RTC_INTERNAL_TAMPER7_EVENT_CB_ID  = 19U,  /*!< RTC Internal Tamper 7 Callback ID  */
267   HAL_RTC_INTERNAL_TAMPER8_EVENT_CB_ID  = 20U,  /*!< RTC Internal Tamper 8 Callback ID  */
268   HAL_RTC_INTERNAL_TAMPER9_EVENT_CB_ID  = 21U,  /*!< RTC Internal Tamper 9 Callback ID  */
269   HAL_RTC_INTERNAL_TAMPER11_EVENT_CB_ID = 22U,  /*!< RTC Internal Tamper 11 Callback ID */
270   HAL_RTC_INTERNAL_TAMPER15_EVENT_CB_ID = 23U,  /*!< RTC Internal Tamper 15 Callback ID */
271   HAL_RTC_MSPINIT_CB_ID                 = 24U,  /*!< RTC Msp Init callback ID           */
272   HAL_RTC_MSPDEINIT_CB_ID               = 25U   /*!< RTC Msp DeInit callback ID         */
273 } HAL_RTC_CallbackIDTypeDef;
274 
275 /**
276   * @brief  HAL RTC Callback pointer definition
277   */
278 typedef  void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc);  /*!< pointer to an RTC callback function */
279 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
280 
281 /**
282   * @}
283   */
284 
285 /* Exported constants --------------------------------------------------------*/
286 /** @defgroup RTC_Exported_Constants RTC Exported Constants
287   * @{
288   */
289 
290 /** @defgroup RTC_Hour_Formats RTC Hour Formats
291   * @{
292   */
293 #define RTC_HOURFORMAT_24                   0U
294 #define RTC_HOURFORMAT_12                   RTC_CR_FMT
295 /**
296   * @}
297   */
298 
299 /** @defgroup RTCEx_Output_selection_Definitions RTCEx Output Selection Definition
300   * @{
301   */
302 #define RTC_OUTPUT_DISABLE                  0U
303 #define RTC_OUTPUT_ALARMA                   RTC_CR_OSEL_0
304 #define RTC_OUTPUT_ALARMB                   RTC_CR_OSEL_1
305 #define RTC_OUTPUT_WAKEUP                   RTC_CR_OSEL
306 #define RTC_OUTPUT_TAMPER                   RTC_CR_TAMPOE
307 /**
308   * @}
309   */
310 
311 /** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions
312   * @{
313   */
314 #define RTC_OUTPUT_POLARITY_HIGH            0U
315 #define RTC_OUTPUT_POLARITY_LOW             RTC_CR_POL
316 /**
317   * @}
318   */
319 
320 /** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT
321   * @{
322   */
323 #define RTC_OUTPUT_TYPE_PUSHPULL            0U
324 #define RTC_OUTPUT_TYPE_OPENDRAIN           RTC_CR_TAMPALRM_TYPE
325 /**
326   * @}
327   */
328 
329 /** @defgroup RTC_Output_PullUp_ALARM_OUT RTC Output Pull-Up ALARM OUT
330   * @{
331   */
332 #define RTC_OUTPUT_PULLUP_NONE              0U
333 #define RTC_OUTPUT_PULLUP_ON                RTC_CR_TAMPALRM_PU
334 /**
335   * @}
336   */
337 
338 #if defined(RTC_CR_OUT2EN)
339 /** @defgroup RTC_Output_ALARM_OUT_Remap RTC Output ALARM OUT Remap
340   * @{
341   */
342 #define RTC_OUTPUT_REMAP_NONE               0U
343 #define RTC_OUTPUT_REMAP_POS1               RTC_CR_OUT2EN
344 /**
345   * @}
346   */
347 #endif /* RTC_CR_OUT2EN */
348 
349 /** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions
350   * @{
351   */
352 #define RTC_HOURFORMAT12_AM                 0U
353 #define RTC_HOURFORMAT12_PM                 1U
354 /**
355   * @}
356   */
357 
358 /** @defgroup RTC_DayLightSaving_Definitions RTC DayLightSaving Definitions
359   * @{
360   */
361 #define RTC_DAYLIGHTSAVING_SUB1H            RTC_CR_SUB1H
362 #define RTC_DAYLIGHTSAVING_ADD1H            RTC_CR_ADD1H
363 #define RTC_DAYLIGHTSAVING_NONE             0U
364 /**
365   * @}
366   */
367 
368 /** @defgroup RTC_StoreOperation_Definitions RTC StoreOperation Definitions
369   * @{
370   */
371 #define RTC_STOREOPERATION_RESET            0U
372 #define RTC_STOREOPERATION_SET              RTC_CR_BKP
373 /**
374   * @}
375   */
376 
377 /** @defgroup RTC_Input_parameter_format_definitions RTC Input Parameter Format Definitions
378   * @{
379   */
380 #define RTC_FORMAT_BIN                      0U
381 #define RTC_FORMAT_BCD                      1U
382 /**
383   * @}
384   */
385 
386 /** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions
387   * @{
388   */
389 
390 /* Coded in BCD format */
391 #define RTC_MONTH_JANUARY                   ((uint8_t)0x01U)
392 #define RTC_MONTH_FEBRUARY                  ((uint8_t)0x02U)
393 #define RTC_MONTH_MARCH                     ((uint8_t)0x03U)
394 #define RTC_MONTH_APRIL                     ((uint8_t)0x04U)
395 #define RTC_MONTH_MAY                       ((uint8_t)0x05U)
396 #define RTC_MONTH_JUNE                      ((uint8_t)0x06U)
397 #define RTC_MONTH_JULY                      ((uint8_t)0x07U)
398 #define RTC_MONTH_AUGUST                    ((uint8_t)0x08U)
399 #define RTC_MONTH_SEPTEMBER                 ((uint8_t)0x09U)
400 #define RTC_MONTH_OCTOBER                   ((uint8_t)0x10U)
401 #define RTC_MONTH_NOVEMBER                  ((uint8_t)0x11U)
402 #define RTC_MONTH_DECEMBER                  ((uint8_t)0x12U)
403 
404 /**
405   * @}
406   */
407 
408 /** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions
409   * @{
410   */
411 #define RTC_WEEKDAY_MONDAY                  ((uint8_t)0x01U)
412 #define RTC_WEEKDAY_TUESDAY                 ((uint8_t)0x02U)
413 #define RTC_WEEKDAY_WEDNESDAY               ((uint8_t)0x03U)
414 #define RTC_WEEKDAY_THURSDAY                ((uint8_t)0x04U)
415 #define RTC_WEEKDAY_FRIDAY                  ((uint8_t)0x05U)
416 #define RTC_WEEKDAY_SATURDAY                ((uint8_t)0x06U)
417 #define RTC_WEEKDAY_SUNDAY                  ((uint8_t)0x07U)
418 
419 /**
420   * @}
421   */
422 
423 /** @defgroup RTC_AlarmDateWeekDay_Definitions RTC AlarmDateWeekDay Definitions
424   * @{
425   */
426 #define RTC_ALARMDATEWEEKDAYSEL_DATE        0U
427 #define RTC_ALARMDATEWEEKDAYSEL_WEEKDAY     RTC_ALRMAR_WDSEL
428 
429 /**
430   * @}
431   */
432 
433 /** @defgroup RTC_AlarmMask_Definitions RTC AlarmMask Definitions
434   * @{
435   */
436 #define RTC_ALARMMASK_NONE                  0U
437 #define RTC_ALARMMASK_DATEWEEKDAY           RTC_ALRMAR_MSK4
438 #define RTC_ALARMMASK_HOURS                 RTC_ALRMAR_MSK3
439 #define RTC_ALARMMASK_MINUTES               RTC_ALRMAR_MSK2
440 #define RTC_ALARMMASK_SECONDS               RTC_ALRMAR_MSK1
441 #define RTC_ALARMMASK_ALL                   (RTC_ALARMMASK_DATEWEEKDAY | RTC_ALARMMASK_HOURS  | \
442                                              RTC_ALARMMASK_MINUTES | RTC_ALARMMASK_SECONDS)
443 
444 /**
445   * @}
446   */
447 
448 /** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions
449   * @{
450   */
451 #define RTC_ALARM_A                         RTC_CR_ALRAE
452 #define RTC_ALARM_B                         RTC_CR_ALRBE
453 
454 /**
455   * @}
456   */
457 /** @defgroup RTC_ALARM_Flag_AutoClear_Definitions RTC Alarms Flag Auto Clear Definitions
458   * @{
459   */
460 #define ALARM_FLAG_AUTOCLR_ENABLE           1U
461 #define ALARM_FLAG_AUTOCLR_DISABLE          0U
462 /**
463   * @}
464   */
465 
466 /** @defgroup RTC_Alarm_Sub_Seconds_BCD_Masks_Definitions RTC Alarm Sub Seconds BCD Masks Definitions
467   *           In BCD mode (BIN=00) the overflow bits of the synchronous counter (bits 31:15) are never compared.
468   * @{
469   */
470 #define RTC_ALARMSUBSECONDMASK_ALL          0U                                                                       /*!< All Alarm SS fields are masked. There is no comparison on sub seconds for Alarm */
471 #define RTC_ALARMSUBSECONDMASK_SS14_1       RTC_ALRMASSR_MASKSS_0                                                    /*!< SS[14:1] not used in Alarmcomparison. Only SS[0] is compared                    */
472 #define RTC_ALARMSUBSECONDMASK_SS14_2       RTC_ALRMASSR_MASKSS_1                                                    /*!< SS[14:2] not used in Alarm comparison. Only SS[1:0] are compared                */
473 #define RTC_ALARMSUBSECONDMASK_SS14_3       (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1)                          /*!< SS[14:3] not used in Alarm comparison. Only SS[2:0] are compared                */
474 #define RTC_ALARMSUBSECONDMASK_SS14_4       RTC_ALRMASSR_MASKSS_2                                                    /*!< SS[14:4] not used in Alarm comparison. Only SS[3:0] are compared                */
475 #define RTC_ALARMSUBSECONDMASK_SS14_5       (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2)                          /*!< SS[14:5] not used in Alarm comparison. Only SS[4:0] are compared                */
476 #define RTC_ALARMSUBSECONDMASK_SS14_6       (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2)                          /*!< SS[14:6] not used in Alarm comparison. Only SS[5:0] are compared                */
477 #define RTC_ALARMSUBSECONDMASK_SS14_7       (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2)  /*!< SS[14:7] not used in Alarm comparison. Only SS[6:0] are compared                */
478 #define RTC_ALARMSUBSECONDMASK_SS14_8       RTC_ALRMASSR_MASKSS_3                                                    /*!< SS[14:8] not used in Alarm comparison. Only SS[7:0] are compared                */
479 #define RTC_ALARMSUBSECONDMASK_SS14_9       (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_3)                          /*!< SS[14:9] not used in Alarm comparison. Only SS[8:0] are compared                */
480 #define RTC_ALARMSUBSECONDMASK_SS14_10      (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3)                          /*!< SS[14:10] not used in Alarm comparison. Only SS[9:0] are compared               */
481 #define RTC_ALARMSUBSECONDMASK_SS14_11      (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3)  /*!< SS[14:11] not used in Alarm comparison. Only SS[10:0] are compared              */
482 #define RTC_ALARMSUBSECONDMASK_SS14_12      (RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)                          /*!< SS[14:12] not used in Alarm comparison.Only SS[11:0] are compared               */
483 #define RTC_ALARMSUBSECONDMASK_SS14_13      (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)  /*!< SS[14:13] not used in Alarm comparison. Only SS[12:0] are compared              */
484 #define RTC_ALARMSUBSECONDMASK_SS14         (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)  /*!< SS[14] not used in Alarm comparison. Only SS[13:0] are compared                 */
485 #define RTC_ALARMSUBSECONDMASK_NONE         RTC_ALRMASSR_MASKSS                                                      /*!< SS[14:0] are compared and must match to activate alarm                          */
486 /**
487   * @}
488   */
489 
490 /** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions
491   * @{
492   */
493 #define RTC_IT_TS                           RTC_CR_TSIE        /*!< Enable Timestamp Interrupt     */
494 #define RTC_IT_WUT                          RTC_CR_WUTIE       /*!< Enable Wakeup timer Interrupt  */
495 #define RTC_IT_SSRU                         RTC_CR_SSRUIE      /*!< Enable SSR Underflow Interrupt */
496 #define RTC_IT_ALRA                         RTC_CR_ALRAIE      /*!< Enable Alarm A Interrupt       */
497 #define RTC_IT_ALRB                         RTC_CR_ALRBIE      /*!< Enable Alarm B Interrupt       */
498 /**
499   * @}
500   */
501 
502 /** @defgroup RTC_Flags_Definitions RTC Flags Definitions
503   * @{
504   */
505 #define RTC_FLAG_RECALPF                    (1U)               /*!< Recalibration pending flag     */
506 #define RTC_FLAG_INITF                      (2U)               /*!< Initialization flag            */
507 #define RTC_FLAG_RSF                        (3U)               /*!< Registers synchronization flag */
508 #define RTC_FLAG_INITS                      (4U)               /*!< Initialization status flag     */
509 #define RTC_FLAG_SHPF                       (5U)               /*!< Shift operation pending flag   */
510 #define RTC_FLAG_WUTWF                      (6U)               /*!< Wakeup timer write flag        */
511 #define RTC_FLAG_SSRUF                      (7U)               /*!< SSR underflow flag             */
512 #define RTC_FLAG_ITSF                       (8U)               /*!< Internal Time-stamp flag       */
513 #define RTC_FLAG_TSOVF                      (9U)               /*!< Time-stamp overflow flag       */
514 #define RTC_FLAG_TSF                        (10U)              /*!< Time-stamp flag                */
515 #define RTC_FLAG_WUTF                       (11U)              /*!< Wakeup timer flag              */
516 #define RTC_FLAG_ALRBF                      (12U)              /*!< Alarm B flag                   */
517 #define RTC_FLAG_ALRAF                      (13U)              /*!< Alarm A flag                   */
518 /**
519   * @}
520   */
521 
522 /** @defgroup RTC_Clear_Flags_Definitions RTC Clear Flags Definitions
523   * @{
524   */
525 #define RTC_CLEAR_SSRUF                     RTC_SCR_CSSRUF   /*!< Clear SSR underflow flag       */
526 #define RTC_CLEAR_ITSF                      RTC_SCR_CITSF    /*!< Clear Internal Time-stamp flag */
527 #define RTC_CLEAR_TSOVF                     RTC_SCR_CTSOVF   /*!< Clear Time-stamp overflow flag */
528 #define RTC_CLEAR_TSF                       RTC_SCR_CTSF     /*!< Clear Time-stamp flag          */
529 #define RTC_CLEAR_WUTF                      RTC_SCR_CWUTF    /*!< Clear Wakeup timer flag        */
530 #define RTC_CLEAR_ALRBF                     RTC_SCR_CALRBF   /*!< Clear Alarm B flag             */
531 #define RTC_CLEAR_ALRAF                     RTC_SCR_CALRAF   /*!< Clear Alarm A flag             */
532 /**
533   * @}
534   */
535 
536 /**
537   * @}
538   */
539 
540 /* Exported macros -----------------------------------------------------------*/
541 /** @defgroup RTC_Exported_Macros RTC Exported Macros
542   * @{
543   */
544 
545 /** @brief Reset RTC handle state
546   * @param  __HANDLE__ RTC handle.
547   * @retval None
548   */
549 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
550 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) do{\
551                                                       (__HANDLE__)->State = HAL_RTC_STATE_RESET;\
552                                                       (__HANDLE__)->MspInitCallback = NULL;\
553                                                       (__HANDLE__)->MspDeInitCallback = NULL;\
554                                                      }while(0)
555 #else
556 #define __HAL_RTC_RESET_HANDLE_STATE(__HANDLE__) ((__HANDLE__)->State = HAL_RTC_STATE_RESET)
557 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
558 
559 /**
560   * @brief  Disable the write protection for RTC registers.
561   * @param  __HANDLE__ specifies the RTC handle.
562   * @retval None
563   */
564 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__)             \
565   do{                                       \
566     RTC->WPR = 0xCAU;   \
567     RTC->WPR = 0x53U;   \
568   } while(0U)
569 
570 /**
571   * @brief  Enable the write protection for RTC registers.
572   * @param  __HANDLE__ specifies the RTC handle.
573   * @retval None
574   */
575 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__)              \
576   do{                                       \
577     RTC->WPR = 0xFFU;   \
578   } while(0U)
579 
580 /**
581   * @brief  Add 1 hour (summer time change).
582   * @note   This interface is deprecated.
583   *         To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions
584   * @param  __HANDLE__ specifies the RTC handle.
585   * @param  __BKP__ Backup
586   *         This parameter can be:
587   *            @arg @ref RTC_STOREOPERATION_RESET
588   *            @arg @ref RTC_STOREOPERATION_SET
589   * @retval None
590   */
591 #define __HAL_RTC_DAYLIGHT_SAVING_TIME_ADD1H(__HANDLE__, __BKP__)                         \
592   do {                                                              \
593     __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__);                \
594     SET_BIT(RTC->CR, RTC_CR_ADD1H);            \
595     MODIFY_REG(RTC->CR, RTC_CR_BKP , (__BKP__)); \
596     __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__);                 \
597   } while(0);
598 
599 /**
600   * @brief  Subtract 1 hour (winter time change).
601   * @note   This interface is deprecated.
602   *         To manage Daylight Saving Time, please use HAL_RTC_DST_xxx functions
603   * @param  __HANDLE__ specifies the RTC handle.
604   * @param  __BKP__ Backup
605   *         This parameter can be:
606   *            @arg @ref RTC_STOREOPERATION_RESET
607   *            @arg @ref RTC_STOREOPERATION_SET
608   * @retval None
609   */
610 #define __HAL_RTC_DAYLIGHT_SAVING_TIME_SUB1H(__HANDLE__, __BKP__)                         \
611   do {                                                              \
612     __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__);                \
613     SET_BIT(RTC->CR, RTC_CR_SUB1H);            \
614     MODIFY_REG(RTC->CR, RTC_CR_BKP , (__BKP__)); \
615     __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__);                 \
616   } while(0);
617 
618 /**
619   * @brief  Enable the RTC ALARMA peripheral.
620   * @param  __HANDLE__ specifies the RTC handle.
621   * @retval None
622   */
623 #define __HAL_RTC_ALARMA_ENABLE(__HANDLE__)  (RTC->CR |= (RTC_CR_ALRAE))
624 
625 /**
626   * @brief  Disable the RTC ALARMA peripheral.
627   * @param  __HANDLE__ specifies the RTC handle.
628   * @retval None
629   */
630 #define __HAL_RTC_ALARMA_DISABLE(__HANDLE__)  (RTC->CR &= ~(RTC_CR_ALRAE))
631 
632 /**
633   * @brief  Enable the RTC ALARMB peripheral.
634   * @param  __HANDLE__ specifies the RTC handle.
635   * @retval None
636   */
637 #define __HAL_RTC_ALARMB_ENABLE(__HANDLE__)   (RTC->CR |= (RTC_CR_ALRBE))
638 
639 /**
640   * @brief  Disable the RTC ALARMB peripheral.
641   * @param  __HANDLE__ specifies the RTC handle.
642   * @retval None
643   */
644 #define __HAL_RTC_ALARMB_DISABLE(__HANDLE__)  (RTC->CR &= ~(RTC_CR_ALRBE))
645 
646 /**
647   * @brief  Enable the RTC Alarm interrupt.
648   * @param  __HANDLE__ specifies the RTC handle.
649   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to be enabled or disabled.
650   *          This parameter can be any combination of the following values:
651   *             @arg @ref RTC_IT_ALRA Alarm A interrupt
652   *             @arg @ref RTC_IT_ALRB Alarm B interrupt
653   * @retval None
654   */
655 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)( \
656                                 ((__INTERRUPT__) == RTC_IT_ALRA) ? (SET_BIT(RTC->CR, RTC_CR_ALRAIE)):\
657                                 ((__INTERRUPT__) == RTC_IT_ALRB) ? (SET_BIT(RTC->CR, RTC_CR_ALRBIE)):\
658                                 (0U)) /* Dummy action because is an invalid parameter value */
659 
660 /**
661   * @brief  Disable the RTC Alarm interrupt.
662   * @param  __HANDLE__ specifies the RTC handle.
663   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to be enabled or disabled.
664   *         This parameter can be any combination of the following values:
665   *            @arg @ref RTC_IT_ALRA Alarm A interrupt
666   *            @arg @ref RTC_IT_ALRB Alarm B interrupt
667   * @retval None
668   */
669 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)( \
670                                 ((__INTERRUPT__) == RTC_IT_ALRA) ? (CLEAR_BIT(RTC->CR, RTC_CR_ALRAIE)):\
671                                 ((__INTERRUPT__) == RTC_IT_ALRB) ? (CLEAR_BIT(RTC->CR, RTC_CR_ALRBIE)):\
672                                 (0U)) /* Dummy action because is an invalid parameter value */
673 
674 /**
675   * @brief  Check whether the specified RTC Alarm interrupt has occurred or not.
676   * @param  __HANDLE__ specifies the RTC handle.
677   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to check.
678   *         This parameter can be:
679   *            @arg @ref RTC_IT_ALRA Alarm A interrupt
680   *            @arg @ref RTC_IT_ALRB Alarm B interrupt
681   * @retval The state of __INTERRUPT__ (TRUE or FALSE).
682   */
683 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__)( \
684                           ((__INTERRUPT__) == RTC_IT_ALRA) ? (READ_BIT(RTC->MISR, RTC_MISR_ALRAMF) == RTC_MISR_ALRAMF):\
685                           ((__INTERRUPT__) == RTC_IT_ALRB) ? (READ_BIT(RTC->MISR, RTC_MISR_ALRBMF) == RTC_MISR_ALRBMF):\
686                           (0U)) /* Return 0 because it is an invalid parameter value */
687 
688 /**
689   * @brief  Check whether the specified RTC Alarm interrupt has been enabled or not.
690   * @param  __HANDLE__ specifies the RTC handle.
691   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to check.
692   *         This parameter can be:
693   *            @arg @ref RTC_IT_ALRA Alarm A interrupt
694   *            @arg @ref RTC_IT_ALRB Alarm B interrupt
695   * @retval The state of __INTERRUPT__ (TRUE or FALSE).
696   */
697 #define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)( \
698                                 ((__INTERRUPT__) == RTC_IT_ALRA) ? (READ_BIT(RTC->CR, RTC_CR_ALRAIE) == RTC_CR_ALRAIE):\
699                                 ((__INTERRUPT__) == RTC_IT_ALRB) ? (READ_BIT(RTC->CR, RTC_CR_ALRBIE) == RTC_CR_ALRBIE):\
700                                 (0U)) /* Return 0 because it is an invalid parameter value */
701 
702 /**
703   * @brief  Get the selected RTC Alarms flag status.
704   * @param  __HANDLE__ specifies the RTC handle.
705   * @param  __FLAG__ specifies the RTC Alarm Flag sources to check.
706   *         This parameter can be:
707   *            @arg @ref RTC_FLAG_ALRAF
708   *            @arg @ref RTC_FLAG_ALRBF
709   * @retval The state of __FLAG__ (TRUE or FALSE).
710   */
711 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)( \
712                                 ((__FLAG__) == RTC_FLAG_ALRAF) ? (READ_BIT(RTC->SR, RTC_SR_ALRAF) == RTC_SR_ALRAF):\
713                                 ((__FLAG__) == RTC_FLAG_ALRBF) ? (READ_BIT(RTC->SR, RTC_SR_ALRBF) == RTC_SR_ALRBF):\
714                                 (0U)) /* Return 0 because it is an invalid parameter value */
715 
716 /**
717   * @brief  Clear the RTC Alarms pending flags.
718   * @param  __HANDLE__ specifies the RTC handle.
719   * @param  __FLAG__ specifies the RTC Alarm Flag sources to clear.
720   *          This parameter can be:
721   *             @arg @ref RTC_FLAG_ALRAF
722   *             @arg @ref RTC_FLAG_ALRBF
723   * @retval None
724   */
725 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)( \
726                                 ((__FLAG__) == RTC_FLAG_ALRAF) ? (WRITE_REG(RTC->SCR, RTC_SCR_CALRAF)):\
727                                 ((__FLAG__) == RTC_FLAG_ALRBF) ? (WRITE_REG(RTC->SCR, RTC_SCR_CALRBF)):\
728                                 (0U)) /* Dummy action because is an invalid parameter value */
729 
730 /**
731   * @brief  Check whether if the RTC Calendar is initialized.
732   * @param  __HANDLE__ specifies the RTC handle.
733   * @retval The state of RTC Calendar initialization (TRUE or FALSE).
734   */
735 #define __HAL_RTC_IS_CALENDAR_INITIALIZED(__HANDLE__)  ((((RTC->ICSR) & (RTC_ICSR_INITS)) == RTC_ICSR_INITS))
736 
737 /**
738   * @}
739   */
740 
741 /* Include RTC HAL Extended module */
742 #include "stm32h7rsxx_hal_rtc_ex.h"
743 
744 /* Exported functions --------------------------------------------------------*/
745 /** @defgroup RTC_Exported_Functions RTC Exported Functions
746   * @{
747   */
748 
749 /** @defgroup RTC_Exported_Functions_Group1 Initialization and de-initialization functions
750   * @{
751   */
752 /* Initialization and de-initialization functions  ****************************/
753 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);
754 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc);
755 
756 void HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc);
757 void HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc);
758 
759 /* Callbacks Register/UnRegister functions  ***********************************/
760 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
761 HAL_StatusTypeDef HAL_RTC_RegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID,
762                                            pRTC_CallbackTypeDef pCallback);
763 HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID);
764 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
765 
766 /**
767   * @}
768   */
769 
770 /** @defgroup RTC_Exported_Functions_Group2 RTC Time and Date functions
771   * @{
772   */
773 /* RTC Time and Date functions ************************************************/
774 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
775 HAL_StatusTypeDef HAL_RTC_GetTime(const RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
776 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
777 HAL_StatusTypeDef HAL_RTC_GetDate(const RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
778 void              HAL_RTC_DST_Add1Hour(const RTC_HandleTypeDef *hrtc);
779 void              HAL_RTC_DST_Sub1Hour(const RTC_HandleTypeDef *hrtc);
780 void              HAL_RTC_DST_SetStoreOperation(const RTC_HandleTypeDef *hrtc);
781 void              HAL_RTC_DST_ClearStoreOperation(const RTC_HandleTypeDef *hrtc);
782 uint32_t          HAL_RTC_DST_ReadStoreOperation(const RTC_HandleTypeDef *hrtc);
783 /**
784   * @}
785   */
786 
787 /** @defgroup RTC_Exported_Functions_Group3 RTC Alarm functions
788   * @{
789   */
790 /* RTC Alarm functions ********************************************************/
791 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
792 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
793 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm);
794 HAL_StatusTypeDef HAL_RTC_GetAlarm(const RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm,
795                                    uint32_t Format);
796 void              HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc);
797 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(const RTC_HandleTypeDef *hrtc, uint32_t Timeout);
798 void              HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc);
799 
800 /**
801   * @}
802   */
803 
804 /** @defgroup  RTC_Exported_Functions_Group4 Peripheral Control functions
805   * @{
806   */
807 /* Peripheral Control functions ***********************************************/
808 HAL_StatusTypeDef   HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc);
809 /**
810   * @}
811   */
812 
813 /** @defgroup RTC_Exported_Functions_Group5 Peripheral State functions
814   * @{
815   */
816 /* Peripheral State functions *************************************************/
817 HAL_RTCStateTypeDef HAL_RTC_GetState(const RTC_HandleTypeDef *hrtc);
818 /**
819   * @}
820   */
821 
822 /**
823   * @}
824   */
825 
826 /* Private types -------------------------------------------------------------*/
827 /* Private variables ---------------------------------------------------------*/
828 /* Private constants ---------------------------------------------------------*/
829 /** @defgroup RTC_Private_Constants RTC Private Constants
830   * @{
831   */
832 /* Masks Definition */
833 #define RTC_TR_RESERVED_MASK                (RTC_TR_PM | RTC_TR_HT | RTC_TR_HU | \
834                                              RTC_TR_MNT | RTC_TR_MNU| RTC_TR_ST | \
835                                              RTC_TR_SU)
836 #define RTC_DR_RESERVED_MASK                (RTC_DR_YT | RTC_DR_YU | RTC_DR_WDU | \
837                                              RTC_DR_MT | RTC_DR_MU | RTC_DR_DT  | \
838                                              RTC_DR_DU)
839 #define RTC_INIT_MASK                       0xFFFFFFFFU
840 #define RTC_RSF_MASK                        (~(RTC_ICSR_INIT | RTC_ICSR_RSF))
841 
842 #define RTC_TIMEOUT_VALUE                   1000U
843 
844 /**
845   * @}
846   */
847 
848 /* Private macros ------------------------------------------------------------*/
849 /** @defgroup RTC_Private_Macros RTC Private Macros
850   * @{
851   */
852 
853 /** @defgroup RTC_IS_RTC_Definitions RTC Private macros to check input parameters
854   * @{
855   */
856 #if defined(RTC_CR_OSEL)
857 #define IS_RTC_OUTPUT(OUTPUT) (((OUTPUT) == RTC_OUTPUT_DISABLE) || \
858                                ((OUTPUT) == RTC_OUTPUT_ALARMA)  || \
859                                ((OUTPUT) == RTC_OUTPUT_ALARMB)  || \
860                                ((OUTPUT) == RTC_OUTPUT_WAKEUP)  || \
861                                ((OUTPUT) == RTC_OUTPUT_TAMPER))
862 #endif /* RTC_CR_OSEL */
863 
864 #define IS_RTC_HOUR_FORMAT(FORMAT)     (((FORMAT) == RTC_HOURFORMAT_12) || \
865                                         ((FORMAT) == RTC_HOURFORMAT_24))
866 
867 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \
868                                 ((POL) == RTC_OUTPUT_POLARITY_LOW))
869 
870 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \
871                                   ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL))
872 
873 #define IS_RTC_OUTPUT_PULLUP(TYPE) (((TYPE) == RTC_OUTPUT_PULLUP_NONE) || \
874                                     ((TYPE) == RTC_OUTPUT_PULLUP_ON))
875 
876 #if defined(RTC_CR_OUT2EN)
877 #define IS_RTC_OUTPUT_REMAP(REMAP)   (((REMAP) == RTC_OUTPUT_REMAP_NONE) || \
878                                       ((REMAP) == RTC_OUTPUT_REMAP_POS1))
879 #endif /* RTC_CR_OUT2EN */
880 
881 #define IS_RTC_HOURFORMAT12(PM)  (((PM) == RTC_HOURFORMAT12_AM) || \
882                                   ((PM) == RTC_HOURFORMAT12_PM))
883 
884 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \
885                                       ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \
886                                       ((SAVE) == RTC_DAYLIGHTSAVING_NONE))
887 
888 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_STOREOPERATION_RESET) || \
889                                            ((OPERATION) == RTC_STOREOPERATION_SET))
890 
891 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_FORMAT_BIN) || \
892                                ((FORMAT) == RTC_FORMAT_BCD))
893 
894 #define IS_RTC_YEAR(YEAR)              ((YEAR) <= 99U)
895 
896 #define IS_RTC_MONTH(MONTH)            (((MONTH) >= 1U) && ((MONTH) <= 12U))
897 
898 #define IS_RTC_DATE(DATE)              (((DATE) >= 1U) && ((DATE) <= 31U))
899 
900 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
901                                  ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
902                                  ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
903                                  ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
904                                  ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
905                                  ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
906                                  ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
907 
908 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) > 0U) && ((DATE) <= 31U))
909 
910 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
911                                                     ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
912                                                     ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
913                                                     ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
914                                                     ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
915                                                     ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
916                                                     ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
917 
918 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \
919                                             ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY))
920 
921 #define IS_RTC_ALARM_MASK(MASK)  (((MASK) & ~(RTC_ALARMMASK_ALL)) == 0UL)
922 
923 #define IS_RTC_ALARM(ALARM)      (((ALARM) == RTC_ALARM_A) || \
924                                   ((ALARM) == RTC_ALARM_B))
925 
926 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= RTC_ALRMASSR_SS)
927 
928 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK)          (((MASK) == 0UL) || \
929                                                      (((MASK) >= RTC_ALARMSUBSECONDMASK_SS14_1) && \
930                                                       ((MASK) <= RTC_ALARMSUBSECONDMASK_NONE)))
931 
932 #define IS_RTC_ASYNCH_PREDIV(PREDIV)   ((PREDIV) <= (RTC_PRER_PREDIV_A >> RTC_PRER_PREDIV_A_Pos))
933 
934 #define IS_RTC_SYNCH_PREDIV(PREDIV)    ((PREDIV) <= (RTC_PRER_PREDIV_S >> RTC_PRER_PREDIV_S_Pos))
935 
936 #define IS_RTC_HOUR12(HOUR)            (((HOUR) > 0U) && ((HOUR) <= 12U))
937 
938 #define IS_RTC_HOUR24(HOUR)            ((HOUR) <= 23U)
939 
940 #define IS_RTC_MINUTES(MINUTES)        ((MINUTES) <= 59U)
941 
942 #define IS_RTC_SECONDS(SECONDS)        ((SECONDS) <= 59U)
943 
944 /**
945   * @}
946   */
947 
948 /**
949   * @}
950   */
951 
952 /* Private functions -------------------------------------------------------------*/
953 /** @defgroup RTC_Private_Functions RTC Private Functions
954   * @{
955   */
956 HAL_StatusTypeDef  RTC_EnterInitMode(RTC_HandleTypeDef *hrtc);
957 HAL_StatusTypeDef  RTC_ExitInitMode(RTC_HandleTypeDef *hrtc);
958 uint8_t            RTC_ByteToBcd2(uint8_t Value);
959 uint8_t            RTC_Bcd2ToByte(uint8_t Value);
960 /**
961   * @}
962   */
963 
964 /**
965   * @}
966   */
967 
968 /**
969   * @}
970   */
971 
972 #ifdef __cplusplus
973 }
974 #endif
975 
976 #endif /* STM32H7RSxx_HAL_RTC_H */
977