include/opcode/s390.h

   1 /* s390.h -- Header file for S390 opcode table
   2    Copyright (C) 2000-2014 Free Software Foundation, Inc.
   3    Contributed by Martin Schwidefsky (schwidefsky@de.ibm.com).
   4
   5    This file is part of BFD, the Binary File Descriptor library.
   6
   7    This program is free software; you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation; either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    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 program; if not, write to the Free Software
  19    Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
  20    02110-1301, USA.  */
  21
  22 #ifndef S390_H
  23 #define S390_H
  24
  25 /* List of instruction sets variations. */
  26
  27 enum s390_opcode_mode_val
  28   {
  29     S390_OPCODE_ESA = 0,
  30     S390_OPCODE_ZARCH
  31   };
  32
  33 enum s390_opcode_cpu_val
  34   {
  35     S390_OPCODE_G5 = 0,
  36     S390_OPCODE_G6,
  37     S390_OPCODE_Z900,
  38     S390_OPCODE_Z990,
  39     S390_OPCODE_Z9_109,
  40     S390_OPCODE_Z9_EC,
  41     S390_OPCODE_Z10,
  42     S390_OPCODE_Z196,
  43     S390_OPCODE_ZEC12,
  44     S390_OPCODE_MAXCPU
  45   };
  46
  47 /* The opcode table is an array of struct s390_opcode.  */
  48
  49 struct s390_opcode
  50   {
  51     /* The opcode name.  */
  52     const char * name;
  53
  54     /* The opcode itself.  Those bits which will be filled in with
  55        operands are zeroes.  */
  56     unsigned char opcode[6];
  57
  58     /* The opcode mask.  This is used by the disassembler.  This is a
  59        mask containing ones indicating those bits which must match the
  60        opcode field, and zeroes indicating those bits which need not
  61        match (and are presumably filled in by operands).  */
  62     unsigned char mask[6];
  63
  64     /* The opcode length in bytes. */
  65     int oplen;
  66
  67     /* An array of operand codes.  Each code is an index into the
  68        operand table.  They appear in the order which the operands must
  69        appear in assembly code, and are terminated by a zero.  */
  70     unsigned char operands[6];
  71
  72     /* Bitmask of execution modes this opcode is available for.  */
  73     unsigned int modes;
  74
  75     /* First cpu this opcode is available for.  */
  76     enum s390_opcode_cpu_val min_cpu;
  77   };
  78
  79 /* The table itself is sorted by major opcode number, and is otherwise
  80    in the order in which the disassembler should consider
  81    instructions.  */
  82 extern const struct s390_opcode s390_opcodes[];
  83 extern const int                s390_num_opcodes;
  84
  85 /* A opcode format table for the .insn pseudo mnemonic.  */
  86 extern const struct s390_opcode s390_opformats[];
  87 extern const int                s390_num_opformats;
  88
  89 /* Values defined for the flags field of a struct powerpc_opcode.  */
  90
  91 /* The operands table is an array of struct s390_operand.  */
  92
  93 struct s390_operand
  94   {
  95     /* The number of bits in the operand.  */
  96     int bits;
  97
  98     /* How far the operand is left shifted in the instruction.  */
  99     int shift;
 100
 101     /* One bit syntax flags.  */
 102     unsigned long flags;
 103   };
 104
 105 /* Elements in the table are retrieved by indexing with values from
 106    the operands field of the powerpc_opcodes table.  */
 107
 108 extern const struct s390_operand s390_operands[];
 109
 110 /* Values defined for the flags field of a struct s390_operand.  */
 111
 112 /* This operand names a register.  The disassembler uses this to print
 113    register names with a leading 'r'.  */
 114 #define S390_OPERAND_GPR 0x1
 115
 116 /* This operand names a floating point register.  The disassembler
 117    prints these with a leading 'f'. */
 118 #define S390_OPERAND_FPR 0x2
 119
 120 /* This operand names an access register.  The disassembler
 121    prints these with a leading 'a'.  */
 122 #define S390_OPERAND_AR 0x4
 123
 124 /* This operand names a control register.  The disassembler
 125    prints these with a leading 'c'.  */
 126 #define S390_OPERAND_CR 0x8
 127
 128 /* This operand is a displacement.  */
 129 #define S390_OPERAND_DISP 0x10
 130
 131 /* This operand names a base register.  */
 132 #define S390_OPERAND_BASE 0x20
 133
 134 /* This operand names an index register, it can be skipped.  */
 135 #define S390_OPERAND_INDEX 0x40
 136
 137 /* This operand is a relative branch displacement.  The disassembler
 138    prints these symbolically if possible.  */
 139 #define S390_OPERAND_PCREL 0x80
 140
 141 /* This operand takes signed values.  */
 142 #define S390_OPERAND_SIGNED 0x100
 143
 144 /* This operand is a length.  */
 145 #define S390_OPERAND_LENGTH 0x200
 146
 147 /* This operand is optional. Only a single operand at the end of
 148    the instruction may be optional.  */
 149 #define S390_OPERAND_OPTIONAL 0x400
 150
 151 /* The operand needs to be a valid GP or FP register pair.  */
 152 #define S390_OPERAND_REG_PAIR 0x800
 153
 154         #endif /* S390_H */