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