gem5  v21.1.0.2
timing.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2011-2012,2015,2017 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) 2002-2005 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 
41 #ifndef __MEM_GEM5_PROTOCOL_TIMING_HH__
42 #define __MEM_GEM5_PROTOCOL_TIMING_HH__
43 
44 #include "mem/packet.hh"
45 
46 namespace gem5
47 {
48 
49 class TimingResponseProtocol;
50 
52 {
53  friend class TimingResponseProtocol;
54 
55  protected:
68  bool sendReq(TimingResponseProtocol *peer, PacketPtr pkt);
69 
82  bool trySend(TimingResponseProtocol *peer, PacketPtr pkt) const;
83 
94 
100 
104  virtual bool recvTimingResp(PacketPtr pkt) = 0;
105 
109  virtual void recvTimingSnoopReq(PacketPtr pkt) = 0;
110 
115  virtual void recvReqRetry() = 0;
116 
122  virtual void recvRetrySnoopResp() = 0;
123 };
124 
126 {
127  friend class TimingRequestProtocol;
128 
129  protected:
142  bool sendResp(TimingRequestProtocol *peer, PacketPtr pkt);
143 
153 
159 
165 
169  virtual bool recvTimingReq(PacketPtr pkt) = 0;
170 
174  virtual bool tryTiming(PacketPtr pkt) = 0;
175 
179  virtual bool recvTimingSnoopResp(PacketPtr pkt) = 0;
180 
186  virtual void recvRespRetry() = 0;
187 };
188 
189 } // namespace gem5
190 
191 #endif //__MEM_GEM5_PROTOCOL_TIMING_HH__
gem5::TimingResponseProtocol::recvRespRetry
virtual void recvRespRetry()=0
Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called...
gem5::TimingResponseProtocol::sendResp
bool sendResp(TimingRequestProtocol *peer, PacketPtr pkt)
Attempt to send a timing response to the peer by calling its corresponding receive function.
Definition: timing.cc:80
gem5::TimingResponseProtocol::recvTimingSnoopResp
virtual bool recvTimingSnoopResp(PacketPtr pkt)=0
Receive a timing snoop response from the peer.
gem5::TimingResponseProtocol::sendRetryReq
void sendRetryReq(TimingRequestProtocol *peer)
Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed.
Definition: timing.cc:95
gem5::TimingRequestProtocol::sendReq
bool sendReq(TimingResponseProtocol *peer, PacketPtr pkt)
Attempt to send a timing request to the peer by calling its corresponding receive function.
Definition: timing.cc:49
gem5::TimingResponseProtocol::sendRetrySnoopResp
void sendRetrySnoopResp(TimingRequestProtocol *peer)
Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed.
Definition: timing.cc:101
packet.hh
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::TimingRequestProtocol::recvRetrySnoopResp
virtual void recvRetrySnoopResp()=0
Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to...
gem5::TimingResponseProtocol
Definition: timing.hh:125
gem5::TimingRequestProtocol::sendSnoopResp
bool sendSnoopResp(TimingResponseProtocol *peer, PacketPtr pkt)
Attempt to send a timing snoop response packet to it's peer by calling its corresponding receive func...
Definition: timing.cc:64
gem5::TimingResponseProtocol::tryTiming
virtual bool tryTiming(PacketPtr pkt)=0
Availability request from the peer.
gem5::TimingRequestProtocol::trySend
bool trySend(TimingResponseProtocol *peer, PacketPtr pkt) const
Check if the peer can handle a timing request.
Definition: timing.cc:56
gem5::TimingRequestProtocol::recvTimingSnoopReq
virtual void recvTimingSnoopReq(PacketPtr pkt)=0
Receive a timing snoop request from the peer.
gem5::TimingRequestProtocol::sendRetryResp
void sendRetryResp(TimingResponseProtocol *peer)
Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed.
Definition: timing.cc:72
gem5::TimingResponseProtocol::recvTimingReq
virtual bool recvTimingReq(PacketPtr pkt)=0
Receive a timing request from the peer.
gem5::TimingRequestProtocol::recvReqRetry
virtual void recvReqRetry()=0
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
gem5::TimingRequestProtocol
Definition: timing.hh:51
gem5::TimingRequestProtocol::recvTimingResp
virtual bool recvTimingResp(PacketPtr pkt)=0
Receive a timing response from the peer.
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::TimingResponseProtocol::sendSnoopReq
void sendSnoopReq(TimingRequestProtocol *peer, PacketPtr pkt)
Attempt to send a timing snoop request packet to the peer by calling its corresponding receive functi...
Definition: timing.cc:87

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