1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
4 * Author: Joerg Roedel <joerg.roedel@amd.com>
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 <uapi/linux/iommu.h>
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 */
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.
32 #define IOMMU_PRIV (1 << 5)
39 struct iommu_domain_ops;
40 struct notifier_block;
42 struct iommu_fault_event;
43 struct iommu_dma_cookie;
45 /* iommu fault flags */
46 #define IOMMU_FAULT_READ 0x0
47 #define IOMMU_FAULT_WRITE 0x1
49 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
50 struct device *, unsigned long, int, void *);
51 typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
53 struct iommu_domain_geometry {
54 dma_addr_t aperture_start; /* First address that can be mapped */
55 dma_addr_t aperture_end; /* Last address that can be mapped */
56 bool force_aperture; /* DMA only allowed in mappable range? */
59 /* Domain feature flags */
60 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
61 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
63 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
64 #define __IOMMU_DOMAIN_DMA_FQ (1U << 3) /* DMA-API uses flush queue */
66 #define __IOMMU_DOMAIN_SVA (1U << 4) /* Shared process address space */
68 #define IOMMU_DOMAIN_ALLOC_FLAGS ~__IOMMU_DOMAIN_DMA_FQ
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_NOEXEC, /* IOMMU_NOEXEC flag */
124 IOMMU_CAP_PRE_BOOT_PROTECTION, /* Firmware says it used the IOMMU for
125 DMA protection and we should too */
127 * Per-device flag indicating if enforce_cache_coherency() will work on
130 IOMMU_CAP_ENFORCE_CACHE_COHERENCY,
132 * IOMMU driver does not issue TLB maintenance during .unmap, so can
133 * usefully support the non-strict DMA flush queue.
135 IOMMU_CAP_DEFERRED_FLUSH,
138 /* These are the possible reserved region types */
139 enum iommu_resv_type {
140 /* Memory regions which must be mapped 1:1 at all times */
143 * Memory regions which are advertised to be 1:1 but are
144 * commonly considered relaxable in some conditions,
145 * for instance in device assignment use case (USB, Graphics)
147 IOMMU_RESV_DIRECT_RELAXABLE,
148 /* Arbitrary "never map this or give it to a device" address ranges */
150 /* Hardware MSI region (untranslated) */
152 /* Software-managed MSI translation window */
157 * struct iommu_resv_region - descriptor for a reserved memory region
158 * @list: Linked list pointers
159 * @start: System physical start address of the region
160 * @length: Length of the region in bytes
161 * @prot: IOMMU Protection flags (READ/WRITE/...)
162 * @type: Type of the reserved region
163 * @free: Callback to free associated memory allocations
165 struct iommu_resv_region {
166 struct list_head list;
170 enum iommu_resv_type type;
171 void (*free)(struct device *dev, struct iommu_resv_region *region);
174 struct iommu_iort_rmr_data {
175 struct iommu_resv_region rr;
177 /* Stream IDs associated with IORT RMR entry */
183 * enum iommu_dev_features - Per device IOMMU features
184 * @IOMMU_DEV_FEAT_SVA: Shared Virtual Addresses
185 * @IOMMU_DEV_FEAT_IOPF: I/O Page Faults such as PRI or Stall. Generally
186 * enabling %IOMMU_DEV_FEAT_SVA requires
187 * %IOMMU_DEV_FEAT_IOPF, but some devices manage I/O Page
188 * Faults themselves instead of relying on the IOMMU. When
189 * supported, this feature must be enabled before and
190 * disabled after %IOMMU_DEV_FEAT_SVA.
192 * Device drivers enable a feature using iommu_dev_enable_feature().
194 enum iommu_dev_features {
199 #define IOMMU_NO_PASID (0U) /* Reserved for DMA w/o PASID */
200 #define IOMMU_FIRST_GLOBAL_PASID (1U) /*starting range for allocation */
201 #define IOMMU_PASID_INVALID (-1U)
202 typedef unsigned int ioasid_t;
204 #ifdef CONFIG_IOMMU_API
207 * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
209 * @start: IOVA representing the start of the range to be flushed
210 * @end: IOVA representing the end of the range to be flushed (inclusive)
211 * @pgsize: The interval at which to perform the flush
212 * @freelist: Removed pages to free after sync
213 * @queued: Indicates that the flush will be queued
215 * This structure is intended to be updated by multiple calls to the
216 * ->unmap() function in struct iommu_ops before eventually being passed
217 * into ->iotlb_sync(). Drivers can add pages to @freelist to be freed after
218 * ->iotlb_sync() or ->iotlb_flush_all() have cleared all cached references to
219 * them. @queued is set to indicate when ->iotlb_flush_all() will be called
220 * later instead of ->iotlb_sync(), so drivers may optimise accordingly.
222 struct iommu_iotlb_gather {
226 struct list_head freelist;
231 * struct iommu_ops - iommu ops and capabilities
232 * @capable: check capability
233 * @domain_alloc: allocate iommu domain
234 * @probe_device: Add device to iommu driver handling
235 * @release_device: Remove device from iommu driver handling
236 * @probe_finalize: Do final setup work after the device is added to an IOMMU
237 * group and attached to the groups domain
238 * @set_platform_dma_ops: Returning control back to the platform DMA ops. This op
239 * is to support old IOMMU drivers, new drivers should use
240 * default domains, and the common IOMMU DMA ops.
241 * @device_group: find iommu group for a particular device
242 * @get_resv_regions: Request list of reserved regions for a device
243 * @of_xlate: add OF master IDs to iommu grouping
244 * @is_attach_deferred: Check if domain attach should be deferred from iommu
245 * driver init to device driver init (default no)
246 * @dev_enable/disable_feat: per device entries to enable/disable
247 * iommu specific features.
248 * @page_response: handle page request response
249 * @def_domain_type: device default domain type, return value:
250 * - IOMMU_DOMAIN_IDENTITY: must use an identity domain
251 * - IOMMU_DOMAIN_DMA: must use a dma domain
252 * - 0: use the default setting
253 * @default_domain_ops: the default ops for domains
254 * @remove_dev_pasid: Remove any translation configurations of a specific
255 * pasid, so that any DMA transactions with this pasid
256 * will be blocked by the hardware.
257 * @pgsize_bitmap: bitmap of all possible supported page sizes
258 * @owner: Driver module providing these ops
261 bool (*capable)(struct device *dev, enum iommu_cap);
263 /* Domain allocation and freeing by the iommu driver */
264 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
266 struct iommu_device *(*probe_device)(struct device *dev);
267 void (*release_device)(struct device *dev);
268 void (*probe_finalize)(struct device *dev);
269 void (*set_platform_dma_ops)(struct device *dev);
270 struct iommu_group *(*device_group)(struct device *dev);
272 /* Request/Free a list of reserved regions for a device */
273 void (*get_resv_regions)(struct device *dev, struct list_head *list);
275 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
276 bool (*is_attach_deferred)(struct device *dev);
278 /* Per device IOMMU features */
279 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
280 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
282 int (*page_response)(struct device *dev,
283 struct iommu_fault_event *evt,
284 struct iommu_page_response *msg);
286 int (*def_domain_type)(struct device *dev);
287 void (*remove_dev_pasid)(struct device *dev, ioasid_t pasid);
289 const struct iommu_domain_ops *default_domain_ops;
290 unsigned long pgsize_bitmap;
291 struct module *owner;
295 * struct iommu_domain_ops - domain specific operations
296 * @attach_dev: attach an iommu domain to a device
299 * * EINVAL - can indicate that device and domain are incompatible due to
300 * some previous configuration of the domain, in which case the
301 * driver shouldn't log an error, since it is legitimate for a
302 * caller to test reuse of existing domains. Otherwise, it may
303 * still represent some other fundamental problem
304 * * ENOMEM - out of memory
305 * * ENOSPC - non-ENOMEM type of resource allocation failures
306 * * EBUSY - device is attached to a domain and cannot be changed
307 * * ENODEV - device specific errors, not able to be attached
308 * * <others> - treated as ENODEV by the caller. Use is discouraged
309 * @set_dev_pasid: set an iommu domain to a pasid of device
310 * @map: map a physically contiguous memory region to an iommu domain
311 * @map_pages: map a physically contiguous set of pages of the same size to
313 * @unmap: unmap a physically contiguous memory region from an iommu domain
314 * @unmap_pages: unmap a number of pages of the same size from an iommu domain
315 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
316 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
317 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
319 * @iova_to_phys: translate iova to physical address
320 * @enforce_cache_coherency: Prevent any kind of DMA from bypassing IOMMU_CACHE,
321 * including no-snoop TLPs on PCIe or other platform
322 * specific mechanisms.
323 * @enable_nesting: Enable nesting
324 * @set_pgtable_quirks: Set io page table quirks (IO_PGTABLE_QUIRK_*)
325 * @free: Release the domain after use.
327 struct iommu_domain_ops {
328 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
329 int (*set_dev_pasid)(struct iommu_domain *domain, struct device *dev,
332 int (*map)(struct iommu_domain *domain, unsigned long iova,
333 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
334 int (*map_pages)(struct iommu_domain *domain, unsigned long iova,
335 phys_addr_t paddr, size_t pgsize, size_t pgcount,
336 int prot, gfp_t gfp, size_t *mapped);
337 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
338 size_t size, struct iommu_iotlb_gather *iotlb_gather);
339 size_t (*unmap_pages)(struct iommu_domain *domain, unsigned long iova,
340 size_t pgsize, size_t pgcount,
341 struct iommu_iotlb_gather *iotlb_gather);
343 void (*flush_iotlb_all)(struct iommu_domain *domain);
344 void (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
346 void (*iotlb_sync)(struct iommu_domain *domain,
347 struct iommu_iotlb_gather *iotlb_gather);
349 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
352 bool (*enforce_cache_coherency)(struct iommu_domain *domain);
353 int (*enable_nesting)(struct iommu_domain *domain);
354 int (*set_pgtable_quirks)(struct iommu_domain *domain,
355 unsigned long quirks);
357 void (*free)(struct iommu_domain *domain);
361 * struct iommu_device - IOMMU core representation of one IOMMU hardware
363 * @list: Used by the iommu-core to keep a list of registered iommus
364 * @ops: iommu-ops for talking to this iommu
365 * @dev: struct device for sysfs handling
366 * @max_pasids: number of supported PASIDs
368 struct iommu_device {
369 struct list_head list;
370 const struct iommu_ops *ops;
371 struct fwnode_handle *fwnode;
377 * struct iommu_fault_event - Generic fault event
379 * Can represent recoverable faults such as a page requests or
380 * unrecoverable faults such as DMA or IRQ remapping faults.
382 * @fault: fault descriptor
383 * @list: pending fault event list, used for tracking responses
385 struct iommu_fault_event {
386 struct iommu_fault fault;
387 struct list_head list;
391 * struct iommu_fault_param - per-device IOMMU fault data
392 * @handler: Callback function to handle IOMMU faults at device level
393 * @data: handler private data
394 * @faults: holds the pending faults which needs response
395 * @lock: protect pending faults list
397 struct iommu_fault_param {
398 iommu_dev_fault_handler_t handler;
400 struct list_head faults;
405 * struct dev_iommu - Collection of per-device IOMMU data
407 * @fault_param: IOMMU detected device fault reporting data
408 * @iopf_param: I/O Page Fault queue and data
409 * @fwspec: IOMMU fwspec data
410 * @iommu_dev: IOMMU device this device is linked to
411 * @priv: IOMMU Driver private data
412 * @max_pasids: number of PASIDs this device can consume
413 * @attach_deferred: the dma domain attachment is deferred
414 * @pci_32bit_workaround: Limit DMA allocations to 32-bit IOVAs
415 * @require_direct: device requires IOMMU_RESV_DIRECT regions
417 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
418 * struct iommu_group *iommu_group;
422 struct iommu_fault_param *fault_param;
423 struct iopf_device_param *iopf_param;
424 struct iommu_fwspec *fwspec;
425 struct iommu_device *iommu_dev;
428 u32 attach_deferred:1;
429 u32 pci_32bit_workaround:1;
430 u32 require_direct:1;
433 int iommu_device_register(struct iommu_device *iommu,
434 const struct iommu_ops *ops,
435 struct device *hwdev);
436 void iommu_device_unregister(struct iommu_device *iommu);
437 int iommu_device_sysfs_add(struct iommu_device *iommu,
438 struct device *parent,
439 const struct attribute_group **groups,
440 const char *fmt, ...) __printf(4, 5);
441 void iommu_device_sysfs_remove(struct iommu_device *iommu);
442 int iommu_device_link(struct iommu_device *iommu, struct device *link);
443 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
444 int iommu_deferred_attach(struct device *dev, struct iommu_domain *domain);
446 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
448 return (struct iommu_device *)dev_get_drvdata(dev);
451 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
453 *gather = (struct iommu_iotlb_gather) {
455 .freelist = LIST_HEAD_INIT(gather->freelist),
459 static inline const struct iommu_ops *dev_iommu_ops(struct device *dev)
462 * Assume that valid ops must be installed if iommu_probe_device()
463 * has succeeded. The device ops are essentially for internal use
464 * within the IOMMU subsystem itself, so we should be able to trust
465 * ourselves not to misuse the helper.
467 return dev->iommu->iommu_dev->ops;
470 extern int bus_iommu_probe(const struct bus_type *bus);
471 extern bool iommu_present(const struct bus_type *bus);
472 extern bool device_iommu_capable(struct device *dev, enum iommu_cap cap);
473 extern bool iommu_group_has_isolated_msi(struct iommu_group *group);
474 extern struct iommu_domain *iommu_domain_alloc(const struct bus_type *bus);
475 extern void iommu_domain_free(struct iommu_domain *domain);
476 extern int iommu_attach_device(struct iommu_domain *domain,
478 extern void iommu_detach_device(struct iommu_domain *domain,
480 extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
481 struct device *dev, ioasid_t pasid);
482 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
483 extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
484 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
485 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
486 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
488 extern size_t iommu_unmap_fast(struct iommu_domain *domain,
489 unsigned long iova, size_t size,
490 struct iommu_iotlb_gather *iotlb_gather);
491 extern ssize_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
492 struct scatterlist *sg, unsigned int nents,
493 int prot, gfp_t gfp);
494 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
495 extern void iommu_set_fault_handler(struct iommu_domain *domain,
496 iommu_fault_handler_t handler, void *token);
498 extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
499 extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
500 extern void iommu_set_default_passthrough(bool cmd_line);
501 extern void iommu_set_default_translated(bool cmd_line);
502 extern bool iommu_default_passthrough(void);
503 extern struct iommu_resv_region *
504 iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
505 enum iommu_resv_type type, gfp_t gfp);
506 extern int iommu_get_group_resv_regions(struct iommu_group *group,
507 struct list_head *head);
509 extern int iommu_attach_group(struct iommu_domain *domain,
510 struct iommu_group *group);
511 extern void iommu_detach_group(struct iommu_domain *domain,
512 struct iommu_group *group);
513 extern struct iommu_group *iommu_group_alloc(void);
514 extern void *iommu_group_get_iommudata(struct iommu_group *group);
515 extern void iommu_group_set_iommudata(struct iommu_group *group,
517 void (*release)(void *iommu_data));
518 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
519 extern int iommu_group_add_device(struct iommu_group *group,
521 extern void iommu_group_remove_device(struct device *dev);
522 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
523 int (*fn)(struct device *, void *));
524 extern struct iommu_group *iommu_group_get(struct device *dev);
525 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
526 extern void iommu_group_put(struct iommu_group *group);
527 extern int iommu_register_device_fault_handler(struct device *dev,
528 iommu_dev_fault_handler_t handler,
531 extern int iommu_unregister_device_fault_handler(struct device *dev);
533 extern int iommu_report_device_fault(struct device *dev,
534 struct iommu_fault_event *evt);
535 extern int iommu_page_response(struct device *dev,
536 struct iommu_page_response *msg);
538 extern int iommu_group_id(struct iommu_group *group);
539 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
541 int iommu_enable_nesting(struct iommu_domain *domain);
542 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
543 unsigned long quirks);
545 void iommu_set_dma_strict(void);
547 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
548 unsigned long iova, int flags);
550 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
552 if (domain->ops->flush_iotlb_all)
553 domain->ops->flush_iotlb_all(domain);
556 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
557 struct iommu_iotlb_gather *iotlb_gather)
559 if (domain->ops->iotlb_sync)
560 domain->ops->iotlb_sync(domain, iotlb_gather);
562 iommu_iotlb_gather_init(iotlb_gather);
566 * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
568 * @gather: TLB gather data
569 * @iova: start of page to invalidate
570 * @size: size of page to invalidate
572 * Helper for IOMMU drivers to check whether a new range and the gathered range
573 * are disjoint. For many IOMMUs, flushing the IOMMU in this case is better
574 * than merging the two, which might lead to unnecessary invalidations.
577 bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
578 unsigned long iova, size_t size)
580 unsigned long start = iova, end = start + size - 1;
582 return gather->end != 0 &&
583 (end + 1 < gather->start || start > gather->end + 1);
588 * iommu_iotlb_gather_add_range - Gather for address-based TLB invalidation
589 * @gather: TLB gather data
590 * @iova: start of page to invalidate
591 * @size: size of page to invalidate
593 * Helper for IOMMU drivers to build arbitrarily-sized invalidation commands
594 * where only the address range matters, and simply minimising intermediate
595 * syncs is preferred.
597 static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
598 unsigned long iova, size_t size)
600 unsigned long end = iova + size - 1;
602 if (gather->start > iova)
603 gather->start = iova;
604 if (gather->end < end)
609 * iommu_iotlb_gather_add_page - Gather for page-based TLB invalidation
610 * @domain: IOMMU domain to be invalidated
611 * @gather: TLB gather data
612 * @iova: start of page to invalidate
613 * @size: size of page to invalidate
615 * Helper for IOMMU drivers to build invalidation commands based on individual
616 * pages, or with page size/table level hints which cannot be gathered if they
619 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
620 struct iommu_iotlb_gather *gather,
621 unsigned long iova, size_t size)
624 * If the new page is disjoint from the current range or is mapped at
625 * a different granularity, then sync the TLB so that the gather
626 * structure can be rewritten.
628 if ((gather->pgsize && gather->pgsize != size) ||
629 iommu_iotlb_gather_is_disjoint(gather, iova, size))
630 iommu_iotlb_sync(domain, gather);
632 gather->pgsize = size;
633 iommu_iotlb_gather_add_range(gather, iova, size);
636 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
638 return gather && gather->queued;
641 /* PCI device grouping function */
642 extern struct iommu_group *pci_device_group(struct device *dev);
643 /* Generic device grouping function */
644 extern struct iommu_group *generic_device_group(struct device *dev);
645 /* FSL-MC device grouping function */
646 struct iommu_group *fsl_mc_device_group(struct device *dev);
649 * struct iommu_fwspec - per-device IOMMU instance data
650 * @ops: ops for this device's IOMMU
651 * @iommu_fwnode: firmware handle for this device's IOMMU
652 * @flags: IOMMU_FWSPEC_* flags
653 * @num_ids: number of associated device IDs
654 * @ids: IDs which this device may present to the IOMMU
656 * Note that the IDs (and any other information, really) stored in this structure should be
657 * considered private to the IOMMU device driver and are not to be used directly by IOMMU
660 struct iommu_fwspec {
661 const struct iommu_ops *ops;
662 struct fwnode_handle *iommu_fwnode;
664 unsigned int num_ids;
668 /* ATS is supported */
669 #define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
672 * struct iommu_sva - handle to a device-mm bond
676 struct iommu_domain *domain;
679 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
680 const struct iommu_ops *ops);
681 void iommu_fwspec_free(struct device *dev);
682 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
683 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
685 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
688 return dev->iommu->fwspec;
693 static inline void dev_iommu_fwspec_set(struct device *dev,
694 struct iommu_fwspec *fwspec)
696 dev->iommu->fwspec = fwspec;
699 static inline void *dev_iommu_priv_get(struct device *dev)
702 return dev->iommu->priv;
707 static inline void dev_iommu_priv_set(struct device *dev, void *priv)
709 dev->iommu->priv = priv;
712 int iommu_probe_device(struct device *dev);
714 int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
715 int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
717 int iommu_device_use_default_domain(struct device *dev);
718 void iommu_device_unuse_default_domain(struct device *dev);
720 int iommu_group_claim_dma_owner(struct iommu_group *group, void *owner);
721 void iommu_group_release_dma_owner(struct iommu_group *group);
722 bool iommu_group_dma_owner_claimed(struct iommu_group *group);
724 int iommu_device_claim_dma_owner(struct device *dev, void *owner);
725 void iommu_device_release_dma_owner(struct device *dev);
727 struct iommu_domain *iommu_sva_domain_alloc(struct device *dev,
728 struct mm_struct *mm);
729 int iommu_attach_device_pasid(struct iommu_domain *domain,
730 struct device *dev, ioasid_t pasid);
731 void iommu_detach_device_pasid(struct iommu_domain *domain,
732 struct device *dev, ioasid_t pasid);
733 struct iommu_domain *
734 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
736 ioasid_t iommu_alloc_global_pasid(struct device *dev);
737 void iommu_free_global_pasid(ioasid_t pasid);
738 #else /* CONFIG_IOMMU_API */
741 struct iommu_group {};
742 struct iommu_fwspec {};
743 struct iommu_device {};
744 struct iommu_fault_param {};
745 struct iommu_iotlb_gather {};
747 static inline bool iommu_present(const struct bus_type *bus)
752 static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
757 static inline struct iommu_domain *iommu_domain_alloc(const struct bus_type *bus)
762 static inline void iommu_domain_free(struct iommu_domain *domain)
766 static inline int iommu_attach_device(struct iommu_domain *domain,
772 static inline void iommu_detach_device(struct iommu_domain *domain,
777 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
782 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
783 phys_addr_t paddr, size_t size, int prot, gfp_t gfp)
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, gfp_t gfp)
808 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
812 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
813 struct iommu_iotlb_gather *iotlb_gather)
817 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
822 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
823 iommu_fault_handler_t handler, void *token)
827 static inline void iommu_get_resv_regions(struct device *dev,
828 struct list_head *list)
832 static inline void iommu_put_resv_regions(struct device *dev,
833 struct list_head *list)
837 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
838 struct list_head *head)
843 static inline void iommu_set_default_passthrough(bool cmd_line)
847 static inline void iommu_set_default_translated(bool cmd_line)
851 static inline bool iommu_default_passthrough(void)
856 static inline int iommu_attach_group(struct iommu_domain *domain,
857 struct iommu_group *group)
862 static inline void iommu_detach_group(struct iommu_domain *domain,
863 struct iommu_group *group)
867 static inline struct iommu_group *iommu_group_alloc(void)
869 return ERR_PTR(-ENODEV);
872 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
877 static inline void iommu_group_set_iommudata(struct iommu_group *group,
879 void (*release)(void *iommu_data))
883 static inline int iommu_group_set_name(struct iommu_group *group,
889 static inline int iommu_group_add_device(struct iommu_group *group,
895 static inline void iommu_group_remove_device(struct device *dev)
899 static inline int iommu_group_for_each_dev(struct iommu_group *group,
901 int (*fn)(struct device *, void *))
906 static inline struct iommu_group *iommu_group_get(struct device *dev)
911 static inline void iommu_group_put(struct iommu_group *group)
916 int iommu_register_device_fault_handler(struct device *dev,
917 iommu_dev_fault_handler_t handler,
923 static inline int iommu_unregister_device_fault_handler(struct device *dev)
929 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
934 static inline int iommu_page_response(struct device *dev,
935 struct iommu_page_response *msg)
940 static inline int iommu_group_id(struct iommu_group *group)
945 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
946 unsigned long quirks)
951 static inline int iommu_device_register(struct iommu_device *iommu,
952 const struct iommu_ops *ops,
953 struct device *hwdev)
958 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
963 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
967 static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
968 struct iommu_iotlb_gather *gather,
969 unsigned long iova, size_t size)
973 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
978 static inline void iommu_device_unregister(struct iommu_device *iommu)
982 static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
983 struct device *parent,
984 const struct attribute_group **groups,
985 const char *fmt, ...)
990 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
994 static inline int iommu_device_link(struct device *dev, struct device *link)
999 static inline void iommu_device_unlink(struct device *dev, struct device *link)
1003 static inline int iommu_fwspec_init(struct device *dev,
1004 struct fwnode_handle *iommu_fwnode,
1005 const struct iommu_ops *ops)
1010 static inline void iommu_fwspec_free(struct device *dev)
1014 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
1021 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
1027 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
1033 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1038 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1043 static inline int iommu_device_use_default_domain(struct device *dev)
1048 static inline void iommu_device_unuse_default_domain(struct device *dev)
1053 iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1058 static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1062 static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1067 static inline void iommu_device_release_dma_owner(struct device *dev)
1071 static inline int iommu_device_claim_dma_owner(struct device *dev, void *owner)
1076 static inline struct iommu_domain *
1077 iommu_sva_domain_alloc(struct device *dev, struct mm_struct *mm)
1082 static inline int iommu_attach_device_pasid(struct iommu_domain *domain,
1083 struct device *dev, ioasid_t pasid)
1088 static inline void iommu_detach_device_pasid(struct iommu_domain *domain,
1089 struct device *dev, ioasid_t pasid)
1093 static inline struct iommu_domain *
1094 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
1100 static inline ioasid_t iommu_alloc_global_pasid(struct device *dev)
1102 return IOMMU_PASID_INVALID;
1105 static inline void iommu_free_global_pasid(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,
1125 #ifdef CONFIG_IOMMU_DEBUGFS
1126 extern struct dentry *iommu_debugfs_dir;
1127 void iommu_debugfs_setup(void);
1129 static inline void iommu_debugfs_setup(void) {}
1132 #ifdef CONFIG_IOMMU_DMA
1133 #include <linux/msi.h>
1135 /* Setup call for arch DMA mapping code */
1136 void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit);
1138 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base);
1140 int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr);
1141 void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg);
1143 #else /* CONFIG_IOMMU_DMA */
1148 static inline void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit)
1152 static inline int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
1157 static inline int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr)
1162 static inline void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1166 #endif /* CONFIG_IOMMU_DMA */
1169 * Newer generations of Tegra SoCs require devices' stream IDs to be directly programmed into
1170 * some registers. These are always paired with a Tegra SMMU or ARM SMMU, for which the contents
1171 * of the struct iommu_fwspec are known. Use this helper to formalize access to these internals.
1173 #define TEGRA_STREAM_ID_BYPASS 0x7f
1175 static inline bool tegra_dev_iommu_get_stream_id(struct device *dev, u32 *stream_id)
1177 #ifdef CONFIG_IOMMU_API
1178 struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
1180 if (fwspec && fwspec->num_ids == 1) {
1181 *stream_id = fwspec->ids[0] & 0xffff;
1189 #ifdef CONFIG_IOMMU_SVA
1190 static inline void mm_pasid_init(struct mm_struct *mm)
1192 mm->pasid = IOMMU_PASID_INVALID;
1194 static inline bool mm_valid_pasid(struct mm_struct *mm)
1196 return mm->pasid != IOMMU_PASID_INVALID;
1198 void mm_pasid_drop(struct mm_struct *mm);
1199 struct iommu_sva *iommu_sva_bind_device(struct device *dev,
1200 struct mm_struct *mm);
1201 void iommu_sva_unbind_device(struct iommu_sva *handle);
1202 u32 iommu_sva_get_pasid(struct iommu_sva *handle);
1204 static inline struct iommu_sva *
1205 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm)
1210 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1214 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1216 return IOMMU_PASID_INVALID;
1218 static inline void mm_pasid_init(struct mm_struct *mm) {}
1219 static inline bool mm_valid_pasid(struct mm_struct *mm) { return false; }
1220 static inline void mm_pasid_drop(struct mm_struct *mm) {}
1221 #endif /* CONFIG_IOMMU_SVA */
1223 #endif /* __LINUX_IOMMU_H */