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 *	from: @(#)asm.h	5.5 (Berkeley) 5/7/91
 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 2
 48#endif
 49
 50#ifndef _STANDALONE
 51#define	STOP_UNWINDING	.cantunwind
 52#define	_FNSTART	.fnstart
 53#define	_FNEND		.fnend
 54#define	_SAVE(...)	.save __VA_ARGS__
 55#else
 56#define	STOP_UNWINDING
 57#define	_FNSTART
 58#define	_FNEND
 59#define	_SAVE(...)
 60#endif
 61
 62/*
 63 * gas/arm uses @ as a single comment character and thus cannot be used here.
 64 * It recognises the # instead of an @ symbol in .type directives.
 65 */
 66#define	_ASM_TYPE_FUNCTION	#function
 67#define	_ASM_TYPE_OBJECT	#object
 68
 69/*
 70 * EENTRY()/EEND() mark "extra" entry/exit points from a function.
 71 * LEENTRY()/LEEND() are the same for local symbols.
 72 * The unwind info cannot handle the concept of a nested function, or a function
 73 * with multiple .fnstart directives, but some of our assembler code is written
 74 * with multiple labels to allow entry at several points.  The EENTRY() macro
 75 * defines such an extra entry point without a new .fnstart, so that it's
 76 * basically just a label that you can jump to.  The EEND() macro does nothing
 77 * at all, except document the exit point associated with the same-named entry.
 78 */
 79#define	GLOBAL(x)	.global x
 80
 81#ifdef __thumb__
 82#define	_FUNC_MODE	.code 16; .thumb_func
 83#else
 84#define	_FUNC_MODE	.code 32
 85#endif
 86
 87#define	_LEENTRY(x) 	.type x,_ASM_TYPE_FUNCTION; _FUNC_MODE; x:
 88#define	_LEEND(x)	/* nothing */
 89#define	_EENTRY(x) 	GLOBAL(x); _LEENTRY(x)
 90#define	_EEND(x)	_LEEND(x)
 91
 92#define	_LENTRY(x)	.text; _ALIGN_TEXT; _LEENTRY(x); _FNSTART
 93#define	_LEND(x)	.size x, . - x; _FNEND
 94#define	_ENTRY(x)	.text; _ALIGN_TEXT; _EENTRY(x); _FNSTART
 95#define	_END(x)		_LEND(x)
 96
 97#define	ENTRY(y)	_ENTRY(_C_LABEL(y));
 98#define	EENTRY(y)	_EENTRY(_C_LABEL(y));
 99#define	ENTRY_NP(y)	_ENTRY(_C_LABEL(y))
100#define	EENTRY_NP(y)	_EENTRY(_C_LABEL(y))
101#define	END(y)		_END(_C_LABEL(y))
102#define	EEND(y)		_EEND(_C_LABEL(y))
103#define	ASENTRY(y)	_ENTRY(_ASM_LABEL(y));
104#define	ASLENTRY(y)	_LENTRY(_ASM_LABEL(y));
105#define	ASEENTRY(y)	_EENTRY(_ASM_LABEL(y));
106#define	ASLEENTRY(y)	_LEENTRY(_ASM_LABEL(y));
107#define	ASENTRY_NP(y)	_ENTRY(_ASM_LABEL(y))
108#define	ASLENTRY_NP(y)	_LENTRY(_ASM_LABEL(y))
109#define	ASEENTRY_NP(y)	_EENTRY(_ASM_LABEL(y))
110#define	ASLEENTRY_NP(y)	_LEENTRY(_ASM_LABEL(y))
111#define	ASEND(y)	_END(_ASM_LABEL(y))
112#define	ASLEND(y)	_LEND(_ASM_LABEL(y))
113#define	ASEEND(y)	_EEND(_ASM_LABEL(y))
114#define	ASLEEND(y)	_LEEND(_ASM_LABEL(y))
115
116#define	ASMSTR		.asciz
117
118#if defined(PIC)
119#define	PLT_SYM(x)	PIC_SYM(x, PLT)
120#define	GOT_SYM(x)	PIC_SYM(x, GOT)
121#define	GOT_GET(x,got,sym)	\
122	ldr	x, sym;		\
123	ldr	x, [x, got]
124#define	GOT_INIT(got,gotsym,pclabel) \
125	ldr	got, gotsym;	\
126	pclabel: add	got, pc
127#ifdef __thumb__
128#define	GOT_INITSYM(gotsym,pclabel) \
129	.align 2;		\
130	gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+4)
131#else
132#define	GOT_INITSYM(gotsym,pclabel) \
133	.align 2;		\
134	gotsym: .word _C_LABEL(_GLOBAL_OFFSET_TABLE_) - (pclabel+8)
135#endif
136
137#ifdef __STDC__
138#define	PIC_SYM(x,y)	x ## ( ## y ## )
139#else
140#define	PIC_SYM(x,y)	x/**/(/**/y/**/)
141#endif
142
143#else
144#define	PLT_SYM(x)	x
145#define	GOT_SYM(x)	x
146#define	GOT_GET(x,got,sym)	\
147	ldr	x, sym;
148#define	GOT_INIT(got,gotsym,pclabel)
149#define	GOT_INITSYM(gotsym,pclabel)
150#define	PIC_SYM(x,y)	x
151#endif	/* PIC */
152
153#undef __FBSDID
154#if !defined(lint) && !defined(STRIP_FBSDID)
155#define __FBSDID(s)     .ident s
156#else
157#define __FBSDID(s)     /* nothing */
158#endif
159
160#define	WEAK_ALIAS(alias,sym)						\
161	.weak alias;							\
162	alias = sym
163
164#ifdef __STDC__
165#define	WARN_REFERENCES(sym,msg)					\
166	.stabs msg ## ,30,0,0,0 ;					\
167	.stabs __STRING(_C_LABEL(sym)) ## ,1,0,0,0
168#else
169#define	WARN_REFERENCES(sym,msg)					\
170	.stabs msg,30,0,0,0 ;						\
171	.stabs __STRING(sym),1,0,0,0
172#endif /* __STDC__ */
173
174# define RET	bx	lr
175# define RETeq	bxeq	lr
176# define RETne	bxne	lr
177# define RETc(c) bx##c	lr
178
179#if __ARM_ARCH >= 7
180#define ISB	isb
181#define DSB	dsb
182#define DMB	dmb
183#define WFI	wfi
184
185#if defined(__ARM_ARCH_7VE__) || defined(__clang__)
186#define	MSR_ELR_HYP(regnum)	msr	elr_hyp, lr
187#define	ERET	eret
188#else
189#define MSR_ELR_HYP(regnum) .word (0xe12ef300 | regnum)
190#define ERET .word 0xe160006e
191#endif
192
193#elif __ARM_ARCH == 6
194#include <machine/sysreg.h>
195#define ISB	mcr CP15_CP15ISB
196#define DSB	mcr CP15_CP15DSB
197#define DMB	mcr CP15_CP15DMB
198#define WFI	mcr CP15_CP15WFI
199#endif
200
201#endif /* !_MACHINE_ASM_H_ */