Components/Storage/src/include/Storage/Device.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/SmingHub/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Device.h - external storage device API
 *
 ****/
#pragma once
 
#include <WString.h>
#include <Printable.h>
#include <Data/LinkedObjectList.h>
#include "PartitionTable.h"
 
#define STORAGE_TYPE_MAP(XX)                                                                                           \
    XX(unknown, 0x00, "Other storage device")                                                                          \
    XX(flash, 0x01, "SPI flash")                                                                                       \
    XX(spiram, 0x02, "SPI RAM")                                                                                        \
    XX(sdcard, 0x03, "SD Card")                                                                                        \
    XX(disk, 0x04, "Physical disk")                                                                                    \
    XX(file, 0x05, "Backing file on separate filesystem")                                                              \
    XX(sysmem, 0x06, "System Memory")
 
namespace Storage
{
class SpiFlash;
 
class Device : public LinkedObjectTemplate<Device>
{
public:
    using List = LinkedObjectListTemplate<Device>;
    using OwnedList = OwnedLinkedObjectListTemplate<Device>;
 
    enum class Type : uint8_t {
        partitionType = uint8_t(Partition::Type::storage),
#define XX(type, value, desc) type = value,
        STORAGE_TYPE_MAP(XX)
#undef XX
    };
 
    Device() : mPartitions(*this)
    {
    }
 
    ~Device();
 
    bool operator==(const String& name) const
    {
        return getName() == name;
    }
 
    const PartitionTable& partitions() const
    {
        return mPartitions;
    }
 
    PartitionTable& editablePartitions()
    {
        return mPartitions;
    }
 
    bool loadPartitions(uint32_t tableOffset)
    {
        return loadPartitions(*this, tableOffset);
    }
 
    bool loadPartitions(Device& source, uint32_t tableOffset);
 
    virtual String getName() const = 0;
 
    virtual uint32_t getId() const
    {
        return 0;
    }
 
    virtual size_t getBlockSize() const = 0;
 
    virtual storage_size_t getSize() const = 0;
 
    virtual Type getType() const = 0;
 
    virtual bool read(storage_size_t address, void* dst, size_t size) = 0;
 
    virtual bool write(storage_size_t address, const void* src, size_t size) = 0;
 
    virtual bool erase_range(storage_size_t address, storage_size_t size) = 0;
 
    virtual uint16_t getSectorSize() const
    {
        return defaultSectorSize;
    }
 
    virtual storage_size_t getSectorCount() const
    {
        return getSize() / getSectorSize();
    }
 
    virtual bool sync()
    {
        return true;
    }
 
    static constexpr uint16_t defaultSectorSize{512};
 
    size_t printTo(Print& p) const;
 
protected:
    PartitionTable mPartitions;
};
 
} // namespace Storage
 
String toString(Storage::Device::Type type);
String toLongString(Storage::Device::Type type);