refactoring partitioning

Author: cristidragomir97

examples/AdvancedUSBInternalOperations/AdvancedUSBInternalOperations.ino

@@ -23,6 +23,7 @@
 
 */
 
+#define UNIFIED_STORAGE_DEBUG
 #include "Arduino_UnifiedStorage.h"
 
 // Two instances are made for the USB and internal storage respectively

examples/InternalStoragePartitioning/InternalStoragePartitioning.ino

@@ -21,7 +21,7 @@
     3. `listPartitions`: This function reads the MBR sector on the QSPI drive and retrieves the partitioning scheme, if this sketch is succesful it should return exactly the partitioning scheme you created
 
 
-    Instructions:
+    INSTRUCTIONS:
     1. Check compatibility with your board and make sure you have "POSIXStorage" and "Arduino_UnifiedStorage" installed
     2. Connect your board to the serial monitor
     3. Wait for the sketch to run 

examples/Logger/Logger.h

@@ -0,0 +1,31 @@
+#ifndef Logger_H
+#define Logger_H
+
+#if defined(ARDUINO_OPTA)
+#include <ArduinoRS485.h>
+
+static void beginRS485(const int baudrate)
+{
+    const auto bitduration { 1.f / baudrate };
+    const auto wordlen { 9.6f }; // OR 10.0f depending on the channel configuration
+    const auto preDelayBR { bitduration * wordlen * 3.5f * 1e6 };
+    const auto postDelayBR { bitduration * wordlen * 3.5f * 1e6 };
+
+    RS485.begin(baudrate);
+    RS485.setDelays(preDelayBR, postDelayBR);
+    RS485.noReceive();
+}
+#endif
+
+static void printlnToSerialOrRS485(String s){
+    #if !defined(ARDUINO_OPTA)
+        Serial.println(s);
+    #else
+        RS485.beginTransmission();
+        RS485.write(s.c_str(), strlen(s.c_str()));
+        RS485.write('\n');
+        RS485.endTransmission();
+  #endif
+}
+
+#endif

examples/Logger/Logger.ino

@@ -23,6 +23,7 @@
 */
 
 #include "Arduino_UnifiedStorage.h"
+#include "Logger.h"
 #include <vector>
 
 
@@ -46,18 +47,15 @@ unsigned long lastLog = 0;
 unsigned long lastMove = 0;
 unsigned long lastBackup = 0;
 
