xref: /rk3399_ARM-atf/lib/el3_runtime/aarch64/context_mgmt.c (revision 2590e819ebccc2223b68b6ed1a4e6145f79e2ea0)
1 /*
2  * Copyright (c) 2013-2025, Arm Limited and Contributors. All rights reserved.
3  * Copyright (c) 2022, NVIDIA Corporation. All rights reserved.
4  *
5  * SPDX-License-Identifier: BSD-3-Clause
6  */
7 
8 #include <assert.h>
9 #include <stdbool.h>
10 #include <string.h>
11 
12 #include <platform_def.h>
13 
14 #include <arch.h>
15 #include <arch_helpers.h>
16 #include <arch_features.h>
17 #include <bl31/interrupt_mgmt.h>
18 #include <common/bl_common.h>
19 #include <common/debug.h>
20 #include <context.h>
21 #include <drivers/arm/gicv3.h>
22 #include <lib/cpus/cpu_ops.h>
23 #include <lib/cpus/errata.h>
24 #include <lib/el3_runtime/context_mgmt.h>
25 #include <lib/el3_runtime/cpu_data.h>
26 #include <lib/el3_runtime/pubsub_events.h>
27 #include <lib/extensions/amu.h>
28 #include <lib/extensions/brbe.h>
29 #include <lib/extensions/debug_v8p9.h>
30 #include <lib/extensions/fgt2.h>
31 #include <lib/extensions/fpmr.h>
32 #include <lib/extensions/mpam.h>
33 #include <lib/extensions/pmuv3.h>
34 #include <lib/extensions/sme.h>
35 #include <lib/extensions/spe.h>
36 #include <lib/extensions/sve.h>
37 #include <lib/extensions/sysreg128.h>
38 #include <lib/extensions/sys_reg_trace.h>
39 #include <lib/extensions/tcr2.h>
40 #include <lib/extensions/trbe.h>
41 #include <lib/extensions/trf.h>
42 #include <lib/utils.h>
43 
44 #if ENABLE_FEAT_TWED
45 /* Make sure delay value fits within the range(0-15) */
46 CASSERT(((TWED_DELAY & ~SCR_TWEDEL_MASK) == 0U), assert_twed_delay_value_check);
47 #endif /* ENABLE_FEAT_TWED */
48 
49 per_world_context_t per_world_context[CPU_DATA_CONTEXT_NUM];
50 static bool has_secure_perworld_init;
51 
52 static void manage_extensions_nonsecure(cpu_context_t *ctx);
53 static void manage_extensions_secure(cpu_context_t *ctx);
54 static void manage_extensions_secure_per_world(void);
55 
56 #if ((IMAGE_BL1) || (IMAGE_BL31 && (!CTX_INCLUDE_EL2_REGS)))
57 static void setup_el1_context(cpu_context_t *ctx, const struct entry_point_info *ep)
58 {
59 	u_register_t sctlr_elx, actlr_elx;
60 
61 	/*
62 	 * Initialise SCTLR_EL1 to the reset value corresponding to the target
63 	 * execution state setting all fields rather than relying on the hw.
64 	 * Some fields have architecturally UNKNOWN reset values and these are
65 	 * set to zero.
66 	 *
67 	 * SCTLR.EE: Endianness is taken from the entrypoint attributes.
68 	 *
69 	 * SCTLR.M, SCTLR.C and SCTLR.I: These fields must be zero (as
70 	 * required by PSCI specification)
71 	 */
72 	sctlr_elx = (EP_GET_EE(ep->h.attr) != 0U) ? SCTLR_EE_BIT : 0UL;
73 	if (GET_RW(ep->spsr) == MODE_RW_64) {
74 		sctlr_elx |= SCTLR_EL1_RES1;
75 	} else {
76 		/*
77 		 * If the target execution state is AArch32 then the following
78 		 * fields need to be set.
79 		 *
80 		 * SCTRL_EL1.nTWE: Set to one so that EL0 execution of WFE
81 		 *  instructions are not trapped to EL1.
82 		 *
83 		 * SCTLR_EL1.nTWI: Set to one so that EL0 execution of WFI
84 		 *  instructions are not trapped to EL1.
85 		 *
86 		 * SCTLR_EL1.CP15BEN: Set to one to enable EL0 execution of the
87 		 *  CP15DMB, CP15DSB, and CP15ISB instructions.
88 		 */
89 		sctlr_elx |= SCTLR_AARCH32_EL1_RES1 | SCTLR_CP15BEN_BIT
90 					| SCTLR_NTWI_BIT | SCTLR_NTWE_BIT;
91 	}
92 
93 	/*
94 	 * If workaround of errata 764081 for Cortex-A75 is used then set
95 	 * SCTLR_EL1.IESB to enable Implicit Error Synchronization Barrier.
96 	 */
97 	if (errata_a75_764081_applies()) {
98 		sctlr_elx |= SCTLR_IESB_BIT;
99 	}
100 
101 	/* Store the initialised SCTLR_EL1 value in the cpu_context */
102 	write_ctx_sctlr_el1_reg_errata(ctx, sctlr_elx);
103 
104 	/*
105 	 * Base the context ACTLR_EL1 on the current value, as it is
106 	 * implementation defined. The context restore process will write
107 	 * the value from the context to the actual register and can cause
108 	 * problems for processor cores that don't expect certain bits to
109 	 * be zero.
110 	 */
111 	actlr_elx = read_actlr_el1();
112 	write_el1_ctx_common(get_el1_sysregs_ctx(ctx), actlr_el1, actlr_elx);
113 }
114 #endif /* (IMAGE_BL1) || (IMAGE_BL31 && (!CTX_INCLUDE_EL2_REGS)) */
115 
116 /******************************************************************************
117  * This function performs initializations that are specific to SECURE state
118  * and updates the cpu context specified by 'ctx'.
119  *****************************************************************************/
120 static void setup_secure_context(cpu_context_t *ctx, const struct entry_point_info *ep)
121 {
122 	u_register_t scr_el3;
123 	el3_state_t *state;
124 
125 	state = get_el3state_ctx(ctx);
126 	scr_el3 = read_ctx_reg(state, CTX_SCR_EL3);
127 
128 #if defined(IMAGE_BL31) && !defined(SPD_spmd)
129 	/*
130 	 * SCR_EL3.IRQ, SCR_EL3.FIQ: Enable the physical FIQ and IRQ routing as
131 	 * indicated by the interrupt routing model for BL31.
132 	 */
133 	scr_el3 |= get_scr_el3_from_routing_model(SECURE);
134 #endif
135 
136 	/* Allow access to Allocation Tags when FEAT_MTE2 is implemented and enabled. */
137 	if (is_feat_mte2_supported()) {
138 		scr_el3 |= SCR_ATA_BIT;
139 	}
140 
141 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
142 
143 	/*
144 	 * Initialize EL1 context registers unless SPMC is running
145 	 * at S-EL2.
146 	 */
147 #if (!SPMD_SPM_AT_SEL2)
148 	setup_el1_context(ctx, ep);
149 #endif
150 
151 	manage_extensions_secure(ctx);
152 
153 	/**
154 	 * manage_extensions_secure_per_world api has to be executed once,
155 	 * as the registers getting initialised, maintain constant value across
156 	 * all the cpus for the secure world.
157 	 * Henceforth, this check ensures that the registers are initialised once
158 	 * and avoids re-initialization from multiple cores.
159 	 */
160 	if (!has_secure_perworld_init) {
161 		manage_extensions_secure_per_world();
162 	}
163 }
164 
165 #if ENABLE_RME
166 /******************************************************************************
167  * This function performs initializations that are specific to REALM state
168  * and updates the cpu context specified by 'ctx'.
169  *****************************************************************************/
170 static void setup_realm_context(cpu_context_t *ctx, const struct entry_point_info *ep)
171 {
172 	u_register_t scr_el3;
173 	el3_state_t *state;
174 
175 	state = get_el3state_ctx(ctx);
176 	scr_el3 = read_ctx_reg(state, CTX_SCR_EL3);
177 
178 	scr_el3 |= SCR_NS_BIT | SCR_NSE_BIT;
179 
180 	/* CSV2 version 2 and above */
181 	if (is_feat_csv2_2_supported()) {
182 		/* Enable access to the SCXTNUM_ELx registers. */
183 		scr_el3 |= SCR_EnSCXT_BIT;
184 	}
185 
186 	if (is_feat_sctlr2_supported()) {
187 		/* Set the SCTLR2En bit in SCR_EL3 to enable access to
188 		 * SCTLR2_ELx registers.
189 		 */
190 		scr_el3 |= SCR_SCTLR2En_BIT;
191 	}
192 
193 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
194 
195 	if (is_feat_fgt2_supported()) {
196 		fgt2_enable(ctx);
197 	}
198 
199 	if (is_feat_debugv8p9_supported()) {
200 		debugv8p9_extended_bp_wp_enable(ctx);
201 	}
202 
203 	if (is_feat_brbe_supported()) {
204 		brbe_enable(ctx);
205 	}
206 
207 }
208 #endif /* ENABLE_RME */
209 
210 /******************************************************************************
211  * This function performs initializations that are specific to NON-SECURE state
212  * and updates the cpu context specified by 'ctx'.
213  *****************************************************************************/
214 static void setup_ns_context(cpu_context_t *ctx, const struct entry_point_info *ep)
215 {
216 	u_register_t scr_el3;
217 	el3_state_t *state;
218 
219 	state = get_el3state_ctx(ctx);
220 	scr_el3 = read_ctx_reg(state, CTX_SCR_EL3);
221 
222 	/* SCR_NS: Set the NS bit */
223 	scr_el3 |= SCR_NS_BIT;
224 
225 	/* Allow access to Allocation Tags when FEAT_MTE2 is implemented and enabled. */
226 	if (is_feat_mte2_supported()) {
227 		scr_el3 |= SCR_ATA_BIT;
228 	}
229 
230 #if !CTX_INCLUDE_PAUTH_REGS
231 	/*
232 	 * Pointer Authentication feature, if present, is always enabled by default
233 	 * for Non secure lower exception levels. We do not have an explicit
234 	 * flag to set it.
235 	 * CTX_INCLUDE_PAUTH_REGS flag, is explicitly used to enable for lower
236 	 * exception levels of secure and realm worlds.
237 	 *
238 	 * To prevent the leakage between the worlds during world switch,
239 	 * we enable it only for the non-secure world.
240 	 *
241 	 * If the Secure/realm world wants to use pointer authentication,
242 	 * CTX_INCLUDE_PAUTH_REGS must be explicitly set to 1, in which case
243 	 * it will be enabled globally for all the contexts.
244 	 *
245 	 * SCR_EL3.API: Set to one to not trap any PAuth instructions at ELs
246 	 *  other than EL3
247 	 *
248 	 * SCR_EL3.APK: Set to one to not trap any PAuth key values at ELs other
249 	 *  than EL3
250 	 */
251 	if (is_armv8_3_pauth_present()) {
252 		scr_el3 |= SCR_API_BIT | SCR_APK_BIT;
253 	}
254 #endif /* CTX_INCLUDE_PAUTH_REGS */
255 
256 #if HANDLE_EA_EL3_FIRST_NS
257 	/* SCR_EL3.EA: Route External Abort and SError Interrupt to EL3. */
258 	scr_el3 |= SCR_EA_BIT;
259 #endif
260 
261 #if RAS_TRAP_NS_ERR_REC_ACCESS
262 	/*
263 	 * SCR_EL3.TERR: Trap Error record accesses. Accesses to the RAS ERR
264 	 * and RAS ERX registers from EL1 and EL2(from any security state)
265 	 * are trapped to EL3.
266 	 * Set here to trap only for NS EL1/EL2
267 	 */
268 	scr_el3 |= SCR_TERR_BIT;
269 #endif
270 
271 	/* CSV2 version 2 and above */
272 	if (is_feat_csv2_2_supported()) {
273 		/* Enable access to the SCXTNUM_ELx registers. */
274 		scr_el3 |= SCR_EnSCXT_BIT;
275 	}
276 
277 #ifdef IMAGE_BL31
278 	/*
279 	 * SCR_EL3.IRQ, SCR_EL3.FIQ: Enable the physical FIQ and IRQ routing as
280 	 *  indicated by the interrupt routing model for BL31.
281 	 */
282 	scr_el3 |= get_scr_el3_from_routing_model(NON_SECURE);
283 #endif
284 
285 	if (is_feat_the_supported()) {
286 		/* Set the RCWMASKEn bit in SCR_EL3 to enable access to
287 		 * RCWMASK_EL1 and RCWSMASK_EL1 registers.
288 		 */
289 		scr_el3 |= SCR_RCWMASKEn_BIT;
290 	}
291 
292 	if (is_feat_sctlr2_supported()) {
293 		/* Set the SCTLR2En bit in SCR_EL3 to enable access to
294 		 * SCTLR2_ELx registers.
295 		 */
296 		scr_el3 |= SCR_SCTLR2En_BIT;
297 	}
298 
299 	if (is_feat_d128_supported()) {
300 		/* Set the D128En bit in SCR_EL3 to enable access to 128-bit
301 		 * versions of TTBR0_EL1, TTBR1_EL1, RCWMASK_EL1, RCWSMASK_EL1,
302 		 * PAR_EL1 and TTBR1_EL2, TTBR0_EL2 and VTTBR_EL2 registers.
303 		 */
304 		scr_el3 |= SCR_D128En_BIT;
305 	}
306 
307 	if (is_feat_fpmr_supported()) {
308 		/* Set the EnFPM bit in SCR_EL3 to enable access to FPMR
309 		 * register.
310 		 */
311 		scr_el3 |= SCR_EnFPM_BIT;
312 	}
313 
314 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
315 
316 	/* Initialize EL2 context registers */
317 #if (CTX_INCLUDE_EL2_REGS && IMAGE_BL31)
318 
319 	/*
320 	 * Initialize SCTLR_EL2 context register with reset value.
321 	 */
322 	write_el2_ctx_common(get_el2_sysregs_ctx(ctx), sctlr_el2, SCTLR_EL2_RES1);
323 
324 	if (is_feat_hcx_supported()) {
325 		/*
326 		 * Initialize register HCRX_EL2 with its init value.
327 		 * As the value of HCRX_EL2 is UNKNOWN on reset, there is a
328 		 * chance that this can lead to unexpected behavior in lower
329 		 * ELs that have not been updated since the introduction of
330 		 * this feature if not properly initialized, especially when
331 		 * it comes to those bits that enable/disable traps.
332 		 */
333 		write_el2_ctx_hcx(get_el2_sysregs_ctx(ctx), hcrx_el2,
334 			HCRX_EL2_INIT_VAL);
335 	}
336 
337 	if (is_feat_fgt_supported()) {
338 		/*
339 		 * Initialize HFG*_EL2 registers with a default value so legacy
340 		 * systems unaware of FEAT_FGT do not get trapped due to their lack
341 		 * of initialization for this feature.
342 		 */
343 		write_el2_ctx_fgt(get_el2_sysregs_ctx(ctx), hfgitr_el2,
344 			HFGITR_EL2_INIT_VAL);
345 		write_el2_ctx_fgt(get_el2_sysregs_ctx(ctx), hfgrtr_el2,
346 			HFGRTR_EL2_INIT_VAL);
347 		write_el2_ctx_fgt(get_el2_sysregs_ctx(ctx), hfgwtr_el2,
348 			HFGWTR_EL2_INIT_VAL);
349 	}
350 #else
351 	/* Initialize EL1 context registers */
352 	setup_el1_context(ctx, ep);
353 #endif /* (CTX_INCLUDE_EL2_REGS && IMAGE_BL31) */
354 
355 	manage_extensions_nonsecure(ctx);
356 }
357 
358 /*******************************************************************************
359  * The following function performs initialization of the cpu_context 'ctx'
360  * for first use that is common to all security states, and sets the
361  * initial entrypoint state as specified by the entry_point_info structure.
362  *
363  * The EE and ST attributes are used to configure the endianness and secure
364  * timer availability for the new execution context.
365  ******************************************************************************/
366 static void setup_context_common(cpu_context_t *ctx, const entry_point_info_t *ep)
367 {
368 	u_register_t scr_el3;
369 	u_register_t mdcr_el3;
370 	el3_state_t *state;
371 	gp_regs_t *gp_regs;
372 
373 	state = get_el3state_ctx(ctx);
374 
375 	/* Clear any residual register values from the context */
376 	zeromem(ctx, sizeof(*ctx));
377 
378 	/*
379 	 * The lower-EL context is zeroed so that no stale values leak to a world.
380 	 * It is assumed that an all-zero lower-EL context is good enough for it
381 	 * to boot correctly. However, there are very few registers where this
382 	 * is not true and some values need to be recreated.
383 	 */
384 #if (CTX_INCLUDE_EL2_REGS && IMAGE_BL31)
385 	el2_sysregs_t *el2_ctx = get_el2_sysregs_ctx(ctx);
386 
387 	/*
388 	 * These bits are set in the gicv3 driver. Losing them (especially the
389 	 * SRE bit) is problematic for all worlds. Henceforth recreate them.
390 	 */
391 	u_register_t icc_sre_el2_val = ICC_SRE_DIB_BIT | ICC_SRE_DFB_BIT |
392 				   ICC_SRE_EN_BIT | ICC_SRE_SRE_BIT;
393 	write_el2_ctx_common(el2_ctx, icc_sre_el2, icc_sre_el2_val);
394 
395 	/*
396 	 * The actlr_el2 register can be initialized in platform's reset handler
397 	 * and it may contain access control bits (e.g. CLUSTERPMUEN bit).
398 	 */
399 	write_el2_ctx_common(el2_ctx, actlr_el2, read_actlr_el2());
400 #endif /* (CTX_INCLUDE_EL2_REGS && IMAGE_BL31) */
401 
402 	/* Start with a clean SCR_EL3 copy as all relevant values are set */
403 	scr_el3 = SCR_RESET_VAL;
404 
405 	/*
406 	 * SCR_EL3.TWE: Set to zero so that execution of WFE instructions at
407 	 *  EL2, EL1 and EL0 are not trapped to EL3.
408 	 *
409 	 * SCR_EL3.TWI: Set to zero so that execution of WFI instructions at
410 	 *  EL2, EL1 and EL0 are not trapped to EL3.
411 	 *
412 	 * SCR_EL3.SMD: Set to zero to enable SMC calls at EL1 and above, from
413 	 *  both Security states and both Execution states.
414 	 *
415 	 * SCR_EL3.SIF: Set to one to disable secure instruction execution from
416 	 *  Non-secure memory.
417 	 */
418 	scr_el3 &= ~(SCR_TWE_BIT | SCR_TWI_BIT | SCR_SMD_BIT);
419 
420 	scr_el3 |= SCR_SIF_BIT;
421 
422 	/*
423 	 * SCR_EL3.RW: Set the execution state, AArch32 or AArch64, for next
424 	 *  Exception level as specified by SPSR.
425 	 */
426 	if (GET_RW(ep->spsr) == MODE_RW_64) {
427 		scr_el3 |= SCR_RW_BIT;
428 	}
429 
430 	/*
431 	 * SCR_EL3.ST: Traps Secure EL1 accesses to the Counter-timer Physical
432 	 * Secure timer registers to EL3, from AArch64 state only, if specified
433 	 * by the entrypoint attributes. If SEL2 is present and enabled, the ST
434 	 * bit always behaves as 1 (i.e. secure physical timer register access
435 	 * is not trapped)
436 	 */
437 	if (EP_GET_ST(ep->h.attr) != 0U) {
438 		scr_el3 |= SCR_ST_BIT;
439 	}
440 
441 	/*
442 	 * If FEAT_HCX is enabled, enable access to HCRX_EL2 by setting
443 	 * SCR_EL3.HXEn.
444 	 */
445 	if (is_feat_hcx_supported()) {
446 		scr_el3 |= SCR_HXEn_BIT;
447 	}
448 
449 	/*
450 	 * If FEAT_LS64_ACCDATA is enabled, enable access to ACCDATA_EL1 by
451 	 * setting SCR_EL3.ADEn and allow the ST64BV0 instruction by setting
452 	 * SCR_EL3.EnAS0.
453 	 */
454 	if (is_feat_ls64_accdata_supported()) {
455 		scr_el3 |= SCR_ADEn_BIT | SCR_EnAS0_BIT;
456 	}
457 
458 	/*
459 	 * If FEAT_RNG_TRAP is enabled, all reads of the RNDR and RNDRRS
460 	 * registers are trapped to EL3.
461 	 */
462 	if (is_feat_rng_trap_supported()) {
463 		scr_el3 |= SCR_TRNDR_BIT;
464 	}
465 
466 #if FAULT_INJECTION_SUPPORT
467 	/* Enable fault injection from lower ELs */
468 	scr_el3 |= SCR_FIEN_BIT;
469 #endif
470 
471 #if CTX_INCLUDE_PAUTH_REGS
472 	/*
473 	 * Enable Pointer Authentication globally for all the worlds.
474 	 *
475 	 * SCR_EL3.API: Set to one to not trap any PAuth instructions at ELs
476 	 *  other than EL3
477 	 *
478 	 * SCR_EL3.APK: Set to one to not trap any PAuth key values at ELs other
479 	 *  than EL3
480 	 */
481 	if (is_armv8_3_pauth_present()) {
482 		scr_el3 |= SCR_API_BIT | SCR_APK_BIT;
483 	}
484 #endif /* CTX_INCLUDE_PAUTH_REGS */
485 
486 	/*
487 	 * SCR_EL3.TCR2EN: Enable access to TCR2_ELx for AArch64 if present.
488 	 */
489 	if (is_feat_tcr2_supported() && (GET_RW(ep->spsr) == MODE_RW_64)) {
490 		scr_el3 |= SCR_TCR2EN_BIT;
491 	}
492 
493 	/*
494 	 * SCR_EL3.PIEN: Enable permission indirection and overlay
495 	 * registers for AArch64 if present.
496 	 */
497 	if (is_feat_sxpie_supported() || is_feat_sxpoe_supported()) {
498 		scr_el3 |= SCR_PIEN_BIT;
499 	}
500 
501 	/*
502 	 * SCR_EL3.GCSEn: Enable GCS registers for AArch64 if present.
503 	 */
504 	if ((is_feat_gcs_supported()) && (GET_RW(ep->spsr) == MODE_RW_64)) {
505 		scr_el3 |= SCR_GCSEn_BIT;
506 	}
507 
508 	/*
509 	 * SCR_EL3.HCE: Enable HVC instructions if next execution state is
510 	 * AArch64 and next EL is EL2, or if next execution state is AArch32 and
511 	 * next mode is Hyp.
512 	 * SCR_EL3.FGTEn: Enable Fine Grained Virtualization Traps under the
513 	 * same conditions as HVC instructions and when the processor supports
514 	 * ARMv8.6-FGT.
515 	 * SCR_EL3.ECVEn: Enable Enhanced Counter Virtualization (ECV)
516 	 * CNTPOFF_EL2 register under the same conditions as HVC instructions
517 	 * and when the processor supports ECV.
518 	 */
519 	if (((GET_RW(ep->spsr) == MODE_RW_64) && (GET_EL(ep->spsr) == MODE_EL2))
520 	    || ((GET_RW(ep->spsr) != MODE_RW_64)
521 		&& (GET_M32(ep->spsr) == MODE32_hyp))) {
522 		scr_el3 |= SCR_HCE_BIT;
523 
524 		if (is_feat_fgt_supported()) {
525 			scr_el3 |= SCR_FGTEN_BIT;
526 		}
527 
528 		if (is_feat_ecv_supported()) {
529 			scr_el3 |= SCR_ECVEN_BIT;
530 		}
531 	}
532 
533 	/* Enable WFE trap delay in SCR_EL3 if supported and configured */
534 	if (is_feat_twed_supported()) {
535 		/* Set delay in SCR_EL3 */
536 		scr_el3 &= ~(SCR_TWEDEL_MASK << SCR_TWEDEL_SHIFT);
537 		scr_el3 |= ((TWED_DELAY & SCR_TWEDEL_MASK)
538 				<< SCR_TWEDEL_SHIFT);
539 
540 		/* Enable WFE delay */
541 		scr_el3 |= SCR_TWEDEn_BIT;
542 	}
543 
544 #if IMAGE_BL31 && defined(SPD_spmd) && SPMD_SPM_AT_SEL2
545 	/* Enable S-EL2 if FEAT_SEL2 is implemented for all the contexts. */
546 	if (is_feat_sel2_supported()) {
547 		scr_el3 |= SCR_EEL2_BIT;
548 	}
549 #endif /* (IMAGE_BL31 && defined(SPD_spmd) && SPMD_SPM_AT_SEL2) */
550 
551 	/*
552 	 * Populate EL3 state so that we've the right context
553 	 * before doing ERET
554 	 */
555 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
556 	write_ctx_reg(state, CTX_ELR_EL3, ep->pc);
557 	write_ctx_reg(state, CTX_SPSR_EL3, ep->spsr);
558 
559 	/* Start with a clean MDCR_EL3 copy as all relevant values are set */
560 	mdcr_el3 = MDCR_EL3_RESET_VAL;
561 
562 	/* ---------------------------------------------------------------------
563 	 * Initialise MDCR_EL3, setting all fields rather than relying on hw.
564 	 * Some fields are architecturally UNKNOWN on reset.
565 	 *
566 	 * MDCR_EL3.SDD: Set to one to disable AArch64 Secure self-hosted debug.
567 	 *  Debug exceptions, other than Breakpoint Instruction exceptions, are
568 	 *  disabled from all ELs in Secure state.
569 	 *
570 	 * MDCR_EL3.SPD32: Set to 0b10 to disable AArch32 Secure self-hosted
571 	 *  privileged debug from S-EL1.
572 	 *
573 	 * MDCR_EL3.TDOSA: Set to zero so that EL2 and EL2 System register
574 	 *  access to the powerdown debug registers do not trap to EL3.
575 	 *
576 	 * MDCR_EL3.TDA: Set to zero to allow EL0, EL1 and EL2 access to the
577 	 *  debug registers, other than those registers that are controlled by
578 	 *  MDCR_EL3.TDOSA.
579 	 */
580 	mdcr_el3 |= ((MDCR_SDD_BIT | MDCR_SPD32(MDCR_SPD32_DISABLE))
581 			& ~(MDCR_TDA_BIT | MDCR_TDOSA_BIT)) ;
582 	write_ctx_reg(state, CTX_MDCR_EL3, mdcr_el3);
583 
584 #if IMAGE_BL31
585 	/* Enable FEAT_TRF for Non-Secure and prohibit for Secure state. */
586 	if (is_feat_trf_supported()) {
587 		trf_enable(ctx);
588 	}
589 
590 	pmuv3_enable(ctx);
591 #endif /* IMAGE_BL31 */
592 
593 	/*
594 	 * Store the X0-X7 value from the entrypoint into the context
595 	 * Use memcpy as we are in control of the layout of the structures
596 	 */
597 	gp_regs = get_gpregs_ctx(ctx);
598 	memcpy(gp_regs, (void *)&ep->args, sizeof(aapcs64_params_t));
599 }
600 
601 /*******************************************************************************
602  * Context management library initialization routine. This library is used by
603  * runtime services to share pointers to 'cpu_context' structures for secure
604  * non-secure and realm states. Management of the structures and their associated
605  * memory is not done by the context management library e.g. the PSCI service
606  * manages the cpu context used for entry from and exit to the non-secure state.
607  * The Secure payload dispatcher service manages the context(s) corresponding to
608  * the secure state. It also uses this library to get access to the non-secure
609  * state cpu context pointers.
610  * Lastly, this library provides the API to make SP_EL3 point to the cpu context
611  * which will be used for programming an entry into a lower EL. The same context
612  * will be used to save state upon exception entry from that EL.
613  ******************************************************************************/
614 void __init cm_init(void)
615 {
616 	/*
617 	 * The context management library has only global data to initialize, but
618 	 * that will be done when the BSS is zeroed out.
619 	 */
620 }
621 
622 /*******************************************************************************
623  * This is the high-level function used to initialize the cpu_context 'ctx' for
624  * first use. It performs initializations that are common to all security states
625  * and initializations specific to the security state specified in 'ep'
626  ******************************************************************************/
627 void cm_setup_context(cpu_context_t *ctx, const entry_point_info_t *ep)
628 {
629 	unsigned int security_state;
630 
631 	assert(ctx != NULL);
632 
633 	/*
634 	 * Perform initializations that are common
635 	 * to all security states
636 	 */
637 	setup_context_common(ctx, ep);
638 
639 	security_state = GET_SECURITY_STATE(ep->h.attr);
640 
641 	/* Perform security state specific initializations */
642 	switch (security_state) {
643 	case SECURE:
644 		setup_secure_context(ctx, ep);
645 		break;
646 #if ENABLE_RME
647 	case REALM:
648 		setup_realm_context(ctx, ep);
649 		break;
650 #endif
651 	case NON_SECURE:
652 		setup_ns_context(ctx, ep);
653 		break;
654 	default:
655 		ERROR("Invalid security state\n");
656 		panic();
657 		break;
658 	}
659 }
660 
661 /*******************************************************************************
662  * Enable architecture extensions for EL3 execution. This function only updates
663  * registers in-place which are expected to either never change or be
664  * overwritten by el3_exit.
665  ******************************************************************************/
666 #if IMAGE_BL31
667 void cm_manage_extensions_el3(void)
668 {
669 	if (is_feat_amu_supported()) {
670 		amu_init_el3();
671 	}
672 
673 	if (is_feat_sme_supported()) {
674 		sme_init_el3();
675 	}
676 
677 	pmuv3_init_el3();
678 }
679 #endif /* IMAGE_BL31 */
680 
681 /******************************************************************************
682  * Function to initialise the registers with the RESET values in the context
683  * memory, which are maintained per world.
684  ******************************************************************************/
685 #if IMAGE_BL31
686 void cm_el3_arch_init_per_world(per_world_context_t *per_world_ctx)
687 {
688 	/*
689 	 * Initialise CPTR_EL3, setting all fields rather than relying on hw.
690 	 *
691 	 * CPTR_EL3.TFP: Set to zero so that accesses to the V- or Z- registers
692 	 *  by Advanced SIMD, floating-point or SVE instructions (if
693 	 *  implemented) do not trap to EL3.
694 	 *
695 	 * CPTR_EL3.TCPAC: Set to zero so that accesses to CPACR_EL1,
696 	 *  CPTR_EL2,CPACR, or HCPTR do not trap to EL3.
697 	 */
698 	uint64_t cptr_el3 = CPTR_EL3_RESET_VAL & ~(TCPAC_BIT | TFP_BIT);
699 
700 	per_world_ctx->ctx_cptr_el3 = cptr_el3;
701 
702 	/*
703 	 * Initialize MPAM3_EL3 to its default reset value
704 	 *
705 	 * MPAM3_EL3_RESET_VAL sets the MPAM3_EL3.TRAPLOWER bit that forces
706 	 * all lower ELn MPAM3_EL3 register access to, trap to EL3
707 	 */
708 
709 	per_world_ctx->ctx_mpam3_el3 = MPAM3_EL3_RESET_VAL;
710 }
711 #endif /* IMAGE_BL31 */
712 
713 /*******************************************************************************
714  * Initialise per_world_context for Non-Secure world.
715  * This function enables the architecture extensions, which have same value
716  * across the cores for the non-secure world.
717  ******************************************************************************/
718 #if IMAGE_BL31
719 void manage_extensions_nonsecure_per_world(void)
720 {
721 	cm_el3_arch_init_per_world(&per_world_context[CPU_CONTEXT_NS]);
722 
723 	if (is_feat_sme_supported()) {
724 		sme_enable_per_world(&per_world_context[CPU_CONTEXT_NS]);
725 	}
726 
727 	if (is_feat_sve_supported()) {
728 		sve_enable_per_world(&per_world_context[CPU_CONTEXT_NS]);
729 	}
730 
731 	if (is_feat_amu_supported()) {
732 		amu_enable_per_world(&per_world_context[CPU_CONTEXT_NS]);
733 	}
734 
735 	if (is_feat_sys_reg_trace_supported()) {
736 		sys_reg_trace_enable_per_world(&per_world_context[CPU_CONTEXT_NS]);
737 	}
738 
739 	if (is_feat_mpam_supported()) {
740 		mpam_enable_per_world(&per_world_context[CPU_CONTEXT_NS]);
741 	}
742 
743 	if (is_feat_fpmr_supported()) {
744 		fpmr_enable_per_world(&per_world_context[CPU_CONTEXT_NS]);
745 	}
746 }
747 #endif /* IMAGE_BL31 */
748 
749 /*******************************************************************************
750  * Initialise per_world_context for Secure world.
751  * This function enables the architecture extensions, which have same value
752  * across the cores for the secure world.
753  ******************************************************************************/
754 static void manage_extensions_secure_per_world(void)
755 {
756 #if IMAGE_BL31
757 	cm_el3_arch_init_per_world(&per_world_context[CPU_CONTEXT_SECURE]);
758 
759 	if (is_feat_sme_supported()) {
760 
761 		if (ENABLE_SME_FOR_SWD) {
762 		/*
763 		 * Enable SME, SVE, FPU/SIMD in secure context, SPM must ensure
764 		 * SME, SVE, and FPU/SIMD context properly managed.
765 		 */
766 			sme_enable_per_world(&per_world_context[CPU_CONTEXT_SECURE]);
767 		} else {
768 		/*
769 		 * Disable SME, SVE, FPU/SIMD in secure context so non-secure
770 		 * world can safely use the associated registers.
771 		 */
772 			sme_disable_per_world(&per_world_context[CPU_CONTEXT_SECURE]);
773 		}
774 	}
775 	if (is_feat_sve_supported()) {
776 		if (ENABLE_SVE_FOR_SWD) {
777 		/*
778 		 * Enable SVE and FPU in secure context, SPM must ensure
779 		 * that the SVE and FPU register contexts are properly managed.
780 		 */
781 			sve_enable_per_world(&per_world_context[CPU_CONTEXT_SECURE]);
782 		} else {
783 		/*
784 		 * Disable SVE and FPU in secure context so non-secure world
785 		 * can safely use them.
786 		 */
787 			sve_disable_per_world(&per_world_context[CPU_CONTEXT_SECURE]);
788 		}
789 	}
790 
791 	/* NS can access this but Secure shouldn't */
792 	if (is_feat_sys_reg_trace_supported()) {
793 		sys_reg_trace_disable_per_world(&per_world_context[CPU_CONTEXT_SECURE]);
794 	}
795 
796 	has_secure_perworld_init = true;
797 #endif /* IMAGE_BL31 */
798 }
799 
800 /*******************************************************************************
801  * Enable architecture extensions on first entry to Non-secure world.
802  ******************************************************************************/
803 static void manage_extensions_nonsecure(cpu_context_t *ctx)
804 {
805 #if IMAGE_BL31
806 	if (is_feat_amu_supported()) {
807 		amu_enable(ctx);
808 	}
809 
810 	if (is_feat_sme_supported()) {
811 		sme_enable(ctx);
812 	}
813 
814 	if (is_feat_fgt2_supported()) {
815 		fgt2_enable(ctx);
816 	}
817 
818 	if (is_feat_debugv8p9_supported()) {
819 		debugv8p9_extended_bp_wp_enable(ctx);
820 	}
821 
822 	/*
823 	 * SPE, TRBE, and BRBE have multi-field enables that affect which world
824 	 * they apply to. Despite this, it is useful to ignore these for
825 	 * simplicity in determining the feature's per world enablement status.
826 	 * This is only possible when context is written per-world. Relied on
827 	 * by SMCCC_ARCH_FEATURE_AVAILABILITY
828 	 */
829 	if (is_feat_spe_supported()) {
830 		spe_enable(ctx);
831 	}
832 
833 	if (is_feat_trbe_supported()) {
834 		trbe_enable(ctx);
835 	}
836 
837 	if (is_feat_brbe_supported()) {
838 		brbe_enable(ctx);
839 	}
840 #endif /* IMAGE_BL31 */
841 }
842 
843 /* TODO: move to lib/extensions/pauth when it has been ported to FEAT_STATE */
844 static __unused void enable_pauth_el2(void)
845 {
846 	u_register_t hcr_el2 = read_hcr_el2();
847 	/*
848 	 * For Armv8.3 pointer authentication feature, disable traps to EL2 when
849 	 *  accessing key registers or using pointer authentication instructions
850 	 *  from lower ELs.
851 	 */
852 	hcr_el2 |= (HCR_API_BIT | HCR_APK_BIT);
853 
854 	write_hcr_el2(hcr_el2);
855 }
856 
857 #if INIT_UNUSED_NS_EL2
858 /*******************************************************************************
859  * Enable architecture extensions in-place at EL2 on first entry to Non-secure
860  * world when EL2 is empty and unused.
861  ******************************************************************************/
862 static void manage_extensions_nonsecure_el2_unused(void)
863 {
864 #if IMAGE_BL31
865 	if (is_feat_spe_supported()) {
866 		spe_init_el2_unused();
867 	}
868 
869 	if (is_feat_amu_supported()) {
870 		amu_init_el2_unused();
871 	}
872 
873 	if (is_feat_mpam_supported()) {
874 		mpam_init_el2_unused();
875 	}
876 
877 	if (is_feat_trbe_supported()) {
878 		trbe_init_el2_unused();
879 	}
880 
881 	if (is_feat_sys_reg_trace_supported()) {
882 		sys_reg_trace_init_el2_unused();
883 	}
884 
885 	if (is_feat_trf_supported()) {
886 		trf_init_el2_unused();
887 	}
888 
889 	pmuv3_init_el2_unused();
890 
891 	if (is_feat_sve_supported()) {
892 		sve_init_el2_unused();
893 	}
894 
895 	if (is_feat_sme_supported()) {
896 		sme_init_el2_unused();
897 	}
898 
899 	if (is_feat_mops_supported()) {
900 		write_hcrx_el2(read_hcrx_el2() | HCRX_EL2_MSCEn_BIT);
901 	}
902 
903 #if ENABLE_PAUTH
904 	enable_pauth_el2();
905 #endif /* ENABLE_PAUTH */
906 #endif /* IMAGE_BL31 */
907 }
908 #endif /* INIT_UNUSED_NS_EL2 */
909 
910 /*******************************************************************************
911  * Enable architecture extensions on first entry to Secure world.
912  ******************************************************************************/
913 static void manage_extensions_secure(cpu_context_t *ctx)
914 {
915 #if IMAGE_BL31
916 	if (is_feat_sme_supported()) {
917 		if (ENABLE_SME_FOR_SWD) {
918 		/*
919 		 * Enable SME, SVE, FPU/SIMD in secure context, secure manager
920 		 * must ensure SME, SVE, and FPU/SIMD context properly managed.
921 		 */
922 			sme_init_el3();
923 			sme_enable(ctx);
924 		} else {
925 		/*
926 		 * Disable SME, SVE, FPU/SIMD in secure context so non-secure
927 		 * world can safely use the associated registers.
928 		 */
929 			sme_disable(ctx);
930 		}
931 	}
932 
933 	/*
934 	 * SPE and TRBE cannot be fully disabled from EL3 registers alone, only
935 	 * sysreg access can. In case the EL1 controls leave them active on
936 	 * context switch, we want the owning security state to be NS so Secure
937 	 * can't be DOSed.
938 	 */
939 	if (is_feat_spe_supported()) {
940 		spe_disable(ctx);
941 	}
942 
943 	if (is_feat_trbe_supported()) {
944 		trbe_disable(ctx);
945 	}
946 #endif /* IMAGE_BL31 */
947 }
948 
949 #if !IMAGE_BL1
950 /*******************************************************************************
951  * The following function initializes the cpu_context for a CPU specified by
952  * its `cpu_idx` for first use, and sets the initial entrypoint state as
953  * specified by the entry_point_info structure.
954  ******************************************************************************/
955 void cm_init_context_by_index(unsigned int cpu_idx,
956 			      const entry_point_info_t *ep)
957 {
958 	cpu_context_t *ctx;
959 	ctx = cm_get_context_by_index(cpu_idx, GET_SECURITY_STATE(ep->h.attr));
960 	cm_setup_context(ctx, ep);
961 }
962 #endif /* !IMAGE_BL1 */
963 
964 /*******************************************************************************
965  * The following function initializes the cpu_context for the current CPU
966  * for first use, and sets the initial entrypoint state as specified by the
967  * entry_point_info structure.
968  ******************************************************************************/
969 void cm_init_my_context(const entry_point_info_t *ep)
970 {
971 	cpu_context_t *ctx;
972 	ctx = cm_get_context(GET_SECURITY_STATE(ep->h.attr));
973 	cm_setup_context(ctx, ep);
974 }
975 
976 /* EL2 present but unused, need to disable safely. SCTLR_EL2 can be ignored */
977 static void init_nonsecure_el2_unused(cpu_context_t *ctx)
978 {
979 #if INIT_UNUSED_NS_EL2
980 	u_register_t hcr_el2 = HCR_RESET_VAL;
981 	u_register_t mdcr_el2;
982 	u_register_t scr_el3;
983 
984 	scr_el3 = read_ctx_reg(get_el3state_ctx(ctx), CTX_SCR_EL3);
985 
986 	/* Set EL2 register width: Set HCR_EL2.RW to match SCR_EL3.RW */
987 	if ((scr_el3 & SCR_RW_BIT) != 0U) {
988 		hcr_el2 |= HCR_RW_BIT;
989 	}
990 
991 	write_hcr_el2(hcr_el2);
992 
993 	/*
994 	 * Initialise CPTR_EL2 setting all fields rather than relying on the hw.
995 	 * All fields have architecturally UNKNOWN reset values.
996 	 */
997 	write_cptr_el2(CPTR_EL2_RESET_VAL);
998 
999 	/*
1000 	 * Initialise CNTHCTL_EL2. All fields are architecturally UNKNOWN on
1001 	 * reset and are set to zero except for field(s) listed below.
1002 	 *
1003 	 * CNTHCTL_EL2.EL1PTEN: Set to one to disable traps to Hyp mode of
1004 	 * Non-secure EL0 and EL1 accesses to the physical timer registers.
1005 	 *
1006 	 * CNTHCTL_EL2.EL1PCTEN: Set to one to disable traps to Hyp mode of
1007 	 * Non-secure EL0 and EL1 accesses to the physical counter registers.
1008 	 */
1009 	write_cnthctl_el2(CNTHCTL_RESET_VAL | EL1PCEN_BIT | EL1PCTEN_BIT);
1010 
1011 	/*
1012 	 * Initialise CNTVOFF_EL2 to zero as it resets to an architecturally
1013 	 * UNKNOWN value.
1014 	 */
1015 	write_cntvoff_el2(0);
1016 
1017 	/*
1018 	 * Set VPIDR_EL2 and VMPIDR_EL2 to match MIDR_EL1 and MPIDR_EL1
1019 	 * respectively.
1020 	 */
1021 	write_vpidr_el2(read_midr_el1());
1022 	write_vmpidr_el2(read_mpidr_el1());
1023 
1024 	/*
1025 	 * Initialise VTTBR_EL2. All fields are architecturally UNKNOWN on reset.
1026 	 *
1027 	 * VTTBR_EL2.VMID: Set to zero. Even though EL1&0 stage 2 address
1028 	 * translation is disabled, cache maintenance operations depend on the
1029 	 * VMID.
1030 	 *
1031 	 * VTTBR_EL2.BADDR: Set to zero as EL1&0 stage 2 address translation is
1032 	 * disabled.
1033 	 */
1034 	write_vttbr_el2(VTTBR_RESET_VAL &
1035 		     ~((VTTBR_VMID_MASK << VTTBR_VMID_SHIFT) |
1036 		       (VTTBR_BADDR_MASK << VTTBR_BADDR_SHIFT)));
1037 
1038 	/*
1039 	 * Initialise MDCR_EL2, setting all fields rather than relying on hw.
1040 	 * Some fields are architecturally UNKNOWN on reset.
1041 	 *
1042 	 * MDCR_EL2.TDRA: Set to zero so that Non-secure EL0 and EL1 System
1043 	 * register accesses to the Debug ROM registers are not trapped to EL2.
1044 	 *
1045 	 * MDCR_EL2.TDOSA: Set to zero so that Non-secure EL1 System register
1046 	 * accesses to the powerdown debug registers are not trapped to EL2.
1047 	 *
1048 	 * MDCR_EL2.TDA: Set to zero so that System register accesses to the
1049 	 * debug registers do not trap to EL2.
1050 	 *
1051 	 * MDCR_EL2.TDE: Set to zero so that debug exceptions are not routed to
1052 	 * EL2.
1053 	 */
1054 	mdcr_el2 = MDCR_EL2_RESET_VAL &
1055 		 ~(MDCR_EL2_TDRA_BIT | MDCR_EL2_TDOSA_BIT | MDCR_EL2_TDA_BIT |
1056 		   MDCR_EL2_TDE_BIT);
1057 
1058 	write_mdcr_el2(mdcr_el2);
1059 
1060 	/*
1061 	 * Initialise HSTR_EL2. All fields are architecturally UNKNOWN on reset.
1062 	 *
1063 	 * HSTR_EL2.T<n>: Set all these fields to zero so that Non-secure EL0 or
1064 	 * EL1 accesses to System registers do not trap to EL2.
1065 	 */
1066 	write_hstr_el2(HSTR_EL2_RESET_VAL & ~(HSTR_EL2_T_MASK));
1067 
1068 	/*
1069 	 * Initialise CNTHP_CTL_EL2. All fields are architecturally UNKNOWN on
1070 	 * reset.
1071 	 *
1072 	 * CNTHP_CTL_EL2:ENABLE: Set to zero to disable the EL2 physical timer
1073 	 * and prevent timer interrupts.
1074 	 */
1075 	write_cnthp_ctl_el2(CNTHP_CTL_RESET_VAL & ~(CNTHP_CTL_ENABLE_BIT));
1076 
1077 	manage_extensions_nonsecure_el2_unused();
1078 #endif /* INIT_UNUSED_NS_EL2 */
1079 }
1080 
1081 /*******************************************************************************
1082  * Prepare the CPU system registers for first entry into realm, secure, or
1083  * normal world.
1084  *
1085  * If execution is requested to EL2 or hyp mode, SCTLR_EL2 is initialized
1086  * If execution is requested to non-secure EL1 or svc mode, and the CPU supports
1087  * EL2 then EL2 is disabled by configuring all necessary EL2 registers.
1088  * For all entries, the EL1 registers are initialized from the cpu_context
1089  ******************************************************************************/
1090 void cm_prepare_el3_exit(uint32_t security_state)
1091 {
1092 	u_register_t sctlr_el2, scr_el3;
1093 	cpu_context_t *ctx = cm_get_context(security_state);
1094 
1095 	assert(ctx != NULL);
1096 
1097 	if (security_state == NON_SECURE) {
1098 		uint64_t el2_implemented = el_implemented(2);
1099 
1100 		scr_el3 = read_ctx_reg(get_el3state_ctx(ctx),
1101 						 CTX_SCR_EL3);
1102 
1103 		if (el2_implemented != EL_IMPL_NONE) {
1104 
1105 			/*
1106 			 * If context is not being used for EL2, initialize
1107 			 * HCRX_EL2 with its init value here.
1108 			 */
1109 			if (is_feat_hcx_supported()) {
1110 				write_hcrx_el2(HCRX_EL2_INIT_VAL);
1111 			}
1112 
1113 			/*
1114 			 * Initialize Fine-grained trap registers introduced
1115 			 * by FEAT_FGT so all traps are initially disabled when
1116 			 * switching to EL2 or a lower EL, preventing undesired
1117 			 * behavior.
1118 			 */
1119 			if (is_feat_fgt_supported()) {
1120 				/*
1121 				 * Initialize HFG*_EL2 registers with a default
1122 				 * value so legacy systems unaware of FEAT_FGT
1123 				 * do not get trapped due to their lack of
1124 				 * initialization for this feature.
1125 				 */
1126 				write_hfgitr_el2(HFGITR_EL2_INIT_VAL);
1127 				write_hfgrtr_el2(HFGRTR_EL2_INIT_VAL);
1128 				write_hfgwtr_el2(HFGWTR_EL2_INIT_VAL);
1129 			}
1130 
1131 			/* Condition to ensure EL2 is being used. */
1132 			if ((scr_el3 & SCR_HCE_BIT) != 0U) {
1133 				/* Initialize SCTLR_EL2 register with reset value. */
1134 				sctlr_el2 = SCTLR_EL2_RES1;
1135 
1136 				/*
1137 				 * If workaround of errata 764081 for Cortex-A75
1138 				 * is used then set SCTLR_EL2.IESB to enable
1139 				 * Implicit Error Synchronization Barrier.
1140 				 */
1141 				if (errata_a75_764081_applies()) {
1142 					sctlr_el2 |= SCTLR_IESB_BIT;
1143 				}
1144 
1145 				write_sctlr_el2(sctlr_el2);
1146 			} else {
1147 				/*
1148 				 * (scr_el3 & SCR_HCE_BIT==0)
1149 				 * EL2 implemented but unused.
1150 				 */
1151 				init_nonsecure_el2_unused(ctx);
1152 			}
1153 		}
1154 	}
1155 #if (!CTX_INCLUDE_EL2_REGS)
1156 	/* Restore EL1 system registers, only when CTX_INCLUDE_EL2_REGS=0 */
1157 	cm_el1_sysregs_context_restore(security_state);
1158 #endif
1159 	cm_set_next_eret_context(security_state);
1160 }
1161 
1162 #if (CTX_INCLUDE_EL2_REGS && IMAGE_BL31)
1163 
1164 static void el2_sysregs_context_save_fgt(el2_sysregs_t *ctx)
1165 {
1166 	write_el2_ctx_fgt(ctx, hdfgrtr_el2, read_hdfgrtr_el2());
1167 	if (is_feat_amu_supported()) {
1168 		write_el2_ctx_fgt(ctx, hafgrtr_el2, read_hafgrtr_el2());
1169 	}
1170 	write_el2_ctx_fgt(ctx, hdfgwtr_el2, read_hdfgwtr_el2());
1171 	write_el2_ctx_fgt(ctx, hfgitr_el2, read_hfgitr_el2());
1172 	write_el2_ctx_fgt(ctx, hfgrtr_el2, read_hfgrtr_el2());
1173 	write_el2_ctx_fgt(ctx, hfgwtr_el2, read_hfgwtr_el2());
1174 }
1175 
1176 static void el2_sysregs_context_restore_fgt(el2_sysregs_t *ctx)
1177 {
1178 	write_hdfgrtr_el2(read_el2_ctx_fgt(ctx, hdfgrtr_el2));
1179 	if (is_feat_amu_supported()) {
1180 		write_hafgrtr_el2(read_el2_ctx_fgt(ctx, hafgrtr_el2));
1181 	}
1182 	write_hdfgwtr_el2(read_el2_ctx_fgt(ctx, hdfgwtr_el2));
1183 	write_hfgitr_el2(read_el2_ctx_fgt(ctx, hfgitr_el2));
1184 	write_hfgrtr_el2(read_el2_ctx_fgt(ctx, hfgrtr_el2));
1185 	write_hfgwtr_el2(read_el2_ctx_fgt(ctx, hfgwtr_el2));
1186 }
1187 
1188 static void el2_sysregs_context_save_fgt2(el2_sysregs_t *ctx)
1189 {
1190 	write_el2_ctx_fgt2(ctx, hdfgrtr2_el2, read_hdfgrtr2_el2());
1191 	write_el2_ctx_fgt2(ctx, hdfgwtr2_el2, read_hdfgwtr2_el2());
1192 	write_el2_ctx_fgt2(ctx, hfgitr2_el2, read_hfgitr2_el2());
1193 	write_el2_ctx_fgt2(ctx, hfgrtr2_el2, read_hfgrtr2_el2());
1194 	write_el2_ctx_fgt2(ctx, hfgwtr2_el2, read_hfgwtr2_el2());
1195 }
1196 
1197 static void el2_sysregs_context_restore_fgt2(el2_sysregs_t *ctx)
1198 {
1199 	write_hdfgrtr2_el2(read_el2_ctx_fgt2(ctx, hdfgrtr2_el2));
1200 	write_hdfgwtr2_el2(read_el2_ctx_fgt2(ctx, hdfgwtr2_el2));
1201 	write_hfgitr2_el2(read_el2_ctx_fgt2(ctx, hfgitr2_el2));
1202 	write_hfgrtr2_el2(read_el2_ctx_fgt2(ctx, hfgrtr2_el2));
1203 	write_hfgwtr2_el2(read_el2_ctx_fgt2(ctx, hfgwtr2_el2));
1204 }
1205 
1206 static void el2_sysregs_context_save_mpam(el2_sysregs_t *ctx)
1207 {
1208 	u_register_t mpam_idr = read_mpamidr_el1();
1209 
1210 	write_el2_ctx_mpam(ctx, mpam2_el2, read_mpam2_el2());
1211 
1212 	/*
1213 	 * The context registers that we intend to save would be part of the
1214 	 * PE's system register frame only if MPAMIDR_EL1.HAS_HCR == 1.
1215 	 */
1216 	if ((mpam_idr & MPAMIDR_HAS_HCR_BIT) == 0U) {
1217 		return;
1218 	}
1219 
1220 	/*
1221 	 * MPAMHCR_EL2, MPAMVPMV_EL2 and MPAMVPM0_EL2 are always present if
1222 	 * MPAMIDR_HAS_HCR_BIT == 1.
1223 	 */
1224 	write_el2_ctx_mpam(ctx, mpamhcr_el2, read_mpamhcr_el2());
1225 	write_el2_ctx_mpam(ctx, mpamvpm0_el2, read_mpamvpm0_el2());
1226 	write_el2_ctx_mpam(ctx, mpamvpmv_el2, read_mpamvpmv_el2());
1227 
1228 	/*
1229 	 * The number of MPAMVPM registers is implementation defined, their
1230 	 * number is stored in the MPAMIDR_EL1 register.
1231 	 */
1232 	switch ((mpam_idr >> MPAMIDR_EL1_VPMR_MAX_SHIFT) & MPAMIDR_EL1_VPMR_MAX_MASK) {
1233 	case 7:
1234 		write_el2_ctx_mpam(ctx, mpamvpm7_el2, read_mpamvpm7_el2());
1235 		__fallthrough;
1236 	case 6:
1237 		write_el2_ctx_mpam(ctx, mpamvpm6_el2, read_mpamvpm6_el2());
1238 		__fallthrough;
1239 	case 5:
1240 		write_el2_ctx_mpam(ctx, mpamvpm5_el2, read_mpamvpm5_el2());
1241 		__fallthrough;
1242 	case 4:
1243 		write_el2_ctx_mpam(ctx, mpamvpm4_el2, read_mpamvpm4_el2());
1244 		__fallthrough;
1245 	case 3:
1246 		write_el2_ctx_mpam(ctx, mpamvpm3_el2, read_mpamvpm3_el2());
1247 		__fallthrough;
1248 	case 2:
1249 		write_el2_ctx_mpam(ctx, mpamvpm2_el2, read_mpamvpm2_el2());
1250 		__fallthrough;
1251 	case 1:
1252 		write_el2_ctx_mpam(ctx, mpamvpm1_el2, read_mpamvpm1_el2());
1253 		break;
1254 	}
1255 }
1256 
1257 static void el2_sysregs_context_restore_mpam(el2_sysregs_t *ctx)
1258 {
1259 	u_register_t mpam_idr = read_mpamidr_el1();
1260 
1261 	write_mpam2_el2(read_el2_ctx_mpam(ctx, mpam2_el2));
1262 
1263 	if ((mpam_idr & MPAMIDR_HAS_HCR_BIT) == 0U) {
1264 		return;
1265 	}
1266 
1267 	write_mpamhcr_el2(read_el2_ctx_mpam(ctx, mpamhcr_el2));
1268 	write_mpamvpm0_el2(read_el2_ctx_mpam(ctx, mpamvpm0_el2));
1269 	write_mpamvpmv_el2(read_el2_ctx_mpam(ctx, mpamvpmv_el2));
1270 
1271 	switch ((mpam_idr >> MPAMIDR_EL1_VPMR_MAX_SHIFT) & MPAMIDR_EL1_VPMR_MAX_MASK) {
1272 	case 7:
1273 		write_mpamvpm7_el2(read_el2_ctx_mpam(ctx, mpamvpm7_el2));
1274 		__fallthrough;
1275 	case 6:
1276 		write_mpamvpm6_el2(read_el2_ctx_mpam(ctx, mpamvpm6_el2));
1277 		__fallthrough;
1278 	case 5:
1279 		write_mpamvpm5_el2(read_el2_ctx_mpam(ctx, mpamvpm5_el2));
1280 		__fallthrough;
1281 	case 4:
1282 		write_mpamvpm4_el2(read_el2_ctx_mpam(ctx, mpamvpm4_el2));
1283 		__fallthrough;
1284 	case 3:
1285 		write_mpamvpm3_el2(read_el2_ctx_mpam(ctx, mpamvpm3_el2));
1286 		__fallthrough;
1287 	case 2:
1288 		write_mpamvpm2_el2(read_el2_ctx_mpam(ctx, mpamvpm2_el2));
1289 		__fallthrough;
1290 	case 1:
1291 		write_mpamvpm1_el2(read_el2_ctx_mpam(ctx, mpamvpm1_el2));
1292 		break;
1293 	}
1294 }
1295 
1296 /* ---------------------------------------------------------------------------
1297  * The following registers are not added:
1298  * ICH_AP0R<n>_EL2
1299  * ICH_AP1R<n>_EL2
1300  * ICH_LR<n>_EL2
1301  *
1302  * NOTE: For a system with S-EL2 present but not enabled, accessing
1303  * ICC_SRE_EL2 is undefined from EL3. To workaround this change the
1304  * SCR_EL3.NS = 1 before accessing this register.
1305  * ---------------------------------------------------------------------------
1306  */
1307 static void el2_sysregs_context_save_gic(el2_sysregs_t *ctx, uint32_t security_state)
1308 {
1309 	u_register_t scr_el3 = read_scr_el3();
1310 
1311 #if defined(SPD_spmd) && SPMD_SPM_AT_SEL2
1312 	write_el2_ctx_common(ctx, icc_sre_el2, read_icc_sre_el2());
1313 #else
1314 	write_scr_el3(scr_el3 | SCR_NS_BIT);
1315 	isb();
1316 
1317 	write_el2_ctx_common(ctx, icc_sre_el2, read_icc_sre_el2());
1318 
1319 	write_scr_el3(scr_el3);
1320 	isb();
1321 #endif
1322 	write_el2_ctx_common(ctx, ich_hcr_el2, read_ich_hcr_el2());
1323 
1324 	if (errata_ich_vmcr_el2_applies()) {
1325 		if (security_state == SECURE) {
1326 			write_scr_el3(scr_el3 & ~SCR_NS_BIT);
1327 		} else {
1328 			write_scr_el3(scr_el3 | SCR_NS_BIT);
1329 		}
1330 		isb();
1331 	}
1332 
1333 	write_el2_ctx_common(ctx, ich_vmcr_el2, read_ich_vmcr_el2());
1334 
1335 	if (errata_ich_vmcr_el2_applies()) {
1336 		write_scr_el3(scr_el3);
1337 		isb();
1338 	}
1339 }
1340 
1341 static void el2_sysregs_context_restore_gic(el2_sysregs_t *ctx, uint32_t security_state)
1342 {
1343 	u_register_t scr_el3 = read_scr_el3();
1344 
1345 #if defined(SPD_spmd) && SPMD_SPM_AT_SEL2
1346 	write_icc_sre_el2(read_el2_ctx_common(ctx, icc_sre_el2));
1347 #else
1348 	write_scr_el3(scr_el3 | SCR_NS_BIT);
1349 	isb();
1350 
1351 	write_icc_sre_el2(read_el2_ctx_common(ctx, icc_sre_el2));
1352 
1353 	write_scr_el3(scr_el3);
1354 	isb();
1355 #endif
1356 	write_ich_hcr_el2(read_el2_ctx_common(ctx, ich_hcr_el2));
1357 
1358 	if (errata_ich_vmcr_el2_applies()) {
1359 		if (security_state == SECURE) {
1360 			write_scr_el3(scr_el3 & ~SCR_NS_BIT);
1361 		} else {
1362 			write_scr_el3(scr_el3 | SCR_NS_BIT);
1363 		}
1364 		isb();
1365 	}
1366 
1367 	write_ich_vmcr_el2(read_el2_ctx_common(ctx, ich_vmcr_el2));
1368 
1369 	if (errata_ich_vmcr_el2_applies()) {
1370 		write_scr_el3(scr_el3);
1371 		isb();
1372 	}
1373 }
1374 
1375 /* -----------------------------------------------------
1376  * The following registers are not added:
1377  * AMEVCNTVOFF0<n>_EL2
1378  * AMEVCNTVOFF1<n>_EL2
1379  * -----------------------------------------------------
1380  */
1381 static void el2_sysregs_context_save_common(el2_sysregs_t *ctx)
1382 {
1383 	write_el2_ctx_common(ctx, actlr_el2, read_actlr_el2());
1384 	write_el2_ctx_common(ctx, afsr0_el2, read_afsr0_el2());
1385 	write_el2_ctx_common(ctx, afsr1_el2, read_afsr1_el2());
1386 	write_el2_ctx_common(ctx, amair_el2, read_amair_el2());
1387 	write_el2_ctx_common(ctx, cnthctl_el2, read_cnthctl_el2());
1388 	write_el2_ctx_common(ctx, cntvoff_el2, read_cntvoff_el2());
1389 	write_el2_ctx_common(ctx, cptr_el2, read_cptr_el2());
1390 	if (CTX_INCLUDE_AARCH32_REGS) {
1391 		write_el2_ctx_common(ctx, dbgvcr32_el2, read_dbgvcr32_el2());
1392 	}
1393 	write_el2_ctx_common(ctx, elr_el2, read_elr_el2());
1394 	write_el2_ctx_common(ctx, esr_el2, read_esr_el2());
1395 	write_el2_ctx_common(ctx, far_el2, read_far_el2());
1396 	write_el2_ctx_common(ctx, hacr_el2, read_hacr_el2());
1397 	write_el2_ctx_common(ctx, hcr_el2, read_hcr_el2());
1398 	write_el2_ctx_common(ctx, hpfar_el2, read_hpfar_el2());
1399 	write_el2_ctx_common(ctx, hstr_el2, read_hstr_el2());
1400 	write_el2_ctx_common(ctx, mair_el2, read_mair_el2());
1401 	write_el2_ctx_common(ctx, mdcr_el2, read_mdcr_el2());
1402 	write_el2_ctx_common(ctx, sctlr_el2, read_sctlr_el2());
1403 	write_el2_ctx_common(ctx, spsr_el2, read_spsr_el2());
1404 	write_el2_ctx_common(ctx, sp_el2, read_sp_el2());
1405 	write_el2_ctx_common(ctx, tcr_el2, read_tcr_el2());
1406 	write_el2_ctx_common(ctx, tpidr_el2, read_tpidr_el2());
1407 	write_el2_ctx_common(ctx, vbar_el2, read_vbar_el2());
1408 	write_el2_ctx_common(ctx, vmpidr_el2, read_vmpidr_el2());
1409 	write_el2_ctx_common(ctx, vpidr_el2, read_vpidr_el2());
1410 	write_el2_ctx_common(ctx, vtcr_el2, read_vtcr_el2());
1411 
1412 	write_el2_ctx_common_sysreg128(ctx, ttbr0_el2, read_ttbr0_el2());
1413 	write_el2_ctx_common_sysreg128(ctx, vttbr_el2, read_vttbr_el2());
1414 }
1415 
1416 static void el2_sysregs_context_restore_common(el2_sysregs_t *ctx)
1417 {
1418 	write_actlr_el2(read_el2_ctx_common(ctx, actlr_el2));
1419 	write_afsr0_el2(read_el2_ctx_common(ctx, afsr0_el2));
1420 	write_afsr1_el2(read_el2_ctx_common(ctx, afsr1_el2));
1421 	write_amair_el2(read_el2_ctx_common(ctx, amair_el2));
1422 	write_cnthctl_el2(read_el2_ctx_common(ctx, cnthctl_el2));
1423 	write_cntvoff_el2(read_el2_ctx_common(ctx, cntvoff_el2));
1424 	write_cptr_el2(read_el2_ctx_common(ctx, cptr_el2));
1425 	if (CTX_INCLUDE_AARCH32_REGS) {
1426 		write_dbgvcr32_el2(read_el2_ctx_common(ctx, dbgvcr32_el2));
1427 	}
1428 	write_elr_el2(read_el2_ctx_common(ctx, elr_el2));
1429 	write_esr_el2(read_el2_ctx_common(ctx, esr_el2));
1430 	write_far_el2(read_el2_ctx_common(ctx, far_el2));
1431 	write_hacr_el2(read_el2_ctx_common(ctx, hacr_el2));
1432 	write_hcr_el2(read_el2_ctx_common(ctx, hcr_el2));
1433 	write_hpfar_el2(read_el2_ctx_common(ctx, hpfar_el2));
1434 	write_hstr_el2(read_el2_ctx_common(ctx, hstr_el2));
1435 	write_mair_el2(read_el2_ctx_common(ctx, mair_el2));
1436 	write_mdcr_el2(read_el2_ctx_common(ctx, mdcr_el2));
1437 	write_sctlr_el2(read_el2_ctx_common(ctx, sctlr_el2));
1438 	write_spsr_el2(read_el2_ctx_common(ctx, spsr_el2));
1439 	write_sp_el2(read_el2_ctx_common(ctx, sp_el2));
1440 	write_tcr_el2(read_el2_ctx_common(ctx, tcr_el2));
1441 	write_tpidr_el2(read_el2_ctx_common(ctx, tpidr_el2));
1442 	write_ttbr0_el2(read_el2_ctx_common(ctx, ttbr0_el2));
1443 	write_vbar_el2(read_el2_ctx_common(ctx, vbar_el2));
1444 	write_vmpidr_el2(read_el2_ctx_common(ctx, vmpidr_el2));
1445 	write_vpidr_el2(read_el2_ctx_common(ctx, vpidr_el2));
1446 	write_vtcr_el2(read_el2_ctx_common(ctx, vtcr_el2));
1447 	write_vttbr_el2(read_el2_ctx_common(ctx, vttbr_el2));
1448 }
1449 
1450 /*******************************************************************************
1451  * Save EL2 sysreg context
1452  ******************************************************************************/
1453 void cm_el2_sysregs_context_save(uint32_t security_state)
1454 {
1455 	cpu_context_t *ctx;
1456 	el2_sysregs_t *el2_sysregs_ctx;
1457 
1458 	ctx = cm_get_context(security_state);
1459 	assert(ctx != NULL);
1460 
1461 	el2_sysregs_ctx = get_el2_sysregs_ctx(ctx);
1462 
1463 	el2_sysregs_context_save_common(el2_sysregs_ctx);
1464 	el2_sysregs_context_save_gic(el2_sysregs_ctx, security_state);
1465 
1466 	if (is_feat_mte2_supported()) {
1467 		write_el2_ctx_mte2(el2_sysregs_ctx, tfsr_el2, read_tfsr_el2());
1468 	}
1469 
1470 	if (is_feat_mpam_supported()) {
1471 		el2_sysregs_context_save_mpam(el2_sysregs_ctx);
1472 	}
1473 
1474 	if (is_feat_fgt_supported()) {
1475 		el2_sysregs_context_save_fgt(el2_sysregs_ctx);
1476 	}
1477 
1478 	if (is_feat_fgt2_supported()) {
1479 		el2_sysregs_context_save_fgt2(el2_sysregs_ctx);
1480 	}
1481 
1482 	if (is_feat_ecv_v2_supported()) {
1483 		write_el2_ctx_ecv(el2_sysregs_ctx, cntpoff_el2, read_cntpoff_el2());
1484 	}
1485 
1486 	if (is_feat_vhe_supported()) {
1487 		write_el2_ctx_vhe(el2_sysregs_ctx, contextidr_el2,
1488 					read_contextidr_el2());
1489 		write_el2_ctx_vhe_sysreg128(el2_sysregs_ctx, ttbr1_el2, read_ttbr1_el2());
1490 	}
1491 
1492 	if (is_feat_ras_supported()) {
1493 		write_el2_ctx_ras(el2_sysregs_ctx, vdisr_el2, read_vdisr_el2());
1494 		write_el2_ctx_ras(el2_sysregs_ctx, vsesr_el2, read_vsesr_el2());
1495 	}
1496 
1497 	if (is_feat_nv2_supported()) {
1498 		write_el2_ctx_neve(el2_sysregs_ctx, vncr_el2, read_vncr_el2());
1499 	}
1500 
1501 	if (is_feat_trf_supported()) {
1502 		write_el2_ctx_trf(el2_sysregs_ctx, trfcr_el2, read_trfcr_el2());
1503 	}
1504 
1505 	if (is_feat_csv2_2_supported()) {
1506 		write_el2_ctx_csv2_2(el2_sysregs_ctx, scxtnum_el2,
1507 					read_scxtnum_el2());
1508 	}
1509 
1510 	if (is_feat_hcx_supported()) {
1511 		write_el2_ctx_hcx(el2_sysregs_ctx, hcrx_el2, read_hcrx_el2());
1512 	}
1513 
1514 	if (is_feat_tcr2_supported()) {
1515 		write_el2_ctx_tcr2(el2_sysregs_ctx, tcr2_el2, read_tcr2_el2());
1516 	}
1517 
1518 	if (is_feat_sxpie_supported()) {
1519 		write_el2_ctx_sxpie(el2_sysregs_ctx, pire0_el2, read_pire0_el2());
1520 		write_el2_ctx_sxpie(el2_sysregs_ctx, pir_el2, read_pir_el2());
1521 	}
1522 
1523 	if (is_feat_sxpoe_supported()) {
1524 		write_el2_ctx_sxpoe(el2_sysregs_ctx, por_el2, read_por_el2());
1525 	}
1526 
1527 	if (is_feat_brbe_supported()) {
1528 		write_el2_ctx_brbe(el2_sysregs_ctx, brbcr_el2, read_brbcr_el2());
1529 	}
1530 
1531 	if (is_feat_s2pie_supported()) {
1532 		write_el2_ctx_s2pie(el2_sysregs_ctx, s2pir_el2, read_s2pir_el2());
1533 	}
1534 
1535 	if (is_feat_gcs_supported()) {
1536 		write_el2_ctx_gcs(el2_sysregs_ctx, gcscr_el2, read_gcscr_el2());
1537 		write_el2_ctx_gcs(el2_sysregs_ctx, gcspr_el2, read_gcspr_el2());
1538 	}
1539 
1540 	if (is_feat_sctlr2_supported()) {
1541 		write_el2_ctx_sctlr2(el2_sysregs_ctx, sctlr2_el2, read_sctlr2_el2());
1542 	}
1543 }
1544 
1545 /*******************************************************************************
1546  * Restore EL2 sysreg context
1547  ******************************************************************************/
1548 void cm_el2_sysregs_context_restore(uint32_t security_state)
1549 {
1550 	cpu_context_t *ctx;
1551 	el2_sysregs_t *el2_sysregs_ctx;
1552 
1553 	ctx = cm_get_context(security_state);
1554 	assert(ctx != NULL);
1555 
1556 	el2_sysregs_ctx = get_el2_sysregs_ctx(ctx);
1557 
1558 	el2_sysregs_context_restore_common(el2_sysregs_ctx);
1559 	el2_sysregs_context_restore_gic(el2_sysregs_ctx, security_state);
1560 
1561 	if (is_feat_mte2_supported()) {
1562 		write_tfsr_el2(read_el2_ctx_mte2(el2_sysregs_ctx, tfsr_el2));
1563 	}
1564 
1565 	if (is_feat_mpam_supported()) {
1566 		el2_sysregs_context_restore_mpam(el2_sysregs_ctx);
1567 	}
1568 
1569 	if (is_feat_fgt_supported()) {
1570 		el2_sysregs_context_restore_fgt(el2_sysregs_ctx);
1571 	}
1572 
1573 	if (is_feat_fgt2_supported()) {
1574 		el2_sysregs_context_restore_fgt2(el2_sysregs_ctx);
1575 	}
1576 
1577 	if (is_feat_ecv_v2_supported()) {
1578 		write_cntpoff_el2(read_el2_ctx_ecv(el2_sysregs_ctx, cntpoff_el2));
1579 	}
1580 
1581 	if (is_feat_vhe_supported()) {
1582 		write_contextidr_el2(read_el2_ctx_vhe(el2_sysregs_ctx,
1583 					contextidr_el2));
1584 		write_ttbr1_el2(read_el2_ctx_vhe(el2_sysregs_ctx, ttbr1_el2));
1585 	}
1586 
1587 	if (is_feat_ras_supported()) {
1588 		write_vdisr_el2(read_el2_ctx_ras(el2_sysregs_ctx, vdisr_el2));
1589 		write_vsesr_el2(read_el2_ctx_ras(el2_sysregs_ctx, vsesr_el2));
1590 	}
1591 
1592 	if (is_feat_nv2_supported()) {
1593 		write_vncr_el2(read_el2_ctx_neve(el2_sysregs_ctx, vncr_el2));
1594 	}
1595 
1596 	if (is_feat_trf_supported()) {
1597 		write_trfcr_el2(read_el2_ctx_trf(el2_sysregs_ctx, trfcr_el2));
1598 	}
1599 
1600 	if (is_feat_csv2_2_supported()) {
1601 		write_scxtnum_el2(read_el2_ctx_csv2_2(el2_sysregs_ctx,
1602 					scxtnum_el2));
1603 	}
1604 
1605 	if (is_feat_hcx_supported()) {
1606 		write_hcrx_el2(read_el2_ctx_hcx(el2_sysregs_ctx, hcrx_el2));
1607 	}
1608 
1609 	if (is_feat_tcr2_supported()) {
1610 		write_tcr2_el2(read_el2_ctx_tcr2(el2_sysregs_ctx, tcr2_el2));
1611 	}
1612 
1613 	if (is_feat_sxpie_supported()) {
1614 		write_pire0_el2(read_el2_ctx_sxpie(el2_sysregs_ctx, pire0_el2));
1615 		write_pir_el2(read_el2_ctx_sxpie(el2_sysregs_ctx, pir_el2));
1616 	}
1617 
1618 	if (is_feat_sxpoe_supported()) {
1619 		write_por_el2(read_el2_ctx_sxpoe(el2_sysregs_ctx, por_el2));
1620 	}
1621 
1622 	if (is_feat_s2pie_supported()) {
1623 		write_s2pir_el2(read_el2_ctx_s2pie(el2_sysregs_ctx, s2pir_el2));
1624 	}
1625 
1626 	if (is_feat_gcs_supported()) {
1627 		write_gcscr_el2(read_el2_ctx_gcs(el2_sysregs_ctx, gcscr_el2));
1628 		write_gcspr_el2(read_el2_ctx_gcs(el2_sysregs_ctx, gcspr_el2));
1629 	}
1630 
1631 	if (is_feat_sctlr2_supported()) {
1632 		write_sctlr2_el2(read_el2_ctx_sctlr2(el2_sysregs_ctx, sctlr2_el2));
1633 	}
1634 
1635 	if (is_feat_brbe_supported()) {
1636 		write_brbcr_el2(read_el2_ctx_brbe(el2_sysregs_ctx, brbcr_el2));
1637 	}
1638 }
1639 #endif /* (CTX_INCLUDE_EL2_REGS && IMAGE_BL31) */
1640 
1641 #if IMAGE_BL31
1642 /*********************************************************************************
1643 * This function allows Architecture features asymmetry among cores.
1644 * TF-A assumes that all the cores in the platform has architecture feature parity
1645 * and hence the context is setup on different core (e.g. primary sets up the
1646 * context for secondary cores).This assumption may not be true for systems where
1647 * cores are not conforming to same Arch version or there is CPU Erratum which
1648 * requires certain feature to be be disabled only on a given core.
1649 *
1650 * This function is called on secondary cores to override any disparity in context
1651 * setup by primary, this would be called during warmboot path.
1652 *********************************************************************************/
1653 void cm_handle_asymmetric_features(void)
1654 {
1655 	cpu_context_t *ctx __maybe_unused = cm_get_context(NON_SECURE);
1656 
1657 	assert(ctx != NULL);
1658 
1659 #if ENABLE_SPE_FOR_NS == FEAT_STATE_CHECK_ASYMMETRIC
1660 	if (is_feat_spe_supported()) {
1661 		spe_enable(ctx);
1662 	} else {
1663 		spe_disable(ctx);
1664 	}
1665 #endif
1666 
1667 #if ERRATA_A520_2938996 || ERRATA_X4_2726228
1668 	if (check_if_affected_core() == ERRATA_APPLIES) {
1669 		if (is_feat_trbe_supported()) {
1670 			trbe_disable(ctx);
1671 		}
1672 	}
1673 #endif
1674 
1675 #if ENABLE_FEAT_TCR2 == FEAT_STATE_CHECK_ASYMMETRIC
1676 	el3_state_t *el3_state = get_el3state_ctx(ctx);
1677 	u_register_t spsr = read_ctx_reg(el3_state, CTX_SPSR_EL3);
1678 
1679 	if (is_feat_tcr2_supported() && (GET_RW(spsr) == MODE_RW_64)) {
1680 		tcr2_enable(ctx);
1681 	} else {
1682 		tcr2_disable(ctx);
1683 	}
1684 #endif
1685 
1686 }
1687 #endif
1688 
1689 /*******************************************************************************
1690  * This function is used to exit to Non-secure world. If CTX_INCLUDE_EL2_REGS
1691  * is enabled, it restores EL1 and EL2 sysreg contexts instead of directly
1692  * updating EL1 and EL2 registers. Otherwise, it calls the generic
1693  * cm_prepare_el3_exit function.
1694  ******************************************************************************/
1695 void cm_prepare_el3_exit_ns(void)
1696 {
1697 #if IMAGE_BL31
1698 	/*
1699 	 * Check and handle Architecture feature asymmetry among cores.
1700 	 *
1701 	 * In warmboot path secondary cores context is initialized on core which
1702 	 * did CPU_ON SMC call, if there is feature asymmetry in these cores handle
1703 	 * it in this function call.
1704 	 * For Symmetric cores this is an empty function.
1705 	 */
1706 	cm_handle_asymmetric_features();
1707 #endif
1708 
1709 #if (CTX_INCLUDE_EL2_REGS && IMAGE_BL31)
1710 #if ENABLE_ASSERTIONS
1711 	cpu_context_t *ctx = cm_get_context(NON_SECURE);
1712 	assert(ctx != NULL);
1713 
1714 	/* Assert that EL2 is used. */
1715 	u_register_t scr_el3 = read_ctx_reg(get_el3state_ctx(ctx), CTX_SCR_EL3);
1716 	assert(((scr_el3 & SCR_HCE_BIT) != 0UL) &&
1717 			(el_implemented(2U) != EL_IMPL_NONE));
1718 #endif /* ENABLE_ASSERTIONS */
1719 
1720 	/* Restore EL2 sysreg contexts */
1721 	cm_el2_sysregs_context_restore(NON_SECURE);
1722 	cm_set_next_eret_context(NON_SECURE);
1723 #else
1724 	cm_prepare_el3_exit(NON_SECURE);
1725 #endif /* (CTX_INCLUDE_EL2_REGS && IMAGE_BL31) */
1726 }
1727 
1728 #if ((IMAGE_BL1) || (IMAGE_BL31 && (!CTX_INCLUDE_EL2_REGS)))
1729 /*******************************************************************************
1730  * The next set of six functions are used by runtime services to save and restore
1731  * EL1 context on the 'cpu_context' structure for the specified security state.
1732  ******************************************************************************/
1733 static void el1_sysregs_context_save(el1_sysregs_t *ctx)
1734 {
1735 	write_el1_ctx_common(ctx, spsr_el1, read_spsr_el1());
1736 	write_el1_ctx_common(ctx, elr_el1, read_elr_el1());
1737 
1738 #if (!ERRATA_SPECULATIVE_AT)
1739 	write_el1_ctx_common(ctx, sctlr_el1, read_sctlr_el1());
1740 	write_el1_ctx_common(ctx, tcr_el1, read_tcr_el1());
1741 #endif /* (!ERRATA_SPECULATIVE_AT) */
1742 
1743 	write_el1_ctx_common(ctx, cpacr_el1, read_cpacr_el1());
1744 	write_el1_ctx_common(ctx, csselr_el1, read_csselr_el1());
1745 	write_el1_ctx_common(ctx, sp_el1, read_sp_el1());
1746 	write_el1_ctx_common(ctx, esr_el1, read_esr_el1());
1747 	write_el1_ctx_common(ctx, mair_el1, read_mair_el1());
1748 	write_el1_ctx_common(ctx, amair_el1, read_amair_el1());
1749 	write_el1_ctx_common(ctx, actlr_el1, read_actlr_el1());
1750 	write_el1_ctx_common(ctx, tpidr_el1, read_tpidr_el1());
1751 	write_el1_ctx_common(ctx, tpidr_el0, read_tpidr_el0());
1752 	write_el1_ctx_common(ctx, tpidrro_el0, read_tpidrro_el0());
1753 	write_el1_ctx_common(ctx, far_el1, read_far_el1());
1754 	write_el1_ctx_common(ctx, afsr0_el1, read_afsr0_el1());
1755 	write_el1_ctx_common(ctx, afsr1_el1, read_afsr1_el1());
1756 	write_el1_ctx_common(ctx, contextidr_el1, read_contextidr_el1());
1757 	write_el1_ctx_common(ctx, vbar_el1, read_vbar_el1());
1758 	write_el1_ctx_common(ctx, mdccint_el1, read_mdccint_el1());
1759 	write_el1_ctx_common(ctx, mdscr_el1, read_mdscr_el1());
1760 
1761 	write_el1_ctx_common_sysreg128(ctx, par_el1, read_par_el1());
1762 	write_el1_ctx_common_sysreg128(ctx, ttbr0_el1, read_ttbr0_el1());
1763 	write_el1_ctx_common_sysreg128(ctx, ttbr1_el1, read_ttbr1_el1());
1764 
1765 	if (CTX_INCLUDE_AARCH32_REGS) {
1766 		/* Save Aarch32 registers */
1767 		write_el1_ctx_aarch32(ctx, spsr_abt, read_spsr_abt());
1768 		write_el1_ctx_aarch32(ctx, spsr_und, read_spsr_und());
1769 		write_el1_ctx_aarch32(ctx, spsr_irq, read_spsr_irq());
1770 		write_el1_ctx_aarch32(ctx, spsr_fiq, read_spsr_fiq());
1771 		write_el1_ctx_aarch32(ctx, dacr32_el2, read_dacr32_el2());
1772 		write_el1_ctx_aarch32(ctx, ifsr32_el2, read_ifsr32_el2());
1773 	}
1774 
1775 	if (NS_TIMER_SWITCH) {
1776 		/* Save NS Timer registers */
1777 		write_el1_ctx_arch_timer(ctx, cntp_ctl_el0, read_cntp_ctl_el0());
1778 		write_el1_ctx_arch_timer(ctx, cntp_cval_el0, read_cntp_cval_el0());
1779 		write_el1_ctx_arch_timer(ctx, cntv_ctl_el0, read_cntv_ctl_el0());
1780 		write_el1_ctx_arch_timer(ctx, cntv_cval_el0, read_cntv_cval_el0());
1781 		write_el1_ctx_arch_timer(ctx, cntkctl_el1, read_cntkctl_el1());
1782 	}
1783 
1784 	if (is_feat_mte2_supported()) {
1785 		write_el1_ctx_mte2(ctx, tfsre0_el1, read_tfsre0_el1());
1786 		write_el1_ctx_mte2(ctx, tfsr_el1, read_tfsr_el1());
1787 		write_el1_ctx_mte2(ctx, rgsr_el1, read_rgsr_el1());
1788 		write_el1_ctx_mte2(ctx, gcr_el1, read_gcr_el1());
1789 	}
1790 
1791 	if (is_feat_ras_supported()) {
1792 		write_el1_ctx_ras(ctx, disr_el1, read_disr_el1());
1793 	}
1794 
1795 	if (is_feat_s1pie_supported()) {
1796 		write_el1_ctx_s1pie(ctx, pire0_el1, read_pire0_el1());
1797 		write_el1_ctx_s1pie(ctx, pir_el1, read_pir_el1());
1798 	}
1799 
1800 	if (is_feat_s1poe_supported()) {
1801 		write_el1_ctx_s1poe(ctx, por_el1, read_por_el1());
1802 	}
1803 
1804 	if (is_feat_s2poe_supported()) {
1805 		write_el1_ctx_s2poe(ctx, s2por_el1, read_s2por_el1());
1806 	}
1807 
1808 	if (is_feat_tcr2_supported()) {
1809 		write_el1_ctx_tcr2(ctx, tcr2_el1, read_tcr2_el1());
1810 	}
1811 
1812 	if (is_feat_trf_supported()) {
1813 		write_el1_ctx_trf(ctx, trfcr_el1, read_trfcr_el1());
1814 	}
1815 
1816 	if (is_feat_csv2_2_supported()) {
1817 		write_el1_ctx_csv2_2(ctx, scxtnum_el0, read_scxtnum_el0());
1818 		write_el1_ctx_csv2_2(ctx, scxtnum_el1, read_scxtnum_el1());
1819 	}
1820 
1821 	if (is_feat_gcs_supported()) {
1822 		write_el1_ctx_gcs(ctx, gcscr_el1, read_gcscr_el1());
1823 		write_el1_ctx_gcs(ctx, gcscre0_el1, read_gcscre0_el1());
1824 		write_el1_ctx_gcs(ctx, gcspr_el1, read_gcspr_el1());
1825 		write_el1_ctx_gcs(ctx, gcspr_el0, read_gcspr_el0());
1826 	}
1827 
1828 	if (is_feat_the_supported()) {
1829 		write_el1_ctx_the_sysreg128(ctx, rcwmask_el1, read_rcwmask_el1());
1830 		write_el1_ctx_the_sysreg128(ctx, rcwsmask_el1, read_rcwsmask_el1());
1831 	}
1832 
1833 	if (is_feat_sctlr2_supported()) {
1834 		write_el1_ctx_sctlr2(ctx, sctlr2_el1, read_sctlr2_el1());
1835 	}
1836 
1837 	if (is_feat_ls64_accdata_supported()) {
1838 		write_el1_ctx_ls64(ctx, accdata_el1, read_accdata_el1());
1839 	}
1840 }
1841 
1842 static void el1_sysregs_context_restore(el1_sysregs_t *ctx)
1843 {
1844 	write_spsr_el1(read_el1_ctx_common(ctx, spsr_el1));
1845 	write_elr_el1(read_el1_ctx_common(ctx, elr_el1));
1846 
1847 #if (!ERRATA_SPECULATIVE_AT)
1848 	write_sctlr_el1(read_el1_ctx_common(ctx, sctlr_el1));
1849 	write_tcr_el1(read_el1_ctx_common(ctx, tcr_el1));
1850 #endif /* (!ERRATA_SPECULATIVE_AT) */
1851 
1852 	write_cpacr_el1(read_el1_ctx_common(ctx, cpacr_el1));
1853 	write_csselr_el1(read_el1_ctx_common(ctx, csselr_el1));
1854 	write_sp_el1(read_el1_ctx_common(ctx, sp_el1));
1855 	write_esr_el1(read_el1_ctx_common(ctx, esr_el1));
1856 	write_ttbr0_el1(read_el1_ctx_common(ctx, ttbr0_el1));
1857 	write_ttbr1_el1(read_el1_ctx_common(ctx, ttbr1_el1));
1858 	write_mair_el1(read_el1_ctx_common(ctx, mair_el1));
1859 	write_amair_el1(read_el1_ctx_common(ctx, amair_el1));
1860 	write_actlr_el1(read_el1_ctx_common(ctx, actlr_el1));
1861 	write_tpidr_el1(read_el1_ctx_common(ctx, tpidr_el1));
1862 	write_tpidr_el0(read_el1_ctx_common(ctx, tpidr_el0));
1863 	write_tpidrro_el0(read_el1_ctx_common(ctx, tpidrro_el0));
1864 	write_par_el1(read_el1_ctx_common(ctx, par_el1));
1865 	write_far_el1(read_el1_ctx_common(ctx, far_el1));
1866 	write_afsr0_el1(read_el1_ctx_common(ctx, afsr0_el1));
1867 	write_afsr1_el1(read_el1_ctx_common(ctx, afsr1_el1));
1868 	write_contextidr_el1(read_el1_ctx_common(ctx, contextidr_el1));
1869 	write_vbar_el1(read_el1_ctx_common(ctx, vbar_el1));
1870 	write_mdccint_el1(read_el1_ctx_common(ctx, mdccint_el1));
1871 	write_mdscr_el1(read_el1_ctx_common(ctx, mdscr_el1));
1872 
1873 	if (CTX_INCLUDE_AARCH32_REGS) {
1874 		/* Restore Aarch32 registers */
1875 		write_spsr_abt(read_el1_ctx_aarch32(ctx, spsr_abt));
1876 		write_spsr_und(read_el1_ctx_aarch32(ctx, spsr_und));
1877 		write_spsr_irq(read_el1_ctx_aarch32(ctx, spsr_irq));
1878 		write_spsr_fiq(read_el1_ctx_aarch32(ctx, spsr_fiq));
1879 		write_dacr32_el2(read_el1_ctx_aarch32(ctx, dacr32_el2));
1880 		write_ifsr32_el2(read_el1_ctx_aarch32(ctx, ifsr32_el2));
1881 	}
1882 
1883 	if (NS_TIMER_SWITCH) {
1884 		/* Restore NS Timer registers */
1885 		write_cntp_ctl_el0(read_el1_ctx_arch_timer(ctx, cntp_ctl_el0));
1886 		write_cntp_cval_el0(read_el1_ctx_arch_timer(ctx, cntp_cval_el0));
1887 		write_cntv_ctl_el0(read_el1_ctx_arch_timer(ctx, cntv_ctl_el0));
1888 		write_cntv_cval_el0(read_el1_ctx_arch_timer(ctx, cntv_cval_el0));
1889 		write_cntkctl_el1(read_el1_ctx_arch_timer(ctx, cntkctl_el1));
1890 	}
1891 
1892 	if (is_feat_mte2_supported()) {
1893 		write_tfsre0_el1(read_el1_ctx_mte2(ctx, tfsre0_el1));
1894 		write_tfsr_el1(read_el1_ctx_mte2(ctx, tfsr_el1));
1895 		write_rgsr_el1(read_el1_ctx_mte2(ctx, rgsr_el1));
1896 		write_gcr_el1(read_el1_ctx_mte2(ctx, gcr_el1));
1897 	}
1898 
1899 	if (is_feat_ras_supported()) {
1900 		write_disr_el1(read_el1_ctx_ras(ctx, disr_el1));
1901 	}
1902 
1903 	if (is_feat_s1pie_supported()) {
1904 		write_pire0_el1(read_el1_ctx_s1pie(ctx, pire0_el1));
1905 		write_pir_el1(read_el1_ctx_s1pie(ctx, pir_el1));
1906 	}
1907 
1908 	if (is_feat_s1poe_supported()) {
1909 		write_por_el1(read_el1_ctx_s1poe(ctx, por_el1));
1910 	}
1911 
1912 	if (is_feat_s2poe_supported()) {
1913 		write_s2por_el1(read_el1_ctx_s2poe(ctx, s2por_el1));
1914 	}
1915 
1916 	if (is_feat_tcr2_supported()) {
1917 		write_tcr2_el1(read_el1_ctx_tcr2(ctx, tcr2_el1));
1918 	}
1919 
1920 	if (is_feat_trf_supported()) {
1921 		write_trfcr_el1(read_el1_ctx_trf(ctx, trfcr_el1));
1922 	}
1923 
1924 	if (is_feat_csv2_2_supported()) {
1925 		write_scxtnum_el0(read_el1_ctx_csv2_2(ctx, scxtnum_el0));
1926 		write_scxtnum_el1(read_el1_ctx_csv2_2(ctx, scxtnum_el1));
1927 	}
1928 
1929 	if (is_feat_gcs_supported()) {
1930 		write_gcscr_el1(read_el1_ctx_gcs(ctx, gcscr_el1));
1931 		write_gcscre0_el1(read_el1_ctx_gcs(ctx, gcscre0_el1));
1932 		write_gcspr_el1(read_el1_ctx_gcs(ctx, gcspr_el1));
1933 		write_gcspr_el0(read_el1_ctx_gcs(ctx, gcspr_el0));
1934 	}
1935 
1936 	if (is_feat_the_supported()) {
1937 		write_rcwmask_el1(read_el1_ctx_the(ctx, rcwmask_el1));
1938 		write_rcwsmask_el1(read_el1_ctx_the(ctx, rcwsmask_el1));
1939 	}
1940 
1941 	if (is_feat_sctlr2_supported()) {
1942 		write_sctlr2_el1(read_el1_ctx_sctlr2(ctx, sctlr2_el1));
1943 	}
1944 
1945 	if (is_feat_ls64_accdata_supported()) {
1946 		write_accdata_el1(read_el1_ctx_ls64(ctx, accdata_el1));
1947 	}
1948 }
1949 
1950 /*******************************************************************************
1951  * The next couple of functions are used by runtime services to save and restore
1952  * EL1 context on the 'cpu_context' structure for the specified security state.
1953  ******************************************************************************/
1954 void cm_el1_sysregs_context_save(uint32_t security_state)
1955 {
1956 	cpu_context_t *ctx;
1957 
1958 	ctx = cm_get_context(security_state);
1959 	assert(ctx != NULL);
1960 
1961 	el1_sysregs_context_save(get_el1_sysregs_ctx(ctx));
1962 
1963 #if IMAGE_BL31
1964 	if (security_state == SECURE)
1965 		PUBLISH_EVENT(cm_exited_secure_world);
1966 	else
1967 		PUBLISH_EVENT(cm_exited_normal_world);
1968 #endif
1969 }
1970 
1971 void cm_el1_sysregs_context_restore(uint32_t security_state)
1972 {
1973 	cpu_context_t *ctx;
1974 
1975 	ctx = cm_get_context(security_state);
1976 	assert(ctx != NULL);
1977 
1978 	el1_sysregs_context_restore(get_el1_sysregs_ctx(ctx));
1979 
1980 #if IMAGE_BL31
1981 	if (security_state == SECURE)
1982 		PUBLISH_EVENT(cm_entering_secure_world);
1983 	else
1984 		PUBLISH_EVENT(cm_entering_normal_world);
1985 #endif
1986 }
1987 
1988 #endif /* ((IMAGE_BL1) || (IMAGE_BL31 && (!CTX_INCLUDE_EL2_REGS))) */
1989 
1990 /*******************************************************************************
1991  * This function populates ELR_EL3 member of 'cpu_context' pertaining to the
1992  * given security state with the given entrypoint
1993  ******************************************************************************/
1994 void cm_set_elr_el3(uint32_t security_state, uintptr_t entrypoint)
1995 {
1996 	cpu_context_t *ctx;
1997 	el3_state_t *state;
1998 
1999 	ctx = cm_get_context(security_state);
2000 	assert(ctx != NULL);
2001 
2002 	/* Populate EL3 state so that ERET jumps to the correct entry */
2003 	state = get_el3state_ctx(ctx);
2004 	write_ctx_reg(state, CTX_ELR_EL3, entrypoint);
2005 }
2006 
2007 /*******************************************************************************
2008  * This function populates ELR_EL3 and SPSR_EL3 members of 'cpu_context'
2009  * pertaining to the given security state
2010  ******************************************************************************/
2011 void cm_set_elr_spsr_el3(uint32_t security_state,
2012 			uintptr_t entrypoint, uint32_t spsr)
2013 {
2014 	cpu_context_t *ctx;
2015 	el3_state_t *state;
2016 
2017 	ctx = cm_get_context(security_state);
2018 	assert(ctx != NULL);
2019 
2020 	/* Populate EL3 state so that ERET jumps to the correct entry */
2021 	state = get_el3state_ctx(ctx);
2022 	write_ctx_reg(state, CTX_ELR_EL3, entrypoint);
2023 	write_ctx_reg(state, CTX_SPSR_EL3, spsr);
2024 }
2025 
2026 /*******************************************************************************
2027  * This function updates a single bit in the SCR_EL3 member of the 'cpu_context'
2028  * pertaining to the given security state using the value and bit position
2029  * specified in the parameters. It preserves all other bits.
2030  ******************************************************************************/
2031 void cm_write_scr_el3_bit(uint32_t security_state,
2032 			  uint32_t bit_pos,
2033 			  uint32_t value)
2034 {
2035 	cpu_context_t *ctx;
2036 	el3_state_t *state;
2037 	u_register_t scr_el3;
2038 
2039 	ctx = cm_get_context(security_state);
2040 	assert(ctx != NULL);
2041 
2042 	/* Ensure that the bit position is a valid one */
2043 	assert(((1UL << bit_pos) & SCR_VALID_BIT_MASK) != 0U);
2044 
2045 	/* Ensure that the 'value' is only a bit wide */
2046 	assert(value <= 1U);
2047 
2048 	/*
2049 	 * Get the SCR_EL3 value from the cpu context, clear the desired bit
2050 	 * and set it to its new value.
2051 	 */
2052 	state = get_el3state_ctx(ctx);
2053 	scr_el3 = read_ctx_reg(state, CTX_SCR_EL3);
2054 	scr_el3 &= ~(1UL << bit_pos);
2055 	scr_el3 |= (u_register_t)value << bit_pos;
2056 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
2057 }
2058 
2059 /*******************************************************************************
2060  * This function retrieves SCR_EL3 member of 'cpu_context' pertaining to the
2061  * given security state.
2062  ******************************************************************************/
2063 u_register_t cm_get_scr_el3(uint32_t security_state)
2064 {
2065 	cpu_context_t *ctx;
2066 	el3_state_t *state;
2067 
2068 	ctx = cm_get_context(security_state);
2069 	assert(ctx != NULL);
2070 
2071 	/* Populate EL3 state so that ERET jumps to the correct entry */
2072 	state = get_el3state_ctx(ctx);
2073 	return read_ctx_reg(state, CTX_SCR_EL3);
2074 }
2075 
2076 /*******************************************************************************
2077  * This function is used to program the context that's used for exception
2078  * return. This initializes the SP_EL3 to a pointer to a 'cpu_context' set for
2079  * the required security state
2080  ******************************************************************************/
2081 void cm_set_next_eret_context(uint32_t security_state)
2082 {
2083 	cpu_context_t *ctx;
2084 
2085 	ctx = cm_get_context(security_state);
2086 	assert(ctx != NULL);
2087 
2088 	cm_set_next_context(ctx);
2089 }
2090