gem5  v22.1.0.0
timing.cc
Go to the documentation of this file.
1 /*
2  * Copyright (c) 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 #include "mem/protocol/timing.hh"
42 
43 namespace gem5
44 {
45 
46 /* The request protocol. */
47 
48 bool
50 {
51  assert(pkt->isRequest());
52  return peer->recvTimingReq(pkt);
53 }
54 
55 bool
57  TimingResponseProtocol *peer, PacketPtr pkt) const
58 {
59  assert(pkt->isRequest());
60  return peer->tryTiming(pkt);
61 }
62 
63 bool
66 {
67  assert(pkt->isResponse());
68  return peer->recvTimingSnoopResp(pkt);
69 }
70 
71 void
73 {
74  peer->recvRespRetry();
75 }
76 
77 /* The response protocol. */
78 
79 bool
81 {
82  assert(pkt->isResponse());
83  return peer->recvTimingResp(pkt);
84 }
85 
86 void
89 {
90  assert(pkt->isRequest());
91  peer->recvTimingSnoopReq(pkt);
92 }
93 
94 void
96 {
97  peer->recvReqRetry();
98 }
99 
100 void
102 {
103  peer->recvRetrySnoopResp();
104 }
105 
106 } // namespace gem5
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:294
bool isResponse() const
Definition: packet.hh:597
bool isRequest() const
Definition: packet.hh:596
virtual bool recvTimingResp(PacketPtr pkt)=0
Receive a timing response from the peer.
void sendRetryResp(TimingResponseProtocol *peer)
Send a retry to the peer that previously attempted a sendTimingResp to this protocol and failed.
Definition: timing.cc:72
bool trySend(TimingResponseProtocol *peer, PacketPtr pkt) const
Check if the peer can handle a timing request.
Definition: timing.cc:56
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
virtual void recvRetrySnoopResp()=0
Called by the peer if sendTimingSnoopResp was called on this protocol (causing recvTimingSnoopResp to...
virtual void recvReqRetry()=0
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
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
virtual void recvTimingSnoopReq(PacketPtr pkt)=0
Receive a timing snoop request from the peer.
virtual bool recvTimingSnoopResp(PacketPtr pkt)=0
Receive a timing snoop response from the peer.
virtual void recvRespRetry()=0
Called by the peer if sendTimingResp was called on this protocol (causing recvTimingResp to be called...
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
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
void sendRetrySnoopResp(TimingRequestProtocol *peer)
Send a retry to the peer that previously attempted a sendTimingSnoopResp to this peer and failed.
Definition: timing.cc:101
void sendRetryReq(TimingRequestProtocol *peer)
Send a retry to the peer that previously attempted a sendTimingReq to this protocol and failed.
Definition: timing.cc:95
virtual bool tryTiming(PacketPtr pkt)=0
Availability request from the peer.
virtual bool recvTimingReq(PacketPtr pkt)=0
Receive a timing request from the peer.
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....

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