112922Sgabeblack@google.com/***************************************************************************** 212922Sgabeblack@google.com 312922Sgabeblack@google.com Licensed to Accellera Systems Initiative Inc. (Accellera) under one or 412922Sgabeblack@google.com more contributor license agreements. See the NOTICE file distributed 512922Sgabeblack@google.com with this work for additional information regarding copyright ownership. 612922Sgabeblack@google.com Accellera licenses this file to you under the Apache License, Version 2.0 712922Sgabeblack@google.com (the "License"); you may not use this file except in compliance with the 812922Sgabeblack@google.com License. You may obtain a copy of the License at 912922Sgabeblack@google.com 1012922Sgabeblack@google.com http://www.apache.org/licenses/LICENSE-2.0 1112922Sgabeblack@google.com 1212922Sgabeblack@google.com Unless required by applicable law or agreed to in writing, software 1312922Sgabeblack@google.com distributed under the License is distributed on an "AS IS" BASIS, 1412922Sgabeblack@google.com WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 1512922Sgabeblack@google.com implied. See the License for the specific language governing 1612922Sgabeblack@google.com permissions and limitations under the License. 1712922Sgabeblack@google.com 1812922Sgabeblack@google.com *****************************************************************************/ 1912922Sgabeblack@google.com 2012922Sgabeblack@google.com//==================================================================== 2112922Sgabeblack@google.com// Nov 06, 2008 2212922Sgabeblack@google.com// 2312922Sgabeblack@google.com// Updated by: 2412922Sgabeblack@google.com// Xiaopeng Qiu, JEDA Technologies, Inc 2512922Sgabeblack@google.com// Email: qiuxp@jedatechnologies.net 2612922Sgabeblack@google.com// 2712922Sgabeblack@google.com// To fix violations of TLM2.0 rules, which are detected by JEDA 2812922Sgabeblack@google.com// TLM2.0 checker. 2912922Sgabeblack@google.com// 3012922Sgabeblack@google.com//==================================================================== 3112922Sgabeblack@google.com 3212922Sgabeblack@google.com#ifndef __SIMPLE_LT_INITIATOR1_DMI_H__ 3312922Sgabeblack@google.com#define __SIMPLE_LT_INITIATOR1_DMI_H__ 3412922Sgabeblack@google.com 3512922Sgabeblack@google.com#include "tlm.h" 3612922Sgabeblack@google.com#include <systemc> 3712922Sgabeblack@google.com#include <cassert> 3812922Sgabeblack@google.com#include <iostream> 3912922Sgabeblack@google.com#include <iomanip> 4012922Sgabeblack@google.com 4112922Sgabeblack@google.comclass SimpleLTInitiator1_dmi : 4212922Sgabeblack@google.com public sc_core::sc_module, 4312922Sgabeblack@google.com public virtual tlm::tlm_bw_transport_if<> 4412922Sgabeblack@google.com{ 4512922Sgabeblack@google.compublic: 4612922Sgabeblack@google.com typedef tlm::tlm_generic_payload transaction_type; 4712922Sgabeblack@google.com typedef tlm::tlm_dmi dmi_type; 4812922Sgabeblack@google.com typedef tlm::tlm_phase phase_type; 4912922Sgabeblack@google.com typedef tlm::tlm_sync_enum sync_enum_type; 5012922Sgabeblack@google.com typedef tlm::tlm_fw_transport_if<> fw_interface_type; 5112922Sgabeblack@google.com typedef tlm::tlm_bw_transport_if<> bw_interface_type; 5212922Sgabeblack@google.com typedef tlm::tlm_initiator_socket<> initiator_socket_type; 5312922Sgabeblack@google.com 5412922Sgabeblack@google.compublic: 5512922Sgabeblack@google.com initiator_socket_type socket; 5612922Sgabeblack@google.com 5712922Sgabeblack@google.compublic: 5812922Sgabeblack@google.com SC_HAS_PROCESS(SimpleLTInitiator1_dmi); 5912922Sgabeblack@google.com SimpleLTInitiator1_dmi(sc_core::sc_module_name name, 6012922Sgabeblack@google.com unsigned int nrOfTransactions = 0x5, 6112922Sgabeblack@google.com unsigned int baseAddress = 0x0) : 6212922Sgabeblack@google.com sc_core::sc_module(name), 6312922Sgabeblack@google.com socket("socket"), 6412922Sgabeblack@google.com mNrOfTransactions(nrOfTransactions), 6512922Sgabeblack@google.com mBaseAddress(baseAddress), 6612922Sgabeblack@google.com mTransactionCount(0) 6712922Sgabeblack@google.com { 6812922Sgabeblack@google.com invalidate(mDMIData); 6912922Sgabeblack@google.com 7012922Sgabeblack@google.com // Bind this initiator's interface to the initiator socket 7112922Sgabeblack@google.com socket(*this); 7212922Sgabeblack@google.com 7312922Sgabeblack@google.com // Initiator thread 7412922Sgabeblack@google.com SC_THREAD(run); 7512922Sgabeblack@google.com } 7612922Sgabeblack@google.com 7712922Sgabeblack@google.com bool initTransaction(transaction_type& trans) 7812922Sgabeblack@google.com { 7912922Sgabeblack@google.com // initialize DMI hint: 8012922Sgabeblack@google.com trans.set_dmi_allowed(false); 8112922Sgabeblack@google.com 8212922Sgabeblack@google.com if (mTransactionCount < mNrOfTransactions) { 8312922Sgabeblack@google.com trans.set_address(mBaseAddress + 4*mTransactionCount); 8412922Sgabeblack@google.com mData = mTransactionCount; 8512922Sgabeblack@google.com trans.set_command(tlm::TLM_WRITE_COMMAND); 8612922Sgabeblack@google.com 8712922Sgabeblack@google.com } else if (mTransactionCount < 2 * mNrOfTransactions) { 8812922Sgabeblack@google.com trans.set_address(mBaseAddress + 4*(mTransactionCount-mNrOfTransactions)); 8912922Sgabeblack@google.com mData = 0; 9012922Sgabeblack@google.com trans.set_command(tlm::TLM_READ_COMMAND); 9112922Sgabeblack@google.com 9212922Sgabeblack@google.com } else { 9312922Sgabeblack@google.com return false; 9412922Sgabeblack@google.com } 9512922Sgabeblack@google.com 9612922Sgabeblack@google.com trans.set_data_ptr(reinterpret_cast<unsigned char*>(&mData)); 9712922Sgabeblack@google.com trans.set_data_length(4); 9812922Sgabeblack@google.com trans.set_streaming_width(4); 9912922Sgabeblack@google.com 10012922Sgabeblack@google.com ++mTransactionCount; 10112922Sgabeblack@google.com return true; 10212922Sgabeblack@google.com } 10312922Sgabeblack@google.com 10412922Sgabeblack@google.com void logStartTransation(transaction_type& trans) 10512922Sgabeblack@google.com { 10612922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_WRITE_COMMAND) { 10712922Sgabeblack@google.com std::cout << name() << ": Send write request: A = 0x" 10812922Sgabeblack@google.com << std::hex << (unsigned int)trans.get_address() 10912922Sgabeblack@google.com << ", D = 0x" << mData << std::dec 11012922Sgabeblack@google.com << " @ " << sc_core::sc_time_stamp() << std::endl; 11112922Sgabeblack@google.com 11212922Sgabeblack@google.com } else { 11312922Sgabeblack@google.com std::cout << name() << ": Send read request: A = 0x" 11412922Sgabeblack@google.com << std::hex << (unsigned int)trans.get_address() << std::dec 11512922Sgabeblack@google.com << " @ " << sc_core::sc_time_stamp() << std::endl; 11612922Sgabeblack@google.com } 11712922Sgabeblack@google.com } 11812922Sgabeblack@google.com 11912922Sgabeblack@google.com void logEndTransaction(transaction_type& trans) 12012922Sgabeblack@google.com { 12112922Sgabeblack@google.com if (trans.get_response_status() != tlm::TLM_OK_RESPONSE) { 12212922Sgabeblack@google.com std::cout << name() << ": Received error response @ " 12312922Sgabeblack@google.com << sc_core::sc_time_stamp() << std::endl; 12412922Sgabeblack@google.com 12512922Sgabeblack@google.com } else { 12612922Sgabeblack@google.com std::cout << name() << ": Received ok response"; 12712922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_READ_COMMAND) { 12812922Sgabeblack@google.com std::cout << ": D = 0x" << std::hex << mData << std::dec; 12912922Sgabeblack@google.com } 13012922Sgabeblack@google.com std::cout << " @ " << sc_core::sc_time_stamp() << std::endl; 13112922Sgabeblack@google.com } 13212922Sgabeblack@google.com } 13312922Sgabeblack@google.com 13412922Sgabeblack@google.com void run() 13512922Sgabeblack@google.com { 13612922Sgabeblack@google.com transaction_type trans; 13712922Sgabeblack@google.com phase_type phase; 13812922Sgabeblack@google.com sc_core::sc_time t; 13912922Sgabeblack@google.com 14012922Sgabeblack@google.com while (initTransaction(trans)) { 14112922Sgabeblack@google.com // Create transaction and initialise phase and t 14212922Sgabeblack@google.com phase = tlm::BEGIN_REQ; 14312922Sgabeblack@google.com t = sc_core::SC_ZERO_TIME; 14412922Sgabeblack@google.com 14512922Sgabeblack@google.com logStartTransation(trans); 14612922Sgabeblack@google.com 14712922Sgabeblack@google.com /////////////////////////////////////////////////////////// 14812922Sgabeblack@google.com // DMI handling: 14912922Sgabeblack@google.com // We use the DMI hint to check if it makes sense to ask for 15012922Sgabeblack@google.com // DMI pointers. The pattern is: 15112922Sgabeblack@google.com // - if the address is covered by a DMI region do a DMI access 15212922Sgabeblack@google.com // - otherwise do a normal transaction 15312922Sgabeblack@google.com // -> check if we get a DMI hint and acquire the DMI pointers if it is 15412922Sgabeblack@google.com // set 15512922Sgabeblack@google.com /////////////////////////////////////////////////////////// 15612922Sgabeblack@google.com 15712922Sgabeblack@google.com // Check if the address is covered by our DMI region 15812922Sgabeblack@google.com if ( (trans.get_address() >= mDMIData.get_start_address()) && 15912922Sgabeblack@google.com (trans.get_address() <= mDMIData.get_end_address()) ) { 16012922Sgabeblack@google.com // We can handle the data here. As the logEndTransaction is assuming 16112922Sgabeblack@google.com // something to happen in the data structure, we really need to 16212922Sgabeblack@google.com // do this: 16312922Sgabeblack@google.com trans.set_response_status(tlm::TLM_OK_RESPONSE); 16412922Sgabeblack@google.com sc_dt::uint64 tmp = trans.get_address() - mDMIData.get_start_address(); 16512922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_WRITE_COMMAND) { 16612922Sgabeblack@google.com *(unsigned int*)&mDMIData.get_dmi_ptr()[tmp] = mData; 16712922Sgabeblack@google.com 16812922Sgabeblack@google.com } else { 16912922Sgabeblack@google.com mData = *(unsigned int*)&mDMIData.get_dmi_ptr()[tmp]; 17012922Sgabeblack@google.com } 17112922Sgabeblack@google.com 17212922Sgabeblack@google.com // Do the wait immediately. Note that doing the wait here eats almost 17312922Sgabeblack@google.com // all the performance anyway, so we only gain something if we're 17412922Sgabeblack@google.com // using temporal decoupling. 17512922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_WRITE_COMMAND) { 17612922Sgabeblack@google.com wait(mDMIData.get_write_latency()); 17712922Sgabeblack@google.com 17812922Sgabeblack@google.com } else { 17912922Sgabeblack@google.com wait(mDMIData.get_read_latency()); 18012922Sgabeblack@google.com } 18112922Sgabeblack@google.com 18212922Sgabeblack@google.com logEndTransaction(trans); 18312922Sgabeblack@google.com 18412922Sgabeblack@google.com } else { // we need a full transaction 18512922Sgabeblack@google.com sc_dt::uint64 addr = trans.get_address(); //Save address before it is mutated 18612922Sgabeblack@google.com socket->b_transport(trans, t); 18712922Sgabeblack@google.com wait(t); 18812922Sgabeblack@google.com logEndTransaction(trans); 18912922Sgabeblack@google.com 19012922Sgabeblack@google.com // Acquire DMI pointer on is available: 19112922Sgabeblack@google.com if (trans.is_dmi_allowed()) 19212922Sgabeblack@google.com { 19312922Sgabeblack@google.com dmi_type tmp; 19412922Sgabeblack@google.com tmp.init(); 19512922Sgabeblack@google.com trans.set_address(addr); //restore address, in case it was mutated. 19612922Sgabeblack@google.com trans.set_write(); 19712922Sgabeblack@google.com if ( socket->get_direct_mem_ptr(trans, tmp) 19812922Sgabeblack@google.com && tmp.is_write_allowed() ) 19912922Sgabeblack@google.com { 20012922Sgabeblack@google.com mDMIData = tmp; 20112922Sgabeblack@google.com } 20212922Sgabeblack@google.com } 20312922Sgabeblack@google.com } 20412922Sgabeblack@google.com } 20512922Sgabeblack@google.com wait(); 20612922Sgabeblack@google.com } 20712922Sgabeblack@google.com 20812922Sgabeblack@google.com sync_enum_type nb_transport_bw(transaction_type& trans, phase_type& phase, sc_core::sc_time& t) 20912922Sgabeblack@google.com { 21012922Sgabeblack@google.com // We should never be called 21112922Sgabeblack@google.com assert(0); 21212922Sgabeblack@google.com return tlm::TLM_COMPLETED; 21312922Sgabeblack@google.com } 21412922Sgabeblack@google.com 21512922Sgabeblack@google.com void invalidate(dmi_type& dmiData) 21612922Sgabeblack@google.com { 21712922Sgabeblack@google.com dmiData.set_start_address(1); 21812922Sgabeblack@google.com dmiData.set_end_address(0); 21912922Sgabeblack@google.com } 22012922Sgabeblack@google.com 22112922Sgabeblack@google.com // Invalidate DMI pointer(s) 22212922Sgabeblack@google.com void invalidate_direct_mem_ptr(sc_dt::uint64 start_range, 22312922Sgabeblack@google.com sc_dt::uint64 end_range) 22412922Sgabeblack@google.com { 22512922Sgabeblack@google.com // do the invalidation if there is an address range overlap 22612922Sgabeblack@google.com if (start_range <= mDMIData.get_end_address ()&& 22712922Sgabeblack@google.com end_range >= mDMIData.get_start_address()) { 22812922Sgabeblack@google.com std::cout << name() << ": got DMI pointer invalidation" 22912922Sgabeblack@google.com << " @ " << sc_core::sc_time_stamp() << std::endl; 23012922Sgabeblack@google.com 23112922Sgabeblack@google.com invalidate(mDMIData); 23212922Sgabeblack@google.com } else { 23312922Sgabeblack@google.com std::cout << name() << ": ignored DMI invalidation for addresses " 23412922Sgabeblack@google.com << std::hex << start_range << ", " 23512922Sgabeblack@google.com << end_range << std::dec 23612922Sgabeblack@google.com << " @ " << sc_core::sc_time_stamp() << std::endl; 23712922Sgabeblack@google.com } 23812922Sgabeblack@google.com } 23912922Sgabeblack@google.com 24012922Sgabeblack@google.com // Test for transport_dbg: 24112922Sgabeblack@google.com // FIXME: use a configurable address 24212922Sgabeblack@google.com void end_of_simulation() 24312922Sgabeblack@google.com { 24412922Sgabeblack@google.com std::cout << name() << ", <<SimpleLTInitiator1>>:" << std::endl 24512922Sgabeblack@google.com << std::endl; 24612922Sgabeblack@google.com unsigned char data[32]; 24712922Sgabeblack@google.com 24812922Sgabeblack@google.com transaction_type trans; 24912922Sgabeblack@google.com trans.set_address(mBaseAddress); 25012922Sgabeblack@google.com trans.set_data_length(32); 25112922Sgabeblack@google.com trans.set_data_ptr(data); 25212922Sgabeblack@google.com trans.set_read(); 25312922Sgabeblack@google.com 25412922Sgabeblack@google.com unsigned int n = socket->transport_dbg(trans); 25512922Sgabeblack@google.com 25612922Sgabeblack@google.com std::cout << "Mem @" << std::hex << mBaseAddress << std::endl; 25712922Sgabeblack@google.com unsigned int j = 0; 25812922Sgabeblack@google.com 25912922Sgabeblack@google.com if (n > 0) 26012922Sgabeblack@google.com { 26112922Sgabeblack@google.com // always align endianness, so that we don't get a diff when 26212922Sgabeblack@google.com // printing the raw data 26312922Sgabeblack@google.com int e_start = 0; 26412922Sgabeblack@google.com int e_end = 4; 26512922Sgabeblack@google.com int e_increment = 1; 26612922Sgabeblack@google.com if (!tlm::host_has_little_endianness()) 26712922Sgabeblack@google.com { 26812922Sgabeblack@google.com e_start = 3; 26912922Sgabeblack@google.com e_end = -1; 27012922Sgabeblack@google.com e_increment = -1; 27112922Sgabeblack@google.com } 27212922Sgabeblack@google.com 27312922Sgabeblack@google.com for (unsigned int i=0; i<n; i+=4) 27412922Sgabeblack@google.com { 27512922Sgabeblack@google.com for (int k=e_start; k!=e_end; k+=e_increment) 27612922Sgabeblack@google.com { 27712922Sgabeblack@google.com std::cout << std::setw(2) << std::setfill('0') 27812922Sgabeblack@google.com << (int)data[i+k]; 27912922Sgabeblack@google.com j++; 28012922Sgabeblack@google.com if (j==16) { 28112922Sgabeblack@google.com j=0; 28212922Sgabeblack@google.com std::cout << std::endl; 28312922Sgabeblack@google.com } else { 28412922Sgabeblack@google.com std::cout << " "; 28512922Sgabeblack@google.com } 28612922Sgabeblack@google.com } 28712922Sgabeblack@google.com } 28812922Sgabeblack@google.com } 28912922Sgabeblack@google.com else 29012922Sgabeblack@google.com { 29112922Sgabeblack@google.com std::cout << "ERROR: debug transaction didn't give data." << std::endl; 29212922Sgabeblack@google.com } 29312922Sgabeblack@google.com std::cout << std::dec << std::endl; 29412922Sgabeblack@google.com } 29512922Sgabeblack@google.comprivate: 29612922Sgabeblack@google.com dmi_type mDMIData; 29712922Sgabeblack@google.com 29812922Sgabeblack@google.com sc_core::sc_event mEndEvent; 29912922Sgabeblack@google.com unsigned int mNrOfTransactions; 30012922Sgabeblack@google.com unsigned int mBaseAddress; 30112922Sgabeblack@google.com unsigned int mTransactionCount; 30212922Sgabeblack@google.com unsigned int mData; 30312922Sgabeblack@google.com}; 30412922Sgabeblack@google.com 30512922Sgabeblack@google.com#endif 306