system.hh revision 10844:8551af601f75 
1/*
2 * Copyright (c) 2010, 2012-2013 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 * Copyright (c) 2002-2005 The Regents of The University of Michigan
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Ali Saidi
41 */
42
43#ifndef __ARCH_ARM_SYSTEM_HH__
44#define __ARCH_ARM_SYSTEM_HH__
45
46#include <string>
47#include <vector>
48
49#include "kern/linux/events.hh"
50#include "params/ArmSystem.hh"
51#include "params/GenericArmSystem.hh"
52#include "sim/sim_object.hh"
53#include "sim/system.hh"
54
55class GenericTimer;
56class ThreadContext;
57
58class ArmSystem : public System
59{
60  protected:
61    /**
62     * PC based event to skip the dprink() call and emulate its
63     * functionality
64     */
65    Linux::DebugPrintkEvent *debugPrintkEvent;
66
67    /**
68     * Pointer to the bootloader object
69     */
70    ObjectFile *bootldr;
71
72    /**
73     * True if this system implements the Security Extensions
74     */
75    const bool _haveSecurity;
76
77    /**
78     * True if this system implements the Large Physical Address Extension
79     */
80    const bool _haveLPAE;
81
82    /**
83     * True if this system implements the virtualization Extensions
84     */
85    const bool _haveVirtualization;
86
87    /**
88     * True if this system implements the Generic Timer extension
89     */
90    const bool _haveGenericTimer;
91
92    /**
93     * Pointer to the Generic Timer wrapper.
94     */
95    GenericTimer *_genericTimer;
96
97    /**
98     * True if the register width of the highest implemented exception level is
99     * 64 bits (ARMv8)
100     */
101    bool _highestELIs64;
102
103    /**
104     * Reset address if the highest implemented exception level is 64 bits
105     * (ARMv8)
106     */
107    const Addr _resetAddr64;
108
109    /**
110     * Supported physical address range in bits if the highest implemented
111     * exception level is 64 bits (ARMv8)
112     */
113    const uint8_t _physAddrRange64;
114
115    /**
116     * True if ASID is 16 bits in AArch64 (ARMv8)
117     */
118    const bool _haveLargeAsid64;
119
120  public:
121    typedef ArmSystemParams Params;
122    const Params *
123    params() const
124    {
125        return dynamic_cast<const Params *>(_params);
126    }
127
128    ArmSystem(Params *p);
129    ~ArmSystem();
130
131    /**
132     * Initialise the system
133     */
134    virtual void initState();
135
136    virtual Addr fixFuncEventAddr(Addr addr)
137    {
138        // Remove the low bit that thumb symbols have set
139        // but that aren't actually odd aligned
140        if (addr & 0x1)
141            return addr & ~1;
142        return addr;
143    }
144
145    /** true if this a multiprocessor system */
146    bool multiProc;
147
148    /** Returns true if this system implements the Security Extensions */
149    bool haveSecurity() const { return _haveSecurity; }
150
151    /** Returns true if this system implements the Large Physical Address
152     * Extension */
153    bool haveLPAE() const { return _haveLPAE; }
154
155    /** Returns true if this system implements the virtualization
156      * Extensions
157      */
158    bool haveVirtualization() const { return _haveVirtualization; }
159
160    /** Returns true if this system implements the Generic Timer extension. */
161    bool haveGenericTimer() const { return _haveGenericTimer; }
162
163    /** Sets the pointer to the Generic Timer. */
164    void setGenericTimer(GenericTimer *generic_timer)
165    {
166        _genericTimer = generic_timer;
167    }
168
169    /** Get a pointer to the system's generic timer model */
170    GenericTimer *getGenericTimer() const { return _genericTimer; }
171
172    /** Returns true if the register width of the highest implemented exception
173     * level is 64 bits (ARMv8) */
174    bool highestELIs64() const { return _highestELIs64; }
175
176    /** Returns the highest implemented exception level */
177    ExceptionLevel highestEL() const
178    {
179        if (_haveSecurity)
180            return EL3;
181        // @todo: uncomment this to enable Virtualization
182        // if (_haveVirtualization)
183        //     return EL2;
184        return EL1;
185    }
186
187    /** Returns the reset address if the highest implemented exception level is
188     * 64 bits (ARMv8) */
189    Addr resetAddr64() const { return _resetAddr64; }
190
191    /** Returns true if ASID is 16 bits in AArch64 (ARMv8) */
192    bool haveLargeAsid64() const { return _haveLargeAsid64; }
193
194    /** Returns the supported physical address range in bits if the highest
195     * implemented exception level is 64 bits (ARMv8) */
196    uint8_t physAddrRange64() const { return _physAddrRange64; }
197
198    /** Returns the supported physical address range in bits */
199    uint8_t physAddrRange() const
200    {
201        if (_highestELIs64)
202            return _physAddrRange64;
203        if (_haveLPAE)
204            return 40;
205        return 32;
206    }
207
208    /** Returns the physical address mask */
209    Addr physAddrMask() const
210    {
211        return mask(physAddrRange());
212    }
213
214    /** Returns true if the system of a specific thread context implements the
215     * Security Extensions
216     */
217    static bool haveSecurity(ThreadContext *tc);
218
219    /** Returns true if the system of a specific thread context implements the
220     * virtualization Extensions
221     */
222    static bool haveVirtualization(ThreadContext *tc);
223
224    /** Returns true if the system of a specific thread context implements the
225     * Large Physical Address Extension
226     */
227    static bool haveLPAE(ThreadContext *tc);
228
229    /** Returns true if the register width of the highest implemented exception
230     * level for the system of a specific thread context is 64 bits (ARMv8)
231     */
232    static bool highestELIs64(ThreadContext *tc);
233
234    /** Returns the highest implemented exception level for the system of a
235     * specific thread context
236     */
237    static ExceptionLevel highestEL(ThreadContext *tc);
238
239    /** Returns the reset address if the highest implemented exception level for
240     * the system of a specific thread context is 64 bits (ARMv8)
241     */
242    static Addr resetAddr64(ThreadContext *tc);
243
244    /** Returns the supported physical address range in bits for the system of a
245     * specific thread context
246     */
247    static uint8_t physAddrRange(ThreadContext *tc);
248
249    /** Returns the physical address mask for the system of a specific thread
250     * context
251     */
252    static Addr physAddrMask(ThreadContext *tc);
253
254    /** Returns true if ASID is 16 bits for the system of a specific thread
255     * context while in AArch64 (ARMv8) */
256    static bool haveLargeAsid64(ThreadContext *tc);
257};
258
259class GenericArmSystem : public ArmSystem
260{
261  public:
262    typedef GenericArmSystemParams Params;
263    const Params *
264    params() const
265    {
266        return dynamic_cast<const Params *>(_params);
267    }
268
269    GenericArmSystem(Params *p) : ArmSystem(p) {};
270    virtual ~GenericArmSystem() {};
271
272    /**
273     * Initialise the system
274     */
275    virtual void initState();
276};
277
278#endif
279