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