xref: /freebsd/sys/arm64/include/asm.h (revision 04b4655997d2d10e3f3748f3a1a1d84c4ae95740)
1412042e2SAndrew Turner /*-
2412042e2SAndrew Turner  * Copyright (c) 2014 Andrew Turner
3412042e2SAndrew Turner  * All rights reserved.
4412042e2SAndrew Turner  *
5412042e2SAndrew Turner  * Redistribution and use in source and binary forms, with or without
6412042e2SAndrew Turner  * modification, are permitted provided that the following conditions
7412042e2SAndrew Turner  * are met:
8412042e2SAndrew Turner  * 1. Redistributions of source code must retain the above copyright
9412042e2SAndrew Turner  *    notice, this list of conditions and the following disclaimer.
10412042e2SAndrew Turner  * 2. Redistributions in binary form must reproduce the above copyright
11412042e2SAndrew Turner  *    notice, this list of conditions and the following disclaimer in the
12412042e2SAndrew Turner  *    documentation and/or other materials provided with the distribution.
13412042e2SAndrew Turner  *
14412042e2SAndrew Turner  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15412042e2SAndrew Turner  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16412042e2SAndrew Turner  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17412042e2SAndrew Turner  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18412042e2SAndrew Turner  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19412042e2SAndrew Turner  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20412042e2SAndrew Turner  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21412042e2SAndrew Turner  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22412042e2SAndrew Turner  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23412042e2SAndrew Turner  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24412042e2SAndrew Turner  * SUCH DAMAGE.
25412042e2SAndrew Turner  *
26412042e2SAndrew Turner  * $FreeBSD$
27412042e2SAndrew Turner  */
28412042e2SAndrew Turner 
29412042e2SAndrew Turner #ifndef _MACHINE_ASM_H_
30412042e2SAndrew Turner #define	_MACHINE_ASM_H_
31412042e2SAndrew Turner 
32412042e2SAndrew Turner #undef __FBSDID
33412042e2SAndrew Turner #if !defined(lint) && !defined(STRIP_FBSDID)
34412042e2SAndrew Turner #define	__FBSDID(s)     .ident s
35412042e2SAndrew Turner #else
36412042e2SAndrew Turner #define	__FBSDID(s)     /* nothing */
37412042e2SAndrew Turner #endif
38412042e2SAndrew Turner 
39412042e2SAndrew Turner #define	_C_LABEL(x)	x
40412042e2SAndrew Turner 
4128d94520SAndrew Turner #ifdef KDTRACE_HOOKS
4228d94520SAndrew Turner #define	DTRACE_NOP	nop
4328d94520SAndrew Turner #else
4428d94520SAndrew Turner #define	DTRACE_NOP
4528d94520SAndrew Turner #endif
4628d94520SAndrew Turner 
476f8866afSAndrew Turner #define	LENTRY(sym)						\
486f8866afSAndrew Turner 	.text; .align 2; .type sym,#function; sym:		\
4928d94520SAndrew Turner 	.cfi_startproc; DTRACE_NOP
506f8866afSAndrew Turner #define	ENTRY(sym)						\
516f8866afSAndrew Turner 	.globl sym; LENTRY(sym)
52412042e2SAndrew Turner #define	EENTRY(sym)						\
53*04b46559SAndrew Turner 	.globl	sym; .text; .align 2; .type sym,#function; sym:
54449ebf13SAndrew Turner #define	LEND(sym) .ltorg; .cfi_endproc; .size sym, . - sym
556f8866afSAndrew Turner #define	END(sym) LEND(sym)
56412042e2SAndrew Turner #define	EEND(sym)
57412042e2SAndrew Turner 
58412042e2SAndrew Turner #define	WEAK_REFERENCE(sym, alias)				\
59412042e2SAndrew Turner 	.weak alias;						\
60412042e2SAndrew Turner 	.set alias,sym
61412042e2SAndrew Turner 
62412042e2SAndrew Turner #define	UINT64_C(x)	(x)
63412042e2SAndrew Turner 
64412042e2SAndrew Turner #if defined(PIC)
65412042e2SAndrew Turner #define	PIC_SYM(x,y)	x ## @ ## y
66412042e2SAndrew Turner #else
67412042e2SAndrew Turner #define	PIC_SYM(x,y)	x
68412042e2SAndrew Turner #endif
69412042e2SAndrew Turner 
708b609ea5SAlexander Kabaev /* Alias for link register x30 */
718b609ea5SAlexander Kabaev #define	lr		x30
728b609ea5SAlexander Kabaev 
73412042e2SAndrew Turner /*
74412042e2SAndrew Turner  * Sets the trap fault handler. The exception handler will return to the
75412042e2SAndrew Turner  * address in the handler register on a data abort or the xzr register to
76412042e2SAndrew Turner  * clear the handler. The tmp parameter should be a register able to hold
77412042e2SAndrew Turner  * the temporary data.
78412042e2SAndrew Turner  */
79412042e2SAndrew Turner #define	SET_FAULT_HANDLER(handler, tmp)					\
80412042e2SAndrew Turner 	ldr	tmp, [x18, #PC_CURTHREAD];	/* Load curthread */	\
81412042e2SAndrew Turner 	ldr	tmp, [tmp, #TD_PCB];		/* Load the pcb */	\
82412042e2SAndrew Turner 	str	handler, [tmp, #PCB_ONFAULT]	/* Set the handler */
83412042e2SAndrew Turner 
84d6a0af23SAndrew Turner #define	ENTER_USER_ACCESS(reg, tmp)					\
85d6a0af23SAndrew Turner 	ldr	tmp, =has_pan;			/* Get the addr of has_pan */ \
86d6a0af23SAndrew Turner 	ldr	reg, [tmp];			/* Read it */		\
87d6a0af23SAndrew Turner 	cbz	reg, 997f;			/* If no PAN skip */	\
88d6a0af23SAndrew Turner 	.inst	0xd500409f | (0 << 8);		/* Clear PAN */		\
89d6a0af23SAndrew Turner 	997:
90d6a0af23SAndrew Turner 
91d6a0af23SAndrew Turner #define	EXIT_USER_ACCESS(reg)						\
92d6a0af23SAndrew Turner 	cbz	reg, 998f;			/* If no PAN skip */	\
93d6a0af23SAndrew Turner 	.inst	0xd500409f | (1 << 8);		/* Set PAN */		\
94d6a0af23SAndrew Turner 	998:
95d6a0af23SAndrew Turner 
96d6a0af23SAndrew Turner #define	EXIT_USER_ACCESS_CHECK(reg, tmp)				\
97d6a0af23SAndrew Turner 	ldr	tmp, =has_pan;			/* Get the addr of has_pan */ \
98d6a0af23SAndrew Turner 	ldr	reg, [tmp];			/* Read it */		\
99d6a0af23SAndrew Turner 	cbz	reg, 999f;			/* If no PAN skip */	\
100d6a0af23SAndrew Turner 	.inst	0xd500409f | (1 << 8);		/* Set PAN */		\
101d6a0af23SAndrew Turner 	999:
102d6a0af23SAndrew Turner 
103494278bbSAndrew Turner /*
104494278bbSAndrew Turner  * Some AArch64 CPUs speculate past an eret instruction. As the user may
105494278bbSAndrew Turner  * control the registers at this point add a speculation barrier usable on
106494278bbSAndrew Turner  * all AArch64 CPUs after the eret instruction.
107494278bbSAndrew Turner  * TODO: ARMv8.5 adds a specific instruction for this, we could use that
108494278bbSAndrew Turner  * if we know we are running on something that supports it.
109494278bbSAndrew Turner  */
110494278bbSAndrew Turner #define	ERET								\
111494278bbSAndrew Turner 	eret;								\
112494278bbSAndrew Turner 	dsb	sy;							\
113494278bbSAndrew Turner 	isb
114494278bbSAndrew Turner 
115412042e2SAndrew Turner #endif /* _MACHINE_ASM_H_ */
116