stm32f2xx_rtc.h 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644
  1. /**
  2. ******************************************************************************
  3. * @file stm32f2xx_rtc.h
  4. * @author MCD Application Team
  5. * @version V1.0.0
  6. * @date 18-April-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. /* Define to prevent recursive inclusion -------------------------------------*/
  23. #ifndef __STM32F2xx_RTC_H
  24. #define __STM32F2xx_RTC_H
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28. /* Includes ------------------------------------------------------------------*/
  29. #include "stm32f2xx.h"
  30. /** @addtogroup STM32F2xx_StdPeriph_Driver
  31. * @{
  32. */
  33. /** @addtogroup RTC
  34. * @{
  35. */
  36. /* Exported types ------------------------------------------------------------*/
  37. /**
  38. * @brief RTC Init structures definition
  39. */
  40. typedef struct
  41. {
  42. uint32_t RTC_HourFormat; /*!< Specifies the RTC Hour Format.
  43. This parameter can be a value of @ref RTC_Hour_Formats */
  44. uint32_t RTC_AsynchPrediv; /*!< Specifies the RTC Asynchronous Predivider value.
  45. This parameter must be set to a value lower than 0x7F */
  46. uint32_t RTC_SynchPrediv; /*!< Specifies the RTC Synchronous Predivider value.
  47. This parameter must be set to a value lower than 0x1FFF */
  48. }RTC_InitTypeDef;
  49. /**
  50. * @brief RTC Time structure definition
  51. */
  52. typedef struct
  53. {
  54. uint8_t RTC_Hours; /*!< Specifies the RTC Time Hour.
  55. This parameter must be set to a value in the 0-12 range
  56. if the RTC_HourFormat_12 is selected or 0-23 range if
  57. the RTC_HourFormat_24 is selected. */
  58. uint8_t RTC_Minutes; /*!< Specifies the RTC Time Minutes.
  59. This parameter must be set to a value in the 0-59 range. */
  60. uint8_t RTC_Seconds; /*!< Specifies the RTC Time Seconds.
  61. This parameter must be set to a value in the 0-59 range. */
  62. uint8_t RTC_H12; /*!< Specifies the RTC AM/PM Time.
  63. This parameter can be a value of @ref RTC_AM_PM_Definitions */
  64. }RTC_TimeTypeDef;
  65. /**
  66. * @brief RTC Date structure definition
  67. */
  68. typedef struct
  69. {
  70. uint8_t RTC_WeekDay; /*!< Specifies the RTC Date WeekDay.
  71. This parameter can be a value of @ref RTC_WeekDay_Definitions */
  72. uint8_t RTC_Month; /*!< Specifies the RTC Date Month (in BCD format).
  73. This parameter can be a value of @ref RTC_Month_Date_Definitions */
  74. uint8_t RTC_Date; /*!< Specifies the RTC Date.
  75. This parameter must be set to a value in the 1-31 range. */
  76. uint8_t RTC_Year; /*!< Specifies the RTC Date Year.
  77. This parameter must be set to a value in the 0-99 range. */
  78. }RTC_DateTypeDef;
  79. /**
  80. * @brief RTC Alarm structure definition
  81. */
  82. typedef struct
  83. {
  84. RTC_TimeTypeDef RTC_AlarmTime; /*!< Specifies the RTC Alarm Time members. */
  85. uint32_t RTC_AlarmMask; /*!< Specifies the RTC Alarm Masks.
  86. This parameter can be a value of @ref RTC_AlarmMask_Definitions */
  87. uint32_t RTC_AlarmDateWeekDaySel; /*!< Specifies the RTC Alarm is on Date or WeekDay.
  88. This parameter can be a value of @ref RTC_AlarmDateWeekDay_Definitions */
  89. uint8_t RTC_AlarmDateWeekDay; /*!< Specifies the RTC Alarm Date/WeekDay.
  90. If the Alarm Date is selected, this parameter
  91. must be set to a value in the 1-31 range.
  92. If the Alarm WeekDay is selected, this
  93. parameter can be a value of @ref RTC_WeekDay_Definitions */
  94. }RTC_AlarmTypeDef;
  95. /* Exported constants --------------------------------------------------------*/
  96. /** @defgroup RTC_Exported_Constants
  97. * @{
  98. */
  99. /** @defgroup RTC_Hour_Formats
  100. * @{
  101. */
  102. #define RTC_HourFormat_24 ((uint32_t)0x00000000)
  103. #define RTC_HourFormat_12 ((uint32_t)0x00000040)
  104. #define IS_RTC_HOUR_FORMAT(FORMAT) (((FORMAT) == RTC_HourFormat_12) || \
  105. ((FORMAT) == RTC_HourFormat_24))
  106. /**
  107. * @}
  108. */
  109. /** @defgroup RTC_Asynchronous_Predivider
  110. * @{
  111. */
  112. #define IS_RTC_ASYNCH_PREDIV(PREDIV) ((PREDIV) <= 0x7F)
  113. /**
  114. * @}
  115. */
  116. /** @defgroup RTC_Synchronous_Predivider
  117. * @{
  118. */
  119. #define IS_RTC_SYNCH_PREDIV(PREDIV) ((PREDIV) <= 0x1FFF)
  120. /**
  121. * @}
  122. */
  123. /** @defgroup RTC_Time_Definitions
  124. * @{
  125. */
  126. #define IS_RTC_HOUR12(HOUR) (((HOUR) > 0) && ((HOUR) <= 12))
  127. #define IS_RTC_HOUR24(HOUR) ((HOUR) <= 23)
  128. #define IS_RTC_MINUTES(MINUTES) ((MINUTES) <= 59)
  129. #define IS_RTC_SECONDS(SECONDS) ((SECONDS) <= 59)
  130. /**
  131. * @}
  132. */
  133. /** @defgroup RTC_AM_PM_Definitions
  134. * @{
  135. */
  136. #define RTC_H12_AM ((uint8_t)0x00)
  137. #define RTC_H12_PM ((uint8_t)0x40)
  138. #define IS_RTC_H12(PM) (((PM) == RTC_H12_AM) || ((PM) == RTC_H12_PM))
  139. /**
  140. * @}
  141. */
  142. /** @defgroup RTC_Year_Date_Definitions
  143. * @{
  144. */
  145. #define IS_RTC_YEAR(YEAR) ((YEAR) <= 99)
  146. /**
  147. * @}
  148. */
  149. /** @defgroup RTC_Month_Date_Definitions
  150. * @{
  151. */
  152. /* Coded in BCD format */
  153. #define RTC_Month_January ((uint8_t)0x01)
  154. #define RTC_Month_February ((uint8_t)0x02)
  155. #define RTC_Month_March ((uint8_t)0x03)
  156. #define RTC_Month_April ((uint8_t)0x04)
  157. #define RTC_Month_May ((uint8_t)0x05)
  158. #define RTC_Month_June ((uint8_t)0x06)
  159. #define RTC_Month_July ((uint8_t)0x07)
  160. #define RTC_Month_August ((uint8_t)0x08)
  161. #define RTC_Month_September ((uint8_t)0x09)
  162. #define RTC_Month_October ((uint8_t)0x10)
  163. #define RTC_Month_November ((uint8_t)0x11)
  164. #define RTC_Month_December ((uint8_t)0x12)
  165. #define IS_RTC_MONTH(MONTH) (((MONTH) >= 1) && ((MONTH) <= 12))
  166. #define IS_RTC_DATE(DATE) (((DATE) >= 1) && ((DATE) <= 31))
  167. /**
  168. * @}
  169. */
  170. /** @defgroup RTC_WeekDay_Definitions
  171. * @{
  172. */
  173. #define RTC_Weekday_Monday ((uint8_t)0x01)
  174. #define RTC_Weekday_Tuesday ((uint8_t)0x02)
  175. #define RTC_Weekday_Wednesday ((uint8_t)0x03)
  176. #define RTC_Weekday_Thursday ((uint8_t)0x04)
  177. #define RTC_Weekday_Friday ((uint8_t)0x05)
  178. #define RTC_Weekday_Saturday ((uint8_t)0x06)
  179. #define RTC_Weekday_Sunday ((uint8_t)0x07)
  180. #define IS_RTC_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_Weekday_Monday) || \
  181. ((WEEKDAY) == RTC_Weekday_Tuesday) || \
  182. ((WEEKDAY) == RTC_Weekday_Wednesday) || \
  183. ((WEEKDAY) == RTC_Weekday_Thursday) || \
  184. ((WEEKDAY) == RTC_Weekday_Friday) || \
  185. ((WEEKDAY) == RTC_Weekday_Saturday) || \
  186. ((WEEKDAY) == RTC_Weekday_Sunday))
  187. /**
  188. * @}
  189. */
  190. /** @defgroup RTC_Alarm_Definitions
  191. * @{
  192. */
  193. #define IS_RTC_ALARM_DATE_WEEKDAY_DATE(DATE) (((DATE) > 0) && ((DATE) <= 31))
  194. #define IS_RTC_ALARM_DATE_WEEKDAY_WEEKDAY(WEEKDAY) (((WEEKDAY) == RTC_Weekday_Monday) || \
  195. ((WEEKDAY) == RTC_Weekday_Tuesday) || \
  196. ((WEEKDAY) == RTC_Weekday_Wednesday) || \
  197. ((WEEKDAY) == RTC_Weekday_Thursday) || \
  198. ((WEEKDAY) == RTC_Weekday_Friday) || \
  199. ((WEEKDAY) == RTC_Weekday_Saturday) || \
  200. ((WEEKDAY) == RTC_Weekday_Sunday))
  201. /**
  202. * @}
  203. */
  204. /** @defgroup RTC_AlarmDateWeekDay_Definitions
  205. * @{
  206. */
  207. #define RTC_AlarmDateWeekDaySel_Date ((uint32_t)0x00000000)
  208. #define RTC_AlarmDateWeekDaySel_WeekDay ((uint32_t)0x40000000)
  209. #define IS_RTC_ALARM_DATE_WEEKDAY_SEL(SEL) (((SEL) == RTC_AlarmDateWeekDaySel_Date) || \
  210. ((SEL) == RTC_AlarmDateWeekDaySel_WeekDay))
  211. /**
  212. * @}
  213. */
  214. /** @defgroup RTC_AlarmMask_Definitions
  215. * @{
  216. */
  217. #define RTC_AlarmMask_None ((uint32_t)0x00000000)
  218. #define RTC_AlarmMask_DateWeekDay ((uint32_t)0x80000000)
  219. #define RTC_AlarmMask_Hours ((uint32_t)0x00800000)
  220. #define RTC_AlarmMask_Minutes ((uint32_t)0x00008000)
  221. #define RTC_AlarmMask_Seconds ((uint32_t)0x00000080)
  222. #define RTC_AlarmMask_All ((uint32_t)0x80808080)
  223. #define IS_ALARM_MASK(MASK) (((MASK) & 0x7F7F7F7F) == (uint32_t)RESET)
  224. /**
  225. * @}
  226. */
  227. /** @defgroup RTC_Alarms_Definitions
  228. * @{
  229. */
  230. #define RTC_Alarm_A ((uint32_t)0x00000100)
  231. #define RTC_Alarm_B ((uint32_t)0x00000200)
  232. #define IS_RTC_ALARM(ALARM) (((ALARM) == RTC_Alarm_A) || ((ALARM) == RTC_Alarm_B))
  233. #define IS_RTC_CMD_ALARM(ALARM) (((ALARM) & (RTC_Alarm_A | RTC_Alarm_B)) != (uint32_t)RESET)
  234. /**
  235. * @}
  236. */
  237. /** @defgroup RTC_Wakeup_Timer_Definitions
  238. * @{
  239. */
  240. #define RTC_WakeUpClock_RTCCLK_Div16 ((uint32_t)0x00000000)
  241. #define RTC_WakeUpClock_RTCCLK_Div8 ((uint32_t)0x00000001)
  242. #define RTC_WakeUpClock_RTCCLK_Div4 ((uint32_t)0x00000002)
  243. #define RTC_WakeUpClock_RTCCLK_Div2 ((uint32_t)0x00000003)
  244. #define RTC_WakeUpClock_CK_SPRE_16bits ((uint32_t)0x00000004)
  245. #define RTC_WakeUpClock_CK_SPRE_17bits ((uint32_t)0x00000006)
  246. #define IS_RTC_WAKEUP_CLOCK(CLOCK) (((CLOCK) == RTC_WakeUpClock_RTCCLK_Div16) || \
  247. ((CLOCK) == RTC_WakeUpClock_RTCCLK_Div8) || \
  248. ((CLOCK) == RTC_WakeUpClock_RTCCLK_Div4) || \
  249. ((CLOCK) == RTC_WakeUpClock_RTCCLK_Div2) || \
  250. ((CLOCK) == RTC_WakeUpClock_CK_SPRE_16bits) || \
  251. ((CLOCK) == RTC_WakeUpClock_CK_SPRE_17bits))
  252. #define IS_RTC_WAKEUP_COUNTER(COUNTER) ((COUNTER) <= 0xFFFF)
  253. /**
  254. * @}
  255. */
  256. /** @defgroup RTC_Time_Stamp_Edges_definitions
  257. * @{
  258. */
  259. #define RTC_TimeStampEdge_Rising ((uint32_t)0x00000000)
  260. #define RTC_TimeStampEdge_Falling ((uint32_t)0x00000008)
  261. #define IS_RTC_TIMESTAMP_EDGE(EDGE) (((EDGE) == RTC_TimeStampEdge_Rising) || \
  262. ((EDGE) == RTC_TimeStampEdge_Falling))
  263. /**
  264. * @}
  265. */
  266. /** @defgroup RTC_Output_selection_Definitions
  267. * @{
  268. */
  269. #define RTC_Output_Disable ((uint32_t)0x00000000)
  270. #define RTC_Output_AlarmA ((uint32_t)0x00200000)
  271. #define RTC_Output_AlarmB ((uint32_t)0x00400000)
  272. #define RTC_Output_WakeUp ((uint32_t)0x00600000)
  273. #define IS_RTC_OUTPUT(OUTPUT) (((OUTPUT) == RTC_Output_Disable) || \
  274. ((OUTPUT) == RTC_Output_AlarmA) || \
  275. ((OUTPUT) == RTC_Output_AlarmB) || \
  276. ((OUTPUT) == RTC_Output_WakeUp))
  277. /**
  278. * @}
  279. */
  280. /** @defgroup RTC_Output_Polarity_Definitions
  281. * @{
  282. */
  283. #define RTC_OutputPolarity_High ((uint32_t)0x00000000)
  284. #define RTC_OutputPolarity_Low ((uint32_t)0x00100000)
  285. #define IS_RTC_OUTPUT_POL(POL) (((POL) == RTC_OutputPolarity_High) || \
  286. ((POL) == RTC_OutputPolarity_Low))
  287. /**
  288. * @}
  289. */
  290. /** @defgroup RTC_Digital_Calibration_Definitions
  291. * @{
  292. */
  293. #define RTC_CalibSign_Positive ((uint32_t)0x00000000)
  294. #define RTC_CalibSign_Negative ((uint32_t)0x00000080)
  295. #define IS_RTC_CALIB_SIGN(SIGN) (((SIGN) == RTC_CalibSign_Positive) || \
  296. ((SIGN) == RTC_CalibSign_Negative))
  297. #define IS_RTC_CALIB_VALUE(VALUE) ((VALUE) < 0x20)
  298. /**
  299. * @}
  300. */
  301. /** @defgroup RTC_DayLightSaving_Definitions
  302. * @{
  303. */
  304. #define RTC_DayLightSaving_SUB1H ((uint32_t)0x00020000)
  305. #define RTC_DayLightSaving_ADD1H ((uint32_t)0x00010000)
  306. #define IS_RTC_DAYLIGHT_SAVING(SAVE) (((SAVE) == RTC_DayLightSaving_SUB1H) || \
  307. ((SAVE) == RTC_DayLightSaving_ADD1H))
  308. #define RTC_StoreOperation_Reset ((uint32_t)0x00000000)
  309. #define RTC_StoreOperation_Set ((uint32_t)0x00040000)
  310. #define IS_RTC_STORE_OPERATION(OPERATION) (((OPERATION) == RTC_StoreOperation_Reset) || \
  311. ((OPERATION) == RTC_StoreOperation_Set))
  312. /**
  313. * @}
  314. */
  315. /** @defgroup RTC_Tamper_Trigger_Definitions
  316. * @{
  317. */
  318. #define RTC_TamperTrigger_RisingEdge ((uint32_t)0x00000000)
  319. #define RTC_TamperTrigger_FallingEdge ((uint32_t)0x00000001)
  320. #define IS_RTC_TAMPER_TRIGGER(TRIGGER) (((TRIGGER) == RTC_TamperTrigger_RisingEdge) || \
  321. ((TRIGGER) == RTC_TamperTrigger_FallingEdge))
  322. /**
  323. * @}
  324. */
  325. /** @defgroup RTC_Tamper_Pins_Definitions
  326. * @{
  327. */
  328. #define RTC_Tamper_1 RTC_TAFCR_TAMP1E
  329. #define IS_RTC_TAMPER(TAMPER) (((TAMPER) == RTC_Tamper_1))
  330. /**
  331. * @}
  332. */
  333. /** @defgroup RTC_Tamper_Pin_Selection
  334. * @{
  335. */
  336. #define RTC_TamperPin_PC13 ((uint32_t)0x00000000)
  337. #define RTC_TamperPin_PI8 ((uint32_t)0x00010000)
  338. #define IS_RTC_TAMPER_PIN(PIN) (((PIN) == RTC_TamperPin_PC13) || \
  339. ((PIN) == RTC_TamperPin_PI8))
  340. /**
  341. * @}
  342. */
  343. /** @defgroup RTC_TimeStamp_Pin_Selection
  344. * @{
  345. */
  346. #define RTC_TimeStampPin_PC13 ((uint32_t)0x00000000)
  347. #define RTC_TimeStampPin_PI8 ((uint32_t)0x00020000)
  348. #define IS_RTC_TIMESTAMP_PIN(PIN) (((PIN) == RTC_TimeStampPin_PC13) || \
  349. ((PIN) == RTC_TimeStampPin_PI8))
  350. /**
  351. * @}
  352. */
  353. /** @defgroup RTC_Output_Type_ALARM_OUT
  354. * @{
  355. */
  356. #define RTC_OutputType_OpenDrain ((uint32_t)0x00000000)
  357. #define RTC_OutputType_PushPull ((uint32_t)0x00040000)
  358. #define IS_RTC_OUTPUT_TYPE(TYPE) (((TYPE) == RTC_OutputType_OpenDrain) || \
  359. ((TYPE) == RTC_OutputType_PushPull))
  360. /**
  361. * @}
  362. */
  363. /** @defgroup RTC_Backup_Registers_Definitions
  364. * @{
  365. */
  366. #define RTC_BKP_DR0 ((uint32_t)0x00000000)
  367. #define RTC_BKP_DR1 ((uint32_t)0x00000001)
  368. #define RTC_BKP_DR2 ((uint32_t)0x00000002)
  369. #define RTC_BKP_DR3 ((uint32_t)0x00000003)
  370. #define RTC_BKP_DR4 ((uint32_t)0x00000004)
  371. #define RTC_BKP_DR5 ((uint32_t)0x00000005)
  372. #define RTC_BKP_DR6 ((uint32_t)0x00000006)
  373. #define RTC_BKP_DR7 ((uint32_t)0x00000007)
  374. #define RTC_BKP_DR8 ((uint32_t)0x00000008)
  375. #define RTC_BKP_DR9 ((uint32_t)0x00000009)
  376. #define RTC_BKP_DR10 ((uint32_t)0x0000000A)
  377. #define RTC_BKP_DR11 ((uint32_t)0x0000000B)
  378. #define RTC_BKP_DR12 ((uint32_t)0x0000000C)
  379. #define RTC_BKP_DR13 ((uint32_t)0x0000000D)
  380. #define RTC_BKP_DR14 ((uint32_t)0x0000000E)
  381. #define RTC_BKP_DR15 ((uint32_t)0x0000000F)
  382. #define RTC_BKP_DR16 ((uint32_t)0x00000010)
  383. #define RTC_BKP_DR17 ((uint32_t)0x00000011)
  384. #define RTC_BKP_DR18 ((uint32_t)0x00000012)
  385. #define RTC_BKP_DR19 ((uint32_t)0x00000013)
  386. #define IS_RTC_BKP(BKP) (((BKP) == RTC_BKP_DR0) || \
  387. ((BKP) == RTC_BKP_DR1) || \
  388. ((BKP) == RTC_BKP_DR2) || \
  389. ((BKP) == RTC_BKP_DR3) || \
  390. ((BKP) == RTC_BKP_DR4) || \
  391. ((BKP) == RTC_BKP_DR5) || \
  392. ((BKP) == RTC_BKP_DR6) || \
  393. ((BKP) == RTC_BKP_DR7) || \
  394. ((BKP) == RTC_BKP_DR8) || \
  395. ((BKP) == RTC_BKP_DR9) || \
  396. ((BKP) == RTC_BKP_DR10) || \
  397. ((BKP) == RTC_BKP_DR11) || \
  398. ((BKP) == RTC_BKP_DR12) || \
  399. ((BKP) == RTC_BKP_DR13) || \
  400. ((BKP) == RTC_BKP_DR14) || \
  401. ((BKP) == RTC_BKP_DR15) || \
  402. ((BKP) == RTC_BKP_DR16) || \
  403. ((BKP) == RTC_BKP_DR17) || \
  404. ((BKP) == RTC_BKP_DR18) || \
  405. ((BKP) == RTC_BKP_DR19))
  406. /**
  407. * @}
  408. */
  409. /** @defgroup RTC_Input_parameter_format_definitions
  410. * @{
  411. */
  412. #define RTC_Format_BIN ((uint32_t)0x000000000)
  413. #define RTC_Format_BCD ((uint32_t)0x000000001)
  414. #define IS_RTC_FORMAT(FORMAT) (((FORMAT) == RTC_Format_BIN) || ((FORMAT) == RTC_Format_BCD))
  415. /**
  416. * @}
  417. */
  418. /** @defgroup RTC_Flags_Definitions
  419. * @{
  420. */
  421. #define RTC_FLAG_TAMP1F ((uint32_t)0x00002000)
  422. #define RTC_FLAG_TSOVF ((uint32_t)0x00001000)
  423. #define RTC_FLAG_TSF ((uint32_t)0x00000800)
  424. #define RTC_FLAG_WUTF ((uint32_t)0x00000400)
  425. #define RTC_FLAG_ALRBF ((uint32_t)0x00000200)
  426. #define RTC_FLAG_ALRAF ((uint32_t)0x00000100)
  427. #define RTC_FLAG_INITF ((uint32_t)0x00000040)
  428. #define RTC_FLAG_RSF ((uint32_t)0x00000020)
  429. #define RTC_FLAG_INITS ((uint32_t)0x00000010)
  430. #define RTC_FLAG_WUTWF ((uint32_t)0x00000004)
  431. #define RTC_FLAG_ALRBWF ((uint32_t)0x00000002)
  432. #define RTC_FLAG_ALRAWF ((uint32_t)0x00000001)
  433. #define IS_RTC_GET_FLAG(FLAG) (((FLAG) == RTC_FLAG_TSOVF) || ((FLAG) == RTC_FLAG_TSF) || \
  434. ((FLAG) == RTC_FLAG_WUTF) || ((FLAG) == RTC_FLAG_ALRBF) || \
  435. ((FLAG) == RTC_FLAG_ALRAF) || ((FLAG) == RTC_FLAG_INITF) || \
  436. ((FLAG) == RTC_FLAG_RSF) || ((FLAG) == RTC_FLAG_WUTWF) || \
  437. ((FLAG) == RTC_FLAG_ALRBWF) || ((FLAG) == RTC_FLAG_ALRAWF) || \
  438. ((FLAG) == RTC_FLAG_TAMP1F))
  439. #define IS_RTC_CLEAR_FLAG(FLAG) (((FLAG) != (uint32_t)RESET) && (((FLAG) & 0xFFFFC0DF) == (uint32_t)RESET))
  440. /**
  441. * @}
  442. */
  443. /** @defgroup RTC_Interrupts_Definitions
  444. * @{
  445. */
  446. #define RTC_IT_TS ((uint32_t)0x00008000)
  447. #define RTC_IT_WUT ((uint32_t)0x00004000)
  448. #define RTC_IT_ALRB ((uint32_t)0x00002000)
  449. #define RTC_IT_ALRA ((uint32_t)0x00001000)
  450. #define RTC_IT_TAMP ((uint32_t)0x00000004) /* Used only to Enable the Tamper Interrupt */
  451. #define RTC_IT_TAMP1 ((uint32_t)0x00020000)
  452. #define IS_RTC_CONFIG_IT(IT) (((IT) != (uint32_t)RESET) && (((IT) & 0xFFFF0FFB) == (uint32_t)RESET))
  453. #define IS_RTC_GET_IT(IT) (((IT) == RTC_IT_TS) || ((IT) == RTC_IT_WUT) || \
  454. ((IT) == RTC_IT_ALRB) || ((IT) == RTC_IT_ALRA) || \
  455. ((IT) == RTC_IT_TAMP1))
  456. #define IS_RTC_CLEAR_IT(IT) (((IT) != (uint32_t)RESET) && (((IT) & 0xFFFD0FFF) == (uint32_t)RESET))
  457. /**
  458. * @}
  459. */
  460. /** @defgroup RTC_Legacy
  461. * @{
  462. */
  463. #define RTC_DigitalCalibConfig RTC_CoarseCalibConfig
  464. #define RTC_DigitalCalibCmd RTC_CoarseCalibCmd
  465. /**
  466. * @}
  467. */
  468. /**
  469. * @}
  470. */
  471. /* Exported macro ------------------------------------------------------------*/
  472. /* Exported functions --------------------------------------------------------*/
  473. /* Function used to set the RTC configuration to the default reset state *****/
  474. ErrorStatus RTC_DeInit(void);
  475. /* Initialization and Configuration functions *********************************/
  476. ErrorStatus RTC_Init(RTC_InitTypeDef* RTC_InitStruct);
  477. void RTC_StructInit(RTC_InitTypeDef* RTC_InitStruct);
  478. void RTC_WriteProtectionCmd(FunctionalState NewState);
  479. ErrorStatus RTC_EnterInitMode(void);
  480. void RTC_ExitInitMode(void);
  481. ErrorStatus RTC_WaitForSynchro(void);
  482. ErrorStatus RTC_RefClockCmd(FunctionalState NewState);
  483. /* Time and Date configuration functions **************************************/
  484. ErrorStatus RTC_SetTime(uint32_t RTC_Format, RTC_TimeTypeDef* RTC_TimeStruct);
  485. void RTC_TimeStructInit(RTC_TimeTypeDef* RTC_TimeStruct);
  486. void RTC_GetTime(uint32_t RTC_Format, RTC_TimeTypeDef* RTC_TimeStruct);
  487. ErrorStatus RTC_SetDate(uint32_t RTC_Format, RTC_DateTypeDef* RTC_DateStruct);
  488. void RTC_DateStructInit(RTC_DateTypeDef* RTC_DateStruct);
  489. void RTC_GetDate(uint32_t RTC_Format, RTC_DateTypeDef* RTC_DateStruct);
  490. /* Alarms (Alarm A and Alarm B) configuration functions **********************/
  491. void RTC_SetAlarm(uint32_t RTC_Format, uint32_t RTC_Alarm, RTC_AlarmTypeDef* RTC_AlarmStruct);
  492. void RTC_AlarmStructInit(RTC_AlarmTypeDef* RTC_AlarmStruct);
  493. void RTC_GetAlarm(uint32_t RTC_Format, uint32_t RTC_Alarm, RTC_AlarmTypeDef* RTC_AlarmStruct);
  494. ErrorStatus RTC_AlarmCmd(uint32_t RTC_Alarm, FunctionalState NewState);
  495. /* WakeUp Timer configuration functions ***************************************/
  496. void RTC_WakeUpClockConfig(uint32_t RTC_WakeUpClock);
  497. void RTC_SetWakeUpCounter(uint32_t RTC_WakeUpCounter);
  498. uint32_t RTC_GetWakeUpCounter(void);
  499. ErrorStatus RTC_WakeUpCmd(FunctionalState NewState);
  500. /* Daylight Saving configuration functions ************************************/
  501. void RTC_DayLightSavingConfig(uint32_t RTC_DayLightSaving, uint32_t RTC_StoreOperation);
  502. uint32_t RTC_GetStoreOperation(void);
  503. /* Output pin Configuration function ******************************************/
  504. void RTC_OutputConfig(uint32_t RTC_Output, uint32_t RTC_OutputPolarity);
  505. /* Coarse Calibration configuration functions *********************************/
  506. ErrorStatus RTC_CoarseCalibConfig(uint32_t RTC_CalibSign, uint32_t Value);
  507. ErrorStatus RTC_CoarseCalibCmd(FunctionalState NewState);
  508. void RTC_CalibOutputCmd(FunctionalState NewState);
  509. /* TimeStamp configuration functions ******************************************/
  510. void RTC_TimeStampCmd(uint32_t RTC_TimeStampEdge, FunctionalState NewState);
  511. void RTC_GetTimeStamp(uint32_t RTC_Format, RTC_TimeTypeDef* RTC_StampTimeStruct,
  512. RTC_DateTypeDef* RTC_StampDateStruct);
  513. /* Tampers configuration functions ********************************************/
  514. void RTC_TamperTriggerConfig(uint32_t RTC_Tamper, uint32_t RTC_TamperTrigger);
  515. void RTC_TamperCmd(uint32_t RTC_Tamper, FunctionalState NewState);
  516. /* Backup Data Registers configuration functions ******************************/
  517. void RTC_WriteBackupRegister(uint32_t RTC_BKP_DR, uint32_t Data);
  518. uint32_t RTC_ReadBackupRegister(uint32_t RTC_BKP_DR);
  519. /* RTC Tamper and TimeStamp Pins Selection and Output Type Config configuration
  520. functions ******************************************************************/
  521. void RTC_TamperPinSelection(uint32_t RTC_TamperPin);
  522. void RTC_TimeStampPinSelection(uint32_t RTC_TimeStampPin);
  523. void RTC_OutputTypeConfig(uint32_t RTC_OutputType);
  524. /* Interrupts and flags management functions **********************************/
  525. void RTC_ITConfig(uint32_t RTC_IT, FunctionalState NewState);
  526. FlagStatus RTC_GetFlagStatus(uint32_t RTC_FLAG);
  527. void RTC_ClearFlag(uint32_t RTC_FLAG);
  528. ITStatus RTC_GetITStatus(uint32_t RTC_IT);
  529. void RTC_ClearITPendingBit(uint32_t RTC_IT);
  530. #ifdef __cplusplus
  531. }
  532. #endif
  533. #endif /*__STM32F2xx_RTC_H */
  534. /**
  535. * @}
  536. */
  537. /**
  538. * @}
  539. */
  540. /******************* (C) COPYRIGHT 2011 STMicroelectronics *****END OF FILE****/