2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met: redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer;
9 * redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution;
12 * neither the name of the copyright holders nor the names of its
13 * contributors may be used to endorse or promote products derived from
14 * this software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 #ifndef __SPARC_FAULTS_HH__
33 #define __SPARC_FAULTS_HH__
35 #include "cpu/static_inst.hh"
36 #include "sim/faults.hh"
38 // The design of the "name" and "vect" functions is in sim/faults.hh
43 typedef uint32_t TrapType;
44 typedef uint32_t FaultPriority;
48 class SparcFaultBase : public FaultBase
55 H, Hyperprivileged = H,
63 const TrapType trapType;
64 const FaultPriority priority;
65 const PrivilegeLevel nextPrivilegeLevel[NumLevels];
68 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
69 StaticInst::nullStaticInstPtr);
70 virtual TrapType trapType() = 0;
71 virtual FaultPriority priority() = 0;
72 virtual FaultStat & countStat() = 0;
73 virtual PrivilegeLevel getNextLevel(PrivilegeLevel current) = 0;
77 class SparcFault : public SparcFaultBase
80 static FaultVals vals;
82 FaultName name() const { return vals.name; }
83 TrapType trapType() { return vals.trapType; }
84 FaultPriority priority() { return vals.priority; }
85 FaultStat & countStat() { return vals.count; }
88 getNextLevel(PrivilegeLevel current)
90 return vals.nextPrivilegeLevel[current];
94 class PowerOnReset : public SparcFault<PowerOnReset>
96 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
97 StaticInst::nullStaticInstPtr);
100 class WatchDogReset : public SparcFault<WatchDogReset> {};
102 class ExternallyInitiatedReset : public SparcFault<ExternallyInitiatedReset> {};
104 class SoftwareInitiatedReset : public SparcFault<SoftwareInitiatedReset> {};
106 class REDStateException : public SparcFault<REDStateException> {};
108 class StoreError : public SparcFault<StoreError> {};
110 class InstructionAccessException : public SparcFault<InstructionAccessException> {};
112 // class InstructionAccessMMUMiss : public SparcFault<InstructionAccessMMUMiss> {};
114 class InstructionAccessError : public SparcFault<InstructionAccessError> {};
116 class IllegalInstruction : public SparcFault<IllegalInstruction> {};
118 class PrivilegedOpcode : public SparcFault<PrivilegedOpcode> {};
120 // class UnimplementedLDD : public SparcFault<UnimplementedLDD> {};
122 // class UnimplementedSTD : public SparcFault<UnimplementedSTD> {};
124 class FpDisabled : public SparcFault<FpDisabled> {};
125 class VecDisabled : public SparcFault<VecDisabled> {};
127 class FpExceptionIEEE754 : public SparcFault<FpExceptionIEEE754> {};
129 class FpExceptionOther : public SparcFault<FpExceptionOther> {};
131 class TagOverflow : public SparcFault<TagOverflow> {};
133 class CleanWindow : public SparcFault<CleanWindow> {};
135 class DivisionByZero : public SparcFault<DivisionByZero> {};
137 class InternalProcessorError :
138 public SparcFault<InternalProcessorError> {};
140 class InstructionInvalidTSBEntry :
141 public SparcFault<InstructionInvalidTSBEntry> {};
143 class DataInvalidTSBEntry : public SparcFault<DataInvalidTSBEntry> {};
145 class DataAccessException : public SparcFault<DataAccessException> {};
147 // class DataAccessMMUMiss : public SparcFault<DataAccessMMUMiss> {};
149 class DataAccessError : public SparcFault<DataAccessError> {};
151 class DataAccessProtection : public SparcFault<DataAccessProtection> {};
153 class MemAddressNotAligned :
154 public SparcFault<MemAddressNotAligned> {};
156 class LDDFMemAddressNotAligned : public SparcFault<LDDFMemAddressNotAligned> {};
158 class STDFMemAddressNotAligned : public SparcFault<STDFMemAddressNotAligned> {};
160 class PrivilegedAction : public SparcFault<PrivilegedAction> {};
162 class LDQFMemAddressNotAligned : public SparcFault<LDQFMemAddressNotAligned> {};
164 class STQFMemAddressNotAligned : public SparcFault<STQFMemAddressNotAligned> {};
166 class InstructionRealTranslationMiss :
167 public SparcFault<InstructionRealTranslationMiss> {};
169 class DataRealTranslationMiss : public SparcFault<DataRealTranslationMiss> {};
171 // class AsyncDataError : public SparcFault<AsyncDataError> {};
174 class EnumeratedFault : public SparcFault<T>
179 EnumeratedFault(uint32_t n) : SparcFault<T>(), _n(n) {}
180 TrapType trapType() { return SparcFault<T>::trapType() + _n; }
183 class InterruptLevelN : public EnumeratedFault<InterruptLevelN>
186 InterruptLevelN(uint32_t n) : EnumeratedFault<InterruptLevelN>(n) {;}
187 FaultPriority priority() { return 3200 - _n*100; }
190 class HstickMatch : public SparcFault<HstickMatch> {};
192 class TrapLevelZero : public SparcFault<TrapLevelZero> {};
194 class InterruptVector : public SparcFault<InterruptVector> {};
196 class PAWatchpoint : public SparcFault<PAWatchpoint> {};
198 class VAWatchpoint : public SparcFault<VAWatchpoint> {};
200 class FastInstructionAccessMMUMiss :
201 public SparcFault<FastInstructionAccessMMUMiss>
206 FastInstructionAccessMMUMiss(Addr addr) : vaddr(addr)
208 FastInstructionAccessMMUMiss() : vaddr(0)
210 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
211 StaticInst::nullStaticInstPtr);
214 class FastDataAccessMMUMiss : public SparcFault<FastDataAccessMMUMiss>
219 FastDataAccessMMUMiss(Addr addr) : vaddr(addr)
221 FastDataAccessMMUMiss() : vaddr(0)
223 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
224 StaticInst::nullStaticInstPtr);
227 class FastDataAccessProtection : public SparcFault<FastDataAccessProtection> {};
229 class InstructionBreakpoint : public SparcFault<InstructionBreakpoint> {};
231 class CpuMondo : public SparcFault<CpuMondo> {};
233 class DevMondo : public SparcFault<DevMondo> {};
235 class ResumableError : public SparcFault<ResumableError> {};
237 class SpillNNormal : public EnumeratedFault<SpillNNormal>
240 SpillNNormal(uint32_t n) : EnumeratedFault<SpillNNormal>(n) {;}
241 // These need to be handled specially to enable spill traps in SE
242 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
243 StaticInst::nullStaticInstPtr);
246 class SpillNOther : public EnumeratedFault<SpillNOther>
249 SpillNOther(uint32_t n) : EnumeratedFault<SpillNOther>(n)
253 class FillNNormal : public EnumeratedFault<FillNNormal>
256 FillNNormal(uint32_t n) : EnumeratedFault<FillNNormal>(n)
258 // These need to be handled specially to enable fill traps in SE
259 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
260 StaticInst::nullStaticInstPtr);
263 class FillNOther : public EnumeratedFault<FillNOther>
266 FillNOther(uint32_t n) : EnumeratedFault<FillNOther>(n)
270 class TrapInstruction : public EnumeratedFault<TrapInstruction>
273 TrapInstruction(uint32_t n) : EnumeratedFault<TrapInstruction>(n)
275 // In SE, trap instructions are requesting services from the OS.
276 void invoke(ThreadContext * tc, const StaticInstPtr &inst =
277 StaticInst::nullStaticInstPtr);
281 * Explicitly declare template static member variables to avoid warnings
282 * in some clang versions
284 template<> SparcFaultBase::FaultVals SparcFault<PowerOnReset>::vals;
285 template<> SparcFaultBase::FaultVals SparcFault<WatchDogReset>::vals;
286 template<> SparcFaultBase::FaultVals
287 SparcFault<ExternallyInitiatedReset>::vals;
288 template<> SparcFaultBase::FaultVals SparcFault<SoftwareInitiatedReset>::vals;
289 template<> SparcFaultBase::FaultVals SparcFault<REDStateException>::vals;
290 template<> SparcFaultBase::FaultVals SparcFault<StoreError>::vals;
291 template<> SparcFaultBase::FaultVals
292 SparcFault<InstructionAccessException>::vals;
293 template<> SparcFaultBase::FaultVals SparcFault<InstructionAccessError>::vals;
294 template<> SparcFaultBase::FaultVals SparcFault<IllegalInstruction>::vals;
295 template<> SparcFaultBase::FaultVals SparcFault<PrivilegedOpcode>::vals;
296 template<> SparcFaultBase::FaultVals SparcFault<FpDisabled>::vals;
297 template<> SparcFaultBase::FaultVals SparcFault<VecDisabled>::vals;
298 template<> SparcFaultBase::FaultVals SparcFault<FpExceptionIEEE754>::vals;
299 template<> SparcFaultBase::FaultVals SparcFault<FpExceptionOther>::vals;
300 template<> SparcFaultBase::FaultVals SparcFault<TagOverflow>::vals;
301 template<> SparcFaultBase::FaultVals SparcFault<CleanWindow>::vals;
302 template<> SparcFaultBase::FaultVals SparcFault<DivisionByZero>::vals;
303 template<> SparcFaultBase::FaultVals SparcFault<InternalProcessorError>::vals;
304 template<> SparcFaultBase::FaultVals
305 SparcFault<InstructionInvalidTSBEntry>::vals;
306 template<> SparcFaultBase::FaultVals SparcFault<DataInvalidTSBEntry>::vals;
307 template<> SparcFaultBase::FaultVals SparcFault<DataAccessException>::vals;
308 template<> SparcFaultBase::FaultVals SparcFault<DataAccessError>::vals;
309 template<> SparcFaultBase::FaultVals SparcFault<DataAccessProtection>::vals;
310 template<> SparcFaultBase::FaultVals SparcFault<MemAddressNotAligned>::vals;
311 template<> SparcFaultBase::FaultVals
312 SparcFault<LDDFMemAddressNotAligned>::vals;
313 template<> SparcFaultBase::FaultVals
314 SparcFault<STDFMemAddressNotAligned>::vals;
315 template<> SparcFaultBase::FaultVals SparcFault<PrivilegedAction>::vals;
316 template<> SparcFaultBase::FaultVals
317 SparcFault<LDQFMemAddressNotAligned>::vals;
318 template<> SparcFaultBase::FaultVals
319 SparcFault<STQFMemAddressNotAligned>::vals;
320 template<> SparcFaultBase::FaultVals
321 SparcFault<InstructionRealTranslationMiss>::vals;
322 template<> SparcFaultBase::FaultVals SparcFault<DataRealTranslationMiss>::vals;
323 template<> SparcFaultBase::FaultVals SparcFault<InterruptLevelN>::vals;
324 template<> SparcFaultBase::FaultVals SparcFault<HstickMatch>::vals;
325 template<> SparcFaultBase::FaultVals SparcFault<TrapLevelZero>::vals;
326 template<> SparcFaultBase::FaultVals SparcFault<InterruptVector>::vals;
327 template<> SparcFaultBase::FaultVals SparcFault<PAWatchpoint>::vals;
328 template<> SparcFaultBase::FaultVals SparcFault<VAWatchpoint>::vals;
329 template<> SparcFaultBase::FaultVals
330 SparcFault<FastInstructionAccessMMUMiss>::vals;
331 template<> SparcFaultBase::FaultVals SparcFault<FastDataAccessMMUMiss>::vals;
333 SparcFaultBase::FaultVals SparcFault<FastDataAccessProtection>::vals;
334 template<> SparcFaultBase::FaultVals SparcFault<InstructionBreakpoint>::vals;
335 template<> SparcFaultBase::FaultVals SparcFault<CpuMondo>::vals;
336 template<> SparcFaultBase::FaultVals SparcFault<DevMondo>::vals;
337 template<> SparcFaultBase::FaultVals SparcFault<ResumableError>::vals;
338 template<> SparcFaultBase::FaultVals SparcFault<SpillNNormal>::vals;
339 template<> SparcFaultBase::FaultVals SparcFault<SpillNOther>::vals;
340 template<> SparcFaultBase::FaultVals SparcFault<FillNNormal>::vals;
341 template<> SparcFaultBase::FaultVals SparcFault<FillNOther>::vals;
342 template<> SparcFaultBase::FaultVals SparcFault<TrapInstruction>::vals;
345 void enterREDState(ThreadContext *tc);
347 void doREDFault(ThreadContext *tc, TrapType tt);
349 void doNormalFault(ThreadContext *tc, TrapType tt, bool gotoHpriv);
351 void getREDVector(MiscReg TT, Addr &PC, Addr &NPC);
353 void getHyperVector(ThreadContext * tc, Addr &PC, Addr &NPC, MiscReg TT);
355 void getPrivVector(ThreadContext *tc, Addr &PC, Addr &NPC, MiscReg TT,
358 } // namespace SparcISA
360 #endif // __SPARC_FAULTS_HH__