[people/ms/u-boot.git] / include / ppc_asm.tmpl

/*
 * (C) Copyright 2000-2002
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

/*
 * This file contains all the macros and symbols which define
 * a PowerPC assembly language environment.
 */
#ifndef	__PPC_ASM_TMPL__
#define __PPC_ASM_TMPL__

#include <config.h>

/***************************************************************************
 *
 * These definitions simplify the ugly declarations necessary for GOT
 * definitions.
 *
 * Stolen from prepboot/bootldr.h, (C) 1998 Gabriel Paubert, paubert@iram.es
 *
 * Uses r12 to access the GOT
 */

#define START_GOT			\
	.section	".got2","aw";	\
.LCTOC1 = .+32768

#define END_GOT				\
	.text

#define GET_GOT				\
	bl	1f		;	\
	.text	2		;	\
0:	.long	.LCTOC1-1f	;	\
	.text			;	\
1:	mflr	r12		;	\
	lwz	r0,0b-1b(r12)	;	\
	add	r12,r0,r12	;

#define GOT_ENTRY(NAME)		.L_ ## NAME = . - .LCTOC1 ; .long NAME

#define GOT(NAME)		.L_ ## NAME (r12)


/***************************************************************************
 * Register names
 */
#define	r0	0
#define	r1	1
#define	r2	2
#define	r3	3
#define	r4	4
#define	r5	5
#define	r6	6
#define	r7	7
#define	r8	8
#define	r9	9
#define	r10	10
#define	r11	11
#define	r12	12
#define	r13	13
#define	r14	14
#define	r15	15
#define	r16	16
#define	r17	17
#define	r18	18
#define	r19	19
#define	r20	20
#define	r21	21
#define	r22	22
#define	r23	23
#define	r24	24
#define	r25	25
#define	r26	26
#define	r27	27
#define	r28	28
#define	r29	29
#define	r30	30
#define	r31	31


#if  defined(CONFIG_5xx)
/* Some special purpose registers */
#define DER	149		/* Debug Enable Register		*/
#define COUNTA	150		/* Breakpoint Counter			*/
#define COUNTB	151		/* Breakpoint Counter			*/
#define LCTRL1	156		/* Load/Store Support			*/
#define LCTRL2	157		/* Load/Store Support			*/
#define ICTRL	158		/* I-Bus Support Control Register	*/
#define EID	81
#endif	/* CONFIG_5xx */

#if defined(CONFIG_MPC8260)

#define HID2		1011

#define HID0_IFEM	(1<<7)

#define HID0_ICE_BITPOS	16
#define HID0_DCE_BITPOS	17

#define IM_REGBASE	0x10000
#define IM_SYPCR	(IM_REGBASE+0x0004)
#define IM_SWSR		(IM_REGBASE+0x000e)
#define IM_BR0		(IM_REGBASE+0x0100)
#define IM_OR0		(IM_REGBASE+0x0104)
#define IM_BR1		(IM_REGBASE+0x0108)
#define IM_OR1		(IM_REGBASE+0x010c)
#define IM_BR2		(IM_REGBASE+0x0110)
#define IM_OR2		(IM_REGBASE+0x0114)
#define IM_MPTPR	(IM_REGBASE+0x0184)
#define IM_PSDMR	(IM_REGBASE+0x0190)
#define IM_PSRT		(IM_REGBASE+0x019c)
#define IM_IMMR		(IM_REGBASE+0x01a8)
#define IM_SCCR		(IM_REGBASE+0x0c80)

#elif defined(CONFIG_MPC5xxx)

#define HID0_ICE_BITPOS	16
#define HID0_DCE_BITPOS	17

#endif

#define curptr r2

#define SYNC \
	sync; \
	isync

/*
 * Macros for storing registers into and loading registers from
 * exception frames.
 */
