1/* $NetBSD: asm.h,v 1.5 2003/08/07 16:26:53 agc Exp $ */
2
3/*-
4 * SPDX-License-Identifier: BSD-3-Clause
5 *
6 * Copyright (c) 1990 The Regents of the University of California.
7 * All rights reserved.
8 *
9 * This code is derived from software contributed to Berkeley by
10 * William Jolitz.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
23 *
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * SUCH DAMAGE.
35 */
36
37#ifndef _MACHINE_ASM_H_
38#define _MACHINE_ASM_H_
39#include <sys/cdefs.h>
40
41#define _C_LABEL(x) x
42#define _ASM_LABEL(x) x
43
44#ifndef _ALIGN_TEXT
45# define _ALIGN_TEXT .align 2
46#endif
47
48#ifndef _STANDALONE
49#define STOP_UNWINDING .cantunwind
50#define _FNSTART .fnstart
51#define _FNEND .fnend
52#define _SAVE(...) .save __VA_ARGS__
53#else
54#define STOP_UNWINDING
55#define _FNSTART
56#define _FNEND
57#define _SAVE(...)
58#endif
59
60/*
61 * gas/arm uses @ as a single comment character and thus cannot be used here.
62 * It recognises the # instead of an @ symbol in .type directives.
63 */
64#define _ASM_TYPE_FUNCTION #function
65#define _ASM_TYPE_OBJECT #object
66
67/*
68 * EENTRY()/EEND() mark "extra" entry/exit points from a function.
69 * LEENTRY()/LEEND() are the same for local symbols.
70 * The unwind info cannot handle the concept of a nested function, or a function
71 * with multiple .fnstart directives, but some of our assembler code is written
72 * with multiple labels to allow entry at several points. The EENTRY() macro
73 * defines such an extra entry point without a new .fnstart, so that it's
74 * basically just a label that you can jump to. The EEND() macro does nothing
75 * at all, except document the exit point associated with the same-named entry.
76 */
77#define GLOBAL(x) .global x
78
79#ifdef __thumb__
80#define _FUNC_MODE .code 16; .thumb_func
81#else
82#define _FUNC_MODE .code 32
83#endif
84
85#define _LEENTRY(x) .type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
86#define _LEEND(x) /* nothing */
87#define _EENTRY(x) GLOBAL(x); _LEENTRY(x)
88#define _EEND(x) _LEEND(x)
89
90#define _LENTRY(x) .text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
91#define _LEND(x) .size x, . - x; _FNEND
92#define _ENTRY(x) .text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
93#define _END(x) _LEND(x)
94
95#define ENTRY(y) _ENTRY(_C_LABEL(y));
96#define EENTRY(y) _EENTRY(_C_LABEL(y));
97#define ENTRY_NP(y) _ENTRY(_C_LABEL(y))
98#define EENTRY_NP(y) _EENTRY(_C_LABEL(y))
99#define END(y) _END(_C_LABEL(y))
100#define EEND(y) _EEND(_C_LABEL(y))
101#define ASENTRY(y) _ENTRY(_ASM_LABEL(y));
102#define ASLENTRY(y) _LENTRY(_ASM_LABEL(y));
103#define ASEENTRY(y) _EENTRY(_ASM_LABEL(y));
104#define ASLEENTRY(y) _LEENTRY(_ASM_LABEL(y));
105#define ASENTRY_NP(y) _ENTRY(_ASM_LABEL(y))
106#define ASLENTRY_NP(y) _LENTRY(_ASM_LABEL(y))
107#define ASEENTRY_NP(y) _EENTRY(_ASM_LABEL(y))
108#define ASLEENTRY_NP(y) _LEENTRY(_ASM_LABEL(y))
109#define ASEND(y) _END(_ASM_LABEL(y))
110#define ASLEND(y) _LEND(_ASM_LABEL(y))
111#define ASEEND(y) _EEND(_ASM_LABEL(y))
112#define ASLEEND(y) _LEEND(_ASM_LABEL(y))
113
114#define ASMSTR .asciz
115
116#if defined(PIC)
117#define PLT_SYM(x) PIC_SYM(x, PLT)
118#define GOT_SYM(x) PIC_SYM(x, GOT)
119#define GOT_GET(x,got,sym) \
120 ldr x, sym; \
121 ldr x, [x, got]
122#define GOT_INIT(got,gotsym,pclabel) \
123 ldr got, gotsym; \
124 pclabel: add got, pc
125#ifdef __thumb__
126#define GOT_INITSYM(gotsym,pclabel) \
127 .align 2; \
128 gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
129#else
130#define GOT_INITSYM(gotsym,pclabel) \
131 .align 2; \
132 gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
133#endif
134
135#ifdef __STDC__
136#define PIC_SYM(x,y) x ## ( ## y ## )
137#else
138#define PIC_SYM(x,y) x/**/(/**/y/**/)
139#endif
140
141#else
142#define PLT_SYM(x) x
143#define GOT_SYM(x) x
144#define GOT_GET(x,got,sym) \
145 ldr x, sym;
146#define GOT_INIT(got,gotsym,pclabel)
147#define GOT_INITSYM(gotsym,pclabel)
148#define PIC_SYM(x,y) x
149#endif /* PIC */
150
151#undef __FBSDID
152#if !defined(lint) && !defined(STRIP_FBSDID)
153#define __FBSDID(s) .ident s
154#else
155#define __FBSDID(s) /* nothing */
156#endif
157
158#define WEAK_ALIAS(alias,sym) \
159 .weak alias; \
160 alias = sym
161
162#ifdef __STDC__
163#define WARN_REFERENCES(sym,msg) \
164 .stabs msg ## ,30,0,0,0 ; \
165 .stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
166#else
167#define WARN_REFERENCES(sym,msg) \
168 .stabs msg,30,0,0,0 ; \
169 .stabs __STRING(sym),1,0,0,0
170#endif /* __STDC__ */
171
172# define RET bx lr
173# define RETeq bxeq lr
174# define RETne bxne lr
175# define RETc(c) bx##c lr
176
177#define ISB isb
178#define DSB dsb
179#define DMB dmb
180#define WFI wfi
181
182#if defined(__ARM_ARCH_7VE__) || defined(__clang__)
183#define MSR_ELR_HYP(regnum) msr elr_hyp, lr
184#define ERET eret
185#else
186#define MSR_ELR_HYP(regnum) .word (0xe12ef300 | regnum)
187#define ERET .word 0xe160006e
188#endif
189
190
191#endif /* !_MACHINE_ASM_H_ */