xref: /rk3399_ARM-atf/lib/el3_runtime/aarch64/context.S (revision ed8f06ddda52bc0333f79e9ff798419e67771ae5)
1/*
2 * Copyright (c) 2013-2023, 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
13	.global	el1_sysregs_context_save
14	.global	el1_sysregs_context_restore
15#if CTX_INCLUDE_FPREGS
16	.global	fpregs_context_save
17	.global	fpregs_context_restore
18#endif /* CTX_INCLUDE_FPREGS */
19	.global	prepare_el3_entry
20	.global	restore_gp_pmcr_pauth_regs
21	.global save_and_update_ptw_el1_sys_regs
22	.global	el3_exit
23
24
25/* ------------------------------------------------------------------
26 * The following function strictly follows the AArch64 PCS to use
27 * x9-x17 (temporary caller-saved registers) to save EL1 system
28 * register context. It assumes that 'x0' is pointing to a
29 * 'el1_sys_regs' structure where the register context will be saved.
30 * ------------------------------------------------------------------
31 */
32func el1_sysregs_context_save
33
34	mrs	x9, spsr_el1
35	mrs	x10, elr_el1
36	stp	x9, x10, [x0, #CTX_SPSR_EL1]
37
38#if !ERRATA_SPECULATIVE_AT
39	mrs	x15, sctlr_el1
40	mrs	x16, tcr_el1
41	stp	x15, x16, [x0, #CTX_SCTLR_EL1]
42#endif /* ERRATA_SPECULATIVE_AT */
43
44	mrs	x17, cpacr_el1
45	mrs	x9, csselr_el1
46	stp	x17, x9, [x0, #CTX_CPACR_EL1]
47
48	mrs	x10, sp_el1
49	mrs	x11, esr_el1
50	stp	x10, x11, [x0, #CTX_SP_EL1]
51
52	mrs	x12, ttbr0_el1
53	mrs	x13, ttbr1_el1
54	stp	x12, x13, [x0, #CTX_TTBR0_EL1]
55
56	mrs	x14, mair_el1
57	mrs	x15, amair_el1
58	stp	x14, x15, [x0, #CTX_MAIR_EL1]
59
60	mrs	x16, actlr_el1
61	mrs	x17, tpidr_el1
62	stp	x16, x17, [x0, #CTX_ACTLR_EL1]
63
64	mrs	x9, tpidr_el0
65	mrs	x10, tpidrro_el0
66	stp	x9, x10, [x0, #CTX_TPIDR_EL0]
67
68	mrs	x13, par_el1
69	mrs	x14, far_el1
70	stp	x13, x14, [x0, #CTX_PAR_EL1]
71
72	mrs	x15, afsr0_el1
73	mrs	x16, afsr1_el1
74	stp	x15, x16, [x0, #CTX_AFSR0_EL1]
75
76	mrs	x17, contextidr_el1
77	mrs	x9, vbar_el1
78	stp	x17, x9, [x0, #CTX_CONTEXTIDR_EL1]
79
80	/* Save AArch32 system registers if the build has instructed so */
81#if CTX_INCLUDE_AARCH32_REGS
82	mrs	x11, spsr_abt
83	mrs	x12, spsr_und
84	stp	x11, x12, [x0, #CTX_SPSR_ABT]
85
86	mrs	x13, spsr_irq
87	mrs	x14, spsr_fiq
88	stp	x13, x14, [x0, #CTX_SPSR_IRQ]
89
90	mrs	x15, dacr32_el2
91	mrs	x16, ifsr32_el2
92	stp	x15, x16, [x0, #CTX_DACR32_EL2]
93#endif /* CTX_INCLUDE_AARCH32_REGS */
94
95	/* Save NS timer registers if the build has instructed so */
96#if NS_TIMER_SWITCH
97	mrs	x10, cntp_ctl_el0
98	mrs	x11, cntp_cval_el0
99	stp	x10, x11, [x0, #CTX_CNTP_CTL_EL0]
100
101	mrs	x12, cntv_ctl_el0
102	mrs	x13, cntv_cval_el0
103	stp	x12, x13, [x0, #CTX_CNTV_CTL_EL0]
104
105	mrs	x14, cntkctl_el1
106	str	x14, [x0, #CTX_CNTKCTL_EL1]
107#endif /* NS_TIMER_SWITCH */
108
109	/* Save MTE system registers if the build has instructed so */
110#if CTX_INCLUDE_MTE_REGS
111	mrs	x15, TFSRE0_EL1
112	mrs	x16, TFSR_EL1
113	stp	x15, x16, [x0, #CTX_TFSRE0_EL1]
114
115	mrs	x9, RGSR_EL1
116	mrs	x10, GCR_EL1
117	stp	x9, x10, [x0, #CTX_RGSR_EL1]
118#endif /* CTX_INCLUDE_MTE_REGS */
119
120	ret
121endfunc el1_sysregs_context_save
122
123/* ------------------------------------------------------------------
124 * The following function strictly follows the AArch64 PCS to use
125 * x9-x17 (temporary caller-saved registers) to restore EL1 system
126 * register context.  It assumes that 'x0' is pointing to a
127 * 'el1_sys_regs' structure from where the register context will be
128 * restored
129 * ------------------------------------------------------------------
130 */
131func el1_sysregs_context_restore
132
133	ldp	x9, x10, [x0, #CTX_SPSR_EL1]
134	msr	spsr_el1, x9
135	msr	elr_el1, x10
136
137#if !ERRATA_SPECULATIVE_AT
138	ldp	x15, x16, [x0, #CTX_SCTLR_EL1]
139	msr	sctlr_el1, x15
140	msr	tcr_el1, x16
141#endif /* ERRATA_SPECULATIVE_AT */
142
143	ldp	x17, x9, [x0, #CTX_CPACR_EL1]
144	msr	cpacr_el1, x17
145	msr	csselr_el1, x9
146
147	ldp	x10, x11, [x0, #CTX_SP_EL1]
148	msr	sp_el1, x10
149	msr	esr_el1, x11
150
151	ldp	x12, x13, [x0, #CTX_TTBR0_EL1]
152	msr	ttbr0_el1, x12
153	msr	ttbr1_el1, x13
154
155	ldp	x14, x15, [x0, #CTX_MAIR_EL1]
156	msr	mair_el1, x14
157	msr	amair_el1, x15
158
159	ldp 	x16, x17, [x0, #CTX_ACTLR_EL1]
160	msr	actlr_el1, x16
161	msr	tpidr_el1, x17
162
163	ldp	x9, x10, [x0, #CTX_TPIDR_EL0]
164	msr	tpidr_el0, x9
165	msr	tpidrro_el0, x10
166
167	ldp	x13, x14, [x0, #CTX_PAR_EL1]
168	msr	par_el1, x13
169	msr	far_el1, x14
170
171	ldp	x15, x16, [x0, #CTX_AFSR0_EL1]
172	msr	afsr0_el1, x15
173	msr	afsr1_el1, x16
174
175	ldp	x17, x9, [x0, #CTX_CONTEXTIDR_EL1]
176	msr	contextidr_el1, x17
177	msr	vbar_el1, x9
178
179	/* Restore AArch32 system registers if the build has instructed so */
180#if CTX_INCLUDE_AARCH32_REGS
181	ldp	x11, x12, [x0, #CTX_SPSR_ABT]
182	msr	spsr_abt, x11
183	msr	spsr_und, x12
184
185	ldp	x13, x14, [x0, #CTX_SPSR_IRQ]
186	msr	spsr_irq, x13
187	msr	spsr_fiq, x14
188
189	ldp	x15, x16, [x0, #CTX_DACR32_EL2]
190	msr	dacr32_el2, x15
191	msr	ifsr32_el2, x16
192#endif /* CTX_INCLUDE_AARCH32_REGS */
193
194	/* Restore NS timer registers if the build has instructed so */
195#if NS_TIMER_SWITCH
196	ldp	x10, x11, [x0, #CTX_CNTP_CTL_EL0]
197	msr	cntp_ctl_el0, x10
198	msr	cntp_cval_el0, x11
199
200	ldp	x12, x13, [x0, #CTX_CNTV_CTL_EL0]
201	msr	cntv_ctl_el0, x12
202	msr	cntv_cval_el0, x13
203
204	ldr	x14, [x0, #CTX_CNTKCTL_EL1]
205	msr	cntkctl_el1, x14
206#endif /* NS_TIMER_SWITCH */
207
208	/* Restore MTE system registers if the build has instructed so */
209#if CTX_INCLUDE_MTE_REGS
210	ldp	x11, x12, [x0, #CTX_TFSRE0_EL1]
211	msr	TFSRE0_EL1, x11
212	msr	TFSR_EL1, x12
213
214	ldp	x13, x14, [x0, #CTX_RGSR_EL1]
215	msr	RGSR_EL1, x13
216	msr	GCR_EL1, x14
217#endif /* CTX_INCLUDE_MTE_REGS */
218
219	/* No explict ISB required here as ERET covers it */
220	ret
221endfunc el1_sysregs_context_restore
222
223/* ------------------------------------------------------------------
224 * The following function follows the aapcs_64 strictly to use
225 * x9-x17 (temporary caller-saved registers according to AArch64 PCS)
226 * to save floating point register context. It assumes that 'x0' is
227 * pointing to a 'fp_regs' structure where the register context will
228 * be saved.
229 *
230 * Access to VFP registers will trap if CPTR_EL3.TFP is set.
231 * However currently we don't use VFP registers nor set traps in
232 * Trusted Firmware, and assume it's cleared.
233 *
234 * TODO: Revisit when VFP is used in secure world
235 * ------------------------------------------------------------------
236 */
237#if CTX_INCLUDE_FPREGS
238func fpregs_context_save
239	stp	q0, q1, [x0, #CTX_FP_Q0]
240	stp	q2, q3, [x0, #CTX_FP_Q2]
241	stp	q4, q5, [x0, #CTX_FP_Q4]
242	stp	q6, q7, [x0, #CTX_FP_Q6]
243	stp	q8, q9, [x0, #CTX_FP_Q8]
244	stp	q10, q11, [x0, #CTX_FP_Q10]
245	stp	q12, q13, [x0, #CTX_FP_Q12]
246	stp	q14, q15, [x0, #CTX_FP_Q14]
247	stp	q16, q17, [x0, #CTX_FP_Q16]
248	stp	q18, q19, [x0, #CTX_FP_Q18]
249	stp	q20, q21, [x0, #CTX_FP_Q20]
250	stp	q22, q23, [x0, #CTX_FP_Q22]
251	stp	q24, q25, [x0, #CTX_FP_Q24]
252	stp	q26, q27, [x0, #CTX_FP_Q26]
253	stp	q28, q29, [x0, #CTX_FP_Q28]
254	stp	q30, q31, [x0, #CTX_FP_Q30]
255
256	mrs	x9, fpsr
257	str	x9, [x0, #CTX_FP_FPSR]
258
259	mrs	x10, fpcr
260	str	x10, [x0, #CTX_FP_FPCR]
261
262#if CTX_INCLUDE_AARCH32_REGS
263	mrs	x11, fpexc32_el2
264	str	x11, [x0, #CTX_FP_FPEXC32_EL2]
265#endif /* CTX_INCLUDE_AARCH32_REGS */
266	ret
267endfunc fpregs_context_save
268
269/* ------------------------------------------------------------------
270 * The following function follows the aapcs_64 strictly to use x9-x17
271 * (temporary caller-saved registers according to AArch64 PCS) to
272 * restore floating point register context. It assumes that 'x0' is
273 * pointing to a 'fp_regs' structure from where the register context
274 * will be restored.
275 *
276 * Access to VFP registers will trap if CPTR_EL3.TFP is set.
277 * However currently we don't use VFP registers nor set traps in
278 * Trusted Firmware, and assume it's cleared.
279 *
280 * TODO: Revisit when VFP is used in secure world
281 * ------------------------------------------------------------------
282 */
283func fpregs_context_restore
284	ldp	q0, q1, [x0, #CTX_FP_Q0]
285	ldp	q2, q3, [x0, #CTX_FP_Q2]
286	ldp	q4, q5, [x0, #CTX_FP_Q4]
287	ldp	q6, q7, [x0, #CTX_FP_Q6]
288	ldp	q8, q9, [x0, #CTX_FP_Q8]
289	ldp	q10, q11, [x0, #CTX_FP_Q10]
290	ldp	q12, q13, [x0, #CTX_FP_Q12]
291	ldp	q14, q15, [x0, #CTX_FP_Q14]
292	ldp	q16, q17, [x0, #CTX_FP_Q16]
293	ldp	q18, q19, [x0, #CTX_FP_Q18]
294	ldp	q20, q21, [x0, #CTX_FP_Q20]
295	ldp	q22, q23, [x0, #CTX_FP_Q22]
296	ldp	q24, q25, [x0, #CTX_FP_Q24]
297	ldp	q26, q27, [x0, #CTX_FP_Q26]
298	ldp	q28, q29, [x0, #CTX_FP_Q28]
299	ldp	q30, q31, [x0, #CTX_FP_Q30]
300
301	ldr	x9, [x0, #CTX_FP_FPSR]
302	msr	fpsr, x9
303
304	ldr	x10, [x0, #CTX_FP_FPCR]
305	msr	fpcr, x10
306
307#if CTX_INCLUDE_AARCH32_REGS
308	ldr	x11, [x0, #CTX_FP_FPEXC32_EL2]
309	msr	fpexc32_el2, x11
310#endif /* CTX_INCLUDE_AARCH32_REGS */
311
312	/*
313	 * No explict ISB required here as ERET to
314	 * switch to secure EL1 or non-secure world
315	 * covers it
316	 */
317
318	ret
319endfunc fpregs_context_restore
320#endif /* CTX_INCLUDE_FPREGS */
321
322	/*
323	 * Set SCR_EL3.EA bit to enable SErrors at EL3
324	 */
325	.macro enable_serror_at_el3
326	mrs     x8, scr_el3
327	orr     x8, x8, #SCR_EA_BIT
328	msr     scr_el3, x8
329	.endm
330
331	/*
332	 * Set the PSTATE bits not set when the exception was taken as
333	 * described in the AArch64.TakeException() pseudocode function
334	 * in ARM DDI 0487F.c page J1-7635 to a default value.
335	 */
336	.macro set_unset_pstate_bits
337	/*
338	 * If Data Independent Timing (DIT) functionality is implemented,
339	 * always enable DIT in EL3
340	 */
341#if ENABLE_FEAT_DIT
342#if ENABLE_FEAT_DIT == 2
343	mrs	x8, id_aa64pfr0_el1
344	and	x8, x8, #(ID_AA64PFR0_DIT_MASK << ID_AA64PFR0_DIT_SHIFT)
345	cbz	x8, 1f
346#endif
347	mov     x8, #DIT_BIT
348	msr     DIT, x8
3491:
350#endif /* ENABLE_FEAT_DIT */
351	.endm /* set_unset_pstate_bits */
352
353/* ------------------------------------------------------------------
354 * The following macro is used to save and restore all the general
355 * purpose and ARMv8.3-PAuth (if enabled) registers.
356 * It also checks if the Secure Cycle Counter (PMCCNTR_EL0)
357 * is disabled in EL3/Secure (ARMv8.5-PMU), wherein PMCCNTR_EL0
358 * needs not to be saved/restored during world switch.
359 *
360 * Ideally we would only save and restore the callee saved registers
361 * when a world switch occurs but that type of implementation is more
362 * complex. So currently we will always save and restore these
363 * registers on entry and exit of EL3.
364 * clobbers: x18
365 * ------------------------------------------------------------------
366 */
367	.macro save_gp_pmcr_pauth_regs
368	stp	x0, x1, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X0]
369	stp	x2, x3, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X2]
370	stp	x4, x5, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X4]
371	stp	x6, x7, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X6]
372	stp	x8, x9, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X8]
373	stp	x10, x11, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X10]
374	stp	x12, x13, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X12]
375	stp	x14, x15, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X14]
376	stp	x16, x17, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X16]
377	stp	x18, x19, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X18]
378	stp	x20, x21, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X20]
379	stp	x22, x23, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X22]
380	stp	x24, x25, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X24]
381	stp	x26, x27, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X26]
382	stp	x28, x29, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X28]
383	mrs	x18, sp_el0
384	str	x18, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_SP_EL0]
385
386	/* PMUv3 is presumed to be always present */
387	mrs	x9, pmcr_el0
388	str	x9, [sp, #CTX_EL3STATE_OFFSET + CTX_PMCR_EL0]
389	/* Disable cycle counter when event counting is prohibited */
390	orr	x9, x9, #PMCR_EL0_DP_BIT
391	msr	pmcr_el0, x9
392	isb
393#if CTX_INCLUDE_PAUTH_REGS
394	/* ----------------------------------------------------------
395 	 * Save the ARMv8.3-PAuth keys as they are not banked
396 	 * by exception level
397	 * ----------------------------------------------------------
398	 */
399	add	x19, sp, #CTX_PAUTH_REGS_OFFSET
400
401	mrs	x20, APIAKeyLo_EL1	/* x21:x20 = APIAKey */
402	mrs	x21, APIAKeyHi_EL1
403	mrs	x22, APIBKeyLo_EL1	/* x23:x22 = APIBKey */
404	mrs	x23, APIBKeyHi_EL1
405	mrs	x24, APDAKeyLo_EL1	/* x25:x24 = APDAKey */
406	mrs	x25, APDAKeyHi_EL1
407	mrs	x26, APDBKeyLo_EL1	/* x27:x26 = APDBKey */
408	mrs	x27, APDBKeyHi_EL1
409	mrs	x28, APGAKeyLo_EL1	/* x29:x28 = APGAKey */
410	mrs	x29, APGAKeyHi_EL1
411
412	stp	x20, x21, [x19, #CTX_PACIAKEY_LO]
413	stp	x22, x23, [x19, #CTX_PACIBKEY_LO]
414	stp	x24, x25, [x19, #CTX_PACDAKEY_LO]
415	stp	x26, x27, [x19, #CTX_PACDBKEY_LO]
416	stp	x28, x29, [x19, #CTX_PACGAKEY_LO]
417#endif /* CTX_INCLUDE_PAUTH_REGS */
418	.endm /* save_gp_pmcr_pauth_regs */
419
420/* -----------------------------------------------------------------
421 * This function saves the context and sets the PSTATE to a known
422 * state, preparing entry to el3.
423 * Save all the general purpose and ARMv8.3-PAuth (if enabled)
424 * registers.
425 * Then set any of the PSTATE bits that are not set by hardware
426 * according to the Aarch64.TakeException pseudocode in the Arm
427 * Architecture Reference Manual to a default value for EL3.
428 * clobbers: x17
429 * -----------------------------------------------------------------
430 */
431func prepare_el3_entry
432	save_gp_pmcr_pauth_regs
433	enable_serror_at_el3
434	/*
435	 * Set the PSTATE bits not described in the Aarch64.TakeException
436	 * pseudocode to their default values.
437	 */
438	set_unset_pstate_bits
439	ret
440endfunc prepare_el3_entry
441
442/* ------------------------------------------------------------------
443 * This function restores ARMv8.3-PAuth (if enabled) and all general
444 * purpose registers except x30 from the CPU context.
445 * x30 register must be explicitly restored by the caller.
446 * ------------------------------------------------------------------
447 */
448func restore_gp_pmcr_pauth_regs
449#if CTX_INCLUDE_PAUTH_REGS
450 	/* Restore the ARMv8.3 PAuth keys */
451	add	x10, sp, #CTX_PAUTH_REGS_OFFSET
452
453	ldp	x0, x1, [x10, #CTX_PACIAKEY_LO]	/* x1:x0 = APIAKey */
454	ldp	x2, x3, [x10, #CTX_PACIBKEY_LO]	/* x3:x2 = APIBKey */
455	ldp	x4, x5, [x10, #CTX_PACDAKEY_LO]	/* x5:x4 = APDAKey */
456	ldp	x6, x7, [x10, #CTX_PACDBKEY_LO]	/* x7:x6 = APDBKey */
457	ldp	x8, x9, [x10, #CTX_PACGAKEY_LO]	/* x9:x8 = APGAKey */
458
459	msr	APIAKeyLo_EL1, x0
460	msr	APIAKeyHi_EL1, x1
461	msr	APIBKeyLo_EL1, x2
462	msr	APIBKeyHi_EL1, x3
463	msr	APDAKeyLo_EL1, x4
464	msr	APDAKeyHi_EL1, x5
465	msr	APDBKeyLo_EL1, x6
466	msr	APDBKeyHi_EL1, x7
467	msr	APGAKeyLo_EL1, x8
468	msr	APGAKeyHi_EL1, x9
469#endif /* CTX_INCLUDE_PAUTH_REGS */
470
471	/* PMUv3 is presumed to be always present */
472	ldr	x0, [sp, #CTX_EL3STATE_OFFSET + CTX_PMCR_EL0]
473	msr	pmcr_el0, x0
474	ldp	x0, x1, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X0]
475	ldp	x2, x3, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X2]
476	ldp	x4, x5, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X4]
477	ldp	x6, x7, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X6]
478	ldp	x8, x9, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X8]
479	ldp	x10, x11, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X10]
480	ldp	x12, x13, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X12]
481	ldp	x14, x15, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X14]
482	ldp	x16, x17, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X16]
483	ldp	x18, x19, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X18]
484	ldp	x20, x21, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X20]
485	ldp	x22, x23, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X22]
486	ldp	x24, x25, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X24]
487	ldp	x26, x27, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X26]
488	ldr	x28, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_SP_EL0]
489	msr	sp_el0, x28
490	ldp	x28, x29, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X28]
491	ret
492endfunc restore_gp_pmcr_pauth_regs
493
494/*
495 * In case of ERRATA_SPECULATIVE_AT, save SCTLR_EL1 and TCR_EL1
496 * registers and update EL1 registers to disable stage1 and stage2
497 * page table walk
498 */
499func save_and_update_ptw_el1_sys_regs
500	/* ----------------------------------------------------------
501	 * Save only sctlr_el1 and tcr_el1 registers
502	 * ----------------------------------------------------------
503	 */
504	mrs	x29, sctlr_el1
505	str	x29, [sp, #(CTX_EL1_SYSREGS_OFFSET + CTX_SCTLR_EL1)]
506	mrs	x29, tcr_el1
507	str	x29, [sp, #(CTX_EL1_SYSREGS_OFFSET + CTX_TCR_EL1)]
508
509	/* ------------------------------------------------------------
510	 * Must follow below order in order to disable page table
511	 * walk for lower ELs (EL1 and EL0). First step ensures that
512	 * page table walk is disabled for stage1 and second step
513	 * ensures that page table walker should use TCR_EL1.EPDx
514	 * bits to perform address translation. ISB ensures that CPU
515	 * does these 2 steps in order.
516	 *
517	 * 1. Update TCR_EL1.EPDx bits to disable page table walk by
518	 *    stage1.
519	 * 2. Enable MMU bit to avoid identity mapping via stage2
520	 *    and force TCR_EL1.EPDx to be used by the page table
521	 *    walker.
522	 * ------------------------------------------------------------
523	 */
524	orr	x29, x29, #(TCR_EPD0_BIT)
525	orr	x29, x29, #(TCR_EPD1_BIT)
526	msr	tcr_el1, x29
527	isb
528	mrs	x29, sctlr_el1
529	orr	x29, x29, #SCTLR_M_BIT
530	msr	sctlr_el1, x29
531	isb
532
533	ret
534endfunc save_and_update_ptw_el1_sys_regs
535
536/* ------------------------------------------------------------------
537 * This routine assumes that the SP_EL3 is pointing to a valid
538 * context structure from where the gp regs and other special
539 * registers can be retrieved.
540 * ------------------------------------------------------------------
541 */
542func el3_exit
543#if ENABLE_ASSERTIONS
544	/* el3_exit assumes SP_EL0 on entry */
545	mrs	x17, spsel
546	cmp	x17, #MODE_SP_EL0
547	ASM_ASSERT(eq)
548#endif /* ENABLE_ASSERTIONS */
549
550	/* ----------------------------------------------------------
551	 * Save the current SP_EL0 i.e. the EL3 runtime stack which
552	 * will be used for handling the next SMC.
553	 * Then switch to SP_EL3.
554	 * ----------------------------------------------------------
555	 */
556	mov	x17, sp
557	msr	spsel, #MODE_SP_ELX
558	str	x17, [sp, #CTX_EL3STATE_OFFSET + CTX_RUNTIME_SP]
559
560#if IMAGE_BL31
561	/* ----------------------------------------------------------
562	 * Restore CPTR_EL3.
563	 * ZCR is only restored if SVE is supported and enabled.
564	 * Synchronization is required before zcr_el3 is addressed.
565	 * ----------------------------------------------------------
566	 */
567	ldp	x19, x20, [sp, #CTX_EL3STATE_OFFSET + CTX_CPTR_EL3]
568	msr	cptr_el3, x19
569
570	ands	x19, x19, #CPTR_EZ_BIT
571	beq	sve_not_enabled
572
573	isb
574	msr	S3_6_C1_C2_0, x20 /* zcr_el3 */
575sve_not_enabled:
576#endif /* IMAGE_BL31 */
577
578#if IMAGE_BL31 && DYNAMIC_WORKAROUND_CVE_2018_3639
579	/* ----------------------------------------------------------
580	 * Restore mitigation state as it was on entry to EL3
581	 * ----------------------------------------------------------
582	 */
583	ldr	x17, [sp, #CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_DISABLE]
584	cbz	x17, 1f
585	blr	x17
5861:
587#endif /* IMAGE_BL31 && DYNAMIC_WORKAROUND_CVE_2018_3639 */
588
589/*
590 * This is a hot path, so we don't want to do some actual FEAT_RAS runtime
591 * detection here. The "esb" is a cheaper variant, so using "dsb" in the
592 * ENABLE_FEAT_RAS==2 case is not ideal, but won't hurt.
593 */
594#if IMAGE_BL31 && ENABLE_FEAT_RAS == 1
595	/* ----------------------------------------------------------
596	 * Issue Error Synchronization Barrier to synchronize SErrors
597	 * before exiting EL3. We're running with EAs unmasked, so
598	 * any synchronized errors would be taken immediately;
599	 * therefore no need to inspect DISR_EL1 register.
600 	 * ----------------------------------------------------------
601	 */
602	esb
603#else
604	dsb	sy
605#endif /* IMAGE_BL31 && ENABLE_FEAT_RAS */
606
607	/* ----------------------------------------------------------
608	 * Restore SPSR_EL3, ELR_EL3 and SCR_EL3 prior to ERET
609	 * ----------------------------------------------------------
610	 */
611	ldr	x18, [sp, #CTX_EL3STATE_OFFSET + CTX_SCR_EL3]
612	ldp	x16, x17, [sp, #CTX_EL3STATE_OFFSET + CTX_SPSR_EL3]
613	msr	scr_el3, x18
614	msr	spsr_el3, x16
615	msr	elr_el3, x17
616
617	restore_ptw_el1_sys_regs
618
619	/* ----------------------------------------------------------
620	 * Restore general purpose (including x30), PMCR_EL0 and
621	 * ARMv8.3-PAuth registers.
622	 * Exit EL3 via ERET to a lower exception level.
623 	 * ----------------------------------------------------------
624 	 */
625	bl	restore_gp_pmcr_pauth_regs
626	ldr	x30, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_LR]
627
628#ifdef IMAGE_BL31
629	str	xzr, [sp, #CTX_EL3STATE_OFFSET + CTX_IS_IN_EL3]
630#endif /* IMAGE_BL31 */
631
632	exception_return
633
634endfunc el3_exit
635