xref: /rk3399_ARM-atf/include/arch/aarch64/arch_helpers.h (revision 0a0a7a9ac82cb79af91f098cedc69cc67bca3978)
1 /*
2  * Copyright (c) 2013-2020, 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 
17 /**********************************************************************
18  * Macros which create inline functions to read or write CPU system
19  * registers
20  *********************************************************************/
21 
22 #define _DEFINE_SYSREG_READ_FUNC(_name, _reg_name)		\
23 static inline u_register_t read_ ## _name(void)			\
24 {								\
25 	u_register_t v;						\
26 	__asm__ volatile ("mrs %0, " #_reg_name : "=r" (v));	\
27 	return v;						\
28 }
29 
30 #define _DEFINE_SYSREG_WRITE_FUNC(_name, _reg_name)			\
31 static inline void write_ ## _name(u_register_t v)			\
32 {									\
33 	__asm__ volatile ("msr " #_reg_name ", %0" : : "r" (v));	\
34 }
35 
36 #define SYSREG_WRITE_CONST(reg_name, v)				\
37 	__asm__ volatile ("msr " #reg_name ", %0" : : "i" (v))
38 
39 /* Define read function for system register */
40 #define DEFINE_SYSREG_READ_FUNC(_name) 			\
41 	_DEFINE_SYSREG_READ_FUNC(_name, _name)
42 
43 /* Define read & write function for system register */
44 #define DEFINE_SYSREG_RW_FUNCS(_name)			\
45 	_DEFINE_SYSREG_READ_FUNC(_name, _name)		\
46 	_DEFINE_SYSREG_WRITE_FUNC(_name, _name)
47 
48 /* Define read & write function for renamed system register */
49 #define DEFINE_RENAME_SYSREG_RW_FUNCS(_name, _reg_name)	\
50 	_DEFINE_SYSREG_READ_FUNC(_name, _reg_name)	\
51 	_DEFINE_SYSREG_WRITE_FUNC(_name, _reg_name)
52 
53 /* Define read function for renamed system register */
54 #define DEFINE_RENAME_SYSREG_READ_FUNC(_name, _reg_name)	\
55 	_DEFINE_SYSREG_READ_FUNC(_name, _reg_name)
56 
57 /* Define write function for renamed system register */
58 #define DEFINE_RENAME_SYSREG_WRITE_FUNC(_name, _reg_name)	\
59 	_DEFINE_SYSREG_WRITE_FUNC(_name, _reg_name)
60 
61 /**********************************************************************
62  * Macros to create inline functions for system instructions
63  *********************************************************************/
64 
65 /* Define function for simple system instruction */
66 #define DEFINE_SYSOP_FUNC(_op)				\
67 static inline void _op(void)				\
68 {							\
69 	__asm__ (#_op);					\
70 }
71 
72 /* Define function for system instruction with register parameter */
73 #define DEFINE_SYSOP_PARAM_FUNC(_op)			\
74 static inline void _op(uint64_t v)			\
75 {							\
76 	 __asm__ (#_op "  %0" : : "r" (v));		\
77 }
78 
79 /* Define function for system instruction with type specifier */
80 #define DEFINE_SYSOP_TYPE_FUNC(_op, _type)		\
81 static inline void _op ## _type(void)			\
82 {							\
83 	__asm__ (#_op " " #_type);			\
84 }
85 
86 /* Define function for system instruction with register parameter */
87 #define DEFINE_SYSOP_TYPE_PARAM_FUNC(_op, _type)	\
88 static inline void _op ## _type(uint64_t v)		\
89 {							\
90 	 __asm__ (#_op " " #_type ", %0" : : "r" (v));	\
91 }
92 
93 /*******************************************************************************
94  * TLB maintenance accessor prototypes
95  ******************************************************************************/
96 
97 #if ERRATA_A57_813419 || ERRATA_A76_1286807
98 /*
99  * Define function for TLBI instruction with type specifier that implements
100  * the workaround for errata 813419 of Cortex-A57 or errata 1286807 of
101  * Cortex-A76.
102  */
103 #define DEFINE_TLBIOP_ERRATA_TYPE_FUNC(_type)\
104 static inline void tlbi ## _type(void)			\
105 {							\
106 	__asm__("tlbi " #_type "\n"			\
107 		"dsb ish\n"				\
108 		"tlbi " #_type);			\
109 }
110 
111 /*
112  * Define function for TLBI instruction with register parameter that implements
113  * the workaround for errata 813419 of Cortex-A57 or errata 1286807 of
114  * Cortex-A76.
115  */
116 #define DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(_type)	\
117 static inline void tlbi ## _type(uint64_t v)			\
118 {								\
119 	__asm__("tlbi " #_type ", %0\n"				\
120 		"dsb ish\n"					\
121 		"tlbi " #_type ", %0" : : "r" (v));		\
122 }
123 #endif /* ERRATA_A57_813419 */
124 
125 #if ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319
126 /*
127  * Define function for DC instruction with register parameter that enables
128  * the workaround for errata 819472, 824069 and 827319 of Cortex-A53.
129  */
130 #define DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(_name, _type)	\
131 static inline void dc ## _name(uint64_t v)			\
132 {								\
133 	__asm__("dc " #_type ", %0" : : "r" (v));		\
134 }
135 #endif /* ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319 */
136 
137 #if ERRATA_A57_813419
138 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1)
139 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1is)
140 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2)
141 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2is)
142 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3)
143 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3is)
144 DEFINE_SYSOP_TYPE_FUNC(tlbi, vmalle1)
145 #elif ERRATA_A76_1286807
146 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle1)
147 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle1is)
148 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle2)
149 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle2is)
150 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3)
151 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(alle3is)
152 DEFINE_TLBIOP_ERRATA_TYPE_FUNC(vmalle1)
153 #else
154 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1)
155 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle1is)
156 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2)
157 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle2is)
158 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle3)
159 DEFINE_SYSOP_TYPE_FUNC(tlbi, alle3is)
160 DEFINE_SYSOP_TYPE_FUNC(tlbi, vmalle1)
161 #endif
162 
163 #if ERRATA_A57_813419
164 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaae1is)
165 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaale1is)
166 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vae2is)
167 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vale2is)
168 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vae3is)
169 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vale3is)
170 #elif ERRATA_A76_1286807
171 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vaae1is)
172 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vaale1is)
173 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vae2is)
174 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vale2is)
175 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vae3is)
176 DEFINE_TLBIOP_ERRATA_TYPE_PARAM_FUNC(vale3is)
177 #else
178 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaae1is)
179 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vaale1is)
180 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vae2is)
181 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vale2is)
182 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vae3is)
183 DEFINE_SYSOP_TYPE_PARAM_FUNC(tlbi, vale3is)
184 #endif
185 
186 /*******************************************************************************
187  * Cache maintenance accessor prototypes
188  ******************************************************************************/
189 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, isw)
190 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, cisw)
191 #if ERRATA_A53_827319
192 DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(csw, cisw)
193 #else
194 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, csw)
195 #endif
196 #if ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319
197 DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(cvac, civac)
198 #else
199 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, cvac)
200 #endif
201 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, ivac)
202 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, civac)
203 #if ERRATA_A53_819472 || ERRATA_A53_824069 || ERRATA_A53_827319
204 DEFINE_DCOP_ERRATA_A53_TYPE_PARAM_FUNC(cvau, civac)
205 #else
206 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, cvau)
207 #endif
208 DEFINE_SYSOP_TYPE_PARAM_FUNC(dc, zva)
209 
210 /*******************************************************************************
211  * Address translation accessor prototypes
212  ******************************************************************************/
213 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e1r)
214 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e1w)
215 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e0r)
216 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s12e0w)
217 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s1e1r)
218 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s1e2r)
219 DEFINE_SYSOP_TYPE_PARAM_FUNC(at, s1e3r)
220 
221 /*******************************************************************************
222  * Strip Pointer Authentication Code
223  ******************************************************************************/
224 DEFINE_SYSOP_PARAM_FUNC(xpaci)
225 
226 void flush_dcache_range(uintptr_t addr, size_t size);
227 void clean_dcache_range(uintptr_t addr, size_t size);
228 void inv_dcache_range(uintptr_t addr, size_t size);
229 
230 void dcsw_op_louis(u_register_t op_type);
231 void dcsw_op_all(u_register_t op_type);
232 
233 void disable_mmu_el1(void);
234 void disable_mmu_el3(void);
235 void disable_mmu_icache_el1(void);
236 void disable_mmu_icache_el3(void);
237 
238 /*******************************************************************************
239  * Misc. accessor prototypes
240  ******************************************************************************/
241 
242 #define write_daifclr(val) SYSREG_WRITE_CONST(daifclr, val)
243 #define write_daifset(val) SYSREG_WRITE_CONST(daifset, val)
244 
245 DEFINE_SYSREG_RW_FUNCS(par_el1)
246 DEFINE_SYSREG_READ_FUNC(id_pfr1_el1)
247 DEFINE_SYSREG_READ_FUNC(id_aa64isar1_el1)
248 DEFINE_SYSREG_READ_FUNC(id_aa64pfr0_el1)
249 DEFINE_SYSREG_READ_FUNC(id_aa64pfr1_el1)
250 DEFINE_SYSREG_READ_FUNC(id_aa64dfr0_el1)
251 DEFINE_SYSREG_READ_FUNC(id_afr0_el1)
252 DEFINE_SYSREG_READ_FUNC(CurrentEl)
253 DEFINE_SYSREG_READ_FUNC(ctr_el0)
254 DEFINE_SYSREG_RW_FUNCS(daif)
255 DEFINE_SYSREG_RW_FUNCS(spsr_el1)
256 DEFINE_SYSREG_RW_FUNCS(spsr_el2)
257 DEFINE_SYSREG_RW_FUNCS(spsr_el3)
258 DEFINE_SYSREG_RW_FUNCS(elr_el1)
259 DEFINE_SYSREG_RW_FUNCS(elr_el2)
260 DEFINE_SYSREG_RW_FUNCS(elr_el3)
261 
262 DEFINE_SYSOP_FUNC(wfi)
263 DEFINE_SYSOP_FUNC(wfe)
264 DEFINE_SYSOP_FUNC(sev)
265 DEFINE_SYSOP_TYPE_FUNC(dsb, sy)
266 DEFINE_SYSOP_TYPE_FUNC(dmb, sy)
267 DEFINE_SYSOP_TYPE_FUNC(dmb, st)
268 DEFINE_SYSOP_TYPE_FUNC(dmb, ld)
269 DEFINE_SYSOP_TYPE_FUNC(dsb, ish)
270 DEFINE_SYSOP_TYPE_FUNC(dsb, nsh)
271 DEFINE_SYSOP_TYPE_FUNC(dsb, ishst)
272 DEFINE_SYSOP_TYPE_FUNC(dmb, oshld)
273 DEFINE_SYSOP_TYPE_FUNC(dmb, oshst)
274 DEFINE_SYSOP_TYPE_FUNC(dmb, osh)
275 DEFINE_SYSOP_TYPE_FUNC(dmb, nshld)
276 DEFINE_SYSOP_TYPE_FUNC(dmb, nshst)
277 DEFINE_SYSOP_TYPE_FUNC(dmb, nsh)
278 DEFINE_SYSOP_TYPE_FUNC(dmb, ishld)
279 DEFINE_SYSOP_TYPE_FUNC(dmb, ishst)
280 DEFINE_SYSOP_TYPE_FUNC(dmb, ish)
281 DEFINE_SYSOP_FUNC(isb)
282 
283 static inline void enable_irq(void)
284 {
285 	/*
286 	 * The compiler memory barrier will prevent the compiler from
287 	 * scheduling non-volatile memory access after the write to the
288 	 * register.
289 	 *
290 	 * This could happen if some initialization code issues non-volatile
291 	 * accesses to an area used by an interrupt handler, in the assumption
292 	 * that it is safe as the interrupts are disabled at the time it does
293 	 * that (according to program order). However, non-volatile accesses
294 	 * are not necessarily in program order relatively with volatile inline
295 	 * assembly statements (and volatile accesses).
296 	 */
297 	COMPILER_BARRIER();
298 	write_daifclr(DAIF_IRQ_BIT);
299 	isb();
300 }
301 
302 static inline void enable_fiq(void)
303 {
304 	COMPILER_BARRIER();
305 	write_daifclr(DAIF_FIQ_BIT);
306 	isb();
307 }
308 
309 static inline void enable_serror(void)
310 {
311 	COMPILER_BARRIER();
312 	write_daifclr(DAIF_ABT_BIT);
313 	isb();
314 }
315 
316 static inline void enable_debug_exceptions(void)
317 {
318 	COMPILER_BARRIER();
319 	write_daifclr(DAIF_DBG_BIT);
320 	isb();
321 }
322 
323 static inline void disable_irq(void)
324 {
325 	COMPILER_BARRIER();
326 	write_daifset(DAIF_IRQ_BIT);
327 	isb();
328 }
329 
330 static inline void disable_fiq(void)
331 {
332 	COMPILER_BARRIER();
333 	write_daifset(DAIF_FIQ_BIT);
334 	isb();
335 }
336 
337 static inline void disable_serror(void)
338 {
339 	COMPILER_BARRIER();
340 	write_daifset(DAIF_ABT_BIT);
341 	isb();
342 }
343 
344 static inline void disable_debug_exceptions(void)
345 {
346 	COMPILER_BARRIER();
347 	write_daifset(DAIF_DBG_BIT);
348 	isb();
349 }
350 
351 void __dead2 smc(uint64_t x0, uint64_t x1, uint64_t x2, uint64_t x3,
352 		 uint64_t x4, uint64_t x5, uint64_t x6, uint64_t x7);
353 
354 /*******************************************************************************
355  * System register accessor prototypes
356  ******************************************************************************/
357 DEFINE_SYSREG_READ_FUNC(midr_el1)
358 DEFINE_SYSREG_READ_FUNC(mpidr_el1)
359 DEFINE_SYSREG_READ_FUNC(id_aa64mmfr0_el1)
360 
361 DEFINE_SYSREG_RW_FUNCS(scr_el3)
362 DEFINE_SYSREG_RW_FUNCS(hcr_el2)
363 
364 DEFINE_SYSREG_RW_FUNCS(vbar_el1)
365 DEFINE_SYSREG_RW_FUNCS(vbar_el2)
366 DEFINE_SYSREG_RW_FUNCS(vbar_el3)
367 
368 DEFINE_SYSREG_RW_FUNCS(sctlr_el1)
369 DEFINE_SYSREG_RW_FUNCS(sctlr_el2)
370 DEFINE_SYSREG_RW_FUNCS(sctlr_el3)
371 
372 DEFINE_SYSREG_RW_FUNCS(actlr_el1)
373 DEFINE_SYSREG_RW_FUNCS(actlr_el2)
374 DEFINE_SYSREG_RW_FUNCS(actlr_el3)
375 
376 DEFINE_SYSREG_RW_FUNCS(esr_el1)
377 DEFINE_SYSREG_RW_FUNCS(esr_el2)
378 DEFINE_SYSREG_RW_FUNCS(esr_el3)
379 
380 DEFINE_SYSREG_RW_FUNCS(afsr0_el1)
381 DEFINE_SYSREG_RW_FUNCS(afsr0_el2)
382 DEFINE_SYSREG_RW_FUNCS(afsr0_el3)
383 
384 DEFINE_SYSREG_RW_FUNCS(afsr1_el1)
385 DEFINE_SYSREG_RW_FUNCS(afsr1_el2)
386 DEFINE_SYSREG_RW_FUNCS(afsr1_el3)
387 
388 DEFINE_SYSREG_RW_FUNCS(far_el1)
389 DEFINE_SYSREG_RW_FUNCS(far_el2)
390 DEFINE_SYSREG_RW_FUNCS(far_el3)
391 
392 DEFINE_SYSREG_RW_FUNCS(mair_el1)
393 DEFINE_SYSREG_RW_FUNCS(mair_el2)
394 DEFINE_SYSREG_RW_FUNCS(mair_el3)
395 
396 DEFINE_SYSREG_RW_FUNCS(amair_el1)
397 DEFINE_SYSREG_RW_FUNCS(amair_el2)
398 DEFINE_SYSREG_RW_FUNCS(amair_el3)
399 
400 DEFINE_SYSREG_READ_FUNC(rvbar_el1)
401 DEFINE_SYSREG_READ_FUNC(rvbar_el2)
402 DEFINE_SYSREG_READ_FUNC(rvbar_el3)
403 
404 DEFINE_SYSREG_RW_FUNCS(rmr_el1)
405 DEFINE_SYSREG_RW_FUNCS(rmr_el2)
406 DEFINE_SYSREG_RW_FUNCS(rmr_el3)
407 
408 DEFINE_SYSREG_RW_FUNCS(tcr_el1)
409 DEFINE_SYSREG_RW_FUNCS(tcr_el2)
410 DEFINE_SYSREG_RW_FUNCS(tcr_el3)
411 
412 DEFINE_SYSREG_RW_FUNCS(ttbr0_el1)
413 DEFINE_SYSREG_RW_FUNCS(ttbr0_el2)
414 DEFINE_SYSREG_RW_FUNCS(ttbr0_el3)
415 
416 DEFINE_SYSREG_RW_FUNCS(ttbr1_el1)
417 
418 DEFINE_SYSREG_RW_FUNCS(vttbr_el2)
419 
420 DEFINE_SYSREG_RW_FUNCS(cptr_el2)
421 DEFINE_SYSREG_RW_FUNCS(cptr_el3)
422 
423 DEFINE_SYSREG_RW_FUNCS(cpacr_el1)
424 DEFINE_SYSREG_RW_FUNCS(cntfrq_el0)
425 DEFINE_SYSREG_RW_FUNCS(cnthp_ctl_el2)
426 DEFINE_SYSREG_RW_FUNCS(cnthp_tval_el2)
427 DEFINE_SYSREG_RW_FUNCS(cnthp_cval_el2)
428 DEFINE_SYSREG_RW_FUNCS(cntps_ctl_el1)
429 DEFINE_SYSREG_RW_FUNCS(cntps_tval_el1)
430 DEFINE_SYSREG_RW_FUNCS(cntps_cval_el1)
431 DEFINE_SYSREG_RW_FUNCS(cntp_ctl_el0)
432 DEFINE_SYSREG_RW_FUNCS(cntp_tval_el0)
433 DEFINE_SYSREG_RW_FUNCS(cntp_cval_el0)
434 DEFINE_SYSREG_READ_FUNC(cntpct_el0)
435 DEFINE_SYSREG_RW_FUNCS(cnthctl_el2)
436 
437 #define get_cntp_ctl_enable(x)  (((x) >> CNTP_CTL_ENABLE_SHIFT) & \
438 					CNTP_CTL_ENABLE_MASK)
439 #define get_cntp_ctl_imask(x)   (((x) >> CNTP_CTL_IMASK_SHIFT) & \
440 					CNTP_CTL_IMASK_MASK)
441 #define get_cntp_ctl_istatus(x) (((x) >> CNTP_CTL_ISTATUS_SHIFT) & \
442 					CNTP_CTL_ISTATUS_MASK)
443 
444 #define set_cntp_ctl_enable(x)  ((x) |= (U(1) << CNTP_CTL_ENABLE_SHIFT))
445 #define set_cntp_ctl_imask(x)   ((x) |= (U(1) << CNTP_CTL_IMASK_SHIFT))
446 
447 #define clr_cntp_ctl_enable(x)  ((x) &= ~(U(1) << CNTP_CTL_ENABLE_SHIFT))
448 #define clr_cntp_ctl_imask(x)   ((x) &= ~(U(1) << CNTP_CTL_IMASK_SHIFT))
449 
450 DEFINE_SYSREG_RW_FUNCS(tpidr_el3)
451 
452 DEFINE_SYSREG_RW_FUNCS(cntvoff_el2)
453 
454 DEFINE_SYSREG_RW_FUNCS(vpidr_el2)
455 DEFINE_SYSREG_RW_FUNCS(vmpidr_el2)
456 
457 DEFINE_SYSREG_READ_FUNC(isr_el1)
458 
459 DEFINE_SYSREG_RW_FUNCS(mdcr_el2)
460 DEFINE_SYSREG_RW_FUNCS(mdcr_el3)
461 DEFINE_SYSREG_RW_FUNCS(hstr_el2)
462 DEFINE_SYSREG_RW_FUNCS(pmcr_el0)
463 
464 /* GICv3 System Registers */
465 
466 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el1, ICC_SRE_EL1)
467 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el2, ICC_SRE_EL2)
468 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sre_el3, ICC_SRE_EL3)
469 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_pmr_el1, ICC_PMR_EL1)
470 DEFINE_RENAME_SYSREG_READ_FUNC(icc_rpr_el1, ICC_RPR_EL1)
471 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen1_el3, ICC_IGRPEN1_EL3)
472 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen1_el1, ICC_IGRPEN1_EL1)
473 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_igrpen0_el1, ICC_IGRPEN0_EL1)
474 DEFINE_RENAME_SYSREG_READ_FUNC(icc_hppir0_el1, ICC_HPPIR0_EL1)
475 DEFINE_RENAME_SYSREG_READ_FUNC(icc_hppir1_el1, ICC_HPPIR1_EL1)
476 DEFINE_RENAME_SYSREG_READ_FUNC(icc_iar0_el1, ICC_IAR0_EL1)
477 DEFINE_RENAME_SYSREG_READ_FUNC(icc_iar1_el1, ICC_IAR1_EL1)
478 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_eoir0_el1, ICC_EOIR0_EL1)
479 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_eoir1_el1, ICC_EOIR1_EL1)
480 DEFINE_RENAME_SYSREG_WRITE_FUNC(icc_sgi0r_el1, ICC_SGI0R_EL1)
481 DEFINE_RENAME_SYSREG_RW_FUNCS(icc_sgi1r, ICC_SGI1R)
482 
483 DEFINE_RENAME_SYSREG_RW_FUNCS(amcgcr_el0, AMCGCR_EL0)
484 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenclr0_el0, AMCNTENCLR0_EL0)
485 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenset0_el0, AMCNTENSET0_EL0)
486 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenclr1_el0, AMCNTENCLR1_EL0)
487 DEFINE_RENAME_SYSREG_RW_FUNCS(amcntenset1_el0, AMCNTENSET1_EL0)
488 
489 DEFINE_RENAME_SYSREG_READ_FUNC(mpamidr_el1, MPAMIDR_EL1)
490 DEFINE_RENAME_SYSREG_RW_FUNCS(mpam3_el3, MPAM3_EL3)
491 DEFINE_RENAME_SYSREG_RW_FUNCS(mpam2_el2, MPAM2_EL2)
492 DEFINE_RENAME_SYSREG_RW_FUNCS(mpamhcr_el2, MPAMHCR_EL2)
493 
494 DEFINE_RENAME_SYSREG_RW_FUNCS(pmblimitr_el1, PMBLIMITR_EL1)
495 
496 DEFINE_RENAME_SYSREG_WRITE_FUNC(zcr_el3, ZCR_EL3)
497 DEFINE_RENAME_SYSREG_WRITE_FUNC(zcr_el2, ZCR_EL2)
498 
499 DEFINE_RENAME_SYSREG_READ_FUNC(erridr_el1, ERRIDR_EL1)
500 DEFINE_RENAME_SYSREG_WRITE_FUNC(errselr_el1, ERRSELR_EL1)
501 
502 DEFINE_RENAME_SYSREG_READ_FUNC(erxfr_el1, ERXFR_EL1)
503 DEFINE_RENAME_SYSREG_RW_FUNCS(erxctlr_el1, ERXCTLR_EL1)
504 DEFINE_RENAME_SYSREG_RW_FUNCS(erxstatus_el1, ERXSTATUS_EL1)
505 DEFINE_RENAME_SYSREG_READ_FUNC(erxaddr_el1, ERXADDR_EL1)
506 DEFINE_RENAME_SYSREG_READ_FUNC(erxmisc0_el1, ERXMISC0_EL1)
507 DEFINE_RENAME_SYSREG_READ_FUNC(erxmisc1_el1, ERXMISC1_EL1)
508 
509 /* Armv8.2 Registers */
510 DEFINE_RENAME_SYSREG_READ_FUNC(id_aa64mmfr2_el1, ID_AA64MMFR2_EL1)
511 
512 /* Armv8.3 Pointer Authentication Registers */
513 DEFINE_RENAME_SYSREG_RW_FUNCS(apiakeyhi_el1, APIAKeyHi_EL1)
514 DEFINE_RENAME_SYSREG_RW_FUNCS(apiakeylo_el1, APIAKeyLo_EL1)
515 
516 /* Armv8.5 MTE Registers */
517 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsre0_el1, TFSRE0_EL1)
518 DEFINE_RENAME_SYSREG_RW_FUNCS(tfsr_el1, TFSR_EL1)
519 DEFINE_RENAME_SYSREG_RW_FUNCS(rgsr_el1, RGSR_EL1)
520 DEFINE_RENAME_SYSREG_RW_FUNCS(gcr_el1, GCR_EL1)
521 
522 #define IS_IN_EL(x) \
523 	(GET_EL(read_CurrentEl()) == MODE_EL##x)
524 
525 #define IS_IN_EL1() IS_IN_EL(1)
526 #define IS_IN_EL2() IS_IN_EL(2)
527 #define IS_IN_EL3() IS_IN_EL(3)
528 
529 static inline unsigned int get_current_el(void)
530 {
531 	return GET_EL(read_CurrentEl());
532 }
533 
534 static inline unsigned int get_current_el_maybe_constant(void)
535 {
536 #if defined(IMAGE_AT_EL1)
537 	return 1;
538 #elif defined(IMAGE_AT_EL2)
539 	return 2;	/* no use-case in TF-A */
540 #elif defined(IMAGE_AT_EL3)
541 	return 3;
542 #else
543 	/*
544 	 * If we do not know which exception level this is being built for
545 	 * (e.g. built for library), fall back to run-time detection.
546 	 */
547 	return get_current_el();
548 #endif
549 }
550 
551 /*
552  * Check if an EL is implemented from AA64PFR0 register fields.
553  */
554 static inline uint64_t el_implemented(unsigned int el)
555 {
556 	if (el > 3U) {
557 		return EL_IMPL_NONE;
558 	} else {
559 		unsigned int shift = ID_AA64PFR0_EL1_SHIFT * el;
560 
561 		return (read_id_aa64pfr0_el1() >> shift) & ID_AA64PFR0_ELX_MASK;
562 	}
563 }
564 
565 /* Previously defined accesor functions with incomplete register names  */
566 
567 #define read_current_el()	read_CurrentEl()
568 
569 #define dsb()			dsbsy()
570 
571 #define read_midr()		read_midr_el1()
572 
573 #define read_mpidr()		read_mpidr_el1()
574 
575 #define read_scr()		read_scr_el3()
576 #define write_scr(_v)		write_scr_el3(_v)
577 
578 #define read_hcr()		read_hcr_el2()
579 #define write_hcr(_v)		write_hcr_el2(_v)
580 
581 #define read_cpacr()		read_cpacr_el1()
582 #define write_cpacr(_v)		write_cpacr_el1(_v)
583 
584 #endif /* ARCH_HELPERS_H */
585