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 <joerg.roedel@amd.com>
   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/ioasid.h>
  17 #include <uapi/linux/iommu.h>
  18
  19 #define IOMMU_READ      (1 << 0)
  20 #define IOMMU_WRITE     (1 << 1)
  21 #define IOMMU_CACHE     (1 << 2) /* DMA cache coherency */
  22 #define IOMMU_NOEXEC    (1 << 3)
  23 #define IOMMU_MMIO      (1 << 4) /* e.g. things like MSI doorbells */
  24 /*
  25  * Where the bus hardware includes a privilege level as part of its access type
  26  * markings, and certain devices are capable of issuing transactions marked as
  27  * either 'supervisor' or 'user', the IOMMU_PRIV flag requests that the other
  28  * given permission flags only apply to accesses at the higher privilege level,
  29  * and that unprivileged transactions should have as little access as possible.
  30  * This would usually imply the same permissions as kernel mappings on the CPU,
  31  * if the IOMMU page table format is equivalent.
  32  */
  33 #define IOMMU_PRIV      (1 << 5)
  34
  35 struct iommu_ops;
  36 struct iommu_group;
  37 struct bus_type;
  38 struct device;
  39 struct iommu_domain;
  40 struct iommu_domain_ops;
  41 struct notifier_block;
  42 struct iommu_sva;
  43 struct iommu_fault_event;
  44 struct iommu_dma_cookie;
  45
  46 /* iommu fault flags */
  47 #define IOMMU_FAULT_READ        0x0
  48 #define IOMMU_FAULT_WRITE       0x1
  49
  50 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
  51                         struct device *, unsigned long, int, void *);
  52 typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
  53
  54 struct iommu_domain_geometry {
  55         dma_addr_t aperture_start; /* First address that can be mapped    */
  56         dma_addr_t aperture_end;   /* Last address that can be mapped     */
  57         bool force_aperture;       /* DMA only allowed in mappable range? */
  58 };
  59
  60 /* Domain feature flags */
  61 #define __IOMMU_DOMAIN_PAGING   (1U << 0)  /* Support for iommu_map/unmap */
  62 #define __IOMMU_DOMAIN_DMA_API  (1U << 1)  /* Domain for use in DMA-API
  63                                               implementation              */
  64 #define __IOMMU_DOMAIN_PT       (1U << 2)  /* Domain is identity mapped   */
  65 #define __IOMMU_DOMAIN_DMA_FQ   (1U << 3)  /* DMA-API uses flush queue    */
  66
  67 #define __IOMMU_DOMAIN_SVA      (1U << 4)  /* Shared process address space */
  68
  69 /*
  70  * This are the possible domain-types
  71  *
  72  *      IOMMU_DOMAIN_BLOCKED    - All DMA is blocked, can be used to isolate
  73  *                                devices
  74  *      IOMMU_DOMAIN_IDENTITY   - DMA addresses are system physical addresses
  75  *      IOMMU_DOMAIN_UNMANAGED  - DMA mappings managed by IOMMU-API user, used
  76  *                                for VMs
  77  *      IOMMU_DOMAIN_DMA        - Internally used for DMA-API implementations.
  78  *                                This flag allows IOMMU drivers to implement
  79  *                                certain optimizations for these domains
  80  *      IOMMU_DOMAIN_DMA_FQ     - As above, but definitely using batched TLB
  81  *                                invalidation.
  82  *      IOMMU_DOMAIN_SVA        - DMA addresses are shared process addresses
  83  *                                represented by mm_struct's.
  84  */
  85 #define IOMMU_DOMAIN_BLOCKED    (0U)
  86 #define IOMMU_DOMAIN_IDENTITY   (__IOMMU_DOMAIN_PT)
  87 #define IOMMU_DOMAIN_UNMANAGED  (__IOMMU_DOMAIN_PAGING)
  88 #define IOMMU_DOMAIN_DMA        (__IOMMU_DOMAIN_PAGING |        \
  89                                  __IOMMU_DOMAIN_DMA_API)
  90 #define IOMMU_DOMAIN_DMA_FQ     (__IOMMU_DOMAIN_PAGING |        \
  91                                  __IOMMU_DOMAIN_DMA_API |       \
  92                                  __IOMMU_DOMAIN_DMA_FQ)
  93 #define IOMMU_DOMAIN_SVA        (__IOMMU_DOMAIN_SVA)
  94
  95 struct iommu_domain {
  96         unsigned type;
  97         const struct iommu_domain_ops *ops;
  98         unsigned long pgsize_bitmap;    /* Bitmap of page sizes in use */
  99         struct iommu_domain_geometry geometry;
 100         struct iommu_dma_cookie *iova_cookie;
 101         enum iommu_page_response_code (*iopf_handler)(struct iommu_fault *fault,
 102                                                       void *data);
 103         void *fault_data;
 104         union {
 105                 struct {
 106                         iommu_fault_handler_t handler;
 107                         void *handler_token;
 108                 };
 109                 struct {        /* IOMMU_DOMAIN_SVA */
 110                         struct mm_struct *mm;
 111                         int users;
 112                 };
 113         };
 114 };
 115
 116 static inline bool iommu_is_dma_domain(struct iommu_domain *domain)
 117 {
 118         return domain->type & __IOMMU_DOMAIN_DMA_API;
 119 }
 120
 121 enum iommu_cap {
 122         IOMMU_CAP_CACHE_COHERENCY,      /* IOMMU_CACHE is supported */
 123         IOMMU_CAP_INTR_REMAP,           /* IOMMU supports interrupt isolation */
 124         IOMMU_CAP_NOEXEC,               /* IOMMU_NOEXEC flag */
 125         IOMMU_CAP_PRE_BOOT_PROTECTION,  /* Firmware says it used the IOMMU for
 126                                            DMA protection and we should too */
 127         /*
 128          * Per-device flag indicating if enforce_cache_coherency() will work on
 129          * this device.
 130          */
 131         IOMMU_CAP_ENFORCE_CACHE_COHERENCY,
 132 };
 133
 134 /* These are the possible reserved region types */
 135 enum iommu_resv_type {
 136         /* Memory regions which must be mapped 1:1 at all times */
 137         IOMMU_RESV_DIRECT,
 138         /*
 139          * Memory regions which are advertised to be 1:1 but are
 140          * commonly considered relaxable in some conditions,
 141          * for instance in device assignment use case (USB, Graphics)
 142          */
 143         IOMMU_RESV_DIRECT_RELAXABLE,
 144         /* Arbitrary "never map this or give it to a device" address ranges */
 145         IOMMU_RESV_RESERVED,
 146         /* Hardware MSI region (untranslated) */
 147         IOMMU_RESV_MSI,
 148         /* Software-managed MSI translation window */
 149         IOMMU_RESV_SW_MSI,
 150 };
 151
 152 /**
 153  * struct iommu_resv_region - descriptor for a reserved memory region
 154  * @list: Linked list pointers
 155  * @start: System physical start address of the region
 156  * @length: Length of the region in bytes
 157  * @prot: IOMMU Protection flags (READ/WRITE/...)
 158  * @type: Type of the reserved region
 159  * @free: Callback to free associated memory allocations
 160  */
 161 struct iommu_resv_region {
 162         struct list_head        list;
 163         phys_addr_t             start;
 164         size_t                  length;
 165         int                     prot;
 166         enum iommu_resv_type    type;
 167         void (*free)(struct device *dev, struct iommu_resv_region *region);
 168 };
 169
 170 struct iommu_iort_rmr_data {
 171         struct iommu_resv_region rr;
 172
 173         /* Stream IDs associated with IORT RMR entry */
 174         const u32 *sids;
 175         u32 num_sids;
 176 };
 177
 178 /**
 179  * enum iommu_dev_features - Per device IOMMU features
 180  * @IOMMU_DEV_FEAT_SVA: Shared Virtual Addresses
 181  * @IOMMU_DEV_FEAT_IOPF: I/O Page Faults such as PRI or Stall. Generally
 182  *                       enabling %IOMMU_DEV_FEAT_SVA requires
 183  *                       %IOMMU_DEV_FEAT_IOPF, but some devices manage I/O Page
 184  *                       Faults themselves instead of relying on the IOMMU. When
 185  *                       supported, this feature must be enabled before and
 186  *                       disabled after %IOMMU_DEV_FEAT_SVA.
 187  *
 188  * Device drivers enable a feature using iommu_dev_enable_feature().
 189  */
 190 enum iommu_dev_features {
 191         IOMMU_DEV_FEAT_SVA,
 192         IOMMU_DEV_FEAT_IOPF,
 193 };
 194
 195 #define IOMMU_PASID_INVALID     (-1U)
 196
 197 #ifdef CONFIG_IOMMU_API
 198
 199 /**
 200  * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
 201  *
 202  * @start: IOVA representing the start of the range to be flushed
 203  * @end: IOVA representing the end of the range to be flushed (inclusive)
 204  * @pgsize: The interval at which to perform the flush
 205  * @freelist: Removed pages to free after sync
 206  * @queued: Indicates that the flush will be queued
 207  *
 208  * This structure is intended to be updated by multiple calls to the
 209  * ->unmap() function in struct iommu_ops before eventually being passed
 210  * into ->iotlb_sync(). Drivers can add pages to @freelist to be freed after
 211  * ->iotlb_sync() or ->iotlb_flush_all() have cleared all cached references to
 212  * them. @queued is set to indicate when ->iotlb_flush_all() will be called
 213  * later instead of ->iotlb_sync(), so drivers may optimise accordingly.
 214  */
 215 struct iommu_iotlb_gather {
 216         unsigned long           start;
 217         unsigned long           end;
 218         size_t                  pgsize;
 219         struct list_head        freelist;
 220         bool                    queued;
 221 };
 222
 223 /**
 224  * struct iommu_ops - iommu ops and capabilities
 225  * @capable: check capability
 226  * @domain_alloc: allocate iommu domain
 227  * @probe_device: Add device to iommu driver handling
 228  * @release_device: Remove device from iommu driver handling
 229  * @probe_finalize: Do final setup work after the device is added to an IOMMU
 230  *                  group and attached to the groups domain
 231  * @device_group: find iommu group for a particular device
 232  * @get_resv_regions: Request list of reserved regions for a device
 233  * @of_xlate: add OF master IDs to iommu grouping
 234  * @is_attach_deferred: Check if domain attach should be deferred from iommu
 235  *                      driver init to device driver init (default no)
 236  * @dev_enable/disable_feat: per device entries to enable/disable
 237  *                               iommu specific features.
 238  * @page_response: handle page request response
 239  * @def_domain_type: device default domain type, return value:
 240  *              - IOMMU_DOMAIN_IDENTITY: must use an identity domain
 241  *              - IOMMU_DOMAIN_DMA: must use a dma domain
 242  *              - 0: use the default setting
 243  * @default_domain_ops: the default ops for domains
 244  * @remove_dev_pasid: Remove any translation configurations of a specific
 245  *                    pasid, so that any DMA transactions with this pasid
 246  *                    will be blocked by the hardware.
 247  * @pgsize_bitmap: bitmap of all possible supported page sizes
 248  * @owner: Driver module providing these ops
 249  */
 250 struct iommu_ops {
 251         bool (*capable)(struct device *dev, enum iommu_cap);
 252
 253         /* Domain allocation and freeing by the iommu driver */
 254         struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
 255
 256         struct iommu_device *(*probe_device)(struct device *dev);
 257         void (*release_device)(struct device *dev);
 258         void (*probe_finalize)(struct device *dev);
 259         struct iommu_group *(*device_group)(struct device *dev);
 260
 261         /* Request/Free a list of reserved regions for a device */
 262         void (*get_resv_regions)(struct device *dev, struct list_head *list);
 263
 264         int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
 265         bool (*is_attach_deferred)(struct device *dev);
 266
 267         /* Per device IOMMU features */
 268         int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
 269         int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
 270
 271         int (*page_response)(struct device *dev,
 272                              struct iommu_fault_event *evt,
 273                              struct iommu_page_response *msg);
 274
 275         int (*def_domain_type)(struct device *dev);
 276         void (*remove_dev_pasid)(struct device *dev, ioasid_t pasid);
 277
 278         const struct iommu_domain_ops *default_domain_ops;
 279         unsigned long pgsize_bitmap;
 280         struct module *owner;
 281 };
 282
 283 /**
 284  * struct iommu_domain_ops - domain specific operations
 285  * @attach_dev: attach an iommu domain to a device
 286  *  Return:
 287  * * 0          - success
 288  * * EINVAL     - can indicate that device and domain are incompatible due to
 289  *                some previous configuration of the domain, in which case the
 290  *                driver shouldn't log an error, since it is legitimate for a
 291  *                caller to test reuse of existing domains. Otherwise, it may
 292  *                still represent some other fundamental problem
 293  * * ENOMEM     - out of memory
 294  * * ENOSPC     - non-ENOMEM type of resource allocation failures
 295  * * EBUSY      - device is attached to a domain and cannot be changed
 296  * * ENODEV     - device specific errors, not able to be attached
 297  * * <others>   - treated as ENODEV by the caller. Use is discouraged
 298  * @detach_dev: detach an iommu domain from a device
 299  * @set_dev_pasid: set an iommu domain to a pasid of device
 300  * @map: map a physically contiguous memory region to an iommu domain
 301  * @map_pages: map a physically contiguous set of pages of the same size to
 302  *             an iommu domain.
 303  * @unmap: unmap a physically contiguous memory region from an iommu domain
 304  * @unmap_pages: unmap a number of pages of the same size from an iommu domain
 305  * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
 306  * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
 307  * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
 308  *            queue
 309  * @iova_to_phys: translate iova to physical address
 310  * @enforce_cache_coherency: Prevent any kind of DMA from bypassing IOMMU_CACHE,
 311  *                           including no-snoop TLPs on PCIe or other platform
 312  *                           specific mechanisms.
 313  * @enable_nesting: Enable nesting
 314  * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
 315  * @free: Release the domain after use.
 316  */
 317 struct iommu_domain_ops {
 318         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
 319         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
 320         int (*set_dev_pasid)(struct iommu_domain *domain, struct device *dev,
 321                              ioasid_t pasid);
 322
 323         int (*map)(struct iommu_domain *domain, unsigned long iova,
 324                    phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
 325         int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
 326                          phys_addr_t paddr, size_t pgsize, size_t pgcount,
 327                          int prot, gfp_t gfp, size_t *mapped);
 328         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
 329                         size_t size, struct iommu_iotlb_gather *iotlb_gather);
 330         size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
 331                               size_t pgsize, size_t pgcount,
 332                               struct iommu_iotlb_gather *iotlb_gather);
 333
 334         void (*flush_iotlb_all)(struct iommu_domain *domain);
 335         void (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
 336                                size_t size);
 337         void (*iotlb_sync)(struct iommu_domain *domain,
 338                            struct iommu_iotlb_gather *iotlb_gather);
 339
 340         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
 341                                     dma_addr_t iova);
 342
 343         bool (*enforce_cache_coherency)(struct iommu_domain *domain);
 344         int (*enable_nesting)(struct iommu_domain *domain);
 345         int (*set_pgtable_quirks)(struct iommu_domain *domain,
 346                                   unsigned long quirks);
 347
 348         void (*free)(struct iommu_domain *domain);
 349 };
 350
 351 /**
 352  * struct iommu_device - IOMMU core representation of one IOMMU hardware
 353  *                       instance
 354  * @list: Used by the iommu-core to keep a list of registered iommus
 355  * @ops: iommu-ops for talking to this iommu
 356  * @dev: struct device for sysfs handling
 357  * @max_pasids: number of supported PASIDs
 358  */
 359 struct iommu_device {
 360         struct list_head list;
 361         const struct iommu_ops *ops;
 362         struct fwnode_handle *fwnode;
 363         struct device *dev;
 364         u32 max_pasids;
 365 };
 366
 367 /**
 368  * struct iommu_fault_event - Generic fault event
 369  *
 370  * Can represent recoverable faults such as a page requests or
 371  * unrecoverable faults such as DMA or IRQ remapping faults.
 372  *
 373  * @fault: fault descriptor
 374  * @list: pending fault event list, used for tracking responses
 375  */
 376 struct iommu_fault_event {
 377         struct iommu_fault fault;
 378         struct list_head list;
 379 };
 380
 381 /**
 382  * struct iommu_fault_param - per-device IOMMU fault data
 383  * @handler: Callback function to handle IOMMU faults at device level
 384  * @data: handler private data
 385  * @faults: holds the pending faults which needs response
 386  * @lock: protect pending faults list
 387  */
 388 struct iommu_fault_param {
 389         iommu_dev_fault_handler_t handler;
 390         void *data;
 391         struct list_head faults;
 392         struct mutex lock;
 393 };
 394
 395 /**
 396  * struct dev_iommu - Collection of per-device IOMMU data
 397  *
 398  * @fault_param: IOMMU detected device fault reporting data
 399  * @iopf_param:  I/O Page Fault queue and data
 400  * @fwspec:      IOMMU fwspec data
 401  * @iommu_dev:   IOMMU device this device is linked to
 402  * @priv:        IOMMU Driver private data
 403  * @max_pasids:  number of PASIDs this device can consume
 404  *
 405  * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
 406  *      struct iommu_group      *iommu_group;
 407  */
 408 struct dev_iommu {
 409         struct mutex lock;
 410         struct iommu_fault_param        *fault_param;
 411         struct iopf_device_param        *iopf_param;
 412         struct iommu_fwspec             *fwspec;
 413         struct iommu_device             *iommu_dev;
 414         void                            *priv;
 415         u32                             max_pasids;
 416 };
 417
 418 int iommu_device_register(struct iommu_device *iommu,
 419                           const struct iommu_ops *ops,
 420                           struct device *hwdev);
 421 void iommu_device_unregister(struct iommu_device *iommu);
 422 int  iommu_device_sysfs_add(struct iommu_device *iommu,
 423                             struct device *parent,
 424                             const struct attribute_group **groups,
 425                             const char *fmt, ...) __printf(4, 5);
 426 void iommu_device_sysfs_remove(struct iommu_device *iommu);
 427 int  iommu_device_link(struct iommu_device   *iommu, struct device *link);
 428 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
 429 int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
 430
 431 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
 432 {
 433         return (struct iommu_device *)dev_get_drvdata(dev);
 434 }
 435
 436 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
 437 {
 438         *gather = (struct iommu_iotlb_gather) {
 439                 .start  = ULONG_MAX,
 440                 .freelist = LIST_HEAD_INIT(gather->freelist),
 441         };
 442 }
 443
 444 static inline const struct iommu_ops *dev_iommu_ops(struct device *dev)
 445 {
 446         /*
 447          * Assume that valid ops must be installed if iommu_probe_device()
 448          * has succeeded. The device ops are essentially for internal use
 449          * within the IOMMU subsystem itself, so we should be able to trust
 450          * ourselves not to misuse the helper.
 451          */
 452         return dev->iommu->iommu_dev->ops;
 453 }
 454
 455 extern int bus_iommu_probe(struct bus_type *bus);
 456 extern bool iommu_present(struct bus_type *bus);
 457 extern bool device_iommu_capable(struct device *dev, enum iommu_cap cap);
 458 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
 459 extern struct iommu_group *iommu_group_get_by_id(int id);
 460 extern void iommu_domain_free(struct iommu_domain *domain);
 461 extern int iommu_attach_device(struct iommu_domain *domain,
 462                                struct device *dev);
 463 extern void iommu_detach_device(struct iommu_domain *domain,
 464                                 struct device *dev);
 465 extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
 466                                    struct device *dev, ioasid_t pasid);
 467 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
 468 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
 469 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 470                      phys_addr_t paddr, size_t size, int prot);
 471 extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
 472                             phys_addr_t paddr, size_t size, int prot);
 473 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 474                           size_t size);
 475 extern size_t iommu_unmap_fast(struct iommu_domain *domain,
 476                                unsigned long iova, size_t size,
 477                                struct iommu_iotlb_gather *iotlb_gather);
 478 extern ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
 479                 struct scatterlist *sg, unsigned int nents, int prot);
 480 extern ssize_t iommu_map_sg_atomic(struct iommu_domain *domain,
 481                                    unsigned long iova, struct scatterlist *sg,
 482                                    unsigned int nents, int prot);
 483 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
 484 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 485                         iommu_fault_handler_t handler, void *token);
 486
 487 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
 488 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
 489 extern void iommu_set_default_passthrough(bool cmd_line);
 490 extern void iommu_set_default_translated(bool cmd_line);
 491 extern bool iommu_default_passthrough(void);
 492 extern struct iommu_resv_region *
 493 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
 494                         enum iommu_resv_type type, gfp_t gfp);
 495 extern int iommu_get_group_resv_regions(struct iommu_group *group,
 496                                         struct list_head *head);
 497
 498 extern int iommu_attach_group(struct iommu_domain *domain,
 499                               struct iommu_group *group);
 500 extern void iommu_detach_group(struct iommu_domain *domain,
 501                                struct iommu_group *group);
 502 extern struct iommu_group *iommu_group_alloc(void);
 503 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 504 extern void iommu_group_set_iommudata(struct iommu_group *group,
 505                                       void *iommu_data,
 506                                       void (*release)(void *iommu_data));
 507 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 508 extern int iommu_group_add_device(struct iommu_group *group,
 509                                   struct device *dev);
 510 extern void iommu_group_remove_device(struct device *dev);
 511 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 512                                     int (*fn)(struct device *, void *));
 513 extern struct iommu_group *iommu_group_get(struct device *dev);
 514 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
 515 extern void iommu_group_put(struct iommu_group *group);
 516 extern int iommu_register_device_fault_handler(struct device *dev,
 517                                         iommu_dev_fault_handler_t handler,
 518                                         void *data);
 519
 520 extern int iommu_unregister_device_fault_handler(struct device *dev);
 521
 522 extern int iommu_report_device_fault(struct device *dev,
 523                                      struct iommu_fault_event *evt);
 524 extern int iommu_page_response(struct device *dev,
 525                                struct iommu_page_response *msg);
 526
 527 extern int iommu_group_id(struct iommu_group *group);
 528 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
 529
 530 int iommu_enable_nesting(struct iommu_domain *domain);
 531 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
 532                 unsigned long quirks);
 533
 534 void iommu_set_dma_strict(void);
 535
 536 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
 537                               unsigned long iova, int flags);
 538
 539 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
 540 {
 541         if (domain->ops->flush_iotlb_all)
 542                 domain->ops->flush_iotlb_all(domain);
 543 }
 544
 545 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
 546                                   struct iommu_iotlb_gather *iotlb_gather)
 547 {
 548         if (domain->ops->iotlb_sync)
 549                 domain->ops->iotlb_sync(domain, iotlb_gather);
 550
 551         iommu_iotlb_gather_init(iotlb_gather);
 552 }
 553
 554 /**
 555  * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
 556  *
 557  * @gather: TLB gather data
 558  * @iova: start of page to invalidate
 559  * @size: size of page to invalidate
 560  *
 561  * Helper for IOMMU drivers to check whether a new range and the gathered range
 562  * are disjoint. For many IOMMUs, flushing the IOMMU in this case is better
 563  * than merging the two, which might lead to unnecessary invalidations.
 564  */
 565 static inline
 566 bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
 567                                     unsigned long iova, size_t size)
 568 {
 569         unsigned long start = iova, end = start + size - 1;
 570
 571         return gather->end != 0 &&
 572                 (end + 1 < gather->start || start > gather->end + 1);
 573 }
 574
 575
 576 /**
 577  * iommu_iotlb_gather_add_range - Gather for address-based TLB invalidation
 578  * @gather: TLB gather data
 579  * @iova: start of page to invalidate
 580  * @size: size of page to invalidate
 581  *
 582  * Helper for IOMMU drivers to build arbitrarily-sized invalidation commands
 583  * where only the address range matters, and simply minimising intermediate
 584  * syncs is preferred.
 585  */
 586 static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
 587                                                 unsigned long iova, size_t size)
 588 {
 589         unsigned long end = iova + size - 1;
 590
 591         if (gather->start > iova)
 592                 gather->start = iova;
 593         if (gather->end < end)
 594                 gather->end = end;
 595 }
 596
 597 /**
 598  * iommu_iotlb_gather_add_page - Gather for page-based TLB invalidation
 599  * @domain: IOMMU domain to be invalidated
 600  * @gather: TLB gather data
 601  * @iova: start of page to invalidate
 602  * @size: size of page to invalidate
 603  *
 604  * Helper for IOMMU drivers to build invalidation commands based on individual
 605  * pages, or with page size/table level hints which cannot be gathered if they
 606  * differ.
 607  */
 608 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
 609                                                struct iommu_iotlb_gather *gather,
 610                                                unsigned long iova, size_t size)
 611 {
 612         /*
 613          * If the new page is disjoint from the current range or is mapped at
 614          * a different granularity, then sync the TLB so that the gather
 615          * structure can be rewritten.
 616          */
 617         if ((gather->pgsize && gather->pgsize != size) ||
 618             iommu_iotlb_gather_is_disjoint(gather, iova, size))
 619                 iommu_iotlb_sync(domain, gather);
 620
 621         gather->pgsize = size;
 622         iommu_iotlb_gather_add_range(gather, iova, size);
 623 }
 624
 625 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
 626 {
 627         return gather && gather->queued;
 628 }
 629
 630 /* PCI device grouping function */
 631 extern struct iommu_group *pci_device_group(struct device *dev);
 632 /* Generic device grouping function */
 633 extern struct iommu_group *generic_device_group(struct device *dev);
 634 /* FSL-MC device grouping function */
 635 struct iommu_group *fsl_mc_device_group(struct device *dev);
 636
 637 /**
 638  * struct iommu_fwspec - per-device IOMMU instance data
 639  * @ops: ops for this device's IOMMU
 640  * @iommu_fwnode: firmware handle for this device's IOMMU
 641  * @flags: IOMMU_FWSPEC_* flags
 642  * @num_ids: number of associated device IDs
 643  * @ids: IDs which this device may present to the IOMMU
 644  *
 645  * Note that the IDs (and any other information, really) stored in this structure should be
 646  * considered private to the IOMMU device driver and are not to be used directly by IOMMU
 647  * consumers.
 648  */
 649 struct iommu_fwspec {
 650         const struct iommu_ops  *ops;
 651         struct fwnode_handle    *iommu_fwnode;
 652         u32                     flags;
 653         unsigned int            num_ids;
 654         u32                     ids[];
 655 };
 656
 657 /* ATS is supported */
 658 #define IOMMU_FWSPEC_PCI_RC_ATS                 (1 << 0)
 659
 660 /**
 661  * struct iommu_sva - handle to a device-mm bond
 662  */
 663 struct iommu_sva {
 664         struct device                   *dev;
 665         struct iommu_domain             *domain;
 666 };
 667
 668 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
 669                       const struct iommu_ops *ops);
 670 void iommu_fwspec_free(struct device *dev);
 671 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
 672 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
 673
 674 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
 675 {
 676         if (dev->iommu)
 677                 return dev->iommu->fwspec;
 678         else
 679                 return NULL;
 680 }
 681
 682 static inline void dev_iommu_fwspec_set(struct device *dev,
 683                                         struct iommu_fwspec *fwspec)
 684 {
 685         dev->iommu->fwspec = fwspec;
 686 }
 687
 688 static inline void *dev_iommu_priv_get(struct device *dev)
 689 {
 690         if (dev->iommu)
 691                 return dev->iommu->priv;
 692         else
 693                 return NULL;
 694 }
 695
 696 static inline void dev_iommu_priv_set(struct device *dev, void *priv)
 697 {
 698         dev->iommu->priv = priv;
 699 }
 700
 701 int iommu_probe_device(struct device *dev);
 702 void iommu_release_device(struct device *dev);
 703
 704 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
 705 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
 706
 707 int iommu_device_use_default_domain(struct device *dev);
 708 void iommu_device_unuse_default_domain(struct device *dev);
 709
 710 int iommu_group_claim_dma_owner(struct iommu_group *group, void *owner);
 711 void iommu_group_release_dma_owner(struct iommu_group *group);
 712 bool iommu_group_dma_owner_claimed(struct iommu_group *group);
 713
 714 int iommu_device_claim_dma_owner(struct device *dev, void *owner);
 715 void iommu_device_release_dma_owner(struct device *dev);
 716
 717 struct iommu_domain *iommu_sva_domain_alloc(struct device *dev,
 718                                             struct mm_struct *mm);
 719 int iommu_attach_device_pasid(struct iommu_domain *domain,
 720                               struct device *dev, ioasid_t pasid);
 721 void iommu_detach_device_pasid(struct iommu_domain *domain,
 722                                struct device *dev, ioasid_t pasid);
 723 struct iommu_domain *
 724 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
 725                                unsigned int type);
 726 #else /* CONFIG_IOMMU_API */
 727
 728 struct iommu_ops {};
 729 struct iommu_group {};
 730 struct iommu_fwspec {};
 731 struct iommu_device {};
 732 struct iommu_fault_param {};
 733 struct iommu_iotlb_gather {};
 734
 735 static inline bool iommu_present(struct bus_type *bus)
 736 {
 737         return false;
 738 }
 739
 740 static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
 741 {
 742         return false;
 743 }
 744
 745 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 746 {
 747         return NULL;
 748 }
 749
 750 static inline struct iommu_group *iommu_group_get_by_id(int id)
 751 {
 752         return NULL;
 753 }
 754
 755 static inline void iommu_domain_free(struct iommu_domain *domain)
 756 {
 757 }
 758
 759 static inline int iommu_attach_device(struct iommu_domain *domain,
 760                                       struct device *dev)
 761 {
 762         return -ENODEV;
 763 }
 764
 765 static inline void iommu_detach_device(struct iommu_domain *domain,
 766                                        struct device *dev)
 767 {
 768 }
 769
 770 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
 771 {
 772         return NULL;
 773 }
 774
 775 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 776                             phys_addr_t paddr, size_t size, int prot)
 777 {
 778         return -ENODEV;
 779 }
 780
 781 static inline int iommu_map_atomic(struct iommu_domain *domain,
 782                                    unsigned long iova, phys_addr_t paddr,
 783                                    size_t size, int prot)
 784 {
 785         return -ENODEV;
 786 }
 787
 788 static inline size_t iommu_unmap(struct iommu_domain *domain,
 789                                  unsigned long iova, size_t size)
 790 {
 791         return 0;
 792 }
 793
 794 static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
 795                                       unsigned long iova, int gfp_order,
 796                                       struct iommu_iotlb_gather *iotlb_gather)
 797 {
 798         return 0;
 799 }
 800
 801 static inline ssize_t iommu_map_sg(struct iommu_domain *domain,
 802                                    unsigned long iova, struct scatterlist *sg,
 803                                    unsigned int nents, int prot)
 804 {
 805         return -ENODEV;
 806 }
 807
 808 static inline ssize_t iommu_map_sg_atomic(struct iommu_domain *domain,
 809                                   unsigned long iova, struct scatterlist *sg,
 810                                   unsigned int nents, int prot)
 811 {
 812         return -ENODEV;
 813 }
 814
 815 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
 816 {
 817 }
 818
 819 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
 820                                   struct iommu_iotlb_gather *iotlb_gather)
 821 {
 822 }
 823
 824 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
 825 {
 826         return 0;
 827 }
 828
 829 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 830                                 iommu_fault_handler_t handler, void *token)
 831 {
 832 }
 833
 834 static inline void iommu_get_resv_regions(struct device *dev,
 835                                         struct list_head *list)
 836 {
 837 }
 838
 839 static inline void iommu_put_resv_regions(struct device *dev,
 840                                         struct list_head *list)
 841 {
 842 }
 843
 844 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
 845                                                struct list_head *head)
 846 {
 847         return -ENODEV;
 848 }
 849
 850 static inline void iommu_set_default_passthrough(bool cmd_line)
 851 {
 852 }
 853
 854 static inline void iommu_set_default_translated(bool cmd_line)
 855 {
 856 }
 857
 858 static inline bool iommu_default_passthrough(void)
 859 {
 860         return true;
 861 }
 862
 863 static inline int iommu_attach_group(struct iommu_domain *domain,
 864                                      struct iommu_group *group)
 865 {
 866         return -ENODEV;
 867 }
 868
 869 static inline void iommu_detach_group(struct iommu_domain *domain,
 870                                       struct iommu_group *group)
 871 {
 872 }
 873
 874 static inline struct iommu_group *iommu_group_alloc(void)
 875 {
 876         return ERR_PTR(-ENODEV);
 877 }
 878
 879 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
 880 {
 881         return NULL;
 882 }
 883
 884 static inline void iommu_group_set_iommudata(struct iommu_group *group,
 885                                              void *iommu_data,
 886                                              void (*release)(void *iommu_data))
 887 {
 888 }
 889
 890 static inline int iommu_group_set_name(struct iommu_group *group,
 891                                        const char *name)
 892 {
 893         return -ENODEV;
 894 }
 895
 896 static inline int iommu_group_add_device(struct iommu_group *group,
 897                                          struct device *dev)
 898 {
 899         return -ENODEV;
 900 }
 901
 902 static inline void iommu_group_remove_device(struct device *dev)
 903 {
 904 }
 905
 906 static inline int iommu_group_for_each_dev(struct iommu_group *group,
 907                                            void *data,
 908                                            int (*fn)(struct device *, void *))
 909 {
 910         return -ENODEV;
 911 }
 912
 913 static inline struct iommu_group *iommu_group_get(struct device *dev)
 914 {
 915         return NULL;
 916 }
 917
 918 static inline void iommu_group_put(struct iommu_group *group)
 919 {
 920 }
 921
 922 static inline
 923 int iommu_register_device_fault_handler(struct device *dev,
 924                                         iommu_dev_fault_handler_t handler,
 925                                         void *data)
 926 {
 927         return -ENODEV;
 928 }
 929
 930 static inline int iommu_unregister_device_fault_handler(struct device *dev)
 931 {
 932         return 0;
 933 }
 934
 935 static inline
 936 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
 937 {
 938         return -ENODEV;
 939 }
 940
 941 static inline int iommu_page_response(struct device *dev,
 942                                       struct iommu_page_response *msg)
 943 {
 944         return -ENODEV;
 945 }
 946
 947 static inline int iommu_group_id(struct iommu_group *group)
 948 {
 949         return -ENODEV;
 950 }
 951
 952 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
 953                 unsigned long quirks)
 954 {
 955         return 0;
 956 }
 957
 958 static inline int iommu_device_register(struct iommu_device *iommu,
 959                                         const struct iommu_ops *ops,
 960                                         struct device *hwdev)
 961 {
 962         return -ENODEV;
 963 }
 964
 965 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
 966 {
 967         return NULL;
 968 }
 969
 970 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
 971 {
 972 }
 973
 974 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
 975                                                struct iommu_iotlb_gather *gather,
 976                                                unsigned long iova, size_t size)
 977 {
 978 }
 979
 980 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
 981 {
 982         return false;
 983 }
 984
 985 static inline void iommu_device_unregister(struct iommu_device *iommu)
 986 {
 987 }
 988
 989 static inline int  iommu_device_sysfs_add(struct iommu_device *iommu,
 990                                           struct device *parent,
 991                                           const struct attribute_group **groups,
 992                                           const char *fmt, ...)
 993 {
 994         return -ENODEV;
 995 }
 996
 997 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
 998 {
 999 }
