Subversion Repositories open8_urisc

/* mips.h.  Mips opcode list for GDB, the GNU debugger.

   Copyright 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,

   2003, 2004, 2005, 2008, 2009, 2010

   Free Software Foundation, Inc.

   Contributed by Ralph Campbell and OSF

   Commented and modified by Ian Lance Taylor, Cygnus Support

   This file is part of GDB, GAS, and the GNU binutils.

   GDB, GAS, and the GNU binutils are free software; you can redistribute

   them and/or modify them under the terms of the GNU General Public

   License as published by the Free Software Foundation; either version 3,

   or (at your option) any later version.

   GDB, GAS, and the GNU binutils are distributed in the hope that they

   will be useful, but WITHOUT ANY WARRANTY; without even the implied

   warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See

   the GNU General Public License for more details.

   You should have received a copy of the GNU General Public License

   along with this file; see the file COPYING3.  If not, write to the Free

   Software Foundation, 51 Franklin Street - Fifth Floor, Boston,

   MA 02110-1301, USA.  */

#ifndef _MIPS_H_

#define _MIPS_H_

/* These are bit masks and shift counts to use to access the various

   fields of an instruction.  To retrieve the X field of an

   instruction, use the expression

        (i >> OP_SH_X) & OP_MASK_X

   To set the same field (to j), use

        i = (i &~ (OP_MASK_X << OP_SH_X)) | (j << OP_SH_X)

   Make sure you use fields that are appropriate for the instruction,

   of course.

   The 'i' format uses OP, RS, RT and IMMEDIATE.

   The 'j' format uses OP and TARGET.

   The 'r' format uses OP, RS, RT, RD, SHAMT and FUNCT.

   The 'b' format uses OP, RS, RT and DELTA.

   The floating point 'i' format uses OP, RS, RT and IMMEDIATE.

   The floating point 'r' format uses OP, FMT, FT, FS, FD and FUNCT.

   A breakpoint instruction uses OP, CODE and SPEC (10 bits of the

   breakpoint instruction are not defined; Kane says the breakpoint

   code field in BREAK is 20 bits; yet MIPS assemblers and debuggers

   only use ten bits).  An optional two-operand form of break/sdbbp

   allows the lower ten bits to be set too, and MIPS32 and later

   architectures allow 20 bits to be set with a signal operand

   (using CODE20).

   The syscall instruction uses CODE20.

   The general coprocessor instructions use COPZ.  */

#define OP_MASK_OP              0x3f

#define OP_SH_OP                26

#define OP_MASK_RS              0x1f

#define OP_SH_RS                21

#define OP_MASK_FR              0x1f

#define OP_SH_FR                21

#define OP_MASK_FMT             0x1f

#define OP_SH_FMT               21

#define OP_MASK_BCC             0x7

#define OP_SH_BCC               18

#define OP_MASK_CODE            0x3ff

#define OP_SH_CODE              16

#define OP_MASK_CODE2           0x3ff

#define OP_SH_CODE2             6

#define OP_MASK_RT              0x1f

#define OP_SH_RT                16

#define OP_MASK_FT              0x1f

#define OP_SH_FT                16

#define OP_MASK_CACHE           0x1f

#define OP_SH_CACHE             16

#define OP_MASK_RD              0x1f

#define OP_SH_RD                11

#define OP_MASK_FS              0x1f

#define OP_SH_FS                11

#define OP_MASK_PREFX           0x1f

#define OP_SH_PREFX             11

#define OP_MASK_CCC             0x7

#define OP_SH_CCC               8

#define OP_MASK_CODE20          0xfffff /* 20 bit syscall/breakpoint code.  */

#define OP_SH_CODE20            6

#define OP_MASK_SHAMT           0x1f

#define OP_SH_SHAMT             6

#define OP_MASK_FD              0x1f

#define OP_SH_FD                6

#define OP_MASK_TARGET          0x3ffffff

#define OP_SH_TARGET            0

#define OP_MASK_COPZ            0x1ffffff

#define OP_SH_COPZ              0

#define OP_MASK_IMMEDIATE       0xffff

#define OP_SH_IMMEDIATE         0

#define OP_MASK_DELTA           0xffff

#define OP_SH_DELTA             0

#define OP_MASK_FUNCT           0x3f

#define OP_SH_FUNCT             0

#define OP_MASK_SPEC            0x3f

#define OP_SH_SPEC              0

#define OP_SH_LOCC              8       /* FP condition code.  */

#define OP_SH_HICC              18      /* FP condition code.  */

#define OP_MASK_CC              0x7

#define OP_SH_COP1NORM          25      /* Normal COP1 encoding.  */

#define OP_MASK_COP1NORM        0x1     /* a single bit.  */

