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