1000
1001 static inline int iommu_device_link(struct device *dev, struct device *link)
1002 {
1003         return -EINVAL;
1004 }
1005
1006 static inline void iommu_device_unlink(struct device *dev, struct device *link)
1007 {
1008 }
1009
1010 static inline int iommu_fwspec_init(struct device *dev,
1011                                     struct fwnode_handle *iommu_fwnode,
1012                                     const struct iommu_ops *ops)
1013 {
1014         return -ENODEV;
1015 }
1016
1017 static inline void iommu_fwspec_free(struct device *dev)
1018 {
1019 }
1020
1021 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
1022                                        int num_ids)
1023 {
1024         return -ENODEV;
1025 }
1026
1027 static inline
1028 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
1029 {
1030         return NULL;
1031 }
1032
1033 static inline int
1034 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
1035 {
1036         return -ENODEV;
1037 }
1038
1039 static inline int
1040 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1041 {
1042         return -ENODEV;
1043 }
1044
1045 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1046 {
1047         return NULL;
1048 }
1049
1050 static inline int iommu_device_use_default_domain(struct device *dev)
1051 {
1052         return 0;
1053 }
1054
1055 static inline void iommu_device_unuse_default_domain(struct device *dev)
1056 {
1057 }
1058
1059 static inline int
1060 iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1061 {
1062         return -ENODEV;
1063 }
1064
1065 static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1066 {
1067 }
1068
1069 static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1070 {
1071         return false;
1072 }
1073
1074 static inline void iommu_device_release_dma_owner(struct device *dev)
1075 {
1076 }
1077
1078 static inline int iommu_device_claim_dma_owner(struct device *dev, void *owner)
1079 {
1080         return -ENODEV;
1081 }
1082
1083 static inline struct iommu_domain *
1084 iommu_sva_domain_alloc(struct device *dev, struct mm_struct *mm)
1085 {
1086         return NULL;
1087 }
1088
1089 static inline int iommu_attach_device_pasid(struct iommu_domain *domain,
1090                                             struct device *dev, ioasid_t pasid)
1091 {
1092         return -ENODEV;
1093 }
1094
1095 static inline void iommu_detach_device_pasid(struct iommu_domain *domain,
1096                                              struct device *dev, ioasid_t pasid)
1097 {
1098 }
1099
1100 static inline struct iommu_domain *
1101 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
1102                                unsigned int type)
1103 {
1104         return NULL;
1105 }
1106 #endif /* CONFIG_IOMMU_API */
1107
1108 /**
1109  * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1110  * @domain:     The IOMMU domain to perform the mapping
1111  * @iova:       The start address to map the buffer
1112  * @sgt:        The sg_table object describing the buffer
1113  * @prot:       IOMMU protection bits
1114  *
1115  * Creates a mapping at @iova for the buffer described by a scatterlist
1116  * stored in the given sg_table object in the provided IOMMU domain.
1117  */
1118 static inline size_t iommu_map_sgtable(struct iommu_domain *domain,
1119                         unsigned long iova, struct sg_table *sgt, int prot)
1120 {
1121         return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot);
1122 }
1123
1124 #ifdef CONFIG_IOMMU_DEBUGFS
1125 extern  struct dentry *iommu_debugfs_dir;
1126 void iommu_debugfs_setup(void);
1127 #else
1128 static inline void iommu_debugfs_setup(void) {}
1129 #endif
1130
1131 #ifdef CONFIG_IOMMU_DMA
1132 #include <linux/msi.h>
1133
1134 /* Setup call for arch DMA mapping code */
1135 void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit);
1136
1137 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base);
1138
1139 int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr);
1140 void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg);
1141
1142 #else /* CONFIG_IOMMU_DMA */
1143
1144 struct msi_desc;
1145 struct msi_msg;
1146
1147 static inline void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit)
1148 {
1149 }
1150
1151 static inline int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
1152 {
1153         return -ENODEV;
1154 }
1155
1156 static inline int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr)
1157 {
1158         return 0;
1159 }
1160
1161 static inline void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1162 {
1163 }
1164
1165 #endif  /* CONFIG_IOMMU_DMA */
1166
1167 /*
1168  * Newer generations of Tegra SoCs require devices' stream IDs to be directly programmed into
1169  * some registers. These are always paired with a Tegra SMMU or ARM SMMU, for which the contents
1170  * of the struct iommu_fwspec are known. Use this helper to formalize access to these internals.
1171  */
1172 #define TEGRA_STREAM_ID_BYPASS 0x7f
1173
1174 static inline bool tegra_dev_iommu_get_stream_id(struct device *dev, u32 *stream_id)
1175 {
1176 #ifdef CONFIG_IOMMU_API
1177         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
1178
1179         if (fwspec && fwspec->num_ids == 1) {
1180                 *stream_id = fwspec->ids[0] & 0xffff;
1181                 return true;
1182         }
1183 #endif
1184
1185         return false;
1186 }
1187
1188 #ifdef CONFIG_IOMMU_SVA
1189 struct iommu_sva *iommu_sva_bind_device(struct device *dev,
1190                                         struct mm_struct *mm);
1191 void iommu_sva_unbind_device(struct iommu_sva *handle);
1192 u32 iommu_sva_get_pasid(struct iommu_sva *handle);
1193 #else
1194 static inline struct iommu_sva *
1195 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm)
1196 {
1197         return NULL;
1198 }
1199
1200 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1201 {
1202 }
1203
1204 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1205 {
1206         return IOMMU_PASID_INVALID;
1207 }
1208 #endif /* CONFIG_IOMMU_SVA */
1209
1210 #endif /* __LINUX_IOMMU_H */