blob: 243a372827f4e47cb02dd6d1d3553436b3e137dc [file] [log] [blame]
Achin Gupta9ac63c52014-01-16 12:08:03 +00001/*
Boyan Karatotev0a580b52024-11-15 15:03:02 +00002 * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.
Achin Gupta9ac63c52014-01-16 12:08:03 +00003 *
dp-arm82cb2c12017-05-03 09:38:09 +01004 * SPDX-License-Identifier: BSD-3-Clause
Achin Gupta9ac63c52014-01-16 12:08:03 +00005 */
6
Dan Handley97043ac2014-04-09 13:14:54 +01007#include <arch.h>
Andrew Thoelke0a30cf52014-03-18 13:46:55 +00008#include <asm_macros.S>
Jan Dabrosbb9549b2019-12-02 13:30:03 +01009#include <assert_macros.S>
Dan Handley97043ac2014-04-09 13:14:54 +010010#include <context.h>
Manish V Badarkhe3b8456b2020-07-23 12:43:25 +010011#include <el3_common_macros.S>
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -050012#include <platform_def.h>
Achin Gupta9ac63c52014-01-16 12:08:03 +000013
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +010014#if CTX_INCLUDE_FPREGS
15 .global fpregs_context_save
16 .global fpregs_context_restore
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +000017#endif /* CTX_INCLUDE_FPREGS */
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +010018
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -050019#if CTX_INCLUDE_SVE_REGS
20 .global sve_context_save
21 .global sve_context_restore
22#endif /* CTX_INCLUDE_SVE_REGS */
23
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +010024#if ERRATA_SPECULATIVE_AT
25 .global save_and_update_ptw_el1_sys_regs
26#endif /* ERRATA_SPECULATIVE_AT */
27
Daniel Boulby97215e02022-01-19 11:20:05 +000028 .global prepare_el3_entry
Alexei Fedoroved108b52019-09-13 14:11:59 +010029 .global restore_gp_pmcr_pauth_regs
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +010030 .global el3_exit
31
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -050032/* Following macros will be used if any of CTX_INCLUDE_FPREGS or CTX_INCLUDE_SVE_REGS is enabled */
33#if CTX_INCLUDE_FPREGS || CTX_INCLUDE_SVE_REGS
34.macro fpregs_state_save base:req hold:req
35 mrs \hold, fpsr
36 str \hold, [\base, #CTX_SIMD_FPSR]
37
38 mrs \hold, fpcr
39 str \hold, [\base, #CTX_SIMD_FPCR]
40
41#if CTX_INCLUDE_AARCH32_REGS && CTX_INCLUDE_FPREGS
42 mrs \hold, fpexc32_el2
43 str \hold, [\base, #CTX_SIMD_FPEXC32]
44#endif
45.endm
46
47.macro fpregs_state_restore base:req hold:req
48 ldr \hold, [\base, #CTX_SIMD_FPSR]
49 msr fpsr, \hold
50
51 ldr \hold, [\base, #CTX_SIMD_FPCR]
52 msr fpcr, \hold
53
54#if CTX_INCLUDE_AARCH32_REGS && CTX_INCLUDE_FPREGS
55 ldr \hold, [\base, #CTX_SIMD_FPEXC32]
56 msr fpexc32_el2, \hold
57#endif
58.endm
59
60#endif /* CTX_INCLUDE_FPREGS || CTX_INCLUDE_SVE_REGS */
61
Alexei Fedoroved108b52019-09-13 14:11:59 +010062/* ------------------------------------------------------------------
63 * The following function follows the aapcs_64 strictly to use
64 * x9-x17 (temporary caller-saved registers according to AArch64 PCS)
65 * to save floating point register context. It assumes that 'x0' is
66 * pointing to a 'fp_regs' structure where the register context will
Achin Gupta9ac63c52014-01-16 12:08:03 +000067 * be saved.
68 *
Alexei Fedoroved108b52019-09-13 14:11:59 +010069 * Access to VFP registers will trap if CPTR_EL3.TFP is set.
70 * However currently we don't use VFP registers nor set traps in
71 * Trusted Firmware, and assume it's cleared.
Achin Gupta9ac63c52014-01-16 12:08:03 +000072 *
73 * TODO: Revisit when VFP is used in secure world
Alexei Fedoroved108b52019-09-13 14:11:59 +010074 * ------------------------------------------------------------------
Achin Gupta9ac63c52014-01-16 12:08:03 +000075 */
Juan Castillo0f21c542014-06-25 17:26:36 +010076#if CTX_INCLUDE_FPREGS
Andrew Thoelke0a30cf52014-03-18 13:46:55 +000077func fpregs_context_save
Per Larsen5141de12025-01-16 11:46:25 +000078.arch_extension fp
79 /* Temporarily enable floating point */
80
Andrei Homescu09ada2f2024-12-14 14:12:56 +000081 /* Save x0 and pass its original value to fpregs_state_save */
82 mov x1, x0
83
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -050084 stp q0, q1, [x0], #32
85 stp q2, q3, [x0], #32
86 stp q4, q5, [x0], #32
87 stp q6, q7, [x0], #32
88 stp q8, q9, [x0], #32
89 stp q10, q11, [x0], #32
90 stp q12, q13, [x0], #32
91 stp q14, q15, [x0], #32
92 stp q16, q17, [x0], #32
93 stp q18, q19, [x0], #32
94 stp q20, q21, [x0], #32
95 stp q22, q23, [x0], #32
96 stp q24, q25, [x0], #32
97 stp q26, q27, [x0], #32
98 stp q28, q29, [x0], #32
99 stp q30, q31, [x0], #32
Achin Gupta9ac63c52014-01-16 12:08:03 +0000100
Andrei Homescu09ada2f2024-12-14 14:12:56 +0000101 fpregs_state_save x1, x9
Achin Gupta9ac63c52014-01-16 12:08:03 +0000102
Per Larsen5141de12025-01-16 11:46:25 +0000103.arch_extension nofp
Achin Gupta9ac63c52014-01-16 12:08:03 +0000104 ret
Kévin Petit8b779622015-03-24 14:03:57 +0000105endfunc fpregs_context_save
Achin Gupta9ac63c52014-01-16 12:08:03 +0000106
Alexei Fedoroved108b52019-09-13 14:11:59 +0100107/* ------------------------------------------------------------------
108 * The following function follows the aapcs_64 strictly to use x9-x17
109 * (temporary caller-saved registers according to AArch64 PCS) to
110 * restore floating point register context. It assumes that 'x0' is
111 * pointing to a 'fp_regs' structure from where the register context
Achin Gupta9ac63c52014-01-16 12:08:03 +0000112 * will be restored.
113 *
Alexei Fedoroved108b52019-09-13 14:11:59 +0100114 * Access to VFP registers will trap if CPTR_EL3.TFP is set.
115 * However currently we don't use VFP registers nor set traps in
116 * Trusted Firmware, and assume it's cleared.
Achin Gupta9ac63c52014-01-16 12:08:03 +0000117 *
118 * TODO: Revisit when VFP is used in secure world
Alexei Fedoroved108b52019-09-13 14:11:59 +0100119 * ------------------------------------------------------------------
Achin Gupta9ac63c52014-01-16 12:08:03 +0000120 */
Andrew Thoelke0a30cf52014-03-18 13:46:55 +0000121func fpregs_context_restore
Per Larsen5141de12025-01-16 11:46:25 +0000122.arch_extension fp
123 /* Temporarily enable floating point */
124
Andrei Homescu09ada2f2024-12-14 14:12:56 +0000125 /* Save x0 and pass its original value to fpregs_state_restore */
126 mov x1, x0
127
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500128 ldp q0, q1, [x0], #32
129 ldp q2, q3, [x0], #32
130 ldp q4, q5, [x0], #32
131 ldp q6, q7, [x0], #32
132 ldp q8, q9, [x0], #32
133 ldp q10, q11, [x0], #32
134 ldp q12, q13, [x0], #32
135 ldp q14, q15, [x0], #32
136 ldp q16, q17, [x0], #32
137 ldp q18, q19, [x0], #32
138 ldp q20, q21, [x0], #32
139 ldp q22, q23, [x0], #32
140 ldp q24, q25, [x0], #32
141 ldp q26, q27, [x0], #32
142 ldp q28, q29, [x0], #32
143 ldp q30, q31, [x0], #32
Achin Gupta9ac63c52014-01-16 12:08:03 +0000144
Andrei Homescu09ada2f2024-12-14 14:12:56 +0000145 fpregs_state_restore x1, x9
Achin Gupta9ac63c52014-01-16 12:08:03 +0000146
Per Larsen5141de12025-01-16 11:46:25 +0000147.arch_extension nofp
Achin Gupta9ac63c52014-01-16 12:08:03 +0000148 ret
Kévin Petit8b779622015-03-24 14:03:57 +0000149endfunc fpregs_context_restore
Juan Castillo0f21c542014-06-25 17:26:36 +0100150#endif /* CTX_INCLUDE_FPREGS */
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100151
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500152#if CTX_INCLUDE_SVE_REGS
153/*
154 * Helper macros for SVE predicates save/restore operations.
155 */
156.macro sve_predicate_op op:req reg:req
157 \op p0, [\reg, #0, MUL VL]
158 \op p1, [\reg, #1, MUL VL]
159 \op p2, [\reg, #2, MUL VL]
160 \op p3, [\reg, #3, MUL VL]
161 \op p4, [\reg, #4, MUL VL]
162 \op p5, [\reg, #5, MUL VL]
163 \op p6, [\reg, #6, MUL VL]
164 \op p7, [\reg, #7, MUL VL]
165 \op p8, [\reg, #8, MUL VL]
166 \op p9, [\reg, #9, MUL VL]
167 \op p10, [\reg, #10, MUL VL]
168 \op p11, [\reg, #11, MUL VL]
169 \op p12, [\reg, #12, MUL VL]
170 \op p13, [\reg, #13, MUL VL]
171 \op p14, [\reg, #14, MUL VL]
172 \op p15, [\reg, #15, MUL VL]
173.endm
174
175.macro sve_vectors_op op:req reg:req
176 \op z0, [\reg, #0, MUL VL]
177 \op z1, [\reg, #1, MUL VL]
178 \op z2, [\reg, #2, MUL VL]
179 \op z3, [\reg, #3, MUL VL]
180 \op z4, [\reg, #4, MUL VL]
181 \op z5, [\reg, #5, MUL VL]
182 \op z6, [\reg, #6, MUL VL]
183 \op z7, [\reg, #7, MUL VL]
184 \op z8, [\reg, #8, MUL VL]
185 \op z9, [\reg, #9, MUL VL]
186 \op z10, [\reg, #10, MUL VL]
187 \op z11, [\reg, #11, MUL VL]
188 \op z12, [\reg, #12, MUL VL]
189 \op z13, [\reg, #13, MUL VL]
190 \op z14, [\reg, #14, MUL VL]
191 \op z15, [\reg, #15, MUL VL]
192 \op z16, [\reg, #16, MUL VL]
193 \op z17, [\reg, #17, MUL VL]
194 \op z18, [\reg, #18, MUL VL]
195 \op z19, [\reg, #19, MUL VL]
196 \op z20, [\reg, #20, MUL VL]
197 \op z21, [\reg, #21, MUL VL]
198 \op z22, [\reg, #22, MUL VL]
199 \op z23, [\reg, #23, MUL VL]
200 \op z24, [\reg, #24, MUL VL]
201 \op z25, [\reg, #25, MUL VL]
202 \op z26, [\reg, #26, MUL VL]
203 \op z27, [\reg, #27, MUL VL]
204 \op z28, [\reg, #28, MUL VL]
205 \op z29, [\reg, #29, MUL VL]
206 \op z30, [\reg, #30, MUL VL]
207 \op z31, [\reg, #31, MUL VL]
208.endm
209
210/* ------------------------------------------------------------------
211 * The following function follows the aapcs_64 strictly to use x9-x17
212 * (temporary caller-saved registers according to AArch64 PCS) to
213 * restore SVE register context. It assumes that 'x0' is
214 * pointing to a 'sve_regs_t' structure to which the register context
215 * will be saved.
216 * ------------------------------------------------------------------
217 */
218func sve_context_save
219.arch_extension sve
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500220 /* Predicate registers */
221 mov x13, #CTX_SIMD_PREDICATES
222 add x9, x0, x13
223 sve_predicate_op str, x9
224
225 /* Save FFR after predicates */
226 mov x13, #CTX_SIMD_FFR
227 add x9, x0, x13
228 rdffr p0.b
229 str p0, [x9]
230
231 /* Save vector registers */
232 mov x13, #CTX_SIMD_VECTORS
233 add x9, x0, x13
234 sve_vectors_op str, x9
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500235.arch_extension nosve
236
237 /* Save FPSR, FPCR and FPEXC32 */
238 fpregs_state_save x0, x9
239
240 ret
241endfunc sve_context_save
242
243/* ------------------------------------------------------------------
244 * The following function follows the aapcs_64 strictly to use x9-x17
245 * (temporary caller-saved registers according to AArch64 PCS) to
246 * restore SVE register context. It assumes that 'x0' is pointing to
247 * a 'sve_regs_t' structure from where the register context will be
248 * restored.
249 * ------------------------------------------------------------------
250 */
251func sve_context_restore
252.arch_extension sve
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500253 /* Restore FFR register before predicates */
254 mov x13, #CTX_SIMD_FFR
255 add x9, x0, x13
256 ldr p0, [x9]
257 wrffr p0.b
258
259 /* Restore predicate registers */
260 mov x13, #CTX_SIMD_PREDICATES
261 add x9, x0, x13
262 sve_predicate_op ldr, x9
263
264 /* Restore vector registers */
265 mov x13, #CTX_SIMD_VECTORS
266 add x9, x0, x13
267 sve_vectors_op ldr, x9
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500268.arch_extension nosve
269
270 /* Restore FPSR, FPCR and FPEXC32 */
271 fpregs_state_restore x0, x9
272 ret
273endfunc sve_context_restore
274#endif /* CTX_INCLUDE_SVE_REGS */
275
Daniel Boulby7d33ffe2021-05-25 18:09:34 +0100276 /*
Manish Pandey1cbe42a2022-11-17 15:47:05 +0000277 * Set SCR_EL3.EA bit to enable SErrors at EL3
278 */
279 .macro enable_serror_at_el3
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500280 mrs x8, scr_el3
281 orr x8, x8, #SCR_EA_BIT
282 msr scr_el3, x8
Manish Pandey1cbe42a2022-11-17 15:47:05 +0000283 .endm
284
285 /*
Daniel Boulby7d33ffe2021-05-25 18:09:34 +0100286 * Set the PSTATE bits not set when the exception was taken as
287 * described in the AArch64.TakeException() pseudocode function
288 * in ARM DDI 0487F.c page J1-7635 to a default value.
289 */
290 .macro set_unset_pstate_bits
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +0000291 /*
292 * If Data Independent Timing (DIT) functionality is implemented,
293 * always enable DIT in EL3
294 */
Daniel Boulby7d33ffe2021-05-25 18:09:34 +0100295#if ENABLE_FEAT_DIT
Manish Pandey43d1d952024-07-18 15:18:20 +0100296#if ENABLE_FEAT_DIT >= 2
Andre Przywara88727fc2023-01-26 16:47:52 +0000297 mrs x8, id_aa64pfr0_el1
298 and x8, x8, #(ID_AA64PFR0_DIT_MASK << ID_AA64PFR0_DIT_SHIFT)
299 cbz x8, 1f
300#endif
Madhukar Pappireddy6d5319a2024-06-17 15:22:36 -0500301 mov x8, #DIT_BIT
302 msr DIT, x8
Andre Przywara88727fc2023-01-26 16:47:52 +00003031:
Daniel Boulby7d33ffe2021-05-25 18:09:34 +0100304#endif /* ENABLE_FEAT_DIT */
305 .endm /* set_unset_pstate_bits */
306
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500307/*-------------------------------------------------------------------------
308 * This macro checks the ENABLE_FEAT_MPAM state, performs ID register
309 * check to see if the platform supports MPAM extension and restores MPAM3
310 * register value if it is FEAT_STATE_ENABLED/FEAT_STATE_CHECKED.
311 *
312 * This is particularly more complicated because we can't check
313 * if the platform supports MPAM by looking for status of a particular bit
314 * in the MDCR_EL3 or CPTR_EL3 register like other extensions.
315 * ------------------------------------------------------------------------
316 */
317
318 .macro restore_mpam3_el3
319#if ENABLE_FEAT_MPAM
Manish Pandey43d1d952024-07-18 15:18:20 +0100320#if ENABLE_FEAT_MPAM >= 2
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500321 mrs x8, id_aa64pfr0_el1
322 lsr x8, x8, #(ID_AA64PFR0_MPAM_SHIFT)
323 and x8, x8, #(ID_AA64PFR0_MPAM_MASK)
324 mrs x7, id_aa64pfr1_el1
325 lsr x7, x7, #(ID_AA64PFR1_MPAM_FRAC_SHIFT)
326 and x7, x7, #(ID_AA64PFR1_MPAM_FRAC_MASK)
327 orr x7, x7, x8
328 cbz x7, no_mpam
329#endif
330 /* -----------------------------------------------------------
331 * Restore MPAM3_EL3 register as per context state
332 * Currently we only enable MPAM for NS world and trap to EL3
333 * for MPAM access in lower ELs of Secure and Realm world
Arvind Ram Prakashac4f6aa2023-11-08 12:28:30 -0600334 * x9 holds address of the per_world context
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500335 * -----------------------------------------------------------
336 */
Arvind Ram Prakashac4f6aa2023-11-08 12:28:30 -0600337
338 ldr x17, [x9, #CTX_MPAM3_EL3]
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500339 msr S3_6_C10_C5_0, x17 /* mpam3_el3 */
340
341no_mpam:
342#endif
343 .endm /* restore_mpam3_el3 */
344
Alexei Fedoroved108b52019-09-13 14:11:59 +0100345/* ------------------------------------------------------------------
Daniel Boulby97215e02022-01-19 11:20:05 +0000346 * The following macro is used to save and restore all the general
Alexei Fedoroved108b52019-09-13 14:11:59 +0100347 * purpose and ARMv8.3-PAuth (if enabled) registers.
Jayanth Dodderi Chidanandd64bfef2022-09-19 23:32:08 +0100348 * It also checks if the Secure Cycle Counter (PMCCNTR_EL0)
349 * is disabled in EL3/Secure (ARMv8.5-PMU), wherein PMCCNTR_EL0
350 * needs not to be saved/restored during world switch.
Alexei Fedoroved108b52019-09-13 14:11:59 +0100351 *
352 * Ideally we would only save and restore the callee saved registers
353 * when a world switch occurs but that type of implementation is more
354 * complex. So currently we will always save and restore these
355 * registers on entry and exit of EL3.
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100356 * clobbers: x18
Alexei Fedoroved108b52019-09-13 14:11:59 +0100357 * ------------------------------------------------------------------
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100358 */
Daniel Boulby97215e02022-01-19 11:20:05 +0000359 .macro save_gp_pmcr_pauth_regs
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100360 stp x0, x1, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X0]
361 stp x2, x3, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X2]
362 stp x4, x5, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X4]
363 stp x6, x7, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X6]
364 stp x8, x9, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X8]
365 stp x10, x11, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X10]
366 stp x12, x13, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X12]
367 stp x14, x15, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X14]
368 stp x16, x17, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X16]
369 stp x18, x19, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X18]
370 stp x20, x21, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X20]
371 stp x22, x23, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X22]
372 stp x24, x25, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X24]
373 stp x26, x27, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X26]
374 stp x28, x29, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X28]
375 mrs x18, sp_el0
376 str x18, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_SP_EL0]
Boyan Karatotevc73686a2023-02-15 13:21:50 +0000377
378 /* PMUv3 is presumed to be always present */
Alexei Fedoroved108b52019-09-13 14:11:59 +0100379 mrs x9, pmcr_el0
Alexei Fedoroved108b52019-09-13 14:11:59 +0100380 str x9, [sp, #CTX_EL3STATE_OFFSET + CTX_PMCR_EL0]
Alexei Fedoroved108b52019-09-13 14:11:59 +0100381#if CTX_INCLUDE_PAUTH_REGS
382 /* ----------------------------------------------------------
383 * Save the ARMv8.3-PAuth keys as they are not banked
384 * by exception level
385 * ----------------------------------------------------------
386 */
387 add x19, sp, #CTX_PAUTH_REGS_OFFSET
388
389 mrs x20, APIAKeyLo_EL1 /* x21:x20 = APIAKey */
390 mrs x21, APIAKeyHi_EL1
391 mrs x22, APIBKeyLo_EL1 /* x23:x22 = APIBKey */
392 mrs x23, APIBKeyHi_EL1
393 mrs x24, APDAKeyLo_EL1 /* x25:x24 = APDAKey */
394 mrs x25, APDAKeyHi_EL1
395 mrs x26, APDBKeyLo_EL1 /* x27:x26 = APDBKey */
396 mrs x27, APDBKeyHi_EL1
397 mrs x28, APGAKeyLo_EL1 /* x29:x28 = APGAKey */
398 mrs x29, APGAKeyHi_EL1
399
400 stp x20, x21, [x19, #CTX_PACIAKEY_LO]
401 stp x22, x23, [x19, #CTX_PACIBKEY_LO]
402 stp x24, x25, [x19, #CTX_PACDAKEY_LO]
403 stp x26, x27, [x19, #CTX_PACDBKEY_LO]
404 stp x28, x29, [x19, #CTX_PACGAKEY_LO]
405#endif /* CTX_INCLUDE_PAUTH_REGS */
Daniel Boulby97215e02022-01-19 11:20:05 +0000406 .endm /* save_gp_pmcr_pauth_regs */
407
408/* -----------------------------------------------------------------
Daniel Boulby7d33ffe2021-05-25 18:09:34 +0100409 * This function saves the context and sets the PSTATE to a known
410 * state, preparing entry to el3.
Daniel Boulby97215e02022-01-19 11:20:05 +0000411 * Save all the general purpose and ARMv8.3-PAuth (if enabled)
412 * registers.
Daniel Boulby7d33ffe2021-05-25 18:09:34 +0100413 * Then set any of the PSTATE bits that are not set by hardware
414 * according to the Aarch64.TakeException pseudocode in the Arm
415 * Architecture Reference Manual to a default value for EL3.
416 * clobbers: x17
Daniel Boulby97215e02022-01-19 11:20:05 +0000417 * -----------------------------------------------------------------
418 */
419func prepare_el3_entry
Boyan Karatotevf8088732024-11-21 13:55:59 +0000420 /*
421 * context is about to mutate, so make sure we don't affect any still
422 * in-flight profiling operations. We don't care that they actually
423 * finish, that can still be later. NOP if not present
424 */
425#if ENABLE_SPE_FOR_NS
426 psb_csync
427#endif
Boyan Karatotev73d98e32024-12-02 09:36:10 +0000428#if ENABLE_TRBE_FOR_NS
429 tsb_csync
430#endif
431 isb
Daniel Boulby97215e02022-01-19 11:20:05 +0000432 save_gp_pmcr_pauth_regs
Jayanth Dodderi Chidanand40e5f7a2023-08-08 16:10:16 +0100433 setup_el3_execution_context
Alexei Fedoroved108b52019-09-13 14:11:59 +0100434 ret
Daniel Boulby97215e02022-01-19 11:20:05 +0000435endfunc prepare_el3_entry
Alexei Fedoroved108b52019-09-13 14:11:59 +0100436
437/* ------------------------------------------------------------------
438 * This function restores ARMv8.3-PAuth (if enabled) and all general
439 * purpose registers except x30 from the CPU context.
440 * x30 register must be explicitly restored by the caller.
441 * ------------------------------------------------------------------
Jeenu Viswambharanef653d92017-11-29 16:59:34 +0000442 */
Alexei Fedoroved108b52019-09-13 14:11:59 +0100443func restore_gp_pmcr_pauth_regs
444#if CTX_INCLUDE_PAUTH_REGS
445 /* Restore the ARMv8.3 PAuth keys */
446 add x10, sp, #CTX_PAUTH_REGS_OFFSET
447
448 ldp x0, x1, [x10, #CTX_PACIAKEY_LO] /* x1:x0 = APIAKey */
449 ldp x2, x3, [x10, #CTX_PACIBKEY_LO] /* x3:x2 = APIBKey */
450 ldp x4, x5, [x10, #CTX_PACDAKEY_LO] /* x5:x4 = APDAKey */
451 ldp x6, x7, [x10, #CTX_PACDBKEY_LO] /* x7:x6 = APDBKey */
452 ldp x8, x9, [x10, #CTX_PACGAKEY_LO] /* x9:x8 = APGAKey */
453
454 msr APIAKeyLo_EL1, x0
455 msr APIAKeyHi_EL1, x1
456 msr APIBKeyLo_EL1, x2
457 msr APIBKeyHi_EL1, x3
458 msr APDAKeyLo_EL1, x4
459 msr APDAKeyHi_EL1, x5
460 msr APDBKeyLo_EL1, x6
461 msr APDBKeyHi_EL1, x7
462 msr APGAKeyLo_EL1, x8
463 msr APGAKeyHi_EL1, x9
464#endif /* CTX_INCLUDE_PAUTH_REGS */
Boyan Karatotevc73686a2023-02-15 13:21:50 +0000465
466 /* PMUv3 is presumed to be always present */
Alexei Fedoroved108b52019-09-13 14:11:59 +0100467 ldr x0, [sp, #CTX_EL3STATE_OFFSET + CTX_PMCR_EL0]
468 msr pmcr_el0, x0
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100469 ldp x0, x1, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X0]
470 ldp x2, x3, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X2]
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100471 ldp x4, x5, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X4]
472 ldp x6, x7, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X6]
473 ldp x8, x9, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X8]
474 ldp x10, x11, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X10]
475 ldp x12, x13, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X12]
476 ldp x14, x15, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X14]
Jeenu Viswambharanef653d92017-11-29 16:59:34 +0000477 ldp x16, x17, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X16]
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100478 ldp x18, x19, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X18]
479 ldp x20, x21, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X20]
480 ldp x22, x23, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X22]
481 ldp x24, x25, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X24]
482 ldp x26, x27, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X26]
Jeenu Viswambharanef653d92017-11-29 16:59:34 +0000483 ldr x28, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_SP_EL0]
484 msr sp_el0, x28
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100485 ldp x28, x29, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_X28]
Jeenu Viswambharanef653d92017-11-29 16:59:34 +0000486 ret
Alexei Fedoroved108b52019-09-13 14:11:59 +0100487endfunc restore_gp_pmcr_pauth_regs
Jeenu Viswambharanef653d92017-11-29 16:59:34 +0000488
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +0100489#if ERRATA_SPECULATIVE_AT
490/* --------------------------------------------------------------------
Manish V Badarkhe3b8456b2020-07-23 12:43:25 +0100491 * In case of ERRATA_SPECULATIVE_AT, save SCTLR_EL1 and TCR_EL1
492 * registers and update EL1 registers to disable stage1 and stage2
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +0100493 * page table walk.
494 * --------------------------------------------------------------------
Manish V Badarkhe3b8456b2020-07-23 12:43:25 +0100495 */
496func save_and_update_ptw_el1_sys_regs
497 /* ----------------------------------------------------------
498 * Save only sctlr_el1 and tcr_el1 registers
499 * ----------------------------------------------------------
500 */
501 mrs x29, sctlr_el1
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +0100502 str x29, [sp, #(CTX_ERRATA_SPEC_AT_OFFSET + CTX_ERRATA_SPEC_AT_SCTLR_EL1)]
Manish V Badarkhe3b8456b2020-07-23 12:43:25 +0100503 mrs x29, tcr_el1
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +0100504 str x29, [sp, #(CTX_ERRATA_SPEC_AT_OFFSET + CTX_ERRATA_SPEC_AT_TCR_EL1)]
Manish V Badarkhe3b8456b2020-07-23 12:43:25 +0100505
506 /* ------------------------------------------------------------
507 * Must follow below order in order to disable page table
508 * walk for lower ELs (EL1 and EL0). First step ensures that
509 * page table walk is disabled for stage1 and second step
510 * ensures that page table walker should use TCR_EL1.EPDx
511 * bits to perform address translation. ISB ensures that CPU
512 * does these 2 steps in order.
513 *
514 * 1. Update TCR_EL1.EPDx bits to disable page table walk by
515 * stage1.
516 * 2. Enable MMU bit to avoid identity mapping via stage2
517 * and force TCR_EL1.EPDx to be used by the page table
518 * walker.
519 * ------------------------------------------------------------
520 */
521 orr x29, x29, #(TCR_EPD0_BIT)
522 orr x29, x29, #(TCR_EPD1_BIT)
523 msr tcr_el1, x29
524 isb
525 mrs x29, sctlr_el1
526 orr x29, x29, #SCTLR_M_BIT
527 msr sctlr_el1, x29
528 isb
Manish V Badarkhe3b8456b2020-07-23 12:43:25 +0100529 ret
530endfunc save_and_update_ptw_el1_sys_regs
531
Jayanth Dodderi Chidanand59b7c0a2024-06-05 11:13:05 +0100532#endif /* ERRATA_SPECULATIVE_AT */
533
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100534/* -----------------------------------------------------------------
535* The below macro returns the address of the per_world context for
536* the security state, retrieved through "get_security_state" macro.
537* The per_world context address is returned in the register argument.
538* Clobbers: x9, x10
539* ------------------------------------------------------------------
540*/
541
542.macro get_per_world_context _reg:req
543 ldr x10, [sp, #CTX_EL3STATE_OFFSET + CTX_SCR_EL3]
544 get_security_state x9, x10
Jayanth Dodderi Chidanand4087ed62023-12-11 11:22:02 +0000545 mov_imm x10, (CTX_PERWORLD_EL3STATE_END - CTX_CPTR_EL3)
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100546 mul x9, x9, x10
547 adrp x10, per_world_context
548 add x10, x10, :lo12:per_world_context
549 add x9, x9, x10
550 mov \_reg, x9
551.endm
552
Alexei Fedoroved108b52019-09-13 14:11:59 +0100553/* ------------------------------------------------------------------
554 * This routine assumes that the SP_EL3 is pointing to a valid
555 * context structure from where the gp regs and other special
556 * registers can be retrieved.
557 * ------------------------------------------------------------------
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +0000558 */
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100559func el3_exit
Jan Dabrosbb9549b2019-12-02 13:30:03 +0100560#if ENABLE_ASSERTIONS
561 /* el3_exit assumes SP_EL0 on entry */
562 mrs x17, spsel
563 cmp x17, #MODE_SP_EL0
564 ASM_ASSERT(eq)
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +0000565#endif /* ENABLE_ASSERTIONS */
Jan Dabrosbb9549b2019-12-02 13:30:03 +0100566
Alexei Fedoroved108b52019-09-13 14:11:59 +0100567 /* ----------------------------------------------------------
568 * Save the current SP_EL0 i.e. the EL3 runtime stack which
569 * will be used for handling the next SMC.
570 * Then switch to SP_EL3.
571 * ----------------------------------------------------------
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100572 */
573 mov x17, sp
Alexei Fedoroved108b52019-09-13 14:11:59 +0100574 msr spsel, #MODE_SP_ELX
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100575 str x17, [sp, #CTX_EL3STATE_OFFSET + CTX_RUNTIME_SP]
576
Max Shvetsov0c5e7d12021-03-22 11:59:37 +0000577 /* ----------------------------------------------------------
Arunachalam Ganapathy68ac5ed2021-07-08 09:35:57 +0100578 * Restore CPTR_EL3.
Boyan Karatotev0a580b52024-11-15 15:03:02 +0000579 * ---------------------------------------------------------- */
Elizabeth Ho461c0a52023-07-18 14:10:25 +0100580
581 /* The address of the per_world context is stored in x9 */
582 get_per_world_context x9
583
584 ldp x19, x20, [x9, #CTX_CPTR_EL3]
Max Shvetsov0c5e7d12021-03-22 11:59:37 +0000585 msr cptr_el3, x19
586
Boyan Karatotevf0c96a22023-04-20 11:00:50 +0100587#if IMAGE_BL31
Arvind Ram Prakashedebefb2023-10-11 12:10:56 -0500588 restore_mpam3_el3
589
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +0000590#endif /* IMAGE_BL31 */
Max Shvetsov0c5e7d12021-03-22 11:59:37 +0000591
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100592#if IMAGE_BL31 && DYNAMIC_WORKAROUND_CVE_2018_3639
Alexei Fedoroved108b52019-09-13 14:11:59 +0100593 /* ----------------------------------------------------------
594 * Restore mitigation state as it was on entry to EL3
595 * ----------------------------------------------------------
596 */
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100597 ldr x17, [sp, #CTX_CVE_2018_3639_OFFSET + CTX_CVE_2018_3639_DISABLE]
Alexei Fedoroved108b52019-09-13 14:11:59 +0100598 cbz x17, 1f
Dimitris Papastamosfe007b22018-05-16 11:36:14 +0100599 blr x17
Antonio Nino Diaz4d1ccf02019-01-30 20:41:31 +00006001:
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +0000601#endif /* IMAGE_BL31 && DYNAMIC_WORKAROUND_CVE_2018_3639 */
602
Manish Pandey6597fcf2023-06-26 17:46:14 +0100603#if IMAGE_BL31
604 synchronize_errors
605#endif /* IMAGE_BL31 */
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +0000606
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +0100607 /* --------------------------------------------------------------
608 * Restore MDCR_EL3, SPSR_EL3, ELR_EL3 and SCR_EL3 prior to ERET
609 * --------------------------------------------------------------
Manish Pandeyff1d2ef2022-11-17 14:43:15 +0000610 */
Manish Pandeyff1d2ef2022-11-17 14:43:15 +0000611 ldp x16, x17, [sp, #CTX_EL3STATE_OFFSET + CTX_SPSR_EL3]
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +0100612 ldr x18, [sp, #CTX_EL3STATE_OFFSET + CTX_SCR_EL3]
613 ldr x19, [sp, #CTX_EL3STATE_OFFSET + CTX_MDCR_EL3]
Manish Pandeyff1d2ef2022-11-17 14:43:15 +0000614 msr spsr_el3, x16
615 msr elr_el3, x17
Jayanth Dodderi Chidanand123002f2024-06-18 15:22:54 +0100616 msr scr_el3, x18
617 msr mdcr_el3, x19
Manish Pandeyff1d2ef2022-11-17 14:43:15 +0000618
619 restore_ptw_el1_sys_regs
620
621 /* ----------------------------------------------------------
622 * Restore general purpose (including x30), PMCR_EL0 and
623 * ARMv8.3-PAuth registers.
624 * Exit EL3 via ERET to a lower exception level.
625 * ----------------------------------------------------------
626 */
627 bl restore_gp_pmcr_pauth_regs
628 ldr x30, [sp, #CTX_GPREGS_OFFSET + CTX_GPREG_LR]
629
Madhukar Pappireddyc2d32a52020-07-24 03:27:12 -0500630#ifdef IMAGE_BL31
Manish Pandeyd04c04a2023-05-25 13:46:14 +0100631 /* Clear the EL3 flag as we are exiting el3 */
632 str xzr, [sp, #CTX_EL3STATE_OFFSET + CTX_NESTED_EA_FLAG]
Jayanth Dodderi Chidanand0ce220a2022-01-26 17:14:43 +0000633#endif /* IMAGE_BL31 */
634
Anthony Steinhauserf461fe32020-01-07 15:44:06 -0800635 exception_return
Antonio Nino Diaz52839622019-01-31 11:58:00 +0000636
Yatharth Kocharbbf8f6f2015-10-02 17:56:48 +0100637endfunc el3_exit