/*
 * Copyright (c) 2015, Technische Universität Kaiserslautern
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. Neither the name of the copyright holder 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 THE COPYRIGHT HOLDER
 * OR CONTRIBUTORS 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.
 *
 * Authors:
 *    Janik Schlemminger
 *    Matthias Jung
 *    Eder F. Zulian
 *    Felipe S. Prado
 *    Lukas Steiner
 *    Derek Christ
 */

#ifndef DRAMSYS_H
#define DRAMSYS_H

#include "DRAMSys/simulation/dram/Dram.h"
#include "DRAMSys/simulation/Arbiter.h"
#include "DRAMSys/simulation/ReorderBuffer.h"
#include "DRAMSys/common/tlm2_base_protocol_checker.h"
#include "DRAMSys/controller/ControllerIF.h"
#include "DRAMSys/simulation/AddressDecoder.h"

#include "DRAMSys/config/DRAMSysConfiguration.h"

#include <string>
#include <list>
#include <memory>
#include <systemc>
#include <tlm>
#include <tlm_utils/multi_passthrough_initiator_socket.h>
#include <tlm_utils/multi_passthrough_target_socket.h>

namespace DRAMSys {

class DRAMSys : public sc_core::sc_module
{
public:
    tlm_utils::multi_passthrough_target_socket<DRAMSys> tSocket;

    SC_HAS_PROCESS(DRAMSys);
    DRAMSys(const sc_core::sc_module_name& name,
            const ::DRAMSys::Config::Configuration& configLib);

    const Configuration& getConfig() const;

protected:
    DRAMSys(const sc_core::sc_module_name& name,
            const ::DRAMSys::Config::Configuration& configLib,
            bool initAndBind);

    void end_of_simulation() override;

    Configuration config;

    //TLM 2.0 Protocol Checkers
    std::vector<std::unique_ptr<tlm_utils::tlm2_base_protocol_checker<>>> controllersTlmCheckers;

    // TODO: Each DRAM has a reorder buffer (check this!)
    std::unique_ptr<ReorderBuffer> reorder;

    // All transactions pass through the same arbiter
    std::unique_ptr<Arbiter> arbiter;

    // Each DRAM unit has a controller
    std::vector<std::unique_ptr<ControllerIF>> controllers;

    // DRAM units
    std::vector<std::unique_ptr<Dram>> drams;

    std::unique_ptr<AddressDecoder> addressDecoder;

    void report(const std::string& message);
    void bindSockets();

private:
    static void logo();
    void instantiateModules(const ::DRAMSys::Config::AddressMapping& addressMapping);
    void setupDebugManager(const std::string& traceName) const;
};

}

#endif // DRAMSYS_H
