Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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
41struct iommu_ops;
42struct iommu_group;
43struct bus_type;
44struct device;
45struct iommu_domain;
46struct notifier_block;
47struct iommu_sva;
48struct iommu_fault_event;
49
50/* iommu fault flags */
51#define IOMMU_FAULT_READ 0x0
52#define IOMMU_FAULT_WRITE 0x1
53
54typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
55 struct device *, unsigned long, int, void *);
56typedef int (*iommu_mm_exit_handler_t)(struct device *dev, struct iommu_sva *,
57 void *);
58typedef int (*iommu_dev_fault_handler_t)(struct iommu_fault *, void *);
59
60struct 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
90struct 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
100enum 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
120enum 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 */
133enum 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 */
158struct 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 */
167enum 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 */
189struct 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 */
206struct 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 * @pgsize_bitmap: bitmap of all possible supported page sizes
250 * @sva_bind_gpasid: bind guest pasid and mm
251 * @sva_unbind_gpasid: unbind guest pasid and mm
252 */
253struct iommu_ops {
254 bool (*capable)(enum iommu_cap);
255
256 /* Domain allocation and freeing by the iommu driver */
257 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
258 void (*domain_free)(struct iommu_domain *);
259
260 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
261 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
262 int (*map)(struct iommu_domain *domain, unsigned long iova,
263 phys_addr_t paddr, size_t size, int prot, gfp_t gfp);
264 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
265 size_t size, struct iommu_iotlb_gather *iotlb_gather);
266 void (*flush_iotlb_all)(struct iommu_domain *domain);
267 void (*iotlb_sync_map)(struct iommu_domain *domain);
268 void (*iotlb_sync)(struct iommu_domain *domain,
269 struct iommu_iotlb_gather *iotlb_gather);
270 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
271 int (*add_device)(struct device *dev);
272 void (*remove_device)(struct device *dev);
273 struct iommu_group *(*device_group)(struct device *dev);
274 int (*domain_get_attr)(struct iommu_domain *domain,
275 enum iommu_attr attr, void *data);
276 int (*domain_set_attr)(struct iommu_domain *domain,
277 enum iommu_attr attr, void *data);
278
279 /* Request/Free a list of reserved regions for a device */
280 void (*get_resv_regions)(struct device *dev, struct list_head *list);
281 void (*put_resv_regions)(struct device *dev, struct list_head *list);
282 void (*apply_resv_region)(struct device *dev,
283 struct iommu_domain *domain,
284 struct iommu_resv_region *region);
285
286 /* Window handling functions */
287 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
288 phys_addr_t paddr, u64 size, int prot);
289 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
290
291 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
292 bool (*is_attach_deferred)(struct iommu_domain *domain, struct device *dev);
293
294 /* Per device IOMMU features */
295 bool (*dev_has_feat)(struct device *dev, enum iommu_dev_features f);
296 bool (*dev_feat_enabled)(struct device *dev, enum iommu_dev_features f);
297 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
298 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
299
300 /* Aux-domain specific attach/detach entries */
301 int (*aux_attach_dev)(struct iommu_domain *domain, struct device *dev);
302 void (*aux_detach_dev)(struct iommu_domain *domain, struct device *dev);
303 int (*aux_get_pasid)(struct iommu_domain *domain, struct device *dev);
304
305 struct iommu_sva *(*sva_bind)(struct device *dev, struct mm_struct *mm,
306 void *drvdata);
307 void (*sva_unbind)(struct iommu_sva *handle);
308 int (*sva_get_pasid)(struct iommu_sva *handle);
309
310 int (*page_response)(struct device *dev,
311 struct iommu_fault_event *evt,
312 struct iommu_page_response *msg);
313 int (*cache_invalidate)(struct iommu_domain *domain, struct device *dev,
314 struct iommu_cache_invalidate_info *inv_info);
315 int (*sva_bind_gpasid)(struct iommu_domain *domain,
316 struct device *dev, struct iommu_gpasid_bind_data *data);
317
318 int (*sva_unbind_gpasid)(struct device *dev, int pasid);
319
320 unsigned long pgsize_bitmap;
321};
322
323/**
324 * struct iommu_device - IOMMU core representation of one IOMMU hardware
325 * instance
326 * @list: Used by the iommu-core to keep a list of registered iommus
327 * @ops: iommu-ops for talking to this iommu
328 * @dev: struct device for sysfs handling
329 */
330struct iommu_device {
331 struct list_head list;
332 const struct iommu_ops *ops;
333 struct fwnode_handle *fwnode;
334 struct device *dev;
335};
336
337/**
338 * struct iommu_fault_event - Generic fault event
339 *
340 * Can represent recoverable faults such as a page requests or
341 * unrecoverable faults such as DMA or IRQ remapping faults.
342 *
343 * @fault: fault descriptor
344 * @list: pending fault event list, used for tracking responses
345 */
346struct iommu_fault_event {
347 struct iommu_fault fault;
348 struct list_head list;
349};
350
351/**
352 * struct iommu_fault_param - per-device IOMMU fault data
353 * @handler: Callback function to handle IOMMU faults at device level
354 * @data: handler private data
355 * @faults: holds the pending faults which needs response
356 * @lock: protect pending faults list
357 */
358struct iommu_fault_param {
359 iommu_dev_fault_handler_t handler;
360 void *data;
361 struct list_head faults;
362 struct mutex lock;
363};
364
365/**
366 * struct iommu_param - collection of per-device IOMMU data
367 *
368 * @fault_param: IOMMU detected device fault reporting data
369 *
370 * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
371 * struct iommu_group *iommu_group;
372 * struct iommu_fwspec *iommu_fwspec;
373 */
374struct iommu_param {
375 struct mutex lock;
376 struct iommu_fault_param *fault_param;
377};
378
379int iommu_device_register(struct iommu_device *iommu);
380void iommu_device_unregister(struct iommu_device *iommu);
381int iommu_device_sysfs_add(struct iommu_device *iommu,
382 struct device *parent,
383 const struct attribute_group **groups,
384 const char *fmt, ...) __printf(4, 5);
385void iommu_device_sysfs_remove(struct iommu_device *iommu);
386int iommu_device_link(struct iommu_device *iommu, struct device *link);
387void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
388
389static inline void iommu_device_set_ops(struct iommu_device *iommu,
390 const struct iommu_ops *ops)
391{
392 iommu->ops = ops;
393}
394
395static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
396 struct fwnode_handle *fwnode)
397{
398 iommu->fwnode = fwnode;
399}
400
401static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
402{
403 return (struct iommu_device *)dev_get_drvdata(dev);
404}
405
406static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
407{
408 *gather = (struct iommu_iotlb_gather) {
409 .start = ULONG_MAX,
410 };
411}
412
413#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
414#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
415#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
416#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
417#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
418#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
419
420extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
421extern bool iommu_present(struct bus_type *bus);
422extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
423extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
424extern struct iommu_group *iommu_group_get_by_id(int id);
425extern void iommu_domain_free(struct iommu_domain *domain);
426extern int iommu_attach_device(struct iommu_domain *domain,
427 struct device *dev);
428extern void iommu_detach_device(struct iommu_domain *domain,
429 struct device *dev);
430extern int iommu_cache_invalidate(struct iommu_domain *domain,
431 struct device *dev,
432 struct iommu_cache_invalidate_info *inv_info);
433extern int iommu_sva_bind_gpasid(struct iommu_domain *domain,
434 struct device *dev, struct iommu_gpasid_bind_data *data);
435extern int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
436 struct device *dev, ioasid_t pasid);
437extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
438extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
439extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
440 phys_addr_t paddr, size_t size, int prot);
441extern int iommu_map_atomic(struct iommu_domain *domain, unsigned long iova,
442 phys_addr_t paddr, size_t size, int prot);
443extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
444 size_t size);
445extern size_t iommu_unmap_fast(struct iommu_domain *domain,
446 unsigned long iova, size_t size,
447 struct iommu_iotlb_gather *iotlb_gather);
448extern size_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
449 struct scatterlist *sg,unsigned int nents, int prot);
450extern size_t iommu_map_sg_atomic(struct iommu_domain *domain,
451 unsigned long iova, struct scatterlist *sg,
452 unsigned int nents, int prot);
453extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
454extern void iommu_set_fault_handler(struct iommu_domain *domain,
455 iommu_fault_handler_t handler, void *token);
456
457extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
458extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
459extern int iommu_request_dm_for_dev(struct device *dev);
460extern int iommu_request_dma_domain_for_dev(struct device *dev);
461extern void iommu_set_default_passthrough(bool cmd_line);
462extern void iommu_set_default_translated(bool cmd_line);
463extern bool iommu_default_passthrough(void);
464extern struct iommu_resv_region *
465iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
466 enum iommu_resv_type type);
467extern int iommu_get_group_resv_regions(struct iommu_group *group,
468 struct list_head *head);
469
470extern int iommu_attach_group(struct iommu_domain *domain,
471 struct iommu_group *group);
472extern void iommu_detach_group(struct iommu_domain *domain,
473 struct iommu_group *group);
474extern struct iommu_group *iommu_group_alloc(void);
475extern void *iommu_group_get_iommudata(struct iommu_group *group);
476extern void iommu_group_set_iommudata(struct iommu_group *group,
477 void *iommu_data,
478 void (*release)(void *iommu_data));
479extern int iommu_group_set_name(struct iommu_group *group, const char *name);
480extern int iommu_group_add_device(struct iommu_group *group,
481 struct device *dev);
482extern void iommu_group_remove_device(struct device *dev);
483extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
484 int (*fn)(struct device *, void *));
485extern struct iommu_group *iommu_group_get(struct device *dev);
486extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
487extern void iommu_group_put(struct iommu_group *group);
488extern int iommu_group_register_notifier(struct iommu_group *group,
489 struct notifier_block *nb);
490extern int iommu_group_unregister_notifier(struct iommu_group *group,
491 struct notifier_block *nb);
492extern int iommu_register_device_fault_handler(struct device *dev,
493 iommu_dev_fault_handler_t handler,
494 void *data);
495
496extern int iommu_unregister_device_fault_handler(struct device *dev);
497
498extern int iommu_report_device_fault(struct device *dev,
499 struct iommu_fault_event *evt);
500extern int iommu_page_response(struct device *dev,
501 struct iommu_page_response *msg);
502
503extern int iommu_group_id(struct iommu_group *group);
504extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
505extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
506
507extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
508 void *data);
509extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
510 void *data);
511
512/* Window handling function prototypes */
513extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
514 phys_addr_t offset, u64 size,
515 int prot);
516extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
517
518extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
519 unsigned long iova, int flags);
520
521static inline void iommu_flush_tlb_all(struct iommu_domain *domain)
522{
523 if (domain->ops->flush_iotlb_all)
524 domain->ops->flush_iotlb_all(domain);
525}
526
527static inline void iommu_tlb_sync(struct iommu_domain *domain,
528 struct iommu_iotlb_gather *iotlb_gather)
529{
530 if (domain->ops->iotlb_sync)
531 domain->ops->iotlb_sync(domain, iotlb_gather);
532
533 iommu_iotlb_gather_init(iotlb_gather);
534}
535
536static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
537 struct iommu_iotlb_gather *gather,
538 unsigned long iova, size_t size)
539{
540 unsigned long start = iova, end = start + size;
541
542 /*
543 * If the new page is disjoint from the current range or is mapped at
544 * a different granularity, then sync the TLB so that the gather
545 * structure can be rewritten.
546 */
547 if (gather->pgsize != size ||
548 end < gather->start || start > gather->end) {
549 if (gather->pgsize)
550 iommu_tlb_sync(domain, gather);
551 gather->pgsize = size;
552 }
553
554 if (gather->end < end)
555 gather->end = end;
556
557 if (gather->start > start)
558 gather->start = start;
559}
560
561/* PCI device grouping function */
562extern struct iommu_group *pci_device_group(struct device *dev);
563/* Generic device grouping function */
564extern struct iommu_group *generic_device_group(struct device *dev);
565/* FSL-MC device grouping function */
566struct iommu_group *fsl_mc_device_group(struct device *dev);
567
568/**
569 * struct iommu_fwspec - per-device IOMMU instance data
570 * @ops: ops for this device's IOMMU
571 * @iommu_fwnode: firmware handle for this device's IOMMU
572 * @iommu_priv: IOMMU driver private data for this device
573 * @num_ids: number of associated device IDs
574 * @ids: IDs which this device may present to the IOMMU
575 */
576struct iommu_fwspec {
577 const struct iommu_ops *ops;
578 struct fwnode_handle *iommu_fwnode;
579 void *iommu_priv;
580 u32 flags;
581 unsigned int num_ids;
582 u32 ids[1];
583};
584
585/* ATS is supported */
586#define IOMMU_FWSPEC_PCI_RC_ATS (1 << 0)
587
588/**
589 * struct iommu_sva - handle to a device-mm bond
590 */
591struct iommu_sva {
592 struct device *dev;
593 const struct iommu_sva_ops *ops;
594};
595
596int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
597 const struct iommu_ops *ops);
598void iommu_fwspec_free(struct device *dev);
599int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
600const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
601
602static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
603{
604 return dev->iommu_fwspec;
605}
606
607static inline void dev_iommu_fwspec_set(struct device *dev,
608 struct iommu_fwspec *fwspec)
609{
610 dev->iommu_fwspec = fwspec;
611}
612
613int iommu_probe_device(struct device *dev);
614void iommu_release_device(struct device *dev);
615
616bool iommu_dev_has_feature(struct device *dev, enum iommu_dev_features f);
617int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
618int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
619bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features f);
620int iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev);
621void iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev);
622int iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev);
623
624struct iommu_sva *iommu_sva_bind_device(struct device *dev,
625 struct mm_struct *mm,
626 void *drvdata);
627void iommu_sva_unbind_device(struct iommu_sva *handle);
628int iommu_sva_set_ops(struct iommu_sva *handle,
629 const struct iommu_sva_ops *ops);
630int iommu_sva_get_pasid(struct iommu_sva *handle);
631
632#else /* CONFIG_IOMMU_API */
633
634struct iommu_ops {};
635struct iommu_group {};
636struct iommu_fwspec {};
637struct iommu_device {};
638struct iommu_fault_param {};
639struct iommu_iotlb_gather {};
640
641static inline bool iommu_present(struct bus_type *bus)
642{
643 return false;
644}
645
646static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
647{
648 return false;
649}
650
651static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
652{
653 return NULL;
654}
655
656static inline struct iommu_group *iommu_group_get_by_id(int id)
657{
658 return NULL;
659}
660
661static inline void iommu_domain_free(struct iommu_domain *domain)
662{
663}
664
665static inline int iommu_attach_device(struct iommu_domain *domain,
666 struct device *dev)
667{
668 return -ENODEV;
669}
670
671static inline void iommu_detach_device(struct iommu_domain *domain,
672 struct device *dev)
673{
674}
675
676static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
677{
678 return NULL;
679}
680
681static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
682 phys_addr_t paddr, size_t size, int prot)
683{
684 return -ENODEV;
685}
686
687static inline int iommu_map_atomic(struct iommu_domain *domain,
688 unsigned long iova, phys_addr_t paddr,
689 size_t size, int prot)
690{
691 return -ENODEV;
692}
693
694static inline size_t iommu_unmap(struct iommu_domain *domain,
695 unsigned long iova, size_t size)
696{
697 return 0;
698}
699
700static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
701 unsigned long iova, int gfp_order,
702 struct iommu_iotlb_gather *iotlb_gather)
703{
704 return 0;
705}
706
707static inline size_t iommu_map_sg(struct iommu_domain *domain,
708 unsigned long iova, struct scatterlist *sg,
709 unsigned int nents, int prot)
710{
711 return 0;
712}
713
714static inline size_t iommu_map_sg_atomic(struct iommu_domain *domain,
715 unsigned long iova, struct scatterlist *sg,
716 unsigned int nents, int prot)
717{
718 return 0;
719}
720
721static inline void iommu_flush_tlb_all(struct iommu_domain *domain)
722{
723}
724
725static inline void iommu_tlb_sync(struct iommu_domain *domain,
726 struct iommu_iotlb_gather *iotlb_gather)
727{
728}
729
730static inline int iommu_domain_window_enable(struct iommu_domain *domain,
731 u32 wnd_nr, phys_addr_t paddr,
732 u64 size, int prot)
733{
734 return -ENODEV;
735}
736
737static inline void iommu_domain_window_disable(struct iommu_domain *domain,
738 u32 wnd_nr)
739{
740}
741
742static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
743{
744 return 0;
745}
746
747static inline void iommu_set_fault_handler(struct iommu_domain *domain,
748 iommu_fault_handler_t handler, void *token)
749{
750}
751
752static inline void iommu_get_resv_regions(struct device *dev,
753 struct list_head *list)
754{
755}
756
757static inline void iommu_put_resv_regions(struct device *dev,
758 struct list_head *list)
759{
760}
761
762static inline int iommu_get_group_resv_regions(struct iommu_group *group,
763 struct list_head *head)
764{
765 return -ENODEV;
766}
767
768static inline int iommu_request_dm_for_dev(struct device *dev)
769{
770 return -ENODEV;
771}
772
773static inline int iommu_request_dma_domain_for_dev(struct device *dev)
774{
775 return -ENODEV;
776}
777
778static inline void iommu_set_default_passthrough(bool cmd_line)
779{
780}
781
782static inline void iommu_set_default_translated(bool cmd_line)
783{
784}
785
786static inline bool iommu_default_passthrough(void)
787{
788 return true;
789}
790
791static inline int iommu_attach_group(struct iommu_domain *domain,
792 struct iommu_group *group)
793{
794 return -ENODEV;
795}
796
797static inline void iommu_detach_group(struct iommu_domain *domain,
798 struct iommu_group *group)
799{
800}
801
802static inline struct iommu_group *iommu_group_alloc(void)
803{
804 return ERR_PTR(-ENODEV);
805}
806
807static inline void *iommu_group_get_iommudata(struct iommu_group *group)
808{
809 return NULL;
810}
811
812static inline void iommu_group_set_iommudata(struct iommu_group *group,
813 void *iommu_data,
814 void (*release)(void *iommu_data))
815{
816}
817
818static inline int iommu_group_set_name(struct iommu_group *group,
819 const char *name)
820{
821 return -ENODEV;
822}
823
824static inline int iommu_group_add_device(struct iommu_group *group,
825 struct device *dev)
826{
827 return -ENODEV;
828}
829
830static inline void iommu_group_remove_device(struct device *dev)
831{
832}
833
834static inline int iommu_group_for_each_dev(struct iommu_group *group,
835 void *data,
836 int (*fn)(struct device *, void *))
837{
838 return -ENODEV;
839}
840
841static inline struct iommu_group *iommu_group_get(struct device *dev)
842{
843 return NULL;
844}
845
846static inline void iommu_group_put(struct iommu_group *group)
847{
848}
849
850static inline int iommu_group_register_notifier(struct iommu_group *group,
851 struct notifier_block *nb)
852{
853 return -ENODEV;
854}
855
856static inline int iommu_group_unregister_notifier(struct iommu_group *group,
857 struct notifier_block *nb)
858{
859 return 0;
860}
861
862static inline
863int iommu_register_device_fault_handler(struct device *dev,
864 iommu_dev_fault_handler_t handler,
865 void *data)
866{
867 return -ENODEV;
868}
869
870static inline int iommu_unregister_device_fault_handler(struct device *dev)
871{
872 return 0;
873}
874
875static inline
876int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
877{
878 return -ENODEV;
879}
880
881static inline int iommu_page_response(struct device *dev,
882 struct iommu_page_response *msg)
883{
884 return -ENODEV;
885}
886
887static inline int iommu_group_id(struct iommu_group *group)
888{
889 return -ENODEV;
890}
891
892static inline int iommu_domain_get_attr(struct iommu_domain *domain,
893 enum iommu_attr attr, void *data)
894{
895 return -EINVAL;
896}
897
898static inline int iommu_domain_set_attr(struct iommu_domain *domain,
899 enum iommu_attr attr, void *data)
900{
901 return -EINVAL;
902}
903
904static inline int iommu_device_register(struct iommu_device *iommu)
905{
906 return -ENODEV;
907}
908
909static inline void iommu_device_set_ops(struct iommu_device *iommu,
910 const struct iommu_ops *ops)
911{
912}
913
914static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
915 struct fwnode_handle *fwnode)
916{
917}
918
919static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
920{
921 return NULL;
922}
923
924static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
925{
926}
927
928static inline void iommu_iotlb_gather_add_page(struct iommu_domain *domain,
929 struct iommu_iotlb_gather *gather,
930 unsigned long iova, size_t size)
931{
932}
933
934static inline void iommu_device_unregister(struct iommu_device *iommu)
935{
936}
937
938static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
939 struct device *parent,
940 const struct attribute_group **groups,
941 const char *fmt, ...)
942{
943 return -ENODEV;
944}
945
946static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
947{
948}
949
950static inline int iommu_device_link(struct device *dev, struct device *link)
951{
952 return -EINVAL;
953}
954
955static inline void iommu_device_unlink(struct device *dev, struct device *link)
956{
957}
958
959static inline int iommu_fwspec_init(struct device *dev,
960 struct fwnode_handle *iommu_fwnode,
961 const struct iommu_ops *ops)
962{
963 return -ENODEV;
964}
965
966static inline void iommu_fwspec_free(struct device *dev)
967{
968}
969
970static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
971 int num_ids)
972{
973 return -ENODEV;
974}
975
976static inline
977const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
978{
979 return NULL;
980}
981
982static inline bool
983iommu_dev_has_feature(struct device *dev, enum iommu_dev_features feat)
984{
985 return false;
986}
987
988static inline bool
989iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat)
990{
991 return false;
992}
993
994static inline int
995iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
996{
997 return -ENODEV;
998}
999
1000static inline int
1001iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1002{
1003 return -ENODEV;
1004}
1005
1006static inline int
1007iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev)
1008{
1009 return -ENODEV;
1010}
1011
1012static inline void
1013iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev)
1014{
1015}
1016
1017static inline int
1018iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev)
1019{
1020 return -ENODEV;
1021}
1022
1023static inline struct iommu_sva *
1024iommu_sva_bind_device(struct device *dev, struct mm_struct *mm, void *drvdata)
1025{
1026 return NULL;
1027}
1028
1029static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1030{
1031}
1032
1033static inline int iommu_sva_set_ops(struct iommu_sva *handle,
1034 const struct iommu_sva_ops *ops)
1035{
1036 return -EINVAL;
1037}
1038
1039static inline int iommu_sva_get_pasid(struct iommu_sva *handle)
1040{
1041 return IOMMU_PASID_INVALID;
1042}
1043
1044static inline int
1045iommu_cache_invalidate(struct iommu_domain *domain,
1046 struct device *dev,
1047 struct iommu_cache_invalidate_info *inv_info)
1048{
1049 return -ENODEV;
1050}
1051static inline int iommu_sva_bind_gpasid(struct iommu_domain *domain,
1052 struct device *dev, struct iommu_gpasid_bind_data *data)
1053{
1054 return -ENODEV;
1055}
1056
1057static inline int iommu_sva_unbind_gpasid(struct iommu_domain *domain,
1058 struct device *dev, int pasid)
1059{
1060 return -ENODEV;
1061}
1062
1063#endif /* CONFIG_IOMMU_API */
1064
1065#ifdef CONFIG_IOMMU_DEBUGFS
1066extern struct dentry *iommu_debugfs_dir;
1067void iommu_debugfs_setup(void);
1068#else
1069static inline void iommu_debugfs_setup(void) {}
1070#endif
1071
1072#endif /* __LINUX_IOMMU_H */