Merge with the head.
[gem5.git] / src / arch / mips / isa_traits.hh
1 /*
2 * Copyright (c) 2003-2005 The Regents of The University of Michigan
3 * Copyright (c) 2007 MIPS Technologies, Inc.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
8 * met: redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer;
10 * redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution;
13 * neither the name of the copyright holders nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * Authors: Gabe Black
30 * Korey Sewell
31 * Jaidev Patwardhan
32 */
33
34 #ifndef __ARCH_MIPS_ISA_TRAITS_HH__
35 #define __ARCH_MIPS_ISA_TRAITS_HH__
36
37 #include "arch/mips/types.hh"
38 #include "arch/mips/mips_core_specific.hh"
39 #include "base/types.hh"
40 #include "config/full_system.hh"
41
42 namespace LittleEndianGuest {};
43
44 class StaticInstPtr;
45
46 namespace MipsISA
47 {
48
49 using namespace LittleEndianGuest;
50
51 StaticInstPtr decodeInst(ExtMachInst);
52
53 // MIPS DOES have a delay slot
54 #define ISA_HAS_DELAY_SLOT 1
55
56 const Addr PageShift = 13;
57 const Addr PageBytes = ULL(1) << PageShift;
58 const Addr Page_Mask = ~(PageBytes - 1);
59 const Addr PageOffset = PageBytes - 1;
60
61
62 ////////////////////////////////////////////////////////////////////////
63 //
64 // Translation stuff
65 //
66
67 const Addr PteShift = 3;
68 const Addr NPtePageShift = PageShift - PteShift;
69 const Addr NPtePage = ULL(1) << NPtePageShift;
70 const Addr PteMask = NPtePage - 1;
71
72 //// All 'Mapped' segments go through the TLB
73 //// All other segments are translated by dropping the MSB, to give
74 //// the corresponding physical address
75 // User Segment - Mapped
76 const Addr USegBase = ULL(0x0);
77 const Addr USegEnd = ULL(0x7FFFFFFF);
78
79 // Kernel Segment 0 - Unmapped
80 const Addr KSeg0End = ULL(0x9FFFFFFF);
81 const Addr KSeg0Base = ULL(0x80000000);
82 const Addr KSeg0Mask = ULL(0x1FFFFFFF);
83
84 // Kernel Segment 1 - Unmapped, Uncached
85 const Addr KSeg1End = ULL(0xBFFFFFFF);
86 const Addr KSeg1Base = ULL(0xA0000000);
87 const Addr KSeg1Mask = ULL(0x1FFFFFFF);
88
89 // Kernel/Supervisor Segment - Mapped
90 const Addr KSSegEnd = ULL(0xDFFFFFFF);
91 const Addr KSSegBase = ULL(0xC0000000);
92
93 // Kernel Segment 3 - Mapped
94 const Addr KSeg3End = ULL(0xFFFFFFFF);
95 const Addr KSeg3Base = ULL(0xE0000000);
96
97
98 // For loading... XXX This maybe could be USegEnd?? --ali
99 const Addr LoadAddrMask = ULL(0xffffffffff);
100
101 inline Addr Phys2K0Seg(Addr addr)
102 {
103 return addr | KSeg0Base;
104 }
105
106
107 const unsigned VABits = 32;
108 const unsigned PABits = 32; // Is this correct?
109 const Addr VAddrImplMask = (ULL(1) << VABits) - 1;
110 const Addr VAddrUnImplMask = ~VAddrImplMask;
111 inline Addr VAddrImpl(Addr a) { return a & VAddrImplMask; }
112 inline Addr VAddrVPN(Addr a) { return a >> MipsISA::PageShift; }
113 inline Addr VAddrOffset(Addr a) { return a & MipsISA::PageOffset; }
114
115 const Addr PAddrImplMask = (ULL(1) << PABits) - 1;
116
117 ////////////////////////////////////////////////////////////////////////
118 //
119 // Interrupt levels
120 //
121 enum InterruptLevels
122 {
123 INTLEVEL_SOFTWARE_MIN = 4,
124 INTLEVEL_SOFTWARE_MAX = 19,
125
126 INTLEVEL_EXTERNAL_MIN = 20,
127 INTLEVEL_EXTERNAL_MAX = 34,
128
129 INTLEVEL_IRQ0 = 20,
130 INTLEVEL_IRQ1 = 21,
131 INTINDEX_ETHERNET = 0,
132 INTINDEX_SCSI = 1,
133 INTLEVEL_IRQ2 = 22,
134 INTLEVEL_IRQ3 = 23,
135
136 INTLEVEL_SERIAL = 33,
137
138 NumInterruptLevels = INTLEVEL_EXTERNAL_MAX
139 };
140
141 // MIPS modes
142 enum mode_type
143 {
144 mode_kernel = 0, // kernel
145 mode_supervisor = 1, // supervisor
146 mode_user = 2, // user mode
147 mode_debug = 3, // debug mode
148 mode_number // number of modes
149 };
150
151 // return a no-op instruction... used for instruction fetch faults
152 const ExtMachInst NoopMachInst = 0x00000000;
153
154 const int LogVMPageSize = 13; // 8K bytes
155 const int VMPageSize = (1 << LogVMPageSize);
156
157 const int BranchPredAddrShiftAmt = 2; // instructions are 4-byte aligned
158
159 const int MachineBytes = 4;
160 const int WordBytes = 4;
161 const int HalfwordBytes = 2;
162 const int ByteBytes = 1;
163
164 const int ANNOTE_NONE = 0;
165 const uint32_t ITOUCH_ANNOTE = 0xffffffff;
166
167 };
168
169 #endif // __ARCH_MIPS_ISA_TRAITS_HH__