xref: /freebsd/sys/arm64/include/cpu.h (revision 6580f5c38dd5b01aeeaed16b370f1a12423437f0)
1 /*-
2  * Copyright (c) 1990 The Regents of the University of California.
3  * Copyright (c) 2014-2016 The FreeBSD Foundation
4  * All rights reserved.
5  *
6  * This code is derived from software contributed to Berkeley by
7  * William Jolitz.
8  *
9  * Portions of this software were developed by Andrew Turner
10  * under sponsorship from the FreeBSD Foundation
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  *	from: FreeBSD: src/sys/i386/include/cpu.h,v 1.62 2001/06/29
36  */
37 
38 #ifdef __arm__
39 #include <arm/cpu.h>
40 #else /* !__arm__ */
41 
42 #ifndef _MACHINE_CPU_H_
43 #define	_MACHINE_CPU_H_
44 
45 #include <machine/atomic.h>
46 #include <machine/frame.h>
47 #include <machine/armreg.h>
48 
49 #define	TRAPF_PC(tfp)		((tfp)->tf_elr)
50 #define	TRAPF_USERMODE(tfp)	(((tfp)->tf_spsr & PSR_M_MASK) == PSR_M_EL0t)
51 
52 #define	cpu_getstack(td)	((td)->td_frame->tf_sp)
53 #define	cpu_setstack(td, sp)	((td)->td_frame->tf_sp = (sp))
54 #define	cpu_spinwait()		__asm __volatile("yield" ::: "memory")
55 #define	cpu_lock_delay()	DELAY(1)
56 
57 /* Extract CPU affinity levels 0-3 */
58 #define	CPU_AFF0(mpidr)	(u_int)(((mpidr) >> 0) & 0xff)
59 #define	CPU_AFF1(mpidr)	(u_int)(((mpidr) >> 8) & 0xff)
60 #define	CPU_AFF2(mpidr)	(u_int)(((mpidr) >> 16) & 0xff)
61 #define	CPU_AFF3(mpidr)	(u_int)(((mpidr) >> 32) & 0xff)
62 #define	CPU_AFF0_MASK	0xffUL
63 #define	CPU_AFF1_MASK	0xff00UL
64 #define	CPU_AFF2_MASK	0xff0000UL
65 #define	CPU_AFF3_MASK	0xff00000000UL
66 #define	CPU_AFF_MASK	(CPU_AFF0_MASK | CPU_AFF1_MASK | \
67     CPU_AFF2_MASK| CPU_AFF3_MASK)	/* Mask affinity fields in MPIDR_EL1 */
68 
69 #ifdef _KERNEL
70 
71 #define	CPU_IMPL_ARM		0x41
72 #define	CPU_IMPL_BROADCOM	0x42
73 #define	CPU_IMPL_CAVIUM		0x43
74 #define	CPU_IMPL_DEC		0x44
75 #define	CPU_IMPL_FUJITSU	0x46
76 #define	CPU_IMPL_INFINEON	0x49
77 #define	CPU_IMPL_FREESCALE	0x4D
78 #define	CPU_IMPL_NVIDIA		0x4E
79 #define	CPU_IMPL_APM		0x50
80 #define	CPU_IMPL_QUALCOMM	0x51
81 #define	CPU_IMPL_MARVELL	0x56
82 #define	CPU_IMPL_APPLE		0x61
83 #define	CPU_IMPL_INTEL		0x69
84 #define	CPU_IMPL_AMPERE		0xC0
85 
86 /* ARM Part numbers */
87 #define	CPU_PART_FOUNDATION	0xD00
88 #define	CPU_PART_CORTEX_A34	0xD02
89 #define	CPU_PART_CORTEX_A53	0xD03
90 #define	CPU_PART_CORTEX_A35	0xD04
91 #define	CPU_PART_CORTEX_A55	0xD05
92 #define	CPU_PART_CORTEX_A65	0xD06
93 #define	CPU_PART_CORTEX_A57	0xD07
94 #define	CPU_PART_CORTEX_A72	0xD08
95 #define	CPU_PART_CORTEX_A73	0xD09
96 #define	CPU_PART_CORTEX_A75	0xD0A
97 #define	CPU_PART_CORTEX_A76	0xD0B
98 #define	CPU_PART_NEOVERSE_N1	0xD0C
99 #define	CPU_PART_CORTEX_A77	0xD0D
100 #define	CPU_PART_CORTEX_A76AE	0xD0E
101 #define	CPU_PART_AEM_V8		0xD0F
102 #define	CPU_PART_NEOVERSE_V1	0xD40
103 #define	CPU_PART_CORTEX_A78	0xD41
104 #define	CPU_PART_CORTEX_A65AE	0xD43
105 #define	CPU_PART_CORTEX_X1	0xD44
106 #define	CPU_PART_CORTEX_A510	0xD46
107 #define	CPU_PART_CORTEX_A710	0xD47
108 #define	CPU_PART_CORTEX_X2	0xD48
109 #define	CPU_PART_NEOVERSE_N2	0xD49
110 #define	CPU_PART_NEOVERSE_E1	0xD4A
111 #define	CPU_PART_CORTEX_A78C	0xD4B
112 #define	CPU_PART_CORTEX_X1C	0xD4C
113 #define	CPU_PART_CORTEX_A715	0xD4D
114 #define	CPU_PART_CORTEX_X3	0xD4E
115 #define	CPU_PART_NEOVERSE_V2	0xD4F
116 
117 /* Cavium Part numbers */
118 #define	CPU_PART_THUNDERX	0x0A1
119 #define	CPU_PART_THUNDERX_81XX	0x0A2
120 #define	CPU_PART_THUNDERX_83XX	0x0A3
121 #define	CPU_PART_THUNDERX2	0x0AF
122 
123 #define	CPU_REV_THUNDERX_1_0	0x00
124 #define	CPU_REV_THUNDERX_1_1	0x01
125 
126 #define	CPU_REV_THUNDERX2_0	0x00
127 
128 /* APM / Ampere Part Number */
129 #define CPU_PART_EMAG8180	0x000
130 
131 /* Qualcomm */
132 #define	CPU_PART_KRYO400_GOLD	0x804
133 #define	CPU_PART_KRYO400_SILVER	0x805
134 
135 /* Apple part numbers */
136 #define CPU_PART_M1_ICESTORM      0x022
137 #define CPU_PART_M1_FIRESTORM     0x023
138 #define CPU_PART_M1_ICESTORM_PRO  0x024
139 #define CPU_PART_M1_FIRESTORM_PRO 0x025
140 #define CPU_PART_M1_ICESTORM_MAX  0x028
141 #define CPU_PART_M1_FIRESTORM_MAX 0x029
142 #define CPU_PART_M2_BLIZZARD      0x032
143 #define CPU_PART_M2_AVALANCHE     0x033
144 #define CPU_PART_M2_BLIZZARD_PRO  0x034
145 #define CPU_PART_M2_AVALANCHE_PRO 0x035
146 #define CPU_PART_M2_BLIZZARD_MAX  0x038
147 #define CPU_PART_M2_AVALANCHE_MAX 0x039
148 
149 #define	CPU_IMPL(midr)	(((midr) >> 24) & 0xff)
150 #define	CPU_PART(midr)	(((midr) >> 4) & 0xfff)
151 #define	CPU_VAR(midr)	(((midr) >> 20) & 0xf)
152 #define	CPU_ARCH(midr)	(((midr) >> 16) & 0xf)
153 #define	CPU_REV(midr)	(((midr) >> 0) & 0xf)
154 
155 #define	CPU_IMPL_TO_MIDR(val)	(((val) & 0xff) << 24)
156 #define	CPU_PART_TO_MIDR(val)	(((val) & 0xfff) << 4)
157 #define	CPU_VAR_TO_MIDR(val)	(((val) & 0xf) << 20)
158 #define	CPU_ARCH_TO_MIDR(val)	(((val) & 0xf) << 16)
159 #define	CPU_REV_TO_MIDR(val)	(((val) & 0xf) << 0)
160 
161 #define	CPU_IMPL_MASK	(0xff << 24)
162 #define	CPU_PART_MASK	(0xfff << 4)
163 #define	CPU_VAR_MASK	(0xf << 20)
164 #define	CPU_ARCH_MASK	(0xf << 16)
165 #define	CPU_REV_MASK	(0xf << 0)
166 
167 #define	CPU_ID_RAW(impl, part, var, rev)		\
168     (CPU_IMPL_TO_MIDR((impl)) |				\
169     CPU_PART_TO_MIDR((part)) | CPU_VAR_TO_MIDR((var)) |	\
170     CPU_REV_TO_MIDR((rev)))
171 
172 #define	CPU_MATCH(mask, impl, part, var, rev)		\
173     (((mask) & PCPU_GET(midr)) ==			\
174     ((mask) & CPU_ID_RAW((impl), (part), (var), (rev))))
175 
176 #define	CPU_MATCH_RAW(mask, devid)			\
177     (((mask) & PCPU_GET(midr)) == ((mask) & (devid)))
178 
179 /*
180  * Chip-specific errata. This defines are intended to be
181  * booleans used within if statements. When an appropriate
182  * kernel option is disabled, these defines must be defined
183  * as 0 to allow the compiler to remove a dead code thus
184  * produce better optimized kernel image.
185  */
186 /*
187  * Vendor:	Cavium
188  * Chip:	ThunderX
189  * Revision(s):	Pass 1.0, Pass 1.1
190  */
191 #ifdef THUNDERX_PASS_1_1_ERRATA
192 #define	CPU_MATCH_ERRATA_CAVIUM_THUNDERX_1_1				\
193     (CPU_MATCH(CPU_IMPL_MASK | CPU_PART_MASK | CPU_REV_MASK,		\
194     CPU_IMPL_CAVIUM, CPU_PART_THUNDERX, 0, CPU_REV_THUNDERX_1_0) ||	\
195     CPU_MATCH(CPU_IMPL_MASK | CPU_PART_MASK | CPU_REV_MASK,		\
196     CPU_IMPL_CAVIUM, CPU_PART_THUNDERX, 0, CPU_REV_THUNDERX_1_1))
197 #else
198 #define	CPU_MATCH_ERRATA_CAVIUM_THUNDERX_1_1	0
199 #endif
200 
201 extern char btext[];
202 extern char etext[];
203 
204 extern uint64_t __cpu_affinity[];
205 
206 struct arm64_addr_mask;
207 extern struct arm64_addr_mask elf64_addr_mask;
208 
209 typedef void (*cpu_reset_hook_t)(void);
210 extern cpu_reset_hook_t cpu_reset_hook;
211 
212 void	cpu_halt(void) __dead2;
213 void	cpu_reset(void) __dead2;
214 void	fork_trampoline(void);
215 void	identify_cache(uint64_t);
216 void	identify_cpu(u_int);
217 void	install_cpu_errata(void);
218 
219 /* Pointer Authentication Code (PAC) support */
220 void	ptrauth_init(void);
221 void	ptrauth_fork(struct thread *, struct thread *);
222 void	ptrauth_exec(struct thread *);
223 void	ptrauth_copy_thread(struct thread *, struct thread *);
224 void	ptrauth_thread_alloc(struct thread *);
225 void	ptrauth_thread0(struct thread *);
226 #ifdef SMP
227 void	ptrauth_mp_start(uint64_t);
228 #endif
229 
230 /* Functions to read the sanitised view of the special registers */
231 void	update_special_regs(u_int);
232 bool	extract_user_id_field(u_int, u_int, uint8_t *);
233 bool	get_kernel_reg(u_int, uint64_t *);
234 bool	get_kernel_reg_masked(u_int, uint64_t *, uint64_t);
235 
236 void	cpu_desc_init(void);
237 
238 #define	CPU_AFFINITY(cpu)	__cpu_affinity[(cpu)]
239 #define	CPU_CURRENT_SOCKET				\
240     (CPU_AFF2(CPU_AFFINITY(PCPU_GET(cpuid))))
241 
242 static __inline uint64_t
243 get_cyclecount(void)
244 {
245 	uint64_t ret;
246 
247 	ret = READ_SPECIALREG(cntvct_el0);
248 
249 	return (ret);
250 }
251 
252 #define	ADDRESS_TRANSLATE_FUNC(stage)				\
253 static inline uint64_t						\
254 arm64_address_translate_ ##stage (uint64_t addr)		\
255 {								\
256 	uint64_t ret;						\
257 								\
258 	__asm __volatile(					\
259 	    "at " __STRING(stage) ", %1 \n"			\
260 	    "isb \n"						\
261 	    "mrs %0, par_el1" : "=r"(ret) : "r"(addr));		\
262 								\
263 	return (ret);						\
264 }
265 
266 ADDRESS_TRANSLATE_FUNC(s1e0r)
267 ADDRESS_TRANSLATE_FUNC(s1e0w)
268 ADDRESS_TRANSLATE_FUNC(s1e1r)
269 ADDRESS_TRANSLATE_FUNC(s1e1w)
270 
271 #endif
272 
273 #endif /* !_MACHINE_CPU_H_ */
274 
275 #endif /* !__arm__ */
276