#define OP_SH_COP1SPEC          21      /* COP1 encodings.  */

#define OP_MASK_COP1SPEC        0xf

#define OP_MASK_COP1SCLR        0x4

#define OP_MASK_COP1CMP         0x3

#define OP_SH_COP1CMP           4

#define OP_SH_FORMAT            21      /* FP short format field.  */

#define OP_MASK_FORMAT          0x7

#define OP_SH_TRUE              16

#define OP_MASK_TRUE            0x1

#define OP_SH_GE                17

#define OP_MASK_GE              0x01

#define OP_SH_UNSIGNED          16

#define OP_MASK_UNSIGNED        0x1

#define OP_SH_HINT              16

#define OP_MASK_HINT            0x1f

#define OP_SH_MMI               0       /* Multimedia (parallel) op.  */

#define OP_MASK_MMI             0x3f

#define OP_SH_MMISUB            6

#define OP_MASK_MMISUB          0x1f

#define OP_MASK_PERFREG         0x1f    /* Performance monitoring.  */

#define OP_SH_PERFREG           1

#define OP_SH_SEL               0        /* Coprocessor select field.  */

#define OP_MASK_SEL             0x7     /* The sel field of mfcZ and mtcZ.  */

#define OP_SH_CODE19            6       /* 19 bit wait code.  */

#define OP_MASK_CODE19          0x7ffff

#define OP_SH_ALN               21

#define OP_MASK_ALN             0x7

#define OP_SH_VSEL              21

#define OP_MASK_VSEL            0x1f

#define OP_MASK_VECBYTE         0x7     /* Selector field is really 4 bits,

                                           but 0x8-0xf don't select bytes.  */

#define OP_SH_VECBYTE           22

#define OP_MASK_VECALIGN        0x7     /* Vector byte-align (alni.ob) op.  */

#define OP_SH_VECALIGN          21

#define OP_MASK_INSMSB          0x1f    /* "ins" MSB.  */

#define OP_SH_INSMSB            11

#define OP_MASK_EXTMSBD         0x1f    /* "ext" MSBD.  */

#define OP_SH_EXTMSBD           11

/* MIPS DSP ASE */

#define OP_SH_DSPACC            11

#define OP_MASK_DSPACC          0x3

#define OP_SH_DSPACC_S          21

#define OP_MASK_DSPACC_S        0x3

#define OP_SH_DSPSFT            20

#define OP_MASK_DSPSFT          0x3f

#define OP_SH_DSPSFT_7          19

#define OP_MASK_DSPSFT_7        0x7f

#define OP_SH_SA3               21

#define OP_MASK_SA3             0x7

#define OP_SH_SA4               21

#define OP_MASK_SA4             0xf

#define OP_SH_IMM8              16

#define OP_MASK_IMM8            0xff

#define OP_SH_IMM10             16

#define OP_MASK_IMM10           0x3ff

#define OP_SH_WRDSP             11

#define OP_MASK_WRDSP           0x3f

#define OP_SH_RDDSP             16

#define OP_MASK_RDDSP           0x3f

#define OP_SH_BP                11

#define OP_MASK_BP              0x3

/* MIPS MT ASE */

#define OP_SH_MT_U              5

#define OP_MASK_MT_U            0x1

#define OP_SH_MT_H              4

#define OP_MASK_MT_H            0x1

#define OP_SH_MTACC_T           18

#define OP_MASK_MTACC_T         0x3

#define OP_SH_MTACC_D           13

#define OP_MASK_MTACC_D         0x3

#define OP_OP_COP0              0x10

#define OP_OP_COP1              0x11

#define OP_OP_COP2              0x12

#define OP_OP_COP3              0x13

#define OP_OP_LWC1              0x31

#define OP_OP_LWC2              0x32

#define OP_OP_LWC3              0x33    /* a.k.a. pref */

#define OP_OP_LDC1              0x35

#define OP_OP_LDC2              0x36

#define OP_OP_LDC3              0x37    /* a.k.a. ld */

#define OP_OP_SWC1              0x39

#define OP_OP_SWC2              0x3a

#define OP_OP_SWC3              0x3b

#define OP_OP_SDC1              0x3d

#define OP_OP_SDC2              0x3e

#define OP_OP_SDC3              0x3f    /* a.k.a. sd */

/* Values in the 'VSEL' field.  */

#define MDMX_FMTSEL_IMM_QH      0x1d

#define MDMX_FMTSEL_IMM_OB      0x1e

#define MDMX_FMTSEL_VEC_QH      0x15

#define MDMX_FMTSEL_VEC_OB      0x16

/* UDI */

#define OP_SH_UDI1              6

#define OP_MASK_UDI1            0x1f

#define OP_SH_UDI2              6

#define OP_MASK_UDI2            0x3ff