#define SAVE_GPR(n, base)	stw	n,GPR0+4*(n)(base)
#define SAVE_2GPRS(n, base)	SAVE_GPR(n, base); SAVE_GPR(n+1, base)
#define SAVE_4GPRS(n, base)	SAVE_2GPRS(n, base); SAVE_2GPRS(n+2, base)
#define SAVE_8GPRS(n, base)	SAVE_4GPRS(n, base); SAVE_4GPRS(n+4, base)
#define SAVE_10GPRS(n, base)	SAVE_8GPRS(n, base); SAVE_2GPRS(n+8, base)
#define REST_GPR(n, base)	lwz	n,GPR0+4*(n)(base)
#define REST_2GPRS(n, base)	REST_GPR(n, base); REST_GPR(n+1, base)
#define REST_4GPRS(n, base)	REST_2GPRS(n, base); REST_2GPRS(n+2, base)
#define REST_8GPRS(n, base)	REST_4GPRS(n, base); REST_4GPRS(n+4, base)
#define REST_10GPRS(n, base)	REST_8GPRS(n, base); REST_2GPRS(n+8, base)

/*
 * GCC sometimes accesses words at negative offsets from the stack
 * pointer, although the SysV ABI says it shouldn't.  To cope with
 * this, we leave this much untouched space on the stack on exception
 * entry.
 */
#define STACK_UNDERHEAD	64

/*
 * Exception entry code.  This code runs with address translation
 * turned off, i.e. using physical addresses.
 * We assume sprg3 has the physical address of the current
 * task's thread_struct.
 */
#define EXCEPTION_PROLOG(reg1, reg2)	\
	mtspr	SPRG0,r20;	\
	mtspr	SPRG1,r21;	\
	mfcr	r20;		\
	subi	r21,r1,INT_FRAME_SIZE+STACK_UNDERHEAD;	/* alloc exc. frame */\
	stw	r20,_CCR(r21);		/* save registers */ \
	stw	r22,GPR22(r21);	\
	stw	r23,GPR23(r21);	\
	mfspr	r20,SPRG0;	\
	stw	r20,GPR20(r21);	\
	mfspr	r22,SPRG1;	\
	stw	r22,GPR21(r21);	\
	mflr	r20;		\
	stw	r20,_LINK(r21);	\
	mfctr	r22;		\
	stw	r22,_CTR(r21);	\
	mfspr	r20,XER;	\
	stw	r20,_XER(r21);	\
	mfspr	r20, DAR_DEAR;	\
	stw	r20,_DAR(r21);	\
	mfspr	r22,reg1;	\
	mfspr	r23,reg2;	\
	stw	r0,GPR0(r21);	\
	stw	r1,GPR1(r21);	\
	stw	r2,GPR2(r21);	\
	stw	r1,0(r21);	\
	mr	r1,r21;			/* set new kernel sp */	\
	SAVE_4GPRS(3, r21);
/*
 * Note: code which follows this uses cr0.eq (set if from kernel),
 * r21, r22 (SRR0), and r23 (SRR1).
 */

/*
 * Exception vectors.
 *
 * The data words for `hdlr' and `int_return' are initialized with
 * OFFSET values only; they must be relocated first before they can
 * be used!
 */
#define COPY_EE(d, s)		rlwimi d,s,0,16,16
#define NOCOPY(d, s)

#ifdef CONFIG_E500
#define EXC_XFER_TEMPLATE(n, label, hdlr, msr, copyee)	\
	stw	r22,_NIP(r21);				\
	stw	r23,_MSR(r21);				\
	li	r23,n;					\
	stw	r23,TRAP(r21);				\
	li	r20,msr;				\
	copyee(r20,r23);				\
	rlwimi	r20,r23,0,25,25;			\
	mtmsr	r20;					\
	bl	1f;					\
1:	mflr	r23;					\
	addis	r23,r23,(hdlr - 1b)@ha;			\
	addi	r23,r23,(hdlr - 1b)@l;			\
	b	transfer_to_handler

#define STD_EXCEPTION(n, label, hdlr)				\
.align 4;							\
label:								\
	EXCEPTION_PROLOG(SRR0, SRR1);				\
	addi	r3,r1,STACK_FRAME_OVERHEAD;			\
	EXC_XFER_TEMPLATE(n, label, hdlr, MSR_KERNEL, NOCOPY)	\