-
 volatile bool usbAvailable = false;
 bool backingUP = false;
 
 void connectionCallback(){
-    printToSerialOrRS485("CONNECTION CALLBACK RAISED !!!");
     usbAvailable = true;
     usbStorage.removeOnConnectCallback();
 }
 
 void disconnectionCallback(){
-    printToSerialOrRS485("DISCONNECTION CALLBACK RAISED !!!");
     usbAvailable = false;
     usbStorage.onConnect(connectionCallback);
 
@@ -76,7 +74,7 @@ void runPeriodically(void (*method)(), unsigned long interval, unsigned long* va
 void logDataToRAM() {
   int timeStamp = millis();
   int sensorReading = analogRead(A0);
-  String line = String(timeStamp) + "," + String(random(9999)) + "\n";
+  String line = String(timeStamp) + "," + String(random(9999));
   sensorDataBuffer.push_back(line);
 }
 
@@ -100,10 +98,10 @@ void performUpdate() {
   backingUP = true;
   unsigned lastUpdateBytes = lastUpdateFile.readAsString().toInt();  // Read the last update size from the file
 
-  printToSerialOrRS485("Last update bytes: " + String(lastUpdateBytes) + "\n");
+  printlnToSerialOrRS485("Last update bytes: " + String(lastUpdateBytes));
 
   if (lastUpdateBytes >= bytesWritten) {
-    printToSerialOrRS485("No new data to copy. \n");
+    printlnToSerialOrRS485("No new data to copy. ");
     backupFile.close();
     lastUpdateFile.close();
     backingUP = false;
@@ -112,14 +110,14 @@ void performUpdate() {
 
   logFile.seek(lastUpdateBytes);  // Move the file pointer to the last update position
   unsigned long totalBytesToMove = bytesWritten - lastUpdateBytes;
-  printToSerialOrRS485("New update bytes: " + String(totalBytesToMove) + "\n");
+  printlnToSerialOrRS485("New update bytes: " + String(totalBytesToMove));
 
   uint8_t* buffer = new uint8_t[totalBytesToMove];
 
   size_t bytesRead = logFile.read(buffer, totalBytesToMove);
   size_t bytesMoved = backupFile.write(buffer, bytesRead);  // Only write the bytes that haven't been backed up yet
 
-  printToSerialOrRS485("Successfully copied " + String(bytesMoved) + " new bytes. \n");
+  printlnToSerialOrRS485("Successfully copied " + String(bytesMoved) + " new bytes. ");
 
   lastUpdateFile.changeMode(FileMode::WRITE);  // Open the last update file in write mode
   lastUpdateFile.write(String(lastUpdateBytes + bytesMoved));  // Update the last update size
@@ -141,32 +139,32 @@ void performUpdate() {
 void backupToUSB() {
   if(usbAvailable && !usbIntialized){
       usbStorage.begin();
-      printToSerialOrRS485("First drive insertion, creating folders... \n");
+      printlnToSerialOrRS485("First drive insertion, creating folders... ");
       Folder usbRoot = usbStorage.getRootFolder();
       String folderName = "LoggerBackup" + String(random(9999));
       backupFolder = usbRoot.createSubfolder(folderName);
-      printToSerialOrRS485("Succesfully created backup folder: " + backupFolder.getPathAsString() + "\n");
+      printlnToSerialOrRS485("Succesfully created backup folder: " + backupFolder.getPathAsString());
       usbStorage.unmount();
       usbIntialized = true;
   }
   else if(usbAvailable && usbIntialized) {
-    printToSerialOrRS485("USB Mass storage is available \n");
+    printlnToSerialOrRS485("USB Mass storage is available ");
     delay(100);
     if (!usbStorage.isMounted()) {
 
-      printToSerialOrRS485("Mounting USB Mass Storage \n");
+      printlnToSerialOrRS485("Mounting USB Mass Storage ");
       digitalWrite(USB_MOUNTED_LED, LOW);
       if(usbStorage.begin()){
         performUpdate();
       } 
 
     } else if (usbStorage.isMounted()) {
-      printToSerialOrRS485("USB Mass storage is connected, performing update \n");
+      printlnToSerialOrRS485("USB Mass storage is connected, performing update ");
       performUpdate();
 
     }
   } else {
-    printToSerialOrRS485("USB Mass storage is not available \n");
+    printlnToSerialOrRS485("USB Mass storage is not available ");
   }
 
 
@@ -188,17 +186,17 @@ void setup() {
   usbStorage.onDisconnect(disconnectionCallback);
 
   pinMode(USB_MOUNTED_LED, OUTPUT);
-  printToSerialOrRS485("Formatting internal storage... \n");
+  printlnToSerialOrRS485("Formatting internal storage... ");
   int formatted = internalStorage.format(FS_LITTLEFS);
-  printToSerialOrRS485("QSPI Format status: " + String(formatted) + "\n");
+  printlnToSerialOrRS485("QSPI Format status: " + String(formatted));
 
 
 
   if (!internalStorage.begin()) {
-    printToSerialOrRS485("Failed to initialize internal storage \n");
+    printlnToSerialOrRS485("Failed to initialize internal storage ");
     return;
   } else {
-    printToSerialOrRS485("Initialized storage \n");
+    printlnToSerialOrRS485("Initialized storage ");
   }
 
 }

src/Boards.h

@@ -4,6 +4,7 @@
     #define HAS_QSPI
     #define USES_RENESAS_CORE
     #define QSPI_STORAGE_SIZE 16384
+    #define HAS_SERIAL
 #endif 
 
 #if defined(ARDUINO_PORTENTA_H7_M7)
@@ -12,19 +13,22 @@
     #define HAS_QSPI
     #define USES_MBED_CORE
     #define QSPI_STORAGE_SIZE 16384
+    #define HAS_SERIAL
 #endif 
 
 #if defined(ARDUINO_OPTA)
     #define HAS_USB
     #define HAS_QSPI
     #define USES_MBED_CORE
     #define QSPI_STORAGE_SIZE 16384
+    #define HAS_RS485
 #endif 
 
 #if defined(ARDUINO_NICLA_VISION)
     #define HAS_QSPI
     #define USES_MBED_CORE
     #define QSPI_STORAGE_SIZE 16384
+    #define HAS_SERIAL
 #endif 
 
 

src/InternalStorage.h

@@ -10,8 +10,13 @@
  */
 class InternalStorage : public Arduino_UnifiedStorage {
 public:
+    
+
     /**
-     * Default constructor for the InternalStorage class.
+     * Constructs an InternalStorage object with default settings.
+     * If no partitions are available, it restores the default partitioning scheme (See restoreDefaultPartitions() for more info).
+     * If partitions are available, it sets the partition number, file system type, and partition name based on the last partition available.
+     * When using the default partitioning scheme the last partition would be the user partition. 
      */
     InternalStorage();
 

src/Partitioning.cpp

@@ -3,11 +3,11 @@
 
  bool Partitioning::eraseMBRSector(BlockDeviceType * blockDevice)
 {
-    unsigned char buffer[MBRBlockSize];
+    unsigned char buffer[mbrBlockSize];
     memset(buffer, 0xFF, sizeof(buffer));
 
     if(blockDevice-> program(buffer, 0, sizeof(buffer)) == 0){
-        if(blockDevice -> erase(0, MBRBlockSize) == 0){
+        if(blockDevice -> erase(0, mbrBlockSize) == 0){
             return true;
         } else {
             return false;
@@ -26,7 +26,7 @@
         totalSize += thisPartition.size;
     }
 
-    if(totalSize <= driveSize && partitions.size() <= 4){
+    if(totalSize <= driveSize && partitions.size() <= maximumMBRPartitions){
         return true;
     } else {
         return false;
@@ -66,7 +66,7 @@
     for (size_t i = 1; i < partitions.size() + 1; ++i) {
         int thisPartitionEnd = (partitions[i - 1].size * 1024) + lastPartitionEnd;
 
-        if(MBRBlockDeviceType::partition(blockDevice, i, MBRPartitionType, lastPartitionEnd, thisPartitionEnd) == 0){
+        if(MBRBlockDeviceType::partition(blockDevice, i, mbrPartitionType, lastPartitionEnd, thisPartitionEnd) == 0){
             success = formatPartition(blockDevice, i, partitions[i - 1].fileSystemType);
         } else {
             success = false;
@@ -101,7 +101,7 @@ std::vector<Partition> Partitioning::readPartitions(BlockDeviceType * blockDevic
 
     auto ret = blockDevice->init();
     if (ret) {
-        Serial.println("ERROR! Unable to read the Block Device.");
+        debugPrint("ERROR! Unable to read the Block Device.");
         return partitions;
     }
 
@@ -115,18 +115,20 @@ std::vector<Partition> Partitioning::readPartitions(BlockDeviceType * blockDevic
 
     ret = blockDevice->read(buffer, 512 - buffer_size, buffer_size);
     if (ret) {
-        Serial.println("ERROR! Unable to read the Master Boot Record");
+        debugPrint("ERROR! Unable to read the Master Boot Record");
 
         delete[] buffer;
         return partitions;
     }
 
+
     auto table_start_offset = buffer_size - sizeof(mbrTable);
     auto table = reinterpret_cast<mbrTable*>(&buffer[table_start_offset]);
-
-    if (table->signature[0] != 0x55 || table->signature[1] != 0xAA) {
-        Serial.println("MBR Not Found");
-        Serial.println("Flash Memory doesn't have partitions.");
+    
+    if (table->signature[0] != mbrMagicNumbers[0] || table->signature[1] != mbrMagicNumbers[1]) {
+ 
+        debugPrint("MBR Not Found");
+        debugPrint("Flash Memory doesn't have partitions.");
         delete[] buffer;
         return partitions;
     }
@@ -136,9 +138,15 @@ std::vector<Partition> Partitioning::readPartitions(BlockDeviceType * blockDevic
     for (auto const& entry : table->entries) {
         partitionIndex ++;
         Partition partition;
-        partition.size = (entry.lbaSize * 4096) >> 10;
 
-        if (entry.type == 0x00) {
+        /*This code calculates the size of a partition in kilobytes.
+        It takes the Logical Block Address (LBA) size of the partition, 
+        multiplies it by 4096 (the size of a block in bytes),
+        and then shifts the result 10 bits to the right to convert it to kilobytes. 
+        */
+       partition.size = (entry.lbaSize * 4096) >> 10;
+
+        if (entry.type == emptyPartitionType) {
             // Skip empty partitions
             continue;
         }

src/Partitioning.h

@@ -4,9 +4,12 @@
 #include "Arduino_POSIXStorage.h"
 #include <vector>
 
-constexpr int MBRBlockSize = 4096;
-constexpr int MBRPartitionType = 0x0B;
+constexpr int mbrBlockSize = 4096;
+constexpr int mbrPartitionType = 0x0B;
 constexpr char * mountPointName = "mountPoint";
+constexpr int maximumMBRPartitions = 4;
+constexpr int emptyPartitionType = 0x00;
+constexpr uint8_t mbrMagicNumbers[] = {0x55, 0xAA};
 
 
 struct Partition {

src/Utils.h

@@ -25,31 +25,6 @@
     return dynamicName;
 }
 
-#if defined(ARDUINO_OPTA)
-#include <ArduinoRS485.h>
-
-static void beginRS485(const int baudrate)
-{
-    const auto bitduration { 1.f / baudrate };
-    const auto wordlen { 9.6f }; // OR 10.0f depending on the channel configuration
-    const auto preDelayBR { bitduration * wordlen * 3.5f * 1e6 };
-    const auto postDelayBR { bitduration * wordlen * 3.5f * 1e6 };
-
-    RS485.begin(baudrate);
-    RS485.setDelays(preDelayBR, postDelayBR);
-    RS485.noReceive();
-}
-#endif
-
-[[gnu::unused]] static int printToSerialOrRS485(String s){
-    #if defined(ARDUINO_PORTENTA_C33) || defined(ARDUINO_PORTENTA_H7_M7)
-        Serial.print(s);
-    #elif defined(ARDUINO_OPTA)
-        RS485.beginTransmission();
-        RS485.write(s.c_str(), strlen(s.c_str()));
-        RS485.endTransmission();
-    #endif 
-}
 
 [[gnu::unused]] static bool copyFolder(const char* source, const char* destination) {
     DIR* dir = opendir(source);