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