Home | History | Annotate | Download | only in opcode
      1 /* v850.h -- Header file for NEC V850 opcode table
      2    Copyright (C) 1996-2016 Free Software Foundation, Inc.
      3    Written by J.T. Conklin, Cygnus Support
      4 
      5    This file is part of GDB, GAS, and the GNU binutils.
      6 
      7    GDB, GAS, and the GNU binutils are free software; you can redistribute
      8    them and/or modify them under the terms of the GNU General Public
      9    License as published by the Free Software Foundation; either version 3,
     10    or (at your option) any later version.
     11 
     12    GDB, GAS, and the GNU binutils are distributed in the hope that they
     13    will be useful, but WITHOUT ANY WARRANTY; without even the implied
     14    warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
     15    the GNU General Public License for more details.
     16 
     17    You should have received a copy of the GNU General Public License
     18    along with this file; see the file COPYING3.  If not, write to the Free
     19    Software Foundation, 51 Franklin Street - Fifth Floor, Boston,
     20    MA 02110-1301, USA.  */
     21 
     22 #ifndef V850_H
     23 #define V850_H
     24 
     25 #ifdef __cplusplus
     26 extern "C" {
     27 #endif
     28 
     29 /* The opcode table is an array of struct v850_opcode.  */
     30 
     31 struct v850_opcode
     32 {
     33   /* The opcode name.  */
     34   const char *name;
     35 
     36   /* The opcode itself.  Those bits which will be filled in with
     37      operands are zeroes.  */
     38   unsigned long opcode;
     39 
     40   /* The opcode mask.  This is used by the disassembler.  This is a
     41      mask containing ones indicating those bits which must match the
     42      opcode field, and zeroes indicating those bits which need not
     43      match (and are presumably filled in by operands).  */
     44   unsigned long mask;
     45 
     46   /* An array of operand codes.  Each code is an index into the
     47      operand table.  They appear in the order which the operands must
     48      appear in assembly code, and are terminated by a zero.  */
     49   unsigned char operands[8];
     50 
     51   /* Which (if any) operand is a memory operand.  */
     52   unsigned int memop;
     53 
     54   /* Target processor(s).  A bit field of processors which support
     55      this instruction.  Note a bit field is used as some instructions
     56      are available on multiple, different processor types, whereas
     57      other instructions are only available on one specific type.  */
     58   unsigned int processors;
     59 };
     60 
     61 /* Values for architecture number.  */
     62 #define arch_V850      0
     63 #define arch_V850E     (arch_V850 + 1)
     64 #define arch_V850E1    (arch_V850E + 1)
     65 #define arch_V850E2    (arch_V850E1 + 1)
     66 #define arch_V850E2V3  (arch_V850E2 + 1)
     67 #define arch_V850E3V5  (arch_V850E2V3 + 1)
     68 #define arch_separator (arch_V850E3V5 + 1)
     69 
     70 #define opt_EXTENSION  (arch_separator)
     71 #define opt_ALIAS      (opt_EXTENSION + 1)
     72 
     73 /* Values for the processors field in the v850_opcode structure.  */
     74 #define PROCESSOR_V850       (1 << (arch_V850))     /* Just the V850.  */
     75 #define PROCESSOR_V850E      (1 << (arch_V850E))    /* Just the V850E.  */
     76 #define PROCESSOR_V850E1     (1 << (arch_V850E1))   /* Just the V850E1.  */
     77 #define PROCESSOR_V850E2     (1 << (arch_V850E2))   /* Just the V850E2.  */
     78 #define PROCESSOR_V850E2V3   (1 << (arch_V850E2V3)) /* Just the V850E2V3.  */
     79 #define PROCESSOR_V850E3V5   (1 << (arch_V850E3V5)) /* Just the V850E3V5.  */
     80 
     81 /* UPPERS */
     82 #define PROCESSOR_V850E3V5_UP (PROCESSOR_V850E3V5)
     83 #define PROCESSOR_V850E2V3_UP (PROCESSOR_V850E2V3 | PROCESSOR_V850E3V5_UP)
     84 #define PROCESSOR_V850E2_UP   (PROCESSOR_V850E2   | PROCESSOR_V850E2V3_UP)
     85 #define PROCESSOR_V850E_UP    (PROCESSOR_V850E    | PROCESSOR_V850E1 | PROCESSOR_V850E2_UP)
     86 #define PROCESSOR_ALL         (PROCESSOR_V850     | PROCESSOR_V850E_UP)
     87 
     88 #define PROCESSOR_MASK        (PROCESSOR_ALL)
     89 #define PROCESSOR_NOT_V850    (PROCESSOR_ALL & (~ PROCESSOR_V850))         /* Any processor except the V850.  */
     90 
     91 #define PROCESSOR_UNKNOWN    ~(PROCESSOR_MASK)
     92 
     93 /* OPTIONS */
     94 #define PROCESSOR_OPTION_EXTENSION (1 << (opt_EXTENSION))                  /* Enable extension opcodes.  */
     95 #define PROCESSOR_OPTION_ALIAS     (1 << (opt_ALIAS))                      /* Enable alias opcodes.  */
     96 
     97 #define SET_PROCESSOR_MASK(mask,set)	((mask) = ((mask) & ~PROCESSOR_MASK) | (set))
     98 
     99 /* The table itself is sorted by major opcode number, and is otherwise
    100    in the order in which the disassembler should consider
    101    instructions.  */
    102 extern const struct v850_opcode v850_opcodes[];
    103 extern const int v850_num_opcodes;
    104 
    105 
    106 /* The operands table is an array of struct v850_operand.  */
    108 
    109 struct v850_operand
    110 {
    111   /* The number of bits in the operand.  */
    112   /* If this value is -1 then the operand's bits are in a discontinous
    113      distribution in the instruction. */
    114   int bits;
    115 
    116   /* (bits >= 0):  How far the operand is left shifted in the instruction.  */
    117   /* (bits == -1): Bit mask of the bits in the operand.  */
    118   int shift;
    119 
    120   /* Insertion function.  This is used by the assembler.  To insert an
    121      operand value into an instruction, check this field.
    122 
    123      If it is NULL, execute
    124          i |= (op & ((1 << o->bits) - 1)) << o->shift;
    125      (i is the instruction which we are filling in, o is a pointer to
    126      this structure, and op is the opcode value; this assumes twos
    127      complement arithmetic).
    128 
    129      If this field is not NULL, then simply call it with the
    130      instruction and the operand value.  It will return the new value
    131      of the instruction.  If the ERRMSG argument is not NULL, then if
    132      the operand value is illegal, *ERRMSG will be set to a warning
    133      string (the operand will be inserted in any case).  If the
    134      operand value is legal, *ERRMSG will be unchanged (most operands
    135      can accept any value).  */
    136   unsigned long (* insert)
    137     (unsigned long instruction, long op, const char ** errmsg);
    138 
    139   /* Extraction function.  This is used by the disassembler.  To
    140      extract this operand type from an instruction, check this field.
    141 
    142      If it is NULL, compute
    143          op = o->bits == -1 ? ((i) & o->shift) : ((i) >> o->shift) & ((1 << o->bits) - 1);
    144 	 if (o->flags & V850_OPERAND_SIGNED)
    145 	     op = (op << (32 - o->bits)) >> (32 - o->bits);
    146      (i is the instruction, o is a pointer to this structure, and op
    147      is the result; this assumes twos complement arithmetic).
    148 
    149      If this field is not NULL, then simply call it with the
    150      instruction value.  It will return the value of the operand.  If
    151      the INVALID argument is not NULL, *INVALID will be set to
    152      non-zero if this operand type can not actually be extracted from
    153      this operand (i.e., the instruction does not match).  If the
    154      operand is valid, *INVALID will not be changed.  */
    155   unsigned long (* extract) (unsigned long instruction, int * invalid);
    156 
    157   /* One bit syntax flags.  */
    158   int flags;
    159 
    160   int default_reloc;
    161 };
    162 
    163 /* Elements in the table are retrieved by indexing with values from
    164    the operands field of the v850_opcodes table.  */
    165 
    166 extern const struct v850_operand v850_operands[];
    167 
    168 /* Values defined for the flags field of a struct v850_operand.  */
    169 
    170 /* This operand names a general purpose register.  */
    171 #define V850_OPERAND_REG	0x01
    172 
    173 /* This operand is the ep register.  */
    174 #define V850_OPERAND_EP		0x02
    175 
    176 /* This operand names a system register.  */
    177 #define V850_OPERAND_SRG	0x04
    178 
    179 /* Prologue eilogue type instruction, V850E specific.  */
    180 #define V850E_OPERAND_REG_LIST	0x08
    181 
    182 /* This operand names a condition code used in the setf instruction.  */
    183 #define V850_OPERAND_CC		0x10
    184 
    185 #define V850_OPERAND_FLOAT_CC	0x20
    186 
    187 /* This operand names a vector purpose register.  */
    188 #define V850_OPERAND_VREG	0x40
    189 
    190 /* 16 bit immediate follows instruction, V850E specific.  */
    191 #define V850E_IMMEDIATE16	0x80
    192 
    193 /* hi16 bit immediate follows instruction, V850E specific.  */
    194 #define V850E_IMMEDIATE16HI	0x100
    195 
    196 /* 23 bit immediate follows instruction, V850E specific.  */
    197 #define V850E_IMMEDIATE23	0x200
    198 
    199 /* 32 bit immediate follows instruction, V850E specific.  */
    200 #define V850E_IMMEDIATE32	0x400
    201 
    202 /* This is a relaxable operand.   Only used for D9->D22 branch relaxing
    203    right now.  We may need others in the future (or maybe handle them like
    204    promoted operands on the mn10300?).  */
    205 #define V850_OPERAND_RELAX	0x800
    206 
    207 /* This operand takes signed values.  */
    208 #define V850_OPERAND_SIGNED	0x1000
    209 
    210 /* This operand is a displacement.  */
    211 #define V850_OPERAND_DISP	0x2000
    212 
    213 /* This operand is a PC displacement.  */
    214 #define V850_PCREL		0x4000
    215 
    216 /* The register specified must be even number.  */
    217 #define V850_REG_EVEN		0x8000
    218 
    219 /* The register specified must not be r0.  */
    220 #define V850_NOT_R0	        0x20000
    221 
    222 /* The register specified must not be 0.  */
    223 #define V850_NOT_IMM0	        0x40000
    224 
    225 /* The condition code must not be SA CONDITION.  */
    226 #define V850_NOT_SA		0x80000
    227 
    228 /* The operand has '!' prefix.  */
    229 #define V850_OPERAND_BANG	0x100000
    230 
    231 /* The operand has '%' prefix.  */
    232 #define V850_OPERAND_PERCENT	0x200000
    233 
    234 /* This operand is a cache oparation.  */
    235 #define V850_OPERAND_CACHEOP	0x400000
    236 
    237 /* This operand is a prefetch oparation.  */
    238 #define V850_OPERAND_PREFOP	0x800000
    239 
    240 /* A PC-relative displacement where a positive value indicates a backwards displacement.  */
    241 #define V850_INVERSE_PCREL	0x1000000
    242 
    243 extern int v850_msg_is_out_of_range (const char *);
    244 
    245 #ifdef __cplusplus
    246 }
    247 #endif
    248 
    249 #endif /* V850_H */
    250