file_system_sd.cpp.hpp

Go to the documentation of this file.

 
#include "fl/fs/fs.h"
#include "fl/stl/has_include.h"
#include "fl/log/log.h"
#include "platforms/is_platform.h"
 
#ifdef FASTLED_TESTING
// Stub filesystem maps to the host's real disk (for unit tests).
// `make_sdcard_filesystem` strong impl lives in
// `platforms/stub/fs_stub.cpp.hpp` (part of `platforms+.cpp.o`).
// IWYU pragma: begin_keep
#include "platforms/stub/fs_stub.hpp" // ok platform headers
// IWYU pragma: end_keep
#define FASTLED_HAS_SDCARD_IMPL 1
 
#elif defined(FL_IS_WASM)
// WASM filesystem backs onto the browser. `make_sdcard_filesystem`
// strong impl lives in `platforms/wasm/fs_wasm.cpp.hpp`.
// IWYU pragma: begin_keep
#include "platforms/wasm/fs_wasm.h" // ok platform headers
// IWYU pragma: end_keep
#define FASTLED_HAS_SDCARD_IMPL 1
 
#elif defined(FL_IS_TEENSY)
// Teensy's Arduino SD wrapper declares a process-wide `SD` object.  Keep
// FastLED's optional filesystem on the SdFat path instead, whose state is
// privately owned and lazy behind an implementation-only fl::Singleton.
// IWYU pragma: begin_keep
#include "platforms/arm/teensy/sdfat/fs_sdfat_teensy.h" // ok platform headers
// IWYU pragma: end_keep
#include "fl/stl/singleton.h"
 
namespace fl { namespace platforms { namespace teensy {
 
SdFatState &sdfat_state() FL_NO_EXCEPT {
    return fl::Singleton<SdFatState>::instance();
}
 
} } } // namespace fl::platforms::teensy
 
#define FASTLED_HAS_SDCARD_IMPL 1
 
#elif FL_HAS_INCLUDE(<SD.h>) && FL_HAS_INCLUDE(<fs.h>)
// Arduino SD library is on the include path. `fs_sdcard_arduino.cpp.hpp`
// provides an `inline` `make_sdcard_filesystem` definition that uses
// the real Arduino `SD`/`FS` libraries. Pulling those into
// `fl.system.sd+.cpp.o` is fine — the linker only links this TU when
// the user calls beginSd, so non-SD sketches see none of it.
#define FASTLED_HAS_SDCARD_IMPL 1
 
#else
#define FASTLED_HAS_SDCARD_IMPL 0
#endif
 
namespace fl {
 
#if !FASTLED_HAS_SDCARD_IMPL
// Weak fallback when no platform-specific SD implementation is
// available in the build environment. Returns nullptr so
// `FileSystem::beginSd()` cleanly returns `false`.
FL_LINK_WEAK FsImplPtr make_sdcard_filesystem(int cs_pin) FL_NO_EXCEPT {
    FASTLED_UNUSED(cs_pin);
    return FsImplPtr();
}
#endif
 
bool FileSystem::beginSd(int cs_pin) FL_NO_EXCEPT {
    mFs = make_sdcard_filesystem(cs_pin);
    if (!mFs) {
        return false;
    }
    mFs->begin();
    return true;
}
 
FileSystem FileSystem::sd(int cs_pin) FL_NO_EXCEPT {
    FileSystem fs;
    fs.beginSd(cs_pin);
    return fs;
}
 
} // namespace fl