xref: /rk3399_ARM-atf/lib/el3_runtime/aarch64/context.S (revision a4defaefe65379554f464e9cf2b4f4d9818740aa)
1/*
2 * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.
3 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
7#include <arch.h>
8#include <asm_macros.S>
9#include <assert_macros.S>
10#include <context.h>
11#include <el3_common_macros.S>
12#include <lib/el3_runtime/cpu_data.h>
13#include <lib/per_cpu/per_cpu_macros.S>
14#include <platform_def.h>
15
16#if CTX_INCLUDE_FPREGS
17	.global	fpregs_context_save
18	.global	fpregs_context_restore
19#endif /* CTX_INCLUDE_FPREGS */
20
21#if CTX_INCLUDE_SVE_REGS
22	.global sve_context_save
23	.global sve_context_restore
24#endif /* CTX_INCLUDE_SVE_REGS */
25
26#if ERRATA_SPECULATIVE_AT
27	.global save_and_update_ptw_el1_sys_regs
28#endif /* ERRATA_SPECULATIVE_AT */
29
30	.global	prepare_el3_entry
31	.global	restore_gp_pmcr_pauth_regs
32	.global	el3_exit
33
34/* Following macros will be used if any of CTX_INCLUDE_FPREGS or CTX_INCLUDE_SVE_REGS is enabled */
35#if CTX_INCLUDE_FPREGS || CTX_INCLUDE_SVE_REGS
36.macro fpregs_state_save base:req hold:req
37	mrs	\hold, fpsr
38	str	\hold, [\base, #CTX_SIMD_FPSR]
39
40	mrs	\hold, fpcr
41	str	\hold, [\base, #CTX_SIMD_FPCR]
42
43#if CTX_INCLUDE_AARCH32_REGS && CTX_INCLUDE_FPREGS
44	mrs	\hold, fpexc32_el2
45	str	\hold, [\base, #CTX_SIMD_FPEXC32]
46#endif
47.endm
48
49.macro fpregs_state_restore base:req hold:req
50	ldr	\hold, [\base, #CTX_SIMD_FPSR]
51	msr	fpsr, \hold
52
53	ldr	\hold, [\base, #CTX_SIMD_FPCR]
54	msr	fpcr, \hold
55
56#if CTX_INCLUDE_AARCH32_REGS && CTX_INCLUDE_FPREGS
57	ldr	\hold, [\base, #CTX_SIMD_FPEXC32]
58	msr	fpexc32_el2, \hold
59#endif
60.endm
61
62#endif /* CTX_INCLUDE_FPREGS || CTX_INCLUDE_SVE_REGS */
63
64/* ------------------------------------------------------------------
65 * The following function follows the aapcs_64 strictly to use
66 * x9-x17 (temporary caller-saved registers according to AArch64 PCS)
67 * to save floating point register context. It assumes that 'x0' is
68 * pointing to a 'fp_regs' structure where the register context will
69 * be saved.
70 *
71 * Access to VFP registers will trap if CPTR_EL3.TFP is set.
72 * However currently we don't use VFP registers nor set traps in
73 * Trusted Firmware, and assume it's cleared.
74 *
75 * TODO: Revisit when VFP is used in secure world
76 * ------------------------------------------------------------------
77 */
78#if CTX_INCLUDE_FPREGS
79func fpregs_context_save
80.arch_extension fp
81	/* Temporarily enable floating point */
82
83	/* Save x0 and pass its original value to fpregs_state_save */
84	mov	x1, x0
85
86	stp	q0, q1, [x0], #32
87	stp	q2, q3, [x0], #32
88	stp	q4, q5, [x0], #32
89	stp	q6, q7, [x0], #32
90	stp	q8, q9, [x0], #32
91	stp	q10, q11, [x0], #32
92	stp	q12, q13, [x0], #32
93	stp	q14, q15, [x0], #32
94	stp	q16, q17, [x0], #32
95	stp	q18, q19, [x0], #32
96	stp	q20, q21, [x0], #32
97	stp	q22, q23, [x0], #32
98	stp	q24, q25, [x0], #32
99	stp	q26, q27, [x0], #32
100	stp	q28, q29, [x0], #32
101	stp	q30, q31, [x0], #32
102
103	fpregs_state_save x1, x9
104
105.arch_extension nofp
106	ret
107endfunc fpregs_context_save
108
109/* ------------------------------------------------------------------
110 * The following function follows the aapcs_64 strictly to use x9-x17
111 * (temporary caller-saved registers according to AArch64 PCS) to
112 * restore floating point register context. It assumes that 'x0' is
113 * pointing to a 'fp_regs' structure from where the register context
114 * will be restored.
115 *
116 * Access to VFP registers will trap if CPTR_EL3.TFP is set.
117 * However currently we don't use VFP registers nor set traps in
118 * Trusted Firmware, and assume it's cleared.
119 *
120 * TODO: Revisit when VFP is used in secure world
121 * ------------------------------------------------------------------
122 */
123func fpregs_context_restore
124.arch_extension fp
125	/* Temporarily enable floating point */
126
127	/* Save x0 and pass its original value to fpregs_state_restore */
128	mov	x1, x0
129
130	ldp	q0, q1, [x0], #32
131	ldp	q2, q3, [x0], #32
132	ldp	q4, q5, [x0], #32
133	ldp	q6, q7, [x0], #32
134	ldp	q8, q9, [x0], #32
135	ldp	q10, q11, [x0], #32
136	ldp	q12, q13, [x0], #32
137	ldp	q14, q15, [x0], #32
138	ldp	q16, q17, [x0], #32
139	ldp	q18, q19, [x0], #32
140	ldp	q20, q21, [x0], #32
141	ldp	q22, q23, [x0], #32
142	ldp	q24, q25, [x0], #32
143	ldp	q26, q27, [x0], #32
144	ldp	q28, q29, [x0], #32
145	ldp	q30, q31, [x0], #32
146
147	fpregs_state_restore x1, x9
148
149.arch_extension nofp
150	ret
151endfunc fpregs_context_restore
152#endif /* CTX_INCLUDE_FPREGS */
153
154#if CTX_INCLUDE_SVE_REGS
155/*
156 * Helper macros for SVE predicates save/restore operations.
157 */
158.macro sve_predicate_op op:req reg:req
159	\op p0, [\reg, #0, MUL VL]
160	\op p1, [\reg, #1, MUL VL]
161	\op p2, [\reg, #2, MUL VL]
162	\op p3, [\reg, #3, MUL VL]
163	\op p4, [\reg, #4, MUL VL]
164	\op p5, [\reg, #5, MUL VL]
165	\op p6, [\reg, #6, MUL VL]
166	\op p7, [\reg, #7, MUL VL]
167	\op p8, [\reg, #8, MUL VL]
168	\op p9, [\reg, #9, MUL VL]
169	\op p10, [\reg, #10, MUL VL]
170	\op p11, [\reg, #11, MUL VL]
171	\op p12, [\reg, #12, MUL VL]
172	\op p13, [\reg, #13, MUL VL]
173	\op p14, [\reg, #14, MUL VL]
174	\op p15, [\reg, #15, MUL VL]
175.endm
176
177.macro sve_vectors_op op:req reg:req
178	\op z0, [\reg, #0, MUL VL]
179	\op z1, [\reg, #1, MUL VL]
180	\op z2, [\reg, #2, MUL VL]
181	\op z3, [\reg, #3, MUL VL]
182	\op z4, [\reg, #4, MUL VL]
183	\op z5, [\reg, #5, MUL VL]
184	\op z6, [\reg, #6, MUL VL]
185	\op z7, [\reg, #7, MUL VL]
186	\op z8, [\reg, #8, MUL VL]
187	\op z9, [\reg, #9, MUL VL]
188	\op z10, [\reg, #10, MUL VL]
189	\op z11, [\reg, #11, MUL VL]
190	\op z12, [\reg, #12, MUL VL]
191	\op z13, [\reg, #13, MUL VL]
192	\op z14, [\reg, #14, MUL VL]
193	\op z15, [\reg, #15, MUL VL]
194	\op z16, [\reg, #16, MUL VL]
195	\op z17, [\reg, #17, MUL VL]
196	\op z18, [\reg, #18, MUL VL]
197	\op z19, [\reg, #19, MUL VL]
198	\op z20, [\reg, #20, MUL VL]
199	\op z21, [\reg, #21, MUL VL]
200	\op z22, [\reg, #22, MUL VL]
201	\op z23, [\reg, #23, MUL VL]
202	\op z24, [\reg, #24, MUL VL]
203	\op z25, [\reg, #25, MUL VL]
204	\op z26, [\reg, #26, MUL VL]
205	\op z27, [\reg, #27, MUL VL]
206	\op z28, [\reg, #28, MUL VL]
207	\op z29, [\reg, #29, MUL VL]
208	\op z30, [\reg, #30, MUL VL]
209	\op z31, [\reg, #31, MUL VL]
210.endm
211
212/* ------------------------------------------------------------------
213 * The following function follows the aapcs_64 strictly to use x9-x17
214 * (temporary caller-saved registers according to AArch64 PCS) to
215 * restore SVE register context. It assumes that 'x0' is
216 * pointing to a 'sve_regs_t' structure to which the register context
217 * will be saved.
218 * ------------------------------------------------------------------
219 */
220func sve_context_save
221.arch_extension sve
222	/* Predicate registers */
223	mov x13, #CTX_SIMD_PREDICATES
224	add	x9, x0, x13
225	sve_predicate_op str, x9
226
227	/* Save FFR after predicates */
228	mov x13, #CTX_SIMD_FFR
229	add	x9, x0, x13
230	rdffr   p0.b
231	str	p0, [x9]
232
233	/* Save vector registers */
234	mov x13, #CTX_SIMD_VECTORS
235	add	x9, x0, x13
236	sve_vectors_op  str, x9
237.arch_extension nosve
238
239	/* Save FPSR, FPCR and FPEXC32 */
240	fpregs_state_save x0, x9
241
242	ret
243endfunc sve_context_save
244
245/* ------------------------------------------------------------------
246 * The following function follows the aapcs_64 strictly to use x9-x17
247 * (temporary caller-saved registers according to AArch64 PCS) to
248 * restore SVE register context. It assumes that 'x0' is pointing to
249 * a 'sve_regs_t' structure from where the register context will be
250 * restored.
251 * ------------------------------------------------------------------
252 */
253func sve_context_restore
254.arch_extension sve
255	/* Restore FFR register before predicates */
256	mov x13, #CTX_SIMD_FFR
257	add	x9, x0, x13
258	ldr	p0, [x9]
259	wrffr	p0.b
260
261	/* Restore predicate registers */
262	mov x13, #CTX_SIMD_PREDICATES
263	add	x9, x0, x13
264	sve_predicate_op ldr, x9
265
266	/* Restore vector registers */
267	mov x13, #CTX_SIMD_VECTORS
268	add	x9, x0, x13
269	sve_vectors_op	ldr, x9
270.arch_extension nosve
271
272	/* Restore FPSR, FPCR and FPEXC32 */
273	fpregs_state_restore x0, x9
274	ret
275endfunc sve_context_restore
276#endif /* CTX_INCLUDE_SVE_REGS */
277
278	/*
279	 * Set the PSTATE bits not set when the exception was taken as
280	 * described in the AArch64.TakeException() pseudocode function
281	 * in ARM DDI 0487F.c page J1-7635 to a default value.
282	 */
283	.macro set_unset_pstate_bits
284	/*
285	 * If Data Independent Timing (DIT) functionality is implemented,
286	 * always enable DIT in EL3
287	 */
288#if ENABLE_FEAT_DIT
289#if ENABLE_FEAT_DIT >= 2
290	mrs	x8, id_aa64pfr0_el1
291	and	x8, x8, #(ID_AA64PFR0_DIT_MASK << ID_AA64PFR0_DIT_SHIFT)
292	cbz	x8, 1f
293#endif
294	mov	x8, #DIT_BIT
295	msr	DIT, x8
2961:
297#endif /* ENABLE_FEAT_DIT */
298	.endm /* set_unset_pstate_bits */
299
300/*-------------------------------------------------------------------------
301 * This macro checks the ENABLE_FEAT_MPAM state, performs ID register
302 * check to see if the platform supports MPAM extension and restores MPAM3
303 * register value if it is FEAT_STATE_ENABLED/FEAT_STATE_CHECKED.
304 *
305 * This is particularly more complicated because we can't check
306 * if the platform supports MPAM  by looking for status of a particular bit
307 * in the MDCR_EL3 or CPTR_EL3 register like other extensions.
308 * ------------------------------------------------------------------------
309 */
310
311	.macro	restore_mpam3_el3
312#if ENABLE_FEAT_MPAM
313#if ENABLE_FEAT_MPAM >= 2
314	mrs x8, id_aa64pfr0_el1
315	lsr x8, x8, #(ID_AA64PFR0_MPAM_SHIFT)
316	and x8, x8, #(ID_AA64PFR0_MPAM_MASK)
317	mrs x7, id_aa64pfr1_el1
318	lsr x7, x7, #(ID_AA64PFR1_MPAM_FRAC_SHIFT)
319	and x7, x7, #(ID_AA64PFR1_MPAM_FRAC_MASK)
320	orr x7, x7, x8
321	cbz x7, no_mpam
322#endif
323	/* -----------------------------------------------------------
324	 * Restore MPAM3_EL3 register as per context state
325	 * Currently we only enable MPAM for NS world and trap to EL3
326	 * for MPAM access in lower ELs of Secure and Realm world
327	 * x9 holds address of the per_world context
328	 * -----------------------------------------------------------
329	 */
330
331	ldr	x17, [x9, #CTX_MPAM3_EL3]
332	msr	S3_6_C10_C5_0, x17 /* mpam3_el3 */
333
334no_mpam:
335#endif
336	.endm /* restore_mpam3_el3 */
337
338/* ------------------------------------------------------------------
339 * The following macro is used to save all the general purpose
340 * registers and swap the FEAT_PAUTH keys with BL31's keys in
341 * cpu_data. It also checks if the Secure Cycle Counter (PMCCNTR_EL0)
342 * is disabled in EL3/Secure (ARMv8.5-PMU), wherein PMCCNTR_EL0 needs
343 * not to be saved/restored during world switch.
344 *
345 * Ideally we would only save and restore the callee saved registers
346 * when a world switch occurs but that type of implementation is more
347 * complex. So currently we will always save and restore these
348 * registers on entry and exit of EL3.
349 * clobbers: x18
350 * ------------------------------------------------------------------
351 */
352	.macro save_gp_pmcr_pauth_regs
353	stp	x0, x1, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X0]
354	stp	x2, x3, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X2]
355	stp	x4, x5, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X4]
356	stp	x6, x7, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X6]
357	stp	x8, x9, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X8]
358	stp	x10, x11, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X10]
359	stp	x12, x13, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X12]
360	stp	x14, x15, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X14]
361	stp	x16, x17, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X16]
362	stp	x18, x19, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X18]
363	stp	x20, x21, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X20]
364	stp	x22, x23, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X22]
365	stp	x24, x25, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X24]
366	stp	x26, x27, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X26]
367	stp	x28, x29, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X28]
368	mrs	x18, sp_el0
369	str	x18, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_SP_EL0]
370
371	/* PMUv3 is presumed to be always present */
372	mrs	x9, pmcr_el0
373	str	x9, [sp, #CTX_EL3STATE_OFFSET + CTX_PMCR_EL0]
374#if CTX_INCLUDE_PAUTH_REGS
375#if CTX_INCLUDE_PAUTH_REGS == 2
376	/* Skip if not present in hardware */
377	is_feat_pauth_present_asm x9, x10
378	beq	no_pauth_\@
379#endif
380	/* ----------------------------------------------------------
381 	 * Save the ARMv8.3-PAuth keys as they are not banked
382 	 * by exception level
383	 * ----------------------------------------------------------
384	 */
385	add	x19, sp, #CTX_PAUTH_REGS_OFFSET
386
387	mrs	x20, APIAKeyLo_EL1	/* x21:x20 = APIAKey */
388	mrs	x21, APIAKeyHi_EL1
389	mrs	x22, APIBKeyLo_EL1	/* x23:x22 = APIBKey */
390	mrs	x23, APIBKeyHi_EL1
391	mrs	x24, APDAKeyLo_EL1	/* x25:x24 = APDAKey */
392	mrs	x25, APDAKeyHi_EL1
393	mrs	x26, APDBKeyLo_EL1	/* x27:x26 = APDBKey */
394	mrs	x27, APDBKeyHi_EL1
395	mrs	x28, APGAKeyLo_EL1	/* x29:x28 = APGAKey */
396	mrs	x29, APGAKeyHi_EL1
397
398	stp	x20, x21, [x19, #CTX_PACIAKEY_LO]
399	stp	x22, x23, [x19, #CTX_PACIBKEY_LO]
400	stp	x24, x25, [x19, #CTX_PACDAKEY_LO]
401	stp	x26, x27, [x19, #CTX_PACDBKEY_LO]
402	stp	x28, x29, [x19, #CTX_PACGAKEY_LO]
403#if ENABLE_PAUTH
404#if IMAGE_BL31
405	/* tpidr_el3 contains the address of the cpu_data structure */
406	per_cpu_cur	percpu_data, x9, x10
407	/* Load APIAKey from cpu_data */
408	ldp	x10, x11, [x9, #CPU_DATA_APIAKEY]
409#endif /* IMAGE_BL31 */
410
411#if IMAGE_BL1
412	/* BL1 does not use cpu_data and has dedicated storage */
413	adr_l	x9, bl1_apiakey
414	ldp	x10, x11, [x9]
415#endif /* IMAGE_BL1 */
416
417	/* Program instruction key A */
418	msr	APIAKeyLo_EL1, x10
419	msr	APIAKeyHi_EL1, x11
420no_pauth_\@:
421#endif /* ENABLE_PAUTH */
422#endif /* CTX_INCLUDE_PAUTH_REGS */
423	.endm /* save_gp_pmcr_pauth_regs */
424
425/* -----------------------------------------------------------------
426 * This function saves the context and sets the PSTATE to a known
427 * state, preparing entry to el3.
428 * Save all the general purpose and ARMv8.3-PAuth (if enabled)
429 * registers.
430 * Then set any of the PSTATE bits that are not set by hardware
431 * according to the Aarch64.TakeException pseudocode in the Arm
432 * Architecture Reference Manual to a default value for EL3.
433 * clobbers: all registers. Will save lower EL's register contents.
434 * returns: a pointer to the current context structure (from sp_el3)
435 * -----------------------------------------------------------------
436 */
437func prepare_el3_entry
438	/*
439	 * context is about to mutate, so make sure we don't affect any still
440	 * in-flight profiling operations. We don't care that they actually
441	 * finish, that can still be later. NOP if not present
442	 */
443#if ENABLE_SPE_FOR_NS
444	psb_csync
445#endif
446#if ENABLE_TRBE_FOR_NS
447	tsb_csync
448#endif
449	isb
450	save_gp_pmcr_pauth_regs
451	setup_el3_execution_context
452
453	/* x0 will point to the context structure (SP_EL3) */
454	mov	x0, sp
455
456	/* Save the SPSR_EL3 and ELR_EL3 so that el3_exit works */
457	mrs	x28, spsr_el3
458	mrs	x29, elr_el3
459	stp	x28, x29, [x0, #CTX_EL3STATE_OFFSET + CTX_SPSR_EL3]
460
461	/*
462	 * Restore the saved C runtime stack value which will become the new
463	 * SP_EL0 i.e. EL3 runtime stack. It was saved in the 'cpu_context'
464	 * structure prior to the last ERET from EL3.
465	 */
466	ldr	x27, [x0, #CTX_EL3STATE_OFFSET + CTX_RUNTIME_SP]
467
468	/* Switch to SP_EL0 */
469	msr	spsel, #MODE_SP_EL0
470	mov	sp, x27
471
472	ret
473endfunc prepare_el3_entry
474
475/* ------------------------------------------------------------------
476 * This function restores ARMv8.3-PAuth (if enabled) and all general
477 * purpose registers except x30 from the CPU context.
478 * x30 register must be explicitly restored by the caller.
479 * ------------------------------------------------------------------
480 */
481func restore_gp_pmcr_pauth_regs
482#if CTX_INCLUDE_PAUTH_REGS
483#if CTX_INCLUDE_PAUTH_REGS == 2
484	/* Skip if not present in hardware */
485	is_feat_pauth_present_asm x0, x1
486	beq	no_pauth
487#endif
488 	/* Restore the ARMv8.3 PAuth keys */
489	add	x10, sp, #CTX_PAUTH_REGS_OFFSET
490
491	ldp	x0, x1, [x10, #CTX_PACIAKEY_LO]	/* x1:x0 = APIAKey */
492	ldp	x2, x3, [x10, #CTX_PACIBKEY_LO]	/* x3:x2 = APIBKey */
493	ldp	x4, x5, [x10, #CTX_PACDAKEY_LO]	/* x5:x4 = APDAKey */
494	ldp	x6, x7, [x10, #CTX_PACDBKEY_LO]	/* x7:x6 = APDBKey */
495	ldp	x8, x9, [x10, #CTX_PACGAKEY_LO]	/* x9:x8 = APGAKey */
496
497	msr	APIAKeyLo_EL1, x0
498	msr	APIAKeyHi_EL1, x1
499	msr	APIBKeyLo_EL1, x2
500	msr	APIBKeyHi_EL1, x3
501	msr	APDAKeyLo_EL1, x4
502	msr	APDAKeyHi_EL1, x5
503	msr	APDBKeyLo_EL1, x6
504	msr	APDBKeyHi_EL1, x7
505	msr	APGAKeyLo_EL1, x8
506	msr	APGAKeyHi_EL1, x9
507no_pauth:
508#endif /* CTX_INCLUDE_PAUTH_REGS */
509
510	/* PMUv3 is presumed to be always present */
511	ldr	x0, [sp, #CTX_EL3STATE_OFFSET + CTX_PMCR_EL0]
512	msr	pmcr_el0, x0
513	ldp	x0, x1, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X0]
514	ldp	x2, x3, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X2]
515	ldp	x4, x5, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X4]
516	ldp	x6, x7, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X6]
517	ldp	x8, x9, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X8]
518	ldp	x10, x11, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X10]
519	ldp	x12, x13, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X12]
520	ldp	x14, x15, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X14]
521	ldp	x16, x17, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X16]
522	ldp	x18, x19, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X18]
523	ldp	x20, x21, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X20]
524	ldp	x22, x23, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X22]
525	ldp	x24, x25, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X24]
526	ldp	x26, x27, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X26]
527	ldr	x28, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_SP_EL0]
528	msr	sp_el0, x28
529	ldp	x28, x29, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X28]
530	ret
531endfunc restore_gp_pmcr_pauth_regs
532
533#if ERRATA_SPECULATIVE_AT
534/* --------------------------------------------------------------------
535 * In case of ERRATA_SPECULATIVE_AT, save SCTLR_EL1 and TCR_EL1
536 * registers and update EL1 registers to disable stage1 and stage2
537 * page table walk.
538 * --------------------------------------------------------------------
539 */
540func save_and_update_ptw_el1_sys_regs
541	/* ----------------------------------------------------------
542	 * Save only sctlr_el1 and tcr_el1 registers
543	 * ----------------------------------------------------------
544	 */
545	mrs	x29, sctlr_el1
546	str	x29, [sp, #(CTX_ERRATA_SPEC_AT_OFFSET + CTX_ERRATA_SPEC_AT_SCTLR_EL1)]
547	mrs	x29, tcr_el1
548	str	x29, [sp, #(CTX_ERRATA_SPEC_AT_OFFSET + CTX_ERRATA_SPEC_AT_TCR_EL1)]
549
550	/* ------------------------------------------------------------
551	 * Must follow below order in order to disable page table
552	 * walk for lower ELs (EL1 and EL0). First step ensures that
553	 * page table walk is disabled for stage1 and second step
554	 * ensures that page table walker should use TCR_EL1.EPDx
555	 * bits to perform address translation. ISB ensures that CPU
556	 * does these 2 steps in order.
557	 *
558	 * 1. Update TCR_EL1.EPDx bits to disable page table walk by
559	 *    stage1.
560	 * 2. Enable MMU bit to avoid identity mapping via stage2
561	 *    and force TCR_EL1.EPDx to be used by the page table
562	 *    walker.
563	 * ------------------------------------------------------------
564	 */
565	orr	x29, x29, #(TCR_EPD0_BIT)
566	orr	x29, x29, #(TCR_EPD1_BIT)
567	msr	tcr_el1, x29
568	isb
569	mrs	x29, sctlr_el1
570	orr	x29, x29, #SCTLR_M_BIT
571	msr	sctlr_el1, x29
572	isb
573	ret
574endfunc save_and_update_ptw_el1_sys_regs
575
576#endif /* ERRATA_SPECULATIVE_AT */
577
578/* -----------------------------------------------------------------
579* The below macro returns the address of the per_world context for
580* the security state, retrieved through "get_security_state" macro.
581* The per_world context address is returned in the register argument.
582* Clobbers: x9, x10
583* ------------------------------------------------------------------
584*/
585
586.macro get_per_world_context _reg:req
587	ldr 	x10, [sp, #CTX_EL3STATE_OFFSET + CTX_SCR_EL3]
588	get_security_state x9, x10
589	mov_imm	x10, (CTX_PERWORLD_EL3STATE_END - CTX_CPTR_EL3)
590	mul	x9, x9, x10
591	adrp	x10, per_world_context
592	add	x10, x10, :lo12:per_world_context
593	add	x9, x9, x10
594	mov 	\_reg, x9
595.endm
596
597/* ------------------------------------------------------------------
598 * This routine assumes that the SP_EL3 is pointing to a valid
599 * context structure from where the gp regs and other special
600 * registers can be retrieved.
601 * ------------------------------------------------------------------
602 */
603func el3_exit
604#if ENABLE_ASSERTIONS
605	/* el3_exit assumes SP_EL0 on entry */
606	mrs	x17, spsel
607	cmp	x17, #MODE_SP_EL0
608	ASM_ASSERT(eq)
609#endif /* ENABLE_ASSERTIONS */
610
611	/* ----------------------------------------------------------
612	 * Save the current SP_EL0 i.e. the EL3 runtime stack which
613	 * will be used for handling the next SMC.
614	 * Then switch to SP_EL3.
615	 * ----------------------------------------------------------
616	 */
617	mov	x17, sp
618	msr	spsel, #MODE_SP_ELX
619	str	x17, [sp, #CTX_EL3STATE_OFFSET + CTX_RUNTIME_SP]
620
621	/* ----------------------------------------------------------
622	 * Restore CPTR_EL3.
623	 * ---------------------------------------------------------- */
624
625	/* The address of the per_world context is stored in x9 */
626	get_per_world_context x9
627
628	ldp	x19, x20, [x9, #CTX_CPTR_EL3]
629	msr	cptr_el3, x19
630
631#if IMAGE_BL31
632	restore_mpam3_el3
633
634#endif /* IMAGE_BL31 */
635
636#if IMAGE_BL31 && DYNAMIC_WORKAROUND_CVE_2018_3639
637	/* ----------------------------------------------------------
638	 * Restore mitigation state as it was on entry to EL3
639	 * ----------------------------------------------------------
640	 */
641	ldr	x17, [sp, #CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_DISABLE]
642	cbz	x17, 1f
643	blr	x17
6441:
645#endif /* IMAGE_BL31 && DYNAMIC_WORKAROUND_CVE_2018_3639 */
646
647#if IMAGE_BL31
648	synchronize_errors
649#endif /* IMAGE_BL31 */
650
651	/* --------------------------------------------------------------
652	 * Restore MDCR_EL3, SPSR_EL3, ELR_EL3 and SCR_EL3 prior to ERET
653	 * --------------------------------------------------------------
654	 */
655	ldp	x16, x17, [sp, #CTX_EL3STATE_OFFSET + CTX_SPSR_EL3]
656	ldr	x18, [sp, #CTX_EL3STATE_OFFSET + CTX_SCR_EL3]
657	ldr	x19, [sp, #CTX_EL3STATE_OFFSET + CTX_MDCR_EL3]
658	msr	spsr_el3, x16
659	msr	elr_el3, x17
660	msr	scr_el3, x18
661	msr	mdcr_el3, x19
662
663	restore_ptw_el1_sys_regs
664
665	/* ----------------------------------------------------------
666	 * Restore general purpose (including x30), PMCR_EL0 and
667	 * ARMv8.3-PAuth registers.
668	 * Exit EL3 via ERET to a lower exception level.
669 	 * ----------------------------------------------------------
670 	 */
671	bl	restore_gp_pmcr_pauth_regs
672	ldr	x30, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_LR]
673
674#ifdef IMAGE_BL31
675	/* Clear the EL3 flag as we are exiting el3 */
676	str	xzr, [sp, #CTX_EL3STATE_OFFSET + CTX_NESTED_EA_FLAG]
677#endif /* IMAGE_BL31 */
678
679	exception_return
680
681endfunc el3_exit
682