xref: /rk3399_ARM-atf/services/spd/tspd/tspd_common.c (revision 51faada71a219a8b94cd8d8e423f0f22e9da4d8f)
1 /*
2  * Copyright (c) 2013-2017, 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 <debug.h>
36 #include <string.h>
37 #include <tsp.h>
38 #include <utils.h>
39 #include "tspd_private.h"
40 
41 /*******************************************************************************
42  * Given a secure payload entrypoint info pointer, entry point PC, register
43  * width, cpu id & pointer to a context data structure, this function will
44  * initialize tsp context and entry point info for the secure payload
45  ******************************************************************************/
46 void tspd_init_tsp_ep_state(struct entry_point_info *tsp_entry_point,
47 				uint32_t rw,
48 				uint64_t pc,
49 				tsp_context_t *tsp_ctx)
50 {
51 	uint32_t ep_attr;
52 
53 	/* Passing a NULL context is a critical programming error */
54 	assert(tsp_ctx);
55 	assert(tsp_entry_point);
56 	assert(pc);
57 
58 	/*
59 	 * We support AArch64 TSP for now.
60 	 * TODO: Add support for AArch32 TSP
61 	 */
62 	assert(rw == TSP_AARCH64);
63 
64 	/* Associate this context with the cpu specified */
65 	tsp_ctx->mpidr = read_mpidr_el1();
66 	tsp_ctx->state = 0;
67 	set_tsp_pstate(tsp_ctx->state, TSP_PSTATE_OFF);
68 	clr_std_smc_active_flag(tsp_ctx->state);
69 
70 	cm_set_context(&tsp_ctx->cpu_ctx, SECURE);
71 
72 	/* initialise an entrypoint to set up the CPU context */
73 	ep_attr = SECURE | EP_ST_ENABLE;
74 	if (read_sctlr_el3() & SCTLR_EE_BIT)
75 		ep_attr |= EP_EE_BIG;
76 	SET_PARAM_HEAD(tsp_entry_point, PARAM_EP, VERSION_1, ep_attr);
77 
78 	tsp_entry_point->pc = pc;
79 	tsp_entry_point->spsr = SPSR_64(MODE_EL1,
80 					MODE_SP_ELX,
81 					DISABLE_ALL_EXCEPTIONS);
82 	zeromem(&tsp_entry_point->args, sizeof(tsp_entry_point->args));
83 }
84 
85 /*******************************************************************************
86  * This function takes an SP context pointer and:
87  * 1. Applies the S-EL1 system register context from tsp_ctx->cpu_ctx.
88  * 2. Saves the current C runtime state (callee saved registers) on the stack
89  *    frame and saves a reference to this state.
90  * 3. Calls el3_exit() so that the EL3 system and general purpose registers
91  *    from the tsp_ctx->cpu_ctx are used to enter the secure payload image.
92  ******************************************************************************/
93 uint64_t tspd_synchronous_sp_entry(tsp_context_t *tsp_ctx)
94 {
95 	uint64_t rc;
96 
97 	assert(tsp_ctx != NULL);
98 	assert(tsp_ctx->c_rt_ctx == 0);
99 
100 	/* Apply the Secure EL1 system register context and switch to it */
101 	assert(cm_get_context(SECURE) == &tsp_ctx->cpu_ctx);
102 	cm_el1_sysregs_context_restore(SECURE);
103 	cm_set_next_eret_context(SECURE);
104 
105 	rc = tspd_enter_sp(&tsp_ctx->c_rt_ctx);
106 #if DEBUG
107 	tsp_ctx->c_rt_ctx = 0;
108 #endif
109 
110 	return rc;
111 }
112 
113 
114 /*******************************************************************************
115  * This function takes an SP context pointer and:
116  * 1. Saves the S-EL1 system register context tp tsp_ctx->cpu_ctx.
117  * 2. Restores the current C runtime state (callee saved registers) from the
118  *    stack frame using the reference to this state saved in tspd_enter_sp().
119  * 3. It does not need to save any general purpose or EL3 system register state
120  *    as the generic smc entry routine should have saved those.
121  ******************************************************************************/
122 void tspd_synchronous_sp_exit(tsp_context_t *tsp_ctx, uint64_t ret)
123 {
124 	assert(tsp_ctx != NULL);
125 	/* Save the Secure EL1 system register context */
126 	assert(cm_get_context(SECURE) == &tsp_ctx->cpu_ctx);
127 	cm_el1_sysregs_context_save(SECURE);
128 
129 	assert(tsp_ctx->c_rt_ctx != 0);
130 	tspd_exit_sp(tsp_ctx->c_rt_ctx, ret);
131 
132 	/* Should never reach here */
133 	assert(0);
134 }
135 
136 /*******************************************************************************
137  * This function takes an SP context pointer and abort any preempted SMC
138  * request.
139  * Return 1 if there was a preempted SMC request, 0 otherwise.
140  ******************************************************************************/
141 int tspd_abort_preempted_smc(tsp_context_t *tsp_ctx)
142 {
143 	if (!get_std_smc_active_flag(tsp_ctx->state))
144 		return 0;
145 
146 	/* Abort any preempted SMC request */
147 	clr_std_smc_active_flag(tsp_ctx->state);
148 
149 	/*
150 	 * Arrange for an entry into the test secure payload. It will
151 	 * be returned via TSP_ABORT_DONE case in tspd_smc_handler.
152 	 */
153 	cm_set_elr_el3(SECURE,
154 		       (uint64_t) &tsp_vectors->abort_std_smc_entry);
155 	uint64_t rc = tspd_synchronous_sp_entry(tsp_ctx);
156 
157 	if (rc != 0)
158 		panic();
159 
160 	return 1;
161 }
162 
163