2 * Copyright (c) 2015-2016, Linaro Limited
4 * This software is licensed under the terms of the GNU General Public
5 * License version 2, as published by the Free Software Foundation, and
6 * may be copied, distributed, and modified under those terms.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
15 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
17 #include <linux/delay.h>
18 #include <linux/device.h>
19 #include <linux/slab.h>
20 #include <linux/tee_drv.h>
21 #include "optee_private.h"
22 #include "optee_smc.h"
25 struct list_head link;
30 void optee_wait_queue_init(struct optee_wait_queue *priv)
32 mutex_init(&priv->mu);
33 INIT_LIST_HEAD(&priv->db);
36 void optee_wait_queue_exit(struct optee_wait_queue *priv)
38 mutex_destroy(&priv->mu);
41 static void handle_rpc_func_cmd_get_time(struct optee_msg_arg *arg)
45 if (arg->num_params != 1)
47 if ((arg->params[0].attr & OPTEE_MSG_ATTR_TYPE_MASK) !=
48 OPTEE_MSG_ATTR_TYPE_VALUE_OUTPUT)
51 ktime_get_real_ts64(&ts);
52 arg->params[0].u.value.a = ts.tv_sec;
53 arg->params[0].u.value.b = ts.tv_nsec;
55 arg->ret = TEEC_SUCCESS;
58 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
61 static struct wq_entry *wq_entry_get(struct optee_wait_queue *wq, u32 key)
67 list_for_each_entry(w, &wq->db, link)
71 w = kmalloc(sizeof(*w), GFP_KERNEL);
73 init_completion(&w->c);
75 list_add_tail(&w->link, &wq->db);
78 mutex_unlock(&wq->mu);
82 static void wq_sleep(struct optee_wait_queue *wq, u32 key)
84 struct wq_entry *w = wq_entry_get(wq, key);
87 wait_for_completion(&w->c);
90 mutex_unlock(&wq->mu);
95 static void wq_wakeup(struct optee_wait_queue *wq, u32 key)
97 struct wq_entry *w = wq_entry_get(wq, key);
103 static void handle_rpc_func_cmd_wq(struct optee *optee,
104 struct optee_msg_arg *arg)
106 if (arg->num_params != 1)
109 if ((arg->params[0].attr & OPTEE_MSG_ATTR_TYPE_MASK) !=
110 OPTEE_MSG_ATTR_TYPE_VALUE_INPUT)
113 switch (arg->params[0].u.value.a) {
114 case OPTEE_MSG_RPC_WAIT_QUEUE_SLEEP:
115 wq_sleep(&optee->wait_queue, arg->params[0].u.value.b);
117 case OPTEE_MSG_RPC_WAIT_QUEUE_WAKEUP:
118 wq_wakeup(&optee->wait_queue, arg->params[0].u.value.b);
124 arg->ret = TEEC_SUCCESS;
127 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
130 static void handle_rpc_func_cmd_wait(struct optee_msg_arg *arg)
134 if (arg->num_params != 1)
137 if ((arg->params[0].attr & OPTEE_MSG_ATTR_TYPE_MASK) !=
138 OPTEE_MSG_ATTR_TYPE_VALUE_INPUT)
141 msec_to_wait = arg->params[0].u.value.a;
143 /* Go to interruptible sleep */
144 msleep_interruptible(msec_to_wait);
146 arg->ret = TEEC_SUCCESS;
149 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
152 static void handle_rpc_supp_cmd(struct tee_context *ctx,
153 struct optee_msg_arg *arg)
155 struct tee_param *params;
157 arg->ret_origin = TEEC_ORIGIN_COMMS;
159 params = kmalloc_array(arg->num_params, sizeof(struct tee_param),
162 arg->ret = TEEC_ERROR_OUT_OF_MEMORY;
166 if (optee_from_msg_param(params, arg->num_params, arg->params)) {
167 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
171 arg->ret = optee_supp_thrd_req(ctx, arg->cmd, arg->num_params, params);
173 if (optee_to_msg_param(arg->params, arg->num_params, params))
174 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
179 static struct tee_shm *cmd_alloc_suppl(struct tee_context *ctx, size_t sz)
182 struct tee_param param;
183 struct optee *optee = tee_get_drvdata(ctx->teedev);
186 param.attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT;
187 param.u.value.a = OPTEE_MSG_RPC_SHM_TYPE_APPL;
188 param.u.value.b = sz;
191 ret = optee_supp_thrd_req(ctx, OPTEE_MSG_RPC_CMD_SHM_ALLOC, 1, ¶m);
193 return ERR_PTR(-ENOMEM);
195 mutex_lock(&optee->supp.mutex);
196 /* Increases count as secure world doesn't have a reference */
197 shm = tee_shm_get_from_id(optee->supp.ctx, param.u.value.c);
198 mutex_unlock(&optee->supp.mutex);
202 static void handle_rpc_func_cmd_shm_alloc(struct tee_context *ctx,
203 struct optee_msg_arg *arg,
204 struct optee_call_ctx *call_ctx)
211 arg->ret_origin = TEEC_ORIGIN_COMMS;
213 if (!arg->num_params ||
214 arg->params[0].attr != OPTEE_MSG_ATTR_TYPE_VALUE_INPUT) {
215 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
219 for (n = 1; n < arg->num_params; n++) {
220 if (arg->params[n].attr != OPTEE_MSG_ATTR_TYPE_NONE) {
221 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
226 sz = arg->params[0].u.value.b;
227 switch (arg->params[0].u.value.a) {
228 case OPTEE_MSG_RPC_SHM_TYPE_APPL:
229 shm = cmd_alloc_suppl(ctx, sz);
231 case OPTEE_MSG_RPC_SHM_TYPE_KERNEL:
232 shm = tee_shm_alloc(ctx, sz, TEE_SHM_MAPPED);
235 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
240 arg->ret = TEEC_ERROR_OUT_OF_MEMORY;
244 if (tee_shm_get_pa(shm, 0, &pa)) {
245 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
249 sz = tee_shm_get_size(shm);
251 if (tee_shm_is_registered(shm)) {
256 pages = tee_shm_get_pages(shm, &page_num);
257 if (!pages || !page_num) {
258 arg->ret = TEEC_ERROR_OUT_OF_MEMORY;
262 pages_list = optee_allocate_pages_list(page_num);
264 arg->ret = TEEC_ERROR_OUT_OF_MEMORY;
268 call_ctx->pages_list = pages_list;
269 call_ctx->num_entries = page_num;
271 arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT |
272 OPTEE_MSG_ATTR_NONCONTIG;
274 * In the least bits of u.tmem.buf_ptr we store buffer offset
275 * from 4k page, as described in OP-TEE ABI.
277 arg->params[0].u.tmem.buf_ptr = virt_to_phys(pages_list) |
278 (tee_shm_get_page_offset(shm) &
279 (OPTEE_MSG_NONCONTIG_PAGE_SIZE - 1));
280 arg->params[0].u.tmem.size = tee_shm_get_size(shm);
281 arg->params[0].u.tmem.shm_ref = (unsigned long)shm;
283 optee_fill_pages_list(pages_list, pages, page_num,
284 tee_shm_get_page_offset(shm));
286 arg->params[0].attr = OPTEE_MSG_ATTR_TYPE_TMEM_OUTPUT;
287 arg->params[0].u.tmem.buf_ptr = pa;
288 arg->params[0].u.tmem.size = sz;
289 arg->params[0].u.tmem.shm_ref = (unsigned long)shm;
292 arg->ret = TEEC_SUCCESS;
298 static void cmd_free_suppl(struct tee_context *ctx, struct tee_shm *shm)
300 struct tee_param param;
302 param.attr = TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT;
303 param.u.value.a = OPTEE_MSG_RPC_SHM_TYPE_APPL;
304 param.u.value.b = tee_shm_get_id(shm);
308 * Match the tee_shm_get_from_id() in cmd_alloc_suppl() as secure
309 * world has released its reference.
311 * It's better to do this before sending the request to supplicant
312 * as we'd like to let the process doing the initial allocation to
313 * do release the last reference too in order to avoid stacking
314 * many pending fput() on the client process. This could otherwise
315 * happen if secure world does many allocate and free in a single
320 optee_supp_thrd_req(ctx, OPTEE_MSG_RPC_CMD_SHM_FREE, 1, ¶m);
323 static void handle_rpc_func_cmd_shm_free(struct tee_context *ctx,
324 struct optee_msg_arg *arg)
328 arg->ret_origin = TEEC_ORIGIN_COMMS;
330 if (arg->num_params != 1 ||
331 arg->params[0].attr != OPTEE_MSG_ATTR_TYPE_VALUE_INPUT) {
332 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
336 shm = (struct tee_shm *)(unsigned long)arg->params[0].u.value.b;
337 switch (arg->params[0].u.value.a) {
338 case OPTEE_MSG_RPC_SHM_TYPE_APPL:
339 cmd_free_suppl(ctx, shm);
341 case OPTEE_MSG_RPC_SHM_TYPE_KERNEL:
345 arg->ret = TEEC_ERROR_BAD_PARAMETERS;
347 arg->ret = TEEC_SUCCESS;
350 static void free_pages_list(struct optee_call_ctx *call_ctx)
352 if (call_ctx->pages_list) {
353 optee_free_pages_list(call_ctx->pages_list,
354 call_ctx->num_entries);
355 call_ctx->pages_list = NULL;
356 call_ctx->num_entries = 0;
360 void optee_rpc_finalize_call(struct optee_call_ctx *call_ctx)
362 free_pages_list(call_ctx);
365 static void handle_rpc_func_cmd(struct tee_context *ctx, struct optee *optee,
367 struct optee_call_ctx *call_ctx)
369 struct optee_msg_arg *arg;
371 arg = tee_shm_get_va(shm, 0);
373 pr_err("%s: tee_shm_get_va %p failed\n", __func__, shm);
378 case OPTEE_MSG_RPC_CMD_GET_TIME:
379 handle_rpc_func_cmd_get_time(arg);
381 case OPTEE_MSG_RPC_CMD_WAIT_QUEUE:
382 handle_rpc_func_cmd_wq(optee, arg);
384 case OPTEE_MSG_RPC_CMD_SUSPEND:
385 handle_rpc_func_cmd_wait(arg);
387 case OPTEE_MSG_RPC_CMD_SHM_ALLOC:
388 free_pages_list(call_ctx);
389 handle_rpc_func_cmd_shm_alloc(ctx, arg, call_ctx);
391 case OPTEE_MSG_RPC_CMD_SHM_FREE:
392 handle_rpc_func_cmd_shm_free(ctx, arg);
395 handle_rpc_supp_cmd(ctx, arg);
400 * optee_handle_rpc() - handle RPC from secure world
401 * @ctx: context doing the RPC
402 * @param: value of registers for the RPC
403 * @call_ctx: call context. Preserved during one OP-TEE invocation
405 * Result of RPC is written back into @param.
407 void optee_handle_rpc(struct tee_context *ctx, struct optee_rpc_param *param,
408 struct optee_call_ctx *call_ctx)
410 struct tee_device *teedev = ctx->teedev;
411 struct optee *optee = tee_get_drvdata(teedev);
415 switch (OPTEE_SMC_RETURN_GET_RPC_FUNC(param->a0)) {
416 case OPTEE_SMC_RPC_FUNC_ALLOC:
417 shm = tee_shm_alloc(ctx, param->a1, TEE_SHM_MAPPED);
418 if (!IS_ERR(shm) && !tee_shm_get_pa(shm, 0, &pa)) {
419 reg_pair_from_64(¶m->a1, ¶m->a2, pa);
420 reg_pair_from_64(¶m->a4, ¶m->a5,
429 case OPTEE_SMC_RPC_FUNC_FREE:
430 shm = reg_pair_to_ptr(param->a1, param->a2);
433 case OPTEE_SMC_RPC_FUNC_FOREIGN_INTR:
435 * A foreign interrupt was raised while secure world was
436 * executing, since they are handled in Linux a dummy RPC is
437 * performed to let Linux take the interrupt through the normal
441 case OPTEE_SMC_RPC_FUNC_CMD:
442 shm = reg_pair_to_ptr(param->a1, param->a2);
443 handle_rpc_func_cmd(ctx, optee, shm, call_ctx);
446 pr_warn("Unknown RPC func 0x%x\n",
447 (u32)OPTEE_SMC_RETURN_GET_RPC_FUNC(param->a0));
451 param->a0 = OPTEE_SMC_CALL_RETURN_FROM_RPC;