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