Merge pull request #9 from 107-systems/renesas

Add support for ArduinoCore-renesas.

Author: aentinger

.github/workflows/compile-examples.yml

@@ -38,6 +38,12 @@ jobs:
             platforms: |
               - name: rp2040:rp2040
                 source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
+          - fqbn: arduino:renesas_portenta:portenta_c33
+            platforms: |
+              - name: arduino:renesas_portenta
+          - fqbn: arduino:renesas_uno:minima
+            platforms: |
+              - name: arduino:renesas_uno
 
     steps:
       - name: Checkout

README.md

@@ -18,6 +18,7 @@ This library provides support functionality for building a complete [Cyphal](htt
 
 This library works for
 * [arduino-pico](https://github.com/earlephilhower/arduino-pico): [`Raspberry Pi Pico`](https://www.raspberrypi.org/products/raspberry-pi-pico), `Adafruit Feather RP2040`, ... :heavy_check_mark:
+* [ArduinoCore-renesas](https://github.com/arduino/ArduinoCore-renesas): [`Portenta C33`](https://store.arduino.cc/products/portenta-c33), [`Uno R4 WiFi`](https://store.arduino.cc/products/uno-r4-wifi), [`Uno R4 Minima`](https://store.arduino.cc/products/uno-r4-minima), ... :heavy_check_mark:
 
 **Features:**
 * API for obtaining a **unique 64-bit ID**.

examples/AsyncReset/AsyncReset.ino

@@ -27,7 +27,12 @@ void setup()
   while (!Serial) { }
 
   Serial.println("Trigger async reset in 5 seconds ...");
-  cyphal::support::platform::reset_async(std::chrono::milliseconds(5000));
+  auto const rc = cyphal::support::platform::reset_async(std::chrono::milliseconds(5000));
+  if (rc.has_value()) {
+    Serial.print("reset_async failed with error code ");
+    Serial.println(static_cast<int>(rc.value()));
+  }
+
   start = millis();
 }
 

examples/SyncReset/SyncReset.ino

@@ -21,7 +21,11 @@ void setup()
   while (!Serial) { }
 
   Serial.println("Trigger sync reset in 5 seconds ...");
-  cyphal::support::platform::reset_sync(std::chrono::milliseconds(5000));
+  auto const rc = cyphal::support::platform::reset_sync(std::chrono::milliseconds(5000));
+  if (rc.has_value()) {
+    Serial.print("reset_sync failed with error code ");
+    Serial.println(static_cast<int>(rc.value()));
+  }
 }
 
 void loop()

library.properties

@@ -6,6 +6,6 @@ sentence=Arduino library for providing a various support functions for building
 paragraph=Examples for such support functionality is an API for obtaining a unique 64-bit ID as well as an API for permanent register storage and retrieval.
 category=Other
 url=https://github.com/107-systems/107-Arduino-Cyphal-Support
-architectures=rp2040
+architectures=rp2040,renesas_portenta,renesas_uno
 includes=107-Arduino-Cyphal-Support.h
 depends=107-Arduino-UniqueId,107-Arduino-Cyphal,107-Arduino-littlefs

src/reset/reset-renesas.cpp

@@ -0,0 +1,89 @@
+/**
+ * This software is distributed under the terms of the MIT License.
+ * Copyright (c) 2023 LXRobotics.
+ * Author: Alexander Entinger <[email protected]>
+ * Contributors: https://github.com/107-systems/107-Arduino-Cyphal-Support/graphs/contributors.
+ */
+
+/**************************************************************************************
+ * INCLUDE
+ **************************************************************************************/
+
+#include "reset.h"
+
+#if defined(ARDUINO_ARCH_RENESAS)
+
+#include <WDT.h>
+
+/* Provide prototype for Arduino's delay function. */
+extern "C" void delay(unsigned long);
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+namespace cyphal::support::platform
+{
+
+/**************************************************************************************
+ * GLOBAL CONSTANTS
+ **************************************************************************************/
+
+#if defined(ARDUINO_MINIMA) || defined(ARDUINO_UNOWIFIR4)
+static uint32_t const WATCHDOG_MAX_DELAY_ms = 5592;
+#elif defined(ARDUINO_PORTENTA_C33)
+static uint32_t const WATCHDOG_MAX_DELAY_ms = 2684;
+#else
+# error "Your selected Renesas MCU is not supported"
+#endif
+
+/**************************************************************************************
+ * GLOBAL VARIABLES
+ **************************************************************************************/
+
+static bool is_async_reset_pending_flag = false;
+
+/**************************************************************************************
+ * FUNCTION DEFINITION
+ **************************************************************************************/
+
+std::optional<Error> reset()
+{
+  WDT.begin(1); /* Minimum delay is 1 ms. */
+  return std::nullopt;
+}
+
+std::optional<Error> reset_sync(std::chrono::milliseconds const ms)
+{
+  if (ms.count() > WATCHDOG_MAX_DELAY_ms)
+    return Error::InvalidParam;
+
+  WDT.begin(ms.count());
+  for(;;) { delay(100); } /* Wait for the watchdog to bite. */
+  return std::nullopt;
+}
+
+std::optional<Error> reset_async(std::chrono::milliseconds const ms)
+{
+  if (ms.count() > WATCHDOG_MAX_DELAY_ms)
+    return Error::InvalidParam;
+
+  WDT.begin(ms.count());
+
+  is_async_reset_pending_flag = true;
+
+  return std::nullopt;
+}
+
+bool is_async_reset_pending()
+{
+  return is_async_reset_pending_flag;
+}
+
+/**************************************************************************************
+ * NAMESPACE
+ **************************************************************************************/
+
+} /* cyphal::support::platform */
+
+#endif /* defined(ARDUINO_ARCH_RENESAS) */

src/reset/reset.h

@@ -11,6 +11,9 @@
  * INCLUDE
  **************************************************************************************/
 
+#ifdef ARDUINO_ARCH_RENESAS
+# undef abs
+#endif
 #include <chrono>
 #include <optional>
 
@@ -36,26 +39,26 @@ enum class Error
 
 /* Immediately after calling this method a reset is performed. */
 std::optional<Error> reset()
-#if !defined(ARDUINO_ARCH_RP2040)
-__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040.")))
+#if !defined(ARDUINO_ARCH_RP2040) && !defined(ARDUINO_ARCH_RENESAS)
+__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040 and ARDUINO_ARCH_RENESAS.")))
 #endif
 ;
 
 /* This method performs a reset in 'ms' milliseconds after its invocation,
  * blocking while waiting for the time to expire.
  */
 std::optional<Error> reset_sync(std::chrono::milliseconds const ms)
-#if !defined(ARDUINO_ARCH_RP2040)
-__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040.")))
+#if !defined(ARDUINO_ARCH_RP2040) && !defined(ARDUINO_ARCH_RENESAS)
+__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040 and ARDUINO_ARCH_RENESAS.")))
 #endif
 ;
 
 /* This method performs a reset in 'ms' milliseconds after its invocation,
  * but returns immediately after its invocation.
  */
 std::optional<Error> reset_async(std::chrono::milliseconds const ms)
-#if !defined(ARDUINO_ARCH_RP2040)
-__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040.")))
+#if !defined(ARDUINO_ARCH_RP2040) && !defined(ARDUINO_ARCH_RENESAS)
+__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040 and ARDUINO_ARCH_RENESAS.")))
 #endif
 ;
 
@@ -64,8 +67,8 @@ __attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040
  * regular watchdog feeding i.e. in the main loop.
  */
 bool is_async_reset_pending()
-#if !defined(ARDUINO_ARCH_RP2040)
-__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040.")))
+#if !defined(ARDUINO_ARCH_RP2040) && !defined(ARDUINO_ARCH_RENESAS)
+__attribute__ ((error("Currently the reset API only supports ARDUINO_ARCH_RP2040 and ARDUINO_ARCH_RENESAS.")))
 #endif
 ;