1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2018-2020 Linaro Limited
9 #include <dm/device_compat.h>
14 #include <linux/arm-smccc.h>
15 #include <linux/err.h>
18 #include "optee_smc.h"
19 #include "optee_msg.h"
20 #include "optee_private.h"
22 #define PAGELIST_ENTRIES_PER_PAGE \
23 ((OPTEE_MSG_NONCONTIG_PAGE_SIZE / sizeof(u64)) - 1)
25 typedef void (optee_invoke_fn)(unsigned long, unsigned long, unsigned long,
26 unsigned long, unsigned long, unsigned long,
27 unsigned long, unsigned long,
28 struct arm_smccc_res *);
31 optee_invoke_fn *invoke_fn;
46 * reg_pair_to_ptr() - Make a pointer of 2 32-bit values
47 * @reg0: High bits of the pointer
48 * @reg1: Low bits of the pointer
50 * Returns the combined result, note that if a pointer is 32-bit wide @reg0
53 static void *reg_pair_to_ptr(u32 reg0, u32 reg1)
55 return (void *)(ulong)(((u64)reg0 << 32) | reg1);
59 * reg_pair_from_64() - Split a 64-bit value into two 32-bit values
60 * @reg0: High bits of @val
61 * @reg1: Low bits of @val
62 * @val: The value to split
64 static void reg_pair_from_64(u32 *reg0, u32 *reg1, u64 val)
71 * optee_alloc_and_init_page_list() - Provide page list of memory buffer
72 * @buf: Start of buffer
73 * @len: Length of buffer
74 * @phys_buf_ptr Physical pointer with coded offset to page list
76 * Secure world doesn't share mapping with Normal world (U-Boot in this case)
77 * so physical pointers are needed when sharing pointers.
79 * Returns a pointer page list on success or NULL on failure
81 void *optee_alloc_and_init_page_list(void *buf, ulong len, u64 *phys_buf_ptr)
83 const unsigned int page_size = OPTEE_MSG_NONCONTIG_PAGE_SIZE;
84 const phys_addr_t page_mask = page_size - 1;
86 unsigned int page_offset;
87 unsigned int num_pages;
88 unsigned int list_size;
92 u64 pages_list[PAGELIST_ENTRIES_PER_PAGE];
97 * A Memory buffer is described in chunks of 4k. The list of
98 * physical addresses has to be represented by a physical pointer
99 * too and a single list has to start at a 4k page and fit into
100 * that page. In order to be able to describe large memory buffers
101 * these 4k pages carrying physical addresses are linked together
102 * in a list. See OPTEE_MSG_ATTR_NONCONTIG in
103 * drivers/tee/optee/optee_msg.h for more information.
106 page_offset = (ulong)buf & page_mask;
107 num_pages = roundup(page_offset + len, page_size) / page_size;
108 list_size = DIV_ROUND_UP(num_pages, PAGELIST_ENTRIES_PER_PAGE) *
110 page_list = memalign(page_size, list_size);
114 pages_data = page_list;
115 buf_base = (u8 *)rounddown((ulong)buf, page_size);
118 pages_data->pages_list[n] = virt_to_phys(buf_base);
120 buf_base += page_size;
123 if (n == PAGELIST_ENTRIES_PER_PAGE) {
124 pages_data->next_page_data =
125 virt_to_phys(pages_data + 1);
131 *phys_buf_ptr = virt_to_phys(page_list) | page_offset;
135 static void optee_get_version(struct udevice *dev,
136 struct tee_version_data *vers)
138 struct tee_version_data v = {
139 .gen_caps = TEE_GEN_CAP_GP | TEE_GEN_CAP_REG_MEM,
145 static int get_msg_arg(struct udevice *dev, uint num_params,
146 struct tee_shm **shmp, struct optee_msg_arg **msg_arg)
149 struct optee_msg_arg *ma;
151 rc = __tee_shm_add(dev, OPTEE_MSG_NONCONTIG_PAGE_SIZE, NULL,
152 OPTEE_MSG_GET_ARG_SIZE(num_params), TEE_SHM_ALLOC,
158 memset(ma, 0, OPTEE_MSG_GET_ARG_SIZE(num_params));
159 ma->num_params = num_params;
165 static int to_msg_param(struct optee_msg_param *msg_params, uint num_params,
166 const struct tee_param *params)
170 for (n = 0; n < num_params; n++) {
171 const struct tee_param *p = params + n;
172 struct optee_msg_param *mp = msg_params + n;
175 case TEE_PARAM_ATTR_TYPE_NONE:
176 mp->attr = OPTEE_MSG_ATTR_TYPE_NONE;
177 memset(&mp->u, 0, sizeof(mp->u));
179 case TEE_PARAM_ATTR_TYPE_VALUE_INPUT:
180 case TEE_PARAM_ATTR_TYPE_VALUE_OUTPUT:
181 case TEE_PARAM_ATTR_TYPE_VALUE_INOUT:
182 mp->attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT + p->attr -
183 TEE_PARAM_ATTR_TYPE_VALUE_INPUT;
184 mp->u.value.a = p->u.value.a;
185 mp->u.value.b = p->u.value.b;
186 mp->u.value.c = p->u.value.c;
188 case TEE_PARAM_ATTR_TYPE_MEMREF_INPUT:
189 case TEE_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
190 case TEE_PARAM_ATTR_TYPE_MEMREF_INOUT:
191 mp->attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT + p->attr -
192 TEE_PARAM_ATTR_TYPE_MEMREF_INPUT;
193 mp->u.rmem.shm_ref = (ulong)p->u.memref.shm;
194 mp->u.rmem.size = p->u.memref.size;
195 mp->u.rmem.offs = p->u.memref.shm_offs;
204 static int from_msg_param(struct tee_param *params, uint num_params,
205 const struct optee_msg_param *msg_params)
210 for (n = 0; n < num_params; n++) {
211 struct tee_param *p = params + n;
212 const struct optee_msg_param *mp = msg_params + n;
213 u32 attr = mp->attr & OPTEE_MSG_ATTR_TYPE_MASK;
216 case OPTEE_MSG_ATTR_TYPE_NONE:
217 p->attr = TEE_PARAM_ATTR_TYPE_NONE;
218 memset(&p->u, 0, sizeof(p->u));
220 case OPTEE_MSG_ATTR_TYPE_VALUE_INPUT:
221 case OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT:
222 case OPTEE_MSG_ATTR_TYPE_VALUE_INOUT:
223 p->attr = TEE_PARAM_ATTR_TYPE_VALUE_INPUT + attr -
224 OPTEE_MSG_ATTR_TYPE_VALUE_INPUT;
225 p->u.value.a = mp->u.value.a;
226 p->u.value.b = mp->u.value.b;
227 p->u.value.c = mp->u.value.c;
229 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT:
230 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT:
231 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT:
232 p->attr = TEE_PARAM_ATTR_TYPE_MEMREF_INPUT + attr -
233 OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
234 p->u.memref.size = mp->u.rmem.size;
235 shm = (struct tee_shm *)(ulong)mp->u.rmem.shm_ref;
238 p->u.memref.shm_offs = 0;
239 p->u.memref.shm = NULL;
242 p->u.memref.shm_offs = mp->u.rmem.offs;
243 p->u.memref.shm = shm;
252 static void handle_rpc(struct udevice *dev, struct rpc_param *param,
257 switch (OPTEE_SMC_RETURN_GET_RPC_FUNC(param->a0)) {
258 case OPTEE_SMC_RPC_FUNC_ALLOC:
259 if (!__tee_shm_add(dev, OPTEE_MSG_NONCONTIG_PAGE_SIZE, NULL,
260 param->a1, TEE_SHM_ALLOC | TEE_SHM_REGISTER,
262 reg_pair_from_64(¶m->a1, ¶m->a2,
263 virt_to_phys(shm->addr));
265 reg_pair_from_64(¶m->a4, ¶m->a5, (ulong)shm);
273 case OPTEE_SMC_RPC_FUNC_FREE:
274 shm = reg_pair_to_ptr(param->a1, param->a2);
277 case OPTEE_SMC_RPC_FUNC_FOREIGN_INTR:
279 case OPTEE_SMC_RPC_FUNC_CMD:
280 shm = reg_pair_to_ptr(param->a1, param->a2);
281 optee_suppl_cmd(dev, shm, page_list);
287 param->a0 = OPTEE_SMC_CALL_RETURN_FROM_RPC;
290 static u32 call_err_to_res(u32 call_err)
293 case OPTEE_SMC_RETURN_OK:
296 return TEE_ERROR_BAD_PARAMETERS;
300 static void flush_shm_dcache(struct udevice *dev, struct optee_msg_arg *arg)
302 size_t sz = OPTEE_MSG_GET_ARG_SIZE(arg->num_params);
304 flush_dcache_range(rounddown((ulong)arg, CONFIG_SYS_CACHELINE_SIZE),
305 roundup((ulong)arg + sz, CONFIG_SYS_CACHELINE_SIZE));
307 tee_flush_all_shm_dcache(dev);
310 static u32 do_call_with_arg(struct udevice *dev, struct optee_msg_arg *arg)
312 struct optee_pdata *pdata = dev_get_plat(dev);
313 struct rpc_param param = { .a0 = OPTEE_SMC_CALL_WITH_ARG };
314 void *page_list = NULL;
316 reg_pair_from_64(¶m.a1, ¶m.a2, virt_to_phys(arg));
318 struct arm_smccc_res res;
320 /* If cache are off from U-Boot, sync the cache shared with OP-TEE */
321 if (!dcache_status())
322 flush_shm_dcache(dev, arg);
324 pdata->invoke_fn(param.a0, param.a1, param.a2, param.a3,
325 param.a4, param.a5, param.a6, param.a7, &res);
327 /* If cache are off from U-Boot, sync the cache shared with OP-TEE */
328 if (!dcache_status())
329 flush_shm_dcache(dev, arg);
334 if (OPTEE_SMC_RETURN_IS_RPC(res.a0)) {
339 handle_rpc(dev, ¶m, &page_list);
342 * In case we've accessed RPMB to serve an RPC
343 * request we need to restore the previously
344 * selected partition as the caller may expect it
345 * to remain unchanged.
347 optee_suppl_rpmb_release(dev);
348 return call_err_to_res(res.a0);
353 static int optee_close_session(struct udevice *dev, u32 session)
357 struct optee_msg_arg *msg_arg;
359 rc = get_msg_arg(dev, 0, &shm, &msg_arg);
363 msg_arg->cmd = OPTEE_MSG_CMD_CLOSE_SESSION;
364 msg_arg->session = session;
365 do_call_with_arg(dev, msg_arg);
372 static int optee_open_session(struct udevice *dev,
373 struct tee_open_session_arg *arg,
374 uint num_params, struct tee_param *params)
378 struct optee_msg_arg *msg_arg;
380 rc = get_msg_arg(dev, num_params + 2, &shm, &msg_arg);
384 msg_arg->cmd = OPTEE_MSG_CMD_OPEN_SESSION;
386 * Initialize and add the meta parameters needed when opening a
389 msg_arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT |
391 msg_arg->params[1].attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT |
393 memcpy(&msg_arg->params[0].u.value, arg->uuid, sizeof(arg->uuid));
394 memcpy(&msg_arg->params[1].u.value, arg->uuid, sizeof(arg->clnt_uuid));
395 msg_arg->params[1].u.value.c = arg->clnt_login;
397 rc = to_msg_param(msg_arg->params + 2, num_params, params);
401 arg->ret = do_call_with_arg(dev, msg_arg);
403 arg->ret_origin = TEE_ORIGIN_COMMS;
407 if (from_msg_param(params, num_params, msg_arg->params + 2)) {
408 arg->ret = TEE_ERROR_COMMUNICATION;
409 arg->ret_origin = TEE_ORIGIN_COMMS;
410 /* Close session again to avoid leakage */
411 optee_close_session(dev, msg_arg->session);
415 arg->session = msg_arg->session;
416 arg->ret = msg_arg->ret;
417 arg->ret_origin = msg_arg->ret_origin;
424 static int optee_invoke_func(struct udevice *dev, struct tee_invoke_arg *arg,
425 uint num_params, struct tee_param *params)
428 struct optee_msg_arg *msg_arg;
431 rc = get_msg_arg(dev, num_params, &shm, &msg_arg);
434 msg_arg->cmd = OPTEE_MSG_CMD_INVOKE_COMMAND;
435 msg_arg->func = arg->func;
436 msg_arg->session = arg->session;
438 rc = to_msg_param(msg_arg->params, num_params, params);
442 arg->ret = do_call_with_arg(dev, msg_arg);
444 arg->ret_origin = TEE_ORIGIN_COMMS;
448 if (from_msg_param(params, num_params, msg_arg->params)) {
449 arg->ret = TEE_ERROR_COMMUNICATION;
450 arg->ret_origin = TEE_ORIGIN_COMMS;
454 arg->ret = msg_arg->ret;
455 arg->ret_origin = msg_arg->ret_origin;
461 static int optee_shm_register(struct udevice *dev, struct tee_shm *shm)
463 struct tee_shm *shm_arg;
464 struct optee_msg_arg *msg_arg;
469 rc = get_msg_arg(dev, 1, &shm_arg, &msg_arg);
473 pl = optee_alloc_and_init_page_list(shm->addr, shm->size, &ph_ptr);
479 msg_arg->cmd = OPTEE_MSG_CMD_REGISTER_SHM;
480 msg_arg->params->attr = OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT |
481 OPTEE_MSG_ATTR_NONCONTIG;
482 msg_arg->params->u.tmem.buf_ptr = ph_ptr;
483 msg_arg->params->u.tmem.shm_ref = (ulong)shm;
484 msg_arg->params->u.tmem.size = shm->size;
486 if (do_call_with_arg(dev, msg_arg) || msg_arg->ret)
491 tee_shm_free(shm_arg);
496 static int optee_shm_unregister(struct udevice *dev, struct tee_shm *shm)
498 struct tee_shm *shm_arg;
499 struct optee_msg_arg *msg_arg;
502 rc = get_msg_arg(dev, 1, &shm_arg, &msg_arg);
506 msg_arg->cmd = OPTEE_MSG_CMD_UNREGISTER_SHM;
507 msg_arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
508 msg_arg->params[0].u.rmem.shm_ref = (ulong)shm;
510 if (do_call_with_arg(dev, msg_arg) || msg_arg->ret)
512 tee_shm_free(shm_arg);
517 static const struct tee_driver_ops optee_ops = {
518 .get_version = optee_get_version,
519 .open_session = optee_open_session,
520 .close_session = optee_close_session,
521 .invoke_func = optee_invoke_func,
522 .shm_register = optee_shm_register,
523 .shm_unregister = optee_shm_unregister,
526 static bool is_optee_api(optee_invoke_fn *invoke_fn)
528 struct arm_smccc_res res;
530 invoke_fn(OPTEE_SMC_CALLS_UID, 0, 0, 0, 0, 0, 0, 0, &res);
532 return res.a0 == OPTEE_MSG_UID_0 && res.a1 == OPTEE_MSG_UID_1 &&
533 res.a2 == OPTEE_MSG_UID_2 && res.a3 == OPTEE_MSG_UID_3;
536 static void print_os_revision(struct udevice *dev, optee_invoke_fn *invoke_fn)
539 struct arm_smccc_res smccc;
540 struct optee_smc_call_get_os_revision_result result;
547 invoke_fn(OPTEE_SMC_CALL_GET_OS_REVISION, 0, 0, 0, 0, 0, 0, 0,
550 if (res.result.build_id)
551 dev_info(dev, "OP-TEE: revision %lu.%lu (%08lx)\n",
552 res.result.major, res.result.minor,
553 res.result.build_id);
555 dev_info(dev, "OP-TEE: revision %lu.%lu\n",
556 res.result.major, res.result.minor);
559 static bool api_revision_is_compatible(optee_invoke_fn *invoke_fn)
562 struct arm_smccc_res smccc;
563 struct optee_smc_calls_revision_result result;
566 invoke_fn(OPTEE_SMC_CALLS_REVISION, 0, 0, 0, 0, 0, 0, 0, &res.smccc);
568 return res.result.major == OPTEE_MSG_REVISION_MAJOR &&
569 (int)res.result.minor >= OPTEE_MSG_REVISION_MINOR;
572 static bool exchange_capabilities(optee_invoke_fn *invoke_fn, u32 *sec_caps)
575 struct arm_smccc_res smccc;
576 struct optee_smc_exchange_capabilities_result result;
579 invoke_fn(OPTEE_SMC_EXCHANGE_CAPABILITIES,
580 OPTEE_SMC_NSEC_CAP_UNIPROCESSOR, 0, 0, 0, 0, 0, 0,
583 if (res.result.status != OPTEE_SMC_RETURN_OK)
586 *sec_caps = res.result.capabilities;
591 /* Simple wrapper functions to be able to use a function pointer */
592 static void optee_smccc_smc(unsigned long a0, unsigned long a1,
593 unsigned long a2, unsigned long a3,
594 unsigned long a4, unsigned long a5,
595 unsigned long a6, unsigned long a7,
596 struct arm_smccc_res *res)
598 arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
601 static void optee_smccc_hvc(unsigned long a0, unsigned long a1,
602 unsigned long a2, unsigned long a3,
603 unsigned long a4, unsigned long a5,
604 unsigned long a6, unsigned long a7,
605 struct arm_smccc_res *res)
607 arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
610 static optee_invoke_fn *get_invoke_func(struct udevice *dev)
614 debug("optee: looking for conduit method in DT.\n");
615 method = ofnode_get_property(dev_ofnode(dev), "method", NULL);
617 debug("optee: missing \"method\" property\n");
618 return ERR_PTR(-ENXIO);
621 if (!strcmp("hvc", method))
622 return optee_smccc_hvc;
623 else if (!strcmp("smc", method))
624 return optee_smccc_smc;
626 debug("optee: invalid \"method\" property: %s\n", method);
627 return ERR_PTR(-EINVAL);
630 static int optee_of_to_plat(struct udevice *dev)
632 struct optee_pdata *pdata = dev_get_plat(dev);
634 pdata->invoke_fn = get_invoke_func(dev);
635 if (IS_ERR(pdata->invoke_fn))
636 return PTR_ERR(pdata->invoke_fn);
641 static int optee_probe(struct udevice *dev)
643 struct optee_pdata *pdata = dev_get_plat(dev);
647 if (!is_optee_api(pdata->invoke_fn)) {
648 dev_err(dev, "OP-TEE api uid mismatch\n");
652 print_os_revision(dev, pdata->invoke_fn);
654 if (!api_revision_is_compatible(pdata->invoke_fn)) {
655 dev_err(dev, "OP-TEE api revision mismatch\n");
660 * OP-TEE can use both shared memory via predefined pool or as
661 * dynamic shared memory provided by normal world. To keep things
662 * simple we're only using dynamic shared memory in this driver.
664 if (!exchange_capabilities(pdata->invoke_fn, &sec_caps) ||
665 !(sec_caps & OPTEE_SMC_SEC_CAP_DYNAMIC_SHM)) {
666 dev_err(dev, "OP-TEE capabilities mismatch\n");
671 * in U-Boot, the discovery of TA on the TEE bus is not supported:
672 * only bind the drivers associated to the supported OP-TEE TA
674 if (IS_ENABLED(CONFIG_RNG_OPTEE)) {
675 ret = device_bind_driver(dev, "optee-rng", "optee-rng", NULL);
683 static const struct udevice_id optee_match[] = {
684 { .compatible = "linaro,optee-tz" },
688 U_BOOT_DRIVER(optee) = {
691 .of_match = optee_match,
692 .of_to_plat = optee_of_to_plat,
693 .probe = optee_probe,
695 .plat_auto = sizeof(struct optee_pdata),
696 .priv_auto = sizeof(struct optee_private),