xref: /freebsd/sys/arm64/include/asm.h (revision cfd6422a5217410fbd66f7a7a8a64d9d85e61229)
1 /*-
2  * Copyright (c) 2014 Andrew Turner
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _MACHINE_ASM_H_
30 #define	_MACHINE_ASM_H_
31 
32 #undef __FBSDID
33 #if !defined(lint) && !defined(STRIP_FBSDID)
34 #define	__FBSDID(s)     .ident s
35 #else
36 #define	__FBSDID(s)     /* nothing */
37 #endif
38 
39 #define	_C_LABEL(x)	x
40 
41 #define	LENTRY(sym)						\
42 	.text; .align 2; .type sym,#function; sym:		\
43 	.cfi_startproc
44 #define	ENTRY(sym)						\
45 	.globl sym; LENTRY(sym)
46 #define	EENTRY(sym)						\
47 	.globl	sym; sym:
48 #define	LEND(sym) .ltorg; .cfi_endproc; .size sym, . - sym
49 #define	END(sym) LEND(sym)
50 #define	EEND(sym)
51 
52 #define	WEAK_REFERENCE(sym, alias)				\
53 	.weak alias;						\
54 	.set alias,sym
55 
56 #define	UINT64_C(x)	(x)
57 
58 #if defined(PIC)
59 #define	PIC_SYM(x,y)	x ## @ ## y
60 #else
61 #define	PIC_SYM(x,y)	x
62 #endif
63 
64 /* Alias for link register x30 */
65 #define	lr		x30
66 
67 /*
68  * Sets the trap fault handler. The exception handler will return to the
69  * address in the handler register on a data abort or the xzr register to
70  * clear the handler. The tmp parameter should be a register able to hold
71  * the temporary data.
72  */
73 #define	SET_FAULT_HANDLER(handler, tmp)					\
74 	ldr	tmp, [x18, #PC_CURTHREAD];	/* Load curthread */	\
75 	ldr	tmp, [tmp, #TD_PCB];		/* Load the pcb */	\
76 	str	handler, [tmp, #PCB_ONFAULT]	/* Set the handler */
77 
78 #define	ENTER_USER_ACCESS(reg, tmp)					\
79 	ldr	tmp, =has_pan;			/* Get the addr of has_pan */ \
80 	ldr	reg, [tmp];			/* Read it */		\
81 	cbz	reg, 997f;			/* If no PAN skip */	\
82 	.inst	0xd500409f | (0 << 8);		/* Clear PAN */		\
83 	997:
84 
85 #define	EXIT_USER_ACCESS(reg)						\
86 	cbz	reg, 998f;			/* If no PAN skip */	\
87 	.inst	0xd500409f | (1 << 8);		/* Set PAN */		\
88 	998:
89 
90 #define	EXIT_USER_ACCESS_CHECK(reg, tmp)				\
91 	ldr	tmp, =has_pan;			/* Get the addr of has_pan */ \
92 	ldr	reg, [tmp];			/* Read it */		\
93 	cbz	reg, 999f;			/* If no PAN skip */	\
94 	.inst	0xd500409f | (1 << 8);		/* Set PAN */		\
95 	999:
96 
97 /*
98  * Some AArch64 CPUs speculate past an eret instruction. As the user may
99  * control the registers at this point add a speculation barrier usable on
100  * all AArch64 CPUs after the eret instruction.
101  * TODO: ARMv8.5 adds a specific instruction for this, we could use that
102  * if we know we are running on something that supports it.
103  */
104 #define	ERET								\
105 	eret;								\
106 	dsb	sy;							\
107 	isb
108 
109 #endif /* _MACHINE_ASM_H_ */
110