Memory.hpp

Go to the documentation of this file.

/******************************************************************************
 * This file is part of project ORCA. More information on the project
 * can be found at the following repositories at GitHub's website.
 *
 * http://https://github.com/andersondomingues/orca-sim
 * http://https://github.com/andersondomingues/orca-software
 * http://https://github.com/andersondomingues/orca-mpsoc
 * http://https://github.com/andersondomingues/orca-tools
 *
 * Copyright (C) 2018-2020 Anderson Domingues, <ti.andersondomingues@gmail.com>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 
******************************************************************************/
#ifndef ORCASIM_MODELING_INCLUDE_MEMORY_HPP_
#define ORCASIM_MODELING_INCLUDE_MEMORY_HPP_

// std API
#include <iostream>
#include <fstream>
#include <cstdlib>
#include <cstdint>
#include <string>

// simulation API
#include "UntimedModel.hpp"

// memory types
#include "MemoryType.hpp"

// counter-specific definitions
#ifdef MEMORY_ENABLE_COUNTERS
#include "Signal.hpp"
#endif

using orcasim::base::UntimedModel;

namespace orcasim::modeling {

class Memory: public UntimedModel {
 private:
    MemoryType* _mem;

    MemoryAddr _length;

    MemoryAddr _base;

    #ifdef MEMORY_ENABLE_COUNTERS

    Signal<uint32_t>* _counter_nload;
    #endif

    #ifdef MEMORY_ENABLE_COUNTERS

    Signal<uint32_t>* _counter_nstore;
    #endif

 public:
    Memory(std::string name, uint32_t size, uint32_t base = 0,
        bool wipe = false, std::string binname = "");

    ~Memory();

    void Write(uint32_t addr, MemoryType* data, uint32_t length);

    void Read(uint32_t addr, MemoryType* buffer, uint32_t length);

    void LoadBin(std::string filename, MemoryAddr base, uint32_t size);

    void SaveBin(std::string filename, MemoryAddr base, uint32_t size);

    void Wipe();

    void Wipe(MemoryAddr base, uint32_t length);

    void Dump(uint32_t base, uint32_t length);

    void Dump();

    MemoryType &operator[](MemoryAddr addr) {
        return _mem[_base + addr];
    }

    MemoryAddr GetBase();

    MemoryAddr GetSize();

    MemoryAddr GetLastAddr();

    MemoryType* GetMap(MemoryAddr addr);

    #ifdef MEMORY_ENABLE_COUNTERS

    Signal<uint32_t>* GetSignalCounterLoad();
    #endif

    #ifdef MEMORY_ENABLE_COUNTERS

    Signal<uint32_t>* GetSignalCounterStore();
    #endif
};

}  // namespace orcasim::modeling
#endif  // ORCASIM_MODELING_INCLUDE_MEMORY_HPP_