RTC: improved board mgm, fixed build wrn

Author: dani-clo

libraries/RTC/RTC.cpp

@@ -182,8 +182,14 @@ int Rtc::getSeconds()
     return -1;
 }
 
+#ifdef CONFIG_RTC_STM32
+
 #if DT_NODE_EXISTS(DT_NODELABEL(rtc))
-#define RTC_NODE DT_NODELABEL(rtc)
+    #define RTC_NODE DT_NODELABEL(rtc)
+#else    
+    #define RTC_NODE DT_INVALID_NODE
+    #warning "RTC node not found in devicetree"
+#endif
 
 /**
  * @brief Rtc library constructor
@@ -193,7 +199,7 @@ int Rtc::getSeconds()
  */
 Rtc::Rtc()
 {
-    rtc_dev = DEVICE_DT_GET(RTC_NODE);
+    rtc_dev = DEVICE_DT_GET_OR_NULL(RTC_NODE);
     if (!rtc_dev) {
         printk("RTC device not found in device tree\n");
     }
@@ -241,10 +247,10 @@ int Rtc::setTime(int year, int month, int day, int hour, int minute, int second)
         .tm_mday = day,
         .tm_mon = month - 1,
         .tm_year = year - 1900,
-        .tm_wday = -1, /* unknown */
-        .tm_yday = -1, /* unknown */
-        .tm_isdst = -1, /* unknown */
-        .tm_nsec = 0 /* unknown */
+        .tm_wday = 0, 
+        .tm_yday = 0, 
+        .tm_isdst = -1, /**< Daylight saving time flag (Unknown = -1) */
+        .tm_nsec = 0 /* Nanoseconds (Unknown = 0) */
     };
 
     return rtc_set_time(rtc_dev, &time);
@@ -395,7 +401,9 @@ bool Rtc::isAlarmPending()
  * @param uint16_t id is an event/alarm identifier
  * @param void *user_data is a void pointer the user can set when registering the callback
  */
