Add EEPROM driver for POSIX

amit-warbhe · amit-warbhe · commit 266bb8d902a7 · 2025-06-24T13:48:53.000+05:30
Implements an IEepromDriver for POSIX based development and testing.
Stores into a file instead of real EEPROM

Change-Id: Ib98a55ca81a6522c425886b2d565daf2d82fb622
diff --git a/executables/referenceApp/platforms/posix/bspConfiguration/CMakeLists.txt b/executables/referenceApp/platforms/posix/bspConfiguration/CMakeLists.txt
@@ -1,3 +1,3 @@
-# This is an empty module kept here because bspCharInputOutput is dependent on
-# this module.
 add_library(bspConfiguration INTERFACE)
+
+target_include_directories(bspConfiguration INTERFACE include)
diff --git a/executables/referenceApp/platforms/posix/bspConfiguration/include/bsp/EepromConfiguration.h b/executables/referenceApp/platforms/posix/bspConfiguration/include/bsp/EepromConfiguration.h
@@ -0,0 +1,5 @@
+// Copyright 2024 Accenture.
+
+#pragma once
+
+#define EEPROM_FILEPATH "/tmp/openbsw_posix_eeprom.bin"
diff --git a/executables/referenceApp/platforms/posix/main/CMakeLists.txt b/executables/referenceApp/platforms/posix/main/CMakeLists.txt
@@ -1,8 +1,8 @@
-add_library(main src/main.cpp)
+add_library(main src/main.cpp src/lifecycle/StaticBsp.cpp)
 
 target_include_directories(main PRIVATE include)
 
-target_link_libraries(main PRIVATE asyncBinding lifecycle)
+target_link_libraries(main PRIVATE asyncBinding lifecycle bspEepromDriver)
 
 add_library(osHooks src/osHooks.cpp)
 
diff --git a/executables/referenceApp/platforms/posix/main/include/lifecycle/StaticBsp.h b/executables/referenceApp/platforms/posix/main/include/lifecycle/StaticBsp.h
@@ -0,0 +1,19 @@
+// Copyright 2024 Accenture.
+
+#pragma once
+
+#include "bsp/eeprom/IEepromDriver.h"
+#include "eeprom/EepromDriver.h"
+
+class StaticBsp
+{
+public:
+    StaticBsp() {}
+
+    void init();
+
+    eeprom::IEepromDriver& getEepromDriver() { return _eepromDriver; }
+
+private:
+    ::eeprom::EepromDriver _eepromDriver;
+};
diff --git a/executables/referenceApp/platforms/posix/main/src/lifecycle/StaticBsp.cpp b/executables/referenceApp/platforms/posix/main/src/lifecycle/StaticBsp.cpp
@@ -0,0 +1,5 @@
+// Copyright 2024 Accenture.
+
+#include "lifecycle/StaticBsp.h"
+
+void StaticBsp::init() { _eepromDriver.init(); }
diff --git a/executables/referenceApp/platforms/posix/main/src/main.cpp b/executables/referenceApp/platforms/posix/main/src/main.cpp
@@ -1,5 +1,7 @@
 // Copyright 2024 Accenture.
 
+#include "lifecycle/StaticBsp.h"
+
 #include <async/AsyncBinding.h>
 #include <lifecycle/LifecycleManager.h>
 
@@ -19,6 +21,7 @@ extern void app_main();
 
 namespace platform
 {
+StaticBsp staticBsp;
 
 #ifdef PLATFORM_SUPPORT_CAN
 ::estd::typed_mem<::systems::CanSystem> canSystem;
@@ -54,6 +57,7 @@ int main()
     signal(SIGINT, intHandler);
     main_thread_setup();
     terminal_setup();
+    ::platform::staticBsp.init();
     app_main(); // entry point for the generic part
     return (1); // we never reach this point
 }
diff --git a/executables/unitTest/bsp/bspConfiguration/include/bsp/EepromConfiguration.h b/executables/unitTest/bsp/bspConfiguration/include/bsp/EepromConfiguration.h
@@ -0,0 +1,5 @@
+// Copyright 2024 Accenture.
+
+#pragma once
+
+#define EEPROM_FILEPATH "/tmp/openbsw_posix_eeprom_ut.bin"
diff --git a/platforms/CMakeLists.txt b/platforms/CMakeLists.txt
@@ -5,6 +5,7 @@ if (NOT BUILD_UNIT_TESTS)
 else ()
     add_subdirectory(posix/bsp/socketCanTransceiver)
     add_subdirectory(posix/bsp/socketCanTransceiver/test/gtest)
+    add_subdirectory(posix/bsp/bspEepromDriver/test/gtest)
     add_subdirectory(s32k1xx/bsp/bspCore/test/gtest)
     add_subdirectory(s32k1xx/bsp/bspIo/test/gtest)
     add_subdirectory(s32k1xx/bsp/bspSci/test/gtest)
