gem5  v21.1.0.2
smmu_v3_ports.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013, 2018-2019 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 __DEV_ARM_SMMU_V3_PORTS_HH__
39 #define __DEV_ARM_SMMU_V3_PORTS_HH__
40 
41 #include "mem/qport.hh"
42 #include "mem/tport.hh"
43 
44 namespace gem5
45 {
46 
47 class SMMUv3;
48 class SMMUv3DeviceInterface;
49 
51 {
52  protected:
54 
55  virtual bool recvTimingResp(PacketPtr pkt);
56  virtual void recvReqRetry();
57 
58  public:
59  SMMURequestPort(const std::string &_name, SMMUv3 &_smmu);
60  virtual ~SMMURequestPort() {}
61 };
62 
63 // Separate request port to send MMU initiated requests on
65 {
66  protected:
68 
69  virtual bool recvTimingResp(PacketPtr pkt);
70  virtual void recvReqRetry();
71 
72  public:
73  SMMUTableWalkPort(const std::string &_name, SMMUv3 &_smmu);
74  virtual ~SMMUTableWalkPort() {}
75 };
76 
78 {
79  protected:
82 
83  virtual void recvFunctional(PacketPtr pkt);
84  virtual Tick recvAtomic(PacketPtr pkt);
85  virtual bool recvTimingReq(PacketPtr pkt);
86 
87  public:
88  SMMUDevicePort(const std::string &_name,
90  PortID _id = InvalidPortID);
91  virtual ~SMMUDevicePort() {}
92 
93  virtual AddrRangeList getAddrRanges() const
94  { return AddrRangeList { AddrRange(0, UINT64_MAX) }; }
95 };
96 
98 {
99  protected:
102 
103  virtual Tick recvAtomic(PacketPtr pkt);
104  virtual AddrRangeList getAddrRanges() const;
105 
106  public:
107  SMMUControlPort(const std::string &_name, SMMUv3 &_smmu,
108  AddrRange _addrRange);
109  virtual ~SMMUControlPort() {}
110 };
111 
113 {
114  protected:
118 
119  virtual bool recvTimingResp(PacketPtr pkt);
120 
121  public:
122  SMMUATSMemoryPort(const std::string &_name, SMMUv3DeviceInterface &_ifc);
123  virtual ~SMMUATSMemoryPort() {}
124 };
125 
127 {
128  protected:
131 
132  virtual void recvFunctional(PacketPtr pkt);
133  virtual Tick recvAtomic(PacketPtr pkt);
134  virtual bool recvTimingReq(PacketPtr pkt);
135 
136  virtual AddrRangeList getAddrRanges() const
137  { return AddrRangeList(); }
138 
139  public:
140  SMMUATSDevicePort(const std::string &_name, SMMUv3DeviceInterface &_ifc);
141  virtual ~SMMUATSDevicePort() {}
142 };
143 
144 } // namespace gem5
145 
146 #endif /* __DEV_ARM_SMMU_V3_PORTS_HH__ */
gem5::SMMURequestPort::recvReqRetry
virtual void recvReqRetry()
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
Definition: smmu_v3_ports.cc:59
gem5::PortID
int16_t PortID
Port index/ID type, and a symbolic name for an invalid port id.
Definition: types.hh:252
gem5::SMMUATSMemoryPort::SMMUATSMemoryPort
SMMUATSMemoryPort(const std::string &_name, SMMUv3DeviceInterface &_ifc)
Definition: smmu_v3_ports.cc:142
gem5::SMMUATSDevicePort::SMMUATSDevicePort
SMMUATSDevicePort(const std::string &_name, SMMUv3DeviceInterface &_ifc)
Definition: smmu_v3_ports.cc:156
gem5::SMMUControlPort::getAddrRanges
virtual AddrRangeList getAddrRanges() const
Get a list of the non-overlapping address ranges the owner is responsible for.
Definition: smmu_v3_ports.cc:135
gem5::SMMUATSDevicePort::respQueue
RespPacketQueue respQueue
Definition: smmu_v3_ports.hh:130
gem5::SMMUATSMemoryPort::recvTimingResp
virtual bool recvTimingResp(PacketPtr pkt)
Receive a timing response from the peer.
Definition: smmu_v3_ports.cc:151
gem5::RespPacketQueue
Definition: packet_queue.hh:300
gem5::SMMUATSMemoryPort
Definition: smmu_v3_ports.hh:112
gem5::SMMUATSDevicePort::recvTimingReq
virtual bool recvTimingReq(PacketPtr pkt)
Receive a timing request from the peer.
Definition: smmu_v3_ports.cc:176
gem5::SMMUDevicePort::recvTimingReq
virtual bool recvTimingReq(PacketPtr pkt)
Receive a timing request from the peer.
Definition: smmu_v3_ports.cc:105
gem5::SMMUATSMemoryPort::ifc
SMMUv3DeviceInterface & ifc
Definition: smmu_v3_ports.hh:115
gem5::QueuedRequestPort
The QueuedRequestPort combines two queues, a request queue and a snoop response queue,...
Definition: qport.hh:109
gem5::AddrRangeList
std::list< AddrRange > AddrRangeList
Convenience typedef for a collection of address ranges.
Definition: addr_range.hh:641
gem5::SMMUATSDevicePort::~SMMUATSDevicePort
virtual ~SMMUATSDevicePort()
Definition: smmu_v3_ports.hh:141
gem5::SMMUATSDevicePort::ifc
SMMUv3DeviceInterface & ifc
Definition: smmu_v3_ports.hh:129
gem5::SMMUTableWalkPort::SMMUTableWalkPort
SMMUTableWalkPort(const std::string &_name, SMMUv3 &_smmu)
Definition: smmu_v3_ports.cc:64
gem5::SMMUTableWalkPort::recvTimingResp
virtual bool recvTimingResp(PacketPtr pkt)
Receive a timing response from the peer.
Definition: smmu_v3_ports.cc:71
gem5::SMMUControlPort::~SMMUControlPort
virtual ~SMMUControlPort()
Definition: smmu_v3_ports.hh:109
gem5::SMMUDevicePort::getAddrRanges
virtual AddrRangeList getAddrRanges() const
Get a list of the non-overlapping address ranges the owner is responsible for.
Definition: smmu_v3_ports.hh:93
gem5::InvalidPortID
const PortID InvalidPortID
Definition: types.hh:253
gem5::SMMUDevicePort::SMMUDevicePort
SMMUDevicePort(const std::string &_name, SMMUv3DeviceInterface &_ifc, PortID _id=InvalidPortID)
Definition: smmu_v3_ports.cc:82
gem5::SMMURequestPort::smmu
SMMUv3 & smmu
Definition: smmu_v3_ports.hh:53
gem5::SMMUDevicePort::ifc
SMMUv3DeviceInterface & ifc
Definition: smmu_v3_ports.hh:80
gem5::SMMUv3
Definition: smmu_v3.hh:85
gem5::SMMURequestPort::recvTimingResp
virtual bool recvTimingResp(PacketPtr pkt)
Receive a timing response from the peer.
Definition: smmu_v3_ports.cc:53
gem5::RequestPort
A RequestPort is a specialisation of a Port, which implements the default protocol for the three diff...
Definition: port.hh:77
gem5::SimpleTimingPort
The simple timing port uses a queued port to implement recvFunctional and recvTimingReq through recvA...
Definition: tport.hh:62
gem5::SMMUTableWalkPort::smmu
SMMUv3 & smmu
Definition: smmu_v3_ports.hh:67
gem5::SMMUDevicePort::respQueue
RespPacketQueue respQueue
Definition: smmu_v3_ports.hh:81
gem5::SMMUATSDevicePort
Definition: smmu_v3_ports.hh:126
gem5::SMMUDevicePort::recvAtomic
virtual Tick recvAtomic(PacketPtr pkt)
Receive an atomic request packet from the peer.
Definition: smmu_v3_ports.cc:99
gem5::SMMUTableWalkPort::~SMMUTableWalkPort
virtual ~SMMUTableWalkPort()
Definition: smmu_v3_ports.hh:74
gem5::QueuedResponsePort
A queued port is a port that has an infinite queue for outgoing packets and thus decouples the module...
Definition: qport.hh:61
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::SMMUATSDevicePort::getAddrRanges
virtual AddrRangeList getAddrRanges() const
Get a list of the non-overlapping address ranges the owner is responsible for.
Definition: smmu_v3_ports.hh:136
gem5::SMMUDevicePort
Definition: smmu_v3_ports.hh:77
gem5::SMMUATSMemoryPort::snoopRespQueue
SnoopRespPacketQueue snoopRespQueue
Definition: smmu_v3_ports.hh:117
gem5::SMMUControlPort
Definition: smmu_v3_ports.hh:97
gem5::SMMUv3DeviceInterface
Definition: smmu_v3_deviceifc.hh:58
gem5::SMMUATSDevicePort::recvAtomic
virtual Tick recvAtomic(PacketPtr pkt)
Receive an atomic request packet from the peer.
Definition: smmu_v3_ports.cc:170
gem5::SMMUControlPort::addrRange
AddrRange addrRange
Definition: smmu_v3_ports.hh:101
gem5::SMMUTableWalkPort
Definition: smmu_v3_ports.hh:64
gem5::SMMUATSDevicePort::recvFunctional
virtual void recvFunctional(PacketPtr pkt)
Receive a functional request packet from the peer.
Definition: smmu_v3_ports.cc:164
gem5::SMMUTableWalkPort::recvReqRetry
virtual void recvReqRetry()
Called by the peer if sendTimingReq was called on this peer (causing recvTimingReq to be called on th...
Definition: smmu_v3_ports.cc:77
qport.hh
tport.hh
gem5::SMMUControlPort::smmu
SMMUv3 & smmu
Definition: smmu_v3_ports.hh:100
gem5::SMMURequestPort::SMMURequestPort
SMMURequestPort(const std::string &_name, SMMUv3 &_smmu)
Definition: smmu_v3_ports.cc:47
gem5::SMMURequestPort::~SMMURequestPort
virtual ~SMMURequestPort()
Definition: smmu_v3_ports.hh:60
gem5::SMMUControlPort::SMMUControlPort
SMMUControlPort(const std::string &_name, SMMUv3 &_smmu, AddrRange _addrRange)
Definition: smmu_v3_ports.cc:110
gem5::SMMUDevicePort::recvFunctional
virtual void recvFunctional(PacketPtr pkt)
Receive a functional request packet from the peer.
Definition: smmu_v3_ports.cc:92
gem5::SMMUATSMemoryPort::reqQueue
ReqPacketQueue reqQueue
Definition: smmu_v3_ports.hh:116
gem5::SMMUControlPort::recvAtomic
virtual Tick recvAtomic(PacketPtr pkt)
Receive an atomic request packet from the peer.
Definition: smmu_v3_ports.cc:119
gem5::SMMUDevicePort::~SMMUDevicePort
virtual ~SMMUDevicePort()
Definition: smmu_v3_ports.hh:91
gem5::ReqPacketQueue
Definition: packet_queue.hh:226
gem5::SMMUATSMemoryPort::~SMMUATSMemoryPort
virtual ~SMMUATSMemoryPort()
Definition: smmu_v3_ports.hh:123
gem5::AddrRange
The AddrRange class encapsulates an address range, and supports a number of tests to check if two ran...
Definition: addr_range.hh:71
std::list< AddrRange >
gem5::SnoopRespPacketQueue
Definition: packet_queue.hh:262
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::SMMURequestPort
Definition: smmu_v3_ports.hh:50

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