added flash device source code

Author: itzandroidtab

flash/flash_device.cpp

@@ -0,0 +1,206 @@
+#include <cstdint>
+#include "flash_os.hpp"
+
+/**
+ * @brief Smallest amount of data that can be programmed
+ * 
+ * <PageSize> = 2 ^ Shift. Shift = 3 => <PageSize> = 2^3 = 8 bytes
+ * 
+ */
+#define PAGE_SIZE_SHIFT (2)
+
+/**
+ * @brief If value is false the device does not support native read. This 
+ * makes the loader use the read function instead of using memory mapped 
+ * io.
+ * 
+ */
+#define NATIVE_READ (false)
+
+/**
+ * @brief Marks if the device supports a chip erase. This can speed up erasing
+ * a chip.
+ * 
+ */
+#define CHIP_ERASE (false)
+
+/**
+ * @brief If value is true only uniform sectors are allowed on the device. 
+ * Speeds up erasing as it can erase multiple sectors at once.
+ * 
+ */
+#define UNIFORM_SECTORS (true)
+
+/**
+ * @brief Sector size shift for when using uniform sector erase
+ * 
+ * <SectorSize> = 2 ^ Shift. Shift = 12 => <SectorSize> = 2 ^ 12 = 4096 bytes
+ * 
+ */
+#define SECTOR_SIZE_SHIFT (2)
+
+/**
+ * @brief Device specific infomation
+ * 
+ */
+extern "C" {
+    const __attribute__ ((section("DevDscr"), __used__)) flash_device FlashDevice = {
+        flash_drv_version, // driver version
+        "test device", // device name
+        device_type::on_chip, // device type
+        0xA0000000, // base address
+        0x00000400, // flash size
+        4, // page size
+        0, // reserved
+        0xff, // blank value
+        100, // page program timeout
+        3000, // sector erase timeout
+
+        // flash sectors
+        {
+            {0x00000400, 0x00000000},
+            end_of_sectors
+        }
+    };
+}
+
+// function overrides when parts are not in use
+#if NATIVE_READ
+    #define VERIFY_FUNC nullptr
+    #define BLANK_CHECK_FUNC nullptr
+    #define OPEN_READ_FUNC nullptr
+#else
+    #define VERIFY_FUNC Verify
+    #define BLANK_CHECK_FUNC BlankCheck
+    #define OPEN_READ_FUNC SEGGER_OPEN_Read
+#endif
+
+#if CHIP_ERASE
+    #define CHIP_ERASE_FUNC EraseChip
+#else
+    #define CHIP_ERASE_FUNC nullptr
+#endif
+
+#if UNIFORM_SECTORS
+    #define UNIFORM_ERASE_FUNC SEGGER_OPEN_Erase
+#else
+    #define UNIFORM_ERASE_FUNC nullptr
+#endif
+
+/**
+ * @brief array with all the functions for the segger software
+ * 
+ */
+extern "C" {
+    const uint32_t SEGGER_OFL_Api[13] __attribute__ ((section ("PrgCode"), __used__)) = {
+        reinterpret_cast<uint32_t>(FeedWatchdog),
+        reinterpret_cast<uint32_t>(Init),
+        reinterpret_cast<uint32_t>(UnInit),
+        reinterpret_cast<uint32_t>(EraseSector),
+        reinterpret_cast<uint32_t>(ProgramPage),
+        reinterpret_cast<uint32_t>(BLANK_CHECK_FUNC),
+        reinterpret_cast<uint32_t>(CHIP_ERASE_FUNC),
+        reinterpret_cast<uint32_t>(VERIFY_FUNC),
+        reinterpret_cast<uint32_t>(nullptr), // SEGGER_OPEN_CalcCRC
+        reinterpret_cast<uint32_t>(OPEN_READ_FUNC),
+        reinterpret_cast<uint32_t>(SEGGER_OPEN_Program),
+        reinterpret_cast<uint32_t>(UNIFORM_ERASE_FUNC),
+        reinterpret_cast<uint32_t>(nullptr), // SEGGER_OPEN_Start for turbo mode
+    };
+}
+
+void __attribute__ ((noinline)) FeedWatchdog(void) {
+    // TODO: implement something to keep the watchdog happy
+    return;
+}
+
+int __attribute__ ((noinline)) Init(const uint32_t address, const uint32_t frequency, const uint32_t function) {
+    // TODO: implement init
+
+    return 0;
+}
+
+int UnInit(const uint32_t function) {
+    // TODO: implement uninit
+
+    return 0;
+}
+
+int __attribute__ ((noinline)) EraseSector(const uint32_t sector_address) {
+    // TODO: implement sector erase
+
+    return 0;
+}
+
+int __attribute__ ((noinline)) ProgramPage(const uint32_t address, const uint32_t size, const uint8_t *const data) {
+    // TODO: implement program page
+
+    return 0;
+}
+
+int __attribute__ ((noinline)) SEGGER_OPEN_Program(uint32_t address, uint32_t size, uint8_t *data) {
+    // get the amount of pages to write
+    const uint32_t pages = size >> PAGE_SIZE_SHIFT;
+
+    for (uint32_t i = 0; i < pages; i++) {
+        // program a page
+        int r = ProgramPage(address + (i * PAGE_SIZE_SHIFT), (0x1 << PAGE_SIZE_SHIFT), &data[i * PAGE_SIZE_SHIFT]);
+
+        // check if something went wrong
+        if (r) {
+            // return a error
+            return 1;
+        }
+    }
+
+    // return everything went oke
+    return 0;
+}
+
+#if CHIP_ERASE == true
+    int EraseChip(void) {
+        // TODO: implement chip erase
+        return 0;
+    }
+#endif
+
+#if UNIFORM_SECTORS
+    int SEGGER_OPEN_Erase(uint32_t SectorAddr, uint32_t SectorIndex, uint32_t NumSectors) {
+        // feed the watchdog
+        FeedWatchdog();
+
+        for (uint32_t i = 0; i < NumSectors; i++) {
+            // erase a sector
+            int r = EraseSector(SectorAddr);
+
+            // check for errors
+            if (r) {
+                // return we have a error
+                return 1;
+            }
+        }
+
+        // return everything went oke
+        return 0;
+    }
+#endif
+
+#if !NATIVE_READ
+    uint32_t Verify(uint32_t Addr, uint32_t NumBytes, uint8_t *pBuff) {
+        // TODO: implement verify
+
+        return 0;
+    }
+
+    int __attribute__ ((noinline)) BlankCheck(const uint32_t address, const uint32_t size, const uint8_t blank_value) {
+        // TODO: implement blankcheck
+
+        return 0;
+    }
+
+    int SEGGER_OPEN_Read(const uint32_t address, const uint32_t size, uint8_t *const data) {
+        // TODO: add read implementation
+
+        return size;
+    }
+#endif