1 /**
2   ******************************************************************************
3   * @file    stm32f4xx_hal_rtc.h
4   * @author  MCD Application Team
5   * @brief   Header file of RTC HAL module.
6   ******************************************************************************
7   * @attention
8   *
9   * Copyright (c) 2017 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 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 
31 /** @addtogroup STM32F4xx_HAL_Driver
32   * @{
33   */
34 
35 /** @addtogroup RTC
36   * @{
37   */
38 
39 /* Exported types ------------------------------------------------------------*/
40 
41 /** @defgroup RTC_Exported_Types RTC Exported Types
42   * @{
43   */
44 
45 /**
46   * @brief  HAL State structures definition
47   */
48 typedef enum
49 {
50   HAL_RTC_STATE_RESET             = 0x00U,  /*!< RTC not yet initialized or disabled */
51   HAL_RTC_STATE_READY             = 0x01U,  /*!< RTC initialized and ready for use   */
52   HAL_RTC_STATE_BUSY              = 0x02U,  /*!< RTC process is ongoing              */
53   HAL_RTC_STATE_TIMEOUT           = 0x03U,  /*!< RTC timeout state                   */
54   HAL_RTC_STATE_ERROR             = 0x04U   /*!< RTC error state                     */
55 } HAL_RTCStateTypeDef;
56 
57 /**
58   * @brief  RTC Configuration Structure definition
59   */
60 typedef struct
61 {
62   uint32_t HourFormat;      /*!< Specifies the RTC Hour Format.
63                                  This parameter can be a value of @ref RTC_Hour_Formats */
64 
65   uint32_t AsynchPrediv;    /*!< Specifies the RTC Asynchronous Predivider value.
66                                  This parameter must be a number between Min_Data = 0x00 and Max_Data = 0x7F */
67 
68   uint32_t SynchPrediv;     /*!< Specifies the RTC Synchronous Predivider value.
69                                  This parameter must be a number between Min_Data = 0x0000 and Max_Data = 0x7FFF */
70 
71   uint32_t OutPut;          /*!< Specifies which signal will be routed to the RTC output.
72                                  This parameter can be a value of @ref RTC_Output_selection_Definitions */
73 
74   uint32_t OutPutPolarity;  /*!< Specifies the polarity of the output signal.
75                                  This parameter can be a value of @ref RTC_Output_Polarity_Definitions */
76 
77   uint32_t OutPutType;      /*!< Specifies the RTC Output Pin mode.
78                                  This parameter can be a value of @ref RTC_Output_Type_ALARM_OUT */
79 } RTC_InitTypeDef;
80 
81 /**
82   * @brief  RTC Time structure definition
83   */
84 typedef struct
85 {
86   uint8_t Hours;            /*!< Specifies the RTC Time Hour.
87                                  This parameter must be a number between Min_Data = 0 and Max_Data = 12 if the RTC_HourFormat_12 is selected
88                                  This parameter must be a number between Min_Data = 0 and Max_Data = 23 if the RTC_HourFormat_24 is selected */
89 
90   uint8_t Minutes;          /*!< Specifies the RTC Time Minutes.
91                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
92 
93   uint8_t Seconds;          /*!< Specifies the RTC Time Seconds.
94                                  This parameter must be a number between Min_Data = 0 and Max_Data = 59 */
95 
96   uint8_t TimeFormat;       /*!< Specifies the RTC AM/PM Time.
97                                  This parameter can be a value of @ref RTC_AM_PM_Definitions */
98 
99   uint32_t SubSeconds;      /*!< Specifies the RTC_SSR RTC Sub Second register content.
100                                  This parameter corresponds to a time unit range between [0-1] Second
101                                  with [1 Sec / SecondFraction +1] granularity */
102 
103   uint32_t SecondFraction;  /*!< Specifies the range or granularity of Sub Second register content
104                                  corresponding to Synchronous prescaler factor value (PREDIV_S)
105                                  This parameter corresponds to a time unit range between [0-1] Second
106                                  with [1 Sec / SecondFraction +1] granularity.
107                                  This field will be used only by HAL_RTC_GetTime function */
108 
109   uint32_t DayLightSaving;  /*!< This interface is deprecated. To manage Daylight
110                                  Saving Time, please use HAL_RTC_DST_xxx functions */
111 
112   uint32_t StoreOperation;  /*!< This interface is deprecated. To manage Daylight
113                                  Saving Time, please use HAL_RTC_DST_xxx functions */
114 } RTC_TimeTypeDef;
115 
116 /**
117   * @brief  RTC Date structure definition
118   */
119 typedef struct
120 {
121   uint8_t WeekDay;  /*!< Specifies the RTC Date WeekDay.
122                          This parameter can be a value of @ref RTC_WeekDay_Definitions */
123 
124   uint8_t Month;    /*!< Specifies the RTC Date Month (in BCD format).
125                          This parameter can be a value of @ref RTC_Month_Date_Definitions */
126 
127   uint8_t Date;     /*!< Specifies the RTC Date.
128                          This parameter must be a number between Min_Data = 1 and Max_Data = 31 */
129 
130   uint8_t Year;     /*!< Specifies the RTC Date Year.
131                          This parameter must be a number between Min_Data = 0 and Max_Data = 99 */
132 
133 } RTC_DateTypeDef;
134 
135 /**
136   * @brief  RTC Alarm structure definition
137   */
138 typedef struct
139 {
140   RTC_TimeTypeDef AlarmTime;     /*!< Specifies the RTC Alarm Time members */
141 
142   uint32_t AlarmMask;            /*!< Specifies the RTC Alarm Masks.
143                                       This parameter can be a value of @ref RTC_AlarmMask_Definitions */
144 
145   uint32_t AlarmSubSecondMask;   /*!< Specifies the RTC Alarm SubSeconds Masks.
146                                       This parameter can be a value of @ref RTC_Alarm_Sub_Seconds_Masks_Definitions */
147 
148   uint32_t AlarmDateWeekDaySel;  /*!< Specifies the RTC Alarm is on Date or WeekDay.
149                                       This parameter can be a value of @ref RTC_AlarmDateWeekDay_Definitions */
150 
151   uint8_t AlarmDateWeekDay;      /*!< Specifies the RTC Alarm Date/WeekDay.
152                                       If the Alarm Date is selected, this parameter must be set to a value in the 1-31 range.
153                                       If the Alarm WeekDay is selected, this parameter can be a value of @ref RTC_WeekDay_Definitions */
154 
155   uint32_t Alarm;                /*!< Specifies the alarm .
156                                       This parameter can be a value of @ref RTC_Alarms_Definitions */
157 } RTC_AlarmTypeDef;
158 
159 /**
160   * @brief  RTC Handle Structure definition
161   */
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;  /*!< Register base address    */
169 
170   RTC_InitTypeDef             Init;       /*!< RTC required parameters  */
171 
172   HAL_LockTypeDef             Lock;       /*!< RTC locking object       */
173 
174   __IO HAL_RTCStateTypeDef    State;      /*!< Time communication state */
175 
176 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
177   void (* AlarmAEventCallback)      (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Alarm A Event callback         */
178 
179   void (* AlarmBEventCallback)      (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Alarm B Event callback         */
180 
181   void (* TimeStampEventCallback)   (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Timestamp Event callback       */
182 
183   void (* WakeUpTimerEventCallback) (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC WakeUpTimer Event callback     */
184 
185   void (* Tamper1EventCallback)     (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Tamper 1 Event callback        */
186 
187 #if defined(RTC_TAMPER2_SUPPORT)
188   void (* Tamper2EventCallback)     (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Tamper 2 Event callback        */
189 #endif /* RTC_TAMPER2_SUPPORT */
190 
191   void (* MspInitCallback)          (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Msp Init callback              */
192 
193   void (* MspDeInitCallback)        (struct __RTC_HandleTypeDef *hrtc);  /*!< RTC Msp DeInit callback            */
194 
195 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
196 
197 } RTC_HandleTypeDef;
198 
199 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
200 /**
201   * @brief  HAL RTC Callback ID enumeration definition
202   */
203 typedef enum
204 {
205   HAL_RTC_ALARM_A_EVENT_CB_ID           = 0x00U,    /*!< RTC Alarm A Event Callback ID       */
206   HAL_RTC_ALARM_B_EVENT_CB_ID           = 0x01U,    /*!< RTC Alarm B Event Callback ID       */
207   HAL_RTC_TIMESTAMP_EVENT_CB_ID         = 0x02U,    /*!< RTC Timestamp Event Callback ID     */
208   HAL_RTC_WAKEUPTIMER_EVENT_CB_ID       = 0x03U,    /*!< RTC Wakeup Timer Event Callback ID  */
209   HAL_RTC_TAMPER1_EVENT_CB_ID           = 0x04U,    /*!< RTC Tamper 1 Callback ID            */
210 #if defined(RTC_TAMPER2_SUPPORT)
211   HAL_RTC_TAMPER2_EVENT_CB_ID           = 0x05U,    /*!< RTC Tamper 2 Callback ID            */
212 #endif /* RTC_TAMPER2_SUPPORT */
213   HAL_RTC_MSPINIT_CB_ID                 = 0x0EU,    /*!< RTC Msp Init callback ID            */
214   HAL_RTC_MSPDEINIT_CB_ID               = 0x0FU     /*!< RTC Msp DeInit callback ID          */
215 } HAL_RTC_CallbackIDTypeDef;
216 
217 /**
218   * @brief  HAL RTC Callback pointer definition
219   */
220 typedef  void (*pRTC_CallbackTypeDef)(RTC_HandleTypeDef *hrtc);  /*!< pointer to an RTC callback function */
221 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
222 
223 /**
224   * @}
225   */
226 
227 /* Exported constants --------------------------------------------------------*/
228 
229 /** @defgroup RTC_Exported_Constants RTC Exported Constants
230   * @{
231   */
232 
233 /** @defgroup RTC_Hour_Formats RTC Hour Formats
234   * @{
235   */
236 #define RTC_HOURFORMAT_24              0x00000000U
237 #define RTC_HOURFORMAT_12              RTC_CR_FMT
238 /**
239   * @}
240   */
241 
242 /** @defgroup RTC_Output_selection_Definitions RTC Output Selection Definitions
243   * @{
244   */
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
249 /**
250   * @}
251   */
252 
253 /** @defgroup RTC_Output_Polarity_Definitions RTC Output Polarity Definitions
254   * @{
255   */
256 #define RTC_OUTPUT_POLARITY_HIGH       0x00000000U
257 #define RTC_OUTPUT_POLARITY_LOW        RTC_CR_POL
258 /**
259   * @}
260   */
261 
262 /** @defgroup RTC_Output_Type_ALARM_OUT RTC Output Type ALARM OUT
263   * @{
264   */
265 #define RTC_OUTPUT_TYPE_OPENDRAIN      0x00000000U
266 #define RTC_OUTPUT_TYPE_PUSHPULL       RTC_TAFCR_ALARMOUTTYPE
267 /**
268   * @}
269   */
270 
271 /** @defgroup RTC_AM_PM_Definitions RTC AM PM Definitions
272   * @{
273   */
274 #define RTC_HOURFORMAT12_AM            ((uint8_t)0x00)
275 #define RTC_HOURFORMAT12_PM            ((uint8_t)0x01)
276 /**
277   * @}
278   */
279 
280 /** @defgroup RTC_DayLightSaving_Definitions RTC DayLight Saving Definitions
281   * @{
282   */
283 #define RTC_DAYLIGHTSAVING_SUB1H       RTC_CR_SUB1H
284 #define RTC_DAYLIGHTSAVING_ADD1H       RTC_CR_ADD1H
285 #define RTC_DAYLIGHTSAVING_NONE        0x00000000U
286 /**
287   * @}
288   */
289 
290 /** @defgroup RTC_StoreOperation_Definitions RTC Store Operation Definitions
291   * @{
292   */
293 #define RTC_STOREOPERATION_RESET        0x00000000U
294 #define RTC_STOREOPERATION_SET          RTC_CR_BKP
295 /**
296   * @}
297   */
298 
299 /** @defgroup RTC_Input_parameter_format_definitions RTC Input Parameter Format Definitions
300   * @{
301   */
302 #define RTC_FORMAT_BIN                  0x00000000U
303 #define RTC_FORMAT_BCD                  0x00000001U
304 /**
305   * @}
306   */
307 
308 /** @defgroup RTC_Month_Date_Definitions RTC Month Date Definitions (in BCD format)
309   * @{
310   */
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)
323 /**
324   * @}
325   */
326 
327 /** @defgroup RTC_WeekDay_Definitions RTC WeekDay Definitions
328   * @{
329   */
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)
337 /**
338   * @}
339   */
340 
341 /** @defgroup RTC_AlarmDateWeekDay_Definitions RTC Alarm Date WeekDay Definitions
342   * @{
343   */
344 #define RTC_ALARMDATEWEEKDAYSEL_DATE      0x00000000U
345 #define RTC_ALARMDATEWEEKDAYSEL_WEEKDAY   RTC_ALRMAR_WDSEL
346 /**
347   * @}
348   */
349 
350 /** @defgroup RTC_AlarmMask_Definitions RTC Alarm Mask Definitions
351   * @{
352   */
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)
362 /**
363   * @}
364   */
365 
366 /** @defgroup RTC_Alarms_Definitions RTC Alarms Definitions
367   * @{
368   */
369 #define RTC_ALARM_A                       RTC_CR_ALRAE
370 #define RTC_ALARM_B                       RTC_CR_ALRBE
371 /**
372   * @}
373   */
374 
375 /** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions RTC Alarm Sub Seconds Masks Definitions
376   * @{
377   */
378 /*!< All Alarm SS fields are masked. There is no comparison on sub seconds for Alarm */
379 #define RTC_ALARMSUBSECONDMASK_ALL         0x00000000U
380 /*!< SS[14:1] are don't care in Alarm comparison. Only SS[0] is compared.     */
381 #define RTC_ALARMSUBSECONDMASK_SS14_1      RTC_ALRMASSR_MASKSS_0
382 /*!< SS[14:2] are don't care in Alarm comparison. Only SS[1:0] are compared.  */
383 #define RTC_ALARMSUBSECONDMASK_SS14_2      RTC_ALRMASSR_MASKSS_1
384 /*!< SS[14:3] are don't care in Alarm comparison. Only SS[2:0] are compared.  */
385 #define RTC_ALARMSUBSECONDMASK_SS14_3      (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1)
386 /*!< SS[14:4] are don't care in Alarm comparison. Only SS[3:0] are compared.  */
387 #define RTC_ALARMSUBSECONDMASK_SS14_4      RTC_ALRMASSR_MASKSS_2
388 /*!< SS[14:5] are don't care in Alarm comparison. Only SS[4:0] are compared.  */
389 #define RTC_ALARMSUBSECONDMASK_SS14_5      (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2)
390 /*!< SS[14:6] are don't care in Alarm comparison. Only SS[5:0] are compared.  */
391 #define RTC_ALARMSUBSECONDMASK_SS14_6      (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2)
392 /*!< SS[14:7] are don't care in Alarm comparison. Only SS[6:0] are compared.  */
393 #define RTC_ALARMSUBSECONDMASK_SS14_7      (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2)
394 /*!< SS[14:8] are don't care in Alarm comparison. Only SS[7:0] are compared.  */
395 #define RTC_ALARMSUBSECONDMASK_SS14_8      RTC_ALRMASSR_MASKSS_3
396 /*!< SS[14:9] are don't care in Alarm comparison. Only SS[8:0] are compared.  */
397 #define RTC_ALARMSUBSECONDMASK_SS14_9      (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_3)
398 /*!< SS[14:10] are don't care in Alarm comparison. Only SS[9:0] are compared. */
399 #define RTC_ALARMSUBSECONDMASK_SS14_10     (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3)
400 /*!< SS[14:11] are don't care in Alarm comparison. Only SS[10:0] are compared. */
401 #define RTC_ALARMSUBSECONDMASK_SS14_11     (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_3)
402 /*!< SS[14:12] are don't care in Alarm comparison. Only SS[11:0] are compared. */
403 #define RTC_ALARMSUBSECONDMASK_SS14_12     (RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)
404 /*!< SS[14:13] are don't care in Alarm comparison. Only SS[12:0] are compared. */
405 #define RTC_ALARMSUBSECONDMASK_SS14_13     (RTC_ALRMASSR_MASKSS_0 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)
406 /*!< SS[14] is don't care in Alarm comparison. Only SS[13:0] are compared. */
407 #define RTC_ALARMSUBSECONDMASK_SS14        (RTC_ALRMASSR_MASKSS_1 | RTC_ALRMASSR_MASKSS_2 | RTC_ALRMASSR_MASKSS_3)
408 /*!< SS[14:0] are compared and must match to activate alarm. */
409 #define RTC_ALARMSUBSECONDMASK_NONE        RTC_ALRMASSR_MASKSS
410 /**
411   * @}
412   */
413 
414 /** @defgroup RTC_Interrupts_Definitions RTC Interrupts Definitions
415   * @{
416   */
417 #define RTC_IT_TS                         RTC_CR_TSIE         /*!< Enable Timestamp Interrupt               */
418 #define RTC_IT_WUT                        RTC_CR_WUTIE        /*!< Enable Wakeup timer Interrupt            */
419 #define RTC_IT_ALRB                       RTC_CR_ALRBIE       /*!< Enable Alarm B Interrupt                 */
420 #define RTC_IT_ALRA                       RTC_CR_ALRAIE       /*!< Enable Alarm A Interrupt                 */
421 /**
422   * @}
423   */
424 
425 /** @defgroup RTC_Flags_Definitions RTC Flags Definitions
426   * @{
427   */
428 #define RTC_FLAG_RECALPF                  RTC_ISR_RECALPF     /*!< Recalibration pending flag               */
429 #if defined(RTC_TAMPER2_SUPPORT)
430 #define RTC_FLAG_TAMP2F                   RTC_ISR_TAMP2F      /*!< Tamper 2 event flag                      */
431 #endif /* RTC_TAMPER2_SUPPORT */
432 #define RTC_FLAG_TAMP1F                   RTC_ISR_TAMP1F      /*!< Tamper 1 event flag                      */
433 #define RTC_FLAG_TSOVF                    RTC_ISR_TSOVF       /*!< Timestamp overflow flag                  */
434 #define RTC_FLAG_TSF                      RTC_ISR_TSF         /*!< Timestamp event flag                     */
435 #define RTC_FLAG_WUTF                     RTC_ISR_WUTF        /*!< Wakeup timer event flag                  */
436 #define RTC_FLAG_ALRBF                    RTC_ISR_ALRBF       /*!< Alarm B event flag                       */
437 #define RTC_FLAG_ALRAF                    RTC_ISR_ALRAF       /*!< Alarm A event flag                       */
438 #define RTC_FLAG_INITF                    RTC_ISR_INITF       /*!< RTC in initialization mode flag          */
439 #define RTC_FLAG_RSF                      RTC_ISR_RSF         /*!< Register synchronization flag            */
440 #define RTC_FLAG_INITS                    RTC_ISR_INITS       /*!< RTC initialization status flag           */
441 #define RTC_FLAG_SHPF                     RTC_ISR_SHPF        /*!< Shift operation pending flag             */
442 #define RTC_FLAG_WUTWF                    RTC_ISR_WUTWF       /*!< WUTR register write allowance flag       */
443 #define RTC_FLAG_ALRBWF                   RTC_ISR_ALRBWF      /*!< ALRMBR register write allowance flag     */
444 #define RTC_FLAG_ALRAWF                   RTC_ISR_ALRAWF      /*!< ALRMAR register write allowance flag     */
445 /**
446   * @}
447   */
448 
449 /**
450   * @}
451   */
452 
453 /* Exported macros -----------------------------------------------------------*/
454 
455 /** @defgroup RTC_Exported_Macros RTC Exported Macros
456   * @{
457   */
458 
459 /** @brief Reset RTC handle state
460   * @param  __HANDLE__ specifies the RTC handle.
461   * @retval None
462   */
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 
473 /**
474   * @brief  Disable the write protection for RTC registers.
475   * @param  __HANDLE__ specifies the RTC handle.
476   * @retval None
477   */
478 #define __HAL_RTC_WRITEPROTECTION_DISABLE(__HANDLE__) do {                                       \
479                                                            (__HANDLE__)->Instance->WPR = 0xCAU;  \
480                                                            (__HANDLE__)->Instance->WPR = 0x53U;  \
481                                                          } while(0U)
482 
483 /**
484   * @brief  Enable the write protection for RTC registers.
485   * @param  __HANDLE__ specifies the RTC handle.
486   * @retval None
487   */
488 #define __HAL_RTC_WRITEPROTECTION_ENABLE(__HANDLE__) do {                                       \
489                                                           (__HANDLE__)->Instance->WPR = 0xFFU;  \
490                                                         } while(0U)
491 
492 
493 /**
494   * @brief  Enable the RTC ALARMA peripheral.
495   * @param  __HANDLE__ specifies the RTC handle.
496   * @retval None
497   */
498 #define __HAL_RTC_ALARMA_ENABLE(__HANDLE__)                           ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRAE))
499 
500 /**
501   * @brief  Disable the RTC ALARMA peripheral.
502   * @param  __HANDLE__ specifies the RTC handle.
503   * @retval None
504   */
505 #define __HAL_RTC_ALARMA_DISABLE(__HANDLE__)                          ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRAE))
506 
507 /**
508   * @brief  Enable the RTC ALARMB peripheral.
509   * @param  __HANDLE__ specifies the RTC handle.
510   * @retval None
511   */
512 #define __HAL_RTC_ALARMB_ENABLE(__HANDLE__)                           ((__HANDLE__)->Instance->CR |= (RTC_CR_ALRBE))
513 
514 /**
515   * @brief  Disable the RTC ALARMB peripheral.
516   * @param  __HANDLE__ specifies the RTC handle.
517   * @retval None
518   */
519 #define __HAL_RTC_ALARMB_DISABLE(__HANDLE__)                          ((__HANDLE__)->Instance->CR &= ~(RTC_CR_ALRBE))
520 
521 /**
522   * @brief  Enable the RTC Alarm interrupt.
523   * @param  __HANDLE__ specifies the RTC handle.
524   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to be enabled or disabled.
525   *          This parameter can be any combination of the following values:
526   *             @arg RTC_IT_ALRA: Alarm A interrupt
527   *             @arg RTC_IT_ALRB: Alarm B interrupt
528   * @retval None
529   */
530 #define __HAL_RTC_ALARM_ENABLE_IT(__HANDLE__, __INTERRUPT__)          ((__HANDLE__)->Instance->CR |= (__INTERRUPT__))
531 
532 /**
533   * @brief  Disable the RTC Alarm interrupt.
534   * @param  __HANDLE__ specifies the RTC handle.
535   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to be enabled or disabled.
536   *          This parameter can be any combination of the following values:
537   *             @arg RTC_IT_ALRA: Alarm A interrupt
538   *             @arg RTC_IT_ALRB: Alarm B interrupt
539   * @retval None
540   */
541 #define __HAL_RTC_ALARM_DISABLE_IT(__HANDLE__, __INTERRUPT__)         ((__HANDLE__)->Instance->CR &= ~(__INTERRUPT__))
542 
543 /**
544   * @brief  Check whether the specified RTC Alarm interrupt has occurred or not.
545   * @param  __HANDLE__ specifies the RTC handle.
546   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt to check.
547   *         This parameter can be:
548   *            @arg RTC_IT_ALRA: Alarm A interrupt
549   *            @arg RTC_IT_ALRB: Alarm B interrupt
550   * @retval None
551   */
552 #define __HAL_RTC_ALARM_GET_IT(__HANDLE__, __INTERRUPT__)           (((((__HANDLE__)->Instance->ISR) & ((__INTERRUPT__) >> 4U)) != 0U) ? 1U : 0U)
553 
554 /**
555   * @brief  Get the selected RTC Alarm's flag status.
556   * @param  __HANDLE__ specifies the RTC handle.
557   * @param  __FLAG__ specifies the RTC Alarm Flag to check.
558   *         This parameter can be:
559   *            @arg RTC_FLAG_ALRAF: Alarm A interrupt flag
560   *            @arg RTC_FLAG_ALRAWF: Alarm A 'write allowed' flag
561   *            @arg RTC_FLAG_ALRBF: Alarm B interrupt flag
562   *            @arg RTC_FLAG_ALRBWF: Alarm B 'write allowed' flag
563   * @retval None
564   */
565 #define __HAL_RTC_ALARM_GET_FLAG(__HANDLE__, __FLAG__)                (((((__HANDLE__)->Instance->ISR) & (__FLAG__)) != 0U) ? 1U : 0U)
566 
567 /**
568   * @brief  Clear the RTC Alarm's pending flags.
569   * @param  __HANDLE__ specifies the RTC handle.
570   * @param  __FLAG__ specifies the RTC Alarm flag to be cleared.
571   *          This parameter can be:
572   *             @arg RTC_FLAG_ALRAF
573   *             @arg RTC_FLAG_ALRBF
574   * @retval None
575   */
576 #define __HAL_RTC_ALARM_CLEAR_FLAG(__HANDLE__, __FLAG__)                  ((__HANDLE__)->Instance->ISR) = (~((__FLAG__) | RTC_ISR_INIT)|((__HANDLE__)->Instance->ISR & RTC_ISR_INIT))
577 
578 /**
579   * @brief  Check whether the specified RTC Alarm interrupt has been enabled or not.
580   * @param  __HANDLE__ specifies the RTC handle.
581   * @param  __INTERRUPT__ specifies the RTC Alarm interrupt sources to check.
582   *         This parameter can be:
583   *            @arg RTC_IT_ALRA: Alarm A interrupt
584   *            @arg RTC_IT_ALRB: Alarm B interrupt
585   * @retval None
586   */
587 #define __HAL_RTC_ALARM_GET_IT_SOURCE(__HANDLE__, __INTERRUPT__)     (((((__HANDLE__)->Instance->CR) & (__INTERRUPT__)) != 0U) ? 1U : 0U)
588 
589 /**
590   * @brief  Enable interrupt on the RTC Alarm associated EXTI line.
591   * @retval None
592   */
593 #define __HAL_RTC_ALARM_EXTI_ENABLE_IT()            (EXTI->IMR |= RTC_EXTI_LINE_ALARM_EVENT)
594 
595 /**
596   * @brief  Disable interrupt on the RTC Alarm associated EXTI line.
597   * @retval None
598   */
599 #define __HAL_RTC_ALARM_EXTI_DISABLE_IT()           (EXTI->IMR &= ~RTC_EXTI_LINE_ALARM_EVENT)
600 
601 /**
602   * @brief  Enable event on the RTC Alarm associated EXTI line.
603   * @retval None.
604   */
605 #define __HAL_RTC_ALARM_EXTI_ENABLE_EVENT()          (EXTI->EMR |= RTC_EXTI_LINE_ALARM_EVENT)
606 
607 /**
608   * @brief  Disable event on the RTC Alarm associated EXTI line.
609   * @retval None.
610   */
611 #define __HAL_RTC_ALARM_EXTI_DISABLE_EVENT()         (EXTI->EMR &= ~RTC_EXTI_LINE_ALARM_EVENT)
612 
613 /**
614   * @brief  Enable falling edge trigger on the RTC Alarm associated EXTI line.
615   * @retval None.
616   */
617 #define __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE()   (EXTI->FTSR |= RTC_EXTI_LINE_ALARM_EVENT)
618 
619 /**
620   * @brief  Disable falling edge trigger on the RTC Alarm associated EXTI line.
621   * @retval None.
622   */
623 #define __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE()  (EXTI->FTSR &= ~RTC_EXTI_LINE_ALARM_EVENT)
624 
625 /**
626   * @brief  Enable rising edge trigger on the RTC Alarm associated EXTI line.
627   * @retval None.
628   */
629 #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE()    (EXTI->RTSR |= RTC_EXTI_LINE_ALARM_EVENT)
630 
631 /**
632   * @brief  Disable rising edge trigger on the RTC Alarm associated EXTI line.
633   * @retval None.
634   */
635 #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE()   (EXTI->RTSR &= ~RTC_EXTI_LINE_ALARM_EVENT)
636 
637 /**
638   * @brief  Enable rising & falling edge trigger on the RTC Alarm associated EXTI line.
639   * @retval None.
640   */
641 #define __HAL_RTC_ALARM_EXTI_ENABLE_RISING_FALLING_EDGE() do {                                             \
642                                                                __HAL_RTC_ALARM_EXTI_ENABLE_RISING_EDGE();  \
643                                                                __HAL_RTC_ALARM_EXTI_ENABLE_FALLING_EDGE(); \
644                                                              } while(0U)
645 
646 /**
647   * @brief  Disable rising & falling edge trigger on the RTC Alarm associated EXTI line.
648   * @retval None.
649   */
650 #define __HAL_RTC_ALARM_EXTI_DISABLE_RISING_FALLING_EDGE() do {                                              \
651                                                                 __HAL_RTC_ALARM_EXTI_DISABLE_RISING_EDGE();  \
652                                                                 __HAL_RTC_ALARM_EXTI_DISABLE_FALLING_EDGE(); \
653                                                               } while(0U)
654 
655 /**
656   * @brief Check whether the RTC Alarm associated EXTI line interrupt flag is set or not.
657   * @retval Line Status.
658   */
659 #define __HAL_RTC_ALARM_EXTI_GET_FLAG()              (EXTI->PR & RTC_EXTI_LINE_ALARM_EVENT)
660 
661 /**
662   * @brief Clear the RTC Alarm associated EXTI line flag.
663   * @retval None.
664   */
665 #define __HAL_RTC_ALARM_EXTI_CLEAR_FLAG()            (EXTI->PR = RTC_EXTI_LINE_ALARM_EVENT)
666 
667 /**
668   * @brief Generate a Software interrupt on RTC Alarm associated EXTI line.
669   * @retval None.
670   */
671 #define __HAL_RTC_ALARM_EXTI_GENERATE_SWIT()         (EXTI->SWIER |= RTC_EXTI_LINE_ALARM_EVENT)
672 /**
673   * @}
674   */
675 
676 /* Include RTC HAL Extended module */
677 #include "stm32f4xx_hal_rtc_ex.h"
678 
679 /* Exported functions --------------------------------------------------------*/
680 
681 /** @addtogroup RTC_Exported_Functions
682   * @{
683   */
684 
685 /** @addtogroup RTC_Exported_Functions_Group1
686   * @{
687   */
688 /* Initialization and de-initialization functions  ****************************/
689 HAL_StatusTypeDef HAL_RTC_Init(RTC_HandleTypeDef *hrtc);
690 HAL_StatusTypeDef HAL_RTC_DeInit(RTC_HandleTypeDef *hrtc);
691 void              HAL_RTC_MspInit(RTC_HandleTypeDef *hrtc);
692 void              HAL_RTC_MspDeInit(RTC_HandleTypeDef *hrtc);
693 
694 /* Callbacks Register/UnRegister functions  ***********************************/
695 #if (USE_HAL_RTC_REGISTER_CALLBACKS == 1)
696 HAL_StatusTypeDef HAL_RTC_RegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID, pRTC_CallbackTypeDef pCallback);
697 HAL_StatusTypeDef HAL_RTC_UnRegisterCallback(RTC_HandleTypeDef *hrtc, HAL_RTC_CallbackIDTypeDef CallbackID);
698 #endif /* USE_HAL_RTC_REGISTER_CALLBACKS */
699 /**
700   * @}
701   */
702 
703 /** @addtogroup RTC_Exported_Functions_Group2
704   * @{
705   */
706 /* RTC Time and Date functions ************************************************/
707 HAL_StatusTypeDef HAL_RTC_SetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
708 HAL_StatusTypeDef HAL_RTC_GetTime(RTC_HandleTypeDef *hrtc, RTC_TimeTypeDef *sTime, uint32_t Format);
709 HAL_StatusTypeDef HAL_RTC_SetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
710 HAL_StatusTypeDef HAL_RTC_GetDate(RTC_HandleTypeDef *hrtc, RTC_DateTypeDef *sDate, uint32_t Format);
711 /**
712   * @}
713   */
714 
715 /** @addtogroup RTC_Exported_Functions_Group3
716   * @{
717   */
718 /* RTC Alarm functions ********************************************************/
719 HAL_StatusTypeDef HAL_RTC_SetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
720 HAL_StatusTypeDef HAL_RTC_SetAlarm_IT(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Format);
721 HAL_StatusTypeDef HAL_RTC_DeactivateAlarm(RTC_HandleTypeDef *hrtc, uint32_t Alarm);
722 HAL_StatusTypeDef HAL_RTC_GetAlarm(RTC_HandleTypeDef *hrtc, RTC_AlarmTypeDef *sAlarm, uint32_t Alarm, uint32_t Format);
723 void              HAL_RTC_AlarmIRQHandler(RTC_HandleTypeDef *hrtc);
724 HAL_StatusTypeDef HAL_RTC_PollForAlarmAEvent(RTC_HandleTypeDef *hrtc, uint32_t Timeout);
725 void              HAL_RTC_AlarmAEventCallback(RTC_HandleTypeDef *hrtc);
726 /**
727   * @}
728   */
729 
730 /** @addtogroup RTC_Exported_Functions_Group4
731   * @{
732   */
733 /* Peripheral Control functions ***********************************************/
734 HAL_StatusTypeDef   HAL_RTC_WaitForSynchro(RTC_HandleTypeDef *hrtc);
735 
736 /* RTC Daylight Saving Time functions *****************************************/
737 void              HAL_RTC_DST_Add1Hour(RTC_HandleTypeDef *hrtc);
738 void              HAL_RTC_DST_Sub1Hour(RTC_HandleTypeDef *hrtc);
739 void              HAL_RTC_DST_SetStoreOperation(RTC_HandleTypeDef *hrtc);
740 void              HAL_RTC_DST_ClearStoreOperation(RTC_HandleTypeDef *hrtc);
741 uint32_t          HAL_RTC_DST_ReadStoreOperation(RTC_HandleTypeDef *hrtc);
742 /**
743   * @}
744   */
745 
746 /** @addtogroup RTC_Exported_Functions_Group5
747   * @{
748   */
749 /* Peripheral State functions *************************************************/
750 HAL_RTCStateTypeDef HAL_RTC_GetState(RTC_HandleTypeDef *hrtc);
751 /**
752   * @}
753   */
754 
755 /**
756   * @}
757   */
758 
759 /* Private types -------------------------------------------------------------*/
760 /* Private variables ---------------------------------------------------------*/
761 /* Private constants ---------------------------------------------------------*/
762 
763 /** @defgroup RTC_Private_Constants RTC Private Constants
764   * @{
765   */
766 /* Masks Definition */
767 #define RTC_TR_RESERVED_MASK    ((uint32_t)(RTC_TR_HT  | RTC_TR_HU  | \
768                                             RTC_TR_MNT | RTC_TR_MNU | \
769                                             RTC_TR_ST  | RTC_TR_SU  | \
770                                             RTC_TR_PM))
771 #define RTC_DR_RESERVED_MASK    ((uint32_t)(RTC_DR_YT | RTC_DR_YU | \
772                                             RTC_DR_MT | RTC_DR_MU | \
773                                             RTC_DR_DT | RTC_DR_DU | \
774                                             RTC_DR_WDU))
775 #define RTC_INIT_MASK           0xFFFFFFFFU
776 #define RTC_RSF_MASK            ((uint32_t)~(RTC_ISR_INIT | RTC_ISR_RSF))
777 #define RTC_FLAGS_MASK          ((uint32_t)(RTC_FLAG_INITF   | RTC_FLAG_INITS  | \
778                                             RTC_FLAG_ALRAF   | RTC_FLAG_ALRAWF | \
779                                             RTC_FLAG_ALRBF   | RTC_FLAG_ALRBWF | \
780                                             RTC_FLAG_WUTF    | RTC_FLAG_WUTWF  | \
781                                             RTC_FLAG_RECALPF | RTC_FLAG_SHPF   | \
782                                             RTC_FLAG_TSF     | RTC_FLAG_TSOVF  | \
783                                             RTC_FLAG_RSF     | RTC_TAMPER_FLAGS_MASK))
784 
785 #define RTC_TIMEOUT_VALUE       1000U
786 
787 #define RTC_EXTI_LINE_ALARM_EVENT  EXTI_IMR_MR17  /*!< External interrupt line 17 Connected to the RTC Alarm event */
788 /**
789   * @}
790   */
791 
792 /* Private macros ------------------------------------------------------------*/
793 
794 /** @defgroup RTC_Private_Macros RTC Private Macros
795   * @{
796   */
797 
798 /** @defgroup RTC_IS_RTC_Definitions RTC Private macros to check input parameters
799   * @{
800   */
801 #define IS_RTC_HOUR_FORMAT(FORMAT)     (((FORMAT) == RTC_HOURFORMAT_12) || \
802                                         ((FORMAT) == RTC_HOURFORMAT_24))
803 
804 #define IS_RTC_OUTPUT(OUTPUT) (((OUTPUT) == RTC_OUTPUT_DISABLE) || \
805                                ((OUTPUT) == RTC_OUTPUT_ALARMA)  || \
806                                ((OUTPUT) == RTC_OUTPUT_ALARMB)  || \
807                                ((OUTPUT) == RTC_OUTPUT_WAKEUP))
808 
809 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OUTPUT_POLARITY_HIGH) || \
810                                 ((POL) == RTC_OUTPUT_POLARITY_LOW))
811 
812 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OUTPUT_TYPE_OPENDRAIN) || \
813                                   ((TYPE) == RTC_OUTPUT_TYPE_PUSHPULL))
814 
815 #define IS_RTC_ASYNCH_PREDIV(PREDIV)   ((PREDIV) <= 0x7FU)
816 #define IS_RTC_SYNCH_PREDIV(PREDIV)    ((PREDIV) <= 0x7FFFU)
817 
818 #define IS_RTC_HOUR12(HOUR)            (((HOUR) > 0U) && ((HOUR) <= 12U))
819 #define IS_RTC_HOUR24(HOUR)            ((HOUR) <= 23U)
820 #define IS_RTC_MINUTES(MINUTES)        ((MINUTES) <= 59U)
821 #define IS_RTC_SECONDS(SECONDS)        ((SECONDS) <= 59U)
822 
823 #define IS_RTC_HOURFORMAT12(PM)  (((PM) == RTC_HOURFORMAT12_AM) || \
824                                   ((PM) == RTC_HOURFORMAT12_PM))
825 
826 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DAYLIGHTSAVING_SUB1H) || \
827                                       ((SAVE) == RTC_DAYLIGHTSAVING_ADD1H) || \
828                                       ((SAVE) == RTC_DAYLIGHTSAVING_NONE))
829 
830 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_STOREOPERATION_RESET) || \
831                                            ((OPERATION) == RTC_STOREOPERATION_SET))
832 
833 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_FORMAT_BIN) || ((FORMAT) == RTC_FORMAT_BCD))
834 
835 #define IS_RTC_YEAR(YEAR)              ((YEAR) <= 99U)
836 #define IS_RTC_MONTH(MONTH)            (((MONTH) >= 1U) && ((MONTH) <= 12U))
837 #define IS_RTC_DATE(DATE)              (((DATE) >= 1U) && ((DATE) <= 31U))
838 
839 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
840                                  ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
841                                  ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
842                                  ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
843                                  ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
844                                  ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
845                                  ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
846 
847 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) > 0U) && ((DATE) <= 31U))
848 
849 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_WEEKDAY_MONDAY)    || \
850                                                     ((WEEKDAY) == RTC_WEEKDAY_TUESDAY)   || \
851                                                     ((WEEKDAY) == RTC_WEEKDAY_WEDNESDAY) || \
852                                                     ((WEEKDAY) == RTC_WEEKDAY_THURSDAY)  || \
853                                                     ((WEEKDAY) == RTC_WEEKDAY_FRIDAY)    || \
854                                                     ((WEEKDAY) == RTC_WEEKDAY_SATURDAY)  || \
855                                                     ((WEEKDAY) == RTC_WEEKDAY_SUNDAY))
856 
857 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_ALARMDATEWEEKDAYSEL_DATE) || \
858                                             ((SEL) == RTC_ALARMDATEWEEKDAYSEL_WEEKDAY))
859 
860 #define IS_RTC_ALARM_MASK(MASK)  (((MASK) & ((uint32_t)~RTC_ALARMMASK_ALL)) == 0U)
861 
862 #define IS_RTC_ALARM(ALARM)      (((ALARM) == RTC_ALARM_A) || ((ALARM) == RTC_ALARM_B))
863 
864 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= RTC_ALRMASSR_SS)
865 
866 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK)   (((MASK) == RTC_ALARMSUBSECONDMASK_ALL)     || \
867                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_1)  || \
868                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_2)  || \
869                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_3)  || \
870                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_4)  || \
871                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_5)  || \
872                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_6)  || \
873                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_7)  || \
874                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_8)  || \
875                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_9)  || \
876                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_10) || \
877                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_11) || \
878                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_12) || \
879                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14_13) || \
880                                               ((MASK) == RTC_ALARMSUBSECONDMASK_SS14)    || \
881                                               ((MASK) == RTC_ALARMSUBSECONDMASK_NONE))
882 /**
883   * @}
884   */
885 
886 /**
887   * @}
888   */
889 
890 /* Private functions ---------------------------------------------------------*/
891 
892 /** @defgroup RTC_Private_Functions RTC Private Functions
893   * @{
894   */
895 HAL_StatusTypeDef  RTC_EnterInitMode(RTC_HandleTypeDef *hrtc);
896 HAL_StatusTypeDef  RTC_ExitInitMode(RTC_HandleTypeDef *hrtc);
897 uint8_t            RTC_ByteToBcd2(uint8_t number);
898 uint8_t            RTC_Bcd2ToByte(uint8_t number);
899 /**
900   * @}
901   */
902 
903 /**
904   * @}
905   */
906 
907 /**
908   * @}
909   */
910 
911 #ifdef __cplusplus
912 }
913 #endif
914 
915 #endif /* STM32F4xx_HAL_RTC_H */
916