coredecouplingltinitiator.h

SystemC Transaction Level Modelling. 是基于SystemC之上的总线互联协议

/*****************************************************************************

  The following code is derived, directly or indirectly, from the SystemC
  source code Copyright (c) 1996-2008 by all Contributors.
  All Rights reserved.

  The contents of this file are subject to the restrictions and limitations
  set forth in the SystemC Open Source License Version 3.0 (the "License");
  You may not use this file except in compliance with such restrictions and
  limitations. You may obtain instructions on how to receive a copy of the
  License at http://www.systemc.org/. Software distributed by Contributors
  under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF
  ANY KIND, either express or implied. See the License for the specific
  language governing rights and limitations under the License.

 *****************************************************************************/

#ifndef __CORE_DECOUPLING_LT_INITIATOR_H__
#define __CORE_DECOUPLING_LT_INITIATOR_H__

#include "tlm.h"
#include "tlm_utils/simple_initiator_socket.h"
#include "tlm_utils/tlm_quantumkeeper.h"
//#include <systemc>
#include <cassert>
//#include <iostream>

class CoreDecouplingLTInitiator : public sc_core::sc_module
{
public:
  typedef tlm::tlm_generic_payload                         transaction_type;
  typedef tlm_utils::simple_initiator_socket<CoreDecouplingLTInitiator> initiator_socket_type;

public:
  initiator_socket_type socket;

public:
  SC_HAS_PROCESS(CoreDecouplingLTInitiator);
  CoreDecouplingLTInitiator(sc_core::sc_module_name name,
                            unsigned int nrOfTransactions = 0x5,
                            unsigned int baseAddress = 0) :
    sc_core::sc_module(name),
    socket("socket"),
    mNrOfTransactions(nrOfTransactions),
    mBaseAddress(baseAddress),
    mTransactionCount(0)
  {
    tlm_utils::tlm_quantumkeeper::set_global_quantum(sc_core::sc_time(500, sc_core::SC_NS));
    mQuantumKeeper.reset();

    // Initiator thread
    SC_THREAD(run);
  }

  bool initTransaction(transaction_type& trans)
  {
    if (mTransactionCount < mNrOfTransactions) {
      trans.set_address(mBaseAddress + 4*mTransactionCount);
      mData = mTransactionCount;
      trans.set_command(tlm::TLM_WRITE_COMMAND);

    } else if (mTransactionCount < 2 * mNrOfTransactions) {
      trans.set_address(mBaseAddress + 4*(mTransactionCount - mNrOfTransactions));
      mData = 0;
      trans.set_command(tlm::TLM_READ_COMMAND);

    } else {
      return false;
    }

    trans.set_data_ptr(reinterpret_cast<unsigned char*>(&mData));
    trans.set_data_length(4);

    ++mTransactionCount;
    return true;
  }

  void logStartTransation(transaction_type& trans)
  {
    if (trans.get_command() == tlm::TLM_WRITE_COMMAND) {
      std::cout << name() << ": Send write request: A = 0x"
                << std::hex << (unsigned int)trans.get_address()
                << ", D = 0x" << mData << std::dec
                << " @ " << mQuantumKeeper.get_current_time()
                << " (" << sc_core::sc_time_stamp() << " + "
                << mQuantumKeeper.get_local_time() << ")"
                << std::endl;
      
    } else {
      std::cout << name() << ": Send read request: A = 0x"
                << std::hex << (unsigned int)trans.get_address()
                << " @ " << mQuantumKeeper.get_current_time()
                << " (" << sc_core::sc_time_stamp() << " + "
                << mQuantumKeeper.get_local_time() << ")"
                << std::endl;
    }
  }

  void logEndTransaction(transaction_type& trans)
  {
    if (trans.get_response_status() != tlm::TLM_OK_RESPONSE) {
      std::cout << name() << ": Received error response @ "
                << mQuantumKeeper.get_current_time()
                << " (" << sc_core::sc_time_stamp() << " + "
                << mQuantumKeeper.get_local_time() << ")"
                << std::endl;

    } else {
      std::cout << name() <<  ": Received ok response";
      if (trans.get_command() == tlm::TLM_READ_COMMAND) {
          std::cout << ": D = 0x" << std::hex << mData << std::dec;
      }
      std::cout << " @ " << mQuantumKeeper.get_current_time()
                << " (" << sc_core::sc_time_stamp() << " + "
                << mQuantumKeeper.get_local_time() << ")"
                << std::endl;
    }
  }

  void run()
  {
    transaction_type trans;

    while (initTransaction(trans)) {
      logStartTransation(trans);
      
      // exec instr
      sc_core::sc_time t = mQuantumKeeper.get_local_time();
      socket->b_transport(trans, t);
      mQuantumKeeper.set(t);
      // Target may have added a delay to the quantum -> sync if needed
      if (mQuantumKeeper.need_sync()) {
        std::cout << "Sync'ing..." << std::endl;
        mQuantumKeeper.sync();
      }

      logEndTransaction(trans);
    }
    wait();
  }

private:
  unsigned int mNrOfTransactions;
  unsigned int mBaseAddress;
  unsigned int mTransactionCount;
  unsigned int mData;
  tlm_utils::tlm_quantumkeeper mQuantumKeeper;
};

#endif