gem5_to_tlm.hh revision 13821:f9252f27ded7
1/* 2 * Copyright 2019 Google, Inc. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: redistributions of source code must retain the above copyright 7 * notice, this list of conditions and the following disclaimer; 8 * redistributions in binary form must reproduce the above copyright 9 * notice, this list of conditions and the following disclaimer in the 10 * documentation and/or other materials provided with the distribution; 11 * neither the name of the copyright holders nor the names of its 12 * contributors may be used to endorse or promote products derived from 13 * this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 16 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 17 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 18 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 19 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 21 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 22 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 23 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 * 27 * Copyright (c) 2015, University of Kaiserslautern 28 * Copyright (c) 2016, Dresden University of Technology (TU Dresden) 29 * All rights reserved. 30 * 31 * Redistribution and use in source and binary forms, with or without 32 * modification, are permitted provided that the following conditions are 33 * met: 34 * 35 * 1. Redistributions of source code must retain the above copyright notice, 36 * this list of conditions and the following disclaimer. 37 * 38 * 2. Redistributions in binary form must reproduce the above copyright 39 * notice, this list of conditions and the following disclaimer in the 40 * documentation and/or other materials provided with the distribution. 41 * 42 * 3. Neither the name of the copyright holder nor the names of its 43 * contributors may be used to endorse or promote products derived from 44 * this software without specific prior written permission. 45 * 46 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 47 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 48 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 49 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 50 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 51 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 52 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 53 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 54 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 55 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 56 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 57 * 58 * Authors: Gabe Black 59 * Matthias Jung 60 * Christian Menard 61 */ 62 63#ifndef __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__ 64#define __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__ 65 66#include <string> 67 68#include "mem/port.hh" 69#include "params/Gem5ToTlmBridge.hh" 70#include "sim/system.hh" 71#include "systemc/ext/core/sc_module.hh" 72#include "systemc/ext/core/sc_module_name.hh" 73#include "systemc/ext/tlm_core/2/generic_payload/gp.hh" 74#include "systemc/ext/tlm_utils/simple_initiator_socket.h" 75#include "systemc/tlm_bridge/sc_peq.hh" 76#include "systemc/tlm_port_wrapper.hh" 77 78namespace sc_gem5 79{ 80 81class Gem5ToTlmBridge : public sc_core::sc_module 82{ 83 private: 84 class BridgeSlavePort : public SlavePort 85 { 86 protected: 87 Gem5ToTlmBridge &bridge; 88 89 AddrRangeList 90 getAddrRanges() const override 91 { 92 return bridge.getAddrRanges(); 93 } 94 Tick 95 recvAtomic(PacketPtr pkt) override 96 { 97 return bridge.recvAtomic(pkt); 98 } 99 void 100 recvFunctional(PacketPtr pkt) override 101 { 102 return bridge.recvFunctional(pkt); 103 } 104 bool 105 recvTimingReq(PacketPtr pkt) override 106 { 107 return bridge.recvTimingReq(pkt); 108 } 109 bool 110 tryTiming(PacketPtr pkt) override 111 { 112 return bridge.tryTiming(pkt); 113 } 114 bool 115 recvTimingSnoopResp(PacketPtr pkt) override 116 { 117 return bridge.recvTimingSnoopResp(pkt); 118 } 119 void recvRespRetry() override { bridge.recvRespRetry(); } 120 121 public: 122 BridgeSlavePort(const std::string &name_, Gem5ToTlmBridge &bridge_) : 123 SlavePort(name_, nullptr), bridge(bridge_) 124 {} 125 }; 126 127 BridgeSlavePort bsp; 128 tlm_utils::simple_initiator_socket<Gem5ToTlmBridge, 64> socket; 129 sc_gem5::TlmInitiatorWrapper<64> wrapper; 130 131 System *system; 132 133 /** 134 * A transaction after BEGIN_REQ has been sent but before END_REQ, which 135 * is blocking the request channel (Exlusion Rule, see IEEE1666) 136 */ 137 tlm::tlm_generic_payload *blockingRequest; 138 139 /** 140 * Did another gem5 request arrive while currently blocked? 141 * This variable is needed when a retry should happen 142 */ 143 bool needToSendRequestRetry; 144 145 /** 146 * A response which has been asked to retry by gem5 and so is blocking 147 * the response channel 148 */ 149 tlm::tlm_generic_payload *blockingResponse; 150 151 AddrRangeList addrRanges; 152 153 protected: 154 void pec(Gem5SystemC::PayloadEvent<Gem5ToTlmBridge> *pe, 155 tlm::tlm_generic_payload &trans, const tlm::tlm_phase &phase); 156 157 // The gem5 port interface. 158 Tick recvAtomic(PacketPtr packet); 159 void recvFunctional(PacketPtr packet); 160 bool recvTimingReq(PacketPtr packet); 161 bool tryTiming(PacketPtr packet); 162 bool recvTimingSnoopResp(PacketPtr packet); 163 void recvRespRetry(); 164 void recvFunctionalSnoop(PacketPtr packet); 165 AddrRangeList getAddrRanges() const { return addrRanges; } 166 167 // The TLM initiator interface. 168 tlm::tlm_sync_enum nb_transport_bw(tlm::tlm_generic_payload &trans, 169 tlm::tlm_phase &phase, 170 sc_core::sc_time &t); 171 172 public: 173 ::Port &gem5_getPort(const std::string &if_name, int idx=-1) override; 174 175 typedef Gem5ToTlmBridgeParams Params; 176 Gem5ToTlmBridge(Params *p, const sc_core::sc_module_name &mn); 177 178 tlm_utils::simple_initiator_socket<Gem5ToTlmBridge, 64> & 179 getSocket() 180 { 181 return socket; 182 } 183 184 void before_end_of_elaboration() override; 185}; 186 187} // namespace sc_gem5 188 189#endif // __SYSTEMC_TLM_BRIDGE_GEM5_TO_TLM_HH__ 190