include/linux/tee_drv.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (c) 2015-2016, Linaro Limited
   4  */
   5
   6 #ifndef __TEE_DRV_H
   7 #define __TEE_DRV_H
   8
   9 #include <linux/device.h>
  10 #include <linux/idr.h>
  11 #include <linux/kref.h>
  12 #include <linux/list.h>
  13 #include <linux/mod_devicetable.h>
  14 #include <linux/tee.h>
  15 #include <linux/types.h>
  16 #include <linux/uuid.h>
  17
  18 /*
  19  * The file describes the API provided by the generic TEE driver to the
  20  * specific TEE driver.
  21  */
  22
  23 #define TEE_SHM_MAPPED          BIT(0)  /* Memory mapped by the kernel */
  24 #define TEE_SHM_DMA_BUF         BIT(1)  /* Memory with dma-buf handle */
  25 #define TEE_SHM_EXT_DMA_BUF     BIT(2)  /* Memory with dma-buf handle */
  26 #define TEE_SHM_REGISTER        BIT(3)  /* Memory registered in secure world */
  27 #define TEE_SHM_USER_MAPPED     BIT(4)  /* Memory mapped in user space */
  28 #define TEE_SHM_POOL            BIT(5)  /* Memory allocated from pool */
  29 #define TEE_SHM_KERNEL_MAPPED   BIT(6)  /* Memory mapped in kernel space */
  30 #define TEE_SHM_PRIV            BIT(7)  /* Memory private to TEE driver */
  31
  32 struct device;
  33 struct tee_device;
  34 struct tee_shm;
  35 struct tee_shm_pool;
  36
  37 /**
  38  * struct tee_context - driver specific context on file pointer data
  39  * @teedev:     pointer to this drivers struct tee_device
  40  * @list_shm:   List of shared memory object owned by this context
  41  * @data:       driver specific context data, managed by the driver
  42  * @refcount:   reference counter for this structure
  43  * @releasing:  flag that indicates if context is being released right now.
  44  *              It is needed to break circular dependency on context during
  45  *              shared memory release.
  46  * @supp_nowait: flag that indicates that requests in this context should not
  47  *              wait for tee-supplicant daemon to be started if not present
  48  *              and just return with an error code. It is needed for requests
  49  *              that arises from TEE based kernel drivers that should be
  50  *              non-blocking in nature.
  51  * @cap_memref_null: flag indicating if the TEE Client support shared
  52  *                   memory buffer with a NULL pointer.
  53  */
  54 struct tee_context {
  55         struct tee_device *teedev;
  56         void *data;
  57         struct kref refcount;
  58         bool releasing;
  59         bool supp_nowait;
  60         bool cap_memref_null;
  61 };
  62
  63 struct tee_param_memref {
  64         size_t shm_offs;
  65         size_t size;
  66         struct tee_shm *shm;
  67 };
  68
  69 struct tee_param_value {
  70         u64 a;
  71         u64 b;
  72         u64 c;
  73 };
  74
  75 struct tee_param {
  76         u64 attr;
  77         union {
  78                 struct tee_param_memref memref;
  79                 struct tee_param_value value;
  80         } u;
  81 };
  82
  83 /**
  84  * struct tee_driver_ops - driver operations vtable
  85  * @get_version:        returns version of driver
  86  * @open:               called when the device file is opened
  87  * @release:            release this open file
  88  * @open_session:       open a new session
  89  * @close_session:      close a session
  90  * @invoke_func:        invoke a trusted function
  91  * @cancel_req:         request cancel of an ongoing invoke or open
  92  * @supp_recv:          called for supplicant to get a command
  93  * @supp_send:          called for supplicant to send a response
  94  * @shm_register:       register shared memory buffer in TEE
  95  * @shm_unregister:     unregister shared memory buffer in TEE
  96  */
  97 struct tee_driver_ops {
  98         void (*get_version)(struct tee_device *teedev,
  99                             struct tee_ioctl_version_data *vers);
 100         int (*open)(struct tee_context *ctx);
 101         void (*release)(struct tee_context *ctx);
 102         int (*open_session)(struct tee_context *ctx,
 103                             struct tee_ioctl_open_session_arg *arg,
 104                             struct tee_param *param);
 105         int (*close_session)(struct tee_context *ctx, u32 session);
 106         int (*invoke_func)(struct tee_context *ctx,
 107                            struct tee_ioctl_invoke_arg *arg,
 108                            struct tee_param *param);
 109         int (*cancel_req)(struct tee_context *ctx, u32 cancel_id, u32 session);
 110         int (*supp_recv)(struct tee_context *ctx, u32 *func, u32 *num_params,
 111                          struct tee_param *param);
 112         int (*supp_send)(struct tee_context *ctx, u32 ret, u32 num_params,
 113                          struct tee_param *param);
 114         int (*shm_register)(struct tee_context *ctx, struct tee_shm *shm,
 115                             struct page **pages, size_t num_pages,
 116                             unsigned long start);
 117         int (*shm_unregister)(struct tee_context *ctx, struct tee_shm *shm);
 118 };
 119
 120 /**
 121  * struct tee_desc - Describes the TEE driver to the subsystem
 122  * @name:       name of driver
 123  * @ops:        driver operations vtable
 124  * @owner:      module providing the driver
 125  * @flags:      Extra properties of driver, defined by TEE_DESC_* below
 126  */
 127 #define TEE_DESC_PRIVILEGED     0x1
 128 struct tee_desc {
 129         const char *name;
 130         const struct tee_driver_ops *ops;
 131         struct module *owner;
 132         u32 flags;
 133 };
 134
 135 /**
 136  * tee_device_alloc() - Allocate a new struct tee_device instance
 137  * @teedesc:    Descriptor for this driver
 138  * @dev:        Parent device for this device
 139  * @pool:       Shared memory pool, NULL if not used
 140  * @driver_data: Private driver data for this device
 141  *
 142  * Allocates a new struct tee_device instance. The device is
 143  * removed by tee_device_unregister().
 144  *
 145  * @returns a pointer to a 'struct tee_device' or an ERR_PTR on failure
 146  */
 147 struct tee_device *tee_device_alloc(const struct tee_desc *teedesc,
 148                                     struct device *dev,
 149                                     struct tee_shm_pool *pool,
 150                                     void *driver_data);
 151
 152 /**
 153  * tee_device_register() - Registers a TEE device
 154  * @teedev:     Device to register
 155  *
 156  * tee_device_unregister() need to be called to remove the @teedev if
 157  * this function fails.
 158  *
 159  * @returns < 0 on failure
 160  */
 161 int tee_device_register(struct tee_device *teedev);
 162
 163 /**
 164  * tee_device_unregister() - Removes a TEE device
 165  * @teedev:     Device to unregister
 166  *
 167  * This function should be called to remove the @teedev even if
 168  * tee_device_register() hasn't been called yet. Does nothing if
 169  * @teedev is NULL.
 170  */
 171 void tee_device_unregister(struct tee_device *teedev);
 172
 173 /**
 174  * tee_session_calc_client_uuid() - Calculates client UUID for session
 175  * @uuid:               Resulting UUID
 176  * @connection_method:  Connection method for session (TEE_IOCTL_LOGIN_*)
 177  * @connectuon_data:    Connection data for opening session
 178  *
 179  * Based on connection method calculates UUIDv5 based client UUID.
 180  *
 181  * For group based logins verifies that calling process has specified
 182  * credentials.
 183  *
 184  * @return < 0 on failure
 185  */
 186 int tee_session_calc_client_uuid(uuid_t *uuid, u32 connection_method,
 187                                  const u8 connection_data[TEE_IOCTL_UUID_LEN]);
 188
 189 /**
 190  * struct tee_shm - shared memory object
 191  * @ctx:        context using the object
 192  * @paddr:      physical address of the shared memory
 193  * @kaddr:      virtual address of the shared memory
 194  * @size:       size of shared memory
 195  * @offset:     offset of buffer in user space
 196  * @pages:      locked pages from userspace
 197  * @num_pages:  number of locked pages
 198  * @dmabuf:     dmabuf used to for exporting to user space
 199  * @flags:      defined by TEE_SHM_* in tee_drv.h
 200  * @id:         unique id of a shared memory object on this device
 201  *
 202  * This pool is only supposed to be accessed directly from the TEE
 203  * subsystem and from drivers that implements their own shm pool manager.
 204  */
 205 struct tee_shm {
 206         struct tee_context *ctx;
 207         phys_addr_t paddr;
 208         void *kaddr;
 209         size_t size;
 210         unsigned int offset;
 211         struct page **pages;
 212         size_t num_pages;
 213         struct dma_buf *dmabuf;
 214         u32 flags;
 215         int id;
 216 };
 217
 218 /**
 219  * struct tee_shm_pool_mgr - shared memory manager
 220  * @ops:                operations
 221  * @private_data:       private data for the shared memory manager
 222  */
 223 struct tee_shm_pool_mgr {
 224         const struct tee_shm_pool_mgr_ops *ops;
 225         void *private_data;
 226 };
 227
 228 /**
 229  * struct tee_shm_pool_mgr_ops - shared memory pool manager operations
 230  * @alloc:              called when allocating shared memory
 231  * @free:               called when freeing shared memory
 232  * @destroy_poolmgr:    called when destroying the pool manager
 233  */
 234 struct tee_shm_pool_mgr_ops {
 235         int (*alloc)(struct tee_shm_pool_mgr *poolmgr, struct tee_shm *shm,
 236                      size_t size);
 237         void (*free)(struct tee_shm_pool_mgr *poolmgr, struct tee_shm *shm);
 238         void (*destroy_poolmgr)(struct tee_shm_pool_mgr *poolmgr);
 239 };
 240
 241 /**
 242  * tee_shm_pool_alloc() - Create a shared memory pool from shm managers
 243  * @priv_mgr:   manager for driver private shared memory allocations
 244  * @dmabuf_mgr: manager for dma-buf shared memory allocations
 245  *
 246  * Allocation with the flag TEE_SHM_DMA_BUF set will use the range supplied
 247  * in @dmabuf, others will use the range provided by @priv.
 248  *
 249  * @returns pointer to a 'struct tee_shm_pool' or an ERR_PTR on failure.
 250  */
 251 struct tee_shm_pool *tee_shm_pool_alloc(struct tee_shm_pool_mgr *priv_mgr,
 252                                         struct tee_shm_pool_mgr *dmabuf_mgr);
 253
 254 /*
 255  * tee_shm_pool_mgr_alloc_res_mem() - Create a shm manager for reserved
 256  * memory
 257  * @vaddr:      Virtual address of start of pool
 258  * @paddr:      Physical address of start of pool
 259  * @size:       Size in bytes of the pool
 260  *
 261  * @returns pointer to a 'struct tee_shm_pool_mgr' or an ERR_PTR on failure.
 262  */
 263 struct tee_shm_pool_mgr *tee_shm_pool_mgr_alloc_res_mem(unsigned long vaddr,
 264                                                         phys_addr_t paddr,
 265                                                         size_t size,
 266                                                         int min_alloc_order);
 267
 268 /**
 269  * tee_shm_pool_mgr_destroy() - Free a shared memory manager
 270  */
 271 static inline void tee_shm_pool_mgr_destroy(struct tee_shm_pool_mgr *poolm)
 272 {
 273         poolm->ops->destroy_poolmgr(poolm);
 274 }
 275
 276 /**
 277  * struct tee_shm_pool_mem_info - holds information needed to create a shared
 278  * memory pool
 279  * @vaddr:      Virtual address of start of pool
 280  * @paddr:      Physical address of start of pool
 281  * @size:       Size in bytes of the pool
 282  */
 283 struct tee_shm_pool_mem_info {
 284         unsigned long vaddr;
 285         phys_addr_t paddr;
 286         size_t size;
 287 };
 288
 289 /**
 290  * tee_shm_pool_alloc_res_mem() - Create a shared memory pool from reserved
 291  * memory range
 292  * @priv_info:   Information for driver private shared memory pool
 293  * @dmabuf_info: Information for dma-buf shared memory pool
 294  *
 295  * Start and end of pools will must be page aligned.
 296  *
 297  * Allocation with the flag TEE_SHM_DMA_BUF set will use the range supplied
 298  * in @dmabuf, others will use the range provided by @priv.
 299  *
 300  * @returns pointer to a 'struct tee_shm_pool' or an ERR_PTR on failure.
 301  */
 302 struct tee_shm_pool *
 303 tee_shm_pool_alloc_res_mem(struct tee_shm_pool_mem_info *priv_info,
 304                            struct tee_shm_pool_mem_info *dmabuf_info);
 305
 306 /**
 307  * tee_shm_pool_free() - Free a shared memory pool
 308  * @pool:       The shared memory pool to free
 309  *
 310  * The must be no remaining shared memory allocated from this pool when
 311  * this function is called.
 312  */
 313 void tee_shm_pool_free(struct tee_shm_pool *pool);
 314
 315 /**
 316  * tee_get_drvdata() - Return driver_data pointer
 317  * @returns the driver_data pointer supplied to tee_register().
 318  */
 319 void *tee_get_drvdata(struct tee_device *teedev);
 320
 321 /**
 322  * tee_shm_alloc() - Allocate shared memory
 323  * @ctx:        Context that allocates the shared memory
 324  * @size:       Requested size of shared memory
 325  * @flags:      Flags setting properties for the requested shared memory.
 326  *
 327  * Memory allocated as global shared memory is automatically freed when the
 328  * TEE file pointer is closed. The @flags field uses the bits defined by
 329  * TEE_SHM_* above. TEE_SHM_MAPPED must currently always be set. If
 330  * TEE_SHM_DMA_BUF global shared memory will be allocated and associated
 331  * with a dma-buf handle, else driver private memory.
 332  *
 333  * @returns a pointer to 'struct tee_shm'
 334  */
 335 struct tee_shm *tee_shm_alloc(struct tee_context *ctx, size_t size, u32 flags);
 336 struct tee_shm *tee_shm_alloc_kernel_buf(struct tee_context *ctx, size_t size);
 337
 338 /**
 339  * tee_shm_register() - Register shared memory buffer
 340  * @ctx:        Context that registers the shared memory
 341  * @addr:       Address is userspace of the shared buffer
 342  * @length:     Length of the shared buffer
 343  * @flags:      Flags setting properties for the requested shared memory.
 344  *
 345  * @returns a pointer to 'struct tee_shm'
 346  */
 347 struct tee_shm *tee_shm_register(struct tee_context *ctx, unsigned long addr,
 348                                  size_t length, u32 flags);
 349
 350 /**
 351  * tee_shm_is_registered() - Check if shared memory object in registered in TEE
 352  * @shm:        Shared memory handle
 353  * @returns true if object is registered in TEE
 354  */
 355 static inline bool tee_shm_is_registered(struct tee_shm *shm)
 356 {
 357         return shm && (shm->flags & TEE_SHM_REGISTER);
 358 }
 359
 360 /**
 361  * tee_shm_free() - Free shared memory
 362  * @shm:        Handle to shared memory to free
 363  */
 364 void tee_shm_free(struct tee_shm *shm);
 365
 366 /**
 367  * tee_shm_put() - Decrease reference count on a shared memory handle
 368  * @shm:        Shared memory handle
 369  */
 370 void tee_shm_put(struct tee_shm *shm);
 371
 372 /**
 373  * tee_shm_va2pa() - Get physical address of a virtual address
 374  * @shm:        Shared memory handle
 375  * @va:         Virtual address to tranlsate
 376  * @pa:         Returned physical address
 377  * @returns 0 on success and < 0 on failure
 378  */
 379 int tee_shm_va2pa(struct tee_shm *shm, void *va, phys_addr_t *pa);
 380
 381 /**
 382  * tee_shm_pa2va() - Get virtual address of a physical address
 383  * @shm:        Shared memory handle
 384  * @pa:         Physical address to tranlsate
 385  * @va:         Returned virtual address
 386  * @returns 0 on success and < 0 on failure
 387  */
 388 int tee_shm_pa2va(struct tee_shm *shm, phys_addr_t pa, void **va);
 389
 390 /**
 391  * tee_shm_get_va() - Get virtual address of a shared memory plus an offset
 392  * @shm:        Shared memory handle
 393  * @offs:       Offset from start of this shared memory
 394  * @returns virtual address of the shared memory + offs if offs is within
 395  *      the bounds of this shared memory, else an ERR_PTR
 396  */
 397 void *tee_shm_get_va(struct tee_shm *shm, size_t offs);
 398
 399 /**
 400  * tee_shm_get_pa() - Get physical address of a shared memory plus an offset
 401  * @shm:        Shared memory handle
 402  * @offs:       Offset from start of this shared memory
 403  * @pa:         Physical address to return
 404  * @returns 0 if offs is within the bounds of this shared memory, else an
 405  *      error code.
 406  */
 407 int tee_shm_get_pa(struct tee_shm *shm, size_t offs, phys_addr_t *pa);
 408
 409 /**
 410  * tee_shm_get_size() - Get size of shared memory buffer
 411  * @shm:        Shared memory handle
 412  * @returns size of shared memory
 413  */
 414 static inline size_t tee_shm_get_size(struct tee_shm *shm)
 415 {
 416         return shm->size;
 417 }
 418
 419 /**
 420  * tee_shm_get_pages() - Get list of pages that hold shared buffer
 421  * @shm:        Shared memory handle
 422  * @num_pages:  Number of pages will be stored there
 423  * @returns pointer to pages array
 424  */
 425 static inline struct page **tee_shm_get_pages(struct tee_shm *shm,
 426                                               size_t *num_pages)
 427 {
 428         *num_pages = shm->num_pages;
 429         return shm->pages;
 430 }
 431
 432 /**
 433  * tee_shm_get_page_offset() - Get shared buffer offset from page start
 434  * @shm:        Shared memory handle
 435  * @returns page offset of shared buffer
 436  */
 437 static inline size_t tee_shm_get_page_offset(struct tee_shm *shm)
 438 {
 439         return shm->offset;
 440 }
 441
 442 /**
 443  * tee_shm_get_id() - Get id of a shared memory object
 444  * @shm:        Shared memory handle
 445  * @returns id
 446  */
 447 static inline int tee_shm_get_id(struct tee_shm *shm)
 448 {
 449         return shm->id;
 450 }
 451
 452 /**
 453  * tee_shm_get_from_id() - Find shared memory object and increase reference
 454  * count
 455  * @ctx:        Context owning the shared memory
 456  * @id:         Id of shared memory object
 457  * @returns a pointer to 'struct tee_shm' on success or an ERR_PTR on failure
 458  */
 459 struct tee_shm *tee_shm_get_from_id(struct tee_context *ctx, int id);
 460
 461 /**
 462  * tee_client_open_context() - Open a TEE context
 463  * @start:      if not NULL, continue search after this context
 464  * @match:      function to check TEE device
 465  * @data:       data for match function
 466  * @vers:       if not NULL, version data of TEE device of the context returned
 467  *
 468  * This function does an operation similar to open("/dev/teeX") in user space.
 469  * A returned context must be released with tee_client_close_context().
 470  *
 471  * Returns a TEE context of the first TEE device matched by the match()
 472  * callback or an ERR_PTR.
 473  */
 474 struct tee_context *
 475 tee_client_open_context(struct tee_context *start,
 476                         int (*match)(struct tee_ioctl_version_data *,
 477                                      const void *),
 478                         const void *data, struct tee_ioctl_version_data *vers);
 479
 480 /**
 481  * tee_client_close_context() - Close a TEE context
 482  * @ctx:        TEE context to close
 483  *
 484  * Note that all sessions previously opened with this context will be
 485  * closed when this function is called.
 486  */
 487 void tee_client_close_context(struct tee_context *ctx);
 488
 489 /**
 490  * tee_client_get_version() - Query version of TEE
 491  * @ctx:        TEE context to TEE to query
 492  * @vers:       Pointer to version data
 493  */
 494 void tee_client_get_version(struct tee_context *ctx,
 495                             struct tee_ioctl_version_data *vers);
 496
 497 /**
 498  * tee_client_open_session() - Open a session to a Trusted Application
 499  * @ctx:        TEE context
 500  * @arg:        Open session arguments, see description of
 501  *              struct tee_ioctl_open_session_arg
 502  * @param:      Parameters passed to the Trusted Application
 503  *
 504  * Returns < 0 on error else see @arg->ret for result. If @arg->ret
 505  * is TEEC_SUCCESS the session identifier is available in @arg->session.
 506  */
 507 int tee_client_open_session(struct tee_context *ctx,
 508                             struct tee_ioctl_open_session_arg *arg,
 509                             struct tee_param *param);
 510
 511 /**
 512  * tee_client_close_session() - Close a session to a Trusted Application
 513  * @ctx:        TEE Context
 514  * @session:    Session id
 515  *
 516  * Return < 0 on error else 0, regardless the session will not be
 517  * valid after this function has returned.
 518  */
 519 int tee_client_close_session(struct tee_context *ctx, u32 session);
 520
 521 /**
 522  * tee_client_invoke_func() - Invoke a function in a Trusted Application
 523  * @ctx:        TEE Context
 524  * @arg:        Invoke arguments, see description of
 525  *              struct tee_ioctl_invoke_arg
 526  * @param:      Parameters passed to the Trusted Application
 527  *
 528  * Returns < 0 on error else see @arg->ret for result.
 529  */
 530 int tee_client_invoke_func(struct tee_context *ctx,
 531                            struct tee_ioctl_invoke_arg *arg,
 532                            struct tee_param *param);
 533
 534 /**
 535  * tee_client_cancel_req() - Request cancellation of the previous open-session
 536  * or invoke-command operations in a Trusted Application
 537  * @ctx:       TEE Context
 538  * @arg:       Cancellation arguments, see description of
 539  *             struct tee_ioctl_cancel_arg
 540  *
 541  * Returns < 0 on error else 0 if the cancellation was successfully requested.
 542  */
 543 int tee_client_cancel_req(struct tee_context *ctx,
 544                           struct tee_ioctl_cancel_arg *arg);
 545
 546 static inline bool tee_param_is_memref(struct tee_param *param)
 547 {
 548         switch (param->attr & TEE_IOCTL_PARAM_ATTR_TYPE_MASK) {
 549         case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INPUT:
 550         case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_OUTPUT:
 551         case TEE_IOCTL_PARAM_ATTR_TYPE_MEMREF_INOUT:
 552                 return true;
 553         default:
 554                 return false;
 555         }
 556 }
 557
 558 extern struct bus_type tee_bus_type;
 559
 560 /**
 561  * struct tee_client_device - tee based device
 562  * @id:                 device identifier
 563  * @dev:                device structure
 564  */
 565 struct tee_client_device {
 566         struct tee_client_device_id id;
 567         struct device dev;
 568 };
 569
 570 #define to_tee_client_device(d) container_of(d, struct tee_client_device, dev)
 571
 572 /**
 573  * struct tee_client_driver - tee client driver
 574  * @id_table:           device id table supported by this driver
 575  * @driver:             driver structure
 576  */
 577 struct tee_client_driver {
 578         const struct tee_client_device_id *id_table;
 579         struct device_driver driver;
 580 };
 581
 582 #define to_tee_client_driver(d) \
 583                 container_of(d, struct tee_client_driver, driver)
 584
 585 #endif /*__TEE_DRV_H*/