include/linux/iommu.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
   4  * Author: Joerg Roedel <[email protected]>
   5  */
   6
   7 #ifndef __LINUX_IOMMU_H
   8 #define __LINUX_IOMMU_H
   9
  10 #include <linux/scatterlist.h>
  11 #include <linux/device.h>
  12 #include <linux/types.h>
  13 #include <linux/errno.h>
  14 #include <linux/err.h>
  15 #include <linux/of.h>
  16 #include <linux/iova_bitmap.h>
  17
  18 #define IOMMU_READ      (1 << 0)
  19 #define IOMMU_WRITE     (1 << 1)
  20 #define IOMMU_CACHE     (1 << 2) /* DMA cache coherency */
  21 #define IOMMU_NOEXEC    (1 << 3)
  22 #define IOMMU_MMIO      (1 << 4) /* e.g. things like MSI doorbells */
  23 /*
  24  * Where the bus hardware includes a privilege level as part of its access type
  25  * markings, and certain devices are capable of issuing transactions marked as
  26  * either 'supervisor' or 'user', the IOMMU_PRIV flag requests that the other
  27  * given permission flags only apply to accesses at the higher privilege level,
  28  * and that unprivileged transactions should have as little access as possible.
  29  * This would usually imply the same permissions as kernel mappings on the CPU,
  30  * if the IOMMU page table format is equivalent.
  31  */
  32 #define IOMMU_PRIV      (1 << 5)
  33
  34 struct iommu_ops;
  35 struct iommu_group;
  36 struct bus_type;
  37 struct device;
  38 struct iommu_domain;
  39 struct iommu_domain_ops;
  40 struct iommu_dirty_ops;
  41 struct notifier_block;
  42 struct iommu_sva;
  43 struct iommu_dma_cookie;
  44 struct iommu_fault_param;
  45 struct iommufd_ctx;
  46 struct iommufd_viommu;
  47
  48 #define IOMMU_FAULT_PERM_READ   (1 << 0) /* read */
  49 #define IOMMU_FAULT_PERM_WRITE  (1 << 1) /* write */
  50 #define IOMMU_FAULT_PERM_EXEC   (1 << 2) /* exec */
  51 #define IOMMU_FAULT_PERM_PRIV   (1 << 3) /* privileged */
  52
  53 /* Generic fault types, can be expanded IRQ remapping fault */
  54 enum iommu_fault_type {
  55         IOMMU_FAULT_PAGE_REQ = 1,       /* page request fault */
  56 };
  57
  58 /**
  59  * struct iommu_fault_page_request - Page Request data
  60  * @flags: encodes whether the corresponding fields are valid and whether this
  61  *         is the last page in group (IOMMU_FAULT_PAGE_REQUEST_* values).
  62  *         When IOMMU_FAULT_PAGE_RESPONSE_NEEDS_PASID is set, the page response
  63  *         must have the same PASID value as the page request. When it is clear,
  64  *         the page response should not have a PASID.
  65  * @pasid: Process Address Space ID
  66  * @grpid: Page Request Group Index
  67  * @perm: requested page permissions (IOMMU_FAULT_PERM_* values)
  68  * @addr: page address
  69  * @private_data: device-specific private information
  70  */
  71 struct iommu_fault_page_request {
  72 #define IOMMU_FAULT_PAGE_REQUEST_PASID_VALID    (1 << 0)
  73 #define IOMMU_FAULT_PAGE_REQUEST_LAST_PAGE      (1 << 1)
  74 #define IOMMU_FAULT_PAGE_RESPONSE_NEEDS_PASID   (1 << 2)
  75         u32     flags;
  76         u32     pasid;
  77         u32     grpid;
  78         u32     perm;
  79         u64     addr;
  80         u64     private_data[2];
  81 };
  82
  83 /**
  84  * struct iommu_fault - Generic fault data
  85  * @type: fault type from &enum iommu_fault_type
  86  * @prm: Page Request message, when @type is %IOMMU_FAULT_PAGE_REQ
  87  */
  88 struct iommu_fault {
  89         u32 type;
  90         struct iommu_fault_page_request prm;
  91 };
  92
  93 /**
  94  * enum iommu_page_response_code - Return status of fault handlers
  95  * @IOMMU_PAGE_RESP_SUCCESS: Fault has been handled and the page tables
  96  *      populated, retry the access. This is "Success" in PCI PRI.
  97  * @IOMMU_PAGE_RESP_FAILURE: General error. Drop all subsequent faults from
  98  *      this device if possible. This is "Response Failure" in PCI PRI.
  99  * @IOMMU_PAGE_RESP_INVALID: Could not handle this fault, don't retry the
 100  *      access. This is "Invalid Request" in PCI PRI.
 101  */
 102 enum iommu_page_response_code {
 103         IOMMU_PAGE_RESP_SUCCESS = 0,
 104         IOMMU_PAGE_RESP_INVALID,
 105         IOMMU_PAGE_RESP_FAILURE,
 106 };
 107
 108 /**
 109  * struct iommu_page_response - Generic page response information
 110  * @pasid: Process Address Space ID
 111  * @grpid: Page Request Group Index
 112  * @code: response code from &enum iommu_page_response_code
 113  */
 114 struct iommu_page_response {
 115         u32     pasid;
 116         u32     grpid;
 117         u32     code;
 118 };
 119
 120 struct iopf_fault {
 121         struct iommu_fault fault;
 122         /* node for pending lists */
 123         struct list_head list;
 124 };
 125
 126 struct iopf_group {
 127         struct iopf_fault last_fault;
 128         struct list_head faults;
 129         size_t fault_count;
 130         /* list node for iommu_fault_param::faults */
 131         struct list_head pending_node;
 132         struct work_struct work;
 133         struct iommu_attach_handle *attach_handle;
 134         /* The device's fault data parameter. */
 135         struct iommu_fault_param *fault_param;
 136         /* Used by handler provider to hook the group on its own lists. */
 137         struct list_head node;
 138         u32 cookie;
 139 };
 140
 141 /**
 142  * struct iopf_queue - IO Page Fault queue
 143  * @wq: the fault workqueue
 144  * @devices: devices attached to this queue
 145  * @lock: protects the device list
 146  */
 147 struct iopf_queue {
 148         struct workqueue_struct *wq;
 149         struct list_head devices;
 150         struct mutex lock;
 151 };
 152
 153 /* iommu fault flags */
 154 #define IOMMU_FAULT_READ        0x0
 155 #define IOMMU_FAULT_WRITE       0x1
 156
 157 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
 158                         struct device *, unsigned long, int, void *);
 159
 160 struct iommu_domain_geometry {
 161         dma_addr_t aperture_start; /* First address that can be mapped    */
 162         dma_addr_t aperture_end;   /* Last address that can be mapped     */
 163         bool force_aperture;       /* DMA only allowed in mappable range? */
 164 };
 165
 166 /* Domain feature flags */
 167 #define __IOMMU_DOMAIN_PAGING   (1U << 0)  /* Support for iommu_map/unmap */
 168 #define __IOMMU_DOMAIN_DMA_API  (1U << 1)  /* Domain for use in DMA-API
 169                                               implementation              */
 170 #define __IOMMU_DOMAIN_PT       (1U << 2)  /* Domain is identity mapped   */
 171 #define __IOMMU_DOMAIN_DMA_FQ   (1U << 3)  /* DMA-API uses flush queue    */
 172
 173 #define __IOMMU_DOMAIN_SVA      (1U << 4)  /* Shared process address space */
 174 #define __IOMMU_DOMAIN_PLATFORM (1U << 5)
 175
 176 #define __IOMMU_DOMAIN_NESTED   (1U << 6)  /* User-managed address space nested
 177                                               on a stage-2 translation        */
 178
 179 #define IOMMU_DOMAIN_ALLOC_FLAGS ~__IOMMU_DOMAIN_DMA_FQ
 180 /*
 181  * This are the possible domain-types
 182  *
 183  *      IOMMU_DOMAIN_BLOCKED    - All DMA is blocked, can be used to isolate
 184  *                                devices
 185  *      IOMMU_DOMAIN_IDENTITY   - DMA addresses are system physical addresses
 186  *      IOMMU_DOMAIN_UNMANAGED  - DMA mappings managed by IOMMU-API user, used
 187  *                                for VMs
 188  *      IOMMU_DOMAIN_DMA        - Internally used for DMA-API implementations.
 189  *                                This flag allows IOMMU drivers to implement
 190  *                                certain optimizations for these domains
 191  *      IOMMU_DOMAIN_DMA_FQ     - As above, but definitely using batched TLB
 192  *                                invalidation.
 193  *      IOMMU_DOMAIN_SVA        - DMA addresses are shared process addresses
 194  *                                represented by mm_struct's.
 195  *      IOMMU_DOMAIN_PLATFORM   - Legacy domain for drivers that do their own
 196  *                                dma_api stuff. Do not use in new drivers.
 197  */
 198 #define IOMMU_DOMAIN_BLOCKED    (0U)
 199 #define IOMMU_DOMAIN_IDENTITY   (__IOMMU_DOMAIN_PT)
 200 #define IOMMU_DOMAIN_UNMANAGED  (__IOMMU_DOMAIN_PAGING)
 201 #define IOMMU_DOMAIN_DMA        (__IOMMU_DOMAIN_PAGING |        \
 202                                  __IOMMU_DOMAIN_DMA_API)
 203 #define IOMMU_DOMAIN_DMA_FQ     (__IOMMU_DOMAIN_PAGING |        \
 204                                  __IOMMU_DOMAIN_DMA_API |       \
 205                                  __IOMMU_DOMAIN_DMA_FQ)
 206 #define IOMMU_DOMAIN_SVA        (__IOMMU_DOMAIN_SVA)
 207 #define IOMMU_DOMAIN_PLATFORM   (__IOMMU_DOMAIN_PLATFORM)
 208 #define IOMMU_DOMAIN_NESTED     (__IOMMU_DOMAIN_NESTED)
 209
 210 struct iommu_domain {
 211         unsigned type;
 212         const struct iommu_domain_ops *ops;
 213         const struct iommu_dirty_ops *dirty_ops;
 214         const struct iommu_ops *owner; /* Whose domain_alloc we came from */
 215         unsigned long pgsize_bitmap;    /* Bitmap of page sizes in use */
 216         struct iommu_domain_geometry geometry;
 217         struct iommu_dma_cookie *iova_cookie;
 218         int (*iopf_handler)(struct iopf_group *group);
 219         void *fault_data;
 220         union {
 221                 struct {
 222                         iommu_fault_handler_t handler;
 223                         void *handler_token;
 224                 };
 225                 struct {        /* IOMMU_DOMAIN_SVA */
 226                         struct mm_struct *mm;
 227                         int users;
 228                         /*
 229                          * Next iommu_domain in mm->iommu_mm->sva-domains list
 230                          * protected by iommu_sva_lock.
 231                          */
 232                         struct list_head next;
 233                 };
 234         };
 235 };
 236
 237 static inline bool iommu_is_dma_domain(struct iommu_domain *domain)
 238 {
 239         return domain->type & __IOMMU_DOMAIN_DMA_API;
 240 }
 241
 242 enum iommu_cap {
 243         IOMMU_CAP_CACHE_COHERENCY,      /* IOMMU_CACHE is supported */
 244         IOMMU_CAP_NOEXEC,               /* IOMMU_NOEXEC flag */
 245         IOMMU_CAP_PRE_BOOT_PROTECTION,  /* Firmware says it used the IOMMU for
 246                                            DMA protection and we should too */
 247         /*
 248          * Per-device flag indicating if enforce_cache_coherency() will work on
 249          * this device.
 250          */
 251         IOMMU_CAP_ENFORCE_CACHE_COHERENCY,
 252         /*
 253          * IOMMU driver does not issue TLB maintenance during .unmap, so can
 254          * usefully support the non-strict DMA flush queue.
 255          */
 256         IOMMU_CAP_DEFERRED_FLUSH,
 257         IOMMU_CAP_DIRTY_TRACKING,       /* IOMMU supports dirty tracking */
 258 };
 259
 260 /* These are the possible reserved region types */
 261 enum iommu_resv_type {
 262         /* Memory regions which must be mapped 1:1 at all times */
 263         IOMMU_RESV_DIRECT,
 264         /*
 265          * Memory regions which are advertised to be 1:1 but are
 266          * commonly considered relaxable in some conditions,
 267          * for instance in device assignment use case (USB, Graphics)
 268          */
 269         IOMMU_RESV_DIRECT_RELAXABLE,
 270         /* Arbitrary "never map this or give it to a device" address ranges */
 271         IOMMU_RESV_RESERVED,
 272         /* Hardware MSI region (untranslated) */
 273         IOMMU_RESV_MSI,
 274         /* Software-managed MSI translation window */
 275         IOMMU_RESV_SW_MSI,
 276 };
 277
 278 /**
 279  * struct iommu_resv_region - descriptor for a reserved memory region
 280  * @list: Linked list pointers
 281  * @start: System physical start address of the region
 282  * @length: Length of the region in bytes
 283  * @prot: IOMMU Protection flags (READ/WRITE/...)
 284  * @type: Type of the reserved region
 285  * @free: Callback to free associated memory allocations
 286  */
 287 struct iommu_resv_region {
 288         struct list_head        list;
 289         phys_addr_t             start;
 290         size_t                  length;
 291         int                     prot;
 292         enum iommu_resv_type    type;
 293         void (*free)(struct device *dev, struct iommu_resv_region *region);
 294 };
 295
 296 struct iommu_iort_rmr_data {
 297         struct iommu_resv_region rr;
 298
 299         /* Stream IDs associated with IORT RMR entry */
 300         const u32 *sids;
 301         u32 num_sids;
 302 };
 303
 304 /**
 305  * enum iommu_dev_features - Per device IOMMU features
 306  * @IOMMU_DEV_FEAT_SVA: Shared Virtual Addresses
 307  * @IOMMU_DEV_FEAT_IOPF: I/O Page Faults such as PRI or Stall. Generally
 308  *                       enabling %IOMMU_DEV_FEAT_SVA requires
 309  *                       %IOMMU_DEV_FEAT_IOPF, but some devices manage I/O Page
 310  *                       Faults themselves instead of relying on the IOMMU. When
 311  *                       supported, this feature must be enabled before and
 312  *                       disabled after %IOMMU_DEV_FEAT_SVA.
 313  *
 314  * Device drivers enable a feature using iommu_dev_enable_feature().
 315  */
 316 enum iommu_dev_features {
 317         IOMMU_DEV_FEAT_SVA,
 318         IOMMU_DEV_FEAT_IOPF,
 319 };
 320
 321 #define IOMMU_NO_PASID  (0U) /* Reserved for DMA w/o PASID */
 322 #define IOMMU_FIRST_GLOBAL_PASID        (1U) /*starting range for allocation */
 323 #define IOMMU_PASID_INVALID     (-1U)
 324 typedef unsigned int ioasid_t;
 325
 326 /* Read but do not clear any dirty bits */
 327 #define IOMMU_DIRTY_NO_CLEAR (1 << 0)
 328
 329 #ifdef CONFIG_IOMMU_API
 330
 331 /**
 332  * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
 333  *
 334  * @start: IOVA representing the start of the range to be flushed
 335  * @end: IOVA representing the end of the range to be flushed (inclusive)
 336  * @pgsize: The interval at which to perform the flush
 337  * @freelist: Removed pages to free after sync
 338  * @queued: Indicates that the flush will be queued
 339  *
 340  * This structure is intended to be updated by multiple calls to the
 341  * ->unmap() function in struct iommu_ops before eventually being passed
 342  * into ->iotlb_sync(). Drivers can add pages to @freelist to be freed after
 343  * ->iotlb_sync() or ->iotlb_flush_all() have cleared all cached references to
 344  * them. @queued is set to indicate when ->iotlb_flush_all() will be called
 345  * later instead of ->iotlb_sync(), so drivers may optimise accordingly.
 346  */
 347 struct iommu_iotlb_gather {
 348         unsigned long           start;
 349         unsigned long           end;
 350         size_t                  pgsize;
 351         struct list_head        freelist;
 352         bool                    queued;
 353 };
 354
 355 /**
 356  * struct iommu_dirty_bitmap - Dirty IOVA bitmap state
 357  * @bitmap: IOVA bitmap
 358  * @gather: Range information for a pending IOTLB flush
 359  */
 360 struct iommu_dirty_bitmap {
 361         struct iova_bitmap *bitmap;
 362         struct iommu_iotlb_gather *gather;
 363 };
 364
 365 /**
 366  * struct iommu_dirty_ops - domain specific dirty tracking operations
 367  * @set_dirty_tracking: Enable or Disable dirty tracking on the iommu domain
 368  * @read_and_clear_dirty: Walk IOMMU page tables for dirtied PTEs marshalled
 369  *                        into a bitmap, with a bit represented as a page.
 370  *                        Reads the dirty PTE bits and clears it from IO
 371  *                        pagetables.
 372  */
 373 struct iommu_dirty_ops {
 374         int (*set_dirty_tracking)(struct iommu_domain *domain, bool enabled);
 375         int (*read_and_clear_dirty)(struct iommu_domain *domain,
 376                                     unsigned long iova, size_t size,
 377                                     unsigned long flags,
 378                                     struct iommu_dirty_bitmap *dirty);
 379 };
 380
 381 /**
 382  * struct iommu_user_data - iommu driver specific user space data info
 383  * @type: The data type of the user buffer
 384  * @uptr: Pointer to the user buffer for copy_from_user()
 385  * @len: The length of the user buffer in bytes
 386  *
 387  * A user space data is an uAPI that is defined in include/uapi/linux/iommufd.h
 388  * @type, @uptr and @len should be just copied from an iommufd core uAPI struct.
 389  */
 390 struct iommu_user_data {
 391         unsigned int type;
 392         void __user *uptr;
 393         size_t len;
 394 };
 395
 396 /**
 397  * struct iommu_user_data_array - iommu driver specific user space data array
 398  * @type: The data type of all the entries in the user buffer array
 399  * @uptr: Pointer to the user buffer array
 400  * @entry_len: The fixed-width length of an entry in the array, in bytes
 401  * @entry_num: The number of total entries in the array
 402  *
 403  * The user buffer includes an array of requests with format defined in
 404  * include/uapi/linux/iommufd.h
 405  */
 406 struct iommu_user_data_array {
 407         unsigned int type;
 408         void __user *uptr;
 409         size_t entry_len;
 410         u32 entry_num;
 411 };
 412
 413 /**
 414  * __iommu_copy_struct_from_user - Copy iommu driver specific user space data
 415  * @dst_data: Pointer to an iommu driver specific user data that is defined in
 416  *            include/uapi/linux/iommufd.h
 417  * @src_data: Pointer to a struct iommu_user_data for user space data info
 418  * @data_type: The data type of the @dst_data. Must match with @src_data.type
 419  * @data_len: Length of current user data structure, i.e. sizeof(struct _dst)
 420  * @min_len: Initial length of user data structure for backward compatibility.
 421  *           This should be offsetofend using the last member in the user data
 422  *           struct that was initially added to include/uapi/linux/iommufd.h
 423  */
 424 static inline int __iommu_copy_struct_from_user(
 425         void *dst_data, const struct iommu_user_data *src_data,
 426         unsigned int data_type, size_t data_len, size_t min_len)
 427 {
 428         if (src_data->type != data_type)
 429                 return -EINVAL;
 430         if (WARN_ON(!dst_data || !src_data))
 431                 return -EINVAL;
 432         if (src_data->len < min_len || data_len < src_data->len)
 433                 return -EINVAL;
 434         return copy_struct_from_user(dst_data, data_len, src_data->uptr,
 435                                      src_data->len);
 436 }
 437
 438 /**
 439  * iommu_copy_struct_from_user - Copy iommu driver specific user space data
 440  * @kdst: Pointer to an iommu driver specific user data that is defined in
 441  *        include/uapi/linux/iommufd.h
 442  * @user_data: Pointer to a struct iommu_user_data for user space data info
 443  * @data_type: The data type of the @kdst. Must match with @user_data->type
 444  * @min_last: The last memember of the data structure @kdst points in the
 445  *            initial version.
 446  * Return 0 for success, otherwise -error.
 447  */
 448 #define iommu_copy_struct_from_user(kdst, user_data, data_type, min_last) \
 449         __iommu_copy_struct_from_user(kdst, user_data, data_type,         \
 450                                       sizeof(*kdst),                      \
 451                                       offsetofend(typeof(*kdst), min_last))
 452
 453 /**
 454  * __iommu_copy_struct_from_user_array - Copy iommu driver specific user space
 455  *                                       data from an iommu_user_data_array
 456  * @dst_data: Pointer to an iommu driver specific user data that is defined in
 457  *            include/uapi/linux/iommufd.h
 458  * @src_array: Pointer to a struct iommu_user_data_array for a user space array
 459  * @data_type: The data type of the @dst_data. Must match with @src_array.type
 460  * @index: Index to the location in the array to copy user data from
 461  * @data_len: Length of current user data structure, i.e. sizeof(struct _dst)
 462  * @min_len: Initial length of user data structure for backward compatibility.
 463  *           This should be offsetofend using the last member in the user data
 464  *           struct that was initially added to include/uapi/linux/iommufd.h
 465  */
 466 static inline int __iommu_copy_struct_from_user_array(
 467         void *dst_data, const struct iommu_user_data_array *src_array,
 468         unsigned int data_type, unsigned int index, size_t data_len,
 469         size_t min_len)
 470 {
 471         struct iommu_user_data src_data;
 472
 473         if (WARN_ON(!src_array || index >= src_array->entry_num))
 474                 return -EINVAL;
 475         if (!src_array->entry_num)
 476                 return -EINVAL;
 477         src_data.uptr = src_array->uptr + src_array->entry_len * index;
 478         src_data.len = src_array->entry_len;
 479         src_data.type = src_array->type;
 480
 481         return __iommu_copy_struct_from_user(dst_data, &src_data, data_type,
 482                                              data_len, min_len);
 483 }
 484
 485 /**
 486  * iommu_copy_struct_from_user_array - Copy iommu driver specific user space
 487  *                                     data from an iommu_user_data_array
 488  * @kdst: Pointer to an iommu driver specific user data that is defined in
 489  *        include/uapi/linux/iommufd.h
 490  * @user_array: Pointer to a struct iommu_user_data_array for a user space
 491  *              array
 492  * @data_type: The data type of the @kdst. Must match with @user_array->type
 493  * @index: Index to the location in the array to copy user data from
 494  * @min_last: The last member of the data structure @kdst points in the
 495  *            initial version.
 496  *
 497  * Copy a single entry from a user array. Return 0 for success, otherwise
 498  * -error.
 499  */
 500 #define iommu_copy_struct_from_user_array(kdst, user_array, data_type, index, \
 501                                           min_last)                           \
 502         __iommu_copy_struct_from_user_array(                                  \
 503                 kdst, user_array, data_type, index, sizeof(*(kdst)),          \
 504                 offsetofend(typeof(*(kdst)), min_last))
 505
 506 /**
 507  * iommu_copy_struct_from_full_user_array - Copy iommu driver specific user
 508  *         space data from an iommu_user_data_array
 509  * @kdst: Pointer to an iommu driver specific user data that is defined in
 510  *        include/uapi/linux/iommufd.h
 511  * @kdst_entry_size: sizeof(*kdst)
 512  * @user_array: Pointer to a struct iommu_user_data_array for a user space
 513  *              array
 514  * @data_type: The data type of the @kdst. Must match with @user_array->type
 515  *
 516  * Copy the entire user array. kdst must have room for kdst_entry_size *
 517  * user_array->entry_num bytes. Return 0 for success, otherwise -error.
 518  */
 519 static inline int
 520 iommu_copy_struct_from_full_user_array(void *kdst, size_t kdst_entry_size,
 521                                        struct iommu_user_data_array *user_array,
 522                                        unsigned int data_type)
 523 {
 524         unsigned int i;
 525         int ret;
 526
 527         if (user_array->type != data_type)
 528                 return -EINVAL;
 529         if (!user_array->entry_num)
 530                 return -EINVAL;
 531         if (likely(user_array->entry_len == kdst_entry_size)) {
 532                 if (copy_from_user(kdst, user_array->uptr,
 533                                    user_array->entry_num *
 534                                            user_array->entry_len))
 535                         return -EFAULT;
 536         }
 537
 538         /* Copy item by item */
 539         for (i = 0; i != user_array->entry_num; i++) {
 540                 ret = copy_struct_from_user(
 541                         kdst + kdst_entry_size * i, kdst_entry_size,
 542                         user_array->uptr + user_array->entry_len * i,
 543                         user_array->entry_len);
 544                 if (ret)
 545                         return ret;
 546         }
 547         return 0;
 548 }
 549
 550 /**
 551  * struct iommu_ops - iommu ops and capabilities
 552  * @capable: check capability
 553  * @hw_info: report iommu hardware information. The data buffer returned by this
 554  *           op is allocated in the iommu driver and freed by the caller after
 555  *           use. The information type is one of enum iommu_hw_info_type defined
 556  *           in include/uapi/linux/iommufd.h.
 557  * @domain_alloc: allocate and return an iommu domain if success. Otherwise
 558  *                NULL is returned. The domain is not fully initialized until
 559  *                the caller iommu_domain_alloc() returns.
 560  * @domain_alloc_paging_flags: Allocate an iommu domain corresponding to the
 561  *                     input parameters as defined in
 562  *                     include/uapi/linux/iommufd.h. The @user_data can be
 563  *                     optionally provided, the new domain must support
 564  *                     __IOMMU_DOMAIN_PAGING. Upon failure, ERR_PTR must be
 565  *                     returned.
 566  * @domain_alloc_paging: Allocate an iommu_domain that can be used for
 567  *                       UNMANAGED, DMA, and DMA_FQ domain types. This is the
 568  *                       same as invoking domain_alloc_paging_flags() with
 569  *                       @flags=0, @user_data=NULL. A driver should implement
 570  *                       only one of the two ops.
 571  * @domain_alloc_sva: Allocate an iommu_domain for Shared Virtual Addressing.
 572  * @domain_alloc_nested: Allocate an iommu_domain for nested translation.
 573  * @probe_device: Add device to iommu driver handling
 574  * @release_device: Remove device from iommu driver handling
 575  * @probe_finalize: Do final setup work after the device is added to an IOMMU
 576  *                  group and attached to the groups domain
 577  * @device_group: find iommu group for a particular device
 578  * @get_resv_regions: Request list of reserved regions for a device
 579  * @of_xlate: add OF master IDs to iommu grouping
 580  * @is_attach_deferred: Check if domain attach should be deferred from iommu
 581  *                      driver init to device driver init (default no)
 582  * @dev_enable/disable_feat: per device entries to enable/disable
 583  *                               iommu specific features.
 584  * @page_response: handle page request response
 585  * @def_domain_type: device default domain type, return value:
 586  *              - IOMMU_DOMAIN_IDENTITY: must use an identity domain
 587  *              - IOMMU_DOMAIN_DMA: must use a dma domain
 588  *              - 0: use the default setting
 589  * @default_domain_ops: the default ops for domains
 590  * @viommu_alloc: Allocate an iommufd_viommu on a physical IOMMU instance behind
 591  *                the @dev, as the set of virtualization resources shared/passed
 592  *                to user space IOMMU instance. And associate it with a nesting
 593  *                @parent_domain. The @viommu_type must be defined in the header
 594  *                include/uapi/linux/iommufd.h
 595  *                It is required to call iommufd_viommu_alloc() helper for
 596  *                a bundled allocation of the core and the driver structures,
 597  *                using the given @ictx pointer.
 598  * @pgsize_bitmap: bitmap of all possible supported page sizes
 599  * @owner: Driver module providing these ops
 600  * @identity_domain: An always available, always attachable identity
 601  *                   translation.
 602  * @blocked_domain: An always available, always attachable blocking
 603  *                  translation.
 604  * @default_domain: If not NULL this will always be set as the default domain.
 605  *                  This should be an IDENTITY/BLOCKED/PLATFORM domain.
 606  *                  Do not use in new drivers.
 607  * @user_pasid_table: IOMMU driver supports user-managed PASID table. There is
 608  *                    no user domain for each PASID and the I/O page faults are
 609  *                    forwarded through the user domain attached to the device
 610  *                    RID.
 611  */
 612 struct iommu_ops {
 613         bool (*capable)(struct device *dev, enum iommu_cap);
 614         void *(*hw_info)(struct device *dev, u32 *length, u32 *type);
 615
 616         /* Domain allocation and freeing by the iommu driver */
 617         struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
 618         struct iommu_domain *(*domain_alloc_paging_flags)(
 619                 struct device *dev, u32 flags,
 620                 const struct iommu_user_data *user_data);
 621         struct iommu_domain *(*domain_alloc_paging)(struct device *dev);
 622         struct iommu_domain *(*domain_alloc_sva)(struct device *dev,
 623                                                  struct mm_struct *mm);
 624         struct iommu_domain *(*domain_alloc_nested)(
 625                 struct device *dev, struct iommu_domain *parent, u32 flags,
 626                 const struct iommu_user_data *user_data);
 627
 628         struct iommu_device *(*probe_device)(struct device *dev);
 629         void (*release_device)(struct device *dev);
 630         void (*probe_finalize)(struct device *dev);
 631         struct iommu_group *(*device_group)(struct device *dev);
 632
 633         /* Request/Free a list of reserved regions for a device */
 634         void (*get_resv_regions)(struct device *dev, struct list_head *list);
 635
 636         int (*of_xlate)(struct device *dev, const struct of_phandle_args *args);
 637         bool (*is_attach_deferred)(struct device *dev);
 638
 639         /* Per device IOMMU features */
 640         int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
 641         int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
 642
 643         void (*page_response)(struct device *dev, struct iopf_fault *evt,
 644                               struct iommu_page_response *msg);
 645
 646         int (*def_domain_type)(struct device *dev);
 647
 648         struct iommufd_viommu *(*viommu_alloc)(
 649                 struct device *dev, struct iommu_domain *parent_domain,
 650                 struct iommufd_ctx *ictx, unsigned int viommu_type);
 651
 652         const struct iommu_domain_ops *default_domain_ops;
 653         unsigned long pgsize_bitmap;
 654         struct module *owner;
 655         struct iommu_domain *identity_domain;
 656         struct iommu_domain *blocked_domain;
 657         struct iommu_domain *release_domain;
 658         struct iommu_domain *default_domain;
 659         u8 user_pasid_table:1;
 660 };
 661
 662 /**
 663  * struct iommu_domain_ops - domain specific operations
 664  * @attach_dev: attach an iommu domain to a device
 665  *  Return:
 666  * * 0          - success
 667  * * EINVAL     - can indicate that device and domain are incompatible due to
 668  *                some previous configuration of the domain, in which case the
 669  *                driver shouldn't log an error, since it is legitimate for a
 670  *                caller to test reuse of existing domains. Otherwise, it may
 671  *                still represent some other fundamental problem
 672  * * ENOMEM     - out of memory
 673  * * ENOSPC     - non-ENOMEM type of resource allocation failures
 674  * * EBUSY      - device is attached to a domain and cannot be changed
 675  * * ENODEV     - device specific errors, not able to be attached
 676  * * <others>   - treated as ENODEV by the caller. Use is discouraged
 677  * @set_dev_pasid: set or replace an iommu domain to a pasid of device. The pasid of
 678  *                 the device should be left in the old config in error case.
 679  * @map_pages: map a physically contiguous set of pages of the same size to
 680  *             an iommu domain.
 681  * @unmap_pages: unmap a number of pages of the same size from an iommu domain
 682  * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
 683  * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
 684  * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
 685  *            queue
 686  * @cache_invalidate_user: Flush hardware cache for user space IO page table.
 687  *                         The @domain must be IOMMU_DOMAIN_NESTED. The @array
 688  *                         passes in the cache invalidation requests, in form
 689  *                         of a driver data structure. The driver must update
 690  *                         array->entry_num to report the number of handled
 691  *                         invalidation requests. The driver data structure
 692  *                         must be defined in include/uapi/linux/iommufd.h
 693  * @iova_to_phys: translate iova to physical address
 694  * @enforce_cache_coherency: Prevent any kind of DMA from bypassing IOMMU_CACHE,
 695  *                           including no-snoop TLPs on PCIe or other platform
 696  *                           specific mechanisms.
 697  * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
 698  * @free: Release the domain after use.
 699  */
 700 struct iommu_domain_ops {
 701         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
 702         int (*set_dev_pasid)(struct iommu_domain *domain, struct device *dev,
 703                              ioasid_t pasid, struct iommu_domain *old);
 704
 705         int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
 706                          phys_addr_t paddr, size_t pgsize, size_t pgcount,
 707                          int prot, gfp_t gfp, size_t *mapped);
 708         size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
 709                               size_t pgsize, size_t pgcount,
 710                               struct iommu_iotlb_gather *iotlb_gather);
 711
 712         void (*flush_iotlb_all)(struct iommu_domain *domain);
 713         int (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
 714                               size_t size);
 715         void (*iotlb_sync)(struct iommu_domain *domain,
 716                            struct iommu_iotlb_gather *iotlb_gather);
 717         int (*cache_invalidate_user)(struct iommu_domain *domain,
 718                                      struct iommu_user_data_array *array);
 719
 720         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
 721                                     dma_addr_t iova);
 722
 723         bool (*enforce_cache_coherency)(struct iommu_domain *domain);
 724         int (*set_pgtable_quirks)(struct iommu_domain *domain,
 725                                   unsigned long quirks);
 726
 727         void (*free)(struct iommu_domain *domain);
 728 };
 729
 730 /**
 731  * struct iommu_device - IOMMU core representation of one IOMMU hardware
 732  *                       instance
 733  * @list: Used by the iommu-core to keep a list of registered iommus
 734  * @ops: iommu-ops for talking to this iommu
 735  * @dev: struct device for sysfs handling
 736  * @singleton_group: Used internally for drivers that have only one group
 737  * @max_pasids: number of supported PASIDs
 738  */
 739 struct iommu_device {
 740         struct list_head list;
 741         const struct iommu_ops *ops;
 742         struct fwnode_handle *fwnode;
 743         struct device *dev;
 744         struct iommu_group *singleton_group;
 745         u32 max_pasids;
 746 };
 747
 748 /**
 749  * struct iommu_fault_param - per-device IOMMU fault data
 750  * @lock: protect pending faults list
 751  * @users: user counter to manage the lifetime of the data
 752  * @rcu: rcu head for kfree_rcu()
 753  * @dev: the device that owns this param
 754  * @queue: IOPF queue
 755  * @queue_list: index into queue->devices
 756  * @partial: faults that are part of a Page Request Group for which the last
 757  *           request hasn't been submitted yet.
 758  * @faults: holds the pending faults which need response
 759  */
 760 struct iommu_fault_param {
 761         struct mutex lock;
 762         refcount_t users;
 763         struct rcu_head rcu;
 764
 765         struct device *dev;
 766         struct iopf_queue *queue;
 767         struct list_head queue_list;
 768
 769         struct list_head partial;
 770         struct list_head faults;
 771 };
 772
 773 /**
 774  * struct dev_iommu - Collection of per-device IOMMU data
 775  *
 776  * @fault_param: IOMMU detected device fault reporting data
 777  * @fwspec:      IOMMU fwspec data
 778  * @iommu_dev:   IOMMU device this device is linked to
 779  * @priv:        IOMMU Driver private data
 780  * @max_pasids:  number of PASIDs this device can consume
 781  * @attach_deferred: the dma domain attachment is deferred
 782  * @pci_32bit_workaround: Limit DMA allocations to 32-bit IOVAs
 783  * @require_direct: device requires IOMMU_RESV_DIRECT regions
 784  * @shadow_on_flush: IOTLB flushes are used to sync shadow tables
 785  *
 786  * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
 787  *      struct iommu_group      *iommu_group;
 788  */
 789 struct dev_iommu {
 790         struct mutex lock;
 791         struct iommu_fault_param __rcu  *fault_param;
 792         struct iommu_fwspec             *fwspec;
 793         struct iommu_device             *iommu_dev;
 794         void                            *priv;
 795         u32                             max_pasids;
 796         u32                             attach_deferred:1;
 797         u32                             pci_32bit_workaround:1;
 798         u32                             require_direct:1;
 799         u32                             shadow_on_flush:1;
 800 };
 801
 802 int iommu_device_register(struct iommu_device *iommu,
 803                           const struct iommu_ops *ops,
 804                           struct device *hwdev);
 805 void iommu_device_unregister(struct iommu_device *iommu);
 806 int  iommu_device_sysfs_add(struct iommu_device *iommu,
 807                             struct device *parent,
 808                             const struct attribute_group **groups,
 809                             const char *fmt, ...) __printf(4, 5);
 810 void iommu_device_sysfs_remove(struct iommu_device *iommu);
 811 int  iommu_device_link(struct iommu_device   *iommu, struct device *link);
 812 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
 813 int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
 814
 815 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
 816 {
 817         return (struct iommu_device *)dev_get_drvdata(dev);
 818 }
 819
 820 /**
 821  * iommu_get_iommu_dev - Get iommu_device for a device
 822  * @dev: an end-point device
 823  *
 824  * Note that this function must be called from the iommu_ops
 825  * to retrieve the iommu_device for a device, which the core code
 826  * guarentees it will not invoke the op without an attached iommu.
 827  */
 828 static inline struct iommu_device *__iommu_get_iommu_dev(struct device *dev)
 829 {
 830         return dev->iommu->iommu_dev;
 831 }
 832
 833 #define iommu_get_iommu_dev(dev, type, member) \
 834         container_of(__iommu_get_iommu_dev(dev), type, member)
 835
 836 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
 837 {
 838         *gather = (struct iommu_iotlb_gather) {
 839                 .start  = ULONG_MAX,
 840                 .freelist = LIST_HEAD_INIT(gather->freelist),
 841         };
 842 }
 843
 844 extern bool device_iommu_capable(struct device *dev, enum iommu_cap cap);
 845 extern bool iommu_group_has_isolated_msi(struct iommu_group *group);
 846 struct iommu_domain *iommu_paging_domain_alloc_flags(struct device *dev, unsigned int flags);
 847 static inline struct iommu_domain *iommu_paging_domain_alloc(struct device *dev)
 848 {
 849         return iommu_paging_domain_alloc_flags(dev, 0);
 850 }
 851 extern void iommu_domain_free(struct iommu_domain *domain);
 852 extern int iommu_attach_device(struct iommu_domain *domain,
 853                                struct device *dev);
 854 extern void iommu_detach_device(struct iommu_domain *domain,
 855                                 struct device *dev);
 856 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
 857 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
 858 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 859                      phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
 860 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 861                           size_t size);
 862 extern size_t iommu_unmap_fast(struct iommu_domain *domain,
 863                                unsigned long iova, size_t size,
 864                                struct iommu_iotlb_gather *iotlb_gather);
 865 extern ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
 866                             struct scatterlist *sg, unsigned int nents,
 867                             int prot, gfp_t gfp);
 868 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
 869 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 870                         iommu_fault_handler_t handler, void *token);
 871
 872 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
 873 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
 874 extern void iommu_set_default_passthrough(bool cmd_line);
 875 extern void iommu_set_default_translated(bool cmd_line);
 876 extern bool iommu_default_passthrough(void);
 877 extern struct iommu_resv_region *
 878 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
 879                         enum iommu_resv_type type, gfp_t gfp);
 880 extern int iommu_get_group_resv_regions(struct iommu_group *group,
 881                                         struct list_head *head);
 882
 883 extern int iommu_attach_group(struct iommu_domain *domain,
 884                               struct iommu_group *group);
 885 extern void iommu_detach_group(struct iommu_domain *domain,
 886                                struct iommu_group *group);
 887 extern struct iommu_group *iommu_group_alloc(void);
 888 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 889 extern void iommu_group_set_iommudata(struct iommu_group *group,
 890                                       void *iommu_data,
 891                                       void (*release)(void *iommu_data));
 892 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 893 extern int iommu_group_add_device(struct iommu_group *group,
 894                                   struct device *dev);
 895 extern void iommu_group_remove_device(struct device *dev);
 896 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 897                                     int (*fn)(struct device *, void *));
 898 extern struct iommu_group *iommu_group_get(struct device *dev);
 899 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
 900 extern void iommu_group_put(struct iommu_group *group);
 901
 902 extern int iommu_group_id(struct iommu_group *group);
 903 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
 904
 905 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
 906                 unsigned long quirks);
 907
 908 void iommu_set_dma_strict(void);
 909
 910 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
 911                               unsigned long iova, int flags);
 912
 913 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
 914 {
 915         if (domain->ops->flush_iotlb_all)
 916                 domain->ops->flush_iotlb_all(domain);
 917 }
 918
 919 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
 920                                   struct iommu_iotlb_gather *iotlb_gather)
 921 {
 922         if (domain->ops->iotlb_sync)
 923                 domain->ops->iotlb_sync(domain, iotlb_gather);
 924
 925         iommu_iotlb_gather_init(iotlb_gather);
 926 }
 927
 928 /**
 929  * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
 930  *
 931  * @gather: TLB gather data
 932  * @iova: start of page to invalidate
 933  * @size: size of page to invalidate
 934  *
 935  * Helper for IOMMU drivers to check whether a new range and the gathered range
 936  * are disjoint. For many IOMMUs, flushing the IOMMU in this case is better
 937  * than merging the two, which might lead to unnecessary invalidations.
 938  */
 939 static inline
 940 bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
 941                                     unsigned long iova, size_t size)
 942 {
 943         unsigned long start = iova, end = start + size - 1;
 944
 945         return gather->end != 0 &&
 946                 (end + 1 < gather->start || start > gather->end + 1);
 947 }
 948
 949
 950 /**
 951  * iommu_iotlb_gather_add_range - Gather for address-based TLB invalidation
 952  * @gather: TLB gather data
 953  * @iova: start of page to invalidate
 954  * @size: size of page to invalidate
 955  *
 956  * Helper for IOMMU drivers to build arbitrarily-sized invalidation commands
 957  * where only the address range matters, and simply minimising intermediate
 958  * syncs is preferred.
 959  */
 960 static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
 961                                                 unsigned long iova, size_t size)
 962 {
 963         unsigned long end = iova + size - 1;
 964
 965         if (gather->start > iova)
 966                 gather->start = iova;
 967         if (gather->end < end)
 968                 gather->end = end;
 969 }
 970
 971 /**
 972  * iommu_iotlb_gather_add_page - Gather for page-based TLB invalidation
 973  * @domain: IOMMU domain to be invalidated
 974  * @gather: TLB gather data
 975  * @iova: start of page to invalidate
 976  * @size: size of page to invalidate
 977  *
 978  * Helper for IOMMU drivers to build invalidation commands based on individual
 979  * pages, or with page size/table level hints which cannot be gathered if they
 980  * differ.
 981  */
 982 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
 983                                                struct iommu_iotlb_gather *gather,
 984                                                unsigned long iova, size_t size)
 985 {
 986         /*
 987          * If the new page is disjoint from the current range or is mapped at
 988          * a different granularity, then sync the TLB so that the gather
 989          * structure can be rewritten.
 990          */
 991         if ((gather->pgsize && gather->pgsize != size) ||
 992             iommu_iotlb_gather_is_disjoint(gather, iova, size))
 993                 iommu_iotlb_sync(domain, gather);
 994
 995         gather->pgsize = size;
 996         iommu_iotlb_gather_add_range(gather, iova, size);
 997 }
 998
 999 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
