Partition.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.
 *
 * Partition.h - C++ wrapper for universal partition table support
 *
 * Original license for IDF code:
 *
 *  Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *
 ****/
#pragma once

#include <Printable.h>
#include <Data/BitSet.h>
#include <Data/CString.h>
#include <Data/LinkedObjectList.h>
#include <cassert>
#include "Types.h"

#define PARTITION_APP_SUBTYPE_MAP(XX)                                                                                  \
    XX(factory, 0x00, "Factory application")                                                                           \
    XX(ota0, 0x10, "OTA #0")                                                                                           \
    XX(ota1, 0x11, "OTA #1")                                                                                           \
    XX(ota2, 0x12, "OTA #2")                                                                                           \
    XX(ota3, 0x13, "OTA #3")                                                                                           \
    XX(ota4, 0x14, "OTA #4")                                                                                           \
    XX(ota5, 0x15, "OTA #5")                                                                                           \
    XX(ota6, 0x16, "OTA #6")                                                                                           \
    XX(ota7, 0x17, "OTA #7")                                                                                           \
    XX(ota8, 0x18, "OTA #8")                                                                                           \
    XX(ota9, 0x19, "OTA #9")                                                                                           \
    XX(ota10, 0x1a, "OTA #10")                                                                                         \
    XX(ota11, 0x1b, "OTA #11")                                                                                         \
    XX(ota12, 0x1c, "OTA #12")                                                                                         \
    XX(ota13, 0x1d, "OTA #13")                                                                                         \
    XX(ota14, 0x1e, "OTA #14")                                                                                         \
    XX(ota15, 0x1f, "OTA #15")                                                                                         \
    XX(test, 0x20, "Test application")

#define PARTITION_DATA_SUBTYPE_MAP(XX)                                                                                 \
    XX(ota, 0x00, "OTA selection")                                                                                     \
    XX(phy, 0x01, "PHY init data")                                                                                     \
    XX(nvs, 0x02, "NVS")                                                                                               \
    XX(coreDump, 0x03, "Core Dump data")                                                                               \
    XX(nvsKeys, 0x04, "NVS key information")                                                                           \
    XX(eFuseEm, 0x05, "eFuse emulation")                                                                               \
    XX(sysParam, 0x40, "System Parameters")                                                                            \
    XX(rfCal, 0x41, "RF Calibration")                                                                                  \
    XX(espHttpd, 0x80, "ESPHTTPD")                                                                                     \
    XX(fat, 0x81, "FAT")                                                                                               \
    XX(spiffs, 0x82, "SPIFFS")                                                                                         \
    XX(fwfs, 0xF1, "FWFS")                                                                                             \
    XX(littlefs, 0xF2, "LittleFS")

namespace Storage
{
class Device;
class PartitionTable;
struct esp_partition_info_t;

namespace Disk
{
class DiskPart;
}

class Partition
{
public:
    enum class Type : uint8_t {
        app = 0x00,
        data = 0x01,
        storage = 0x02,
        userMin = 0x40,
        userMax = 0xFE,
        invalid = 0xff,
        any = 0xff,
    };

    struct SubType {
        static constexpr uint8_t any{0xff};
        static constexpr uint8_t invalid{0xff};

        enum class App : uint8_t {
            partitionType = uint8_t(Type::app),
#define XX(type, value, desc) type = value,
            PARTITION_APP_SUBTYPE_MAP(XX)
#undef XX
                ota_min = ota0,
            ota_max = ota15,
            any = 0xff
        };

        enum class Data : uint8_t {
            partitionType = uint8_t(Type::data),
#define XX(subtype, value, desc) subtype = value,
            PARTITION_DATA_SUBTYPE_MAP(XX)
#undef XX
                any = 0xff
        };
    };

    enum class Flag {
        encrypted = 0,
        readOnly = 31, 
    };

    static constexpr size_t nameSize{16};
    using Name = char[nameSize];
    using Flags = BitSet<uint32_t, Flag>;

    struct FullType {
        Type type;
        uint8_t subtype;

        constexpr FullType() : type(Type::invalid), subtype(SubType::invalid)
        {
        }

        constexpr FullType(Type type, uint8_t subtype) : type(type), subtype(subtype)
        {
        }

        explicit operator bool() const
        {
            return type != Type::invalid && subtype != uint8_t(SubType::invalid);
        }

        template <typename T> constexpr FullType(T subType) : FullType(Type(T::partitionType), uint8_t(subType))
        {
        }

        bool operator==(const FullType& other) const
        {
            return type == other.type && subtype == other.subtype;
        }

        bool operator!=(const FullType& other) const
        {
            return !operator==(other);
        }

        constexpr uint16_t value() const
        {
            return uint8_t(type) << 8 | subtype;
        }

        operator String() const;
    };

    struct Info : public LinkedObjectTemplate<Info>, public Printable {
        using OwnedList = OwnedLinkedObjectListTemplate<Info>;

