1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2018 Linaro Limited
8 #include <dm/device_compat.h>
12 #include <linux/arm-smccc.h>
13 #include <linux/err.h>
16 #include "optee_smc.h"
17 #include "optee_msg.h"
18 #include "optee_private.h"
20 #define PAGELIST_ENTRIES_PER_PAGE \
21 ((OPTEE_MSG_NONCONTIG_PAGE_SIZE / sizeof(u64)) - 1)
23 typedef void (optee_invoke_fn)(unsigned long, unsigned long, unsigned long,
24 unsigned long, unsigned long, unsigned long,
25 unsigned long, unsigned long,
26 struct arm_smccc_res *);
29 optee_invoke_fn *invoke_fn;
44 * reg_pair_to_ptr() - Make a pointer of 2 32-bit values
45 * @reg0: High bits of the pointer
46 * @reg1: Low bits of the pointer
48 * Returns the combined result, note that if a pointer is 32-bit wide @reg0
51 static void *reg_pair_to_ptr(u32 reg0, u32 reg1)
53 return (void *)(ulong)(((u64)reg0 << 32) | reg1);
57 * reg_pair_from_64() - Split a 64-bit value into two 32-bit values
58 * @reg0: High bits of @val
59 * @reg1: Low bits of @val
60 * @val: The value to split
62 static void reg_pair_from_64(u32 *reg0, u32 *reg1, u64 val)
69 * optee_alloc_and_init_page_list() - Provide page list of memory buffer
70 * @buf: Start of buffer
71 * @len: Length of buffer
72 * @phys_buf_ptr Physical pointer with coded offset to page list
74 * Secure world doesn't share mapping with Normal world (U-Boot in this case)
75 * so physical pointers are needed when sharing pointers.
77 * Returns a pointer page list on success or NULL on failure
79 void *optee_alloc_and_init_page_list(void *buf, ulong len, u64 *phys_buf_ptr)
81 const unsigned int page_size = OPTEE_MSG_NONCONTIG_PAGE_SIZE;
82 const phys_addr_t page_mask = page_size - 1;
84 unsigned int page_offset;
85 unsigned int num_pages;
86 unsigned int list_size;
90 u64 pages_list[PAGELIST_ENTRIES_PER_PAGE];
95 * A Memory buffer is described in chunks of 4k. The list of
96 * physical addresses has to be represented by a physical pointer
97 * too and a single list has to start at a 4k page and fit into
98 * that page. In order to be able to describe large memory buffers
99 * these 4k pages carrying physical addresses are linked together
100 * in a list. See OPTEE_MSG_ATTR_NONCONTIG in
101 * drivers/tee/optee/optee_msg.h for more information.
104 page_offset = (ulong)buf & page_mask;
105 num_pages = roundup(page_offset + len, page_size) / page_size;
106 list_size = DIV_ROUND_UP(num_pages, PAGELIST_ENTRIES_PER_PAGE) *
108 page_list = memalign(page_size, list_size);
112 pages_data = page_list;
113 buf_base = (u8 *)rounddown((ulong)buf, page_size);
116 pages_data->pages_list[n] = virt_to_phys(buf_base);
118 buf_base += page_size;
121 if (n == PAGELIST_ENTRIES_PER_PAGE) {
122 pages_data->next_page_data =
123 virt_to_phys(pages_data + 1);
129 *phys_buf_ptr = virt_to_phys(page_list) | page_offset;
133 static void optee_get_version(struct udevice *dev,
134 struct tee_version_data *vers)
136 struct tee_version_data v = {
137 .gen_caps = TEE_GEN_CAP_GP | TEE_GEN_CAP_REG_MEM,
143 static int get_msg_arg(struct udevice *dev, uint num_params,
144 struct tee_shm **shmp, struct optee_msg_arg **msg_arg)
147 struct optee_msg_arg *ma;
149 rc = __tee_shm_add(dev, OPTEE_MSG_NONCONTIG_PAGE_SIZE, NULL,
150 OPTEE_MSG_GET_ARG_SIZE(num_params), TEE_SHM_ALLOC,
156 memset(ma, 0, OPTEE_MSG_GET_ARG_SIZE(num_params));
157 ma->num_params = num_params;
163 static int to_msg_param(struct optee_msg_param *msg_params, uint num_params,
164 const struct tee_param *params)
168 for (n = 0; n < num_params; n++) {
169 const struct tee_param *p = params + n;
170 struct optee_msg_param *mp = msg_params + n;
173 case TEE_PARAM_ATTR_TYPE_NONE:
174 mp->attr = OPTEE_MSG_ATTR_TYPE_NONE;
175 memset(&mp->u, 0, sizeof(mp->u));
177 case TEE_PARAM_ATTR_TYPE_VALUE_INPUT:
178 case TEE_PARAM_ATTR_TYPE_VALUE_OUTPUT:
179 case TEE_PARAM_ATTR_TYPE_VALUE_INOUT:
180 mp->attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT + p->attr -
181 TEE_PARAM_ATTR_TYPE_VALUE_INPUT;
182 mp->u.value.a = p->u.value.a;
183 mp->u.value.b = p->u.value.b;
184 mp->u.value.c = p->u.value.c;
186 case TEE_PARAM_ATTR_TYPE_MEMREF_INPUT:
187 case TEE_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
188 case TEE_PARAM_ATTR_TYPE_MEMREF_INOUT:
189 mp->attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT + p->attr -
190 TEE_PARAM_ATTR_TYPE_MEMREF_INPUT;
191 mp->u.rmem.shm_ref = (ulong)p->u.memref.shm;
192 mp->u.rmem.size = p->u.memref.size;
193 mp->u.rmem.offs = p->u.memref.shm_offs;
202 static int from_msg_param(struct tee_param *params, uint num_params,
203 const struct optee_msg_param *msg_params)
208 for (n = 0; n < num_params; n++) {
209 struct tee_param *p = params + n;
210 const struct optee_msg_param *mp = msg_params + n;
211 u32 attr = mp->attr & OPTEE_MSG_ATTR_TYPE_MASK;
214 case OPTEE_MSG_ATTR_TYPE_NONE:
215 p->attr = TEE_PARAM_ATTR_TYPE_NONE;
216 memset(&p->u, 0, sizeof(p->u));
218 case OPTEE_MSG_ATTR_TYPE_VALUE_INPUT:
219 case OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT:
220 case OPTEE_MSG_ATTR_TYPE_VALUE_INOUT:
221 p->attr = TEE_PARAM_ATTR_TYPE_VALUE_INPUT + attr -
222 OPTEE_MSG_ATTR_TYPE_VALUE_INPUT;
223 p->u.value.a = mp->u.value.a;
224 p->u.value.b = mp->u.value.b;
225 p->u.value.c = mp->u.value.c;
227 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT:
228 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT:
229 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT:
230 p->attr = TEE_PARAM_ATTR_TYPE_MEMREF_INPUT + attr -
231 OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
232 p->u.memref.size = mp->u.rmem.size;
233 shm = (struct tee_shm *)(ulong)mp->u.rmem.shm_ref;
236 p->u.memref.shm_offs = 0;
237 p->u.memref.shm = NULL;
240 p->u.memref.shm_offs = mp->u.rmem.offs;
241 p->u.memref.shm = shm;
250 static void handle_rpc(struct udevice *dev, struct rpc_param *param,
255 switch (OPTEE_SMC_RETURN_GET_RPC_FUNC(param->a0)) {
256 case OPTEE_SMC_RPC_FUNC_ALLOC:
257 if (!__tee_shm_add(dev, OPTEE_MSG_NONCONTIG_PAGE_SIZE, NULL,
258 param->a1, TEE_SHM_ALLOC | TEE_SHM_REGISTER,
260 reg_pair_from_64(¶m->a1, ¶m->a2,
261 virt_to_phys(shm->addr));
263 reg_pair_from_64(¶m->a4, ¶m->a5, (ulong)shm);
271 case OPTEE_SMC_RPC_FUNC_FREE:
272 shm = reg_pair_to_ptr(param->a1, param->a2);
275 case OPTEE_SMC_RPC_FUNC_FOREIGN_INTR:
277 case OPTEE_SMC_RPC_FUNC_CMD:
278 shm = reg_pair_to_ptr(param->a1, param->a2);
279 optee_suppl_cmd(dev, shm, page_list);
285 param->a0 = OPTEE_SMC_CALL_RETURN_FROM_RPC;
288 static u32 call_err_to_res(u32 call_err)
291 case OPTEE_SMC_RETURN_OK:
294 return TEE_ERROR_BAD_PARAMETERS;
298 static u32 do_call_with_arg(struct udevice *dev, struct optee_msg_arg *arg)
300 struct optee_pdata *pdata = dev_get_platdata(dev);
301 struct rpc_param param = { .a0 = OPTEE_SMC_CALL_WITH_ARG };
302 void *page_list = NULL;
304 reg_pair_from_64(¶m.a1, ¶m.a2, virt_to_phys(arg));
306 struct arm_smccc_res res;
308 pdata->invoke_fn(param.a0, param.a1, param.a2, param.a3,
309 param.a4, param.a5, param.a6, param.a7, &res);
314 if (OPTEE_SMC_RETURN_IS_RPC(res.a0)) {
319 handle_rpc(dev, ¶m, &page_list);
322 * In case we've accessed RPMB to serve an RPC
323 * request we need to restore the previously
324 * selected partition as the caller may expect it
325 * to remain unchanged.
327 optee_suppl_rpmb_release(dev);
328 return call_err_to_res(res.a0);
333 static int optee_close_session(struct udevice *dev, u32 session)
337 struct optee_msg_arg *msg_arg;
339 rc = get_msg_arg(dev, 0, &shm, &msg_arg);
343 msg_arg->cmd = OPTEE_MSG_CMD_CLOSE_SESSION;
344 msg_arg->session = session;
345 do_call_with_arg(dev, msg_arg);
352 static int optee_open_session(struct udevice *dev,
353 struct tee_open_session_arg *arg,
354 uint num_params, struct tee_param *params)
358 struct optee_msg_arg *msg_arg;
360 rc = get_msg_arg(dev, num_params + 2, &shm, &msg_arg);
364 msg_arg->cmd = OPTEE_MSG_CMD_OPEN_SESSION;
366 * Initialize and add the meta parameters needed when opening a
369 msg_arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT |
371 msg_arg->params[1].attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT |
373 memcpy(&msg_arg->params[0].u.value, arg->uuid, sizeof(arg->uuid));
374 memcpy(&msg_arg->params[1].u.value, arg->uuid, sizeof(arg->clnt_uuid));
375 msg_arg->params[1].u.value.c = arg->clnt_login;
377 rc = to_msg_param(msg_arg->params + 2, num_params, params);
381 arg->ret = do_call_with_arg(dev, msg_arg);
383 arg->ret_origin = TEE_ORIGIN_COMMS;
387 if (from_msg_param(params, num_params, msg_arg->params + 2)) {
388 arg->ret = TEE_ERROR_COMMUNICATION;
389 arg->ret_origin = TEE_ORIGIN_COMMS;
390 /* Close session again to avoid leakage */
391 optee_close_session(dev, msg_arg->session);
395 arg->session = msg_arg->session;
396 arg->ret = msg_arg->ret;
397 arg->ret_origin = msg_arg->ret_origin;
404 static int optee_invoke_func(struct udevice *dev, struct tee_invoke_arg *arg,
405 uint num_params, struct tee_param *params)
408 struct optee_msg_arg *msg_arg;
411 rc = get_msg_arg(dev, num_params, &shm, &msg_arg);
414 msg_arg->cmd = OPTEE_MSG_CMD_INVOKE_COMMAND;
415 msg_arg->func = arg->func;
416 msg_arg->session = arg->session;
418 rc = to_msg_param(msg_arg->params, num_params, params);
422 arg->ret = do_call_with_arg(dev, msg_arg);
424 arg->ret_origin = TEE_ORIGIN_COMMS;
428 if (from_msg_param(params, num_params, msg_arg->params)) {
429 arg->ret = TEE_ERROR_COMMUNICATION;
430 arg->ret_origin = TEE_ORIGIN_COMMS;
434 arg->ret = msg_arg->ret;
435 arg->ret_origin = msg_arg->ret_origin;
441 static int optee_shm_register(struct udevice *dev, struct tee_shm *shm)
443 struct tee_shm *shm_arg;
444 struct optee_msg_arg *msg_arg;
449 rc = get_msg_arg(dev, 1, &shm_arg, &msg_arg);
453 pl = optee_alloc_and_init_page_list(shm->addr, shm->size, &ph_ptr);
459 msg_arg->cmd = OPTEE_MSG_CMD_REGISTER_SHM;
460 msg_arg->params->attr = OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT |
461 OPTEE_MSG_ATTR_NONCONTIG;
462 msg_arg->params->u.tmem.buf_ptr = ph_ptr;
463 msg_arg->params->u.tmem.shm_ref = (ulong)shm;
464 msg_arg->params->u.tmem.size = shm->size;
466 if (do_call_with_arg(dev, msg_arg) || msg_arg->ret)
471 tee_shm_free(shm_arg);
476 static int optee_shm_unregister(struct udevice *dev, struct tee_shm *shm)
478 struct tee_shm *shm_arg;
479 struct optee_msg_arg *msg_arg;
482 rc = get_msg_arg(dev, 1, &shm_arg, &msg_arg);
486 msg_arg->cmd = OPTEE_MSG_CMD_UNREGISTER_SHM;
487 msg_arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
488 msg_arg->params[0].u.rmem.shm_ref = (ulong)shm;
490 if (do_call_with_arg(dev, msg_arg) || msg_arg->ret)
492 tee_shm_free(shm_arg);
497 static const struct tee_driver_ops optee_ops = {
498 .get_version = optee_get_version,
499 .open_session = optee_open_session,
500 .close_session = optee_close_session,
501 .invoke_func = optee_invoke_func,
502 .shm_register = optee_shm_register,
503 .shm_unregister = optee_shm_unregister,
506 static bool is_optee_api(optee_invoke_fn *invoke_fn)
508 struct arm_smccc_res res;
510 invoke_fn(OPTEE_SMC_CALLS_UID, 0, 0, 0, 0, 0, 0, 0, &res);
512 return res.a0 == OPTEE_MSG_UID_0 && res.a1 == OPTEE_MSG_UID_1 &&
513 res.a2 == OPTEE_MSG_UID_2 && res.a3 == OPTEE_MSG_UID_3;
516 static void print_os_revision(struct udevice *dev, optee_invoke_fn *invoke_fn)
519 struct arm_smccc_res smccc;
520 struct optee_smc_call_get_os_revision_result result;
527 invoke_fn(OPTEE_SMC_CALL_GET_OS_REVISION, 0, 0, 0, 0, 0, 0, 0,
530 if (res.result.build_id)
531 dev_info(dev, "OP-TEE: revision %lu.%lu (%08lx)\n",
532 res.result.major, res.result.minor,
533 res.result.build_id);
535 dev_info(dev, "OP-TEE: revision %lu.%lu\n",
536 res.result.major, res.result.minor);
539 static bool api_revision_is_compatible(optee_invoke_fn *invoke_fn)
542 struct arm_smccc_res smccc;
543 struct optee_smc_calls_revision_result result;
546 invoke_fn(OPTEE_SMC_CALLS_REVISION, 0, 0, 0, 0, 0, 0, 0, &res.smccc);
548 return res.result.major == OPTEE_MSG_REVISION_MAJOR &&
549 (int)res.result.minor >= OPTEE_MSG_REVISION_MINOR;
552 static bool exchange_capabilities(optee_invoke_fn *invoke_fn, u32 *sec_caps)
555 struct arm_smccc_res smccc;
556 struct optee_smc_exchange_capabilities_result result;
559 invoke_fn(OPTEE_SMC_EXCHANGE_CAPABILITIES,
560 OPTEE_SMC_NSEC_CAP_UNIPROCESSOR, 0, 0, 0, 0, 0, 0,
563 if (res.result.status != OPTEE_SMC_RETURN_OK)
566 *sec_caps = res.result.capabilities;
571 /* Simple wrapper functions to be able to use a function pointer */
572 static void optee_smccc_smc(unsigned long a0, unsigned long a1,
573 unsigned long a2, unsigned long a3,
574 unsigned long a4, unsigned long a5,
575 unsigned long a6, unsigned long a7,
576 struct arm_smccc_res *res)
578 arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
581 static void optee_smccc_hvc(unsigned long a0, unsigned long a1,
582 unsigned long a2, unsigned long a3,
583 unsigned long a4, unsigned long a5,
584 unsigned long a6, unsigned long a7,
585 struct arm_smccc_res *res)
587 arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
590 static optee_invoke_fn *get_invoke_func(struct udevice *dev)
594 debug("optee: looking for conduit method in DT.\n");
595 method = ofnode_get_property(dev->node, "method", NULL);
597 debug("optee: missing \"method\" property\n");
598 return ERR_PTR(-ENXIO);
601 if (!strcmp("hvc", method))
602 return optee_smccc_hvc;
603 else if (!strcmp("smc", method))
604 return optee_smccc_smc;
606 debug("optee: invalid \"method\" property: %s\n", method);
607 return ERR_PTR(-EINVAL);
610 static int optee_ofdata_to_platdata(struct udevice *dev)
612 struct optee_pdata *pdata = dev_get_platdata(dev);
614 pdata->invoke_fn = get_invoke_func(dev);
615 if (IS_ERR(pdata->invoke_fn))
616 return PTR_ERR(pdata->invoke_fn);
621 static int optee_probe(struct udevice *dev)
623 struct optee_pdata *pdata = dev_get_platdata(dev);
626 if (!is_optee_api(pdata->invoke_fn)) {
627 debug("%s: OP-TEE api uid mismatch\n", __func__);
631 print_os_revision(dev, pdata->invoke_fn);
633 if (!api_revision_is_compatible(pdata->invoke_fn)) {
634 debug("%s: OP-TEE api revision mismatch\n", __func__);
639 * OP-TEE can use both shared memory via predefined pool or as
640 * dynamic shared memory provided by normal world. To keep things
641 * simple we're only using dynamic shared memory in this driver.
643 if (!exchange_capabilities(pdata->invoke_fn, &sec_caps) ||
644 !(sec_caps & OPTEE_SMC_SEC_CAP_DYNAMIC_SHM)) {
645 debug("%s: OP-TEE capabilities mismatch\n", __func__);
652 static const struct udevice_id optee_match[] = {
653 { .compatible = "linaro,optee-tz" },
657 U_BOOT_DRIVER(optee) = {
660 .of_match = optee_match,
661 .ofdata_to_platdata = optee_ofdata_to_platdata,
662 .probe = optee_probe,
664 .platdata_auto = sizeof(struct optee_pdata),
665 .priv_auto = sizeof(struct optee_private),