#define OP_SH_UDI3              6

#define OP_MASK_UDI3            0x7fff

#define OP_SH_UDI4              6

#define OP_MASK_UDI4            0xfffff

/* Octeon */

#define OP_SH_BBITIND           16

#define OP_MASK_BBITIND         0x1f

#define OP_SH_CINSPOS           6

#define OP_MASK_CINSPOS         0x1f

#define OP_SH_CINSLM1           11

#define OP_MASK_CINSLM1         0x1f

#define OP_SH_SEQI              6

#define OP_MASK_SEQI            0x3ff

/* Loongson */

#define OP_SH_OFFSET_A          6

#define OP_MASK_OFFSET_A        0xff

#define OP_SH_OFFSET_B          3

#define OP_MASK_OFFSET_B        0xff

#define OP_SH_OFFSET_C          6

#define OP_MASK_OFFSET_C        0x1ff

#define OP_SH_RZ                0

#define OP_MASK_RZ              0x1f

#define OP_SH_FZ                0

#define OP_MASK_FZ              0x1f

/* This structure holds information for a particular instruction.  */

struct mips_opcode

{

  /* The name of the instruction.  */

  const char *name;

  /* A string describing the arguments for this instruction.  */

  const char *args;

  /* The basic opcode for the instruction.  When assembling, this

     opcode is modified by the arguments to produce the actual opcode

     that is used.  If pinfo is INSN_MACRO, then this is 0.  */

  unsigned long match;

  /* If pinfo is not INSN_MACRO, then this is a bit mask for the

     relevant portions of the opcode when disassembling.  If the

     actual opcode anded with the match field equals the opcode field,

     then we have found the correct instruction.  If pinfo is

     INSN_MACRO, then this field is the macro identifier.  */

  unsigned long mask;

  /* For a macro, this is INSN_MACRO.  Otherwise, it is a collection

     of bits describing the instruction, notably any relevant hazard

     information.  */

  unsigned long pinfo;

  /* A collection of additional bits describing the instruction. */

  unsigned long pinfo2;

  /* A collection of bits describing the instruction sets of which this

     instruction or macro is a member. */

  unsigned long membership;

};