        CString name;
        storage_size_t offset{0};
        storage_size_t size{0};
        Type type{Type::invalid};
        uint8_t subtype{SubType::invalid};
        Flags flags;

        Info()
        {
        }

        Info(const String& name, FullType fullType, storage_size_t offset, storage_size_t size, Flags flags = 0)
            : name(name), offset(offset), size(size), type(fullType.type), subtype(fullType.subtype), flags(flags)
        {
        }

        FullType fullType() const
        {
            return {type, subtype};
        }

        bool match(Type type, uint8_t subType) const
        {
            return (type == Type::any || type == this->type) && (subType == SubType::any || subType == this->subtype);
        }

        virtual const Disk::DiskPart* diskpart() const
        {
            return nullptr;
        }

        size_t printTo(Print& p) const override;
    };

    Partition()
    {
    }

    Partition(const Partition& other) : mDevice(other.mDevice), mPart(other.mPart)
    {
    }

    Partition(Device& device, const Info& info) : mDevice(&device), mPart(&info)
    {
    }

    bool verify(Type type, uint8_t subtype) const;

    bool verify(uint8_t type, uint8_t subtype) const
    {
        return verify(Type(type), subtype);
    }

    template <typename T> bool verify(T subType) const
    {
        return verify(Type(T::partitionType), uint8_t(subType));
    }

    static inline SubType::App apptypeOta(uint8_t i)
    {
        auto subtype = SubType::App(uint8_t(SubType::App::ota_min) + i);
        assert(subtype >= SubType::App::ota_min && subtype <= SubType::App::ota_max);
        return subtype;
    }

    explicit operator bool() const
    {
        return mDevice != nullptr && mPart != nullptr;
    }

    bool read(storage_size_t offset, void* dst, size_t size);

    template <typename T>
    typename std::enable_if<std::is_pod<T>::value, bool>::type read(storage_size_t offset, T& value)
    {
        return read(offset, &value, sizeof(value));
    }

    bool write(storage_size_t offset, const void* src, size_t size);

    bool erase_range(storage_size_t offset, storage_size_t size);

    Partition::Type type() const
    {
        return mPart ? Partition::Type(mPart->type) : Type::invalid;
    }

    uint8_t subType() const
    {
        return mPart ? mPart->subtype : SubType::invalid;
    }

    FullType fullType() const
    {
        return mPart ? mPart->fullType() : FullType{};
    }

    storage_size_t address() const
    {
        return (mPart && mPart->type != Partition::Type::storage) ? mPart->offset : 0;
    }

    storage_size_t lastAddress() const
    {
        return mPart ? (mPart->offset + mPart->size - 1) : 0;
    }

    storage_size_t size() const
    {
        return mPart ? mPart->size : 0;
    }

    String name() const
    {
        return mPart ? mPart->name.c_str() : nullptr;
    }

    Flags flags() const
    {
        return mPart ? mPart->flags : 0;
    }

    bool isEncrypted() const
    {
        return flags()[Flag::encrypted];
    }

    bool isReadOnly() const
    {
        return mPart ? mPart->flags[Flag::readOnly] : true;
    }

    String typeString() const;
    String longTypeString() const;
    bool getDeviceAddress(storage_size_t& address, storage_size_t size) const;

    String getDeviceName() const;

    bool contains(storage_size_t addr) const
    {
        return mPart ? (addr >= mPart->offset && addr <= lastAddress()) : false;
    }

    bool operator==(const Partition& other) const
    {
        return mDevice == other.mDevice && mPart == other.mPart;
    }

    bool operator==(const char* name) const
    {
        return mPart ? mPart->name.equals(name) : false;
    }

    bool operator==(const String& name) const
    {
        return mPart ? mPart->name.equals(name) : false;
    }

    template <typename T> bool operator!=(const T& other) const
    {
        return !operator==(other);
    }

    size_t getBlockSize() const;

    uint16_t getSectorSize() const;

    storage_size_t getSectorCount() const
    {
        return size() / getSectorSize();
    }

    bool sync();

    const Disk::DiskPart* diskpart() const
    {
        return mPart ? mPart->diskpart() : nullptr;
    }

    size_t printTo(Print& p) const;

protected:
    Device* mDevice{nullptr};
    const Info* mPart{nullptr};

private:
    bool allowRead();
    bool allowWrite();
};

} // namespace Storage

String toString(Storage::Partition::Type type, uint8_t subType);
String toLongString(Storage::Partition::Type type, uint8_t subType);

template <typename E> typename std::enable_if<bool(E::partitionType), String>::type toString(E subType)
{
    return toString(Storage::Partition::Type(E::partitionType), uint8_t(subType));
}

template <typename E> typename std::enable_if<bool(E::partitionType), String>::type toLongString(E subType)
{
    return toLongString(Storage::Partition::Type(E::partitionType), uint8_t(subType));
}