stm32f4xx_ll_rtc.c 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892
  1. /**
  2. ******************************************************************************
  3. * @file stm32f4xx_ll_rtc.c
  4. * @author MCD Application Team
  5. * @brief RTC LL module driver.
  6. ******************************************************************************
  7. * @attention
  8. *
  9. * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
  10. *
  11. * Redistribution and use in source and binary forms, with or without modification,
  12. * are permitted provided that the following conditions are met:
  13. * 1. Redistributions of source code must retain the above copyright notice,
  14. * this list of conditions and the following disclaimer.
  15. * 2. Redistributions in binary form must reproduce the above copyright notice,
  16. * this list of conditions and the following disclaimer in the documentation
  17. * and/or other materials provided with the distribution.
  18. * 3. Neither the name of STMicroelectronics nor the names of its contributors
  19. * may be used to endorse or promote products derived from this software
  20. * without specific prior written permission.
  21. *
  22. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  23. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25. * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
  26. * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  28. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  30. * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. *
  33. ******************************************************************************
  34. */
  35. #if defined(USE_FULL_LL_DRIVER)
  36. /* Includes ------------------------------------------------------------------*/
  37. #include "stm32f4xx_ll_rtc.h"
  38. #include "stm32f4xx_ll_cortex.h"
  39. #ifdef USE_FULL_ASSERT
  40. #include "stm32_assert.h"
  41. #else
  42. #define assert_param(expr) ((void)0U)
  43. #endif
  44. /** @addtogroup STM32F4xx_LL_Driver
  45. * @{
  46. */
  47. #if defined(RTC)
  48. /** @addtogroup RTC_LL
  49. * @{
  50. */
  51. /* Private types -------------------------------------------------------------*/
  52. /* Private variables ---------------------------------------------------------*/
  53. /* Private constants ---------------------------------------------------------*/
  54. /** @addtogroup RTC_LL_Private_Constants
  55. * @{
  56. */
  57. /* Default values used for prescaler */
  58. #define RTC_ASYNCH_PRESC_DEFAULT 0x0000007FU
  59. #define RTC_SYNCH_PRESC_DEFAULT 0x000000FFU
  60. /* Values used for timeout */
  61. #define RTC_INITMODE_TIMEOUT 1000U /* 1s when tick set to 1ms */
  62. #define RTC_SYNCHRO_TIMEOUT 1000U /* 1s when tick set to 1ms */
  63. /**
  64. * @}
  65. */
  66. /* Private macros ------------------------------------------------------------*/
  67. /** @addtogroup RTC_LL_Private_Macros
  68. * @{
  69. */
  70. #define IS_LL_RTC_HOURFORMAT(__VALUE__) (((__VALUE__) == LL_RTC_HOURFORMAT_24HOUR) \
  71. || ((__VALUE__) == LL_RTC_HOURFORMAT_AMPM))
  72. #define IS_LL_RTC_ASYNCH_PREDIV(__VALUE__) ((__VALUE__) <= 0x7FU)
  73. #define IS_LL_RTC_SYNCH_PREDIV(__VALUE__) ((__VALUE__) <= 0x7FFFU)
  74. #define IS_LL_RTC_FORMAT(__VALUE__) (((__VALUE__) == LL_RTC_FORMAT_BIN) \
  75. || ((__VALUE__) == LL_RTC_FORMAT_BCD))
  76. #define IS_LL_RTC_TIME_FORMAT(__VALUE__) (((__VALUE__) == LL_RTC_TIME_FORMAT_AM_OR_24) \
  77. || ((__VALUE__) == LL_RTC_TIME_FORMAT_PM))
  78. #define IS_LL_RTC_HOUR12(__HOUR__) (((__HOUR__) > 0U) && ((__HOUR__) <= 12U))
  79. #define IS_LL_RTC_HOUR24(__HOUR__) ((__HOUR__) <= 23U)
  80. #define IS_LL_RTC_MINUTES(__MINUTES__) ((__MINUTES__) <= 59U)
  81. #define IS_LL_RTC_SECONDS(__SECONDS__) ((__SECONDS__) <= 59U)
  82. #define IS_LL_RTC_WEEKDAY(__VALUE__) (((__VALUE__) == LL_RTC_WEEKDAY_MONDAY) \
  83. || ((__VALUE__) == LL_RTC_WEEKDAY_TUESDAY) \
  84. || ((__VALUE__) == LL_RTC_WEEKDAY_WEDNESDAY) \
  85. || ((__VALUE__) == LL_RTC_WEEKDAY_THURSDAY) \
  86. || ((__VALUE__) == LL_RTC_WEEKDAY_FRIDAY) \
  87. || ((__VALUE__) == LL_RTC_WEEKDAY_SATURDAY) \
  88. || ((__VALUE__) == LL_RTC_WEEKDAY_SUNDAY))
  89. #define IS_LL_RTC_DAY(__DAY__) (((__DAY__) >= 1U) && ((__DAY__) <= 31U))
  90. #define IS_LL_RTC_MONTH(__VALUE__) (((__VALUE__) == LL_RTC_MONTH_JANUARY) \
  91. || ((__VALUE__) == LL_RTC_MONTH_FEBRUARY) \
  92. || ((__VALUE__) == LL_RTC_MONTH_MARCH) \
  93. || ((__VALUE__) == LL_RTC_MONTH_APRIL) \
  94. || ((__VALUE__) == LL_RTC_MONTH_MAY) \
  95. || ((__VALUE__) == LL_RTC_MONTH_JUNE) \
  96. || ((__VALUE__) == LL_RTC_MONTH_JULY) \
  97. || ((__VALUE__) == LL_RTC_MONTH_AUGUST) \
  98. || ((__VALUE__) == LL_RTC_MONTH_SEPTEMBER) \
  99. || ((__VALUE__) == LL_RTC_MONTH_OCTOBER) \
  100. || ((__VALUE__) == LL_RTC_MONTH_NOVEMBER) \
  101. || ((__VALUE__) == LL_RTC_MONTH_DECEMBER))
  102. #define IS_LL_RTC_YEAR(__YEAR__) ((__YEAR__) <= 99U)
  103. #define IS_LL_RTC_ALMA_MASK(__VALUE__) (((__VALUE__) == LL_RTC_ALMA_MASK_NONE) \
  104. || ((__VALUE__) == LL_RTC_ALMA_MASK_DATEWEEKDAY) \
  105. || ((__VALUE__) == LL_RTC_ALMA_MASK_HOURS) \
  106. || ((__VALUE__) == LL_RTC_ALMA_MASK_MINUTES) \
  107. || ((__VALUE__) == LL_RTC_ALMA_MASK_SECONDS) \
  108. || ((__VALUE__) == LL_RTC_ALMA_MASK_ALL))
  109. #define IS_LL_RTC_ALMB_MASK(__VALUE__) (((__VALUE__) == LL_RTC_ALMB_MASK_NONE) \
  110. || ((__VALUE__) == LL_RTC_ALMB_MASK_DATEWEEKDAY) \
  111. || ((__VALUE__) == LL_RTC_ALMB_MASK_HOURS) \
  112. || ((__VALUE__) == LL_RTC_ALMB_MASK_MINUTES) \
  113. || ((__VALUE__) == LL_RTC_ALMB_MASK_SECONDS) \
  114. || ((__VALUE__) == LL_RTC_ALMB_MASK_ALL))
  115. #define IS_LL_RTC_ALMA_DATE_WEEKDAY_SEL(__SEL__) (((__SEL__) == LL_RTC_ALMA_DATEWEEKDAYSEL_DATE) || \
  116. ((__SEL__) == LL_RTC_ALMA_DATEWEEKDAYSEL_WEEKDAY))
  117. #define IS_LL_RTC_ALMB_DATE_WEEKDAY_SEL(__SEL__) (((__SEL__) == LL_RTC_ALMB_DATEWEEKDAYSEL_DATE) || \
  118. ((__SEL__) == LL_RTC_ALMB_DATEWEEKDAYSEL_WEEKDAY))
  119. /**
  120. * @}
  121. */
  122. /* Private function prototypes -----------------------------------------------*/
  123. /* Exported functions --------------------------------------------------------*/
  124. /** @addtogroup RTC_LL_Exported_Functions
  125. * @{
  126. */
  127. /** @addtogroup RTC_LL_EF_Init
  128. * @{
  129. */
  130. /**
  131. * @brief De-Initializes the RTC registers to their default reset values.
  132. * @note This function doesn't reset the RTC Clock source and RTC Backup Data
  133. * registers.
  134. * @param RTCx RTC Instance
  135. * @retval An ErrorStatus enumeration value:
  136. * - SUCCESS: RTC registers are de-initialized
  137. * - ERROR: RTC registers are not de-initialized
  138. */
  139. ErrorStatus LL_RTC_DeInit(RTC_TypeDef *RTCx)
  140. {
  141. ErrorStatus status = ERROR;
  142. /* Check the parameter */
  143. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  144. /* Disable the write protection for RTC registers */
  145. LL_RTC_DisableWriteProtection(RTCx);
  146. /* Set Initialization mode */
  147. if (LL_RTC_EnterInitMode(RTCx) != ERROR)
  148. {
  149. /* Reset TR, DR and CR registers */
  150. LL_RTC_WriteReg(RTCx, TR, 0x00000000U);
  151. #if defined(RTC_WAKEUP_SUPPORT)
  152. LL_RTC_WriteReg(RTCx, WUTR, RTC_WUTR_WUT);
  153. #endif /* RTC_WAKEUP_SUPPORT */
  154. LL_RTC_WriteReg(RTCx, DR , (RTC_DR_WDU_0 | RTC_DR_MU_0 | RTC_DR_DU_0));
  155. /* Reset All CR bits except CR[2:0] */
  156. #if defined(RTC_WAKEUP_SUPPORT)
  157. LL_RTC_WriteReg(RTCx, CR, (LL_RTC_ReadReg(RTCx, CR) & RTC_CR_WUCKSEL));
  158. #else
  159. LL_RTC_WriteReg(RTCx, CR, 0x00000000U);
  160. #endif /* RTC_WAKEUP_SUPPORT */
  161. LL_RTC_WriteReg(RTCx, PRER, (RTC_PRER_PREDIV_A | RTC_SYNCH_PRESC_DEFAULT));
  162. LL_RTC_WriteReg(RTCx, ALRMAR, 0x00000000U);
  163. LL_RTC_WriteReg(RTCx, ALRMBR, 0x00000000U);
  164. LL_RTC_WriteReg(RTCx, SHIFTR, 0x00000000U);
  165. LL_RTC_WriteReg(RTCx, CALR, 0x00000000U);
  166. LL_RTC_WriteReg(RTCx, ALRMASSR, 0x00000000U);
  167. LL_RTC_WriteReg(RTCx, ALRMBSSR, 0x00000000U);
  168. /* Reset ISR register and exit initialization mode */
  169. LL_RTC_WriteReg(RTCx, ISR, 0x00000000U);
  170. /* Reset Tamper and alternate functions configuration register */
  171. LL_RTC_WriteReg(RTCx, TAFCR, 0x00000000U);
  172. /* Wait till the RTC RSF flag is set */
  173. status = LL_RTC_WaitForSynchro(RTCx);
  174. }
  175. /* Enable the write protection for RTC registers */
  176. LL_RTC_EnableWriteProtection(RTCx);
  177. return status;
  178. }
  179. /**
  180. * @brief Initializes the RTC registers according to the specified parameters
  181. * in RTC_InitStruct.
  182. * @param RTCx RTC Instance
  183. * @param RTC_InitStruct pointer to a @ref LL_RTC_InitTypeDef structure that contains
  184. * the configuration information for the RTC peripheral.
  185. * @note The RTC Prescaler register is write protected and can be written in
  186. * initialization mode only.
  187. * @retval An ErrorStatus enumeration value:
  188. * - SUCCESS: RTC registers are initialized
  189. * - ERROR: RTC registers are not initialized
  190. */
  191. ErrorStatus LL_RTC_Init(RTC_TypeDef *RTCx, LL_RTC_InitTypeDef *RTC_InitStruct)
  192. {
  193. ErrorStatus status = ERROR;
  194. /* Check the parameters */
  195. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  196. assert_param(IS_LL_RTC_HOURFORMAT(RTC_InitStruct->HourFormat));
  197. assert_param(IS_LL_RTC_ASYNCH_PREDIV(RTC_InitStruct->AsynchPrescaler));
  198. assert_param(IS_LL_RTC_SYNCH_PREDIV(RTC_InitStruct->SynchPrescaler));
  199. /* Disable the write protection for RTC registers */
  200. LL_RTC_DisableWriteProtection(RTCx);
  201. /* Set Initialization mode */
  202. if (LL_RTC_EnterInitMode(RTCx) != ERROR)
  203. {
  204. /* Set Hour Format */
  205. LL_RTC_SetHourFormat(RTCx, RTC_InitStruct->HourFormat);
  206. /* Configure Synchronous and Asynchronous prescaler factor */
  207. LL_RTC_SetSynchPrescaler(RTCx, RTC_InitStruct->SynchPrescaler);
  208. LL_RTC_SetAsynchPrescaler(RTCx, RTC_InitStruct->AsynchPrescaler);
  209. /* Exit Initialization mode */
  210. LL_RTC_DisableInitMode(RTCx);
  211. status = SUCCESS;
  212. }
  213. /* Enable the write protection for RTC registers */
  214. LL_RTC_EnableWriteProtection(RTCx);
  215. return status;
  216. }
  217. /**
  218. * @brief Set each @ref LL_RTC_InitTypeDef field to default value.
  219. * @param RTC_InitStruct pointer to a @ref LL_RTC_InitTypeDef structure which will be initialized.
  220. * @retval None
  221. */
  222. void LL_RTC_StructInit(LL_RTC_InitTypeDef *RTC_InitStruct)
  223. {
  224. /* Set RTC_InitStruct fields to default values */
  225. RTC_InitStruct->HourFormat = LL_RTC_HOURFORMAT_24HOUR;
  226. RTC_InitStruct->AsynchPrescaler = RTC_ASYNCH_PRESC_DEFAULT;
  227. RTC_InitStruct->SynchPrescaler = RTC_SYNCH_PRESC_DEFAULT;
  228. }
  229. /**
  230. * @brief Set the RTC current time.
  231. * @param RTCx RTC Instance
  232. * @param RTC_Format This parameter can be one of the following values:
  233. * @arg @ref LL_RTC_FORMAT_BIN
  234. * @arg @ref LL_RTC_FORMAT_BCD
  235. * @param RTC_TimeStruct pointer to a RTC_TimeTypeDef structure that contains
  236. * the time configuration information for the RTC.
  237. * @retval An ErrorStatus enumeration value:
  238. * - SUCCESS: RTC Time register is configured
  239. * - ERROR: RTC Time register is not configured
  240. */
  241. ErrorStatus LL_RTC_TIME_Init(RTC_TypeDef *RTCx, uint32_t RTC_Format, LL_RTC_TimeTypeDef *RTC_TimeStruct)
  242. {
  243. ErrorStatus status = ERROR;
  244. /* Check the parameters */
  245. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  246. assert_param(IS_LL_RTC_FORMAT(RTC_Format));
  247. if (RTC_Format == LL_RTC_FORMAT_BIN)
  248. {
  249. if (LL_RTC_GetHourFormat(RTCx) != LL_RTC_HOURFORMAT_24HOUR)
  250. {
  251. assert_param(IS_LL_RTC_HOUR12(RTC_TimeStruct->Hours));
  252. assert_param(IS_LL_RTC_TIME_FORMAT(RTC_TimeStruct->TimeFormat));
  253. }
  254. else
  255. {
  256. RTC_TimeStruct->TimeFormat = 0x00U;
  257. assert_param(IS_LL_RTC_HOUR24(RTC_TimeStruct->Hours));
  258. }
  259. assert_param(IS_LL_RTC_MINUTES(RTC_TimeStruct->Minutes));
  260. assert_param(IS_LL_RTC_SECONDS(RTC_TimeStruct->Seconds));
  261. }
  262. else
  263. {
  264. if (LL_RTC_GetHourFormat(RTCx) != LL_RTC_HOURFORMAT_24HOUR)
  265. {
  266. assert_param(IS_LL_RTC_HOUR12(__LL_RTC_CONVERT_BCD2BIN(RTC_TimeStruct->Hours)));
  267. assert_param(IS_LL_RTC_TIME_FORMAT(RTC_TimeStruct->TimeFormat));
  268. }
  269. else
  270. {
  271. RTC_TimeStruct->TimeFormat = 0x00U;
  272. assert_param(IS_LL_RTC_HOUR24(__LL_RTC_CONVERT_BCD2BIN(RTC_TimeStruct->Hours)));
  273. }
  274. assert_param(IS_LL_RTC_MINUTES(__LL_RTC_CONVERT_BCD2BIN(RTC_TimeStruct->Minutes)));
  275. assert_param(IS_LL_RTC_SECONDS(__LL_RTC_CONVERT_BCD2BIN(RTC_TimeStruct->Seconds)));
  276. }
  277. /* Disable the write protection for RTC registers */
  278. LL_RTC_DisableWriteProtection(RTCx);
  279. /* Set Initialization mode */
  280. if (LL_RTC_EnterInitMode(RTCx) != ERROR)
  281. {
  282. /* Check the input parameters format */
  283. if (RTC_Format != LL_RTC_FORMAT_BIN)
  284. {
  285. LL_RTC_TIME_Config(RTCx, RTC_TimeStruct->TimeFormat, RTC_TimeStruct->Hours,
  286. RTC_TimeStruct->Minutes, RTC_TimeStruct->Seconds);
  287. }
  288. else
  289. {
  290. LL_RTC_TIME_Config(RTCx, RTC_TimeStruct->TimeFormat, __LL_RTC_CONVERT_BIN2BCD(RTC_TimeStruct->Hours),
  291. __LL_RTC_CONVERT_BIN2BCD(RTC_TimeStruct->Minutes),
  292. __LL_RTC_CONVERT_BIN2BCD(RTC_TimeStruct->Seconds));
  293. }
  294. /* Exit Initialization mode */
  295. LL_RTC_DisableInitMode(RTC);
  296. /* If RTC_CR_BYPSHAD bit = 0, wait for synchro else this check is not needed */
  297. if (LL_RTC_IsShadowRegBypassEnabled(RTCx) == 0U)
  298. {
  299. status = LL_RTC_WaitForSynchro(RTCx);
  300. }
  301. else
  302. {
  303. status = SUCCESS;
  304. }
  305. }
  306. /* Enable the write protection for RTC registers */
  307. LL_RTC_EnableWriteProtection(RTCx);
  308. return status;
  309. }
  310. /**
  311. * @brief Set each @ref LL_RTC_TimeTypeDef field to default value (Time = 00h:00min:00sec).
  312. * @param RTC_TimeStruct pointer to a @ref LL_RTC_TimeTypeDef structure which will be initialized.
  313. * @retval None
  314. */
  315. void LL_RTC_TIME_StructInit(LL_RTC_TimeTypeDef *RTC_TimeStruct)
  316. {
  317. /* Time = 00h:00min:00sec */
  318. RTC_TimeStruct->TimeFormat = LL_RTC_TIME_FORMAT_AM_OR_24;
  319. RTC_TimeStruct->Hours = 0U;
  320. RTC_TimeStruct->Minutes = 0U;
  321. RTC_TimeStruct->Seconds = 0U;
  322. }
  323. /**
  324. * @brief Set the RTC current date.
  325. * @param RTCx RTC Instance
  326. * @param RTC_Format This parameter can be one of the following values:
  327. * @arg @ref LL_RTC_FORMAT_BIN
  328. * @arg @ref LL_RTC_FORMAT_BCD
  329. * @param RTC_DateStruct pointer to a RTC_DateTypeDef structure that contains
  330. * the date configuration information for the RTC.
  331. * @retval An ErrorStatus enumeration value:
  332. * - SUCCESS: RTC Day register is configured
  333. * - ERROR: RTC Day register is not configured
  334. */
  335. ErrorStatus LL_RTC_DATE_Init(RTC_TypeDef *RTCx, uint32_t RTC_Format, LL_RTC_DateTypeDef *RTC_DateStruct)
  336. {
  337. ErrorStatus status = ERROR;
  338. /* Check the parameters */
  339. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  340. assert_param(IS_LL_RTC_FORMAT(RTC_Format));
  341. if ((RTC_Format == LL_RTC_FORMAT_BIN) && ((RTC_DateStruct->Month & 0x10U) == 0x10U))
  342. {
  343. RTC_DateStruct->Month = (RTC_DateStruct->Month & (uint32_t)~(0x10U)) + 0x0AU;
  344. }
  345. if (RTC_Format == LL_RTC_FORMAT_BIN)
  346. {
  347. assert_param(IS_LL_RTC_YEAR(RTC_DateStruct->Year));
  348. assert_param(IS_LL_RTC_MONTH(RTC_DateStruct->Month));
  349. assert_param(IS_LL_RTC_DAY(RTC_DateStruct->Day));
  350. }
  351. else
  352. {
  353. assert_param(IS_LL_RTC_YEAR(__LL_RTC_CONVERT_BCD2BIN(RTC_DateStruct->Year)));
  354. assert_param(IS_LL_RTC_MONTH(__LL_RTC_CONVERT_BCD2BIN(RTC_DateStruct->Month)));
  355. assert_param(IS_LL_RTC_DAY(__LL_RTC_CONVERT_BCD2BIN(RTC_DateStruct->Day)));
  356. }
  357. assert_param(IS_LL_RTC_WEEKDAY(RTC_DateStruct->WeekDay));
  358. /* Disable the write protection for RTC registers */
  359. LL_RTC_DisableWriteProtection(RTCx);
  360. /* Set Initialization mode */
  361. if (LL_RTC_EnterInitMode(RTCx) != ERROR)
  362. {
  363. /* Check the input parameters format */
  364. if (RTC_Format != LL_RTC_FORMAT_BIN)
  365. {
  366. LL_RTC_DATE_Config(RTCx, RTC_DateStruct->WeekDay, RTC_DateStruct->Day, RTC_DateStruct->Month, RTC_DateStruct->Year);
  367. }
  368. else
  369. {
  370. LL_RTC_DATE_Config(RTCx, RTC_DateStruct->WeekDay, __LL_RTC_CONVERT_BIN2BCD(RTC_DateStruct->Day),
  371. __LL_RTC_CONVERT_BIN2BCD(RTC_DateStruct->Month), __LL_RTC_CONVERT_BIN2BCD(RTC_DateStruct->Year));
  372. }
  373. /* Exit Initialization mode */
  374. LL_RTC_DisableInitMode(RTC);
  375. /* If RTC_CR_BYPSHAD bit = 0, wait for synchro else this check is not needed */
  376. if (LL_RTC_IsShadowRegBypassEnabled(RTCx) == 0U)
  377. {
  378. status = LL_RTC_WaitForSynchro(RTCx);
  379. }
  380. else
  381. {
  382. status = SUCCESS;
  383. }
  384. }
  385. /* Enable the write protection for RTC registers */
  386. LL_RTC_EnableWriteProtection(RTCx);
  387. return status;
  388. }
  389. /**
  390. * @brief Set each @ref LL_RTC_DateTypeDef field to default value (date = Monday, January 01 xx00)
  391. * @param RTC_DateStruct pointer to a @ref LL_RTC_DateTypeDef structure which will be initialized.
  392. * @retval None
  393. */
  394. void LL_RTC_DATE_StructInit(LL_RTC_DateTypeDef *RTC_DateStruct)
  395. {
  396. /* Monday, January 01 xx00 */
  397. RTC_DateStruct->WeekDay = LL_RTC_WEEKDAY_MONDAY;
  398. RTC_DateStruct->Day = 1U;
  399. RTC_DateStruct->Month = LL_RTC_MONTH_JANUARY;
  400. RTC_DateStruct->Year = 0U;
  401. }
  402. /**
  403. * @brief Set the RTC Alarm A.
  404. * @note The Alarm register can only be written when the corresponding Alarm
  405. * is disabled (Use @ref LL_RTC_ALMA_Disable function).
  406. * @param RTCx RTC Instance
  407. * @param RTC_Format This parameter can be one of the following values:
  408. * @arg @ref LL_RTC_FORMAT_BIN
  409. * @arg @ref LL_RTC_FORMAT_BCD
  410. * @param RTC_AlarmStruct pointer to a @ref LL_RTC_AlarmTypeDef structure that
  411. * contains the alarm configuration parameters.
  412. * @retval An ErrorStatus enumeration value:
  413. * - SUCCESS: ALARMA registers are configured
  414. * - ERROR: ALARMA registers are not configured
  415. */
  416. ErrorStatus LL_RTC_ALMA_Init(RTC_TypeDef *RTCx, uint32_t RTC_Format, LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
  417. {
  418. /* Check the parameters */
  419. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  420. assert_param(IS_LL_RTC_FORMAT(RTC_Format));
  421. assert_param(IS_LL_RTC_ALMA_MASK(RTC_AlarmStruct->AlarmMask));
  422. assert_param(IS_LL_RTC_ALMA_DATE_WEEKDAY_SEL(RTC_AlarmStruct->AlarmDateWeekDaySel));
  423. if (RTC_Format == LL_RTC_FORMAT_BIN)
  424. {
  425. if (LL_RTC_GetHourFormat(RTCx) != LL_RTC_HOURFORMAT_24HOUR)
  426. {
  427. assert_param(IS_LL_RTC_HOUR12(RTC_AlarmStruct->AlarmTime.Hours));
  428. assert_param(IS_LL_RTC_TIME_FORMAT(RTC_AlarmStruct->AlarmTime.TimeFormat));
  429. }
  430. else
  431. {
  432. RTC_AlarmStruct->AlarmTime.TimeFormat = 0x00U;
  433. assert_param(IS_LL_RTC_HOUR24(RTC_AlarmStruct->AlarmTime.Hours));
  434. }
  435. assert_param(IS_LL_RTC_MINUTES(RTC_AlarmStruct->AlarmTime.Minutes));
  436. assert_param(IS_LL_RTC_SECONDS(RTC_AlarmStruct->AlarmTime.Seconds));
  437. if (RTC_AlarmStruct->AlarmDateWeekDaySel == LL_RTC_ALMA_DATEWEEKDAYSEL_DATE)
  438. {
  439. assert_param(IS_LL_RTC_DAY(RTC_AlarmStruct->AlarmDateWeekDay));
  440. }
  441. else
  442. {
  443. assert_param(IS_LL_RTC_WEEKDAY(RTC_AlarmStruct->AlarmDateWeekDay));
  444. }
  445. }
  446. else
  447. {
  448. if (LL_RTC_GetHourFormat(RTCx) != LL_RTC_HOURFORMAT_24HOUR)
  449. {
  450. assert_param(IS_LL_RTC_HOUR12(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Hours)));
  451. assert_param(IS_LL_RTC_TIME_FORMAT(RTC_AlarmStruct->AlarmTime.TimeFormat));
  452. }
  453. else
  454. {
  455. RTC_AlarmStruct->AlarmTime.TimeFormat = 0x00U;
  456. assert_param(IS_LL_RTC_HOUR24(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Hours)));
  457. }
  458. assert_param(IS_LL_RTC_MINUTES(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Minutes)));
  459. assert_param(IS_LL_RTC_SECONDS(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Seconds)));
  460. if (RTC_AlarmStruct->AlarmDateWeekDaySel == LL_RTC_ALMA_DATEWEEKDAYSEL_DATE)
  461. {
  462. assert_param(IS_LL_RTC_DAY(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmDateWeekDay)));
  463. }
  464. else
  465. {
  466. assert_param(IS_LL_RTC_WEEKDAY(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmDateWeekDay)));
  467. }
  468. }
  469. /* Disable the write protection for RTC registers */
  470. LL_RTC_DisableWriteProtection(RTCx);
  471. /* Select weekday selection */
  472. if (RTC_AlarmStruct->AlarmDateWeekDaySel == LL_RTC_ALMA_DATEWEEKDAYSEL_DATE)
  473. {
  474. /* Set the date for ALARM */
  475. LL_RTC_ALMA_DisableWeekday(RTCx);
  476. if (RTC_Format != LL_RTC_FORMAT_BIN)
  477. {
  478. LL_RTC_ALMA_SetDay(RTCx, RTC_AlarmStruct->AlarmDateWeekDay);
  479. }
  480. else
  481. {
  482. LL_RTC_ALMA_SetDay(RTCx, __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmDateWeekDay));
  483. }
  484. }
  485. else
  486. {
  487. /* Set the week day for ALARM */
  488. LL_RTC_ALMA_EnableWeekday(RTCx);
  489. LL_RTC_ALMA_SetWeekDay(RTCx, RTC_AlarmStruct->AlarmDateWeekDay);
  490. }
  491. /* Configure the Alarm register */
  492. if (RTC_Format != LL_RTC_FORMAT_BIN)
  493. {
  494. LL_RTC_ALMA_ConfigTime(RTCx, RTC_AlarmStruct->AlarmTime.TimeFormat, RTC_AlarmStruct->AlarmTime.Hours,
  495. RTC_AlarmStruct->AlarmTime.Minutes, RTC_AlarmStruct->AlarmTime.Seconds);
  496. }
  497. else
  498. {
  499. LL_RTC_ALMA_ConfigTime(RTCx, RTC_AlarmStruct->AlarmTime.TimeFormat,
  500. __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmTime.Hours),
  501. __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmTime.Minutes),
  502. __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmTime.Seconds));
  503. }
  504. /* Set ALARM mask */
  505. LL_RTC_ALMA_SetMask(RTCx, RTC_AlarmStruct->AlarmMask);
  506. /* Enable the write protection for RTC registers */
  507. LL_RTC_EnableWriteProtection(RTCx);
  508. return SUCCESS;
  509. }
  510. /**
  511. * @brief Set the RTC Alarm B.
  512. * @note The Alarm register can only be written when the corresponding Alarm
  513. * is disabled (@ref LL_RTC_ALMB_Disable function).
  514. * @param RTCx RTC Instance
  515. * @param RTC_Format This parameter can be one of the following values:
  516. * @arg @ref LL_RTC_FORMAT_BIN
  517. * @arg @ref LL_RTC_FORMAT_BCD
  518. * @param RTC_AlarmStruct pointer to a @ref LL_RTC_AlarmTypeDef structure that
  519. * contains the alarm configuration parameters.
  520. * @retval An ErrorStatus enumeration value:
  521. * - SUCCESS: ALARMB registers are configured
  522. * - ERROR: ALARMB registers are not configured
  523. */
  524. ErrorStatus LL_RTC_ALMB_Init(RTC_TypeDef *RTCx, uint32_t RTC_Format, LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
  525. {
  526. /* Check the parameters */
  527. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  528. assert_param(IS_LL_RTC_FORMAT(RTC_Format));
  529. assert_param(IS_LL_RTC_ALMB_MASK(RTC_AlarmStruct->AlarmMask));
  530. assert_param(IS_LL_RTC_ALMB_DATE_WEEKDAY_SEL(RTC_AlarmStruct->AlarmDateWeekDaySel));
  531. if (RTC_Format == LL_RTC_FORMAT_BIN)
  532. {
  533. if (LL_RTC_GetHourFormat(RTCx) != LL_RTC_HOURFORMAT_24HOUR)
  534. {
  535. assert_param(IS_LL_RTC_HOUR12(RTC_AlarmStruct->AlarmTime.Hours));
  536. assert_param(IS_LL_RTC_TIME_FORMAT(RTC_AlarmStruct->AlarmTime.TimeFormat));
  537. }
  538. else
  539. {
  540. RTC_AlarmStruct->AlarmTime.TimeFormat = 0x00U;
  541. assert_param(IS_LL_RTC_HOUR24(RTC_AlarmStruct->AlarmTime.Hours));
  542. }
  543. assert_param(IS_LL_RTC_MINUTES(RTC_AlarmStruct->AlarmTime.Minutes));
  544. assert_param(IS_LL_RTC_SECONDS(RTC_AlarmStruct->AlarmTime.Seconds));
  545. if (RTC_AlarmStruct->AlarmDateWeekDaySel == LL_RTC_ALMB_DATEWEEKDAYSEL_DATE)
  546. {
  547. assert_param(IS_LL_RTC_DAY(RTC_AlarmStruct->AlarmDateWeekDay));
  548. }
  549. else
  550. {
  551. assert_param(IS_LL_RTC_WEEKDAY(RTC_AlarmStruct->AlarmDateWeekDay));
  552. }
  553. }
  554. else
  555. {
  556. if (LL_RTC_GetHourFormat(RTCx) != LL_RTC_HOURFORMAT_24HOUR)
  557. {
  558. assert_param(IS_LL_RTC_HOUR12(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Hours)));
  559. assert_param(IS_LL_RTC_TIME_FORMAT(RTC_AlarmStruct->AlarmTime.TimeFormat));
  560. }
  561. else
  562. {
  563. RTC_AlarmStruct->AlarmTime.TimeFormat = 0x00U;
  564. assert_param(IS_LL_RTC_HOUR24(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Hours)));
  565. }
  566. assert_param(IS_LL_RTC_MINUTES(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Minutes)));
  567. assert_param(IS_LL_RTC_SECONDS(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmTime.Seconds)));
  568. if (RTC_AlarmStruct->AlarmDateWeekDaySel == LL_RTC_ALMB_DATEWEEKDAYSEL_DATE)
  569. {
  570. assert_param(IS_LL_RTC_DAY(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmDateWeekDay)));
  571. }
  572. else
  573. {
  574. assert_param(IS_LL_RTC_WEEKDAY(__LL_RTC_CONVERT_BCD2BIN(RTC_AlarmStruct->AlarmDateWeekDay)));
  575. }
  576. }
  577. /* Disable the write protection for RTC registers */
  578. LL_RTC_DisableWriteProtection(RTCx);
  579. /* Select weekday selection */
  580. if (RTC_AlarmStruct->AlarmDateWeekDaySel == LL_RTC_ALMB_DATEWEEKDAYSEL_DATE)
  581. {
  582. /* Set the date for ALARM */
  583. LL_RTC_ALMB_DisableWeekday(RTCx);
  584. if (RTC_Format != LL_RTC_FORMAT_BIN)
  585. {
  586. LL_RTC_ALMB_SetDay(RTCx, RTC_AlarmStruct->AlarmDateWeekDay);
  587. }
  588. else
  589. {
  590. LL_RTC_ALMB_SetDay(RTCx, __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmDateWeekDay));
  591. }
  592. }
  593. else
  594. {
  595. /* Set the week day for ALARM */
  596. LL_RTC_ALMB_EnableWeekday(RTCx);
  597. LL_RTC_ALMB_SetWeekDay(RTCx, RTC_AlarmStruct->AlarmDateWeekDay);
  598. }
  599. /* Configure the Alarm register */
  600. if (RTC_Format != LL_RTC_FORMAT_BIN)
  601. {
  602. LL_RTC_ALMB_ConfigTime(RTCx, RTC_AlarmStruct->AlarmTime.TimeFormat, RTC_AlarmStruct->AlarmTime.Hours,
  603. RTC_AlarmStruct->AlarmTime.Minutes, RTC_AlarmStruct->AlarmTime.Seconds);
  604. }
  605. else
  606. {
  607. LL_RTC_ALMB_ConfigTime(RTCx, RTC_AlarmStruct->AlarmTime.TimeFormat,
  608. __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmTime.Hours),
  609. __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmTime.Minutes),
  610. __LL_RTC_CONVERT_BIN2BCD(RTC_AlarmStruct->AlarmTime.Seconds));
  611. }
  612. /* Set ALARM mask */
  613. LL_RTC_ALMB_SetMask(RTCx, RTC_AlarmStruct->AlarmMask);
  614. /* Enable the write protection for RTC registers */
  615. LL_RTC_EnableWriteProtection(RTCx);
  616. return SUCCESS;
  617. }
  618. /**
  619. * @brief Set each @ref LL_RTC_AlarmTypeDef of ALARMA field to default value (Time = 00h:00mn:00sec /
  620. * Day = 1st day of the month/Mask = all fields are masked).
  621. * @param RTC_AlarmStruct pointer to a @ref LL_RTC_AlarmTypeDef structure which will be initialized.
  622. * @retval None
  623. */
  624. void LL_RTC_ALMA_StructInit(LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
  625. {
  626. /* Alarm Time Settings : Time = 00h:00mn:00sec */
  627. RTC_AlarmStruct->AlarmTime.TimeFormat = LL_RTC_ALMA_TIME_FORMAT_AM;
  628. RTC_AlarmStruct->AlarmTime.Hours = 0U;
  629. RTC_AlarmStruct->AlarmTime.Minutes = 0U;
  630. RTC_AlarmStruct->AlarmTime.Seconds = 0U;
  631. /* Alarm Day Settings : Day = 1st day of the month */
  632. RTC_AlarmStruct->AlarmDateWeekDaySel = LL_RTC_ALMA_DATEWEEKDAYSEL_DATE;
  633. RTC_AlarmStruct->AlarmDateWeekDay = 1U;
  634. /* Alarm Masks Settings : Mask = all fields are not masked */
  635. RTC_AlarmStruct->AlarmMask = LL_RTC_ALMA_MASK_NONE;
  636. }
  637. /**
  638. * @brief Set each @ref LL_RTC_AlarmTypeDef of ALARMA field to default value (Time = 00h:00mn:00sec /
  639. * Day = 1st day of the month/Mask = all fields are masked).
  640. * @param RTC_AlarmStruct pointer to a @ref LL_RTC_AlarmTypeDef structure which will be initialized.
  641. * @retval None
  642. */
  643. void LL_RTC_ALMB_StructInit(LL_RTC_AlarmTypeDef *RTC_AlarmStruct)
  644. {
  645. /* Alarm Time Settings : Time = 00h:00mn:00sec */
  646. RTC_AlarmStruct->AlarmTime.TimeFormat = LL_RTC_ALMB_TIME_FORMAT_AM;
  647. RTC_AlarmStruct->AlarmTime.Hours = 0U;
  648. RTC_AlarmStruct->AlarmTime.Minutes = 0U;
  649. RTC_AlarmStruct->AlarmTime.Seconds = 0U;
  650. /* Alarm Day Settings : Day = 1st day of the month */
  651. RTC_AlarmStruct->AlarmDateWeekDaySel = LL_RTC_ALMB_DATEWEEKDAYSEL_DATE;
  652. RTC_AlarmStruct->AlarmDateWeekDay = 1U;
  653. /* Alarm Masks Settings : Mask = all fields are not masked */
  654. RTC_AlarmStruct->AlarmMask = LL_RTC_ALMB_MASK_NONE;
  655. }
  656. /**
  657. * @brief Enters the RTC Initialization mode.
  658. * @note The RTC Initialization mode is write protected, use the
  659. * @ref LL_RTC_DisableWriteProtection before calling this function.
  660. * @param RTCx RTC Instance
  661. * @retval An ErrorStatus enumeration value:
  662. * - SUCCESS: RTC is in Init mode
  663. * - ERROR: RTC is not in Init mode
  664. */
  665. ErrorStatus LL_RTC_EnterInitMode(RTC_TypeDef *RTCx)
  666. {
  667. __IO uint32_t timeout = RTC_INITMODE_TIMEOUT;
  668. ErrorStatus status = SUCCESS;
  669. uint32_t tmp = 0U;
  670. /* Check the parameter */
  671. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  672. /* Check if the Initialization mode is set */
  673. if (LL_RTC_IsActiveFlag_INIT(RTCx) == 0U)
  674. {
  675. /* Set the Initialization mode */
  676. LL_RTC_EnableInitMode(RTCx);
  677. /* Wait till RTC is in INIT state and if Time out is reached exit */
  678. tmp = LL_RTC_IsActiveFlag_INIT(RTCx);
  679. while ((timeout != 0U) && (tmp != 1U))
  680. {
  681. if (LL_SYSTICK_IsActiveCounterFlag() == 1U)
  682. {
  683. timeout --;
  684. }
  685. tmp = LL_RTC_IsActiveFlag_INIT(RTCx);
  686. if (timeout == 0U)
  687. {
  688. status = ERROR;
  689. }
  690. }
  691. }
  692. return status;
  693. }
  694. /**
  695. * @brief Exit the RTC Initialization mode.
  696. * @note When the initialization sequence is complete, the calendar restarts
  697. * counting after 4 RTCCLK cycles.
  698. * @note The RTC Initialization mode is write protected, use the
  699. * @ref LL_RTC_DisableWriteProtection before calling this function.
  700. * @param RTCx RTC Instance
  701. * @retval An ErrorStatus enumeration value:
  702. * - SUCCESS: RTC exited from in Init mode
  703. * - ERROR: Not applicable
  704. */
  705. ErrorStatus LL_RTC_ExitInitMode(RTC_TypeDef *RTCx)
  706. {
  707. /* Check the parameter */
  708. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  709. /* Disable initialization mode */
  710. LL_RTC_DisableInitMode(RTCx);
  711. return SUCCESS;
  712. }
  713. /**
  714. * @brief Waits until the RTC Time and Day registers (RTC_TR and RTC_DR) are
  715. * synchronized with RTC APB clock.
  716. * @note The RTC Resynchronization mode is write protected, use the
  717. * @ref LL_RTC_DisableWriteProtection before calling this function.
  718. * @note To read the calendar through the shadow registers after Calendar
  719. * initialization, calendar update or after wakeup from low power modes
  720. * the software must first clear the RSF flag.
  721. * The software must then wait until it is set again before reading
  722. * the calendar, which means that the calendar registers have been
  723. * correctly copied into the RTC_TR and RTC_DR shadow registers.
  724. * @param RTCx RTC Instance
  725. * @retval An ErrorStatus enumeration value:
  726. * - SUCCESS: RTC registers are synchronised
  727. * - ERROR: RTC registers are not synchronised
  728. */
  729. ErrorStatus LL_RTC_WaitForSynchro(RTC_TypeDef *RTCx)
  730. {
  731. __IO uint32_t timeout = RTC_SYNCHRO_TIMEOUT;
  732. ErrorStatus status = SUCCESS;
  733. uint32_t tmp = 0U;
  734. /* Check the parameter */
  735. assert_param(IS_RTC_ALL_INSTANCE(RTCx));
  736. /* Clear RSF flag */
  737. LL_RTC_ClearFlag_RS(RTCx);
  738. /* Wait the registers to be synchronised */
  739. tmp = LL_RTC_IsActiveFlag_RS(RTCx);
  740. while ((timeout != 0U) && (tmp != 0U))
  741. {
  742. if (LL_SYSTICK_IsActiveCounterFlag() == 1U)
  743. {
  744. timeout--;
  745. }
  746. tmp = LL_RTC_IsActiveFlag_RS(RTCx);
  747. if (timeout == 0U)
  748. {
  749. status = ERROR;
  750. }
  751. }
  752. if (status != ERROR)
  753. {
  754. timeout = RTC_SYNCHRO_TIMEOUT;
  755. tmp = LL_RTC_IsActiveFlag_RS(RTCx);
  756. while ((timeout != 0U) && (tmp != 1U))
  757. {
  758. if (LL_SYSTICK_IsActiveCounterFlag() == 1U)
  759. {
  760. timeout--;
  761. }
  762. tmp = LL_RTC_IsActiveFlag_RS(RTCx);
  763. if (timeout == 0U)
  764. {
  765. status = ERROR;
  766. }
  767. }
  768. }
  769. return (status);
  770. }
  771. /**
  772. * @}
  773. */
  774. /**
  775. * @}
  776. */
  777. /**
  778. * @}
  779. */
  780. #endif /* defined(RTC) */
  781. /**
  782. * @}
  783. */
  784. #endif /* USE_FULL_LL_DRIVER */
  785. /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/