asm.h revision 275264
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 275264 2014-11-29 19:31:23Z andrew $
37 */
38
39#ifndef _MACHINE_ASM_H_
40#define _MACHINE_ASM_H_
41#include <sys/cdefs.h>
42
43#define	_C_LABEL(x)	x
44#define	_ASM_LABEL(x)	x
45
46#ifndef _ALIGN_TEXT
47# define _ALIGN_TEXT .align 0
48#endif
49
50#if defined(__ARM_EABI__) && !defined(_STANDALONE)
51#define	STOP_UNWINDING	.cantunwind
52#define	_FNSTART	.fnstart
53#define	_FNEND		.fnend
54#else
55#define	STOP_UNWINDING
56#define	_FNSTART
57#define	_FNEND
58#endif
59
60/*
61 * EENTRY()/EEND() mark "extra" entry/exit points from a function.
62 * The unwind info cannot handle the concept of a nested function, or a function
63 * with multiple .fnstart directives, but some of our assembler code is written
64 * with multiple labels to allow entry at several points.  The EENTRY() macro
65 * defines such an extra entry point without a new .fnstart, so that it's
66 * basically just a label that you can jump to.  The EEND() macro does nothing
67 * at all, except document the exit point associated with the same-named entry.
68 */
69#define	_EENTRY(x) 	.globl x; .type x,_ASM_TYPE_FUNCTION; x:
70#define	_EEND(x)	/* nothing */
71
72/*
73 * gas/arm uses @ as a single comment character and thus cannot be used here
74 * Instead it recognised the # instead of an @ symbols in .type directives
75 * We define a couple of macros so that assembly code will not be dependent
76 * on one or the other.
77 */
78#define _ASM_TYPE_FUNCTION	#function
79#define _ASM_TYPE_OBJECT	#object
80#define GLOBAL(X) .globl x
81#define	_ENTRY(x) \
82	.text; _ALIGN_TEXT; _EENTRY(x) _FNSTART
83#define	_END(x)	.size x, . - x; _FNEND
84
85#ifdef GPROF
86#  define _PROF_PROLOGUE	\
87	mov ip, lr; bl __mcount
88#else
89# define _PROF_PROLOGUE
90#endif
91
92#define	ENTRY(y)	_ENTRY(_C_LABEL(y)); _PROF_PROLOGUE
93#define	EENTRY(y)	_EENTRY(_C_LABEL(y)); _PROF_PROLOGUE
94#define	ENTRY_NP(y)	_ENTRY(_C_LABEL(y))
95#define	EENTRY_NP(y)	_EENTRY(_C_LABEL(y))
96#define	END(y)		_END(_C_LABEL(y))
97#define	EEND(y)
98#define	ASENTRY(y)	_ENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
99#define	ASEENTRY(y)	_EENTRY(_ASM_LABEL(y)); _PROF_PROLOGUE
100#define	ASENTRY_NP(y)	_ENTRY(_ASM_LABEL(y))
101#define	ASEENTRY_NP(y)	_EENTRY(_ASM_LABEL(y))
102#define	ASEND(y)	_END(_ASM_LABEL(y))
103#define	ASEEND(y)
104
105#define	ASMSTR		.asciz
106
107#if defined(PIC)
108#define	PLT_SYM(x)	PIC_SYM(x, PLT)
109#define	GOT_SYM(x)	PIC_SYM(x, GOT)
110#define	GOT_GET(x,got,sym)	\
111	ldr	x, sym;		\
112	ldr	x, [x, got]
113#define	GOT_INIT(got,gotsym,pclabel) \
114	ldr	got, gotsym;	\
115	add	got, got, pc;	\
116	pclabel:
117#define	GOT_INITSYM(gotsym,pclabel) \
118	gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) + (. - (pclabel+4))
119
120#ifdef __STDC__
121#define	PIC_SYM(x,y)	x ## ( ## y ## )
122#else
123#define	PIC_SYM(x,y)	x/**/(/**/y/**/)
124#endif
125
126#else
127#define	PLT_SYM(x)	x
128#define	GOT_SYM(x)	x
129#define	GOT_GET(x,got,sym)	\
130	ldr	x, sym;
131#define	GOT_INIT(got,gotsym,pclabel)
132#define	GOT_INITSYM(gotsym,pclabel)
133#define	PIC_SYM(x,y)	x
134#endif	/* PIC */
135
136#undef __FBSDID
137#if !defined(lint) && !defined(STRIP_FBSDID)
138#define __FBSDID(s)     .ident s
139#else
140#define __FBSDID(s)     /* nothing */
141#endif
142
143
144#define	WEAK_ALIAS(alias,sym)						\
145	.weak alias;							\
146	alias = sym
147
148#ifdef __STDC__
149#define	WARN_REFERENCES(sym,msg)					\
150	.stabs msg ## ,30,0,0,0 ;					\
151	.stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
152#else
153#define	WARN_REFERENCES(sym,msg)					\
154	.stabs msg,30,0,0,0 ;						\
155	.stabs __STRING(sym),1,0,0,0
156#endif /* __STDC__ */
157
158/* Exactly one of the __ARM_ARCH_*__ macros will be defined by the compiler. */
159/* The _ARM_ARCH_* macros are deprecated and will be removed soon. */
160/* This should be moved into another header so it can be used in
161 * both asm and C code. machine/asm.h cannot be included in C code. */
162#if defined (__ARM_ARCH_7__) || defined (__ARM_ARCH_7A__)
163#define _ARM_ARCH_7
164#define _HAVE_ARMv7_INSTRUCTIONS 1
165#endif
166
167#if defined (_HAVE_ARMv7_INSTRUCTIONS) || defined (__ARM_ARCH_6__) || \
168	defined (__ARM_ARCH_6J__) || defined (__ARM_ARCH_6K__) || \
169	defined (__ARM_ARCH_6Z__) || defined (__ARM_ARCH_6ZK__)
170#define _ARM_ARCH_6
171#define _HAVE_ARMv6_INSTRUCTIONS 1
172#endif
173
174#if defined (_HAVE_ARMv6_INSTRUCTIONS) || defined (__ARM_ARCH_5TE__) || \
175    defined (__ARM_ARCH_5TEJ__) || defined (__ARM_ARCH_5E__)
176#define _ARM_ARCH_5E
177#define _HAVE_ARMv5E_INSTRUCTIONS 1
178#endif
179
180#if defined (_HAVE_ARMv5E_INSTRUCTIONS) || defined (__ARM_ARCH_5__) || \
181    defined (__ARM_ARCH_5T__)
182#define _ARM_ARCH_5
183#define _HAVE_ARMv5_INSTRUCTIONS 1
184#endif
185
186#if defined (_HAVE_ARMv5_INSTRUCTIONS) || defined (__ARM_ARCH_4T__)
187#define _ARM_ARCH_4T
188#define _HAVE_ARMv4T_INSTRUCTIONS 1
189#endif
190
191/* FreeBSD requires ARMv4, so this is always set. */
192#define _HAVE_ARMv4_INSTRUCTIONS 1
193
194#if defined (_HAVE_ARMv4T_INSTRUCTIONS)
195# define RET	bx	lr
196# define RETeq	bxeq	lr
197# define RETne	bxne	lr
198# define RETc(c) bx##c	lr
199#else
200# define RET	mov	pc, lr
201# define RETeq	moveq	pc, lr
202# define RETne	movne	pc, lr
203# define RETc(c) mov##c	pc, lr
204#endif
205
206#endif /* !_MACHINE_ASM_H_ */
207