Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
/*	$NetBSD: instr.h,v 1.12 2022/08/30 11:05:59 rin Exp $ */

/*
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This software was developed by the Computer Systems Engineering group
 * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
 * contributed to Berkeley.
 *
 * All advertising materials mentioning features or use of this software
 * must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Lawrence Berkeley Laboratory.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)instr.h	8.1 (Berkeley) 6/11/93
 */

#ifndef _POWERPC_INSTR_H_
#define _POWERPC_INSTR_H_

/*
 * An instruction.
 */
union instr {
	int	i_int;			/* as a whole */

 
	/*
	 * Any instruction type.
	 */
	struct {
		u_int	i_opcd:6;	/* first-level decode */
		u_int	:25;
		u_int	i_rc:1;
	} i_any;

	/*
	 * Format A
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_frt:5;
		u_int	i_fra:5;
		u_int	i_frb:5;
		u_int	i_frc:5;
		u_int	i_xo:5;
		u_int	i_rc:1;
	} i_a;

	/*
	 * Format B
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_bo:5;
		u_int	i_bi:5;
		int	i_bd:14;
		u_int	i_aa:1;
		u_int	i_lk:1;
	} i_b;

	/*
	 * Format D
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		int	i_d:16;
	} i_d;

	/*
	 * Format DE
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		int	i_d:12;
		u_int	i_xo:4;
	} i_de;

	/*
	 * Format I
	 */
	struct {
		u_int	i_opcd:6;
		int	i_li:24;
		int	i_aa:1;
		int	i_lk:1;
	} i_i;

	/*
	 * Format M
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		u_int	i_rb:5;
		int	i_mb:5;
		int	i_me:5;
		u_int	i_rc:1;
	} i_m;

	/*
	 * Format MD
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		int	i_sh1_5:5;
		int	i_mb:6;
		u_int	i_xo:3;
		int	i_sh0:1;
		u_int	i_rc:1;
	} i_md;

	/*
	 * Format MDS
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		u_int	i_rb:5;
		int	i_mb:6;
		u_int	i_xo:4;
		u_int	i_rc:1;
	} i_mds;


	/*
	 * Format S
	 */
	struct {
		u_int	i_opcd:6;
		int	:24;
		int	i_i:1;
		int	:1;
	} i_s;

	/*
	 * Format X
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		u_int	i_rb:5;
		u_int	i_xo:10;
		u_int	i_rc:1;
	} i_x;

	/*
	 * Format XFL
	 */
	struct {
		u_int	i_opcd:6;
		int	:1;
		int	i_flm:8;
		int	:1;
		int	i_frb:5;
		u_int	i_xo:10;
		int	:1;
	} i_xfl;

	/*
	 * Format XFX
	 */
	struct {
		u_int	i_opcd:6;
		int	i_dcrn:10;
		u_int	i_xo:10;
		int	:1;
	} i_xfx;

	/*
	 * Format XL
	 */
	struct {
		u_int	i_opcd:6;
		int	i_bt:5;
		int	i_ba:5;
		int	i_bb:5;
		u_int	i_xo:10;
		int	i_lk:1;
	} i_xl;

	/*
	 * Format XS
	 */
	struct {
		u_int	i_opcd:6;
		u_int	i_rs:5;
		u_int	i_ra:5;
		int	i_sh0_4:5;
		u_int	i_xo:9;
		int	i_sh5:1;
		u_int	i_rc:1;
	} i_xs;

};

#define	i_rt	i_rs

/*
 * Primary opcode numbers:
 */