/* These are the characters which may appear in the args field of an

   instruction.  They appear in the order in which the fields appear

   when the instruction is used.  Commas and parentheses in the args

   string are ignored when assembling, and written into the output

   when disassembling.

   Each of these characters corresponds to a mask field defined above.

   "1" 5 bit sync type (OP_*_SHAMT)

   "<" 5 bit shift amount (OP_*_SHAMT)

   ">" shift amount between 32 and 63, stored after subtracting 32 (OP_*_SHAMT)

   "a" 26 bit target address (OP_*_TARGET)

   "b" 5 bit base register (OP_*_RS)

   "c" 10 bit breakpoint code (OP_*_CODE)

   "d" 5 bit destination register specifier (OP_*_RD)

   "h" 5 bit prefx hint (OP_*_PREFX)

   "i" 16 bit unsigned immediate (OP_*_IMMEDIATE)

   "j" 16 bit signed immediate (OP_*_DELTA)

   "k" 5 bit cache opcode in target register position (OP_*_CACHE)

       Also used for immediate operands in vr5400 vector insns.

   "o" 16 bit signed offset (OP_*_DELTA)

   "p" 16 bit PC relative branch target address (OP_*_DELTA)

   "q" 10 bit extra breakpoint code (OP_*_CODE2)

   "r" 5 bit same register used as both source and target (OP_*_RS)

   "s" 5 bit source register specifier (OP_*_RS)

   "t" 5 bit target register (OP_*_RT)

   "u" 16 bit upper 16 bits of address (OP_*_IMMEDIATE)

   "v" 5 bit same register used as both source and destination (OP_*_RS)

   "w" 5 bit same register used as both target and destination (OP_*_RT)

   "U" 5 bit same destination register in both OP_*_RD and OP_*_RT

       (used by clo and clz)

   "C" 25 bit coprocessor function code (OP_*_COPZ)

   "B" 20 bit syscall/breakpoint function code (OP_*_CODE20)

   "J" 19 bit wait function code (OP_*_CODE19)

   "x" accept and ignore register name

   "z" must be zero register

   "K" 5 bit Hardware Register (rdhwr instruction) (OP_*_RD)

   "+A" 5 bit ins/ext/dins/dext/dinsm/dextm position, which becomes

        LSB (OP_*_SHAMT).

        Enforces: 0 <= pos < 32.

   "+B" 5 bit ins/dins size, which becomes MSB (OP_*_INSMSB).

        Requires that "+A" or "+E" occur first to set position.

        Enforces: 0 < (pos+size) <= 32.

   "+C" 5 bit ext/dext size, which becomes MSBD (OP_*_EXTMSBD).

        Requires that "+A" or "+E" occur first to set position.

        Enforces: 0 < (pos+size) <= 32.

        (Also used by "dext" w/ different limits, but limits for

        that are checked by the M_DEXT macro.)

   "+E" 5 bit dinsu/dextu position, which becomes LSB-32 (OP_*_SHAMT).

        Enforces: 32 <= pos < 64.

   "+F" 5 bit "dinsm/dinsu" size, which becomes MSB-32 (OP_*_INSMSB).

        Requires that "+A" or "+E" occur first to set position.

        Enforces: 32 < (pos+size) <= 64.

   "+G" 5 bit "dextm" size, which becomes MSBD-32 (OP_*_EXTMSBD).

        Requires that "+A" or "+E" occur first to set position.

        Enforces: 32 < (pos+size) <= 64.

   "+H" 5 bit "dextu" size, which becomes MSBD (OP_*_EXTMSBD).

        Requires that "+A" or "+E" occur first to set position.

        Enforces: 32 < (pos+size) <= 64.

   Floating point instructions:

   "D" 5 bit destination register (OP_*_FD)

   "M" 3 bit compare condition code (OP_*_CCC) (only used for mips4 and up)

   "N" 3 bit branch condition code (OP_*_BCC) (only used for mips4 and up)

   "S" 5 bit fs source 1 register (OP_*_FS)

   "T" 5 bit ft source 2 register (OP_*_FT)

   "R" 5 bit fr source 3 register (OP_*_FR)

   "V" 5 bit same register used as floating source and destination (OP_*_FS)

   "W" 5 bit same register used as floating target and destination (OP_*_FT)

   Coprocessor instructions:

   "E" 5 bit target register (OP_*_RT)

   "G" 5 bit destination register (OP_*_RD)

   "H" 3 bit sel field for (d)mtc* and (d)mfc* (OP_*_SEL)

   "P" 5 bit performance-monitor register (OP_*_PERFREG)

   "e" 5 bit vector register byte specifier (OP_*_VECBYTE)

   "%" 3 bit immediate vr5400 vector alignment operand (OP_*_VECALIGN)

   see also "k" above

   "+D" Combined destination register ("G") and sel ("H") for CP0 ops,

        for pretty-printing in disassembly only.

   Macro instructions:

   "A" General 32 bit expression

   "I" 32 bit immediate (value placed in imm_expr).

   "+I" 32 bit immediate (value placed in imm2_expr).

   "F" 64 bit floating point constant in .rdata

   "L" 64 bit floating point constant in .lit8

   "f" 32 bit floating point constant

   "l" 32 bit floating point constant in .lit4

   MDMX instruction operands (note that while these use the FP register

   fields, they accept both $fN and $vN names for the registers):

   "O"  MDMX alignment offset (OP_*_ALN)

   "Q"  MDMX vector/scalar/immediate source (OP_*_VSEL and OP_*_FT)

   "X"  MDMX destination register (OP_*_FD)

   "Y"  MDMX source register (OP_*_FS)

   "Z"  MDMX source register (OP_*_FT)

   DSP ASE usage:

   "2" 2 bit unsigned immediate for byte align (OP_*_BP)

   "3" 3 bit unsigned immediate (OP_*_SA3)

   "4" 4 bit unsigned immediate (OP_*_SA4)

   "5" 8 bit unsigned immediate (OP_*_IMM8)

   "6" 5 bit unsigned immediate (OP_*_RS)

   "7" 2 bit dsp accumulator register (OP_*_DSPACC)

   "8" 6 bit unsigned immediate (OP_*_WRDSP)

   "9" 2 bit dsp accumulator register (OP_*_DSPACC_S)

   "0" 6 bit signed immediate (OP_*_DSPSFT)

   ":" 7 bit signed immediate (OP_*_DSPSFT_7)

   "'" 6 bit unsigned immediate (OP_*_RDDSP)

   "@" 10 bit signed immediate (OP_*_IMM10)

   MT ASE usage:

   "!" 1 bit usermode flag (OP_*_MT_U)

   "$" 1 bit load high flag (OP_*_MT_H)

   "*" 2 bit dsp/smartmips accumulator register (OP_*_MTACC_T)

   "&" 2 bit dsp/smartmips accumulator register (OP_*_MTACC_D)

   "g" 5 bit coprocessor 1 and 2 destination register (OP_*_RD)

   "+t" 5 bit coprocessor 0 destination register (OP_*_RT)

   "+T" 5 bit coprocessor 0 destination register (OP_*_RT) - disassembly only

   UDI immediates:

   "+1" UDI immediate bits 6-10

   "+2" UDI immediate bits 6-15

   "+3" UDI immediate bits 6-20

   "+4" UDI immediate bits 6-25

   Octeon:

   "+x" Bit index field of bbit.  Enforces: 0 <= index < 32.

   "+X" Bit index field of bbit aliasing bbit32.  Matches if 32 <= index < 64,

        otherwise skips to next candidate.

   "+p" Position field of cins/cins32/exts/exts32. Enforces 0 <= pos < 32.

   "+P" Position field of cins/exts aliasing cins32/exts32.  Matches if

        32 <= pos < 64, otherwise skips to next candidate.

   "+Q" Immediate field of seqi/snei.  Enforces -512 <= imm < 512.

   "+s" Length-minus-one field of cins/exts.  Enforces: 0 <= lenm1 < 32.

   "+S" Length-minus-one field of cins32/exts32 or cins/exts aliasing

        cint32/exts32.  Enforces non-negative value and that

        pos + lenm1 < 32 or pos + lenm1 < 64 depending whether previous

        position field is "+p" or "+P".

   Loongson-3A:

   "+a" 8-bit signed offset in bit 6 (OP_*_OFFSET_A)

   "+b" 8-bit signed offset in bit 3 (OP_*_OFFSET_B)

   "+c" 9-bit signed offset in bit 6 (OP_*_OFFSET_C)

   "+z" 5-bit rz register (OP_*_RZ)

   "+Z" 5-bit fz register (OP_*_FZ)

   Other:

   "()" parens surrounding optional value

   ","  separates operands

   "[]" brackets around index for vector-op scalar operand specifier (vr5400)

   "+"  Start of extension sequence.

   Characters used so far, for quick reference when adding more:

   "1234567890"

   "%[]<>(),+:'@!$*&"

   "ABCDEFGHIJKLMNOPQRSTUVWXYZ"

   "abcdefghijklopqrstuvwxz"

   Extension character sequences used so far ("+" followed by the

   following), for quick reference when adding more:

   "1234"

   "ABCDEFGHIPQSTXZ"

   "abcpstxz"

*/

