include/opcode/arm.h

   1 /* ARM assembler/disassembler support.
   2    Copyright 2004, 2010, 2011 Free Software Foundation, Inc.
   3
   4    This file is part of GDB and GAS.
   5
   6    GDB and GAS are free software; you can redistribute it and/or
   7    modify it under the terms of the GNU General Public License as
   8    published by the Free Software Foundation; either version 3, or (at
   9    your option) any later version.
  10
  11    GDB and GAS are distributed in the hope that it will be useful, but
  12    WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14    General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with GDB or GAS; see the file COPYING3.  If not, write to the
  18    Free Software Foundation, 51 Franklin Street - Fifth Floor, Boston,
  19    MA 02110-1301, USA.  */
  20
  21 /* The following bitmasks control CPU extensions:  */
  22 #define ARM_EXT_V1       0x00000001     /* All processors (core set).  */
  23 #define ARM_EXT_V2       0x00000002     /* Multiply instructions.  */
  24 #define ARM_EXT_V2S      0x00000004     /* SWP instructions.       */
  25 #define ARM_EXT_V3       0x00000008     /* MSR MRS.                */
  26 #define ARM_EXT_V3M      0x00000010     /* Allow long multiplies.  */
  27 #define ARM_EXT_V4       0x00000020     /* Allow half word loads.  */
  28 #define ARM_EXT_V4T      0x00000040     /* Thumb.                  */
  29 #define ARM_EXT_V5       0x00000080     /* Allow CLZ, etc.         */
  30 #define ARM_EXT_V5T      0x00000100     /* Improved interworking.  */
  31 #define ARM_EXT_V5ExP    0x00000200     /* DSP core set.           */
  32 #define ARM_EXT_V5E      0x00000400     /* DSP Double transfers.   */
  33 #define ARM_EXT_V5J      0x00000800     /* Jazelle extension.      */
  34 #define ARM_EXT_V6       0x00001000     /* ARM V6.                 */
  35 #define ARM_EXT_V6K      0x00002000     /* ARM V6K.                */
  36 /*                       0x00004000        Was ARM V6Z.            */
  37 #define ARM_EXT_V6T2     0x00008000     /* Thumb-2.                */
  38 #define ARM_EXT_DIV      0x00010000     /* Integer division.       */
  39 /* The 'M' in Arm V7M stands for Microcontroller.
  40    On earlier architecture variants it stands for Multiply.  */
  41 #define ARM_EXT_V5E_NOTM 0x00020000     /* Arm V5E but not Arm V7M. */
  42 #define ARM_EXT_V6_NOTM  0x00040000     /* Arm V6 but not Arm V7M. */
  43 #define ARM_EXT_V7       0x00080000     /* Arm V7.                 */
  44 #define ARM_EXT_V7A      0x00100000     /* Arm V7A.                */
  45 #define ARM_EXT_V7R      0x00200000     /* Arm V7R.                */
  46 #define ARM_EXT_V7M      0x00400000     /* Arm V7M.                */
  47 #define ARM_EXT_V6M      0x00800000     /* ARM V6M.                 */
  48 #define ARM_EXT_BARRIER  0x01000000     /* DSB/DMB/ISB.             */
  49 #define ARM_EXT_THUMB_MSR 0x02000000    /* Thumb MSR/MRS.           */
  50 #define ARM_EXT_V6_DSP 0x04000000       /* ARM v6 (DSP-related),
  51                                            not in v7-M.  */
  52 #define ARM_EXT_MP       0x08000000     /* Multiprocessing Extensions.  */
  53 #define ARM_EXT_SEC      0x10000000     /* Security extensions.  */
  54 #define ARM_EXT_OS       0x20000000     /* OS Extensions.  */
  55 #define ARM_EXT_ADIV     0x40000000     /* Integer divide extensions in ARM
  56                                            state.  */
  57 #define ARM_EXT_VIRT     0x80000000     /* Virtualization extensions.  */
  58
  59 /* Co-processor space extensions.  */
  60 #define ARM_CEXT_XSCALE   0x00000001    /* Allow MIA etc.          */
  61 #define ARM_CEXT_MAVERICK 0x00000002    /* Use Cirrus/DSP coprocessor.  */
  62 #define ARM_CEXT_IWMMXT   0x00000004    /* Intel Wireless MMX technology coprocessor.   */
  63 #define ARM_CEXT_IWMMXT2  0x00000008    /* Intel Wireless MMX technology coprocessor version 2.   */
  64
  65 #define FPU_ENDIAN_PURE  0x80000000     /* Pure-endian doubles.       */
  66 #define FPU_ENDIAN_BIG   0              /* Double words-big-endian.   */
  67 #define FPU_FPA_EXT_V1   0x40000000     /* Base FPA instruction set.  */
  68 #define FPU_FPA_EXT_V2   0x20000000     /* LFM/SFM.                   */
  69 #define FPU_MAVERICK     0x10000000     /* Cirrus Maverick.           */
  70 #define FPU_VFP_EXT_V1xD 0x08000000     /* Base VFP instruction set.  */
  71 #define FPU_VFP_EXT_V1   0x04000000     /* Double-precision insns.    */
  72 #define FPU_VFP_EXT_V2   0x02000000     /* ARM10E VFPr1.              */
  73 #define FPU_VFP_EXT_V3xD 0x01000000     /* VFPv3 single-precision.    */
  74 #define FPU_VFP_EXT_V3   0x00800000     /* VFPv3 double-precision.    */
  75 #define FPU_NEON_EXT_V1  0x00400000     /* Neon (SIMD) insns.         */
  76 #define FPU_VFP_EXT_D32  0x00200000     /* Registers D16-D31.         */
  77 #define FPU_VFP_EXT_FP16 0x00100000     /* Half-precision extensions. */
  78 #define FPU_NEON_EXT_FMA 0x00080000     /* Neon fused multiply-add    */
  79 #define FPU_VFP_EXT_FMA  0x00040000     /* VFP fused multiply-add     */
  80
  81 /* Architectures are the sum of the base and extensions.  The ARM ARM (rev E)
  82    defines the following: ARMv3, ARMv3M, ARMv4xM, ARMv4, ARMv4TxM, ARMv4T,
  83    ARMv5xM, ARMv5, ARMv5TxM, ARMv5T, ARMv5TExP, ARMv5TE.  To these we add
  84    three more to cover cores prior to ARM6.  Finally, there are cores which
  85    implement further extensions in the co-processor space.  */
  86 #define ARM_AEXT_V1                       ARM_EXT_V1
  87 #define ARM_AEXT_V2     (ARM_AEXT_V1    | ARM_EXT_V2)
  88 #define ARM_AEXT_V2S    (ARM_AEXT_V2    | ARM_EXT_V2S)
  89 #define ARM_AEXT_V3     (ARM_AEXT_V2S   | ARM_EXT_V3)
  90 #define ARM_AEXT_V3M    (ARM_AEXT_V3    | ARM_EXT_V3M)
  91 #define ARM_AEXT_V4xM   (ARM_AEXT_V3    | ARM_EXT_V4)
  92 #define ARM_AEXT_V4     (ARM_AEXT_V3M   | ARM_EXT_V4)
  93 #define ARM_AEXT_V4TxM  (ARM_AEXT_V4xM  | ARM_EXT_V4T)
  94 #define ARM_AEXT_V4T    (ARM_AEXT_V4    | ARM_EXT_V4T)
  95 #define ARM_AEXT_V5xM   (ARM_AEXT_V4xM  | ARM_EXT_V5)
  96 #define ARM_AEXT_V5     (ARM_AEXT_V4    | ARM_EXT_V5)
  97 #define ARM_AEXT_V5TxM  (ARM_AEXT_V5xM  | ARM_EXT_V4T | ARM_EXT_V5T)
  98 #define ARM_AEXT_V5T    (ARM_AEXT_V5    | ARM_EXT_V4T | ARM_EXT_V5T)
  99 #define ARM_AEXT_V5TExP (ARM_AEXT_V5T   | ARM_EXT_V5ExP)
 100 #define ARM_AEXT_V5TE   (ARM_AEXT_V5TExP | ARM_EXT_V5E)
 101 #define ARM_AEXT_V5TEJ  (ARM_AEXT_V5TE  | ARM_EXT_V5J)
 102 #define ARM_AEXT_V6     (ARM_AEXT_V5TEJ | ARM_EXT_V6)
 103 #define ARM_AEXT_V6K    (ARM_AEXT_V6    | ARM_EXT_V6K)
 104 #define ARM_AEXT_V6Z    (ARM_AEXT_V6K   | ARM_EXT_SEC)
 105 #define ARM_AEXT_V6ZK   (ARM_AEXT_V6K   | ARM_EXT_SEC)
 106 #define ARM_AEXT_V6T2   (ARM_AEXT_V6 \
 107     | ARM_EXT_V6T2 | ARM_EXT_V6_NOTM | ARM_EXT_THUMB_MSR \
 108     | ARM_EXT_V6_DSP )
 109 #define ARM_AEXT_V6KT2  (ARM_AEXT_V6T2 | ARM_EXT_V6K)
 110 #define ARM_AEXT_V6ZT2  (ARM_AEXT_V6T2 | ARM_EXT_SEC)
 111 #define ARM_AEXT_V6ZKT2 (ARM_AEXT_V6T2 | ARM_EXT_V6K | ARM_EXT_SEC)
 112 #define ARM_AEXT_V7_ARM (ARM_AEXT_V6KT2 | ARM_EXT_V7 | ARM_EXT_BARRIER)
 113 #define ARM_AEXT_V7A    (ARM_AEXT_V7_ARM | ARM_EXT_V7A)
 114 #define ARM_AEXT_V7R    (ARM_AEXT_V7_ARM | ARM_EXT_V7R | ARM_EXT_DIV)
 115 #define ARM_AEXT_NOTM \
 116   (ARM_AEXT_V4 | ARM_EXT_V5ExP | ARM_EXT_V5J | ARM_EXT_V6_NOTM \
 117    | ARM_EXT_V6_DSP )
 118 #define ARM_AEXT_V6M_ONLY \
 119   ((ARM_EXT_BARRIER | ARM_EXT_V6M | ARM_EXT_THUMB_MSR) & ~(ARM_AEXT_NOTM))
 120 #define ARM_AEXT_V6M \
 121   ((ARM_AEXT_V6K | ARM_AEXT_V6M_ONLY) & ~(ARM_AEXT_NOTM))
 122 #define ARM_AEXT_V6SM (ARM_AEXT_V6M | ARM_EXT_OS)
 123 #define ARM_AEXT_V7M \
 124   ((ARM_AEXT_V7_ARM | ARM_EXT_V6M | ARM_EXT_V7M | ARM_EXT_DIV) \
 125    & ~(ARM_AEXT_NOTM))
 126 #define ARM_AEXT_V7 (ARM_AEXT_V7A & ARM_AEXT_V7R & ARM_AEXT_V7M)
 127 #define ARM_AEXT_V7EM \
 128   (ARM_AEXT_V7M | ARM_EXT_V5ExP | ARM_EXT_V6_DSP)
 129
 130 /* Processors with specific extensions in the co-processor space.  */
 131 #define ARM_ARCH_XSCALE ARM_FEATURE (ARM_AEXT_V5TE, ARM_CEXT_XSCALE)
 132 #define ARM_ARCH_IWMMXT \
 133  ARM_FEATURE (ARM_AEXT_V5TE, ARM_CEXT_XSCALE | ARM_CEXT_IWMMXT)
 134 #define ARM_ARCH_IWMMXT2        \
 135  ARM_FEATURE (ARM_AEXT_V5TE, ARM_CEXT_XSCALE | ARM_CEXT_IWMMXT | ARM_CEXT_IWMMXT2)
 136
 137 #define FPU_VFP_V1xD    (FPU_VFP_EXT_V1xD | FPU_ENDIAN_PURE)
 138 #define FPU_VFP_V1      (FPU_VFP_V1xD | FPU_VFP_EXT_V1)
 139 #define FPU_VFP_V2      (FPU_VFP_V1 | FPU_VFP_EXT_V2)
 140 #define FPU_VFP_V3D16   (FPU_VFP_V2 | FPU_VFP_EXT_V3xD | FPU_VFP_EXT_V3)
 141 #define FPU_VFP_V3      (FPU_VFP_V3D16 | FPU_VFP_EXT_D32)
 142 #define FPU_VFP_V3xD    (FPU_VFP_V1xD | FPU_VFP_EXT_V2 | FPU_VFP_EXT_V3xD)
 143 #define FPU_VFP_V4D16   (FPU_VFP_V3D16 | FPU_VFP_EXT_FP16 | FPU_VFP_EXT_FMA)
 144 #define FPU_VFP_V4      (FPU_VFP_V3 | FPU_VFP_EXT_FP16 | FPU_VFP_EXT_FMA)
 145 #define FPU_VFP_V4_SP_D16 (FPU_VFP_V3xD | FPU_VFP_EXT_FP16 | FPU_VFP_EXT_FMA)
 146 #define FPU_VFP_HARD    (FPU_VFP_EXT_V1xD | FPU_VFP_EXT_V1 | FPU_VFP_EXT_V2 \
 147                          | FPU_VFP_EXT_V3xD | FPU_VFP_EXT_FMA | FPU_NEON_EXT_FMA \
 148                          | FPU_VFP_EXT_V3 | FPU_NEON_EXT_V1 | FPU_VFP_EXT_D32)
 149 #define FPU_FPA         (FPU_FPA_EXT_V1 | FPU_FPA_EXT_V2)
 150
 151 /* Deprecated.  */
 152 #define FPU_ARCH_VFP    ARM_FEATURE (0, FPU_ENDIAN_PURE)
 153
 154 #define FPU_ARCH_FPE    ARM_FEATURE (0, FPU_FPA_EXT_V1)
 155 #define FPU_ARCH_FPA    ARM_FEATURE (0, FPU_FPA)
 156
 157 #define FPU_ARCH_VFP_V1xD ARM_FEATURE (0, FPU_VFP_V1xD)
 158 #define FPU_ARCH_VFP_V1   ARM_FEATURE (0, FPU_VFP_V1)
 159 #define FPU_ARCH_VFP_V2   ARM_FEATURE (0, FPU_VFP_V2)
 160 #define FPU_ARCH_VFP_V3D16      ARM_FEATURE (0, FPU_VFP_V3D16)
 161 #define FPU_ARCH_VFP_V3D16_FP16 \
 162   ARM_FEATURE (0, FPU_VFP_V3D16 | FPU_VFP_EXT_FP16)
 163 #define FPU_ARCH_VFP_V3   ARM_FEATURE (0, FPU_VFP_V3)
 164 #define FPU_ARCH_VFP_V3_FP16    ARM_FEATURE (0, FPU_VFP_V3 | FPU_VFP_EXT_FP16)
 165 #define FPU_ARCH_VFP_V3xD       ARM_FEATURE (0, FPU_VFP_V3xD)
 166 #define FPU_ARCH_VFP_V3xD_FP16  ARM_FEATURE (0, FPU_VFP_V3xD | FPU_VFP_EXT_FP16)
 167 #define FPU_ARCH_NEON_V1  ARM_FEATURE (0, FPU_NEON_EXT_V1)
 168 #define FPU_ARCH_VFP_V3_PLUS_NEON_V1 \
 169   ARM_FEATURE (0, FPU_VFP_V3 | FPU_NEON_EXT_V1)
 170 #define FPU_ARCH_NEON_FP16 \
 171   ARM_FEATURE (0, FPU_VFP_V3 | FPU_NEON_EXT_V1 | FPU_VFP_EXT_FP16)
 172 #define FPU_ARCH_VFP_HARD ARM_FEATURE (0, FPU_VFP_HARD)
 173 #define FPU_ARCH_VFP_V4 ARM_FEATURE(0, FPU_VFP_V4)
 174 #define FPU_ARCH_VFP_V4D16 ARM_FEATURE(0, FPU_VFP_V4D16)
 175 #define FPU_ARCH_VFP_V4_SP_D16 ARM_FEATURE(0, FPU_VFP_V4_SP_D16)
 176 #define FPU_ARCH_NEON_VFP_V4 \
 177   ARM_FEATURE(0, FPU_VFP_V4 | FPU_NEON_EXT_V1 | FPU_NEON_EXT_FMA)
 178
 179 #define FPU_ARCH_ENDIAN_PURE ARM_FEATURE (0, FPU_ENDIAN_PURE)
 180
 181 #define FPU_ARCH_MAVERICK ARM_FEATURE (0, FPU_MAVERICK)
 182
 183 #define ARM_ARCH_V1     ARM_FEATURE (ARM_AEXT_V1, 0)
 184 #define ARM_ARCH_V2     ARM_FEATURE (ARM_AEXT_V2, 0)
 185 #define ARM_ARCH_V2S    ARM_FEATURE (ARM_AEXT_V2S, 0)
 186 #define ARM_ARCH_V3     ARM_FEATURE (ARM_AEXT_V3, 0)
 187 #define ARM_ARCH_V3M    ARM_FEATURE (ARM_AEXT_V3M, 0)
 188 #define ARM_ARCH_V4xM   ARM_FEATURE (ARM_AEXT_V4xM, 0)
 189 #define ARM_ARCH_V4     ARM_FEATURE (ARM_AEXT_V4, 0)
 190 #define ARM_ARCH_V4TxM  ARM_FEATURE (ARM_AEXT_V4TxM, 0)
 191 #define ARM_ARCH_V4T    ARM_FEATURE (ARM_AEXT_V4T, 0)
 192 #define ARM_ARCH_V5xM   ARM_FEATURE (ARM_AEXT_V5xM, 0)
 193 #define ARM_ARCH_V5     ARM_FEATURE (ARM_AEXT_V5, 0)
 194 #define ARM_ARCH_V5TxM  ARM_FEATURE (ARM_AEXT_V5TxM, 0)
 195 #define ARM_ARCH_V5T    ARM_FEATURE (ARM_AEXT_V5T, 0)
 196 #define ARM_ARCH_V5TExP ARM_FEATURE (ARM_AEXT_V5TExP, 0)
 197 #define ARM_ARCH_V5TE   ARM_FEATURE (ARM_AEXT_V5TE, 0)
 198 #define ARM_ARCH_V5TEJ  ARM_FEATURE (ARM_AEXT_V5TEJ, 0)
 199 #define ARM_ARCH_V6     ARM_FEATURE (ARM_AEXT_V6, 0)
 200 #define ARM_ARCH_V6K    ARM_FEATURE (ARM_AEXT_V6K, 0)
 201 #define ARM_ARCH_V6Z    ARM_FEATURE (ARM_AEXT_V6Z, 0)
 202 #define ARM_ARCH_V6ZK   ARM_FEATURE (ARM_AEXT_V6ZK, 0)
 203 #define ARM_ARCH_V6T2   ARM_FEATURE (ARM_AEXT_V6T2, 0)
 204 #define ARM_ARCH_V6KT2  ARM_FEATURE (ARM_AEXT_V6KT2, 0)
 205 #define ARM_ARCH_V6ZT2  ARM_FEATURE (ARM_AEXT_V6ZT2, 0)
 206 #define ARM_ARCH_V6ZKT2 ARM_FEATURE (ARM_AEXT_V6ZKT2, 0)
 207 #define ARM_ARCH_V6M    ARM_FEATURE (ARM_AEXT_V6M, 0)
 208 #define ARM_ARCH_V6SM   ARM_FEATURE (ARM_AEXT_V6SM, 0)
 209 #define ARM_ARCH_V7     ARM_FEATURE (ARM_AEXT_V7, 0)
 210 #define ARM_ARCH_V7A    ARM_FEATURE (ARM_AEXT_V7A, 0)
 211 #define ARM_ARCH_V7R    ARM_FEATURE (ARM_AEXT_V7R, 0)
 212 #define ARM_ARCH_V7M    ARM_FEATURE (ARM_AEXT_V7M, 0)
 213 #define ARM_ARCH_V7EM   ARM_FEATURE (ARM_AEXT_V7EM, 0)
 214
 215 /* Some useful combinations:  */
 216 #define ARM_ARCH_NONE   ARM_FEATURE (0, 0)
 217 #define FPU_NONE        ARM_FEATURE (0, 0)
 218 #define ARM_ANY         ARM_FEATURE (-1, 0)     /* Any basic core.  */
 219 #define FPU_ANY_HARD    ARM_FEATURE (0, FPU_FPA | FPU_VFP_HARD | FPU_MAVERICK)
 220 #define ARM_ARCH_THUMB2 ARM_FEATURE (ARM_EXT_V6T2 | ARM_EXT_V7 | ARM_EXT_V7A | ARM_EXT_V7R | ARM_EXT_V7M | ARM_EXT_DIV, 0)
 221 /* v7-a+sec.  */
 222 #define ARM_ARCH_V7A_SEC ARM_FEATURE (ARM_AEXT_V7A | ARM_EXT_SEC, 0)
 223 /* v7-a+mp+sec.  */
 224 #define ARM_ARCH_V7A_MP_SEC \
 225                         ARM_FEATURE (ARM_AEXT_V7A | ARM_EXT_MP | ARM_EXT_SEC, \
 226                                      0)
 227 /* v7-a+idiv+mp+sec+virt.  */
 228 #define ARM_ARCH_V7A_IDIV_MP_SEC_VIRT \
 229                         ARM_FEATURE (ARM_AEXT_V7A | ARM_EXT_MP | ARM_EXT_SEC \
 230                                      | ARM_EXT_DIV | ARM_EXT_ADIV \
 231                                      | ARM_EXT_VIRT, 0)
 232 /* Features that are present in v6M and v6S-M but not other v6 cores.  */
 233 #define ARM_ARCH_V6M_ONLY ARM_FEATURE (ARM_AEXT_V6M_ONLY, 0)
 234
 235 /* There are too many feature bits to fit in a single word, so use a
 236    structure.  For simplicity we put all core features in one word and
 237    everything else in the other.  */
 238 typedef struct
 239 {
 240   unsigned long core;
 241   unsigned long coproc;
 242 } arm_feature_set;
 243
 244 #define ARM_CPU_HAS_FEATURE(CPU,FEAT) \
 245   (((CPU).core & (FEAT).core) != 0 || ((CPU).coproc & (FEAT).coproc) != 0)
 246
 247 #define ARM_MERGE_FEATURE_SETS(TARG,F1,F2)      \
 248   do {                                          \
 249     (TARG).core = (F1).core | (F2).core;        \
 250     (TARG).coproc = (F1).coproc | (F2).coproc;  \
 251   } while (0)
 252
 253 #define ARM_CLEAR_FEATURE(TARG,F1,F2)           \
 254   do {                                          \
 255     (TARG).core = (F1).core &~ (F2).core;       \
 256     (TARG).coproc = (F1).coproc &~ (F2).coproc; \
 257   } while (0)
 258
 259 #define ARM_FEATURE(core, coproc) {(core), (coproc)}