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 notifier_block;
  41 struct iommu_sva;
  42 struct iommu_fault_event;
  43
  44 /* iommu fault flags */
  45 #define IOMMU_FAULT_READ        0x0
  46 #define IOMMU_FAULT_WRITE       0x1
  47
  48 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
  49                         struct device *, unsigned long, int, void *);
  50 typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
  51
  52 struct iommu_domain_geometry {
  53         dma_addr_t aperture_start; /* First address that can be mapped    */
  54         dma_addr_t aperture_end;   /* Last address that can be mapped     */
  55         bool force_aperture;       /* DMA only allowed in mappable range? */
  56 };
  57
  58 /* Domain feature flags */
  59 #define __IOMMU_DOMAIN_PAGING   (1U << 0)  /* Support for iommu_map/unmap */
  60 #define __IOMMU_DOMAIN_DMA_API  (1U << 1)  /* Domain for use in DMA-API
  61                                               implementation              */
  62 #define __IOMMU_DOMAIN_PT       (1U << 2)  /* Domain is identity mapped   */
  63
  64 /*
  65  * This are the possible domain-types
  66  *
  67  *      IOMMU_DOMAIN_BLOCKED    - All DMA is blocked, can be used to isolate
  68  *                                devices
  69  *      IOMMU_DOMAIN_IDENTITY   - DMA addresses are system physical addresses
  70  *      IOMMU_DOMAIN_UNMANAGED  - DMA mappings managed by IOMMU-API user, used
  71  *                                for VMs
  72  *      IOMMU_DOMAIN_DMA        - Internally used for DMA-API implementations.
  73  *                                This flag allows IOMMU drivers to implement
  74  *                                certain optimizations for these domains
  75  */
  76 #define IOMMU_DOMAIN_BLOCKED    (0U)
  77 #define IOMMU_DOMAIN_IDENTITY   (__IOMMU_DOMAIN_PT)
  78 #define IOMMU_DOMAIN_UNMANAGED  (__IOMMU_DOMAIN_PAGING)
  79 #define IOMMU_DOMAIN_DMA        (__IOMMU_DOMAIN_PAGING |        \
  80                                  __IOMMU_DOMAIN_DMA_API)
  81
  82 struct iommu_domain {
  83         unsigned type;
  84         const struct iommu_ops *ops;
  85         unsigned long pgsize_bitmap;    /* Bitmap of page sizes in use */
  86         iommu_fault_handler_t handler;
  87         void *handler_token;
  88         struct iommu_domain_geometry geometry;
  89         void *iova_cookie;
  90 };
  91
  92 enum iommu_cap {
  93         IOMMU_CAP_CACHE_COHERENCY,      /* IOMMU can enforce cache coherent DMA
  94                                            transactions */
  95         IOMMU_CAP_INTR_REMAP,           /* IOMMU supports interrupt isolation */
  96         IOMMU_CAP_NOEXEC,               /* IOMMU_NOEXEC flag */
  97 };
  98
  99 /* These are the possible reserved region types */
 100 enum iommu_resv_type {
 101         /* Memory regions which must be mapped 1:1 at all times */
 102         IOMMU_RESV_DIRECT,
 103         /*
 104          * Memory regions which are advertised to be 1:1 but are
 105          * commonly considered relaxable in some conditions,
 106          * for instance in device assignment use case (USB, Graphics)
 107          */
 108         IOMMU_RESV_DIRECT_RELAXABLE,
 109         /* Arbitrary "never map this or give it to a device" address ranges */
 110         IOMMU_RESV_RESERVED,
 111         /* Hardware MSI region (untranslated) */
 112         IOMMU_RESV_MSI,
 113         /* Software-managed MSI translation window */
 114         IOMMU_RESV_SW_MSI,
 115 };
 116
 117 /**
 118  * struct iommu_resv_region - descriptor for a reserved memory region
 119  * @list: Linked list pointers
 120  * @start: System physical start address of the region
 121  * @length: Length of the region in bytes
 122  * @prot: IOMMU Protection flags (READ/WRITE/...)
 123  * @type: Type of the reserved region
 124  */
 125 struct iommu_resv_region {
 126         struct list_head        list;
 127         phys_addr_t             start;
 128         size_t                  length;
 129         int                     prot;
 130         enum iommu_resv_type    type;
 131 };
 132
 133 /**
 134  * enum iommu_dev_features - Per device IOMMU features
 135  * @IOMMU_DEV_FEAT_AUX: Auxiliary domain feature
 136  * @IOMMU_DEV_FEAT_SVA: Shared Virtual Addresses
 137  * @IOMMU_DEV_FEAT_IOPF: I/O Page Faults such as PRI or Stall. Generally
 138  *                       enabling %IOMMU_DEV_FEAT_SVA requires
 139  *                       %IOMMU_DEV_FEAT_IOPF, but some devices manage I/O Page
 140  *                       Faults themselves instead of relying on the IOMMU. When
 141  *                       supported, this feature must be enabled before and
 142  *                       disabled after %IOMMU_DEV_FEAT_SVA.
 143  *
 144  * Device drivers query whether a feature is supported using
 145  * iommu_dev_has_feature(), and enable it using iommu_dev_enable_feature().
 146  */
 147 enum iommu_dev_features {
 148         IOMMU_DEV_FEAT_AUX,
 149         IOMMU_DEV_FEAT_SVA,
 150         IOMMU_DEV_FEAT_IOPF,
 151 };
 152
 153 #define IOMMU_PASID_INVALID     (-1U)
 154
 155 #ifdef CONFIG_IOMMU_API
 156
 157 /**
 158  * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
 159  *
 160  * @start: IOVA representing the start of the range to be flushed
 161  * @end: IOVA representing the end of the range to be flushed (inclusive)
 162  * @pgsize: The interval at which to perform the flush
 163  *
 164  * This structure is intended to be updated by multiple calls to the
 165  * ->unmap() function in struct iommu_ops before eventually being passed
 166  * into ->iotlb_sync().
 167  */
 168 struct iommu_iotlb_gather {
 169         unsigned long           start;
 170         unsigned long           end;
 171         size_t                  pgsize;
 172         struct page             *freelist;
 173 };
 174
 175 /**
 176  * struct iommu_ops - iommu ops and capabilities
 177  * @capable: check capability
 178  * @domain_alloc: allocate iommu domain
 179  * @domain_free: free iommu domain
 180  * @attach_dev: attach device to an iommu domain
 181  * @detach_dev: detach device from an iommu domain
 182  * @map: map a physically contiguous memory region to an iommu domain
 183  * @map_pages: map a physically contiguous set of pages of the same size to
 184  *             an iommu domain.
 185  * @unmap: unmap a physically contiguous memory region from an iommu domain
 186  * @unmap_pages: unmap a number of pages of the same size from an iommu domain
 187  * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
 188  * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
 189  * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
 190  *            queue
 191  * @iova_to_phys: translate iova to physical address
 192  * @probe_device: Add device to iommu driver handling
 193  * @release_device: Remove device from iommu driver handling
 194  * @probe_finalize: Do final setup work after the device is added to an IOMMU
 195  *                  group and attached to the groups domain
 196  * @device_group: find iommu group for a particular device
 197  * @enable_nesting: Enable nesting
 198  * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
 199  * @get_resv_regions: Request list of reserved regions for a device
 200  * @put_resv_regions: Free list of reserved regions for a device
 201  * @apply_resv_region: Temporary helper call-back for iova reserved ranges
 202  * @of_xlate: add OF master IDs to iommu grouping
 203  * @is_attach_deferred: Check if domain attach should be deferred from iommu
 204  *                      driver init to device driver init (default no)
 205  * @dev_has/enable/disable_feat: per device entries to check/enable/disable
 206  *                               iommu specific features.
 207  * @dev_feat_enabled: check enabled feature
 208  * @aux_attach/detach_dev: aux-domain specific attach/detach entries.
 209  * @aux_get_pasid: get the pasid given an aux-domain
 210  * @sva_bind: Bind process address space to device
 211  * @sva_unbind: Unbind process address space from device
 212  * @sva_get_pasid: Get PASID associated to a SVA handle
 213  * @page_response: handle page request response
 214  * @cache_invalidate: invalidate translation caches
 215  * @sva_bind_gpasid: bind guest pasid and mm
 216  * @sva_unbind_gpasid: unbind guest pasid and mm
 217  * @def_domain_type: device default domain type, return value:
 218  *              - IOMMU_DOMAIN_IDENTITY: must use an identity domain
 219  *              - IOMMU_DOMAIN_DMA: must use a dma domain
 220  *              - 0: use the default setting
 221  * @pgsize_bitmap: bitmap of all possible supported page sizes
 222  * @owner: Driver module providing these ops
 223  */
 224 struct iommu_ops {
 225         bool (*capable)(enum iommu_cap);
 226
 227         /* Domain allocation and freeing by the iommu driver */
 228         struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
 229         void (*domain_free)(struct iommu_domain *);
 230
 231         int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
 232         void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
 233         int (*map)(struct iommu_domain *domain, unsigned long iova,
 234                    phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
 235         int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
 236                          phys_addr_t paddr, size_t pgsize, size_t pgcount,
 237                          int prot, gfp_t gfp, size_t *mapped);
 238         size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
 239                      size_t size, struct iommu_iotlb_gather *iotlb_gather);
 240         size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
 241                               size_t pgsize, size_t pgcount,
 242                               struct iommu_iotlb_gather *iotlb_gather);
 243         void (*flush_iotlb_all)(struct iommu_domain *domain);
 244         void (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
 245                                size_t size);
 246         void (*iotlb_sync)(struct iommu_domain *domain,
 247                            struct iommu_iotlb_gather *iotlb_gather);
 248         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
 249         struct iommu_device *(*probe_device)(struct device *dev);
 250         void (*release_device)(struct device *dev);
 251         void (*probe_finalize)(struct device *dev);
 252         struct iommu_group *(*device_group)(struct device *dev);
 253         int (*enable_nesting)(struct iommu_domain *domain);
 254         int (*set_pgtable_quirks)(struct iommu_domain *domain,
 255                                   unsigned long quirks);
 256
 257         /* Request/Free a list of reserved regions for a device */
 258         void (*get_resv_regions)(struct device *dev, struct list_head *list);
 259         void (*put_resv_regions)(struct device *dev, struct list_head *list);
 260         void (*apply_resv_region)(struct device *dev,
 261                                   struct iommu_domain *domain,
 262                                   struct iommu_resv_region *region);
 263
 264         int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
 265         bool (*is_attach_deferred)(struct iommu_domain *domain, struct device *dev);
 266
 267         /* Per device IOMMU features */
 268         bool (*dev_has_feat)(struct device *dev, enum iommu_dev_features f);
 269         bool (*dev_feat_enabled)(struct device *dev, enum iommu_dev_features f);
 270         int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
 271         int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
 272
 273         /* Aux-domain specific attach/detach entries */
 274         int (*aux_attach_dev)(struct iommu_domain *domain, struct device *dev);
 275         void (*aux_detach_dev)(struct iommu_domain *domain, struct device *dev);
 276         int (*aux_get_pasid)(struct iommu_domain *domain, struct device *dev);
 277
 278         struct iommu_sva *(*sva_bind)(struct device *dev, struct mm_struct *mm,
 279                                       void *drvdata);
 280         void (*sva_unbind)(struct iommu_sva *handle);
 281         u32 (*sva_get_pasid)(struct iommu_sva *handle);
 282
 283         int (*page_response)(struct device *dev,
 284                              struct iommu_fault_event *evt,
 285                              struct iommu_page_response *msg);
 286         int (*cache_invalidate)(struct iommu_domain *domain, struct device *dev,
 287                                 struct iommu_cache_invalidate_info *inv_info);
 288         int (*sva_bind_gpasid)(struct iommu_domain *domain,
 289                         struct device *dev, struct iommu_gpasid_bind_data *data);
 290
 291         int (*sva_unbind_gpasid)(struct device *dev, u32 pasid);
 292
 293         int (*def_domain_type)(struct device *dev);
 294
 295         unsigned long pgsize_bitmap;
 296         struct module *owner;
 297 };
 298
 299 /**
 300  * struct iommu_device - IOMMU core representation of one IOMMU hardware
 301  *                       instance
 302  * @list: Used by the iommu-core to keep a list of registered iommus
 303  * @ops: iommu-ops for talking to this iommu
 304  * @dev: struct device for sysfs handling
 305  */
 306 struct iommu_device {
 307         struct list_head list;
 308         const struct iommu_ops *ops;
 309         struct fwnode_handle *fwnode;
 310         struct device *dev;
 311 };
 312
 313 /**
 314  * struct iommu_fault_event - Generic fault event
 315  *
 316  * Can represent recoverable faults such as a page requests or
 317  * unrecoverable faults such as DMA or IRQ remapping faults.
 318  *
 319  * @fault: fault descriptor
 320  * @list: pending fault event list, used for tracking responses
 321  */
 322 struct iommu_fault_event {
 323         struct iommu_fault fault;
 324         struct list_head list;
 325 };
 326
 327 /**
 328  * struct iommu_fault_param - per-device IOMMU fault data
 329  * @handler: Callback function to handle IOMMU faults at device level
 330  * @data: handler private data
 331  * @faults: holds the pending faults which needs response
 332  * @lock: protect pending faults list
 333  */
 334 struct iommu_fault_param {
 335         iommu_dev_fault_handler_t handler;
 336         void *data;
 337         struct list_head faults;
 338         struct mutex lock;
 339 };
 340
 341 /**
 342  * struct dev_iommu - Collection of per-device IOMMU data
 343  *
 344  * @fault_param: IOMMU detected device fault reporting data
 345  * @iopf_param:  I/O Page Fault queue and data
 346  * @fwspec:      IOMMU fwspec data
 347  * @iommu_dev:   IOMMU device this device is linked to
 348  * @priv:        IOMMU Driver private data
 349  *
 350  * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
 351  *      struct iommu_group      *iommu_group;
 352  */
 353 struct dev_iommu {
 354         struct mutex lock;
 355         struct iommu_fault_param        *fault_param;
 356         struct iopf_device_param        *iopf_param;
 357         struct iommu_fwspec             *fwspec;
 358         struct iommu_device             *iommu_dev;
 359         void                            *priv;
 360 };
 361
 362 int iommu_device_register(struct iommu_device *iommu,
 363                           const struct iommu_ops *ops,
 364                           struct device *hwdev);
 365 void iommu_device_unregister(struct iommu_device *iommu);
 366 int  iommu_device_sysfs_add(struct iommu_device *iommu,
 367                             struct device *parent,
 368                             const struct attribute_group **groups,
 369                             const char *fmt, ...) __printf(4, 5);
 370 void iommu_device_sysfs_remove(struct iommu_device *iommu);
 371 int  iommu_device_link(struct iommu_device   *iommu, struct device *link);
 372 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
 373 int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
 374
 375 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
 376 {
 377         return (struct iommu_device *)dev_get_drvdata(dev);
 378 }
 379
 380 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
 381 {
 382         *gather = (struct iommu_iotlb_gather) {
 383                 .start  = ULONG_MAX,
 384         };
 385 }
 386
 387 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE           1 /* Device added */
 388 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE           2 /* Pre Device removed */
 389 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER          3 /* Pre Driver bind */
 390 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER         4 /* Post Driver bind */
 391 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER        5 /* Pre Driver unbind */
 392 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER       6 /* Post Driver unbind */
 393
 394 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
 395 extern int bus_iommu_probe(struct bus_type *bus);
 396 extern bool iommu_present(struct bus_type *bus);
 397 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
 398 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
 399 extern struct iommu_group *iommu_group_get_by_id(int id);
 400 extern void iommu_domain_free(struct iommu_domain *domain);
 401 extern int iommu_attach_device(struct iommu_domain *domain,
 402                                struct device *dev);
 403 extern void iommu_detach_device(struct iommu_domain *domain,
 404                                 struct device *dev);
 405 extern int iommu_uapi_cache_invalidate(struct iommu_domain *domain,
 406                                        struct device *dev,
 407                                        void __user *uinfo);
 408
 409 extern int iommu_uapi_sva_bind_gpasid(struct iommu_domain *domain,
 410                                       struct device *dev, void __user *udata);
 411 extern int iommu_uapi_sva_unbind_gpasid(struct iommu_domain *domain,
 412                                         struct device *dev, void __user *udata);
 413 extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
 414                                    struct device *dev, ioasid_t pasid);
 415 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
 416 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
 417 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
 418                      phys_addr_t paddr, size_t size, int prot);
 419 extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
 420                             phys_addr_t paddr, size_t size, int prot);
 421 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 422                           size_t size);
 423 extern size_t iommu_unmap_fast(struct iommu_domain *domain,
 424                                unsigned long iova, size_t size,
 425                                struct iommu_iotlb_gather *iotlb_gather);
 426 extern size_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
 427                            struct scatterlist *sg,unsigned int nents, int prot);
 428 extern size_t iommu_map_sg_atomic(struct iommu_domain *domain,
 429                                   unsigned long iova, struct scatterlist *sg,
 430                                   unsigned int nents, int prot);
 431 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
 432 extern void iommu_set_fault_handler(struct iommu_domain *domain,
 433                         iommu_fault_handler_t handler, void *token);
 434
 435 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
 436 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
 437 extern void generic_iommu_put_resv_regions(struct device *dev,
 438                                            struct list_head *list);
 439 extern void iommu_set_default_passthrough(bool cmd_line);
 440 extern void iommu_set_default_translated(bool cmd_line);
 441 extern bool iommu_default_passthrough(void);
 442 extern struct iommu_resv_region *
 443 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
 444                         enum iommu_resv_type type);
 445 extern int iommu_get_group_resv_regions(struct iommu_group *group,
 446                                         struct list_head *head);
 447
 448 extern int iommu_attach_group(struct iommu_domain *domain,
 449                               struct iommu_group *group);
 450 extern void iommu_detach_group(struct iommu_domain *domain,
 451                                struct iommu_group *group);
 452 extern struct iommu_group *iommu_group_alloc(void);
 453 extern void *iommu_group_get_iommudata(struct iommu_group *group);
 454 extern void iommu_group_set_iommudata(struct iommu_group *group,
 455                                       void *iommu_data,
 456                                       void (*release)(void *iommu_data));
 457 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
 458 extern int iommu_group_add_device(struct iommu_group *group,
 459                                   struct device *dev);
 460 extern void iommu_group_remove_device(struct device *dev);
 461 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
 462                                     int (*fn)(struct device *, void *));
 463 extern struct iommu_group *iommu_group_get(struct device *dev);
 464 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
 465 extern void iommu_group_put(struct iommu_group *group);
 466 extern int iommu_group_register_notifier(struct iommu_group *group,
 467                                          struct notifier_block *nb);
 468 extern int iommu_group_unregister_notifier(struct iommu_group *group,
 469                                            struct notifier_block *nb);
 470 extern int iommu_register_device_fault_handler(struct device *dev,
 471                                         iommu_dev_fault_handler_t handler,
 472                                         void *data);
 473
 474 extern int iommu_unregister_device_fault_handler(struct device *dev);
 475
 476 extern int iommu_report_device_fault(struct device *dev,
 477                                      struct iommu_fault_event *evt);
 478 extern int iommu_page_response(struct device *dev,
 479                                struct iommu_page_response *msg);
 480
 481 extern int iommu_group_id(struct iommu_group *group);
 482 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
 483
 484 int iommu_enable_nesting(struct iommu_domain *domain);
 485 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
 486                 unsigned long quirks);
 487
 488 void iommu_set_dma_strict(bool val);
 489 bool iommu_get_dma_strict(struct iommu_domain *domain);
 490
 491 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
 492                               unsigned long iova, int flags);
 493
 494 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
 495 {
 496         if (domain->ops->flush_iotlb_all)
 497                 domain->ops->flush_iotlb_all(domain);
 498 }
 499
 500 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
 501                                   struct iommu_iotlb_gather *iotlb_gather)
 502 {
 503         if (domain->ops->iotlb_sync)
 504                 domain->ops->iotlb_sync(domain, iotlb_gather);
 505
 506         iommu_iotlb_gather_init(iotlb_gather);
 507 }
 508
 509 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
 510                                                struct iommu_iotlb_gather *gather,
 511                                                unsigned long iova, size_t size)
 512 {
 513         unsigned long start = iova, end = start + size - 1;
 514
 515         /*
 516          * If the new page is disjoint from the current range or is mapped at
 517          * a different granularity, then sync the TLB so that the gather
 518          * structure can be rewritten.
 519          */
 520         if (gather->pgsize != size ||
 521             end + 1 < gather->start || start > gather->end + 1) {
 522                 if (gather->pgsize)
 523                         iommu_iotlb_sync(domain, gather);
 524                 gather->pgsize = size;
 525         }
 526
 527         if (gather->end < end)
 528                 gather->end = end;
 529
 530         if (gather->start > start)
 531                 gather->start = start;
 532 }
 533
 534 /* PCI device grouping function */
 535 extern struct iommu_group *pci_device_group(struct device *dev);
 536 /* Generic device grouping function */
 537 extern struct iommu_group *generic_device_group(struct device *dev);
 538 /* FSL-MC device grouping function */
 539 struct iommu_group *fsl_mc_device_group(struct device *dev);
 540
 541 /**
 542  * struct iommu_fwspec - per-device IOMMU instance data
 543  * @ops: ops for this device's IOMMU
 544  * @iommu_fwnode: firmware handle for this device's IOMMU
 545  * @flags: IOMMU_FWSPEC_* flags
 546  * @num_ids: number of associated device IDs
 547  * @ids: IDs which this device may present to the IOMMU
 548  */
 549 struct iommu_fwspec {
 550         const struct iommu_ops  *ops;
 551         struct fwnode_handle    *iommu_fwnode;
 552         u32                     flags;
 553         unsigned int            num_ids;
 554         u32                     ids[];
 555 };
 556
 557 /* ATS is supported */
 558 #define IOMMU_FWSPEC_PCI_RC_ATS                 (1 << 0)
 559
 560 /**
 561  * struct iommu_sva - handle to a device-mm bond
 562  */
 563 struct iommu_sva {
 564         struct device                   *dev;
 565 };
 566
 567 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
 568                       const struct iommu_ops *ops);
 569 void iommu_fwspec_free(struct device *dev);
 570 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
 571 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
 572
 573 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
 574 {
 575         if (dev->iommu)
 576                 return dev->iommu->fwspec;
 577         else
 578                 return NULL;
 579 }
 580
 581 static inline void dev_iommu_fwspec_set(struct device *dev,
 582                                         struct iommu_fwspec *fwspec)
 583 {
 584         dev->iommu->fwspec = fwspec;
 585 }
 586
 587 static inline void *dev_iommu_priv_get(struct device *dev)
 588 {
 589         if (dev->iommu)
 590                 return dev->iommu->priv;
 591         else
 592                 return NULL;
 593 }
 594
 595 static inline void dev_iommu_priv_set(struct device *dev, void *priv)
 596 {
 597         dev->iommu->priv = priv;
 598 }
 599
 600 int iommu_probe_device(struct device *dev);
 601 void iommu_release_device(struct device *dev);
 602
 603 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
 604 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
 605 bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features f);
 606 int iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev);
 607 void iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev);
 608 int iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev);
 609
 610 struct iommu_sva *iommu_sva_bind_device(struct device *dev,
 611                                         struct mm_struct *mm,
 612                                         void *drvdata);
 613 void iommu_sva_unbind_device(struct iommu_sva *handle);
 614 u32 iommu_sva_get_pasid(struct iommu_sva *handle);
 615
 616 #else /* CONFIG_IOMMU_API */
 617
 618 struct iommu_ops {};
 619 struct iommu_group {};
 620 struct iommu_fwspec {};
 621 struct iommu_device {};
 622 struct iommu_fault_param {};
 623 struct iommu_iotlb_gather {};
 624
 625 static inline bool iommu_present(struct bus_type *bus)
 626 {
 627         return false;
 628 }
 629
 630 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
 631 {
 632         return false;
 633 }
 634
 635 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
 636 {
 637         return NULL;
 638 }
 639
 640 static inline struct iommu_group *iommu_group_get_by_id(int id)
 641 {
 642         return NULL;
 643 }
 644
 645 static inline void iommu_domain_free(struct iommu_domain *domain)
 646 {
 647 }
 648
 649 static inline int iommu_attach_device(struct iommu_domain *domain,
 650                                       struct device *dev)
 651 {
 652         return -ENODEV;
 653 }
 654
 655 static inline void iommu_detach_device(struct iommu_domain *domain,
 656                                        struct device *dev)
 657 {
 658 }
 659
 660 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
 661 {
 662         return NULL;
 663 }
 664
 665 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
 666                             phys_addr_t paddr, size_t size, int prot)
 667 {
 668         return -ENODEV;
 669 }
 670
 671 static inline int iommu_map_atomic(struct iommu_domain *domain,
 672                                    unsigned long iova, phys_addr_t paddr,
 673                                    size_t size, int prot)
 674 {
 675         return -ENODEV;
 676 }
 677
 678 static inline size_t iommu_unmap(struct iommu_domain *domain,
 679                                  unsigned long iova, size_t size)
 680 {
 681         return 0;
 682 }
 683
 684 static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
 685                                       unsigned long iova, int gfp_order,
 686                                       struct iommu_iotlb_gather *iotlb_gather)
 687 {
 688         return 0;
 689 }
 690
 691 static inline size_t iommu_map_sg(struct iommu_domain *domain,
 692                                   unsigned long iova, struct scatterlist *sg,
 693                                   unsigned int nents, int prot)
 694 {
 695         return 0;
 696 }
 697
 698 static inline size_t iommu_map_sg_atomic(struct iommu_domain *domain,
 699                                   unsigned long iova, struct scatterlist *sg,
 700                                   unsigned int nents, int prot)
 701 {
 702         return 0;
 703 }
 704
 705 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
 706 {
 707 }
 708
 709 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
 710                                   struct iommu_iotlb_gather *iotlb_gather)
 711 {
 712 }
 713
 714 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
 715 {
 716         return 0;
 717 }
 718
 719 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
 720                                 iommu_fault_handler_t handler, void *token)
 721 {
 722 }
 723
 724 static inline void iommu_get_resv_regions(struct device *dev,
 725                                         struct list_head *list)
 726 {
 727 }
 728
 729 static inline void iommu_put_resv_regions(struct device *dev,
 730                                         struct list_head *list)
 731 {
 732 }
 733
 734 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
 735                                                struct list_head *head)
 736 {
 737         return -ENODEV;
 738 }
 739
 740 static inline void iommu_set_default_passthrough(bool cmd_line)
 741 {
 742 }
 743
 744 static inline void iommu_set_default_translated(bool cmd_line)
 745 {
 746 }
 747
 748 static inline bool iommu_default_passthrough(void)
 749 {
 750         return true;
 751 }
 752
 753 static inline int iommu_attach_group(struct iommu_domain *domain,
 754                                      struct iommu_group *group)
 755 {
 756         return -ENODEV;
 757 }
 758
 759 static inline void iommu_detach_group(struct iommu_domain *domain,
 760                                       struct iommu_group *group)
 761 {
 762 }
 763
 764 static inline struct iommu_group *iommu_group_alloc(void)
 765 {
 766         return ERR_PTR(-ENODEV);
 767 }
 768
 769 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
 770 {
 771         return NULL;
 772 }
 773
 774 static inline void iommu_group_set_iommudata(struct iommu_group *group,
 775                                              void *iommu_data,
 776                                              void (*release)(void *iommu_data))
 777 {
 778 }
 779
 780 static inline int iommu_group_set_name(struct iommu_group *group,
 781                                        const char *name)
 782 {
 783         return -ENODEV;
 784 }
 785
 786 static inline int iommu_group_add_device(struct iommu_group *group,
 787                                          struct device *dev)
 788 {
 789         return -ENODEV;
 790 }
 791
 792 static inline void iommu_group_remove_device(struct device *dev)
 793 {
 794 }
 795
 796 static inline int iommu_group_for_each_dev(struct iommu_group *group,
 797                                            void *data,
 798                                            int (*fn)(struct device *, void *))
 799 {
 800         return -ENODEV;
 801 }
 802
 803 static inline struct iommu_group *iommu_group_get(struct device *dev)
 804 {
 805         return NULL;
 806 }
 807
 808 static inline void iommu_group_put(struct iommu_group *group)
 809 {
 810 }
 811
 812 static inline int iommu_group_register_notifier(struct iommu_group *group,
 813                                                 struct notifier_block *nb)
 814 {
 815         return -ENODEV;
 816 }
 817
 818 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
 819                                                   struct notifier_block *nb)
 820 {
 821         return 0;
 822 }
 823
 824 static inline
 825 int iommu_register_device_fault_handler(struct device *dev,
 826                                         iommu_dev_fault_handler_t handler,
 827                                         void *data)
 828 {
 829         return -ENODEV;
 830 }
 831
 832 static inline int iommu_unregister_device_fault_handler(struct device *dev)
 833 {
 834         return 0;
 835 }
 836
 837 static inline
 838 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
 839 {
 840         return -ENODEV;
 841 }
 842
 843 static inline int iommu_page_response(struct device *dev,
 844                                       struct iommu_page_response *msg)
 845 {
 846         return -ENODEV;
 847 }
 848
 849 static inline int iommu_group_id(struct iommu_group *group)
 850 {
 851         return -ENODEV;
 852 }
 853
 854 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
 855                 unsigned long quirks)
 856 {
 857         return 0;
 858 }
 859
 860 static inline int iommu_device_register(struct iommu_device *iommu,
 861                                         const struct iommu_ops *ops,
 862                                         struct device *hwdev)
 863 {
 864         return -ENODEV;
 865 }
 866
 867 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
 868 {
 869         return NULL;
 870 }
 871
 872 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
 873 {
 874 }
 875
 876 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
 877                                                struct iommu_iotlb_gather *gather,
 878                                                unsigned long iova, size_t size)
 879 {
 880 }
 881
 882 static inline void iommu_device_unregister(struct iommu_device *iommu)
 883 {
 884 }
 885
 886 static inline int  iommu_device_sysfs_add(struct iommu_device *iommu,
 887                                           struct device *parent,
 888                                           const struct attribute_group **groups,
 889                                           const char *fmt, ...)
 890 {
 891         return -ENODEV;
 892 }
 893
 894 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
 895 {
 896 }
 897
 898 static inline int iommu_device_link(struct device *dev, struct device *link)
 899 {
 900         return -EINVAL;
 901 }
 902
 903 static inline void iommu_device_unlink(struct device *dev, struct device *link)
 904 {
 905 }
 906
 907 static inline int iommu_fwspec_init(struct device *dev,
 908                                     struct fwnode_handle *iommu_fwnode,
 909                                     const struct iommu_ops *ops)
 910 {
 911         return -ENODEV;
 912 }
 913
 914 static inline void iommu_fwspec_free(struct device *dev)
 915 {
 916 }
 917
 918 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
 919                                        int num_ids)
 920 {
 921         return -ENODEV;
 922 }
 923
 924 static inline
 925 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
 926 {
 927         return NULL;
 928 }
 929
 930 static inline bool
 931 iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat)
 932 {
 933         return false;
 934 }
 935
 936 static inline int
 937 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
 938 {
 939         return -ENODEV;
 940 }
 941
 942 static inline int
 943 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
 944 {
 945         return -ENODEV;
 946 }
 947
 948 static inline int
 949 iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev)
 950 {
 951         return -ENODEV;
 952 }
 953
 954 static inline void
 955 iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev)
 956 {
 957 }
 958
 959 static inline int
 960 iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev)
 961 {
 962         return -ENODEV;
 963 }
 964
 965 static inline struct iommu_sva *
 966 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm, void *drvdata)
 967 {
 968         return NULL;
 969 }
 970
 971 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
 972 {
 973 }
 974
 975 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
 976 {
 977         return IOMMU_PASID_INVALID;
 978 }
 979
 980 static inline int
 981 iommu_uapi_cache_invalidate(struct iommu_domain *domain,
 982                             struct device *dev,
 983                             struct iommu_cache_invalidate_info *inv_info)
 984 {
 985         return -ENODEV;
 986 }
 987
 988 static inline int iommu_uapi_sva_bind_gpasid(struct iommu_domain *domain,
 989                                              struct device *dev, void __user *udata)
 990 {
 991         return -ENODEV;
 992 }
 993
 994 static inline int iommu_uapi_sva_unbind_gpasid(struct iommu_domain *domain,
 995                                                struct device *dev, void __user *udata)
 996 {
 997         return -ENODEV;
 998 }
 999
1000 static inline int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
1001                                           struct device *dev,
1002                                           ioasid_t pasid)
1003 {
1004         return -ENODEV;
1005 }
1006
1007 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1008 {
1009         return NULL;
1010 }
1011 #endif /* CONFIG_IOMMU_API */
1012
1013 /**
1014  * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1015  * @domain:     The IOMMU domain to perform the mapping
1016  * @iova:       The start address to map the buffer
1017  * @sgt:        The sg_table object describing the buffer
1018  * @prot:       IOMMU protection bits
1019  *
1020  * Creates a mapping at @iova for the buffer described by a scatterlist
1021  * stored in the given sg_table object in the provided IOMMU domain.
1022  */
1023 static inline size_t iommu_map_sgtable(struct iommu_domain *domain,
1024                         unsigned long iova, struct sg_table *sgt, int prot)
1025 {
1026         return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot);
1027 }
1028
1029 #ifdef CONFIG_IOMMU_DEBUGFS
1030 extern  struct dentry *iommu_debugfs_dir;
1031 void iommu_debugfs_setup(void);
1032 #else
1033 static inline void iommu_debugfs_setup(void) {}
1034 #endif
1035
1036 #endif /* __LINUX_IOMMU_H */