xref: /netbsd/sys/arch/sparc/include/instr.h (revision bf9ec67e)
1 /*	$NetBSD: instr.h,v 1.5 2000/08/16 11:33:27 pk Exp $ */
2 
3 /*
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This software was developed by the Computer Systems Engineering group
8  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
9  * contributed to Berkeley.
10  *
11  * All advertising materials mentioning features or use of this software
12  * must display the following acknowledgement:
13  *	This product includes software developed by the University of
14  *	California, Lawrence Berkeley Laboratory.
15  *
16  * Redistribution and use in source and binary forms, with or without
17  * modification, are permitted provided that the following conditions
18  * are met:
19  * 1. Redistributions of source code must retain the above copyright
20  *    notice, this list of conditions and the following disclaimer.
21  * 2. Redistributions in binary form must reproduce the above copyright
22  *    notice, this list of conditions and the following disclaimer in the
23  *    documentation and/or other materials provided with the distribution.
24  * 3. All advertising materials mentioning features or use of this software
25  *    must display the following acknowledgement:
26  *	This product includes software developed by the University of
27  *	California, Berkeley and its contributors.
28  * 4. Neither the name of the University nor the names of its contributors
29  *    may be used to endorse or promote products derived from this software
30  *    without specific prior written permission.
31  *
32  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
33  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
34  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
35  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
36  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
41  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
42  * SUCH DAMAGE.
43  *
44  *	@(#)instr.h	8.1 (Berkeley) 6/11/93
45  */
46 
47 /* see also Appendix F of the SPARC version 8 document */
48 enum IOP { IOP_OP2, IOP_CALL, IOP_reg, IOP_mem };
49 enum IOP2 { IOP2_UNIMP, IOP2_BPcc, IOP2_Bicc, IOP2_BPr,
50 	IOP2_SETHI, IOP2_FBPfcc, IOP2_FBfcc, IOP2_CBccc };
51 enum IOP3_reg {
52 	IOP3_ADD, IOP3_AND, IOP3_OR, IOP3_XOR,
53 	IOP3_SUB, IOP3_ANDN, IOP3_ORN, IOP3_XNOR,
54 	IOP3_ADDX, IOP3_rerr09, IOP3_UMUL, IOP3_SMUL,
55 	IOP3_SUBX, IOP3_rerr0d, IOP3_UDIV, IOP3_SDIV,
56 	IOP3_ADDcc, IOP3_ANDcc, IOP3_ORcc, IOP3_XORcc,
57 	IOP3_SUBcc, IOP3_ANDNcc, IOP3_ORNcc, IOP3_XNORcc,
58 	IOP3_ADDXcc, IOP3_rerr19, IOP3_UMULcc, IOP3_SMULcc,
59 	IOP3_SUBXcc, IOP3_rerr1d, IOP3_UDIVcc, IOP3_SDIVcc,
60 	IOP3_TADDcc, IOP3_TSUBcc, IOP3_TADDccTV, IOP3_TSUBccTV,
61 	IOP3_MULScc, IOP3_SLL, IOP3_SRL, IOP3_SRA,
62 	IOP3_RDASR_RDY_STBAR, IOP3_RDPSR, IOP3_RDWIM, IOP3_RDTGBR,
63 	IOP3_rerr2c, IOP3_rerr2d, IOP3_rerr2e, IOP3_rerr2f,
64 	IOP3_WRASR_WRY, IOP3_WRPSR, IOP3_WRWIM, IOP3_WRTBR,
65 	IOP3_FPop1, IOP3_FPop2, IOP3_CPop1, IOP3_CPop2,
66 	IOP3_JMPL, IOP3_RETT, IOP3_Ticc, IOP3_FLUSH,
67 	IOP3_SAVE, IOP3_RESTORE, IOP3_rerr3e, IOP3_rerr3f
68 };
69 enum IOP3_mem {
70 	IOP3_LD, IOP3_LDUB, IOP3_LDUH, IOP3_LDD,
71 	IOP3_ST, IOP3_STB, IOP3_STH, IOP3_STD,
72 	IOP3_merr08, IOP3_LDSB, IOP3_LDSH, IOP3_merr0b,
73 	IOP3_merr0c, IOP3_LDSTUB, IOP3_merr0f, IOP3_SWAP,
74 	IOP3_LDA, IOP3_LDUBA, IOP3_LDUHA, IOP3_LDDA,
75 	IOP3_STA, IOP3_STBA, IOP3_STHA, IOP3_STDA,
76 	IOP3_merr18, IOP3_LDSBA, IOP3_LDSHA, IOP3_merr1b,
77 	IOP3_merr1c, IOP3_LDSTUBA, IOP3_merr1f, IOP3_SWAPA,
78 	IOP3_LDF, IOP3_LDFSR, IOP3_merr22, IOP3_LDDF,
79 	IOP3_STF, IOP3_STFSR, IOP3_STDFQ, IOP3_STDF,
80 	IOP3_merr28, IOP3_merr29, IOP3_merr2a, IOP3_merr2b,
81 	IOP3_merr2c, IOP3_merr2d, IOP3_merr2e, IOP3_merr2f,
82 	IOP3_LFC, IOP3_LDCSR, IOP3_merr32, IOP3_LDDC,
83 	IOP3_STC, IOP3_STCSR, IOP3_STDCQ, IOP3_STDC,
84 	IOP3_merr38, IOP3_merr39, IOP3_merr3a, IOP3_merr3b,
85 	IOP3_merr3c, IOP3_merr3d, IOP3_merr3e, IOP3_merr3f
86 };
87 
88 /*
89  * Integer condition codes.
90  */
91 #define	Icc_N	0x0		/* never */
92 #define	Icc_E	0x1		/* equal (equiv. zero) */
93 #define	Icc_LE	0x2		/* less or equal */
94 #define	Icc_L	0x3		/* less */
95 #define	Icc_LEU	0x4		/* less or equal unsigned */
96 #define	Icc_CS	0x5		/* carry set (equiv. less unsigned) */
97 #define	Icc_NEG	0x6		/* negative */
98 #define	Icc_VS	0x7		/* overflow set */
99 #define	Icc_A	0x8		/* always */
100 #define	Icc_NE	0x9		/* not equal (equiv. not zero) */
101 #define	Icc_G	0xa		/* greater */
102 #define	Icc_GE	0xb		/* greater or equal */
103 #define	Icc_GU	0xc		/* greater unsigned */
104 #define	Icc_CC	0xd		/* carry clear (equiv. gtr or eq unsigned) */
105 #define	Icc_POS	0xe		/* positive */
106 #define	Icc_VC	0xf		/* overflow clear */
107 
108 /*
109  * Integer registers.
110  */
111 #define	I_G0	0
112 #define	I_G1	1
113 #define	I_G2	2
114 #define	I_G3	3
115 #define	I_G4	4
116 #define	I_G5	5
117 #define	I_G6	6
118 #define	I_G7	7
119 #define	I_O0	8
120 #define	I_O1	9
121 #define	I_O2	10
122 #define	I_O3	11
123 #define	I_O4	12
124 #define	I_O5	13
125 #define	I_O6	14
126 #define	I_O7	15
127 #define	I_L0	16
128 #define	I_L1	17
129 #define	I_L2	18
130 #define	I_L3	19
131 #define	I_L4	20
132 #define	I_L5	21
133 #define	I_L6	22
134 #define	I_L7	23
135 #define	I_I0	24
136 #define	I_I1	25
137 #define	I_I2	26
138 #define	I_I3	27
139 #define	I_I4	28
140 #define	I_I5	29
141 #define	I_I6	30
142 #define	I_I7	31
143 
144 /*
145  * An instruction.
146  */
147 union instr {
148 	int	i_int;			/* as a whole */
149 
150 	/*
151 	 * The first level of decoding is to use the top 2 bits.
152 	 * This gives us one of three `formats', which usually give
153 	 * a second level of decoding.
154 	 */
155 	struct {
156 		u_int	i_op:2;		/* first-level decode */
157 		u_int	:30;
158 	} i_any;
159 
160 	/*
161 	 * Format 1 instructions: CALL (undifferentiated).
162 	 */
163 	struct {
164 		u_int	:2;		/* 01 */
165 		int	i_disp:30;	/* displacement */
166 	} i_call;
167 
168 	/*
169 	 * Format 2 instructions (SETHI, UNIMP, and branches, plus illegal
170 	 * unused codes).
171 	 */
172 	struct {
173 		u_int	:2;		/* 00 */
174 		u_int	:5;
175 		u_int	i_op2:3;	/* second-level decode */
176 		u_int	:22;
177 	} i_op2;
178 
179 	/* UNIMP, SETHI */
180 	struct {
181 		u_int	:2;		/* 00 */
182 		u_int	i_rd:5;		/* destination register */
183 		u_int	i_op2:3;	/* opcode: UNIMP or SETHI */
184 		u_int	i_imm:22;	/* immediate value */
185 	} i_imm22;
186 
187 	/* branches: Bicc, FBfcc, CBccc */
188 	struct {
189 		u_int	:2;		/* 00 */
190 		u_int	i_annul:1;	/* annul bit */
191 		u_int	i_cond:4;	/* condition codes */
192 		u_int	i_op2:3;	/* opcode: {Bi,FBf,CBc}cc */
193 		int	i_disp:22;	/* branch displacement */
194 	} i_branch;
195 
196 	/* more branches: BPcc, FBPfcc */
197 	struct {
198 		u_int	:2;		/* 00 */
199 		u_int	i_annul:1;	/* annul bit */
200 		u_int	i_cond:4;	/* condition codes */
201 		u_int	i_op2:3;	/* opcode: {BP,FBPf}cc */
202 		u_int	i_cc:2;		/* condition code selector */
203 		u_int	i_pred:1;	/* branch prediction bit */
204 		int	i_disp:19;	/* branch displacement */
205 	} i_branch_p;
206 
207 	/* one last branch: BPr */
208 	struct {
209 		u_int	:2;		/* 00 */
210 		u_int	i_annul:1;	/* annul bit */
211 		u_int	:1;		/* 0 */
212 		u_int	i_rcond:4;	/* register condition */
213 		u_int	:3;		/* 011 */
214 		int	i_disphi:2;	/* branch displacement, hi bits */
215 		u_int   i_pred:1;	/* branch prediction bit */
216 		u_int   i_rs1:1;	/* source register 1 */
217 		u_int	i_displo:16;	/* branch displacement, lo bits */
218 	} i_branch_pr;
219 
220 
221 	/*
222 	 * Format 3 instructions (memory reference; arithmetic, logical,
223 	 * shift, and other miscellaneous operations).  The second-level
224 	 * decode almost always makes use of an `rd' and `rs1', however
225 	 * (see also IOP3_reg and IOP3_mem).
226 	 *
227 	 * Beyond that, the low 14 bits may be broken up in one of three
228 	 * different ways, if at all:
229 	 *	1 bit of imm=0 + 8 bits of asi + 5 bits of rs2 [reg & mem]
230 	 *	1 bit of imm=1 + 13 bits of signed immediate [reg & mem]
231 	 *	9 bits of copressor `opf' opcode + 5 bits of rs2 [reg only]
232 	 */
233 	struct {
234 		u_int	:2;		/* 10 or 11 */
235 		u_int	i_rd:5;		/* destination register */
236 		u_int	i_op3:6;	/* second-level decode */
237 		u_int	i_rs1:5;	/* source register 1 */
238 		u_int	i_low14:14;	/* varies */
239 	} i_op3;
240 
241 	/*
242 	 * Memory forms.  These set i_op=3 and use simm13 or asi layout.
243 	 * Memory references without an ASI should use 0, but the actual
244 	 * ASI field is simply ignored.
245 	 */
246 	struct {
247 		u_int	:2;		/* 11 only */
248 		u_int	i_rd:5;		/* destination register */
249 		u_int	i_op3:6;	/* second-level decode (see IOP3_mem) */
250 		u_int	i_i:1;		/* immediate vs asi */
251 		u_int	i_low13:13;	/* depend on i bit */
252 	} i_loadstore;
253 
254 	/*
255 	 * Memory and register forms.
256 	 * These come in quite a variety and we do not
257 	 * attempt to break them down much.
258 	 */
259 	struct {
260 		u_int	:2;		/* 10 or 11 */
261 		u_int	i_rd:5;		/* destination register */
262 		u_int	i_op3:6;	/* second-level decode */
263 		u_int	i_rs1:5;	/* source register 1 */
264 		u_int	i_i:1;		/* immediate bit (1) */
265 		int	i_simm13:13;	/* signed immediate */
266 	} i_simm13;
267 	struct {
268 		u_int	:2;		/* 10 or 11 */
269 		u_int	i_rd:5;		/* destination register */
270 		u_int	i_op3:6;	/* second-level decode */
271 		u_int	i_rs1:5;	/* source register 1 */
272 		u_int	i_i:1;		/* immediate vs asi */
273 		u_int	i_asi:8;	/* asi */
274 		u_int	i_rs2:5;	/* source register 2 */
275 	} i_asi;
276 	struct {
277 		u_int	:2;		/* 10 only (register, no memory) */
278 		u_int	i_rd:5;		/* destination register */
279 		u_int	i_op3:6;	/* second-level decode (see IOP3_reg) */
280 		u_int	i_rs1:5;	/* source register 1 */
281 		u_int	i_opf:9;	/* coprocessor 3rd-level decode */
282 		u_int	i_rs2:5;	/* source register 2 */
283 	} i_opf;
284 
285 	/*
286 	 * Format 4 instructions (movcc, fmovr, fmovcc, and tcc).  The
287 	 * second-level decode almost always makes use of an `rd' and either
288 	 * `rs1' or `cond'.
289 	 *
290 	 * Beyond that, the low 14 bits may be broken up in one of three
291 	 * different ways, if at all:
292 	 *	1 bit of imm=0 + 8 bits of asi + 5 bits of rs2 [reg & mem]
293 	 *	1 bit of imm=1 + 13 bits of signed immediate [reg & mem]
294 	 * 9 bits of copressor `opf' opcode + 5 bits of rs2 [reg only] */
295 	struct {
296 		u_int	:2;		/* 10 */
297 		u_int	i_rd:5;		/* destination register */
298 		u_int	i_op3:6;	/* second-level decode */
299 		u_int	i_rs1:5;	/* source register 1 */
300 		u_int	i_low14:14;	/* varies */
301 	} i_op4;
302 
303 	/*
304 	 * Move fp register on condition codes.
305 	 */
306 	struct {
307 		u_int	:2;		/* 10 */
308 		u_int	i_rd:5;		/* destination register */
309 		u_int	i_op3:6;	/* second-level decode */
310 		u_int	:1;
311 		u_int	i_cond:4;	/* condition */
312 		u_int	i_opf_cc:3;	/* condition code register */
313 		u_int	i_opf_low:6;	/* third level decode */
314 		u_int	i_rs2:5;	/* source register */
315 	} i_fmovcc;
316 
317 	/*
318 	 * Move fp register on integer register.
319 	 */
320 	struct {
321 		u_int	:2;		/* 10 */
322 		u_int	i_rd:5;		/* destination register */
323 		u_int	i_op3:6;	/* second-level decode */
324 		u_int	i_rs1:5;	/* source register 1 */
325 		u_int	:1;
326 		u_int	i_rcond:3;	/* register condition */
327 		u_int	i_opf_low:6;
328 		u_int	i_rs2:5;	/* source register 2 */
329 	} i_fmovr;
330 
331 };
332 
333 /*
334  * Internal macros for building instructions.  These correspond 1-to-1 to
335  * the names above.  Note that x << y | z == (x << y) | z.
336  */
337 #define	_I_ANY(op, b)	((op) << 30 | (b))
338 
339 #define	_I_OP2(high, op2, low) \
340 		_I_ANY(IOP_OP2, (high) << 25 | (op2) << 22 | (low))
341 #define	_I_IMM22(rd, op2, imm) \
342 		_I_ANY(IOP_OP2, (rd) << 25 | (op2) << 22 | (imm))
343 #define	_I_BRANCH(a, c, op2, disp) \
344 		_I_ANY(IOP_OP2, (a) << 29 | (c) << 25 | (op2) << 22 | (disp))
345 #define	_I_FBFCC(a, cond, disp) \
346 		_I_BRANCH(a, cond, IOP2_FBfcc, disp)
347 #define	_I_CBCCC(a, cond, disp) \
348 		_I_BRANCH(a, cond, IOP2_CBccc, disp)
349 
350 #define	_I_SIMM(simm)		(1 << 13 | ((simm) & 0x1fff))
351 
352 #define	_I_OP3_GEN(form, rd, op3, rs1, low14) \
353 		_I_ANY(form, (rd) << 25 | (op3) << 19 | (rs1) << 14 | (low14))
354 #define	_I_OP3_LS_RAR(rd, op3, rs1, asi, rs2) \
355 		_I_OP3_GEN(IOP_mem, rd, op3, rs1, (asi) << 5 | (rs2))
356 #define	_I_OP3_LS_RI(rd, op3, rs1, simm13) \
357 		_I_OP3_GEN(IOP_mem, rd, op3, rs1, _I_SIMM(simm13))
358 #define	_I_OP3_LS_RR(rd, op3, rs1, rs2) \
359 		_I_OP3_GEN(IOP_mem, rd, op3, rs1, rs2)
360 #define	_I_OP3_R_RAR(rd, op3, rs1, asi, rs2) \
361 		_I_OP3_GEN(IOP_reg, rd, op3, rs1, (asi) << 5 | (rs2))
362 #define	_I_OP3_R_RI(rd, op3, rs1, simm13) \
363 		_I_OP3_GEN(IOP_reg, rd, op3, rs1, _I_SIMM(simm13))
364 #define	_I_OP3_R_RR(rd, op3, rs1, rs2) \
365 		_I_OP3_GEN(IOP_reg, rd, op3, rs1, rs2)
366 
367 #define	I_CALL(d)		_I_ANY(IOP_CALL, d)
368 #define	I_UNIMP(v)		_I_IMM22(0, IOP2_UNIMP, v)
369 #define	I_BN(a, d)		_I_BRANCH(a, Icc_N, IOP2_Bicc, d)
370 #define	I_BE(a, d)		_I_BRANCH(a, Icc_E, IOP2_Bicc, d)
371 #define	I_BZ(a, d)		_I_BRANCH(a, Icc_E, IOP2_Bicc, d)
372 #define	I_BLE(a, d)		_I_BRANCH(a, Icc_LE, IOP2_Bicc, d)
373 #define	I_BL(a, d)		_I_BRANCH(a, Icc_L, IOP2_Bicc, d)
374 #define	I_BLEU(a, d)		_I_BRANCH(a, Icc_LEU, IOP2_Bicc, d)
375 #define	I_BCS(a, d)		_I_BRANCH(a, Icc_CS, IOP2_Bicc, d)
376 #define	I_BLU(a, d)		_I_BRANCH(a, Icc_CS, IOP2_Bicc, d)
377 #define	I_BNEG(a, d)		_I_BRANCH(a, Icc_NEG, IOP2_Bicc, d)
378 #define	I_BVS(a, d)		_I_BRANCH(a, Icc_VS, IOP2_Bicc, d)
379 #define	I_BA(a, d)		_I_BRANCH(a, Icc_A, IOP2_Bicc, d)
380 #define	I_B(a, d)		_I_BRANCH(a, Icc_A, IOP2_Bicc, d)
381 #define	I_BNE(a, d)		_I_BRANCH(a, Icc_NE, IOP2_Bicc, d)
382 #define	I_BNZ(a, d)		_I_BRANCH(a, Icc_NE, IOP2_Bicc, d)
383 #define	I_BG(a, d)		_I_BRANCH(a, Icc_G, IOP2_Bicc, d)
384 #define	I_BGE(a, d)		_I_BRANCH(a, Icc_GE, IOP2_Bicc, d)
385 #define	I_BGU(a, d)		_I_BRANCH(a, Icc_GU, IOP2_Bicc, d)
386 #define	I_BCC(a, d)		_I_BRANCH(a, Icc_CC, IOP2_Bicc, d)
387 #define	I_BGEU(a, d)		_I_BRANCH(a, Icc_CC, IOP2_Bicc, d)
388 #define	I_BPOS(a, d)		_I_BRANCH(a, Icc_POS, IOP2_Bicc, d)
389 #define	I_BVC(a, d)		_I_BRANCH(a, Icc_VC, IOP2_Bicc, d)
390 #define	I_SETHI(r, v)		_I_IMM22(r, 4, v)
391 
392 #define	I_ORri(rd, rs1, imm)	_I_OP3_R_RI(rd, IOP3_OR, rs1, imm)
393 #define	I_ORrr(rd, rs1, rs2)	_I_OP3_R_RR(rd, IOP3_OR, rs1, rs2)
394 
395 #define	I_MOVi(rd, imm)		_I_OP3_R_RI(rd, IOP3_OR, I_G0, imm)
396 #define	I_MOVr(rd, rs)		_I_OP3_R_RR(rd, IOP3_OR, I_G0, rs)
397 
398 #define	I_RDPSR(rd)		_I_OP3_R_RR(rd, IOP3_RDPSR, 0, 0)
399 
400 #define	I_JMPLri(rd, rs1, imm)	_I_OP3_R_RI(rd, IOP3_JMPL, rs1, imm)
401 #define	I_JMPLrr(rd, rs1, rs2)	_I_OP3_R_RR(rd, IOP3_JMPL, rs1, rs2)
402 
403 /*
404  * (Since these are sparse, we skip the enumerations for now.)
405  * FPop values.  All appear in both FPop1 and FPop2 spaces, but arithmetic
406  * ops should happen only with FPop1 and comparison only with FPop2.
407  * The type sits in the low two bits; those bits are given as zero here.
408  */
409 #define	FMOV	0x00
410 #define	FNEG	0x04
411 #define	FABS	0x08
412 #define	FSQRT	0x28
413 #define	FADD	0x40
414 #define	FSUB	0x44
415 #define	FMUL	0x48
416 #define	FDIV	0x4c
417 #define	FCMP	0x50
418 #define	FCMPE	0x54
419 #define	FSMULD	0x68
420 #define	FDMULX	0x6c
421 #define FTOX	0x80
422 #define FXTOS	0x84
423 #define FXTOD	0x88
424 #define FXTOQ	0x8c
425 #define	FTOS	0xc4
426 #define	FTOD	0xc8
427 #define	FTOQ	0xcc
428 #define	FTOI	0xd0
429 
430 /* These are in FPop2 space */
431 #define FMVFC0	0x00
432 #define FMVRZ	0x24
433 #define FMVFC1	0x40
434 #define FMVRLEZ	0x44
435 #define FMVRLZ	0x64
436 #define FMVFC2	0x80
437 #define FMVRNZ	0xa4
438 #define FMVFC3	0xc0
439 #define FMVRGZ	0xc4
440 #define FMVRGEZ	0xe4
441 #define FMVIC	0x100
442 #define FMVXC	0x180
443 
444 /*
445  * FPU data types.
446  */
447 #define FTYPE_LNG	-1	/* data = 64-bit signed long integer */
448 #define	FTYPE_INT	0	/* data = 32-bit signed integer */
449 #define	FTYPE_SNG	1	/* data = 32-bit float */
450 #define	FTYPE_DBL	2	/* data = 64-bit double */
451 #define	FTYPE_EXT	3	/* data = 128-bit extended (quad-prec) */
452