Refactor SPI flash API to C++ namespaces

Replace C-style spi_flash_* function names with a C++ namespace API (spi::flash::Probe, spi::flash::cmd::Read, etc.). Rename constants to kCamelCase, move debug macros to the header, switch from time() to timing::Millis() for timeouts (now in ms), use common::ArraySize instead of ARRAY_SIZE macro, and add const correctness to idcode parameters.

Author: vanvught

lib-configstore/device/spi/storedevice.cpp

@@ -37,11 +37,14 @@
 StoreDevice::StoreDevice() {
     CONFIGSTORE_DEBUG_ENTRY();
 
-    if (!spi_flash_probe()) {
+    if (!spi::flash::Probe()) {
         puts("StoreDevice: No SPI flash chip.");
     } else {
-        printf("StoreDevice: %s sector size %u total %u bytes [%u kB]\n", spi_flash_get_name(), static_cast<unsigned int>(spi_flash_get_sector_size()), static_cast<unsigned int>(spi_flash_get_size()),
-               static_cast<unsigned int>(spi_flash_get_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;
     }
 
@@ -54,17 +57,17 @@ StoreDevice::~StoreDevice() {
 }
 
 uint32_t StoreDevice::GetSize() const {
-    return spi_flash_get_size();
+    return spi::flash::Size();
 }
 
 uint32_t StoreDevice::GetSectorSize() const {
-    return spi_flash_get_sector_size();
+    return spi::flash::SectorSize();
 }
 
 bool StoreDevice::Read(uint32_t offset, uint32_t length, uint8_t* buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
-    result = spi_flash_cmd_read_fast(offset, length, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
+    result = spi::flash::cmd::Read(offset, length, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
 
     CONFIGSTORE_DEBUG_PRINTF("result=%d", static_cast<int>(result));
     CONFIGSTORE_DEBUG_EXIT();
@@ -74,7 +77,7 @@ bool StoreDevice::Read(uint32_t offset, uint32_t length, uint8_t* buffer, stored
 bool StoreDevice::Erase(uint32_t offset, uint32_t length, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
-    result = spi_flash_cmd_erase(offset, length) ? storedevice::Result::kOk : storedevice::Result::kError;
+    result = spi::flash::cmd::Erase(offset, length) ? storedevice::Result::kOk : storedevice::Result::kError;
 
     CONFIGSTORE_DEBUG_PRINTF("result=%d", static_cast<int>(result));
     CONFIGSTORE_DEBUG_EXIT();
@@ -84,7 +87,7 @@ bool StoreDevice::Erase(uint32_t offset, uint32_t length, storedevice::Result& r
 bool StoreDevice::Write(uint32_t offset, uint32_t length, const uint8_t* buffer, storedevice::Result& result) {
     CONFIGSTORE_DEBUG_ENTRY();
 
-    result = spi_flash_cmd_write_multi(offset, length, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
+    result = spi::flash::cmd::Write(offset, length, buffer) ? storedevice::Result::kOk : storedevice::Result::kError;
 
     CONFIGSTORE_DEBUG_PRINTF("result=%d", static_cast<int>(result));
     CONFIGSTORE_DEBUG_EXIT();

lib-flash/include/spi/spi_flash.h

@@ -2,7 +2,7 @@
  * @file spi_flash.h
  *
  */
-/* Copyright (C) 2018-2024 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2018-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -28,25 +28,47 @@
 
 #include <cstdint>
 
-namespace spi::flash
-{
-inline constexpr uint32_t PAGE_SIZE = 256;
-inline constexpr uint32_t SECTOR_SIZE = 4096;
-} // namespace spi::flash
+#ifdef DEBUG_SPI_FLASH
+#include "firmware/debug/debug_debug.h"
+
+#define SPI_FLASH_DEBUG_ENTRY() DEBUG_ENTRY()
+#define SPI_FLASH_DEBUG_EXIT() DEBUG_EXIT()
+#define SPI_FLASH_DEBUG_PRINTF(...) DEBUG_PRINTF(__VA_ARGS__)
+#define SPI_FLASH_DEBUG_PUTS(...) DEBUG_PUTS(__VA_ARGS__)
+#else
+#define SPI_FLASH_DEBUG_ENTRY() \
+    do {                        \
+    } while (false)
+#define SPI_FLASH_DEBUG_EXIT() \
+    do {                       \
+    } while (false)
+#define SPI_FLASH_DEBUG_PRINTF(...) \
+    do {                            \
+    } while (false)
+#define SPI_FLASH_DEBUG_PUTS(...) \
+    do {                          \
+    } while (false)
+#endif
 
-bool spi_flash_probe();
+namespace spi::flash {
+inline constexpr uint32_t kPageSize = 256;
+inline constexpr uint32_t kSectorSize = 4096;
 
-const char* spi_flash_get_name();
-uint32_t spi_flash_get_size();
+bool Probe();
 
-inline uint32_t spi_flash_get_sector_size()
-{
-    return spi::flash::SECTOR_SIZE;
+const char* Name();
+uint32_t Size();
+
+inline uint32_t SectorSize() {
+    return spi::flash::kSectorSize;
 }
 
-bool spi_flash_cmd_read_fast(uint32_t offset, uint32_t length, uint8_t* data);
-bool spi_flash_cmd_write_multi(uint32_t offset, uint32_t length, const uint8_t* buffer);
-bool spi_flash_cmd_erase(uint32_t offset, uint32_t length);
-bool spi_flash_cmd_write_status(uint8_t sr);
+namespace cmd {
+bool Read(uint32_t offset, uint32_t length, uint8_t* data);
+bool Write(uint32_t offset, uint32_t length, const uint8_t* buffer);
+bool Erase(uint32_t offset, uint32_t length);
+bool WriteStatus(uint8_t status);
+} // namespace cmd
+} // namespace spi::flash
 
-#endif  // SPI_SPI_FLASH_H_
+#endif // SPI_SPI_FLASH_H_

lib-flash/src/spi/gd32/spi_flash.cpp

@@ -2,7 +2,7 @@
  * @file spi_flash.cpp
  *
  */
-/* Copyright (C) 2022-2024 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2022-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -28,49 +28,50 @@
 #include "./../../spi/spi_flash_internal.h"
 #include "gd32_spi.h"
 #include "gd32_gpio.h"
-#include "gd32.h"
-#include "firmware/debug/debug_debug.h"
+#include "gd32.h" // IWYU pragma: keep
+
+namespace {
+void SpiTransfern(char* buffer, uint32_t length) {
+    Gd32SpiTransfernb(buffer, buffer, length);
+}
+} // namespace
 
 void SpiInit() {
-	Gd32SpiBegin();
-	Gd32SpiChipSelect(GD32_SPI_CS_NONE);
-	Gd32SpiSetSpeedHz(SPI_XFER_SPEED_HZ);
-	Gd32SpiSetDataMode(GD32_SPI_MODE0);
+    Gd32SpiBegin();
+    Gd32SpiChipSelect(GD32_SPI_CS_NONE);
+    Gd32SpiSetSpeedHz(SPI_XFER_SPEED_HZ);
+    Gd32SpiSetDataMode(GD32_SPI_MODE0);
 
-	Gd32GpioFsel(SPI_FLASH_CS_GPIOx, SPI_FLASH_CS_GPIO_PINx, GPIO_FSEL_OUTPUT);
-	GPIO_BOP(SPI_FLASH_CS_GPIOx) = SPI_FLASH_CS_GPIO_PINx;
+    Gd32GpioFsel(SPI_FLASH_CS_GPIOx, SPI_FLASH_CS_GPIO_PINx, GPIO_FSEL_OUTPUT);
+    GPIO_BOP(SPI_FLASH_CS_GPIOx) = SPI_FLASH_CS_GPIO_PINx;
 
-#if defined (SPI_FLASH_WP_GPIO_PINx)
-	Gd32GpioFsel(SPI_GPIOx, SPI_FLASH_WP_GPIO_PINx, GPIO_FSEL_OUTPUT);
-	GPIO_BOP(SPI_GPIOx) = SPI_FLASH_WP_GPIO_PINx;
+#if defined(SPI_FLASH_WP_GPIO_PINx)
+    Gd32GpioFsel(SPI_GPIOx, SPI_FLASH_WP_GPIO_PINx, GPIO_FSEL_OUTPUT);
+    GPIO_BOP(SPI_GPIOx) = SPI_FLASH_WP_GPIO_PINx;
 #endif
 
-#if defined (SPI_FLASH_HOLD_GPIO_PINx)
-	Gd32GpioFsel(SPI_GPIOx, SPI_FLASH_HOLD_GPIO_PINx, GPIO_FSEL_OUTPUT);
-	GPIO_BOP(SPI_GPIOx) = SPI_FLASH_HOLD_GPIO_PINx;
+#if defined(SPI_FLASH_HOLD_GPIO_PINx)
+    Gd32GpioFsel(SPI_GPIOx, SPI_FLASH_HOLD_GPIO_PINx, GPIO_FSEL_OUTPUT);
+    GPIO_BOP(SPI_GPIOx) = SPI_FLASH_HOLD_GPIO_PINx;
 #endif
 }
 
-inline static void SpiTransfern(char *buffer, uint32_t length) {
-	Gd32SpiTransfernb(buffer, buffer, length);
-}
-
-void SpiXfer(uint32_t length, const uint8_t *out, uint8_t *in, uint32_t flags) {
-	if (flags & SPI_XFER_BEGIN) {
-		GPIO_BC(SPI_FLASH_CS_GPIOx) = SPI_FLASH_CS_GPIO_PINx;
-	}
+void SpiXfer(uint32_t length, const uint8_t* data_out, uint8_t* data_in, uint32_t flags) {
+    if (flags & SPI_XFER_BEGIN) {
+        GPIO_BC(SPI_FLASH_CS_GPIOx) = SPI_FLASH_CS_GPIO_PINx;
+    }
 
-	if (length != 0) {
-		if (in == nullptr) {
-			Gd32SpiWritenb(reinterpret_cast<const char *>(out), length);
-		} else if (out == nullptr) {
-			SpiTransfern(reinterpret_cast<char *>(in), length);
-		} else {
-			Gd32SpiTransfernb(reinterpret_cast<const char *>(out), reinterpret_cast<char *>(in), length);
-		}
-	}
+    if (length != 0) {
+        if (data_in == nullptr) {
+            Gd32SpiWritenb(reinterpret_cast<const char*>(data_out), length);
+        } else if (data_out == nullptr) {
+            SpiTransfern(reinterpret_cast<char*>(data_in), length);
+        } else {
+            Gd32SpiTransfernb(reinterpret_cast<const char*>(data_out), reinterpret_cast<char*>(data_in), length);
+        }
+    }
 
-	if (flags & SPI_XFER_END) {
-		GPIO_BOP(SPI_FLASH_CS_GPIOx) = SPI_FLASH_CS_GPIO_PINx;
-	}
+    if (flags & SPI_XFER_END) {
+        GPIO_BOP(SPI_FLASH_CS_GPIOx) = SPI_FLASH_CS_GPIO_PINx;
+    }
 }

lib-flash/src/spi/gigadevice.cpp

@@ -12,7 +12,7 @@
 /*
  * Original code : https://github.com/martinezjavier/u-boot/blob/master/drivers/mtd/spi/gigadevice.c
  */
-/* Copyright (C) 2021-2024 by Arjan van Vught mailto:info@gd32-dmx.org
+/* Copyright (C) 2021-2026 by Arjan van Vught mailto:info@gd32-dmx.org
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -35,57 +35,56 @@
 
 #include <cstdint>
 
+#include "common/utils/utils_array.h"
 #include "spi/spi_flash.h"
 #include "spi_flash_internal.h"
- #include "firmware/debug/debug_debug.h"
 
-struct GigadeviceSpiFlashParams
-{
+struct GigadeviceSpiFlashParams {
     const uint16_t kId;
     const uint16_t kNrBlocks;
     const char* const kName;
 };
 
 static constexpr struct GigadeviceSpiFlashParams kGigadeviceSpiFlashTable[] = {
-	{
-		0x6016,
-		64,
-		"GD25LQ",
-	},
-	{
-		0x4015,
-		8,
-		"GD25Q40",
-	},
-	{
-		0x4017,
-		128,
-		"GD25Q64B",
-	},
+    {
+        .kId = 0x6016,
+        .kNrBlocks = 64,
+        .kName = "GD25LQ",
+    },
+    {
+        .kId = 0x4015,
+        .kNrBlocks = 8,
+        .kName = "GD25Q40",
+    },
+    {
+        .kId = 0x4017,
+        .kNrBlocks = 128,
+        .kName = "GD25Q64B",
+    },
 };
 
-bool SpiFlashProbeGigadevice(struct SpiFlashInfo* flash, uint8_t* idcode)
-{
+bool SpiFlashProbeGigadevice(struct SpiFlashInfo* flash, const uint8_t* idcode) {
+    SPI_FLASH_DEBUG_ENTRY();
+
     const struct GigadeviceSpiFlashParams* params;
-    unsigned int i;
+    size_t index;
 
-    for (i = 0; i < ARRAY_SIZE(kGigadeviceSpiFlashTable); i++)
-    {
-        params = &kGigadeviceSpiFlashTable[i];
-        if (params->kId == ((idcode[1] << 8) | idcode[2]))
-        {
+    for (index = 0; index < common::ArraySize(kGigadeviceSpiFlashTable); index++) {
+        params = &kGigadeviceSpiFlashTable[index];
+        if (params->kId == ((idcode[1] << 8) | idcode[2])) {
             break;
         }
     }
 
-    if (i == ARRAY_SIZE(kGigadeviceSpiFlashTable))
-    {
-        DEBUG_PRINTF("SF: Unsupported GigaDevice ID %02x%02x", idcode[1], idcode[2]);
+    if (index == common::ArraySize(kGigadeviceSpiFlashTable)) {
+        SPI_FLASH_DEBUG_PRINTF("SF: Unsupported GigaDevice ID %02x%02x", idcode[1], idcode[2]);
+        SPI_FLASH_DEBUG_EXIT();
         return false;
     }
 
     flash->name = params->kName;
-    flash->size = 16U * spi::flash::SECTOR_SIZE * params->kNrBlocks;
+    flash->size = 16U * spi::flash::kSectorSize * params->kNrBlocks;
 
+    SPI_FLASH_DEBUG_EXIT();
     return true;
 }