include/opcode/ppc.h

   1 /* ppc.h -- Header file for PowerPC opcode table
   2    Copyright 1994, 1995, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
   3    2007, 2008, 2009 Free Software Foundation, Inc.
   4    Written by Ian Lance Taylor, Cygnus Support
   5
   6 This file is part of GDB, GAS, and the GNU binutils.
   7
   8 GDB, GAS, and the GNU binutils are free software; you can redistribute
   9 them and/or modify them under the terms of the GNU General Public
  10 License as published by the Free Software Foundation; either version
  11 1, or (at your option) any later version.
  12
  13 GDB, GAS, and the GNU binutils are distributed in the hope that they
  14 will be useful, but WITHOUT ANY WARRANTY; without even the implied
  15 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See
  16 the GNU General Public License for more details.
  17
  18 You should have received a copy of the GNU General Public License
  19 along with this file; see the file COPYING.  If not, write to the Free
  20 Software Foundation, 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef PPC_H
  23 #define PPC_H
  24
  25 #include "bfd_stdint.h"
  26
  27 typedef uint64_t ppc_cpu_t;
  28
  29 /* The opcode table is an array of struct powerpc_opcode.  */
  30
  31 struct powerpc_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   /* One bit flags for the opcode.  These are used to indicate which
  47      specific processors support the instructions.  The defined values
  48      are listed below.  */
  49   ppc_cpu_t flags;
  50
  51   /* One bit flags for the opcode.  These are used to indicate which
  52      specific processors no longer support the instructions.  The defined
  53      values are listed below.  */
  54   ppc_cpu_t deprecated;
  55
  56   /* An array of operand codes.  Each code is an index into the
  57      operand table.  They appear in the order which the operands must
  58      appear in assembly code, and are terminated by a zero.  */
  59   unsigned char operands[8];
  60 };
  61
  62 /* The table itself is sorted by major opcode number, and is otherwise
  63    in the order in which the disassembler should consider
  64    instructions.  */
  65 extern const struct powerpc_opcode powerpc_opcodes[];
  66 extern const int powerpc_num_opcodes;
  67
  68 /* Values defined for the flags field of a struct powerpc_opcode.  */
  69
  70 /* Opcode is defined for the PowerPC architecture.  */
  71 #define PPC_OPCODE_PPC                   1
  72
  73 /* Opcode is defined for the POWER (RS/6000) architecture.  */
  74 #define PPC_OPCODE_POWER                 2
  75
  76 /* Opcode is defined for the POWER2 (Rios 2) architecture.  */
  77 #define PPC_OPCODE_POWER2                4
  78
  79 /* Opcode is only defined on 32 bit architectures.  */
  80 #define PPC_OPCODE_32                    8
  81
  82 /* Opcode is only defined on 64 bit architectures.  */
  83 #define PPC_OPCODE_64                 0x10
  84
  85 /* Opcode is supported by the Motorola PowerPC 601 processor.  The 601
  86    is assumed to support all PowerPC (PPC_OPCODE_PPC) instructions,
  87    but it also supports many additional POWER instructions.  */
  88 #define PPC_OPCODE_601                0x20
  89
  90 /* Opcode is supported in both the Power and PowerPC architectures
  91    (ie, compiler's -mcpu=common or assembler's -mcom).  */
  92 #define PPC_OPCODE_COMMON             0x40
  93
  94 /* Opcode is supported for any Power or PowerPC platform (this is
  95    for the assembler's -many option, and it eliminates duplicates).  */
  96 #define PPC_OPCODE_ANY                0x80
  97
  98 /* Opcode is supported as part of the 64-bit bridge.  */
  99 #define PPC_OPCODE_64_BRIDGE         0x100
 100
 101 /* Opcode is supported by Altivec Vector Unit */
 102 #define PPC_OPCODE_ALTIVEC           0x200
 103
 104 /* Opcode is supported by PowerPC 403 processor.  */
 105 #define PPC_OPCODE_403               0x400
 106
 107 /* Opcode is supported by PowerPC BookE processor.  */
 108 #define PPC_OPCODE_BOOKE             0x800
 109
 110 /* Opcode is only supported by 64-bit PowerPC BookE processor.  */
 111 #define PPC_OPCODE_BOOKE64          0x1000
 112
 113 /* Opcode is supported by PowerPC 440 processor.  */
 114 #define PPC_OPCODE_440              0x2000
 115
 116 /* Opcode is only supported by Power4 architecture.  */
 117 #define PPC_OPCODE_POWER4           0x4000
 118
 119 /* Opcode is only supported by Power7 architecture.  */
 120 #define PPC_OPCODE_POWER7           0x8000
 121
 122 /* Opcode is only supported by POWERPC Classic architecture.  */
 123 #define PPC_OPCODE_CLASSIC         0x10000
 124
 125 /* Opcode is only supported by e500x2 Core.  */
 126 #define PPC_OPCODE_SPE             0x20000
 127
 128 /* Opcode is supported by e500x2 Integer select APU.  */
 129 #define PPC_OPCODE_ISEL            0x40000
 130
 131 /* Opcode is an e500 SPE floating point instruction.  */
 132 #define PPC_OPCODE_EFS             0x80000
 133
 134 /* Opcode is supported by branch locking APU.  */
 135 #define PPC_OPCODE_BRLOCK         0x100000
 136
 137 /* Opcode is supported by performance monitor APU.  */
 138 #define PPC_OPCODE_PMR            0x200000
 139
 140 /* Opcode is supported by cache locking APU.  */
 141 #define PPC_OPCODE_CACHELCK       0x400000
 142
 143 /* Opcode is supported by machine check APU.  */
 144 #define PPC_OPCODE_RFMCI          0x800000
 145
 146 /* Opcode is only supported by Power5 architecture.  */
 147 #define PPC_OPCODE_POWER5        0x1000000
 148
 149 /* Opcode is supported by PowerPC e300 family.  */
 150 #define PPC_OPCODE_E300          0x2000000
 151
 152 /* Opcode is only supported by Power6 architecture.  */
 153 #define PPC_OPCODE_POWER6        0x4000000
 154
 155 /* Opcode is only supported by PowerPC Cell family.  */
 156 #define PPC_OPCODE_CELL          0x8000000
 157
 158 /* Opcode is supported by CPUs with paired singles support.  */
 159 #define PPC_OPCODE_PPCPS         0x10000000
 160
 161 /* Opcode is supported by Power E500MC */
 162 #define PPC_OPCODE_E500MC        0x20000000
 163
 164 /* Opcode is supported by PowerPC 405 processor.  */
 165 #define PPC_OPCODE_405           0x40000000
 166
 167 /* Opcode is supported by Vector-Scalar (VSX) Unit */
 168 #define PPC_OPCODE_VSX           0x80000000
 169
 170 /* Opcode is supported by A2.  */
 171 #define PPC_OPCODE_A2           0x100000000ULL
 172
 173 /* Opcode is supported by PowerPC 476 processor.  */
 174 #define PPC_OPCODE_476           0x200000000ULL
 175
 176 /* A macro to extract the major opcode from an instruction.  */
 177 #define PPC_OP(i) (((i) >> 26) & 0x3f)
 178 \f
 179 /* The operands table is an array of struct powerpc_operand.  */
 180
 181 struct powerpc_operand
 182 {
 183   /* A bitmask of bits in the operand.  */
 184   unsigned int bitm;
 185
 186   /* How far the operand is left shifted in the instruction.
 187      -1 to indicate that BITM and SHIFT cannot be used to determine
 188      where the operand goes in the insn.  */
 189   int shift;
 190
 191   /* Insertion function.  This is used by the assembler.  To insert an
 192      operand value into an instruction, check this field.
 193
 194      If it is NULL, execute
 195          i |= (op & o->bitm) << o->shift;
 196      (i is the instruction which we are filling in, o is a pointer to
 197      this structure, and op is the operand value).
 198
 199      If this field is not NULL, then simply call it with the
 200      instruction and the operand value.  It will return the new value
 201      of the instruction.  If the ERRMSG argument is not NULL, then if
 202      the operand value is illegal, *ERRMSG will be set to a warning
 203      string (the operand will be inserted in any case).  If the
 204      operand value is legal, *ERRMSG will be unchanged (most operands
 205      can accept any value).  */
 206   unsigned long (*insert)
 207     (unsigned long instruction, long op, ppc_cpu_t dialect, const char **errmsg);
 208
 209   /* Extraction function.  This is used by the disassembler.  To
 210      extract this operand type from an instruction, check this field.
 211
 212      If it is NULL, compute
 213          op = (i >> o->shift) & o->bitm;
 214          if ((o->flags & PPC_OPERAND_SIGNED) != 0)
 215            sign_extend (op);
 216      (i is the instruction, o is a pointer to this structure, and op
 217      is the result).
 218
 219      If this field is not NULL, then simply call it with the
 220      instruction value.  It will return the value of the operand.  If
 221      the INVALID argument is not NULL, *INVALID will be set to
 222      non-zero if this operand type can not actually be extracted from
 223      this operand (i.e., the instruction does not match).  If the
 224      operand is valid, *INVALID will not be changed.  */
 225   long (*extract) (unsigned long instruction, ppc_cpu_t dialect, int *invalid);
 226
 227   /* One bit syntax flags.  */
 228   unsigned long flags;
 229 };
 230
 231 /* Elements in the table are retrieved by indexing with values from
 232    the operands field of the powerpc_opcodes table.  */
 233
 234 extern const struct powerpc_operand powerpc_operands[];
 235 extern const unsigned int num_powerpc_operands;
 236
 237 /* Values defined for the flags field of a struct powerpc_operand.  */
 238
 239 /* This operand takes signed values.  */
 240 #define PPC_OPERAND_SIGNED (0x1)
 241
 242 /* This operand takes signed values, but also accepts a full positive
 243    range of values when running in 32 bit mode.  That is, if bits is
 244    16, it takes any value from -0x8000 to 0xffff.  In 64 bit mode,
 245    this flag is ignored.  */
 246 #define PPC_OPERAND_SIGNOPT (0x2)
 247
 248 /* This operand does not actually exist in the assembler input.  This
 249    is used to support extended mnemonics such as mr, for which two
 250    operands fields are identical.  The assembler should call the
 251    insert function with any op value.  The disassembler should call
 252    the extract function, ignore the return value, and check the value
 253    placed in the valid argument.  */
 254 #define PPC_OPERAND_FAKE (0x4)
 255
 256 /* The next operand should be wrapped in parentheses rather than
 257    separated from this one by a comma.  This is used for the load and
 258    store instructions which want their operands to look like
 259        reg,displacement(reg)
 260    */
 261 #define PPC_OPERAND_PARENS (0x8)
 262
 263 /* This operand may use the symbolic names for the CR fields, which
 264    are
 265        lt  0    gt  1   eq  2   so  3   un  3
 266        cr0 0    cr1 1   cr2 2   cr3 3
 267        cr4 4    cr5 5   cr6 6   cr7 7
 268    These may be combined arithmetically, as in cr2*4+gt.  These are
 269    only supported on the PowerPC, not the POWER.  */
 270 #define PPC_OPERAND_CR (0x10)
 271
 272 /* This operand names a register.  The disassembler uses this to print
 273    register names with a leading 'r'.  */
 274 #define PPC_OPERAND_GPR (0x20)
 275
 276 /* Like PPC_OPERAND_GPR, but don't print a leading 'r' for r0.  */
 277 #define PPC_OPERAND_GPR_0 (0x40)
 278
 279 /* This operand names a floating point register.  The disassembler
 280    prints these with a leading 'f'.  */
 281 #define PPC_OPERAND_FPR (0x80)
 282
 283 /* This operand is a relative branch displacement.  The disassembler
 284    prints these symbolically if possible.  */
 285 #define PPC_OPERAND_RELATIVE (0x100)
 286
 287 /* This operand is an absolute branch address.  The disassembler
 288    prints these symbolically if possible.  */
 289 #define PPC_OPERAND_ABSOLUTE (0x200)
 290
 291 /* This operand is optional, and is zero if omitted.  This is used for
 292    example, in the optional BF field in the comparison instructions.  The
 293    assembler must count the number of operands remaining on the line,
 294    and the number of operands remaining for the opcode, and decide
 295    whether this operand is present or not.  The disassembler should
 296    print this operand out only if it is not zero.  */
 297 #define PPC_OPERAND_OPTIONAL (0x400)
 298
 299 /* This flag is only used with PPC_OPERAND_OPTIONAL.  If this operand
 300    is omitted, then for the next operand use this operand value plus
 301    1, ignoring the next operand field for the opcode.  This wretched
 302    hack is needed because the Power rotate instructions can take
 303    either 4 or 5 operands.  The disassembler should print this operand
 304    out regardless of the PPC_OPERAND_OPTIONAL field.  */
 305 #define PPC_OPERAND_NEXT (0x800)
 306
 307 /* This operand should be regarded as a negative number for the
 308    purposes of overflow checking (i.e., the normal most negative
 309    number is disallowed and one more than the normal most positive
 310    number is allowed).  This flag will only be set for a signed
 311    operand.  */
 312 #define PPC_OPERAND_NEGATIVE (0x1000)
 313
 314 /* This operand names a vector unit register.  The disassembler
 315    prints these with a leading 'v'.  */
 316 #define PPC_OPERAND_VR (0x2000)
 317
 318 /* This operand is for the DS field in a DS form instruction.  */
 319 #define PPC_OPERAND_DS (0x4000)
 320
 321 /* This operand is for the DQ field in a DQ form instruction.  */
 322 #define PPC_OPERAND_DQ (0x8000)
 323
 324 /* Valid range of operand is 0..n rather than 0..n-1.  */
 325 #define PPC_OPERAND_PLUS1 (0x10000)
 326
 327 /* Xilinx APU and FSL related operands */
 328 #define PPC_OPERAND_FSL (0x20000)
 329 #define PPC_OPERAND_FCR (0x40000)
 330 #define PPC_OPERAND_UDI (0x80000)
 331
 332 /* This operand names a vector-scalar unit register.  The disassembler
 333    prints these with a leading 'vs'.  */
 334 #define PPC_OPERAND_VSR (0x100000)
 335 \f
 336 /* The POWER and PowerPC assemblers use a few macros.  We keep them
 337    with the operands table for simplicity.  The macro table is an
 338    array of struct powerpc_macro.  */
 339
 340 struct powerpc_macro
 341 {
 342   /* The macro name.  */
 343   const char *name;
 344
 345   /* The number of operands the macro takes.  */
 346   unsigned int operands;
 347
 348   /* One bit flags for the opcode.  These are used to indicate which
 349      specific processors support the instructions.  The values are the
 350      same as those for the struct powerpc_opcode flags field.  */
 351   ppc_cpu_t flags;
 352
 353   /* A format string to turn the macro into a normal instruction.
 354      Each %N in the string is replaced with operand number N (zero
 355      based).  */
 356   const char *format;
 357 };
 358
 359 extern const struct powerpc_macro powerpc_macros[];
 360 extern const int powerpc_num_macros;
 361
 362 extern ppc_cpu_t ppc_parse_cpu (ppc_cpu_t, const char *);
 363
 364 #endif /* PPC_H */