xref: /xnu-8792.61.2/osfmk/arm64/machine_machdep.h (revision 42e220869062b56f8d7d0726fd4c88954f87902c)
1 /*
2  * Copyright (c) 2017 Apple Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 #ifndef _MACHDEP_INTERNAL_H_
29 #define _MACHDEP_INTERNAL_H_
30 
31 #include <machine/types.h>
32 
33 #include <pexpert/arm64/board_config.h>
34 
35 /* We cache the current cthread pointer in TPIDRRO_EL0 and
36  * the current CPU number in the low 12 bits of TPIDR_EL0.
37  *
38  * The cthread pointer must be aligned
39  * sufficiently that the maximum CPU number will fit.
40  *
41  * NOTE: Keep this in sync with libsyscall/os/tsd.h, specifically _os_cpu_number()
42  */
43 #define MACHDEP_TPIDR_CPUNUM_MASK       (0x0000000000000fff)
44 
45 /*
46  * Machine Thread Flags (machine_thread.flags)
47  */
48 
49 /* Thread is entitled to use x18, don't smash it when switching to thread. */
50 #if !__ARM_KERNEL_PROTECT__
51 #define ARM_MACHINE_THREAD_PRESERVE_X18_SHIFT           0
52 #define ARM_MACHINE_THREAD_PRESERVE_X18                 (1 << ARM_MACHINE_THREAD_PRESERVE_X18_SHIFT)
53 #endif /* !__ARM_KERNEL_PROTECT__ */
54 
55 #if defined(HAS_APPLE_PAC)
56 #define ARM_MACHINE_THREAD_DISABLE_USER_JOP_SHIFT       1
57 #define ARM_MACHINE_THREAD_DISABLE_USER_JOP             (1 << ARM_MACHINE_THREAD_DISABLE_USER_JOP_SHIFT)
58 #endif
59 
60 #endif /* _MACHDEP_INTERNAL_H_ */
61