rename ConfigParamaBase to FlashParam

CMakeLists.txt

@@ -24,6 +24,7 @@ set(bin_name ${PROJECT_NAME})
 add_executable(${bin_name}
     src/main.cpp
     src/ConfigMenu.cpp
+    src/ConfigParam.cpp
     src/FlashParam.cpp
     src/ImageFitter.cpp
     src/lcd_background.cpp

src/ConfigParam.cpp

@@ -0,0 +1,47 @@
+/*-----------------------------------------------------------/
+/ ConfigParam.h
+/------------------------------------------------------------/
+/ Copyright (c) 2024, Elehobica
+/ Released under the BSD-2-Clause
+/ refer to https://opensource.org/licenses/BSD-2-Clause
+/-----------------------------------------------------------*/
+
+#include "ConfigParam.h"
+
+namespace FlashParamNs {
+//=================================
+// Implementation of ConfigParam class
+//=================================
+ConfigParam& ConfigParam::instance()  // Singleton
+{
+    static ConfigParam instance;
+    return instance;
+}
+
+uint32_t ConfigParam::getBootCountFromFlash()
+{
+    auto& param = P_CFG_BOOT_COUNT;
+    ReadFromFlashVisitor visitor;
+    visitor(&param);
+    return param.get();
+}
+
+void ConfigParam::incBootCount()
+{
+    auto& param = P_CFG_BOOT_COUNT;
+    param.set(param.get() + 1);
+}
+
+void ConfigParam::initialize()
+{
+    loadDefault();
+    // don't load from Flash if flash is blank
+    if (getBootCountFromFlash() == 0xffffffffUL) { return; }
+    // load from flash and get format revision
+    uint32_t formatRevExpected = P_CFG_FORMAT_REV.get();
+    loadFromFlash();
+    uint32_t formatRev = P_CFG_FORMAT_REV.get();
+    // Force to reset to default due to format revision changed (parameter/address) to avoid mulfunction
+    if (formatRevExpected != formatRev) { loadDefault(); }
+}
+}

src/ConfigParam.h

@@ -47,32 +47,14 @@ typedef enum {
     CFG_MENU_IDX_PLAY_RANDOM_DIR_DEPTH,
 } ParamId_t;
 
-struct ConfigParam : ConfigParamBase {
-    static ConfigParam& instance() {  // Singleton
-        static ConfigParam instance;
-        return instance;
-    }
-    uint32_t getBootCountFromFlash() {
-        auto& param = P_CFG_BOOT_COUNT;
-        ReadFromFlashVisitor visitor;
-        visitor(&param);
-        return param.get();
-    }
-    void incBootCount() {
-        auto& param = P_CFG_BOOT_COUNT;
-        param.set(param.get() + 1);
-    }
-    void initialize() {
-        loadDefault();
-        // don't load from Flash if flash is blank
-        if (getBootCountFromFlash() == 0xffffffffUL) { return; }
-        // load from flash and get format revision
-        uint32_t formatRevExpected = P_CFG_FORMAT_REV.get();
-        loadFromFlash();
-        uint32_t formatRev = P_CFG_FORMAT_REV.get();
-        // Force to reset to default due to format revision changed (parameter/address) to avoid mulfunction
-        if (formatRevExpected != formatRev) { loadDefault(); }
-    }
+//=================================
+// Interface of ConfigParam class
+//=================================
+struct ConfigParam : FlashParam {
+    static ConfigParam& instance();  // Singleton
+    uint32_t getBootCountFromFlash();
+    void incBootCount();
+    void initialize();
 
     // Parameter<T>     inst                                         id                                          name                                          addr   default
     Parameter<uint32_t> P_CFG_BOOT_COUNT                            {CFG_BOOT_COUNT,                             "CFG_BOOT_COUNT",                             0x000, 10};

src/FlashParam.cpp

@@ -90,30 +90,32 @@ void Params::storeToFlash() const
 }
 
 //=================================
-// Implementation of ConfigParamBase class
+// Implementation of FlashParam class
 //=================================
-ConfigParamBase& ConfigParamBase::instance()
+FlashParam& FlashParam::instance()
 {
-    static ConfigParamBase instance; // Singleton
+    static FlashParam instance; // Singleton
     return instance;
 }
 
-void ConfigParamBase::printInfo() const
+void FlashParam::printInfo() const
 {
+    UserFlash& userFlash = UserFlash::instance();
+    userFlash.printInfo();
     Params::instance().printInfo();
 }
 
-void ConfigParamBase::loadDefault()
+void FlashParam::loadDefault()
 {
     Params::instance().loadDefault();
 }
 
-void ConfigParamBase::loadFromFlash()
+void FlashParam::loadFromFlash()
 {
     Params::instance().loadFromFlash();
 }
 
-void ConfigParamBase::finalize() const
+void FlashParam::finalize() const
 {
     Params::instance().storeToFlash();
 }

src/FlashParam.h

@@ -38,7 +38,7 @@ class Parameter {
     const size_t size;
     valueType value = defaultValue;
     friend class Params;
-    friend class ConfigParamBase;
+    friend class FlashParam;
     friend class ReadFromFlashVisitor;
     friend class WriteReserveVisitor;
     friend class PrintInfoVisitor;
@@ -113,16 +113,16 @@ class Params
     }
     std::map<const uint32_t, variant_t> paramMap;
     template<typename> friend class Parameter;  // for all Parameter<> classes
-    friend class ConfigParamBase;
+    friend class FlashParam;
 };
 
 //=================================
-// Interface of ConfigParamBase class
+// Interface of FlashParam class
 //=================================
-class ConfigParamBase
+class FlashParam
 {
 public:
-    static ConfigParamBase& instance(); // Singleton
+    static FlashParam& instance(); // Singleton
     void printInfo() const;
     void finalize() const;
     /*
@@ -139,10 +139,10 @@ class ConfigParamBase
     void setValue(const uint32_t& id, const T& value) { _setValue<Parameter<T>>(id, value); }
 
 protected:
-    ConfigParamBase() = default;
-    ~ConfigParamBase() = default;
-    ConfigParamBase(const ConfigParamBase&) = delete;
-    ConfigParamBase& operator=(const ConfigParamBase&) = delete;
+    FlashParam() = default;
+    ~FlashParam() = default;
+    FlashParam(const FlashParam&) = delete;
+    FlashParam& operator=(const FlashParam&) = delete;
     void loadDefault();
     void loadFromFlash();
     // accessor by uint32_t on template T = Patameter<>

src/UIMode.cpp

@@ -35,7 +35,6 @@ UIMode::ExitType UIMode::exitType = UIMode::NoError;
 ConfigMenu& UIMode::cfgMenu = ConfigMenu::instance();
 ConfigParam& UIMode::cfgParam = ConfigParam::instance();
 LcdCanvas* UIMode::lcd = nullptr;  // dynamic instance generation after configureLcd() is needed
-UserFlash& UIMode::userFlash = UserFlash::instance();
 std::array<UIMode*, NUM_UI_MODES> UIMode::ui_mode_ary;
 
 //================================
@@ -193,7 +192,6 @@ UIOpeningMode::UIOpeningMode() : UIMode("UIOpeningMode", OpeningMode)
 void UIOpeningMode::restoreFromFlash() const
 {
     // Load Configuration parameters from Flash
-    userFlash.printInfo();
     cfgParam.printInfo();
     //cfgMenu.printInfo();
     cfgParam.incBootCount();

src/UIMode.h

@@ -16,7 +16,6 @@
 #include "LcdCanvas.h"
 #include "LcdCanvasIconDef.h"
 #include "ui_control.h"
-#include "UserFlash.h"
 
 typedef enum {
     None = 0,
@@ -83,7 +82,6 @@ class UIMode
     static ConfigMenu& cfgMenu;
     static ConfigParam& cfgParam;
     static LcdCanvas* lcd;
-    static UserFlash& userFlash;
     bool isAudioFile(const uint16_t& idx) const;
     const char* name;
     UIMode* prevMode = nullptr;

src/UserFlash.cpp

@@ -11,6 +11,7 @@
 
 #include "pico/flash.h"
 
+namespace FlashParamNs {
 void _user_flash_program_core(void* ptr)
 {
     UserFlash* inst = static_cast<UserFlash*>(ptr);
@@ -62,3 +63,4 @@ void UserFlash::_program_core()
     flash_range_program(UserFlashOfs, data.data(), FLASH_PAGE_SIZE);
     std::copy(flashContents, flashContents + data.size(), data.begin());
 }
+}

src/UserFlash.h

@@ -10,12 +10,10 @@
 
 #include "hardware/flash.h"
 
+namespace FlashParamNs {
 //=================================
 // Interface of UserFlash class
 //=================================
-
-//#define userFlash UserFlash::instance()
-
 class UserFlash
 {
 public:
@@ -44,14 +42,15 @@ class UserFlash
     static constexpr size_t EraseSize = ((UserReqSize + (FLASH_SECTOR_SIZE - 1)) / FLASH_SECTOR_SIZE) * FLASH_SECTOR_SIZE;
     static constexpr size_t PagePgrSize = ((UserReqSize + (FLASH_PAGE_SIZE - 1)) / FLASH_PAGE_SIZE) * FLASH_PAGE_SIZE;
     static constexpr uint32_t UserFlashOfs = FlashSize - EraseSize;
-    const uint8_t* flashContents = reinterpret_cast<const uint8_t*>(XIP_BASE + UserFlashOfs);
-    std::array<uint8_t, PagePgrSize> data;
-    // Singleton
     UserFlash();
     virtual ~UserFlash();
     UserFlash(const UserFlash&) = delete;
     UserFlash& operator=(const UserFlash&) = delete;
     void _program_core();
+    const uint8_t* flashContents = reinterpret_cast<const uint8_t*>(XIP_BASE + UserFlashOfs);
+    std::array<uint8_t, PagePgrSize> data;
 
     friend void _user_flash_program_core(void*);
+    friend class FlashParam;
 };
+}