2 * Copyright (c) 2015-2019, ARM Limited and Contributors. All rights reserved.
4 * SPDX-License-Identifier: BSD-3-Clause
7 /*******************************************************************************
8 * This is the Secure Payload Dispatcher (SPD). The dispatcher is meant to be a
9 * plug-in component to the Secure Monitor, registered as a runtime service. The
10 * SPD is expected to be a functional extension of the Secure Payload (SP) that
11 * executes in Secure EL1. The Secure Monitor will delegate all SMCs targeting
12 * the Trusted OS/Applications range to the dispatcher. The SPD will either
13 * handle the request locally or delegate it to the Secure Payload. It is also
14 * responsible for initialising and maintaining communication with the SP.
15 ******************************************************************************/
16 #include <arch_helpers.h>
21 #include <bl31/bl31.h>
22 #include <common/bl_common.h>
23 #include <common/debug.h>
24 #include <common/runtime_svc.h>
25 #include <lib/el3_runtime/context_mgmt.h>
26 #include <plat/common/platform.h>
27 #include <tools_share/uuid.h>
30 #include "tlkd_private.h"
32 extern const spd_pm_ops_t tlkd_pm_ops
;
34 /*******************************************************************************
35 * Per-cpu Secure Payload state
36 ******************************************************************************/
37 tlk_context_t tlk_ctx
;
39 /*******************************************************************************
40 * CPU number on which TLK booted up
41 ******************************************************************************/
42 static uint32_t boot_cpu
;
44 /* TLK UID: RFC-4122 compliant UUID (version-5, sha-1) */
45 DEFINE_SVC_UUID2(tlk_uuid
,
46 0xc9e911bd, 0xba2b, 0xee52, 0xb1, 0x72,
47 0x46, 0x1f, 0xba, 0x97, 0x7f, 0x63);
49 static int32_t tlkd_init(void);
51 /*******************************************************************************
52 * Secure Payload Dispatcher setup. The SPD finds out the SP entrypoint and type
53 * (aarch32/aarch64) if not already known and initialises the context for entry
54 * into the SP for its initialisation.
55 ******************************************************************************/
56 static int32_t tlkd_setup(void)
58 entry_point_info_t
*tlk_ep_info
;
61 * Get information about the Secure Payload (BL32) image. Its
62 * absence is a critical failure.
64 tlk_ep_info
= bl31_plat_get_next_image_ep_info(SECURE
);
66 WARN("No SP provided. Booting device without SP"
67 " initialization. SMC`s destined for SP"
68 " will return SMC_UNK\n");
73 * If there's no valid entry point for SP, we return a non-zero value
74 * signalling failure initializing the service. We bail out without
75 * registering any handlers
81 * Inspect the SP image's SPSR and determine it's execution state
82 * i.e whether AArch32 or AArch64.
84 tlkd_init_tlk_ep_state(tlk_ep_info
,
85 (tlk_ep_info
->spsr
>> MODE_RW_SHIFT
) & MODE_RW_MASK
,
90 * All TLK SPD initialization done. Now register our init function
91 * with BL31 for deferred invocation
93 bl31_register_bl32_init(&tlkd_init
);
98 /*******************************************************************************
99 * This function passes control to the Secure Payload image (BL32) for the first
100 * time on the primary cpu after a cold boot. It assumes that a valid secure
101 * context has already been created by tlkd_setup() which can be directly
102 * used. This function performs a synchronous entry into the Secure payload.
103 * The SP passes control back to this routine through a SMC.
104 ******************************************************************************/
105 static int32_t tlkd_init(void)
107 entry_point_info_t
*tlk_entry_point
;
110 * Get information about the Secure Payload (BL32) image. Its
111 * absence is a critical failure.
113 tlk_entry_point
= bl31_plat_get_next_image_ep_info(SECURE
);
114 assert(tlk_entry_point
);
116 cm_init_my_context(tlk_entry_point
);
119 * TLK runs only on a single CPU. Store the value of the boot
120 * CPU for sanity checking later.
122 boot_cpu
= plat_my_core_pos();
125 * Arrange for an entry into the test secure payload.
127 return tlkd_synchronous_sp_entry(&tlk_ctx
);
130 /*******************************************************************************
131 * This function is responsible for handling all SMCs in the Trusted OS/App
132 * range from the non-secure state as defined in the SMC Calling Convention
133 * Document. It is also responsible for communicating with the Secure payload
134 * to delegate work and return results back to the non-secure state. Lastly it
135 * will also return any information that the secure payload needs to do the
136 * work assigned to it.
137 ******************************************************************************/
138 static uintptr_t tlkd_smc_handler(uint32_t smc_fid
,
147 cpu_context_t
*ns_cpu_context
;
152 /* Passing a NULL context is a critical programming error */
155 /* These SMCs are only supported by a single CPU */
156 if (boot_cpu
!= plat_my_core_pos())
157 SMC_RET1(handle
, SMC_UNK
);
159 /* Determine which security state this SMC originated from */
160 ns
= is_caller_non_secure(flags
);
165 * This function ID is used by SP to indicate that it was
166 * preempted by a non-secure world IRQ.
171 SMC_RET1(handle
, SMC_UNK
);
173 assert(handle
== cm_get_context(SECURE
));
174 cm_el1_sysregs_context_save(SECURE
);
176 /* Get a reference to the non-secure context */
177 ns_cpu_context
= cm_get_context(NON_SECURE
);
178 assert(ns_cpu_context
);
181 * Restore non-secure state. There is no need to save the
182 * secure system register context since the SP was supposed
183 * to preserve it during S-EL1 interrupt handling.
185 cm_el1_sysregs_context_restore(NON_SECURE
);
186 cm_set_next_eret_context(NON_SECURE
);
188 SMC_RET1(ns_cpu_context
, x1
);
191 * This is a request from the non-secure context to:
193 * a. register shared memory with the SP for storing it's
195 * b. register shared memory with the SP for passing args
196 * required for maintaining sessions with the Trusted
198 * c. register shared persistent buffers for secure storage
199 * d. register NS DRAM ranges passed by Cboot
200 * e. register Root of Trust parameters from Cboot for Verified Boot
201 * f. open/close sessions
202 * g. issue commands to the Trusted Apps
203 * h. resume the preempted yielding SMC call.
205 case TLK_REGISTER_LOGBUF
:
206 case TLK_REGISTER_REQBUF
:
207 case TLK_SS_REGISTER_HANDLER
:
208 case TLK_REGISTER_NS_DRAM_RANGES
:
209 case TLK_SET_ROOT_OF_TRUST
:
210 case TLK_OPEN_TA_SESSION
:
211 case TLK_CLOSE_TA_SESSION
:
212 case TLK_TA_LAUNCH_OP
:
213 case TLK_TA_SEND_EVENT
:
217 SMC_RET1(handle
, SMC_UNK
);
220 * This is a fresh request from the non-secure client.
221 * The parameters are in x1 and x2. Figure out which
222 * registers need to be preserved, save the non-secure
223 * state and send the request to the secure payload.
225 assert(handle
== cm_get_context(NON_SECURE
));
228 * Check if we are already processing a yielding SMC
229 * call. Of all the supported fids, only the "resume"
230 * fid expects the flag to be set.
232 if (smc_fid
== TLK_RESUME_FID
) {
233 if (!get_yield_smc_active_flag(tlk_ctx
.state
))
234 SMC_RET1(handle
, SMC_UNK
);
236 if (get_yield_smc_active_flag(tlk_ctx
.state
))
237 SMC_RET1(handle
, SMC_UNK
);
240 cm_el1_sysregs_context_save(NON_SECURE
);
243 * Verify if there is a valid context to use.
245 assert(&tlk_ctx
.cpu_ctx
== cm_get_context(SECURE
));
248 * Mark the SP state as active.
250 set_yield_smc_active_flag(tlk_ctx
.state
);
253 * We are done stashing the non-secure context. Ask the
254 * secure payload to do the work now.
256 cm_el1_sysregs_context_restore(SECURE
);
257 cm_set_next_eret_context(SECURE
);
260 * TLK is a 32-bit Trusted OS and so expects the SMC
261 * arguments via r0-r7. TLK expects the monitor frame
262 * registers to be 64-bits long. Hence, we pass x0 in
263 * r0-r1, x1 in r2-r3, x3 in r4-r5 and x4 in r6-r7.
265 * As smc_fid is a uint32 value, r1 contains 0.
267 gp_regs
= get_gpregs_ctx(&tlk_ctx
.cpu_ctx
);
268 write_ctx_reg(gp_regs
, CTX_GPREG_X4
, (uint32_t)x2
);
269 write_ctx_reg(gp_regs
, CTX_GPREG_X5
, (uint32_t)(x2
>> 32));
270 write_ctx_reg(gp_regs
, CTX_GPREG_X6
, (uint32_t)x3
);
271 write_ctx_reg(gp_regs
, CTX_GPREG_X7
, (uint32_t)(x3
>> 32));
272 SMC_RET4(&tlk_ctx
.cpu_ctx
, smc_fid
, 0, (uint32_t)x1
,
273 (uint32_t)(x1
>> 32));
276 * Translate NS/EL1-S virtual addresses.
278 * x1 = virtual address
281 * Returns PA:lo in r0, PA:hi in r1.
283 case TLK_VA_TRANSLATE
:
285 /* Should be invoked only by secure world */
287 SMC_RET1(handle
, SMC_UNK
);
289 /* NS virtual addresses are 64-bit long */
290 if (x3
& TLK_TRANSLATE_NS_VADDR
)
291 x1
= (uint32_t)x1
| (x2
<< 32);
294 SMC_RET1(handle
, SMC_UNK
);
297 * TODO: Sanity check x1. This would require platform
301 /* virtual address and type: ns/s */
302 par
= tlkd_va_translate(x1
, x3
);
304 /* return physical address in r0-r1 */
305 SMC_RET4(handle
, (uint32_t)par
, (uint32_t)(par
>> 32), 0, 0);
308 * This is a request from the SP to mark completion of
309 * a yielding function ID.
311 case TLK_REQUEST_DONE
:
313 SMC_RET1(handle
, SMC_UNK
);
316 * Mark the SP state as inactive.
318 clr_yield_smc_active_flag(tlk_ctx
.state
);
320 /* Get a reference to the non-secure context */
321 ns_cpu_context
= cm_get_context(NON_SECURE
);
322 assert(ns_cpu_context
);
325 * This is a request completion SMC and we must switch to
326 * the non-secure world to pass the result.
328 cm_el1_sysregs_context_save(SECURE
);
331 * We are done stashing the secure context. Switch to the
332 * non-secure context and return the result.
334 cm_el1_sysregs_context_restore(NON_SECURE
);
335 cm_set_next_eret_context(NON_SECURE
);
336 SMC_RET1(ns_cpu_context
, x1
);
339 * This function ID is used only by the SP to indicate it has
340 * finished initialising itself after a cold boot
344 SMC_RET1(handle
, SMC_UNK
);
347 * SP has been successfully initialized. Register power
348 * management hooks with PSCI
350 psci_register_spd_pm_hook(&tlkd_pm_ops
);
353 * TLK reports completion. The SPD must have initiated
354 * the original request through a synchronous entry
355 * into the SP. Jump back to the original C runtime
358 tlkd_synchronous_sp_exit(&tlk_ctx
, x1
);
362 * These function IDs are used only by TLK to indicate it has
364 * 1. suspending itself after an earlier psci cpu_suspend
366 * 2. resuming itself after an earlier psci cpu_suspend
368 * 3. powering down after an earlier psci system_off/system_reset
371 case TLK_SUSPEND_DONE
:
372 case TLK_RESUME_DONE
:
373 case TLK_SYSTEM_OFF_DONE
:
376 SMC_RET1(handle
, SMC_UNK
);
379 * TLK reports completion. TLKD must have initiated the
380 * original request through a synchronous entry into the SP.
381 * Jump back to the original C runtime context, and pass x1 as
382 * return value to the caller
384 tlkd_synchronous_sp_exit(&tlk_ctx
, x1
);
388 * Return the number of service function IDs implemented to
389 * provide service to non-secure
392 SMC_RET1(handle
, TLK_NUM_FID
);
395 * Return TLK's UID to the caller
398 SMC_UUID_RET(handle
, tlk_uuid
);
401 * Return the version of current implementation
403 case TOS_CALL_VERSION
:
404 SMC_RET2(handle
, TLK_VERSION_MAJOR
, TLK_VERSION_MINOR
);
407 WARN("%s: Unhandled SMC: 0x%x\n", __func__
, smc_fid
);
411 SMC_RET1(handle
, SMC_UNK
);
414 /* Define a SPD runtime service descriptor for fast SMC calls */
425 /* Define a SPD runtime service descriptor for yielding SMC calls */
436 /* Define a SPD runtime service descriptor for fast SMC calls */
447 /* Define a SPD runtime service descriptor for yielding SMC calls */