Add FS::format (esp8266#702)

Author: igrr

cores/esp8266/FS.cpp

@@ -167,6 +167,13 @@ bool FS::begin() {
     return _impl->begin();
 }
 
+bool FS::format() {
+    if (!_impl) {
+        return false;
+    }
+    return _impl->format();
+}
+
 File FS::open(const String& path, const char* mode) {
     return open(path.c_str(), mode);
 }

cores/esp8266/FS.h

@@ -92,6 +92,8 @@ class FS
 
     bool begin();
 
+    bool format();
+
     File open(const char* path, const char* mode);
     File open(const String& path, const char* mode);
 

cores/esp8266/FSImpl.h

@@ -63,6 +63,7 @@ class DirImpl {
 class FSImpl {
 public:
     virtual bool begin() = 0;
+    virtual bool format() = 0;
     virtual FileImplPtr open(const char* path, OpenMode openMode, AccessMode accessMode) = 0;
     virtual DirImplPtr openDir(const char* path) = 0;
     virtual bool rename(const char* pathFrom, const char* pathTo) = 0;

cores/esp8266/spiffs_api.cpp

@@ -102,6 +102,25 @@ class SPIFFSImpl : public FSImpl {
         return _tryMount();
     }
 
+    bool format() override {
+        bool wasMounted = (SPIFFS_mounted(&_fs) != 0);
+
+        if (_tryMount()) {
+            SPIFFS_unmount(&_fs);
+        }
+        auto rc = SPIFFS_format(&_fs);
+        if (rc != SPIFFS_OK) {
+            DEBUGV("SPIFFS_format: rc=%d, err=%d\r\n", rc, _fs.err_code);
+            return false;
+        }
+
+        if (wasMounted) {
+            return _tryMount();
+        }
+
+        return true;
+    }
+
 protected:
     friend class SPIFFSFileImpl;
     friend class SPIFFSDirImpl;

tests/FSWrapper/FSWrapper.ino

@@ -4,7 +4,7 @@
 
 void fail(const char* msg) {
   Serial.println(msg);
-  while(true) {
+  while (true) {
     yield();
   }
 }
@@ -15,6 +15,21 @@ void setup() {
   WiFi.mode(WIFI_OFF);
   Serial.println("\n\nFS test\n");
 
+  {
+    if (!SPIFFS.format()) {
+      fail("format failed");
+    }
+    Dir root = SPIFFS.openDir("/");
+    int count = 0;
+    while (root.next()) {
+      ++count;
+    }
+    if (count > 0) {
+      fail("some files left after format");
+    }
+  }
+
+
   if (!SPIFFS.begin()) {
     fail("SPIFFS init failed");
   }
@@ -63,15 +78,15 @@ void setup() {
   {
     Dir root = SPIFFS.openDir("/");
     while (root.next()) {
-        String fileName = root.fileName();
-        File f = root.openFile("r");
-        Serial.printf("%s: %d\r\n", fileName.c_str(), f.size());
+      String fileName = root.fileName();
+      File f = root.openFile("r");
+      Serial.printf("%s: %d\r\n", fileName.c_str(), f.size());
     }
   }
 
   {
     Dir root = SPIFFS.openDir("/");
-    while(root.next()) {
+    while (root.next()) {
       String fileName = root.fileName();
       Serial.print("deleting ");
       Serial.println(fileName);
@@ -96,6 +111,20 @@ void setup() {
     }
   }
 
+  {
+    if (!SPIFFS.format()) {
+      fail("format failed");
+    }
+    Dir root = SPIFFS.openDir("/");
+    int count = 0;
+    while (root.next()) {
+      ++count;
+    }
+    if (count > 0) {
+      fail("some files left after format");
+    }
+  }
+
   Serial.println("success");
 }