xref: /freebsd/sys/powerpc/include/asm.h (revision 7cc42f6d)
1 /*-
2  * SPDX-License-Identifier: BSD-4-Clause
3  *
4  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
5  * Copyright (C) 1995, 1996 TooLs GmbH.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by TooLs GmbH.
19  * 4. The name of TooLs GmbH may not be used to endorse or promote products
20  *    derived from this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25  * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  *	$NetBSD: asm.h,v 1.6.18.1 2000/07/25 08:37:14 kleink Exp $
34  * $FreeBSD$
35  */
36 
37 #ifndef _MACHINE_ASM_H_
38 #define	_MACHINE_ASM_H_
39 
40 #include <sys/cdefs.h>
41 
42 #if defined(PIC) && !defined(__powerpc64__)
43 #define	PIC_PROLOGUE	XXX
44 #define	PIC_EPILOGUE	XXX
45 #define	PIC_PLT(x)	x@plt
46 #ifdef	__STDC__
47 #define	PIC_GOT(x)	XXX
48 #else	/* not __STDC__ */
49 #define	PIC_GOT(x)	XXX
50 #endif	/* __STDC__ */
51 #else
52 #define	PIC_PROLOGUE
53 #define	PIC_EPILOGUE
54 #define	PIC_PLT(x)	x
55 #define PIC_GOT(x)	x
56 #endif
57 
58 #define	CNAME(csym)		csym
59 #define	ASMNAME(asmsym)		asmsym
60 #ifdef __powerpc64__
61 #define	HIDENAME(asmsym)	__CONCAT(_,asmsym)
62 #else
63 #define	HIDENAME(asmsym)	__CONCAT(.,asmsym)
64 #endif
65 
66 #if !defined(_CALL_ELF) || _CALL_ELF == 1
67 #ifdef _KERNEL
68 /* ELFv1 kernel uses global dot symbols */
69 #define	DOT_LABEL(name)		__CONCAT(.,name)
70 #define	TYPE_ENTRY(name)	.size	name,24; \
71 				.type	DOT_LABEL(name),@function; \
72 				.globl	DOT_LABEL(name);
73 #define	END_SIZE(name)		.size	DOT_LABEL(name),.-DOT_LABEL(name);
74 #else /* !_KERNEL */
75 /* ELFv1 user code uses local function entry points */
76 #define	DOT_LABEL(name)		__CONCAT(.L.,name)
77 #define	TYPE_ENTRY(name)	.type	name,@function;
78 #define	END_SIZE(name)		.size	name,.-DOT_LABEL(name);
79 #endif /* _KERNEL */
80 #else
81 /* ELFv2 doesn't have any of this complication */
82 #define	DOT_LABEL(name)		name
83 #define	TYPE_ENTRY(name)	.type	name,@function;
84 #define	END_SIZE(name)		.size	name,.-DOT_LABEL(name);
85 #endif
86 
87 #define	_GLOBAL(name) \
88 	.data; \
89 	.p2align 2; \
90 	.globl	name; \
91 	name:
92 
93 #ifdef __powerpc64__
94 #define TOC_NAME_FOR_REF(name)	__CONCAT(.L,name)
95 #define	TOC_REF(name)	TOC_NAME_FOR_REF(name)@toc
96 #define TOC_ENTRY(name) \
97 	.section ".toc","aw"; \
98 	TOC_NAME_FOR_REF(name): \
99         .tc name[TC],name
100 #endif
101 
102 #ifdef __powerpc64__
103 
104 #if !defined(_CALL_ELF) || _CALL_ELF == 1
105 #define	_ENTRY(name) \
106 	.section ".text"; \
107 	.p2align 2; \
108 	.globl	name; \
109 	.section ".opd","aw"; \
110 	.p2align 3; \
111 	name: \
112 	.quad	DOT_LABEL(name),.TOC.@tocbase,0; \
113 	.previous; \
114 	.p2align 4; \
115 	TYPE_ENTRY(name) \
116 DOT_LABEL(name):
117 #define	_NAKED_ENTRY(name)	_ENTRY(name)
118 #else
119 #define	_ENTRY(name) \
120 	.text; \
121 	.p2align 4; \
122 	.globl	name; \
123 	.type	name,@function; \
124 name: \
125 	addis	%r2, %r12, (.TOC.-name)@ha; \
126 	addi	%r2, %r2, (.TOC.-name)@l; \
127 	.localentry name, .-name;
128 
129 /* "Naked" function entry.  No TOC prologue for ELFv2. */
130 #define	_NAKED_ENTRY(name) \
131 	.text; \
132 	.p2align 4; \
133 	.globl	name; \
134 	.type	name,@function; \
135 name: \
136 	.localentry name, .-name;
137 #endif
138 
139 #define	_END(name) \
140 	.long	0; \
141 	.byte	0,0,0,0,0,0,0,0; \
142 	END_SIZE(name)
143 
144 #define	LOAD_ADDR(reg, var) \
145 	lis	reg, var@highest; \
146 	ori	reg, reg, var@higher; \
147 	rldicr	reg, reg, 32, 31; \
148 	oris	reg, reg, var@h; \
149 	ori	reg, reg, var@l;
150 #else /* !__powerpc64__ */
151 #define	_ENTRY(name) \
152 	.text; \
153 	.p2align 4; \
154 	.globl	name; \
155 	.type	name,@function; \
156 	name:
157 #define	_END(name)
158 
159 #define _NAKED_ENTRY(name)	_ENTRY(name)
160 
161 #define	LOAD_ADDR(reg, var) \
162 	lis	reg, var@ha; \
163 	ori	reg, reg, var@l;
164 #endif /* __powerpc64__ */
165 
166 #if defined(PROF) || (defined(_KERNEL) && defined(GPROF))
167 # ifdef __powerpc64__
168 #   define	_PROF_PROLOGUE	mflr 0;					\
169 				std 3,48(1);				\
170 				std 4,56(1);				\
171 				std 5,64(1);				\
172 				std 0,16(1);				\
173 				stdu 1,-112(1);				\
174 				bl _mcount;				\
175 				nop;					\
176 				ld 0,112+16(1);				\
177 				ld 3,112+48(1);				\
178 				ld 4,112+56(1);				\
179 				ld 5,112+64(1);				\
180 				mtlr 0;					\
181 				addi 1,1,112
182 # else
183 #   define	_PROF_PROLOGUE	mflr 0; stw 0,4(1); bl _mcount
184 # endif
185 #else
186 # define	_PROF_PROLOGUE
187 #endif
188 
189 #define	ASENTRY(y)	_ENTRY(ASMNAME(y)); _PROF_PROLOGUE
190 #define	END(y)		_END(CNAME(y))
191 #define	ENTRY(y)	_ENTRY(CNAME(y)); _PROF_PROLOGUE
192 #define	GLOBAL(y)	_GLOBAL(CNAME(y))
193 
194 #define	ASENTRY_NOPROF(y)	_ENTRY(ASMNAME(y))
195 #define	ENTRY_NOPROF(y)		_ENTRY(CNAME(y))
196 
197 /* Load NIA without affecting branch prediction */
198 #define	LOAD_LR_NIA	bcl	20, 31, .+4
199 
200 /*
201  * Magic sequence to return to native endian.
202  * Overwrites r0 and r11.
203  *
204  * The encoding of the instruction "tdi 0, %r0, 0x48" in opposite endian
205  * happens to be "b . + 8". This is useful because we can write a sequence
206  * of instructions that can execute in either endian.
207  *
208  * Use a sequence of handcoded instructions that switches contexts to the
209  * instruction following the sequence, but with the correct PSL_LE bit.
210  *
211  * The same sequence works for both BE and LE because the xori will flip
212  * the bit to the other state, and the code only runs when running in the
213  * wrong endian.
214  *
215  * This sequence is NMI-reentrant.
216  *
217  * Do not change the length of this sequence without looking at the users,
218  * this is used in size-constrained places like the reset vector!
219  */
220 #define	RETURN_TO_NATIVE_ENDIAN						  \
221 	tdi	0, %r0, 0x48;	/* Endian swapped: b . + 8		*/\
222 	b	1f;		/* Will fall through to here if correct */\
223 	.long	0xa600607d;	/* mfmsr %r11				*/\
224 	.long	0x00000038;	/* li %r0, 0				*/\
225 	.long	0x6401617d;	/* mtmsrd %r0, 1 (L=1 EE,RI bits only)	*/\
226 	.long	0x01006b69;	/* xori %r11, %r11, 0x1 (PSL_LE)	*/\
227 	.long	0xa602087c;	/* mflr %r0				*/\
228 	.long	0x05009f42;	/* LOAD_LR_NIA				*/\
229 	.long	0xa6037b7d;	/* 0: mtsrr1 %r11			*/\
230 	.long	0xa602687d;	/* mflr	%r11				*/\
231 	.long	0x18006b39;	/* addi	%r11, %r11, (1f - 0b)		*/\
232 	.long	0xa6037a7d;	/* mtsrr0 %r11				*/\
233 	.long	0xa603087c;	/* mtlr %r0				*/\
234 	.long	0x2400004c;	/* rfid					*/\
235 1:	/* RETURN_TO_NATIVE_ENDIAN */
236 
237 #define	ASMSTR		.asciz
238 
239 #define	RCSID(x)	.text; .asciz x
240 
241 #undef __FBSDID
242 #if !defined(lint) && !defined(STRIP_FBSDID)
243 #define __FBSDID(s)	.ident s
244 #else
245 #define __FBSDID(s)	/* nothing */
246 #endif /* not lint and not STRIP_FBSDID */
247 
248 #define	WEAK_REFERENCE(sym, alias)				\
249 	.weak alias;						\
250 	.equ alias,sym
251 
252 #ifdef __STDC__
253 #define	WARN_REFERENCES(_sym,_msg)				\
254 	.section .gnu.warning. ## _sym ; .ascii _msg ; .text
255 #else
256 #define	WARN_REFERENCES(_sym,_msg)				\
257 	.section .gnu.warning./**/_sym ; .ascii _msg ; .text
258 #endif /* __STDC__ */
259 
260 #endif /* !_MACHINE_ASM_H_ */
261