sparc: add missing comment about hyperprivileged register operands
[deliverable/binutils-gdb.git] / include / opcode / sparc.h
CommitLineData
252b5132 1/* Definitions for opcode table for the sparc.
6f2750fe 2 Copyright (C) 1989-2016 Free Software Foundation, Inc.
252b5132 3
47b0e7ad
NC
4 This file is part of GAS, the GNU Assembler, GDB, the GNU debugger, and
5 the GNU Binutils.
252b5132 6
47b0e7ad
NC
7 GAS/GDB is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
e4e42b45 9 the Free Software Foundation; either version 3, or (at your option)
47b0e7ad 10 any later version.
252b5132 11
47b0e7ad
NC
12 GAS/GDB 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.
252b5132 16
47b0e7ad 17 You should have received a copy of the GNU General Public License
e4e42b45 18 along with GAS or GDB; see the file COPYING3. If not, write to
47b0e7ad
NC
19 the Free Software Foundation, 51 Franklin Street - Fifth Floor,
20 Boston, MA 02110-1301, USA. */
252b5132 21
b3f7d5fd 22#include "ansidecl.h"
252b5132 23
1fe0971e
TS
24#ifdef __cplusplus
25extern "C" {
26#endif
27
252b5132
RH
28/* The SPARC opcode table (and other related data) is defined in
29 the opcodes library in sparc-opc.c. If you change anything here, make
30 sure you fix up that file, and vice versa. */
31
32 /* FIXME-someday: perhaps the ,a's and such should be embedded in the
33 instruction's name rather than the args. This would make gas faster, pinsn
34 slower, but would mess up some macros a bit. xoxorich. */
35
36/* List of instruction sets variations.
37 These values are such that each element is either a superset of a
38 preceding each one or they conflict in which case SPARC_OPCODE_CONFLICT_P
39 returns non-zero.
40 The values are indices into `sparc_opcode_archs' defined in sparc-opc.c.
41 Don't change this without updating sparc-opc.c. */
42
47b0e7ad
NC
43enum sparc_opcode_arch_val
44{
252b5132
RH
45 SPARC_OPCODE_ARCH_V6 = 0,
46 SPARC_OPCODE_ARCH_V7,
47 SPARC_OPCODE_ARCH_V8,
d6787ef9 48 SPARC_OPCODE_ARCH_LEON,
252b5132
RH
49 SPARC_OPCODE_ARCH_SPARCLET,
50 SPARC_OPCODE_ARCH_SPARCLITE,
47b0e7ad 51 /* V9 variants must appear last. */
252b5132 52 SPARC_OPCODE_ARCH_V9,
47b0e7ad
NC
53 SPARC_OPCODE_ARCH_V9A, /* V9 with ultrasparc additions. */
54 SPARC_OPCODE_ARCH_V9B, /* V9 with ultrasparc and cheetah additions. */
55 SPARC_OPCODE_ARCH_BAD /* Error return from sparc_opcode_lookup_arch. */
252b5132
RH
56};
57
58/* The highest architecture in the table. */
59#define SPARC_OPCODE_ARCH_MAX (SPARC_OPCODE_ARCH_BAD - 1)
60
61/* Given an enum sparc_opcode_arch_val, return the bitmask to use in
62 insn encoding/decoding. */
63#define SPARC_OPCODE_ARCH_MASK(arch) (1 << (arch))
64
65/* Given a valid sparc_opcode_arch_val, return non-zero if it's v9. */
66#define SPARC_OPCODE_ARCH_V9_P(arch) ((arch) >= SPARC_OPCODE_ARCH_V9)
67
68/* Table of cpu variants. */
69
47b0e7ad
NC
70typedef struct sparc_opcode_arch
71{
252b5132
RH
72 const char *name;
73 /* Mask of sparc_opcode_arch_val's supported.
74 EG: For v7 this would be
75 (SPARC_OPCODE_ARCH_MASK (..._V6) | SPARC_OPCODE_ARCH_MASK (..._V7)).
76 These are short's because sparc_opcode.architecture is. */
77 short supported;
47b0e7ad 78} sparc_opcode_arch;
252b5132
RH
79
80extern const struct sparc_opcode_arch sparc_opcode_archs[];
81
82/* Given architecture name, look up it's sparc_opcode_arch_val value. */
8cf3f354 83extern enum sparc_opcode_arch_val sparc_opcode_lookup_arch (const char *);
252b5132
RH
84
85/* Return the bitmask of supported architectures for ARCH. */
86#define SPARC_OPCODE_SUPPORTED(ARCH) (sparc_opcode_archs[ARCH].supported)
87
88/* Non-zero if ARCH1 conflicts with ARCH2.
89 IE: ARCH1 as a supported bit set that ARCH2 doesn't, and vice versa. */
90#define SPARC_OPCODE_CONFLICT_P(ARCH1, ARCH2) \
47b0e7ad
NC
91 (((SPARC_OPCODE_SUPPORTED (ARCH1) & SPARC_OPCODE_SUPPORTED (ARCH2)) \
92 != SPARC_OPCODE_SUPPORTED (ARCH1)) \
93 && ((SPARC_OPCODE_SUPPORTED (ARCH1) & SPARC_OPCODE_SUPPORTED (ARCH2)) \
252b5132
RH
94 != SPARC_OPCODE_SUPPORTED (ARCH2)))
95
96/* Structure of an opcode table entry. */
97
47b0e7ad
NC
98typedef struct sparc_opcode
99{
252b5132 100 const char *name;
47b0e7ad
NC
101 unsigned long match; /* Bits that must be set. */
102 unsigned long lose; /* Bits that must not be set. */
252b5132 103 const char *args;
47b0e7ad 104 /* This was called "delayed" in versions before the flags. */
9e8c70f9 105 unsigned int flags;
ec668d69 106 unsigned int hwcaps;
3d68f91c 107 unsigned int hwcaps2;
252b5132 108 short architecture; /* Bitmask of sparc_opcode_arch_val's. */
47b0e7ad
NC
109} sparc_opcode;
110
252b5132 111/* FIXME: Add F_ANACHRONISTIC flag for v9. */
9e8c70f9
DM
112#define F_DELAYED 0x00000001 /* Delayed branch. */
113#define F_ALIAS 0x00000002 /* Alias for a "real" instruction. */
114#define F_UNBR 0x00000004 /* Unconditional branch. */
115#define F_CONDBR 0x00000008 /* Conditional branch. */
116#define F_JSR 0x00000010 /* Subroutine call. */
117#define F_FLOAT 0x00000020 /* Floating point instruction (not a branch). */
118#define F_FBR 0x00000040 /* Floating point branch. */
0afd1215
DM
119#define F_PREFERRED 0x00000080 /* A preferred alias. */
120
121#define F_PREF_ALIAS (F_ALIAS|F_PREFERRED)
ec668d69 122
3d68f91c
JM
123/* These must match the ELF_SPARC_HWCAP_* and ELF_SPARC_HWCAP2_*
124 values precisely. See include/elf/sparc.h. */
ec668d69
DM
125#define HWCAP_MUL32 0x00000001 /* umul/umulcc/smul/smulcc insns */
126#define HWCAP_DIV32 0x00000002 /* udiv/udivcc/sdiv/sdivcc insns */
127#define HWCAP_FSMULD 0x00000004 /* 'fsmuld' insn */
128#define HWCAP_V8PLUS 0x00000008 /* v9 insns available to 32bit */
129#define HWCAP_POPC 0x00000010 /* 'popc' insn */
130#define HWCAP_VIS 0x00000020 /* VIS insns */
131#define HWCAP_VIS2 0x00000040 /* VIS2 insns */
132#define HWCAP_ASI_BLK_INIT \
133 0x00000080 /* block init ASIs */
134#define HWCAP_FMAF 0x00000100 /* fused multiply-add */
135#define HWCAP_VIS3 0x00000400 /* VIS3 insns */
136#define HWCAP_HPC 0x00000800 /* HPC insns */
137#define HWCAP_RANDOM 0x00001000 /* 'random' insn */
138#define HWCAP_TRANS 0x00002000 /* transaction insns */
139#define HWCAP_FJFMAU 0x00004000 /* unfused multiply-add */
140#define HWCAP_IMA 0x00008000 /* integer multiply-add */
141#define HWCAP_ASI_CACHE_SPARING \
142 0x00010000 /* cache sparing ASIs */
143#define HWCAP_AES 0x00020000 /* AES crypto insns */
144#define HWCAP_DES 0x00040000 /* DES crypto insns */
145#define HWCAP_KASUMI 0x00080000 /* KASUMI crypto insns */
146#define HWCAP_CAMELLIA 0x00100000 /* CAMELLIA crypto insns */
147#define HWCAP_MD5 0x00200000 /* MD5 hashing insns */
148#define HWCAP_SHA1 0x00400000 /* SHA1 hashing insns */
149#define HWCAP_SHA256 0x00800000 /* SHA256 hashing insns */
150#define HWCAP_SHA512 0x01000000 /* SHA512 hashing insns */
151#define HWCAP_MPMUL 0x02000000 /* Multiple Precision Multiply */
152#define HWCAP_MONT 0x04000000 /* Montgomery Mult/Sqrt */
153#define HWCAP_PAUSE 0x08000000 /* Pause insn */
154#define HWCAP_CBCOND 0x10000000 /* Compare and Branch insns */
155#define HWCAP_CRC32C 0x20000000 /* CRC32C insn */
252b5132 156
3d68f91c 157#define HWCAP2_FJATHPLUS 0x00000001 /* Fujitsu Athena+ */
0b6be415 158#define HWCAP2_VIS3B 0x00000002 /* Subset of VIS3 present on sparc64 X+. */
3d68f91c
JM
159#define HWCAP2_ADP 0x00000004 /* Application Data Protection */
160#define HWCAP2_SPARC5 0x00000008 /* The 29 new fp and sub instructions */
161#define HWCAP2_MWAIT 0x00000010 /* mwait instruction and load/monitor ASIs */
162#define HWCAP2_XMPMUL 0x00000020 /* XOR multiple precision multiply */
163#define HWCAP2_XMONT 0x00000040 /* XOR Montgomery mult/sqr instructions */
164#define HWCAP2_NSEC \
165 0x00000080 /* pause insn with support for nsec timings */
166#define HWCAP2_FJATHHPC 0x00001000 /* Fujitsu HPC instrs */
167#define HWCAP2_FJDES 0x00002000 /* Fujitsu DES instrs */
168#define HWCAP2_FJAES 0x00010000 /* Fujitsu AES instrs */
169
170
47b0e7ad
NC
171/* All sparc opcodes are 32 bits, except for the `set' instruction (really a
172 macro), which is 64 bits. It is handled as a special case.
252b5132 173
47b0e7ad
NC
174 The match component is a mask saying which bits must match a particular
175 opcode in order for an instruction to be an instance of that opcode.
252b5132 176
47b0e7ad
NC
177 The args component is a string containing one character for each operand of the
178 instruction.
252b5132 179
47b0e7ad 180 Kinds of operands:
252b5132
RH
181 # Number used by optimizer. It is ignored.
182 1 rs1 register.
183 2 rs2 register.
184 d rd register.
185 e frs1 floating point register.
186 v frs1 floating point register (double/even).
187 V frs1 floating point register (quad/multiple of 4).
188 f frs2 floating point register.
189 B frs2 floating point register (double/even).
190 R frs2 floating point register (quad/multiple of 4).
ea783ef3
DM
191 4 frs3 floating point register.
192 5 frs3 floating point register (doube/even).
252b5132
RH
193 g frsd floating point register.
194 H frsd floating point register (double/even).
195 J frsd floating point register (quad/multiple of 4).
3d68f91c 196 } frsd floating point register (double/even) that is == frs2
252b5132
RH
197 b crs1 coprocessor register
198 c crs2 coprocessor register
199 D crsd coprocessor register
200 m alternate space register (asr) in rd
201 M alternate space register (asr) in rs1
202 h 22 high bits.
203 X 5 bit unsigned immediate
204 Y 6 bit unsigned immediate
19f7b010 205 3 SIAM mode (3 bits). (v9b)
252b5132
RH
206 K MEMBAR mask (7 bits). (v9)
207 j 10 bit Immediate. (v9)
208 I 11 bit Immediate. (v9)
209 i 13 bit Immediate.
210 n 22 bit immediate.
211 k 2+14 bit PC relative immediate. (v9)
212 G 19 bit PC relative immediate. (v9)
213 l 22 bit PC relative immediate.
214 L 30 bit PC relative immediate.
215 a Annul. The annul bit is set.
216 A Alternate address space. Stored as 8 bits.
217 C Coprocessor state register.
218 F floating point state register.
219 p Processor state register.
220 N Branch predict clear ",pn" (v9)
221 T Branch predict set ",pt" (v9)
222 z %icc. (v9)
223 Z %xcc. (v9)
224 q Floating point queue.
225 r Single register that is both rs1 and rd.
226 O Single register that is both rs2 and rd.
227 Q Coprocessor queue.
228 S Special case.
229 t Trap base register.
230 w Window invalid mask register.
231 y Y register.
232 u sparclet coprocessor registers in rd position
233 U sparclet coprocessor registers in rs1 position
234 E %ccr. (v9)
235 s %fprs. (v9)
236 P %pc. (v9)
237 W %tick. (v9)
3d68f91c 238 { %mcdper. (v9b)
252b5132
RH
239 o %asi. (v9)
240 6 %fcc0. (v9)
241 7 %fcc1. (v9)
242 8 %fcc2. (v9)
243 9 %fcc3. (v9)
244 ! Privileged Register in rd (v9)
245 ? Privileged Register in rs1 (v9)
337c570c
JM
246 % Hyperprivileged Register in rd (v9b)
247 $ Hyperprivileged Register in rs1 (v9b)
252b5132
RH
248 * Prefetch function constant. (v9)
249 x OPF field (v9 impdep).
250 0 32/64 bit immediate for set or setx (v9) insns
251 _ Ancillary state register in rd (v9a)
252 / Ancillary state register in rs1 (v9a)
2615994e 253 ( entire floating point state register (%efsr)
6cda1326 254 ) 5 bit immediate placed in RS3 field
2615994e 255 = 2+8 bit PC relative immediate. (v9) */
47b0e7ad
NC
256
257#define OP2(x) (((x) & 0x7) << 22) /* Op2 field of format2 insns. */
258#define OP3(x) (((x) & 0x3f) << 19) /* Op3 field of format3 insns. */
259#define OP(x) ((unsigned) ((x) & 0x3) << 30) /* Op field of all insns. */
260#define OPF(x) (((x) & 0x1ff) << 5) /* Opf field of float insns. */
261#define OPF_LOW5(x) OPF ((x) & 0x1f) /* V9. */
ea783ef3 262#define OPF_LOW4(x) OPF ((x) & 0xf) /* V9. */
47b0e7ad 263#define F3F(x, y, z) (OP (x) | OP3 (y) | OPF (z)) /* Format3 float insns. */
2c63854f 264#define F3F4(x, y, z) (OP (x) | OP3 (y) | OPF_LOW4 (z))
47b0e7ad
NC
265#define F3I(x) (((x) & 0x1) << 13) /* Immediate field of format 3 insns. */
266#define F2(x, y) (OP (x) | OP2(y)) /* Format 2 insns. */
267#define F3(x, y, z) (OP (x) | OP3(y) | F3I(z)) /* Format3 insns. */
268#define F1(x) (OP (x))
269#define DISP30(x) ((x) & 0x3fffffff)
270#define ASI(x) (((x) & 0xff) << 5) /* Asi field of format3 insns. */
271#define RS2(x) ((x) & 0x1f) /* Rs2 field. */
272#define SIMM13(x) ((x) & 0x1fff) /* Simm13 field. */
273#define RD(x) (((x) & 0x1f) << 25) /* Destination register field. */
274#define RS1(x) (((x) & 0x1f) << 14) /* Rs1 field. */
ea783ef3 275#define RS3(x) (((x) & 0x1f) << 9) /* Rs3 field. */
47b0e7ad
NC
276#define ASI_RS2(x) (SIMM13 (x))
277#define MEMBAR(x) ((x) & 0x7f)
278#define SLCPOP(x) (((x) & 0x7f) << 6) /* Sparclet cpop. */
279
280#define ANNUL (1 << 29)
281#define BPRED (1 << 19) /* V9. */
282#define IMMED F3I (1)
283#define RD_G0 RD (~0)
284#define RS1_G0 RS1 (~0)
285#define RS2_G0 RS2 (~0)
252b5132
RH
286
287extern const struct sparc_opcode sparc_opcodes[];
288extern const int sparc_num_opcodes;
289
8cf3f354
AM
290extern int sparc_encode_asi (const char *);
291extern const char *sparc_decode_asi (int);
292extern int sparc_encode_membar (const char *);
293extern const char *sparc_decode_membar (int);
294extern int sparc_encode_prefetch (const char *);
295extern const char *sparc_decode_prefetch (int);
296extern int sparc_encode_sparclet_cpreg (const char *);
297extern const char *sparc_decode_sparclet_cpreg (int);
252b5132 298
47b0e7ad
NC
299/* Local Variables:
300 fill-column: 131
301 comment-column: 0
302 End: */
252b5132 303
1fe0971e
TS
304#ifdef __cplusplus
305}
306#endif
This page took 0.670492 seconds and 4 git commands to generate.