UpgraderBase.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.
 *
 * Ota.h
 *
 * This header includes all unified Over-The-Air functions.
 *
*/
 
#pragma once
#include <Storage.h>
#include <Storage/SpiFlash.h>
 
namespace Ota
{
class UpgraderBase
{
public:
    static constexpr uint8_t SLOT_NONE{255};
 
    using Partition = Storage::Partition;
 
    virtual ~UpgraderBase()
    {
    }
 
    virtual bool begin(Partition partition, size_t size = 0) = 0;
 
    virtual size_t write(const uint8_t* buffer, size_t size) = 0;
 
    virtual bool end() = 0;
 
    virtual bool abort()
    {
        return false;
    }
 
    virtual bool setBootPartition(Partition partition, bool save = true) = 0;
 
    virtual Partition getBootPartition() = 0;
 
    virtual Partition getRunningPartition() = 0;
 
    virtual Partition getNextBootPartition(Partition startFrom = {}) = 0;
 
    Storage::Iterator getBootPartitions()
    {
        return Storage::findPartition(Partition::Type::app);
    }
 
    // utility functions
 
    uint8_t getSlot(Partition partition)
    {
        if(partition.type() != Partition::Type::app) {
            return SLOT_NONE;
        }
 
        using App = Partition::SubType::App;
        auto subtype = App(partition.subType());
        if(subtype < App::ota_min || subtype > App::ota_max) {
            return SLOT_NONE;
        }
 
        return uint8_t(subtype) - uint8_t(App::ota_min);
    }
};
 
} // namespace Ota