#define CRIT_EXCEPTION(n, label, hdlr)				\
.align 4;							\
label:								\
	EXCEPTION_PROLOG(CSRR0, CSRR1);				\
	addi	r3,r1,STACK_FRAME_OVERHEAD;			\
	EXC_XFER_TEMPLATE(n, label, hdlr,			\
	MSR_KERNEL & ~(MSR_ME|MSR_DE|MSR_CE), NOCOPY)		\

#define MCK_EXCEPTION(n, label, hdlr)				\
.align 4;							\
label:								\
	EXCEPTION_PROLOG(MCSRR0, MCSRR1);			\
	addi	r3,r1,STACK_FRAME_OVERHEAD;			\
	EXC_XFER_TEMPLATE(n, label, hdlr,			\
	MSR_KERNEL & ~(MSR_ME|MSR_DE|MSR_CE), NOCOPY)		\

#else	/* !E500 */

#define EXC_XFER_TEMPLATE(label, hdlr, msr, copyee)	\
	bl	1f;					\
1:	mflr    r20;					\
	lwz	r20,(.L_ ## label)-1b+8(r20);		\
	mtlr	r20;					\
	li	r20,msr;				\
	copyee(r20,r23);				\
	rlwimi	r20,r23,0,25,25;			\
	blrl;						\
.L_ ## label :						\
	.long	hdlr - _start + _START_OFFSET;		\
	.long	int_return - _start + _START_OFFSET;	\
	.long	transfer_to_handler - _start + _START_OFFSET

#define STD_EXCEPTION(n, label, hdlr)				\
	. = n;							\
label:								\
	EXCEPTION_PROLOG(SRR0, SRR1);				\
	addi	r3,r1,STACK_FRAME_OVERHEAD;			\
	EXC_XFER_TEMPLATE(label, hdlr, MSR_KERNEL, NOCOPY)	\

#define CRIT_EXCEPTION(n, label, hdlr)				\
	. = n;							\
label:								\
	EXCEPTION_PROLOG(CSRR0, CSRR1);				\
	addi	r3,r1,STACK_FRAME_OVERHEAD;			\
	EXC_XFER_TEMPLATE(label, hdlr,				\
	MSR_KERNEL & ~(MSR_ME|MSR_DE|MSR_CE), NOCOPY)		\

#define MCK_EXCEPTION(n, label, hdlr)				\
	. = n;							\
label:								\
	EXCEPTION_PROLOG(MCSRR0, MCSRR1);			\
	addi	r3,r1,STACK_FRAME_OVERHEAD;			\
	EXC_XFER_TEMPLATE(label, hdlr,				\
	MSR_KERNEL & ~(MSR_ME|MSR_DE|MSR_CE), NOCOPY)		\

#endif	/* !E500 */
#endif	/* __PPC_ASM_TMPL__ */
Commit	Line	Data
d62589d5 WD	1	/*
	2	* (C) Copyright 2000-2002
	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	4	*
1a459660	5	* SPDX-License-Identifier: GPL-2.0+
d62589d5 WD	6	*/
	7
	8	/*
	9	* This file contains all the macros and symbols which define
	10	* a PowerPC assembly language environment.
	11	*/
	12	#ifndef __PPC_ASM_TMPL__
	13	#define __PPC_ASM_TMPL__
	14
96d2bb95 SW	15	#include <config.h>
96d2bb95 SW	16
d62589d5 WD	17	/***************************************************************************
	18	*
	19	* These definitions simplify the ugly declarations necessary for GOT
	20	* definitions.
	21	*
	22	* Stolen from prepboot/bootldr.h, (C) 1998 Gabriel Paubert, paubert@iram.es
	23	*
161e4ae4	24	* Uses r12 to access the GOT
d62589d5 WD	25	*/
	26
	27	#define START_GOT \
	28	.section ".got2","aw"; \
	29	.LCTOC1 = .+32768
	30
	31	#define END_GOT \
	32	.text
	33
	34	#define GET_GOT \
	35	bl 1f ; \
	36	.text 2 ; \
	37	0: .long .LCTOC1-1f ; \
	38	.text ; \
0f8aa159 JT	39	1: mflr r12 ; \
	40	lwz r0,0b-1b(r12) ; \
	41	add r12,r0,r12 ;
d62589d5 WD	42
	43	#define GOT_ENTRY(NAME) .L_ ## NAME = . - .LCTOC1 ; .long NAME
	44
0f8aa159	45	#define GOT(NAME) .L_ ## NAME (r12)
d62589d5 WD	46
	47
	48	/***************************************************************************
	49	* Register names
	50	*/
	51	#define r0 0
	52	#define r1 1
	53	#define r2 2
	54	#define r3 3
	55	#define r4 4
	56	#define r5 5
	57	#define r6 6
	58	#define r7 7
	59	#define r8 8
	60	#define r9 9
	61	#define r10 10
	62	#define r11 11
	63	#define r12 12
	64	#define r13 13
	65	#define r14 14
	66	#define r15 15
	67	#define r16 16
	68	#define r17 17
	69	#define r18 18
	70	#define r19 19
	71	#define r20 20
	72	#define r21 21
	73	#define r22 22
	74	#define r23 23
	75	#define r24 24
	76	#define r25 25
	77	#define r26 26
	78	#define r27 27
	79	#define r28 28
	80	#define r29 29
	81	#define r30 30
	82	#define r31 31
	83
	84
0db5bca8 WD	85	#if defined(CONFIG_5xx)
0db5bca8 WD	86	/* Some special purpose registers */
83b4cfa3 WD	87	#define DER 149 /* Debug Enable Register */
	88	#define COUNTA 150 /* Breakpoint Counter */
	89	#define COUNTB 151 /* Breakpoint Counter */
	90	#define LCTRL1 156 /* Load/Store Support */
	91	#define LCTRL2 157 /* Load/Store Support */
0db5bca8 WD	92	#define ICTRL 158 /* I-Bus Support Control Register */
	93	#define EID 81
	94	#endif /* CONFIG_5xx */
	95
5b8e76c3	96	#if defined(CONFIG_MPC8260)
d62589d5 WD	97
	98	#define HID2 1011
	99
	100	#define HID0_IFEM (1<<7)
	101
	102	#define HID0_ICE_BITPOS 16
	103	#define HID0_DCE_BITPOS 17
	104
	105	#define IM_REGBASE 0x10000
	106	#define IM_SYPCR (IM_REGBASE+0x0004)
	107	#define IM_SWSR (IM_REGBASE+0x000e)
	108	#define IM_BR0 (IM_REGBASE+0x0100)
	109	#define IM_OR0 (IM_REGBASE+0x0104)
	110	#define IM_BR1 (IM_REGBASE+0x0108)
	111	#define IM_OR1 (IM_REGBASE+0x010c)
	112	#define IM_BR2 (IM_REGBASE+0x0110)
	113	#define IM_OR2 (IM_REGBASE+0x0114)
	114	#define IM_MPTPR (IM_REGBASE+0x0184)
	115	#define IM_PSDMR (IM_REGBASE+0x0190)
	116	#define IM_PSRT (IM_REGBASE+0x019c)
	117	#define IM_IMMR (IM_REGBASE+0x01a8)
	118	#define IM_SCCR (IM_REGBASE+0x0c80)
	119
d6ed3222	120	#elif defined(CONFIG_MPC5xxx)
945af8d7 WD	121
	122	#define HID0_ICE_BITPOS 16
	123	#define HID0_DCE_BITPOS 17
	124
d62589d5 WD	125	#endif
	126
	127	#define curptr r2
	128
	129	#define SYNC \
	130	sync; \
	131	isync
	132
	133	/*
	134	* Macros for storing registers into and loading registers from
	135	* exception frames.
	136	*/
	137	#define SAVE_GPR(n, base) stw n,GPR0+4*(n)(base)
	138	#define SAVE_2GPRS(n, base) SAVE_GPR(n, base); SAVE_GPR(n+1, base)
	139	#define SAVE_4GPRS(n, base) SAVE_2GPRS(n, base); SAVE_2GPRS(n+2, base)
	140	#define SAVE_8GPRS(n, base) SAVE_4GPRS(n, base); SAVE_4GPRS(n+4, base)
	141	#define SAVE_10GPRS(n, base) SAVE_8GPRS(n, base); SAVE_2GPRS(n+8, base)
	142	#define REST_GPR(n, base) lwz n,GPR0+4*(n)(base)
	143	#define REST_2GPRS(n, base) REST_GPR(n, base); REST_GPR(n+1, base)
	144	#define REST_4GPRS(n, base) REST_2GPRS(n, base); REST_2GPRS(n+2, base)
	145	#define REST_8GPRS(n, base) REST_4GPRS(n, base); REST_4GPRS(n+4, base)
	146	#define REST_10GPRS(n, base) REST_8GPRS(n, base); REST_2GPRS(n+8, base)
	147
	148	/*
	149	* GCC sometimes accesses words at negative offsets from the stack
	150	* pointer, although the SysV ABI says it shouldn't. To cope with
	151	* this, we leave this much untouched space on the stack on exception
	152	* entry.
	153	*/
	154	#define STACK_UNDERHEAD 64
	155
	156	/*
	157	* Exception entry code. This code runs with address translation
	158	* turned off, i.e. using physical addresses.
	159	* We assume sprg3 has the physical address of the current
	160	* task's thread_struct.
	161	*/
efa35cf1	162	#define EXCEPTION_PROLOG(reg1, reg2) \
d62589d5 WD	163	mtspr SPRG0,r20; \
	164	mtspr SPRG1,r21; \
	165	mfcr r20; \
	166	subi r21,r1,INT_FRAME_SIZE+STACK_UNDERHEAD; /* alloc exc. frame */\
	167	stw r20,_CCR(r21); /* save registers */ \
	168	stw r22,GPR22(r21); \
	169	stw r23,GPR23(r21); \
	170	mfspr r20,SPRG0; \
	171	stw r20,GPR20(r21); \
	172	mfspr r22,SPRG1; \
	173	stw r22,GPR21(r21); \
	174	mflr r20; \
	175	stw r20,_LINK(r21); \
	176	mfctr r22; \
	177	stw r22,_CTR(r21); \
	178	mfspr r20,XER; \
	179	stw r20,_XER(r21); \
cc3023b9	180	mfspr r20, DAR_DEAR; \
efa35cf1 GB	181	stw r20,_DAR(r21); \
	182	mfspr r22,reg1; \
	183	mfspr r23,reg2; \
d62589d5 WD	184	stw r0,GPR0(r21); \
	185	stw r1,GPR1(r21); \
	186	stw r2,GPR2(r21); \
	187	stw r1,0(r21); \
	188	mr r1,r21; /* set new kernel sp */ \
	189	SAVE_4GPRS(3, r21);
	190	/*
	191	* Note: code which follows this uses cr0.eq (set if from kernel),
	192	* r21, r22 (SRR0), and r23 (SRR1).
	193	*/
	194
d62589d5 WD	195	/*
	196	* Exception vectors.
	197	*
	198	* The data words for `hdlr' and `int_return' are initialized with
	199	* OFFSET values only; they must be relocated first before they can
	200	* be used!
	201	*/
fc4e1887 JT	202	#define COPY_EE(d, s) rlwimi d,s,0,16,16
fc4e1887 JT	203	#define NOCOPY(d, s)
96d2bb95 SW	204
	205	#ifdef CONFIG_E500
	206	#define EXC_XFER_TEMPLATE(n, label, hdlr, msr, copyee) \
	207	stw r22,_NIP(r21); \
	208	stw r23,_MSR(r21); \
	209	li r23,n; \
	210	stw r23,TRAP(r21); \
	211	li r20,msr; \
	212	copyee(r20,r23); \
	213	rlwimi r20,r23,0,25,25; \
	214	mtmsr r20; \
	215	bl 1f; \
	216	1: mflr r23; \
	217	addis r23,r23,(hdlr - 1b)@ha; \
	218	addi r23,r23,(hdlr - 1b)@l; \
	219	b transfer_to_handler
	220
	221	#define STD_EXCEPTION(n, label, hdlr) \
50689461	222	.align 4; \
96d2bb95 SW	223	label: \
	224	EXCEPTION_PROLOG(SRR0, SRR1); \
	225	addi r3,r1,STACK_FRAME_OVERHEAD; \
	226	EXC_XFER_TEMPLATE(n, label, hdlr, MSR_KERNEL, NOCOPY) \
	227
	228	#define CRIT_EXCEPTION(n, label, hdlr) \
50689461	229	.align 4; \
96d2bb95 SW	230	label: \
	231	EXCEPTION_PROLOG(CSRR0, CSRR1); \
	232	addi r3,r1,STACK_FRAME_OVERHEAD; \
	233	EXC_XFER_TEMPLATE(n, label, hdlr, \
	234	MSR_KERNEL & ~(MSR_ME\|MSR_DE\|MSR_CE), NOCOPY) \
	235
	236	#define MCK_EXCEPTION(n, label, hdlr) \
50689461	237	.align 4; \
96d2bb95 SW	238	label: \
	239	EXCEPTION_PROLOG(MCSRR0, MCSRR1); \
	240	addi r3,r1,STACK_FRAME_OVERHEAD; \
	241	EXC_XFER_TEMPLATE(n, label, hdlr, \
	242	MSR_KERNEL & ~(MSR_ME\|MSR_DE\|MSR_CE), NOCOPY) \
	243
	244	#else /* !E500 */
	245
fc4e1887 JT	246	#define EXC_XFER_TEMPLATE(label, hdlr, msr, copyee) \
	247	bl 1f; \
	248	1: mflr r20; \
	249	lwz r20,(.L_ ## label)-1b+8(r20); \
	250	mtlr r20; \
	251	li r20,msr; \
	252	copyee(r20,r23); \
d62589d5	253	rlwimi r20,r23,0,25,25; \
83b4cfa3	254	blrl; \
d62589d5	255	.L_ ## label : \
efa35cf1	256	.long hdlr - _start + _START_OFFSET; \
fc4e1887 JT	257	.long int_return - _start + _START_OFFSET; \
	258	.long transfer_to_handler - _start + _START_OFFSET
	259
	260	#define STD_EXCEPTION(n, label, hdlr) \
	261	. = n; \
	262	label: \
	263	EXCEPTION_PROLOG(SRR0, SRR1); \
	264	addi r3,r1,STACK_FRAME_OVERHEAD; \
	265	EXC_XFER_TEMPLATE(label, hdlr, MSR_KERNEL, NOCOPY) \
efa35cf1 GB	266
efa35cf1 GB	267	#define CRIT_EXCEPTION(n, label, hdlr) \
83b4cfa3	268	. = n; \
efa35cf1	269	label: \
02032e8f	270	EXCEPTION_PROLOG(CSRR0, CSRR1); \
83b4cfa3	271	addi r3,r1,STACK_FRAME_OVERHEAD; \
fc4e1887 JT	272	EXC_XFER_TEMPLATE(label, hdlr, \
fc4e1887 JT	273	MSR_KERNEL & ~(MSR_ME\|MSR_DE\|MSR_CE), NOCOPY) \
efa35cf1	274
efa35cf1	275	#define MCK_EXCEPTION(n, label, hdlr) \
83b4cfa3	276	. = n; \
efa35cf1	277	label: \
83b4cfa3	278	EXCEPTION_PROLOG(MCSRR0, MCSRR1); \
83b4cfa3	279	addi r3,r1,STACK_FRAME_OVERHEAD; \
fc4e1887 JT	280	EXC_XFER_TEMPLATE(label, hdlr, \
fc4e1887 JT	281	MSR_KERNEL & ~(MSR_ME\|MSR_DE\|MSR_CE), NOCOPY) \
d62589d5	282
96d2bb95	283	#endif /* !E500 */
d62589d5	284	#endif /* __PPC_ASM_TMPL__ */