xref: /rk3399_ARM-atf/lib/el3_runtime/aarch64/context_mgmt.c (revision b7e398d64cc4d5bfe279f1a50b7c7e4ea9263534)
1532ed618SSoby Mathew /*
28aabea33SPaul Beesley  * Copyright (c) 2013-2019, ARM Limited and Contributors. All rights reserved.
3532ed618SSoby Mathew  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5532ed618SSoby Mathew  */
6532ed618SSoby Mathew 
7532ed618SSoby Mathew #include <assert.h>
840daecc1SAntonio Nino Diaz #include <stdbool.h>
9532ed618SSoby Mathew #include <string.h>
1009d40e0eSAntonio Nino Diaz 
1109d40e0eSAntonio Nino Diaz #include <platform_def.h>
1209d40e0eSAntonio Nino Diaz 
1309d40e0eSAntonio Nino Diaz #include <arch.h>
1409d40e0eSAntonio Nino Diaz #include <arch_helpers.h>
15*b7e398d6SSoby Mathew #include <arch_features.h>
1609d40e0eSAntonio Nino Diaz #include <bl31/interrupt_mgmt.h>
1709d40e0eSAntonio Nino Diaz #include <common/bl_common.h>
1809d40e0eSAntonio Nino Diaz #include <context.h>
1909d40e0eSAntonio Nino Diaz #include <lib/el3_runtime/context_mgmt.h>
2009d40e0eSAntonio Nino Diaz #include <lib/el3_runtime/pubsub_events.h>
2109d40e0eSAntonio Nino Diaz #include <lib/extensions/amu.h>
2209d40e0eSAntonio Nino Diaz #include <lib/extensions/mpam.h>
2309d40e0eSAntonio Nino Diaz #include <lib/extensions/spe.h>
2409d40e0eSAntonio Nino Diaz #include <lib/extensions/sve.h>
2509d40e0eSAntonio Nino Diaz #include <lib/utils.h>
2609d40e0eSAntonio Nino Diaz #include <plat/common/platform.h>
2709d40e0eSAntonio Nino Diaz #include <smccc_helpers.h>
28532ed618SSoby Mathew 
29532ed618SSoby Mathew 
30532ed618SSoby Mathew /*******************************************************************************
31532ed618SSoby Mathew  * Context management library initialisation routine. This library is used by
32532ed618SSoby Mathew  * runtime services to share pointers to 'cpu_context' structures for the secure
33532ed618SSoby Mathew  * and non-secure states. Management of the structures and their associated
34532ed618SSoby Mathew  * memory is not done by the context management library e.g. the PSCI service
35532ed618SSoby Mathew  * manages the cpu context used for entry from and exit to the non-secure state.
36532ed618SSoby Mathew  * The Secure payload dispatcher service manages the context(s) corresponding to
37532ed618SSoby Mathew  * the secure state. It also uses this library to get access to the non-secure
38532ed618SSoby Mathew  * state cpu context pointers.
39532ed618SSoby Mathew  * Lastly, this library provides the api to make SP_EL3 point to the cpu context
40532ed618SSoby Mathew  * which will used for programming an entry into a lower EL. The same context
41532ed618SSoby Mathew  * will used to save state upon exception entry from that EL.
42532ed618SSoby Mathew  ******************************************************************************/
4387c85134SDaniel Boulby void __init cm_init(void)
44532ed618SSoby Mathew {
45532ed618SSoby Mathew 	/*
46532ed618SSoby Mathew 	 * The context management library has only global data to intialize, but
47532ed618SSoby Mathew 	 * that will be done when the BSS is zeroed out
48532ed618SSoby Mathew 	 */
49532ed618SSoby Mathew }
50532ed618SSoby Mathew 
51532ed618SSoby Mathew /*******************************************************************************
52532ed618SSoby Mathew  * The following function initializes the cpu_context 'ctx' for
53532ed618SSoby Mathew  * first use, and sets the initial entrypoint state as specified by the
54532ed618SSoby Mathew  * entry_point_info structure.
55532ed618SSoby Mathew  *
56532ed618SSoby Mathew  * The security state to initialize is determined by the SECURE attribute
571634cae8SAntonio Nino Diaz  * of the entry_point_info.
58532ed618SSoby Mathew  *
598aabea33SPaul Beesley  * The EE and ST attributes are used to configure the endianness and secure
60532ed618SSoby Mathew  * timer availability for the new execution context.
61532ed618SSoby Mathew  *
62532ed618SSoby Mathew  * To prepare the register state for entry call cm_prepare_el3_exit() and
63532ed618SSoby Mathew  * el3_exit(). For Secure-EL1 cm_prepare_el3_exit() is equivalent to
64532ed618SSoby Mathew  * cm_e1_sysreg_context_restore().
65532ed618SSoby Mathew  ******************************************************************************/
661634cae8SAntonio Nino Diaz void cm_setup_context(cpu_context_t *ctx, const entry_point_info_t *ep)
67532ed618SSoby Mathew {
68532ed618SSoby Mathew 	unsigned int security_state;
693e61b2b5SDavid Cunado 	uint32_t scr_el3, pmcr_el0;
70532ed618SSoby Mathew 	el3_state_t *state;
71532ed618SSoby Mathew 	gp_regs_t *gp_regs;
722ab9617eSVarun Wadekar 	unsigned long sctlr_elx, actlr_elx;
73532ed618SSoby Mathew 
74a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
75532ed618SSoby Mathew 
76532ed618SSoby Mathew 	security_state = GET_SECURITY_STATE(ep->h.attr);
77532ed618SSoby Mathew 
78532ed618SSoby Mathew 	/* Clear any residual register values from the context */
7932f0d3c6SDouglas Raillard 	zeromem(ctx, sizeof(*ctx));
80532ed618SSoby Mathew 
81532ed618SSoby Mathew 	/*
8218f2efd6SDavid Cunado 	 * SCR_EL3 was initialised during reset sequence in macro
8318f2efd6SDavid Cunado 	 * el3_arch_init_common. This code modifies the SCR_EL3 fields that
8418f2efd6SDavid Cunado 	 * affect the next EL.
8518f2efd6SDavid Cunado 	 *
8618f2efd6SDavid Cunado 	 * The following fields are initially set to zero and then updated to
8718f2efd6SDavid Cunado 	 * the required value depending on the state of the SPSR_EL3 and the
8818f2efd6SDavid Cunado 	 * Security state and entrypoint attributes of the next EL.
89532ed618SSoby Mathew 	 */
90a0fee747SAntonio Nino Diaz 	scr_el3 = (uint32_t)read_scr();
91532ed618SSoby Mathew 	scr_el3 &= ~(SCR_NS_BIT | SCR_RW_BIT | SCR_FIQ_BIT | SCR_IRQ_BIT |
92532ed618SSoby Mathew 			SCR_ST_BIT | SCR_HCE_BIT);
9318f2efd6SDavid Cunado 	/*
9418f2efd6SDavid Cunado 	 * SCR_NS: Set the security state of the next EL.
9518f2efd6SDavid Cunado 	 */
96532ed618SSoby Mathew 	if (security_state != SECURE)
97532ed618SSoby Mathew 		scr_el3 |= SCR_NS_BIT;
9818f2efd6SDavid Cunado 	/*
9918f2efd6SDavid Cunado 	 * SCR_EL3.RW: Set the execution state, AArch32 or AArch64, for next
10018f2efd6SDavid Cunado 	 *  Exception level as specified by SPSR.
10118f2efd6SDavid Cunado 	 */
102532ed618SSoby Mathew 	if (GET_RW(ep->spsr) == MODE_RW_64)
103532ed618SSoby Mathew 		scr_el3 |= SCR_RW_BIT;
10418f2efd6SDavid Cunado 	/*
10518f2efd6SDavid Cunado 	 * SCR_EL3.ST: Traps Secure EL1 accesses to the Counter-timer Physical
10618f2efd6SDavid Cunado 	 *  Secure timer registers to EL3, from AArch64 state only, if specified
10718f2efd6SDavid Cunado 	 *  by the entrypoint attributes.
10818f2efd6SDavid Cunado 	 */
109a0fee747SAntonio Nino Diaz 	if (EP_GET_ST(ep->h.attr) != 0U)
110532ed618SSoby Mathew 		scr_el3 |= SCR_ST_BIT;
111532ed618SSoby Mathew 
11224f671f3SJulius Werner #if !HANDLE_EA_EL3_FIRST
11318f2efd6SDavid Cunado 	/*
11418f2efd6SDavid Cunado 	 * SCR_EL3.EA: Do not route External Abort and SError Interrupt External
11518f2efd6SDavid Cunado 	 *  to EL3 when executing at a lower EL. When executing at EL3, External
11618f2efd6SDavid Cunado 	 *  Aborts are taken to EL3.
11718f2efd6SDavid Cunado 	 */
118532ed618SSoby Mathew 	scr_el3 &= ~SCR_EA_BIT;
119532ed618SSoby Mathew #endif
120532ed618SSoby Mathew 
1211a7c1cfeSJeenu Viswambharan #if FAULT_INJECTION_SUPPORT
1221a7c1cfeSJeenu Viswambharan 	/* Enable fault injection from lower ELs */
1231a7c1cfeSJeenu Viswambharan 	scr_el3 |= SCR_FIEN_BIT;
1241a7c1cfeSJeenu Viswambharan #endif
1251a7c1cfeSJeenu Viswambharan 
1265283962eSAntonio Nino Diaz #if !CTX_INCLUDE_PAUTH_REGS
1275283962eSAntonio Nino Diaz 	/*
1285283962eSAntonio Nino Diaz 	 * If the pointer authentication registers aren't saved during world
1295283962eSAntonio Nino Diaz 	 * switches the value of the registers can be leaked from the Secure to
1305283962eSAntonio Nino Diaz 	 * the Non-secure world. To prevent this, rather than enabling pointer
1315283962eSAntonio Nino Diaz 	 * authentication everywhere, we only enable it in the Non-secure world.
1325283962eSAntonio Nino Diaz 	 *
1335283962eSAntonio Nino Diaz 	 * If the Secure world wants to use pointer authentication,
1345283962eSAntonio Nino Diaz 	 * CTX_INCLUDE_PAUTH_REGS must be set to 1.
1355283962eSAntonio Nino Diaz 	 */
1365283962eSAntonio Nino Diaz 	if (security_state == NON_SECURE)
1375283962eSAntonio Nino Diaz 		scr_el3 |= SCR_API_BIT | SCR_APK_BIT;
1385283962eSAntonio Nino Diaz #endif /* !CTX_INCLUDE_PAUTH_REGS */
1395283962eSAntonio Nino Diaz 
140*b7e398d6SSoby Mathew 	unsigned int mte = get_armv8_5_mte_support();
141*b7e398d6SSoby Mathew 
142*b7e398d6SSoby Mathew 	/*
143*b7e398d6SSoby Mathew 	 * Enable MTE support unilaterally for normal world if the CPU supports
144*b7e398d6SSoby Mathew 	 * it.
145*b7e398d6SSoby Mathew 	 */
146*b7e398d6SSoby Mathew 	if (mte != MTE_UNIMPLEMENTED) {
147*b7e398d6SSoby Mathew 		if (security_state == NON_SECURE) {
148*b7e398d6SSoby Mathew 			scr_el3 |= SCR_ATA_BIT;
149*b7e398d6SSoby Mathew 		}
150*b7e398d6SSoby Mathew 	}
151*b7e398d6SSoby Mathew 
1523d8256b2SMasahiro Yamada #ifdef IMAGE_BL31
153532ed618SSoby Mathew 	/*
1548aabea33SPaul Beesley 	 * SCR_EL3.IRQ, SCR_EL3.FIQ: Enable the physical FIQ and IRQ routing as
15518f2efd6SDavid Cunado 	 *  indicated by the interrupt routing model for BL31.
156532ed618SSoby Mathew 	 */
157532ed618SSoby Mathew 	scr_el3 |= get_scr_el3_from_routing_model(security_state);
158532ed618SSoby Mathew #endif
159532ed618SSoby Mathew 
160532ed618SSoby Mathew 	/*
16118f2efd6SDavid Cunado 	 * SCR_EL3.HCE: Enable HVC instructions if next execution state is
16218f2efd6SDavid Cunado 	 * AArch64 and next EL is EL2, or if next execution state is AArch32 and
16318f2efd6SDavid Cunado 	 * next mode is Hyp.
164532ed618SSoby Mathew 	 */
165a0fee747SAntonio Nino Diaz 	if (((GET_RW(ep->spsr) == MODE_RW_64) && (GET_EL(ep->spsr) == MODE_EL2))
166a0fee747SAntonio Nino Diaz 	    || ((GET_RW(ep->spsr) != MODE_RW_64)
167a0fee747SAntonio Nino Diaz 		&& (GET_M32(ep->spsr) == MODE32_hyp))) {
168532ed618SSoby Mathew 		scr_el3 |= SCR_HCE_BIT;
169532ed618SSoby Mathew 	}
170532ed618SSoby Mathew 
17118f2efd6SDavid Cunado 	/*
17218f2efd6SDavid Cunado 	 * Initialise SCTLR_EL1 to the reset value corresponding to the target
17318f2efd6SDavid Cunado 	 * execution state setting all fields rather than relying of the hw.
17418f2efd6SDavid Cunado 	 * Some fields have architecturally UNKNOWN reset values and these are
17518f2efd6SDavid Cunado 	 * set to zero.
17618f2efd6SDavid Cunado 	 *
17718f2efd6SDavid Cunado 	 * SCTLR.EE: Endianness is taken from the entrypoint attributes.
17818f2efd6SDavid Cunado 	 *
17918f2efd6SDavid Cunado 	 * SCTLR.M, SCTLR.C and SCTLR.I: These fields must be zero (as
18018f2efd6SDavid Cunado 	 *  required by PSCI specification)
18118f2efd6SDavid Cunado 	 */
182a0fee747SAntonio Nino Diaz 	sctlr_elx = (EP_GET_EE(ep->h.attr) != 0U) ? SCTLR_EE_BIT : 0U;
18318f2efd6SDavid Cunado 	if (GET_RW(ep->spsr) == MODE_RW_64)
18418f2efd6SDavid Cunado 		sctlr_elx |= SCTLR_EL1_RES1;
18518f2efd6SDavid Cunado 	else {
18618f2efd6SDavid Cunado 		/*
18718f2efd6SDavid Cunado 		 * If the target execution state is AArch32 then the following
18818f2efd6SDavid Cunado 		 * fields need to be set.
18918f2efd6SDavid Cunado 		 *
19018f2efd6SDavid Cunado 		 * SCTRL_EL1.nTWE: Set to one so that EL0 execution of WFE
19118f2efd6SDavid Cunado 		 *  instructions are not trapped to EL1.
19218f2efd6SDavid Cunado 		 *
19318f2efd6SDavid Cunado 		 * SCTLR_EL1.nTWI: Set to one so that EL0 execution of WFI
19418f2efd6SDavid Cunado 		 *  instructions are not trapped to EL1.
19518f2efd6SDavid Cunado 		 *
19618f2efd6SDavid Cunado 		 * SCTLR_EL1.CP15BEN: Set to one to enable EL0 execution of the
19718f2efd6SDavid Cunado 		 *  CP15DMB, CP15DSB, and CP15ISB instructions.
19818f2efd6SDavid Cunado 		 */
19918f2efd6SDavid Cunado 		sctlr_elx |= SCTLR_AARCH32_EL1_RES1 | SCTLR_CP15BEN_BIT
20018f2efd6SDavid Cunado 					| SCTLR_NTWI_BIT | SCTLR_NTWE_BIT;
20118f2efd6SDavid Cunado 	}
20218f2efd6SDavid Cunado 
2035f5d1ed7SLouis Mayencourt #if ERRATA_A75_764081
2045f5d1ed7SLouis Mayencourt 	/*
2055f5d1ed7SLouis Mayencourt 	 * If workaround of errata 764081 for Cortex-A75 is used then set
2065f5d1ed7SLouis Mayencourt 	 * SCTLR_EL1.IESB to enable Implicit Error Synchronization Barrier.
2075f5d1ed7SLouis Mayencourt 	 */
2085f5d1ed7SLouis Mayencourt 	sctlr_elx |= SCTLR_IESB_BIT;
2095f5d1ed7SLouis Mayencourt #endif
2105f5d1ed7SLouis Mayencourt 
21118f2efd6SDavid Cunado 	/*
21218f2efd6SDavid Cunado 	 * Store the initialised SCTLR_EL1 value in the cpu_context - SCTLR_EL2
2138aabea33SPaul Beesley 	 * and other EL2 registers are set up by cm_prepare_ns_entry() as they
21418f2efd6SDavid Cunado 	 * are not part of the stored cpu_context.
21518f2efd6SDavid Cunado 	 */
21618f2efd6SDavid Cunado 	write_ctx_reg(get_sysregs_ctx(ctx), CTX_SCTLR_EL1, sctlr_elx);
21718f2efd6SDavid Cunado 
2182ab9617eSVarun Wadekar 	/*
2192ab9617eSVarun Wadekar 	 * Base the context ACTLR_EL1 on the current value, as it is
2202ab9617eSVarun Wadekar 	 * implementation defined. The context restore process will write
2212ab9617eSVarun Wadekar 	 * the value from the context to the actual register and can cause
2222ab9617eSVarun Wadekar 	 * problems for processor cores that don't expect certain bits to
2232ab9617eSVarun Wadekar 	 * be zero.
2242ab9617eSVarun Wadekar 	 */
2252ab9617eSVarun Wadekar 	actlr_elx = read_actlr_el1();
2262ab9617eSVarun Wadekar 	write_ctx_reg((get_sysregs_ctx(ctx)), (CTX_ACTLR_EL1), (actlr_elx));
2272ab9617eSVarun Wadekar 
2283e61b2b5SDavid Cunado 	if (security_state == SECURE) {
2293e61b2b5SDavid Cunado 		/*
2303e61b2b5SDavid Cunado 		 * Initialise PMCR_EL0 for secure context only, setting all
2313e61b2b5SDavid Cunado 		 * fields rather than relying on hw. Some fields are
2323e61b2b5SDavid Cunado 		 * architecturally UNKNOWN on reset.
2333e61b2b5SDavid Cunado 		 *
2343e61b2b5SDavid Cunado 		 * PMCR_EL0.LC: Set to one so that cycle counter overflow, that
2353e61b2b5SDavid Cunado 		 *  is recorded in PMOVSCLR_EL0[31], occurs on the increment
2363e61b2b5SDavid Cunado 		 *  that changes PMCCNTR_EL0[63] from 1 to 0.
2373e61b2b5SDavid Cunado 		 *
2383e61b2b5SDavid Cunado 		 * PMCR_EL0.DP: Set to one so that the cycle counter,
2393e61b2b5SDavid Cunado 		 *  PMCCNTR_EL0 does not count when event counting is prohibited.
2403e61b2b5SDavid Cunado 		 *
2413e61b2b5SDavid Cunado 		 * PMCR_EL0.X: Set to zero to disable export of events.
2423e61b2b5SDavid Cunado 		 *
2433e61b2b5SDavid Cunado 		 * PMCR_EL0.D: Set to zero so that, when enabled, PMCCNTR_EL0
2443e61b2b5SDavid Cunado 		 *  counts on every clock cycle.
2453e61b2b5SDavid Cunado 		 */
2463e61b2b5SDavid Cunado 		pmcr_el0 = ((PMCR_EL0_RESET_VAL | PMCR_EL0_LC_BIT
2473e61b2b5SDavid Cunado 				| PMCR_EL0_DP_BIT)
2483e61b2b5SDavid Cunado 				& ~(PMCR_EL0_X_BIT | PMCR_EL0_D_BIT));
2493e61b2b5SDavid Cunado 		write_ctx_reg(get_sysregs_ctx(ctx), CTX_PMCR_EL0, pmcr_el0);
2503e61b2b5SDavid Cunado 	}
2513e61b2b5SDavid Cunado 
252532ed618SSoby Mathew 	/* Populate EL3 state so that we've the right context before doing ERET */
253532ed618SSoby Mathew 	state = get_el3state_ctx(ctx);
254532ed618SSoby Mathew 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
255532ed618SSoby Mathew 	write_ctx_reg(state, CTX_ELR_EL3, ep->pc);
256532ed618SSoby Mathew 	write_ctx_reg(state, CTX_SPSR_EL3, ep->spsr);
257532ed618SSoby Mathew 
258532ed618SSoby Mathew 	/*
259532ed618SSoby Mathew 	 * Store the X0-X7 value from the entrypoint into the context
260532ed618SSoby Mathew 	 * Use memcpy as we are in control of the layout of the structures
261532ed618SSoby Mathew 	 */
262532ed618SSoby Mathew 	gp_regs = get_gpregs_ctx(ctx);
263532ed618SSoby Mathew 	memcpy(gp_regs, (void *)&ep->args, sizeof(aapcs64_params_t));
264532ed618SSoby Mathew }
265532ed618SSoby Mathew 
266532ed618SSoby Mathew /*******************************************************************************
2670fd0f222SDimitris Papastamos  * Enable architecture extensions on first entry to Non-secure world.
2680fd0f222SDimitris Papastamos  * When EL2 is implemented but unused `el2_unused` is non-zero, otherwise
2690fd0f222SDimitris Papastamos  * it is zero.
2700fd0f222SDimitris Papastamos  ******************************************************************************/
27140daecc1SAntonio Nino Diaz static void enable_extensions_nonsecure(bool el2_unused)
2720fd0f222SDimitris Papastamos {
2730fd0f222SDimitris Papastamos #if IMAGE_BL31
274281a08ccSDimitris Papastamos #if ENABLE_SPE_FOR_LOWER_ELS
275281a08ccSDimitris Papastamos 	spe_enable(el2_unused);
276281a08ccSDimitris Papastamos #endif
277380559c1SDimitris Papastamos 
278380559c1SDimitris Papastamos #if ENABLE_AMU
279380559c1SDimitris Papastamos 	amu_enable(el2_unused);
280380559c1SDimitris Papastamos #endif
2811a853370SDavid Cunado 
2821a853370SDavid Cunado #if ENABLE_SVE_FOR_NS
2831a853370SDavid Cunado 	sve_enable(el2_unused);
2841a853370SDavid Cunado #endif
2855f835918SJeenu Viswambharan 
2865f835918SJeenu Viswambharan #if ENABLE_MPAM_FOR_LOWER_ELS
2875f835918SJeenu Viswambharan 	mpam_enable(el2_unused);
2885f835918SJeenu Viswambharan #endif
2890fd0f222SDimitris Papastamos #endif
2900fd0f222SDimitris Papastamos }
2910fd0f222SDimitris Papastamos 
2920fd0f222SDimitris Papastamos /*******************************************************************************
293532ed618SSoby Mathew  * The following function initializes the cpu_context for a CPU specified by
294532ed618SSoby Mathew  * its `cpu_idx` for first use, and sets the initial entrypoint state as
295532ed618SSoby Mathew  * specified by the entry_point_info structure.
296532ed618SSoby Mathew  ******************************************************************************/
297532ed618SSoby Mathew void cm_init_context_by_index(unsigned int cpu_idx,
298532ed618SSoby Mathew 			      const entry_point_info_t *ep)
299532ed618SSoby Mathew {
300532ed618SSoby Mathew 	cpu_context_t *ctx;
301532ed618SSoby Mathew 	ctx = cm_get_context_by_index(cpu_idx, GET_SECURITY_STATE(ep->h.attr));
3021634cae8SAntonio Nino Diaz 	cm_setup_context(ctx, ep);
303532ed618SSoby Mathew }
304532ed618SSoby Mathew 
305532ed618SSoby Mathew /*******************************************************************************
306532ed618SSoby Mathew  * The following function initializes the cpu_context for the current CPU
307532ed618SSoby Mathew  * for first use, and sets the initial entrypoint state as specified by the
308532ed618SSoby Mathew  * entry_point_info structure.
309532ed618SSoby Mathew  ******************************************************************************/
310532ed618SSoby Mathew void cm_init_my_context(const entry_point_info_t *ep)
311532ed618SSoby Mathew {
312532ed618SSoby Mathew 	cpu_context_t *ctx;
313532ed618SSoby Mathew 	ctx = cm_get_context(GET_SECURITY_STATE(ep->h.attr));
3141634cae8SAntonio Nino Diaz 	cm_setup_context(ctx, ep);
315532ed618SSoby Mathew }
316532ed618SSoby Mathew 
317532ed618SSoby Mathew /*******************************************************************************
318532ed618SSoby Mathew  * Prepare the CPU system registers for first entry into secure or normal world
319532ed618SSoby Mathew  *
320532ed618SSoby Mathew  * If execution is requested to EL2 or hyp mode, SCTLR_EL2 is initialized
321532ed618SSoby Mathew  * If execution is requested to non-secure EL1 or svc mode, and the CPU supports
322532ed618SSoby Mathew  * EL2 then EL2 is disabled by configuring all necessary EL2 registers.
323532ed618SSoby Mathew  * For all entries, the EL1 registers are initialized from the cpu_context
324532ed618SSoby Mathew  ******************************************************************************/
325532ed618SSoby Mathew void cm_prepare_el3_exit(uint32_t security_state)
326532ed618SSoby Mathew {
327d832aee9Sdp-arm 	uint32_t sctlr_elx, scr_el3, mdcr_el2;
328532ed618SSoby Mathew 	cpu_context_t *ctx = cm_get_context(security_state);
32940daecc1SAntonio Nino Diaz 	bool el2_unused = false;
330a0fee747SAntonio Nino Diaz 	uint64_t hcr_el2 = 0U;
331532ed618SSoby Mathew 
332a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
333532ed618SSoby Mathew 
334532ed618SSoby Mathew 	if (security_state == NON_SECURE) {
335a0fee747SAntonio Nino Diaz 		scr_el3 = (uint32_t)read_ctx_reg(get_el3state_ctx(ctx),
336a0fee747SAntonio Nino Diaz 						 CTX_SCR_EL3);
337a0fee747SAntonio Nino Diaz 		if ((scr_el3 & SCR_HCE_BIT) != 0U) {
338532ed618SSoby Mathew 			/* Use SCTLR_EL1.EE value to initialise sctlr_el2 */
339a0fee747SAntonio Nino Diaz 			sctlr_elx = (uint32_t)read_ctx_reg(get_sysregs_ctx(ctx),
340532ed618SSoby Mathew 							   CTX_SCTLR_EL1);
3412e09d4f8SKen Kuang 			sctlr_elx &= SCTLR_EE_BIT;
342532ed618SSoby Mathew 			sctlr_elx |= SCTLR_EL2_RES1;
3435f5d1ed7SLouis Mayencourt #if ERRATA_A75_764081
3445f5d1ed7SLouis Mayencourt 			/*
3455f5d1ed7SLouis Mayencourt 			 * If workaround of errata 764081 for Cortex-A75 is used
3465f5d1ed7SLouis Mayencourt 			 * then set SCTLR_EL2.IESB to enable Implicit Error
3475f5d1ed7SLouis Mayencourt 			 * Synchronization Barrier.
3485f5d1ed7SLouis Mayencourt 			 */
3495f5d1ed7SLouis Mayencourt 			sctlr_elx |= SCTLR_IESB_BIT;
3505f5d1ed7SLouis Mayencourt #endif
351532ed618SSoby Mathew 			write_sctlr_el2(sctlr_elx);
352a0fee747SAntonio Nino Diaz 		} else if (el_implemented(2) != EL_IMPL_NONE) {
35340daecc1SAntonio Nino Diaz 			el2_unused = true;
3540fd0f222SDimitris Papastamos 
35518f2efd6SDavid Cunado 			/*
35618f2efd6SDavid Cunado 			 * EL2 present but unused, need to disable safely.
35718f2efd6SDavid Cunado 			 * SCTLR_EL2 can be ignored in this case.
35818f2efd6SDavid Cunado 			 *
3593ff4aaacSJeenu Viswambharan 			 * Set EL2 register width appropriately: Set HCR_EL2
3603ff4aaacSJeenu Viswambharan 			 * field to match SCR_EL3.RW.
36118f2efd6SDavid Cunado 			 */
362a0fee747SAntonio Nino Diaz 			if ((scr_el3 & SCR_RW_BIT) != 0U)
3633ff4aaacSJeenu Viswambharan 				hcr_el2 |= HCR_RW_BIT;
3643ff4aaacSJeenu Viswambharan 
3653ff4aaacSJeenu Viswambharan 			/*
3663ff4aaacSJeenu Viswambharan 			 * For Armv8.3 pointer authentication feature, disable
3673ff4aaacSJeenu Viswambharan 			 * traps to EL2 when accessing key registers or using
3683ff4aaacSJeenu Viswambharan 			 * pointer authentication instructions from lower ELs.
3693ff4aaacSJeenu Viswambharan 			 */
3703ff4aaacSJeenu Viswambharan 			hcr_el2 |= (HCR_API_BIT | HCR_APK_BIT);
3713ff4aaacSJeenu Viswambharan 
3723ff4aaacSJeenu Viswambharan 			write_hcr_el2(hcr_el2);
373532ed618SSoby Mathew 
37418f2efd6SDavid Cunado 			/*
37518f2efd6SDavid Cunado 			 * Initialise CPTR_EL2 setting all fields rather than
37618f2efd6SDavid Cunado 			 * relying on the hw. All fields have architecturally
37718f2efd6SDavid Cunado 			 * UNKNOWN reset values.
37818f2efd6SDavid Cunado 			 *
37918f2efd6SDavid Cunado 			 * CPTR_EL2.TCPAC: Set to zero so that Non-secure EL1
38018f2efd6SDavid Cunado 			 *  accesses to the CPACR_EL1 or CPACR from both
38118f2efd6SDavid Cunado 			 *  Execution states do not trap to EL2.
38218f2efd6SDavid Cunado 			 *
38318f2efd6SDavid Cunado 			 * CPTR_EL2.TTA: Set to zero so that Non-secure System
38418f2efd6SDavid Cunado 			 *  register accesses to the trace registers from both
38518f2efd6SDavid Cunado 			 *  Execution states do not trap to EL2.
38618f2efd6SDavid Cunado 			 *
38718f2efd6SDavid Cunado 			 * CPTR_EL2.TFP: Set to zero so that Non-secure accesses
38818f2efd6SDavid Cunado 			 *  to SIMD and floating-point functionality from both
38918f2efd6SDavid Cunado 			 *  Execution states do not trap to EL2.
39018f2efd6SDavid Cunado 			 */
39118f2efd6SDavid Cunado 			write_cptr_el2(CPTR_EL2_RESET_VAL &
39218f2efd6SDavid Cunado 					~(CPTR_EL2_TCPAC_BIT | CPTR_EL2_TTA_BIT
39318f2efd6SDavid Cunado 					| CPTR_EL2_TFP_BIT));
394532ed618SSoby Mathew 
39518f2efd6SDavid Cunado 			/*
3968aabea33SPaul Beesley 			 * Initialise CNTHCTL_EL2. All fields are
39718f2efd6SDavid Cunado 			 * architecturally UNKNOWN on reset and are set to zero
39818f2efd6SDavid Cunado 			 * except for field(s) listed below.
39918f2efd6SDavid Cunado 			 *
40018f2efd6SDavid Cunado 			 * CNTHCTL_EL2.EL1PCEN: Set to one to disable traps to
40118f2efd6SDavid Cunado 			 *  Hyp mode of Non-secure EL0 and EL1 accesses to the
40218f2efd6SDavid Cunado 			 *  physical timer registers.
40318f2efd6SDavid Cunado 			 *
40418f2efd6SDavid Cunado 			 * CNTHCTL_EL2.EL1PCTEN: Set to one to disable traps to
40518f2efd6SDavid Cunado 			 *  Hyp mode of  Non-secure EL0 and EL1 accesses to the
40618f2efd6SDavid Cunado 			 *  physical counter registers.
40718f2efd6SDavid Cunado 			 */
40818f2efd6SDavid Cunado 			write_cnthctl_el2(CNTHCTL_RESET_VAL |
40918f2efd6SDavid Cunado 						EL1PCEN_BIT | EL1PCTEN_BIT);
410532ed618SSoby Mathew 
41118f2efd6SDavid Cunado 			/*
41218f2efd6SDavid Cunado 			 * Initialise CNTVOFF_EL2 to zero as it resets to an
41318f2efd6SDavid Cunado 			 * architecturally UNKNOWN value.
41418f2efd6SDavid Cunado 			 */
415532ed618SSoby Mathew 			write_cntvoff_el2(0);
416532ed618SSoby Mathew 
41718f2efd6SDavid Cunado 			/*
41818f2efd6SDavid Cunado 			 * Set VPIDR_EL2 and VMPIDR_EL2 to match MIDR_EL1 and
41918f2efd6SDavid Cunado 			 * MPIDR_EL1 respectively.
42018f2efd6SDavid Cunado 			 */
421532ed618SSoby Mathew 			write_vpidr_el2(read_midr_el1());
422532ed618SSoby Mathew 			write_vmpidr_el2(read_mpidr_el1());
423532ed618SSoby Mathew 
424532ed618SSoby Mathew 			/*
42518f2efd6SDavid Cunado 			 * Initialise VTTBR_EL2. All fields are architecturally
42618f2efd6SDavid Cunado 			 * UNKNOWN on reset.
42718f2efd6SDavid Cunado 			 *
42818f2efd6SDavid Cunado 			 * VTTBR_EL2.VMID: Set to zero. Even though EL1&0 stage
42918f2efd6SDavid Cunado 			 *  2 address translation is disabled, cache maintenance
43018f2efd6SDavid Cunado 			 *  operations depend on the VMID.
43118f2efd6SDavid Cunado 			 *
43218f2efd6SDavid Cunado 			 * VTTBR_EL2.BADDR: Set to zero as EL1&0 stage 2 address
43318f2efd6SDavid Cunado 			 *  translation is disabled.
434532ed618SSoby Mathew 			 */
43518f2efd6SDavid Cunado 			write_vttbr_el2(VTTBR_RESET_VAL &
43618f2efd6SDavid Cunado 				~((VTTBR_VMID_MASK << VTTBR_VMID_SHIFT)
43718f2efd6SDavid Cunado 				| (VTTBR_BADDR_MASK << VTTBR_BADDR_SHIFT)));
43818f2efd6SDavid Cunado 
439495f3d3cSDavid Cunado 			/*
44018f2efd6SDavid Cunado 			 * Initialise MDCR_EL2, setting all fields rather than
44118f2efd6SDavid Cunado 			 * relying on hw. Some fields are architecturally
44218f2efd6SDavid Cunado 			 * UNKNOWN on reset.
44318f2efd6SDavid Cunado 			 *
44418f2efd6SDavid Cunado 			 * MDCR_EL2.TDRA: Set to zero so that Non-secure EL0 and
44518f2efd6SDavid Cunado 			 *  EL1 System register accesses to the Debug ROM
44618f2efd6SDavid Cunado 			 *  registers are not trapped to EL2.
44718f2efd6SDavid Cunado 			 *
44818f2efd6SDavid Cunado 			 * MDCR_EL2.TDOSA: Set to zero so that Non-secure EL1
44918f2efd6SDavid Cunado 			 *  System register accesses to the powerdown debug
45018f2efd6SDavid Cunado 			 *  registers are not trapped to EL2.
45118f2efd6SDavid Cunado 			 *
45218f2efd6SDavid Cunado 			 * MDCR_EL2.TDA: Set to zero so that System register
45318f2efd6SDavid Cunado 			 *  accesses to the debug registers do not trap to EL2.
45418f2efd6SDavid Cunado 			 *
45518f2efd6SDavid Cunado 			 * MDCR_EL2.TDE: Set to zero so that debug exceptions
45618f2efd6SDavid Cunado 			 *  are not routed to EL2.
45718f2efd6SDavid Cunado 			 *
45818f2efd6SDavid Cunado 			 * MDCR_EL2.HPME: Set to zero to disable EL2 Performance
45918f2efd6SDavid Cunado 			 *  Monitors.
46018f2efd6SDavid Cunado 			 *
46118f2efd6SDavid Cunado 			 * MDCR_EL2.TPM: Set to zero so that Non-secure EL0 and
46218f2efd6SDavid Cunado 			 *  EL1 accesses to all Performance Monitors registers
46318f2efd6SDavid Cunado 			 *  are not trapped to EL2.
46418f2efd6SDavid Cunado 			 *
46518f2efd6SDavid Cunado 			 * MDCR_EL2.TPMCR: Set to zero so that Non-secure EL0
46618f2efd6SDavid Cunado 			 *  and EL1 accesses to the PMCR_EL0 or PMCR are not
46718f2efd6SDavid Cunado 			 *  trapped to EL2.
46818f2efd6SDavid Cunado 			 *
46918f2efd6SDavid Cunado 			 * MDCR_EL2.HPMN: Set to value of PMCR_EL0.N which is the
47018f2efd6SDavid Cunado 			 *  architecturally-defined reset value.
471495f3d3cSDavid Cunado 			 */
472d832aee9Sdp-arm 			mdcr_el2 = ((MDCR_EL2_RESET_VAL |
47318f2efd6SDavid Cunado 					((read_pmcr_el0() & PMCR_EL0_N_BITS)
47418f2efd6SDavid Cunado 					>> PMCR_EL0_N_SHIFT)) &
47518f2efd6SDavid Cunado 					~(MDCR_EL2_TDRA_BIT | MDCR_EL2_TDOSA_BIT
47618f2efd6SDavid Cunado 					| MDCR_EL2_TDA_BIT | MDCR_EL2_TDE_BIT
47718f2efd6SDavid Cunado 					| MDCR_EL2_HPME_BIT | MDCR_EL2_TPM_BIT
47818f2efd6SDavid Cunado 					| MDCR_EL2_TPMCR_BIT));
479d832aee9Sdp-arm 
480d832aee9Sdp-arm 			write_mdcr_el2(mdcr_el2);
481d832aee9Sdp-arm 
482939f66d6SDavid Cunado 			/*
48318f2efd6SDavid Cunado 			 * Initialise HSTR_EL2. All fields are architecturally
48418f2efd6SDavid Cunado 			 * UNKNOWN on reset.
48518f2efd6SDavid Cunado 			 *
48618f2efd6SDavid Cunado 			 * HSTR_EL2.T<n>: Set all these fields to zero so that
48718f2efd6SDavid Cunado 			 *  Non-secure EL0 or EL1 accesses to System registers
48818f2efd6SDavid Cunado 			 *  do not trap to EL2.
489939f66d6SDavid Cunado 			 */
49018f2efd6SDavid Cunado 			write_hstr_el2(HSTR_EL2_RESET_VAL & ~(HSTR_EL2_T_MASK));
491939f66d6SDavid Cunado 			/*
49218f2efd6SDavid Cunado 			 * Initialise CNTHP_CTL_EL2. All fields are
49318f2efd6SDavid Cunado 			 * architecturally UNKNOWN on reset.
49418f2efd6SDavid Cunado 			 *
49518f2efd6SDavid Cunado 			 * CNTHP_CTL_EL2:ENABLE: Set to zero to disable the EL2
49618f2efd6SDavid Cunado 			 *  physical timer and prevent timer interrupts.
497939f66d6SDavid Cunado 			 */
49818f2efd6SDavid Cunado 			write_cnthp_ctl_el2(CNTHP_CTL_RESET_VAL &
49918f2efd6SDavid Cunado 						~(CNTHP_CTL_ENABLE_BIT));
500532ed618SSoby Mathew 		}
5010fd0f222SDimitris Papastamos 		enable_extensions_nonsecure(el2_unused);
502532ed618SSoby Mathew 	}
503532ed618SSoby Mathew 
50417b4c0ddSDimitris Papastamos 	cm_el1_sysregs_context_restore(security_state);
50517b4c0ddSDimitris Papastamos 	cm_set_next_eret_context(security_state);
506532ed618SSoby Mathew }
507532ed618SSoby Mathew 
508532ed618SSoby Mathew /*******************************************************************************
509532ed618SSoby Mathew  * The next four functions are used by runtime services to save and restore
510532ed618SSoby Mathew  * EL1 context on the 'cpu_context' structure for the specified security
511532ed618SSoby Mathew  * state.
512532ed618SSoby Mathew  ******************************************************************************/
513532ed618SSoby Mathew void cm_el1_sysregs_context_save(uint32_t security_state)
514532ed618SSoby Mathew {
515532ed618SSoby Mathew 	cpu_context_t *ctx;
516532ed618SSoby Mathew 
517532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
518a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
519532ed618SSoby Mathew 
520532ed618SSoby Mathew 	el1_sysregs_context_save(get_sysregs_ctx(ctx));
52117b4c0ddSDimitris Papastamos 
52217b4c0ddSDimitris Papastamos #if IMAGE_BL31
52317b4c0ddSDimitris Papastamos 	if (security_state == SECURE)
52417b4c0ddSDimitris Papastamos 		PUBLISH_EVENT(cm_exited_secure_world);
52517b4c0ddSDimitris Papastamos 	else
52617b4c0ddSDimitris Papastamos 		PUBLISH_EVENT(cm_exited_normal_world);
52717b4c0ddSDimitris Papastamos #endif
528532ed618SSoby Mathew }
529532ed618SSoby Mathew 
530532ed618SSoby Mathew void cm_el1_sysregs_context_restore(uint32_t security_state)
531532ed618SSoby Mathew {
532532ed618SSoby Mathew 	cpu_context_t *ctx;
533532ed618SSoby Mathew 
534532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
535a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
536532ed618SSoby Mathew 
537532ed618SSoby Mathew 	el1_sysregs_context_restore(get_sysregs_ctx(ctx));
53817b4c0ddSDimitris Papastamos 
53917b4c0ddSDimitris Papastamos #if IMAGE_BL31
54017b4c0ddSDimitris Papastamos 	if (security_state == SECURE)
54117b4c0ddSDimitris Papastamos 		PUBLISH_EVENT(cm_entering_secure_world);
54217b4c0ddSDimitris Papastamos 	else
54317b4c0ddSDimitris Papastamos 		PUBLISH_EVENT(cm_entering_normal_world);
54417b4c0ddSDimitris Papastamos #endif
545532ed618SSoby Mathew }
546532ed618SSoby Mathew 
547532ed618SSoby Mathew /*******************************************************************************
548532ed618SSoby Mathew  * This function populates ELR_EL3 member of 'cpu_context' pertaining to the
549532ed618SSoby Mathew  * given security state with the given entrypoint
550532ed618SSoby Mathew  ******************************************************************************/
551532ed618SSoby Mathew void cm_set_elr_el3(uint32_t security_state, uintptr_t entrypoint)
552532ed618SSoby Mathew {
553532ed618SSoby Mathew 	cpu_context_t *ctx;
554532ed618SSoby Mathew 	el3_state_t *state;
555532ed618SSoby Mathew 
556532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
557a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
558532ed618SSoby Mathew 
559532ed618SSoby Mathew 	/* Populate EL3 state so that ERET jumps to the correct entry */
560532ed618SSoby Mathew 	state = get_el3state_ctx(ctx);
561532ed618SSoby Mathew 	write_ctx_reg(state, CTX_ELR_EL3, entrypoint);
562532ed618SSoby Mathew }
563532ed618SSoby Mathew 
564532ed618SSoby Mathew /*******************************************************************************
565532ed618SSoby Mathew  * This function populates ELR_EL3 and SPSR_EL3 members of 'cpu_context'
566532ed618SSoby Mathew  * pertaining to the given security state
567532ed618SSoby Mathew  ******************************************************************************/
568532ed618SSoby Mathew void cm_set_elr_spsr_el3(uint32_t security_state,
569532ed618SSoby Mathew 			uintptr_t entrypoint, uint32_t spsr)
570532ed618SSoby Mathew {
571532ed618SSoby Mathew 	cpu_context_t *ctx;
572532ed618SSoby Mathew 	el3_state_t *state;
573532ed618SSoby Mathew 
574532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
575a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
576532ed618SSoby Mathew 
577532ed618SSoby Mathew 	/* Populate EL3 state so that ERET jumps to the correct entry */
578532ed618SSoby Mathew 	state = get_el3state_ctx(ctx);
579532ed618SSoby Mathew 	write_ctx_reg(state, CTX_ELR_EL3, entrypoint);
580532ed618SSoby Mathew 	write_ctx_reg(state, CTX_SPSR_EL3, spsr);
581532ed618SSoby Mathew }
582532ed618SSoby Mathew 
583532ed618SSoby Mathew /*******************************************************************************
584532ed618SSoby Mathew  * This function updates a single bit in the SCR_EL3 member of the 'cpu_context'
585532ed618SSoby Mathew  * pertaining to the given security state using the value and bit position
586532ed618SSoby Mathew  * specified in the parameters. It preserves all other bits.
587532ed618SSoby Mathew  ******************************************************************************/
588532ed618SSoby Mathew void cm_write_scr_el3_bit(uint32_t security_state,
589532ed618SSoby Mathew 			  uint32_t bit_pos,
590532ed618SSoby Mathew 			  uint32_t value)
591532ed618SSoby Mathew {
592532ed618SSoby Mathew 	cpu_context_t *ctx;
593532ed618SSoby Mathew 	el3_state_t *state;
594532ed618SSoby Mathew 	uint32_t scr_el3;
595532ed618SSoby Mathew 
596532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
597a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
598532ed618SSoby Mathew 
599532ed618SSoby Mathew 	/* Ensure that the bit position is a valid one */
600a0fee747SAntonio Nino Diaz 	assert(((1U << bit_pos) & SCR_VALID_BIT_MASK) != 0U);
601532ed618SSoby Mathew 
602532ed618SSoby Mathew 	/* Ensure that the 'value' is only a bit wide */
603a0fee747SAntonio Nino Diaz 	assert(value <= 1U);
604532ed618SSoby Mathew 
605532ed618SSoby Mathew 	/*
606532ed618SSoby Mathew 	 * Get the SCR_EL3 value from the cpu context, clear the desired bit
607532ed618SSoby Mathew 	 * and set it to its new value.
608532ed618SSoby Mathew 	 */
609532ed618SSoby Mathew 	state = get_el3state_ctx(ctx);
610a0fee747SAntonio Nino Diaz 	scr_el3 = (uint32_t)read_ctx_reg(state, CTX_SCR_EL3);
611a0fee747SAntonio Nino Diaz 	scr_el3 &= ~(1U << bit_pos);
612532ed618SSoby Mathew 	scr_el3 |= value << bit_pos;
613532ed618SSoby Mathew 	write_ctx_reg(state, CTX_SCR_EL3, scr_el3);
614532ed618SSoby Mathew }
615532ed618SSoby Mathew 
616532ed618SSoby Mathew /*******************************************************************************
617532ed618SSoby Mathew  * This function retrieves SCR_EL3 member of 'cpu_context' pertaining to the
618532ed618SSoby Mathew  * given security state.
619532ed618SSoby Mathew  ******************************************************************************/
620532ed618SSoby Mathew uint32_t cm_get_scr_el3(uint32_t security_state)
621532ed618SSoby Mathew {
622532ed618SSoby Mathew 	cpu_context_t *ctx;
623532ed618SSoby Mathew 	el3_state_t *state;
624532ed618SSoby Mathew 
625532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
626a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
627532ed618SSoby Mathew 
628532ed618SSoby Mathew 	/* Populate EL3 state so that ERET jumps to the correct entry */
629532ed618SSoby Mathew 	state = get_el3state_ctx(ctx);
630a0fee747SAntonio Nino Diaz 	return (uint32_t)read_ctx_reg(state, CTX_SCR_EL3);
631532ed618SSoby Mathew }
632532ed618SSoby Mathew 
633532ed618SSoby Mathew /*******************************************************************************
634532ed618SSoby Mathew  * This function is used to program the context that's used for exception
635532ed618SSoby Mathew  * return. This initializes the SP_EL3 to a pointer to a 'cpu_context' set for
636532ed618SSoby Mathew  * the required security state
637532ed618SSoby Mathew  ******************************************************************************/
638532ed618SSoby Mathew void cm_set_next_eret_context(uint32_t security_state)
639532ed618SSoby Mathew {
640532ed618SSoby Mathew 	cpu_context_t *ctx;
641532ed618SSoby Mathew 
642532ed618SSoby Mathew 	ctx = cm_get_context(security_state);
643a0fee747SAntonio Nino Diaz 	assert(ctx != NULL);
644532ed618SSoby Mathew 
645532ed618SSoby Mathew 	cm_set_next_context(ctx);
646532ed618SSoby Mathew }
647