/* These are the bits which may be set in the pinfo field of an

   instructions, if it is not equal to INSN_MACRO.  */

/* Modifies the general purpose register in OP_*_RD.  */

#define INSN_WRITE_GPR_D            0x00000001

/* Modifies the general purpose register in OP_*_RT.  */

#define INSN_WRITE_GPR_T            0x00000002

/* Modifies general purpose register 31.  */

#define INSN_WRITE_GPR_31           0x00000004

/* Modifies the floating point register in OP_*_FD.  */

#define INSN_WRITE_FPR_D            0x00000008

/* Modifies the floating point register in OP_*_FS.  */

#define INSN_WRITE_FPR_S            0x00000010

/* Modifies the floating point register in OP_*_FT.  */

#define INSN_WRITE_FPR_T            0x00000020

/* Reads the general purpose register in OP_*_RS.  */

#define INSN_READ_GPR_S             0x00000040

/* Reads the general purpose register in OP_*_RT.  */

#define INSN_READ_GPR_T             0x00000080

/* Reads the floating point register in OP_*_FS.  */

#define INSN_READ_FPR_S             0x00000100

/* Reads the floating point register in OP_*_FT.  */

#define INSN_READ_FPR_T             0x00000200

/* Reads the floating point register in OP_*_FR.  */

#define INSN_READ_FPR_R             0x00000400

/* Modifies coprocessor condition code.  */

#define INSN_WRITE_COND_CODE        0x00000800

/* Reads coprocessor condition code.  */

#define INSN_READ_COND_CODE         0x00001000

/* TLB operation.  */

#define INSN_TLB                    0x00002000

/* Reads coprocessor register other than floating point register.  */

#define INSN_COP                    0x00004000

/* Instruction loads value from memory, requiring delay.  */

#define INSN_LOAD_MEMORY_DELAY      0x00008000

/* Instruction loads value from coprocessor, requiring delay.  */

#define INSN_LOAD_COPROC_DELAY      0x00010000

/* Instruction has unconditional branch delay slot.  */

#define INSN_UNCOND_BRANCH_DELAY    0x00020000

/* Instruction has conditional branch delay slot.  */

#define INSN_COND_BRANCH_DELAY      0x00040000

/* Conditional branch likely: if branch not taken, insn nullified.  */

#define INSN_COND_BRANCH_LIKELY     0x00080000

/* Moves to coprocessor register, requiring delay.  */

#define INSN_COPROC_MOVE_DELAY      0x00100000

/* Loads coprocessor register from memory, requiring delay.  */

#define INSN_COPROC_MEMORY_DELAY    0x00200000

/* Reads the HI register.  */

#define INSN_READ_HI                0x00400000

/* Reads the LO register.  */

#define INSN_READ_LO                0x00800000

/* Modifies the HI register.  */

