sim_firmware.h

Go to the documentation of this file.

/*
 * sim_firmware.h
 *
 *  Copyright 2021-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_FIRMWARE_H__
#define __YASIMAVR_FIRMWARE_H__
 
#include "sim_types.h"
#include "sim_memory.h"
#include <map>
 
YASIMAVR_BEGIN_NAMESPACE
 
 
//=======================================================================================
class AVR_CORE_PUBLIC_API Firmware {
 
public:
 
    struct block_view_t {
        bytes_view_t bytes;
        size_t base = 0;
    };
 
    enum Area {
        Area_Flash,
        Area_Data,
        Area_EEPROM,
        Area_Fuses,
        Area_Lock,
        Area_Signature,
        Area_UserSignatures,
    };
 
    struct Symbol {
        size_t      addr;
        size_t      size;
        std::string name;
        Area        area;
    };
 
    unsigned long frequency;
    double vcc;
    double aref;
    reg_addr_t console_register;
 
    Firmware();
    Firmware(const Firmware& other) = default;
 
    static Firmware* read_elf(const std::string& filename);
 
    void add_block(Area area, const block_view_t& block);
 
    bool has_memory(Area area) const;
 
    std::vector<Area> memories() const;
 
    size_t memory_size(Area area) const;
 
    std::vector<block_view_t> blocks(Area area) const;
 
    bool load_memory(Area area, NonVolatileMemory& memory) const;
 
    mem_addr_t datasize() const;
    mem_addr_t bsssize() const;
 
    void add_symbol(const Symbol& s);
    const std::vector<Symbol>& symbols() const;
 
    Firmware& operator=(const Firmware& other) = default;
 
private:
 
    struct block_t {
        bytes_t     bytes;
        size_t      base;
 
        constexpr block_t(size_t b, size_t n) : bytes(n), base(b) {}
    };
 
    std::map<Area, std::vector<block_t>> m_blocks;
    mem_addr_t m_datasize;
    mem_addr_t m_bsssize;
    std::vector<Symbol> m_symbols;
 
};
 
inline mem_addr_t Firmware::datasize() const
{
    return m_datasize;
}
 
inline mem_addr_t Firmware::bsssize() const
{
    return m_bsssize;
}
 
inline const std::vector<Firmware::Symbol>& Firmware::symbols() const
{
    return m_symbols;
}
 
 
YASIMAVR_END_NAMESPACE
 
#endif //__YASIMAVR_FIRMWARE_H__