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_INITIATOR3_DMI_H__ 3312922Sgabeblack@google.com#define __SIMPLE_LT_INITIATOR3_DMI_H__ 3412922Sgabeblack@google.com 3512922Sgabeblack@google.com#include "tlm.h" 3612922Sgabeblack@google.com#include "tlm_utils/simple_initiator_socket.h" 3712922Sgabeblack@google.com#include <systemc> 3812922Sgabeblack@google.com#include <cassert> 3912922Sgabeblack@google.com#include <iostream> 4012922Sgabeblack@google.com#include <map> 4112922Sgabeblack@google.com 4212922Sgabeblack@google.comclass SimpleLTInitiator3_dmi : public sc_core::sc_module 4312922Sgabeblack@google.com{ 4412922Sgabeblack@google.compublic: 4512922Sgabeblack@google.com typedef tlm::tlm_generic_payload transaction_type; 4612922Sgabeblack@google.com typedef tlm::tlm_dmi dmi_type; 4712922Sgabeblack@google.com typedef tlm::tlm_phase phase_type; 4812922Sgabeblack@google.com typedef tlm::tlm_sync_enum sync_enum_type; 4912922Sgabeblack@google.com typedef tlm_utils::simple_initiator_socket<SimpleLTInitiator3_dmi> initiator_socket_type; 5012922Sgabeblack@google.com 5112922Sgabeblack@google.compublic: 5212922Sgabeblack@google.com initiator_socket_type socket; 5312922Sgabeblack@google.com 5412922Sgabeblack@google.compublic: 5512922Sgabeblack@google.com SC_HAS_PROCESS(SimpleLTInitiator3_dmi); 5612922Sgabeblack@google.com SimpleLTInitiator3_dmi(sc_core::sc_module_name name, 5712922Sgabeblack@google.com unsigned int nrOfTransactions = 0x5, 5812922Sgabeblack@google.com unsigned int baseAddress = 0x0) : 5912922Sgabeblack@google.com sc_core::sc_module(name), 6012922Sgabeblack@google.com socket("socket"), 6112922Sgabeblack@google.com mNrOfTransactions(nrOfTransactions), 6212922Sgabeblack@google.com mBaseAddress(baseAddress), 6312922Sgabeblack@google.com mTransactionCount(0) 6412922Sgabeblack@google.com { 6512922Sgabeblack@google.com mDMIDataReads.first.set_start_address(1); 6612922Sgabeblack@google.com mDMIDataReads.first.set_end_address(0); 6712922Sgabeblack@google.com mDMIDataWrites.first.set_start_address(1); 6812922Sgabeblack@google.com mDMIDataWrites.first.set_end_address(0); 6912922Sgabeblack@google.com 7012922Sgabeblack@google.com socket.register_invalidate_direct_mem_ptr(this, &SimpleLTInitiator3_dmi::invalidate_direct_mem_ptr); 7112922Sgabeblack@google.com 7212922Sgabeblack@google.com // Initiator thread 7312922Sgabeblack@google.com SC_THREAD(run); 7412922Sgabeblack@google.com } 7512922Sgabeblack@google.com 7612922Sgabeblack@google.com bool initTransaction(transaction_type& trans) 7712922Sgabeblack@google.com { 7812922Sgabeblack@google.com if (mTransactionCount < mNrOfTransactions) { 7912922Sgabeblack@google.com trans.set_address(mBaseAddress + 4*mTransactionCount); 8012922Sgabeblack@google.com mData = mTransactionCount; 8112922Sgabeblack@google.com trans.set_command(tlm::TLM_WRITE_COMMAND); 8212922Sgabeblack@google.com 8312922Sgabeblack@google.com } else if (mTransactionCount < 2 * mNrOfTransactions) { 8412922Sgabeblack@google.com trans.set_address(mBaseAddress + 4*(mTransactionCount-mNrOfTransactions)); 8512922Sgabeblack@google.com mData = 0; 8612922Sgabeblack@google.com trans.set_command(tlm::TLM_READ_COMMAND); 8712922Sgabeblack@google.com 8812922Sgabeblack@google.com } else { 8912922Sgabeblack@google.com return false; 9012922Sgabeblack@google.com } 9112922Sgabeblack@google.com 9212922Sgabeblack@google.com trans.set_data_ptr(reinterpret_cast<unsigned char*>(&mData)); 9312922Sgabeblack@google.com trans.set_data_length(4); 9412922Sgabeblack@google.com trans.set_streaming_width(4); 9512922Sgabeblack@google.com trans.set_dmi_allowed(false); 9612922Sgabeblack@google.com trans.set_response_status(tlm::TLM_INCOMPLETE_RESPONSE); 9712922Sgabeblack@google.com 9812922Sgabeblack@google.com ++mTransactionCount; 9912922Sgabeblack@google.com return true; 10012922Sgabeblack@google.com } 10112922Sgabeblack@google.com 10212922Sgabeblack@google.com void logStartTransation(transaction_type& trans) 10312922Sgabeblack@google.com { 10412922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_WRITE_COMMAND) { 10512922Sgabeblack@google.com std::cout << name() << ": Send write request: A = 0x" 10612922Sgabeblack@google.com << std::hex << (unsigned int)trans.get_address() 10712922Sgabeblack@google.com << ", D = 0x" << mData << std::dec 10812922Sgabeblack@google.com << " @ " << sc_core::sc_time_stamp() << std::endl; 10912922Sgabeblack@google.com 11012922Sgabeblack@google.com } else { 11112922Sgabeblack@google.com std::cout << name() << ": Send read request: A = 0x" 11212922Sgabeblack@google.com << std::hex << (unsigned int)trans.get_address() << std::dec 11312922Sgabeblack@google.com << " @ " << sc_core::sc_time_stamp() << std::endl; 11412922Sgabeblack@google.com } 11512922Sgabeblack@google.com } 11612922Sgabeblack@google.com 11712922Sgabeblack@google.com void logEndTransaction(transaction_type& trans) 11812922Sgabeblack@google.com { 11912922Sgabeblack@google.com if (trans.get_response_status() != tlm::TLM_OK_RESPONSE) { 12012922Sgabeblack@google.com std::cout << name() << ": Received error response @ " 12112922Sgabeblack@google.com << sc_core::sc_time_stamp() << std::endl; 12212922Sgabeblack@google.com 12312922Sgabeblack@google.com } else { 12412922Sgabeblack@google.com std::cout << name() << ": Received ok response"; 12512922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_READ_COMMAND) { 12612922Sgabeblack@google.com std::cout << ": D = 0x" << std::hex << mData << std::dec; 12712922Sgabeblack@google.com } 12812922Sgabeblack@google.com std::cout << " @ " << sc_core::sc_time_stamp() << std::endl; 12912922Sgabeblack@google.com } 13012922Sgabeblack@google.com } 13112922Sgabeblack@google.com 13212922Sgabeblack@google.com std::pair<dmi_type, bool>& getDMIData(const transaction_type& trans) 13312922Sgabeblack@google.com { 13412922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_READ_COMMAND) { 13512922Sgabeblack@google.com return mDMIDataReads; 13612922Sgabeblack@google.com 13712922Sgabeblack@google.com } else { // WRITE 13812922Sgabeblack@google.com return mDMIDataWrites; 13912922Sgabeblack@google.com } 14012922Sgabeblack@google.com } 14112922Sgabeblack@google.com 14212922Sgabeblack@google.com void run() 14312922Sgabeblack@google.com { 14412922Sgabeblack@google.com transaction_type trans; 14512922Sgabeblack@google.com sc_core::sc_time t; 14612922Sgabeblack@google.com 14712922Sgabeblack@google.com while (initTransaction(trans)) { 14812922Sgabeblack@google.com // Create transaction and initialise t 14912922Sgabeblack@google.com t = sc_core::SC_ZERO_TIME; 15012922Sgabeblack@google.com 15112922Sgabeblack@google.com logStartTransation(trans); 15212922Sgabeblack@google.com 15312922Sgabeblack@google.com /////////////////////////////////////////////////////////// 15412922Sgabeblack@google.com // DMI handling: 15512922Sgabeblack@google.com // We do *not* use the DMI hint to check if it makes sense to ask for 15612922Sgabeblack@google.com // DMI pointers. So the pattern is: 15712922Sgabeblack@google.com // - if the address is not covered by a DMI region try to acquire DMI 15812922Sgabeblack@google.com // pointers 15912922Sgabeblack@google.com // - if we have a DMI pointer, do the DMI "transaction" 16012922Sgabeblack@google.com // - otherwise fall back to a normal transaction 16112922Sgabeblack@google.com /////////////////////////////////////////////////////////// 16212922Sgabeblack@google.com 16312922Sgabeblack@google.com std::pair<dmi_type, bool>& dmi_data = getDMIData(trans); 16412922Sgabeblack@google.com 16512922Sgabeblack@google.com // Check if we need to acquire a DMI pointer 16612922Sgabeblack@google.com if((trans.get_address() < dmi_data.first.get_start_address()) || 16712922Sgabeblack@google.com (trans.get_address() > dmi_data.first.get_end_address()) ) 16812922Sgabeblack@google.com { 16912922Sgabeblack@google.com sc_dt::uint64 address = trans.get_address(); //save original address 17012922Sgabeblack@google.com dmi_data.second = 17112922Sgabeblack@google.com socket->get_direct_mem_ptr(trans, 17212922Sgabeblack@google.com dmi_data.first); 17312922Sgabeblack@google.com trans.set_address(address); 17412922Sgabeblack@google.com } 17512922Sgabeblack@google.com // Do DMI "transaction" if we have a valid region 17612922Sgabeblack@google.com if (dmi_data.second && 17712922Sgabeblack@google.com (trans.get_address() >= dmi_data.first.get_start_address()) && 17812922Sgabeblack@google.com (trans.get_address() <= dmi_data.first.get_end_address()) ) 17912922Sgabeblack@google.com { 18012922Sgabeblack@google.com // We can handle the data here. As the logEndTransaction is assuming 18112922Sgabeblack@google.com // something to happen in the data structure, we really need to 18212922Sgabeblack@google.com // do this: 18312922Sgabeblack@google.com trans.set_response_status(tlm::TLM_OK_RESPONSE); 18412922Sgabeblack@google.com 18512922Sgabeblack@google.com sc_dt::uint64 tmp = trans.get_address() - dmi_data.first.get_start_address(); 18612922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_WRITE_COMMAND) 18712922Sgabeblack@google.com { 18812922Sgabeblack@google.com *(unsigned int*)&dmi_data.first.get_dmi_ptr()[tmp] = mData; 18912922Sgabeblack@google.com } 19012922Sgabeblack@google.com else 19112922Sgabeblack@google.com { 19212922Sgabeblack@google.com mData = *(unsigned int*)&dmi_data.first.get_dmi_ptr()[tmp]; 19312922Sgabeblack@google.com } 19412922Sgabeblack@google.com 19512922Sgabeblack@google.com // Do the wait immediately. Note that doing the wait here eats almost 19612922Sgabeblack@google.com // all the performance anyway, so we only gain something if we're 19712922Sgabeblack@google.com // using temporal decoupling. 19812922Sgabeblack@google.com if (trans.get_command() == tlm::TLM_WRITE_COMMAND) { 19912922Sgabeblack@google.com wait(dmi_data.first.get_write_latency()); 20012922Sgabeblack@google.com 20112922Sgabeblack@google.com } else { 20212922Sgabeblack@google.com wait(dmi_data.first.get_read_latency()); 20312922Sgabeblack@google.com } 20412922Sgabeblack@google.com } 20512922Sgabeblack@google.com else // we need a full transaction 20612922Sgabeblack@google.com { 20712922Sgabeblack@google.com socket->b_transport(trans, t); 20812922Sgabeblack@google.com // wait for the returned delay 20912922Sgabeblack@google.com wait(t); 21012922Sgabeblack@google.com } 21112922Sgabeblack@google.com 21212922Sgabeblack@google.com logEndTransaction(trans); 21312922Sgabeblack@google.com } 21412922Sgabeblack@google.com wait(); 21512922Sgabeblack@google.com 21612922Sgabeblack@google.com } 21712922Sgabeblack@google.com 21812922Sgabeblack@google.com // Invalidate DMI pointer(s) 21912922Sgabeblack@google.com void invalidate_direct_mem_ptr(sc_dt::uint64 start_range, 22012922Sgabeblack@google.com sc_dt::uint64 end_range) 22112922Sgabeblack@google.com { 22212922Sgabeblack@google.com // FIXME: probably faster to always invalidate everything? 22312922Sgabeblack@google.com if (start_range <= mDMIDataReads.first.get_end_address ()&& 22412922Sgabeblack@google.com end_range >= mDMIDataReads.first.get_start_address()) { 22512922Sgabeblack@google.com mDMIDataReads.second = false; 22612922Sgabeblack@google.com } 22712922Sgabeblack@google.com if (start_range <= mDMIDataWrites.first.get_end_address ()&& 22812922Sgabeblack@google.com end_range >= mDMIDataWrites.first.get_start_address()) { 22912922Sgabeblack@google.com mDMIDataWrites.second = false; 23012922Sgabeblack@google.com } 23112922Sgabeblack@google.com } 23212922Sgabeblack@google.com 23312922Sgabeblack@google.comprivate: 23412922Sgabeblack@google.com std::pair<dmi_type, bool> mDMIDataReads; 23512922Sgabeblack@google.com std::pair<dmi_type, bool> mDMIDataWrites; 23612922Sgabeblack@google.com 23712922Sgabeblack@google.com sc_core::sc_event mEndEvent; 23812922Sgabeblack@google.com unsigned int mNrOfTransactions; 23912922Sgabeblack@google.com unsigned int mBaseAddress; 24012922Sgabeblack@google.com unsigned int mTransactionCount; 24112922Sgabeblack@google.com unsigned int mData; 24212922Sgabeblack@google.com}; 24312922Sgabeblack@google.com 24412922Sgabeblack@google.com#endif 245