Deprecate SPIFFS, move examples to LittleFS (esp8266#7263)

* Deprecate SPIFFS, move examples to LittleFS

SPIFFS has been a great filesystem, but it has significant problems in
many cases (and it's also pretty slow).  Development seems to have
slowed/stopped on the upstream version, and we're not able to provide
support or fix the known issues with it as-is.

Deprecate SPIFFS variable.

Update all examples to use LittleFS instead of SPIFFS.

Also, minor cleanup on very old examples which has obsolete delays
waiting for the Serial port to come up, or which were stuck at 9600 baud
because of their ancient AVR heritage.

Fixes esp8266#7095

* Remove leftover debug code

* Clean up comments in some examples

* Update documentation on SPIFFS deprecation

* Fix host tests to avoid deprecation warnings

* Fix cut-n-paste error

* Restore SpeedTest.ino, adjust to allow custom FSes

Co-authored-by: Develo <[email protected]>

Author: earlephilhower

boards.txt

@@ -4960,15 +4960,15 @@ espinotee.menu.baud.3000000.upload.speed=3000000
 wifinfo.name=WifInfo
 wifinfo.build.board=WIFINFO
 wifinfo.build.variant=wifinfo
-wifinfo.menu.ESPModule.ESP07192=ESP07 (1M/192K SPIFFS)
+wifinfo.menu.ESPModule.ESP07192=ESP07 (1M/192K FS)
 wifinfo.menu.ESPModule.ESP07192.build.board=ESP8266_ESP07
 wifinfo.menu.ESPModule.ESP07192.build.flash_ld=eagle.flash.1m192.ld
 wifinfo.menu.ESPModule.ESP07192.build.flash_size=1M
 wifinfo.menu.ESPModule.ESP07192.build.spiffs_blocksize=4096
 wifinfo.menu.ESPModule.ESP07192.build.spiffs_end=0xFB000
 wifinfo.menu.ESPModule.ESP07192.build.spiffs_start=0xCB000
 wifinfo.menu.ESPModule.ESP07192.upload.maximum_size=827376
-wifinfo.menu.ESPModule.ESP12=ESP12 (4M/1M SPIFFS)
+wifinfo.menu.ESPModule.ESP12=ESP12 (4M/1M FS)
 wifinfo.menu.ESPModule.ESP12.build.board=ESP8266_ESP12
 wifinfo.menu.ESPModule.ESP12.build.flash_ld=eagle.flash.4m1m.ld
 wifinfo.menu.ESPModule.ESP12.build.flash_size=4M

cores/esp8266/FS.h

@@ -266,7 +266,7 @@ using fs::SPIFFSConfig;
 #endif //FS_NO_GLOBALS
 
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SPIFFS)
-extern fs::FS SPIFFS;
+extern fs::FS SPIFFS __attribute__((deprecated("SPIFFS has been deprecated. Please consider moving to LittleFS or other filesystems.")));
 #endif
 
 #endif //FS_H

cores/esp8266/spiffs_api.cpp

@@ -37,8 +37,8 @@ int32_t spiffs_hal_read(uint32_t addr, uint32_t size, uint8_t *dst) {
     return flash_hal_read(addr, size, dst);
 }
 
-
-
+#pragma GCC diagnostic push
+#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 
 namespace spiffs_impl {
 
@@ -149,6 +149,8 @@ extern "C" void spiffs_request_end(void)
     SPIFFS.end();
 }
 
+#pragma GCC diagnostic pop
+
 #endif // ARDUINO
 #endif // !CORE_MOCK
 

cores/esp8266/spiffs_api.h

@@ -171,7 +171,7 @@ class SPIFFSImpl : public FSImpl
             return false;
         }
         _cfg = *static_cast<const SPIFFSConfig *>(&cfg);
-	return true;
+        return true;
     }
 
     bool begin() override

doc/boards.rst

@@ -344,7 +344,7 @@ Parameters in Arduino IDE:
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - Card: "WEMOS D1 Mini Lite"
-- Flash Size: "1M (512K SPIFFS)"
+- Flash Size: "1M (512K FS)"
 - CPU Frequency: "80 Mhz"
 
 Power:

doc/esp8266wifi/bearssl-client-secure-class.rst

@@ -102,9 +102,9 @@ The web browser you're using to read this document keeps a list of 100s of certi
 
 In many cases your application will know the specific CA it needs to validate web or MQTT servers against (often just a single, self-signing CA private to your institution).  Simply load your private CA in a `BearSSL::X509List` and use that as your trust anchor.
 
