arch_xt_nvm.h

Go to the documentation of this file.

/*
 * arch_xt_nvm.h
 *
 *  Copyright 2022-2026 Clement Savergne <csavergne@yahoo.com>
 
    This file is part of yasim-avr.
 
    yasim-avr is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    yasim-avr is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with yasim-avr.  If not, see <http://www.gnu.org/licenses/>.
 */
 
//=======================================================================================
 
#ifndef __YASIMAVR_XT_NVM_H__
#define __YASIMAVR_XT_NVM_H__
 
#include "arch_xt_globals.h"
#include "core/sim_peripheral.h"
#include "core/sim_interrupt.h"
#include "core/sim_memory.h"
 
YASIMAVR_BEGIN_NAMESPACE
 
 
//=======================================================================================
 
class AVR_ARCHXT_PUBLIC_API ArchXT_USERROW : public Peripheral {
 
public:
 
    explicit ArchXT_USERROW(reg_addr_t base);
 
    virtual bool init(Device& device) override;
    virtual void ioreg_write_handler(reg_addr_t addr, const ioreg_write_t& data) override;
 
private:
 
    const reg_addr_t m_reg_base;
    NonVolatileMemory* m_userrow;
 
};
 
 
//=======================================================================================
 
class AVR_ARCHXT_PUBLIC_API ArchXT_Fuses : public Peripheral {
 
public:
 
    explicit ArchXT_Fuses(reg_addr_t base);
 
    virtual bool init(Device& device) override;
    virtual void reset(int flags) override;
 
private:
 
    const reg_addr_t m_reg_base;
    NonVolatileMemory* m_fuses;
    MemorySectionManager* m_section_manager;
 
    void configure_flash_sections();
 
};
 
 
//=======================================================================================
 
struct ArchXT_NVMConfig {
 
    reg_addr_t reg_base;
    mem_addr_t flash_page_size;
    mem_addr_t eeprom_page_size;
    unsigned int buffer_erase_delay;
    unsigned int page_write_delay;
    unsigned int page_erase_delay;
    unsigned int chip_erase_delay;
    unsigned int eeprom_erase_delay;
    int_vect_t iv_eeready;
 
};
 
class AVR_ARCHXT_PUBLIC_API ArchXT_NVM : public Peripheral {
 
public:
 
    explicit ArchXT_NVM(const ArchXT_NVMConfig& config);
    virtual ~ArchXT_NVM();
 
    virtual bool init(Device& device) override;
    virtual void reset(int flags) override;
    virtual bool ctlreq(ctlreq_id_t req, ctlreq_data_t* data) override;
    virtual void ioreg_write_handler(reg_addr_t addr, const ioreg_write_t& data) override;
 
private:
 
    enum Command {
        Cmd_Idle,
        Cmd_PageWrite,
        Cmd_PageErase,
        Cmd_PageEraseWrite,
        Cmd_BufferErase,
        Cmd_ChipErase,
        Cmd_EEPROMErase,
    };
 
    enum State {
        State_Idle,
        State_Executing,
        State_Halting,
    };
 
    const ArchXT_NVMConfig& m_config;
    State m_state;
    uint8_t* m_buffer;
    uint8_t* m_bufset;
    int m_mem_index;
    mem_addr_t m_page;
    BoundFunctionCycleTimer<ArchXT_NVM> m_timer;
 
    InterruptFlag m_ee_intflag;
 
    MemorySectionManager* m_section_manager;
    BoundFunctionSignalHook<ArchXT_NVM> m_section_hook;
    bool m_pending_bootlock;
 
    NonVolatileMemory* get_memory(int nvm_index);
    void clear_buffer();
    void write_nvm(NVM_request_t& nvm_req);
    void execute_command(Command cmd);
    unsigned int execute_page_command(Command cmd);
    void timer_next();
    void section_raised(const signal_data_t& sigdata, int hooktag);
 
};
 
 
YASIMAVR_END_NAMESPACE
 
#endif //__YASIMAVR_XT_NVM_H__