1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
7 #ifndef __LINUX_IOMMU_H
8 #define __LINUX_IOMMU_H
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>
16 #include <linux/ioasid.h>
17 #include <uapi/linux/iommu.h>
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 */
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.
33 #define IOMMU_PRIV (1 << 5)
40 struct iommu_domain_ops;
41 struct notifier_block;
43 struct iommu_fault_event;
44 struct iommu_dma_cookie;
46 /* iommu fault flags */
47 #define IOMMU_FAULT_READ 0x0
48 #define IOMMU_FAULT_WRITE 0x1
50 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
51 struct device *, unsigned long, int, void *);
52 typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
54 struct iommu_domain_geometry {
55 dma_addr_t aperture_start; /* First address that can be mapped */
56 dma_addr_t aperture_end; /* Last address that can be mapped */
57 bool force_aperture; /* DMA only allowed in mappable range? */
60 /* Domain feature flags */
61 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
62 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
64 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
65 #define __IOMMU_DOMAIN_DMA_FQ (1U << 3) /* DMA-API uses flush queue */
67 #define __IOMMU_DOMAIN_SVA (1U << 4) /* Shared process address space */
70 * This are the possible domain-types
72 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
74 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
75 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
77 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
78 * This flag allows IOMMU drivers to implement
79 * certain optimizations for these domains
80 * IOMMU_DOMAIN_DMA_FQ - As above, but definitely using batched TLB
82 * IOMMU_DOMAIN_SVA - DMA addresses are shared process addresses
83 * represented by mm_struct's.
85 #define IOMMU_DOMAIN_BLOCKED (0U)
86 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
87 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
88 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
89 __IOMMU_DOMAIN_DMA_API)
90 #define IOMMU_DOMAIN_DMA_FQ (__IOMMU_DOMAIN_PAGING | \
91 __IOMMU_DOMAIN_DMA_API | \
92 __IOMMU_DOMAIN_DMA_FQ)
93 #define IOMMU_DOMAIN_SVA (__IOMMU_DOMAIN_SVA)
97 const struct iommu_domain_ops *ops;
98 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
99 struct iommu_domain_geometry geometry;
100 struct iommu_dma_cookie *iova_cookie;
101 enum iommu_page_response_code (*iopf_handler)(struct iommu_fault *fault,
106 iommu_fault_handler_t handler;
109 struct { /* IOMMU_DOMAIN_SVA */
110 struct mm_struct *mm;
116 static inline bool iommu_is_dma_domain(struct iommu_domain *domain)
118 return domain->type & __IOMMU_DOMAIN_DMA_API;
122 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU_CACHE is supported */
123 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
124 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
125 IOMMU_CAP_PRE_BOOT_PROTECTION, /* Firmware says it used the IOMMU for
126 DMA protection and we should too */
128 * Per-device flag indicating if enforce_cache_coherency() will work on
131 IOMMU_CAP_ENFORCE_CACHE_COHERENCY,
134 /* These are the possible reserved region types */
135 enum iommu_resv_type {
136 /* Memory regions which must be mapped 1:1 at all times */
139 * Memory regions which are advertised to be 1:1 but are
140 * commonly considered relaxable in some conditions,
141 * for instance in device assignment use case (USB, Graphics)
143 IOMMU_RESV_DIRECT_RELAXABLE,
144 /* Arbitrary "never map this or give it to a device" address ranges */
146 /* Hardware MSI region (untranslated) */
148 /* Software-managed MSI translation window */
153 * struct iommu_resv_region - descriptor for a reserved memory region
154 * @list: Linked list pointers
155 * @start: System physical start address of the region
156 * @length: Length of the region in bytes
157 * @prot: IOMMU Protection flags (READ/WRITE/...)
158 * @type: Type of the reserved region
159 * @free: Callback to free associated memory allocations
161 struct iommu_resv_region {
162 struct list_head list;
166 enum iommu_resv_type type;
167 void (*free)(struct device *dev, struct iommu_resv_region *region);
170 struct iommu_iort_rmr_data {
171 struct iommu_resv_region rr;
173 /* Stream IDs associated with IORT RMR entry */
179 * enum iommu_dev_features - Per device IOMMU features
180 * @IOMMU_DEV_FEAT_SVA: Shared Virtual Addresses
181 * @IOMMU_DEV_FEAT_IOPF: I/O Page Faults such as PRI or Stall. Generally
182 * enabling %IOMMU_DEV_FEAT_SVA requires
183 * %IOMMU_DEV_FEAT_IOPF, but some devices manage I/O Page
184 * Faults themselves instead of relying on the IOMMU. When
185 * supported, this feature must be enabled before and
186 * disabled after %IOMMU_DEV_FEAT_SVA.
188 * Device drivers enable a feature using iommu_dev_enable_feature().
190 enum iommu_dev_features {
195 #define IOMMU_PASID_INVALID (-1U)
197 #ifdef CONFIG_IOMMU_API
200 * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
202 * @start: IOVA representing the start of the range to be flushed
203 * @end: IOVA representing the end of the range to be flushed (inclusive)
204 * @pgsize: The interval at which to perform the flush
205 * @freelist: Removed pages to free after sync
206 * @queued: Indicates that the flush will be queued
208 * This structure is intended to be updated by multiple calls to the
209 * ->unmap() function in struct iommu_ops before eventually being passed
210 * into ->iotlb_sync(). Drivers can add pages to @freelist to be freed after
211 * ->iotlb_sync() or ->iotlb_flush_all() have cleared all cached references to
212 * them. @queued is set to indicate when ->iotlb_flush_all() will be called
213 * later instead of ->iotlb_sync(), so drivers may optimise accordingly.
215 struct iommu_iotlb_gather {
219 struct list_head freelist;
224 * struct iommu_ops - iommu ops and capabilities
225 * @capable: check capability
226 * @domain_alloc: allocate iommu domain
227 * @probe_device: Add device to iommu driver handling
228 * @release_device: Remove device from iommu driver handling
229 * @probe_finalize: Do final setup work after the device is added to an IOMMU
230 * group and attached to the groups domain
231 * @device_group: find iommu group for a particular device
232 * @get_resv_regions: Request list of reserved regions for a device
233 * @of_xlate: add OF master IDs to iommu grouping
234 * @is_attach_deferred: Check if domain attach should be deferred from iommu
235 * driver init to device driver init (default no)
236 * @dev_enable/disable_feat: per device entries to enable/disable
237 * iommu specific features.
238 * @page_response: handle page request response
239 * @def_domain_type: device default domain type, return value:
240 * - IOMMU_DOMAIN_IDENTITY: must use an identity domain
241 * - IOMMU_DOMAIN_DMA: must use a dma domain
242 * - 0: use the default setting
243 * @default_domain_ops: the default ops for domains
244 * @remove_dev_pasid: Remove any translation configurations of a specific
245 * pasid, so that any DMA transactions with this pasid
246 * will be blocked by the hardware.
247 * @pgsize_bitmap: bitmap of all possible supported page sizes
248 * @owner: Driver module providing these ops
251 bool (*capable)(struct device *dev, enum iommu_cap);
253 /* Domain allocation and freeing by the iommu driver */
254 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
256 struct iommu_device *(*probe_device)(struct device *dev);
257 void (*release_device)(struct device *dev);
258 void (*probe_finalize)(struct device *dev);
259 struct iommu_group *(*device_group)(struct device *dev);
261 /* Request/Free a list of reserved regions for a device */
262 void (*get_resv_regions)(struct device *dev, struct list_head *list);
264 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
265 bool (*is_attach_deferred)(struct device *dev);
267 /* Per device IOMMU features */
268 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
269 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
271 int (*page_response)(struct device *dev,
272 struct iommu_fault_event *evt,
273 struct iommu_page_response *msg);
275 int (*def_domain_type)(struct device *dev);
276 void (*remove_dev_pasid)(struct device *dev, ioasid_t pasid);
278 const struct iommu_domain_ops *default_domain_ops;
279 unsigned long pgsize_bitmap;
280 struct module *owner;
284 * struct iommu_domain_ops - domain specific operations
285 * @attach_dev: attach an iommu domain to a device
288 * * EINVAL - can indicate that device and domain are incompatible due to
289 * some previous configuration of the domain, in which case the
290 * driver shouldn't log an error, since it is legitimate for a
291 * caller to test reuse of existing domains. Otherwise, it may
292 * still represent some other fundamental problem
293 * * ENOMEM - out of memory
294 * * ENOSPC - non-ENOMEM type of resource allocation failures
295 * * EBUSY - device is attached to a domain and cannot be changed
296 * * ENODEV - device specific errors, not able to be attached
297 * * <others> - treated as ENODEV by the caller. Use is discouraged
298 * @detach_dev: detach an iommu domain from a device
299 * @set_dev_pasid: set an iommu domain to a pasid of device
300 * @map: map a physically contiguous memory region to an iommu domain
301 * @map_pages: map a physically contiguous set of pages of the same size to
303 * @unmap: unmap a physically contiguous memory region from an iommu domain
304 * @unmap_pages: unmap a number of pages of the same size from an iommu domain
305 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
306 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
307 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
309 * @iova_to_phys: translate iova to physical address
310 * @enforce_cache_coherency: Prevent any kind of DMA from bypassing IOMMU_CACHE,
311 * including no-snoop TLPs on PCIe or other platform
312 * specific mechanisms.
313 * @enable_nesting: Enable nesting
314 * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
315 * @free: Release the domain after use.
317 struct iommu_domain_ops {
318 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
319 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
320 int (*set_dev_pasid)(struct iommu_domain *domain, struct device *dev,
323 int (*map)(struct iommu_domain *domain, unsigned long iova,
324 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
325 int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
326 phys_addr_t paddr, size_t pgsize, size_t pgcount,
327 int prot, gfp_t gfp, size_t *mapped);
328 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
329 size_t size, struct iommu_iotlb_gather *iotlb_gather);
330 size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
331 size_t pgsize, size_t pgcount,
332 struct iommu_iotlb_gather *iotlb_gather);
334 void (*flush_iotlb_all)(struct iommu_domain *domain);
335 void (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
337 void (*iotlb_sync)(struct iommu_domain *domain,
338 struct iommu_iotlb_gather *iotlb_gather);
340 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
343 bool (*enforce_cache_coherency)(struct iommu_domain *domain);
344 int (*enable_nesting)(struct iommu_domain *domain);
345 int (*set_pgtable_quirks)(struct iommu_domain *domain,
346 unsigned long quirks);
348 void (*free)(struct iommu_domain *domain);
352 * struct iommu_device - IOMMU core representation of one IOMMU hardware
354 * @list: Used by the iommu-core to keep a list of registered iommus
355 * @ops: iommu-ops for talking to this iommu
356 * @dev: struct device for sysfs handling
357 * @max_pasids: number of supported PASIDs
359 struct iommu_device {
360 struct list_head list;
361 const struct iommu_ops *ops;
362 struct fwnode_handle *fwnode;
368 * struct iommu_fault_event - Generic fault event
370 * Can represent recoverable faults such as a page requests or
371 * unrecoverable faults such as DMA or IRQ remapping faults.
373 * @fault: fault descriptor
374 * @list: pending fault event list, used for tracking responses
376 struct iommu_fault_event {
377 struct iommu_fault fault;
378 struct list_head list;
382 * struct iommu_fault_param - per-device IOMMU fault data
383 * @handler: Callback function to handle IOMMU faults at device level
384 * @data: handler private data
385 * @faults: holds the pending faults which needs response
386 * @lock: protect pending faults list
388 struct iommu_fault_param {
389 iommu_dev_fault_handler_t handler;
391 struct list_head faults;
396 * struct dev_iommu - Collection of per-device IOMMU data
398 * @fault_param: IOMMU detected device fault reporting data
399 * @iopf_param: I/O Page Fault queue and data
400 * @fwspec: IOMMU fwspec data
401 * @iommu_dev: IOMMU device this device is linked to
402 * @priv: IOMMU Driver private data
403 * @max_pasids: number of PASIDs this device can consume
405 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
406 * struct iommu_group *iommu_group;
410 struct iommu_fault_param *fault_param;
411 struct iopf_device_param *iopf_param;
412 struct iommu_fwspec *fwspec;
413 struct iommu_device *iommu_dev;
418 int iommu_device_register(struct iommu_device *iommu,
419 const struct iommu_ops *ops,
420 struct device *hwdev);
421 void iommu_device_unregister(struct iommu_device *iommu);
422 int iommu_device_sysfs_add(struct iommu_device *iommu,
423 struct device *parent,
424 const struct attribute_group **groups,
425 const char *fmt, ...) __printf(4, 5);
426 void iommu_device_sysfs_remove(struct iommu_device *iommu);
427 int iommu_device_link(struct iommu_device *iommu, struct device *link);
428 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
429 int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
431 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
433 return (struct iommu_device *)dev_get_drvdata(dev);
436 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
438 *gather = (struct iommu_iotlb_gather) {
440 .freelist = LIST_HEAD_INIT(gather->freelist),
444 static inline const struct iommu_ops *dev_iommu_ops(struct device *dev)
447 * Assume that valid ops must be installed if iommu_probe_device()
448 * has succeeded. The device ops are essentially for internal use
449 * within the IOMMU subsystem itself, so we should be able to trust
450 * ourselves not to misuse the helper.
452 return dev->iommu->iommu_dev->ops;
455 extern int bus_iommu_probe(struct bus_type *bus);
456 extern bool iommu_present(struct bus_type *bus);
457 extern bool device_iommu_capable(struct device *dev, enum iommu_cap cap);
458 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
459 extern struct iommu_group *iommu_group_get_by_id(int id);
460 extern void iommu_domain_free(struct iommu_domain *domain);
461 extern int iommu_attach_device(struct iommu_domain *domain,
463 extern void iommu_detach_device(struct iommu_domain *domain,
465 extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
466 struct device *dev, ioasid_t pasid);
467 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
468 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
469 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
470 phys_addr_t paddr, size_t size, int prot);
471 extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
472 phys_addr_t paddr, size_t size, int prot);
473 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
475 extern size_t iommu_unmap_fast(struct iommu_domain *domain,
476 unsigned long iova, size_t size,
477 struct iommu_iotlb_gather *iotlb_gather);
478 extern ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
479 struct scatterlist *sg, unsigned int nents, int prot);
480 extern ssize_t iommu_map_sg_atomic(struct iommu_domain *domain,
481 unsigned long iova, struct scatterlist *sg,
482 unsigned int nents, int prot);
483 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
484 extern void iommu_set_fault_handler(struct iommu_domain *domain,
485 iommu_fault_handler_t handler, void *token);
487 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
488 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
489 extern void iommu_set_default_passthrough(bool cmd_line);
490 extern void iommu_set_default_translated(bool cmd_line);
491 extern bool iommu_default_passthrough(void);
492 extern struct iommu_resv_region *
493 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
494 enum iommu_resv_type type, gfp_t gfp);
495 extern int iommu_get_group_resv_regions(struct iommu_group *group,
496 struct list_head *head);
498 extern int iommu_attach_group(struct iommu_domain *domain,
499 struct iommu_group *group);
500 extern void iommu_detach_group(struct iommu_domain *domain,
501 struct iommu_group *group);
502 extern struct iommu_group *iommu_group_alloc(void);
503 extern void *iommu_group_get_iommudata(struct iommu_group *group);
504 extern void iommu_group_set_iommudata(struct iommu_group *group,
506 void (*release)(void *iommu_data));
507 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
508 extern int iommu_group_add_device(struct iommu_group *group,
510 extern void iommu_group_remove_device(struct device *dev);
511 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
512 int (*fn)(struct device *, void *));
513 extern struct iommu_group *iommu_group_get(struct device *dev);
514 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
515 extern void iommu_group_put(struct iommu_group *group);
516 extern int iommu_register_device_fault_handler(struct device *dev,
517 iommu_dev_fault_handler_t handler,
520 extern int iommu_unregister_device_fault_handler(struct device *dev);
522 extern int iommu_report_device_fault(struct device *dev,
523 struct iommu_fault_event *evt);
524 extern int iommu_page_response(struct device *dev,
525 struct iommu_page_response *msg);
527 extern int iommu_group_id(struct iommu_group *group);
528 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
530 int iommu_enable_nesting(struct iommu_domain *domain);
531 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
532 unsigned long quirks);
534 void iommu_set_dma_strict(void);
536 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
537 unsigned long iova, int flags);
539 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
541 if (domain->ops->flush_iotlb_all)
542 domain->ops->flush_iotlb_all(domain);
545 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
546 struct iommu_iotlb_gather *iotlb_gather)
548 if (domain->ops->iotlb_sync)
549 domain->ops->iotlb_sync(domain, iotlb_gather);
551 iommu_iotlb_gather_init(iotlb_gather);
555 * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
557 * @gather: TLB gather data
558 * @iova: start of page to invalidate
559 * @size: size of page to invalidate
561 * Helper for IOMMU drivers to check whether a new range and the gathered range
562 * are disjoint. For many IOMMUs, flushing the IOMMU in this case is better
563 * than merging the two, which might lead to unnecessary invalidations.
566 bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
567 unsigned long iova, size_t size)
569 unsigned long start = iova, end = start + size - 1;
571 return gather->end != 0 &&
572 (end + 1 < gather->start || start > gather->end + 1);
577 * iommu_iotlb_gather_add_range - Gather for address-based TLB invalidation
578 * @gather: TLB gather data
579 * @iova: start of page to invalidate
580 * @size: size of page to invalidate
582 * Helper for IOMMU drivers to build arbitrarily-sized invalidation commands
583 * where only the address range matters, and simply minimising intermediate
584 * syncs is preferred.
586 static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
587 unsigned long iova, size_t size)
589 unsigned long end = iova + size - 1;
591 if (gather->start > iova)
592 gather->start = iova;
593 if (gather->end < end)
598 * iommu_iotlb_gather_add_page - Gather for page-based TLB invalidation
599 * @domain: IOMMU domain to be invalidated
600 * @gather: TLB gather data
601 * @iova: start of page to invalidate
602 * @size: size of page to invalidate
604 * Helper for IOMMU drivers to build invalidation commands based on individual
605 * pages, or with page size/table level hints which cannot be gathered if they
608 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
609 struct iommu_iotlb_gather *gather,
610 unsigned long iova, size_t size)
613 * If the new page is disjoint from the current range or is mapped at
614 * a different granularity, then sync the TLB so that the gather
615 * structure can be rewritten.
617 if ((gather->pgsize && gather->pgsize != size) ||
618 iommu_iotlb_gather_is_disjoint(gather, iova, size))
619 iommu_iotlb_sync(domain, gather);
621 gather->pgsize = size;
622 iommu_iotlb_gather_add_range(gather, iova, size);
625 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
627 return gather && gather->queued;
630 /* PCI device grouping function */
631 extern struct iommu_group *pci_device_group(struct device *dev);
632 /* Generic device grouping function */
633 extern struct iommu_group *generic_device_group(struct device *dev);
634 /* FSL-MC device grouping function */
635 struct iommu_group *fsl_mc_device_group(struct device *dev);
638 * struct iommu_fwspec - per-device IOMMU instance data
639 * @ops: ops for this device's IOMMU
640 * @iommu_fwnode: firmware handle for this device's IOMMU
641 * @flags: IOMMU_FWSPEC_* flags
642 * @num_ids: number of associated device IDs
643 * @ids: IDs which this device may present to the IOMMU
645 * Note that the IDs (and any other information, really) stored in this structure should be
646 * considered private to the IOMMU device driver and are not to be used directly by IOMMU
649 struct iommu_fwspec {
650 const struct iommu_ops *ops;
651 struct fwnode_handle *iommu_fwnode;
653 unsigned int num_ids;
657 /* ATS is supported */
658 #define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
661 * struct iommu_sva - handle to a device-mm bond
665 struct iommu_domain *domain;
668 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
669 const struct iommu_ops *ops);
670 void iommu_fwspec_free(struct device *dev);
671 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
672 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
674 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
677 return dev->iommu->fwspec;
682 static inline void dev_iommu_fwspec_set(struct device *dev,
683 struct iommu_fwspec *fwspec)
685 dev->iommu->fwspec = fwspec;
688 static inline void *dev_iommu_priv_get(struct device *dev)
691 return dev->iommu->priv;
696 static inline void dev_iommu_priv_set(struct device *dev, void *priv)
698 dev->iommu->priv = priv;
701 int iommu_probe_device(struct device *dev);
702 void iommu_release_device(struct device *dev);
704 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
705 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
707 int iommu_device_use_default_domain(struct device *dev);
708 void iommu_device_unuse_default_domain(struct device *dev);
710 int iommu_group_claim_dma_owner(struct iommu_group *group, void *owner);
711 void iommu_group_release_dma_owner(struct iommu_group *group);
712 bool iommu_group_dma_owner_claimed(struct iommu_group *group);
714 int iommu_device_claim_dma_owner(struct device *dev, void *owner);
715 void iommu_device_release_dma_owner(struct device *dev);
717 struct iommu_domain *iommu_sva_domain_alloc(struct device *dev,
718 struct mm_struct *mm);
719 int iommu_attach_device_pasid(struct iommu_domain *domain,
720 struct device *dev, ioasid_t pasid);
721 void iommu_detach_device_pasid(struct iommu_domain *domain,
722 struct device *dev, ioasid_t pasid);
723 struct iommu_domain *
724 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
726 #else /* CONFIG_IOMMU_API */
729 struct iommu_group {};
730 struct iommu_fwspec {};
731 struct iommu_device {};
732 struct iommu_fault_param {};
733 struct iommu_iotlb_gather {};
735 static inline bool iommu_present(struct bus_type *bus)
740 static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
745 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
750 static inline struct iommu_group *iommu_group_get_by_id(int id)
755 static inline void iommu_domain_free(struct iommu_domain *domain)
759 static inline int iommu_attach_device(struct iommu_domain *domain,
765 static inline void iommu_detach_device(struct iommu_domain *domain,
770 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
775 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
776 phys_addr_t paddr, size_t size, int prot)
781 static inline int iommu_map_atomic(struct iommu_domain *domain,
782 unsigned long iova, phys_addr_t paddr,
783 size_t size, int prot)
788 static inline size_t iommu_unmap(struct iommu_domain *domain,
789 unsigned long iova, size_t size)
794 static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
795 unsigned long iova, int gfp_order,
796 struct iommu_iotlb_gather *iotlb_gather)
801 static inline ssize_t iommu_map_sg(struct iommu_domain *domain,
802 unsigned long iova, struct scatterlist *sg,
803 unsigned int nents, int prot)
808 static inline ssize_t iommu_map_sg_atomic(struct iommu_domain *domain,
809 unsigned long iova, struct scatterlist *sg,
810 unsigned int nents, int prot)
815 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
819 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
820 struct iommu_iotlb_gather *iotlb_gather)
824 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
829 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
830 iommu_fault_handler_t handler, void *token)
834 static inline void iommu_get_resv_regions(struct device *dev,
835 struct list_head *list)
839 static inline void iommu_put_resv_regions(struct device *dev,
840 struct list_head *list)
844 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
845 struct list_head *head)
850 static inline void iommu_set_default_passthrough(bool cmd_line)
854 static inline void iommu_set_default_translated(bool cmd_line)
858 static inline bool iommu_default_passthrough(void)
863 static inline int iommu_attach_group(struct iommu_domain *domain,
864 struct iommu_group *group)
869 static inline void iommu_detach_group(struct iommu_domain *domain,
870 struct iommu_group *group)
874 static inline struct iommu_group *iommu_group_alloc(void)
876 return ERR_PTR(-ENODEV);
879 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
884 static inline void iommu_group_set_iommudata(struct iommu_group *group,
886 void (*release)(void *iommu_data))
890 static inline int iommu_group_set_name(struct iommu_group *group,
896 static inline int iommu_group_add_device(struct iommu_group *group,
902 static inline void iommu_group_remove_device(struct device *dev)
906 static inline int iommu_group_for_each_dev(struct iommu_group *group,
908 int (*fn)(struct device *, void *))
913 static inline struct iommu_group *iommu_group_get(struct device *dev)
918 static inline void iommu_group_put(struct iommu_group *group)
923 int iommu_register_device_fault_handler(struct device *dev,
924 iommu_dev_fault_handler_t handler,
930 static inline int iommu_unregister_device_fault_handler(struct device *dev)
936 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
941 static inline int iommu_page_response(struct device *dev,
942 struct iommu_page_response *msg)
947 static inline int iommu_group_id(struct iommu_group *group)
952 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
953 unsigned long quirks)
958 static inline int iommu_device_register(struct iommu_device *iommu,
959 const struct iommu_ops *ops,
960 struct device *hwdev)
965 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
970 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
974 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
975 struct iommu_iotlb_gather *gather,
976 unsigned long iova, size_t size)
980 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
985 static inline void iommu_device_unregister(struct iommu_device *iommu)
989 static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
990 struct device *parent,
991 const struct attribute_group **groups,
992 const char *fmt, ...)
997 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
1001 static inline int iommu_device_link(struct device *dev, struct device *link)
1006 static inline void iommu_device_unlink(struct device *dev, struct device *link)
1010 static inline int iommu_fwspec_init(struct device *dev,
1011 struct fwnode_handle *iommu_fwnode,
1012 const struct iommu_ops *ops)
1017 static inline void iommu_fwspec_free(struct device *dev)
1021 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
1028 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
1034 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
1040 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1045 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1050 static inline int iommu_device_use_default_domain(struct device *dev)
1055 static inline void iommu_device_unuse_default_domain(struct device *dev)
1060 iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1065 static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1069 static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1074 static inline void iommu_device_release_dma_owner(struct device *dev)
1078 static inline int iommu_device_claim_dma_owner(struct device *dev, void *owner)
1083 static inline struct iommu_domain *
1084 iommu_sva_domain_alloc(struct device *dev, struct mm_struct *mm)
1089 static inline int iommu_attach_device_pasid(struct iommu_domain *domain,
1090 struct device *dev, ioasid_t pasid)
1095 static inline void iommu_detach_device_pasid(struct iommu_domain *domain,
1096 struct device *dev, ioasid_t pasid)
1100 static inline struct iommu_domain *
1101 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
1106 #endif /* CONFIG_IOMMU_API */
1109 * iommu_map_sgtable - Map the given buffer to the IOMMU domain
1110 * @domain: The IOMMU domain to perform the mapping
1111 * @iova: The start address to map the buffer
1112 * @sgt: The sg_table object describing the buffer
1113 * @prot: IOMMU protection bits
1115 * Creates a mapping at @iova for the buffer described by a scatterlist
1116 * stored in the given sg_table object in the provided IOMMU domain.
1118 static inline size_t iommu_map_sgtable(struct iommu_domain *domain,
1119 unsigned long iova, struct sg_table *sgt, int prot)
1121 return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot);
1124 #ifdef CONFIG_IOMMU_DEBUGFS
1125 extern struct dentry *iommu_debugfs_dir;
1126 void iommu_debugfs_setup(void);
1128 static inline void iommu_debugfs_setup(void) {}
1131 #ifdef CONFIG_IOMMU_DMA
1132 #include <linux/msi.h>
1134 /* Setup call for arch DMA mapping code */
1135 void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit);
1137 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base);
1139 int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr);
1140 void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg);
1142 #else /* CONFIG_IOMMU_DMA */
1147 static inline void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit)
1151 static inline int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
1156 static inline int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr)
1161 static inline void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1165 #endif /* CONFIG_IOMMU_DMA */
1168 * Newer generations of Tegra SoCs require devices' stream IDs to be directly programmed into
1169 * some registers. These are always paired with a Tegra SMMU or ARM SMMU, for which the contents
1170 * of the struct iommu_fwspec are known. Use this helper to formalize access to these internals.
1172 #define TEGRA_STREAM_ID_BYPASS 0x7f
1174 static inline bool tegra_dev_iommu_get_stream_id(struct device *dev, u32 *stream_id)
1176 #ifdef CONFIG_IOMMU_API
1177 struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
1179 if (fwspec && fwspec->num_ids == 1) {
1180 *stream_id = fwspec->ids[0] & 0xffff;
1188 #ifdef CONFIG_IOMMU_SVA
1189 struct iommu_sva *iommu_sva_bind_device(struct device *dev,
1190 struct mm_struct *mm);
1191 void iommu_sva_unbind_device(struct iommu_sva *handle);
1192 u32 iommu_sva_get_pasid(struct iommu_sva *handle);
1194 static inline struct iommu_sva *
1195 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm)
1200 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1204 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1206 return IOMMU_PASID_INVALID;
1208 #endif /* CONFIG_IOMMU_SVA */
1210 #endif /* __LINUX_IOMMU_H */