1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2015, Linaro Limited
6 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
8 #include <linux/arm-smccc.h>
9 #include <linux/errno.h>
11 #include <linux/module.h>
13 #include <linux/of_platform.h>
14 #include <linux/platform_device.h>
15 #include <linux/slab.h>
16 #include <linux/string.h>
17 #include <linux/tee_drv.h>
18 #include <linux/types.h>
19 #include <linux/uaccess.h>
20 #include <linux/workqueue.h>
21 #include "optee_private.h"
22 #include "optee_smc.h"
25 #define DRIVER_NAME "optee"
27 #define OPTEE_SHM_NUM_PRIV_PAGES CONFIG_OPTEE_SHM_NUM_PRIV_PAGES
30 * optee_from_msg_param() - convert from OPTEE_MSG parameters to
32 * @params: subsystem internal parameter representation
33 * @num_params: number of elements in the parameter arrays
34 * @msg_params: OPTEE_MSG parameters
35 * Returns 0 on success or <0 on failure
37 int optee_from_msg_param(struct tee_param *params, size_t num_params,
38 const struct optee_msg_param *msg_params)
45 for (n = 0; n < num_params; n++) {
46 struct tee_param *p = params + n;
47 const struct optee_msg_param *mp = msg_params + n;
48 u32 attr = mp->attr & OPTEE_MSG_ATTR_TYPE_MASK;
51 case OPTEE_MSG_ATTR_TYPE_NONE:
52 p->attr = TEE_IOCTL_PARAM_ATTR_TYPE_NONE;
53 memset(&p->u, 0, sizeof(p->u));
55 case OPTEE_MSG_ATTR_TYPE_VALUE_INPUT:
56 case OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT:
57 case OPTEE_MSG_ATTR_TYPE_VALUE_INOUT:
58 p->attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT +
59 attr - OPTEE_MSG_ATTR_TYPE_VALUE_INPUT;
60 p->u.value.a = mp->u.value.a;
61 p->u.value.b = mp->u.value.b;
62 p->u.value.c = mp->u.value.c;
64 case OPTEE_MSG_ATTR_TYPE_TMEM_INPUT:
65 case OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT:
66 case OPTEE_MSG_ATTR_TYPE_TMEM_INOUT:
67 p->attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT +
68 attr - OPTEE_MSG_ATTR_TYPE_TMEM_INPUT;
69 p->u.memref.size = mp->u.tmem.size;
70 shm = (struct tee_shm *)(unsigned long)
73 p->u.memref.shm_offs = 0;
74 p->u.memref.shm = NULL;
77 rc = tee_shm_get_pa(shm, 0, &pa);
80 p->u.memref.shm_offs = mp->u.tmem.buf_ptr - pa;
81 p->u.memref.shm = shm;
83 case OPTEE_MSG_ATTR_TYPE_RMEM_INPUT:
84 case OPTEE_MSG_ATTR_TYPE_RMEM_OUTPUT:
85 case OPTEE_MSG_ATTR_TYPE_RMEM_INOUT:
86 p->attr = TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT +
87 attr - OPTEE_MSG_ATTR_TYPE_RMEM_INPUT;
88 p->u.memref.size = mp->u.rmem.size;
89 shm = (struct tee_shm *)(unsigned long)
93 p->u.memref.shm_offs = 0;
94 p->u.memref.shm = NULL;
97 p->u.memref.shm_offs = mp->u.rmem.offs;
98 p->u.memref.shm = shm;
109 static int to_msg_param_tmp_mem(struct optee_msg_param *mp,
110 const struct tee_param *p)
115 mp->attr = OPTEE_MSG_ATTR_TYPE_TMEM_INPUT + p->attr -
116 TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT;
118 mp->u.tmem.shm_ref = (unsigned long)p->u.memref.shm;
119 mp->u.tmem.size = p->u.memref.size;
121 if (!p->u.memref.shm) {
122 mp->u.tmem.buf_ptr = 0;
126 rc = tee_shm_get_pa(p->u.memref.shm, p->u.memref.shm_offs, &pa);
130 mp->u.tmem.buf_ptr = pa;
131 mp->attr |= OPTEE_MSG_ATTR_CACHE_PREDEFINED <<
132 OPTEE_MSG_ATTR_CACHE_SHIFT;
137 static int to_msg_param_reg_mem(struct optee_msg_param *mp,
138 const struct tee_param *p)
140 mp->attr = OPTEE_MSG_ATTR_TYPE_RMEM_INPUT + p->attr -
141 TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT;
143 mp->u.rmem.shm_ref = (unsigned long)p->u.memref.shm;
144 mp->u.rmem.size = p->u.memref.size;
145 mp->u.rmem.offs = p->u.memref.shm_offs;
150 * optee_to_msg_param() - convert from struct tee_params to OPTEE_MSG parameters
151 * @msg_params: OPTEE_MSG parameters
152 * @num_params: number of elements in the parameter arrays
153 * @params: subsystem itnernal parameter representation
154 * Returns 0 on success or <0 on failure
156 int optee_to_msg_param(struct optee_msg_param *msg_params, size_t num_params,
157 const struct tee_param *params)
162 for (n = 0; n < num_params; n++) {
163 const struct tee_param *p = params + n;
164 struct optee_msg_param *mp = msg_params + n;
167 case TEE_IOCTL_PARAM_ATTR_TYPE_NONE:
168 mp->attr = TEE_IOCTL_PARAM_ATTR_TYPE_NONE;
169 memset(&mp->u, 0, sizeof(mp->u));
171 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT:
172 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT:
173 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT:
174 mp->attr = OPTEE_MSG_ATTR_TYPE_VALUE_INPUT + p->attr -
175 TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT;
176 mp->u.value.a = p->u.value.a;
177 mp->u.value.b = p->u.value.b;
178 mp->u.value.c = p->u.value.c;
180 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT:
181 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
182 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT:
183 if (tee_shm_is_registered(p->u.memref.shm))
184 rc = to_msg_param_reg_mem(mp, p);
186 rc = to_msg_param_tmp_mem(mp, p);
197 static void optee_get_version(struct tee_device *teedev,
198 struct tee_ioctl_version_data *vers)
200 struct tee_ioctl_version_data v = {
201 .impl_id = TEE_IMPL_ID_OPTEE,
202 .impl_caps = TEE_OPTEE_CAP_TZ,
203 .gen_caps = TEE_GEN_CAP_GP,
205 struct optee *optee = tee_get_drvdata(teedev);
207 if (optee->sec_caps & OPTEE_SMC_SEC_CAP_DYNAMIC_SHM)
208 v.gen_caps |= TEE_GEN_CAP_REG_MEM;
209 if (optee->sec_caps & OPTEE_SMC_SEC_CAP_MEMREF_NULL)
210 v.gen_caps |= TEE_GEN_CAP_MEMREF_NULL;
214 static void optee_bus_scan(struct work_struct *work)
216 WARN_ON(optee_enumerate_devices(PTA_CMD_GET_DEVICES_SUPP));
219 static int optee_open(struct tee_context *ctx)
221 struct optee_context_data *ctxdata;
222 struct tee_device *teedev = ctx->teedev;
223 struct optee *optee = tee_get_drvdata(teedev);
225 ctxdata = kzalloc(sizeof(*ctxdata), GFP_KERNEL);
229 if (teedev == optee->supp_teedev) {
232 mutex_lock(&optee->supp.mutex);
233 if (!optee->supp.ctx) {
235 optee->supp.ctx = ctx;
237 mutex_unlock(&optee->supp.mutex);
243 if (!optee->scan_bus_done) {
244 INIT_WORK(&optee->scan_bus_work, optee_bus_scan);
245 optee->scan_bus_wq = create_workqueue("optee_bus_scan");
246 if (!optee->scan_bus_wq) {
250 queue_work(optee->scan_bus_wq, &optee->scan_bus_work);
251 optee->scan_bus_done = true;
254 mutex_init(&ctxdata->mutex);
255 INIT_LIST_HEAD(&ctxdata->sess_list);
257 if (optee->sec_caps & OPTEE_SMC_SEC_CAP_MEMREF_NULL)
258 ctx->cap_memref_null = true;
260 ctx->cap_memref_null = false;
266 static void optee_release(struct tee_context *ctx)
268 struct optee_context_data *ctxdata = ctx->data;
269 struct tee_device *teedev = ctx->teedev;
270 struct optee *optee = tee_get_drvdata(teedev);
272 struct optee_msg_arg *arg = NULL;
274 struct optee_session *sess;
275 struct optee_session *sess_tmp;
280 shm = tee_shm_alloc(ctx, sizeof(struct optee_msg_arg), TEE_SHM_MAPPED);
282 arg = tee_shm_get_va(shm, 0);
284 * If va2pa fails for some reason, we can't call into
285 * secure world, only free the memory. Secure OS will leak
286 * sessions and finally refuse more sessions, but we will
287 * at least let normal world reclaim its memory.
290 if (tee_shm_va2pa(shm, arg, &parg))
291 arg = NULL; /* prevent usage of parg below */
294 list_for_each_entry_safe(sess, sess_tmp, &ctxdata->sess_list,
296 list_del(&sess->list_node);
297 if (!IS_ERR_OR_NULL(arg)) {
298 memset(arg, 0, sizeof(*arg));
299 arg->cmd = OPTEE_MSG_CMD_CLOSE_SESSION;
300 arg->session = sess->session_id;
301 optee_do_call_with_arg(ctx, parg);
312 if (teedev == optee->supp_teedev) {
313 if (optee->scan_bus_wq) {
314 destroy_workqueue(optee->scan_bus_wq);
315 optee->scan_bus_wq = NULL;
317 optee_supp_release(&optee->supp);
321 static const struct tee_driver_ops optee_ops = {
322 .get_version = optee_get_version,
324 .release = optee_release,
325 .open_session = optee_open_session,
326 .close_session = optee_close_session,
327 .invoke_func = optee_invoke_func,
328 .cancel_req = optee_cancel_req,
329 .shm_register = optee_shm_register,
330 .shm_unregister = optee_shm_unregister,
333 static const struct tee_desc optee_desc = {
334 .name = DRIVER_NAME "-clnt",
336 .owner = THIS_MODULE,
339 static const struct tee_driver_ops optee_supp_ops = {
340 .get_version = optee_get_version,
342 .release = optee_release,
343 .supp_recv = optee_supp_recv,
344 .supp_send = optee_supp_send,
345 .shm_register = optee_shm_register_supp,
346 .shm_unregister = optee_shm_unregister_supp,
349 static const struct tee_desc optee_supp_desc = {
350 .name = DRIVER_NAME "-supp",
351 .ops = &optee_supp_ops,
352 .owner = THIS_MODULE,
353 .flags = TEE_DESC_PRIVILEGED,
356 static bool optee_msg_api_uid_is_optee_api(optee_invoke_fn *invoke_fn)
358 struct arm_smccc_res res;
360 invoke_fn(OPTEE_SMC_CALLS_UID, 0, 0, 0, 0, 0, 0, 0, &res);
362 if (res.a0 == OPTEE_MSG_UID_0 && res.a1 == OPTEE_MSG_UID_1 &&
363 res.a2 == OPTEE_MSG_UID_2 && res.a3 == OPTEE_MSG_UID_3)
368 static void optee_msg_get_os_revision(optee_invoke_fn *invoke_fn)
371 struct arm_smccc_res smccc;
372 struct optee_smc_call_get_os_revision_result result;
379 invoke_fn(OPTEE_SMC_CALL_GET_OS_REVISION, 0, 0, 0, 0, 0, 0, 0,
382 if (res.result.build_id)
383 pr_info("revision %lu.%lu (%08lx)", res.result.major,
384 res.result.minor, res.result.build_id);
386 pr_info("revision %lu.%lu", res.result.major, res.result.minor);
389 static bool optee_msg_api_revision_is_compatible(optee_invoke_fn *invoke_fn)
392 struct arm_smccc_res smccc;
393 struct optee_smc_calls_revision_result result;
396 invoke_fn(OPTEE_SMC_CALLS_REVISION, 0, 0, 0, 0, 0, 0, 0, &res.smccc);
398 if (res.result.major == OPTEE_MSG_REVISION_MAJOR &&
399 (int)res.result.minor >= OPTEE_MSG_REVISION_MINOR)
404 static bool optee_msg_exchange_capabilities(optee_invoke_fn *invoke_fn,
408 struct arm_smccc_res smccc;
409 struct optee_smc_exchange_capabilities_result result;
414 * TODO This isn't enough to tell if it's UP system (from kernel
415 * point of view) or not, is_smp() returns the the information
416 * needed, but can't be called directly from here.
418 if (!IS_ENABLED(CONFIG_SMP) || nr_cpu_ids == 1)
419 a1 |= OPTEE_SMC_NSEC_CAP_UNIPROCESSOR;
421 invoke_fn(OPTEE_SMC_EXCHANGE_CAPABILITIES, a1, 0, 0, 0, 0, 0, 0,
424 if (res.result.status != OPTEE_SMC_RETURN_OK)
427 *sec_caps = res.result.capabilities;
431 static struct tee_shm_pool *optee_config_dyn_shm(void)
433 struct tee_shm_pool_mgr *priv_mgr;
434 struct tee_shm_pool_mgr *dmabuf_mgr;
437 rc = optee_shm_pool_alloc_pages();
442 rc = optee_shm_pool_alloc_pages();
444 tee_shm_pool_mgr_destroy(priv_mgr);
449 rc = tee_shm_pool_alloc(priv_mgr, dmabuf_mgr);
451 tee_shm_pool_mgr_destroy(priv_mgr);
452 tee_shm_pool_mgr_destroy(dmabuf_mgr);
458 static struct tee_shm_pool *
459 optee_config_shm_memremap(optee_invoke_fn *invoke_fn, void **memremaped_shm)
462 struct arm_smccc_res smccc;
463 struct optee_smc_get_shm_config_result result;
471 struct tee_shm_pool_mgr *priv_mgr;
472 struct tee_shm_pool_mgr *dmabuf_mgr;
474 const int sz = OPTEE_SHM_NUM_PRIV_PAGES * PAGE_SIZE;
476 invoke_fn(OPTEE_SMC_GET_SHM_CONFIG, 0, 0, 0, 0, 0, 0, 0, &res.smccc);
477 if (res.result.status != OPTEE_SMC_RETURN_OK) {
478 pr_err("static shm service not available\n");
479 return ERR_PTR(-ENOENT);
482 if (res.result.settings != OPTEE_SMC_SHM_CACHED) {
483 pr_err("only normal cached shared memory supported\n");
484 return ERR_PTR(-EINVAL);
487 begin = roundup(res.result.start, PAGE_SIZE);
488 end = rounddown(res.result.start + res.result.size, PAGE_SIZE);
492 if (size < 2 * OPTEE_SHM_NUM_PRIV_PAGES * PAGE_SIZE) {
493 pr_err("too small shared memory area\n");
494 return ERR_PTR(-EINVAL);
497 va = memremap(paddr, size, MEMREMAP_WB);
499 pr_err("shared memory ioremap failed\n");
500 return ERR_PTR(-EINVAL);
502 vaddr = (unsigned long)va;
504 rc = tee_shm_pool_mgr_alloc_res_mem(vaddr, paddr, sz,
505 3 /* 8 bytes aligned */);
514 rc = tee_shm_pool_mgr_alloc_res_mem(vaddr, paddr, size, PAGE_SHIFT);
516 goto err_free_priv_mgr;
519 rc = tee_shm_pool_alloc(priv_mgr, dmabuf_mgr);
521 goto err_free_dmabuf_mgr;
523 *memremaped_shm = va;
528 tee_shm_pool_mgr_destroy(dmabuf_mgr);
530 tee_shm_pool_mgr_destroy(priv_mgr);
536 /* Simple wrapper functions to be able to use a function pointer */
537 static void optee_smccc_smc(unsigned long a0, unsigned long a1,
538 unsigned long a2, unsigned long a3,
539 unsigned long a4, unsigned long a5,
540 unsigned long a6, unsigned long a7,
541 struct arm_smccc_res *res)
543 arm_smccc_smc(a0, a1, a2, a3, a4, a5, a6, a7, res);
546 static void optee_smccc_hvc(unsigned long a0, unsigned long a1,
547 unsigned long a2, unsigned long a3,
548 unsigned long a4, unsigned long a5,
549 unsigned long a6, unsigned long a7,
550 struct arm_smccc_res *res)
552 arm_smccc_hvc(a0, a1, a2, a3, a4, a5, a6, a7, res);
555 static optee_invoke_fn *get_invoke_func(struct device *dev)
559 pr_info("probing for conduit method.\n");
561 if (device_property_read_string(dev, "method", &method)) {
562 pr_warn("missing \"method\" property\n");
563 return ERR_PTR(-ENXIO);
566 if (!strcmp("hvc", method))
567 return optee_smccc_hvc;
568 else if (!strcmp("smc", method))
569 return optee_smccc_smc;
571 pr_warn("invalid \"method\" property: %s\n", method);
572 return ERR_PTR(-EINVAL);
575 static int optee_remove(struct platform_device *pdev)
577 struct optee *optee = platform_get_drvdata(pdev);
580 * Ask OP-TEE to free all cached shared memory objects to decrease
581 * reference counters and also avoid wild pointers in secure world
582 * into the old shared memory range.
584 optee_disable_shm_cache(optee);
587 * The two devices have to be unregistered before we can free the
590 tee_device_unregister(optee->supp_teedev);
591 tee_device_unregister(optee->teedev);
593 tee_shm_pool_free(optee->pool);
594 if (optee->memremaped_shm)
595 memunmap(optee->memremaped_shm);
596 optee_wait_queue_exit(&optee->wait_queue);
597 optee_supp_uninit(&optee->supp);
598 mutex_destroy(&optee->call_queue.mutex);
605 static int optee_probe(struct platform_device *pdev)
607 optee_invoke_fn *invoke_fn;
608 struct tee_shm_pool *pool = ERR_PTR(-EINVAL);
609 struct optee *optee = NULL;
610 void *memremaped_shm = NULL;
611 struct tee_device *teedev;
615 invoke_fn = get_invoke_func(&pdev->dev);
616 if (IS_ERR(invoke_fn))
617 return PTR_ERR(invoke_fn);
619 if (!optee_msg_api_uid_is_optee_api(invoke_fn)) {
620 pr_warn("api uid mismatch\n");
624 optee_msg_get_os_revision(invoke_fn);
626 if (!optee_msg_api_revision_is_compatible(invoke_fn)) {
627 pr_warn("api revision mismatch\n");
631 if (!optee_msg_exchange_capabilities(invoke_fn, &sec_caps)) {
632 pr_warn("capabilities mismatch\n");
637 * Try to use dynamic shared memory if possible
639 if (sec_caps & OPTEE_SMC_SEC_CAP_DYNAMIC_SHM)
640 pool = optee_config_dyn_shm();
643 * If dynamic shared memory is not available or failed - try static one
645 if (IS_ERR(pool) && (sec_caps & OPTEE_SMC_SEC_CAP_HAVE_RESERVED_SHM))
646 pool = optee_config_shm_memremap(invoke_fn, &memremaped_shm);
649 return PTR_ERR(pool);
651 optee = kzalloc(sizeof(*optee), GFP_KERNEL);
657 optee->invoke_fn = invoke_fn;
658 optee->sec_caps = sec_caps;
660 teedev = tee_device_alloc(&optee_desc, NULL, pool, optee);
661 if (IS_ERR(teedev)) {
662 rc = PTR_ERR(teedev);
665 optee->teedev = teedev;
667 teedev = tee_device_alloc(&optee_supp_desc, NULL, pool, optee);
668 if (IS_ERR(teedev)) {
669 rc = PTR_ERR(teedev);
672 optee->supp_teedev = teedev;
674 rc = tee_device_register(optee->teedev);
678 rc = tee_device_register(optee->supp_teedev);
682 mutex_init(&optee->call_queue.mutex);
683 INIT_LIST_HEAD(&optee->call_queue.waiters);
684 optee_wait_queue_init(&optee->wait_queue);
685 optee_supp_init(&optee->supp);
686 optee->memremaped_shm = memremaped_shm;
689 optee_enable_shm_cache(optee);
691 if (optee->sec_caps & OPTEE_SMC_SEC_CAP_DYNAMIC_SHM)
692 pr_info("dynamic shared memory is enabled\n");
694 platform_set_drvdata(pdev, optee);
696 rc = optee_enumerate_devices(PTA_CMD_GET_DEVICES);
702 pr_info("initialized driver\n");
707 * tee_device_unregister() is safe to call even if the
708 * devices hasn't been registered with
709 * tee_device_register() yet.
711 tee_device_unregister(optee->supp_teedev);
712 tee_device_unregister(optee->teedev);
716 tee_shm_pool_free(pool);
718 memunmap(memremaped_shm);
722 static const struct of_device_id optee_dt_match[] = {
723 { .compatible = "linaro,optee-tz" },
726 MODULE_DEVICE_TABLE(of, optee_dt_match);
728 static struct platform_driver optee_driver = {
729 .probe = optee_probe,
730 .remove = optee_remove,
733 .of_match_table = optee_dt_match,
736 module_platform_driver(optee_driver);
738 MODULE_AUTHOR("Linaro");
739 MODULE_DESCRIPTION("OP-TEE driver");
740 MODULE_VERSION("1.0");
741 MODULE_LICENSE("GPL v2");
742 MODULE_ALIAS("platform:optee");