feat(sdmmc): Add RAW disk functions (espressif#9796)

* feat(sdmmc): Add RAW disk functions

feat(sdmmc): fixed printf mismatches and missing callback

feat(sdmmc): added ci.json

Removed excess log_i

* ci(pre-commit): Apply automatic fixes

* Fixed sdmmc host check to pass CI

* feat(sdmmc): fixed example USB check

---------

Co-Authored-By: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-Authored-By: Lucas Saavedra Vaz <[email protected]>

libraries/SD_MMC/examples/SD2USBMSC/SD2USBMSC.ino

@@ -0,0 +1,102 @@
+#if !SOC_USB_OTG_SUPPORTED || ARDUINO_USB_MODE
+#error Device does not support USB_OTG or native USB CDC/JTAG is selected
+#endif
+
+#include <USB.h>
+#include <USBMSC.h>
+#include <SD_MMC.h>
+
+// USB Mass Storage Class (MSC) object
+USBMSC msc;
+
+int clk = 36;
+int cmd = 35;
+int d0 = 37;
+int d1 = 38;
+int d2 = 33;
+int d3 = 34;
+bool onebit = true;  // set to false for 4-bit. 1-bit will ignore the d1-d3 pins (but d3 must be pulled high)
+
+static int32_t onWrite(uint32_t lba, uint32_t offset, uint8_t *buffer, uint32_t bufsize) {
+  uint32_t secSize = SD_MMC.sectorSize();
+  if (!secSize) {
+    return false;  // disk error
+  }
+  log_v("Write lba: %ld\toffset: %ld\tbufsize: %ld", lba, offset, bufsize);
+  for (int x = 0; x < bufsize / secSize; x++) {
+    uint8_t blkbuffer[secSize];
+    memcpy(blkbuffer, (uint8_t *)buffer + secSize * x, secSize);
+    if (!SD_MMC.writeRAW(blkbuffer, lba + x)) {
+      return false;
+    }
+  }
+  return bufsize;
+}
+
+static int32_t onRead(uint32_t lba, uint32_t offset, void *buffer, uint32_t bufsize) {
+  uint32_t secSize = SD_MMC.sectorSize();
+  if (!secSize) {
+    return false;  // disk error
+  }
+  log_v("Read lba: %ld\toffset: %ld\tbufsize: %ld\tsector: %lu", lba, offset, bufsize, secSize);
+  for (int x = 0; x < bufsize / secSize; x++) {
+    if (!SD_MMC.readRAW((uint8_t *)buffer + (x * secSize), lba + x)) {
+      return false;  // outside of volume boundary
+    }
+  }
+  return bufsize;
+}
+
+static bool onStartStop(uint8_t power_condition, bool start, bool load_eject) {
+  log_i("Start/Stop power: %u\tstart: %d\teject: %d", power_condition, start, load_eject);
+  return true;
+}
+
+static void usbEventCallback(void *arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
+  if (event_base == ARDUINO_USB_EVENTS) {
+    arduino_usb_event_data_t *data = (arduino_usb_event_data_t *)event_data;
+    switch (event_id) {
+      case ARDUINO_USB_STARTED_EVENT: Serial.println("USB PLUGGED"); break;
+      case ARDUINO_USB_STOPPED_EVENT: Serial.println("USB UNPLUGGED"); break;
+      case ARDUINO_USB_SUSPEND_EVENT: Serial.printf("USB SUSPENDED: remote_wakeup_en: %u\n", data->suspend.remote_wakeup_en); break;
+      case ARDUINO_USB_RESUME_EVENT:  Serial.println("USB RESUMED"); break;
+
+      default: break;
+    }
+  }
+}
+
+void setup() {
+  Serial.begin(115200);
+  Serial.println("Starting Serial");
+
+  Serial.println("Mounting SDcard");
+  SD_MMC.setPins(clk, cmd, d0, d1, d2, d3);
+  if (!SD_MMC.begin("/sdcard", onebit)) {
+    Serial.println("Mount Failed");
+    return;
+  }
+
+  Serial.println("Initializing MSC");
+  // Initialize USB metadata and callbacks for MSC (Mass Storage Class)
+  msc.vendorID("ESP32");
+  msc.productID("USB_MSC");
+  msc.productRevision("1.0");
+  msc.onRead(onRead);
+  msc.onWrite(onWrite);
+  msc.onStartStop(onStartStop);
+  msc.mediaPresent(true);
+  msc.begin(SD_MMC.numSectors(), SD_MMC.sectorSize());
+
+  Serial.println("Initializing USB");
+
+  USB.begin();
+  USB.onEvent(usbEventCallback);
+
+  Serial.printf("Card Size: %lluMB\n", SD_MMC.totalBytes() / 1024 / 1024);
+  Serial.printf("Sector: %d\tCount: %d\n", SD_MMC.sectorSize(), SD_MMC.numSectors());
+}
+
+void loop() {
+  delay(-1);
+}

libraries/SD_MMC/examples/SD2USBMSC/ci.json

@@ -0,0 +1,9 @@
+{
+  "targets": {
+    "esp32": false,
+    "esp32s2": false,
+    "esp32c3": false,
+    "esp32c6": false,
+    "esp32h2": false
+  }
+}

libraries/SD_MMC/src/SD_MMC.cpp

@@ -207,5 +207,19 @@ uint64_t SDMMCFS::usedBytes()
 	return size;
 }
 
+int SDMMCFS::sectorSize() {
+  if (!_card) {
+    return 0;
+  }
+  return _card->csd.sector_size;
+}
+
+int SDMMCFS::numSectors() {
+  if (!_card) {
+    return 0;
+  }
+  return (totalBytes() / _card->csd.sector_size);
+}
+
 SDMMCFS SD_MMC = SDMMCFS(FSImplPtr(new VFSImpl()));
 #endif /* SOC_SDMMC_HOST_SUPPORTED */

libraries/SD_MMC/src/SD_MMC.h

@@ -16,7 +16,11 @@
 
 #include "sdkconfig.h"
 #include "soc/soc_caps.h"
-#ifdef SOC_SDMMC_HOST_SUPPORTED
+#ifndef SOC_SDMMC_HOST_SUPPORTED
+#ifdef ARDUINO
+#warning The SDMMC library requires a device with an SDIO Host
+#endif
+#else
 
 #include "FS.h"
 #include "driver/sdmmc_types.h"
@@ -56,6 +60,10 @@ class SDMMCFS : public FS
     uint64_t cardSize();
     uint64_t totalBytes();
     uint64_t usedBytes();
+    int sectorSize();
+    int numSectors();
+    bool readRAW(uint8_t *buffer, uint32_t sector);
+    bool writeRAW(uint8_t *buffer, uint32_t sector);
 };
 
 }