1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2018 Linaro Limited
10 #include <linux/arm-smccc.h>
11 #include <linux/err.h>
14 #include "optee_smc.h"
15 #include "optee_msg.h"
16 #include "optee_private.h"
18 #define PAGELIST_ENTRIES_PER_PAGE \
19 ((OPTEE_MSG_NONCONTIG_PAGE_SIZE / sizeof(u64)) - 1)
21 typedef void (optee_invoke_fn)(unsigned long, unsigned long, unsigned long,
22 unsigned long, unsigned long, unsigned long,
23 unsigned long, unsigned long,
24 struct arm_smccc_res *);
27 optee_invoke_fn *invoke_fn;
42 * reg_pair_to_ptr() - Make a pointer of 2 32-bit values
43 * @reg0: High bits of the pointer
44 * @reg1: Low bits of the pointer
46 * Returns the combined result, note that if a pointer is 32-bit wide @reg0
49 static void *reg_pair_to_ptr(u32 reg0, u32 reg1)
51 return (void *)(ulong)(((u64)reg0 << 32) | reg1);
55 * reg_pair_from_64() - Split a 64-bit value into two 32-bit values
56 * @reg0: High bits of @val
57 * @reg1: Low bits of @val
58 * @val: The value to split
60 static void reg_pair_from_64(u32 *reg0, u32 *reg1, u64 val)
67 * optee_alloc_and_init_page_list() - Provide page list of memory buffer
68 * @buf: Start of buffer
69 * @len: Length of buffer
70 * @phys_buf_ptr Physical pointer with coded offset to page list
72 * Secure world doesn't share mapping with Normal world (U-Boot in this case)
73 * so physical pointers are needed when sharing pointers.
75 * Returns a pointer page list on success or NULL on failure
77 void *optee_alloc_and_init_page_list(void *buf, ulong len, u64 *phys_buf_ptr)
79 const unsigned int page_size = OPTEE_MSG_NONCONTIG_PAGE_SIZE;
80 const phys_addr_t page_mask = page_size - 1;
82 unsigned int page_offset;
83 unsigned int num_pages;
84 unsigned int list_size;
88 u64 pages_list[PAGELIST_ENTRIES_PER_PAGE];
93 * A Memory buffer is described in chunks of 4k. The list of
94 * physical addresses has to be represented by a physical pointer
95 * too and a single list has to start at a 4k page and fit into
96 * that page. In order to be able to describe large memory buffers
97 * these 4k pages carrying physical addresses are linked together
98 * in a list. See OPTEE_MSG_ATTR_NONCONTIG in
99 * drivers/tee/optee/optee_msg.h for more information.
102 page_offset = (ulong)buf & page_mask;
103 num_pages = roundup(page_offset + len, page_size) / page_size;
104 list_size = DIV_ROUND_UP(num_pages, PAGELIST_ENTRIES_PER_PAGE) *
106 page_list = memalign(page_size, list_size);
110 pages_data = page_list;
111 buf_base = (u8 *)rounddown((ulong)buf, page_size);
114 pages_data->pages_list[n] = virt_to_phys(buf_base);
116 buf_base += page_size;
119 if (n == PAGELIST_ENTRIES_PER_PAGE) {
120 pages_data->next_page_data =
121 virt_to_phys(pages_data + 1);
127 *phys_buf_ptr = virt_to_phys(page_list) | page_offset;
131 static void optee_get_version(struct udevice *dev,
132 struct tee_version_data *vers)
134 struct tee_version_data v = {
135 .gen_caps = TEE_GEN_CAP_GP | TEE_GEN_CAP_REG_MEM,
141 static int get_msg_arg(struct udevice *dev, uint num_params,
142 struct tee_shm **shmp, struct optee_msg_arg **msg_arg)
145 struct optee_msg_arg *ma;
147 rc = __tee_shm_add(dev, OPTEE_MSG_NONCONTIG_PAGE_SIZE, NULL,
148 OPTEE_MSG_GET_ARG_SIZE(num_params), TEE_SHM_ALLOC,
154 memset(ma, 0, OPTEE_MSG_GET_ARG_SIZE(num_params));
155 ma->num_params = num_params;
161 static int to_msg_param(struct optee_msg_param *msg_params, uint num_params,
162 const struct tee_param *params)
166 for (n = 0; n < num_params; n++) {
167 const struct tee_param *p = params + n;
168 struct optee_msg_param *mp = msg_params + n;
171 case TEE_PARAM_ATTR_TYPE_NONE:
172 mp->attr = OPTEE_MSG_ATTR_TYPE_NONE;
173 memset(&mp->u, 0, sizeof(mp->u));
175 case TEE_PARAM_ATTR_TYPE_VALUE_INPUT:
176 case TEE_PARAM_ATTR_TYPE_VALUE_OUTPUT:
177 case TEE_PARAM_ATTR_TYPE_VALUE_INOUT:
178 mp->attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT + p->attr -
179 TEE_PARAM_ATTR_TYPE_VALUE_INPUT;
180 mp->u.value.a = p->u.value.a;
181 mp->u.value.b = p->u.value.b;
182 mp->u.value.c = p->u.value.c;
184 case TEE_PARAM_ATTR_TYPE_MEMREF_INPUT:
185 case TEE_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
186 case TEE_PARAM_ATTR_TYPE_MEMREF_INOUT:
187 mp->attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT + p->attr -
188 TEE_PARAM_ATTR_TYPE_MEMREF_INPUT;
189 mp->u.rmem.shm_ref = (ulong)p->u.memref.shm;
190 mp->u.rmem.size = p->u.memref.size;
191 mp->u.rmem.offs = p->u.memref.shm_offs;
200 static int from_msg_param(struct tee_param *params, uint num_params,
201 const struct optee_msg_param *msg_params)
206 for (n = 0; n < num_params; n++) {
207 struct tee_param *p = params + n;
208 const struct optee_msg_param *mp = msg_params + n;
209 u32 attr = mp->attr & OPTEE_MSG_ATTR_TYPE_MASK;
212 case OPTEE_MSG_ATTR_TYPE_NONE:
213 p->attr = TEE_PARAM_ATTR_TYPE_NONE;
214 memset(&p->u, 0, sizeof(p->u));
216 case OPTEE_MSG_ATTR_TYPE_VALUE_INPUT:
217 case OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT:
218 case OPTEE_MSG_ATTR_TYPE_VALUE_INOUT:
219 p->attr = TEE_PARAM_ATTR_TYPE_VALUE_INPUT + attr -
220 OPTEE_MSG_ATTR_TYPE_VALUE_INPUT;
221 p->u.value.a = mp->u.value.a;
222 p->u.value.b = mp->u.value.b;
223 p->u.value.c = mp->u.value.c;
225 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT:
226 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT:
227 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT:
228 p->attr = TEE_PARAM_ATTR_TYPE_MEMREF_INPUT + attr -
229 OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
230 p->u.memref.size = mp->u.rmem.size;
231 shm = (struct tee_shm *)(ulong)mp->u.rmem.shm_ref;
234 p->u.memref.shm_offs = 0;
235 p->u.memref.shm = NULL;
238 p->u.memref.shm_offs = mp->u.rmem.offs;
239 p->u.memref.shm = shm;
248 static void handle_rpc(struct udevice *dev, struct rpc_param *param,
253 switch (OPTEE_SMC_RETURN_GET_RPC_FUNC(param->a0)) {
254 case OPTEE_SMC_RPC_FUNC_ALLOC:
255 if (!__tee_shm_add(dev, OPTEE_MSG_NONCONTIG_PAGE_SIZE, NULL,
256 param->a1, TEE_SHM_ALLOC | TEE_SHM_REGISTER,
258 reg_pair_from_64(¶m->a1, ¶m->a2,
259 virt_to_phys(shm->addr));
261 reg_pair_from_64(¶m->a4, ¶m->a5, (ulong)shm);
269 case OPTEE_SMC_RPC_FUNC_FREE:
270 shm = reg_pair_to_ptr(param->a1, param->a2);
273 case OPTEE_SMC_RPC_FUNC_FOREIGN_INTR:
275 case OPTEE_SMC_RPC_FUNC_CMD:
276 shm = reg_pair_to_ptr(param->a1, param->a2);
277 optee_suppl_cmd(dev, shm, page_list);
283 param->a0 = OPTEE_SMC_CALL_RETURN_FROM_RPC;
286 static u32 call_err_to_res(u32 call_err)
289 case OPTEE_SMC_RETURN_OK:
292 return TEE_ERROR_BAD_PARAMETERS;
296 static u32 do_call_with_arg(struct udevice *dev, struct optee_msg_arg *arg)
298 struct optee_pdata *pdata = dev_get_platdata(dev);
299 struct rpc_param param = { .a0 = OPTEE_SMC_CALL_WITH_ARG };
300 void *page_list = NULL;
302 reg_pair_from_64(¶m.a1, ¶m.a2, virt_to_phys(arg));
304 struct arm_smccc_res res;
306 pdata->invoke_fn(param.a0, param.a1, param.a2, param.a3,
307 param.a4, param.a5, param.a6, param.a7, &res);
312 if (OPTEE_SMC_RETURN_IS_RPC(res.a0)) {
317 handle_rpc(dev, ¶m, &page_list);
320 * In case we've accessed RPMB to serve an RPC
321 * request we need to restore the previously
322 * selected partition as the caller may expect it
323 * to remain unchanged.
325 optee_suppl_rpmb_release(dev);
326 return call_err_to_res(res.a0);
331 static int optee_close_session(struct udevice *dev, u32 session)
335 struct optee_msg_arg *msg_arg;
337 rc = get_msg_arg(dev, 0, &shm, &msg_arg);
341 msg_arg->cmd = OPTEE_MSG_CMD_CLOSE_SESSION;
342 msg_arg->session = session;
343 do_call_with_arg(dev, msg_arg);
350 static int optee_open_session(struct udevice *dev,
351 struct tee_open_session_arg *arg,
352 uint num_params, struct tee_param *params)
356 struct optee_msg_arg *msg_arg;
358 rc = get_msg_arg(dev, num_params + 2, &shm, &msg_arg);
362 msg_arg->cmd = OPTEE_MSG_CMD_OPEN_SESSION;
364 * Initialize and add the meta parameters needed when opening a
367 msg_arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT |
369 msg_arg->params[1].attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT |
371 memcpy(&msg_arg->params[0].u.value, arg->uuid, sizeof(arg->uuid));
372 memcpy(&msg_arg->params[1].u.value, arg->uuid, sizeof(arg->clnt_uuid));
373 msg_arg->params[1].u.value.c = arg->clnt_login;
375 rc = to_msg_param(msg_arg->params + 2, num_params, params);
379 arg->ret = do_call_with_arg(dev, msg_arg);
381 arg->ret_origin = TEE_ORIGIN_COMMS;
385 if (from_msg_param(params, num_params, msg_arg->params + 2)) {
386 arg->ret = TEE_ERROR_COMMUNICATION;
387 arg->ret_origin = TEE_ORIGIN_COMMS;
388 /* Close session again to avoid leakage */
389 optee_close_session(dev, msg_arg->session);
393 arg->session = msg_arg->session;
394 arg->ret = msg_arg->ret;
395 arg->ret_origin = msg_arg->ret_origin;
402 static int optee_invoke_func(struct udevice *dev, struct tee_invoke_arg *arg,
403 uint num_params, struct tee_param *params)
406 struct optee_msg_arg *msg_arg;
409 rc = get_msg_arg(dev, num_params, &shm, &msg_arg);
412 msg_arg->cmd = OPTEE_MSG_CMD_INVOKE_COMMAND;
413 msg_arg->func = arg->func;
414 msg_arg->session = arg->session;
416 rc = to_msg_param(msg_arg->params, num_params, params);
420 arg->ret = do_call_with_arg(dev, msg_arg);
422 arg->ret_origin = TEE_ORIGIN_COMMS;
426 if (from_msg_param(params, num_params, msg_arg->params)) {
427 arg->ret = TEE_ERROR_COMMUNICATION;
428 arg->ret_origin = TEE_ORIGIN_COMMS;
432 arg->ret = msg_arg->ret;
433 arg->ret_origin = msg_arg->ret_origin;
439 static int optee_shm_register(struct udevice *dev, struct tee_shm *shm)
441 struct tee_shm *shm_arg;
442 struct optee_msg_arg *msg_arg;
447 rc = get_msg_arg(dev, 1, &shm_arg, &msg_arg);
451 pl = optee_alloc_and_init_page_list(shm->addr, shm->size, &ph_ptr);
457 msg_arg->cmd = OPTEE_MSG_CMD_REGISTER_SHM;
458 msg_arg->params->attr = OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT |
459 OPTEE_MSG_ATTR_NONCONTIG;
460 msg_arg->params->u.tmem.buf_ptr = ph_ptr;
461 msg_arg->params->u.tmem.shm_ref = (ulong)shm;
462 msg_arg->params->u.tmem.size = shm->size;
464 if (do_call_with_arg(dev, msg_arg) || msg_arg->ret)
469 tee_shm_free(shm_arg);
474 static int optee_shm_unregister(struct udevice *dev, struct tee_shm *shm)
476 struct tee_shm *shm_arg;
477 struct optee_msg_arg *msg_arg;
480 rc = get_msg_arg(dev, 1, &shm_arg, &msg_arg);
484 msg_arg->cmd = OPTEE_MSG_CMD_UNREGISTER_SHM;
485 msg_arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
486 msg_arg->params[0].u.rmem.shm_ref = (ulong)shm;
488 if (do_call_with_arg(dev, msg_arg) || msg_arg->ret)
490 tee_shm_free(shm_arg);
495 static const struct tee_driver_ops optee_ops = {
496 .get_version = optee_get_version,
497 .open_session = optee_open_session,
498 .close_session = optee_close_session,
499 .invoke_func = optee_invoke_func,
500 .shm_register = optee_shm_register,
501 .shm_unregister = optee_shm_unregister,
504 static bool is_optee_api(optee_invoke_fn *invoke_fn)
506 struct arm_smccc_res res;
508 invoke_fn(OPTEE_SMC_CALLS_UID, 0, 0, 0, 0, 0, 0, 0, &res);
510 return res.a0 == OPTEE_MSG_UID_0 && res.a1 == OPTEE_MSG_UID_1 &&
511 res.a2 == OPTEE_MSG_UID_2 && res.a3 == OPTEE_MSG_UID_3;
514 static void print_os_revision(optee_invoke_fn *invoke_fn)
517 struct arm_smccc_res smccc;
518 struct optee_smc_call_get_os_revision_result result;
525 invoke_fn(OPTEE_SMC_CALL_GET_OS_REVISION, 0, 0, 0, 0, 0, 0, 0,
528 if (res.result.build_id)
529 debug("OP-TEE revision %lu.%lu (%08lx)\n", res.result.major,
530 res.result.minor, res.result.build_id);
532 debug("OP-TEE revision %lu.%lu\n", res.result.major,
536 static bool api_revision_is_compatible(optee_invoke_fn *invoke_fn)
539 struct arm_smccc_res smccc;
540 struct optee_smc_calls_revision_result result;
543 invoke_fn(OPTEE_SMC_CALLS_REVISION, 0, 0, 0, 0, 0, 0, 0, &res.smccc);
545 return res.result.major == OPTEE_MSG_REVISION_MAJOR &&
546 (int)res.result.minor >= OPTEE_MSG_REVISION_MINOR;
549 static bool exchange_capabilities(optee_invoke_fn *invoke_fn, u32 *sec_caps)
552 struct arm_smccc_res smccc;
553 struct optee_smc_exchange_capabilities_result result;
556 invoke_fn(OPTEE_SMC_EXCHANGE_CAPABILITIES,
557 OPTEE_SMC_NSEC_CAP_UNIPROCESSOR, 0, 0, 0, 0, 0, 0,
560 if (res.result.status != OPTEE_SMC_RETURN_OK)
563 *sec_caps = res.result.capabilities;
568 /* Simple wrapper functions to be able to use a function pointer */
569 static void optee_smccc_smc(unsigned long a0, unsigned long a1,
570 unsigned long a2, unsigned long a3,
571 unsigned long a4, unsigned long a5,
572 unsigned long a6, unsigned long a7,
573 struct arm_smccc_res *res)
575 arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
578 static void optee_smccc_hvc(unsigned long a0, unsigned long a1,
579 unsigned long a2, unsigned long a3,
580 unsigned long a4, unsigned long a5,
581 unsigned long a6, unsigned long a7,
582 struct arm_smccc_res *res)
584 arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
587 static optee_invoke_fn *get_invoke_func(struct udevice *dev)
591 debug("optee: looking for conduit method in DT.\n");
592 method = ofnode_get_property(dev->node, "method", NULL);
594 debug("optee: missing \"method\" property\n");
595 return ERR_PTR(-ENXIO);
598 if (!strcmp("hvc", method))
599 return optee_smccc_hvc;
600 else if (!strcmp("smc", method))
601 return optee_smccc_smc;
603 debug("optee: invalid \"method\" property: %s\n", method);
604 return ERR_PTR(-EINVAL);
607 static int optee_ofdata_to_platdata(struct udevice *dev)
609 struct optee_pdata *pdata = dev_get_platdata(dev);
611 pdata->invoke_fn = get_invoke_func(dev);
612 if (IS_ERR(pdata->invoke_fn))
613 return PTR_ERR(pdata->invoke_fn);
618 static int optee_probe(struct udevice *dev)
620 struct optee_pdata *pdata = dev_get_platdata(dev);
623 if (!is_optee_api(pdata->invoke_fn)) {
624 debug("%s: OP-TEE api uid mismatch\n", __func__);
628 print_os_revision(pdata->invoke_fn);
630 if (!api_revision_is_compatible(pdata->invoke_fn)) {
631 debug("%s: OP-TEE api revision mismatch\n", __func__);
636 * OP-TEE can use both shared memory via predefined pool or as
637 * dynamic shared memory provided by normal world. To keep things
638 * simple we're only using dynamic shared memory in this driver.
640 if (!exchange_capabilities(pdata->invoke_fn, &sec_caps) ||
641 !(sec_caps & OPTEE_SMC_SEC_CAP_DYNAMIC_SHM)) {
642 debug("%s: OP-TEE capabilities mismatch\n", __func__);
649 static const struct udevice_id optee_match[] = {
650 { .compatible = "linaro,optee-tz" },
654 U_BOOT_DRIVER(optee) = {
657 .of_match = optee_match,
658 .ofdata_to_platdata = optee_ofdata_to_platdata,
659 .probe = optee_probe,
661 .platdata_auto_alloc_size = sizeof(struct optee_pdata),
662 .priv_auto_alloc_size = sizeof(struct optee_private),