#define INSN_WRITE_HI               0x01000000

/* Modifies the LO register.  */

#define INSN_WRITE_LO               0x02000000

/* Takes a trap (easier to keep out of delay slot).  */

#define INSN_TRAP                   0x04000000

/* Instruction stores value into memory.  */

#define INSN_STORE_MEMORY           0x08000000

/* Instruction uses single precision floating point.  */

#define FP_S                        0x10000000

/* Instruction uses double precision floating point.  */

#define FP_D                        0x20000000

/* Instruction is part of the tx39's integer multiply family.    */

#define INSN_MULT                   0x40000000

/* Instruction synchronize shared memory.  */

#define INSN_SYNC                   0x80000000

/* Instruction is actually a macro.  It should be ignored by the

   disassembler, and requires special treatment by the assembler.  */

#define INSN_MACRO                  0xffffffff

/* These are the bits which may be set in the pinfo2 field of an

   instruction. */

/* Instruction is a simple alias (I.E. "move" for daddu/addu/or) */

#define INSN2_ALIAS                 0x00000001

/* Instruction reads MDMX accumulator. */

#define INSN2_READ_MDMX_ACC         0x00000002

/* Instruction writes MDMX accumulator. */

#define INSN2_WRITE_MDMX_ACC        0x00000004

/* Macro uses single-precision floating-point instructions.  This should

   only be set for macros.  For instructions, FP_S in pinfo carries the

   same information.  */

#define INSN2_M_FP_S                0x00000008

/* Macro uses double-precision floating-point instructions.  This should

   only be set for macros.  For instructions, FP_D in pinfo carries the

   same information.  */

#define INSN2_M_FP_D                0x00000010

/* Modifies the general purpose register in OP_*_RZ.  */

#define INSN2_WRITE_GPR_Z           0x00000020

/* Modifies the floating point register in OP_*_FZ.  */

#define INSN2_WRITE_FPR_Z           0x00000040

/* Reads the general purpose register in OP_*_RZ.  */

#define INSN2_READ_GPR_Z            0x00000080

/* Reads the floating point register in OP_*_FZ.  */

#define INSN2_READ_FPR_Z            0x00000100

/* Reads the general purpose register in OP_*_RD.  */

#define INSN2_READ_GPR_D            0x00000200

/* Masks used to mark instructions to indicate which MIPS ISA level

   they were introduced in.  INSN_ISA_MASK masks an enumeration that

   specifies the base ISA level(s).  The remainder of a 32-bit

   word constructed using these macros is a bitmask of the remaining

   INSN_* values below.  */

#define INSN_ISA_MASK             0x0000000ful

/* We cannot start at zero due to ISA_UNKNOWN below.  */

#define INSN_ISA1                 1

#define INSN_ISA2                 2

#define INSN_ISA3                 3

#define INSN_ISA4                 4

#define INSN_ISA5                 5

#define INSN_ISA32                6

#define INSN_ISA32R2              7

#define INSN_ISA64                8

#define INSN_ISA64R2              9

/* Below this point the INSN_* values correspond to combinations of ISAs.

   They are only for use in the opcodes table to indicate membership of

   a combination of ISAs that cannot be expressed using the usual inclusion

   ordering on the above INSN_* values.  */

#define INSN_ISA3_32              10

#define INSN_ISA3_32R2            11

#define INSN_ISA4_32              12

#define INSN_ISA4_32R2            13

#define INSN_ISA5_32R2            14

/* Given INSN_ISA* values X and Y, where X ranges over INSN_ISA1 through

   INSN_ISA5_32R2 and Y ranges over INSN_ISA1 through INSN_ISA64R2,

   this table describes whether at least one of the ISAs described by X

   is/are implemented by ISA Y.  (Think of Y as the ISA level supported by

   a particular core and X as the ISA level(s) at which a certain instruction

   is defined.)  The ISA(s) described by X is/are implemented by Y iff

   (mips_isa_table[(Y & INSN_ISA_MASK) - 1] >> ((X & INSN_ISA_MASK) - 1)) & 1

   is non-zero.  */

static const unsigned int mips_isa_table[] =

  { 0x0001, 0x0003, 0x0607, 0x1e0f, 0x3e1f, 0x0a23, 0x3e63, 0x3ebf, 0x3fff };

/* Masks used for Chip specific instructions.  */

#define INSN_CHIP_MASK            0xc3ff0c20

/* Cavium Networks Octeon instructions.  */

#define INSN_OCTEON               0x00000800

/* Masks used for MIPS-defined ASEs.  */

#define INSN_ASE_MASK             0x3c00f000

/* DSP ASE */

#define INSN_DSP                  0x00001000

#define INSN_DSP64                0x00002000

/* 0x00004000 is unused.  */

