arch/ppc/xmon/ppc.h

   1 /*
   2  * BK Id: SCCS/s.ppc.h 1.7 06/05/01 21:22:06 paulus
   3  */
   4 /* ppc.h -- Header file for PowerPC opcode table
   5    Copyright 1994 Free Software Foundation, Inc.
   6    Written 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
  13 1, 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 COPYING.  If not, write to the Free
  22 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  23
  24 #ifndef PPC_H
  25 #define PPC_H
  26
  27 /* The opcode table is an array of struct powerpc_opcode.  */
  28
  29 struct powerpc_opcode
  30 {
  31   /* The opcode name.  */
  32   const char *name;
  33
  34   /* The opcode itself.  Those bits which will be filled in with
  35      operands are zeroes.  */
  36   unsigned long opcode;
  37
  38   /* The opcode mask.  This is used by the disassembler.  This is a
  39      mask containing ones indicating those bits which must match the
  40      opcode field, and zeroes indicating those bits which need not
  41      match (and are presumably filled in by operands).  */
  42   unsigned long mask;
  43
  44   /* One bit flags for the opcode.  These are used to indicate which
  45      specific processors support the instructions.  The defined values
  46      are listed below.  */
  47   unsigned long flags;
  48
  49   /* An array of operand codes.  Each code is an index into the
  50      operand table.  They appear in the order which the operands must
  51      appear in assembly code, and are terminated by a zero.  */
  52   unsigned char operands[8];
  53 };
  54
  55 /* The table itself is sorted by major opcode number, and is otherwise
  56    in the order in which the disassembler should consider
  57    instructions.  */
  58 extern const struct powerpc_opcode powerpc_opcodes[];
  59 extern const int powerpc_num_opcodes;
  60
  61 /* Values defined for the flags field of a struct powerpc_opcode.  */
  62
  63 /* Opcode is defined for the PowerPC architecture.  */
  64 #define PPC_OPCODE_PPC (01)
  65
  66 /* Opcode is defined for the POWER (RS/6000) architecture.  */
  67 #define PPC_OPCODE_POWER (02)
  68
  69 /* Opcode is defined for the POWER2 (Rios 2) architecture.  */
  70 #define PPC_OPCODE_POWER2 (04)
  71
  72 /* Opcode is only defined on 32 bit architectures.  */
  73 #define PPC_OPCODE_32 (010)
  74
  75 /* Opcode is only defined on 64 bit architectures.  */
  76 #define PPC_OPCODE_64 (020)
  77
  78 /* Opcode is supported by the Motorola PowerPC 601 processor.  The 601
  79    is assumed to support all PowerPC (PPC_OPCODE_PPC) instructions,
  80    but it also supports many additional POWER instructions.  */
  81 #define PPC_OPCODE_601 (040)
  82
  83 /* A macro to extract the major opcode from an instruction.  */
  84 #define PPC_OP(i) (((i) >> 26) & 0x3f)
  85 \f
  86 /* The operands table is an array of struct powerpc_operand.  */
  87
  88 struct powerpc_operand
  89 {
  90   /* The number of bits in the operand.  */
  91   int bits;
  92
  93   /* How far the operand is left shifted in the instruction.  */
  94   int shift;
  95
  96   /* Insertion function.  This is used by the assembler.  To insert an
  97      operand value into an instruction, check this field.
  98
  99      If it is NULL, execute
 100          i |= (op & ((1 << o->bits) - 1)) << o->shift;
 101      (i is the instruction which we are filling in, o is a pointer to
 102      this structure, and op is the opcode value; this assumes twos
 103      complement arithmetic).
 104
 105      If this field is not NULL, then simply call it with the
 106      instruction and the operand value.  It will return the new value
 107      of the instruction.  If the ERRMSG argument is not NULL, then if
 108      the operand value is illegal, *ERRMSG will be set to a warning
 109      string (the operand will be inserted in any case).  If the
 110      operand value is legal, *ERRMSG will be unchanged (most operands
 111      can accept any value).  */
 112   unsigned long (*insert) PARAMS ((unsigned long instruction, long op,
 113                                    const char **errmsg));
 114
 115   /* Extraction function.  This is used by the disassembler.  To
 116      extract this operand type from an instruction, check this field.
 117
 118      If it is NULL, compute
 119          op = ((i) >> o->shift) & ((1 << o->bits) - 1);
 120          if ((o->flags & PPC_OPERAND_SIGNED) != 0
 121              && (op & (1 << (o->bits - 1))) != 0)
 122            op -= 1 << o->bits;
 123      (i is the instruction, o is a pointer to this structure, and op
 124      is the result; this assumes twos complement arithmetic).
 125
 126      If this field is not NULL, then simply call it with the
 127      instruction value.  It will return the value of the operand.  If
 128      the INVALID argument is not NULL, *INVALID will be set to
 129      non-zero if this operand type can not actually be extracted from
 130      this operand (i.e., the instruction does not match).  If the
 131      operand is valid, *INVALID will not be changed.  */
 132   long (*extract) PARAMS ((unsigned long instruction, int *invalid));
 133
 134   /* One bit syntax flags.  */
 135   unsigned long flags;
 136 };
 137
 138 /* Elements in the table are retrieved by indexing with values from
 139    the operands field of the powerpc_opcodes table.  */
 140
 141 extern const struct powerpc_operand powerpc_operands[];
 142
 143 /* Values defined for the flags field of a struct powerpc_operand.  */
 144
 145 /* This operand takes signed values.  */
 146 #define PPC_OPERAND_SIGNED (01)
 147
 148 /* This operand takes signed values, but also accepts a full positive
 149    range of values when running in 32 bit mode.  That is, if bits is
 150    16, it takes any value from -0x8000 to 0xffff.  In 64 bit mode,
 151    this flag is ignored.  */
 152 #define PPC_OPERAND_SIGNOPT (02)
 153
 154 /* This operand does not actually exist in the assembler input.  This
 155    is used to support extended mnemonics such as mr, for which two
 156    operands fields are identical.  The assembler should call the
 157    insert function with any op value.  The disassembler should call
 158    the extract function, ignore the return value, and check the value
 159    placed in the valid argument.  */
 160 #define PPC_OPERAND_FAKE (04)
 161
 162 /* The next operand should be wrapped in parentheses rather than
 163    separated from this one by a comma.  This is used for the load and
 164    store instructions which want their operands to look like
 165        reg,displacement(reg)
 166    */
 167 #define PPC_OPERAND_PARENS (010)
 168
 169 /* This operand may use the symbolic names for the CR fields, which
 170    are
 171        lt  0    gt  1   eq  2   so  3   un  3
 172        cr0 0    cr1 1   cr2 2   cr3 3
 173        cr4 4    cr5 5   cr6 6   cr7 7
 174    These may be combined arithmetically, as in cr2*4+gt.  These are
 175    only supported on the PowerPC, not the POWER.  */
 176 #define PPC_OPERAND_CR (020)
 177
 178 /* This operand names a register.  The disassembler uses this to print
 179    register names with a leading 'r'.  */
 180 #define PPC_OPERAND_GPR (040)
 181
 182 /* This operand names a floating point register.  The disassembler
 183    prints these with a leading 'f'.  */
 184 #define PPC_OPERAND_FPR (0100)
 185
 186 /* This operand is a relative branch displacement.  The disassembler
 187    prints these symbolically if possible.  */
 188 #define PPC_OPERAND_RELATIVE (0200)
 189
 190 /* This operand is an absolute branch address.  The disassembler
 191    prints these symbolically if possible.  */
 192 #define PPC_OPERAND_ABSOLUTE (0400)
 193
 194 /* This operand is optional, and is zero if omitted.  This is used for
 195    the optional BF and L fields in the comparison instructions.  The
 196    assembler must count the number of operands remaining on the line,
 197    and the number of operands remaining for the opcode, and decide
 198    whether this operand is present or not.  The disassembler should
 199    print this operand out only if it is not zero.  */
 200 #define PPC_OPERAND_OPTIONAL (01000)
 201
 202 /* This flag is only used with PPC_OPERAND_OPTIONAL.  If this operand
 203    is omitted, then for the next operand use this operand value plus
 204    1, ignoring the next operand field for the opcode.  This wretched
 205    hack is needed because the Power rotate instructions can take
 206    either 4 or 5 operands.  The disassembler should print this operand
 207    out regardless of the PPC_OPERAND_OPTIONAL field.  */
 208 #define PPC_OPERAND_NEXT (02000)
 209
 210 /* This operand should be regarded as a negative number for the
 211    purposes of overflow checking (i.e., the normal most negative
 212    number is disallowed and one more than the normal most positive
 213    number is allowed).  This flag will only be set for a signed
 214    operand.  */
 215 #define PPC_OPERAND_NEGATIVE (04000)
 216 \f
 217 /* The POWER and PowerPC assemblers use a few macros.  We keep them
 218    with the operands table for simplicity.  The macro table is an
 219    array of struct powerpc_macro.  */
 220
 221 struct powerpc_macro
 222 {
 223   /* The macro name.  */
 224   const char *name;
 225
 226   /* The number of operands the macro takes.  */
 227   unsigned int operands;
 228
 229   /* One bit flags for the opcode.  These are used to indicate which
 230      specific processors support the instructions.  The values are the
 231      same as those for the struct powerpc_opcode flags field.  */
 232   unsigned long flags;
 233
 234   /* A format string to turn the macro into a normal instruction.
 235      Each %N in the string is replaced with operand number N (zero
 236      based).  */
 237   const char *format;
 238 };
 239
 240 extern const struct powerpc_macro powerpc_macros[];
 241 extern const int powerpc_num_macros;
 242
 243 #endif /* PPC_H */