asm.h revision 290648
1/*	$NetBSD: asm.h,v 1.5 2003/08/07 16:26:53 agc Exp $	*/
2
3/*-
4 * Copyright (c) 1990 The Regents of the University of California.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to Berkeley by
8 * William Jolitz.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 *    notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 *    may be used to endorse or promote products derived from this software
20 *    without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
33 *
34 *	from: @(#)asm.h	5.5 (Berkeley) 5/7/91
35 *
36 * $FreeBSD: head/sys/arm/include/asm.h 290648 2015-11-10 12:02:41Z mmel $
37 */
38
39#ifndef _MACHINE_ASM_H_
40#define _MACHINE_ASM_H_
41#include <sys/cdefs.h>
42#include <machine/acle-compat.h>
43#include <machine/sysreg.h>
44
45#define	_C_LABEL(x)	x
46#define	_ASM_LABEL(x)	x
47
48#ifndef _ALIGN_TEXT
49# define _ALIGN_TEXT .align 2
50#endif
51
52#ifndef _STANDALONE
53#define	STOP_UNWINDING	.cantunwind
54#define	_FNSTART	.fnstart
55#define	_FNEND		.fnend
56#define	_SAVE(...)	.save __VA_ARGS__
57#else
58#define	STOP_UNWINDING
59#define	_FNSTART
60#define	_FNEND
61#define	_SAVE(...)
62#endif
63
64/*
65 * gas/arm uses @ as a single comment character and thus cannot be used here.
66 * It recognises the # instead of an @ symbol in .type directives.
67 */
68#define	_ASM_TYPE_FUNCTION	#function
69#define	_ASM_TYPE_OBJECT	#object
70
71/* XXX Is this still the right prologue for profiling? */
72#ifdef GPROF
73#define	_PROF_PROLOGUE	\
74	mov ip, lr;	\
75	bl __mcount
76#else
77#define	_PROF_PROLOGUE
78#endif
79
80/*
81 * EENTRY()/EEND() mark "extra" entry/exit points from a function.
82 * LEENTRY()/LEEND() are the the same for local symbols.
83 * The unwind info cannot handle the concept of a nested function, or a function
84 * with multiple .fnstart directives, but some of our assembler code is written
85 * with multiple labels to allow entry at several points.  The EENTRY() macro
86 * defines such an extra entry point without a new .fnstart, so that it's
87 * basically just a label that you can jump to.  The EEND() macro does nothing
88 * at all, except document the exit point associated with the same-named entry.
89 */
90#define	GLOBAL(x)	.global x
91
92#ifdef __thumb__
93#define	_FUNC_MODE	.code 16; .thumb_func
94#else
95#define	_FUNC_MODE	.code 32
96#endif
97
98#define	_LEENTRY(x) 	.type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
99#define	_LEEND(x)	/* nothing */
100#define	_EENTRY(x) 	GLOBAL(x); _LEENTRY(x)
101#define	_EEND(x)	_LEEND(x)
102
103#define	_LENTRY(x)	.text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
104#define	_LEND(x)	.size x, . - x; _FNEND
105#define	_ENTRY(x)	.text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
106#define	_END(x)		_LEND(x)
107
108#define	ENTRY(y)	_ENTRY(_C_LABEL(y)); _PROF_PROLOGUE
109#define	EENTRY(y)	_EENTRY(_C_LABEL(y));
110#define	ENTRY_NP(y)	_ENTRY(_C_LABEL(y))
111#define	EENTRY_NP(y)	_EENTRY(_C_LABEL(y))
112#define	END(y)		_END(_C_LABEL(y))
113#define	EEND(y)		_EEND(_C_LABEL(y))
114#define	ASENTRY(y)	_ENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
115#define	ASLENTRY(y)	_LENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
116#define	ASEENTRY(y)	_EENTRY(_ASM_LABEL(y));
117#define	ASLEENTRY(y)	_LEENTRY(_ASM_LABEL(y));
118#define	ASENTRY_NP(y)	_ENTRY(_ASM_LABEL(y))
119#define	ASLENTRY_NP(y)	_LENTRY(_ASM_LABEL(y))
120#define	ASEENTRY_NP(y)	_EENTRY(_ASM_LABEL(y))
121#define	ASLEENTRY_NP(y)	_LEENTRY(_ASM_LABEL(y))
122#define	ASEND(y)	_END(_ASM_LABEL(y))
123#define	ASLEND(y)	_LEND(_ASM_LABEL(y))
124#define	ASEEND(y)	_EEND(_ASM_LABEL(y))
125#define	ASLEEND(y)	_LEEND(_ASM_LABEL(y))
126
127#define	ASMSTR		.asciz
128
129#if defined(PIC)
130#define	PLT_SYM(x)	PIC_SYM(x, PLT)
131#define	GOT_SYM(x)	PIC_SYM(x, GOT)
132#define	GOT_GET(x,got,sym)	\
133	ldr	x, sym;		\
134	ldr	x, [x, got]
135#define	GOT_INIT(got,gotsym,pclabel) \
136	ldr	got, gotsym;	\
137	pclabel: add	got, pc
138#ifdef __thumb__
139#define	GOT_INITSYM(gotsym,pclabel) \
140	.align 2;		\
141	gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
142#else
143#define	GOT_INITSYM(gotsym,pclabel) \
144	.align 2;		\
145	gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
146#endif
147
148#ifdef __STDC__
149#define	PIC_SYM(x,y)	x ## ( ## y ## )
150#else
151#define	PIC_SYM(x,y)	x/**/(/**/y/**/)
152#endif
153
154#else
155#define	PLT_SYM(x)	x
156#define	GOT_SYM(x)	x
157#define	GOT_GET(x,got,sym)	\
158	ldr	x, sym;
159#define	GOT_INIT(got,gotsym,pclabel)
160#define	GOT_INITSYM(gotsym,pclabel)
161#define	PIC_SYM(x,y)	x
162#endif	/* PIC */
163
164#undef __FBSDID
165#if !defined(lint) && !defined(STRIP_FBSDID)
166#define __FBSDID(s)     .ident s
167#else
168#define __FBSDID(s)     /* nothing */
169#endif
170
171
172#define	WEAK_ALIAS(alias,sym)						\
173	.weak alias;							\
174	alias = sym
175
176#ifdef __STDC__
177#define	WARN_REFERENCES(sym,msg)					\
178	.stabs msg ## ,30,0,0,0 ;					\
179	.stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
180#else
181#define	WARN_REFERENCES(sym,msg)					\
182	.stabs msg,30,0,0,0 ;						\
183	.stabs __STRING(sym),1,0,0,0
184#endif /* __STDC__ */
185
186/* Exactly one of the __ARM_ARCH_*__ macros will be defined by the compiler. */
187/* The _ARM_ARCH_* macros are deprecated and will be removed soon. */
188/* This should be moved into another header so it can be used in
189 * both asm and C code. machine/asm.h cannot be included in C code. */
190#if defined (__ARM_ARCH_7__) || defined (__ARM_ARCH_7A__)
191#define _ARM_ARCH_7
192#define _HAVE_ARMv7_INSTRUCTIONS 1
193#endif
194
195#if defined (_HAVE_ARMv7_INSTRUCTIONS) || defined (__ARM_ARCH_6__) || \
196	defined (__ARM_ARCH_6J__) || defined (__ARM_ARCH_6K__) || \
197	defined (__ARM_ARCH_6Z__) || defined (__ARM_ARCH_6ZK__)
198#define _ARM_ARCH_6
199#define _HAVE_ARMv6_INSTRUCTIONS 1
200#endif
201
202#if defined (_HAVE_ARMv6_INSTRUCTIONS) || defined (__ARM_ARCH_5TE__) || \
203    defined (__ARM_ARCH_5TEJ__) || defined (__ARM_ARCH_5E__)
204#define _ARM_ARCH_5E
205#define _HAVE_ARMv5E_INSTRUCTIONS 1
206#endif
207
208#if defined (_HAVE_ARMv5E_INSTRUCTIONS) || defined (__ARM_ARCH_5__) || \
209    defined (__ARM_ARCH_5T__)
210#define _ARM_ARCH_5
211#define _HAVE_ARMv5_INSTRUCTIONS 1
212#endif
213
214#if defined (_HAVE_ARMv5_INSTRUCTIONS) || defined (__ARM_ARCH_4T__)
215#define _ARM_ARCH_4T
216#define _HAVE_ARMv4T_INSTRUCTIONS 1
217#endif
218
219/* FreeBSD requires ARMv4, so this is always set. */
220#define _HAVE_ARMv4_INSTRUCTIONS 1
221
222#if defined (_HAVE_ARMv4T_INSTRUCTIONS)
223# define RET	bx	lr
224# define RETeq	bxeq	lr
225# define RETne	bxne	lr
226# define RETc(c) bx##c	lr
227#else
228# define RET	mov	pc, lr
229# define RETeq	moveq	pc, lr
230# define RETne	movne	pc, lr
231# define RETc(c) mov##c	pc, lr
232#endif
233
234#if __ARM_ARCH >= 7
235#define ISB	isb
236#define DSB	dsb
237#define DMB	dmb
238#define WFI	wfi
239#elif __ARM_ARCH == 6
240#define ISB	mcr CP15_CP15ISB
241#define DSB	mcr CP15_CP15DSB
242#define DMB	mcr CP15_CP15DMB
243#define WFI	mcr CP15_CP15WFI
244#else
245#define ISB	mcr CP15_CP15ISB
246#define DSB	mcr CP15_CP15DSB	/* DSB and DMB are the */
247#define DMB	mcr CP15_CP15DSB	/* same prior to v6.*/
248/* No form of WFI available on v4, define nothing to get an error on use. */
249#endif
250
251#endif /* !_MACHINE_ASM_H_ */
252