Components/IFS/src/include/IFS/SPIFFS/FileSystem.h

Go to the documentation of this file.

#pragma once

#include "../FileSystem.h"
#include "FileMeta.h"
#include <spiffs.h>
extern "C" {
#include <spiffs_nucleus.h>
}

/*
 * Maxmimum number of open files
 */
#define FFS_MAX_FILEDESC 8

namespace IFS
{
namespace SPIFFS
{
/*
 * Wraps SPIFFS
 */
class FileSystem : public IFileSystem
{
public:
    FileSystem(Storage::Partition partition) : partition(partition)
    {
    }

    ~FileSystem();

    int mount() override;
    int getinfo(Info& info) override;
    String getErrorString(int err) override;
    int opendir(const char* path, DirHandle& dir) override;
    int readdir(DirHandle dir, Stat& stat) override;
    int rewinddir(DirHandle dir) override;
    int closedir(DirHandle dir) override;
    int mkdir(const char* path) override;
    int stat(const char* path, Stat* stat) override;
    int fstat(FileHandle file, Stat* stat) override;
    int setacl(FileHandle file, const ACL& acl) override;
    int setattr(const char* path, FileAttributes attr) override;
    int settime(FileHandle file, time_t mtime) override;
    int setcompression(FileHandle file, const Compression& compression) override;
    FileHandle open(const char* path, OpenFlags flags) override;
    FileHandle fopen(const Stat& stat, OpenFlags flags) override;
    int close(FileHandle file) override;
    int read(FileHandle file, void* data, size_t size) override;
    int write(FileHandle file, const void* data, size_t size) override;
    int lseek(FileHandle file, int offset, SeekOrigin origin) override;
    int eof(FileHandle file) override;
    int32_t tell(FileHandle file) override;
    int ftruncate(FileHandle file, size_t new_size) override;
    int flush(FileHandle file) override;
    int rename(const char* oldpath, const char* newpath) override;
    int remove(const char* path) override;
    int fremove(FileHandle file) override;
    int format() override;
    int check() override;

    int getFilePath(FileID fileid, NameBuffer& buffer);

private:
    spiffs* handle()
    {
        return &fs;
    }

    int tryMount(spiffs_config& cfg);

    SpiffsMetaBuffer* initMetaBuffer(FileHandle file);
    SpiffsMetaBuffer* getMetaBuffer(FileHandle file);
    int flushMeta(FileHandle file);

    void touch(FileHandle file)
    {
        settime(file, fsGetTimeUTC());
    }

    static constexpr size_t CACHE_PAGES{8};
    static constexpr size_t LOG_PAGE_SIZE{256};
    static constexpr size_t MIN_BLOCKSIZE{256};
    static constexpr size_t CACHE_PAGE_SIZE{sizeof(spiffs_cache_page) + LOG_PAGE_SIZE};
    static constexpr size_t CACHE_SIZE{sizeof(spiffs_cache) + CACHE_PAGES * CACHE_PAGE_SIZE};

    Storage::Partition partition;
    SpiffsMetaBuffer metaCache[FFS_MAX_FILEDESC];
    spiffs fs;
    uint16_t workBuffer[LOG_PAGE_SIZE];
    spiffs_fd fileDescriptors[FFS_MAX_FILEDESC];
    uint8_t cache[CACHE_SIZE];
};

} // namespace SPIFFS
} // namespace IFS