xref: /rk3399_ARM-atf/services/spd/tspd/tspd_common.c (revision 3ee8a16402522d6d2959e27520f75c79b1218a2b)
1 /*
2  * Copyright (c) 2013-2014, ARM Limited and Contributors. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  * Redistributions of source code must retain the above copyright notice, this
8  * list of conditions and the following disclaimer.
9  *
10  * Redistributions in binary form must reproduce the above copyright notice,
11  * this list of conditions and the following disclaimer in the documentation
12  * and/or other materials provided with the distribution.
13  *
14  * Neither the name of ARM nor the names of its contributors may be used
15  * to endorse or promote products derived from this software without specific
16  * prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  */
30 
31 #include <arch_helpers.h>
32 #include <assert.h>
33 #include <bl_common.h>
34 #include <context_mgmt.h>
35 #include <platform.h>
36 #include <string.h>
37 #include "tspd_private.h"
38 
39 /*******************************************************************************
40  * Given a secure payload entrypoint, register width, cpu id & pointer to a
41  * context data structure, this function will create a secure context ready for
42  * programming an entry into the secure payload.
43  ******************************************************************************/
44 int32_t tspd_init_secure_context(uint64_t entrypoint,
45 				uint32_t rw,
46 				uint64_t mpidr,
47 				tsp_context_t *tsp_ctx)
48 {
49 	uint32_t scr, sctlr;
50 	el1_sys_regs_t *el1_state;
51 	uint32_t spsr;
52 
53 	/* Passing a NULL context is a critical programming error */
54 	assert(tsp_ctx);
55 
56 	/*
57 	 * We support AArch64 TSP for now.
58 	 * TODO: Add support for AArch32 TSP
59 	 */
60 	assert(rw == TSP_AARCH64);
61 
62 	/*
63 	 * This might look redundant if the context was statically
64 	 * allocated but this function cannot make that assumption.
65 	 */
66 	memset(tsp_ctx, 0, sizeof(*tsp_ctx));
67 
68 	/* Set the right security state and register width for the SP */
69 	scr = read_scr();
70 	scr &= ~SCR_NS_BIT;
71 	scr &= ~SCR_RW_BIT;
72 	if (rw == TSP_AARCH64)
73 		scr |= SCR_RW_BIT;
74 
75 	/* Get a pointer to the S-EL1 context memory */
76 	el1_state = get_sysregs_ctx(&tsp_ctx->cpu_ctx);
77 
78 	/*
79 	 * Program the SCTLR_EL1 such that upon entry in S-EL1, caches and MMU are
80 	 * disabled and exception endianess is set to be the same as EL3
81 	 */
82 	sctlr = read_sctlr_el3();
83 	sctlr &= SCTLR_EE_BIT;
84 	sctlr |= SCTLR_EL1_RES1;
85 	write_ctx_reg(el1_state, CTX_SCTLR_EL1, sctlr);
86 
87 	/* Set this context as ready to be initialised i.e OFF */
88 	set_tsp_pstate(tsp_ctx->state, TSP_PSTATE_OFF);
89 
90 	/*
91 	 * This context has not been used yet. It will become valid
92 	 * when the TSP is interrupted and wants the TSPD to preserve
93 	 * the context.
94 	 */
95 	clr_std_smc_active_flag(tsp_ctx->state);
96 
97 	/* Associate this context with the cpu specified */
98 	tsp_ctx->mpidr = mpidr;
99 
100 	cm_set_context(mpidr, &tsp_ctx->cpu_ctx, SECURE);
101 	spsr = SPSR_64(MODE_EL1, MODE_SP_ELX, DISABLE_ALL_EXCEPTIONS);
102 	cm_set_el3_eret_context(SECURE, entrypoint, spsr, scr);
103 
104 	return 0;
105 }
106 
107 /*******************************************************************************
108  * This function takes an SP context pointer and:
109  * 1. Applies the S-EL1 system register context from tsp_ctx->cpu_ctx.
110  * 2. Saves the current C runtime state (callee saved registers) on the stack
111  *    frame and saves a reference to this state.
112  * 3. Calls el3_exit() so that the EL3 system and general purpose registers
113  *    from the tsp_ctx->cpu_ctx are used to enter the secure payload image.
114  ******************************************************************************/
115 uint64_t tspd_synchronous_sp_entry(tsp_context_t *tsp_ctx)
116 {
117 	uint64_t rc;
118 
119 	assert(tsp_ctx->c_rt_ctx == 0);
120 
121 	/* Apply the Secure EL1 system register context and switch to it */
122 	assert(cm_get_context(read_mpidr(), SECURE) == &tsp_ctx->cpu_ctx);
123 	cm_el1_sysregs_context_restore(SECURE);
124 	cm_set_next_eret_context(SECURE);
125 
126 	rc = tspd_enter_sp(&tsp_ctx->c_rt_ctx);
127 #if DEBUG
128 	tsp_ctx->c_rt_ctx = 0;
129 #endif
130 
131 	return rc;
132 }
133 
134 
135 /*******************************************************************************
136  * This function takes an SP context pointer and:
137  * 1. Saves the S-EL1 system register context tp tsp_ctx->cpu_ctx.
138  * 2. Restores the current C runtime state (callee saved registers) from the
139  *    stack frame using the reference to this state saved in tspd_enter_sp().
140  * 3. It does not need to save any general purpose or EL3 system register state
141  *    as the generic smc entry routine should have saved those.
142  ******************************************************************************/
143 void tspd_synchronous_sp_exit(tsp_context_t *tsp_ctx, uint64_t ret)
144 {
145 	/* Save the Secure EL1 system register context */
146 	assert(cm_get_context(read_mpidr(), SECURE) == &tsp_ctx->cpu_ctx);
147 	cm_el1_sysregs_context_save(SECURE);
148 
149 	assert(tsp_ctx->c_rt_ctx != 0);
150 	tspd_exit_sp(tsp_ctx->c_rt_ctx, ret);
151 
152 	/* Should never reach here */
153 	assert(0);
154 }
155