Initial RTC

Author: pennam

src/Arduino_PortentaBreakoutCarrier.h

@@ -35,6 +35,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 #include <Portenta_Ethernet.h>
 #include <Ethernet.h>
 #include "utility/Analog/Analog.h"
+#include "utility/RTC/RTC.h"
 
 #define LAST_ARDUINO_PIN_NUMBER LEDB + 1
 typedef enum {
@@ -252,6 +253,7 @@ class BreakoutCarrierClass {
     MbedSPI SPI_0;
     PDMClass PDM;
     arduino::EthernetClass Ethernet;
+    HWClock RTClock;
     BreakoutCarrierClass() : I2C_0(PH_8,PH_7),
                              I2C_1(PB_7,PB_6),
                              I2C_2(PH_12,PH_11),
@@ -261,7 +263,8 @@ class BreakoutCarrierClass {
                              UART3(PJ_8, PJ_9, NC, NC),
                              SPI_0(PC_2, PC_3, PI_1),
                              PDM(PB_2, PE_2, NC),
-                             Ethernet()
+                             Ethernet(),
+                             RTClock()
     {
     }
 };

src/utility/RTC/RTC.cpp

@@ -0,0 +1,51 @@
+/*
+  RTC.cpp
+  Copyright (c) 2021 Arduino LLC. All right reserved.
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#include "Arduino.h"
+#include "RealTimeClock.h"
+#include "RTC.h"
+#include "mbed.h"
+
+HWClock::HWClock() : lastTimestamp(0)
+{
+  // Empty
+}
+
+
+// getTime returns the current time as unix-timestamp.
+// Return 0 if time has not been set.
+Timestamp HWClock :: getTime() {
+    Timestamp res;
+    //if (lastTimestamp == 0) {
+    //    return res;
+    //}
+    time_t seconds = time(NULL);
+    res.setFromUnixTimestamp(seconds);
+    return res;
+}
+
+// setTime sets the current time given a unix-timestamp.
+bool HWClock :: setTime(Timestamp t) {
+    lastTimestamp = t.getUnixTimestamp();
+    ::set_time(lastTimestamp);
+}
+
+// setTimeWith will sync the current clock with the
+// time given by the specified provider.
+//void HWClock :: setTimeWith(TimeSyncProvider &ts) {
+//    setTime(ts.getTime());
+//}
+

src/utility/RTC/RTC.h

@@ -0,0 +1,37 @@
+/*
+  RTC.h
+  Copyright (c) 2021 Arduino LLC. All right reserved.
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#ifndef ARDUINO_HW_RTC_H
+#define ARDUINO_HW_RTC_H
+
+#include "RealTimeClock.h"
+
+class HWClock : public RealTimeClock {
+public:
+    HWClock();
+
+    // Get the current time as unix-timestamp.
+    // Return 0 if time has not been set.
+    virtual Timestamp getTime();
+
+    // Set the current time as unix-timestamp
+    virtual bool setTime(Timestamp t);
+
+private:
+    uint64_t lastTimestamp;
+};
+
+#endif

src/utility/RTC/RealTimeClock.h

@@ -0,0 +1,43 @@
+/*
+  RealTimeClock.h
+  
+  Copyright (c) 2021 Arduino LLC. All right reserved.
+  
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#pragma once
+
+#include "TimeSyncProvider.h"
+
+// RealTimeClock interface
+// RTC should implement this interface.
+// A RealTimeClock may be used as a TimeSyncProvider.
+class RealTimeClock : public TimeSyncProvider
+{
+  public:
+    // getTime returns the current time as unix-timestamp.
+    // Return 0 if time has not been set.
+    virtual Timestamp getTime() = 0;
+
+    // setTime sets the current time given a unix-timestamp.
+    virtual bool setTime(Timestamp t) = 0;
+
+    // setTimeWith will sync the current clock with the
+    // time given by the specified provider.
+    //void setTimeWith(TimeSyncProvider &ts) {
+    //  setTime(ts.getTime());
+    //}
+};

src/utility/RTC/TimeSyncProvider.h

@@ -0,0 +1,34 @@
+/*
+  TimeSyncProvider.h
+  
+  Copyright (c) 2021 Arduino LLC. All right reserved.
+  
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#pragma once
+
+#include "Timestamp.h"
+
+// TimeSyncProvider interface
+// Time providers (like NetworkTimeProtocol, GPS, DCF77, etc) should
+// implement this interface.
+class TimeSyncProvider
+{
+  public:
+    // getTime returns the current time as unix-timestamp.
+    // Return 0 if time has not been set.
+    virtual Timestamp getTime() = 0;
+};

src/utility/RTC/Timestamp.cpp

@@ -0,0 +1,58 @@
+/*
+  Timestamp.cpp
+  Copyright (c) 2021 Arduino LLC. All right reserved.
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#include "mbed_mktime.h"
+#include "Timestamp.h"
+
+int Timestamp :: minute() {
+    struct tm timeinfo;
+    if (_rtc_localtime(Timestamp :: ts32, &timeinfo, RTC_4_YEAR_LEAP_YEAR_SUPPORT) == false) {
+        return -1;
+    }
+    return timeinfo.tm_min;
+}
+
+int Timestamp :: hour() {
+    struct tm timeinfo;
+    if (_rtc_localtime(Timestamp :: ts32, &timeinfo, RTC_4_YEAR_LEAP_YEAR_SUPPORT) == false) {
+        return -1;
+    }
+    return timeinfo.tm_hour;
+}
+
+int Timestamp :: day() {
+    struct tm timeinfo;
+    if (_rtc_localtime(Timestamp :: ts32, &timeinfo, RTC_4_YEAR_LEAP_YEAR_SUPPORT) == false) {
+        return -1;
+    }
+    return timeinfo.tm_mday;
+}
+
+int Timestamp :: month() {
+    struct tm timeinfo;
+    if (_rtc_localtime(Timestamp :: ts32, &timeinfo, RTC_4_YEAR_LEAP_YEAR_SUPPORT) == false) {
+        return -1;
+    }
+    return timeinfo.tm_mon;
+}
+
+int Timestamp :: year() {
+    struct tm timeinfo;
+    if (_rtc_localtime(Timestamp :: ts32, &timeinfo, RTC_4_YEAR_LEAP_YEAR_SUPPORT) == false) {
+        return -1;
+    }
+    return timeinfo.tm_year;
+}

src/utility/RTC/Timestamp.h

@@ -0,0 +1,60 @@
+/*
+  Timestamp.h
+  
+  Copyright (c) 2021 Arduino LLC. All right reserved.
+  
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+  
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+  
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+*/
+
+#pragma once
+
+// Timestamp represents a fixed time
+typedef struct {
+  public:
+    int second() { return ts32 % 60; }
+    int minute();
+    int hour();
+
+    int day();
+    int month();
+    int year();
+
+    // Internal data
+  private:
+    // use uint64 to handle the 2038 rollover
+    uint64_t ts;
+
+    // *** to avoid 64bit math on small systems an alternative may be:
+
+  public:
+    void setFromUnixTimestamp(uint64_t t) {
+      after_2038 = (t >= 0x100000000);
+      ts32 = t;
+    }
+    uint64_t getUnixTimestamp() {
+      uint64_t t = ts32;
+      if (after_2038) t += 0x100000000;
+      return t;
+    }
+
+    // Internal data
+  private:
+    uint32_t ts32;
+    bool after_2038;
+
+    // More accessor methods, for example:
+    //void setTimeVal(struct tm t); // accept posix timeval
+    //struct tm getTimeVal();       // return posix timeval
+} Timestamp;