2 * Copyright (c) 2010,2013,2015 ARM Limited
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.
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.
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.
40 #ifndef __DEV_ARM_RV_HH__
41 #define __DEV_ARM_RV_HH__
43 #include "base/bitunion.hh"
44 #include "dev/io_device.hh"
45 #include "params/RealViewCtrl.hh"
46 #include "params/RealViewOsc.hh"
47 #include "params/RealViewTemperatureSensor.hh"
50 * This implements the simple real view registers on a PBXA9
53 class RealViewCtrl : public BasicPioDevice
74 Device(RealViewCtrl &parent, DeviceFunc func,
75 uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev)
77 parent.registerDevice(func, site, pos, dcc, dev, this);
82 virtual uint32_t read() const = 0;
83 virtual void write(uint32_t value) = 0;
127 BitUnion32(SysLockReg)
128 Bitfield<15,0> lockVal;
130 EndBitUnion(SysLockReg)
132 BitUnion32(CfgCtrlReg)
134 Bitfield<15, 12> pos;
135 Bitfield<17, 16> site;
136 Bitfield<25, 20> func;
137 Bitfield<29, 26> dcc;
140 EndBitUnion(CfgCtrlReg)
142 static const uint32_t CFG_CTRL_ADDR_MASK = 0x3fffffffUL;
146 /** This register is used for smp booting.
147 * The primary cpu writes the secondary start address here before
148 * sends it a soft interrupt. The secondary cpu reads this register and if
149 * it's non-zero it jumps to the address
153 /** This register contains the result from a system control reg access
158 typedef RealViewCtrlParams Params;
162 return dynamic_cast<const Params *>(_params);
165 * The constructor for RealView just registers itself with the MMU.
166 * @param p params structure
168 RealViewCtrl(Params *p);
171 * Handle a read to the device
172 * @param pkt The memory request.
173 * @param data Where to put the data.
175 Tick read(PacketPtr pkt) override;
178 * All writes are simply ignored.
179 * @param pkt The memory request.
180 * @param data the data
182 Tick write(PacketPtr pkt) override;
184 void serialize(CheckpointOut &cp) const override;
185 void unserialize(CheckpointIn &cp) override;
188 void registerDevice(DeviceFunc func, uint8_t site, uint8_t pos,
189 uint8_t dcc, uint16_t dev,
193 std::map<uint32_t, Device *> devices;
197 * This is an implementation of a programmable oscillator on the that
198 * can be configured through the RealView/Versatile Express
199 * configuration interface.
201 * See ARM DUI 0447J (ARM Motherboard Express uATX -- V2M-P1).
204 : public ClockDomain, RealViewCtrl::Device
207 RealViewOsc(RealViewOscParams *p);
208 virtual ~RealViewOsc() {};
210 void startup() override;
212 void serialize(CheckpointOut &cp) const override;
213 void unserialize(CheckpointIn &cp) override;
215 public: // RealViewCtrl::Device interface
216 uint32_t read() const override;
217 void write(uint32_t freq) override;
220 void clockPeriod(Tick clock_period);
224 * This device implements the temperature sensor used in the
225 * RealView/Versatile Express platform.
227 * See ARM DUI 0447J (ARM Motherboard Express uATX -- V2M-P1).
229 class RealViewTemperatureSensor
230 : public SimObject, RealViewCtrl::Device
233 RealViewTemperatureSensor(RealViewTemperatureSensorParams *p)
235 RealViewCtrl::Device(*p->parent, RealViewCtrl::FUNC_TEMP,
236 p->site, p->position, p->dcc, p->device),
239 virtual ~RealViewTemperatureSensor() {};
241 public: // RealViewCtrl::Device interface
242 uint32_t read() const override;
243 void write(uint32_t temp) override {}
246 /** The system this RV device belongs to */
251 #endif // __DEV_ARM_RV_HH__