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