gem5  v22.1.0.0
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__
The ClockDomain provides clock to group of clocked objects bundled under the same clock domain.
Definition: clock_domain.hh:72
Tick clockPeriod() const
Wrapper that groups a few flag bits under the same undelying container.
Definition: flags.hh:45
A Packet is used to encapsulate a transfer between two objects in the memory system (e....
Definition: packet.hh:294
PioDeviceParams Params
Definition: io_device.hh:134
Device(RealViewCtrl &parent, DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev)
Definition: rv_ctrl.hh:76
virtual uint32_t read() const =0
virtual void write(uint32_t value)=0
void registerDevice(DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev, Device *handler)
Definition: rv_ctrl.cc:219
Bitfield< 29, 26 > dcc
Definition: rv_ctrl.hh:140
SysLockReg sysLock
Definition: rv_ctrl.hh:147
PARAMS(RealViewCtrl)
EndBitUnion(SysLockReg) BitUnion32(CfgCtrlReg) Bitfield< 11
Tick write(PacketPtr pkt) override
All writes are simply ignored.
Definition: rv_ctrl.cc:133
Bitfield< 30 > wr
Definition: rv_ctrl.hh:141
Bitfield< 15, 12 > pos
Definition: rv_ctrl.hh:137
uint32_t scData
This register contains the result from a system control reg access.
Definition: rv_ctrl.hh:158
Tick read(PacketPtr pkt) override
Handle a read to the device.
Definition: rv_ctrl.cc:57
uint32_t flags
This register is used for smp booting.
Definition: rv_ctrl.hh:154
void unserialize(CheckpointIn &cp) override
Unserialize an object.
Definition: rv_ctrl.cc:213
BitUnion32(SysLockReg) Bitfield< 15
Bitfield< 17, 16 > site
Definition: rv_ctrl.hh:138
Bitfield< 16 > locked
Definition: rv_ctrl.hh:132
void serialize(CheckpointOut &cp) const override
Serialize an object.
Definition: rv_ctrl.cc:207
Bitfield< 25, 20 > func
Definition: rv_ctrl.hh:139
Bitfield< 31 > start
Definition: rv_ctrl.hh:142
std::map< uint32_t, Device * > devices
Definition: rv_ctrl.hh:192
This is an implementation of a programmable oscillator on the that can be configured through the Real...
Definition: rv_ctrl.hh:204
virtual ~RealViewOsc()
Definition: rv_ctrl.hh:207
This device implements the temperature sensor used in the RealView/Versatile Express platform.
Definition: rv_ctrl.hh:230
RealViewTemperatureSensor(const RealViewTemperatureSensorParams &p)
Definition: rv_ctrl.hh:232
void write(uint32_t temp) override
Definition: rv_ctrl.hh:242
System * system
The system this RV device belongs to.
Definition: rv_ctrl.hh:246
Abstract superclass for simulation objects.
Definition: sim_object.hh:148
virtual void startup()
startup() is the final initialization call before simulation.
Definition: sim_object.cc:99
Bitfield< 54 > p
Definition: pagetable.hh:70
Bitfield< 15 > system
Definition: misc.hh:1004
Reference material can be found at the JEDEC website: UFS standard http://www.jedec....
std::ostream CheckpointOut
Definition: serialize.hh:66
uint64_t Tick
Tick count type.
Definition: types.hh:58
Overload hash function for BasicBlockRange type.
Definition: misc.hh:2826

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