Merge pull request #58 from FRASTM/f1_bkup_date

Adds date retention in the backup memory for the stm32f1xx

Author: fpistm

README.md

@@ -113,6 +113,12 @@ _One-Second interrupt_
     * **`void detachSecondsInterrupt(void)`**
 
 
+_Date retention for stm32F1xx_
+
+  STM32 RTC includes date save/retrieve mechanism for the stm32F1xx mcu, that do not have a date counter.
+
+  The content is stored in BackUp memory which is kept during Reset and powered by Vbat when the Vdd is off.
+
 
 ### Since STM32 Core version > 1.5.0
 _Reset time management_

examples/F1RTCDateRetention/F1RTCDateRetention.ino

@@ -0,0 +1,103 @@
+/*
+  F1RTCDateRetention
+
+  This sketch shows how to keep the RTC date with backup registers on a stm32F1 MCU.
+  It is reserved for stm32F1 as other devices actually embed the feature.
+  If a VBat is present on the target board, then the content is kept when
+  the VDD power supply is off, else the content is reset
+
+  Creation 03 dec 2021
+  by FRASTM for STMicroelectronics
+
+  This example code is in the public domain.
+
+  https://github.com/stm32duino/STM32RTC
+*/
+
+#include <STM32RTC.h>
+
+/* Get the rtc object */
+STM32RTC& rtc = STM32RTC::getInstance();
+
+#if !defined(STM32F1xx)
+#error "Not applicable (only stm32F1xx save date in backup memory)"
+#endif /* !STM32F1xx */
+
+#define INITIAL_SEC 53
+#define INITIAL_MIN 59
+#define INITIAL_HOUR 23
+#define INITIAL_WDAY 2
+#define INITIAL_DAY 7
+#define INITIAL_MONTH 12
+#define INITIAL_YEAR 21
+
+uint32_t subSec;
+byte seconds;
+byte minutes;
+byte hours;
+byte am_pm;
+
+/* these values are read in the backUp register */
+byte weekDay;
+byte day;
+byte month;
+byte year;
+
+void setup()
+{
+  Serial.begin(115200);
+
+  // Select RTC clock source: LSI_CLOCK, LSE_CLOCK or HSE_CLOCK.
+  // By default the LSI is selected as source.
+  //rtc.setClockSource(STM32RTC::LSE_CLOCK);
+
+  // true: reset the backUp register (restart from the initial date/time above on each reset)
+  // false: keep the latest date from the BackUp register on each reset
+  bool reset_bkup = false;
+  rtc.begin(reset_bkup); // initialize RTC 24H format
+  // get the date if stored in BackUp reg
+  rtc.getDate(&weekDay, &day, &month, &year);
+  if (reset_bkup) {
+    Serial.printf("reset the date to %02d/%02d/%02d\n", day, month, year);
+  } else {
+    Serial.printf("date from the BackUp %02d/%02d/%02d\n", day, month, year);
+  }
+
+  // Check if date is valid = read in the backUp reg.
+  // Note that backup reg only keep the date /time
+  // and a power off reset the content if not saved by Vbat
+  // HAL_RTC init date is set to 1st of January 2000
+if ((day == 1) && (month == RTC_MONTH_JANUARY) && (year == 0)) {
+    // Set the time
+    rtc.setHours(INITIAL_HOUR);
+    rtc.setMinutes(INITIAL_MIN);
+    rtc.setSeconds(INITIAL_SEC);
+
+    // Set the date
+    rtc.setWeekDay(INITIAL_WDAY);
+    rtc.setDay(INITIAL_DAY);
+    rtc.setMonth(INITIAL_MONTH);
+    rtc.setYear(INITIAL_YEAR);
+
+    // Here you can also use
+    //rtc.setTime(hours, minutes, seconds);
+    //rtc.setDate(weekDay, day, month, year);
+  }
+}
+
+void loop()
+{
+  // Print date...
+  Serial.printf("%02d/%02d/%02d \t", rtc.getDay(), rtc.getMonth(), rtc.getYear());
+
+  uint8_t sec = 0;
+  uint8_t mn = 0;
+  uint8_t hrs = 0;
+  uint32_t subs = 0;
+  rtc.getTime(&hrs, &mn, &sec, &subs);
+
+  // ...and time
+  Serial.printf("%02d:%02d:%02d\n", hrs, mn, sec);
+
+  delay(1000);
+}

src/rtc.c

@@ -35,6 +35,7 @@
   */
 
 #include "rtc.h"
+#include <string.h>
 
 #if defined(STM32_CORE_VERSION) && (STM32_CORE_VERSION  > 0x01090000) &&\
     defined(HAL_RTC_MODULE_ENABLED) && !defined(HAL_RTC_MODULE_ONLY)
@@ -367,17 +368,36 @@ void RTC_init(hourFormat_t format, sourceClock_t source, bool reset)
   RtcHandle.Init.OutPutType = RTC_OUTPUT_TYPE_OPENDRAIN;
 #endif /* STM32F1xx */
 
+  /* Ensure backup domain is enabled before we init the RTC so we can use the backup registers for date retention on stm32f1xx baords */
+  enableBackupDomain();
+
   HAL_RTC_Init(&RtcHandle);
 
