Refactor flash/storage I/O to use std::span

Reworked config store, flashcode, flashcode install, SPI flash commands, and DMX scene read/write paths to use `std::span` instead of raw pointer+length pairs. This improves API safety and call-site clarity while preserving behavior.

The update also cleans up SPI flash internals (namespacing, command constants, probe function names), adds readiness/operation timeout handling and watchdog feeds during long flash operations, and aligns node/display conditional includes/macros so RDM and node-type builds resolve the right dependencies.

Author: vanvught

common/include/json/json_jsondoc.h

@@ -95,6 +95,8 @@ class JsonDoc {
     }
 
     void WriteField(const char* key, uint32_t value) {
+		assert(key != nullptr);
+		
         if (!first_) {
             Write(",");
         }
@@ -121,6 +123,8 @@ class JsonDoc {
     }
 
     void Write(const char* string) {
+		assert(string != nullptr);
+		
         if (pos_ >= max_len_) {
             return;
         }

lib-artnet/include/json/artnetparamsconst.h

@@ -28,9 +28,6 @@
 #include "common/utils/utils_hash.h"
 #include "json/json_key.h"
 #include "dmxnode_outputtype.h"
-#if defined(DMXNODE_OUTPUT_DMX)
-#include "dmx.h"
-#endif
 
 namespace json {
 struct ArtNetParamsConst {
@@ -40,9 +37,9 @@ struct ArtNetParamsConst {
 #if defined(RDM_CONTROLLER) || defined(RDM_RESPONDER)
     static constexpr auto kEnableRdm = json::MakeSimpleKey("enable_rdm");
 
-    static constexpr json::PortKey kRdmEnablePortA{"rdm_enable_port_a", 17, Fnv1a32("rdm_enable_port_a", 17)};
+    static constexpr json::PortKey kRdmEnablePortA{.name="rdm_enable_port_a", .length=17, .hash=Fnv1a32("rdm_enable_port_a", 17)};
 #if (DMX_MAX_PORTS > 1)
-    static constexpr json::PortKey kRdmEnablePortB{"rdm_enable_port_b", 17, Fnv1a32("rdm_enable_port_b", 17)};
+    static constexpr json::PortKey kRdmEnablePortB{.name="rdm_enable_port_b", .length=17, .hash=Fnv1a32("rdm_enable_port_b", 17)};
 #endif
 #if (DMX_MAX_PORTS > 2)
     static constexpr json::PortKey kRdmEnablePortC{"rdm_enable_port_c", 17, Fnv1a32("rdm_enable_port_c", 17)};
@@ -66,9 +63,9 @@ struct ArtNetParamsConst {
 #endif
 
 #if defined(DMX_MAX_PORTS)
-    static constexpr json::PortKey kDestinationIpPortA{"destination_ip_port_a", 21, Fnv1a32("destination_ip_port_a", 21)};
+    static constexpr json::PortKey kDestinationIpPortA{.name="destination_ip_port_a", .length=21, .hash=Fnv1a32("destination_ip_port_a", 21)};
 #if (DMX_MAX_PORTS > 1)
-    static constexpr json::PortKey kDestinationIpPortB{"destination_ip_port_b", 21, Fnv1a32("destination_ip_port_b", 21)};
+    static constexpr json::PortKey kDestinationIpPortB{.name="destination_ip_port_b", .length=21, .hash=Fnv1a32("destination_ip_port_b", 21)};
 #endif
 #if (DMX_MAX_PORTS > 2)
     static constexpr json::PortKey kDestinationIpPortC{"destination_ip_port_c", 21, Fnv1a32("destination_ip_port_c", 21)};
@@ -90,9 +87,9 @@ struct ArtNetParamsConst {
 #endif
     };
 
-    static constexpr json::PortKey kProtocolPortA{"protocol_port_a", 15, Fnv1a32("protocol_port_a", 15)};
+    static constexpr json::PortKey kProtocolPortA{.name="protocol_port_a", .length=15, .hash=Fnv1a32("protocol_port_a", 15)};
 #if (DMX_MAX_PORTS > 1)
-    static constexpr json::PortKey kProtocolPortB{"protocol_port_b", 15, Fnv1a32("protocol_port_b", 15)};
+    static constexpr json::PortKey kProtocolPortB{.name="protocol_port_b", .length=15, .hash=Fnv1a32("protocol_port_b", 15)};
 #endif
 #if (DMX_MAX_PORTS > 2)
     static constexpr json::PortKey kProtocolPortC{"protocol_port_c", 15, Fnv1a32("protocol_port_c", 15)};
@@ -114,9 +111,9 @@ struct ArtNetParamsConst {
 #endif
     };
 
-    static constexpr json::PortKey kBgDiscoveryPortA{"bg_discovery_port_a", 19, Fnv1a32("bg_discovery_port_a", 19)};
+    static constexpr json::PortKey kBgDiscoveryPortA{.name="bg_discovery_port_a", .length=19, .hash=Fnv1a32("bg_discovery_port_a", 19)};
 #if (DMX_MAX_PORTS > 1)
-    static constexpr json::PortKey kBgDiscoveryPortB{"bg_discovery_port_b", 19, Fnv1a32("bg_discovery_port_b", 19)};
+    static constexpr json::PortKey kBgDiscoveryPortB{.name="bg_discovery_port_b", .length=19, .hash=Fnv1a32("bg_discovery_port_b", 19)};
 #endif
 #if (DMX_MAX_PORTS > 2)
     static constexpr json::PortKey kBgDiscoveryPortC{"bg_discovery_port_c", 19, Fnv1a32("bg_discovery_port_c", 19)};

lib-artnet/src/node/failsafe/artnetnodefailsafe.cpp

@@ -24,6 +24,7 @@
  */
 
 #include <cstdint>
+#include <span>
 
 #include "artnetnode.h"
 #include "dmxnode.h"
@@ -38,7 +39,7 @@ void ArtNetNode::FailSafeRecord() {
 
     for (uint32_t port_index = 0; port_index < dmxnode::kMaxPorts; port_index++) {
         if (node_.port[port_index].direction == dmxnode::Direction::kOutput) {
-            dmxnode::scenes::Write(port_index, dmxnode::Data::Backup(port_index));
+            dmxnode::scenes::Write(port_index, std::span<const uint8_t>{dmxnode::Data::Backup(port_index), dmxnode::kUniverseSize});
         }
     }
 
@@ -54,7 +55,7 @@ void ArtNetNode::FailSafePlayback() {
 
     for (uint32_t port_index = 0; port_index < dmxnode::kMaxPorts; port_index++) {
         if (node_.port[port_index].direction == dmxnode::Direction::kOutput) {
-            dmxnode::scenes::Read(port_index, const_cast<uint8_t*>(dmxnode::Data::Backup(port_index)));
+            dmxnode::scenes::Read(port_index, std::span<uint8_t>{const_cast<uint8_t*>(dmxnode::Data::Backup(port_index)), dmxnode::kUniverseSize});
             dmxnode::DataOutput(dmxnode_output_type_, port_index);
 
             if (!output_port_[port_index].is_transmitting) {

lib-clib/src/gd32/time_systick/time.cpp

@@ -45,7 +45,7 @@ extern "C" {
  *     1970-01-01 00:00:00 +0000 (UTC).
  */
 
-int gettimeofday(struct timeval* tv, __attribute__((unused)) struct timezone* tz) {
+int gettimeofday(struct timeval* tv, [[maybe_unused]] struct timezone* tz) {
     assert(tv != 0);
 
     const auto kCurrentSysTickMillis = gv_systick_millis;
@@ -77,7 +77,7 @@ int gettimeofday(struct timeval* tv, __attribute__((unused)) struct timezone* tz
     return 0;
 }
 
-int settimeofday(const struct timeval* tv, __attribute__((unused)) const struct timezone* tz) {
+int settimeofday(const struct timeval* tv, [[maybe_unused]] const struct timezone* tz) {
     assert(tv != 0);
 
     struct timeval g;

lib-clib/src/gd32/time_timer/time.cpp

@@ -110,7 +110,7 @@ extern "C" {
  *     1970-01-01 00:00:00 +0000 (UTC).
  */
 
-int gettimeofday(struct timeval* tv, __attribute__((unused)) struct timezone* tz) {
+int gettimeofday(struct timeval* tv, [[maybe_unused]] struct timezone* tz) {
     assert(tv != nullptr);
 
 #if __CORTEX_M == 7
@@ -127,7 +127,7 @@ int gettimeofday(struct timeval* tv, __attribute__((unused)) struct timezone* tz
     return 0;
 }
 
-int settimeofday(const struct timeval* tv, __attribute__((unused)) const struct timezone* tz) {
+int settimeofday(const struct timeval* tv, [[maybe_unused]] const struct timezone* tz) {
     assert(tv != nullptr);
 
     // Disable the timer interrupt to prevent it from triggering while we adjust the counter

lib-configstore/device/gd32/ram/storedevice.cpp

@@ -29,6 +29,7 @@
 
 #include <cstdint>
 #include <cstdio>
+#include <span>
 #include <cassert>
 
 #include "configstoredevice.h"
@@ -61,29 +62,30 @@ uint32_t StoreDevice::GetSectorSize() const {
     return kFlashSectorSize;
 }
 
-bool StoreDevice::Read(__attribute__((unused)) uint32_t offset, __attribute__((unused)) uint32_t length, __attribute__((unused)) uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Read([[maybe_unused]] uint32_t offset, [[maybe_unused]] std::span<uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
-    assert((offset + length) <= BSRAM_SIZE);
+    assert(offset <= BSRAM_SIZE);
+    assert(buffer.size() <= (BSRAM_SIZE - offset));
 
     result = storedevice::Result::kOk;
 
     CONFIGSTORE_DEBUG_EXIT();
     return true;
 }
 
-bool StoreDevice::Erase(__attribute__((unused)) uint32_t offset, __attribute__((unused)) uint32_t length, storedevice::Result& result) {
+bool StoreDevice::Erase([[maybe_unused]] uint32_t offset, [[maybe_unused]] uint32_t length, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
     result = storedevice::Result::kOk;
-    
 
     CONFIGSTORE_DEBUG_EXIT();
     return true;
 }
 
-bool StoreDevice::Write(__attribute__((unused)) uint32_t offset, __attribute__((unused)) uint32_t length, __attribute__((unused)) const uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Write([[maybe_unused]] uint32_t offset, [[maybe_unused]] std::span<const uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
-    assert((offset + length) <= BSRAM_SIZE);
+    assert(offset <= BSRAM_SIZE);
+    assert(buffer.size() <= (BSRAM_SIZE - offset));
 
     result = storedevice::Result::kOk;
 

lib-configstore/device/gd32/rom/storedevice.cpp

@@ -28,6 +28,7 @@
 #endif
 
 #include <cstdint>
+#include <span>
 
 #include "configstoredevice.h"
 #include "flashcode.h"
@@ -54,11 +55,11 @@ uint32_t StoreDevice::GetSectorSize() const {
     return FlashCode::GetSectorSize();
 }
 
-bool StoreDevice::Read(uint32_t offset, uint32_t length, uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Read(uint32_t offset, std::span<uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
     flashcode::Result flashrom_result;
-    const auto kState = FlashCode::Read(offset, length, buffer, flashrom_result);
+    const auto kState = FlashCode::Read(offset, buffer, flashrom_result);
 
     result = static_cast<storedevice::Result>(flashrom_result);
 
@@ -78,11 +79,11 @@ bool StoreDevice::Erase(uint32_t offset, uint32_t length, storedevice::Result& r
     return kState;
 }
 
-bool StoreDevice::Write(uint32_t offset, uint32_t length, const uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Write(uint32_t offset, std::span<const uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
     flashcode::Result flashrom_result;
-    const auto kState = FlashCode::Write(offset, length, buffer, flashrom_result);
+    const auto kState = FlashCode::Write(offset, buffer, flashrom_result);
 
     result = static_cast<storedevice::Result>(flashrom_result);
 

lib-configstore/device/i2c/storedevice.cpp

@@ -72,11 +72,12 @@ uint32_t StoreDevice::GetSectorSize() const {
     return storedevice::kFlashSectorSize;
 }
 
-bool StoreDevice::Read(uint32_t offset, uint32_t length, uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Read(uint32_t offset, std::span<uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
-    assert((offset + length) <= storedevice::ROM_SIZE);
 
-    AT24C32::Read(offset, buffer, length);
+    assert((offset + buffer.size()) <= storedevice::kRomSize);
+
+    AT24C32::Read(offset, buffer);
 
     result = storedevice::Result::kOk;
 
@@ -93,11 +94,12 @@ bool StoreDevice::Erase([[maybe_unused]] uint32_t offset, [[maybe_unused]] uint3
     return true;
 }
 
-bool StoreDevice::Write(uint32_t offset, uint32_t length, const uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Write(uint32_t offset, std::span<const uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
-    assert((offset + length) <= ROM_SIZE);
 
-    AT24C32::Write(offset, buffer, length);
+    assert((offset + buffer.size()) <= storedevice::kRomSize);
+
+    AT24C32::Write(offset, buffer);
 
     result = storedevice::Result::kOk;
 

lib-configstore/device/spi/storedevice.cpp

@@ -29,6 +29,7 @@
 
 #include <cstdint>
 #include <cstdio>
+#include <span>
 
 #include "configstoredevice.h"
 #include "spi/spi_flash.h"
@@ -40,11 +41,8 @@ StoreDevice::StoreDevice() {
     if (!spi::flash::Probe()) {
         puts("StoreDevice: No SPI flash chip.");
     } else {
-        printf("StoreDevice: SPI flash %s sector size %u total %u bytes [%u kB]\n", 
-          spi::flash::Name(), 
-          static_cast<unsigned int>(spi::flash::SectorSize()), 
-          static_cast<unsigned int>(spi::flash::Size()),
-          static_cast<unsigned int>(spi::flash::Size() / 1024U));
+        printf("StoreDevice: SPI flash %s sector size %u total %u bytes [%u kB]\n", spi::flash::Name(), static_cast<unsigned int>(spi::flash::SectorSize()), static_cast<unsigned int>(spi::flash::Size()),
+               static_cast<unsigned int>(spi::flash::Size() / 1024U));
         detected_ = true;
     }
 
@@ -64,10 +62,10 @@ uint32_t StoreDevice::GetSectorSize() const {
     return spi::flash::SectorSize();
 }
 
-bool StoreDevice::Read(uint32_t offset, uint32_t length, uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Read(uint32_t offset, std::span<uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
-    result = spi::flash::cmd::Read(offset, length, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
+    result = spi::flash::cmd::Read(offset, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
 
     CONFIGSTORE_DEBUG_PRINTF("result=%d", static_cast<int>(result));
     CONFIGSTORE_DEBUG_EXIT();
@@ -84,10 +82,10 @@ bool StoreDevice::Erase(uint32_t offset, uint32_t length, storedevice::Result& r
     return true;
 }
 
-bool StoreDevice::Write(uint32_t offset, uint32_t length, const uint8_t* buffer, storedevice::Result& result) {
+bool StoreDevice::Write(uint32_t offset, std::span<const uint8_t> buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
-    result = spi::flash::cmd::Write(offset, length, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
+    result = spi::flash::cmd::Write(offset, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
 
     CONFIGSTORE_DEBUG_PRINTF("result=%d", static_cast<int>(result));
     CONFIGSTORE_DEBUG_EXIT();

lib-configstore/include/configstore.h

@@ -28,6 +28,7 @@
 
 #include <cstdint>
 #include <cstring>
+#include <span>
 #include <cassert>
 
 #include "configstoredevice.h"
@@ -92,7 +93,7 @@ class ConfigStore : StoreDevice {
             CONFIGSTORE_DEBUG_PRINTF("s_start_address=%p", reinterpret_cast<void*>(s_start_address));
 
             storedevice::Result result;
-            while (!StoreDevice::Read(s_start_address, kStoreSize, reinterpret_cast<uint8_t*>(&s_store), result)) {
+            while (!StoreDevice::Read(s_start_address, std::span{s_store}, result)) {
             }
             assert(result == storedevice::Result::kOk);
         }
@@ -593,7 +594,7 @@ class ConfigStore : StoreDevice {
                 break;
             case State::kWriting: {
                 storedevice::Result result;
-                if (StoreDevice::Write(s_start_address, sizeof(ConfigurationStore), reinterpret_cast<uint8_t*>(&s_store), result)) {
+                if (StoreDevice::Write(s_start_address, std::span{s_store}.first<sizeof(ConfigurationStore)>(), result)) {
                     s_state = State::kIdle;
                     return false;
                 }