1000 {
1001         return gather && gather->queued;
1002 }
1003
1004 static inline void iommu_dirty_bitmap_init(struct iommu_dirty_bitmap *dirty,
1005                                            struct iova_bitmap *bitmap,
1006                                            struct iommu_iotlb_gather *gather)
1007 {
1008         if (gather)
1009                 iommu_iotlb_gather_init(gather);
1010
1011         dirty->bitmap = bitmap;
1012         dirty->gather = gather;
1013 }
1014
1015 static inline void iommu_dirty_bitmap_record(struct iommu_dirty_bitmap *dirty,
1016                                              unsigned long iova,
1017                                              unsigned long length)
1018 {
1019         if (dirty->bitmap)
1020                 iova_bitmap_set(dirty->bitmap, iova, length);
1021
1022         if (dirty->gather)
1023                 iommu_iotlb_gather_add_range(dirty->gather, iova, length);
1024 }
1025
1026 /* PCI device grouping function */
1027 extern struct iommu_group *pci_device_group(struct device *dev);
1028 /* Generic device grouping function */
1029 extern struct iommu_group *generic_device_group(struct device *dev);
1030 /* FSL-MC device grouping function */
1031 struct iommu_group *fsl_mc_device_group(struct device *dev);
1032 extern struct iommu_group *generic_single_device_group(struct device *dev);
1033
1034 /**
1035  * struct iommu_fwspec - per-device IOMMU instance data
1036  * @iommu_fwnode: firmware handle for this device's IOMMU
1037  * @flags: IOMMU_FWSPEC_* flags
1038  * @num_ids: number of associated device IDs
1039  * @ids: IDs which this device may present to the IOMMU
1040  *
1041  * Note that the IDs (and any other information, really) stored in this structure should be
1042  * considered private to the IOMMU device driver and are not to be used directly by IOMMU
1043  * consumers.
1044  */
1045 struct iommu_fwspec {
1046         struct fwnode_handle    *iommu_fwnode;
1047         u32                     flags;
1048         unsigned int            num_ids;
1049         u32                     ids[];
1050 };
1051
1052 /* ATS is supported */
1053 #define IOMMU_FWSPEC_PCI_RC_ATS                 (1 << 0)
1054 /* CANWBS is supported */
1055 #define IOMMU_FWSPEC_PCI_RC_CANWBS              (1 << 1)
1056
1057 /*
1058  * An iommu attach handle represents a relationship between an iommu domain
1059  * and a PASID or RID of a device. It is allocated and managed by the component
1060  * that manages the domain and is stored in the iommu group during the time the
1061  * domain is attached.
1062  */
1063 struct iommu_attach_handle {
1064         struct iommu_domain             *domain;
1065 };
1066
1067 /**
1068  * struct iommu_sva - handle to a device-mm bond
1069  */
1070 struct iommu_sva {
1071         struct iommu_attach_handle      handle;
1072         struct device                   *dev;
1073         refcount_t                      users;
1074 };
1075
1076 struct iommu_mm_data {
1077         u32                     pasid;
1078         struct list_head        sva_domains;
1079 };
1080
1081 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode);
1082 void iommu_fwspec_free(struct device *dev);
1083 int iommu_fwspec_add_ids(struct device *dev, const u32 *ids, int num_ids);
1084
1085 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1086 {
1087         if (dev->iommu)
1088                 return dev->iommu->fwspec;
1089         else
1090                 return NULL;
1091 }
1092
1093 static inline void dev_iommu_fwspec_set(struct device *dev,
1094                                         struct iommu_fwspec *fwspec)
1095 {
1096         dev->iommu->fwspec = fwspec;
1097 }
1098
1099 static inline void *dev_iommu_priv_get(struct device *dev)
1100 {
1101         if (dev->iommu)
1102                 return dev->iommu->priv;
1103         else
1104                 return NULL;
1105 }
1106
1107 void dev_iommu_priv_set(struct device *dev, void *priv);
1108
1109 extern struct mutex iommu_probe_device_lock;
1110 int iommu_probe_device(struct device *dev);
1111
1112 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
1113 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
1114
1115 int iommu_device_use_default_domain(struct device *dev);
1116 void iommu_device_unuse_default_domain(struct device *dev);
1117
1118 int iommu_group_claim_dma_owner(struct iommu_group *group, void *owner);
1119 void iommu_group_release_dma_owner(struct iommu_group *group);
1120 bool iommu_group_dma_owner_claimed(struct iommu_group *group);
1121
1122 int iommu_device_claim_dma_owner(struct device *dev, void *owner);
1123 void iommu_device_release_dma_owner(struct device *dev);
1124
1125 int iommu_attach_device_pasid(struct iommu_domain *domain,
1126                               struct device *dev, ioasid_t pasid,
1127                               struct iommu_attach_handle *handle);
1128 void iommu_detach_device_pasid(struct iommu_domain *domain,
1129                                struct device *dev, ioasid_t pasid);
1130 ioasid_t iommu_alloc_global_pasid(struct device *dev);
1131 void iommu_free_global_pasid(ioasid_t pasid);
1132 #else /* CONFIG_IOMMU_API */
1133
1134 struct iommu_ops {};
1135 struct iommu_group {};
1136 struct iommu_fwspec {};
1137 struct iommu_device {};
1138 struct iommu_fault_param {};
1139 struct iommu_iotlb_gather {};
1140 struct iommu_dirty_bitmap {};
1141 struct iommu_dirty_ops {};
1142
1143 static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
1144 {
1145         return false;
1146 }
1147
1148 static inline struct iommu_domain *iommu_paging_domain_alloc_flags(struct device *dev,
1149                                                      unsigned int flags)
1150 {
1151         return ERR_PTR(-ENODEV);
1152 }
1153
1154 static inline struct iommu_domain *iommu_paging_domain_alloc(struct device *dev)
1155 {
1156         return ERR_PTR(-ENODEV);
1157 }
1158
1159 static inline void iommu_domain_free(struct iommu_domain *domain)
1160 {
1161 }
1162
1163 static inline int iommu_attach_device(struct iommu_domain *domain,
1164                                       struct device *dev)
1165 {
1166         return -ENODEV;
1167 }
1168
1169 static inline void iommu_detach_device(struct iommu_domain *domain,
1170                                        struct device *dev)
1171 {
1172 }
1173
1174 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
1175 {
1176         return NULL;
1177 }
1178
1179 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
1180                             phys_addr_t paddr, size_t size, int prot, gfp_t gfp)
1181 {
1182         return -ENODEV;
1183 }
1184
1185 static inline size_t iommu_unmap(struct iommu_domain *domain,
1186                                  unsigned long iova, size_t size)
1187 {
1188         return 0;
1189 }
1190
1191 static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
1192                                       unsigned long iova, int gfp_order,
1193                                       struct iommu_iotlb_gather *iotlb_gather)
1194 {
1195         return 0;
1196 }
1197
1198 static inline ssize_t iommu_map_sg(struct iommu_domain *domain,
1199                                    unsigned long iova, struct scatterlist *sg,
1200                                    unsigned int nents, int prot, gfp_t gfp)
1201 {
1202         return -ENODEV;
1203 }
1204
1205 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
1206 {
1207 }
1208
1209 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
1210                                   struct iommu_iotlb_gather *iotlb_gather)
1211 {
1212 }
1213
1214 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
1215 {
1216         return 0;
1217 }
1218
1219 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
1220                                 iommu_fault_handler_t handler, void *token)
1221 {
1222 }
1223
1224 static inline void iommu_get_resv_regions(struct device *dev,
1225                                         struct list_head *list)
1226 {
1227 }
1228
1229 static inline void iommu_put_resv_regions(struct device *dev,
1230                                         struct list_head *list)
1231 {
1232 }
1233
1234 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
1235                                                struct list_head *head)
1236 {
1237         return -ENODEV;
1238 }
1239
1240 static inline void iommu_set_default_passthrough(bool cmd_line)
1241 {
1242 }
1243
1244 static inline void iommu_set_default_translated(bool cmd_line)
1245 {
1246 }
1247
1248 static inline bool iommu_default_passthrough(void)
1249 {
1250         return true;
1251 }
1252
1253 static inline int iommu_attach_group(struct iommu_domain *domain,
1254                                      struct iommu_group *group)
1255 {
1256         return -ENODEV;
1257 }
1258
1259 static inline void iommu_detach_group(struct iommu_domain *domain,
1260                                       struct iommu_group *group)
1261 {
1262 }
1263
1264 static inline struct iommu_group *iommu_group_alloc(void)
1265 {
1266         return ERR_PTR(-ENODEV);
1267 }
1268
1269 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
1270 {
1271         return NULL;
1272 }
1273
1274 static inline void iommu_group_set_iommudata(struct iommu_group *group,
1275                                              void *iommu_data,
1276                                              void (*release)(void *iommu_data))
1277 {
1278 }
1279
1280 static inline int iommu_group_set_name(struct iommu_group *group,
1281                                        const char *name)
1282 {
1283         return -ENODEV;
1284 }
1285
1286 static inline int iommu_group_add_device(struct iommu_group *group,
1287                                          struct device *dev)
1288 {
1289         return -ENODEV;
1290 }
1291
1292 static inline void iommu_group_remove_device(struct device *dev)
1293 {
1294 }
1295
1296 static inline int iommu_group_for_each_dev(struct iommu_group *group,
1297                                            void *data,
1298                                            int (*fn)(struct device *, void *))
1299 {
1300         return -ENODEV;
1301 }
1302
1303 static inline struct iommu_group *iommu_group_get(struct device *dev)
1304 {
1305         return NULL;
1306 }
1307
1308 static inline void iommu_group_put(struct iommu_group *group)
1309 {
1310 }
1311
1312 static inline int iommu_group_id(struct iommu_group *group)
1313 {
1314         return -ENODEV;
1315 }
1316
1317 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
1318                 unsigned long quirks)
1319 {
1320         return 0;
1321 }
1322
1323 static inline int iommu_device_register(struct iommu_device *iommu,
1324                                         const struct iommu_ops *ops,
1325                                         struct device *hwdev)
1326 {
1327         return -ENODEV;
1328 }
1329
1330 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
1331 {
1332         return NULL;
1333 }
1334
1335 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
1336 {
1337 }
1338
1339 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
1340                                                struct iommu_iotlb_gather *gather,
1341                                                unsigned long iova, size_t size)
1342 {
1343 }
1344
1345 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
1346 {
1347         return false;
1348 }
1349
1350 static inline void iommu_dirty_bitmap_init(struct iommu_dirty_bitmap *dirty,
1351                                            struct iova_bitmap *bitmap,
1352                                            struct iommu_iotlb_gather *gather)
1353 {
1354 }
1355
1356 static inline void iommu_dirty_bitmap_record(struct iommu_dirty_bitmap *dirty,
1357                                              unsigned long iova,
1358                                              unsigned long length)
1359 {
1360 }
1361
1362 static inline void iommu_device_unregister(struct iommu_device *iommu)
1363 {
1364 }
1365
1366 static inline int  iommu_device_sysfs_add(struct iommu_device *iommu,
1367                                           struct device *parent,
1368                                           const struct attribute_group **groups,
1369                                           const char *fmt, ...)
1370 {
1371         return -ENODEV;
1372 }
1373
1374 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
1375 {
1376 }
1377
1378 static inline int iommu_device_link(struct device *dev, struct device *link)
1379 {
1380         return -EINVAL;
1381 }
1382
1383 static inline void iommu_device_unlink(struct device *dev, struct device *link)
1384 {
1385 }
1386
1387 static inline int iommu_fwspec_init(struct device *dev,
1388                                     struct fwnode_handle *iommu_fwnode)
1389 {
1390         return -ENODEV;
1391 }
1392
1393 static inline void iommu_fwspec_free(struct device *dev)
1394 {
1395 }
1396
1397 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
1398                                        int num_ids)
1399 {
1400         return -ENODEV;
1401 }
1402
1403 static inline int
1404 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
1405 {
1406         return -ENODEV;
1407 }
1408
1409 static inline int
1410 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1411 {
1412         return -ENODEV;
1413 }
1414
1415 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1416 {
1417         return NULL;
1418 }
1419
1420 static inline int iommu_device_use_default_domain(struct device *dev)
1421 {
1422         return 0;
1423 }
1424
1425 static inline void iommu_device_unuse_default_domain(struct device *dev)
1426 {
1427 }
1428
1429 static inline int
1430 iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1431 {
1432         return -ENODEV;
1433 }
1434
1435 static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1436 {
1437 }
1438
1439 static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1440 {
1441         return false;
1442 }
1443
1444 static inline void iommu_device_release_dma_owner(struct device *dev)
1445 {
1446 }
1447
1448 static inline int iommu_device_claim_dma_owner(struct device *dev, void *owner)
1449 {
1450         return -ENODEV;
1451 }
1452
1453 static inline int iommu_attach_device_pasid(struct iommu_domain *domain,
1454                                             struct device *dev, ioasid_t pasid,
1455                                             struct iommu_attach_handle *handle)
1456 {
1457         return -ENODEV;
1458 }
1459
1460 static inline void iommu_detach_device_pasid(struct iommu_domain *domain,
1461                                              struct device *dev, ioasid_t pasid)
1462 {
1463 }
1464
1465 static inline ioasid_t iommu_alloc_global_pasid(struct device *dev)
1466 {
1467         return IOMMU_PASID_INVALID;
1468 }
1469
1470 static inline void iommu_free_global_pasid(ioasid_t pasid) {}
1471 #endif /* CONFIG_IOMMU_API */
1472
1473 #if IS_ENABLED(CONFIG_LOCKDEP) && IS_ENABLED(CONFIG_IOMMU_API)
1474 void iommu_group_mutex_assert(struct device *dev);
1475 #else
1476 static inline void iommu_group_mutex_assert(struct device *dev)
1477 {
1478 }
1479 #endif
1480
1481 /**
1482  * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1483  * @domain:     The IOMMU domain to perform the mapping
1484  * @iova:       The start address to map the buffer
1485  * @sgt:        The sg_table object describing the buffer
1486  * @prot:       IOMMU protection bits
1487  *
1488  * Creates a mapping at @iova for the buffer described by a scatterlist
1489  * stored in the given sg_table object in the provided IOMMU domain.
1490  */
1491 static inline ssize_t iommu_map_sgtable(struct iommu_domain *domain,
1492                         unsigned long iova, struct sg_table *sgt, int prot)
1493 {
1494         return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot,
1495                             GFP_KERNEL);
1496 }
1497
1498 #ifdef CONFIG_IOMMU_DEBUGFS
1499 extern  struct dentry *iommu_debugfs_dir;
1500 void iommu_debugfs_setup(void);
1501 #else
1502 static inline void iommu_debugfs_setup(void) {}
1503 #endif
1504
1505 #ifdef CONFIG_IOMMU_DMA
1506 #include <linux/msi.h>
1507
1508 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base);
1509
1510 int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr);
1511 void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg);
1512
1513 #else /* CONFIG_IOMMU_DMA */
1514
1515 struct msi_desc;
1516 struct msi_msg;
1517
1518 static inline int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
1519 {
1520         return -ENODEV;
1521 }
1522
1523 static inline int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr)
1524 {
1525         return 0;
1526 }
1527
1528 static inline void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1529 {
1530 }
1531
1532 #endif  /* CONFIG_IOMMU_DMA */
1533
1534 /*
1535  * Newer generations of Tegra SoCs require devices' stream IDs to be directly programmed into
1536  * some registers. These are always paired with a Tegra SMMU or ARM SMMU, for which the contents
1537  * of the struct iommu_fwspec are known. Use this helper to formalize access to these internals.
1538  */
1539 #define TEGRA_STREAM_ID_BYPASS 0x7f
1540
1541 static inline bool tegra_dev_iommu_get_stream_id(struct device *dev, u32 *stream_id)
1542 {
1543 #ifdef CONFIG_IOMMU_API
1544         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
1545
1546         if (fwspec && fwspec->num_ids == 1) {
1547                 *stream_id = fwspec->ids[0] & 0xffff;
1548                 return true;
1549         }
1550 #endif
1551
1552         return false;
1553 }
1554
1555 #ifdef CONFIG_IOMMU_MM_DATA
1556 static inline void mm_pasid_init(struct mm_struct *mm)
1557 {
1558         /*
1559          * During dup_mm(), a new mm will be memcpy'd from an old one and that makes
1560          * the new mm and the old one point to a same iommu_mm instance. When either
1561          * one of the two mms gets released, the iommu_mm instance is freed, leaving
1562          * the other mm running into a use-after-free/double-free problem. To avoid
1563          * the problem, zeroing the iommu_mm pointer of a new mm is needed here.
1564          */
1565         mm->iommu_mm = NULL;
1566 }
1567
1568 static inline bool mm_valid_pasid(struct mm_struct *mm)
1569 {
1570         return READ_ONCE(mm->iommu_mm);
1571 }
1572
1573 static inline u32 mm_get_enqcmd_pasid(struct mm_struct *mm)
1574 {
1575         struct iommu_mm_data *iommu_mm = READ_ONCE(mm->iommu_mm);
1576
1577         if (!iommu_mm)
1578                 return IOMMU_PASID_INVALID;
1579         return iommu_mm->pasid;
1580 }
1581
1582 void mm_pasid_drop(struct mm_struct *mm);
1583 struct iommu_sva *iommu_sva_bind_device(struct device *dev,
1584                                         struct mm_struct *mm);
1585 void iommu_sva_unbind_device(struct iommu_sva *handle);
1586 u32 iommu_sva_get_pasid(struct iommu_sva *handle);
1587 #else
1588 static inline struct iommu_sva *
1589 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm)
1590 {
1591         return ERR_PTR(-ENODEV);
1592 }
1593
1594 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1595 {
1596 }
1597
1598 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1599 {
1600         return IOMMU_PASID_INVALID;
1601 }
1602 static inline void mm_pasid_init(struct mm_struct *mm) {}
1603 static inline bool mm_valid_pasid(struct mm_struct *mm) { return false; }
1604
1605 static inline u32 mm_get_enqcmd_pasid(struct mm_struct *mm)
1606 {
1607         return IOMMU_PASID_INVALID;
1608 }
1609
1610 static inline void mm_pasid_drop(struct mm_struct *mm) {}
1611 #endif /* CONFIG_IOMMU_SVA */
1612
1613 #ifdef CONFIG_IOMMU_IOPF
1614 int iopf_queue_add_device(struct iopf_queue *queue, struct device *dev);
1615 void iopf_queue_remove_device(struct iopf_queue *queue, struct device *dev);
1616 int iopf_queue_flush_dev(struct device *dev);
1617 struct iopf_queue *iopf_queue_alloc(const char *name);
1618 void iopf_queue_free(struct iopf_queue *queue);
1619 int iopf_queue_discard_partial(struct iopf_queue *queue);
1620 void iopf_free_group(struct iopf_group *group);
1621 int iommu_report_device_fault(struct device *dev, struct iopf_fault *evt);
1622 void iopf_group_response(struct iopf_group *group,
1623                          enum iommu_page_response_code status);
1624 #else
1625 static inline int
1626 iopf_queue_add_device(struct iopf_queue *queue, struct device *dev)
1627 {
1628         return -ENODEV;
1629 }
1630
1631 static inline void
1632 iopf_queue_remove_device(struct iopf_queue *queue, struct device *dev)
1633 {
1634 }
1635
1636 static inline int iopf_queue_flush_dev(struct device *dev)
1637 {
1638         return -ENODEV;
1639 }
1640
1641 static inline struct iopf_queue *iopf_queue_alloc(const char *name)
1642 {
1643         return NULL;
1644 }
1645
1646 static inline void iopf_queue_free(struct iopf_queue *queue)
1647 {
1648 }
1649
1650 static inline int iopf_queue_discard_partial(struct iopf_queue *queue)
1651 {
1652         return -ENODEV;
1653 }
1654
1655 static inline void iopf_free_group(struct iopf_group *group)
1656 {
1657 }
1658
1659 static inline int
1660 iommu_report_device_fault(struct device *dev, struct iopf_fault *evt)
1661 {
1662         return -ENODEV;
1663 }
1664
1665 static inline void iopf_group_response(struct iopf_group *group,
1666                                        enum iommu_page_response_code status)
1667 {
1668 }
1669 #endif /* CONFIG_IOMMU_IOPF */
1670 #endif /* __LINUX_IOMMU_H */