diff --git a/platforms/posix/bsp/CMakeLists.txt b/platforms/posix/bsp/CMakeLists.txt
@@ -3,6 +3,7 @@ add_subdirectory(bspMcu)
 add_subdirectory(bspStdio)
 add_subdirectory(bspSystemTime)
 add_subdirectory(socketCanTransceiver)
+add_subdirectory(bspEepromDriver)
 
 add_library(socBsp INTERFACE)
 target_link_libraries(socBsp INTERFACE bspInterruptsImpl bspMcu bspStdio
diff --git a/platforms/posix/bsp/bspEepromDriver/CMakeLists.txt b/platforms/posix/bsp/bspEepromDriver/CMakeLists.txt
@@ -0,0 +1,5 @@
+add_library(bspEepromDriver src/eeprom/EepromDriver.cpp)
+
+target_include_directories(bspEepromDriver PUBLIC include)
+
+target_link_libraries(bspEepromDriver PUBLIC bspConfiguration bsp)
diff --git a/platforms/posix/bsp/bspEepromDriver/include/eeprom/EepromDriver.h b/platforms/posix/bsp/bspEepromDriver/include/eeprom/EepromDriver.h
@@ -0,0 +1,26 @@
+// Copyright 2024 Accenture.
+
+#pragma once
+
+#include "bsp/EepromConfiguration.h"
+#include "bsp/eeprom/IEepromDriver.h"
+
+#include <string>
+
+namespace eeprom
+{
+class EepromDriver : public IEepromDriver
+{
+public:
+    bsp::BspReturnCode init() override;
+
+    bsp::BspReturnCode write(uint32_t address, uint8_t const* buffer, uint32_t length) override;
+
+    bsp::BspReturnCode read(uint32_t address, uint8_t* buffer, uint32_t length) override;
+
+private:
+    static constexpr size_t EEPROM_SIZE = 4096; // 4KB
+    std::string const eepromFilePath    = EEPROM_FILEPATH;
+    int eepromFd{-1};
+};
+} // namespace eeprom
diff --git a/platforms/posix/bsp/bspEepromDriver/module.spec b/platforms/posix/bsp/bspEepromDriver/module.spec
@@ -0,0 +1 @@
+oss: true
diff --git a/platforms/posix/bsp/bspEepromDriver/src/eeprom/EepromDriver.cpp b/platforms/posix/bsp/bspEepromDriver/src/eeprom/EepromDriver.cpp
@@ -0,0 +1,93 @@
+// Copyright 2024 Accenture.
+
+#include "eeprom/EepromDriver.h"
+
+#include "bsp/Bsp.h"
+
+#include <sys/stat.h>
+
+#include <cstring>
+#include <fcntl.h>
+#include <unistd.h>
+
+namespace eeprom
+{
+
+bsp::BspReturnCode EepromDriver::init()
+{
+    bool success = true;
+    eepromFd     = open(eepromFilePath.c_str(), O_RDWR | O_CREAT | O_EXCL, 0666);
+    if (eepromFd != -1)
+    {
+        success = (chmod(eepromFilePath.c_str(), 0666) != -1)
+                  && (ftruncate(eepromFd, EEPROM_SIZE) != -1);
+
+        if (success)
+        {
+            // Initialize file with 0xFF
+            uint8_t buffer[EEPROM_SIZE];
+            memset(buffer, 0xFF, EEPROM_SIZE);
+            ssize_t const written = ::write(eepromFd, buffer, EEPROM_SIZE);
+            success               = ((EEPROM_SIZE == written) && (fsync(eepromFd) == 0));
+        }
+
+        if (!success)
+        {
+            close(eepromFd);
+            eepromFd = -1;
+        }
+    }
+    else if (EEXIST == errno)
+    {
+        // File already exists: open it without O_EXCL
+        eepromFd = open(eepromFilePath.c_str(), O_RDWR);
+        success  = (-1 != eepromFd);
+    }
+    else
+    {
+        success = false;
+    }
+
+    if (!success)
+    {
+        return ::bsp::BSP_ERROR;
+    }
+    return ::bsp::BSP_OK;
+}
+
+bsp::BspReturnCode
+EepromDriver::write(uint32_t const address, uint8_t const* const buffer, uint32_t const length)
+{
+    bool success
+        = ((-1 != eepromFd) && (address < EEPROM_SIZE) && ((address + length) < EEPROM_SIZE));
+
+    success = (success && (lseek(eepromFd, address, SEEK_SET) != -1));
+    success = (success && (::write(eepromFd, buffer, length) == length));
+    success = (success && (fsync(eepromFd) == 0));
+
+    if (!success)
+    {
+        printf("Failed to write to EEPROM file\r\n");
+        return ::bsp::BSP_ERROR;
+    }
+    return ::bsp::BSP_OK;
+}
+
+bsp::BspReturnCode
+EepromDriver::read(uint32_t const address, uint8_t* const buffer, uint32_t const length)
+{
+    bool success
+        = ((-1 != eepromFd) && (address < EEPROM_SIZE) && ((address + length) < EEPROM_SIZE));
+
+    success = (success && (lseek(eepromFd, address, SEEK_SET) != -1));
+    success = (success && (::read(eepromFd, buffer, length) == length));
+
+    if (!success)
+    {
+        printf("Failed to read from EEPROM file\r\n");
+        return ::bsp::BSP_ERROR;
+    }
+    return ::bsp::BSP_OK;
+}
+
+} // namespace eeprom
diff --git a/platforms/posix/bsp/bspEepromDriver/test/gtest/CMakeLists.txt b/platforms/posix/bsp/bspEepromDriver/test/gtest/CMakeLists.txt
@@ -0,0 +1,8 @@
+add_executable(bspEepromDriverTest src/eeprom/EepromDriverTest.cpp
+                ../../src/eeprom/EepromDriver.cpp)
+
+target_include_directories(bspEepromDriverTest PRIVATE ../../include)
+
+target_link_libraries(bspEepromDriverTest PRIVATE bsp utbspConfiguration gtest_main)
+
+gtest_discover_tests(bspEepromDriverTest PROPERTIES LABELS "bspEepromDriverTest")
diff --git a/platforms/posix/bsp/bspEepromDriver/test/gtest/src/eeprom/EepromDriverTest.cpp b/platforms/posix/bsp/bspEepromDriver/test/gtest/src/eeprom/EepromDriverTest.cpp
@@ -0,0 +1,102 @@
+// Copyright 2024 Accenture.
+
+#include "eeprom/EepromDriver.h"
+
+#include <gtest/gtest.h>
+
+namespace
+{
+
+using namespace ::testing;
+
+class EepromDriverTest : public ::testing::Test
+{
+protected:
+    ::eeprom::EepromDriver _cut;
+
+public:
+    static constexpr size_t EEPROM_SIZE = 4096; // 4KB
+};
+
+TEST_F(EepromDriverTest, testEepromWriteBeyondSizeError)
+{
+    EXPECT_EQ(::bsp::BSP_OK, _cut.init());
+
+    uint8_t dataToWrite[] = {0x01, 0x02, 0x03, 0x04, 0x05};
+    uint32_t address      = EepromDriverTest::EEPROM_SIZE + 1; // Start address beyond size
+
+    bool result = _cut.write(address, dataToWrite, sizeof(dataToWrite));
+    EXPECT_EQ(::bsp::BSP_ERROR, result);
+}
+
+TEST_F(EepromDriverTest, testEepromWriteRead)
+{
+    EXPECT_EQ(::bsp::BSP_OK, _cut.init());
+
+    uint8_t dataToWrite[] = {0x01, 0x02, 0x03, 0x04, 0x05};
+    uint32_t address      = 0x00;
+
+    bool result = _cut.write(address, dataToWrite, sizeof(dataToWrite));
+    EXPECT_EQ(::bsp::BSP_OK, result);
+
+    uint8_t readData[sizeof(dataToWrite)] = {0};
+    result                                = _cut.read(address, readData, sizeof(readData));
+    EXPECT_EQ(::bsp::BSP_OK, result);
+
+    // Verify data
+    for (size_t i = 0; i < sizeof(dataToWrite); i++)
+    {
+        EXPECT_EQ(dataToWrite[i], readData[i]);
+    }
+}
+
+TEST_F(EepromDriverTest, testEepromReadBeyondSizeError)
+{
+    EXPECT_EQ(::bsp::BSP_OK, _cut.init());
+
+    uint8_t readData[10] = {0};
+    uint32_t address     = EepromDriverTest::EEPROM_SIZE + 1;
+
+    bool result = _cut.read(address, readData, sizeof(readData));
+    EXPECT_EQ(::bsp::BSP_ERROR, result);
+}
+
+TEST_F(EepromDriverTest, testNullpointerBufferRead)
+{
+    EXPECT_EQ(::bsp::BSP_OK, _cut.init());
+
+    uint32_t address = 0x00;
+    bool result      = _cut.read(address, nullptr, 10);
+
+    EXPECT_EQ(::bsp::BSP_ERROR, result);
+}
+
+TEST_F(EepromDriverTest, testNullpointerBufferWrite)
+{
+    EXPECT_EQ(::bsp::BSP_OK, _cut.init());
+
+    uint32_t address = 0x00;
+    bool result      = _cut.write(address, nullptr, 10);
+
+    EXPECT_EQ(::bsp::BSP_ERROR, result);
+}
+
+TEST_F(EepromDriverTest, testWriteWithoutInit)
+{
+    uint8_t dataToWrite[] = {0x01, 0x02, 0x03, 0x04, 0x05};
+    uint32_t address      = 0x00;
+
+    bool result = _cut.write(address, dataToWrite, sizeof(dataToWrite));
+    EXPECT_EQ(::bsp::BSP_ERROR, result);
+}
+
+TEST_F(EepromDriverTest, testReadWithoutInit)
+{
+    uint8_t readData[10] = {0};
+    uint32_t address     = 0x00;
+
+    bool result = _cut.read(address, readData, sizeof(readData));
+    EXPECT_EQ(::bsp::BSP_ERROR, result);
+}
+
+} // namespace
