gem5  v21.1.0.2
rv_ctrl.hh
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2010,2013,2015 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_RV_HH__
39 #define __DEV_ARM_RV_HH__
40 
41 #include "base/bitunion.hh"
42 #include "dev/io_device.hh"
43 #include "params/RealViewCtrl.hh"
44 #include "params/RealViewOsc.hh"
45 #include "params/RealViewTemperatureSensor.hh"
46 
51 namespace gem5
52 {
53 
55 {
56  public:
58  {
59  FUNC_OSC = 1,
60  FUNC_VOLT = 2,
61  FUNC_AMP = 3,
62  FUNC_TEMP = 4,
64  FUNC_SCC = 6,
69  FUNC_POWER = 12,
71  };
72 
73  class Device
74  {
75  public:
77  uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev)
78  {
79  parent.registerDevice(func, site, pos, dcc, dev, this);
80  }
81 
82  virtual ~Device() {}
83 
84  virtual uint32_t read() const = 0;
85  virtual void write(uint32_t value) = 0;
86  };
87 
88  protected:
89  enum
90  {
91  IdReg = 0x00,
92  SwReg = 0x04,
93  Led = 0x08,
94  Osc0 = 0x0C,
95  Osc1 = 0x10,
96  Osc2 = 0x14,
97  Osc3 = 0x18,
98  Osc4 = 0x1C,
99  Lock = 0x20,
100  Clock100 = 0x24,
101  CfgData1 = 0x28,
102  CfgData2 = 0x2C,
103  Flags = 0x30,
104  FlagsClr = 0x34,
105  NvFlags = 0x38,
106  NvFlagsClr = 0x3C,
107  ResetCtl = 0x40,
108  PciCtl = 0x44,
109  MciCtl = 0x48,
110  Flash = 0x4C,
111  Clcd = 0x50,
112  ClcdSer = 0x54,
113  Bootcs = 0x58,
114  Clock24 = 0x5C,
115  Misc = 0x60,
116  IoSel = 0x70,
117  ProcId0 = 0x84,
118  ProcId1 = 0x88,
119  CfgData = 0xA0,
120  CfgCtrl = 0xA4,
121  CfgStat = 0xA8,
122  TestOsc0 = 0xC0,
123  TestOsc1 = 0xC4,
124  TestOsc2 = 0xC8,
125  TestOsc3 = 0xCC,
126  TestOsc4 = 0xD0
127  };
128 
129  // system lock value
130  BitUnion32(SysLockReg)
131  Bitfield<15,0> lockVal;
132  Bitfield<16> locked;
133  EndBitUnion(SysLockReg)
134 
135  BitUnion32(CfgCtrlReg)
136  Bitfield<11, 0> dev;
137  Bitfield<15, 12> pos;
138  Bitfield<17, 16> site;
139  Bitfield<25, 20> func;
140  Bitfield<29, 26> dcc;
141  Bitfield<30> wr;
142  Bitfield<31> start;
143  EndBitUnion(CfgCtrlReg)
144 
145  static const uint32_t CFG_CTRL_ADDR_MASK = 0x3fffffffUL;
146 
147  SysLockReg sysLock;
148 
154  uint32_t flags;
155 
158  uint32_t scData;
159 
160  public:
162 
167  RealViewCtrl(const Params &p);
168 
174  Tick read(PacketPtr pkt) override;
175 
181  Tick write(PacketPtr pkt) override;
182 
183  void serialize(CheckpointOut &cp) const override;
184  void unserialize(CheckpointIn &cp) override;
185 
186  public:
187  void registerDevice(DeviceFunc func, uint8_t site, uint8_t pos,
188  uint8_t dcc, uint16_t dev,
189  Device *handler);
190 
191  protected:
192  std::map<uint32_t, Device *> devices;
193 };
194 
203  : public ClockDomain, RealViewCtrl::Device
204 {
205  public:
206  RealViewOsc(const RealViewOscParams &p);
207  virtual ~RealViewOsc() {};
208 
209  void startup() override;
210 
211  void serialize(CheckpointOut &cp) const override;
212  void unserialize(CheckpointIn &cp) override;
213 
214  public: // RealViewCtrl::Device interface
215  uint32_t read() const override;
216  void write(uint32_t freq) override;
217 
218  protected:
219  void clockPeriod(Tick clock_period);
220 };
221 
230 {
231  public:
232  RealViewTemperatureSensor(const RealViewTemperatureSensorParams &p)
233  : SimObject(p),
234  RealViewCtrl::Device(*p.parent, RealViewCtrl::FUNC_TEMP,
235  p.site, p.position, p.dcc, p.device),
236  system(p.system)
237  {}
239 
240  public: // RealViewCtrl::Device interface
241  uint32_t read() const override;
242  void write(uint32_t temp) override {}
243 
244  protected:
247 };
248 
249 } // namespace gem5
250 
251 #endif // __DEV_ARM_RV_HH__
gem5::RealViewCtrl::TestOsc1
@ TestOsc1
Definition: rv_ctrl.hh:123
gem5::RealViewCtrl::Clock24
@ Clock24
Definition: rv_ctrl.hh:114
gem5::RealViewCtrl::MciCtl
@ MciCtl
Definition: rv_ctrl.hh:109
io_device.hh
gem5::RealViewCtrl::scData
uint32_t scData
This register contains the result from a system control reg access.
Definition: rv_ctrl.hh:158
gem5::RealViewTemperatureSensor::~RealViewTemperatureSensor
virtual ~RealViewTemperatureSensor()
Definition: rv_ctrl.hh:238
gem5::RealViewCtrl::BitUnion32
BitUnion32(SysLockReg) Bitfield< 15
gem5::RealViewCtrl::Misc
@ Misc
Definition: rv_ctrl.hh:115
gem5::RealViewCtrl::FlagsClr
@ FlagsClr
Definition: rv_ctrl.hh:104
gem5::RealViewCtrl::FUNC_SCC
@ FUNC_SCC
Definition: rv_ctrl.hh:64
gem5::RealViewCtrl::Device::read
virtual uint32_t read() const =0
gem5::RealViewCtrl::TestOsc0
@ TestOsc0
Definition: rv_ctrl.hh:122
gem5::RealViewCtrl::FUNC_DVIMODE
@ FUNC_DVIMODE
Definition: rv_ctrl.hh:68
gem5::CheckpointIn
Definition: serialize.hh:68
gem5::RealViewCtrl::ClcdSer
@ ClcdSer
Definition: rv_ctrl.hh:112
gem5::RealViewCtrl::site
Bitfield< 17, 16 > site
Definition: rv_ctrl.hh:138
gem5::X86ISA::system
Bitfield< 15 > system
Definition: misc.hh:1003
gem5::RealViewCtrl::CfgStat
@ CfgStat
Definition: rv_ctrl.hh:121
gem5::RealViewCtrl::TestOsc3
@ TestOsc3
Definition: rv_ctrl.hh:125
gem5::RealViewCtrl::Clock100
@ Clock100
Definition: rv_ctrl.hh:100
gem5::RealViewCtrl::FUNC_ENERGY
@ FUNC_ENERGY
Definition: rv_ctrl.hh:70
gem5::RealViewCtrl::Osc0
@ Osc0
Definition: rv_ctrl.hh:94
gem5::RealViewCtrl::Osc4
@ Osc4
Definition: rv_ctrl.hh:98
gem5::PioDevice::Params
PioDeviceParams Params
Definition: io_device.hh:134
gem5::RealViewCtrl::FUNC_SHUTDOWN
@ FUNC_SHUTDOWN
Definition: rv_ctrl.hh:66
gem5::RealViewCtrl::TestOsc2
@ TestOsc2
Definition: rv_ctrl.hh:124
gem5::Flags
Wrapper that groups a few flag bits under the same undelying container.
Definition: flags.hh:44
gem5::RealViewCtrl::FUNC_RESET
@ FUNC_RESET
Definition: rv_ctrl.hh:63
gem5::System
Definition: system.hh:77
gem5::RealViewCtrl::Device::~Device
virtual ~Device()
Definition: rv_ctrl.hh:82
gem5::RealViewCtrl::start
Bitfield< 31 > start
Definition: rv_ctrl.hh:142
gem5::RealViewCtrl::Led
@ Led
Definition: rv_ctrl.hh:93
gem5::ClockDomain
The ClockDomain provides clock to group of clocked objects bundled under the same clock domain.
Definition: clock_domain.hh:71
gem5::Packet
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:283
gem5::MipsISA::p
Bitfield< 0 > p
Definition: pra_constants.hh:326
gem5::Tick
uint64_t Tick
Tick count type.
Definition: types.hh:58
gem5::RealViewCtrl::PciCtl
@ PciCtl
Definition: rv_ctrl.hh:108
bitunion.hh
gem5::RealViewCtrl::Osc2
@ Osc2
Definition: rv_ctrl.hh:96
gem5::RealViewCtrl::func
Bitfield< 25, 20 > func
Definition: rv_ctrl.hh:139
gem5::RealViewCtrl::Device
Definition: rv_ctrl.hh:73
gem5::RealViewCtrl::serialize
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: rv_ctrl.cc:207
gem5::SimObject
Abstract superclass for simulation objects.
Definition: sim_object.hh:146
gem5::RealViewCtrl::locked
Bitfield< 16 > locked
Definition: rv_ctrl.hh:132
gem5::RealViewCtrl::IdReg
@ IdReg
Definition: rv_ctrl.hh:91
gem5::RealViewCtrl::PARAMS
PARAMS(RealViewCtrl)
gem5::RealViewCtrl::SwReg
@ SwReg
Definition: rv_ctrl.hh:92
gem5::RealViewCtrl::dcc
Bitfield< 29, 26 > dcc
Definition: rv_ctrl.hh:140
gem5::RealViewTemperatureSensor::write
void write(uint32_t temp) override
Definition: rv_ctrl.hh:242
gem5::RealViewOsc::~RealViewOsc
virtual ~RealViewOsc()
Definition: rv_ctrl.hh:207
gem5::RealViewCtrl::ProcId0
@ ProcId0
Definition: rv_ctrl.hh:117
gem5::RealViewCtrl::IoSel
@ IoSel
Definition: rv_ctrl.hh:116
gem5::RealViewCtrl::lockVal
lockVal
Definition: rv_ctrl.hh:131
gem5::RealViewTemperatureSensor
This device implements the temperature sensor used in the RealView/Versatile Express platform.
Definition: rv_ctrl.hh:228
gem5::RealViewCtrl::NvFlags
@ NvFlags
Definition: rv_ctrl.hh:105
gem5::RealViewCtrl::pos
Bitfield< 15, 12 > pos
Definition: rv_ctrl.hh:137
gem5::RealViewCtrl::FUNC_AMP
@ FUNC_AMP
Definition: rv_ctrl.hh:61
gem5::RealViewCtrl::CfgData
@ CfgData
Definition: rv_ctrl.hh:119
gem5::RealViewCtrl::Osc1
@ Osc1
Definition: rv_ctrl.hh:95
gem5::RealViewCtrl::unserialize
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: rv_ctrl.cc:213
std
Overload hash function for BasicBlockRange type.
Definition: types.hh:111
gem5::RealViewCtrl
Definition: rv_ctrl.hh:54
gem5::RealViewCtrl::FUNC_TEMP
@ FUNC_TEMP
Definition: rv_ctrl.hh:62
gem5::SimObject::startup
virtual void startup()
startup() is the final initialization call before simulation.
Definition: sim_object.cc:99
gem5::RealViewCtrl::Lock
@ Lock
Definition: rv_ctrl.hh:99
gem5::RealViewCtrl::Bootcs
@ Bootcs
Definition: rv_ctrl.hh:113
gem5::RealViewCtrl::CfgCtrl
@ CfgCtrl
Definition: rv_ctrl.hh:120
gem5::RealViewCtrl::TestOsc4
@ TestOsc4
Definition: rv_ctrl.hh:126
gem5::RealViewCtrl::dev
dev
Definition: rv_ctrl.hh:136
gem5::RealViewCtrl::ResetCtl
@ ResetCtl
Definition: rv_ctrl.hh:107
gem5::RealViewCtrl::EndBitUnion
EndBitUnion(SysLockReg) BitUnion32(CfgCtrlReg) Bitfield< 11
gem5::RealViewTemperatureSensor::system
System * system
The system this RV device belongs to.
Definition: rv_ctrl.hh:246
gem5::RealViewCtrl::Clcd
@ Clcd
Definition: rv_ctrl.hh:111
gem5::RealViewCtrl::Device::write
virtual void write(uint32_t value)=0
gem5::RealViewCtrl::NvFlagsClr
@ NvFlagsClr
Definition: rv_ctrl.hh:106
gem5::CheckpointOut
std::ostream CheckpointOut
Definition: serialize.hh:66
gem5::RealViewCtrl::wr
Bitfield< 30 > wr
Definition: rv_ctrl.hh:141
gem5::RealViewCtrl::write
Tick write(PacketPtr pkt) override
All writes are simply ignored.
Definition: rv_ctrl.cc:133
gem5::RealViewCtrl::devices
std::map< uint32_t, Device * > devices
Definition: rv_ctrl.hh:192
gem5::RealViewCtrl::CfgData2
@ CfgData2
Definition: rv_ctrl.hh:102
gem5::RealViewCtrl::FUNC_MUXFPGA
@ FUNC_MUXFPGA
Definition: rv_ctrl.hh:65
gem5::RealViewCtrl::flags
uint32_t flags
This register is used for smp booting.
Definition: rv_ctrl.hh:154
gem5::RealViewCtrl::sysLock
SysLockReg sysLock
Definition: rv_ctrl.hh:147
gem5
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
Definition: decoder.cc:40
gem5::RealViewCtrl::FUNC_VOLT
@ FUNC_VOLT
Definition: rv_ctrl.hh:60
gem5::RealViewCtrl::FUNC_POWER
@ FUNC_POWER
Definition: rv_ctrl.hh:69
gem5::BasicPioDevice
Definition: io_device.hh:147
gem5::RealViewCtrl::registerDevice
void registerDevice(DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev, Device *handler)
Definition: rv_ctrl.cc:219
gem5::RealViewOsc
This is an implementation of a programmable oscillator on the that can be configured through the Real...
Definition: rv_ctrl.hh:202
gem5::RealViewCtrl::read
Tick read(PacketPtr pkt) override
Handle a read to the device.
Definition: rv_ctrl.cc:57
gem5::RealViewCtrl::CfgData1
@ CfgData1
Definition: rv_ctrl.hh:101
gem5::RealViewCtrl::Flash
@ Flash
Definition: rv_ctrl.hh:110
gem5::RealViewCtrl::Osc3
@ Osc3
Definition: rv_ctrl.hh:97
gem5::RealViewTemperatureSensor::RealViewTemperatureSensor
RealViewTemperatureSensor(const RealViewTemperatureSensorParams &p)
Definition: rv_ctrl.hh:232
gem5::RealViewCtrl::ProcId1
@ ProcId1
Definition: rv_ctrl.hh:118
gem5::RealViewCtrl::DeviceFunc
DeviceFunc
Definition: rv_ctrl.hh:57
gem5::RealViewCtrl::Device::Device
Device(RealViewCtrl &parent, DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev)
Definition: rv_ctrl.hh:76
gem5::RealViewCtrl::FUNC_OSC
@ FUNC_OSC
Definition: rv_ctrl.hh:59
gem5::Clocked::clockPeriod
Tick clockPeriod() const
Definition: clocked_object.hh:217
gem5::RealViewCtrl::FUNC_REBOOT
@ FUNC_REBOOT
Definition: rv_ctrl.hh:67

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