/* MIPS-3D ASE */

#define INSN_MIPS3D               0x00008000

/* MIPS R4650 instruction.  */

#define INSN_4650                 0x00010000

/* LSI R4010 instruction.  */

#define INSN_4010                 0x00020000

/* NEC VR4100 instruction.  */

#define INSN_4100                 0x00040000

/* Toshiba R3900 instruction.  */

#define INSN_3900                 0x00080000

/* MIPS R10000 instruction.  */

#define INSN_10000                0x00100000

/* Broadcom SB-1 instruction.  */

#define INSN_SB1                  0x00200000

/* NEC VR4111/VR4181 instruction.  */

#define INSN_4111                 0x00400000

/* NEC VR4120 instruction.  */

#define INSN_4120                 0x00800000

/* NEC VR5400 instruction.  */

#define INSN_5400                 0x01000000

/* NEC VR5500 instruction.  */

#define INSN_5500                 0x02000000

/* MDMX ASE */

#define INSN_MDMX                 0x04000000

/* MT ASE */

#define INSN_MT                   0x08000000

/* SmartMIPS ASE  */

#define INSN_SMARTMIPS            0x10000000

/* DSP R2 ASE  */

#define INSN_DSPR2                0x20000000

/* ST Microelectronics Loongson 2E.  */

#define INSN_LOONGSON_2E          0x40000000

/* ST Microelectronics Loongson 2F.  */

#define INSN_LOONGSON_2F          0x80000000

/* Loongson 3A.  */

#define INSN_LOONGSON_3A          0x00000400

/* RMI Xlr instruction */

#define INSN_XLR                  0x00000020

/* MIPS ISA defines, use instead of hardcoding ISA level.  */

#define       ISA_UNKNOWN     0               /* Gas internal use.  */

#define       ISA_MIPS1       INSN_ISA1

#define       ISA_MIPS2       INSN_ISA2

#define       ISA_MIPS3       INSN_ISA3

#define       ISA_MIPS4       INSN_ISA4

#define       ISA_MIPS5       INSN_ISA5

#define       ISA_MIPS32      INSN_ISA32

#define       ISA_MIPS64      INSN_ISA64

#define       ISA_MIPS32R2    INSN_ISA32R2

#define       ISA_MIPS64R2    INSN_ISA64R2

/* CPU defines, use instead of hardcoding processor number. Keep this

   in sync with bfd/archures.c in order for machine selection to work.  */

#define CPU_UNKNOWN     0               /* Gas internal use.  */

#define CPU_R3000       3000

#define CPU_R3900       3900

#define CPU_R4000       4000

#define CPU_R4010       4010

#define CPU_VR4100      4100

#define CPU_R4111       4111

#define CPU_VR4120      4120

#define CPU_R4300       4300

#define CPU_R4400       4400

#define CPU_R4600       4600

#define CPU_R4650       4650

#define CPU_R5000       5000

#define CPU_VR5400      5400

#define CPU_VR5500      5500

#define CPU_R6000       6000

#define CPU_RM7000      7000

#define CPU_R8000       8000

#define CPU_RM9000      9000

#define CPU_R10000      10000

#define CPU_R12000      12000

#define CPU_R14000      14000

#define CPU_R16000      16000

#define CPU_MIPS16      16

#define CPU_MIPS32      32

#define CPU_MIPS32R2    33

#define CPU_MIPS5       5

#define CPU_MIPS64      64

#define CPU_MIPS64R2    65

#define CPU_SB1         12310201        /* octal 'SB', 01.  */

#define CPU_LOONGSON_2E 3001

#define CPU_LOONGSON_2F 3002

#define CPU_LOONGSON_3A 3003

#define CPU_OCTEON      6501

#define CPU_XLR         887682          /* decimal 'XLR'   */

/* Test for membership in an ISA including chip specific ISAs.  INSN

   is pointer to an element of the opcode table; ISA is the specified

   ISA/ASE bitmask to test against; and CPU is the CPU specific ISA to

   test, or zero if no CPU specific ISA test is desired.  */

