Add a FSConfig and SDFSConfig param to FS.begin()

Allows for configuration values to be passed into a filesystem via the
begin method.  By default, a FS will receive a nullptr and should so
whatever is appropriate.

The base FSConfig class has one parameter, _autoFormat, set by the
default constructor to true.

For SPIFFS, you can now disable auto formatting on mount failure by
passing in a FSConfig(false) object.

For SDFS a SDFSConfig parameter can be passed into config specifying the
chip select and SPI configuration.  If nothing is passed in, the begin
will fail since there are no safe default values here.

Author: Earle F. Philhower, III

cores/esp8266/FS.cpp

@@ -220,11 +220,11 @@ bool Dir::rewind() {
     return _impl->rewind();
 }
 
-bool FS::begin() {
+bool FS::begin(const FSConfig *cfg) {
     if (!_impl) {
         return false;
     }
-    return _impl->begin();
+    return _impl->begin(cfg);
 }
 
 void FS::end() {

cores/esp8266/FS.h

@@ -119,12 +119,22 @@ struct FSInfo {
     size_t maxPathLength;
 };
 
+class FSConfig
+{
+public:
+    FSConfig(bool autoFormat = true) {
+        _autoFormat = autoFormat;
+    }
+
+    bool _autoFormat;
+};
+
 class FS
 {
 public:
     FS(FSImplPtr impl) : _impl(impl) { }
 
-    bool begin();
+    bool begin(const FSConfig *cfg = nullptr);
     void end();
 
     bool format();
@@ -166,6 +176,7 @@ using fs::SeekSet;
 using fs::SeekCur;
 using fs::SeekEnd;
 using fs::FSInfo;
+using fs::FSConfig;
 #endif //FS_NO_GLOBALS
 
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SPIFFS)

cores/esp8266/FSImpl.h

@@ -69,7 +69,7 @@ class DirImpl {
 class FSImpl {
 public:
     virtual ~FSImpl () { }
-    virtual bool begin() = 0;
+    virtual bool begin(const FSConfig *cfg) = 0;
     virtual void end() = 0;
     virtual bool format() = 0;
     virtual bool info(FSInfo& info) = 0;

cores/esp8266/spiffs_api.h

@@ -136,7 +136,7 @@ class SPIFFSImpl : public FSImpl
         return false;
     }
 
-    bool begin() override
+    bool begin(const FSConfig *cfg) override
     {
 #if defined(ARDUINO) && !defined(CORE_MOCK)
         if (&_SPIFFS_end <= &_SPIFFS_start)
@@ -152,12 +152,16 @@ class SPIFFSImpl : public FSImpl
         if (_tryMount()) {
             return true;
         }
-        auto rc = SPIFFS_format(&_fs);
-        if (rc != SPIFFS_OK) {
-            DEBUGV("SPIFFS_format: rc=%d, err=%d\r\n", rc, _fs.err_code);
+	if (!cfg || cfg->_autoFormat) {
+            auto rc = SPIFFS_format(&_fs);
+            if (rc != SPIFFS_OK) {
+                DEBUGV("SPIFFS_format: rc=%d, err=%d\r\n", rc, _fs.err_code);
+                return false;
+            }
+            return _tryMount();
+        } else {
             return false;
         }
-        return _tryMount();
     }
 
     void end() override

doc/filesystem.rst

@@ -134,7 +134,17 @@ begin
 
 This method mounts SPIFFS file system. It must be called before any
 other FS APIs are used. Returns *true* if file system was mounted
-successfully, false otherwise.
+successfully, false otherwise.  With no options it will format SPIFFS
+if it is unable to mount it on the first try.
+
+.. code:: cpp
+
+    auto cfg = FSConfig(false);
+    SPIFFS.begin(&cfg);
+
+If a ``FSConfig`` object is passed in, with the autoFormat parameter
+set to ``false``, then if the filesystem is unable to be mounted it
+will return an error code instead of trying to format it.
 
 end
 ~~~

libraries/SD/src/SD.h

@@ -32,8 +32,8 @@
 class SDClass {
 public:
     boolean begin(uint8_t csPin, SPISettings cfg = SPI_HALF_SPEED) {
-        setSDFSConfig(csPin, cfg);
-        return (boolean)SDFS.begin();
+        auto fsCfg = SDFSConfig(csPin, cfg);
+        return (boolean)SDFS.begin(&fsCfg);
     }
 
     void end(bool endSPI = true) {
@@ -44,8 +44,7 @@ class SDClass {
     }
 
     File open(const char *filename, uint8_t mode = FILE_READ) {
-        File f = SDFS.open(filename, getMode(mode));
-        return f;
+        return SDFS.open(filename, getMode(mode));
     }
 
     File open(const String &filename, uint8_t mode = FILE_READ) {

libraries/SDFS/src/SDFS.cpp

@@ -34,11 +34,6 @@ using namespace fs;
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SDFS)
 static sdfs::SDFSImpl *_SDFSImpl = new sdfs::SDFSImpl();
 FS SDFS = FS(FSImplPtr(_SDFSImpl));
-
-// Global configuration functions
-void setSDFSConfig(int8_t csPin, SPISettings spiConfig) {
-    _SDFSImpl->setSDFSIOConfig(csPin, spiConfig);
-}
 #endif
 
 namespace sdfs {

libraries/SDFS/src/SDFS.h

@@ -41,6 +41,18 @@ namespace sdfs {
 
 class SDFSFileImpl;
 class SDFSDirImpl;
+class SDFSConfig : public FSConfig
+{
+public:
+    SDFSConfig(uint8_t cs, SPISettings spi) {
+        _autoFormat = false;
+        _cs = cs;
+        _spi = spi;
+    }
+
+    uint8_t _cs;
+    SPISettings _spi;
+};
 
 class SDFSImpl : public FSImpl
 {
@@ -86,14 +98,20 @@ class SDFSImpl : public FSImpl
         return _mounted ?_fs.rmdir(path) : false;
     }
 
-    bool begin() override {
+    bool begin(const FSConfig *cfg) override {
         if (_mounted) {
             end();
         }
-        if (_csPin >= 0) {
+        if (!cfg) {
+            return false; // You need to tell me the CS and SPI setup or I can't do anything!
+        }
+        const SDFSConfig *myCfg = static_cast<const SDFSConfig *>(cfg);
+        _csPin = myCfg->_cs;
+        _spiSettings = myCfg->_spi;
+        _mounted = _fs.begin(_csPin, _spiSettings);
+        if (!_mounted && myCfg->_autoFormat) {
+            format();
             _mounted = _fs.begin(_csPin, _spiSettings);
-        } else {
-            _mounted = _fs.begin();
         }
         return _mounted;
     }
@@ -347,7 +365,7 @@ class SDFSDirImpl : public DirImpl
 
 #if !defined(NO_GLOBAL_INSTANCES) && !defined(NO_GLOBAL_SDFS)
 extern FS SDFS;
-extern void setSDFSConfig(int8_t csPin, SPISettings spiConfig = SD_SCK_MHZ(10));
+using sdfs::SDFSConfig;
 #endif
 
 #endif // SDFS.h

libraries/esp8266/keywords.txt

@@ -93,6 +93,7 @@ SPIFFS	KEYWORD1
 SDFS	KEYWORD1
 File	KEYWORD1
 Dir	KEYWORD1
+FSConfig	KEYWORD1
 
 # Seek enums
 SeekSet	LITERAL1

tests/host/fs/test_fs.cpp

@@ -191,10 +191,11 @@ TEST_CASE("#1819 Can list all files with openDir(\"\")", "[fs][bugreport]")
 TEST_CASE("SDFS", "[sdfs]")
 {
     SDFS_MOCK_DECLARE();
-    setSDFSConfig(0);
     SDFS.end();
+    auto cfg = SDFSConfig(0, SD_SCK_MHZ(1));
+    SDFS.begin(&cfg);
     REQUIRE(SDFS.format());
-    REQUIRE(SDFS.begin());
+    REQUIRE(SDFS.begin(&cfg));
     REQUIRE(SDFS.mkdir("/happy/face"));
     REQUIRE(SDFS.mkdir("/happy/nose"));
     REQUIRE(SDFS.rmdir("/happy/face"));
@@ -207,7 +208,9 @@ TEST_CASE("SDFS", "[sdfs]")
 TEST_CASE("Files.ino example", "[sd]")
 {
     SDFS_MOCK_DECLARE();
-    setSDFSConfig(0);
+    SDFS.end();
+    auto cfg = SDFSConfig(0, SD_SCK_MHZ(1));
+    SDFS.begin(&cfg);
     SDFS.end();
     REQUIRE(SDFS.format());
     REQUIRE(SD.begin(4));
@@ -243,7 +246,9 @@ static String readFileSD(const char* name)
 TEST_CASE("Listfiles.ino example", "[sd]")
 {
     SDFS_MOCK_DECLARE();
-    setSDFSConfig(0);
+    SDFS.end();
+    auto cfg = SDFSConfig(0, SD_SCK_MHZ(1));
+    SDFS.begin(&cfg);
     SDFS.end();
     REQUIRE(SDFS.format());
     REQUIRE(SD.begin(4));