gem5  v21.1.0.2
smmu_v3_proc.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_PROC_HH__
39 #define __DEV_ARM_SMMU_V3_PROC_HH__
40 
41 #include <list>
42 #include <queue>
43 #include <string>
44 
45 #include "base/coroutine.hh"
46 #include "base/types.hh"
47 #include "mem/packet.hh"
48 
49 namespace gem5
50 {
51 
52 class SMMUv3DeviceInterface;
53 
54 /*
55  * The meaning of these becomes apparent when you
56  * look at runProcessAtomic()/runProcessTiming().
57  */
59 {
68 };
69 
70 struct SMMUAction
71 {
76 };
77 
78 class SMMUv3;
79 class SMMUProcess;
80 
82 {
83  explicit SMMUSemaphore(unsigned _max) :
84  count(_max), max(_max)
85  {}
86 
87  unsigned count;
88  unsigned max;
89  std::queue<SMMUProcess *> queue;
90 };
91 
92 struct SMMUSignal
93 {
95 };
96 
98 {
99  private:
101 
103  std::string myName;
104 
105  void wakeup();
106 
107  protected:
109 
111 
112  void reinit();
113 
114  virtual void main(Yield &yield) = 0;
115 
116  void doRead(Yield &yield, Addr addr, void *ptr, size_t size);
117  void doWrite(Yield &yield, Addr addr, const void *ptr, size_t size);
118  void doDelay(Yield &yield, Cycles cycles);
119  void doSleep(Yield &yield);
120 
121  void doSemaphoreDown(Yield &yield, SMMUSemaphore &sem);
122  void doSemaphoreUp(SMMUSemaphore &sem);
123 
124  void doWaitForSignal(Yield &yield, SMMUSignal &sig);
125  void doBroadcastSignal(SMMUSignal &sig);
126 
127  void scheduleWakeup(Tick when);
128 
129  public:
130  SMMUProcess(const std::string &name, SMMUv3 &_smmu);
131  virtual ~SMMUProcess();
132 
133  SMMUAction run(PacketPtr pkt);
134 
135  const std::string name() const { return myName; };
136 };
137 
138 } // namespace gem5
139 
140 #endif /* __DEV_ARM_SMMU_V3_PROC_HH__ */
gem5::ACTION_INITIAL_NOP
@ ACTION_INITIAL_NOP
Definition: smmu_v3_proc.hh:60
gem5::SMMUProcess::Yield
Coroutine::CallerType Yield
Definition: smmu_v3_proc.hh:108
gem5::SMMUProcess::wakeup
void wakeup()
Definition: smmu_v3_proc.cc:61
gem5::SMMUProcess
Definition: smmu_v3_proc.hh:97
gem5::SMMUProcess::doSemaphoreDown
void doSemaphoreDown(Yield &yield, SMMUSemaphore &sem)
Definition: smmu_v3_proc.cc:151
gem5::SMMUAction
Definition: smmu_v3_proc.hh:70
gem5::SMMUSemaphore::SMMUSemaphore
SMMUSemaphore(unsigned _max)
Definition: smmu_v3_proc.hh:83
gem5::ACTION_SEND_RESP
@ ACTION_SEND_RESP
Definition: smmu_v3_proc.hh:63
gem5::SMMUProcess::doSemaphoreUp
void doSemaphoreUp(SMMUSemaphore &sem)
Definition: smmu_v3_proc.cc:163
gem5::SMMUActionType
SMMUActionType
Definition: smmu_v3_proc.hh:58
gem5::SMMUProcess::~SMMUProcess
virtual ~SMMUProcess()
Definition: smmu_v3_proc.cc:55
gem5::SMMUProcess::reinit
void reinit()
Definition: smmu_v3_proc.cc:67
gem5::SMMUv3
Definition: smmu_v3.hh:85
packet.hh
gem5::Cycles
Cycles is a wrapper class for representing cycle counts, i.e.
Definition: types.hh:78
gem5::ACTION_SLEEP
@ ACTION_SLEEP
Definition: smmu_v3_proc.hh:66
gem5::SMMUProcess::name
const std::string name() const
Definition: smmu_v3_proc.hh:135
gem5::ACTION_SEND_RESP_ATS
@ ACTION_SEND_RESP_ATS
Definition: smmu_v3_proc.hh:64
gem5::SMMUSignal
Definition: smmu_v3_proc.hh:92
gem5::SMMUProcess::doBroadcastSignal
void doBroadcastSignal(SMMUSignal &sig)
Definition: smmu_v3_proc.cc:185
gem5::SMMUProcess::main
virtual void main(Yield &yield)=0
gem5::ACTION_TERMINATE
@ ACTION_TERMINATE
Definition: smmu_v3_proc.hh:67
gem5::SMMUSemaphore
Definition: smmu_v3_proc.hh:81
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::ACTION_SEND_REQ
@ ACTION_SEND_REQ
Definition: smmu_v3_proc.hh:61
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::SMMUProcess::Coroutine
gem5::Coroutine< PacketPtr, SMMUAction > Coroutine
Definition: smmu_v3_proc.hh:100
gem5::SMMUProcess::doSleep
void doSleep(Yield &yield)
Definition: smmu_v3_proc.cc:143
gem5::Packet::SenderState
A virtual base opaque structure used to hold state associated with the packet (e.g....
Definition: packet.hh:457
gem5::SMMUProcess::SMMUProcess
SMMUProcess(const std::string &name, SMMUv3 &_smmu)
Definition: smmu_v3_proc.cc:49
gem5::SMMUv3DeviceInterface
Definition: smmu_v3_deviceifc.hh:58
gem5::Addr
uint64_t Addr
Address type This will probably be moved somewhere else in the near future.
Definition: types.hh:147
gem5::Coroutine
This template defines a Coroutine wrapper type with a Boost-like interface.
Definition: coroutine.hh:64
gem5::SMMUProcess::scheduleWakeup
void scheduleWakeup(Tick when)
Definition: smmu_v3_proc.cc:200
gem5::SMMUSemaphore::queue
std::queue< SMMUProcess * > queue
Definition: smmu_v3_proc.hh:89
gem5::SMMUSemaphore::max
unsigned max
Definition: smmu_v3_proc.hh:88
gem5::SMMUProcess::doDelay
void doDelay(Yield &yield, Cycles cycles)
Definition: smmu_v3_proc.cc:131
gem5::SMMUProcess::doRead
void doRead(Yield &yield, Addr addr, void *ptr, size_t size)
Definition: smmu_v3_proc.cc:75
gem5::ACTION_DELAY
@ ACTION_DELAY
Definition: smmu_v3_proc.hh:65
gem5::SMMUProcess::coroutine
Coroutine * coroutine
Definition: smmu_v3_proc.hh:102
types.hh
gem5::SMMUAction::delay
Tick delay
Definition: smmu_v3_proc.hh:75
gem5::SMMUProcess::run
SMMUAction run(PacketPtr pkt)
Definition: smmu_v3_proc.cc:209
gem5::SMMUProcess::doWrite
void doWrite(Yield &yield, Addr addr, const void *ptr, size_t size)
Definition: smmu_v3_proc.cc:104
gem5::ACTION_SEND_REQ_FINAL
@ ACTION_SEND_REQ_FINAL
Definition: smmu_v3_proc.hh:62
coroutine.hh
gem5::SMMUAction::ifc
SMMUv3DeviceInterface * ifc
Definition: smmu_v3_proc.hh:74
gem5::Coroutine::CallerType
CallerType: A reference to an object of this class will be passed to the coroutine task.
Definition: coroutine.hh:85
gem5::SMMUSemaphore::count
unsigned count
Definition: smmu_v3_proc.hh:87
gem5::SMMUAction::pkt
PacketPtr pkt
Definition: smmu_v3_proc.hh:73
gem5::SMMUProcess::doWaitForSignal
void doWaitForSignal(Yield &yield, SMMUSignal &sig)
Definition: smmu_v3_proc.cc:178
gem5::SMMUAction::type
SMMUActionType type
Definition: smmu_v3_proc.hh:72
std::list
STL list class.
Definition: stl.hh:51
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::SMMUSignal::waiting
std::list< SMMUProcess * > waiting
Definition: smmu_v3_proc.hh:94
gem5::SMMUProcess::smmu
SMMUv3 & smmu
Definition: smmu_v3_proc.hh:110
gem5::X86ISA::addr
Bitfield< 3 > addr
Definition: types.hh:84
gem5::SMMUProcess::myName
std::string myName
Definition: smmu_v3_proc.hh:103

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