drivers/tee/tee_core.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (c) 2015-2016, Linaro Limited
   4  */
   5
   6 #define pr_fmt(fmt) "%s: " fmt, __func__
   7
   8 #include <linux/cdev.h>
   9 #include <linux/cred.h>
  10 #include <linux/fs.h>
  11 #include <linux/idr.h>
  12 #include <linux/module.h>
  13 #include <linux/slab.h>
  14 #include <linux/tee_drv.h>
  15 #include <linux/uaccess.h>
  16 #include <crypto/hash.h>
  17 #include <crypto/sha1.h>
  18 #include "tee_private.h"
  19
  20 #define TEE_NUM_DEVICES 32
  21
  22 #define TEE_IOCTL_PARAM_SIZE(x) (sizeof(struct tee_param) * (x))
  23
  24 #define TEE_UUID_NS_NAME_SIZE   128
  25
  26 /*
  27  * TEE Client UUID name space identifier (UUIDv4)
  28  *
  29  * Value here is random UUID that is allocated as name space identifier for
  30  * forming Client UUID's for TEE environment using UUIDv5 scheme.
  31  */
  32 static const uuid_t tee_client_uuid_ns = UUID_INIT(0x58ac9ca0, 0x2086, 0x4683,
  33                                                    0xa1, 0xb8, 0xec, 0x4b,
  34                                                    0xc0, 0x8e, 0x01, 0xb6);
  35
  36 /*
  37  * Unprivileged devices in the lower half range and privileged devices in
  38  * the upper half range.
  39  */
  40 static DECLARE_BITMAP(dev_mask, TEE_NUM_DEVICES);
  41 static DEFINE_SPINLOCK(driver_lock);
  42
  43 static struct class *tee_class;
  44 static dev_t tee_devt;
  45
  46 static struct tee_context *teedev_open(struct tee_device *teedev)
  47 {
  48         int rc;
  49         struct tee_context *ctx;
  50
  51         if (!tee_device_get(teedev))
  52                 return ERR_PTR(-EINVAL);
  53
  54         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
  55         if (!ctx) {
  56                 rc = -ENOMEM;
  57                 goto err;
  58         }
  59
  60         kref_init(&ctx->refcount);
  61         ctx->teedev = teedev;
  62         rc = teedev->desc->ops->open(ctx);
  63         if (rc)
  64                 goto err;
  65
  66         return ctx;
  67 err:
  68         kfree(ctx);
  69         tee_device_put(teedev);
  70         return ERR_PTR(rc);
  71
  72 }
  73
  74 void teedev_ctx_get(struct tee_context *ctx)
  75 {
  76         if (ctx->releasing)
  77                 return;
  78
  79         kref_get(&ctx->refcount);
  80 }
  81
  82 static void teedev_ctx_release(struct kref *ref)
  83 {
  84         struct tee_context *ctx = container_of(ref, struct tee_context,
  85                                                refcount);
  86         ctx->releasing = true;
  87         ctx->teedev->desc->ops->release(ctx);
  88         kfree(ctx);
  89 }
  90
  91 void teedev_ctx_put(struct tee_context *ctx)
  92 {
  93         if (ctx->releasing)
  94                 return;
  95
  96         kref_put(&ctx->refcount, teedev_ctx_release);
  97 }
  98
  99 static void teedev_close_context(struct tee_context *ctx)
 100 {
 101         struct tee_device *teedev = ctx->teedev;
 102
 103         teedev_ctx_put(ctx);
 104         tee_device_put(teedev);
 105 }
 106
 107 static int tee_open(struct inode *inode, struct file *filp)
 108 {
 109         struct tee_context *ctx;
 110
 111         ctx = teedev_open(container_of(inode->i_cdev, struct tee_device, cdev));
 112         if (IS_ERR(ctx))
 113                 return PTR_ERR(ctx);
 114
 115         /*
 116          * Default user-space behaviour is to wait for tee-supplicant
 117          * if not present for any requests in this context.
 118          */
 119         ctx->supp_nowait = false;
 120         filp->private_data = ctx;
 121         return 0;
 122 }
 123
 124 static int tee_release(struct inode *inode, struct file *filp)
 125 {
 126         teedev_close_context(filp->private_data);
 127         return 0;
 128 }
 129
 130 /**
 131  * uuid_v5() - Calculate UUIDv5
 132  * @uuid: Resulting UUID
 133  * @ns: Name space ID for UUIDv5 function
 134  * @name: Name for UUIDv5 function
 135  * @size: Size of name
 136  *
 137  * UUIDv5 is specific in RFC 4122.
 138  *
 139  * This implements section (for SHA-1):
 140  * 4.3.  Algorithm for Creating a Name-Based UUID
 141  */
 142 static int uuid_v5(uuid_t *uuid, const uuid_t *ns, const void *name,
 143                    size_t size)
 144 {
 145         unsigned char hash[SHA1_DIGEST_SIZE];
 146         struct crypto_shash *shash = NULL;
 147         struct shash_desc *desc = NULL;
 148         int rc;
 149
 150         shash = crypto_alloc_shash("sha1", 0, 0);
 151         if (IS_ERR(shash)) {
 152                 rc = PTR_ERR(shash);
 153                 pr_err("shash(sha1) allocation failed\n");
 154                 return rc;
 155         }
 156
 157         desc = kzalloc(sizeof(*desc) + crypto_shash_descsize(shash),
 158                        GFP_KERNEL);
 159         if (!desc) {
 160                 rc = -ENOMEM;
 161                 goto out_free_shash;
 162         }
 163
 164         desc->tfm = shash;
 165
 166         rc = crypto_shash_init(desc);
 167         if (rc < 0)
 168                 goto out_free_desc;
 169
 170         rc = crypto_shash_update(desc, (const u8 *)ns, sizeof(*ns));
 171         if (rc < 0)
 172                 goto out_free_desc;
 173
 174         rc = crypto_shash_update(desc, (const u8 *)name, size);
 175         if (rc < 0)
 176                 goto out_free_desc;
 177
 178         rc = crypto_shash_final(desc, hash);
 179         if (rc < 0)
 180                 goto out_free_desc;
 181
 182         memcpy(uuid->b, hash, UUID_SIZE);
 183
 184         /* Tag for version 5 */
 185         uuid->b[6] = (hash[6] & 0x0F) | 0x50;
 186         uuid->b[8] = (hash[8] & 0x3F) | 0x80;
 187
 188 out_free_desc:
 189         kfree(desc);
 190
 191 out_free_shash:
 192         crypto_free_shash(shash);
 193         return rc;
 194 }
 195
 196 int tee_session_calc_client_uuid(uuid_t *uuid, u32 connection_method,
 197                                  const u8 connection_data[TEE_IOCTL_UUID_LEN])
 198 {
 199         gid_t ns_grp = (gid_t)-1;
 200         kgid_t grp = INVALID_GID;
 201         char *name = NULL;
 202         int name_len;
 203         int rc;
 204
 205         if (connection_method == TEE_IOCTL_LOGIN_PUBLIC ||
 206             connection_method == TEE_IOCTL_LOGIN_REE_KERNEL) {
 207                 /* Nil UUID to be passed to TEE environment */
 208                 uuid_copy(uuid, &uuid_null);
 209                 return 0;
 210         }
 211
 212         /*
 213          * In Linux environment client UUID is based on UUIDv5.
 214          *
 215          * Determine client UUID with following semantics for 'name':
 216          *
 217          * For TEEC_LOGIN_USER:
 218          * uid=<uid>
 219          *
 220          * For TEEC_LOGIN_GROUP:
 221          * gid=<gid>
 222          *
 223          */
 224
 225         name = kzalloc(TEE_UUID_NS_NAME_SIZE, GFP_KERNEL);
 226         if (!name)
 227                 return -ENOMEM;
 228
 229         switch (connection_method) {
 230         case TEE_IOCTL_LOGIN_USER:
 231                 name_len = snprintf(name, TEE_UUID_NS_NAME_SIZE, "uid=%x",
 232                                     current_euid().val);
 233                 if (name_len >= TEE_UUID_NS_NAME_SIZE) {
 234                         rc = -E2BIG;
 235                         goto out_free_name;
 236                 }
 237                 break;
 238
 239         case TEE_IOCTL_LOGIN_GROUP:
 240                 memcpy(&ns_grp, connection_data, sizeof(gid_t));
 241                 grp = make_kgid(current_user_ns(), ns_grp);
 242                 if (!gid_valid(grp) || !in_egroup_p(grp)) {
 243                         rc = -EPERM;
 244                         goto out_free_name;
 245                 }
 246
 247                 name_len = snprintf(name, TEE_UUID_NS_NAME_SIZE, "gid=%x",
 248                                     grp.val);
 249                 if (name_len >= TEE_UUID_NS_NAME_SIZE) {
 250                         rc = -E2BIG;
 251                         goto out_free_name;
 252                 }
 253                 break;
 254
 255         default:
 256                 rc = -EINVAL;
 257                 goto out_free_name;
 258         }
 259
 260         rc = uuid_v5(uuid, &tee_client_uuid_ns, name, name_len);
 261 out_free_name:
 262         kfree(name);
 263
 264         return rc;
 265 }
 266 EXPORT_SYMBOL_GPL(tee_session_calc_client_uuid);
 267
 268 static int tee_ioctl_version(struct tee_context *ctx,
 269                              struct tee_ioctl_version_data __user *uvers)
 270 {
 271         struct tee_ioctl_version_data vers;
 272
 273         ctx->teedev->desc->ops->get_version(ctx->teedev, &vers);
 274
 275         if (ctx->teedev->desc->flags & TEE_DESC_PRIVILEGED)
 276                 vers.gen_caps |= TEE_GEN_CAP_PRIVILEGED;
 277
 278         if (copy_to_user(uvers, &vers, sizeof(vers)))
 279                 return -EFAULT;
 280
 281         return 0;
 282 }
 283
 284 static int tee_ioctl_shm_alloc(struct tee_context *ctx,
 285                                struct tee_ioctl_shm_alloc_data __user *udata)
 286 {
 287         long ret;
 288         struct tee_ioctl_shm_alloc_data data;
 289         struct tee_shm *shm;
 290
 291         if (copy_from_user(&data, udata, sizeof(data)))
 292                 return -EFAULT;
 293
 294         /* Currently no input flags are supported */
 295         if (data.flags)
 296                 return -EINVAL;
 297
 298         shm = tee_shm_alloc(ctx, data.size, TEE_SHM_MAPPED | TEE_SHM_DMA_BUF);
 299         if (IS_ERR(shm))
 300                 return PTR_ERR(shm);
 301
 302         data.id = shm->id;
 303         data.flags = shm->flags;
 304         data.size = shm->size;
 305
 306         if (copy_to_user(udata, &data, sizeof(data)))
 307                 ret = -EFAULT;
 308         else
 309                 ret = tee_shm_get_fd(shm);
 310
 311         /*
 312          * When user space closes the file descriptor the shared memory
 313          * should be freed or if tee_shm_get_fd() failed then it will
 314          * be freed immediately.
 315          */
 316         tee_shm_put(shm);
 317         return ret;
 318 }
 319
 320 static int
 321 tee_ioctl_shm_register(struct tee_context *ctx,
 322                        struct tee_ioctl_shm_register_data __user *udata)
 323 {
 324         long ret;
 325         struct tee_ioctl_shm_register_data data;
 326         struct tee_shm *shm;
 327
 328         if (copy_from_user(&data, udata, sizeof(data)))
 329                 return -EFAULT;
 330
 331         /* Currently no input flags are supported */
 332         if (data.flags)
 333                 return -EINVAL;
 334
 335         shm = tee_shm_register(ctx, data.addr, data.length,
 336                                TEE_SHM_DMA_BUF | TEE_SHM_USER_MAPPED);
 337         if (IS_ERR(shm))
 338                 return PTR_ERR(shm);
 339
 340         data.id = shm->id;
 341         data.flags = shm->flags;
 342         data.length = shm->size;
 343
 344         if (copy_to_user(udata, &data, sizeof(data)))
 345                 ret = -EFAULT;
 346         else
 347                 ret = tee_shm_get_fd(shm);
 348         /*
 349          * When user space closes the file descriptor the shared memory
 350          * should be freed or if tee_shm_get_fd() failed then it will
 351          * be freed immediately.
 352          */
 353         tee_shm_put(shm);
 354         return ret;
 355 }
 356
 357 static int params_from_user(struct tee_context *ctx, struct tee_param *params,
 358                             size_t num_params,
 359                             struct tee_ioctl_param __user *uparams)
 360 {
 361         size_t n;
 362
 363         for (n = 0; n < num_params; n++) {
 364                 struct tee_shm *shm;
 365                 struct tee_ioctl_param ip;
 366
 367                 if (copy_from_user(&ip, uparams + n, sizeof(ip)))
 368                         return -EFAULT;
 369
 370                 /* All unused attribute bits has to be zero */
 371                 if (ip.attr & ~TEE_IOCTL_PARAM_ATTR_MASK)
 372                         return -EINVAL;
 373
 374                 params[n].attr = ip.attr;
 375                 switch (ip.attr & TEE_IOCTL_PARAM_ATTR_TYPE_MASK) {
 376                 case TEE_IOCTL_PARAM_ATTR_TYPE_NONE:
 377                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT:
 378                         break;
 379                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT:
 380                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT:
 381                         params[n].u.value.a = ip.a;
 382                         params[n].u.value.b = ip.b;
 383                         params[n].u.value.c = ip.c;
 384                         break;
 385                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT:
 386                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
 387                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT:
 388                         /*
 389                          * If a NULL pointer is passed to a TA in the TEE,
 390                          * the ip.c IOCTL parameters is set to TEE_MEMREF_NULL
 391                          * indicating a NULL memory reference.
 392                          */
 393                         if (ip.c != TEE_MEMREF_NULL) {
 394                                 /*
 395                                  * If we fail to get a pointer to a shared
 396                                  * memory object (and increase the ref count)
 397                                  * from an identifier we return an error. All
 398                                  * pointers that has been added in params have
 399                                  * an increased ref count. It's the callers
 400                                  * responibility to do tee_shm_put() on all
 401                                  * resolved pointers.
 402                                  */
 403                                 shm = tee_shm_get_from_id(ctx, ip.c);
 404                                 if (IS_ERR(shm))
 405                                         return PTR_ERR(shm);
 406
 407                                 /*
 408                                  * Ensure offset + size does not overflow
 409                                  * offset and does not overflow the size of
 410                                  * the referred shared memory object.
 411                                  */
 412                                 if ((ip.a + ip.b) < ip.a ||
 413                                     (ip.a + ip.b) > shm->size) {
 414                                         tee_shm_put(shm);
 415                                         return -EINVAL;
 416                                 }
 417                         } else if (ctx->cap_memref_null) {
 418                                 /* Pass NULL pointer to OP-TEE */
 419                                 shm = NULL;
 420                         } else {
 421                                 return -EINVAL;
 422                         }
 423
 424                         params[n].u.memref.shm_offs = ip.a;
 425                         params[n].u.memref.size = ip.b;
 426                         params[n].u.memref.shm = shm;
 427                         break;
 428                 default:
 429                         /* Unknown attribute */
 430                         return -EINVAL;
 431                 }
 432         }
 433         return 0;
 434 }
 435
 436 static int params_to_user(struct tee_ioctl_param __user *uparams,
 437                           size_t num_params, struct tee_param *params)
 438 {
 439         size_t n;
 440
 441         for (n = 0; n < num_params; n++) {
 442                 struct tee_ioctl_param __user *up = uparams + n;
 443                 struct tee_param *p = params + n;
 444
 445                 switch (p->attr) {
 446                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT:
 447                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT:
 448                         if (put_user(p->u.value.a, &up->a) ||
 449                             put_user(p->u.value.b, &up->b) ||
 450                             put_user(p->u.value.c, &up->c))
 451                                 return -EFAULT;
 452                         break;
 453                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
 454                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT:
 455                         if (put_user((u64)p->u.memref.size, &up->b))
 456                                 return -EFAULT;
 457                         break;
 458                 default:
 459                         break;
 460                 }
 461         }
 462         return 0;
 463 }
 464
 465 static int tee_ioctl_open_session(struct tee_context *ctx,
 466                                   struct tee_ioctl_buf_data __user *ubuf)
 467 {
 468         int rc;
 469         size_t n;
 470         struct tee_ioctl_buf_data buf;
 471         struct tee_ioctl_open_session_arg __user *uarg;
 472         struct tee_ioctl_open_session_arg arg;
 473         struct tee_ioctl_param __user *uparams = NULL;
 474         struct tee_param *params = NULL;
 475         bool have_session = false;
 476
 477         if (!ctx->teedev->desc->ops->open_session)
 478                 return -EINVAL;
 479
 480         if (copy_from_user(&buf, ubuf, sizeof(buf)))
 481                 return -EFAULT;
 482
 483         if (buf.buf_len > TEE_MAX_ARG_SIZE ||
 484             buf.buf_len < sizeof(struct tee_ioctl_open_session_arg))
 485                 return -EINVAL;
 486
 487         uarg = u64_to_user_ptr(buf.buf_ptr);
 488         if (copy_from_user(&arg, uarg, sizeof(arg)))
 489                 return -EFAULT;
 490
 491         if (sizeof(arg) + TEE_IOCTL_PARAM_SIZE(arg.num_params) != buf.buf_len)
 492                 return -EINVAL;
 493
 494         if (arg.num_params) {
 495                 params = kcalloc(arg.num_params, sizeof(struct tee_param),
 496                                  GFP_KERNEL);
 497                 if (!params)
 498                         return -ENOMEM;
 499                 uparams = uarg->params;
 500                 rc = params_from_user(ctx, params, arg.num_params, uparams);
 501                 if (rc)
 502                         goto out;
 503         }
 504
 505         if (arg.clnt_login >= TEE_IOCTL_LOGIN_REE_KERNEL_MIN &&
 506             arg.clnt_login <= TEE_IOCTL_LOGIN_REE_KERNEL_MAX) {
 507                 pr_debug("login method not allowed for user-space client\n");
 508                 rc = -EPERM;
 509                 goto out;
 510         }
 511
 512         rc = ctx->teedev->desc->ops->open_session(ctx, &arg, params);
 513         if (rc)
 514                 goto out;
 515         have_session = true;
 516
 517         if (put_user(arg.session, &uarg->session) ||
 518             put_user(arg.ret, &uarg->ret) ||
 519             put_user(arg.ret_origin, &uarg->ret_origin)) {
 520                 rc = -EFAULT;
 521                 goto out;
 522         }
 523         rc = params_to_user(uparams, arg.num_params, params);
 524 out:
 525         /*
 526          * If we've succeeded to open the session but failed to communicate
 527          * it back to user space, close the session again to avoid leakage.
 528          */
 529         if (rc && have_session && ctx->teedev->desc->ops->close_session)
 530                 ctx->teedev->desc->ops->close_session(ctx, arg.session);
 531
 532         if (params) {
 533                 /* Decrease ref count for all valid shared memory pointers */
 534                 for (n = 0; n < arg.num_params; n++)
 535                         if (tee_param_is_memref(params + n) &&
 536                             params[n].u.memref.shm)
 537                                 tee_shm_put(params[n].u.memref.shm);
 538                 kfree(params);
 539         }
 540
 541         return rc;
 542 }
 543
 544 static int tee_ioctl_invoke(struct tee_context *ctx,
 545                             struct tee_ioctl_buf_data __user *ubuf)
 546 {
 547         int rc;
 548         size_t n;
 549         struct tee_ioctl_buf_data buf;
 550         struct tee_ioctl_invoke_arg __user *uarg;
 551         struct tee_ioctl_invoke_arg arg;
 552         struct tee_ioctl_param __user *uparams = NULL;
 553         struct tee_param *params = NULL;
 554
 555         if (!ctx->teedev->desc->ops->invoke_func)
 556                 return -EINVAL;
 557
 558         if (copy_from_user(&buf, ubuf, sizeof(buf)))
 559                 return -EFAULT;
 560
 561         if (buf.buf_len > TEE_MAX_ARG_SIZE ||
 562             buf.buf_len < sizeof(struct tee_ioctl_invoke_arg))
 563                 return -EINVAL;
 564
 565         uarg = u64_to_user_ptr(buf.buf_ptr);
 566         if (copy_from_user(&arg, uarg, sizeof(arg)))
 567                 return -EFAULT;
 568
 569         if (sizeof(arg) + TEE_IOCTL_PARAM_SIZE(arg.num_params) != buf.buf_len)
 570                 return -EINVAL;
 571
 572         if (arg.num_params) {
 573                 params = kcalloc(arg.num_params, sizeof(struct tee_param),
 574                                  GFP_KERNEL);
 575                 if (!params)
 576                         return -ENOMEM;
 577                 uparams = uarg->params;
 578                 rc = params_from_user(ctx, params, arg.num_params, uparams);
 579                 if (rc)
 580                         goto out;
 581         }
 582
 583         rc = ctx->teedev->desc->ops->invoke_func(ctx, &arg, params);
 584         if (rc)
 585                 goto out;
 586
 587         if (put_user(arg.ret, &uarg->ret) ||
 588             put_user(arg.ret_origin, &uarg->ret_origin)) {
 589                 rc = -EFAULT;
 590                 goto out;
 591         }
 592         rc = params_to_user(uparams, arg.num_params, params);
 593 out:
 594         if (params) {
 595                 /* Decrease ref count for all valid shared memory pointers */
 596                 for (n = 0; n < arg.num_params; n++)
 597                         if (tee_param_is_memref(params + n) &&
 598                             params[n].u.memref.shm)
 599                                 tee_shm_put(params[n].u.memref.shm);
 600                 kfree(params);
 601         }
 602         return rc;
 603 }
 604
 605 static int tee_ioctl_cancel(struct tee_context *ctx,
 606                             struct tee_ioctl_cancel_arg __user *uarg)
 607 {
 608         struct tee_ioctl_cancel_arg arg;
 609
 610         if (!ctx->teedev->desc->ops->cancel_req)
 611                 return -EINVAL;
 612
 613         if (copy_from_user(&arg, uarg, sizeof(arg)))
 614                 return -EFAULT;
 615
 616         return ctx->teedev->desc->ops->cancel_req(ctx, arg.cancel_id,
 617                                                   arg.session);
 618 }
 619
 620 static int
 621 tee_ioctl_close_session(struct tee_context *ctx,
 622                         struct tee_ioctl_close_session_arg __user *uarg)
 623 {
 624         struct tee_ioctl_close_session_arg arg;
 625
 626         if (!ctx->teedev->desc->ops->close_session)
 627                 return -EINVAL;
 628
 629         if (copy_from_user(&arg, uarg, sizeof(arg)))
 630                 return -EFAULT;
 631
 632         return ctx->teedev->desc->ops->close_session(ctx, arg.session);
 633 }
 634
 635 static int params_to_supp(struct tee_context *ctx,
 636                           struct tee_ioctl_param __user *uparams,
 637                           size_t num_params, struct tee_param *params)
 638 {
 639         size_t n;
 640
 641         for (n = 0; n < num_params; n++) {
 642                 struct tee_ioctl_param ip;
 643                 struct tee_param *p = params + n;
 644
 645                 ip.attr = p->attr;
 646                 switch (p->attr & TEE_IOCTL_PARAM_ATTR_TYPE_MASK) {
 647                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INPUT:
 648                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT:
 649                         ip.a = p->u.value.a;
 650                         ip.b = p->u.value.b;
 651                         ip.c = p->u.value.c;
 652                         break;
 653                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT:
 654                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
 655                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT:
 656                         ip.b = p->u.memref.size;
 657                         if (!p->u.memref.shm) {
 658                                 ip.a = 0;
 659                                 ip.c = (u64)-1; /* invalid shm id */
 660                                 break;
 661                         }
 662                         ip.a = p->u.memref.shm_offs;
 663                         ip.c = p->u.memref.shm->id;
 664                         break;
 665                 default:
 666                         ip.a = 0;
 667                         ip.b = 0;
 668                         ip.c = 0;
 669                         break;
 670                 }
 671
 672                 if (copy_to_user(uparams + n, &ip, sizeof(ip)))
 673                         return -EFAULT;
 674         }
 675
 676         return 0;
 677 }
 678
 679 static int tee_ioctl_supp_recv(struct tee_context *ctx,
 680                                struct tee_ioctl_buf_data __user *ubuf)
 681 {
 682         int rc;
 683         struct tee_ioctl_buf_data buf;
 684         struct tee_iocl_supp_recv_arg __user *uarg;
 685         struct tee_param *params;
 686         u32 num_params;
 687         u32 func;
 688
 689         if (!ctx->teedev->desc->ops->supp_recv)
 690                 return -EINVAL;
 691
 692         if (copy_from_user(&buf, ubuf, sizeof(buf)))
 693                 return -EFAULT;
 694
 695         if (buf.buf_len > TEE_MAX_ARG_SIZE ||
 696             buf.buf_len < sizeof(struct tee_iocl_supp_recv_arg))
 697                 return -EINVAL;
 698
 699         uarg = u64_to_user_ptr(buf.buf_ptr);
 700         if (get_user(num_params, &uarg->num_params))
 701                 return -EFAULT;
 702
 703         if (sizeof(*uarg) + TEE_IOCTL_PARAM_SIZE(num_params) != buf.buf_len)
 704                 return -EINVAL;
 705
 706         params = kcalloc(num_params, sizeof(struct tee_param), GFP_KERNEL);
 707         if (!params)
 708                 return -ENOMEM;
 709
 710         rc = params_from_user(ctx, params, num_params, uarg->params);
 711         if (rc)
 712                 goto out;
 713
 714         rc = ctx->teedev->desc->ops->supp_recv(ctx, &func, &num_params, params);
 715         if (rc)
 716                 goto out;
 717
 718         if (put_user(func, &uarg->func) ||
 719             put_user(num_params, &uarg->num_params)) {
 720                 rc = -EFAULT;
 721                 goto out;
 722         }
 723
 724         rc = params_to_supp(ctx, uarg->params, num_params, params);
 725 out:
 726         kfree(params);
 727         return rc;
 728 }
 729
 730 static int params_from_supp(struct tee_param *params, size_t num_params,
 731                             struct tee_ioctl_param __user *uparams)
 732 {
 733         size_t n;
 734
 735         for (n = 0; n < num_params; n++) {
 736                 struct tee_param *p = params + n;
 737                 struct tee_ioctl_param ip;
 738
 739                 if (copy_from_user(&ip, uparams + n, sizeof(ip)))
 740                         return -EFAULT;
 741
 742                 /* All unused attribute bits has to be zero */
 743                 if (ip.attr & ~TEE_IOCTL_PARAM_ATTR_MASK)
 744                         return -EINVAL;
 745
 746                 p->attr = ip.attr;
 747                 switch (ip.attr & TEE_IOCTL_PARAM_ATTR_TYPE_MASK) {
 748                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_OUTPUT:
 749                 case TEE_IOCTL_PARAM_ATTR_TYPE_VALUE_INOUT:
 750                         /* Only out and in/out values can be updated */
 751                         p->u.value.a = ip.a;
 752                         p->u.value.b = ip.b;
 753                         p->u.value.c = ip.c;
 754                         break;
 755                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
 756                 case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT:
 757                         /*
 758                          * Only the size of the memref can be updated.
 759                          * Since we don't have access to the original
 760                          * parameters here, only store the supplied size.
 761                          * The driver will copy the updated size into the
 762                          * original parameters.
 763                          */
 764                         p->u.memref.shm = NULL;
 765                         p->u.memref.shm_offs = 0;
 766                         p->u.memref.size = ip.b;
 767                         break;
 768                 default:
 769                         memset(&p->u, 0, sizeof(p->u));
 770                         break;
 771                 }
 772         }
 773         return 0;
 774 }
 775
 776 static int tee_ioctl_supp_send(struct tee_context *ctx,
 777                                struct tee_ioctl_buf_data __user *ubuf)
 778 {
 779         long rc;
 780         struct tee_ioctl_buf_data buf;
 781         struct tee_iocl_supp_send_arg __user *uarg;
 782         struct tee_param *params;
 783         u32 num_params;
 784         u32 ret;
 785
 786         /* Not valid for this driver */
 787         if (!ctx->teedev->desc->ops->supp_send)
 788                 return -EINVAL;
 789
 790         if (copy_from_user(&buf, ubuf, sizeof(buf)))
 791                 return -EFAULT;
 792
 793         if (buf.buf_len > TEE_MAX_ARG_SIZE ||
 794             buf.buf_len < sizeof(struct tee_iocl_supp_send_arg))
 795                 return -EINVAL;
 796
 797         uarg = u64_to_user_ptr(buf.buf_ptr);
 798         if (get_user(ret, &uarg->ret) ||
 799             get_user(num_params, &uarg->num_params))
 800                 return -EFAULT;
 801
 802         if (sizeof(*uarg) + TEE_IOCTL_PARAM_SIZE(num_params) > buf.buf_len)
 803                 return -EINVAL;
 804
 805         params = kcalloc(num_params, sizeof(struct tee_param), GFP_KERNEL);
 806         if (!params)
 807                 return -ENOMEM;
 808
 809         rc = params_from_supp(params, num_params, uarg->params);
 810         if (rc)
 811                 goto out;
 812
 813         rc = ctx->teedev->desc->ops->supp_send(ctx, ret, num_params, params);
 814 out:
 815         kfree(params);
 816         return rc;
 817 }
 818
 819 static long tee_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
 820 {
 821         struct tee_context *ctx = filp->private_data;
 822         void __user *uarg = (void __user *)arg;
 823
 824         switch (cmd) {
 825         case TEE_IOC_VERSION:
 826                 return tee_ioctl_version(ctx, uarg);
 827         case TEE_IOC_SHM_ALLOC:
 828                 return tee_ioctl_shm_alloc(ctx, uarg);
 829         case TEE_IOC_SHM_REGISTER:
 830                 return tee_ioctl_shm_register(ctx, uarg);
 831         case TEE_IOC_OPEN_SESSION:
 832                 return tee_ioctl_open_session(ctx, uarg);
 833         case TEE_IOC_INVOKE:
 834                 return tee_ioctl_invoke(ctx, uarg);
 835         case TEE_IOC_CANCEL:
 836                 return tee_ioctl_cancel(ctx, uarg);
 837         case TEE_IOC_CLOSE_SESSION:
 838                 return tee_ioctl_close_session(ctx, uarg);
 839         case TEE_IOC_SUPPL_RECV:
 840                 return tee_ioctl_supp_recv(ctx, uarg);
 841         case TEE_IOC_SUPPL_SEND:
 842                 return tee_ioctl_supp_send(ctx, uarg);
 843         default:
 844                 return -EINVAL;
 845         }
 846 }
 847
 848 static const struct file_operations tee_fops = {
 849         .owner = THIS_MODULE,
 850         .open = tee_open,
 851         .release = tee_release,
 852         .unlocked_ioctl = tee_ioctl,
 853         .compat_ioctl = compat_ptr_ioctl,
 854 };
 855
 856 static void tee_release_device(struct device *dev)
 857 {
 858         struct tee_device *teedev = container_of(dev, struct tee_device, dev);
 859
 860         spin_lock(&driver_lock);
 861         clear_bit(teedev->id, dev_mask);
 862         spin_unlock(&driver_lock);
 863         mutex_destroy(&teedev->mutex);
 864         idr_destroy(&teedev->idr);
 865         kfree(teedev);
 866 }
 867
 868 /**
 869  * tee_device_alloc() - Allocate a new struct tee_device instance
 870  * @teedesc:    Descriptor for this driver
 871  * @dev:        Parent device for this device
 872  * @pool:       Shared memory pool, NULL if not used
 873  * @driver_data: Private driver data for this device
 874  *
 875  * Allocates a new struct tee_device instance. The device is
 876  * removed by tee_device_unregister().
 877  *
 878  * @returns a pointer to a 'struct tee_device' or an ERR_PTR on failure
 879  */
 880 struct tee_device *tee_device_alloc(const struct tee_desc *teedesc,
 881                                     struct device *dev,
 882                                     struct tee_shm_pool *pool,
 883                                     void *driver_data)
 884 {
 885         struct tee_device *teedev;
 886         void *ret;
 887         int rc, max_id;
 888         int offs = 0;
 889
 890         if (!teedesc || !teedesc->name || !teedesc->ops ||
 891             !teedesc->ops->get_version || !teedesc->ops->open ||
 892             !teedesc->ops->release || !pool)
 893                 return ERR_PTR(-EINVAL);
 894
 895         teedev = kzalloc(sizeof(*teedev), GFP_KERNEL);
 896         if (!teedev) {
 897                 ret = ERR_PTR(-ENOMEM);
 898                 goto err;
 899         }
 900
 901         max_id = TEE_NUM_DEVICES / 2;
 902
 903         if (teedesc->flags & TEE_DESC_PRIVILEGED) {
 904                 offs = TEE_NUM_DEVICES / 2;
 905                 max_id = TEE_NUM_DEVICES;
 906         }
 907
 908         spin_lock(&driver_lock);
 909         teedev->id = find_next_zero_bit(dev_mask, max_id, offs);
 910         if (teedev->id < max_id)
 911                 set_bit(teedev->id, dev_mask);
 912         spin_unlock(&driver_lock);
 913
 914         if (teedev->id >= max_id) {
 915                 ret = ERR_PTR(-ENOMEM);
 916                 goto err;
 917         }
 918
 919         snprintf(teedev->name, sizeof(teedev->name), "tee%s%d",
 920                  teedesc->flags & TEE_DESC_PRIVILEGED ? "priv" : "",
 921                  teedev->id - offs);
 922
 923         teedev->dev.class = tee_class;
 924         teedev->dev.release = tee_release_device;
 925         teedev->dev.parent = dev;
 926
 927         teedev->dev.devt = MKDEV(MAJOR(tee_devt), teedev->id);
 928
 929         rc = dev_set_name(&teedev->dev, "%s", teedev->name);
 930         if (rc) {
 931                 ret = ERR_PTR(rc);
 932                 goto err_devt;
 933         }
 934
 935         cdev_init(&teedev->cdev, &tee_fops);
 936         teedev->cdev.owner = teedesc->owner;
 937
 938         dev_set_drvdata(&teedev->dev, driver_data);
 939         device_initialize(&teedev->dev);
 940
 941         /* 1 as tee_device_unregister() does one final tee_device_put() */
 942         teedev->num_users = 1;
 943         init_completion(&teedev->c_no_users);
 944         mutex_init(&teedev->mutex);
 945         idr_init(&teedev->idr);
 946
 947         teedev->desc = teedesc;
 948         teedev->pool = pool;
 949
 950         return teedev;
 951 err_devt:
 952         unregister_chrdev_region(teedev->dev.devt, 1);
 953 err:
 954         pr_err("could not register %s driver\n",
 955                teedesc->flags & TEE_DESC_PRIVILEGED ? "privileged" : "client");
 956         if (teedev && teedev->id < TEE_NUM_DEVICES) {
 957                 spin_lock(&driver_lock);
 958                 clear_bit(teedev->id, dev_mask);
 959                 spin_unlock(&driver_lock);
 960         }
 961         kfree(teedev);
 962         return ret;
 963 }
 964 EXPORT_SYMBOL_GPL(tee_device_alloc);
 965
 966 static ssize_t implementation_id_show(struct device *dev,
 967                                       struct device_attribute *attr, char *buf)
 968 {
 969         struct tee_device *teedev = container_of(dev, struct tee_device, dev);
 970         struct tee_ioctl_version_data vers;
 971
 972         teedev->desc->ops->get_version(teedev, &vers);
 973         return scnprintf(buf, PAGE_SIZE, "%d\n", vers.impl_id);
 974 }
 975 static DEVICE_ATTR_RO(implementation_id);
 976
 977 static struct attribute *tee_dev_attrs[] = {
 978         &dev_attr_implementation_id.attr,
 979         NULL
 980 };
 981
 982 ATTRIBUTE_GROUPS(tee_dev);
 983
 984 /**
 985  * tee_device_register() - Registers a TEE device
 986  * @teedev:     Device to register
 987  *
 988  * tee_device_unregister() need to be called to remove the @teedev if
 989  * this function fails.
 990  *
 991  * @returns < 0 on failure
 992  */
 993 int tee_device_register(struct tee_device *teedev)
 994 {
 995         int rc;
 996
 997         if (teedev->flags & TEE_DEVICE_FLAG_REGISTERED) {
 998                 dev_err(&teedev->dev, "attempt to register twice\n");
 999                 return -EINVAL;
1000         }
1001
1002         teedev->dev.groups = tee_dev_groups;
1003
1004         rc = cdev_device_add(&teedev->cdev, &teedev->dev);
1005         if (rc) {
1006                 dev_err(&teedev->dev,
1007                         "unable to cdev_device_add() %s, major %d, minor %d, err=%d\n",
1008                         teedev->name, MAJOR(teedev->dev.devt),
1009                         MINOR(teedev->dev.devt), rc);
1010                 return rc;
1011         }
1012
1013         teedev->flags |= TEE_DEVICE_FLAG_REGISTERED;
1014         return 0;
1015 }
1016 EXPORT_SYMBOL_GPL(tee_device_register);
1017
1018 void tee_device_put(struct tee_device *teedev)
1019 {
1020         mutex_lock(&teedev->mutex);
1021         /* Shouldn't put in this state */
1022         if (!WARN_ON(!teedev->desc)) {
1023                 teedev->num_users--;
1024                 if (!teedev->num_users) {
1025                         teedev->desc = NULL;
1026                         complete(&teedev->c_no_users);
1027                 }
1028         }
1029         mutex_unlock(&teedev->mutex);
1030 }
1031
1032 bool tee_device_get(struct tee_device *teedev)
1033 {
1034         mutex_lock(&teedev->mutex);
1035         if (!teedev->desc) {
1036                 mutex_unlock(&teedev->mutex);
1037                 return false;
1038         }
1039         teedev->num_users++;
1040         mutex_unlock(&teedev->mutex);
1041         return true;
1042 }
1043
1044 /**
1045  * tee_device_unregister() - Removes a TEE device
1046  * @teedev:     Device to unregister
1047  *
1048  * This function should be called to remove the @teedev even if
1049  * tee_device_register() hasn't been called yet. Does nothing if
1050  * @teedev is NULL.
1051  */
1052 void tee_device_unregister(struct tee_device *teedev)
1053 {
1054         if (!teedev)
1055                 return;
1056
1057         if (teedev->flags & TEE_DEVICE_FLAG_REGISTERED)
1058                 cdev_device_del(&teedev->cdev, &teedev->dev);
1059
1060         tee_device_put(teedev);
1061         wait_for_completion(&teedev->c_no_users);
1062
1063         /*
1064          * No need to take a mutex any longer now since teedev->desc was
1065          * set to NULL before teedev->c_no_users was completed.
1066          */
1067
1068         teedev->pool = NULL;
1069
1070         put_device(&teedev->dev);
1071 }
1072 EXPORT_SYMBOL_GPL(tee_device_unregister);
1073
1074 /**
1075  * tee_get_drvdata() - Return driver_data pointer
1076  * @teedev:     Device containing the driver_data pointer
1077  * @returns the driver_data pointer supplied to tee_register().
1078  */
1079 void *tee_get_drvdata(struct tee_device *teedev)
1080 {
1081         return dev_get_drvdata(&teedev->dev);
1082 }
1083 EXPORT_SYMBOL_GPL(tee_get_drvdata);
1084
1085 struct match_dev_data {
1086         struct tee_ioctl_version_data *vers;
1087         const void *data;
1088         int (*match)(struct tee_ioctl_version_data *, const void *);
1089 };
1090
1091 static int match_dev(struct device *dev, const void *data)
1092 {
1093         const struct match_dev_data *match_data = data;
1094         struct tee_device *teedev = container_of(dev, struct tee_device, dev);
1095
1096         teedev->desc->ops->get_version(teedev, match_data->vers);
1097         return match_data->match(match_data->vers, match_data->data);
1098 }
1099
1100 struct tee_context *
1101 tee_client_open_context(struct tee_context *start,
1102                         int (*match)(struct tee_ioctl_version_data *,
1103                                      const void *),
1104                         const void *data, struct tee_ioctl_version_data *vers)
1105 {
1106         struct device *dev = NULL;
1107         struct device *put_dev = NULL;
1108         struct tee_context *ctx = NULL;
1109         struct tee_ioctl_version_data v;
1110         struct match_dev_data match_data = { vers ? vers : &v, data, match };
1111
1112         if (start)
1113                 dev = &start->teedev->dev;
1114
1115         do {
1116                 dev = class_find_device(tee_class, dev, &match_data, match_dev);
1117                 if (!dev) {
1118                         ctx = ERR_PTR(-ENOENT);
1119                         break;
1120                 }
1121
1122                 put_device(put_dev);
1123                 put_dev = dev;
1124
1125                 ctx = teedev_open(container_of(dev, struct tee_device, dev));
1126         } while (IS_ERR(ctx) && PTR_ERR(ctx) != -ENOMEM);
1127
1128         put_device(put_dev);
1129         /*
1130          * Default behaviour for in kernel client is to not wait for
1131          * tee-supplicant if not present for any requests in this context.
1132          * Also this flag could be configured again before call to
1133          * tee_client_open_session() if any in kernel client requires
1134          * different behaviour.
1135          */
1136         if (!IS_ERR(ctx))
1137                 ctx->supp_nowait = true;
1138
1139         return ctx;
1140 }
1141 EXPORT_SYMBOL_GPL(tee_client_open_context);
1142
1143 void tee_client_close_context(struct tee_context *ctx)
1144 {
1145         teedev_close_context(ctx);
1146 }
1147 EXPORT_SYMBOL_GPL(tee_client_close_context);
1148
1149 void tee_client_get_version(struct tee_context *ctx,
1150                             struct tee_ioctl_version_data *vers)
1151 {
1152         ctx->teedev->desc->ops->get_version(ctx->teedev, vers);
1153 }
1154 EXPORT_SYMBOL_GPL(tee_client_get_version);
1155
1156 int tee_client_open_session(struct tee_context *ctx,
1157                             struct tee_ioctl_open_session_arg *arg,
1158                             struct tee_param *param)
1159 {
1160         if (!ctx->teedev->desc->ops->open_session)
1161                 return -EINVAL;
1162         return ctx->teedev->desc->ops->open_session(ctx, arg, param);
1163 }
1164 EXPORT_SYMBOL_GPL(tee_client_open_session);
1165
1166 int tee_client_close_session(struct tee_context *ctx, u32 session)
1167 {
1168         if (!ctx->teedev->desc->ops->close_session)
1169                 return -EINVAL;
1170         return ctx->teedev->desc->ops->close_session(ctx, session);
1171 }
1172 EXPORT_SYMBOL_GPL(tee_client_close_session);
1173
1174 int tee_client_invoke_func(struct tee_context *ctx,
1175                            struct tee_ioctl_invoke_arg *arg,
1176                            struct tee_param *param)
1177 {
1178         if (!ctx->teedev->desc->ops->invoke_func)
1179                 return -EINVAL;
1180         return ctx->teedev->desc->ops->invoke_func(ctx, arg, param);
1181 }
1182 EXPORT_SYMBOL_GPL(tee_client_invoke_func);
1183
1184 int tee_client_cancel_req(struct tee_context *ctx,
1185                           struct tee_ioctl_cancel_arg *arg)
1186 {
1187         if (!ctx->teedev->desc->ops->cancel_req)
1188                 return -EINVAL;
1189         return ctx->teedev->desc->ops->cancel_req(ctx, arg->cancel_id,
1190                                                   arg->session);
1191 }
1192
1193 static int tee_client_device_match(struct device *dev,
1194                                    struct device_driver *drv)
1195 {
1196         const struct tee_client_device_id *id_table;
1197         struct tee_client_device *tee_device;
1198
1199         id_table = to_tee_client_driver(drv)->id_table;
1200         tee_device = to_tee_client_device(dev);
1201
1202         while (!uuid_is_null(&id_table->uuid)) {
1203                 if (uuid_equal(&tee_device->id.uuid, &id_table->uuid))
1204                         return 1;
1205                 id_table++;
1206         }
1207
1208         return 0;
1209 }
1210
1211 static int tee_client_device_uevent(struct device *dev,
1212                                     struct kobj_uevent_env *env)
1213 {
1214         uuid_t *dev_id = &to_tee_client_device(dev)->id.uuid;
1215
1216         return add_uevent_var(env, "MODALIAS=tee:%pUb", dev_id);
1217 }
1218
1219 struct bus_type tee_bus_type = {
1220         .name           = "tee",
1221         .match          = tee_client_device_match,
1222         .uevent         = tee_client_device_uevent,
1223 };
1224 EXPORT_SYMBOL_GPL(tee_bus_type);
1225
1226 static int __init tee_init(void)
1227 {
1228         int rc;
1229
1230         tee_class = class_create(THIS_MODULE, "tee");
1231         if (IS_ERR(tee_class)) {
1232                 pr_err("couldn't create class\n");
1233                 return PTR_ERR(tee_class);
1234         }
1235
1236         rc = alloc_chrdev_region(&tee_devt, 0, TEE_NUM_DEVICES, "tee");
1237         if (rc) {
1238                 pr_err("failed to allocate char dev region\n");
1239                 goto out_unreg_class;
1240         }
1241
1242         rc = bus_register(&tee_bus_type);
1243         if (rc) {
1244                 pr_err("failed to register tee bus\n");
1245                 goto out_unreg_chrdev;
1246         }
1247
1248         return 0;
1249
1250 out_unreg_chrdev:
1251         unregister_chrdev_region(tee_devt, TEE_NUM_DEVICES);
1252 out_unreg_class:
1253         class_destroy(tee_class);
1254         tee_class = NULL;
1255
1256         return rc;
1257 }
1258
1259 static void __exit tee_exit(void)
1260 {
1261         bus_unregister(&tee_bus_type);
1262         unregister_chrdev_region(tee_devt, TEE_NUM_DEVICES);
1263         class_destroy(tee_class);
1264         tee_class = NULL;
1265 }
1266
1267 subsys_initcall(tee_init);
1268 module_exit(tee_exit);
1269
1270 MODULE_AUTHOR("Linaro");
1271 MODULE_DESCRIPTION("TEE Driver");
1272 MODULE_VERSION("1.0");
1273 MODULE_LICENSE("GPL v2");