Replace ESP8266SdFat w/SdFat 2.3.0, SDIO, ExFAT (earlephilhower#2764)

* Replace ESP8266SdFat w/SdFat 2.3.0, add SDIO and ExFAT support

Remove ESP8266SdFat fork and replaces with upstream SdFat to simplify
maintenance.

This 2.3.0 version adds SDIO support and enables exFAT support.
Also upgraded FAT filename support to 256 chars, identical to  LittleFS.

* Add SDIO support to SD and SDFS, documentation, and examples

* Update SD examples to all support SPI0, SPI1, or SDIO

Author: earlephilhower

.gitmodules

@@ -10,9 +10,6 @@
 [submodule "libraries/LittleFS/lib/littlefs"]
 	path = libraries/LittleFS/lib/littlefs
 	url = https://github.com/littlefs-project/littlefs.git
-[submodule "libraries/SdFat"]
-	path = libraries/ESP8266SdFat
-	url = https://github.com/earlephilhower/ESP8266SdFat.git
 [submodule "libraries/Keyboard"]
 	path = libraries/HID_Keyboard
 	url = https://github.com/earlephilhower/Keyboard.git
@@ -49,3 +46,6 @@
 [submodule "libraries/ESPHost"]
 	path = libraries/ESPHost
 	url = https://github.com/Networking-for-Arduino/ESPHost.git
+[submodule "libraries/SdFat"]
+	path = libraries/SdFat
+	url = https://github.com/greiman/SdFat.git

docs/fs.rst

@@ -174,6 +174,23 @@ second SPI port, ``SPI1``.  Just use the following call in place of
 
     SD.begin(cspin, SPI1);
 
+Enabling SDIO operation for SD
+------------------------------
+SDIO support is available thanks to SdFat implementing a PIO-based SDIO controller.
+This mode can significantly increase IO performance to SD cards but it requires that
+all 4 DAT0..DAT3 lines to be wired to the Pico (most SD breakout boards only provide
+1-but SPI mode of operation).
+
+To enable SDIO mode, simply specify the SD_CLK, SD_CMD, and SD_DAT0 GPIO pins.  The clock
+and command pins can be any GPIO (not limited to legal SPI pins).  The DAT0 pin can be any
+GPIO with remaining DAT1...3 pins consecutively connected.
+
+..code:: cpp
+
+    SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
+
+No other changes are required in the application to take advantage of this high
+performance mode.
 
 Using VFS (Virtual File System) for POSIX support
 -------------------------------------------------

libraries/ESP8266SdFat

@@ -37,6 +37,11 @@ const int _MOSI = 7;  // AKA SPI TX
 const int _CS = 5;
 const int _SCK = 6;
 
+// If you have all 4 DAT pins wired up to the Pico you can use SDIO mode
+const int RP_CLK_GPIO = -1; // Set to CLK GPIO
+const int RP_CMD_GPIO = -1; // Set to CMD GPIO
+const int RP_DAT0_GPIO = -1; // Set to DAT0 GPIO. DAT1..3 must be consecutively connected.
+
 // include the SD library:
 #include <SPI.h>
 #include <SD.h>
@@ -54,21 +59,26 @@ void setup() {
   Serial.println("\nInitializing SD card...");
 
   bool sdInitialized = false;
-  // Ensure the SPI pinout the SD card is connected to is configured properly
-  // Select the correct SPI based on _MISO pin for the RP2040
-  if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
-    SPI.setRX(_MISO);
-    SPI.setTX(_MOSI);
-    SPI.setSCK(_SCK);
-    sdInitialized = SD.begin(_CS);
-  } else if (_MISO == 8 || _MISO == 12) {
-    SPI1.setRX(_MISO);
-    SPI1.setTX(_MOSI);
-    SPI1.setSCK(_SCK);
-    sdInitialized = SD.begin(_CS, SPI1);
+  if (RP_CLK_GPIO >= 0) {
+    // No special requirements on pin locations, this is PIO programmed
+    sdInitialized = SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
   } else {
-    Serial.println(F("ERROR: Unknown SPI Configuration"));
-    return;
+    // Ensure the SPI pinout the SD card is connected to is configured properly
+    // Select the correct SPI based on _MISO pin for the RP2040
+    if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
+      SPI.setRX(_MISO);
+      SPI.setTX(_MOSI);
+      SPI.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS);
+    } else if (_MISO == 8 || _MISO == 12) {
+      SPI1.setRX(_MISO);
+      SPI1.setTX(_MOSI);
+      SPI1.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS, SPI1);
+    } else {
+      Serial.println(F("ERROR: Unknown SPI Configuration"));
+      return;
+    }
   }
 
   if (!sdInitialized) {
@@ -114,7 +124,7 @@ void setup() {
   Serial.println();
 
   // print the type and size of the first FAT-type volume
-  uint32_t volumesize;
+  uint64_t volumesize;
   Serial.print("Volume type is:    FAT");
   Serial.println(SD.fatType(), DEC);
 
@@ -130,7 +140,7 @@ void setup() {
   Serial.println((float)volumesize / 1024.0);
 
   Serial.print("Card size:  ");
-  Serial.println((float)SD.size() / 1000);
+  Serial.println((float)SD.size64() / 1000);
 
   FSInfo fs_info;
   SDFS.info(fs_info);

libraries/SD/examples/CardInfo/CardInfo.ino

@@ -30,6 +30,11 @@ const int _MOSI = 7;
 const int _CS = 5;
 const int _SCK = 6;
 
+// If you have all 4 DAT pins wired up to the Pico you can use SDIO mode
+const int RP_CLK_GPIO = -1; // Set to CLK GPIO
+const int RP_CMD_GPIO = -1; // Set to CMD GPIO
+const int RP_DAT0_GPIO = -1; // Set to DAT0 GPIO. DAT1..3 must be consecutively connected.
+
 #include <SPI.h>
 #include <SD.h>
 
@@ -39,13 +44,31 @@ void setup() {
 
   Serial.print("Initializing SD card...");
 
-  // Ensure the SPI pinout the SD card is connected to is configured properly
-  SPI.setRX(_MISO);
-  SPI.setTX(_MOSI);
-  SPI.setSCK(_SCK);
+  bool sdInitialized = false;
+  if (RP_CLK_GPIO >= 0) {
+    // No special requirements on pin locations, this is PIO programmed
+    sdInitialized = SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
+  } else {
+    // Ensure the SPI pinout the SD card is connected to is configured properly
+    // Select the correct SPI based on _MISO pin for the RP2040
+    if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
+      SPI.setRX(_MISO);
+      SPI.setTX(_MOSI);
+      SPI.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS);
+    } else if (_MISO == 8 || _MISO == 12) {
+      SPI1.setRX(_MISO);
+      SPI1.setTX(_MOSI);
+      SPI1.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS, SPI1);
+    } else {
+      Serial.println(F("ERROR: Unknown SPI Configuration"));
+      return;
+    }
+  }
 
   // see if the card is present and can be initialized:
-  if (!SD.begin(_CS)) {
+  if (!sdInitialized) {
     Serial.println("Card failed, or not present");
     // don't do anything more:
     return;

libraries/SD/examples/Datalogger/Datalogger.ino

@@ -30,6 +30,11 @@ const int _MOSI = 7;
 const int _CS = 5;
 const int _SCK = 6;
 
+// If you have all 4 DAT pins wired up to the Pico you can use SDIO mode
+const int RP_CLK_GPIO = -1; // Set to CLK GPIO
+const int RP_CMD_GPIO = -1; // Set to CMD GPIO
+const int RP_DAT0_GPIO = -1; // Set to DAT0 GPIO. DAT1..3 must be consecutively connected.
+
 #include <SPI.h>
 #include <SD.h>
 
@@ -39,13 +44,31 @@ void setup() {
 
   Serial.print("Initializing SD card...");
 
-  // Ensure the SPI pinout the SD card is connected to is configured properly
-  SPI.setRX(_MISO);
-  SPI.setTX(_MOSI);
-  SPI.setSCK(_SCK);
+  bool sdInitialized = false;
+  if (RP_CLK_GPIO >= 0) {
+    // No special requirements on pin locations, this is PIO programmed
+    sdInitialized = SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
+  } else {
+    // Ensure the SPI pinout the SD card is connected to is configured properly
+    // Select the correct SPI based on _MISO pin for the RP2040
+    if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
+      SPI.setRX(_MISO);
+      SPI.setTX(_MOSI);
+      SPI.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS);
+    } else if (_MISO == 8 || _MISO == 12) {
+      SPI1.setRX(_MISO);
+      SPI1.setTX(_MOSI);
+      SPI1.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS, SPI1);
+    } else {
+      Serial.println(F("ERROR: Unknown SPI Configuration"));
+      return;
+    }
+  }
 
   // see if the card is present and can be initialized:
-  if (!SD.begin(_CS)) {
+  if (!sdInitialized) {
     Serial.println("Card failed, or not present");
     // don't do anything more:
     return;

libraries/SD/examples/DumpFile/DumpFile.ino

@@ -28,6 +28,11 @@ const int _MOSI = 7;
 const int _CS = 5;
 const int _SCK = 6;
 
+// If you have all 4 DAT pins wired up to the Pico you can use SDIO mode
+const int RP_CLK_GPIO = -1; // Set to CLK GPIO
+const int RP_CMD_GPIO = -1; // Set to CMD GPIO
+const int RP_DAT0_GPIO = -1; // Set to DAT0 GPIO. DAT1..3 must be consecutively connected.
+
 #include <SPI.h>
 #include <SD.h>
 
@@ -39,12 +44,30 @@ void setup() {
 
   Serial.print("Initializing SD card...");
 
-  // Ensure the SPI pinout the SD card is connected to is configured properly
-  SPI.setRX(_MISO);
-  SPI.setTX(_MOSI);
-  SPI.setSCK(_SCK);
+  bool sdInitialized = false;
+  if (RP_CLK_GPIO >= 0) {
+    // No special requirements on pin locations, this is PIO programmed
+    sdInitialized = SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
+  } else {
+    // Ensure the SPI pinout the SD card is connected to is configured properly
+    // Select the correct SPI based on _MISO pin for the RP2040
+    if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
+      SPI.setRX(_MISO);
+      SPI.setTX(_MOSI);
+      SPI.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS);
+    } else if (_MISO == 8 || _MISO == 12) {
+      SPI1.setRX(_MISO);
+      SPI1.setTX(_MOSI);
+      SPI1.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS, SPI1);
+    } else {
+      Serial.println(F("ERROR: Unknown SPI Configuration"));
+      return;
+    }
+  }
 
-  if (!SD.begin(_CS)) {
+  if (!sdInitialized) {
     Serial.println("initialization failed!");
     return;
   }

libraries/SD/examples/Files/Files.ino

@@ -28,6 +28,11 @@ const int _MOSI = 7;
 const int _CS = 5;
 const int _SCK = 6;
 
+// If you have all 4 DAT pins wired up to the Pico you can use SDIO mode
+const int RP_CLK_GPIO = -1; // Set to CLK GPIO
+const int RP_CMD_GPIO = -1; // Set to CMD GPIO
+const int RP_DAT0_GPIO = -1; // Set to DAT0 GPIO. DAT1..3 must be consecutively connected.
+
 #include <SPI.h>
 #include <SD.h>
 
@@ -39,12 +44,30 @@ void setup() {
 
   Serial.print("Initializing SD card...");
 
-  // Ensure the SPI pinout the SD card is connected to is configured properly
-  SPI.setRX(_MISO);
-  SPI.setTX(_MOSI);
-  SPI.setSCK(_SCK);
+  bool sdInitialized = false;
+  if (RP_CLK_GPIO >= 0) {
+    // No special requirements on pin locations, this is PIO programmed
+    sdInitialized = SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
+  } else {
+    // Ensure the SPI pinout the SD card is connected to is configured properly
+    // Select the correct SPI based on _MISO pin for the RP2040
+    if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
+      SPI.setRX(_MISO);
+      SPI.setTX(_MOSI);
+      SPI.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS);
+    } else if (_MISO == 8 || _MISO == 12) {
+      SPI1.setRX(_MISO);
+      SPI1.setTX(_MOSI);
+      SPI1.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS, SPI1);
+    } else {
+      Serial.println(F("ERROR: Unknown SPI Configuration"));
+      return;
+    }
+  }
 
