gem5  v22.0.0.2
tlm_to_gem5.hh
Go to the documentation of this file.
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) 2016, Dresden University of Technology (TU Dresden)
28  * All rights reserved.
29  *
30  * Redistribution and use in source and binary forms, with or without
31  * modification, are permitted provided that the following conditions are
32  * met:
33  *
34  * 1. Redistributions of source code must retain the above copyright notice,
35  * this list of conditions and the following disclaimer.
36  *
37  * 2. Redistributions in binary form must reproduce the above copyright
38  * notice, this list of conditions and the following disclaimer in the
39  * documentation and/or other materials provided with the distribution.
40  *
41  * 3. Neither the name of the copyright holder nor the names of its
42  * contributors may be used to endorse or promote products derived from
43  * this software without specific prior written permission.
44  *
45  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
46  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
47  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
48  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
49  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
50  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
51  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
52  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
53  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
54  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
55  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
56  */
57 
58 #ifndef __SYSTEMC_TLM_BRIDGE_TLM_TO_GEM5_HH__
59 #define __SYSTEMC_TLM_BRIDGE_TLM_TO_GEM5_HH__
60 
61 #include <functional>
62 
63 #include "mem/port.hh"
64 #include "params/TlmToGem5BridgeBase.hh"
72 
73 namespace sc_gem5
74 {
75 
77  std::function<void(gem5::PacketPtr pkt, tlm::tlm_generic_payload &trans)>;
78 
80 
83 
85 {
86  protected:
88 };
89 
90 template <unsigned int BITWIDTH>
92 {
93  private:
95  {
98  };
99 
101  {
102  protected:
104 
105  bool
107  {
108  return bridge.recvTimingResp(pkt);
109  }
110  void recvReqRetry() override { bridge.recvReqRetry(); }
111  void recvRangeChange() override { bridge.recvRangeChange(); }
112 
113  public:
114  BridgeRequestPort(const std::string &name_,
115  TlmToGem5Bridge<BITWIDTH> &bridge_) :
116  RequestPort(name_, nullptr), bridge(bridge_)
117  {}
118  };
119 
121 
125 
127 
129 
134 
136 
139  sc_core::sc_time &delay);
140 
143 
144  void destroyPacket(gem5::PacketPtr pkt);
145 
147 
148  void invalidateDmi(const gem5::MemBackdoor &backdoor);
149 
150  protected:
151  // payload event call back
152  void peq_cb(tlm::tlm_generic_payload &trans, const tlm::tlm_phase &phase);
153 
154  // The TLM target interface
156  tlm::tlm_phase &phase,
159  unsigned int transport_dbg(tlm::tlm_generic_payload &trans);
161  tlm::tlm_dmi &dmi_data);
162 
163  // Gem5 port interface.
165  void recvReqRetry();
166  void recvRangeChange();
167 
168  public:
169  gem5::Port &gem5_getPort(const std::string &if_name, int idx=-1) override;
170 
171  typedef gem5::TlmToGem5BridgeBaseParams Params;
172  TlmToGem5Bridge(const Params &p, const sc_core::sc_module_name &mn);
173 
176  {
177  return socket;
178  }
179 
180  void before_end_of_elaboration() override;
181 
183 };
184 
185 } // namespace sc_gem5
186 
187 #endif // __SYSTEMC_TLM_BRIDGE_TLM_TO_GEM5_HH__
sc_gem5::TlmToGem5Bridge::TlmSenderState::trans
tlm::tlm_generic_payload & trans
Definition: tlm_to_gem5.hh:96
sc_gem5::TlmToGem5Bridge::BridgeRequestPort::bridge
TlmToGem5Bridge< BITWIDTH > & bridge
Definition: tlm_to_gem5.hh:103
sc_gem5::TlmToGem5Bridge::system
gem5::System * system
Definition: tlm_to_gem5.hh:135
sc_gem5::payload2packet
PacketPtr payload2packet(RequestorID _id, tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.cc:99
sc_gem5::TlmToGem5Bridge::pendingPacket
gem5::PacketPtr pendingPacket
Definition: tlm_to_gem5.hh:124
sc_gem5::TlmToGem5Bridge::recvRangeChange
void recvRangeChange()
Definition: tlm_to_gem5.cc:507
sc_gem5::TlmToGem5Bridge::_id
const gem5::RequestorID _id
Definition: tlm_to_gem5.hh:182
sc_core::sc_module
Definition: sc_module.hh:101
sc_gem5::TlmToGem5Bridge::BridgeRequestPort
Definition: tlm_to_gem5.hh:100
tlm::tlm_phase
Definition: phase.hh:47
sc_gem5::TlmToGem5Bridge::pendingRequest
tlm::tlm_generic_payload * pendingRequest
Definition: tlm_to_gem5.hh:123
peq_with_cb_and_phase.h
sc_gem5::TlmToGem5Bridge::peq
tlm_utils::peq_with_cb_and_phase< TlmToGem5Bridge< BITWIDTH > > peq
Definition: tlm_to_gem5.hh:120
sc_module_name.hh
tlm::tlm_dmi
Definition: dmi.hh:46
gem5::RequestPort::RequestPort
RequestPort(const std::string &name, SimObject *_owner, PortID id=InvalidPortID)
Request port.
Definition: port.cc:117
sc_gem5::TlmToGem5Bridge::destroyPacket
void destroyPacket(gem5::PacketPtr pkt)
Definition: tlm_to_gem5.cc:251
sc_ext.hh
sc_gem5::TlmToGem5Bridge::recvTimingResp
bool recvTimingResp(gem5::PacketPtr pkt)
Definition: tlm_to_gem5.cc:434
sc_core::sc_module::sc_module
sc_module()
Definition: sc_module.cc:256
sc_gem5::TlmToGem5Bridge::BridgeRequestPort::BridgeRequestPort
BridgeRequestPort(const std::string &name_, TlmToGem5Bridge< BITWIDTH > &bridge_)
Definition: tlm_to_gem5.hh:114
sc_gem5::TlmToGem5Bridge::TlmToGem5Bridge
TlmToGem5Bridge(const Params &p, const sc_core::sc_module_name &mn)
Definition: tlm_to_gem5.cc:526
sc_gem5::TlmToGem5Bridge::bmp
BridgeRequestPort bmp
Definition: tlm_to_gem5.hh:130
sc_gem5::TlmToGem5Bridge::recvReqRetry
void recvReqRetry()
Definition: tlm_to_gem5.cc:480
sc_gem5::TlmToGem5Bridge::responseInProgress
bool responseInProgress
Definition: tlm_to_gem5.hh:128
gem5::RequestPort
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:77
sc_gem5::TlmToGem5Bridge::nb_transport_fw
tlm::tlm_sync_enum nb_transport_fw(tlm::tlm_generic_payload &trans, tlm::tlm_phase &phase, sc_core::sc_time &t)
Definition: tlm_to_gem5.cc:295
sc_gem5::TlmToGem5Bridge::BridgeRequestPort::recvTimingResp
bool recvTimingResp(gem5::PacketPtr pkt) override
Receive a timing response from the peer.
Definition: tlm_to_gem5.hh:106
gem5::System
Definition: system.hh:75
gem5::VegaISA::t
Bitfield< 51 > t
Definition: pagetable.hh:56
gem5::VegaISA::p
Bitfield< 54 > p
Definition: pagetable.hh:70
sc_gem5::TlmToGem5BridgeBase
Definition: tlm_to_gem5.hh:84
sc_gem5::TlmToGem5Bridge::before_end_of_elaboration
void before_end_of_elaboration() override
Definition: tlm_to_gem5.cc:541
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:291
sc_gem5::TlmToGem5Bridge::wrapper
sc_gem5::TlmTargetWrapper< BITWIDTH > wrapper
Definition: tlm_to_gem5.hh:133
sc_core::sc_time
Definition: sc_time.hh:49
sc_gem5::TlmToGem5Bridge::sendEndReq
void sendEndReq(tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.cc:156
sc_gem5::TlmToGem5Bridge::TlmSenderState
Definition: tlm_to_gem5.hh:94
port.hh
sc_core::sc_module_name
Definition: sc_module_name.hh:41
sc_gem5::TlmToGem5Bridge::getSocket
tlm_utils::simple_target_socket< TlmToGem5Bridge< BITWIDTH >, BITWIDTH > & getSocket()
Definition: tlm_to_gem5.hh:175
sc_gem5::TlmToGem5Bridge::sendBeginResp
void sendBeginResp(tlm::tlm_generic_payload &trans, sc_core::sc_time &delay)
Definition: tlm_to_gem5.cc:168
gem5::Packet::SenderState
A virtual base opaque structure used to hold state associated with the packet (e.g....
Definition: packet.hh:465
sc_gem5::TlmToGem5Bridge::checkTransaction
void checkTransaction(tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.cc:258
tlm_utils::simple_target_socket
Definition: simple_target_socket.h:605
tlm_utils::peq_with_cb_and_phase
An event queue that can contain any number of pending notifications.
Definition: peq_with_cb_and_phase.h:152
gem5::MemBackdoor
Definition: backdoor.hh:41
sc_module.hh
sc_gem5::addPayloadToPacketConversionStep
void addPayloadToPacketConversionStep(PayloadToPacketConversionStep step)
Notify the Tlm2Gem5 bridge that we need an extra step to properly convert a tlm payload to gem5 packe...
Definition: tlm_to_gem5.cc:93
sc_gem5::TlmToGem5Bridge::Params
gem5::TlmToGem5BridgeBaseParams Params
Definition: tlm_to_gem5.hh:171
sc_gem5::TlmToGem5Bridge::handleBeginReq
void handleBeginReq(tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.cc:191
sc_gem5::TlmToGem5Bridge::b_transport
void b_transport(tlm::tlm_generic_payload &trans, sc_core::sc_time &t)
Definition: tlm_to_gem5.cc:321
sc_gem5::TlmToGem5Bridge::TlmSenderState::TlmSenderState
TlmSenderState(tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.hh:97
sc_gem5::TlmToGem5Bridge::BridgeRequestPort::recvReqRetry
void recvReqRetry() override
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
Definition: tlm_to_gem5.hh:110
sc_gem5::PayloadToPacketConversionStep
std::function< void(gem5::PacketPtr pkt, tlm::tlm_generic_payload &trans)> PayloadToPacketConversionStep
Definition: tlm_to_gem5.hh:77
sc_gem5::TlmToGem5Bridge::gem5_getPort
gem5::Port & gem5_getPort(const std::string &if_name, int idx=-1) override
Definition: tlm_to_gem5.cc:515
tlm::tlm_generic_payload
Definition: gp.hh:133
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
sc_gem5::TlmToGem5Bridge
Definition: tlm_to_gem5.hh:91
tlm::tlm_sync_enum
tlm_sync_enum
Definition: fw_bw_ifs.hh:48
tlm_port_wrapper.hh
sc_gem5::TlmToGem5Bridge::handleEndResp
void handleEndResp(tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.cc:235
sc_gem5
Definition: sc_clock.cc:41
gem5::RequestorID
uint16_t RequestorID
Definition: request.hh:95
sc_gem5::TlmToGem5Bridge::transport_dbg
unsigned int transport_dbg(tlm::tlm_generic_payload &trans)
Definition: tlm_to_gem5.cc:361
sc_gem5::TlmToGem5Bridge::socket
tlm_utils::simple_target_socket< TlmToGem5Bridge< BITWIDTH >, BITWIDTH > socket
Definition: tlm_to_gem5.hh:132
sc_gem5::TlmToGem5Bridge::BridgeRequestPort::recvRangeChange
void recvRangeChange() override
Called to receive an address range change from the peer response port.
Definition: tlm_to_gem5.hh:111
sc_gem5::TlmToGem5Bridge::needToSendRetry
bool needToSendRetry
Definition: tlm_to_gem5.hh:126
sc_gem5::TlmTargetBaseWrapper
Definition: tlm_port_wrapper.hh:44
sc_gem5::TlmToGem5Bridge::get_direct_mem_ptr
bool get_direct_mem_ptr(tlm::tlm_generic_payload &trans, tlm::tlm_dmi &dmi_data)
Definition: tlm_to_gem5.cc:383
sc_gem5::TlmToGem5Bridge::peq_cb
void peq_cb(tlm::tlm_generic_payload &trans, const tlm::tlm_phase &phase)
Definition: tlm_to_gem5.cc:278
sc_gem5::TlmToGem5Bridge::invalidateDmi
void invalidateDmi(const gem5::MemBackdoor &backdoor)
Definition: tlm_to_gem5.cc:270
simple_target_socket.h
gp.hh
sc_gem5::TlmToGem5Bridge::waitForRetry
bool waitForRetry
Definition: tlm_to_gem5.hh:122

Generated on Thu Jul 28 2022 13:32:43 for gem5 by doxygen 1.8.17