xref: /rk3399_ARM-atf/include/arch/aarch64/arch_helpers.h (revision ed0c801fc69f55103c597dcc29cadf4c7cb7d575)
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 #if ENABLE_FEAT_D128
268 DECLARE_SYSREG128_RW_FUNCS(par_el1)
269 #else
270 DEFINE_SYSREG_RW_FUNCS(par_el1)
271 #endif
272 
273 DEFINE_IDREG_READ_FUNC(id_pfr1_el1)
274 DEFINE_IDREG_READ_FUNC(id_aa64isar0_el1)
275 DEFINE_IDREG_READ_FUNC(id_aa64isar1_el1)
276 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64isar2_el1, ID_AA64ISAR2_EL1)
277 DEFINE_IDREG_READ_FUNC(id_aa64pfr0_el1)
278 DEFINE_IDREG_READ_FUNC(id_aa64pfr1_el1)
279 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64pfr2_el1, ID_AA64PFR2_EL1)
280 DEFINE_IDREG_READ_FUNC(id_aa64dfr0_el1)
281 DEFINE_IDREG_READ_FUNC(id_aa64dfr1_el1)
282 DEFINE_IDREG_READ_FUNC(id_afr0_el1)
283 DEFINE_SYSREG_READ_FUNC(CurrentEl)
284 DEFINE_SYSREG_READ_FUNC(ctr_el0)
285 DEFINE_SYSREG_RW_FUNCS(daif)
286 DEFINE_SYSREG_RW_FUNCS(spsr_el1)
287 DEFINE_SYSREG_RW_FUNCS(spsr_el2)
288 DEFINE_SYSREG_RW_FUNCS(spsr_el3)
289 DEFINE_SYSREG_RW_FUNCS(elr_el1)
290 DEFINE_SYSREG_RW_FUNCS(elr_el2)
291 DEFINE_SYSREG_RW_FUNCS(elr_el3)
292 DEFINE_SYSREG_RW_FUNCS(mdccsr_el0)
293 DEFINE_SYSREG_RW_FUNCS(mdccint_el1)
294 DEFINE_SYSREG_RW_FUNCS(dbgdtrrx_el0)
295 DEFINE_SYSREG_RW_FUNCS(dbgdtrtx_el0)
296 DEFINE_SYSREG_RW_FUNCS(sp_el1)
297 DEFINE_SYSREG_RW_FUNCS(sp_el2)
298 DEFINE_SYSREG_RW_FUNCS(dbgprcr_el1)
299 
300 DEFINE_SYSOP_FUNC(wfi)
301 DEFINE_SYSOP_FUNC(wfe)
302 DEFINE_SYSOP_FUNC(sev)
303 DEFINE_SYSOP_TYPE_FUNC(dsb, sy)
304 DEFINE_SYSOP_TYPE_FUNC(dmb, sy)
305 DEFINE_SYSOP_TYPE_FUNC(dmb, st)
306 DEFINE_SYSOP_TYPE_FUNC(dmb, ld)
307 DEFINE_SYSOP_TYPE_FUNC(dsb, ish)
308 DEFINE_SYSOP_TYPE_FUNC(dsb, osh)
309 DEFINE_SYSOP_TYPE_FUNC(dsb, nsh)
310 DEFINE_SYSOP_TYPE_FUNC(dsb, ishst)
311 DEFINE_SYSOP_TYPE_FUNC(dsb, oshst)
312 DEFINE_SYSOP_TYPE_FUNC(dmb, oshld)
313 DEFINE_SYSOP_TYPE_FUNC(dmb, oshst)
314 DEFINE_SYSOP_TYPE_FUNC(dmb, osh)
315 DEFINE_SYSOP_TYPE_FUNC(dmb, nshld)
316 DEFINE_SYSOP_TYPE_FUNC(dmb, nshst)
317 DEFINE_SYSOP_TYPE_FUNC(dmb, nsh)
318 DEFINE_SYSOP_TYPE_FUNC(dmb, ishld)
319 DEFINE_SYSOP_TYPE_FUNC(dmb, ishst)
320 DEFINE_SYSOP_TYPE_FUNC(dmb, ish)
321 DEFINE_SYSOP_FUNC(isb)
322 
323 static inline void enable_irq(void)
324 {
325 	/*
326 	 * The compiler memory barrier will prevent the compiler from
327 	 * scheduling non-volatile memory access after the write to the
328 	 * register.
329 	 *
330 	 * This could happen if some initialization code issues non-volatile
331 	 * accesses to an area used by an interrupt handler, in the assumption
332 	 * that it is safe as the interrupts are disabled at the time it does
333 	 * that (according to program order). However, non-volatile accesses
334 	 * are not necessarily in program order relatively with volatile inline
335 	 * assembly statements (and volatile accesses).
336 	 */
337 	COMPILER_BARRIER();
338 	write_daifclr(DAIF_IRQ_BIT);
339 	isb();
340 }
341 
342 static inline void enable_fiq(void)
343 {
344 	COMPILER_BARRIER();
345 	write_daifclr(DAIF_FIQ_BIT);
346 	isb();
347 }
348 
349 static inline void enable_serror(void)
350 {
351 	COMPILER_BARRIER();
352 	write_daifclr(DAIF_ABT_BIT);
353 	isb();
354 }
355 
356 static inline void enable_debug_exceptions(void)
357 {
358 	COMPILER_BARRIER();
359 	write_daifclr(DAIF_DBG_BIT);
360 	isb();
361 }
362 
363 static inline void disable_irq(void)
364 {
365 	COMPILER_BARRIER();
366 	write_daifset(DAIF_IRQ_BIT);
367 	isb();
368 }
369 
370 static inline void disable_fiq(void)
371 {
372 	COMPILER_BARRIER();
373 	write_daifset(DAIF_FIQ_BIT);
374 	isb();
375 }
376 
377 static inline void disable_serror(void)
378 {
379 	COMPILER_BARRIER();
380 	write_daifset(DAIF_ABT_BIT);
381 	isb();
382 }
383 
384 static inline void disable_debug_exceptions(void)
385 {
386 	COMPILER_BARRIER();
387 	write_daifset(DAIF_DBG_BIT);
388 	isb();
389 }
390 
391 void __dead2 smc(uint64_t x0, uint64_t x1, uint64_t x2, uint64_t x3,
392 		 uint64_t x4, uint64_t x5, uint64_t x6, uint64_t x7);
393 
394 /*******************************************************************************
395  * System register accessor prototypes
396  ******************************************************************************/
397 DEFINE_IDREG_READ_FUNC(midr_el1)
398 DEFINE_SYSREG_READ_FUNC(mpidr_el1)
399 DEFINE_IDREG_READ_FUNC(id_aa64mmfr0_el1)
400 DEFINE_IDREG_READ_FUNC(id_aa64mmfr1_el1)
401 
402 DEFINE_SYSREG_RW_FUNCS(scr_el3)
403 DEFINE_SYSREG_RW_FUNCS(hcr_el2)
404 
405 DEFINE_SYSREG_RW_FUNCS(vbar_el1)
406 DEFINE_SYSREG_RW_FUNCS(vbar_el2)
407 DEFINE_SYSREG_RW_FUNCS(vbar_el3)
408 
409 DEFINE_SYSREG_RW_FUNCS(sctlr_el1)
410 DEFINE_SYSREG_RW_FUNCS(sctlr_el2)
411 DEFINE_SYSREG_RW_FUNCS(sctlr_el3)
412 
413 DEFINE_SYSREG_RW_FUNCS(actlr_el1)
414 DEFINE_SYSREG_RW_FUNCS(actlr_el2)
415 DEFINE_SYSREG_RW_FUNCS(actlr_el3)
416 
417 DEFINE_SYSREG_RW_FUNCS(esr_el1)
418 DEFINE_SYSREG_RW_FUNCS(esr_el2)
419 DEFINE_SYSREG_RW_FUNCS(esr_el3)
420 
421 DEFINE_SYSREG_RW_FUNCS(afsr0_el1)
422 DEFINE_SYSREG_RW_FUNCS(afsr0_el2)
423 DEFINE_SYSREG_RW_FUNCS(afsr0_el3)
424 
425 DEFINE_SYSREG_RW_FUNCS(afsr1_el1)
426 DEFINE_SYSREG_RW_FUNCS(afsr1_el2)
427 DEFINE_SYSREG_RW_FUNCS(afsr1_el3)
428 
429 DEFINE_SYSREG_RW_FUNCS(far_el1)
430 DEFINE_SYSREG_RW_FUNCS(far_el2)
431 DEFINE_SYSREG_RW_FUNCS(far_el3)
432 
433 DEFINE_SYSREG_RW_FUNCS(mair_el1)
434 DEFINE_SYSREG_RW_FUNCS(mair_el2)
435 DEFINE_SYSREG_RW_FUNCS(mair_el3)
436 
437 DEFINE_SYSREG_RW_FUNCS(amair_el1)
438 DEFINE_SYSREG_RW_FUNCS(amair_el2)
439 DEFINE_SYSREG_RW_FUNCS(amair_el3)
440 
441 DEFINE_SYSREG_READ_FUNC(rvbar_el1)
442 DEFINE_SYSREG_READ_FUNC(rvbar_el2)
443 DEFINE_SYSREG_READ_FUNC(rvbar_el3)
444 
445 DEFINE_SYSREG_RW_FUNCS(rmr_el1)
446 DEFINE_SYSREG_RW_FUNCS(rmr_el2)
447 DEFINE_SYSREG_RW_FUNCS(rmr_el3)
448 
449 DEFINE_SYSREG_RW_FUNCS(tcr_el1)
450 DEFINE_SYSREG_RW_FUNCS(tcr_el2)
451 DEFINE_SYSREG_RW_FUNCS(tcr_el3)
452 
453 #if ENABLE_FEAT_D128
454 DECLARE_SYSREG128_RW_FUNCS(ttbr0_el1)
455 DECLARE_SYSREG128_RW_FUNCS(ttbr1_el1)
456 DECLARE_SYSREG128_RW_FUNCS(ttbr0_el2)
457 DECLARE_SYSREG128_RW_FUNCS(ttbr1_el2)
458 DECLARE_SYSREG128_RW_FUNCS(vttbr_el2)
459 #else
460 DEFINE_SYSREG_RW_FUNCS(ttbr0_el1)
461 DEFINE_SYSREG_RW_FUNCS(ttbr1_el1)
462 DEFINE_SYSREG_RW_FUNCS(ttbr0_el2)
463 DEFINE_RENAME_SYSREG_RW_FUNCS(ttbr1_el2, TTBR1_EL2)
464 DEFINE_SYSREG_RW_FUNCS(vttbr_el2)
465 #endif
466 
467 DEFINE_SYSREG_RW_FUNCS(ttbr0_el3)
468 
469 DEFINE_SYSREG_RW_FUNCS(cptr_el2)
470 DEFINE_SYSREG_RW_FUNCS(cptr_el3)
471 
472 DEFINE_SYSREG_RW_FUNCS(cpacr_el1)
473 DEFINE_SYSREG_RW_FUNCS(cntfrq_el0)
474 DEFINE_SYSREG_RW_FUNCS(cnthp_ctl_el2)
475 DEFINE_SYSREG_RW_FUNCS(cnthp_tval_el2)
476 DEFINE_SYSREG_RW_FUNCS(cnthp_cval_el2)
477 DEFINE_SYSREG_RW_FUNCS(cntps_ctl_el1)
478 DEFINE_SYSREG_RW_FUNCS(cntps_tval_el1)
479 DEFINE_SYSREG_RW_FUNCS(cntps_cval_el1)
480 DEFINE_SYSREG_RW_FUNCS(cntp_ctl_el0)
481 DEFINE_SYSREG_RW_FUNCS(cntp_tval_el0)
482 DEFINE_SYSREG_RW_FUNCS(cntp_cval_el0)
483 DEFINE_SYSREG_READ_FUNC(cntpct_el0)
484 DEFINE_SYSREG_RW_FUNCS(cnthctl_el2)
485 DEFINE_SYSREG_RW_FUNCS(cntv_ctl_el0)
486 DEFINE_SYSREG_RW_FUNCS(cntv_cval_el0)
487 DEFINE_SYSREG_RW_FUNCS(cntkctl_el1)
488 
489 DEFINE_SYSREG_RW_FUNCS(vtcr_el2)
490 
491 #define get_cntp_ctl_enable(x)  (((x) >> CNTP_CTL_ENABLE_SHIFT) & \
492 					CNTP_CTL_ENABLE_MASK)
493 #define get_cntp_ctl_imask(x)   (((x) >> CNTP_CTL_IMASK_SHIFT) & \
494 					CNTP_CTL_IMASK_MASK)
495 #define get_cntp_ctl_istatus(x) (((x) >> CNTP_CTL_ISTATUS_SHIFT) & \
496 					CNTP_CTL_ISTATUS_MASK)
497 
498 #define set_cntp_ctl_enable(x)  ((x) |= (U(1) << CNTP_CTL_ENABLE_SHIFT))
499 #define set_cntp_ctl_imask(x)   ((x) |= (U(1) << CNTP_CTL_IMASK_SHIFT))
500 
501 #define clr_cntp_ctl_enable(x)  ((x) &= ~(U(1) << CNTP_CTL_ENABLE_SHIFT))
502 #define clr_cntp_ctl_imask(x)   ((x) &= ~(U(1) << CNTP_CTL_IMASK_SHIFT))
503 
504 DEFINE_SYSREG_RW_FUNCS(tpidr_el0)
505 DEFINE_SYSREG_RW_FUNCS(tpidr_el1)
506 DEFINE_SYSREG_RW_FUNCS(tpidr_el2)
507 DEFINE_SYSREG_RW_FUNCS(tpidr_el3)
508 
509 DEFINE_SYSREG_RW_FUNCS(cntvoff_el2)
510 
511 DEFINE_SYSREG_RW_FUNCS(vpidr_el2)
512 DEFINE_SYSREG_RW_FUNCS(vmpidr_el2)
513 
514 DEFINE_SYSREG_RW_FUNCS(hacr_el2)
515 DEFINE_SYSREG_RW_FUNCS(hpfar_el2)
516 
517 DEFINE_SYSREG_RW_FUNCS(dbgvcr32_el2)
518 DEFINE_RENAME_SYSREG_RW_FUNCS(ich_hcr_el2, ICH_HCR_EL2)
519 DEFINE_RENAME_SYSREG_RW_FUNCS(ich_vmcr_el2, ICH_VMCR_EL2)
520 
521 DEFINE_SYSREG_READ_FUNC(isr_el1)
522 
523 DEFINE_SYSREG_RW_FUNCS(mdscr_el1)
524 DEFINE_SYSREG_RW_FUNCS(mdcr_el2)
525 DEFINE_SYSREG_RW_FUNCS(mdcr_el3)
526 DEFINE_SYSREG_RW_FUNCS(hstr_el2)
527 DEFINE_SYSREG_RW_FUNCS(pmcr_el0)
528 
529 DEFINE_SYSREG_RW_FUNCS(csselr_el1)
530 DEFINE_SYSREG_RW_FUNCS(tpidrro_el0)
531 DEFINE_SYSREG_RW_FUNCS(contextidr_el1)
532 DEFINE_SYSREG_RW_FUNCS(spsr_abt)
533 DEFINE_SYSREG_RW_FUNCS(spsr_und)
534 DEFINE_SYSREG_RW_FUNCS(spsr_irq)
535 DEFINE_SYSREG_RW_FUNCS(spsr_fiq)
536 DEFINE_SYSREG_RW_FUNCS(dacr32_el2)
537 DEFINE_SYSREG_RW_FUNCS(ifsr32_el2)
538 
539 /* GICv3 System Registers */
540 
541 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el1, ICC_SRE_EL1)
542 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el2, ICC_SRE_EL2)
543 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el3, ICC_SRE_EL3)
544 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_pmr_el1, ICC_PMR_EL1)
545 DEFINE_RENAME_SYSREG_READ_FUNC(icc_rpr_el1, ICC_RPR_EL1)
546 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen1_el3, ICC_IGRPEN1_EL3)
547 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen1_el1, ICC_IGRPEN1_EL1)
548 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen0_el1, ICC_IGRPEN0_EL1)
549 DEFINE_RENAME_SYSREG_READ_FUNC(icc_hppir0_el1, ICC_HPPIR0_EL1)
550 DEFINE_RENAME_SYSREG_READ_FUNC(icc_hppir1_el1, ICC_HPPIR1_EL1)
551 DEFINE_RENAME_SYSREG_READ_FUNC(icc_iar0_el1, ICC_IAR0_EL1)
552 DEFINE_RENAME_SYSREG_READ_FUNC(icc_iar1_el1, ICC_IAR1_EL1)
553 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_eoir0_el1, ICC_EOIR0_EL1)
554 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_eoir1_el1, ICC_EOIR1_EL1)
555 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_sgi0r_el1, ICC_SGI0R_EL1)
556 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sgi1r, ICC_SGI1R)
557 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_asgi1r, ICC_ASGI1R)
558 
559 DEFINE_RENAME_SYSREG_READ_FUNC(amcfgr_el0, AMCFGR_EL0)
560 DEFINE_RENAME_SYSREG_READ_FUNC(amcgcr_el0, AMCGCR_EL0)
561 DEFINE_RENAME_SYSREG_READ_FUNC(amcg1idr_el0, AMCG1IDR_EL0)
562 DEFINE_RENAME_SYSREG_RW_FUNCS(amcr_el0, AMCR_EL0)
563 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenclr0_el0, AMCNTENCLR0_EL0)
564 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenset0_el0, AMCNTENSET0_EL0)
565 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenclr1_el0, AMCNTENCLR1_EL0)
566 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenset1_el0, AMCNTENSET1_EL0)
567 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr00_el0, AMEVCNTR00_EL0);
568 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr01_el0, AMEVCNTR01_EL0);
569 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr02_el0, AMEVCNTR02_EL0);
570 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr03_el0, AMEVCNTR03_EL0);
571 
572 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr10_el0, AMEVCNTR10_EL0);
573 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr11_el0, AMEVCNTR11_EL0);
574 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr12_el0, AMEVCNTR12_EL0);
575 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr13_el0, AMEVCNTR13_EL0);
576 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr14_el0, AMEVCNTR14_EL0);
577 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr15_el0, AMEVCNTR15_EL0);
578 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr16_el0, AMEVCNTR16_EL0);
579 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr17_el0, AMEVCNTR17_EL0);
580 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr18_el0, AMEVCNTR18_EL0);
581 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr19_el0, AMEVCNTR19_EL0);
582 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1a_el0, AMEVCNTR1A_EL0);
583 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1b_el0, AMEVCNTR1B_EL0);
584 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1c_el0, AMEVCNTR1C_EL0);
585 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1d_el0, AMEVCNTR1D_EL0);
586 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1e_el0, AMEVCNTR1E_EL0);
587 DEFINE_RENAME_SYSREG_RW_FUNCS(amevcntr1f_el0, AMEVCNTR1F_EL0);
588 
589 DEFINE_RENAME_SYSREG_RW_FUNCS(pmblimitr_el1, PMBLIMITR_EL1)
590 
591 DEFINE_RENAME_SYSREG_WRITE_FUNC(zcr_el3, ZCR_EL3)
592 DEFINE_RENAME_SYSREG_WRITE_FUNC(zcr_el2, ZCR_EL2)
593 
594 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64smfr0_el1, ID_AA64SMFR0_EL1)
595 DEFINE_RENAME_SYSREG_RW_FUNCS(smcr_el3, SMCR_EL3)
596 DEFINE_RENAME_SYSREG_RW_FUNCS(svcr, SVCR)
597 
598 DEFINE_RENAME_SYSREG_READ_FUNC(erridr_el1, ERRIDR_EL1)
599 DEFINE_RENAME_SYSREG_WRITE_FUNC(errselr_el1, ERRSELR_EL1)
600 
601 DEFINE_RENAME_SYSREG_READ_FUNC(erxfr_el1, ERXFR_EL1)
602 DEFINE_RENAME_SYSREG_RW_FUNCS(erxctlr_el1, ERXCTLR_EL1)
603 DEFINE_RENAME_SYSREG_RW_FUNCS(erxstatus_el1, ERXSTATUS_EL1)
604 DEFINE_RENAME_SYSREG_READ_FUNC(erxaddr_el1, ERXADDR_EL1)
605 DEFINE_RENAME_SYSREG_READ_FUNC(erxmisc0_el1, ERXMISC0_EL1)
606 DEFINE_RENAME_SYSREG_READ_FUNC(erxmisc1_el1, ERXMISC1_EL1)
607 
608 DEFINE_RENAME_SYSREG_RW_FUNCS(scxtnum_el2, SCXTNUM_EL2)
609 DEFINE_RENAME_SYSREG_RW_FUNCS(scxtnum_el1, SCXTNUM_EL1)
610 DEFINE_RENAME_SYSREG_RW_FUNCS(scxtnum_el0, SCXTNUM_EL0)
611 
612 /* Armv8.1 VHE Registers */
613 DEFINE_RENAME_SYSREG_RW_FUNCS(contextidr_el2, CONTEXTIDR_EL2)
614 
615 /* Armv8.2 ID Registers */
616 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64mmfr2_el1, ID_AA64MMFR2_EL1)
617 
618 /* Armv8.2 RAS Registers */
619 DEFINE_RENAME_SYSREG_RW_FUNCS(disr_el1, DISR_EL1)
620 DEFINE_RENAME_SYSREG_RW_FUNCS(vdisr_el2, VDISR_EL2)
621 DEFINE_RENAME_SYSREG_RW_FUNCS(vsesr_el2, VSESR_EL2)
622 
623 /* Armv8.2 MPAM Registers */
624 DEFINE_RENAME_SYSREG_READ_FUNC(mpamidr_el1, MPAMIDR_EL1)
625 DEFINE_RENAME_SYSREG_RW_FUNCS(mpam3_el3, MPAM3_EL3)
626 DEFINE_RENAME_SYSREG_RW_FUNCS(mpam2_el2, MPAM2_EL2)
627 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamhcr_el2, MPAMHCR_EL2)
628 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm0_el2, MPAMVPM0_EL2)
629 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm1_el2, MPAMVPM1_EL2)
630 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm2_el2, MPAMVPM2_EL2)
631 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm3_el2, MPAMVPM3_EL2)
632 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm4_el2, MPAMVPM4_EL2)
633 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm5_el2, MPAMVPM5_EL2)
634 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm6_el2, MPAMVPM6_EL2)
635 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpm7_el2, MPAMVPM7_EL2)
636 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamvpmv_el2, MPAMVPMV_EL2)
637 
638 /* Armv8.3 Pointer Authentication Registers */
639 DEFINE_RENAME_SYSREG_RW_FUNCS(apiakeyhi_el1, APIAKeyHi_EL1)
640 DEFINE_RENAME_SYSREG_RW_FUNCS(apiakeylo_el1, APIAKeyLo_EL1)
641 
642 /* Armv8.4 Data Independent Timing Register */
643 DEFINE_RENAME_SYSREG_RW_FUNCS(dit, DIT)
644 
645 /* Armv8.4 FEAT_TRF Register */
646 DEFINE_RENAME_SYSREG_RW_FUNCS(trfcr_el2, TRFCR_EL2)
647 DEFINE_RENAME_SYSREG_RW_FUNCS(trfcr_el1, TRFCR_EL1)
648 DEFINE_RENAME_SYSREG_RW_FUNCS(vncr_el2, VNCR_EL2)
649 
650 /* Armv8.5 MTE Registers */
651 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsre0_el1, TFSRE0_EL1)
652 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsr_el1, TFSR_EL1)
653 DEFINE_RENAME_SYSREG_RW_FUNCS(rgsr_el1, RGSR_EL1)
654 DEFINE_RENAME_SYSREG_RW_FUNCS(gcr_el1, GCR_EL1)
655 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsr_el2, TFSR_EL2)
656 
657 /* Armv8.5 FEAT_RNG Registers */
658 DEFINE_RENAME_SYSREG_READ_FUNC(rndr, RNDR)
659 DEFINE_RENAME_SYSREG_READ_FUNC(rndrrs, RNDRRS)
660 
661 /* Armv8.6 FEAT_FGT Registers */
662 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgrtr_el2, HDFGRTR_EL2)
663 DEFINE_RENAME_SYSREG_RW_FUNCS(hafgrtr_el2, HAFGRTR_EL2)
664 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgwtr_el2, HDFGWTR_EL2)
665 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgitr_el2, HFGITR_EL2)
666 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgrtr_el2, HFGRTR_EL2)
667 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgwtr_el2, HFGWTR_EL2)
668 
669 /* ARMv8.6 FEAT_ECV Register */
670 DEFINE_RENAME_SYSREG_RW_FUNCS(cntpoff_el2, CNTPOFF_EL2)
671 
672 /* FEAT_HCX Register */
673 DEFINE_RENAME_SYSREG_RW_FUNCS(hcrx_el2, HCRX_EL2)
674 
675 /* Armv8.9 system registers */
676 DEFINE_RENAME_IDREG_READ_FUNC(id_aa64mmfr3_el1, ID_AA64MMFR3_EL1)
677 
678 /* Armv8.9 FEAT_FGT2 Registers */
679 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgrtr2_el2, HDFGRTR2_EL2)
680 DEFINE_RENAME_SYSREG_RW_FUNCS(hdfgwtr2_el2, HDFGWTR2_EL2)
681 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgitr2_el2, HFGITR2_EL2)
682 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgrtr2_el2, HFGRTR2_EL2)
683 DEFINE_RENAME_SYSREG_RW_FUNCS(hfgwtr2_el2, HFGWTR2_EL2)
684 
685 /* FEAT_TCR2 Register */
686 DEFINE_RENAME_SYSREG_RW_FUNCS(tcr2_el1, TCR2_EL1)
687 DEFINE_RENAME_SYSREG_RW_FUNCS(tcr2_el2, TCR2_EL2)
688 
689 /* FEAT_SxPIE Registers */
690 DEFINE_RENAME_SYSREG_RW_FUNCS(pire0_el1, PIRE0_EL1)
691 DEFINE_RENAME_SYSREG_RW_FUNCS(pire0_el2, PIRE0_EL2)
692 DEFINE_RENAME_SYSREG_RW_FUNCS(pir_el1, PIR_EL1)
693 DEFINE_RENAME_SYSREG_RW_FUNCS(pir_el2, PIR_EL2)
694 DEFINE_RENAME_SYSREG_RW_FUNCS(s2pir_el2, S2PIR_EL2)
695 
696 /* FEAT_SxPOE Registers */
697 DEFINE_RENAME_SYSREG_RW_FUNCS(por_el1, POR_EL1)
698 DEFINE_RENAME_SYSREG_RW_FUNCS(por_el2, POR_EL2)
699 DEFINE_RENAME_SYSREG_RW_FUNCS(s2por_el1, S2POR_EL1)
700 
701 /* FEAT_GCS Registers */
702 DEFINE_RENAME_SYSREG_RW_FUNCS(gcscr_el2, GCSCR_EL2)
703 DEFINE_RENAME_SYSREG_RW_FUNCS(gcspr_el2, GCSPR_EL2)
704 DEFINE_RENAME_SYSREG_RW_FUNCS(gcscr_el1, GCSCR_EL1)
705 DEFINE_RENAME_SYSREG_RW_FUNCS(gcscre0_el1, GCSCRE0_EL1)
706 DEFINE_RENAME_SYSREG_RW_FUNCS(gcspr_el1, GCSPR_EL1)
707 DEFINE_RENAME_SYSREG_RW_FUNCS(gcspr_el0, GCSPR_EL0)
708 
709 /* FEAT_THE Registers */
710 #if ENABLE_FEAT_D128
711 DECLARE_SYSREG128_RW_FUNCS(rcwmask_el1)
712 DECLARE_SYSREG128_RW_FUNCS(rcwsmask_el1)
713 #else
714 DEFINE_RENAME_SYSREG_RW_FUNCS(rcwmask_el1, RCWMASK_EL1)
715 DEFINE_RENAME_SYSREG_RW_FUNCS(rcwsmask_el1, RCWSMASK_EL1)
716 #endif
717 
718 /* FEAT_SCTLR2 Registers */
719 DEFINE_RENAME_SYSREG_RW_FUNCS(sctlr2_el1, SCTLR2_EL1)
720 DEFINE_RENAME_SYSREG_RW_FUNCS(sctlr2_el2, SCTLR2_EL2)
721 
722 /* FEAT_LS64_ACCDATA Registers */
723 DEFINE_RENAME_SYSREG_RW_FUNCS(accdata_el1, ACCDATA_EL1)
724 
725 /* DynamIQ Control registers */
726 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpwrdn_el1, CLUSTERPWRDN_EL1)
727 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmcr_el1, CLUSTERPMCR_EL1)
728 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmcntenset_el1, CLUSTERPMCNTENSET_EL1)
729 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmccntr_el1, CLUSTERPMCCNTR_EL1)
730 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmovsset_el1, CLUSTERPMOVSSET_EL1)
731 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmovsclr_el1, CLUSTERPMOVSCLR_EL1)
732 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmselr_el1, CLUSTERPMSELR_EL1)
733 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmxevcntr_el1, CLUSTERPMXEVCNTR_EL1)
734 DEFINE_RENAME_SYSREG_RW_FUNCS(clusterpmxevtyper_el1, CLUSTERPMXEVTYPER_EL1)
735 
736 /* CPU Power/Performance Management registers */
737 DEFINE_RENAME_SYSREG_RW_FUNCS(cpuppmcr_el3, CPUPPMCR_EL3)
738 DEFINE_RENAME_SYSREG_RW_FUNCS(cpumpmmcr_el3, CPUMPMMCR_EL3)
739 
740 /* Armv9.1 FEAT_BRBE Registers */
741 DEFINE_RENAME_SYSREG_RW_FUNCS(brbcr_el2, BRBCR_EL2)
742 
743 /* Armv9.2 RME Registers */
744 DEFINE_RENAME_SYSREG_RW_FUNCS(gptbr_el3, GPTBR_EL3)
745 DEFINE_RENAME_SYSREG_RW_FUNCS(gpccr_el3, GPCCR_EL3)
746 
747 DEFINE_RENAME_SYSREG_RW_FUNCS(fpmr, FPMR)
748 
749 #define IS_IN_EL(x) \
750 	(GET_EL(read_CurrentEl()) == MODE_EL##x)
751 
752 #define IS_IN_EL1() IS_IN_EL(1)
753 #define IS_IN_EL2() IS_IN_EL(2)
754 #define IS_IN_EL3() IS_IN_EL(3)
755 
756 static inline unsigned int get_current_el(void)
757 {
758 	return GET_EL(read_CurrentEl());
759 }
760 
761 static inline unsigned int get_current_el_maybe_constant(void)
762 {
763 #if defined(IMAGE_AT_EL1)
764 	return 1;
765 #elif defined(IMAGE_AT_EL2)
766 	return 2;	/* no use-case in TF-A */
767 #elif defined(IMAGE_AT_EL3)
768 	return 3;
769 #else
770 	/*
771 	 * If we do not know which exception level this is being built for
772 	 * (e.g. built for library), fall back to run-time detection.
773 	 */
774 	return get_current_el();
775 #endif
776 }
777 
778 /*
779  * Check if an EL is implemented from AA64PFR0 register fields.
780  */
781 static inline uint64_t el_implemented(unsigned int el)
782 {
783 	if (el > 3U) {
784 		return EL_IMPL_NONE;
785 	} else {
786 		unsigned int shift = ID_AA64PFR0_EL1_SHIFT * el;
787 
788 		return (read_id_aa64pfr0_el1() >> shift) & ID_AA64PFR0_ELX_MASK;
789 	}
790 }
791 
792 /*
793  * TLBI PAALLOS instruction
794  * (TLB Invalidate GPT Information by PA, All Entries, Outer Shareable)
795  */
796 static inline void tlbipaallos(void)
797 {
798 	__asm__("sys #6, c8, c1, #4");
799 }
800 
801 /*
802  * TLBI RPALOS instructions
803  * (TLB Range Invalidate GPT Information by PA, Last level, Outer Shareable)
804  *
805  * command SIZE, bits [47:44] field:
806  * 0b0000	4KB
807  * 0b0001	16KB
808  * 0b0010	64KB
809  * 0b0011	2MB
810  * 0b0100	32MB
811  * 0b0101	512MB
812  * 0b0110	1GB
813  * 0b0111	16GB
814  * 0b1000	64GB
815  * 0b1001	512GB
816  */
817 #define TLBI_SZ_4K		0UL
818 #define TLBI_SZ_16K		1UL
819 #define TLBI_SZ_64K		2UL
820 #define TLBI_SZ_2M		3UL
821 #define TLBI_SZ_32M		4UL
822 #define TLBI_SZ_512M		5UL
823 #define TLBI_SZ_1G		6UL
824 #define TLBI_SZ_16G		7UL
825 #define TLBI_SZ_64G		8UL
826 #define TLBI_SZ_512G		9UL
827 
828 #define	TLBI_ADDR_SHIFT		U(12)
829 #define	TLBI_SIZE_SHIFT		U(44)
830 
831 #define TLBIRPALOS(_addr, _size)				\
832 {								\
833 	u_register_t arg = ((_addr) >> TLBI_ADDR_SHIFT) |	\
834 			   ((_size) << TLBI_SIZE_SHIFT);	\
835 	__asm__("sys #6, c8, c4, #7, %0" : : "r" (arg));	\
836 }
837 
838 /* Note: addr must be aligned to 4KB */
839 static inline void tlbirpalos_4k(uintptr_t addr)
840 {
841 	TLBIRPALOS(addr, TLBI_SZ_4K);
842 }
843 
844 /* Note: addr must be aligned to 16KB */
845 static inline void tlbirpalos_16k(uintptr_t addr)
846 {
847 	TLBIRPALOS(addr, TLBI_SZ_16K);
848 }
849 
850 /* Note: addr must be aligned to 64KB */
851 static inline void tlbirpalos_64k(uintptr_t addr)
852 {
853 	TLBIRPALOS(addr, TLBI_SZ_64K);
854 }
855 
856 /* Note: addr must be aligned to 2MB */
857 static inline void tlbirpalos_2m(uintptr_t addr)
858 {
859 	TLBIRPALOS(addr, TLBI_SZ_2M);
860 }
861 
862 /* Note: addr must be aligned to 32MB */
863 static inline void tlbirpalos_32m(uintptr_t addr)
864 {
865 	TLBIRPALOS(addr, TLBI_SZ_32M);
866 }
867 
868 /* Note: addr must be aligned to 512MB */
869 static inline void tlbirpalos_512m(uintptr_t addr)
870 {
871 	TLBIRPALOS(addr, TLBI_SZ_512M);
872 }
873 
874 /* Previously defined accessor functions with incomplete register names  */
875 
876 #define read_current_el()	read_CurrentEl()
877 
878 #define dsb()			dsbsy()
879 
880 #define read_midr()		read_midr_el1()
881 
882 #define read_mpidr()		read_mpidr_el1()
883 
884 #define read_scr()		read_scr_el3()
885 #define write_scr(_v)		write_scr_el3(_v)
886 
887 #define read_hcr()		read_hcr_el2()
888 #define write_hcr(_v)		write_hcr_el2(_v)
889 
890 #define read_cpacr()		read_cpacr_el1()
891 #define write_cpacr(_v)		write_cpacr_el1(_v)
892 
893 #define read_clusterpwrdn()		read_clusterpwrdn_el1()
894 #define write_clusterpwrdn(_v)		write_clusterpwrdn_el1(_v)
895 
896 #define read_clusterpmcr()		read_clusterpmcr_el1()
897 #define write_clusterpmcr(_v)		write_clusterpmcr_el1(_v)
898 
899 #define read_clusterpmcntenset()	read_clusterpmcntenset_el1()
900 #define write_clusterpmcntenset(_v)	write_clusterpmcntenset_el1(_v)
901 
902 #define read_clusterpmccntr()		read_clusterpmccntr_el1()
903 #define write_clusterpmccntr(_v)	write_clusterpmccntr_el1(_v)
904 
905 #define read_clusterpmovsset()		read_clusterpmovsset_el1()
906 #define write_clusterpmovsset(_v)	write_clusterpmovsset_el1(_v)
907 
908 #define read_clusterpmovsclr()		read_clusterpmovsclr_el1()
909 #define write_clusterpmovsclr(_v)	write_clusterpmovsclr_el1(_v)
910 
911 #define read_clusterpmselr()		read_clusterpmselr_el1()
912 #define write_clusterpmselr(_v)		write_clusterpmselr_el1(_v)
913 
914 #define read_clusterpmxevcntr()		read_clusterpmxevcntr_el1()
915 #define write_clusterpmxevcntr(_v)	write_clusterpmxevcntr_el1(_v)
916 
917 #define read_clusterpmxevtyper()	read_clusterpmxevtyper_el1()
918 #define write_clusterpmxevtyper(_v)	write_clusterpmxevtyper_el1(_v)
919 
920 #if ERRATA_SPECULATIVE_AT
921 /*
922  * Assuming SCTLR.M bit is already enabled
923  * 1. Enable page table walk by clearing TCR_EL1.EPDx bits
924  * 2. Execute AT instruction for lower EL1/0
925  * 3. Disable page table walk by setting TCR_EL1.EPDx bits
926  */
927 #define AT(_at_inst, _va)	\
928 {	\
929 	assert((read_sctlr_el1() & SCTLR_M_BIT) != 0ULL);	\
930 	write_tcr_el1(read_tcr_el1() & ~(TCR_EPD0_BIT | TCR_EPD1_BIT));	\
931 	isb();	\
932 	_at_inst(_va);	\
933 	write_tcr_el1(read_tcr_el1() | (TCR_EPD0_BIT | TCR_EPD1_BIT));	\
934 	isb();	\
935 }
936 #else
937 #define AT(_at_inst, _va)	_at_inst(_va)
938 #endif
939 
940 #endif /* ARCH_HELPERS_H */
941