e6703f81a400c988b431fb005e97c6454508a7ca
[external/binutils.git] / include / opcode / mips.h
1 /* mips.h.  Mips opcode list for GDB, the GNU debugger.
2    Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
3    2003, 2004, 2005, 2008, 2009, 2010
4    Free Software Foundation, Inc.
5    Contributed by Ralph Campbell and OSF
6    Commented and modified by Ian Lance Taylor, Cygnus Support
7
8    This file is part of GDB, GAS, and the GNU binutils.
9
10    GDB, GAS, and the GNU binutils are free software; you can redistribute
11    them and/or modify them under the terms of the GNU General Public
12    License as published by the Free Software Foundation; either version 3,
13    or (at your option) any later version.
14
15    GDB, GAS, and the GNU binutils are distributed in the hope that they
16    will be useful, but WITHOUT ANY WARRANTY; without even the implied
17    warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
18    the GNU General Public License for more details.
19
20    You should have received a copy of the GNU General Public License
21    along with this file; see the file COPYING3.  If not, write to the Free
22    Software Foundation, 51 Franklin Street - Fifth Floor, Boston,
23    MA 02110-1301, USA.  */
24
25 #ifndef _MIPS_H_
26 #define _MIPS_H_
27
28 /* These are bit masks and shift counts to use to access the various
29    fields of an instruction.  To retrieve the X field of an
30    instruction, use the expression
31         (i >> OP_SH_X) & OP_MASK_X
32    To set the same field (to j), use
33         i = (i &~ (OP_MASK_X << OP_SH_X)) | (j << OP_SH_X)
34
35    Make sure you use fields that are appropriate for the instruction,
36    of course.
37
38    The 'i' format uses OP, RS, RT and IMMEDIATE.
39
40    The 'j' format uses OP and TARGET.
41
42    The 'r' format uses OP, RS, RT, RD, SHAMT and FUNCT.
43
44    The 'b' format uses OP, RS, RT and DELTA.
45
46    The floating point 'i' format uses OP, RS, RT and IMMEDIATE.
47
48    The floating point 'r' format uses OP, FMT, FT, FS, FD and FUNCT.
49
50    A breakpoint instruction uses OP, CODE and SPEC (10 bits of the
51    breakpoint instruction are not defined; Kane says the breakpoint
52    code field in BREAK is 20 bits; yet MIPS assemblers and debuggers
53    only use ten bits).  An optional two-operand form of break/sdbbp
54    allows the lower ten bits to be set too, and MIPS32 and later
55    architectures allow 20 bits to be set with a signal operand
56    (using CODE20).
57
58    The syscall instruction uses CODE20.
59
60    The general coprocessor instructions use COPZ.  */
61
62 #define OP_MASK_OP              0x3f
63 #define OP_SH_OP                26
64 #define OP_MASK_RS              0x1f
65 #define OP_SH_RS                21
66 #define OP_MASK_FR              0x1f
67 #define OP_SH_FR                21
68 #define OP_MASK_FMT             0x1f
69 #define OP_SH_FMT               21
70 #define OP_MASK_BCC             0x7
71 #define OP_SH_BCC               18
72 #define OP_MASK_CODE            0x3ff
73 #define OP_SH_CODE              16
74 #define OP_MASK_CODE2           0x3ff
75 #define OP_SH_CODE2             6
76 #define OP_MASK_RT              0x1f
77 #define OP_SH_RT                16
78 #define OP_MASK_FT              0x1f
79 #define OP_SH_FT                16
80 #define OP_MASK_CACHE           0x1f
81 #define OP_SH_CACHE             16
82 #define OP_MASK_RD              0x1f
83 #define OP_SH_RD                11
84 #define OP_MASK_FS              0x1f
85 #define OP_SH_FS                11
86 #define OP_MASK_PREFX           0x1f
87 #define OP_SH_PREFX             11
88 #define OP_MASK_CCC             0x7
89 #define OP_SH_CCC               8
90 #define OP_MASK_CODE20          0xfffff /* 20 bit syscall/breakpoint code.  */
91 #define OP_SH_CODE20            6
92 #define OP_MASK_SHAMT           0x1f
93 #define OP_SH_SHAMT             6
94 #define OP_MASK_EXTLSB          OP_MASK_SHAMT
95 #define OP_SH_EXTLSB            OP_SH_SHAMT
96 #define OP_MASK_STYPE           OP_MASK_SHAMT
97 #define OP_SH_STYPE             OP_SH_SHAMT
98 #define OP_MASK_FD              0x1f
99 #define OP_SH_FD                6
100 #define OP_MASK_TARGET          0x3ffffff
101 #define OP_SH_TARGET            0
102 #define OP_MASK_COPZ            0x1ffffff
103 #define OP_SH_COPZ              0
104 #define OP_MASK_IMMEDIATE       0xffff
105 #define OP_SH_IMMEDIATE         0
106 #define OP_MASK_DELTA           0xffff
107 #define OP_SH_DELTA             0
108 #define OP_MASK_FUNCT           0x3f
109 #define OP_SH_FUNCT             0
110 #define OP_MASK_SPEC            0x3f
111 #define OP_SH_SPEC              0
112 #define OP_SH_LOCC              8       /* FP condition code.  */
113 #define OP_SH_HICC              18      /* FP condition code.  */
114 #define OP_MASK_CC              0x7
115 #define OP_SH_COP1NORM          25      /* Normal COP1 encoding.  */
116 #define OP_MASK_COP1NORM        0x1     /* a single bit.  */
117 #define OP_SH_COP1SPEC          21      /* COP1 encodings.  */
118 #define OP_MASK_COP1SPEC        0xf
119 #define OP_MASK_COP1SCLR        0x4
120 #define OP_MASK_COP1CMP         0x3
121 #define OP_SH_COP1CMP           4
122 #define OP_SH_FORMAT            21      /* FP short format field.  */
123 #define OP_MASK_FORMAT          0x7
124 #define OP_SH_TRUE              16
125 #define OP_MASK_TRUE            0x1
126 #define OP_SH_GE                17
127 #define OP_MASK_GE              0x01
128 #define OP_SH_UNSIGNED          16
129 #define OP_MASK_UNSIGNED        0x1
130 #define OP_SH_HINT              16
131 #define OP_MASK_HINT            0x1f
132 #define OP_SH_MMI               0       /* Multimedia (parallel) op.  */
133 #define OP_MASK_MMI             0x3f
134 #define OP_SH_MMISUB            6
135 #define OP_MASK_MMISUB          0x1f
136 #define OP_MASK_PERFREG         0x1f    /* Performance monitoring.  */
137 #define OP_SH_PERFREG           1
138 #define OP_SH_SEL               0       /* Coprocessor select field.  */
139 #define OP_MASK_SEL             0x7     /* The sel field of mfcZ and mtcZ.  */
140 #define OP_SH_CODE19            6       /* 19 bit wait code.  */
141 #define OP_MASK_CODE19          0x7ffff
142 #define OP_SH_ALN               21
143 #define OP_MASK_ALN             0x7
144 #define OP_SH_VSEL              21
145 #define OP_MASK_VSEL            0x1f
146 #define OP_MASK_VECBYTE         0x7     /* Selector field is really 4 bits,
147                                            but 0x8-0xf don't select bytes.  */
148 #define OP_SH_VECBYTE           22
149 #define OP_MASK_VECALIGN        0x7     /* Vector byte-align (alni.ob) op.  */
150 #define OP_SH_VECALIGN          21
151 #define OP_MASK_INSMSB          0x1f    /* "ins" MSB.  */
152 #define OP_SH_INSMSB            11
153 #define OP_MASK_EXTMSBD         0x1f    /* "ext" MSBD.  */
154 #define OP_SH_EXTMSBD           11
155
156 /* MIPS DSP ASE */
157 #define OP_SH_DSPACC            11
158 #define OP_MASK_DSPACC          0x3
159 #define OP_SH_DSPACC_S          21
160 #define OP_MASK_DSPACC_S        0x3
161 #define OP_SH_DSPSFT            20
162 #define OP_MASK_DSPSFT          0x3f
163 #define OP_SH_DSPSFT_7          19
164 #define OP_MASK_DSPSFT_7        0x7f
165 #define OP_SH_SA3               21
166 #define OP_MASK_SA3             0x7
167 #define OP_SH_SA4               21
168 #define OP_MASK_SA4             0xf
169 #define OP_SH_IMM8              16
170 #define OP_MASK_IMM8            0xff
171 #define OP_SH_IMM10             16
172 #define OP_MASK_IMM10           0x3ff
173 #define OP_SH_WRDSP             11
174 #define OP_MASK_WRDSP           0x3f
175 #define OP_SH_RDDSP             16
176 #define OP_MASK_RDDSP           0x3f
177 #define OP_SH_BP                11
178 #define OP_MASK_BP              0x3
179
180 /* MIPS MT ASE */
181 #define OP_SH_MT_U              5
182 #define OP_MASK_MT_U            0x1
183 #define OP_SH_MT_H              4
184 #define OP_MASK_MT_H            0x1
185 #define OP_SH_MTACC_T           18
186 #define OP_MASK_MTACC_T         0x3
187 #define OP_SH_MTACC_D           13
188 #define OP_MASK_MTACC_D         0x3
189
190 /* MIPS MCU ASE */
191 #define OP_MASK_3BITPOS         0x7
192 #define OP_SH_3BITPOS           12
193 #define OP_MASK_OFFSET12        0xfff
194 #define OP_SH_OFFSET12          0
195
196 #define OP_OP_COP0              0x10
197 #define OP_OP_COP1              0x11
198 #define OP_OP_COP2              0x12
199 #define OP_OP_COP3              0x13
200 #define OP_OP_LWC1              0x31
201 #define OP_OP_LWC2              0x32
202 #define OP_OP_LWC3              0x33    /* a.k.a. pref */
203 #define OP_OP_LDC1              0x35
204 #define OP_OP_LDC2              0x36
205 #define OP_OP_LDC3              0x37    /* a.k.a. ld */
206 #define OP_OP_SWC1              0x39
207 #define OP_OP_SWC2              0x3a
208 #define OP_OP_SWC3              0x3b
209 #define OP_OP_SDC1              0x3d
210 #define OP_OP_SDC2              0x3e
211 #define OP_OP_SDC3              0x3f    /* a.k.a. sd */
212
213 /* Values in the 'VSEL' field.  */
214 #define MDMX_FMTSEL_IMM_QH      0x1d
215 #define MDMX_FMTSEL_IMM_OB      0x1e
216 #define MDMX_FMTSEL_VEC_QH      0x15
217 #define MDMX_FMTSEL_VEC_OB      0x16
218
219 /* UDI */
220 #define OP_SH_UDI1              6
221 #define OP_MASK_UDI1            0x1f
222 #define OP_SH_UDI2              6
223 #define OP_MASK_UDI2            0x3ff
224 #define OP_SH_UDI3              6
225 #define OP_MASK_UDI3            0x7fff
226 #define OP_SH_UDI4              6
227 #define OP_MASK_UDI4            0xfffff
228
229 /* Octeon */
230 #define OP_SH_BBITIND           16
231 #define OP_MASK_BBITIND         0x1f
232 #define OP_SH_CINSPOS           6
233 #define OP_MASK_CINSPOS         0x1f
234 #define OP_SH_CINSLM1           11
235 #define OP_MASK_CINSLM1         0x1f
236 #define OP_SH_SEQI              6
237 #define OP_MASK_SEQI            0x3ff
238
239 /* Loongson */
240 #define OP_SH_OFFSET_A          6
241 #define OP_MASK_OFFSET_A        0xff
242 #define OP_SH_OFFSET_B          3
243 #define OP_MASK_OFFSET_B        0xff
244 #define OP_SH_OFFSET_C          6
245 #define OP_MASK_OFFSET_C        0x1ff
246 #define OP_SH_RZ                0
247 #define OP_MASK_RZ              0x1f
248 #define OP_SH_FZ                0
249 #define OP_MASK_FZ              0x1f
250
251 /* Every MICROMIPSOP_X definition requires a corresponding OP_X
252    definition, and vice versa.  This simplifies various parts
253    of the operand handling in GAS.  The fields below only exist
254    in the microMIPS encoding, so define each one to have an empty
255    range.  */
256 #define OP_MASK_CODE10          0
257 #define OP_SH_CODE10            0
258 #define OP_MASK_TRAP            0
259 #define OP_SH_TRAP              0
260 #define OP_MASK_OFFSET10        0
261 #define OP_SH_OFFSET10          0
262 #define OP_MASK_RS3             0
263 #define OP_SH_RS3               0
264 #define OP_MASK_MB              0
265 #define OP_SH_MB                0
266 #define OP_MASK_MC              0
267 #define OP_SH_MC                0
268 #define OP_MASK_MD              0
269 #define OP_SH_MD                0
270 #define OP_MASK_ME              0
271 #define OP_SH_ME                0
272 #define OP_MASK_MF              0
273 #define OP_SH_MF                0
274 #define OP_MASK_MG              0
275 #define OP_SH_MG                0
276 #define OP_MASK_MH              0
277 #define OP_SH_MH                0
278 #define OP_MASK_MI              0
279 #define OP_SH_MI                0
280 #define OP_MASK_MJ              0
281 #define OP_SH_MJ                0
282 #define OP_MASK_ML              0
283 #define OP_SH_ML                0
284 #define OP_MASK_MM              0
285 #define OP_SH_MM                0
286 #define OP_MASK_MN              0
287 #define OP_SH_MN                0
288 #define OP_MASK_MP              0
289 #define OP_SH_MP                0
290 #define OP_MASK_MQ              0
291 #define OP_SH_MQ                0
292 #define OP_MASK_IMMA            0
293 #define OP_SH_IMMA              0
294 #define OP_MASK_IMMB            0
295 #define OP_SH_IMMB              0
296 #define OP_MASK_IMMC            0
297 #define OP_SH_IMMC              0
298 #define OP_MASK_IMMF            0
299 #define OP_SH_IMMF              0
300 #define OP_MASK_IMMG            0
301 #define OP_SH_IMMG              0
302 #define OP_MASK_IMMH            0
303 #define OP_SH_IMMH              0
304 #define OP_MASK_IMMI            0
305 #define OP_SH_IMMI              0
306 #define OP_MASK_IMMJ            0
307 #define OP_SH_IMMJ              0
308 #define OP_MASK_IMML            0
309 #define OP_SH_IMML              0
310 #define OP_MASK_IMMM            0
311 #define OP_SH_IMMM              0
312 #define OP_MASK_IMMN            0
313 #define OP_SH_IMMN              0
314 #define OP_MASK_IMMO            0
315 #define OP_SH_IMMO              0
316 #define OP_MASK_IMMP            0
317 #define OP_SH_IMMP              0
318 #define OP_MASK_IMMQ            0
319 #define OP_SH_IMMQ              0
320 #define OP_MASK_IMMU            0
321 #define OP_SH_IMMU              0
322 #define OP_MASK_IMMW            0
323 #define OP_SH_IMMW              0
324 #define OP_MASK_IMMX            0
325 #define OP_SH_IMMX              0
326 #define OP_MASK_IMMY            0
327 #define OP_SH_IMMY              0
328
329 /* This structure holds information for a particular instruction.  */
330
331 struct mips_opcode
332 {
333   /* The name of the instruction.  */
334   const char *name;
335   /* A string describing the arguments for this instruction.  */
336   const char *args;
337   /* The basic opcode for the instruction.  When assembling, this
338      opcode is modified by the arguments to produce the actual opcode
339      that is used.  If pinfo is INSN_MACRO, then this is 0.  */
340   unsigned long match;
341   /* If pinfo is not INSN_MACRO, then this is a bit mask for the
342      relevant portions of the opcode when disassembling.  If the
343      actual opcode anded with the match field equals the opcode field,
344      then we have found the correct instruction.  If pinfo is
345      INSN_MACRO, then this field is the macro identifier.  */
346   unsigned long mask;
347   /* For a macro, this is INSN_MACRO.  Otherwise, it is a collection
348      of bits describing the instruction, notably any relevant hazard
349      information.  */
350   unsigned long pinfo;
351   /* A collection of additional bits describing the instruction. */
352   unsigned long pinfo2;
353   /* A collection of bits describing the instruction sets of which this
354      instruction or macro is a member. */
355   unsigned long membership;
356 };
357
358 /* These are the characters which may appear in the args field of an
359    instruction.  They appear in the order in which the fields appear
360    when the instruction is used.  Commas and parentheses in the args
361    string are ignored when assembling, and written into the output
362    when disassembling.
363
364    Each of these characters corresponds to a mask field defined above.
365
366    "1" 5 bit sync type (OP_*_SHAMT)
367    "<" 5 bit shift amount (OP_*_SHAMT)
368    ">" shift amount between 32 and 63, stored after subtracting 32 (OP_*_SHAMT)
369    "a" 26 bit target address (OP_*_TARGET)
370    "b" 5 bit base register (OP_*_RS)
371    "c" 10 bit breakpoint code (OP_*_CODE)
372    "d" 5 bit destination register specifier (OP_*_RD)
373    "h" 5 bit prefx hint (OP_*_PREFX)
374    "i" 16 bit unsigned immediate (OP_*_IMMEDIATE)
375    "j" 16 bit signed immediate (OP_*_DELTA)
376    "k" 5 bit cache opcode in target register position (OP_*_CACHE)
377        Also used for immediate operands in vr5400 vector insns.
378    "o" 16 bit signed offset (OP_*_DELTA)
379    "p" 16 bit PC relative branch target address (OP_*_DELTA)
380    "q" 10 bit extra breakpoint code (OP_*_CODE2)
381    "r" 5 bit same register used as both source and target (OP_*_RS)
382    "s" 5 bit source register specifier (OP_*_RS)
383    "t" 5 bit target register (OP_*_RT)
384    "u" 16 bit upper 16 bits of address (OP_*_IMMEDIATE)
385    "v" 5 bit same register used as both source and destination (OP_*_RS)
386    "w" 5 bit same register used as both target and destination (OP_*_RT)
387    "U" 5 bit same destination register in both OP_*_RD and OP_*_RT
388        (used by clo and clz)
389    "C" 25 bit coprocessor function code (OP_*_COPZ)
390    "B" 20 bit syscall/breakpoint function code (OP_*_CODE20)
391    "J" 19 bit wait function code (OP_*_CODE19)
392    "x" accept and ignore register name
393    "z" must be zero register
394    "K" 5 bit Hardware Register (rdhwr instruction) (OP_*_RD)
395    "+A" 5 bit ins/ext/dins/dext/dinsm/dextm position, which becomes
396         LSB (OP_*_SHAMT; OP_*_EXTLSB or OP_*_STYPE may be used for
397         microMIPS compatibility).
398         Enforces: 0 <= pos < 32.
399    "+B" 5 bit ins/dins size, which becomes MSB (OP_*_INSMSB).
400         Requires that "+A" or "+E" occur first to set position.
401         Enforces: 0 < (pos+size) <= 32.
402    "+C" 5 bit ext/dext size, which becomes MSBD (OP_*_EXTMSBD).
403         Requires that "+A" or "+E" occur first to set position.
404         Enforces: 0 < (pos+size) <= 32.
405         (Also used by "dext" w/ different limits, but limits for
406         that are checked by the M_DEXT macro.)
407    "+E" 5 bit dinsu/dextu position, which becomes LSB-32 (OP_*_SHAMT).
408         Enforces: 32 <= pos < 64.
409    "+F" 5 bit "dinsm/dinsu" size, which becomes MSB-32 (OP_*_INSMSB).
410         Requires that "+A" or "+E" occur first to set position.
411         Enforces: 32 < (pos+size) <= 64.
412    "+G" 5 bit "dextm" size, which becomes MSBD-32 (OP_*_EXTMSBD).
413         Requires that "+A" or "+E" occur first to set position.
414         Enforces: 32 < (pos+size) <= 64.
415    "+H" 5 bit "dextu" size, which becomes MSBD (OP_*_EXTMSBD).
416         Requires that "+A" or "+E" occur first to set position.
417         Enforces: 32 < (pos+size) <= 64.
418
419    Floating point instructions:
420    "D" 5 bit destination register (OP_*_FD)
421    "M" 3 bit compare condition code (OP_*_CCC) (only used for mips4 and up)
422    "N" 3 bit branch condition code (OP_*_BCC) (only used for mips4 and up)
423    "S" 5 bit fs source 1 register (OP_*_FS)
424    "T" 5 bit ft source 2 register (OP_*_FT)
425    "R" 5 bit fr source 3 register (OP_*_FR)
426    "V" 5 bit same register used as floating source and destination (OP_*_FS)
427    "W" 5 bit same register used as floating target and destination (OP_*_FT)
428
429    Coprocessor instructions:
430    "E" 5 bit target register (OP_*_RT)
431    "G" 5 bit destination register (OP_*_RD)
432    "H" 3 bit sel field for (d)mtc* and (d)mfc* (OP_*_SEL)
433    "P" 5 bit performance-monitor register (OP_*_PERFREG)
434    "e" 5 bit vector register byte specifier (OP_*_VECBYTE)
435    "%" 3 bit immediate vr5400 vector alignment operand (OP_*_VECALIGN)
436    see also "k" above
437    "+D" Combined destination register ("G") and sel ("H") for CP0 ops,
438         for pretty-printing in disassembly only.
439
440    Macro instructions:
441    "A" General 32 bit expression
442    "I" 32 bit immediate (value placed in imm_expr).
443    "+I" 32 bit immediate (value placed in imm2_expr).
444    "F" 64 bit floating point constant in .rdata
445    "L" 64 bit floating point constant in .lit8
446    "f" 32 bit floating point constant
447    "l" 32 bit floating point constant in .lit4
448
449    MDMX instruction operands (note that while these use the FP register
450    fields, they accept both $fN and $vN names for the registers):  
451    "O"  MDMX alignment offset (OP_*_ALN)
452    "Q"  MDMX vector/scalar/immediate source (OP_*_VSEL and OP_*_FT)
453    "X"  MDMX destination register (OP_*_FD) 
454    "Y"  MDMX source register (OP_*_FS)
455    "Z"  MDMX source register (OP_*_FT)
456
457    DSP ASE usage:
458    "2" 2 bit unsigned immediate for byte align (OP_*_BP)
459    "3" 3 bit unsigned immediate (OP_*_SA3)
460    "4" 4 bit unsigned immediate (OP_*_SA4)
461    "5" 8 bit unsigned immediate (OP_*_IMM8)
462    "6" 5 bit unsigned immediate (OP_*_RS)
463    "7" 2 bit dsp accumulator register (OP_*_DSPACC)
464    "8" 6 bit unsigned immediate (OP_*_WRDSP)
465    "9" 2 bit dsp accumulator register (OP_*_DSPACC_S)
466    "0" 6 bit signed immediate (OP_*_DSPSFT)
467    ":" 7 bit signed immediate (OP_*_DSPSFT_7)
468    "'" 6 bit unsigned immediate (OP_*_RDDSP)
469    "@" 10 bit signed immediate (OP_*_IMM10)
470
471    MT ASE usage:
472    "!" 1 bit usermode flag (OP_*_MT_U)
473    "$" 1 bit load high flag (OP_*_MT_H)
474    "*" 2 bit dsp/smartmips accumulator register (OP_*_MTACC_T)
475    "&" 2 bit dsp/smartmips accumulator register (OP_*_MTACC_D)
476    "g" 5 bit coprocessor 1 and 2 destination register (OP_*_RD)
477    "+t" 5 bit coprocessor 0 destination register (OP_*_RT)
478    "+T" 5 bit coprocessor 0 destination register (OP_*_RT) - disassembly only
479
480    MCU ASE usage:
481    "~" 12 bit offset (OP_*_OFFSET12)
482    "\" 3 bit position for aset and aclr (OP_*_3BITPOS)
483
484    UDI immediates:
485    "+1" UDI immediate bits 6-10
486    "+2" UDI immediate bits 6-15
487    "+3" UDI immediate bits 6-20
488    "+4" UDI immediate bits 6-25
489
490    Octeon:
491    "+x" Bit index field of bbit.  Enforces: 0 <= index < 32.
492    "+X" Bit index field of bbit aliasing bbit32.  Matches if 32 <= index < 64,
493         otherwise skips to next candidate.
494    "+p" Position field of cins/cins32/exts/exts32. Enforces 0 <= pos < 32.
495    "+P" Position field of cins/exts aliasing cins32/exts32.  Matches if
496         32 <= pos < 64, otherwise skips to next candidate.
497    "+Q" Immediate field of seqi/snei.  Enforces -512 <= imm < 512.
498    "+s" Length-minus-one field of cins/exts.  Enforces: 0 <= lenm1 < 32.
499    "+S" Length-minus-one field of cins32/exts32 or cins/exts aliasing
500         cint32/exts32.  Enforces non-negative value and that
501         pos + lenm1 < 32 or pos + lenm1 < 64 depending whether previous
502         position field is "+p" or "+P".
503
504    Loongson-3A:
505    "+a" 8-bit signed offset in bit 6 (OP_*_OFFSET_A)
506    "+b" 8-bit signed offset in bit 3 (OP_*_OFFSET_B)
507    "+c" 9-bit signed offset in bit 6 (OP_*_OFFSET_C)
508    "+z" 5-bit rz register (OP_*_RZ)
509    "+Z" 5-bit fz register (OP_*_FZ)
510
511    Other:
512    "()" parens surrounding optional value
513    ","  separates operands
514    "[]" brackets around index for vector-op scalar operand specifier (vr5400)
515    "+"  Start of extension sequence.
516
517    Characters used so far, for quick reference when adding more:
518    "1234567890"
519    "%[]<>(),+:'@!$*&\~"
520    "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
521    "abcdefghijklopqrstuvwxz"
522
523    Extension character sequences used so far ("+" followed by the
524    following), for quick reference when adding more:
525    "1234"
526    "ABCDEFGHIPQSTXZ"
527    "abcpstxz"
528 */
529
530 /* These are the bits which may be set in the pinfo field of an
531    instructions, if it is not equal to INSN_MACRO.  */
532
533 /* Modifies the general purpose register in OP_*_RD.  */
534 #define INSN_WRITE_GPR_D            0x00000001
535 /* Modifies the general purpose register in OP_*_RT.  */
536 #define INSN_WRITE_GPR_T            0x00000002
537 /* Modifies general purpose register 31.  */
538 #define INSN_WRITE_GPR_31           0x00000004
539 /* Modifies the floating point register in OP_*_FD.  */
540 #define INSN_WRITE_FPR_D            0x00000008
541 /* Modifies the floating point register in OP_*_FS.  */
542 #define INSN_WRITE_FPR_S            0x00000010
543 /* Modifies the floating point register in OP_*_FT.  */
544 #define INSN_WRITE_FPR_T            0x00000020
545 /* Reads the general purpose register in OP_*_RS.  */
546 #define INSN_READ_GPR_S             0x00000040
547 /* Reads the general purpose register in OP_*_RT.  */
548 #define INSN_READ_GPR_T             0x00000080
549 /* Reads the floating point register in OP_*_FS.  */
550 #define INSN_READ_FPR_S             0x00000100
551 /* Reads the floating point register in OP_*_FT.  */
552 #define INSN_READ_FPR_T             0x00000200
553 /* Reads the floating point register in OP_*_FR.  */
554 #define INSN_READ_FPR_R             0x00000400
555 /* Modifies coprocessor condition code.  */
556 #define INSN_WRITE_COND_CODE        0x00000800
557 /* Reads coprocessor condition code.  */
558 #define INSN_READ_COND_CODE         0x00001000
559 /* TLB operation.  */
560 #define INSN_TLB                    0x00002000
561 /* Reads coprocessor register other than floating point register.  */
562 #define INSN_COP                    0x00004000
563 /* Instruction loads value from memory, requiring delay.  */
564 #define INSN_LOAD_MEMORY_DELAY      0x00008000
565 /* Instruction loads value from coprocessor, requiring delay.  */
566 #define INSN_LOAD_COPROC_DELAY      0x00010000
567 /* Instruction has unconditional branch delay slot.  */
568 #define INSN_UNCOND_BRANCH_DELAY    0x00020000
569 /* Instruction has conditional branch delay slot.  */
570 #define INSN_COND_BRANCH_DELAY      0x00040000
571 /* Conditional branch likely: if branch not taken, insn nullified.  */
572 #define INSN_COND_BRANCH_LIKELY     0x00080000
573 /* Moves to coprocessor register, requiring delay.  */
574 #define INSN_COPROC_MOVE_DELAY      0x00100000
575 /* Loads coprocessor register from memory, requiring delay.  */
576 #define INSN_COPROC_MEMORY_DELAY    0x00200000
577 /* Reads the HI register.  */
578 #define INSN_READ_HI                0x00400000
579 /* Reads the LO register.  */
580 #define INSN_READ_LO                0x00800000
581 /* Modifies the HI register.  */
582 #define INSN_WRITE_HI               0x01000000
583 /* Modifies the LO register.  */
584 #define INSN_WRITE_LO               0x02000000
585 /* Not to be placed in a branch delay slot, either architecturally
586    or for ease of handling (such as with instructions that take a trap).  */
587 #define INSN_NO_DELAY_SLOT          0x04000000
588 /* Instruction stores value into memory.  */
589 #define INSN_STORE_MEMORY           0x08000000
590 /* Instruction uses single precision floating point.  */
591 #define FP_S                        0x10000000
592 /* Instruction uses double precision floating point.  */
593 #define FP_D                        0x20000000
594 /* Instruction is part of the tx39's integer multiply family.    */
595 #define INSN_MULT                   0x40000000
596 /* Modifies the general purpose register in MICROMIPSOP_*_RS.  */
597 #define INSN_WRITE_GPR_S            0x80000000
598 /* Instruction is actually a macro.  It should be ignored by the
599    disassembler, and requires special treatment by the assembler.  */
600 #define INSN_MACRO                  0xffffffff
601
602 /* These are the bits which may be set in the pinfo2 field of an
603    instruction. */
604
605 /* Instruction is a simple alias (I.E. "move" for daddu/addu/or) */
606 #define INSN2_ALIAS                 0x00000001
607 /* Instruction reads MDMX accumulator. */
608 #define INSN2_READ_MDMX_ACC         0x00000002
609 /* Instruction writes MDMX accumulator. */
610 #define INSN2_WRITE_MDMX_ACC        0x00000004
611 /* Macro uses single-precision floating-point instructions.  This should
612    only be set for macros.  For instructions, FP_S in pinfo carries the
613    same information.  */
614 #define INSN2_M_FP_S                0x00000008
615 /* Macro uses double-precision floating-point instructions.  This should
616    only be set for macros.  For instructions, FP_D in pinfo carries the
617    same information.  */
618 #define INSN2_M_FP_D                0x00000010
619 /* Modifies the general purpose register in OP_*_RZ.  */
620 #define INSN2_WRITE_GPR_Z           0x00000020
621 /* Modifies the floating point register in OP_*_FZ.  */
622 #define INSN2_WRITE_FPR_Z           0x00000040
623 /* Reads the general purpose register in OP_*_RZ.  */
624 #define INSN2_READ_GPR_Z            0x00000080
625 /* Reads the floating point register in OP_*_FZ.  */
626 #define INSN2_READ_FPR_Z            0x00000100
627 /* Reads the general purpose register in OP_*_RD.  */
628 #define INSN2_READ_GPR_D            0x00000200
629
630
631 /* Instruction has a branch delay slot that requires a 16-bit instruction.  */
632 #define INSN2_BRANCH_DELAY_16BIT    0x00000400
633 /* Instruction has a branch delay slot that requires a 32-bit instruction.  */
634 #define INSN2_BRANCH_DELAY_32BIT    0x00000800
635 /* Reads the floating point register in MICROMIPSOP_*_FD.  */
636 #define INSN2_READ_FPR_D            0x00001000
637 /* Modifies the general purpose register in MICROMIPSOP_*_MB.  */
638 #define INSN2_WRITE_GPR_MB          0x00002000
639 /* Reads the general purpose register in MICROMIPSOP_*_MC.  */
640 #define INSN2_READ_GPR_MC           0x00004000
641 /* Reads/writes the general purpose register in MICROMIPSOP_*_MD.  */
642 #define INSN2_MOD_GPR_MD            0x00008000
643 /* Reads the general purpose register in MICROMIPSOP_*_ME.  */
644 #define INSN2_READ_GPR_ME           0x00010000
645 /* Reads/writes the general purpose register in MICROMIPSOP_*_MF.  */
646 #define INSN2_MOD_GPR_MF            0x00020000
647 /* Reads the general purpose register in MICROMIPSOP_*_MG.  */
648 #define INSN2_READ_GPR_MG           0x00040000
649 /* Reads the general purpose register in MICROMIPSOP_*_MJ.  */
650 #define INSN2_READ_GPR_MJ           0x00080000
651 /* Modifies the general purpose register in MICROMIPSOP_*_MJ.  */
652 #define INSN2_WRITE_GPR_MJ          0x00100000
653 /* Reads the general purpose register in MICROMIPSOP_*_MP.  */
654 #define INSN2_READ_GPR_MP           0x00200000
655 /* Modifies the general purpose register in MICROMIPSOP_*_MP.  */
656 #define INSN2_WRITE_GPR_MP          0x00400000
657 /* Reads the general purpose register in MICROMIPSOP_*_MQ.  */
658 #define INSN2_READ_GPR_MQ           0x00800000
659 /* Reads/Writes the stack pointer ($29).  */
660 #define INSN2_MOD_SP                0x01000000
661 /* Reads the RA ($31) register.  */
662 #define INSN2_READ_GPR_31           0x02000000
663 /* Reads the global pointer ($28).  */
664 #define INSN2_READ_GP               0x04000000
665 /* Reads the program counter ($pc).  */
666 #define INSN2_READ_PC               0x08000000
667 /* Is an unconditional branch insn. */
668 #define INSN2_UNCOND_BRANCH         0x10000000
669 /* Is a conditional branch insn. */
670 #define INSN2_COND_BRANCH           0x20000000
671 /* Modifies the general purpose registers in MICROMIPSOP_*_MH/I.  */
672 #define INSN2_WRITE_GPR_MHI         0x40000000
673 /* Reads the general purpose registers in MICROMIPSOP_*_MM/N.  */
674 #define INSN2_READ_GPR_MMN          0x80000000
675
676 /* Masks used to mark instructions to indicate which MIPS ISA level
677    they were introduced in.  INSN_ISA_MASK masks an enumeration that
678    specifies the base ISA level(s).  The remainder of a 32-bit
679    word constructed using these macros is a bitmask of the remaining
680    INSN_* values below.  */
681
682 #define INSN_ISA_MASK             0x0000000ful
683
684 /* We cannot start at zero due to ISA_UNKNOWN below.  */
685 #define INSN_ISA1                 1
686 #define INSN_ISA2                 2
687 #define INSN_ISA3                 3
688 #define INSN_ISA4                 4
689 #define INSN_ISA5                 5
690 #define INSN_ISA32                6
691 #define INSN_ISA32R2              7
692 #define INSN_ISA64                8
693 #define INSN_ISA64R2              9
694 /* Below this point the INSN_* values correspond to combinations of ISAs.
695    They are only for use in the opcodes table to indicate membership of
696    a combination of ISAs that cannot be expressed using the usual inclusion
697    ordering on the above INSN_* values.  */
698 #define INSN_ISA3_32              10
699 #define INSN_ISA3_32R2            11
700 #define INSN_ISA4_32              12
701 #define INSN_ISA4_32R2            13
702 #define INSN_ISA5_32R2            14
703
704 /* Given INSN_ISA* values X and Y, where X ranges over INSN_ISA1 through
705    INSN_ISA5_32R2 and Y ranges over INSN_ISA1 through INSN_ISA64R2,
706    this table describes whether at least one of the ISAs described by X
707    is/are implemented by ISA Y.  (Think of Y as the ISA level supported by
708    a particular core and X as the ISA level(s) at which a certain instruction
709    is defined.)  The ISA(s) described by X is/are implemented by Y iff
710    (mips_isa_table[(Y & INSN_ISA_MASK) - 1] >> ((X & INSN_ISA_MASK) - 1)) & 1
711    is non-zero.  */
712 static const unsigned int mips_isa_table[] =
713   { 0x0001, 0x0003, 0x0607, 0x1e0f, 0x3e1f, 0x0a23, 0x3e63, 0x3ebf, 0x3fff };
714
715 /* Masks used for Chip specific instructions.  */
716 #define INSN_CHIP_MASK            0xc3ff0c20
717
718 /* Cavium Networks Octeon instructions.  */
719 #define INSN_OCTEON               0x00000800
720
721 /* Masks used for MIPS-defined ASEs.  */
722 #define INSN_ASE_MASK             0x3c00f010
723
724 /* DSP ASE */ 
725 #define INSN_DSP                  0x00001000
726 #define INSN_DSP64                0x00002000
727
728 /* 0x00004000 is unused.  */
729
730 /* MIPS-3D ASE */
731 #define INSN_MIPS3D               0x00008000
732
733 /* MIPS R4650 instruction.  */
734 #define INSN_4650                 0x00010000
735 /* LSI R4010 instruction.  */
736 #define INSN_4010                 0x00020000
737 /* NEC VR4100 instruction.  */
738 #define INSN_4100                 0x00040000
739 /* Toshiba R3900 instruction.  */
740 #define INSN_3900                 0x00080000
741 /* MIPS R10000 instruction.  */
742 #define INSN_10000                0x00100000
743 /* Broadcom SB-1 instruction.  */
744 #define INSN_SB1                  0x00200000
745 /* NEC VR4111/VR4181 instruction.  */
746 #define INSN_4111                 0x00400000
747 /* NEC VR4120 instruction.  */
748 #define INSN_4120                 0x00800000
749 /* NEC VR5400 instruction.  */
750 #define INSN_5400                 0x01000000
751 /* NEC VR5500 instruction.  */
752 #define INSN_5500                 0x02000000
753
754 /* MDMX ASE */ 
755 #define INSN_MDMX                 0x04000000
756 /* MT ASE */
757 #define INSN_MT                   0x08000000
758 /* SmartMIPS ASE  */
759 #define INSN_SMARTMIPS            0x10000000
760 /* DSP R2 ASE  */
761 #define INSN_DSPR2                0x20000000
762 /* ST Microelectronics Loongson 2E.  */
763 #define INSN_LOONGSON_2E          0x40000000
764 /* ST Microelectronics Loongson 2F.  */
765 #define INSN_LOONGSON_2F          0x80000000
766 /* Loongson 3A.  */
767 #define INSN_LOONGSON_3A          0x00000400
768 /* RMI Xlr instruction */
769 #define INSN_XLR                  0x00000020
770
771 /* MCU (MicroController) ASE */
772 #define INSN_MCU                  0x00000010
773
774 /* MIPS ISA defines, use instead of hardcoding ISA level.  */
775
776 #define       ISA_UNKNOWN     0               /* Gas internal use.  */
777 #define       ISA_MIPS1       INSN_ISA1
778 #define       ISA_MIPS2       INSN_ISA2
779 #define       ISA_MIPS3       INSN_ISA3
780 #define       ISA_MIPS4       INSN_ISA4
781 #define       ISA_MIPS5       INSN_ISA5
782
783 #define       ISA_MIPS32      INSN_ISA32
784 #define       ISA_MIPS64      INSN_ISA64
785
786 #define       ISA_MIPS32R2    INSN_ISA32R2
787 #define       ISA_MIPS64R2    INSN_ISA64R2
788
789
790 /* CPU defines, use instead of hardcoding processor number. Keep this
791    in sync with bfd/archures.c in order for machine selection to work.  */
792 #define CPU_UNKNOWN     0               /* Gas internal use.  */
793 #define CPU_R3000       3000
794 #define CPU_R3900       3900
795 #define CPU_R4000       4000
796 #define CPU_R4010       4010
797 #define CPU_VR4100      4100
798 #define CPU_R4111       4111
799 #define CPU_VR4120      4120
800 #define CPU_R4300       4300
801 #define CPU_R4400       4400
802 #define CPU_R4600       4600
803 #define CPU_R4650       4650
804 #define CPU_R5000       5000
805 #define CPU_VR5400      5400
806 #define CPU_VR5500      5500
807 #define CPU_R6000       6000
808 #define CPU_RM7000      7000
809 #define CPU_R8000       8000
810 #define CPU_RM9000      9000
811 #define CPU_R10000      10000
812 #define CPU_R12000      12000
813 #define CPU_R14000      14000
814 #define CPU_R16000      16000
815 #define CPU_MIPS16      16
816 #define CPU_MIPS32      32
817 #define CPU_MIPS32R2    33
818 #define CPU_MIPS5       5
819 #define CPU_MIPS64      64
820 #define CPU_MIPS64R2    65
821 #define CPU_SB1         12310201        /* octal 'SB', 01.  */
822 #define CPU_LOONGSON_2E 3001
823 #define CPU_LOONGSON_2F 3002
824 #define CPU_LOONGSON_3A 3003
825 #define CPU_OCTEON      6501
826 #define CPU_XLR         887682          /* decimal 'XLR'   */
827
828 /* Test for membership in an ISA including chip specific ISAs.  INSN
829    is pointer to an element of the opcode table; ISA is the specified
830    ISA/ASE bitmask to test against; and CPU is the CPU specific ISA to
831    test, or zero if no CPU specific ISA test is desired.  */
832
833 #define OPCODE_IS_MEMBER(insn, isa, cpu)                                \
834     (((isa & INSN_ISA_MASK) != 0                                        \
835       && ((insn)->membership & INSN_ISA_MASK) != 0                      \
836       && ((mips_isa_table [(isa & INSN_ISA_MASK) - 1] >>                \
837            (((insn)->membership & INSN_ISA_MASK) - 1)) & 1) != 0)       \
838      || ((isa & ~INSN_ISA_MASK)                                         \
839           & ((insn)->membership & ~INSN_ISA_MASK)) != 0                 \
840      || (cpu == CPU_R4650 && ((insn)->membership & INSN_4650) != 0)     \
841      || (cpu == CPU_RM7000 && ((insn)->membership & INSN_4650) != 0)    \
842      || (cpu == CPU_RM9000 && ((insn)->membership & INSN_4650) != 0)    \
843      || (cpu == CPU_R4010 && ((insn)->membership & INSN_4010) != 0)     \
844      || (cpu == CPU_VR4100 && ((insn)->membership & INSN_4100) != 0)    \
845      || (cpu == CPU_R3900 && ((insn)->membership & INSN_3900) != 0)     \
846      || ((cpu == CPU_R10000 || cpu == CPU_R12000 || cpu == CPU_R14000   \
847           || cpu == CPU_R16000)                                         \
848          && ((insn)->membership & INSN_10000) != 0)                     \
849      || (cpu == CPU_SB1 && ((insn)->membership & INSN_SB1) != 0)        \
850      || (cpu == CPU_R4111 && ((insn)->membership & INSN_4111) != 0)     \
851      || (cpu == CPU_VR4120 && ((insn)->membership & INSN_4120) != 0)    \
852      || (cpu == CPU_VR5400 && ((insn)->membership & INSN_5400) != 0)    \
853      || (cpu == CPU_VR5500 && ((insn)->membership & INSN_5500) != 0)    \
854      || (cpu == CPU_LOONGSON_2E                                         \
855          && ((insn)->membership & INSN_LOONGSON_2E) != 0)               \
856      || (cpu == CPU_LOONGSON_2F                                         \
857          && ((insn)->membership & INSN_LOONGSON_2F) != 0)               \
858      || (cpu == CPU_LOONGSON_3A                                         \
859          && ((insn)->membership & INSN_LOONGSON_3A) != 0)               \
860      || (cpu == CPU_OCTEON                                              \
861          && ((insn)->membership & INSN_OCTEON) != 0)                    \
862      || (cpu == CPU_XLR && ((insn)->membership & INSN_XLR) != 0)        \
863      || 0)      /* Please keep this term for easier source merging.  */
864
865 /* This is a list of macro expanded instructions.
866
867    _I appended means immediate
868    _A appended means address
869    _AB appended means address with base register
870    _D appended means 64 bit floating point constant
871    _S appended means 32 bit floating point constant.  */
872
873 enum
874 {
875   M_ABS,
876   M_ACLR_AB,
877   M_ACLR_OB,
878   M_ADD_I,
879   M_ADDU_I,
880   M_AND_I,
881   M_ASET_AB,
882   M_ASET_OB,
883   M_BALIGN,
884   M_BC1FL,
885   M_BC1TL,
886   M_BC2FL,
887   M_BC2TL,
888   M_BEQ,
889   M_BEQ_I,
890   M_BEQL,
891   M_BEQL_I,
892   M_BGE,
893   M_BGEL,
894   M_BGE_I,
895   M_BGEL_I,
896   M_BGEU,
897   M_BGEUL,
898   M_BGEU_I,
899   M_BGEUL_I,
900   M_BGEZ,
901   M_BGEZL,
902   M_BGEZALL,
903   M_BGT,
904   M_BGTL,
905   M_BGT_I,
906   M_BGTL_I,
907   M_BGTU,
908   M_BGTUL,
909   M_BGTU_I,
910   M_BGTUL_I,
911   M_BGTZ,
912   M_BGTZL,
913   M_BLE,
914   M_BLEL,
915   M_BLE_I,
916   M_BLEL_I,
917   M_BLEU,
918   M_BLEUL,
919   M_BLEU_I,
920   M_BLEUL_I,
921   M_BLEZ,
922   M_BLEZL,
923   M_BLT,
924   M_BLTL,
925   M_BLT_I,
926   M_BLTL_I,
927   M_BLTU,
928   M_BLTUL,
929   M_BLTU_I,
930   M_BLTUL_I,
931   M_BLTZ,
932   M_BLTZL,
933   M_BLTZALL,
934   M_BNE,
935   M_BNEL,
936   M_BNE_I,
937   M_BNEL_I,
938   M_CACHE_AB,
939   M_CACHE_OB,
940   M_DABS,
941   M_DADD_I,
942   M_DADDU_I,
943   M_DDIV_3,
944   M_DDIV_3I,
945   M_DDIVU_3,
946   M_DDIVU_3I,
947   M_DEXT,
948   M_DINS,
949   M_DIV_3,
950   M_DIV_3I,
951   M_DIVU_3,
952   M_DIVU_3I,
953   M_DLA_AB,
954   M_DLCA_AB,
955   M_DLI,
956   M_DMUL,
957   M_DMUL_I,
958   M_DMULO,
959   M_DMULO_I,
960   M_DMULOU,
961   M_DMULOU_I,
962   M_DREM_3,
963   M_DREM_3I,
964   M_DREMU_3,
965   M_DREMU_3I,
966   M_DSUB_I,
967   M_DSUBU_I,
968   M_DSUBU_I_2,
969   M_J_A,
970   M_JAL_1,
971   M_JAL_2,
972   M_JAL_A,
973   M_JALS_1,
974   M_JALS_2,
975   M_JALS_A,
976   M_L_DOB,
977   M_L_DAB,
978   M_LA_AB,
979   M_LB_A,
980   M_LB_AB,
981   M_LBU_A,
982   M_LBU_AB,
983   M_LCA_AB,
984   M_LD_A,
985   M_LD_OB,
986   M_LD_AB,
987   M_LDC1_AB,
988   M_LDC2_AB,
989   M_LDC2_OB,
990   M_LDC3_AB,
991   M_LDL_AB,
992   M_LDL_OB,
993   M_LDM_AB,
994   M_LDM_OB,
995   M_LDP_AB,
996   M_LDP_OB,
997   M_LDR_AB,
998   M_LDR_OB,
999   M_LH_A,
1000   M_LH_AB,
1001   M_LHU_A,
1002   M_LHU_AB,
1003   M_LI,
1004   M_LI_D,
1005   M_LI_DD,
1006   M_LI_S,
1007   M_LI_SS,
1008   M_LL_AB,
1009   M_LL_OB,
1010   M_LLD_AB,
1011   M_LLD_OB,
1012   M_LS_A,
1013   M_LW_A,
1014   M_LW_AB,
1015   M_LWC0_A,
1016   M_LWC0_AB,
1017   M_LWC1_A,
1018   M_LWC1_AB,
1019   M_LWC2_A,
1020   M_LWC2_AB,
1021   M_LWC2_OB,
1022   M_LWC3_A,
1023   M_LWC3_AB,
1024   M_LWL_A,
1025   M_LWL_AB,
1026   M_LWL_OB,
1027   M_LWM_AB,
1028   M_LWM_OB,
1029   M_LWP_AB,
1030   M_LWP_OB,
1031   M_LWR_A,
1032   M_LWR_AB,
1033   M_LWR_OB,
1034   M_LWU_AB,
1035   M_LWU_OB,
1036   M_MSGSND,
1037   M_MSGLD,
1038   M_MSGLD_T,
1039   M_MSGWAIT,
1040   M_MSGWAIT_T,
1041   M_MOVE,
1042   M_MUL,
1043   M_MUL_I,
1044   M_MULO,
1045   M_MULO_I,
1046   M_MULOU,
1047   M_MULOU_I,
1048   M_NOR_I,
1049   M_OR_I,
1050   M_PREF_AB,
1051   M_PREF_OB,
1052   M_REM_3,
1053   M_REM_3I,
1054   M_REMU_3,
1055   M_REMU_3I,
1056   M_DROL,
1057   M_ROL,
1058   M_DROL_I,
1059   M_ROL_I,
1060   M_DROR,
1061   M_ROR,
1062   M_DROR_I,
1063   M_ROR_I,
1064   M_S_DA,
1065   M_S_DOB,
1066   M_S_DAB,
1067   M_S_S,
1068   M_SC_AB,
1069   M_SC_OB,
1070   M_SCD_AB,
1071   M_SCD_OB,
1072   M_SD_A,
1073   M_SD_OB,
1074   M_SD_AB,
1075   M_SDC1_AB,
1076   M_SDC2_AB,
1077   M_SDC2_OB,
1078   M_SDC3_AB,
1079   M_SDL_AB,
1080   M_SDL_OB,
1081   M_SDM_AB,
1082   M_SDM_OB,
1083   M_SDP_AB,
1084   M_SDP_OB,
1085   M_SDR_AB,
1086   M_SDR_OB,
1087   M_SEQ,
1088   M_SEQ_I,
1089   M_SGE,
1090   M_SGE_I,
1091   M_SGEU,
1092   M_SGEU_I,
1093   M_SGT,
1094   M_SGT_I,
1095   M_SGTU,
1096   M_SGTU_I,
1097   M_SLE,
1098   M_SLE_I,
1099   M_SLEU,
1100   M_SLEU_I,
1101   M_SLT_I,
1102   M_SLTU_I,
1103   M_SNE,
1104   M_SNE_I,
1105   M_SB_A,
1106   M_SB_AB,
1107   M_SH_A,
1108   M_SH_AB,
1109   M_SW_A,
1110   M_SW_AB,
1111   M_SWC0_A,
1112   M_SWC0_AB,
1113   M_SWC1_A,
1114   M_SWC1_AB,
1115   M_SWC2_A,
1116   M_SWC2_AB,
1117   M_SWC2_OB,
1118   M_SWC3_A,
1119   M_SWC3_AB,
1120   M_SWL_A,
1121   M_SWL_AB,
1122   M_SWL_OB,
1123   M_SWM_AB,
1124   M_SWM_OB,
1125   M_SWP_AB,
1126   M_SWP_OB,
1127   M_SWR_A,
1128   M_SWR_AB,
1129   M_SWR_OB,
1130   M_SUB_I,
1131   M_SUBU_I,
1132   M_SUBU_I_2,
1133   M_TEQ_I,
1134   M_TGE_I,
1135   M_TGEU_I,
1136   M_TLT_I,
1137   M_TLTU_I,
1138   M_TNE_I,
1139   M_TRUNCWD,
1140   M_TRUNCWS,
1141   M_ULD,
1142   M_ULD_A,
1143   M_ULH,
1144   M_ULH_A,
1145   M_ULHU,
1146   M_ULHU_A,
1147   M_ULW,
1148   M_ULW_A,
1149   M_USH,
1150   M_USH_A,
1151   M_USW,
1152   M_USW_A,
1153   M_USD,
1154   M_USD_A,
1155   M_XOR_I,
1156   M_COP0,
1157   M_COP1,
1158   M_COP2,
1159   M_COP3,
1160   M_NUM_MACROS
1161 };
1162
1163
1164 /* The order of overloaded instructions matters.  Label arguments and
1165    register arguments look the same. Instructions that can have either
1166    for arguments must apear in the correct order in this table for the
1167    assembler to pick the right one. In other words, entries with
1168    immediate operands must apear after the same instruction with
1169    registers.
1170
1171    Many instructions are short hand for other instructions (i.e., The
1172    jal <register> instruction is short for jalr <register>).  */
1173
1174 extern const struct mips_opcode mips_builtin_opcodes[];
1175 extern const int bfd_mips_num_builtin_opcodes;
1176 extern struct mips_opcode *mips_opcodes;
1177 extern int bfd_mips_num_opcodes;
1178 #define NUMOPCODES bfd_mips_num_opcodes
1179
1180 \f
1181 /* The rest of this file adds definitions for the mips16 TinyRISC
1182    processor.  */
1183
1184 /* These are the bitmasks and shift counts used for the different
1185    fields in the instruction formats.  Other than OP, no masks are
1186    provided for the fixed portions of an instruction, since they are
1187    not needed.
1188
1189    The I format uses IMM11.
1190
1191    The RI format uses RX and IMM8.
1192
1193    The RR format uses RX, and RY.
1194
1195    The RRI format uses RX, RY, and IMM5.
1196
1197    The RRR format uses RX, RY, and RZ.
1198
1199    The RRI_A format uses RX, RY, and IMM4.
1200
1201    The SHIFT format uses RX, RY, and SHAMT.
1202
1203    The I8 format uses IMM8.
1204
1205    The I8_MOVR32 format uses RY and REGR32.
1206
1207    The IR_MOV32R format uses REG32R and MOV32Z.
1208
1209    The I64 format uses IMM8.
1210
1211    The RI64 format uses RY and IMM5.
1212    */
1213
1214 #define MIPS16OP_MASK_OP        0x1f
1215 #define MIPS16OP_SH_OP          11
1216 #define MIPS16OP_MASK_IMM11     0x7ff
1217 #define MIPS16OP_SH_IMM11       0
1218 #define MIPS16OP_MASK_RX        0x7
1219 #define MIPS16OP_SH_RX          8
1220 #define MIPS16OP_MASK_IMM8      0xff
1221 #define MIPS16OP_SH_IMM8        0
1222 #define MIPS16OP_MASK_RY        0x7
1223 #define MIPS16OP_SH_RY          5
1224 #define MIPS16OP_MASK_IMM5      0x1f
1225 #define MIPS16OP_SH_IMM5        0
1226 #define MIPS16OP_MASK_RZ        0x7
1227 #define MIPS16OP_SH_RZ          2
1228 #define MIPS16OP_MASK_IMM4      0xf
1229 #define MIPS16OP_SH_IMM4        0
1230 #define MIPS16OP_MASK_REGR32    0x1f
1231 #define MIPS16OP_SH_REGR32      0
1232 #define MIPS16OP_MASK_REG32R    0x1f
1233 #define MIPS16OP_SH_REG32R      3
1234 #define MIPS16OP_EXTRACT_REG32R(i) ((((i) >> 5) & 7) | ((i) & 0x18))
1235 #define MIPS16OP_MASK_MOVE32Z   0x7
1236 #define MIPS16OP_SH_MOVE32Z     0
1237 #define MIPS16OP_MASK_IMM6      0x3f
1238 #define MIPS16OP_SH_IMM6        5
1239
1240 /* These are the characters which may appears in the args field of a MIPS16
1241    instruction.  They appear in the order in which the fields appear when the
1242    instruction is used.  Commas and parentheses in the args string are ignored
1243    when assembling, and written into the output when disassembling.
1244
1245    "y" 3 bit register (MIPS16OP_*_RY)
1246    "x" 3 bit register (MIPS16OP_*_RX)
1247    "z" 3 bit register (MIPS16OP_*_RZ)
1248    "Z" 3 bit register (MIPS16OP_*_MOVE32Z)
1249    "v" 3 bit same register as source and destination (MIPS16OP_*_RX)
1250    "w" 3 bit same register as source and destination (MIPS16OP_*_RY)
1251    "0" zero register ($0)
1252    "S" stack pointer ($sp or $29)
1253    "P" program counter
1254    "R" return address register ($ra or $31)
1255    "X" 5 bit MIPS register (MIPS16OP_*_REGR32)
1256    "Y" 5 bit MIPS register (MIPS16OP_*_REG32R)
1257    "6" 6 bit unsigned break code (MIPS16OP_*_IMM6)
1258    "a" 26 bit jump address
1259    "e" 11 bit extension value
1260    "l" register list for entry instruction
1261    "L" register list for exit instruction
1262
1263    The remaining codes may be extended.  Except as otherwise noted,
1264    the full extended operand is a 16 bit signed value.
1265    "<" 3 bit unsigned shift count * 0 (MIPS16OP_*_RZ) (full 5 bit unsigned)
1266    ">" 3 bit unsigned shift count * 0 (MIPS16OP_*_RX) (full 5 bit unsigned)
1267    "[" 3 bit unsigned shift count * 0 (MIPS16OP_*_RZ) (full 6 bit unsigned)
1268    "]" 3 bit unsigned shift count * 0 (MIPS16OP_*_RX) (full 6 bit unsigned)
1269    "4" 4 bit signed immediate * 0 (MIPS16OP_*_IMM4) (full 15 bit signed)
1270    "5" 5 bit unsigned immediate * 0 (MIPS16OP_*_IMM5)
1271    "H" 5 bit unsigned immediate * 2 (MIPS16OP_*_IMM5)
1272    "W" 5 bit unsigned immediate * 4 (MIPS16OP_*_IMM5)
1273    "D" 5 bit unsigned immediate * 8 (MIPS16OP_*_IMM5)
1274    "j" 5 bit signed immediate * 0 (MIPS16OP_*_IMM5)
1275    "8" 8 bit unsigned immediate * 0 (MIPS16OP_*_IMM8)
1276    "V" 8 bit unsigned immediate * 4 (MIPS16OP_*_IMM8)
1277    "C" 8 bit unsigned immediate * 8 (MIPS16OP_*_IMM8)
1278    "U" 8 bit unsigned immediate * 0 (MIPS16OP_*_IMM8) (full 16 bit unsigned)
1279    "k" 8 bit signed immediate * 0 (MIPS16OP_*_IMM8)
1280    "K" 8 bit signed immediate * 8 (MIPS16OP_*_IMM8)
1281    "p" 8 bit conditional branch address (MIPS16OP_*_IMM8)
1282    "q" 11 bit branch address (MIPS16OP_*_IMM11)
1283    "A" 8 bit PC relative address * 4 (MIPS16OP_*_IMM8)
1284    "B" 5 bit PC relative address * 8 (MIPS16OP_*_IMM5)
1285    "E" 5 bit PC relative address * 4 (MIPS16OP_*_IMM5)
1286    "m" 7 bit register list for save instruction (18 bit extended)
1287    "M" 7 bit register list for restore instruction (18 bit extended)
1288   */
1289
1290 /* Save/restore encoding for the args field when all 4 registers are
1291    either saved as arguments or saved/restored as statics.  */
1292 #define MIPS16_ALL_ARGS    0xe
1293 #define MIPS16_ALL_STATICS 0xb
1294
1295 /* For the mips16, we use the same opcode table format and a few of
1296    the same flags.  However, most of the flags are different.  */
1297
1298 /* Modifies the register in MIPS16OP_*_RX.  */
1299 #define MIPS16_INSN_WRITE_X                 0x00000001
1300 /* Modifies the register in MIPS16OP_*_RY.  */
1301 #define MIPS16_INSN_WRITE_Y                 0x00000002
1302 /* Modifies the register in MIPS16OP_*_RZ.  */
1303 #define MIPS16_INSN_WRITE_Z                 0x00000004
1304 /* Modifies the T ($24) register.  */
1305 #define MIPS16_INSN_WRITE_T                 0x00000008
1306 /* Modifies the SP ($29) register.  */
1307 #define MIPS16_INSN_WRITE_SP                0x00000010
1308 /* Modifies the RA ($31) register.  */
1309 #define MIPS16_INSN_WRITE_31                0x00000020
1310 /* Modifies the general purpose register in MIPS16OP_*_REG32R.  */
1311 #define MIPS16_INSN_WRITE_GPR_Y             0x00000040
1312 /* Reads the register in MIPS16OP_*_RX.  */
1313 #define MIPS16_INSN_READ_X                  0x00000080
1314 /* Reads the register in MIPS16OP_*_RY.  */
1315 #define MIPS16_INSN_READ_Y                  0x00000100
1316 /* Reads the register in MIPS16OP_*_MOVE32Z.  */
1317 #define MIPS16_INSN_READ_Z                  0x00000200
1318 /* Reads the T ($24) register.  */
1319 #define MIPS16_INSN_READ_T                  0x00000400
1320 /* Reads the SP ($29) register.  */
1321 #define MIPS16_INSN_READ_SP                 0x00000800
1322 /* Reads the RA ($31) register.  */
1323 #define MIPS16_INSN_READ_31                 0x00001000
1324 /* Reads the program counter.  */
1325 #define MIPS16_INSN_READ_PC                 0x00002000
1326 /* Reads the general purpose register in MIPS16OP_*_REGR32.  */
1327 #define MIPS16_INSN_READ_GPR_X              0x00004000
1328 /* Is an unconditional branch insn. */
1329 #define MIPS16_INSN_UNCOND_BRANCH           0x00008000
1330 /* Is a conditional branch insn. */
1331 #define MIPS16_INSN_COND_BRANCH             0x00010000
1332
1333 /* The following flags have the same value for the mips16 opcode
1334    table:
1335
1336    INSN_ISA3
1337
1338    INSN_UNCOND_BRANCH_DELAY
1339    INSN_COND_BRANCH_DELAY
1340    INSN_COND_BRANCH_LIKELY (never used)
1341    INSN_READ_HI
1342    INSN_READ_LO
1343    INSN_WRITE_HI
1344    INSN_WRITE_LO
1345    INSN_TRAP
1346    FP_D (never used)
1347    */
1348
1349 extern const struct mips_opcode mips16_opcodes[];
1350 extern const int bfd_mips16_num_opcodes;
1351
1352 /* These are the bit masks and shift counts used for the different fields
1353    in the microMIPS instruction formats.  No masks are provided for the
1354    fixed portions of an instruction, since they are not needed.  */
1355
1356 #define MICROMIPSOP_MASK_IMMEDIATE      0xffff
1357 #define MICROMIPSOP_SH_IMMEDIATE        0
1358 #define MICROMIPSOP_MASK_DELTA          0xffff
1359 #define MICROMIPSOP_SH_DELTA            0
1360 #define MICROMIPSOP_MASK_CODE10         0x3ff
1361 #define MICROMIPSOP_SH_CODE10           16      /* 10-bit wait code.  */
1362 #define MICROMIPSOP_MASK_TRAP           0xf
1363 #define MICROMIPSOP_SH_TRAP             12      /* 4-bit trap code.  */
1364 #define MICROMIPSOP_MASK_SHAMT          0x1f
1365 #define MICROMIPSOP_SH_SHAMT            11
1366 #define MICROMIPSOP_MASK_TARGET         0x3ffffff
1367 #define MICROMIPSOP_SH_TARGET           0
1368 #define MICROMIPSOP_MASK_EXTLSB         0x1f    /* "ext" LSB.  */
1369 #define MICROMIPSOP_SH_EXTLSB           6
1370 #define MICROMIPSOP_MASK_EXTMSBD        0x1f    /* "ext" MSBD.  */
1371 #define MICROMIPSOP_SH_EXTMSBD          11
1372 #define MICROMIPSOP_MASK_INSMSB         0x1f    /* "ins" MSB.  */
1373 #define MICROMIPSOP_SH_INSMSB           11
1374 #define MICROMIPSOP_MASK_CODE           0x3ff
1375 #define MICROMIPSOP_SH_CODE             16      /* 10-bit higher break code. */
1376 #define MICROMIPSOP_MASK_CODE2          0x3ff
1377 #define MICROMIPSOP_SH_CODE2            6       /* 10-bit lower break code.  */
1378 #define MICROMIPSOP_MASK_CACHE          0x1f
1379 #define MICROMIPSOP_SH_CACHE            21      /* 5-bit cache op.  */
1380 #define MICROMIPSOP_MASK_SEL            0x7
1381 #define MICROMIPSOP_SH_SEL              11
1382 #define MICROMIPSOP_MASK_OFFSET12       0xfff
1383 #define MICROMIPSOP_SH_OFFSET12         0
1384 #define MICROMIPSOP_MASK_3BITPOS        0x7
1385 #define MICROMIPSOP_SH_3BITPOS          21
1386 #define MICROMIPSOP_MASK_STYPE          0x1f
1387 #define MICROMIPSOP_SH_STYPE            16
1388 #define MICROMIPSOP_MASK_OFFSET10       0x3ff
1389 #define MICROMIPSOP_SH_OFFSET10         6
1390 #define MICROMIPSOP_MASK_RS             0x1f
1391 #define MICROMIPSOP_SH_RS               16
1392 #define MICROMIPSOP_MASK_RT             0x1f
1393 #define MICROMIPSOP_SH_RT               21
1394 #define MICROMIPSOP_MASK_RD             0x1f
1395 #define MICROMIPSOP_SH_RD               11
1396 #define MICROMIPSOP_MASK_FS             0x1f
1397 #define MICROMIPSOP_SH_FS               16
1398 #define MICROMIPSOP_MASK_FT             0x1f
1399 #define MICROMIPSOP_SH_FT               21
1400 #define MICROMIPSOP_MASK_FD             0x1f
1401 #define MICROMIPSOP_SH_FD               11
1402 #define MICROMIPSOP_MASK_FR             0x1f
1403 #define MICROMIPSOP_SH_FR               6
1404 #define MICROMIPSOP_MASK_RS3            0x1f
1405 #define MICROMIPSOP_SH_RS3              6
1406 #define MICROMIPSOP_MASK_PREFX          0x1f
1407 #define MICROMIPSOP_SH_PREFX            11
1408 #define MICROMIPSOP_MASK_BCC            0x7
1409 #define MICROMIPSOP_SH_BCC              18
1410 #define MICROMIPSOP_MASK_CCC            0x7
1411 #define MICROMIPSOP_SH_CCC              13
1412 #define MICROMIPSOP_MASK_COPZ           0x7fffff
1413 #define MICROMIPSOP_SH_COPZ             3
1414
1415 #define MICROMIPSOP_MASK_MB             0x7
1416 #define MICROMIPSOP_SH_MB               23
1417 #define MICROMIPSOP_MASK_MC             0x7
1418 #define MICROMIPSOP_SH_MC               4
1419 #define MICROMIPSOP_MASK_MD             0x7
1420 #define MICROMIPSOP_SH_MD               7
1421 #define MICROMIPSOP_MASK_ME             0x7
1422 #define MICROMIPSOP_SH_ME               1
1423 #define MICROMIPSOP_MASK_MF             0x7
1424 #define MICROMIPSOP_SH_MF               3
1425 #define MICROMIPSOP_MASK_MG             0x7
1426 #define MICROMIPSOP_SH_MG               0
1427 #define MICROMIPSOP_MASK_MH             0x7
1428 #define MICROMIPSOP_SH_MH               7
1429 #define MICROMIPSOP_MASK_MI             0x7
1430 #define MICROMIPSOP_SH_MI               7
1431 #define MICROMIPSOP_MASK_MJ             0x1f
1432 #define MICROMIPSOP_SH_MJ               0
1433 #define MICROMIPSOP_MASK_ML             0x7
1434 #define MICROMIPSOP_SH_ML               4
1435 #define MICROMIPSOP_MASK_MM             0x7
1436 #define MICROMIPSOP_SH_MM               1
1437 #define MICROMIPSOP_MASK_MN             0x7
1438 #define MICROMIPSOP_SH_MN               4
1439 #define MICROMIPSOP_MASK_MP             0x1f
1440 #define MICROMIPSOP_SH_MP               5
1441 #define MICROMIPSOP_MASK_MQ             0x7
1442 #define MICROMIPSOP_SH_MQ               7
1443
1444 #define MICROMIPSOP_MASK_IMMA           0x7f
1445 #define MICROMIPSOP_SH_IMMA             0
1446 #define MICROMIPSOP_MASK_IMMB           0x7
1447 #define MICROMIPSOP_SH_IMMB             1
1448 #define MICROMIPSOP_MASK_IMMC           0xf
1449 #define MICROMIPSOP_SH_IMMC             0
1450 #define MICROMIPSOP_MASK_IMMD           0x3ff
1451 #define MICROMIPSOP_SH_IMMD             0
1452 #define MICROMIPSOP_MASK_IMME           0x7f
1453 #define MICROMIPSOP_SH_IMME             0
1454 #define MICROMIPSOP_MASK_IMMF           0xf
1455 #define MICROMIPSOP_SH_IMMF             0
1456 #define MICROMIPSOP_MASK_IMMG           0xf
1457 #define MICROMIPSOP_SH_IMMG             0
1458 #define MICROMIPSOP_MASK_IMMH           0xf
1459 #define MICROMIPSOP_SH_IMMH             0
1460 #define MICROMIPSOP_MASK_IMMI           0x7f
1461 #define MICROMIPSOP_SH_IMMI             0
1462 #define MICROMIPSOP_MASK_IMMJ           0xf
1463 #define MICROMIPSOP_SH_IMMJ             0
1464 #define MICROMIPSOP_MASK_IMML           0xf
1465 #define MICROMIPSOP_SH_IMML             0
1466 #define MICROMIPSOP_MASK_IMMM           0x7
1467 #define MICROMIPSOP_SH_IMMM             1
1468 #define MICROMIPSOP_MASK_IMMN           0x3
1469 #define MICROMIPSOP_SH_IMMN             4
1470 #define MICROMIPSOP_MASK_IMMO           0xf
1471 #define MICROMIPSOP_SH_IMMO             0
1472 #define MICROMIPSOP_MASK_IMMP           0x1f
1473 #define MICROMIPSOP_SH_IMMP             0
1474 #define MICROMIPSOP_MASK_IMMQ           0x7fffff
1475 #define MICROMIPSOP_SH_IMMQ             0
1476 #define MICROMIPSOP_MASK_IMMU           0x1f
1477 #define MICROMIPSOP_SH_IMMU             0
1478 #define MICROMIPSOP_MASK_IMMW           0x3f
1479 #define MICROMIPSOP_SH_IMMW             1
1480 #define MICROMIPSOP_MASK_IMMX           0xf
1481 #define MICROMIPSOP_SH_IMMX             1
1482 #define MICROMIPSOP_MASK_IMMY           0x1ff
1483 #define MICROMIPSOP_SH_IMMY             1
1484
1485 /* Placeholders for fields that only exist in the traditional 32-bit
1486    instruction encoding; see the comment above for details.  */
1487 #define MICROMIPSOP_MASK_CODE20         0
1488 #define MICROMIPSOP_SH_CODE20           0
1489 #define MICROMIPSOP_MASK_PERFREG        0
1490 #define MICROMIPSOP_SH_PERFREG          0
1491 #define MICROMIPSOP_MASK_CODE19         0
1492 #define MICROMIPSOP_SH_CODE19           0
1493 #define MICROMIPSOP_MASK_ALN            0
1494 #define MICROMIPSOP_SH_ALN              0
1495 #define MICROMIPSOP_MASK_VECBYTE        0
1496 #define MICROMIPSOP_SH_VECBYTE          0
1497 #define MICROMIPSOP_MASK_VECALIGN       0
1498 #define MICROMIPSOP_SH_VECALIGN         0
1499 #define MICROMIPSOP_MASK_DSPACC         0
1500 #define MICROMIPSOP_SH_DSPACC           0
1501 #define MICROMIPSOP_MASK_DSPACC_S       0
1502 #define MICROMIPSOP_SH_DSPACC_S         0
1503 #define MICROMIPSOP_MASK_DSPSFT         0
1504 #define MICROMIPSOP_SH_DSPSFT           0
1505 #define MICROMIPSOP_MASK_DSPSFT_7       0
1506 #define MICROMIPSOP_SH_DSPSFT_7         0
1507 #define MICROMIPSOP_MASK_SA3            0
1508 #define MICROMIPSOP_SH_SA3              0
1509 #define MICROMIPSOP_MASK_SA4            0
1510 #define MICROMIPSOP_SH_SA4              0
1511 #define MICROMIPSOP_MASK_IMM8           0
1512 #define MICROMIPSOP_SH_IMM8             0
1513 #define MICROMIPSOP_MASK_IMM10          0
1514 #define MICROMIPSOP_SH_IMM10            0
1515 #define MICROMIPSOP_MASK_WRDSP          0
1516 #define MICROMIPSOP_SH_WRDSP            0
1517 #define MICROMIPSOP_MASK_RDDSP          0
1518 #define MICROMIPSOP_SH_RDDSP            0
1519 #define MICROMIPSOP_MASK_BP             0
1520 #define MICROMIPSOP_SH_BP               0
1521 #define MICROMIPSOP_MASK_MT_U           0
1522 #define MICROMIPSOP_SH_MT_U             0
1523 #define MICROMIPSOP_MASK_MT_H           0
1524 #define MICROMIPSOP_SH_MT_H             0
1525 #define MICROMIPSOP_MASK_MTACC_T        0
1526 #define MICROMIPSOP_SH_MTACC_T          0
1527 #define MICROMIPSOP_MASK_MTACC_D        0
1528 #define MICROMIPSOP_SH_MTACC_D          0
1529 #define MICROMIPSOP_MASK_BBITIND        0
1530 #define MICROMIPSOP_SH_BBITIND          0
1531 #define MICROMIPSOP_MASK_CINSPOS        0
1532 #define MICROMIPSOP_SH_CINSPOS          0
1533 #define MICROMIPSOP_MASK_CINSLM1        0
1534 #define MICROMIPSOP_SH_CINSLM1          0
1535 #define MICROMIPSOP_MASK_SEQI           0
1536 #define MICROMIPSOP_SH_SEQI             0
1537 #define MICROMIPSOP_SH_OFFSET_A         0
1538 #define MICROMIPSOP_MASK_OFFSET_A       0
1539 #define MICROMIPSOP_SH_OFFSET_B         0
1540 #define MICROMIPSOP_MASK_OFFSET_B       0
1541 #define MICROMIPSOP_SH_OFFSET_C         0
1542 #define MICROMIPSOP_MASK_OFFSET_C       0
1543 #define MICROMIPSOP_SH_RZ               0
1544 #define MICROMIPSOP_MASK_RZ             0
1545 #define MICROMIPSOP_SH_FZ               0
1546 #define MICROMIPSOP_MASK_FZ             0
1547
1548 /* These are the characters which may appears in the args field of a microMIPS
1549    instruction.  They appear in the order in which the fields appear
1550    when the instruction is used.  Commas and parentheses in the args
1551    string are ignored when assembling, and written into the output
1552    when disassembling.
1553
1554    The followings are for 16-bit microMIPS instructions.
1555
1556    "ma" must be $28
1557    "mc" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_MC) at bit 4
1558         The same register used as both source and target.
1559    "md" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_MD) at bit 7
1560    "me" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_ME) at bit 1
1561         The same register used as both source and target.
1562    "mf" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_MF) at bit 3
1563    "mg" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_MG) at bit 0
1564    "mh" MIPS registers 4, 5, 6 (MICROMIPSOP_*_MH) at bit 7
1565    "mi" MIPS registers 5, 6, 7, 21, 22 (MICROMIPSOP_*_MI) at bit 7
1566         ("mh" and "mi" form a valid 3-bit register pair)
1567    "mj" 5-bit MIPS registers (MICROMIPSOP_*_MJ) at bit 0
1568    "ml" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_ML) at bit 4
1569    "mm" 3-bit MIPS registers 0, 2, 3, 16-20 (MICROMIPSOP_*_MM) at bit 1
1570    "mn" 3-bit MIPS registers 0, 2, 3, 16-20 (MICROMIPSOP_*_MN) at bit 4
1571    "mp" 5-bit MIPS registers (MICROMIPSOP_*_MP) at bit 5
1572    "mq" 3-bit MIPS registers 0, 2-7, 17 (MICROMIPSOP_*_MQ) at bit 7
1573    "mr" must be program counter
1574    "ms" must be $29
1575    "mt" must be the same as the previous register
1576    "mx" must be the same as the destination register
1577    "my" must be $31
1578    "mz" must be $0
1579
1580    "mA" 7-bit immediate (-64 .. 63) << 2 (MICROMIPSOP_*_IMMA)
1581    "mB" 3-bit immediate (-1, 1, 4, 8, 12, 16, 20, 24) (MICROMIPSOP_*_IMMB)
1582    "mC" 4-bit immediate (1, 2, 3, 4, 7, 8, 15, 16, 31, 32, 63, 64, 128, 255,
1583         32768, 65535) (MICROMIPSOP_*_IMMC)
1584    "mD" 10-bit branch address (-512 .. 511) << 1 (MICROMIPSOP_*_IMMD)
1585    "mE" 7-bit branch address (-64 .. 63) << 1 (MICROMIPSOP_*_IMME)
1586    "mF" 4-bit immediate (0 .. 15)  (MICROMIPSOP_*_IMMF)
1587    "mG" 4-bit immediate (-1 .. 14) (MICROMIPSOP_*_IMMG)
1588    "mH" 4-bit immediate (0 .. 15) << 1 (MICROMIPSOP_*_IMMH)
1589    "mI" 7-bit immediate (-1 .. 126) (MICROMIPSOP_*_IMMI)
1590    "mJ" 4-bit immediate (0 .. 15) << 2 (MICROMIPSOP_*_IMMJ)
1591    "mL" 4-bit immediate (0 .. 15) (MICROMIPSOP_*_IMML)
1592    "mM" 3-bit immediate (1 .. 8) (MICROMIPSOP_*_IMMM)
1593    "mN" 2-bit immediate (0 .. 3) for register list (MICROMIPSOP_*_IMMN)
1594    "mO" 4-bit immediate (0 .. 15) (MICROMIPSOP_*_IMML)
1595    "mP" 5-bit immediate (0 .. 31) << 2 (MICROMIPSOP_*_IMMP)
1596    "mU" 5-bit immediate (0 .. 31) << 2 (MICROMIPSOP_*_IMMU)
1597    "mW" 6-bit immediate (0 .. 63) << 2 (MICROMIPSOP_*_IMMW)
1598    "mX" 4-bit immediate (-8 .. 7) (MICROMIPSOP_*_IMMX)
1599    "mY" 9-bit immediate (-258 .. -3, 2 .. 257) << 2 (MICROMIPSOP_*_IMMY)
1600    "mZ" must be zero
1601
1602    In most cases 32-bit microMIPS instructions use the same characters
1603    as MIPS (with ADDIUPC being a notable exception, but there are some
1604    others too).
1605
1606    "." 10-bit signed offset/number (MICROMIPSOP_*_OFFSET10)
1607    "1" 5-bit sync type (MICROMIPSOP_*_SHAMT)
1608    "<" 5-bit shift amount (MICROMIPSOP_*_SHAMT)
1609    ">" shift amount between 32 and 63, stored after subtracting 32
1610        (MICROMIPSOP_*_SHAMT)
1611    "\" 3-bit position for ASET and ACLR (MICROMIPSOP_*_3BITPOS)
1612    "|" 4-bit trap code (MICROMIPSOP_*_TRAP)
1613    "~" 12-bit signed offset (MICROMIPSOP_*_OFFSET12)
1614    "a" 26-bit target address (MICROMIPSOP_*_TARGET)
1615    "b" 5-bit base register (MICROMIPSOP_*_RS)
1616    "c" 10-bit higher breakpoint code (MICROMIPSOP_*_CODE)
1617    "d" 5-bit destination register specifier (MICROMIPSOP_*_RD)
1618    "h" 5-bit PREFX hint (MICROMIPSOP_*_PREFX)
1619    "i" 16 bit unsigned immediate (MICROMIPSOP_*_IMMEDIATE)
1620    "j" 16-bit signed immediate (MICROMIPSOP_*_DELTA)
1621    "k" 5-bit cache opcode in target register position (MICROMIPSOP_*_CACHE)
1622    "n" register list for 32-bit LWM/SWM instruction (MICROMIPSOP_*_RT)
1623    "o" 16-bit signed offset (MICROMIPSOP_*_DELTA)
1624    "p" 16-bit PC-relative branch target address (MICROMIPSOP_*_DELTA)
1625    "q" 10-bit lower breakpoint code (MICROMIPSOP_*_CODE2)
1626    "r" 5-bit same register used as both source and target (MICROMIPSOP_*_RS)
1627    "s" 5-bit source register specifier (MICROMIPSOP_*_RS)
1628    "t" 5-bit target register (MICROMIPSOP_*_RT)
1629    "u" 16-bit upper 16 bits of address (MICROMIPSOP_*_IMMEDIATE)
1630    "v" 5-bit same register used as both source and destination
1631        (MICROMIPSOP_*_RS)
1632    "w" 5-bit same register used as both target and destination
1633        (MICROMIPSOP_*_RT)
1634    "y" 5-bit source 3 register for ALNV.PS (MICROMIPSOP_*_RS3)
1635    "z" must be zero register
1636    "C" 23-bit coprocessor function code (MICROMIPSOP_*_COPZ)
1637    "B" 8-bit syscall/wait function code (MICROMIPSOP_*_CODE10)
1638    "K" 5-bit Hardware Register (RDHWR instruction) (MICROMIPSOP_*_RS)
1639
1640    "+A" 5-bit INS/EXT/DINS/DEXT/DINSM/DEXTM position, which becomes
1641         LSB (MICROMIPSOP_*_EXTLSB).
1642         Enforces: 0 <= pos < 32.
1643    "+B" 5-bit INS/DINS size, which becomes MSB (MICROMIPSOP_*_INSMSB).
1644         Requires that "+A" or "+E" occur first to set position.
1645         Enforces: 0 < (pos+size) <= 32.
1646    "+C" 5-bit EXT/DEXT size, which becomes MSBD (MICROMIPSOP_*_EXTMSBD).
1647         Requires that "+A" or "+E" occur first to set position.
1648         Enforces: 0 < (pos+size) <= 32.
1649         (Also used by DEXT w/ different limits, but limits for
1650         that are checked by the M_DEXT macro.)
1651    "+E" 5-bit DINSU/DEXTU position, which becomes LSB-32 (MICROMIPSOP_*_EXTLSB).
1652         Enforces: 32 <= pos < 64.
1653    "+F" 5-bit DINSM/DINSU size, which becomes MSB-32 (MICROMIPSOP_*_INSMSB).
1654         Requires that "+A" or "+E" occur first to set position.
1655         Enforces: 32 < (pos+size) <= 64.
1656    "+G" 5-bit DEXTM size, which becomes MSBD-32 (MICROMIPSOP_*_EXTMSBD).
1657         Requires that "+A" or "+E" occur first to set position.
1658         Enforces: 32 < (pos+size) <= 64.
1659    "+H" 5-bit DEXTU size, which becomes MSBD (MICROMIPSOP_*_EXTMSBD).
1660         Requires that "+A" or "+E" occur first to set position.
1661         Enforces: 32 < (pos+size) <= 64.
1662
1663    PC-relative addition (ADDIUPC) instruction:
1664    "mQ" 23-bit offset (-4194304 .. 4194303) << 2 (MICROMIPSOP_*_IMMQ)
1665    "mb" 3-bit MIPS registers 2-7, 16, 17 (MICROMIPSOP_*_MB) at bit 23
1666
1667    Floating point instructions:
1668    "D" 5-bit destination register (MICROMIPSOP_*_FD)
1669    "M" 3-bit compare condition code (MICROMIPSOP_*_CCC)
1670    "N" 3-bit branch condition code (MICROMIPSOP_*_BCC)
1671    "R" 5-bit fr source 3 register (MICROMIPSOP_*_FR)
1672    "S" 5-bit fs source 1 register (MICROMIPSOP_*_FS)
1673    "T" 5-bit ft source 2 register (MICROMIPSOP_*_FT)
1674    "V" 5-bit same register used as floating source and destination or target
1675        (MICROMIPSOP_*_FS)
1676
1677    Coprocessor instructions:
1678    "E" 5-bit target register (MICROMIPSOP_*_RT)
1679    "G" 5-bit destination register (MICROMIPSOP_*_RD)
1680    "H" 3-bit sel field for (D)MTC* and (D)MFC* (MICROMIPSOP_*_SEL)
1681    "+D" combined destination register ("G") and sel ("H") for CP0 ops,
1682         for pretty-printing in disassembly only
1683
1684    Macro instructions:
1685    "A" general 32 bit expression
1686    "I" 32-bit immediate (value placed in imm_expr).
1687    "+I" 32-bit immediate (value placed in imm2_expr).
1688    "F" 64-bit floating point constant in .rdata
1689    "L" 64-bit floating point constant in .lit8
1690    "f" 32-bit floating point constant
1691    "l" 32-bit floating point constant in .lit4
1692
1693    Other:
1694    "()" parens surrounding optional value
1695    ","  separates operands
1696    "+"  start of extension sequence
1697    "m"  start of microMIPS extension sequence
1698
1699    Characters used so far, for quick reference when adding more:
1700    "1234567890"
1701    "<>(),+.\|~"
1702    "ABCDEFGHI KLMN   RST V    "
1703    "abcd f hijklmnopqrstuvw yz"
1704
1705    Extension character sequences used so far ("+" followed by the
1706    following), for quick reference when adding more:
1707    ""
1708    ""
1709    "ABCDEFGHI"
1710    ""
1711
1712    Extension character sequences used so far ("m" followed by the
1713    following), for quick reference when adding more:
1714    ""
1715    ""
1716    " BCDEFGHIJ LMNOPQ   U WXYZ"
1717    " bcdefghij lmn pq st   xyz"
1718 */
1719
1720 extern const struct mips_opcode micromips_opcodes[];
1721 extern const int bfd_micromips_num_opcodes;
1722
1723 /* A NOP insn impemented as "or at,at,zero".
1724    Used to implement -mfix-loongson2f.  */
1725 #define LOONGSON2F_NOP_INSN     0x00200825
1726
1727 #endif /* _MIPS_H_ */