/*!
 \file Memory.h
 \brief Basic TLM-2 memory model
 \author Màrius Montón
 \date August 2018
 */
// SPDX-License-Identifier: GPL-3.0-or-later

#ifndef __MEMORY_H__
#define __MEMORY_H__

#include <iostream>
#include <fstream>

#define SC_INCLUDE_DYNAMIC_PROCESSES

#include "systemc"

#include "tlm.h"
#include "tlm_utils/simple_target_socket.h"

#include "spdlog/spdlog.h"
#include "spdlog/sinks/basic_file_sink.h"

namespace riscv_tlm {
/**
 * @brief Basic TLM-2 memory
 */
    class Memory : sc_core::sc_module {
    public:
        // TLM-2 socket, defaults to 32-bits wide, base protocol
        tlm_utils::simple_target_socket<Memory> socket;

        /* 16 MBytes */
        enum {
            SIZE = 0x1000000
        };
        const sc_core::sc_time LATENCY;

        Memory(sc_core::sc_module_name const &name, std::string const &filename);

        explicit Memory(const sc_core::sc_module_name &name);

        ~Memory() override;

        /**
         * @brief Returns Program Counter read from hexfile
         * @return Initial PC
         */
        virtual std::uint32_t getPCfromHEX();

        // TLM-2 blocking transport method
        virtual void b_transport(tlm::tlm_generic_payload &trans,
                                 sc_core::sc_time &delay);

        // *********************************************
        // TLM-2 forward DMI method
        // *********************************************
        virtual bool get_direct_mem_ptr(tlm::tlm_generic_payload &trans,
                                        tlm::tlm_dmi &dmi_data);

        // *********************************************
        // TLM-2 debug transport method
        // *********************************************
        virtual unsigned int transport_dbg(tlm::tlm_generic_payload &trans);

    private:

        /**
         * @brief Memory array in bytes
         */
        std::array<uint8_t, Memory::SIZE> mem{};

        /**
         * @brief Log class
         */
        std::shared_ptr<spdlog::logger> logger;

        /**
         * @brief Program counter (PC) read from hex file
         */
        std::uint32_t program_counter;

        /**
         * @brief DMI can be used?
         */
        bool dmi_allowed;

        /**
         * @brief Read Intel hex file
         * @param filename file name to read
         */
        void readHexFile(const std::string &filename);
    };
}
#endif /* __MEMORY_H__ */