#define	OPC_TDI		0x02
#define	OPC_TWI		0x03
#define	OPC_MULLI	0x07
#define	OPC_SUBFIC	0x08
#define	OPC_BCE		0x09
#define	OPC_CMPLI	0x0a
#define	OPC_CMPI	0x0b
#define	OPC_ADDIC	0x0c
#define	OPC_ADDIC_DOT	0x0d
#define	OPC_ADDI	0x0e
#define	OPC_ADDIS	0x0f
#define	OPC_BC		0x10
#define	OPC_SC		0x11
#define	OPC_B		0x12
#define	OPC_branch_19	0x13
#define	OPC_RLWIMI	0x14
#define	OPC_RLWINM	0x15
#define	OPC_BE		0x16
#define	OPC_RLWNM	0x17
#define	OPC_ORI		0x18
#define	OPC_ORIS	0x19
#define	OPC_XORI	0x1a
#define	OPC_XORIS	0x1b
#define	OPC_ANDI	0x1c
#define	OPC_ANDIS	0x1d
#define	OPC_dwe_rot_30	0x1e
#define	OPC_integer_31	0x1f
#define	OPC_LWZ		0x20
#define	OPC_LWZU	0x21
#define	OPC_LBZ		0x22
#define	OPC_LBZU	0x23
#define	OPC_STW		0x24
#define	OPC_STWU	0x25
#define	OPC_STB		0x26
#define	OPC_STBU	0x27
#define	OPC_LHZ		0x28
#define	OPC_LHZU	0x29
#define	OPC_LHA		0x2a
#define	OPC_LHAU	0x2b
#define	OPC_STH		0x2c
#define	OPC_STHU	0x2d
#define	OPC_LMW		0x2e
#define	OPC_STMW	0x2f
#define	OPC_LFS		0x30
#define	OPC_LFSU	0x31
#define	OPC_LFD		0x32
#define	OPC_LFDU	0x33
#define	OPC_STFS	0x34
#define	OPC_STFSU	0x35
#define	OPC_STFD	0x36
#define	OPC_STFDU	0x37
#define	OPC_load_st_58	0x3a
#define	OPC_sp_fp_59	0x3b
#define	OPC_load_st_62	0x3e
#define	OPC_dp_fp_63	0x3f

/*
 * Opcode 31 sub-types (FP only)
 */
#define	OPC31_TW	0x004
#define	OPC31_LFSX	0x217
#define	OPC31_LFSUX	0x237
#define	OPC31_LFDX	0x257
#define	OPC31_LFDUX	0x277
#define	OPC31_STFSX	0x297
#define	OPC31_STFSUX	0x2b7
#define	OPC31_STFDX	0x2d7
#define	OPC31_STFDUX	0x2f7
#define	OPC31_STFIWX	0x3d7

/* Mask for all valid indexed FP load/store ops (except stfiwx) */
#define	OPC31_FPMASK	0x31f
#define	OPC31_FPOP	0x217

/* m[ft]spr are also opcode 31; ra/rb encode the spr */
#define	OPC31_MFSPR	0x153
#define OPC31_MTSPR	0x1d3

/*
 * Opcode 31 sub-types (integer only)
 */
#define OPC31_OR	0x1bc

/*
 * Opcode 31 sub-types (load/store multiple bytes)
 */
#define	OPC31_LWZX	0x017
#define	OPC31_LWZUX	0x037
#define	OPC31_STWX	0x097
#define	OPC31_STWUX	0x0b7
#define	OPC31_LHZX	0x117
#define	OPC31_LHZUX	0x137
#define	OPC31_LHAX	0x157
#define	OPC31_LHAUX	0x177
#define	OPC31_STHX	0x197
#define	OPC31_STHUX	0x1b7
#define	OPC31_LWBRX	0x216
#define	OPC31_STWBRX	0x296
#define	OPC31_LHBRX	0x316
#define	OPC31_STHBRX	0x396

/*
 * Opcode 59 sub-types:
 */

#define	OPC59_FDIVS	0x12
#define	OPC59_FSUBS	0x14
#define	OPC59_FADDS	0x15
#define	OPC59_FSQRTS	0x16
#define	OPC59_FRES	0x18
#define	OPC59_FMULS	0x19
#define	OPC59_FMSUBS	0x1c
#define	OPC59_FMADDS	0x1d
#define	OPC59_FNMSUBS	0x1e
#define	OPC59_FNMADDS	0x1f

