///////////////////////////////////////////////////////////////////////////////
// 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 _EEFCFLASH_H
#define _EEFCFLASH_H

#include <stdint.h>
#include <exception>

#include "Flash.h"

class EefcFlash : public Flash
{
public:
    EefcFlash(Samba& samba,
              const std::string& name,
              uint32_t addr,
              uint32_t pages,
              uint32_t size,
              uint32_t planes,
              uint32_t lockRegions,
              uint32_t uniqueIdWords,
              uint32_t user,
              uint32_t stack,
              uint32_t regs,
              bool canBrownout);
    virtual ~EefcFlash();

    void eraseAll(uint32_t offset);
    void eraseAuto(bool enable);

    std::vector<bool> getLockRegions();

    bool getSecurity();

    bool getBod();
    bool canBod() { return _canBrownout; }

    bool getBor();
    bool canBor() { return _canBrownout; }

    bool getBootFlash();
    bool canBootFlash() { return true; }

    std::vector<uint32_t> getUniqueId();

    void writeOptions();

    void ready();

    void writePage(uint32_t page);
    void readPage(uint32_t page, uint8_t* data);

    static const uint32_t PagesPerErase;

private:
    uint32_t _regs;
    uint32_t _uniqueIdWords;
    bool _canBrownout;
    bool _eraseAuto;

    void waitFSR(int seconds = 1);
    void writeFCR0(uint8_t cmd, uint32_t arg);
    void writeFCR1(uint8_t cmd, uint32_t arg);
    uint32_t readFRR0();
    uint32_t readFRR1();
};

#endif // _EEFCFLASH_H
