Merge pull request #10592 from PaggieZ/ports/analog/add-rtc

tannewt · web-flow · commit f09b42c3b5eb · 2025-08-28T10:47:08.000-07:00
Add RTC module to ports/analog for MAX32690_apard
diff --git a/ports/analog/common-hal/rtc/RTC.c b/ports/analog/common-hal/rtc/RTC.c
@@ -0,0 +1,42 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2019 Nick Moore for Adafruit Industries
+// SPDX-FileCopyrightText: Copyright (c) 2019 Artur Pacholec
+// SPDX-FileCopyrightText: Copyright (c) 2025 Peggy Zhu, Analog Devices, Inc.
+//
+// SPDX-License-Identifier: MIT
+
+#include <stdlib.h>
+
+#include "py/obj.h"
+#include "py/runtime.h"
+#include "shared/timeutils/timeutils.h"
+#include "supervisor/port.h"
+
+// This is the time in seconds since 2000 that the RTC was started.
+// TODO: Change the offset to ticks so that it can be a subsecond adjustment.
+static uint32_t rtc_offset = 0;
+
+void common_hal_rtc_get_time(timeutils_struct_time_t *tm) {
+    uint64_t ticks_s = port_get_raw_ticks(NULL) / 1024;
+    timeutils_seconds_since_2000_to_struct_time(rtc_offset + ticks_s, tm);
+}
+
+void common_hal_rtc_set_time(timeutils_struct_time_t *tm) {
+    uint64_t ticks_s = port_get_raw_ticks(NULL) / 1024;
+    uint32_t epoch_s = timeutils_seconds_since_2000(
+        tm->tm_year, tm->tm_mon, tm->tm_mday, tm->tm_hour, tm->tm_min, tm->tm_sec
+        );
+    rtc_offset = epoch_s - ticks_s;
+}
+
+// the calibration function will be implemented in near future
+// the RTC oscillator on my MAX32690-APARD is only off by 0.001 second
+// the inaccuracy is still tolerable
+int common_hal_rtc_get_calibration(void) {
+    return 0;
+}
+
+void common_hal_rtc_set_calibration(int calibration) {
+    mp_raise_NotImplementedError_varg(MP_ERROR_TEXT("%q"), MP_QSTR_calibration);
+}
diff --git a/ports/analog/common-hal/rtc/RTC.h b/ports/analog/common-hal/rtc/RTC.h
@@ -0,0 +1,11 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2018 Noralf Trønnes
+// SPDX-FileCopyrightText: Copyright (c) 2019 Artur Pacholec
+// SPDX-FileCopyrightText: Copyright (c) 2025 Peggy Zhu, Analog Devices, Inc.
+//
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+extern void rtc_reset(void);
diff --git a/ports/analog/common-hal/rtc/__init__.c b/ports/analog/common-hal/rtc/__init__.c
@@ -0,0 +1,6 @@
+// This file is part of the CircuitPython project: https://circuitpython.org
+//
+// SPDX-FileCopyrightText: Copyright (c) 2024 Adafruit Industries LLC
+// SPDX-FileCopyrightText: Copyright (c) 2025 Peggy Zhu, Analog Devices, Inc.
+//
+// SPDX-License-Identifier: MIT
diff --git a/ports/analog/mpconfigport.mk b/ports/analog/mpconfigport.mk
@@ -24,7 +24,7 @@ INTERNAL_FLASH_FILESYSTEM = 1
 
 # Plan to implement
 CIRCUITPY_BUSIO ?= 0
-CIRCUITPY_RTC ?= 0
+CIRCUITPY_RTC ?= 1
 
 # Other modules (may or may not implement):
 CIRCUITPY_ANALOGIO ?= 0
