xref: /rk3399_ARM-atf/services/spd/opteed/opteed_main.c (revision 0e8def996e73673d3e2c3d755a84e2b759ab3052)
1aa5da461SJens Wiklander /*
2*0e8def99SRaymond Mao  * Copyright (c) 2013-2023, Arm Limited and Contributors. All rights reserved.
3aa5da461SJens Wiklander  *
482cb2c1aSdp-arm  * SPDX-License-Identifier: BSD-3-Clause
5aa5da461SJens Wiklander  */
6aa5da461SJens Wiklander 
7aa5da461SJens Wiklander 
8aa5da461SJens Wiklander /*******************************************************************************
9aa5da461SJens Wiklander  * This is the Secure Payload Dispatcher (SPD). The dispatcher is meant to be a
10aa5da461SJens Wiklander  * plug-in component to the Secure Monitor, registered as a runtime service. The
11aa5da461SJens Wiklander  * SPD is expected to be a functional extension of the Secure Payload (SP) that
12aa5da461SJens Wiklander  * executes in Secure EL1. The Secure Monitor will delegate all SMCs targeting
13aa5da461SJens Wiklander  * the Trusted OS/Applications range to the dispatcher. The SPD will either
14aa5da461SJens Wiklander  * handle the request locally or delegate it to the Secure Payload. It is also
15aa5da461SJens Wiklander  * responsible for initialising and maintaining communication with the SP.
16aa5da461SJens Wiklander  ******************************************************************************/
17aa5da461SJens Wiklander #include <assert.h>
18aa5da461SJens Wiklander #include <errno.h>
1905c69cf7SJeffrey Kardatzke #include <inttypes.h>
20aa5da461SJens Wiklander #include <stddef.h>
2109d40e0eSAntonio Nino Diaz 
2209d40e0eSAntonio Nino Diaz #include <arch_helpers.h>
2309d40e0eSAntonio Nino Diaz #include <bl31/bl31.h>
2409d40e0eSAntonio Nino Diaz #include <common/bl_common.h>
2509d40e0eSAntonio Nino Diaz #include <common/debug.h>
2609d40e0eSAntonio Nino Diaz #include <common/runtime_svc.h>
27f4bbf435SJeffrey Kardatzke #include <lib/coreboot.h>
2809d40e0eSAntonio Nino Diaz #include <lib/el3_runtime/context_mgmt.h>
2905c69cf7SJeffrey Kardatzke #include <lib/optee_utils.h>
30*0e8def99SRaymond Mao #include <lib/transfer_list.h>
3105c69cf7SJeffrey Kardatzke #include <lib/xlat_tables/xlat_tables_v2.h>
32f4bbf435SJeffrey Kardatzke #if OPTEE_ALLOW_SMC_LOAD
33f4bbf435SJeffrey Kardatzke #include <libfdt.h>
34f4bbf435SJeffrey Kardatzke #endif  /* OPTEE_ALLOW_SMC_LOAD */
3509d40e0eSAntonio Nino Diaz #include <plat/common/platform.h>
3609d40e0eSAntonio Nino Diaz #include <tools_share/uuid.h>
3709d40e0eSAntonio Nino Diaz 
38aa5da461SJens Wiklander #include "opteed_private.h"
39aa5da461SJens Wiklander #include "teesmc_opteed.h"
402a4b4b71SIsla Mitchell 
41*0e8def99SRaymond Mao #if OPTEE_ALLOW_SMC_LOAD
42*0e8def99SRaymond Mao static struct transfer_list_header *bl31_tl;
43*0e8def99SRaymond Mao #endif
44*0e8def99SRaymond Mao 
45aa5da461SJens Wiklander /*******************************************************************************
46aa5da461SJens Wiklander  * Address of the entrypoint vector table in OPTEE. It is
47aa5da461SJens Wiklander  * initialised once on the primary core after a cold boot.
48aa5da461SJens Wiklander  ******************************************************************************/
496c77e749SSandrine Bailleux struct optee_vectors *optee_vector_table;
50aa5da461SJens Wiklander 
51aa5da461SJens Wiklander /*******************************************************************************
52aa5da461SJens Wiklander  * Array to keep track of per-cpu OPTEE state
53aa5da461SJens Wiklander  ******************************************************************************/
54aa5da461SJens Wiklander optee_context_t opteed_sp_context[OPTEED_CORE_COUNT];
55aa5da461SJens Wiklander uint32_t opteed_rw;
56aa5da461SJens Wiklander 
5705c69cf7SJeffrey Kardatzke #if OPTEE_ALLOW_SMC_LOAD
5805c69cf7SJeffrey Kardatzke static bool opteed_allow_load;
5985ab8823SJeffrey Kardatzke /* OP-TEE image loading service UUID */
6085ab8823SJeffrey Kardatzke DEFINE_SVC_UUID2(optee_image_load_uuid,
6185ab8823SJeffrey Kardatzke 	0xb1eafba3, 0x5d31, 0x4612, 0xb9, 0x06,
6285ab8823SJeffrey Kardatzke 	0xc4, 0xc7, 0xa4, 0xbe, 0x3c, 0xc0);
63f4bbf435SJeffrey Kardatzke 
64f4bbf435SJeffrey Kardatzke #define OPTEED_FDT_SIZE 256
65f4bbf435SJeffrey Kardatzke static uint8_t fdt_buf[OPTEED_FDT_SIZE] __aligned(CACHE_WRITEBACK_GRANULE);
66f4bbf435SJeffrey Kardatzke 
6705c69cf7SJeffrey Kardatzke #else
68aa5da461SJens Wiklander static int32_t opteed_init(void);
6905c69cf7SJeffrey Kardatzke #endif
7005c69cf7SJeffrey Kardatzke 
7105c69cf7SJeffrey Kardatzke uint64_t dual32to64(uint32_t high, uint32_t low)
7205c69cf7SJeffrey Kardatzke {
7305c69cf7SJeffrey Kardatzke 	return ((uint64_t)high << 32) | low;
7405c69cf7SJeffrey Kardatzke }
75aa5da461SJens Wiklander 
76aa5da461SJens Wiklander /*******************************************************************************
77aa5da461SJens Wiklander  * This function is the handler registered for S-EL1 interrupts by the
78aa5da461SJens Wiklander  * OPTEED. It validates the interrupt and upon success arranges entry into
79aa5da461SJens Wiklander  * the OPTEE at 'optee_fiq_entry()' for handling the interrupt.
80aa5da461SJens Wiklander  ******************************************************************************/
81aa5da461SJens Wiklander static uint64_t opteed_sel1_interrupt_handler(uint32_t id,
82aa5da461SJens Wiklander 					    uint32_t flags,
83aa5da461SJens Wiklander 					    void *handle,
84aa5da461SJens Wiklander 					    void *cookie)
85aa5da461SJens Wiklander {
86aa5da461SJens Wiklander 	uint32_t linear_id;
87aa5da461SJens Wiklander 	optee_context_t *optee_ctx;
88aa5da461SJens Wiklander 
89aa5da461SJens Wiklander 	/* Check the security state when the exception was generated */
90aa5da461SJens Wiklander 	assert(get_interrupt_src_ss(flags) == NON_SECURE);
91aa5da461SJens Wiklander 
92aa5da461SJens Wiklander 	/* Sanity check the pointer to this cpu's context */
93aa5da461SJens Wiklander 	assert(handle == cm_get_context(NON_SECURE));
94aa5da461SJens Wiklander 
95aa5da461SJens Wiklander 	/* Save the non-secure context before entering the OPTEE */
96aa5da461SJens Wiklander 	cm_el1_sysregs_context_save(NON_SECURE);
97aa5da461SJens Wiklander 
98aa5da461SJens Wiklander 	/* Get a reference to this cpu's OPTEE context */
99fd650ff6SSoby Mathew 	linear_id = plat_my_core_pos();
100aa5da461SJens Wiklander 	optee_ctx = &opteed_sp_context[linear_id];
101aa5da461SJens Wiklander 	assert(&optee_ctx->cpu_ctx == cm_get_context(SECURE));
102aa5da461SJens Wiklander 
103776ff52aSDaniel Boulby 	cm_set_elr_el3(SECURE, (uint64_t)&optee_vector_table->fiq_entry);
104aa5da461SJens Wiklander 	cm_el1_sysregs_context_restore(SECURE);
105aa5da461SJens Wiklander 	cm_set_next_eret_context(SECURE);
106aa5da461SJens Wiklander 
107aa5da461SJens Wiklander 	/*
108aa5da461SJens Wiklander 	 * Tell the OPTEE that it has to handle an FIQ (synchronously).
109aa5da461SJens Wiklander 	 * Also the instruction in normal world where the interrupt was
110aa5da461SJens Wiklander 	 * generated is passed for debugging purposes. It is safe to
111aa5da461SJens Wiklander 	 * retrieve this address from ELR_EL3 as the secure context will
112aa5da461SJens Wiklander 	 * not take effect until el3_exit().
113aa5da461SJens Wiklander 	 */
114aa5da461SJens Wiklander 	SMC_RET1(&optee_ctx->cpu_ctx, read_elr_el3());
115aa5da461SJens Wiklander }
116aa5da461SJens Wiklander 
117aa5da461SJens Wiklander /*******************************************************************************
118aa5da461SJens Wiklander  * OPTEE Dispatcher setup. The OPTEED finds out the OPTEE entrypoint and type
119aa5da461SJens Wiklander  * (aarch32/aarch64) if not already known and initialises the context for entry
120aa5da461SJens Wiklander  * into OPTEE for its initialization.
121aa5da461SJens Wiklander  ******************************************************************************/
122724fd958SMasahiro Yamada static int32_t opteed_setup(void)
123aa5da461SJens Wiklander {
12405c69cf7SJeffrey Kardatzke #if OPTEE_ALLOW_SMC_LOAD
12505c69cf7SJeffrey Kardatzke 	opteed_allow_load = true;
12605c69cf7SJeffrey Kardatzke 	INFO("Delaying OP-TEE setup until we receive an SMC call to load it\n");
12705c69cf7SJeffrey Kardatzke 	return 0;
12805c69cf7SJeffrey Kardatzke #else
129aa5da461SJens Wiklander 	entry_point_info_t *optee_ep_info;
130aa5da461SJens Wiklander 	uint32_t linear_id;
131*0e8def99SRaymond Mao 	uint64_t arg0;
132*0e8def99SRaymond Mao 	uint64_t arg1;
133*0e8def99SRaymond Mao 	uint64_t arg2;
134*0e8def99SRaymond Mao 	uint64_t arg3;
135*0e8def99SRaymond Mao 	struct transfer_list_header *tl = NULL;
136*0e8def99SRaymond Mao 	struct transfer_list_entry *te = NULL;
137*0e8def99SRaymond Mao 	void *dt = NULL;
138aa5da461SJens Wiklander 
139fd650ff6SSoby Mathew 	linear_id = plat_my_core_pos();
140aa5da461SJens Wiklander 
141aa5da461SJens Wiklander 	/*
142aa5da461SJens Wiklander 	 * Get information about the Secure Payload (BL32) image. Its
143aa5da461SJens Wiklander 	 * absence is a critical failure.  TODO: Add support to
144aa5da461SJens Wiklander 	 * conditionally include the SPD service
145aa5da461SJens Wiklander 	 */
146aa5da461SJens Wiklander 	optee_ep_info = bl31_plat_get_next_image_ep_info(SECURE);
147aa5da461SJens Wiklander 	if (!optee_ep_info) {
148aa5da461SJens Wiklander 		WARN("No OPTEE provided by BL2 boot loader, Booting device"
149aa5da461SJens Wiklander 			" without OPTEE initialization. SMC`s destined for OPTEE"
150aa5da461SJens Wiklander 			" will return SMC_UNK\n");
151aa5da461SJens Wiklander 		return 1;
152aa5da461SJens Wiklander 	}
153aa5da461SJens Wiklander 
154aa5da461SJens Wiklander 	/*
155aa5da461SJens Wiklander 	 * If there's no valid entry point for SP, we return a non-zero value
156aa5da461SJens Wiklander 	 * signalling failure initializing the service. We bail out without
157aa5da461SJens Wiklander 	 * registering any handlers
158aa5da461SJens Wiklander 	 */
159aa5da461SJens Wiklander 	if (!optee_ep_info->pc)
160aa5da461SJens Wiklander 		return 1;
161aa5da461SJens Wiklander 
162*0e8def99SRaymond Mao 	if (TRANSFER_LIST &&
163*0e8def99SRaymond Mao 		optee_ep_info->args.arg1 == (TRANSFER_LIST_SIGNATURE |
164*0e8def99SRaymond Mao 					REGISTER_CONVENTION_VERSION_MASK)) {
165*0e8def99SRaymond Mao 		tl = (void *)optee_ep_info->args.arg3;
166*0e8def99SRaymond Mao 		if (transfer_list_check_header(tl) == TL_OPS_NON) {
167*0e8def99SRaymond Mao 			return 1;
168*0e8def99SRaymond Mao 		}
169d59a6accSEdison Ai 
170*0e8def99SRaymond Mao 		opteed_rw = GET_RW(optee_ep_info->spsr);
171*0e8def99SRaymond Mao 		te = transfer_list_find(tl, TL_TAG_FDT);
172*0e8def99SRaymond Mao 		dt = transfer_list_entry_data(te);
173*0e8def99SRaymond Mao 
174*0e8def99SRaymond Mao 		if (opteed_rw == OPTEE_AARCH64) {
175*0e8def99SRaymond Mao 			arg0 = (uint64_t)dt;
176*0e8def99SRaymond Mao 			arg2 = 0;
177*0e8def99SRaymond Mao 		} else {
178*0e8def99SRaymond Mao 			arg2 = (uint64_t)dt;
179*0e8def99SRaymond Mao 			arg0 = 0;
180*0e8def99SRaymond Mao 		}
181*0e8def99SRaymond Mao 
182*0e8def99SRaymond Mao 		arg1 = optee_ep_info->args.arg1;
183*0e8def99SRaymond Mao 		arg3 = optee_ep_info->args.arg3;
184*0e8def99SRaymond Mao 	} else {
185*0e8def99SRaymond Mao 		/* Default handoff arguments */
186*0e8def99SRaymond Mao 		opteed_rw = optee_ep_info->args.arg0;
187*0e8def99SRaymond Mao 		arg0 = optee_ep_info->args.arg1; /* opteed_pageable_part */
188*0e8def99SRaymond Mao 		arg1 = optee_ep_info->args.arg2; /* opteed_mem_limit */
189*0e8def99SRaymond Mao 		arg2 = optee_ep_info->args.arg3; /* dt_addr */
190*0e8def99SRaymond Mao 		arg3 = 0;
191*0e8def99SRaymond Mao 	}
192*0e8def99SRaymond Mao 
193*0e8def99SRaymond Mao 	opteed_init_optee_ep_state(optee_ep_info, opteed_rw, optee_ep_info->pc,
194*0e8def99SRaymond Mao 				arg0, arg1, arg2, arg3,
195aa5da461SJens Wiklander 				&opteed_sp_context[linear_id]);
196aa5da461SJens Wiklander 
197aa5da461SJens Wiklander 	/*
198aa5da461SJens Wiklander 	 * All OPTEED initialization done. Now register our init function with
199aa5da461SJens Wiklander 	 * BL31 for deferred invocation
200aa5da461SJens Wiklander 	 */
201aa5da461SJens Wiklander 	bl31_register_bl32_init(&opteed_init);
202aa5da461SJens Wiklander 
203aa5da461SJens Wiklander 	return 0;
20405c69cf7SJeffrey Kardatzke #endif  /* OPTEE_ALLOW_SMC_LOAD */
205aa5da461SJens Wiklander }
206aa5da461SJens Wiklander 
207aa5da461SJens Wiklander /*******************************************************************************
208aa5da461SJens Wiklander  * This function passes control to the OPTEE image (BL32) for the first time
209aa5da461SJens Wiklander  * on the primary cpu after a cold boot. It assumes that a valid secure
210aa5da461SJens Wiklander  * context has already been created by opteed_setup() which can be directly
211aa5da461SJens Wiklander  * used.  It also assumes that a valid non-secure context has been
212aa5da461SJens Wiklander  * initialised by PSCI so it does not need to save and restore any
213aa5da461SJens Wiklander  * non-secure state. This function performs a synchronous entry into
2148d7c80faSJeffrey Kardatzke  * OPTEE. OPTEE passes control back to this routine through a SMC. This returns
2158d7c80faSJeffrey Kardatzke  * a non-zero value on success and zero on failure.
216aa5da461SJens Wiklander  ******************************************************************************/
21705c69cf7SJeffrey Kardatzke static int32_t
21805c69cf7SJeffrey Kardatzke opteed_init_with_entry_point(entry_point_info_t *optee_entry_point)
219aa5da461SJens Wiklander {
220fd650ff6SSoby Mathew 	uint32_t linear_id = plat_my_core_pos();
221aa5da461SJens Wiklander 	optee_context_t *optee_ctx = &opteed_sp_context[linear_id];
222aa5da461SJens Wiklander 	uint64_t rc;
223aa5da461SJens Wiklander 	assert(optee_entry_point);
224aa5da461SJens Wiklander 
225fd650ff6SSoby Mathew 	cm_init_my_context(optee_entry_point);
226aa5da461SJens Wiklander 
227aa5da461SJens Wiklander 	/*
228aa5da461SJens Wiklander 	 * Arrange for an entry into OPTEE. It will be returned via
229aa5da461SJens Wiklander 	 * OPTEE_ENTRY_DONE case
230aa5da461SJens Wiklander 	 */
231aa5da461SJens Wiklander 	rc = opteed_synchronous_sp_entry(optee_ctx);
232aa5da461SJens Wiklander 	assert(rc != 0);
233aa5da461SJens Wiklander 
234aa5da461SJens Wiklander 	return rc;
235aa5da461SJens Wiklander }
236aa5da461SJens Wiklander 
23705c69cf7SJeffrey Kardatzke #if !OPTEE_ALLOW_SMC_LOAD
23805c69cf7SJeffrey Kardatzke static int32_t opteed_init(void)
23905c69cf7SJeffrey Kardatzke {
24005c69cf7SJeffrey Kardatzke 	entry_point_info_t *optee_entry_point;
24105c69cf7SJeffrey Kardatzke 	/*
24205c69cf7SJeffrey Kardatzke 	 * Get information about the OP-TEE (BL32) image. Its
24305c69cf7SJeffrey Kardatzke 	 * absence is a critical failure.
24405c69cf7SJeffrey Kardatzke 	 */
24505c69cf7SJeffrey Kardatzke 	optee_entry_point = bl31_plat_get_next_image_ep_info(SECURE);
24605c69cf7SJeffrey Kardatzke 	return opteed_init_with_entry_point(optee_entry_point);
24705c69cf7SJeffrey Kardatzke }
24805c69cf7SJeffrey Kardatzke #endif  /* !OPTEE_ALLOW_SMC_LOAD */
24905c69cf7SJeffrey Kardatzke 
25005c69cf7SJeffrey Kardatzke #if OPTEE_ALLOW_SMC_LOAD
251f4bbf435SJeffrey Kardatzke #if COREBOOT
252f4bbf435SJeffrey Kardatzke /*
253f4bbf435SJeffrey Kardatzke  * Adds a firmware/coreboot node with the coreboot table information to a device
254f4bbf435SJeffrey Kardatzke  * tree. Returns zero on success or if there is no coreboot table information;
255f4bbf435SJeffrey Kardatzke  * failure code otherwise.
256f4bbf435SJeffrey Kardatzke  */
257f4bbf435SJeffrey Kardatzke static int add_coreboot_node(void *fdt)
258f4bbf435SJeffrey Kardatzke {
259f4bbf435SJeffrey Kardatzke 	int ret;
260f4bbf435SJeffrey Kardatzke 	uint64_t coreboot_table_addr;
261f4bbf435SJeffrey Kardatzke 	uint32_t coreboot_table_size;
262f4bbf435SJeffrey Kardatzke 	struct {
263f4bbf435SJeffrey Kardatzke 		uint64_t addr;
264f4bbf435SJeffrey Kardatzke 		uint32_t size;
265f4bbf435SJeffrey Kardatzke 	} reg_node;
266f4bbf435SJeffrey Kardatzke 	coreboot_get_table_location(&coreboot_table_addr, &coreboot_table_size);
267f4bbf435SJeffrey Kardatzke 	if (!coreboot_table_addr || !coreboot_table_size) {
268f4bbf435SJeffrey Kardatzke 		WARN("Unable to get coreboot table location for device tree");
269f4bbf435SJeffrey Kardatzke 		return 0;
270f4bbf435SJeffrey Kardatzke 	}
271f4bbf435SJeffrey Kardatzke 	ret = fdt_begin_node(fdt, "firmware");
272f4bbf435SJeffrey Kardatzke 	if (ret)
273f4bbf435SJeffrey Kardatzke 		return ret;
274f4bbf435SJeffrey Kardatzke 
275f4bbf435SJeffrey Kardatzke 	ret = fdt_property(fdt, "ranges", NULL, 0);
276f4bbf435SJeffrey Kardatzke 	if (ret)
277f4bbf435SJeffrey Kardatzke 		return ret;
278f4bbf435SJeffrey Kardatzke 
279f4bbf435SJeffrey Kardatzke 	ret = fdt_begin_node(fdt, "coreboot");
280f4bbf435SJeffrey Kardatzke 	if (ret)
281f4bbf435SJeffrey Kardatzke 		return ret;
282f4bbf435SJeffrey Kardatzke 
283f4bbf435SJeffrey Kardatzke 	ret = fdt_property_string(fdt, "compatible", "coreboot");
284f4bbf435SJeffrey Kardatzke 	if (ret)
285f4bbf435SJeffrey Kardatzke 		return ret;
286f4bbf435SJeffrey Kardatzke 
287f4bbf435SJeffrey Kardatzke 	reg_node.addr = cpu_to_fdt64(coreboot_table_addr);
288f4bbf435SJeffrey Kardatzke 	reg_node.size = cpu_to_fdt32(coreboot_table_size);
289f4bbf435SJeffrey Kardatzke 	ret = fdt_property(fdt, "reg", &reg_node,
290f4bbf435SJeffrey Kardatzke 				sizeof(uint64_t) + sizeof(uint32_t));
291f4bbf435SJeffrey Kardatzke 	if (ret)
292f4bbf435SJeffrey Kardatzke 		return ret;
293f4bbf435SJeffrey Kardatzke 
294f4bbf435SJeffrey Kardatzke 	ret = fdt_end_node(fdt);
295f4bbf435SJeffrey Kardatzke 	if (ret)
296f4bbf435SJeffrey Kardatzke 		return ret;
297f4bbf435SJeffrey Kardatzke 
298f4bbf435SJeffrey Kardatzke 	return fdt_end_node(fdt);
299f4bbf435SJeffrey Kardatzke }
300f4bbf435SJeffrey Kardatzke #endif /* COREBOOT */
301f4bbf435SJeffrey Kardatzke 
302f4bbf435SJeffrey Kardatzke /*
303f4bbf435SJeffrey Kardatzke  * Creates a device tree for passing into OP-TEE. Currently is populated with
304f4bbf435SJeffrey Kardatzke  * the coreboot table address.
305f4bbf435SJeffrey Kardatzke  * Returns 0 on success, error code otherwise.
306f4bbf435SJeffrey Kardatzke  */
307f4bbf435SJeffrey Kardatzke static int create_opteed_dt(void)
308f4bbf435SJeffrey Kardatzke {
309f4bbf435SJeffrey Kardatzke 	int ret;
310f4bbf435SJeffrey Kardatzke 
311f4bbf435SJeffrey Kardatzke 	ret = fdt_create(fdt_buf, OPTEED_FDT_SIZE);
312f4bbf435SJeffrey Kardatzke 	if (ret)
313f4bbf435SJeffrey Kardatzke 		return ret;
314f4bbf435SJeffrey Kardatzke 
315f4bbf435SJeffrey Kardatzke 	ret = fdt_finish_reservemap(fdt_buf);
316f4bbf435SJeffrey Kardatzke 	if (ret)
317f4bbf435SJeffrey Kardatzke 		return ret;
318f4bbf435SJeffrey Kardatzke 
319f4bbf435SJeffrey Kardatzke 	ret = fdt_begin_node(fdt_buf, "");
320f4bbf435SJeffrey Kardatzke 	if (ret)
321f4bbf435SJeffrey Kardatzke 		return ret;
322f4bbf435SJeffrey Kardatzke 
323f4bbf435SJeffrey Kardatzke #if COREBOOT
324f4bbf435SJeffrey Kardatzke 	ret = add_coreboot_node(fdt_buf);
325f4bbf435SJeffrey Kardatzke 	if (ret)
326f4bbf435SJeffrey Kardatzke 		return ret;
327f4bbf435SJeffrey Kardatzke #endif /* COREBOOT */
328f4bbf435SJeffrey Kardatzke 
329f4bbf435SJeffrey Kardatzke 	ret = fdt_end_node(fdt_buf);
330f4bbf435SJeffrey Kardatzke 	if (ret)
331f4bbf435SJeffrey Kardatzke 		return ret;
332f4bbf435SJeffrey Kardatzke 
333f4bbf435SJeffrey Kardatzke 	return fdt_finish(fdt_buf);
334f4bbf435SJeffrey Kardatzke }
335f4bbf435SJeffrey Kardatzke 
336*0e8def99SRaymond Mao static int32_t create_smc_tl(const void *fdt, uint32_t fdt_sz)
337*0e8def99SRaymond Mao {
338*0e8def99SRaymond Mao #if TRANSFER_LIST
339*0e8def99SRaymond Mao 	bl31_tl = transfer_list_init((void *)(uintptr_t)FW_HANDOFF_BASE,
340*0e8def99SRaymond Mao 				FW_HANDOFF_SIZE);
341*0e8def99SRaymond Mao 	if (!bl31_tl) {
342*0e8def99SRaymond Mao 		ERROR("Failed to initialize Transfer List at 0x%lx\n",
343*0e8def99SRaymond Mao 		(unsigned long)FW_HANDOFF_BASE);
344*0e8def99SRaymond Mao 		return -1;
345*0e8def99SRaymond Mao 	}
346*0e8def99SRaymond Mao 
347*0e8def99SRaymond Mao 	if (!transfer_list_add(bl31_tl, TL_TAG_FDT, fdt_sz, fdt)) {
348*0e8def99SRaymond Mao 		return -1;
349*0e8def99SRaymond Mao 	}
350*0e8def99SRaymond Mao 	return 0;
351*0e8def99SRaymond Mao #else
352*0e8def99SRaymond Mao 	return -1;
353*0e8def99SRaymond Mao #endif
354*0e8def99SRaymond Mao }
355*0e8def99SRaymond Mao 
35605c69cf7SJeffrey Kardatzke /*******************************************************************************
35705c69cf7SJeffrey Kardatzke  * This function is responsible for handling the SMC that loads the OP-TEE
35805c69cf7SJeffrey Kardatzke  * binary image via a non-secure SMC call. It takes the size and physical
35905c69cf7SJeffrey Kardatzke  * address of the payload as parameters.
36005c69cf7SJeffrey Kardatzke  ******************************************************************************/
36105c69cf7SJeffrey Kardatzke static int32_t opteed_handle_smc_load(uint64_t data_size, uint32_t data_pa)
36205c69cf7SJeffrey Kardatzke {
36305c69cf7SJeffrey Kardatzke 	uintptr_t data_va = data_pa;
36405c69cf7SJeffrey Kardatzke 	uint64_t mapped_data_pa;
36505c69cf7SJeffrey Kardatzke 	uintptr_t mapped_data_va;
36605c69cf7SJeffrey Kardatzke 	uint64_t data_map_size;
36705c69cf7SJeffrey Kardatzke 	int32_t rc;
36805c69cf7SJeffrey Kardatzke 	optee_header_t *image_header;
36905c69cf7SJeffrey Kardatzke 	uint8_t *image_ptr;
37005c69cf7SJeffrey Kardatzke 	uint64_t target_pa;
37105c69cf7SJeffrey Kardatzke 	uint64_t target_end_pa;
37205c69cf7SJeffrey Kardatzke 	uint64_t image_pa;
37305c69cf7SJeffrey Kardatzke 	uintptr_t image_va;
37405c69cf7SJeffrey Kardatzke 	optee_image_t *curr_image;
37505c69cf7SJeffrey Kardatzke 	uintptr_t target_va;
37605c69cf7SJeffrey Kardatzke 	uint64_t target_size;
37705c69cf7SJeffrey Kardatzke 	entry_point_info_t optee_ep_info;
37805c69cf7SJeffrey Kardatzke 	uint32_t linear_id = plat_my_core_pos();
379f4bbf435SJeffrey Kardatzke 	uint64_t dt_addr = 0;
380*0e8def99SRaymond Mao 	uint64_t arg0 = 0;
381*0e8def99SRaymond Mao 	uint64_t arg1 = 0;
382*0e8def99SRaymond Mao 	uint64_t arg2 = 0;
383*0e8def99SRaymond Mao 	uint64_t arg3 = 0;
38405c69cf7SJeffrey Kardatzke 
38505c69cf7SJeffrey Kardatzke 	mapped_data_pa = page_align(data_pa, DOWN);
38605c69cf7SJeffrey Kardatzke 	mapped_data_va = mapped_data_pa;
38705c69cf7SJeffrey Kardatzke 	data_map_size = page_align(data_size + (mapped_data_pa - data_pa), UP);
38805c69cf7SJeffrey Kardatzke 
3898d7c80faSJeffrey Kardatzke 	/*
3908d7c80faSJeffrey Kardatzke 	 * We do not validate the passed in address because we are trusting the
3918d7c80faSJeffrey Kardatzke 	 * non-secure world at this point still.
3928d7c80faSJeffrey Kardatzke 	 */
39305c69cf7SJeffrey Kardatzke 	rc = mmap_add_dynamic_region(mapped_data_pa, mapped_data_va,
39405c69cf7SJeffrey Kardatzke 				     data_map_size, MT_MEMORY | MT_RO | MT_NS);
39505c69cf7SJeffrey Kardatzke 	if (rc != 0) {
39605c69cf7SJeffrey Kardatzke 		return rc;
39705c69cf7SJeffrey Kardatzke 	}
39805c69cf7SJeffrey Kardatzke 
39905c69cf7SJeffrey Kardatzke 	image_header = (optee_header_t *)data_va;
40005c69cf7SJeffrey Kardatzke 	if (image_header->magic != TEE_MAGIC_NUM_OPTEE ||
40105c69cf7SJeffrey Kardatzke 	    image_header->version != 2 || image_header->nb_images != 1) {
40205c69cf7SJeffrey Kardatzke 		mmap_remove_dynamic_region(mapped_data_va, data_map_size);
40305c69cf7SJeffrey Kardatzke 		return -EINVAL;
40405c69cf7SJeffrey Kardatzke 	}
40505c69cf7SJeffrey Kardatzke 
40605c69cf7SJeffrey Kardatzke 	image_ptr = (uint8_t *)data_va + sizeof(optee_header_t) +
40705c69cf7SJeffrey Kardatzke 			sizeof(optee_image_t);
40805c69cf7SJeffrey Kardatzke 	if (image_header->arch == 1) {
40905c69cf7SJeffrey Kardatzke 		opteed_rw = OPTEE_AARCH64;
41005c69cf7SJeffrey Kardatzke 	} else {
41105c69cf7SJeffrey Kardatzke 		opteed_rw = OPTEE_AARCH32;
41205c69cf7SJeffrey Kardatzke 	}
41305c69cf7SJeffrey Kardatzke 
41405c69cf7SJeffrey Kardatzke 	curr_image = &image_header->optee_image_list[0];
41505c69cf7SJeffrey Kardatzke 	image_pa = dual32to64(curr_image->load_addr_hi,
41605c69cf7SJeffrey Kardatzke 			      curr_image->load_addr_lo);
41705c69cf7SJeffrey Kardatzke 	image_va = image_pa;
41805c69cf7SJeffrey Kardatzke 	target_end_pa = image_pa + curr_image->size;
41905c69cf7SJeffrey Kardatzke 
42005c69cf7SJeffrey Kardatzke 	/* Now also map the memory we want to copy it to. */
42105c69cf7SJeffrey Kardatzke 	target_pa = page_align(image_pa, DOWN);
42205c69cf7SJeffrey Kardatzke 	target_va = target_pa;
42305c69cf7SJeffrey Kardatzke 	target_size = page_align(target_end_pa, UP) - target_pa;
42405c69cf7SJeffrey Kardatzke 
42505c69cf7SJeffrey Kardatzke 	rc = mmap_add_dynamic_region(target_pa, target_va, target_size,
42605c69cf7SJeffrey Kardatzke 				     MT_MEMORY | MT_RW | MT_SECURE);
42705c69cf7SJeffrey Kardatzke 	if (rc != 0) {
42805c69cf7SJeffrey Kardatzke 		mmap_remove_dynamic_region(mapped_data_va, data_map_size);
42905c69cf7SJeffrey Kardatzke 		return rc;
43005c69cf7SJeffrey Kardatzke 	}
43105c69cf7SJeffrey Kardatzke 
43205c69cf7SJeffrey Kardatzke 	INFO("Loaded OP-TEE via SMC: size %d addr 0x%" PRIx64 "\n",
43305c69cf7SJeffrey Kardatzke 	     curr_image->size, image_va);
43405c69cf7SJeffrey Kardatzke 
43505c69cf7SJeffrey Kardatzke 	memcpy((void *)image_va, image_ptr, curr_image->size);
43605c69cf7SJeffrey Kardatzke 	flush_dcache_range(target_pa, target_size);
43705c69cf7SJeffrey Kardatzke 
43805c69cf7SJeffrey Kardatzke 	mmap_remove_dynamic_region(mapped_data_va, data_map_size);
43905c69cf7SJeffrey Kardatzke 	mmap_remove_dynamic_region(target_va, target_size);
44005c69cf7SJeffrey Kardatzke 
44105c69cf7SJeffrey Kardatzke 	/* Save the non-secure state */
44205c69cf7SJeffrey Kardatzke 	cm_el1_sysregs_context_save(NON_SECURE);
44305c69cf7SJeffrey Kardatzke 
444f4bbf435SJeffrey Kardatzke 	rc = create_opteed_dt();
445f4bbf435SJeffrey Kardatzke 	if (rc) {
446f4bbf435SJeffrey Kardatzke 		ERROR("Failed device tree creation %d\n", rc);
447f4bbf435SJeffrey Kardatzke 		return rc;
448f4bbf435SJeffrey Kardatzke 	}
449f4bbf435SJeffrey Kardatzke 	dt_addr = (uint64_t)fdt_buf;
450f4bbf435SJeffrey Kardatzke 	flush_dcache_range(dt_addr, OPTEED_FDT_SIZE);
451f4bbf435SJeffrey Kardatzke 
452*0e8def99SRaymond Mao 	if (TRANSFER_LIST &&
453*0e8def99SRaymond Mao 	    !create_smc_tl((void *)dt_addr, OPTEED_FDT_SIZE)) {
454*0e8def99SRaymond Mao 		struct transfer_list_entry *te = NULL;
455*0e8def99SRaymond Mao 		void *dt = NULL;
456*0e8def99SRaymond Mao 
457*0e8def99SRaymond Mao 		te = transfer_list_find(bl31_tl, TL_TAG_FDT);
458*0e8def99SRaymond Mao 		dt = transfer_list_entry_data(te);
459*0e8def99SRaymond Mao 
460*0e8def99SRaymond Mao 		if (opteed_rw == OPTEE_AARCH64) {
461*0e8def99SRaymond Mao 			arg0 = (uint64_t)dt;
462*0e8def99SRaymond Mao 			arg2 = 0;
463*0e8def99SRaymond Mao 		} else {
464*0e8def99SRaymond Mao 			arg2 = (uint64_t)dt;
465*0e8def99SRaymond Mao 			arg0 = 0;
466*0e8def99SRaymond Mao 		}
467*0e8def99SRaymond Mao 		arg1 = TRANSFER_LIST_SIGNATURE |
468*0e8def99SRaymond Mao 			REGISTER_CONVENTION_VERSION_MASK;
469*0e8def99SRaymond Mao 		arg3 = (uint64_t)bl31_tl;
470*0e8def99SRaymond Mao 	} else {
471*0e8def99SRaymond Mao 		/* Default handoff arguments */
472*0e8def99SRaymond Mao 		arg2 = dt_addr;
473*0e8def99SRaymond Mao 	}
474*0e8def99SRaymond Mao 
47505c69cf7SJeffrey Kardatzke 	opteed_init_optee_ep_state(&optee_ep_info,
47605c69cf7SJeffrey Kardatzke 				   opteed_rw,
47705c69cf7SJeffrey Kardatzke 				   image_pa,
478*0e8def99SRaymond Mao 				   arg0,
479*0e8def99SRaymond Mao 				   arg1,
480*0e8def99SRaymond Mao 				   arg2,
481*0e8def99SRaymond Mao 				   arg3,
48205c69cf7SJeffrey Kardatzke 				   &opteed_sp_context[linear_id]);
4838d7c80faSJeffrey Kardatzke 	if (opteed_init_with_entry_point(&optee_ep_info) == 0) {
4848d7c80faSJeffrey Kardatzke 		rc = -EFAULT;
4858d7c80faSJeffrey Kardatzke 	}
48605c69cf7SJeffrey Kardatzke 
48705c69cf7SJeffrey Kardatzke 	/* Restore non-secure state */
48805c69cf7SJeffrey Kardatzke 	cm_el1_sysregs_context_restore(NON_SECURE);
48905c69cf7SJeffrey Kardatzke 	cm_set_next_eret_context(NON_SECURE);
49005c69cf7SJeffrey Kardatzke 
49105c69cf7SJeffrey Kardatzke 	return rc;
49205c69cf7SJeffrey Kardatzke }
49305c69cf7SJeffrey Kardatzke #endif  /* OPTEE_ALLOW_SMC_LOAD */
494aa5da461SJens Wiklander 
495aa5da461SJens Wiklander /*******************************************************************************
496aa5da461SJens Wiklander  * This function is responsible for handling all SMCs in the Trusted OS/App
497aa5da461SJens Wiklander  * range from the non-secure state as defined in the SMC Calling Convention
498aa5da461SJens Wiklander  * Document. It is also responsible for communicating with the Secure
499aa5da461SJens Wiklander  * payload to delegate work and return results back to the non-secure
500aa5da461SJens Wiklander  * state. Lastly it will also return any information that OPTEE needs to do
501aa5da461SJens Wiklander  * the work assigned to it.
502aa5da461SJens Wiklander  ******************************************************************************/
50357d1e5faSMasahiro Yamada static uintptr_t opteed_smc_handler(uint32_t smc_fid,
50457d1e5faSMasahiro Yamada 			 u_register_t x1,
50557d1e5faSMasahiro Yamada 			 u_register_t x2,
50657d1e5faSMasahiro Yamada 			 u_register_t x3,
50757d1e5faSMasahiro Yamada 			 u_register_t x4,
508aa5da461SJens Wiklander 			 void *cookie,
509aa5da461SJens Wiklander 			 void *handle,
51057d1e5faSMasahiro Yamada 			 u_register_t flags)
511aa5da461SJens Wiklander {
512aa5da461SJens Wiklander 	cpu_context_t *ns_cpu_context;
513fd650ff6SSoby Mathew 	uint32_t linear_id = plat_my_core_pos();
514aa5da461SJens Wiklander 	optee_context_t *optee_ctx = &opteed_sp_context[linear_id];
515aa5da461SJens Wiklander 	uint64_t rc;
516aa5da461SJens Wiklander 
517aa5da461SJens Wiklander 	/*
518aa5da461SJens Wiklander 	 * Determine which security state this SMC originated from
519aa5da461SJens Wiklander 	 */
520aa5da461SJens Wiklander 
521aa5da461SJens Wiklander 	if (is_caller_non_secure(flags)) {
52205c69cf7SJeffrey Kardatzke #if OPTEE_ALLOW_SMC_LOAD
52385ab8823SJeffrey Kardatzke 		if (opteed_allow_load && smc_fid == NSSMC_OPTEED_CALL_UID) {
52485ab8823SJeffrey Kardatzke 			/* Provide the UUID of the image loading service. */
52585ab8823SJeffrey Kardatzke 			SMC_UUID_RET(handle, optee_image_load_uuid);
52685ab8823SJeffrey Kardatzke 		}
52705c69cf7SJeffrey Kardatzke 		if (smc_fid == NSSMC_OPTEED_CALL_LOAD_IMAGE) {
52805c69cf7SJeffrey Kardatzke 			/*
52905c69cf7SJeffrey Kardatzke 			 * TODO: Consider wiping the code for SMC loading from
53005c69cf7SJeffrey Kardatzke 			 * memory after it has been invoked similar to what is
53105c69cf7SJeffrey Kardatzke 			 * done under RECLAIM_INIT, but extended to happen
53205c69cf7SJeffrey Kardatzke 			 * later.
53305c69cf7SJeffrey Kardatzke 			 */
53405c69cf7SJeffrey Kardatzke 			if (!opteed_allow_load) {
53505c69cf7SJeffrey Kardatzke 				SMC_RET1(handle, -EPERM);
53605c69cf7SJeffrey Kardatzke 			}
53705c69cf7SJeffrey Kardatzke 
53805c69cf7SJeffrey Kardatzke 			opteed_allow_load = false;
53905c69cf7SJeffrey Kardatzke 			uint64_t data_size = dual32to64(x1, x2);
54005c69cf7SJeffrey Kardatzke 			uint64_t data_pa = dual32to64(x3, x4);
54105c69cf7SJeffrey Kardatzke 			if (!data_size || !data_pa) {
54205c69cf7SJeffrey Kardatzke 				/*
54305c69cf7SJeffrey Kardatzke 				 * This is invoked when the OP-TEE image didn't
54405c69cf7SJeffrey Kardatzke 				 * load correctly in the kernel but we want to
54505c69cf7SJeffrey Kardatzke 				 * block off loading of it later for security
54605c69cf7SJeffrey Kardatzke 				 * reasons.
54705c69cf7SJeffrey Kardatzke 				 */
54805c69cf7SJeffrey Kardatzke 				SMC_RET1(handle, -EINVAL);
54905c69cf7SJeffrey Kardatzke 			}
55005c69cf7SJeffrey Kardatzke 			SMC_RET1(handle, opteed_handle_smc_load(
55105c69cf7SJeffrey Kardatzke 					data_size, data_pa));
55205c69cf7SJeffrey Kardatzke 		}
55305c69cf7SJeffrey Kardatzke #endif  /* OPTEE_ALLOW_SMC_LOAD */
554aa5da461SJens Wiklander 		/*
555aa5da461SJens Wiklander 		 * This is a fresh request from the non-secure client.
556aa5da461SJens Wiklander 		 * The parameters are in x1 and x2. Figure out which
557aa5da461SJens Wiklander 		 * registers need to be preserved, save the non-secure
558aa5da461SJens Wiklander 		 * state and send the request to the secure payload.
559aa5da461SJens Wiklander 		 */
560aa5da461SJens Wiklander 		assert(handle == cm_get_context(NON_SECURE));
561aa5da461SJens Wiklander 
562aa5da461SJens Wiklander 		cm_el1_sysregs_context_save(NON_SECURE);
563aa5da461SJens Wiklander 
564aa5da461SJens Wiklander 		/*
565aa5da461SJens Wiklander 		 * We are done stashing the non-secure context. Ask the
56605c69cf7SJeffrey Kardatzke 		 * OP-TEE to do the work now. If we are loading vi an SMC,
56705c69cf7SJeffrey Kardatzke 		 * then we also need to init this CPU context if not done
56805c69cf7SJeffrey Kardatzke 		 * already.
569aa5da461SJens Wiklander 		 */
57005c69cf7SJeffrey Kardatzke 		if (optee_vector_table == NULL) {
57105c69cf7SJeffrey Kardatzke 			SMC_RET1(handle, -EINVAL);
57205c69cf7SJeffrey Kardatzke 		}
57305c69cf7SJeffrey Kardatzke 
57405c69cf7SJeffrey Kardatzke 		if (get_optee_pstate(optee_ctx->state) ==
57505c69cf7SJeffrey Kardatzke 		    OPTEE_PSTATE_UNKNOWN) {
57605c69cf7SJeffrey Kardatzke 			opteed_cpu_on_finish_handler(0);
57705c69cf7SJeffrey Kardatzke 		}
578aa5da461SJens Wiklander 
579aa5da461SJens Wiklander 		/*
580aa5da461SJens Wiklander 		 * Verify if there is a valid context to use, copy the
581aa5da461SJens Wiklander 		 * operation type and parameters to the secure context
582aa5da461SJens Wiklander 		 * and jump to the fast smc entry point in the secure
583aa5da461SJens Wiklander 		 * payload. Entry into S-EL1 will take place upon exit
584aa5da461SJens Wiklander 		 * from this function.
585aa5da461SJens Wiklander 		 */
586aa5da461SJens Wiklander 		assert(&optee_ctx->cpu_ctx == cm_get_context(SECURE));
587aa5da461SJens Wiklander 
588aa5da461SJens Wiklander 		/* Set appropriate entry for SMC.
589aa5da461SJens Wiklander 		 * We expect OPTEE to manage the PSTATE.I and PSTATE.F
590aa5da461SJens Wiklander 		 * flags as appropriate.
591aa5da461SJens Wiklander 		 */
592aa5da461SJens Wiklander 		if (GET_SMC_TYPE(smc_fid) == SMC_TYPE_FAST) {
593aa5da461SJens Wiklander 			cm_set_elr_el3(SECURE, (uint64_t)
594776ff52aSDaniel Boulby 					&optee_vector_table->fast_smc_entry);
595aa5da461SJens Wiklander 		} else {
596aa5da461SJens Wiklander 			cm_set_elr_el3(SECURE, (uint64_t)
597776ff52aSDaniel Boulby 					&optee_vector_table->yield_smc_entry);
598aa5da461SJens Wiklander 		}
599aa5da461SJens Wiklander 
600aa5da461SJens Wiklander 		cm_el1_sysregs_context_restore(SECURE);
601aa5da461SJens Wiklander 		cm_set_next_eret_context(SECURE);
602aa5da461SJens Wiklander 
60356a6412dSAshutosh Singh 		write_ctx_reg(get_gpregs_ctx(&optee_ctx->cpu_ctx),
60456a6412dSAshutosh Singh 			      CTX_GPREG_X4,
60556a6412dSAshutosh Singh 			      read_ctx_reg(get_gpregs_ctx(handle),
60656a6412dSAshutosh Singh 					   CTX_GPREG_X4));
60756a6412dSAshutosh Singh 		write_ctx_reg(get_gpregs_ctx(&optee_ctx->cpu_ctx),
60856a6412dSAshutosh Singh 			      CTX_GPREG_X5,
60956a6412dSAshutosh Singh 			      read_ctx_reg(get_gpregs_ctx(handle),
61056a6412dSAshutosh Singh 					   CTX_GPREG_X5));
61156a6412dSAshutosh Singh 		write_ctx_reg(get_gpregs_ctx(&optee_ctx->cpu_ctx),
61256a6412dSAshutosh Singh 			      CTX_GPREG_X6,
61356a6412dSAshutosh Singh 			      read_ctx_reg(get_gpregs_ctx(handle),
61456a6412dSAshutosh Singh 					   CTX_GPREG_X6));
615aa5da461SJens Wiklander 		/* Propagate hypervisor client ID */
616aa5da461SJens Wiklander 		write_ctx_reg(get_gpregs_ctx(&optee_ctx->cpu_ctx),
617aa5da461SJens Wiklander 			      CTX_GPREG_X7,
618aa5da461SJens Wiklander 			      read_ctx_reg(get_gpregs_ctx(handle),
619aa5da461SJens Wiklander 					   CTX_GPREG_X7));
620aa5da461SJens Wiklander 
621aa5da461SJens Wiklander 		SMC_RET4(&optee_ctx->cpu_ctx, smc_fid, x1, x2, x3);
622aa5da461SJens Wiklander 	}
623aa5da461SJens Wiklander 
624aa5da461SJens Wiklander 	/*
625aa5da461SJens Wiklander 	 * Returning from OPTEE
626aa5da461SJens Wiklander 	 */
627aa5da461SJens Wiklander 
628aa5da461SJens Wiklander 	switch (smc_fid) {
629aa5da461SJens Wiklander 	/*
630aa5da461SJens Wiklander 	 * OPTEE has finished initialising itself after a cold boot
631aa5da461SJens Wiklander 	 */
632aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_ENTRY_DONE:
633aa5da461SJens Wiklander 		/*
634aa5da461SJens Wiklander 		 * Stash the OPTEE entry points information. This is done
635aa5da461SJens Wiklander 		 * only once on the primary cpu
636aa5da461SJens Wiklander 		 */
637776ff52aSDaniel Boulby 		assert(optee_vector_table == NULL);
638776ff52aSDaniel Boulby 		optee_vector_table = (optee_vectors_t *) x1;
639aa5da461SJens Wiklander 
640776ff52aSDaniel Boulby 		if (optee_vector_table) {
641aa5da461SJens Wiklander 			set_optee_pstate(optee_ctx->state, OPTEE_PSTATE_ON);
642aa5da461SJens Wiklander 
643aa5da461SJens Wiklander 			/*
644aa5da461SJens Wiklander 			 * OPTEE has been successfully initialized.
645aa5da461SJens Wiklander 			 * Register power management hooks with PSCI
646aa5da461SJens Wiklander 			 */
647aa5da461SJens Wiklander 			psci_register_spd_pm_hook(&opteed_pm);
648aa5da461SJens Wiklander 
649aa5da461SJens Wiklander 			/*
650aa5da461SJens Wiklander 			 * Register an interrupt handler for S-EL1 interrupts
651aa5da461SJens Wiklander 			 * when generated during code executing in the
652aa5da461SJens Wiklander 			 * non-secure state.
653aa5da461SJens Wiklander 			 */
654aa5da461SJens Wiklander 			flags = 0;
655aa5da461SJens Wiklander 			set_interrupt_rm_flag(flags, NON_SECURE);
656aa5da461SJens Wiklander 			rc = register_interrupt_type_handler(INTR_TYPE_S_EL1,
657aa5da461SJens Wiklander 						opteed_sel1_interrupt_handler,
658aa5da461SJens Wiklander 						flags);
659aa5da461SJens Wiklander 			if (rc)
660aa5da461SJens Wiklander 				panic();
661aa5da461SJens Wiklander 		}
662aa5da461SJens Wiklander 
663aa5da461SJens Wiklander 		/*
664aa5da461SJens Wiklander 		 * OPTEE reports completion. The OPTEED must have initiated
665aa5da461SJens Wiklander 		 * the original request through a synchronous entry into
666aa5da461SJens Wiklander 		 * OPTEE. Jump back to the original C runtime context.
667aa5da461SJens Wiklander 		 */
668aa5da461SJens Wiklander 		opteed_synchronous_sp_exit(optee_ctx, x1);
669185a23ffSJonathan Wright 		break;
670aa5da461SJens Wiklander 
671aa5da461SJens Wiklander 
672aa5da461SJens Wiklander 	/*
673aa5da461SJens Wiklander 	 * These function IDs is used only by OP-TEE to indicate it has
674aa5da461SJens Wiklander 	 * finished:
675aa5da461SJens Wiklander 	 * 1. turning itself on in response to an earlier psci
676aa5da461SJens Wiklander 	 *    cpu_on request
677aa5da461SJens Wiklander 	 * 2. resuming itself after an earlier psci cpu_suspend
678aa5da461SJens Wiklander 	 *    request.
679aa5da461SJens Wiklander 	 */
680aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_ON_DONE:
681aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_RESUME_DONE:
682aa5da461SJens Wiklander 
683aa5da461SJens Wiklander 
684aa5da461SJens Wiklander 	/*
685aa5da461SJens Wiklander 	 * These function IDs is used only by the SP to indicate it has
686aa5da461SJens Wiklander 	 * finished:
687aa5da461SJens Wiklander 	 * 1. suspending itself after an earlier psci cpu_suspend
688aa5da461SJens Wiklander 	 *    request.
689aa5da461SJens Wiklander 	 * 2. turning itself off in response to an earlier psci
690aa5da461SJens Wiklander 	 *    cpu_off request.
691aa5da461SJens Wiklander 	 */
692aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_OFF_DONE:
693aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_SUSPEND_DONE:
694aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_SYSTEM_OFF_DONE:
695aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_SYSTEM_RESET_DONE:
696aa5da461SJens Wiklander 
697aa5da461SJens Wiklander 		/*
698aa5da461SJens Wiklander 		 * OPTEE reports completion. The OPTEED must have initiated the
699aa5da461SJens Wiklander 		 * original request through a synchronous entry into OPTEE.
700aa5da461SJens Wiklander 		 * Jump back to the original C runtime context, and pass x1 as
701aa5da461SJens Wiklander 		 * return value to the caller
702aa5da461SJens Wiklander 		 */
703aa5da461SJens Wiklander 		opteed_synchronous_sp_exit(optee_ctx, x1);
704185a23ffSJonathan Wright 		break;
705aa5da461SJens Wiklander 
706aa5da461SJens Wiklander 	/*
707aa5da461SJens Wiklander 	 * OPTEE is returning from a call or being preempted from a call, in
708aa5da461SJens Wiklander 	 * either case execution should resume in the normal world.
709aa5da461SJens Wiklander 	 */
710aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_CALL_DONE:
711aa5da461SJens Wiklander 		/*
712aa5da461SJens Wiklander 		 * This is the result from the secure client of an
713aa5da461SJens Wiklander 		 * earlier request. The results are in x0-x3. Copy it
714aa5da461SJens Wiklander 		 * into the non-secure context, save the secure state
715aa5da461SJens Wiklander 		 * and return to the non-secure state.
716aa5da461SJens Wiklander 		 */
717aa5da461SJens Wiklander 		assert(handle == cm_get_context(SECURE));
718aa5da461SJens Wiklander 		cm_el1_sysregs_context_save(SECURE);
719aa5da461SJens Wiklander 
720aa5da461SJens Wiklander 		/* Get a reference to the non-secure context */
721aa5da461SJens Wiklander 		ns_cpu_context = cm_get_context(NON_SECURE);
722aa5da461SJens Wiklander 		assert(ns_cpu_context);
723aa5da461SJens Wiklander 
724aa5da461SJens Wiklander 		/* Restore non-secure state */
725aa5da461SJens Wiklander 		cm_el1_sysregs_context_restore(NON_SECURE);
726aa5da461SJens Wiklander 		cm_set_next_eret_context(NON_SECURE);
727aa5da461SJens Wiklander 
728aa5da461SJens Wiklander 		SMC_RET4(ns_cpu_context, x1, x2, x3, x4);
729aa5da461SJens Wiklander 
730aa5da461SJens Wiklander 	/*
731aa5da461SJens Wiklander 	 * OPTEE has finished handling a S-EL1 FIQ interrupt. Execution
732aa5da461SJens Wiklander 	 * should resume in the normal world.
733aa5da461SJens Wiklander 	 */
734aa5da461SJens Wiklander 	case TEESMC_OPTEED_RETURN_FIQ_DONE:
735aa5da461SJens Wiklander 		/* Get a reference to the non-secure context */
736aa5da461SJens Wiklander 		ns_cpu_context = cm_get_context(NON_SECURE);
737aa5da461SJens Wiklander 		assert(ns_cpu_context);
738aa5da461SJens Wiklander 
739aa5da461SJens Wiklander 		/*
740aa5da461SJens Wiklander 		 * Restore non-secure state. There is no need to save the
741aa5da461SJens Wiklander 		 * secure system register context since OPTEE was supposed
742aa5da461SJens Wiklander 		 * to preserve it during S-EL1 interrupt handling.
743aa5da461SJens Wiklander 		 */
744aa5da461SJens Wiklander 		cm_el1_sysregs_context_restore(NON_SECURE);
745aa5da461SJens Wiklander 		cm_set_next_eret_context(NON_SECURE);
746aa5da461SJens Wiklander 
747aa5da461SJens Wiklander 		SMC_RET0((uint64_t) ns_cpu_context);
748aa5da461SJens Wiklander 
749aa5da461SJens Wiklander 	default:
750aa5da461SJens Wiklander 		panic();
751aa5da461SJens Wiklander 	}
752aa5da461SJens Wiklander }
753aa5da461SJens Wiklander 
754aa5da461SJens Wiklander /* Define an OPTEED runtime service descriptor for fast SMC calls */
755aa5da461SJens Wiklander DECLARE_RT_SVC(
756aa5da461SJens Wiklander 	opteed_fast,
757aa5da461SJens Wiklander 
758aa5da461SJens Wiklander 	OEN_TOS_START,
759aa5da461SJens Wiklander 	OEN_TOS_END,
760aa5da461SJens Wiklander 	SMC_TYPE_FAST,
761aa5da461SJens Wiklander 	opteed_setup,
762aa5da461SJens Wiklander 	opteed_smc_handler
763aa5da461SJens Wiklander );
764aa5da461SJens Wiklander 
765bbbbcdaeSDavid Cunado /* Define an OPTEED runtime service descriptor for yielding SMC calls */
766aa5da461SJens Wiklander DECLARE_RT_SVC(
767aa5da461SJens Wiklander 	opteed_std,
768aa5da461SJens Wiklander 
769aa5da461SJens Wiklander 	OEN_TOS_START,
770aa5da461SJens Wiklander 	OEN_TOS_END,
771bbbbcdaeSDavid Cunado 	SMC_TYPE_YIELD,
772aa5da461SJens Wiklander 	NULL,
773aa5da461SJens Wiklander 	opteed_smc_handler
774aa5da461SJens Wiklander );
775