1/*
2 * Copyright (c) 2010 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) 2003-2005 The Regents of The University of Michigan
15 * Copyright (c) 2007-2008 The Florida State University
16 * All rights reserved.
17 *
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions are
20 * met: redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer;
22 * redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution;
25 * neither the name of the copyright holders nor the names of its
26 * contributors may be used to endorse or promote products derived from
27 * this software without specific prior written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 *
41 * Authors: Ali Saidi
42 * Gabe Black
43 */
44
45#ifndef __ARM_FAULTS_HH__
46#define __ARM_FAULTS_HH__
47
48#include "arch/arm/miscregs.hh"
49#include "arch/arm/types.hh"
50#include "config/full_system.hh"
51#include "sim/faults.hh"
52#include "base/misc.hh"
53
54// The design of the "name" and "vect" functions is in sim/faults.hh
55
56namespace ArmISA
57{
58typedef const Addr FaultOffset;
59
60class ArmFault : public FaultBase
61{
62 protected:
63 Addr getVector(ThreadContext *tc);
64
65 public:
66 enum StatusEncoding
67 {
68 // Fault Status register encodings
69 // ARM ARM B3.9.4
70 AlignmentFault = 0x1,
71 DebugEvent = 0x2,
72 AccessFlag0 = 0x3,
73 InstructionCacheMaintenance = 0x4,
74 Translation0 = 0x5,
75 AccessFlag1 = 0x6,
76 Translation1 = 0x7,
77 SynchronousExternalAbort0 = 0x8,
78 Domain0 = 0x9,
79 SynchronousExternalAbort1 = 0x8,
80 Domain1 = 0xb,
81 TranslationTableWalkExtAbt0 = 0xc,
82 Permission0 = 0xd,
83 TranslationTableWalkExtAbt1 = 0xe,
84 Permission1 = 0xf,
85 AsynchronousExternalAbort = 0x16,
86 MemoryAccessAsynchronousParityError = 0x18,
87 MemoryAccessSynchronousParityError = 0x19,
88 TranslationTableWalkPrtyErr0 = 0x1c,
89 TranslationTableWalkPrtyErr1 = 0x1e,
90 };
91
92 struct FaultVals
93 {
94 const FaultName name;
95 const FaultOffset offset;
96 const OperatingMode nextMode;
97 const uint8_t armPcOffset;
98 const uint8_t thumbPcOffset;
99 const bool abortDisable;
100 const bool fiqDisable;
101 FaultStat count;
102 };
103
104#if FULL_SYSTEM
105 void invoke(ThreadContext *tc);
106#endif
107 virtual FaultStat& countStat() = 0;
108 virtual FaultOffset offset() = 0;
109 virtual OperatingMode nextMode() = 0;
110 virtual uint8_t armPcOffset() = 0;
111 virtual uint8_t thumbPcOffset() = 0;
112 virtual bool abortDisable() = 0;
113 virtual bool fiqDisable() = 0;
114};
115
116template<typename T>
117class ArmFaultVals : public ArmFault
118{
119 protected:
120 static FaultVals vals;
121
122 public:
123 FaultName name() const { return vals.name; }
124 FaultStat & countStat() {return vals.count;}
125 FaultOffset offset() { return vals.offset; }
126 OperatingMode nextMode() { return vals.nextMode; }
127 uint8_t armPcOffset() { return vals.armPcOffset; }
128 uint8_t thumbPcOffset() { return vals.thumbPcOffset; }
129 bool abortDisable() { return vals.abortDisable; }
130 bool fiqDisable() { return vals.fiqDisable; }
131};
132
133class Reset : public ArmFaultVals<Reset>
134#if FULL_SYSTEM
135{
136 public:
137 void invoke(ThreadContext *tc);
138};
139#else
140{};
141#endif //FULL_SYSTEM
142
143class UndefinedInstruction : public ArmFaultVals<UndefinedInstruction>
144{
145#if !FULL_SYSTEM
146 protected:
147 ExtMachInst machInst;
148 bool unknown;
149 const char *mnemonic;
150
151 public:
152 UndefinedInstruction(ExtMachInst _machInst,
153 bool _unknown,
154 const char *_mnemonic = NULL) :
155 machInst(_machInst), unknown(_unknown), mnemonic(_mnemonic)
156 {
157 }
158
159 void invoke(ThreadContext *tc);
160#endif
161};
162
163class SupervisorCall : public ArmFaultVals<SupervisorCall>
164{
165#if !FULL_SYSTEM
166 protected:
167 ExtMachInst machInst;
168
169 public:
170 SupervisorCall(ExtMachInst _machInst) : machInst(_machInst)
171 {}
172
173 void invoke(ThreadContext *tc);
174#endif
175};
176
177template <class T>
178class AbortFault : public ArmFaultVals<T>
179{
180 protected:
181 Addr faultAddr;
182 bool write;
183 uint8_t domain;
184 uint8_t status;
185
186 public:
187 AbortFault(Addr _faultAddr, bool _write,
188 uint8_t _domain, uint8_t _status) :
189 faultAddr(_faultAddr), write(_write),
190 domain(_domain), status(_status)
191 {}
192
193 void invoke(ThreadContext *tc);
194};
195
196class PrefetchAbort : public AbortFault<PrefetchAbort>
197{
198 public:
199 static const MiscRegIndex FsrIndex = MISCREG_IFSR;
200 static const MiscRegIndex FarIndex = MISCREG_IFAR;
201
202 PrefetchAbort(Addr _addr, uint8_t _status) :
203 AbortFault<PrefetchAbort>(_addr, false, 0, _status)
204 {}
205};
206
207class DataAbort : public AbortFault<DataAbort>
208{
209 public:
210 static const MiscRegIndex FsrIndex = MISCREG_DFSR;
211 static const MiscRegIndex FarIndex = MISCREG_DFAR;
212
213 DataAbort(Addr _addr, uint8_t _domain, bool _write, uint8_t _status) :
214 AbortFault<DataAbort>(_addr, _write, _domain, _status)
215 {}
216};
217
218class Interrupt : public ArmFaultVals<Interrupt> {};
219class FastInterrupt : public ArmFaultVals<FastInterrupt> {};
220
221static inline Fault genMachineCheckFault()
222{
223 return new Reset();
224}
225
226} // ArmISA namespace
227
228#endif // __ARM_FAULTS_HH__