-void Rtc::alarmCallbackWrapper(const struct device *dev, uint16_t id, void *user_data)
+void Rtc::alarmCallbackWrapper([[maybe_unused]] const struct device *dev,
+                               [[maybe_unused]] uint16_t id,
+                               void *user_data)
 {
     Rtc *self = static_cast<Rtc *>(user_data);
     if (self && self->userAlarmCallback) {
@@ -427,7 +435,8 @@ int Rtc::setUpdateCallback(RtcUpdateCallback cb, void *user_data)
  * @param const struct device *dev is the hardware device (not used at this level)
  * @param void *user_data is a void pointer the user can set when registering the callback
  */
-void Rtc::updateCallbackWrapper(const struct device *dev, void *user_data)
+void Rtc::updateCallbackWrapper([[maybe_unused]] const struct device *dev,
+                                void *user_data)
 {
     Rtc *self = static_cast<Rtc *>(user_data);
     if (self && self->userUpdateCallback) {
@@ -465,9 +474,14 @@ int Rtc::getCalibration(int32_t &calibration)
     return rtc_get_calibration(rtc_dev, &calibration);
 }
 
-#elif DT_NODE_EXISTS(DT_NODELABEL(rtc2))
+#else // For non-STM32 platforms, we use the generic counter API to implement RTC functionality
 
+#if DT_NODE_EXISTS(DT_NODELABEL(rtc2))
 #define COUNTER_NODE DT_NODELABEL(rtc2)
+#else
+#warning "RTC node not found in devicetree"
+#define COUNTER_NODE DT_INVALID_NODE
+#endif
 LOG_MODULE_REGISTER(Rtc);
 
 // Utility functions - local scope only
@@ -500,7 +514,7 @@ void Rtc::alarmHandler(const struct device *dev, uint8_t chan_id, uint32_t ticks
     if (rtc->user_callback) {
         rtc->user_callback(dev, chan_id, ticks, rtc->user_data);
     } else {
-        LOG_WRN("Alarm triggered but no callback registered! Channel: %d, Ticks: %u", chan_id, ticks);
+        printk("Alarm triggered but no callback registered! Channel: %d, Ticks: %u\n", chan_id, ticks);
     }
 }
 
@@ -512,7 +526,7 @@ void Rtc::alarmHandler(const struct device *dev, uint8_t chan_id, uint32_t ticks
  */
 Rtc::Rtc()
 {
-    counter_dev = DEVICE_DT_GET(COUNTER_NODE);
+    counter_dev = DEVICE_DT_GET_OR_NULL(COUNTER_NODE);
     timeOffset = 0;
     user_callback = nullptr;
     user_data = nullptr;
@@ -527,8 +541,12 @@ Rtc::Rtc()
  */
 bool Rtc::begin()
 {
+    if (!counter_dev) {
+        printk("RTC counter device not found in device tree\n");
+        return false;
+    }
     if (!device_is_ready(counter_dev)) {
-        LOG_ERR("RTC counter device not ready");
+        printk("RTC counter device not ready\n");
         return false;
     }
 
@@ -559,7 +577,7 @@ int Rtc::setTime(int year, int month, int day, int hour, int minute, int second)
 
     uint32_t freq = counter_get_frequency(counter_dev);
     if (freq == 0) {
-        LOG_ERR("Counter frequency is zero");
+        printk("Counter frequency is zero\n");
         return -1;
     }
 
@@ -618,6 +636,7 @@ int Rtc::setAlarm(int year, int month, int day, int hour, int minute, int second
     uint32_t current_ticks;
 
     if (counter_get_value(counter_dev, &current_ticks) != 0) {
+        printk("Failed to get current counter value\n");
         return -1;
     }
 
@@ -641,7 +660,7 @@ int Rtc::setAlarm(int year, int month, int day, int hour, int minute, int second
 
     int ret = counter_set_channel_alarm(counter_dev, 0, &alarm_cfg);
     if (ret != 0) {
-        LOG_WRN("Failed to set alarm: %d", ret);
+        printk("Failed to set alarm: %d\n", ret);
         user_callback = nullptr;
         user_data = nullptr;
         return ret;
@@ -661,13 +680,69 @@ int Rtc::cancelAlarm()
 {
     int ret = counter_cancel_channel_alarm(counter_dev, 0);
     if (ret != 0) {
-        LOG_WRN("Failed to cancel alarm: %d", ret);
+        printk("Failed to cancel alarm: %d\n", ret);
     }
     user_callback = nullptr;
     user_data = nullptr;
     return ret;
 }
 
+/**
+ * @brief Retrieves the currently configured alarm time.
+ * This function is not supported and will return -1 to indicate this.
+ *
+ * @return -1 to indicate not supported.
+ */
+int Rtc::getAlarm([[maybe_unused]] int &year, [[maybe_unused]] int &month, [[maybe_unused]] int &day,
+                  [[maybe_unused]] int &hour, [[maybe_unused]] int &minute, [[maybe_unused]] int &second)
+{
+    return -1;
+}
+
+/**
+ * @brief Checks whether an alarm is currently pending.
+ * This function is not supported and will return false to indicate this.
+ * 
+ * @return false to indicate not supported.
+ */
+bool Rtc::isAlarmPending()
+{
+    return false;
+}
+
+/**
+ * @brief Registers an update callback function.
+ * This function is not supported and will return -1 to indicate this.
+ * 
+ * @return -1 to indicate not supported.
+ */
+int Rtc::setUpdateCallback([[maybe_unused]] RtcUpdateCallback cb, [[maybe_unused]] void *user_data)
+{
+    return -1;
+}
+
+/**
+ * @brief Sets the Rtc calibration value.
+ * This function is not supported and will return -1 to indicate this.
+ * 
+ * @return -1 to indicate not supported.
+ */
+int Rtc::setCalibration([[maybe_unused]] int32_t calibration)
+{
+    return -1;
+}
+
+/**
+ * @brief Retrieves the current Rtc calibration value.
+ * This function is not supported and will return -1 to indicate this.
+ * 
+ * @return -1 to indicate not supported.
+ */
+int Rtc::getCalibration([[maybe_unused]] int32_t &calibration)
+{
+    return -1;
+}
+
 /**
  * @brief Converts a date and time to Unix epoch seconds.
  *
@@ -756,4 +831,4 @@ void Rtc::epochToDatetime(time_t t, int &year, int &month, int &day, int &hour,
     month = m + 1;
     day = days + 1;
 }
-#endif
+#endif /* CONFIG_RTC_STM32*/

libraries/RTC/RTC.h

@@ -217,7 +217,7 @@ class Rtc {
      */
     int getTime(int &year, int &month, int &day, int &hour, int &minute, int &second);
 
-#if DT_NODE_EXISTS(DT_NODELABEL(rtc))
+#ifdef CONFIG_RTC_STM32
     /**
      * @brief Schedules an alarm for a specific time.
      *
@@ -240,7 +240,7 @@ class Rtc {
      */
     int cancelAlarm();
 
-#elif DT_NODE_EXISTS(DT_NODELABEL(rtc2))
+#else
     /**
      * @brief Sets an RTC alarm for boards using the Zephyr counter driver.
      *
@@ -260,12 +260,53 @@ class Rtc {
 
     /**
      * @brief Cancels an active alarm.
+     * 
      * @return 0 on success, negative error code otherwise.
      */
     int cancelAlarm();
+
+    /**
+     * @brief Retrieves the currently configured alarm time.
+     * 
+     * @return -1 to indicate not supported.
+     */
+    int getAlarm([[maybe_unused]] int &year, [[maybe_unused]] int &month, [[maybe_unused]] int &day,
+                 [[maybe_unused]] int &hour, [[maybe_unused]] int &minute, [[maybe_unused]] int &second);
+
+    /**
+     * @brief Checks whether an alarm is currently pending.
+     * This function is not supported and will return -1 to indicate this.
+     * 
+     * @return false to indicate not supported.
+     */
+    bool isAlarmPending();
+
+    /**
+     * @brief Registers an update callback function.
+     * This function is not supported and will return -1 to indicate this.
+     * 
+     * @return -1 to indicate not supported.
+     */
+    int setUpdateCallback([[maybe_unused]] RtcUpdateCallback cb, [[maybe_unused]] void *user_data);
+
+    /**
+     * @brief Sets the Rtc calibration value.
+     * This function is not supported and will return -1 to indicate this.
+     * 
+     * @return -1 to indicate not supported.
+     */
+    int setCalibration([[maybe_unused]] int32_t calibration);
+
+    /**
+     * @brief Retrieves the current Rtc calibration value.
+     * This function is not supported and will return -1 to indicate this.
+     * 
+     * @return -1 to indicate not supported.
+     */
+    int getCalibration([[maybe_unused]] int32_t &calibration);
 #endif
 
-#if DT_NODE_EXISTS(DT_NODELABEL(rtc))
+#ifdef CONFIG_RTC_STM32
     /**
      * @brief Retrieves the currently configured alarm time.
      *
@@ -315,15 +356,15 @@ class Rtc {
 #endif
 
 private:
-#if DT_NODE_EXISTS(DT_NODELABEL(rtc))
+#ifdef CONFIG_RTC_STM32
     /** @brief Pointer to the Zephyr RTC device. */
     const struct device *rtc_dev;
 
     /** @brief Internal static wrapper for alarm callbacks. */
-    static void alarmCallbackWrapper(const struct device *dev, uint16_t id, void *user_data);
+    static void alarmCallbackWrapper([[maybe_unused]] const struct device *dev, [[maybe_unused]] uint16_t id, void *user_data);
 
     /** @brief Internal static wrapper for update callbacks. */
-    static void updateCallbackWrapper(const struct device *dev, void *user_data);
+    static void updateCallbackWrapper([[maybe_unused]] const struct device *dev, void *user_data);
 
     RtcAlarmCallback userAlarmCallback = nullptr;   /**< User-registered alarm callback. */
     void *userAlarmCallbackData = nullptr;          /**< User data for alarm callback. */
@@ -333,7 +374,7 @@ class Rtc {
 
     uint16_t alarmId = 0; /**< Default alarm identifier. */
 
-#elif DT_NODE_EXISTS(DT_NODELABEL(rtc2))
+#else
     /** @brief Pointer to the Zephyr counter device used as RTC backend. */
     const struct device *counter_dev;
 

libraries/RTC/examples/AlarmRTC/AlarmRTC.ino

@@ -68,7 +68,7 @@ void setup() {
 void loop() {
     char printBuffer[30]; // declare a buffer of large enough size for the message we want to display
     int y, m, d, h, min, s;
-    int status = rtc.getTime(y, m, d, h, min, s);
+    rtc.getTime(y, m, d, h, min, s);
     // Because the print() and println() functions do not support formatted output directly, we can use this trick to prepare a buffer with the string we want to show
     sprintf(printBuffer, "Time is: %04d-%02d-%02d %02d:%02d:%02d", y, m, d, h, min, s);
     Serial.println(printBuffer);

libraries/RTC/examples/CalibrationRTC/CalibrationRTC.ino

@@ -1,13 +1,10 @@
 #include "RTC.h"
 #include <stdio.h>
 
-// Doesn't work on the Opta for some reason.
-
-
 Rtc rtc;
 
 void setup() {
-    char printBuffer[30];
+    char printBuffer[64];
     delay(1000);
     Serial.begin(115200);
     if (!rtc.begin()) {
@@ -17,7 +14,7 @@ void setup() {
 
     int calib = 0;
     if (rtc.getCalibration(calib) == 0) {
-        sprintf(printBuffer, "Current calibration: %d\n", calib);
+        snprintf(printBuffer, sizeof(printBuffer), "Current calibration: %d\n", calib);
         Serial.println(printBuffer);
     } else {
         Serial.println("Failed to get calibration");
@@ -28,7 +25,7 @@ void setup() {
     int32_t new_calib = calib + 1;
 
     if (rtc.setCalibration(new_calib) == 0) {
-        sprintf(printBuffer, "Calibration updated to: %d\n", new_calib);
+        snprintf(printBuffer, sizeof(printBuffer), "Calibration updated to: %d\n", new_calib);
         Serial.println(printBuffer);
     } else {
         Serial.println("Failed to set calibration");