/*
 * Opcode 62 sub-types:
 */
#define	OPC62_LDE	0x0
#define	OPC62_LDEU	0x1
#define	OPC62_LFSE	0x4
#define	OPC62_LFSEU	0x5
#define	OPC62_LFDE	0x6
#define	OPC62_LFDEU	0x7
#define	OPC62_STDE	0x8
#define	OPC62_STDEU	0x9
#define	OPC62_STFSE	0xc
#define	OPC62_STFSEU	0xd
#define	OPC62_STFDE	0xe
#define	OPC62_STFDEU	0xf

/*
 * Opcode 63 sub-types:
 *
 * (The first group are masks....)
 */

#define	OPC63M_MASK	0x10
#define	OPC63M_FDIV	0x12
#define	OPC63M_FSUB	0x14
#define	OPC63M_FADD	0x15
#define	OPC63M_FSQRT	0x16
#define	OPC63M_FSEL	0x17
#define	OPC63M_FMUL	0x19
#define	OPC63M_FRSQRTE	0x1a
#define	OPC63M_FMSUB	0x1c
#define	OPC63M_FMADD	0x1d
#define	OPC63M_FNMSUB	0x1e
#define	OPC63M_FNMADD	0x1f

#define	OPC63_FCMPU	0x00
#define	OPC63_FRSP	0x0c
#define	OPC63_FCTIW	0x0e
#define	OPC63_FCTIWZ	0x0f
#define	OPC63_FCMPO	0x20
#define	OPC63_MTFSB1	0x26
#define	OPC63_FNEG	0x28
#define	OPC63_MCRFS	0x40
#define	OPC63_MTFSB0	0x46
#define	OPC63_FMR	0x48
#define	OPC63_MTFSFI	0x86
#define	OPC63_FNABS	0x88
#define	OPC63_FABS	0x108
#define	OPC63_MFFS	0x247
#define	OPC63_MTFSF	0x2c7
#define	OPC63_FCTID	0x32e
#define	OPC63_FCTIDZ	0x32f
#define	OPC63_FCFID	0x34e

/*
 * Branch instruction modifiers.
 */
#define	B_LK		0x01	/* Link flag (LR=CIA+4) */
#define	B_AA		0x02	/* Absolute flag */

/*
 * Helpers for decoding mfspr
 */
#define	OPC_MFSPR_CODE		0x7c0002a6
#define	OPC_MFSPR_MASK		(~(0x1f << 21))
#define	OPC_MFSPR(spr)		(OPC_MFSPR_CODE |\
				 (((spr) & 0x1f) << 16) |\
				 (((spr) & 0x3e0) << 6))
#define	OPC_MFSPR_REG(o)	(((o) >> 21) & 0x1f)
#define	OPC_MFSPR_P(o, spr)	(((o) & OPC_MFSPR_MASK) == OPC_MFSPR(spr))

/*
 * booke doesn't have lwsync even though gcc emits it so we have to emulate it.
 */
#define	OPC_LWSYNC		0x7c2004ac

/*
 * FPCSR rounding modes.
 */
#define	  FSR_RD_RN	0		/* round to nearest */
#define	  FSR_RD_RZ	1		/* round towards 0 */
#define	  FSR_RD_RP	2		/* round towards +inf */
#define	  FSR_RD_RM	3		/* round towards -inf */

/*
 * Convert an address to an offset used in a PowerPC branch instruction.
 * We simply shift away the low bits since we are going convert the bl
 * to a bla.
 */
#define	fixup_addr2offset(x)	((uintptr_t)(x) >> 2)
struct powerpc_jump_fixup_info {
	uint32_t jfi_stub;
	uint32_t jfi_real;
};
 
void	powerpc_fixup_stubs(uint32_t *, uint32_t *, uint32_t *, uint32_t *);


#endif /* !_POWERPC_INSTR_H_ */