xref: /xnu-11215.41.3/osfmk/arm64/machine_machdep.h (revision 33de042d024d46de5ff4e89f2471de6608e37fa4)
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 #ifdef MACH_KERNEL_PRIVATE
36 
37 /* We cache the following in EL0 registers
38  *     TPIDRRO_EL0
39  *         - the current cthread pointer
40  *     TPIDR_EL0
41  *         - the current CPU number (12 bits)
42  *         - the current logical cluster id (8 bits)
43  *
44  * NOTE: Keep this in sync with libsyscall/os/tsd.h,
45  *       specifically _os_cpu_number(), _os_cpu_cluster_number()
46  */
47 #define MACHDEP_TPIDR_CPUNUM_SHIFT     0
48 #define MACHDEP_TPIDR_CPUNUM_MASK      0x0000000000000fff
49 #define MACHDEP_TPIDR_CLUSTERID_SHIFT  12
50 #define MACHDEP_TPIDR_CLUSTERID_MASK   0x00000000000ff000
51 
52 #endif // MACH_KERNEL_PRIVATE
53 
54 /*
55  * Machine Thread Flags (machine_thread.flags)
56  */
57 
58 /* Thread is entitled to use x18, don't smash it when switching to thread. */
59 #if !__ARM_KERNEL_PROTECT__
60 #define ARM_MACHINE_THREAD_PRESERVE_X18_SHIFT           0
61 #define ARM_MACHINE_THREAD_PRESERVE_X18                 (1 << ARM_MACHINE_THREAD_PRESERVE_X18_SHIFT)
62 #endif /* !__ARM_KERNEL_PROTECT__ */
63 
64 #if defined(HAS_APPLE_PAC)
65 #define ARM_MACHINE_THREAD_DISABLE_USER_JOP_SHIFT       1
66 #define ARM_MACHINE_THREAD_DISABLE_USER_JOP             (1 << ARM_MACHINE_THREAD_DISABLE_USER_JOP_SHIFT)
67 #endif /* HAS_APPLE_PAC */
68 
69 /* Thread should use 1 GHz timebase */
70 #define ARM_MACHINE_THREAD_USES_1GHZ_TIMBASE_SHIFT      2
71 #define ARM_MACHINE_THREAD_USES_1GHZ_TIMBASE            (1 << ARM_MACHINE_THREAD_USES_1GHZ_TIMBASE_SHIFT)
72 
73 #endif /* _MACHDEP_INTERNAL_H_ */
74