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