Added all the F4 libraries to the project
[fw/stlink] / exampleF4 / STM32F4xx_StdPeriph_Driver / inc / stm32f4xx_rtc.h
1 /**
2   ******************************************************************************
3   * @file    stm32f4xx_rtc.h
4   * @author  MCD Application Team
5   * @version V1.0.0RC1
6   * @date    25-August-2011
7   * @brief   This file contains all the functions prototypes for the RTC firmware
8   *          library.
9   ******************************************************************************
10   * @attention
11   *
12   * THE PRESENT FIRMWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS
13   * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE
14   * TIME. AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY
15   * DIRECT, INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING
16   * FROM THE CONTENT OF SUCH FIRMWARE AND/OR THE USE MADE BY CUSTOMERS OF THE
17   * CODING INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS.
18   *
19   * <h2><center>&copy; COPYRIGHT 2011 STMicroelectronics</center></h2>
20   ****************************************************************************** 
21   */
22
23 /* Define to prevent recursive inclusion -------------------------------------*/
24 #ifndef __STM32F4xx_RTC_H
25 #define __STM32F4xx_RTC_H
26
27 #ifdef __cplusplus
28  extern "C" {
29 #endif
30
31 /* Includes ------------------------------------------------------------------*/
32 #include "stm32f4xx.h"
33
34 /** @addtogroup STM32F4xx_StdPeriph_Driver
35   * @{
36   */
37
38 /** @addtogroup RTC
39   * @{
40   */ 
41
42 /* Exported types ------------------------------------------------------------*/
43
44 /** 
45   * @brief  RTC Init structures definition  
46   */ 
47 typedef struct
48 {
49   uint32_t RTC_HourFormat;   /*!< Specifies the RTC Hour Format.
50                              This parameter can be a value of @ref RTC_Hour_Formats */
51   
52   uint32_t RTC_AsynchPrediv; /*!< Specifies the RTC Asynchronous Predivider value.
53                              This parameter must be set to a value lower than 0x7F */
54   
55   uint32_t RTC_SynchPrediv;  /*!< Specifies the RTC Synchronous Predivider value.
56                              This parameter must be set to a value lower than 0x7FFF */
57 }RTC_InitTypeDef;
58
59 /** 
60   * @brief  RTC Time structure definition  
61   */
62 typedef struct
63 {
64   uint8_t RTC_Hours;    /*!< Specifies the RTC Time Hour.
65                         This parameter must be set to a value in the 0-12 range
66                         if the RTC_HourFormat_12 is selected or 0-23 range if
67                         the RTC_HourFormat_24 is selected. */
68
69   uint8_t RTC_Minutes;  /*!< Specifies the RTC Time Minutes.
70                         This parameter must be set to a value in the 0-59 range. */
71   
72   uint8_t RTC_Seconds;  /*!< Specifies the RTC Time Seconds.
73                         This parameter must be set to a value in the 0-59 range. */
74
75   uint8_t RTC_H12;      /*!< Specifies the RTC AM/PM Time.
76                         This parameter can be a value of @ref RTC_AM_PM_Definitions */
77 }RTC_TimeTypeDef; 
78
79 /** 
80   * @brief  RTC Date structure definition  
81   */
82 typedef struct
83 {
84   uint8_t RTC_WeekDay; /*!< Specifies the RTC Date WeekDay.
85                         This parameter can be a value of @ref RTC_WeekDay_Definitions */
86   
87   uint8_t RTC_Month;   /*!< Specifies the RTC Date Month (in BCD format).
88                         This parameter can be a value of @ref RTC_Month_Date_Definitions */
89
90   uint8_t RTC_Date;     /*!< Specifies the RTC Date.
91                         This parameter must be set to a value in the 1-31 range. */
92   
93   uint8_t RTC_Year;     /*!< Specifies the RTC Date Year.
94                         This parameter must be set to a value in the 0-99 range. */
95 }RTC_DateTypeDef;
96
97 /** 
98   * @brief  RTC Alarm structure definition  
99   */
100 typedef struct
101 {
102   RTC_TimeTypeDef RTC_AlarmTime;     /*!< Specifies the RTC Alarm Time members. */
103
104   uint32_t RTC_AlarmMask;            /*!< Specifies the RTC Alarm Masks.
105                                      This parameter can be a value of @ref RTC_AlarmMask_Definitions */
106
107   uint32_t RTC_AlarmDateWeekDaySel;  /*!< Specifies the RTC Alarm is on Date or WeekDay.
108                                      This parameter can be a value of @ref RTC_AlarmDateWeekDay_Definitions */
109   
110   uint8_t RTC_AlarmDateWeekDay;      /*!< Specifies the RTC Alarm Date/WeekDay.
111                                      If the Alarm Date is selected, this parameter
112                                      must be set to a value in the 1-31 range.
113                                      If the Alarm WeekDay is selected, this 
114                                      parameter can be a value of @ref RTC_WeekDay_Definitions */
115 }RTC_AlarmTypeDef;
116
117 /* Exported constants --------------------------------------------------------*/
118
119 /** @defgroup RTC_Exported_Constants
120   * @{
121   */ 
122
123
124 /** @defgroup RTC_Hour_Formats 
125   * @{
126   */ 
127 #define RTC_HourFormat_24              ((uint32_t)0x00000000)
128 #define RTC_HourFormat_12              ((uint32_t)0x00000040)
129 #define IS_RTC_HOUR_FORMAT(FORMAT)     (((FORMAT) == RTC_HourFormat_12) || \
130                                         ((FORMAT) == RTC_HourFormat_24))
131 /**
132   * @}
133   */ 
134
135 /** @defgroup RTC_Asynchronous_Predivider 
136   * @{
137   */ 
138 #define IS_RTC_ASYNCH_PREDIV(PREDIV)   ((PREDIV) <= 0x7F)
139  
140 /**
141   * @}
142   */ 
143
144
145 /** @defgroup RTC_Synchronous_Predivider 
146   * @{
147   */ 
148 #define IS_RTC_SYNCH_PREDIV(PREDIV)    ((PREDIV) <= 0x7FFF)
149
150 /**
151   * @}
152   */ 
153
154 /** @defgroup RTC_Time_Definitions 
155   * @{
156   */ 
157 #define IS_RTC_HOUR12(HOUR)            (((HOUR) > 0) && ((HOUR) <= 12))
158 #define IS_RTC_HOUR24(HOUR)            ((HOUR) <= 23)
159 #define IS_RTC_MINUTES(MINUTES)        ((MINUTES) <= 59)
160 #define IS_RTC_SECONDS(SECONDS)        ((SECONDS) <= 59)
161
162 /**
163   * @}
164   */ 
165
166 /** @defgroup RTC_AM_PM_Definitions 
167   * @{
168   */ 
169 #define RTC_H12_AM                     ((uint8_t)0x00)
170 #define RTC_H12_PM                     ((uint8_t)0x40)
171 #define IS_RTC_H12(PM) (((PM) == RTC_H12_AM) || ((PM) == RTC_H12_PM))
172
173 /**
174   * @}
175   */ 
176
177 /** @defgroup RTC_Year_Date_Definitions 
178   * @{
179   */ 
180 #define IS_RTC_YEAR(YEAR)              ((YEAR) <= 99)
181
182 /**
183   * @}
184   */ 
185
186 /** @defgroup RTC_Month_Date_Definitions 
187   * @{
188   */ 
189
190 /* Coded in BCD format */
191 #define RTC_Month_January              ((uint8_t)0x01)
192 #define RTC_Month_February             ((uint8_t)0x02)
193 #define RTC_Month_March                ((uint8_t)0x03)
194 #define RTC_Month_April                ((uint8_t)0x04)
195 #define RTC_Month_May                  ((uint8_t)0x05)
196 #define RTC_Month_June                 ((uint8_t)0x06)
197 #define RTC_Month_July                 ((uint8_t)0x07)
198 #define RTC_Month_August               ((uint8_t)0x08)
199 #define RTC_Month_September            ((uint8_t)0x09)
200 #define RTC_Month_October              ((uint8_t)0x10)
201 #define RTC_Month_November             ((uint8_t)0x11)
202 #define RTC_Month_December             ((uint8_t)0x12)
203 #define IS_RTC_MONTH(MONTH)            (((MONTH) >= 1) && ((MONTH) <= 12))
204 #define IS_RTC_DATE(DATE)              (((DATE) >= 1) && ((DATE) <= 31))
205
206 /**
207   * @}
208   */ 
209
210 /** @defgroup RTC_WeekDay_Definitions 
211   * @{
212   */ 
213   
214 #define RTC_Weekday_Monday             ((uint8_t)0x01)
215 #define RTC_Weekday_Tuesday            ((uint8_t)0x02)
216 #define RTC_Weekday_Wednesday          ((uint8_t)0x03)
217 #define RTC_Weekday_Thursday           ((uint8_t)0x04)
218 #define RTC_Weekday_Friday             ((uint8_t)0x05)
219 #define RTC_Weekday_Saturday           ((uint8_t)0x06)
220 #define RTC_Weekday_Sunday             ((uint8_t)0x07)
221 #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_Weekday_Monday) || \
222                                  ((WEEKDAY) == RTC_Weekday_Tuesday) || \
223                                  ((WEEKDAY) == RTC_Weekday_Wednesday) || \
224                                  ((WEEKDAY) == RTC_Weekday_Thursday) || \
225                                  ((WEEKDAY) == RTC_Weekday_Friday) || \
226                                  ((WEEKDAY) == RTC_Weekday_Saturday) || \
227                                  ((WEEKDAY) == RTC_Weekday_Sunday))
228 /**
229   * @}
230   */ 
231
232
233 /** @defgroup RTC_Alarm_Definitions
234   * @{
235   */ 
236 #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) > 0) && ((DATE) <= 31))
237 #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_Weekday_Monday) || \
238                                                     ((WEEKDAY) == RTC_Weekday_Tuesday) || \
239                                                     ((WEEKDAY) == RTC_Weekday_Wednesday) || \
240                                                     ((WEEKDAY) == RTC_Weekday_Thursday) || \
241                                                     ((WEEKDAY) == RTC_Weekday_Friday) || \
242                                                     ((WEEKDAY) == RTC_Weekday_Saturday) || \
243                                                     ((WEEKDAY) == RTC_Weekday_Sunday))
244
245 /**
246   * @}
247   */ 
248
249
250 /** @defgroup RTC_AlarmDateWeekDay_Definitions 
251   * @{
252   */ 
253 #define RTC_AlarmDateWeekDaySel_Date      ((uint32_t)0x00000000)
254 #define RTC_AlarmDateWeekDaySel_WeekDay   ((uint32_t)0x40000000)
255
256 #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_AlarmDateWeekDaySel_Date) || \
257                                             ((SEL) == RTC_AlarmDateWeekDaySel_WeekDay))
258
259 /**
260   * @}
261   */ 
262
263
264 /** @defgroup RTC_AlarmMask_Definitions 
265   * @{
266   */ 
267 #define RTC_AlarmMask_None                ((uint32_t)0x00000000)
268 #define RTC_AlarmMask_DateWeekDay         ((uint32_t)0x80000000)
269 #define RTC_AlarmMask_Hours               ((uint32_t)0x00800000)
270 #define RTC_AlarmMask_Minutes             ((uint32_t)0x00008000)
271 #define RTC_AlarmMask_Seconds             ((uint32_t)0x00000080)
272 #define RTC_AlarmMask_All                 ((uint32_t)0x80808080)
273 #define IS_ALARM_MASK(MASK)  (((MASK) & 0x7F7F7F7F) == (uint32_t)RESET)
274
275 /**
276   * @}
277   */ 
278
279 /** @defgroup RTC_Alarms_Definitions 
280   * @{
281   */ 
282 #define RTC_Alarm_A                       ((uint32_t)0x00000100)
283 #define RTC_Alarm_B                       ((uint32_t)0x00000200)
284 #define IS_RTC_ALARM(ALARM)     (((ALARM) == RTC_Alarm_A) || ((ALARM) == RTC_Alarm_B))
285 #define IS_RTC_CMD_ALARM(ALARM) (((ALARM) & (RTC_Alarm_A | RTC_Alarm_B)) != (uint32_t)RESET)
286
287 /**
288   * @}
289   */ 
290
291   /** @defgroup RTC_Alarm_Sub_Seconds_Masks_Definitions
292   * @{
293   */ 
294 #define RTC_AlarmSubSecondMask_All         ((uint32_t)0x00000000) /*!< All Alarm SS fields are masked. 
295                                                                        There is no comparison on sub seconds 
296                                                                        for Alarm */
297 #define RTC_AlarmSubSecondMask_SS14_1      ((uint32_t)0x01000000) /*!< SS[14:1] are don't care in Alarm 
298                                                                        comparison. Only SS[0] is compared. */
299 #define RTC_AlarmSubSecondMask_SS14_2      ((uint32_t)0x02000000) /*!< SS[14:2] are don't care in Alarm 
300                                                                        comparison. Only SS[1:0] are compared */
301 #define RTC_AlarmSubSecondMask_SS14_3      ((uint32_t)0x03000000) /*!< SS[14:3] are don't care in Alarm 
302                                                                        comparison. Only SS[2:0] are compared */
303 #define RTC_AlarmSubSecondMask_SS14_4      ((uint32_t)0x04000000) /*!< SS[14:4] are don't care in Alarm 
304                                                                        comparison. Only SS[3:0] are compared */
305 #define RTC_AlarmSubSecondMask_SS14_5      ((uint32_t)0x05000000) /*!< SS[14:5] are don't care in Alarm 
306                                                                        comparison. Only SS[4:0] are compared */
307 #define RTC_AlarmSubSecondMask_SS14_6      ((uint32_t)0x06000000) /*!< SS[14:6] are don't care in Alarm 
308                                                                        comparison. Only SS[5:0] are compared */
309 #define RTC_AlarmSubSecondMask_SS14_7      ((uint32_t)0x07000000) /*!< SS[14:7] are don't care in Alarm 
310                                                                        comparison. Only SS[6:0] are compared */
311 #define RTC_AlarmSubSecondMask_SS14_8      ((uint32_t)0x08000000) /*!< SS[14:8] are don't care in Alarm 
312                                                                        comparison. Only SS[7:0] are compared */
313 #define RTC_AlarmSubSecondMask_SS14_9      ((uint32_t)0x09000000) /*!< SS[14:9] are don't care in Alarm 
314                                                                        comparison. Only SS[8:0] are compared */
315 #define RTC_AlarmSubSecondMask_SS14_10     ((uint32_t)0x0A000000) /*!< SS[14:10] are don't care in Alarm 
316                                                                        comparison. Only SS[9:0] are compared */
317 #define RTC_AlarmSubSecondMask_SS14_11     ((uint32_t)0x0B000000) /*!< SS[14:11] are don't care in Alarm 
318                                                                        comparison. Only SS[10:0] are compared */
319 #define RTC_AlarmSubSecondMask_SS14_12     ((uint32_t)0x0C000000) /*!< SS[14:12] are don't care in Alarm 
320                                                                        comparison.Only SS[11:0] are compared */
321 #define RTC_AlarmSubSecondMask_SS14_13     ((uint32_t)0x0D000000) /*!< SS[14:13] are don't care in Alarm 
322                                                                        comparison. Only SS[12:0] are compared */
323 #define RTC_AlarmSubSecondMask_SS14        ((uint32_t)0x0E000000) /*!< SS[14] is don't care in Alarm 
324                                                                        comparison.Only SS[13:0] are compared */
325 #define RTC_AlarmSubSecondMask_None        ((uint32_t)0x0F000000) /*!< SS[14:0] are compared and must match 
326                                                                        to activate alarm. */
327 #define IS_RTC_ALARM_SUB_SECOND_MASK(MASK)   (((MASK) == RTC_AlarmSubSecondMask_All) || \
328                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_1) || \
329                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_2) || \
330                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_3) || \
331                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_4) || \
332                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_5) || \
333                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_6) || \
334                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_7) || \
335                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_8) || \
336                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_9) || \
337                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_10) || \
338                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_11) || \
339                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_12) || \
340                                               ((MASK) == RTC_AlarmSubSecondMask_SS14_13) || \
341                                               ((MASK) == RTC_AlarmSubSecondMask_SS14) || \
342                                               ((MASK) == RTC_AlarmSubSecondMask_None))
343 /**
344   * @}
345   */ 
346
347 /** @defgroup RTC_Alarm_Sub_Seconds_Value
348   * @{
349   */ 
350
351 #define IS_RTC_ALARM_SUB_SECOND_VALUE(VALUE) ((VALUE) <= 0x00007FFF)
352
353 /**
354   * @}
355   */ 
356
357 /** @defgroup RTC_Wakeup_Timer_Definitions 
358   * @{
359   */ 
360 #define RTC_WakeUpClock_RTCCLK_Div16        ((uint32_t)0x00000000)
361 #define RTC_WakeUpClock_RTCCLK_Div8         ((uint32_t)0x00000001)
362 #define RTC_WakeUpClock_RTCCLK_Div4         ((uint32_t)0x00000002)
363 #define RTC_WakeUpClock_RTCCLK_Div2         ((uint32_t)0x00000003)
364 #define RTC_WakeUpClock_CK_SPRE_16bits      ((uint32_t)0x00000004)
365 #define RTC_WakeUpClock_CK_SPRE_17bits      ((uint32_t)0x00000006)
366 #define IS_RTC_WAKEUP_CLOCK(CLOCK) (((CLOCK) == RTC_WakeUpClock_RTCCLK_Div16) || \
367                                     ((CLOCK) == RTC_WakeUpClock_RTCCLK_Div8) || \
368                                     ((CLOCK) == RTC_WakeUpClock_RTCCLK_Div4) || \
369                                     ((CLOCK) == RTC_WakeUpClock_RTCCLK_Div2) || \
370                                     ((CLOCK) == RTC_WakeUpClock_CK_SPRE_16bits) || \
371                                     ((CLOCK) == RTC_WakeUpClock_CK_SPRE_17bits))
372 #define IS_RTC_WAKEUP_COUNTER(COUNTER)  ((COUNTER) <= 0xFFFF)
373 /**
374   * @}
375   */ 
376
377 /** @defgroup RTC_Time_Stamp_Edges_definitions 
378   * @{
379   */ 
380 #define RTC_TimeStampEdge_Rising          ((uint32_t)0x00000000)
381 #define RTC_TimeStampEdge_Falling         ((uint32_t)0x00000008)
382 #define IS_RTC_TIMESTAMP_EDGE(EDGE) (((EDGE) == RTC_TimeStampEdge_Rising) || \
383                                      ((EDGE) == RTC_TimeStampEdge_Falling))
384 /**
385   * @}
386   */ 
387
388 /** @defgroup RTC_Output_selection_Definitions 
389   * @{
390   */ 
391 #define RTC_Output_Disable             ((uint32_t)0x00000000)
392 #define RTC_Output_AlarmA              ((uint32_t)0x00200000)
393 #define RTC_Output_AlarmB              ((uint32_t)0x00400000)
394 #define RTC_Output_WakeUp              ((uint32_t)0x00600000)
395  
396 #define IS_RTC_OUTPUT(OUTPUT) (((OUTPUT) == RTC_Output_Disable) || \
397                                ((OUTPUT) == RTC_Output_AlarmA) || \
398                                ((OUTPUT) == RTC_Output_AlarmB) || \
399                                ((OUTPUT) == RTC_Output_WakeUp))
400
401 /**
402   * @}
403   */ 
404
405 /** @defgroup RTC_Output_Polarity_Definitions 
406   * @{
407   */ 
408 #define RTC_OutputPolarity_High           ((uint32_t)0x00000000)
409 #define RTC_OutputPolarity_Low            ((uint32_t)0x00100000)
410 #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OutputPolarity_High) || \
411                                 ((POL) == RTC_OutputPolarity_Low))
412 /**
413   * @}
414   */ 
415
416
417 /** @defgroup RTC_Digital_Calibration_Definitions 
418   * @{
419   */ 
420 #define RTC_CalibSign_Positive            ((uint32_t)0x00000000) 
421 #define RTC_CalibSign_Negative            ((uint32_t)0x00000080)
422 #define IS_RTC_CALIB_SIGN(SIGN) (((SIGN) == RTC_CalibSign_Positive) || \
423                                  ((SIGN) == RTC_CalibSign_Negative))
424 #define IS_RTC_CALIB_VALUE(VALUE) ((VALUE) < 0x20)
425
426 /**
427   * @}
428   */ 
429
430  /** @defgroup RTC_Calib_Output_selection_Definitions 
431   * @{
432   */ 
433 #define RTC_CalibOutput_512Hz            ((uint32_t)0x00000000) 
434 #define RTC_CalibOutput_1Hz              ((uint32_t)0x00080000)
435 #define IS_RTC_CALIB_OUTPUT(OUTPUT)  (((OUTPUT) == RTC_CalibOutput_512Hz) || \
436                                       ((OUTPUT) == RTC_CalibOutput_1Hz))
437 /**
438   * @}
439   */ 
440
441 /** @defgroup RTC_Smooth_calib_period_Definitions 
442   * @{
443   */ 
444 #define RTC_SmoothCalibPeriod_32sec   ((uint32_t)0x00000000) /*!<  if RTCCLK = 32768 Hz, Smooth calibation
445                                                              period is 32s,  else 2exp20 RTCCLK seconds */
446 #define RTC_SmoothCalibPeriod_16sec   ((uint32_t)0x00002000) /*!<  if RTCCLK = 32768 Hz, Smooth calibation 
447                                                              period is 16s, else 2exp19 RTCCLK seconds */
448 #define RTC_SmoothCalibPeriod_8sec    ((uint32_t)0x00004000) /*!<  if RTCCLK = 32768 Hz, Smooth calibation 
449                                                              period is 8s, else 2exp18 RTCCLK seconds */
450 #define IS_RTC_SMOOTH_CALIB_PERIOD(PERIOD) (((PERIOD) == RTC_SmoothCalibPeriod_32sec) || \
451                                              ((PERIOD) == RTC_SmoothCalibPeriod_16sec) || \
452                                              ((PERIOD) == RTC_SmoothCalibPeriod_8sec))
453                                           
454 /**
455   * @}
456   */ 
457
458 /** @defgroup RTC_Smooth_calib_Plus_pulses_Definitions 
459   * @{
460   */ 
461 #define RTC_SmoothCalibPlusPulses_Set    ((uint32_t)0x00008000) /*!<  The number of RTCCLK pulses added  
462                                                                 during a X -second window = Y - CALM[8:0]. 
463                                                                  with Y = 512, 256, 128 when X = 32, 16, 8 */
464 #define RTC_SmoothCalibPlusPulses_Reset  ((uint32_t)0x00000000) /*!<  The number of RTCCLK pulses subbstited
465                                                                  during a 32-second window =   CALM[8:0]. */
466 #define IS_RTC_SMOOTH_CALIB_PLUS(PLUS) (((PLUS) == RTC_SmoothCalibPlusPulses_Set) || \
467                                          ((PLUS) == RTC_SmoothCalibPlusPulses_Reset))
468
469 /**
470   * @}
471   */ 
472
473 /** @defgroup RTC_Smooth_calib_Minus_pulses_Definitions 
474   * @{
475   */ 
476 #define  IS_RTC_SMOOTH_CALIB_MINUS(VALUE) ((VALUE) <= 0x000001FF)
477
478 /**
479   * @}
480   */
481
482 /** @defgroup RTC_DayLightSaving_Definitions 
483   * @{
484   */ 
485 #define RTC_DayLightSaving_SUB1H   ((uint32_t)0x00020000)
486 #define RTC_DayLightSaving_ADD1H   ((uint32_t)0x00010000)
487 #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DayLightSaving_SUB1H) || \
488                                       ((SAVE) == RTC_DayLightSaving_ADD1H))
489
490 #define RTC_StoreOperation_Reset        ((uint32_t)0x00000000)
491 #define RTC_StoreOperation_Set          ((uint32_t)0x00040000)
492 #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_StoreOperation_Reset) || \
493                                            ((OPERATION) == RTC_StoreOperation_Set))
494 /**
495   * @}
496   */ 
497
498 /** @defgroup RTC_Tamper_Trigger_Definitions 
499   * @{
500   */ 
501 #define RTC_TamperTrigger_RisingEdge            ((uint32_t)0x00000000)
502 #define RTC_TamperTrigger_FallingEdge           ((uint32_t)0x00000001)
503 #define RTC_TamperTrigger_LowLevel              ((uint32_t)0x00000000)
504 #define RTC_TamperTrigger_HighLevel             ((uint32_t)0x00000001)
505 #define IS_RTC_TAMPER_TRIGGER(TRIGGER) (((TRIGGER) == RTC_TamperTrigger_RisingEdge) || \
506                                         ((TRIGGER) == RTC_TamperTrigger_FallingEdge) || \
507                                         ((TRIGGER) == RTC_TamperTrigger_LowLevel) || \
508                                         ((TRIGGER) == RTC_TamperTrigger_HighLevel)) 
509
510 /**
511   * @}
512   */ 
513
514 /** @defgroup RTC_Tamper_Filter_Definitions 
515   * @{
516   */ 
517 #define RTC_TamperFilter_Disable   ((uint32_t)0x00000000) /*!< Tamper filter is disabled */
518
519 #define RTC_TamperFilter_2Sample   ((uint32_t)0x00000800) /*!< Tamper is activated after 2 
520                                                           consecutive samples at the active level */
521 #define RTC_TamperFilter_4Sample   ((uint32_t)0x00001000) /*!< Tamper is activated after 4 
522                                                           consecutive samples at the active level */
523 #define RTC_TamperFilter_8Sample   ((uint32_t)0x00001800) /*!< Tamper is activated after 8 
524                                                           consecutive samples at the active leve. */
525 #define IS_RTC_TAMPER_FILTER(FILTER) (((FILTER) == RTC_TamperFilter_Disable) || \
526                                       ((FILTER) == RTC_TamperFilter_2Sample) || \
527                                       ((FILTER) == RTC_TamperFilter_4Sample) || \
528                                       ((FILTER) == RTC_TamperFilter_8Sample))
529 /**
530   * @}
531   */ 
532
533 /** @defgroup RTC_Tamper_Sampling_Frequencies_Definitions 
534   * @{
535   */ 
536 #define RTC_TamperSamplingFreq_RTCCLK_Div32768  ((uint32_t)0x00000000) /*!< Each of the tamper inputs are sampled
537                                                                            with a frequency =  RTCCLK / 32768 */
538 #define RTC_TamperSamplingFreq_RTCCLK_Div16384  ((uint32_t)0x000000100) /*!< Each of the tamper inputs are sampled
539                                                                             with a frequency =  RTCCLK / 16384 */
540 #define RTC_TamperSamplingFreq_RTCCLK_Div8192   ((uint32_t)0x00000200) /*!< Each of the tamper inputs are sampled
541                                                                            with a frequency =  RTCCLK / 8192  */
542 #define RTC_TamperSamplingFreq_RTCCLK_Div4096   ((uint32_t)0x00000300) /*!< Each of the tamper inputs are sampled
543                                                                            with a frequency =  RTCCLK / 4096  */
544 #define RTC_TamperSamplingFreq_RTCCLK_Div2048   ((uint32_t)0x00000400) /*!< Each of the tamper inputs are sampled
545                                                                            with a frequency =  RTCCLK / 2048  */
546 #define RTC_TamperSamplingFreq_RTCCLK_Div1024   ((uint32_t)0x00000500) /*!< Each of the tamper inputs are sampled
547                                                                            with a frequency =  RTCCLK / 1024  */
548 #define RTC_TamperSamplingFreq_RTCCLK_Div512    ((uint32_t)0x00000600) /*!< Each of the tamper inputs are sampled
549                                                                            with a frequency =  RTCCLK / 512   */
550 #define RTC_TamperSamplingFreq_RTCCLK_Div256    ((uint32_t)0x00000700) /*!< Each of the tamper inputs are sampled
551                                                                            with a frequency =  RTCCLK / 256   */
552 #define IS_RTC_TAMPER_SAMPLING_FREQ(FREQ) (((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div32768) || \
553                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div16384) || \
554                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div8192) || \
555                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div4096) || \
556                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div2048) || \
557                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div1024) || \
558                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div512) || \
559                                            ((FREQ) ==RTC_TamperSamplingFreq_RTCCLK_Div256))
560
561 /**
562   * @}
563   */
564
565   /** @defgroup RTC_Tamper_Pin_Precharge_Duration_Definitions 
566   * @{
567   */ 
568 #define RTC_TamperPrechargeDuration_1RTCCLK ((uint32_t)0x00000000)  /*!< Tamper pins are pre-charged before 
569                                                                          sampling during 1 RTCCLK cycle */
570 #define RTC_TamperPrechargeDuration_2RTCCLK ((uint32_t)0x00002000)  /*!< Tamper pins are pre-charged before 
571                                                                          sampling during 2 RTCCLK cycles */
572 #define RTC_TamperPrechargeDuration_4RTCCLK ((uint32_t)0x00004000)  /*!< Tamper pins are pre-charged before 
573                                                                          sampling during 4 RTCCLK cycles */
574 #define RTC_TamperPrechargeDuration_8RTCCLK ((uint32_t)0x00006000)  /*!< Tamper pins are pre-charged before 
575                                                                          sampling during 8 RTCCLK cycles */
576
577 #define IS_RTC_TAMPER_PRECHARGE_DURATION(DURATION) (((DURATION) == RTC_TamperPrechargeDuration_1RTCCLK) || \
578                                                     ((DURATION) == RTC_TamperPrechargeDuration_2RTCCLK) || \
579                                                     ((DURATION) == RTC_TamperPrechargeDuration_4RTCCLK) || \
580                                                     ((DURATION) == RTC_TamperPrechargeDuration_8RTCCLK))
581 /**
582   * @}
583   */
584
585 /** @defgroup RTC_Tamper_Pins_Definitions 
586   * @{
587   */ 
588 #define RTC_Tamper_1                    RTC_TAFCR_TAMP1E
589 #define IS_RTC_TAMPER(TAMPER) (((TAMPER) == RTC_Tamper_1))
590
591 /**
592   * @}
593   */
594
595 /** @defgroup RTC_Tamper_Pin_Selection 
596   * @{
597   */ 
598 #define RTC_TamperPin_PC13                 ((uint32_t)0x00000000)
599 #define RTC_TamperPin_PI8                  ((uint32_t)0x00010000)
600 #define IS_RTC_TAMPER_PIN(PIN) (((PIN) == RTC_TamperPin_PC13) || \
601                                 ((PIN) == RTC_TamperPin_PI8))
602 /**
603   * @}
604   */ 
605
606 /** @defgroup RTC_TimeStamp_Pin_Selection 
607   * @{
608   */ 
609 #define RTC_TimeStampPin_PC13              ((uint32_t)0x00000000)
610 #define RTC_TimeStampPin_PI8               ((uint32_t)0x00020000)
611 #define IS_RTC_TIMESTAMP_PIN(PIN) (((PIN) == RTC_TimeStampPin_PC13) || \
612                                    ((PIN) == RTC_TimeStampPin_PI8))
613 /**
614   * @}
615   */ 
616
617 /** @defgroup RTC_Output_Type_ALARM_OUT 
618   * @{
619   */ 
620 #define RTC_OutputType_OpenDrain           ((uint32_t)0x00000000)
621 #define RTC_OutputType_PushPull            ((uint32_t)0x00040000)
622 #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OutputType_OpenDrain) || \
623                                   ((TYPE) == RTC_OutputType_PushPull))
624
625 /**
626   * @}
627   */ 
628
629 /** @defgroup RTC_Add_1_Second_Parameter_Definitions
630   * @{
631   */ 
632 #define RTC_ShiftAdd1S_Reset      ((uint32_t)0x00000000)
633 #define RTC_ShiftAdd1S_Set        ((uint32_t)0x80000000)
634 #define IS_RTC_SHIFT_ADD1S(SEL) (((SEL) == RTC_ShiftAdd1S_Reset) || \
635                                  ((SEL) == RTC_ShiftAdd1S_Set))
636 /**
637   * @}
638   */ 
639
640 /** @defgroup RTC_Substract_Fraction_Of_Second_Value
641   * @{
642   */ 
643 #define IS_RTC_SHIFT_SUBFS(FS) ((FS) <= 0x00007FFF)
644
645 /**
646   * @}
647   */
648
649 /** @defgroup RTC_Backup_Registers_Definitions 
650   * @{
651   */
652
653 #define RTC_BKP_DR0                       ((uint32_t)0x00000000)
654 #define RTC_BKP_DR1                       ((uint32_t)0x00000001)
655 #define RTC_BKP_DR2                       ((uint32_t)0x00000002)
656 #define RTC_BKP_DR3                       ((uint32_t)0x00000003)
657 #define RTC_BKP_DR4                       ((uint32_t)0x00000004)
658 #define RTC_BKP_DR5                       ((uint32_t)0x00000005)
659 #define RTC_BKP_DR6                       ((uint32_t)0x00000006)
660 #define RTC_BKP_DR7                       ((uint32_t)0x00000007)
661 #define RTC_BKP_DR8                       ((uint32_t)0x00000008)
662 #define RTC_BKP_DR9                       ((uint32_t)0x00000009)
663 #define RTC_BKP_DR10                      ((uint32_t)0x0000000A)
664 #define RTC_BKP_DR11                      ((uint32_t)0x0000000B)
665 #define RTC_BKP_DR12                      ((uint32_t)0x0000000C)
666 #define RTC_BKP_DR13                      ((uint32_t)0x0000000D)
667 #define RTC_BKP_DR14                      ((uint32_t)0x0000000E)
668 #define RTC_BKP_DR15                      ((uint32_t)0x0000000F)
669 #define RTC_BKP_DR16                      ((uint32_t)0x00000010)
670 #define RTC_BKP_DR17                      ((uint32_t)0x00000011)
671 #define RTC_BKP_DR18                      ((uint32_t)0x00000012)
672 #define RTC_BKP_DR19                      ((uint32_t)0x00000013)
673 #define IS_RTC_BKP(BKP)                   (((BKP) == RTC_BKP_DR0) || \
674                                            ((BKP) == RTC_BKP_DR1) || \
675                                            ((BKP) == RTC_BKP_DR2) || \
676                                            ((BKP) == RTC_BKP_DR3) || \
677                                            ((BKP) == RTC_BKP_DR4) || \
678                                            ((BKP) == RTC_BKP_DR5) || \
679                                            ((BKP) == RTC_BKP_DR6) || \
680                                            ((BKP) == RTC_BKP_DR7) || \
681                                            ((BKP) == RTC_BKP_DR8) || \
682                                            ((BKP) == RTC_BKP_DR9) || \
683                                            ((BKP) == RTC_BKP_DR10) || \
684                                            ((BKP) == RTC_BKP_DR11) || \
685                                            ((BKP) == RTC_BKP_DR12) || \
686                                            ((BKP) == RTC_BKP_DR13) || \
687                                            ((BKP) == RTC_BKP_DR14) || \
688                                            ((BKP) == RTC_BKP_DR15) || \
689                                            ((BKP) == RTC_BKP_DR16) || \
690                                            ((BKP) == RTC_BKP_DR17) || \
691                                            ((BKP) == RTC_BKP_DR18) || \
692                                            ((BKP) == RTC_BKP_DR19))
693 /**
694   * @}
695   */ 
696
697 /** @defgroup RTC_Input_parameter_format_definitions 
698   * @{
699   */ 
700 #define RTC_Format_BIN                    ((uint32_t)0x000000000)
701 #define RTC_Format_BCD                    ((uint32_t)0x000000001)
702 #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_Format_BIN) || ((FORMAT) == RTC_Format_BCD))
703
704 /**
705   * @}
706   */ 
707
708 /** @defgroup RTC_Flags_Definitions 
709   * @{
710   */ 
711 #define RTC_FLAG_RECALPF                  ((uint32_t)0x00010000)
712 #define RTC_FLAG_TAMP1F                   ((uint32_t)0x00002000)
713 #define RTC_FLAG_TSOVF                    ((uint32_t)0x00001000)
714 #define RTC_FLAG_TSF                      ((uint32_t)0x00000800)
715 #define RTC_FLAG_WUTF                     ((uint32_t)0x00000400)
716 #define RTC_FLAG_ALRBF                    ((uint32_t)0x00000200)
717 #define RTC_FLAG_ALRAF                    ((uint32_t)0x00000100)
718 #define RTC_FLAG_INITF                    ((uint32_t)0x00000040)
719 #define RTC_FLAG_RSF                      ((uint32_t)0x00000020)
720 #define RTC_FLAG_INITS                    ((uint32_t)0x00000010)
721 #define RTC_FLAG_SHPF                     ((uint32_t)0x00000008)
722 #define RTC_FLAG_WUTWF                    ((uint32_t)0x00000004)
723 #define RTC_FLAG_ALRBWF                   ((uint32_t)0x00000002)
724 #define RTC_FLAG_ALRAWF                   ((uint32_t)0x00000001)
725 #define IS_RTC_GET_FLAG(FLAG) (((FLAG) == RTC_FLAG_TSOVF) || ((FLAG) == RTC_FLAG_TSF) || \
726                                ((FLAG) == RTC_FLAG_WUTF) || ((FLAG) == RTC_FLAG_ALRBF) || \
727                                ((FLAG) == RTC_FLAG_ALRAF) || ((FLAG) == RTC_FLAG_INITF) || \
728                                ((FLAG) == RTC_FLAG_RSF) || ((FLAG) == RTC_FLAG_WUTWF) || \
729                                ((FLAG) == RTC_FLAG_ALRBWF) || ((FLAG) == RTC_FLAG_ALRAWF) || \
730                                ((FLAG) == RTC_FLAG_TAMP1F) || ((FLAG) == RTC_FLAG_RECALPF) || \
731                                 ((FLAG) == RTC_FLAG_SHPF))
732 #define IS_RTC_CLEAR_FLAG(FLAG) (((FLAG) != (uint32_t)RESET) && (((FLAG) & 0xFFFF00DF) == (uint32_t)RESET))
733 /**
734   * @}
735   */ 
736
737 /** @defgroup RTC_Interrupts_Definitions 
738   * @{
739   */ 
740 #define RTC_IT_TS                         ((uint32_t)0x00008000)
741 #define RTC_IT_WUT                        ((uint32_t)0x00004000)
742 #define RTC_IT_ALRB                       ((uint32_t)0x00002000)
743 #define RTC_IT_ALRA                       ((uint32_t)0x00001000)
744 #define RTC_IT_TAMP                       ((uint32_t)0x00000004) /* Used only to Enable the Tamper Interrupt */
745 #define RTC_IT_TAMP1                      ((uint32_t)0x00020000)
746
747 #define IS_RTC_CONFIG_IT(IT) (((IT) != (uint32_t)RESET) && (((IT) & 0xFFFF0FFB) == (uint32_t)RESET))
748 #define IS_RTC_GET_IT(IT) (((IT) == RTC_IT_TS) || ((IT) == RTC_IT_WUT) || \
749                            ((IT) == RTC_IT_ALRB) || ((IT) == RTC_IT_ALRA) || \
750                            ((IT) == RTC_IT_TAMP1))
751 #define IS_RTC_CLEAR_IT(IT) (((IT) != (uint32_t)RESET) && (((IT) & 0xFFFD0FFF) == (uint32_t)RESET))
752
753 /**
754   * @}
755   */ 
756
757 /** @defgroup RTC_Legacy 
758   * @{
759   */ 
760 #define RTC_DigitalCalibConfig  RTC_CoarseCalibConfig
761 #define RTC_DigitalCalibCmd     RTC_CoarseCalibCmd
762
763 /**
764   * @}
765   */ 
766
767 /**
768   * @}
769   */ 
770
771 /* Exported macro ------------------------------------------------------------*/
772 /* Exported functions --------------------------------------------------------*/ 
773
774 /*  Function used to set the RTC configuration to the default reset state *****/
775 ErrorStatus RTC_DeInit(void);
776
777 /* Initialization and Configuration functions *********************************/
778 ErrorStatus RTC_Init(RTC_InitTypeDef* RTC_InitStruct);
779 void RTC_StructInit(RTC_InitTypeDef* RTC_InitStruct);
780 void RTC_WriteProtectionCmd(FunctionalState NewState);
781 ErrorStatus RTC_EnterInitMode(void);
782 void RTC_ExitInitMode(void);
783 ErrorStatus RTC_WaitForSynchro(void);
784 ErrorStatus RTC_RefClockCmd(FunctionalState NewState);
785 void RTC_BypassShadowCmd(FunctionalState NewState);
786
787 /* Time and Date configuration functions **************************************/
788 ErrorStatus RTC_SetTime(uint32_t RTC_Format, RTC_TimeTypeDef* RTC_TimeStruct);
789 void RTC_TimeStructInit(RTC_TimeTypeDef* RTC_TimeStruct);
790 void RTC_GetTime(uint32_t RTC_Format, RTC_TimeTypeDef* RTC_TimeStruct);
791 uint32_t RTC_GetSubSecond(void);
792 ErrorStatus RTC_SetDate(uint32_t RTC_Format, RTC_DateTypeDef* RTC_DateStruct);
793 void RTC_DateStructInit(RTC_DateTypeDef* RTC_DateStruct);
794 void RTC_GetDate(uint32_t RTC_Format, RTC_DateTypeDef* RTC_DateStruct);
795
796 /* Alarms (Alarm A and Alarm B) configuration functions  **********************/
797 void RTC_SetAlarm(uint32_t RTC_Format, uint32_t RTC_Alarm, RTC_AlarmTypeDef* RTC_AlarmStruct);
798 void RTC_AlarmStructInit(RTC_AlarmTypeDef* RTC_AlarmStruct);
799 void RTC_GetAlarm(uint32_t RTC_Format, uint32_t RTC_Alarm, RTC_AlarmTypeDef* RTC_AlarmStruct);
800 ErrorStatus RTC_AlarmCmd(uint32_t RTC_Alarm, FunctionalState NewState);
801 void RTC_AlarmSubSecondConfig(uint32_t RTC_Alarm, uint32_t RTC_AlarmSubSecondValue, uint32_t RTC_AlarmSubSecondMask);
802 uint32_t RTC_GetAlarmSubSecond(uint32_t RTC_Alarm);
803
804 /* WakeUp Timer configuration functions ***************************************/
805 void RTC_WakeUpClockConfig(uint32_t RTC_WakeUpClock);
806 void RTC_SetWakeUpCounter(uint32_t RTC_WakeUpCounter);
807 uint32_t RTC_GetWakeUpCounter(void);
808 ErrorStatus RTC_WakeUpCmd(FunctionalState NewState);
809
810 /* Daylight Saving configuration functions ************************************/
811 void RTC_DayLightSavingConfig(uint32_t RTC_DayLightSaving, uint32_t RTC_StoreOperation);
812 uint32_t RTC_GetStoreOperation(void);
813
814 /* Output pin Configuration function ******************************************/
815 void RTC_OutputConfig(uint32_t RTC_Output, uint32_t RTC_OutputPolarity);
816
817 /* Digital Calibration configuration functions *********************************/
818 ErrorStatus RTC_CoarseCalibConfig(uint32_t RTC_CalibSign, uint32_t Value);
819 ErrorStatus RTC_CoarseCalibCmd(FunctionalState NewState);
820 void RTC_CalibOutputCmd(FunctionalState NewState);
821 void RTC_CalibOutputConfig(uint32_t RTC_CalibOutput);
822 ErrorStatus RTC_SmoothCalibConfig(uint32_t RTC_SmoothCalibPeriod, 
823                                   uint32_t RTC_SmoothCalibPlusPulses,
824                                   uint32_t RTC_SmouthCalibMinusPulsesValue);
825
826 /* TimeStamp configuration functions ******************************************/
827 void RTC_TimeStampCmd(uint32_t RTC_TimeStampEdge, FunctionalState NewState);
828 void RTC_GetTimeStamp(uint32_t RTC_Format, RTC_TimeTypeDef* RTC_StampTimeStruct,
829                                       RTC_DateTypeDef* RTC_StampDateStruct);
830 uint32_t RTC_GetTimeStampSubSecond(void);
831
832 /* Tampers configuration functions ********************************************/
833 void RTC_TamperTriggerConfig(uint32_t RTC_Tamper, uint32_t RTC_TamperTrigger);
834 void RTC_TamperCmd(uint32_t RTC_Tamper, FunctionalState NewState);
835 void RTC_TamperFilterConfig(uint32_t RTC_TamperFilter);
836 void RTC_TamperSamplingFreqConfig(uint32_t RTC_TamperSamplingFreq);
837 void RTC_TamperPinsPrechargeDuration(uint32_t RTC_TamperPrechargeDuration);
838 void RTC_TimeStampOnTamperDetectionCmd(FunctionalState NewState);
839 void RTC_TamperPullUpCmd(FunctionalState NewState);
840
841 /* Backup Data Registers configuration functions ******************************/
842 void RTC_WriteBackupRegister(uint32_t RTC_BKP_DR, uint32_t Data);
843 uint32_t RTC_ReadBackupRegister(uint32_t RTC_BKP_DR);
844
845 /* RTC Tamper and TimeStamp Pins Selection and Output Type Config configuration
846    functions ******************************************************************/
847 void RTC_TamperPinSelection(uint32_t RTC_TamperPin);
848 void RTC_TimeStampPinSelection(uint32_t RTC_TimeStampPin);
849 void RTC_OutputTypeConfig(uint32_t RTC_OutputType);
850
851 /* RTC_Shift_control_synchonisation_functions *********************************/
852 ErrorStatus RTC_SynchroShiftConfig(uint32_t RTC_ShiftAdd1S, uint32_t RTC_ShiftSubFS);
853
854 /* Interrupts and flags management functions **********************************/
855 void RTC_ITConfig(uint32_t RTC_IT, FunctionalState NewState);
856 FlagStatus RTC_GetFlagStatus(uint32_t RTC_FLAG);
857 void RTC_ClearFlag(uint32_t RTC_FLAG);
858 ITStatus RTC_GetITStatus(uint32_t RTC_IT);
859 void RTC_ClearITPendingBit(uint32_t RTC_IT);
860
861 #ifdef __cplusplus
862 }
863 #endif
864
865 #endif /*__STM32F4xx_RTC_H */
866
867 /**
868   * @}
869   */ 
870
871 /**
872   * @}
873   */ 
874
875 /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/