-  if (!SD.begin(_CS)) {
+  if (!sdInitialized) {
     Serial.println("initialization failed!");
     return;
   }

libraries/SD/examples/ReadWrite/ReadWrite.ino

@@ -42,6 +42,11 @@ const int _MOSI = 7;  // AKA SPI TX
 const int _CS = 5;
 const int _SCK = 6;
 
+// If you have all 4 DAT pins wired up to the Pico you can use SDIO mode
+const int RP_CLK_GPIO = -1; // Set to CLK GPIO
+const int RP_CMD_GPIO = -1; // Set to CMD GPIO
+const int RP_DAT0_GPIO = -1; // Set to DAT0 GPIO. DAT1..3 must be consecutively connected.
+
 #include <SPI.h>
 #include <SD.h>
 
@@ -58,21 +63,26 @@ void setup() {
   Serial.println("\nInitializing SD card...");
 
   bool sdInitialized = false;
-  // Ensure the SPI pinout the SD card is connected to is configured properly
-  // Select the correct SPI based on _MISO pin for the RP2040
-  if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
-    SPI.setRX(_MISO);
-    SPI.setTX(_MOSI);
-    SPI.setSCK(_SCK);
-    sdInitialized = SD.begin(_CS);
-  } else if (_MISO == 8 || _MISO == 12) {
-    SPI1.setRX(_MISO);
-    SPI1.setTX(_MOSI);
-    SPI1.setSCK(_SCK);
-    sdInitialized = SD.begin(_CS, SPI1);
+  if (RP_CLK_GPIO >= 0) {
+    // No special requirements on pin locations, this is PIO programmed
+    sdInitialized = SD.begin(RP_CLK_GPIO, RP_CMD_GPIO, RP_DAT0_GPIO);
   } else {
-    Serial.println(F("ERROR: Unknown SPI Configuration"));
-    return;
+    // Ensure the SPI pinout the SD card is connected to is configured properly
+    // Select the correct SPI based on _MISO pin for the RP2040
+    if (_MISO == 0 || _MISO == 4 || _MISO == 16) {
+      SPI.setRX(_MISO);
+      SPI.setTX(_MOSI);
+      SPI.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS);
+    } else if (_MISO == 8 || _MISO == 12) {
+      SPI1.setRX(_MISO);
+      SPI1.setTX(_MOSI);
+      SPI1.setSCK(_SCK);
+      sdInitialized = SD.begin(_CS, SPI1);
+    } else {
+      Serial.println(F("ERROR: Unknown SPI Configuration"));
+      return;
+    }
   }
 
   if (!sdInitialized) {

libraries/SD/examples/listfiles/listfiles.ino

@@ -36,11 +36,17 @@ class SDClass {
         SDFS.setConfig(SDFSConfig(csPin, SPI_HALF_SPEED, spi));
         return SDFS.begin();
     }
+
     bool begin(uint8_t csPin, uint32_t cfg = SPI_HALF_SPEED, HardwareSPI &spi = SPI) {
         SDFS.setConfig(SDFSConfig(csPin, cfg, spi));
         return SDFS.begin();
     }
 
+    bool begin(uint8_t clkPin, uint8_t cmdPin, uint8_t dat0Pin, uint32_t cfg = SD_SCK_MHZ(50)) {
+        SDFS.setConfig(SDFSConfig(clkPin, cmdPin, dat0Pin, cfg));
+        return SDFS.begin();
+    }
+
     void end(bool endSPI = true) {
         SDFS.end();
         if (endSPI && _spi) {