gem5  v22.1.0.0
qport.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2012,2015 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  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions are
16  * met: redistributions of source code must retain the above copyright
17  * notice, this list of conditions and the following disclaimer;
18  * redistributions in binary form must reproduce the above copyright
19  * notice, this list of conditions and the following disclaimer in the
20  * documentation and/or other materials provided with the distribution;
21  * neither the name of the copyright holders nor the names of its
22  * contributors may be used to endorse or promote products derived from
23  * this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  */
37 
38 #ifndef __MEM_QPORT_HH__
39 #define __MEM_QPORT_HH__
40 
46 #include "mem/packet_queue.hh"
47 #include "mem/port.hh"
48 #include "sim/sim_object.hh"
49 
50 namespace gem5
51 {
52 
62 {
63 
64  protected:
65 
68 
70 
71  public:
72 
80  QueuedResponsePort(const std::string& name, SimObject* owner,
81  RespPacketQueue &resp_queue, PortID id = InvalidPortID) :
82  ResponsePort(name, owner, id), respQueue(resp_queue)
83  { }
84 
85  virtual ~QueuedResponsePort() { }
86 
93  void schedTimingResp(PacketPtr pkt, Tick when)
94  { respQueue.schedSendTiming(pkt, when); }
95 
99  { return respQueue.trySatisfyFunctional(pkt); }
100 };
101 
110 {
111 
112  protected:
113 
116 
119 
121 
123 
124  public:
125 
133  QueuedRequestPort(const std::string& name, SimObject* owner,
134  ReqPacketQueue &req_queue,
135  SnoopRespPacketQueue &snoop_resp_queue,
136  PortID id = InvalidPortID) :
137  RequestPort(name, owner, id), reqQueue(req_queue),
138  snoopRespQueue(snoop_resp_queue)
139  { }
140 
141  virtual ~QueuedRequestPort() { }
142 
149  void schedTimingReq(PacketPtr pkt, Tick when)
150  { reqQueue.schedSendTiming(pkt, when); }
151 
159  { snoopRespQueue.schedSendTiming(pkt, when); }
160 
164  {
165  return reqQueue.trySatisfyFunctional(pkt) ||
167  }
168 };
169 
170 } // namespace gem5
171 
172 #endif // __MEM_QPORT_HH__
bool trySatisfyFunctional(PacketPtr pkt)
Check the list of buffered packets against the supplied functional request.
Definition: packet_queue.cc:87
void retry()
Retry sending a packet from the queue.
Definition: packet_queue.cc:66
void schedSendTiming(PacketPtr pkt, Tick when)
Add a packet to the transmit list, and schedule a send event.
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:294
const PortID id
A numeric identifier to distinguish ports in a vector, and set to InvalidPortID in case this port is ...
Definition: port.hh:79
const std::string name() const
Return port name (for DPRINTF).
Definition: port.hh:111
The QueuedRequestPort combines two queues, a request queue and a snoop response queue,...
Definition: qport.hh:110
void schedTimingReq(PacketPtr pkt, Tick when)
Schedule the sending of a timing request.
Definition: qport.hh:149
virtual ~QueuedRequestPort()
Definition: qport.hh:141
void schedTimingSnoopResp(PacketPtr pkt, Tick when)
Schedule the sending of a timing snoop response.
Definition: qport.hh:158
QueuedRequestPort(const std::string &name, SimObject *owner, ReqPacketQueue &req_queue, SnoopRespPacketQueue &snoop_resp_queue, PortID id=InvalidPortID)
Create a QueuedPort with a given name, owner, and a supplied implementation of two packet queues.
Definition: qport.hh:133
bool trySatisfyFunctional(PacketPtr pkt)
Check the list of buffered packets against the supplied functional request.
Definition: qport.hh:163
void recvReqRetry()
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
Definition: qport.hh:120
void recvRetrySnoopResp()
Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to...
Definition: qport.hh:122
ReqPacketQueue & reqQueue
Packet queue used to store outgoing requests.
Definition: qport.hh:115
SnoopRespPacketQueue & snoopRespQueue
Packet queue used to store outgoing snoop responses.
Definition: qport.hh:118
A queued port is a port that has an infinite queue for outgoing packets and thus decouples the module...
Definition: qport.hh:62
void recvRespRetry()
Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called...
Definition: qport.hh:69
QueuedResponsePort(const std::string &name, SimObject *owner, RespPacketQueue &resp_queue, PortID id=InvalidPortID)
Create a QueuedPort with a given name, owner, and a supplied implementation of a packet queue.
Definition: qport.hh:80
RespPacketQueue & respQueue
Packet queue used to store outgoing responses.
Definition: qport.hh:67
bool trySatisfyFunctional(PacketPtr pkt)
Check the list of buffered packets against the supplied functional request.
Definition: qport.hh:98
virtual ~QueuedResponsePort()
Definition: qport.hh:85
void schedTimingResp(PacketPtr pkt, Tick when)
Schedule the sending of a timing response.
Definition: qport.hh:93
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:79
SimObject & owner
Definition: port.hh:86
A ResponsePort is a specialization of a port.
Definition: port.hh:270
SimObject & owner
Definition: port.hh:279
Abstract superclass for simulation objects.
Definition: sim_object.hh:148
Port Object Declaration.
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
const PortID InvalidPortID
Definition: types.hh:246
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:245
uint64_t Tick
Tick count type.
Definition: types.hh:58
Declaration of a simple PacketQueue that is associated with a port on which it attempts to send packe...

Generated on Wed Dec 21 2022 10:22:37 for gem5 by doxygen 1.9.1