xref: /rk3399_ARM-atf/include/arch/aarch64/arch_helpers.h (revision 79e7aae82dd173d1ccc63e5d553222f1d58f12f5)
1 /*
2  * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.
3  *
4  * SPDX-License-Identifier: BSD-3-Clause
5  */
6 
7 #ifndef ARCH_HELPERS_H
8 #define ARCH_HELPERS_H
9 
10 #include <cdefs.h>
11 #include <stdbool.h>
12 #include <stdint.h>
13 #include <string.h>
14 
15 #include <arch.h>
16 #include <lib/extensions/sysreg128.h>
17 
18 /**********************************************************************
19  * Macros which create inline functions to read or write CPU system
20  * registers
21  *********************************************************************/
22 
23 #define _DEFINE_SYSREG_READ_FUNC(_name, _reg_name)		\
24 static inline u_register_t read_ ## _name(void)			\
25 {								\
26 	u_register_t v;						\
27 	__asm__ volatile ("mrs %0, " #_reg_name : "=r" (v));	\
28 	return v;						\
29 }
30 
31 #define _DEFINE_SYSREG_READ_FUNC_NV(_name, _reg_name)		\
32 static inline u_register_t read_ ## _name(void)			\
33 {								\
34 	u_register_t v;						\
35 	__asm__ ("mrs %0, " #_reg_name : "=r" (v));		\
36 	return v;						\
37 }
38 
39 #define _DEFINE_SYSREG_WRITE_FUNC(_name, _reg_name)			\
40 static inline void write_ ## _name(u_register_t v)			\
41 {									\
42 	__asm__ volatile ("msr " #_reg_name ", %0" : : "r" (v));	\
43 }
44 
45 #define SYSREG_WRITE_CONST(reg_name, v)				\
46 	__asm__ volatile ("msr " #reg_name ", %0" : : "i" (v))
47 
48 /* Define read function for system register */
49 #define DEFINE_SYSREG_READ_FUNC(_name) 			\
50 	_DEFINE_SYSREG_READ_FUNC(_name, _name)
51 
52 /* Define read & write function for system register */
53 #define DEFINE_SYSREG_RW_FUNCS(_name)			\
54 	_DEFINE_SYSREG_READ_FUNC(_name, _name)		\
55 	_DEFINE_SYSREG_WRITE_FUNC(_name, _name)
56 
57 /* Define read & write function for renamed system register */
58 #define DEFINE_RENAME_SYSREG_RW_FUNCS(_name, _reg_name)	\
59 	_DEFINE_SYSREG_READ_FUNC(_name, _reg_name)	\
60 	_DEFINE_SYSREG_WRITE_FUNC(_name, _reg_name)
61 
62 /* Define read function for renamed system register */
63 #define DEFINE_RENAME_SYSREG_READ_FUNC(_name, _reg_name)	\
64 	_DEFINE_SYSREG_READ_FUNC(_name, _reg_name)
65 
66 /* Define write function for renamed system register */
67 #define DEFINE_RENAME_SYSREG_WRITE_FUNC(_name, _reg_name)	\
68 	_DEFINE_SYSREG_WRITE_FUNC(_name, _reg_name)
69 
70 /* Define read function for ID register (w/o volatile qualifier) */
71 #define DEFINE_IDREG_READ_FUNC(_name)			\
72 	_DEFINE_SYSREG_READ_FUNC_NV(_name, _name)
73 
74 /* Define read function for renamed ID register (w/o volatile qualifier) */
75 #define DEFINE_RENAME_IDREG_READ_FUNC(_name, _reg_name)	\
76 	_DEFINE_SYSREG_READ_FUNC_NV(_name, _reg_name)
77 
78 /**********************************************************************
79  * Macros to create inline functions for system instructions
80  *********************************************************************/
81 
82 /* Define function for simple system instruction */
83 #define DEFINE_SYSOP_FUNC(_op)				\
84 static inline void _op(void)				\
85 {							\
86 	__asm__ (#_op);					\
87 }
88 
89 /* Define function for system instruction with register parameter */
90 #define DEFINE_SYSOP_PARAM_FUNC(_op)			\
91 static inline void _op(uint64_t v)			\
92 {							\
93 	 __asm__ (#_op "  %0" : : "r" (v));		\
94 }
95 
96 /* Define function for system instruction with type specifier */
97 #define DEFINE_SYSOP_TYPE_FUNC(_op, _type)		\
98 static inline void _op ## _type(void)			\
99 {							\
100 	__asm__ (#_op " " #_type : : : "memory");			\
101 }
102 
103 /* Define function for system instruction with register parameter */
104 #define DEFINE_SYSOP_TYPE_PARAM_FUNC(_op, _type)	\
105 static inline void _op ## _type(uint64_t v)		\
106 {							\
107 	 __asm__ (#_op " " #_type ", %0" : : "r" (v));	\
108 }
109 
110 /*******************************************************************************
111  * TLB maintenance accessor prototypes
112  ******************************************************************************/
113 
114 #if ERRATA_A57_813419 || ERRATA_A76_1286807
115 /*
116  * Define function for TLBI instruction with type specifier that implements
117  * the workaround for errata 813419 of Cortex-A57 or errata 1286807 of
118  * Cortex-A76.
119  */
120 #define DEFINE_TLBIOP_ERRATA_TYPE_FUNC(_type)\
121 static inline void tlbi ## _type(void)			\
122 {							\
123 	__asm__("tlbi " #_type "\n"			\
124 		"dsb ish\n"				\
125 		"tlbi " #_type);			\
126 }
127 
128 /*
129  * Define function for TLBI instruction with register parameter that implements
130  * the workaround for errata 813419 of Cortex-A57 or errata 1286807 of
131  * Cortex-A76.
132  */
133 #define DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(_type)	\
134 static inline void tlbi ## _type(uint64_t v)			\
135 {								\
136 	__asm__("tlbi " #_type ", %0\n"				\
137 		"dsb ish\n"					\
138 		"tlbi " #_type ", %0" : : "r" (v));		\
139 }
140 #endif /* ERRATA_A57_813419 */
141 
142 #if ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319
143 /*
144  * Define function for DC instruction with register parameter that enables
145  * the workaround for errata 819472, 824069 and 827319 of Cortex-A53.
146  */
147 #define DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(_name, _type)	\
148 static inline void dc ## _name(uint64_t v)			\
149 {								\
150 	__asm__("dc " #_type ", %0" : : "r" (v));		\
151 }
152 #endif /* ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319 */
153 
154 #if ERRATA_A57_813419
155 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1)
156 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1is)
157 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2)
158 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2is)
159 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3)
160 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3is)
161 DEFINE_SYSOP_TYPE_FUNC(tlbi, vmalle1)
162 #elif ERRATA_A76_1286807
163 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle1)
164 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle1is)
165 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle2)
166 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle2is)
167 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3)
168 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3is)
169 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(vmalle1)
170 #else
171 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1)
172 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1is)
173 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2)
174 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2is)
175 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle3)
176 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle3is)
177 DEFINE_SYSOP_TYPE_FUNC(tlbi, vmalle1)
178 #endif
179 
180 #if ERRATA_A57_813419
181 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaae1is)
182 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaale1is)
183 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vae2is)
184 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vale2is)
185 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vae3is)
186 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vale3is)
187 #elif ERRATA_A76_1286807
188 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vaae1is)
189 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vaale1is)
190 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vae2is)
191 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vale2is)
192 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vae3is)
193 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vale3is)
194 #else
195 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaae1is)
196 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaale1is)
197 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vae2is)
198 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vale2is)
199 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vae3is)
200 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vale3is)
201 #endif
202 
203 /*******************************************************************************
204  * Cache maintenance accessor prototypes
205  ******************************************************************************/
206 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, isw)
207 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, cisw)
208 #if ERRATA_A53_827319
209 DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(csw, cisw)
210 #else
211 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, csw)
212 #endif
213 #if ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319
214 DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(cvac, civac)
215 #else
216 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, cvac)
217 #endif
218 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, ivac)
219 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, civac)
220 #if ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319
221 DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(cvau, civac)
222 #else
223 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, cvau)
224 #endif
225 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, zva)
226 
227 /*******************************************************************************
228  * Address translation accessor prototypes
229  ******************************************************************************/
230 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e1r)
231 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e1w)
232 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e0r)
233 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e0w)
234 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s1e1r)
235 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s1e2r)
236 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s1e3r)
237 
238 /*******************************************************************************
239  * Strip Pointer Authentication Code
240  ******************************************************************************/
241 DEFINE_SYSOP_PARAM_FUNC(xpaci)
242 
243 void flush_dcache_range(uintptr_t addr, size_t size);
244 void flush_dcache_to_popa_range(uintptr_t addr, size_t size);
245 void flush_dcache_to_popa_range_mte2(uintptr_t addr, size_t size);
246 void clean_dcache_range(uintptr_t addr, size_t size);
247 void inv_dcache_range(uintptr_t addr, size_t size);
248 bool is_dcache_enabled(void);
249 
250 void dcsw_op_louis(u_register_t op_type);
251 void dcsw_op_all(u_register_t op_type);
252 
253 void disable_mmu_el1(void);
254 void disable_mmu_el3(void);
255 void disable_mpu_el2(void);
256 void disable_mmu_icache_el1(void);
257 void disable_mmu_icache_el3(void);
258 void disable_mpu_icache_el2(void);
259 
260 /*******************************************************************************
261  * Misc. accessor prototypes
262  ******************************************************************************/
263 
264 #define write_daifclr(val) SYSREG_WRITE_CONST(daifclr, val)
265 #define write_daifset(val) SYSREG_WRITE_CONST(daifset, val)
266 
267 
268 #if ENABLE_FEAT_D128 && !defined(SPD_tspd)
269 /* Don't use mrrs/msrr read/write implementation with tspd,
270  * While using SPD=tspd, tspd compiles with current arch_helpers
271  * thus trying to use mrrs/msrr read/write from Secure-world.
272  * SCR_EL3.D128en is set only for Non-Secure world, which may cause
273  * panic while using mrrs/msrr from tspd secure world.
274  */
275 DECLARE_SYSREG128_RW_FUNCS(par_el1)
276 
277 DECLARE_SYSREG128_RW_FUNCS(ttbr0_el1)
278 DECLARE_SYSREG128_RW_FUNCS(ttbr1_el1)
279 
280 DECLARE_SYSREG128_RW_FUNCS(ttbr0_el2)
281 DECLARE_SYSREG128_RW_FUNCS(ttbr1_el2)
282 DECLARE_SYSREG128_RW_FUNCS(vttbr_el2)
283 
284 /* FEAT_THE Registers */
285 DECLARE_SYSREG128_RW_FUNCS(rcwmask_el1)
286 DECLARE_SYSREG128_RW_FUNCS(rcwsmask_el1)
287 #else
288 DEFINE_SYSREG_RW_FUNCS(par_el1)
289 
290 DEFINE_SYSREG_RW_FUNCS(ttbr0_el1)
291 DEFINE_SYSREG_RW_FUNCS(ttbr1_el1)
292 
293 DEFINE_SYSREG_RW_FUNCS(ttbr0_el2)
294 DEFINE_RENAME_SYSREG_RW_FUNCS(ttbr1_el2, TTBR1_EL2)
295 DEFINE_SYSREG_RW_FUNCS(vttbr_el2)
296 
297 /* FEAT_THE Registers */
298 DEFINE_RENAME_SYSREG_RW_FUNCS(rcwmask_el1, RCWMASK_EL1)
299 DEFINE_RENAME_SYSREG_RW_FUNCS(rcwsmask_el1, RCWSMASK_EL1)
300 
301 #endif /* ENABLE_FEAT_D128 && !defined(SPD_tspd) */
302 
303 DEFINE_IDREG_READ_FUNC(id_pfr1_el1)
304 DEFINE_IDREG_READ_FUNC(id_aa64isar0_el1)
305 DEFINE_IDREG_READ_FUNC(id_aa64isar1_el1)
306 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64isar2_el1, ID_AA64ISAR2_EL1)
307 DEFINE_IDREG_READ_FUNC(id_aa64pfr0_el1)
308 DEFINE_IDREG_READ_FUNC(id_aa64pfr1_el1)
309 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64pfr2_el1, ID_AA64PFR2_EL1)
310 DEFINE_IDREG_READ_FUNC(id_aa64dfr0_el1)
311 DEFINE_IDREG_READ_FUNC(id_aa64dfr1_el1)
312 DEFINE_IDREG_READ_FUNC(id_afr0_el1)
313 DEFINE_SYSREG_READ_FUNC(CurrentEl)
314 DEFINE_SYSREG_READ_FUNC(ctr_el0)
315 DEFINE_SYSREG_RW_FUNCS(daif)
316 DEFINE_SYSREG_RW_FUNCS(spsr_el1)
317 DEFINE_SYSREG_RW_FUNCS(spsr_el2)
318 DEFINE_SYSREG_RW_FUNCS(spsr_el3)
319 DEFINE_SYSREG_RW_FUNCS(elr_el1)
320 DEFINE_SYSREG_RW_FUNCS(elr_el2)
321 DEFINE_SYSREG_RW_FUNCS(elr_el3)
322 DEFINE_SYSREG_RW_FUNCS(mdccsr_el0)
323 DEFINE_SYSREG_RW_FUNCS(mdccint_el1)
324 DEFINE_SYSREG_RW_FUNCS(dbgdtrrx_el0)
325 DEFINE_SYSREG_RW_FUNCS(dbgdtrtx_el0)
326 DEFINE_SYSREG_RW_FUNCS(sp_el1)
327 DEFINE_SYSREG_RW_FUNCS(sp_el2)
328 DEFINE_SYSREG_RW_FUNCS(dbgprcr_el1)
329 
330 DEFINE_SYSOP_FUNC(wfi)
331 DEFINE_SYSOP_FUNC(wfe)
332 DEFINE_SYSOP_FUNC(sev)
333 DEFINE_SYSOP_TYPE_FUNC(dsb, sy)
334 DEFINE_SYSOP_TYPE_FUNC(dmb, sy)
335 DEFINE_SYSOP_TYPE_FUNC(dmb, st)
336 DEFINE_SYSOP_TYPE_FUNC(dmb, ld)
337 DEFINE_SYSOP_TYPE_FUNC(dsb, ish)
338 DEFINE_SYSOP_TYPE_FUNC(dsb, osh)
339 DEFINE_SYSOP_TYPE_FUNC(dsb, nsh)
340 DEFINE_SYSOP_TYPE_FUNC(dsb, ishst)
341 DEFINE_SYSOP_TYPE_FUNC(dsb, oshst)
342 DEFINE_SYSOP_TYPE_FUNC(dmb, oshld)
343 DEFINE_SYSOP_TYPE_FUNC(dmb, oshst)
344 DEFINE_SYSOP_TYPE_FUNC(dmb, osh)
345 DEFINE_SYSOP_TYPE_FUNC(dmb, nshld)
346 DEFINE_SYSOP_TYPE_FUNC(dmb, nshst)
347 DEFINE_SYSOP_TYPE_FUNC(dmb, nsh)
348 DEFINE_SYSOP_TYPE_FUNC(dmb, ishld)
349 DEFINE_SYSOP_TYPE_FUNC(dmb, ishst)
350 DEFINE_SYSOP_TYPE_FUNC(dmb, ish)
351 DEFINE_SYSOP_FUNC(isb)
352 
353 static inline void enable_irq(void)
354 {
355 	/*
356 	 * The compiler memory barrier will prevent the compiler from
357 	 * scheduling non-volatile memory access after the write to the
358 	 * register.
359 	 *
360 	 * This could happen if some initialization code issues non-volatile
361 	 * accesses to an area used by an interrupt handler, in the assumption
362 	 * that it is safe as the interrupts are disabled at the time it does
363 	 * that (according to program order). However, non-volatile accesses
364 	 * are not necessarily in program order relatively with volatile inline
365 	 * assembly statements (and volatile accesses).
366 	 */
367 	COMPILER_BARRIER();
368 	write_daifclr(DAIF_IRQ_BIT);
369 	isb();
370 }
371 
372 static inline void enable_fiq(void)
373 {
374 	COMPILER_BARRIER();
375 	write_daifclr(DAIF_FIQ_BIT);
376 	isb();
377 }
378 
379 static inline void enable_serror(void)
380 {
381 	COMPILER_BARRIER();
382 	write_daifclr(DAIF_ABT_BIT);
383 	isb();
384 }
385 
386 static inline void enable_debug_exceptions(void)
387 {
388 	COMPILER_BARRIER();
389 	write_daifclr(DAIF_DBG_BIT);
390 	isb();
391 }
392 
393 static inline void disable_irq(void)
394 {
395 	COMPILER_BARRIER();
396 	write_daifset(DAIF_IRQ_BIT);
397 	isb();
398 }
399 
400 static inline void disable_fiq(void)
401 {
402 	COMPILER_BARRIER();
403 	write_daifset(DAIF_FIQ_BIT);
404 	isb();
405 }
406 
407 static inline void disable_serror(void)
408 {
409 	COMPILER_BARRIER();
410 	write_daifset(DAIF_ABT_BIT);
411 	isb();
412 }
413 
414 static inline void disable_debug_exceptions(void)
415 {
416 	COMPILER_BARRIER();
417 	write_daifset(DAIF_DBG_BIT);
418 	isb();
419 }
420 
421 void __dead2 smc(uint64_t x0, uint64_t x1, uint64_t x2, uint64_t x3,
422 		 uint64_t x4, uint64_t x5, uint64_t x6, uint64_t x7);
423 
424 /*******************************************************************************
425  * System register accessor prototypes
426  ******************************************************************************/
427 DEFINE_IDREG_READ_FUNC(midr_el1)
428 DEFINE_SYSREG_READ_FUNC(mpidr_el1)
429 DEFINE_IDREG_READ_FUNC(id_aa64mmfr0_el1)
430 DEFINE_IDREG_READ_FUNC(id_aa64mmfr1_el1)
431 
432 DEFINE_SYSREG_RW_FUNCS(scr_el3)
433 DEFINE_SYSREG_RW_FUNCS(hcr_el2)
434 
435 DEFINE_SYSREG_RW_FUNCS(vbar_el1)
436 DEFINE_SYSREG_RW_FUNCS(vbar_el2)
437 DEFINE_SYSREG_RW_FUNCS(vbar_el3)
438 
439 DEFINE_SYSREG_RW_FUNCS(sctlr_el1)
440 DEFINE_SYSREG_RW_FUNCS(sctlr_el2)
441 DEFINE_SYSREG_RW_FUNCS(sctlr_el3)
442 
443 DEFINE_SYSREG_RW_FUNCS(actlr_el1)
444 DEFINE_SYSREG_RW_FUNCS(actlr_el2)
445 DEFINE_SYSREG_RW_FUNCS(actlr_el3)
446 
447 DEFINE_SYSREG_RW_FUNCS(esr_el1)
448 DEFINE_SYSREG_RW_FUNCS(esr_el2)
449 DEFINE_SYSREG_RW_FUNCS(esr_el3)
450 
451 DEFINE_SYSREG_RW_FUNCS(afsr0_el1)
452 DEFINE_SYSREG_RW_FUNCS(afsr0_el2)
453 DEFINE_SYSREG_RW_FUNCS(afsr0_el3)
454 
455 DEFINE_SYSREG_RW_FUNCS(afsr1_el1)
456 DEFINE_SYSREG_RW_FUNCS(afsr1_el2)
457 DEFINE_SYSREG_RW_FUNCS(afsr1_el3)
458 
459 DEFINE_SYSREG_RW_FUNCS(far_el1)
460 DEFINE_SYSREG_RW_FUNCS(far_el2)
461 DEFINE_SYSREG_RW_FUNCS(far_el3)
462 
463 DEFINE_SYSREG_RW_FUNCS(mair_el1)
464 DEFINE_SYSREG_RW_FUNCS(mair_el2)
465 DEFINE_SYSREG_RW_FUNCS(mair_el3)
466 
467 DEFINE_SYSREG_RW_FUNCS(amair_el1)
468 DEFINE_SYSREG_RW_FUNCS(amair_el2)
469 DEFINE_SYSREG_RW_FUNCS(amair_el3)
470 
471 DEFINE_SYSREG_READ_FUNC(rvbar_el1)
472 DEFINE_SYSREG_READ_FUNC(rvbar_el2)
473 DEFINE_SYSREG_READ_FUNC(rvbar_el3)
474 
475 DEFINE_SYSREG_RW_FUNCS(rmr_el1)
476 DEFINE_SYSREG_RW_FUNCS(rmr_el2)
477 DEFINE_SYSREG_RW_FUNCS(rmr_el3)
478 
479 DEFINE_SYSREG_RW_FUNCS(tcr_el1)
480 DEFINE_SYSREG_RW_FUNCS(tcr_el2)
481 DEFINE_SYSREG_RW_FUNCS(tcr_el3)
482 
483 DEFINE_SYSREG_RW_FUNCS(ttbr0_el3)
484 
485 DEFINE_SYSREG_RW_FUNCS(cptr_el2)
486 DEFINE_SYSREG_RW_FUNCS(cptr_el3)
487 
488 DEFINE_SYSREG_RW_FUNCS(cpacr_el1)
489 DEFINE_SYSREG_RW_FUNCS(cntfrq_el0)
490 DEFINE_SYSREG_RW_FUNCS(cnthp_ctl_el2)
491 DEFINE_SYSREG_RW_FUNCS(cnthp_tval_el2)
492 DEFINE_SYSREG_RW_FUNCS(cnthp_cval_el2)
493 DEFINE_SYSREG_RW_FUNCS(cntps_ctl_el1)
494 DEFINE_SYSREG_RW_FUNCS(cntps_tval_el1)
495 DEFINE_SYSREG_RW_FUNCS(cntps_cval_el1)
496 DEFINE_SYSREG_RW_FUNCS(cntp_ctl_el0)
497 DEFINE_SYSREG_RW_FUNCS(cntp_tval_el0)
498 DEFINE_SYSREG_RW_FUNCS(cntp_cval_el0)
499 DEFINE_SYSREG_READ_FUNC(cntpct_el0)
500 DEFINE_SYSREG_RW_FUNCS(cnthctl_el2)
501 DEFINE_SYSREG_RW_FUNCS(cntv_ctl_el0)
502 DEFINE_SYSREG_RW_FUNCS(cntv_cval_el0)
503 DEFINE_SYSREG_RW_FUNCS(cntkctl_el1)
504 
505 DEFINE_SYSREG_RW_FUNCS(vtcr_el2)
506 
507 #define get_cntp_ctl_enable(x)  (((x) >> CNTP_CTL_ENABLE_SHIFT) & \
508 					CNTP_CTL_ENABLE_MASK)
509 #define get_cntp_ctl_imask(x)   (((x) >> CNTP_CTL_IMASK_SHIFT) & \
510 					CNTP_CTL_IMASK_MASK)
511 #define get_cntp_ctl_istatus(x) (((x) >> CNTP_CTL_ISTATUS_SHIFT) & \
512 					CNTP_CTL_ISTATUS_MASK)
513 
514 #define set_cntp_ctl_enable(x)  ((x) |= (U(1) << CNTP_CTL_ENABLE_SHIFT))
515 #define set_cntp_ctl_imask(x)   ((x) |= (U(1) << CNTP_CTL_IMASK_SHIFT))
516 
517 #define clr_cntp_ctl_enable(x)  ((x) &= ~(U(1) << CNTP_CTL_ENABLE_SHIFT))
518 #define clr_cntp_ctl_imask(x)   ((x) &= ~(U(1) << CNTP_CTL_IMASK_SHIFT))
519 
520 DEFINE_SYSREG_RW_FUNCS(tpidr_el0)
521 DEFINE_SYSREG_RW_FUNCS(tpidr_el1)
522 DEFINE_SYSREG_RW_FUNCS(tpidr_el2)
523 DEFINE_SYSREG_RW_FUNCS(tpidr_el3)
524 
525 DEFINE_SYSREG_RW_FUNCS(cntvoff_el2)
526 
527 DEFINE_SYSREG_RW_FUNCS(vpidr_el2)
528 DEFINE_SYSREG_RW_FUNCS(vmpidr_el2)
529 
530 DEFINE_SYSREG_RW_FUNCS(hacr_el2)
531 DEFINE_SYSREG_RW_FUNCS(hpfar_el2)
532 
533 DEFINE_SYSREG_RW_FUNCS(dbgvcr32_el2)
534 DEFINE_RENAME_SYSREG_RW_FUNCS(ich_hcr_el2, ICH_HCR_EL2)
535 DEFINE_RENAME_SYSREG_RW_FUNCS(ich_vmcr_el2, ICH_VMCR_EL2)
536 
537 DEFINE_SYSREG_READ_FUNC(isr_el1)
538 
539 DEFINE_SYSREG_RW_FUNCS(mdscr_el1)
540 DEFINE_SYSREG_RW_FUNCS(mdcr_el2)
541 DEFINE_SYSREG_RW_FUNCS(mdcr_el3)
542 DEFINE_SYSREG_RW_FUNCS(hstr_el2)
543 DEFINE_SYSREG_RW_FUNCS(pmcr_el0)
544 
545 DEFINE_SYSREG_RW_FUNCS(csselr_el1)
546 DEFINE_SYSREG_RW_FUNCS(tpidrro_el0)
547 DEFINE_SYSREG_RW_FUNCS(contextidr_el1)
548 DEFINE_SYSREG_RW_FUNCS(spsr_abt)
549 DEFINE_SYSREG_RW_FUNCS(spsr_und)
550 DEFINE_SYSREG_RW_FUNCS(spsr_irq)
551 DEFINE_SYSREG_RW_FUNCS(spsr_fiq)
552 DEFINE_SYSREG_RW_FUNCS(dacr32_el2)
553 DEFINE_SYSREG_RW_FUNCS(ifsr32_el2)
554 
555 /* GICv3 System Registers */
556 
557 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el1, ICC_SRE_EL1)
558 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el2, ICC_SRE_EL2)
559 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el3, ICC_SRE_EL3)
560 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_pmr_el1, ICC_PMR_EL1)
561 DEFINE_RENAME_SYSREG_READ_FUNC(icc_rpr_el1, ICC_RPR_EL1)
562 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen1_el3, ICC_IGRPEN1_EL3)
563 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen1_el1, ICC_IGRPEN1_EL1)
564 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen0_el1, ICC_IGRPEN0_EL1)
565 DEFINE_RENAME_SYSREG_READ_FUNC(icc_hppir0_el1, ICC_HPPIR0_EL1)
566 DEFINE_RENAME_SYSREG_READ_FUNC(icc_hppir1_el1, ICC_HPPIR1_EL1)
567 DEFINE_RENAME_SYSREG_READ_FUNC(icc_iar0_el1, ICC_IAR0_EL1)
568 DEFINE_RENAME_SYSREG_READ_FUNC(icc_iar1_el1, ICC_IAR1_EL1)
569 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_eoir0_el1, ICC_EOIR0_EL1)
570 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_eoir1_el1, ICC_EOIR1_EL1)
571 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_sgi0r_el1, ICC_SGI0R_EL1)
572 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sgi1r, ICC_SGI1R)
573 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_asgi1r, ICC_ASGI1R)
574 
575 DEFINE_RENAME_SYSREG_READ_FUNC(amcfgr_el0, AMCFGR_EL0)
576 DEFINE_RENAME_SYSREG_READ_FUNC(amcgcr_el0, AMCGCR_EL0)
577 DEFINE_RENAME_SYSREG_READ_FUNC(amcg1idr_el0, AMCG1IDR_EL0)
578 DEFINE_RENAME_SYSREG_RW_FUNCS(amcr_el0, AMCR_EL0)
579 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenclr0_el0, AMCNTENCLR0_EL0)
580 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenset0_el0, AMCNTENSET0_EL0)
581 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenclr1_el0, AMCNTENCLR1_EL0)
582 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenset1_el0, AMCNTENSET1_EL0)
583 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr00_el0, AMEVCNTR00_EL0);
584 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr01_el0, AMEVCNTR01_EL0);
585 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr02_el0, AMEVCNTR02_EL0);
586 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr03_el0, AMEVCNTR03_EL0);
587 
588 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr10_el0, AMEVCNTR10_EL0);
589 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr11_el0, AMEVCNTR11_EL0);
590 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr12_el0, AMEVCNTR12_EL0);
591 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr13_el0, AMEVCNTR13_EL0);
592 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr14_el0, AMEVCNTR14_EL0);
593 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr15_el0, AMEVCNTR15_EL0);
594 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr16_el0, AMEVCNTR16_EL0);
595 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr17_el0, AMEVCNTR17_EL0);
596 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr18_el0, AMEVCNTR18_EL0);
597 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr19_el0, AMEVCNTR19_EL0);
598 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1a_el0, AMEVCNTR1A_EL0);
599 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1b_el0, AMEVCNTR1B_EL0);
600 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1c_el0, AMEVCNTR1C_EL0);
601 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1d_el0, AMEVCNTR1D_EL0);
602 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1e_el0, AMEVCNTR1E_EL0);
603 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1f_el0, AMEVCNTR1F_EL0);
604 
605 DEFINE_RENAME_SYSREG_RW_FUNCS(pmblimitr_el1, PMBLIMITR_EL1)
606 
607 DEFINE_RENAME_SYSREG_WRITE_FUNC(zcr_el3, ZCR_EL3)
608 DEFINE_RENAME_SYSREG_WRITE_FUNC(zcr_el2, ZCR_EL2)
609 
610 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64smfr0_el1, ID_AA64SMFR0_EL1)
611 DEFINE_RENAME_SYSREG_RW_FUNCS(smcr_el3, SMCR_EL3)
612 DEFINE_RENAME_SYSREG_RW_FUNCS(svcr, SVCR)
613 
614 DEFINE_RENAME_SYSREG_READ_FUNC(erridr_el1, ERRIDR_EL1)
615 DEFINE_RENAME_SYSREG_WRITE_FUNC(errselr_el1, ERRSELR_EL1)
616 
617 DEFINE_RENAME_SYSREG_READ_FUNC(erxfr_el1, ERXFR_EL1)
618 DEFINE_RENAME_SYSREG_RW_FUNCS(erxctlr_el1, ERXCTLR_EL1)
619 DEFINE_RENAME_SYSREG_RW_FUNCS(erxstatus_el1, ERXSTATUS_EL1)
620 DEFINE_RENAME_SYSREG_READ_FUNC(erxaddr_el1, ERXADDR_EL1)
621 DEFINE_RENAME_SYSREG_READ_FUNC(erxmisc0_el1, ERXMISC0_EL1)
622 DEFINE_RENAME_SYSREG_READ_FUNC(erxmisc1_el1, ERXMISC1_EL1)
623 
624 DEFINE_RENAME_SYSREG_RW_FUNCS(scxtnum_el2, SCXTNUM_EL2)
625 DEFINE_RENAME_SYSREG_RW_FUNCS(scxtnum_el1, SCXTNUM_EL1)
626 DEFINE_RENAME_SYSREG_RW_FUNCS(scxtnum_el0, SCXTNUM_EL0)
627 
628 /* Armv8.1 VHE Registers */
629 DEFINE_RENAME_SYSREG_RW_FUNCS(contextidr_el2, CONTEXTIDR_EL2)
630 
631 /* Armv8.2 ID Registers */
632 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64mmfr2_el1, ID_AA64MMFR2_EL1)
633 
634 /* Armv8.2 RAS Registers */
635 DEFINE_RENAME_SYSREG_RW_FUNCS(disr_el1, DISR_EL1)
636 DEFINE_RENAME_SYSREG_RW_FUNCS(vdisr_el2, VDISR_EL2)
637 DEFINE_RENAME_SYSREG_RW_FUNCS(vsesr_el2, VSESR_EL2)
638 
639 /* Armv8.2 MPAM Registers */
640 DEFINE_RENAME_SYSREG_READ_FUNC(mpamidr_el1, MPAMIDR_EL1)
641 DEFINE_RENAME_SYSREG_RW_FUNCS(mpam3_el3, MPAM3_EL3)
642 DEFINE_RENAME_SYSREG_RW_FUNCS(mpam2_el2, MPAM2_EL2)
643 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamhcr_el2, MPAMHCR_EL2)
644 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm0_el2, MPAMVPM0_EL2)
645 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm1_el2, MPAMVPM1_EL2)
646 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm2_el2, MPAMVPM2_EL2)
647 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm3_el2, MPAMVPM3_EL2)
648 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm4_el2, MPAMVPM4_EL2)
649 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm5_el2, MPAMVPM5_EL2)
650 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm6_el2, MPAMVPM6_EL2)
651 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm7_el2, MPAMVPM7_EL2)
652 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpmv_el2, MPAMVPMV_EL2)
653 
654 /* Armv8.3 Pointer Authentication Registers */
655 DEFINE_RENAME_SYSREG_RW_FUNCS(apiakeyhi_el1, APIAKeyHi_EL1)
656 DEFINE_RENAME_SYSREG_RW_FUNCS(apiakeylo_el1, APIAKeyLo_EL1)
657 
658 /* Armv8.4 Data Independent Timing Register */
659 DEFINE_RENAME_SYSREG_RW_FUNCS(dit, DIT)
660 
661 /* Armv8.4 FEAT_TRF Register */
662 DEFINE_RENAME_SYSREG_RW_FUNCS(trfcr_el2, TRFCR_EL2)
663 DEFINE_RENAME_SYSREG_RW_FUNCS(trfcr_el1, TRFCR_EL1)
664 DEFINE_RENAME_SYSREG_RW_FUNCS(vncr_el2, VNCR_EL2)
665 
666 /* Armv8.5 MTE Registers */
667 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsre0_el1, TFSRE0_EL1)
668 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsr_el1, TFSR_EL1)
669 DEFINE_RENAME_SYSREG_RW_FUNCS(rgsr_el1, RGSR_EL1)
670 DEFINE_RENAME_SYSREG_RW_FUNCS(gcr_el1, GCR_EL1)
671 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsr_el2, TFSR_EL2)
672 
673 /* Armv8.5 FEAT_RNG Registers */
674 DEFINE_RENAME_SYSREG_READ_FUNC(rndr, RNDR)
675 DEFINE_RENAME_SYSREG_READ_FUNC(rndrrs, RNDRRS)
676 
677 /* Armv8.6 FEAT_FGT Registers */
678 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgrtr_el2, HDFGRTR_EL2)
679 DEFINE_RENAME_SYSREG_RW_FUNCS(hafgrtr_el2, HAFGRTR_EL2)
680 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgwtr_el2, HDFGWTR_EL2)
681 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgitr_el2, HFGITR_EL2)
682 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgrtr_el2, HFGRTR_EL2)
683 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgwtr_el2, HFGWTR_EL2)
684 
685 /* ARMv8.6 FEAT_ECV Register */
686 DEFINE_RENAME_SYSREG_RW_FUNCS(cntpoff_el2, CNTPOFF_EL2)
687 
688 /* FEAT_HCX Register */
689 DEFINE_RENAME_SYSREG_RW_FUNCS(hcrx_el2, HCRX_EL2)
690 
691 /* Armv8.9 system registers */
692 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64mmfr3_el1, ID_AA64MMFR3_EL1)
693 
694 /* Armv8.9 FEAT_FGT2 Registers */
695 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgrtr2_el2, HDFGRTR2_EL2)
696 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgwtr2_el2, HDFGWTR2_EL2)
697 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgitr2_el2, HFGITR2_EL2)
698 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgrtr2_el2, HFGRTR2_EL2)
699 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgwtr2_el2, HFGWTR2_EL2)
700 
701 /* FEAT_TCR2 Register */
702 DEFINE_RENAME_SYSREG_RW_FUNCS(tcr2_el1, TCR2_EL1)
703 DEFINE_RENAME_SYSREG_RW_FUNCS(tcr2_el2, TCR2_EL2)
704 
705 /* FEAT_SxPIE Registers */
706 DEFINE_RENAME_SYSREG_RW_FUNCS(pire0_el1, PIRE0_EL1)
707 DEFINE_RENAME_SYSREG_RW_FUNCS(pire0_el2, PIRE0_EL2)
708 DEFINE_RENAME_SYSREG_RW_FUNCS(pir_el1, PIR_EL1)
709 DEFINE_RENAME_SYSREG_RW_FUNCS(pir_el2, PIR_EL2)
710 DEFINE_RENAME_SYSREG_RW_FUNCS(s2pir_el2, S2PIR_EL2)
711 
712 /* FEAT_SxPOE Registers */
713 DEFINE_RENAME_SYSREG_RW_FUNCS(por_el1, POR_EL1)
714 DEFINE_RENAME_SYSREG_RW_FUNCS(por_el2, POR_EL2)
715 DEFINE_RENAME_SYSREG_RW_FUNCS(s2por_el1, S2POR_EL1)
716 
717 /* FEAT_GCS Registers */
718 DEFINE_RENAME_SYSREG_RW_FUNCS(gcscr_el2, GCSCR_EL2)
719 DEFINE_RENAME_SYSREG_RW_FUNCS(gcspr_el2, GCSPR_EL2)
720 DEFINE_RENAME_SYSREG_RW_FUNCS(gcscr_el1, GCSCR_EL1)
721 DEFINE_RENAME_SYSREG_RW_FUNCS(gcscre0_el1, GCSCRE0_EL1)
722 DEFINE_RENAME_SYSREG_RW_FUNCS(gcspr_el1, GCSPR_EL1)
723 DEFINE_RENAME_SYSREG_RW_FUNCS(gcspr_el0, GCSPR_EL0)
724 
725 /* FEAT_SCTLR2 Registers */
726 DEFINE_RENAME_SYSREG_RW_FUNCS(sctlr2_el1, SCTLR2_EL1)
727 DEFINE_RENAME_SYSREG_RW_FUNCS(sctlr2_el2, SCTLR2_EL2)
728 
729 /* FEAT_LS64_ACCDATA Registers */
730 DEFINE_RENAME_SYSREG_RW_FUNCS(accdata_el1, ACCDATA_EL1)
731 
732 /* DynamIQ Control registers */
733 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpwrdn_el1, CLUSTERPWRDN_EL1)
734 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmcr_el1, CLUSTERPMCR_EL1)
735 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmcntenset_el1, CLUSTERPMCNTENSET_EL1)
736 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmccntr_el1, CLUSTERPMCCNTR_EL1)
737 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmovsset_el1, CLUSTERPMOVSSET_EL1)
738 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmovsclr_el1, CLUSTERPMOVSCLR_EL1)
739 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmselr_el1, CLUSTERPMSELR_EL1)
740 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmxevcntr_el1, CLUSTERPMXEVCNTR_EL1)
741 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmxevtyper_el1, CLUSTERPMXEVTYPER_EL1)
742 
743 /* CPU Power/Performance Management registers */
744 DEFINE_RENAME_SYSREG_RW_FUNCS(cpuppmcr_el3, CPUPPMCR_EL3)
745 DEFINE_RENAME_SYSREG_RW_FUNCS(cpumpmmcr_el3, CPUMPMMCR_EL3)
746 
747 /* Armv9.1 FEAT_BRBE Registers */
748 DEFINE_RENAME_SYSREG_RW_FUNCS(brbcr_el2, BRBCR_EL2)
749 
750 /* Armv9.2 RME Registers */
751 DEFINE_RENAME_SYSREG_RW_FUNCS(gptbr_el3, GPTBR_EL3)
752 DEFINE_RENAME_SYSREG_RW_FUNCS(gpccr_el3, GPCCR_EL3)
753 
754 DEFINE_RENAME_SYSREG_RW_FUNCS(fpmr, FPMR)
755 
756 #define IS_IN_EL(x) \
757 	(GET_EL(read_CurrentEl()) == MODE_EL##x)
758 
759 #define IS_IN_EL1() IS_IN_EL(1)
760 #define IS_IN_EL2() IS_IN_EL(2)
761 #define IS_IN_EL3() IS_IN_EL(3)
762 
763 static inline unsigned int get_current_el(void)
764 {
765 	return GET_EL(read_CurrentEl());
766 }
767 
768 static inline unsigned int get_current_el_maybe_constant(void)
769 {
770 #if defined(IMAGE_AT_EL1)
771 	return 1;
772 #elif defined(IMAGE_AT_EL2)
773 	return 2;	/* no use-case in TF-A */
774 #elif defined(IMAGE_AT_EL3)
775 	return 3;
776 #else
777 	/*
778 	 * If we do not know which exception level this is being built for
779 	 * (e.g. built for library), fall back to run-time detection.
780 	 */
781 	return get_current_el();
782 #endif
783 }
784 
785 /*
786  * Check if an EL is implemented from AA64PFR0 register fields.
787  */
788 static inline uint64_t el_implemented(unsigned int el)
789 {
790 	if (el > 3U) {
791 		return EL_IMPL_NONE;
792 	} else {
793 		unsigned int shift = ID_AA64PFR0_EL1_SHIFT * el;
794 
795 		return (read_id_aa64pfr0_el1() >> shift) & ID_AA64PFR0_ELX_MASK;
796 	}
797 }
798 
799 /*
800  * TLBI PAALLOS instruction
801  * (TLB Invalidate GPT Information by PA, All Entries, Outer Shareable)
802  */
803 static inline void tlbipaallos(void)
804 {
805 	__asm__("sys #6, c8, c1, #4");
806 }
807 
808 /*
809  * TLBI RPALOS instructions
810  * (TLB Range Invalidate GPT Information by PA, Last level, Outer Shareable)
811  *
812  * command SIZE, bits [47:44] field:
813  * 0b0000	4KB
814  * 0b0001	16KB
815  * 0b0010	64KB
816  * 0b0011	2MB
817  * 0b0100	32MB
818  * 0b0101	512MB
819  * 0b0110	1GB
820  * 0b0111	16GB
821  * 0b1000	64GB
822  * 0b1001	512GB
823  */
824 #define TLBI_SZ_4K		0UL
825 #define TLBI_SZ_16K		1UL
826 #define TLBI_SZ_64K		2UL
827 #define TLBI_SZ_2M		3UL
828 #define TLBI_SZ_32M		4UL
829 #define TLBI_SZ_512M		5UL
830 #define TLBI_SZ_1G		6UL
831 #define TLBI_SZ_16G		7UL
832 #define TLBI_SZ_64G		8UL
833 #define TLBI_SZ_512G		9UL
834 
835 #define	TLBI_ADDR_SHIFT		U(12)
836 #define	TLBI_SIZE_SHIFT		U(44)
837 
838 #define TLBIRPALOS(_addr, _size)				\
839 {								\
840 	u_register_t arg = ((_addr) >> TLBI_ADDR_SHIFT) |	\
841 			   ((_size) << TLBI_SIZE_SHIFT);	\
842 	__asm__("sys #6, c8, c4, #7, %0" : : "r" (arg));	\
843 }
844 
845 /* Note: addr must be aligned to 4KB */
846 static inline void tlbirpalos_4k(uintptr_t addr)
847 {
848 	TLBIRPALOS(addr, TLBI_SZ_4K);
849 }
850 
851 /* Note: addr must be aligned to 16KB */
852 static inline void tlbirpalos_16k(uintptr_t addr)
853 {
854 	TLBIRPALOS(addr, TLBI_SZ_16K);
855 }
856 
857 /* Note: addr must be aligned to 64KB */
858 static inline void tlbirpalos_64k(uintptr_t addr)
859 {
860 	TLBIRPALOS(addr, TLBI_SZ_64K);
861 }
862 
863 /* Note: addr must be aligned to 2MB */
864 static inline void tlbirpalos_2m(uintptr_t addr)
865 {
866 	TLBIRPALOS(addr, TLBI_SZ_2M);
867 }
868 
869 /* Note: addr must be aligned to 32MB */
870 static inline void tlbirpalos_32m(uintptr_t addr)
871 {
872 	TLBIRPALOS(addr, TLBI_SZ_32M);
873 }
874 
875 /* Note: addr must be aligned to 512MB */
876 static inline void tlbirpalos_512m(uintptr_t addr)
877 {
878 	TLBIRPALOS(addr, TLBI_SZ_512M);
879 }
880 
881 /* Previously defined accessor functions with incomplete register names  */
882 
883 #define read_current_el()	read_CurrentEl()
884 
885 #define dsb()			dsbsy()
886 
887 #define read_midr()		read_midr_el1()
888 
889 #define read_mpidr()		read_mpidr_el1()
890 
891 #define read_scr()		read_scr_el3()
892 #define write_scr(_v)		write_scr_el3(_v)
893 
894 #define read_hcr()		read_hcr_el2()
895 #define write_hcr(_v)		write_hcr_el2(_v)
896 
897 #define read_cpacr()		read_cpacr_el1()
898 #define write_cpacr(_v)		write_cpacr_el1(_v)
899 
900 #define read_clusterpwrdn()		read_clusterpwrdn_el1()
901 #define write_clusterpwrdn(_v)		write_clusterpwrdn_el1(_v)
902 
903 #define read_clusterpmcr()		read_clusterpmcr_el1()
904 #define write_clusterpmcr(_v)		write_clusterpmcr_el1(_v)
905 
906 #define read_clusterpmcntenset()	read_clusterpmcntenset_el1()
907 #define write_clusterpmcntenset(_v)	write_clusterpmcntenset_el1(_v)
908 
909 #define read_clusterpmccntr()		read_clusterpmccntr_el1()
910 #define write_clusterpmccntr(_v)	write_clusterpmccntr_el1(_v)
911 
912 #define read_clusterpmovsset()		read_clusterpmovsset_el1()
913 #define write_clusterpmovsset(_v)	write_clusterpmovsset_el1(_v)
914 
915 #define read_clusterpmovsclr()		read_clusterpmovsclr_el1()
916 #define write_clusterpmovsclr(_v)	write_clusterpmovsclr_el1(_v)
917 
918 #define read_clusterpmselr()		read_clusterpmselr_el1()
919 #define write_clusterpmselr(_v)		write_clusterpmselr_el1(_v)
920 
921 #define read_clusterpmxevcntr()		read_clusterpmxevcntr_el1()
922 #define write_clusterpmxevcntr(_v)	write_clusterpmxevcntr_el1(_v)
923 
924 #define read_clusterpmxevtyper()	read_clusterpmxevtyper_el1()
925 #define write_clusterpmxevtyper(_v)	write_clusterpmxevtyper_el1(_v)
926 
927 #if ERRATA_SPECULATIVE_AT
928 /*
929  * Assuming SCTLR.M bit is already enabled
930  * 1. Enable page table walk by clearing TCR_EL1.EPDx bits
931  * 2. Execute AT instruction for lower EL1/0
932  * 3. Disable page table walk by setting TCR_EL1.EPDx bits
933  */
934 #define AT(_at_inst, _va)	\
935 {	\
936 	assert((read_sctlr_el1() & SCTLR_M_BIT) != 0ULL);	\
937 	write_tcr_el1(read_tcr_el1() & ~(TCR_EPD0_BIT | TCR_EPD1_BIT));	\
938 	isb();	\
939 	_at_inst(_va);	\
940 	write_tcr_el1(read_tcr_el1() | (TCR_EPD0_BIT | TCR_EPD1_BIT));	\
941 	isb();	\
942 }
943 #else
944 #define AT(_at_inst, _va)	_at_inst(_va)
945 #endif
946 
947 #endif /* ARCH_HELPERS_H */
948