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