///////////////////////////////////////////////////////////////////////////////
// BOSSA
//
// Copyright (c) 2011-2018, ShumaTech
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the <organization> nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
///////////////////////////////////////////////////////////////////////////////
#ifndef _FLASHER_H
#define _FLASHER_H

#include <string>
#include <exception>
#include <vector>

#include "Device.h"
#include "Flash.h"
#include "Samba.h"
#include "FileError.h"

class FlashOffsetError : public std::exception
{
public:
    FlashOffsetError() : std::exception() {};
    virtual const char* what() const throw() { return "Flash offset is invalid"; }
};

class FlasherObserver
{
public:
    FlasherObserver() {}
    virtual ~FlasherObserver() {}

    virtual void onStatus(const char *message, ...) = 0;
    virtual void onProgress(int num, int div) = 0;
};

class FlasherInfo
{
public:
    FlasherInfo() {}
    virtual ~FlasherInfo() {}

    void print();

    std::string name;
    uint32_t    chipId;
    uint32_t    extChipId;
    std::string version;
    uint32_t    address;
    uint32_t    numPages;
    uint32_t    pageSize;
    uint32_t    totalSize;
    uint32_t    numPlanes;

    bool        security;
    bool        bootFlash;
    bool        bod;
    bool        bor;

    bool        canBootFlash;
    bool        canBod;
    bool        canBor;
    bool        canChipErase;
    bool        canWriteBuffer;
    bool        canChecksumBuffer;

    std::vector<bool> lockRegions;
    std::vector<uint32_t> uniqueId;
};

std::unique_ptr<FlasherInfo> new_flasher_info();

class Flasher
{
public:
    Flasher(Samba& samba, Device& device, FlasherObserver& observer) : _samba(samba), _flash(device.getFlash()), _device(device), _observer(observer) {}
    virtual ~Flasher() {}

    void erase(uint32_t foffset);
    void write(const char* filename, uint32_t foffset = 0);
    bool verify(const char* filename, uint32_t& pageErrors, uint32_t& totalErrors, uint32_t foffset = 0);
    void read(const char* filename, uint32_t fsize, uint32_t foffset = 0);
    void lock(const std::string& regionArg, bool enable);
    void info(FlasherInfo& info);

    void setSecurity();
    void setBod(bool enable);
    void setBor(bool enable);
    void setBootFlash(bool enable);

    void writeOptions();
    void reset();

private:
    Samba& _samba;
    Device::FlashPtr& _flash;
    Device& _device;
    FlasherObserver& _observer;
};

std::unique_ptr<Flasher> new_flasher(Samba& samba, Device& device, FlasherObserver& observer);

#endif // _FLASHER_H