#define OPCODE_IS_MEMBER(insn, isa, cpu)                                \

    (((isa & INSN_ISA_MASK) != 0                                        \

      && ((insn)->membership & INSN_ISA_MASK) != 0                      \

      && ((mips_isa_table [(isa & INSN_ISA_MASK) - 1] >>                \

           (((insn)->membership & INSN_ISA_MASK) - 1)) & 1) != 0)       \

     || ((isa & ~INSN_ISA_MASK)                                         \

          & ((insn)->membership & ~INSN_ISA_MASK)) != 0                 \

     || (cpu == CPU_R4650 && ((insn)->membership & INSN_4650) != 0)      \

     || (cpu == CPU_RM7000 && ((insn)->membership & INSN_4650) != 0)     \

     || (cpu == CPU_RM9000 && ((insn)->membership & INSN_4650) != 0)     \

     || (cpu == CPU_R4010 && ((insn)->membership & INSN_4010) != 0)      \

     || (cpu == CPU_VR4100 && ((insn)->membership & INSN_4100) != 0)     \

     || (cpu == CPU_R3900 && ((insn)->membership & INSN_3900) != 0)      \

     || ((cpu == CPU_R10000 || cpu == CPU_R12000 || cpu == CPU_R14000   \

          || cpu == CPU_R16000)                                         \

         && ((insn)->membership & INSN_10000) != 0)                      \

     || (cpu == CPU_SB1 && ((insn)->membership & INSN_SB1) != 0) \

     || (cpu == CPU_R4111 && ((insn)->membership & INSN_4111) != 0)      \

     || (cpu == CPU_VR4120 && ((insn)->membership & INSN_4120) != 0)     \

     || (cpu == CPU_VR5400 && ((insn)->membership & INSN_5400) != 0)     \

     || (cpu == CPU_VR5500 && ((insn)->membership & INSN_5500) != 0)     \

     || (cpu == CPU_LOONGSON_2E                                         \

         && ((insn)->membership & INSN_LOONGSON_2E) != 0)               \

     || (cpu == CPU_LOONGSON_2F                                         \

         && ((insn)->membership & INSN_LOONGSON_2F) != 0)               \

     || (cpu == CPU_LOONGSON_3A                                         \

         && ((insn)->membership & INSN_LOONGSON_3A) != 0)               \

     || (cpu == CPU_OCTEON                                              \

         && ((insn)->membership & INSN_OCTEON) != 0)                     \

     || (cpu == CPU_XLR && ((insn)->membership & INSN_XLR) != 0)        \

     || 0)       /* Please keep this term for easier source merging.  */

/* This is a list of macro expanded instructions.

   _I appended means immediate

   _A appended means address

   _AB appended means address with base register

   _D appended means 64 bit floating point constant

   _S appended means 32 bit floating point constant.  */

enum

{

  M_ABS,

  M_ADD_I,

  M_ADDU_I,

  M_AND_I,

  M_BALIGN,

  M_BEQ,

  M_BEQ_I,

  M_BEQL_I,

  M_BGE,

  M_BGEL,

  M_BGE_I,

  M_BGEL_I,

  M_BGEU,

  M_BGEUL,

  M_BGEU_I,

  M_BGEUL_I,

  M_BGT,

  M_BGTL,

  M_BGT_I,

  M_BGTL_I,

  M_BGTU,

  M_BGTUL,

  M_BGTU_I,

  M_BGTUL_I,

  M_BLE,

  M_BLEL,

  M_BLE_I,

  M_BLEL_I,

  M_BLEU,

  M_BLEUL,

  M_BLEU_I,

  M_BLEUL_I,

  M_BLT,

  M_BLTL,

  M_BLT_I,

  M_BLTL_I,

  M_BLTU,

  M_BLTUL,

  M_BLTU_I,

  M_BLTUL_I,

  M_BNE,

  M_BNE_I,

  M_BNEL_I,

  M_CACHE_AB,

  M_DABS,

  M_DADD_I,

  M_DADDU_I,

  M_DDIV_3,

  M_DDIV_3I,

  M_DDIVU_3,

  M_DDIVU_3I,

  M_DEXT,

  M_DINS,

  M_DIV_3,

  M_DIV_3I,

  M_DIVU_3,

  M_DIVU_3I,

  M_DLA_AB,

  M_DLCA_AB,

  M_DLI,

  M_DMUL,

  M_DMUL_I,

  M_DMULO,

  M_DMULO_I,

  M_DMULOU,

  M_DMULOU_I,

  M_DREM_3,

  M_DREM_3I,

  M_DREMU_3,

  M_DREMU_3I,

  M_DSUB_I,

  M_DSUBU_I,

  M_DSUBU_I_2,

  M_J_A,

  M_JAL_1,

  M_JAL_2,

  M_JAL_A,

  M_L_DOB,

  M_L_DAB,

  M_LA_AB,

  M_LB_A,

  M_LB_AB,

  M_LBU_A,

  M_LBU_AB,

  M_LCA_AB,

  M_LD_A,

  M_LD_OB,

  M_LD_AB,

  M_LDC1_AB,

  M_LDC2_AB,

  M_LDC3_AB,

  M_LDL_AB,

  M_LDR_AB,

  M_LH_A,

  M_LH_AB,

  M_LHU_A,

  M_LHU_AB,

  M_LI,

  M_LI_D,

  M_LI_DD,

  M_LI_S,

  M_LI_SS,

  M_LL_AB,