+#if defined(STM32F1xx)
+  // Copy RTC date back out of the BackUp registers
+  uint32_t BackupDate;
+  /* date from backup battery was not reset, load it */
+  if (!reset) {
+    BackupDate = getBackupRegister(RTC_BKP_DATE) << 16;
+    BackupDate |= getBackupRegister(RTC_BKP_DATE + 1) & 0xFFFF;
+    if (BackupDate != 0) {
+      /* cannot force the date to be 0 but 1/1/2000 is the reset value, always */
+      memcpy(&RtcHandle.DateToUpdate, &BackupDate, 4);
+      /* and fill the new RTC Date value */
+      RTC_SetDate(RtcHandle.DateToUpdate.Year, RtcHandle.DateToUpdate.Month,
+                  RtcHandle.DateToUpdate.Date, RtcHandle.DateToUpdate.WeekDay);
+    }
+  }
+  RTC_StoreDate();
+#endif /* STM32F1xx */
+
 #if defined(RTC_CR_BYPSHAD)
   /* Enable Direct Read of the calendar registers (not through Shadow) */
   HAL_RTCEx_EnableBypassShadow(&RtcHandle);
 #endif
 
   HAL_NVIC_SetPriority(RTC_Alarm_IRQn, RTC_IRQ_PRIO, RTC_IRQ_SUBPRIO);
   HAL_NVIC_EnableIRQ(RTC_Alarm_IRQn);
-  /* Ensure backup domain is enabled */
-  enableBackupDomain();
 }
 
 /**
@@ -460,6 +480,12 @@ void RTC_GetTime(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint32_t *s
   RTC_TimeTypeDef RTC_TimeStruct;
 
   if ((hours != NULL) && (minutes != NULL) && (seconds != NULL)) {
+#if defined(STM32F1xx)
+    /* Store the date prior to checking the time, this may roll over to the next day as part of the time check,
+       we need to the new date details in the backup registers if it changes */
+    uint8_t current_date = RtcHandle.DateToUpdate.Date;
+#endif
+
     HAL_RTC_GetTime(&RtcHandle, &RTC_TimeStruct, RTC_FORMAT_BIN);
     *hours = RTC_TimeStruct.Hours;
     *minutes = RTC_TimeStruct.Minutes;
@@ -482,6 +508,10 @@ void RTC_GetTime(uint8_t *hours, uint8_t *minutes, uint8_t *seconds, uint32_t *s
 #else
     UNUSED(period);
     UNUSED(subSeconds);
+
+    if (current_date != RtcHandle.DateToUpdate.Date) {
+      RTC_StoreDate();
+    }
 #endif /* !STM32F1xx */
   }
 }
@@ -505,6 +535,9 @@ void RTC_SetDate(uint8_t year, uint8_t month, uint8_t day, uint8_t wday)
     RTC_DateStruct.WeekDay = wday;
     HAL_RTC_SetDate(&RtcHandle, &RTC_DateStruct, RTC_FORMAT_BIN);
     setBackupRegister(RTC_BKP_INDEX, RTC_BKP_VALUE);
+#if defined(STM32F1xx)
+    RTC_StoreDate();
+#endif /* STM32F1xx */
   }
 }
 
@@ -526,6 +559,9 @@ void RTC_GetDate(uint8_t *year, uint8_t *month, uint8_t *day, uint8_t *wday)
     *month = RTC_DateStruct.Month;
     *day = RTC_DateStruct.Date;
     *wday = RTC_DateStruct.WeekDay;
+#if defined(STM32F1xx)
+    RTC_StoreDate();
+#endif /* STM32F1xx */
   }
 }
 
@@ -834,6 +870,17 @@ void RTC_WKUP_IRQHandler(void)
 #endif /* STM32F1xx */
 #endif /* ONESECOND_IRQn */
 
+#if defined(STM32F1xx)
+void RTC_StoreDate(void)
+{
+  /* Store the date in the backup registers */
+  uint32_t dateToStore;
+  memcpy(&dateToStore, &RtcHandle.DateToUpdate, 4);
+  setBackupRegister(RTC_BKP_DATE, dateToStore >> 16);
+  setBackupRegister(RTC_BKP_DATE + 1, dateToStore & 0xffff);
+}
+#endif
+
 #ifdef __cplusplus
 }
 #endif

src/rtc.h

@@ -77,6 +77,16 @@ typedef enum {
 typedef void(*voidCallbackPtr)(void *);
 
 /* Exported constants --------------------------------------------------------*/
+
+#if defined(STM32F1xx)
+/* select 32 bits in backup memory to store date.
+   2 consecutive 16bit reg. are reserved: RTC_BKP_DATE & RTC_BKP_DATE + 1 */
+#if !defined(RTC_BKP_DATE)
+/* can be changed for your convenience (here : LL_RTC_BKP_DR6 & LL_RTC_BKP_DR7) */
+#define RTC_BKP_DATE LL_RTC_BKP_DR6
+#endif
+#endif /* STM32F1xx */
+
 /* Interrupt priority */
 #ifndef RTC_IRQ_PRIO
 #define RTC_IRQ_PRIO       2
@@ -188,6 +198,10 @@ void attachSecondsIrqCallback(voidCallbackPtr func);
 void detachSecondsIrqCallback(void);
 #endif /* ONESECOND_IRQn */
 
+#if defined(STM32F1xx)
+void RTC_StoreDate(void);
+#endif
+
 #ifdef __cplusplus
 }
 #endif