-However, there are cases where you will not know beforehand which CA you will need (i.e. a user enters a website through a keypad), and you need to keep the list of CAs just like your web browser.  In those cases, you need to generate a certificate bundle on the PC while compiling your application, upload the `certs.ar` bundle to SPIFFS or SD when uploading your application binary, and pass it to a `BearSSL::CertStore()` in order to validate TLS peers.
+However, there are cases where you will not know beforehand which CA you will need (i.e. a user enters a website through a keypad), and you need to keep the list of CAs just like your web browser.  In those cases, you need to generate a certificate bundle on the PC while compiling your application, upload the `certs.ar` bundle to LittleFS or SD when uploading your application binary, and pass it to a `BearSSL::CertStore()` in order to validate TLS peers.
 
-See the `BearSSL_CertStore` example for full details as the `BearSSL::CertStore` requires the creation of a cookie-cutter object for filesystem access (because the SD and SPIFFS filesystems are presently incompatible with each other).  At a high level in your `setup()` you will call `BearSSL::initCertStore()` on a global object, and then pass this global certificate store to `client.setCertStore(&gCA)` before every connection attempt to enable it as a validation option.
+See the `BearSSL_CertStore` example for full details.
 
 Supported Crypto
 ~~~~~~~~~~~~~~~~

doc/esp8266wifi/client-secure-class.rst

@@ -42,31 +42,32 @@ Load client certificate from file system.
 .. code:: cpp
 
     #include <FS.h>
+    #include <LittleFS.h>
     #include <ESP8266WiFi.h>
     #include <WiFiClientSecure.h>
 
-    const char* certyficateFile = "/client.cer";
+    const char* certificateFile = "/client.cer";
 
 *setup() or loop()*
 
 .. code:: cpp
 
-    if (!SPIFFS.begin()) 
+    if (!LittleFS.begin())
     {
       Serial.println("Failed to mount the file system");
       return;
     }
 
-    Serial.printf("Opening %s", certyficateFile);
-    File crtFile = SPIFFS.open(certyficateFile, "r");
+    Serial.printf("Opening %s", certificateFile);
+    File crtFile = LittleFS.open(certificateFile, "r");
     if (!crtFile)
     {
       Serial.println(" Failed!");
     }
 
     WiFiClientSecure client;
 
-    Serial.print("Loading %s", certyficateFile);
+    Serial.print("Loading %s", certificateFile);
     if (!client.loadCertificate(crtFile))
     {
       Serial.println(" Failed!");

doc/faq/readme.rst

@@ -79,7 +79,7 @@ perform. It is not listed among libraries verified to work with ESP8266.
 
 `Read more <a03-library-does-not-work.rst>`__.
 
-In the IDE, for ESP-12E that has 4M flash, I can choose 4M (1M SPIFFS) or 4M (3M SPIFFS). No matter what I select, the IDE tells me the maximum code space is about 1M. Where does my flash go?
+In the IDE, for ESP-12E that has 4M flash, I can choose 4M (1M FS) or 4M (3M FS). No matter what I select, the IDE tells me the maximum code space is about 1M. Where does my flash go?
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The reason we cannot have more than 1MB of code in flash has to do with
@@ -90,7 +90,7 @@ total, but switching such "banks" on the fly is not easy and efficient,
 so we don't bother doing that. Besides, no one has so far complained
 about 1MB of code space being insufficient for practical purposes.
 
-The option to choose 3M or 1M SPIFFS is to optimize the upload time.
+The option to choose 3M or 1M filesystem is to optimize the upload time.
 Uploading 3MB takes a long time so sometimes you can just use 1MB. Other
 2MB of flash can still be used with ``ESP.flashRead`` and
 ``ESP.flashWrite`` APIs if necessary.

doc/filesystem.rst

@@ -63,6 +63,16 @@ following include to the sketch:
 
     #include "FS.h"
 
+SPIFFS Deprecation Warning
+--------------------------
+
+SPIFFS is currently deprecated and may be removed in future releases of
+the core.  Please consider moving your code to LittleFS.  SPIFFS is not
+actively supported anymore by the upstream developer, while LittleFS is
+under active development, supports real directories, and is many times
+faster for most operations.
+
+
 SPIFFS and LittleFS
 -------------------
 

doc/installing.rst

@@ -244,6 +244,6 @@ BeagleBone, CubieBoard).
 - `What is PlatformIO? <https://docs.platformio.org/en/latest/what-is-platformio.html?utm_source=arduino-esp8266>`__
 - `PlatformIO IDE <https://platformio.org/platformio-ide?utm_source=arduino-esp8266>`__
 - `PlatformIO Core <https://docs.platformio.org/en/latest/core.html?utm_source=arduino-esp8266>`__ (command line tool)
