gem5  v21.1.0.2
atomic.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_ATOMIC_HH__
42 #define __MEM_GEM5_PROTOCOL_ATOMIC_HH__
43 
44 #include "mem/backdoor.hh"
45 #include "mem/packet.hh"
46 
47 namespace gem5
48 {
49 
50 class AtomicResponseProtocol;
51 
53 {
54  friend class AtomicResponseProtocol;
55 
56  protected:
68 
81  MemBackdoorPtr &backdoor);
82 
86  virtual Tick recvAtomicSnoop(PacketPtr pkt) = 0;
87 };
88 
90 {
91  friend class AtomicRequestProtocol;
92 
93  protected:
105 
109  virtual Tick recvAtomic(PacketPtr pkt) = 0;
110 
115  virtual Tick recvAtomicBackdoor(
116  PacketPtr pkt, MemBackdoorPtr &backdoor) = 0;
117 };
118 
119 } // namespace gem5
120 
121 #endif //__MEM_GEM5_PROTOCOL_ATOMIC_HH__
gem5::AtomicResponseProtocol::sendSnoop
Tick sendSnoop(AtomicRequestProtocol *peer, PacketPtr pkt)
Send an atomic snoop request packet, where the data is moved and the state is updated in zero time,...
Definition: atomic.cc:68
backdoor.hh
gem5::AtomicResponseProtocol
Definition: atomic.hh:89
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::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::AtomicRequestProtocol::send
Tick send(AtomicResponseProtocol *peer, PacketPtr pkt)
Send an atomic request packet, where the data is moved and the state is updated in zero time,...
Definition: atomic.cc:51
gem5::AtomicResponseProtocol::recvAtomic
virtual Tick recvAtomic(PacketPtr pkt)=0
Receive an atomic request packet from the peer.
gem5::MemBackdoor
Definition: backdoor.hh:41
gem5::AtomicRequestProtocol
Definition: atomic.hh:52
gem5::AtomicRequestProtocol::sendBackdoor
Tick sendBackdoor(AtomicResponseProtocol *peer, PacketPtr pkt, MemBackdoorPtr &backdoor)
Send an atomic request packet like above, but also request a backdoor to the data being accessed.
Definition: atomic.cc:58
gem5::AtomicRequestProtocol::recvAtomicSnoop
virtual Tick recvAtomicSnoop(PacketPtr pkt)=0
Receive an atomic snoop request packet from our peer.
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::AtomicResponseProtocol::recvAtomicBackdoor
virtual Tick recvAtomicBackdoor(PacketPtr pkt, MemBackdoorPtr &backdoor)=0
Receive an atomic request packet from the peer, and optionally provide a backdoor to the data being a...

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