types.hh revision 7498
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) 2007-2008 The Florida State University
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: Stephen Hines
41 */
42
43#ifndef __ARCH_ARM_TYPES_HH__
44#define __ARCH_ARM_TYPES_HH__
45
46#include "base/bitunion.hh"
47#include "base/types.hh"
48
49namespace ArmISA
50{
51    typedef uint32_t MachInst;
52
53    BitUnion64(ExtMachInst)
54        Bitfield<63, 56> newItstate;
55        // ITSTATE bits
56        Bitfield<55, 48> itstate;
57        Bitfield<55, 52> itstateCond;
58        Bitfield<51, 48> itstateMask;
59
60        // FPSCR fields
61        Bitfield<41, 40> fpscrStride;
62        Bitfield<39, 37> fpscrLen;
63
64        // Bitfields to select mode.
65        Bitfield<36>     thumb;
66        Bitfield<35>     bigThumb;
67
68        // Made up bitfields that make life easier.
69        Bitfield<33>     sevenAndFour;
70        Bitfield<32>     isMisc;
71
72        uint32_t         instBits;
73
74        // All the different types of opcode fields.
75        Bitfield<27, 25> encoding;
76        Bitfield<25>     useImm;
77        Bitfield<24, 21> opcode;
78        Bitfield<24, 20> mediaOpcode;
79        Bitfield<24>     opcode24;
80        Bitfield<24, 23> opcode24_23;
81        Bitfield<23, 20> opcode23_20;
82        Bitfield<23, 21> opcode23_21;
83        Bitfield<20>     opcode20;
84        Bitfield<22>     opcode22;
85        Bitfield<19, 16> opcode19_16;
86        Bitfield<19>     opcode19;
87        Bitfield<18>     opcode18;
88        Bitfield<15, 12> opcode15_12;
89        Bitfield<15>     opcode15;
90        Bitfield<7,  4>  miscOpcode;
91        Bitfield<7,5>    opc2;
92        Bitfield<7>      opcode7;
93        Bitfield<6>      opcode6;
94        Bitfield<4>      opcode4;
95
96        Bitfield<31, 28> condCode;
97        Bitfield<20>     sField;
98        Bitfield<19, 16> rn;
99        Bitfield<15, 12> rd;
100        Bitfield<15, 12> rt;
101        Bitfield<11, 7>  shiftSize;
102        Bitfield<6,  5>  shift;
103        Bitfield<3,  0>  rm;
104
105        Bitfield<11, 8>  rs;
106
107        SubBitUnion(puswl, 24, 20)
108            Bitfield<24> prepost;
109            Bitfield<23> up;
110            Bitfield<22> psruser;
111            Bitfield<21> writeback;
112            Bitfield<20> loadOp;
113        EndSubBitUnion(puswl)
114
115        Bitfield<24, 20> pubwl;
116
117        Bitfield<7, 0> imm;
118
119        Bitfield<11, 8>  rotate;
120
121        Bitfield<11, 0>  immed11_0;
122        Bitfield<7,  0>  immed7_0;
123
124        Bitfield<11, 8>  immedHi11_8;
125        Bitfield<3,  0>  immedLo3_0;
126
127        Bitfield<15, 0>  regList;
128
129        Bitfield<23, 0>  offset;
130
131        Bitfield<23, 0>  immed23_0;
132
133        Bitfield<11, 8>  cpNum;
134        Bitfield<18, 16> fn;
135        Bitfield<14, 12> fd;
136        Bitfield<3>      fpRegImm;
137        Bitfield<3,  0>  fm;
138        Bitfield<2,  0>  fpImm;
139        Bitfield<24, 20> punwl;
140
141        Bitfield<7,  0>  m5Func;
142
143        // 16 bit thumb bitfields
144        Bitfield<15, 13> topcode15_13;
145        Bitfield<13, 11> topcode13_11;
146        Bitfield<12, 11> topcode12_11;
147        Bitfield<12, 10> topcode12_10;
148        Bitfield<11, 9>  topcode11_9;
149        Bitfield<11, 8>  topcode11_8;
150        Bitfield<10, 9>  topcode10_9;
151        Bitfield<10, 8>  topcode10_8;
152        Bitfield<9,  6>  topcode9_6;
153        Bitfield<7>      topcode7;
154        Bitfield<7, 6>   topcode7_6;
155        Bitfield<7, 5>   topcode7_5;
156        Bitfield<7, 4>   topcode7_4;
157        Bitfield<3, 0>   topcode3_0;
158
159        // 32 bit thumb bitfields
160        Bitfield<28, 27> htopcode12_11;
161        Bitfield<26, 25> htopcode10_9;
162        Bitfield<25>     htopcode9;
163        Bitfield<25, 24> htopcode9_8;
164        Bitfield<25, 21> htopcode9_5;
165        Bitfield<25, 20> htopcode9_4;
166        Bitfield<24>     htopcode8;
167        Bitfield<24, 23> htopcode8_7;
168        Bitfield<24, 22> htopcode8_6;
169        Bitfield<24, 21> htopcode8_5;
170        Bitfield<23>     htopcode7;
171        Bitfield<23, 21> htopcode7_5;
172        Bitfield<22>     htopcode6;
173        Bitfield<22, 21> htopcode6_5;
174        Bitfield<21, 20> htopcode5_4;
175        Bitfield<20>     htopcode4;
176
177        Bitfield<19, 16> htrn;
178        Bitfield<20>     hts;
179
180        Bitfield<15>     ltopcode15;
181        Bitfield<11, 8>  ltopcode11_8;
182        Bitfield<7,  6>  ltopcode7_6;
183        Bitfield<7,  4>  ltopcode7_4;
184        Bitfield<4>      ltopcode4;
185
186        Bitfield<11, 8>  ltrd;
187        Bitfield<11, 8>  ltcoproc;
188    EndBitUnion(ExtMachInst)
189
190    // Shift types for ARM instructions
191    enum ArmShiftType {
192        LSL = 0,
193        LSR,
194        ASR,
195        ROR
196    };
197
198    typedef uint64_t LargestRead;
199    // Need to use 64 bits to make sure that read requests get handled properly
200
201    typedef int RegContextParam;
202    typedef int RegContextVal;
203
204    //used in FP convert & round function
205    enum ConvertType{
206        SINGLE_TO_DOUBLE,
207        SINGLE_TO_WORD,
208        SINGLE_TO_LONG,
209
210        DOUBLE_TO_SINGLE,
211        DOUBLE_TO_WORD,
212        DOUBLE_TO_LONG,
213
214        LONG_TO_SINGLE,
215        LONG_TO_DOUBLE,
216        LONG_TO_WORD,
217        LONG_TO_PS,
218
219        WORD_TO_SINGLE,
220        WORD_TO_DOUBLE,
221        WORD_TO_LONG,
222        WORD_TO_PS,
223
224        PL_TO_SINGLE,
225        PU_TO_SINGLE
226    };
227
228    //used in FP convert & round function
229    enum RoundMode{
230        RND_ZERO,
231        RND_DOWN,
232        RND_UP,
233        RND_NEAREST
234    };
235
236    enum OperatingMode {
237        MODE_USER = 16,
238        MODE_FIQ = 17,
239        MODE_IRQ = 18,
240        MODE_SVC = 19,
241        MODE_MON = 22,
242        MODE_ABORT = 23,
243        MODE_UNDEFINED = 27,
244        MODE_SYSTEM = 31,
245        MODE_MAXMODE = MODE_SYSTEM
246    };
247
248    static inline bool
249    badMode(OperatingMode mode)
250    {
251        switch (mode) {
252          case MODE_USER:
253          case MODE_FIQ:
254          case MODE_IRQ:
255          case MODE_SVC:
256          case MODE_MON:
257          case MODE_ABORT:
258          case MODE_UNDEFINED:
259          case MODE_SYSTEM:
260            return false;
261          default:
262            return true;
263        }
264    }
265
266    struct CoreSpecific {
267        // Empty for now on the ARM
268    };
269
270} // namespace ArmISA
271
272#endif
273