Merge branches 'apple/dart', 'arm/mediatek', 'arm/renesas', 'arm/rockchip', 'arm...
[sfrench/cifs-2.6.git] / include / linux / iommu.h
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
4  * Author: Joerg Roedel <joerg.roedel@amd.com>
5  */
6
7 #ifndef __LINUX_IOMMU_H
8 #define __LINUX_IOMMU_H
9
10 #include <linux/scatterlist.h>
11 #include <linux/device.h>
12 #include <linux/types.h>
13 #include <linux/errno.h>
14 #include <linux/err.h>
15 #include <linux/of.h>
16 #include <uapi/linux/iommu.h>
17
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 */
23 /*
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.
31  */
32 #define IOMMU_PRIV      (1 << 5)
33
34 struct iommu_ops;
35 struct iommu_group;
36 struct bus_type;
37 struct device;
38 struct iommu_domain;
39 struct iommu_domain_ops;
40 struct notifier_block;
41 struct iommu_sva;
42 struct iommu_fault_event;
43 struct iommu_dma_cookie;
44
45 /* iommu fault flags */
46 #define IOMMU_FAULT_READ        0x0
47 #define IOMMU_FAULT_WRITE       0x1
48
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 *);
52
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? */
57 };
58
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
62                                               implementation              */
63 #define __IOMMU_DOMAIN_PT       (1U << 2)  /* Domain is identity mapped   */
64 #define __IOMMU_DOMAIN_DMA_FQ   (1U << 3)  /* DMA-API uses flush queue    */
65
66 #define __IOMMU_DOMAIN_SVA      (1U << 4)  /* Shared process address space */
67
68 #define IOMMU_DOMAIN_ALLOC_FLAGS ~__IOMMU_DOMAIN_DMA_FQ
69 /*
70  * This are the possible domain-types
71  *
72  *      IOMMU_DOMAIN_BLOCKED    - All DMA is blocked, can be used to isolate
73  *                                devices
74  *      IOMMU_DOMAIN_IDENTITY   - DMA addresses are system physical addresses
75  *      IOMMU_DOMAIN_UNMANAGED  - DMA mappings managed by IOMMU-API user, used
76  *                                for VMs
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
81  *                                invalidation.
82  *      IOMMU_DOMAIN_SVA        - DMA addresses are shared process addresses
83  *                                represented by mm_struct's.
84  */
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)
94
95 struct iommu_domain {
96         unsigned type;
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,
102                                                       void *data);
103         void *fault_data;
104         union {
105                 struct {
106                         iommu_fault_handler_t handler;
107                         void *handler_token;
108                 };
109                 struct {        /* IOMMU_DOMAIN_SVA */
110                         struct mm_struct *mm;
111                         int users;
112                 };
113         };
114 };
115
116 static inline bool iommu_is_dma_domain(struct iommu_domain *domain)
117 {
118         return domain->type & __IOMMU_DOMAIN_DMA_API;
119 }
120
121 enum iommu_cap {
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 */
126         /*
127          * Per-device flag indicating if enforce_cache_coherency() will work on
128          * this device.
129          */
130         IOMMU_CAP_ENFORCE_CACHE_COHERENCY,
131         /*
132          * IOMMU driver does not issue TLB maintenance during .unmap, so can
133          * usefully support the non-strict DMA flush queue.
134          */
135         IOMMU_CAP_DEFERRED_FLUSH,
136 };
137
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 */
141         IOMMU_RESV_DIRECT,
142         /*
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)
146          */
147         IOMMU_RESV_DIRECT_RELAXABLE,
148         /* Arbitrary "never map this or give it to a device" address ranges */
149         IOMMU_RESV_RESERVED,
150         /* Hardware MSI region (untranslated) */
151         IOMMU_RESV_MSI,
152         /* Software-managed MSI translation window */
153         IOMMU_RESV_SW_MSI,
154 };
155
156 /**
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
164  */
165 struct iommu_resv_region {
166         struct list_head        list;
167         phys_addr_t             start;
168         size_t                  length;
169         int                     prot;
170         enum iommu_resv_type    type;
171         void (*free)(struct device *dev, struct iommu_resv_region *region);
172 };
173
174 struct iommu_iort_rmr_data {
175         struct iommu_resv_region rr;
176
177         /* Stream IDs associated with IORT RMR entry */
178         const u32 *sids;
179         u32 num_sids;
180 };
181
182 /**
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.
191  *
192  * Device drivers enable a feature using iommu_dev_enable_feature().
193  */
194 enum iommu_dev_features {
195         IOMMU_DEV_FEAT_SVA,
196         IOMMU_DEV_FEAT_IOPF,
197 };
198
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;
203
204 #ifdef CONFIG_IOMMU_API
205
206 /**
207  * struct iommu_iotlb_gather - Range information for a pending IOTLB flush
208  *
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
214  *
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.
221  */
222 struct iommu_iotlb_gather {
223         unsigned long           start;
224         unsigned long           end;
225         size_t                  pgsize;
226         struct list_head        freelist;
227         bool                    queued;
228 };
229
230 /**
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
259  */
260 struct iommu_ops {
261         bool (*capable)(struct device *dev, enum iommu_cap);
262
263         /* Domain allocation and freeing by the iommu driver */
264         struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
265
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);
271
272         /* Request/Free a list of reserved regions for a device */
273         void (*get_resv_regions)(struct device *dev, struct list_head *list);
274
275         int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
276         bool (*is_attach_deferred)(struct device *dev);
277
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);
281
282         int (*page_response)(struct device *dev,
283                              struct iommu_fault_event *evt,
284                              struct iommu_page_response *msg);
285
286         int (*def_domain_type)(struct device *dev);
287         void (*remove_dev_pasid)(struct device *dev, ioasid_t pasid);
288
289         const struct iommu_domain_ops *default_domain_ops;
290         unsigned long pgsize_bitmap;
291         struct module *owner;
292 };
293
294 /**
295  * struct iommu_domain_ops - domain specific operations
296  * @attach_dev: attach an iommu domain to a device
297  *  Return:
298  * * 0          - success
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
312  *             an iommu domain.
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
318  *            queue
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.
326  */
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,
330                              ioasid_t pasid);
331
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);
342
343         void (*flush_iotlb_all)(struct iommu_domain *domain);
344         void (*iotlb_sync_map)(struct iommu_domain *domain, unsigned long iova,
345                                size_t size);
346         void (*iotlb_sync)(struct iommu_domain *domain,
347                            struct iommu_iotlb_gather *iotlb_gather);
348
349         phys_addr_t (*iova_to_phys)(struct iommu_domain *domain,
350                                     dma_addr_t iova);
351
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);
356
357         void (*free)(struct iommu_domain *domain);
358 };
359
360 /**
361  * struct iommu_device - IOMMU core representation of one IOMMU hardware
362  *                       instance
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
367  */
368 struct iommu_device {
369         struct list_head list;
370         const struct iommu_ops *ops;
371         struct fwnode_handle *fwnode;
372         struct device *dev;
373         u32 max_pasids;
374 };
375
376 /**
377  * struct iommu_fault_event - Generic fault event
378  *
379  * Can represent recoverable faults such as a page requests or
380  * unrecoverable faults such as DMA or IRQ remapping faults.
381  *
382  * @fault: fault descriptor
383  * @list: pending fault event list, used for tracking responses
384  */
385 struct iommu_fault_event {
386         struct iommu_fault fault;
387         struct list_head list;
388 };
389
390 /**
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
396  */
397 struct iommu_fault_param {
398         iommu_dev_fault_handler_t handler;
399         void *data;
400         struct list_head faults;
401         struct mutex lock;
402 };
403
404 /**
405  * struct dev_iommu - Collection of per-device IOMMU data
406  *
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
416  *
417  * TODO: migrate other per device data pointers under iommu_dev_data, e.g.
418  *      struct iommu_group      *iommu_group;
419  */
420 struct dev_iommu {
421         struct mutex lock;
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;
426         void                            *priv;
427         u32                             max_pasids;
428         u32                             attach_deferred:1;
429         u32                             pci_32bit_workaround:1;
430         u32                             require_direct:1;
431 };
432
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);
445
446 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
447 {
448         return (struct iommu_device *)dev_get_drvdata(dev);
449 }
450
451 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
452 {
453         *gather = (struct iommu_iotlb_gather) {
454                 .start  = ULONG_MAX,
455                 .freelist = LIST_HEAD_INIT(gather->freelist),
456         };
457 }
458
459 static inline const struct iommu_ops *dev_iommu_ops(struct device *dev)
460 {
461         /*
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.
466          */
467         return dev->iommu->iommu_dev->ops;
468 }
469
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,
477                                struct device *dev);
478 extern void iommu_detach_device(struct iommu_domain *domain,
479                                 struct device *dev);
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,
487                           size_t size);
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);
497
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);
508
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,
516                                       void *iommu_data,
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,
520                                   struct device *dev);
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,
529                                         void *data);
530
531 extern int iommu_unregister_device_fault_handler(struct device *dev);
532
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);
537
538 extern int iommu_group_id(struct iommu_group *group);
539 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
540
541 int iommu_enable_nesting(struct iommu_domain *domain);
542 int iommu_set_pgtable_quirks(struct iommu_domain *domain,
543                 unsigned long quirks);
544
545 void iommu_set_dma_strict(void);
546
547 extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
548                               unsigned long iova, int flags);
549
550 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
551 {
552         if (domain->ops->flush_iotlb_all)
553                 domain->ops->flush_iotlb_all(domain);
554 }
555
556 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
557                                   struct iommu_iotlb_gather *iotlb_gather)
558 {
559         if (domain->ops->iotlb_sync)
560                 domain->ops->iotlb_sync(domain, iotlb_gather);
561
562         iommu_iotlb_gather_init(iotlb_gather);
563 }
564
565 /**
566  * iommu_iotlb_gather_is_disjoint - Checks whether a new range is disjoint
567  *
568  * @gather: TLB gather data
569  * @iova: start of page to invalidate
570  * @size: size of page to invalidate
571  *
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.
575  */
576 static inline
577 bool iommu_iotlb_gather_is_disjoint(struct iommu_iotlb_gather *gather,
578                                     unsigned long iova, size_t size)
579 {
580         unsigned long start = iova, end = start + size - 1;
581
582         return gather->end != 0 &&
583                 (end + 1 < gather->start || start > gather->end + 1);
584 }
585
586
587 /**
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
592  *
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.
596  */
597 static inline void iommu_iotlb_gather_add_range(struct iommu_iotlb_gather *gather,
598                                                 unsigned long iova, size_t size)
599 {
600         unsigned long end = iova + size - 1;
601
602         if (gather->start > iova)
603                 gather->start = iova;
604         if (gather->end < end)
605                 gather->end = end;
606 }
607
608 /**
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
614  *
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
617  * differ.
618  */
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)
622 {
623         /*
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.
627          */
628         if ((gather->pgsize && gather->pgsize != size) ||
629             iommu_iotlb_gather_is_disjoint(gather, iova, size))
630                 iommu_iotlb_sync(domain, gather);
631
632         gather->pgsize = size;
633         iommu_iotlb_gather_add_range(gather, iova, size);
634 }
635
636 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
637 {
638         return gather && gather->queued;
639 }
640
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);
647
648 /**
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
655  *
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
658  * consumers.
659  */
660 struct iommu_fwspec {
661         const struct iommu_ops  *ops;
662         struct fwnode_handle    *iommu_fwnode;
663         u32                     flags;
664         unsigned int            num_ids;
665         u32                     ids[];
666 };
667
668 /* ATS is supported */
669 #define IOMMU_FWSPEC_PCI_RC_ATS                 (1 << 0)
670
671 /**
672  * struct iommu_sva - handle to a device-mm bond
673  */
674 struct iommu_sva {
675         struct device                   *dev;
676         struct iommu_domain             *domain;
677 };
678
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);
684
685 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
686 {
687         if (dev->iommu)
688                 return dev->iommu->fwspec;
689         else
690                 return NULL;
691 }
692
693 static inline void dev_iommu_fwspec_set(struct device *dev,
694                                         struct iommu_fwspec *fwspec)
695 {
696         dev->iommu->fwspec = fwspec;
697 }
698
699 static inline void *dev_iommu_priv_get(struct device *dev)
700 {
701         if (dev->iommu)
702                 return dev->iommu->priv;
703         else
704                 return NULL;
705 }
706
707 static inline void dev_iommu_priv_set(struct device *dev, void *priv)
708 {
709         dev->iommu->priv = priv;
710 }
711
712 int iommu_probe_device(struct device *dev);
713
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);
716
717 int iommu_device_use_default_domain(struct device *dev);
718 void iommu_device_unuse_default_domain(struct device *dev);
719
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);
723
724 int iommu_device_claim_dma_owner(struct device *dev, void *owner);
725 void iommu_device_release_dma_owner(struct device *dev);
726
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,
735                                unsigned int type);
736 ioasid_t iommu_alloc_global_pasid(struct device *dev);
737 void iommu_free_global_pasid(ioasid_t pasid);
738 #else /* CONFIG_IOMMU_API */
739
740 struct iommu_ops {};
741 struct iommu_group {};
742 struct iommu_fwspec {};
743 struct iommu_device {};
744 struct iommu_fault_param {};
745 struct iommu_iotlb_gather {};
746
747 static inline bool iommu_present(const struct bus_type *bus)
748 {
749         return false;
750 }
751
752 static inline bool device_iommu_capable(struct device *dev, enum iommu_cap cap)
753 {
754         return false;
755 }
756
757 static inline struct iommu_domain *iommu_domain_alloc(const struct bus_type *bus)
758 {
759         return NULL;
760 }
761
762 static inline void iommu_domain_free(struct iommu_domain *domain)
763 {
764 }
765
766 static inline int iommu_attach_device(struct iommu_domain *domain,
767                                       struct device *dev)
768 {
769         return -ENODEV;
770 }
771
772 static inline void iommu_detach_device(struct iommu_domain *domain,
773                                        struct device *dev)
774 {
775 }
776
777 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
778 {
779         return NULL;
780 }
781
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)
784 {
785         return -ENODEV;
786 }
787
788 static inline size_t iommu_unmap(struct iommu_domain *domain,
789                                  unsigned long iova, size_t size)
790 {
791         return 0;
792 }
793
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)
797 {
798         return 0;
799 }
800
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)
804 {
805         return -ENODEV;
806 }
807
808 static inline void iommu_flush_iotlb_all(struct iommu_domain *domain)
809 {
810 }
811
812 static inline void iommu_iotlb_sync(struct iommu_domain *domain,
813                                   struct iommu_iotlb_gather *iotlb_gather)
814 {
815 }
816
817 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
818 {
819         return 0;
820 }
821
822 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
823                                 iommu_fault_handler_t handler, void *token)
824 {
825 }
826
827 static inline void iommu_get_resv_regions(struct device *dev,
828                                         struct list_head *list)
829 {
830 }
831
832 static inline void iommu_put_resv_regions(struct device *dev,
833                                         struct list_head *list)
834 {
835 }
836
837 static inline int iommu_get_group_resv_regions(struct iommu_group *group,
838                                                struct list_head *head)
839 {
840         return -ENODEV;
841 }
842
843 static inline void iommu_set_default_passthrough(bool cmd_line)
844 {
845 }
846
847 static inline void iommu_set_default_translated(bool cmd_line)
848 {
849 }
850
851 static inline bool iommu_default_passthrough(void)
852 {
853         return true;
854 }
855
856 static inline int iommu_attach_group(struct iommu_domain *domain,
857                                      struct iommu_group *group)
858 {
859         return -ENODEV;
860 }
861
862 static inline void iommu_detach_group(struct iommu_domain *domain,
863                                       struct iommu_group *group)
864 {
865 }
866
867 static inline struct iommu_group *iommu_group_alloc(void)
868 {
869         return ERR_PTR(-ENODEV);
870 }
871
872 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
873 {
874         return NULL;
875 }
876
877 static inline void iommu_group_set_iommudata(struct iommu_group *group,
878                                              void *iommu_data,
879                                              void (*release)(void *iommu_data))
880 {
881 }
882
883 static inline int iommu_group_set_name(struct iommu_group *group,
884                                        const char *name)
885 {
886         return -ENODEV;
887 }
888
889 static inline int iommu_group_add_device(struct iommu_group *group,
890                                          struct device *dev)
891 {
892         return -ENODEV;
893 }
894
895 static inline void iommu_group_remove_device(struct device *dev)
896 {
897 }
898
899 static inline int iommu_group_for_each_dev(struct iommu_group *group,
900                                            void *data,
901                                            int (*fn)(struct device *, void *))
902 {
903         return -ENODEV;
904 }
905
906 static inline struct iommu_group *iommu_group_get(struct device *dev)
907 {
908         return NULL;
909 }
910
911 static inline void iommu_group_put(struct iommu_group *group)
912 {
913 }
914
915 static inline
916 int iommu_register_device_fault_handler(struct device *dev,
917                                         iommu_dev_fault_handler_t handler,
918                                         void *data)
919 {
920         return -ENODEV;
921 }
922
923 static inline int iommu_unregister_device_fault_handler(struct device *dev)
924 {
925         return 0;
926 }
927
928 static inline
929 int iommu_report_device_fault(struct device *dev, struct iommu_fault_event *evt)
930 {
931         return -ENODEV;
932 }
933
934 static inline int iommu_page_response(struct device *dev,
935                                       struct iommu_page_response *msg)
936 {
937         return -ENODEV;
938 }
939
940 static inline int iommu_group_id(struct iommu_group *group)
941 {
942         return -ENODEV;
943 }
944
945 static inline int iommu_set_pgtable_quirks(struct iommu_domain *domain,
946                 unsigned long quirks)
947 {
948         return 0;
949 }
950
951 static inline int iommu_device_register(struct iommu_device *iommu,
952                                         const struct iommu_ops *ops,
953                                         struct device *hwdev)
954 {
955         return -ENODEV;
956 }
957
958 static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
959 {
960         return NULL;
961 }
962
963 static inline void iommu_iotlb_gather_init(struct iommu_iotlb_gather *gather)
964 {
965 }
966
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)
970 {
971 }
972
973 static inline bool iommu_iotlb_gather_queued(struct iommu_iotlb_gather *gather)
974 {
975         return false;
976 }
977
978 static inline void iommu_device_unregister(struct iommu_device *iommu)
979 {
980 }
981
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, ...)
986 {
987         return -ENODEV;
988 }
989
990 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
991 {
992 }
993
994 static inline int iommu_device_link(struct device *dev, struct device *link)
995 {
996         return -EINVAL;
997 }
998
999 static inline void iommu_device_unlink(struct device *dev, struct device *link)
1000 {
1001 }
1002
1003 static inline int iommu_fwspec_init(struct device *dev,
1004                                     struct fwnode_handle *iommu_fwnode,
1005                                     const struct iommu_ops *ops)
1006 {
1007         return -ENODEV;
1008 }
1009
1010 static inline void iommu_fwspec_free(struct device *dev)
1011 {
1012 }
1013
1014 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
1015                                        int num_ids)
1016 {
1017         return -ENODEV;
1018 }
1019
1020 static inline
1021 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
1022 {
1023         return NULL;
1024 }
1025
1026 static inline int
1027 iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
1028 {
1029         return -ENODEV;
1030 }
1031
1032 static inline int
1033 iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
1034 {
1035         return -ENODEV;
1036 }
1037
1038 static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
1039 {
1040         return NULL;
1041 }
1042
1043 static inline int iommu_device_use_default_domain(struct device *dev)
1044 {
1045         return 0;
1046 }
1047
1048 static inline void iommu_device_unuse_default_domain(struct device *dev)
1049 {
1050 }
1051
1052 static inline int
1053 iommu_group_claim_dma_owner(struct iommu_group *group, void *owner)
1054 {
1055         return -ENODEV;
1056 }
1057
1058 static inline void iommu_group_release_dma_owner(struct iommu_group *group)
1059 {
1060 }
1061
1062 static inline bool iommu_group_dma_owner_claimed(struct iommu_group *group)
1063 {
1064         return false;
1065 }
1066
1067 static inline void iommu_device_release_dma_owner(struct device *dev)
1068 {
1069 }
1070
1071 static inline int iommu_device_claim_dma_owner(struct device *dev, void *owner)
1072 {
1073         return -ENODEV;
1074 }
1075
1076 static inline struct iommu_domain *
1077 iommu_sva_domain_alloc(struct device *dev, struct mm_struct *mm)
1078 {
1079         return NULL;
1080 }
1081
1082 static inline int iommu_attach_device_pasid(struct iommu_domain *domain,
1083                                             struct device *dev, ioasid_t pasid)
1084 {
1085         return -ENODEV;
1086 }
1087
1088 static inline void iommu_detach_device_pasid(struct iommu_domain *domain,
1089                                              struct device *dev, ioasid_t pasid)
1090 {
1091 }
1092
1093 static inline struct iommu_domain *
1094 iommu_get_domain_for_dev_pasid(struct device *dev, ioasid_t pasid,
1095                                unsigned int type)
1096 {
1097         return NULL;
1098 }
1099
1100 static inline ioasid_t iommu_alloc_global_pasid(struct device *dev)
1101 {
1102         return IOMMU_PASID_INVALID;
1103 }
1104
1105 static inline void iommu_free_global_pasid(ioasid_t pasid) {}
1106 #endif /* CONFIG_IOMMU_API */
1107
1108 /**
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
1114  *
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.
1117  */
1118 static inline size_t iommu_map_sgtable(struct iommu_domain *domain,
1119                         unsigned long iova, struct sg_table *sgt, int prot)
1120 {
1121         return iommu_map_sg(domain, iova, sgt->sgl, sgt->orig_nents, prot,
1122                             GFP_KERNEL);
1123 }
1124
1125 #ifdef CONFIG_IOMMU_DEBUGFS
1126 extern  struct dentry *iommu_debugfs_dir;
1127 void iommu_debugfs_setup(void);
1128 #else
1129 static inline void iommu_debugfs_setup(void) {}
1130 #endif
1131
1132 #ifdef CONFIG_IOMMU_DMA
1133 #include <linux/msi.h>
1134
1135 /* Setup call for arch DMA mapping code */
1136 void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit);
1137
1138 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base);
1139
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);
1142
1143 #else /* CONFIG_IOMMU_DMA */
1144
1145 struct msi_desc;
1146 struct msi_msg;
1147
1148 static inline void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 dma_limit)
1149 {
1150 }
1151
1152 static inline int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
1153 {
1154         return -ENODEV;
1155 }
1156
1157 static inline int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr)
1158 {
1159         return 0;
1160 }
1161
1162 static inline void iommu_dma_compose_msi_msg(struct msi_desc *desc, struct msi_msg *msg)
1163 {
1164 }
1165
1166 #endif  /* CONFIG_IOMMU_DMA */
1167
1168 /*
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.
1172  */
1173 #define TEGRA_STREAM_ID_BYPASS 0x7f
1174
1175 static inline bool tegra_dev_iommu_get_stream_id(struct device *dev, u32 *stream_id)
1176 {
1177 #ifdef CONFIG_IOMMU_API
1178         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
1179
1180         if (fwspec && fwspec->num_ids == 1) {
1181                 *stream_id = fwspec->ids[0] & 0xffff;
1182                 return true;
1183         }
1184 #endif
1185
1186         return false;
1187 }
1188
1189 #ifdef CONFIG_IOMMU_SVA
1190 static inline void mm_pasid_init(struct mm_struct *mm)
1191 {
1192         mm->pasid = IOMMU_PASID_INVALID;
1193 }
1194 static inline bool mm_valid_pasid(struct mm_struct *mm)
1195 {
1196         return mm->pasid != IOMMU_PASID_INVALID;
1197 }
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);
1203 #else
1204 static inline struct iommu_sva *
1205 iommu_sva_bind_device(struct device *dev, struct mm_struct *mm)
1206 {
1207         return NULL;
1208 }
1209
1210 static inline void iommu_sva_unbind_device(struct iommu_sva *handle)
1211 {
1212 }
1213
1214 static inline u32 iommu_sva_get_pasid(struct iommu_sva *handle)
1215 {
1216         return IOMMU_PASID_INVALID;
1217 }
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 */
1222
1223 #endif /* __LINUX_IOMMU_H */