gem5  v21.1.0.2
bridge.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2013 ARM Limited
3  * All rights reserved
4  *
5  * The license below extends only to copyright in the software and shall
6  * not be construed as granting a license to any other intellectual
7  * property including but not limited to intellectual property relating
8  * to a hardware implementation of the functionality of the software
9  * licensed hereunder. You may use the software subject to the license
10  * terms below provided that you ensure that this notice is replicated
11  * unmodified and in its entirety in all distributions of the software,
12  * modified or unmodified, in source code or in binary form.
13  *
14  * Copyright (c) 2006 The Regents of The University of Michigan
15  * All rights reserved.
16  *
17  * Redistribution and use in source and binary forms, with or without
18  * modification, are permitted provided that the following conditions are
19  * met: redistributions of source code must retain the above copyright
20  * notice, this list of conditions and the following disclaimer;
21  * redistributions in binary form must reproduce the above copyright
22  * notice, this list of conditions and the following disclaimer in the
23  * documentation and/or other materials provided with the distribution;
24  * neither the name of the copyright holders nor the names of its
25  * contributors may be used to endorse or promote products derived from
26  * this software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
40 
47 #ifndef __MEM_BRIDGE_HH__
48 #define __MEM_BRIDGE_HH__
49 
50 #include <deque>
51 
52 #include "base/types.hh"
53 #include "mem/port.hh"
54 #include "params/Bridge.hh"
55 #include "sim/clocked_object.hh"
56 
57 namespace gem5
58 {
59 
73 class Bridge : public ClockedObject
74 {
75  protected:
76 
82  {
83 
84  public:
85 
86  const Tick tick;
87  const PacketPtr pkt;
88 
89  DeferredPacket(PacketPtr _pkt, Tick _tick) : tick(_tick), pkt(_pkt)
90  { }
91  };
92 
93  // Forward declaration to allow the response port to have a pointer
94  class BridgeRequestPort;
95 
103  {
104 
105  private:
106 
109 
114 
116  const Cycles delay;
117 
120 
128 
130  unsigned int outstandingResponses;
131 
133  bool retryReq;
134 
136  unsigned int respQueueLimit;
137 
142  std::unique_ptr<Packet> pendingDelete;
143 
149  bool respQueueFull() const;
150 
156  void trySendTiming();
157 
160 
161  public:
162 
174  BridgeResponsePort(const std::string& _name, Bridge& _bridge,
175  BridgeRequestPort& _memSidePort, Cycles _delay,
176  int _resp_limit, std::vector<AddrRange> _ranges);
177 
185  void schedTimingResp(PacketPtr pkt, Tick when);
186 
192  void retryStalledReq();
193 
194  protected:
195 
198  bool recvTimingReq(PacketPtr pkt);
199 
202  void recvRespRetry();
203 
207 
210  void recvFunctional(PacketPtr pkt);
211 
215  };
216 
217 
224  {
225 
226  private:
227 
230 
235 
237  const Cycles delay;
238 
246 
248  const unsigned int reqQueueLimit;
249 
255  void trySendTiming();
256 
259 
260  public:
261 
272  BridgeRequestPort(const std::string& _name, Bridge& _bridge,
273  BridgeResponsePort& _cpuSidePort, Cycles _delay,
274  int _req_limit);
275 
281  bool reqQueueFull() const;
282 
290  void schedTimingReq(PacketPtr pkt, Tick when);
291 
301 
302  protected:
303 
306  bool recvTimingResp(PacketPtr pkt);
307 
310  void recvReqRetry();
311  };
312 
315 
318 
319  public:
320 
321  Port &getPort(const std::string &if_name,
322  PortID idx=InvalidPortID) override;
323 
324  void init() override;
325 
326  typedef BridgeParams Params;
327 
328  Bridge(const Params &p);
329 };
330 
331 } // namespace gem5
332 
333 #endif //__MEM_BRIDGE_HH__
gem5::Bridge::cpuSidePort
BridgeResponsePort cpuSidePort
Response port of the bridge.
Definition: bridge.hh:314
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::Bridge::BridgeRequestPort::transmitList
std::deque< DeferredPacket > transmitList
Request packet queue.
Definition: bridge.hh:245
gem5::Bridge::BridgeResponsePort::pendingDelete
std::unique_ptr< Packet > pendingDelete
Upstream caches need this packet until true is returned, so hold it for deletion until a subsequent c...
Definition: bridge.hh:142
gem5::Bridge::BridgeResponsePort::retryStalledReq
void retryStalledReq()
Retry any stalled request that we have failed to accept at an earlier point in time.
Definition: bridge.cc:207
gem5::Bridge::BridgeResponsePort::delay
const Cycles delay
Minimum request delay though this bridge.
Definition: bridge.hh:116
gem5::Bridge::BridgeResponsePort::schedTimingResp
void schedTimingResp(PacketPtr pkt, Tick when)
Queue a response packet to be sent out later and also schedule a send if necessary.
Definition: bridge.cc:234
gem5::Bridge::BridgeRequestPort::BridgeRequestPort
BridgeRequestPort(const std::string &_name, Bridge &_bridge, BridgeResponsePort &_cpuSidePort, Cycles _delay, int _req_limit)
Constructor for the BridgeRequestPort.
Definition: bridge.cc:69
gem5::Bridge::DeferredPacket::DeferredPacket
DeferredPacket(PacketPtr _pkt, Tick _tick)
Definition: bridge.hh:89
gem5::Bridge::BridgeResponsePort::recvAtomic
Tick recvAtomic(PacketPtr pkt)
When receiving a Atomic requestfrom the peer port, pass it to the bridge.
Definition: bridge.cc:342
std::vector
STL vector class.
Definition: stl.hh:37
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::Bridge::Params
BridgeParams Params
Definition: bridge.hh:326
gem5::Bridge::DeferredPacket::pkt
const PacketPtr pkt
Definition: bridge.hh:87
gem5::Bridge::BridgeRequestPort
Port on the side that forwards requests and receives responses.
Definition: bridge.hh:223
gem5::Bridge::BridgeResponsePort::BridgeResponsePort
BridgeResponsePort(const std::string &_name, Bridge &_bridge, BridgeRequestPort &_memSidePort, Cycles _delay, int _resp_limit, std::vector< AddrRange > _ranges)
Constructor for the BridgeResponsePort.
Definition: bridge.cc:56
gem5::Bridge::BridgeResponsePort::getAddrRanges
AddrRangeList getAddrRanges() const
When receiving a address range request the peer port, pass it to the bridge.
Definition: bridge.cc:392
gem5::RequestPort
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:77
gem5::Cycles
Cycles is a wrapper class for representing cycle counts, i.e.
Definition: types.hh:78
gem5::Bridge::BridgeResponsePort::recvTimingReq
bool recvTimingReq(PacketPtr pkt)
When receiving a timing request from the peer port, pass it to the bridge.
Definition: bridge.cc:147
gem5::Bridge::BridgeRequestPort::trySatisfyFunctional
bool trySatisfyFunctional(PacketPtr pkt)
Check a functional request against the packets in our request queue.
Definition: bridge.cc:375
gem5::Bridge::BridgeResponsePort::trySendTiming
void trySendTiming()
Handle send event, scheduled when the packet at the head of the response queue is ready to transmit (...
Definition: bridge.cc:286
gem5::Bridge
A bridge is used to interface two different crossbars (or in general a memory-mapped requestor and re...
Definition: bridge.hh:73
gem5::Bridge::BridgeResponsePort::recvFunctional
void recvFunctional(PacketPtr pkt)
When receiving a Functional request from the peer port, pass it to the bridge.
Definition: bridge.cc:351
gem5::Bridge::BridgeResponsePort::retryReq
bool retryReq
If we should send a retry when space becomes available.
Definition: bridge.hh:133
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::Bridge::BridgeRequestPort::recvTimingResp
bool recvTimingResp(PacketPtr pkt)
When receiving a timing request from the peer port, pass it to the bridge.
Definition: bridge.cc:125
gem5::Bridge::BridgeRequestPort::cpuSidePort
BridgeResponsePort & cpuSidePort
The response port on the other side of the bridge.
Definition: bridge.hh:234
port.hh
gem5::Bridge::init
void init() override
init() is called after all C++ SimObjects have been created and all ports are connected.
Definition: bridge.cc:102
gem5::Bridge::BridgeResponsePort
The port on the side that receives requests and sends responses.
Definition: bridge.hh:102
gem5::Bridge::BridgeResponsePort::outstandingResponses
unsigned int outstandingResponses
Counter to track the outstanding responses.
Definition: bridge.hh:130
gem5::Bridge::BridgeResponsePort::respQueueLimit
unsigned int respQueueLimit
Max queue size for reserved responses.
Definition: bridge.hh:136
gem5::Bridge::BridgeResponsePort::transmitList
std::deque< DeferredPacket > transmitList
Response packet queue.
Definition: bridge.hh:127
gem5::ClockedObject
The ClockedObject class extends the SimObject with a clock and accessor functions to relate ticks to ...
Definition: clocked_object.hh:234
gem5::Bridge::BridgeResponsePort::bridge
Bridge & bridge
The bridge to which this port belongs.
Definition: bridge.hh:108
gem5::Bridge::DeferredPacket::tick
const Tick tick
Definition: bridge.hh:86
gem5::EventFunctionWrapper
Definition: eventq.hh:1115
gem5::ResponsePort
A ResponsePort is a specialization of a port.
Definition: port.hh:268
gem5::Bridge::BridgeRequestPort::sendEvent
EventFunctionWrapper sendEvent
Send event for the request queue.
Definition: bridge.hh:258
gem5::Bridge::memSidePort
BridgeRequestPort memSidePort
Request port of the bridge.
Definition: bridge.hh:317
gem5::Bridge::BridgeRequestPort::delay
const Cycles delay
Minimum delay though this bridge.
Definition: bridge.hh:237
gem5::Bridge::BridgeRequestPort::reqQueueLimit
const unsigned int reqQueueLimit
Max queue size for request packets.
Definition: bridge.hh:248
gem5::Bridge::BridgeResponsePort::recvRespRetry
void recvRespRetry()
When receiving a retry request from the peer port, pass it to the bridge.
Definition: bridge.cc:336
gem5::Port
Ports are used to interface objects to each other.
Definition: port.hh:61
gem5::Bridge::BridgeResponsePort::sendEvent
EventFunctionWrapper sendEvent
Send event for the response queue.
Definition: bridge.hh:159
gem5::Bridge::BridgeRequestPort::schedTimingReq
void schedTimingReq(PacketPtr pkt, Tick when)
Queue a request packet to be sent out later and also schedule a send if necessary.
Definition: bridge.cc:217
types.hh
clocked_object.hh
std::deque
STL deque class.
Definition: stl.hh:44
gem5::Bridge::BridgeResponsePort::ranges
const AddrRangeList ranges
Address ranges to pass through the bridge.
Definition: bridge.hh:119
gem5::Bridge::DeferredPacket
A deferred packet stores a packet along with its scheduled transmission time.
Definition: bridge.hh:81
gem5::Bridge::Bridge
Bridge(const Params &p)
Definition: bridge.cc:80
gem5::Bridge::BridgeRequestPort::trySendTiming
void trySendTiming()
Handle send event, scheduled when the packet at the head of the outbound queue is ready to transmit (...
Definition: bridge.cc:248
std::list< AddrRange >
gem5::Bridge::BridgeRequestPort::bridge
Bridge & bridge
The bridge to which this port belongs.
Definition: bridge.hh:229
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::Bridge::BridgeResponsePort::respQueueFull
bool respQueueFull() const
Is this side blocked from accepting new response packets.
Definition: bridge.cc:113
gem5::Bridge::BridgeResponsePort::memSidePort
BridgeRequestPort & memSidePort
Request port on the other side of the bridge.
Definition: bridge.hh:113
gem5::Named::_name
const std::string _name
Definition: named.hh:41
gem5::Bridge::getPort
Port & getPort(const std::string &if_name, PortID idx=InvalidPortID) override
Get a port with a given name and index.
Definition: bridge.cc:90
gem5::Bridge::BridgeRequestPort::recvReqRetry
void recvReqRetry()
When receiving a retry request from the peer port, pass it to the bridge.
Definition: bridge.cc:330
gem5::Bridge::BridgeRequestPort::reqQueueFull
bool reqQueueFull() const
Is this side blocked from accepting new request packets.
Definition: bridge.cc:119

Generated on Tue Sep 21 2021 12:25:28 for gem5 by doxygen 1.8.17