-- `Advanced usage <https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=arduino-esp8266>`__ - custom settings, uploading to SPIFFS, Over-the-Air (OTA), staging version
+- `Advanced usage <https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=arduino-esp8266>`__ - custom settings, uploading to LittleFS, Over-the-Air (OTA), staging version
 - `Integration with Cloud and Standalone IDEs <https://docs.platformio.org/en/latest/ide.html?utm_source=arduino-esp8266>`__ - Cloud9, Codeanywhere, Eclipse Che (Codenvy), Atom, CLion, Eclipse, Emacs, NetBeans, Qt Creator, Sublime Text, VIM, Visual Studio, and VSCode
 - `Project Examples <https://docs.platformio.org/en/latest/platforms/espressif8266.html?utm_source=arduino-esp8266#examples>`__

doc/libraries.rst

@@ -25,7 +25,7 @@ This is a bit different from standard EEPROM class. You need to call ``EEPROM.be
 
 ``EEPROM.write`` does not write to flash immediately, instead you must call ``EEPROM.commit()`` whenever you wish to save changes to flash. ``EEPROM.end()`` will also commit, and will release the RAM copy of EEPROM contents.
 
-EEPROM library uses one sector of flash located just after the SPIFFS.
+EEPROM library uses one sector of flash located just after the embedded filesystem.
 
 `Three examples <https://github.com/esp8266/Arduino/tree/master/libraries/EEPROM>`__  included.
 

doc/ota_updates/readme.rst

@@ -360,7 +360,7 @@ If this is the case, then most likely ESP module has not been reset after initia
 The most common causes of OTA failure are as follows:
 
 - not enough physical memory on the chip (e.g. ESP01 with 512K flash memory is not enough for OTA).
-- too much memory declared for SPIFFS so new sketch will not fit between existing sketch and SPIFFS – see `Update process - memory view <#update-process-memory-view>`__.
+- too much memory declared for the filesystem so new sketch will not fit between existing sketch and the filesystem – see `Update process - memory view <#update-process-memory-view>`__.
 - too little memory declared in Arduino IDE for your selected board (i.e. less than physical size).
 - not resetting the ESP module after initial upload using serial port.
 

libraries/DNSServer/examples/CaptivePortalAdvanced/CaptivePortalAdvanced.ino

@@ -56,7 +56,7 @@ unsigned int status = WL_IDLE_STATUS;
 
 void setup() {
   delay(1000);
-  Serial.begin(9600);
+  Serial.begin(115200);
   Serial.println();
   Serial.println("Configuring access point...");
   /* You can remove the password parameter if you want the AP to be open. */

libraries/EEPROM/examples/eeprom_read/eeprom_read.ino

@@ -15,9 +15,6 @@ byte value;
 void setup() {
   // initialize serial and wait for port to open:
   Serial.begin(115200);
-  while (!Serial) {
-    ; // wait for serial port to connect. Needed for Leonardo only
-  }
   EEPROM.begin(512);
 }
 

libraries/ESP8266HTTPClient/examples/PostHttpClient/PostHttpClient.ino

@@ -8,8 +8,6 @@
 #include <ESP8266WiFi.h>
 #include <ESP8266HTTPClient.h>
 
-#define USE_SERIAL Serial
-
 /* this can be run with an emulated server on host:
         cd esp8266-core-root-dir
         cd tests/host
@@ -27,21 +25,21 @@
 
 void setup() {
 
-  USE_SERIAL.begin(115200);
+  Serial.begin(115200);
 
-  USE_SERIAL.println();
-  USE_SERIAL.println();
-  USE_SERIAL.println();
+  Serial.println();
+  Serial.println();
+  Serial.println();
 
   WiFi.begin(STASSID, STAPSK);
 
   while (WiFi.status() != WL_CONNECTED) {
     delay(500);
-    USE_SERIAL.print(".");
+    Serial.print(".");
   }
-  USE_SERIAL.println("");
-  USE_SERIAL.print("Connected! IP address: ");
-  USE_SERIAL.println(WiFi.localIP());
+  Serial.println("");
+  Serial.print("Connected! IP address: ");
+  Serial.println(WiFi.localIP());
 
 }
 
@@ -52,29 +50,29 @@ void loop() {
     WiFiClient client;
     HTTPClient http;
 
-    USE_SERIAL.print("[HTTP] begin...\n");
+    Serial.print("[HTTP] begin...\n");
     // configure traged server and url
     http.begin(client, "http://" SERVER_IP "/postplain/"); //HTTP
     http.addHeader("Content-Type", "application/json");
 
-    USE_SERIAL.print("[HTTP] POST...\n");
+    Serial.print("[HTTP] POST...\n");
     // start connection and send HTTP header and body
     int httpCode = http.POST("{\"hello\":\"world\"}");
 
     // httpCode will be negative on error
     if (httpCode > 0) {
       // HTTP header has been send and Server response header has been handled
-      USE_SERIAL.printf("[HTTP] POST... code: %d\n", httpCode);
+      Serial.printf("[HTTP] POST... code: %d\n", httpCode);
 
       // file found at server
       if (httpCode == HTTP_CODE_OK) {
         const String& payload = http.getString();
-        USE_SERIAL.println("received payload:\n<<");
-        USE_SERIAL.println(payload);
-        USE_SERIAL.println(">>");
+        Serial.println("received payload:\n<<");
+        Serial.println(payload);
+        Serial.println(">>");
       }
     } else {
-      USE_SERIAL.printf("[HTTP] POST... failed, error: %s\n", http.errorToString(httpCode).c_str());
+      Serial.printf("[HTTP] POST... failed, error: %s\n", http.errorToString(httpCode).c_str());
     }
 
     http.end();

libraries/ESP8266WebServer/examples/FSBrowser/FSBrowser.ino

@@ -25,8 +25,8 @@
 
 // Select the FileSystem by uncommenting one of the lines below
 
-#define USE_SPIFFS
-//#define USE_LITTLEFS
+//#define USE_SPIFFS
+#define USE_LITTLEFS
 //#define USE_SDFS
 
 // Uncomment the following line to embed a version of the web page in the code

libraries/ESP8266WebServer/examples/HttpHashCredAuth/HttpHashCredAuth.ino

@@ -7,10 +7,11 @@
   1. Creating a secure web server using ESP8266ESP8266WebServerSecure
   2. Use of HTTP authentication on this secure server
   3. A simple web interface to allow an authenticated user to change Credentials
-  4. Persisting those credentials through a reboot of the ESP by saving them to SPIFFS without storing them as plain text
+  4. Persisting those credentials through a reboot of the ESP by saving them to LittleFS without storing them as plain text
 */
 
 #include <FS.h>
+#include <LittleFS.h>
 #include <ESP8266WiFi.h>
 #include <ESP8266WebServerSecure.h>
 
@@ -23,8 +24,8 @@
 const char* ssid = STASSID;
 const char* wifi_pw = STAPSK;
 
-const String file_credentials = R"(/credentials.txt)"; //SPIFFS file name for the saved credentials
-const String change_creds =  "changecreds"; //address for a credential change
+const String file_credentials = R"(/credentials.txt)"; // LittleFS file name for the saved credentials
+const String change_creds =  "changecreds";            // Address for a credential change
 
 //The ESP8266WebServerSecure requires an encryption certificate and matching key.
 //These can generated with the bash script available in the ESP8266 Arduino repository.
@@ -83,7 +84,7 @@ gz5JWYhbD6c38khSzJb0pNXCo3EuYAVa36kDM96k1BtWuhRS10Q1VXk=
 
 ESP8266WebServerSecure server(443);
 
-//These are temporary credentials that will only be used if none are found saved in SPIFFS.
+//These are temporary credentials that will only be used if none are found saved in LittleFS.
 String login = "admin";
 const String realm = "global";
 String H1 = "";
@@ -92,9 +93,9 @@ String authentication_failed = "User authentication has failed.";
 void setup() {
   Serial.begin(115200);
 
-  //Initialize SPIFFS to save credentials
-  if(!SPIFFS.begin()){
-		Serial.println("SPIFFS initialization error, programmer flash configured?");
+  //Initialize LittleFS to save credentials
+  if(!LittleFS.begin()){
+		Serial.println("LittleFS initialization error, programmer flash configured?");
     ESP.restart();
 	}
 
@@ -187,16 +188,16 @@ void showcredentialpage(){
   server.send(200, "text/html", page);
 }
 
-//Saves credentials to SPIFFS
+//Saves credentials to LittleFS
 void savecredentials(String new_login, String new_password)
 {
   //Set global variables to new values
   login=new_login;
   H1=ESP8266WebServer::credentialHash(new_login,realm,new_password);
 
-  //Save new values to SPIFFS for loading on next reboot
+  //Save new values to LittleFS for loading on next reboot
   Serial.println("Saving credentials.");
-  File f=SPIFFS.open(file_credentials,"w"); //open as a brand new file, discard old contents
+  File f=LittleFS.open(file_credentials,"w"); //open as a brand new file, discard old contents
   if(f){
     Serial.println("Modifying credentials in file system.");
     f.println(login);
@@ -208,12 +209,12 @@ void savecredentials(String new_login, String new_password)
   Serial.println("Credentials saved.");
 }
 
-//loads credentials from SPIFFS
+//loads credentials from LittleFS
 void loadcredentials()
 {
   Serial.println("Searching for credentials.");
   File f;
-  f=SPIFFS.open(file_credentials,"r");
+  f=LittleFS.open(file_credentials,"r");
   if(f){
     Serial.println("Loading credentials from file system.");
     String mod=f.readString(); //read the file to a String