blob: 8239ece9fdfc218aff0f99b1a078608ab04b58c2 [file] [log] [blame]
Joerg Roedel4a77a6c2008-11-26 17:02:33 +01001/*
2 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
3 * Author: Joerg Roedel <joerg.roedel@amd.com>
4 *
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published
7 * by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
18
19#ifndef __LINUX_IOMMU_H
20#define __LINUX_IOMMU_H
21
Joerg Roedele8245c12017-04-26 15:34:06 +020022#include <linux/scatterlist.h>
23#include <linux/device.h>
24#include <linux/types.h>
Laura Abbott74315cc2011-06-08 17:29:11 -040025#include <linux/errno.h>
Wang YanQing9a08d372013-04-19 09:38:04 +080026#include <linux/err.h>
Will Deacond0f60a42014-08-27 16:15:59 +010027#include <linux/of.h>
Laura Abbott74315cc2011-06-08 17:29:11 -040028
Will Deaconca13bb32013-11-05 15:59:53 +000029#define IOMMU_READ (1 << 0)
30#define IOMMU_WRITE (1 << 1)
31#define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
Antonios Motakisa720b412014-10-13 14:06:16 +010032#define IOMMU_NOEXEC (1 << 3)
Robin Murphy31e68502016-04-05 12:39:30 +010033#define IOMMU_MMIO (1 << 4) /* e.g. things like MSI doorbells */
Mitchel Humpherys579b2a62017-01-06 18:58:08 +053034/*
Robin Murphyadf5e512017-01-27 12:22:54 +000035 * Where the bus hardware includes a privilege level as part of its access type
36 * markings, and certain devices are capable of issuing transactions marked as
37 * either 'supervisor' or 'user', the IOMMU_PRIV flag requests that the other
38 * given permission flags only apply to accesses at the higher privilege level,
39 * and that unprivileged transactions should have as little access as possible.
40 * This would usually imply the same permissions as kernel mappings on the CPU,
41 * if the IOMMU page table format is equivalent.
Mitchel Humpherys579b2a62017-01-06 18:58:08 +053042 */
43#define IOMMU_PRIV (1 << 5)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010044
Joerg Roedel905d66c2011-09-06 16:03:26 +020045struct iommu_ops;
Alex Williamsond72e31c2012-05-30 14:18:53 -060046struct iommu_group;
Joerg Roedelff217762011-08-26 16:48:26 +020047struct bus_type;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010048struct device;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040049struct iommu_domain;
Joerg Roedelba1eabfa2012-08-03 15:55:41 +020050struct notifier_block;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040051
52/* iommu fault flags */
53#define IOMMU_FAULT_READ 0x0
54#define IOMMU_FAULT_WRITE 0x1
55
56typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030057 struct device *, unsigned long, int, void *);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010058
Joerg Roedel0ff64f82012-01-26 19:40:53 +010059struct iommu_domain_geometry {
60 dma_addr_t aperture_start; /* First address that can be mapped */
61 dma_addr_t aperture_end; /* Last address that can be mapped */
62 bool force_aperture; /* DMA only allowed in mappable range? */
63};
64
Joerg Roedel8539c7c2015-03-26 13:43:05 +010065/* Domain feature flags */
66#define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
67#define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
68 implementation */
69#define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
70
71/*
72 * This are the possible domain-types
73 *
74 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
75 * devices
76 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
77 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
78 * for VMs
79 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
80 * This flag allows IOMMU drivers to implement
81 * certain optimizations for these domains
82 */
83#define IOMMU_DOMAIN_BLOCKED (0U)
84#define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
85#define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
86#define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
87 __IOMMU_DOMAIN_DMA_API)
88
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010089struct iommu_domain {
Joerg Roedel8539c7c2015-03-26 13:43:05 +010090 unsigned type;
Thierry Redingb22f6432014-06-27 09:03:12 +020091 const struct iommu_ops *ops;
Robin Murphyd16e0fa2016-04-07 18:42:06 +010092 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040093 iommu_fault_handler_t handler;
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030094 void *handler_token;
Joerg Roedel0ff64f82012-01-26 19:40:53 +010095 struct iommu_domain_geometry geometry;
Robin Murphy0db2e5d2015-10-01 20:13:58 +010096 void *iova_cookie;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010097};
98
Joerg Roedel1aed0742014-09-03 18:34:04 +020099enum iommu_cap {
100 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
101 transactions */
102 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
Antonios Motakisc4986642014-10-13 14:06:17 +0100103 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
Joerg Roedel1aed0742014-09-03 18:34:04 +0200104};
Sheng Yangdbb9fd82009-03-18 15:33:06 +0800105
Varun Sethi7cabf492013-07-15 10:20:56 +0530106/*
107 * Following constraints are specifc to FSL_PAMUV1:
108 * -aperture must be power of 2, and naturally aligned
109 * -number of windows must be power of 2, and address space size
110 * of each window is determined by aperture size / # of windows
111 * -the actual size of the mapped region of a window must be power
112 * of 2 starting with 4KB and physical address must be naturally
113 * aligned.
114 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
115 * The caller can invoke iommu_domain_get_attr to check if the underlying
116 * iommu implementation supports these constraints.
117 */
118
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100119enum iommu_attr {
Joerg Roedel0ff64f82012-01-26 19:40:53 +0100120 DOMAIN_ATTR_GEOMETRY,
Joerg Roedeld2e12162013-01-29 13:49:04 +0100121 DOMAIN_ATTR_PAGING,
Joerg Roedel69356712013-02-04 14:00:01 +0100122 DOMAIN_ATTR_WINDOWS,
Varun Sethi7cabf492013-07-15 10:20:56 +0530123 DOMAIN_ATTR_FSL_PAMU_STASH,
124 DOMAIN_ATTR_FSL_PAMU_ENABLE,
125 DOMAIN_ATTR_FSL_PAMUV1,
Will Deaconc02607a2014-09-29 10:05:06 -0600126 DOMAIN_ATTR_NESTING, /* two stages of translation */
Zhen Lei2da274c2018-09-20 17:10:22 +0100127 DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE,
Joerg Roedela8b8a88a2013-01-29 14:36:31 +0100128 DOMAIN_ATTR_MAX,
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100129};
130
Eric Augerd30ddca2017-01-19 20:57:48 +0000131/* These are the possible reserved region types */
Robin Murphy9d3a4de2017-03-16 17:00:16 +0000132enum iommu_resv_type {
133 /* Memory regions which must be mapped 1:1 at all times */
134 IOMMU_RESV_DIRECT,
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};
Eric Augerd30ddca2017-01-19 20:57:48 +0000142
Joerg Roedela1015c22015-05-28 18:41:33 +0200143/**
Eric Augere5b52342017-01-19 20:57:47 +0000144 * struct iommu_resv_region - descriptor for a reserved memory region
Joerg Roedela1015c22015-05-28 18:41:33 +0200145 * @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/...)
Eric Augerd30ddca2017-01-19 20:57:48 +0000149 * @type: Type of the reserved region
Joerg Roedela1015c22015-05-28 18:41:33 +0200150 */
Eric Augere5b52342017-01-19 20:57:47 +0000151struct iommu_resv_region {
Joerg Roedela1015c22015-05-28 18:41:33 +0200152 struct list_head list;
153 phys_addr_t start;
154 size_t length;
155 int prot;
Robin Murphy9d3a4de2017-03-16 17:00:16 +0000156 enum iommu_resv_type type;
Joerg Roedela1015c22015-05-28 18:41:33 +0200157};
158
Lu Baolua3a19592019-03-25 09:30:28 +0800159/* Per device IOMMU features */
160enum iommu_dev_features {
161 IOMMU_DEV_FEAT_AUX, /* Aux-domain feature */
162};
163
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200164#ifdef CONFIG_IOMMU_API
165
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200166/**
167 * struct iommu_ops - iommu ops and capabilities
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900168 * @capable: check capability
169 * @domain_alloc: allocate iommu domain
170 * @domain_free: free iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200171 * @attach_dev: attach device to an iommu domain
172 * @detach_dev: detach device from an iommu domain
173 * @map: map a physically contiguous memory region to an iommu domain
174 * @unmap: unmap a physically contiguous memory region from an iommu domain
Tom Murphydb04d4a2019-02-11 15:50:33 +0000175 * @flush_iotlb_all: Synchronously flush all hardware TLBs for this domain
tom51eb7802018-12-04 18:27:34 +0000176 * @iotlb_range_add: Add a given iova range to the flush queue for this domain
Geert Uytterhoeven2405bc12019-02-20 14:00:52 +0100177 * @iotlb_sync_map: Sync mappings created recently using @map to the hardware
tom51eb7802018-12-04 18:27:34 +0000178 * @iotlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
Joerg Roedeladd02cfd2017-08-23 15:50:04 +0200179 * queue
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200180 * @iova_to_phys: translate iova to physical address
Alex Williamsond72e31c2012-05-30 14:18:53 -0600181 * @add_device: add device to iommu grouping
182 * @remove_device: remove device from iommu grouping
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900183 * @device_group: find iommu group for a particular device
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100184 * @domain_get_attr: Query domain attributes
185 * @domain_set_attr: Change domain attributes
Eric Augere5b52342017-01-19 20:57:47 +0000186 * @get_resv_regions: Request list of reserved regions for a device
187 * @put_resv_regions: Free list of reserved regions for a device
188 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900189 * @domain_window_enable: Configure and enable a particular window for a domain
190 * @domain_window_disable: Disable a particular window for a domain
Will Deacond0f60a42014-08-27 16:15:59 +0100191 * @of_xlate: add OF master IDs to iommu grouping
Geert Uytterhoevena7055d52019-02-20 14:00:53 +0100192 * @is_attach_deferred: Check if domain attach should be deferred from iommu
193 * driver init to device driver init (default no)
Lu Baolua3a19592019-03-25 09:30:28 +0800194 * @dev_has/enable/disable_feat: per device entries to check/enable/disable
195 * iommu specific features.
196 * @dev_feat_enabled: check enabled feature
197 * @aux_attach/detach_dev: aux-domain specific attach/detach entries.
198 * @aux_get_pasid: get the pasid given an aux-domain
Robin Murphyd16e0fa2016-04-07 18:42:06 +0100199 * @pgsize_bitmap: bitmap of all possible supported page sizes
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200200 */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100201struct iommu_ops {
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200202 bool (*capable)(enum iommu_cap);
Joerg Roedel938c4702015-03-26 13:43:04 +0100203
204 /* Domain allocation and freeing by the iommu driver */
Joerg Roedel8539c7c2015-03-26 13:43:05 +0100205 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
Joerg Roedel938c4702015-03-26 13:43:04 +0100206 void (*domain_free)(struct iommu_domain *);
207
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100208 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
209 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
Joerg Roedel67651782010-01-21 16:32:27 +0100210 int (*map)(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen50090652011-11-10 11:32:25 +0200211 phys_addr_t paddr, size_t size, int prot);
212 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
213 size_t size);
Joerg Roedeladd02cfd2017-08-23 15:50:04 +0200214 void (*flush_iotlb_all)(struct iommu_domain *domain);
215 void (*iotlb_range_add)(struct iommu_domain *domain,
216 unsigned long iova, size_t size);
Dmitry Osipenko1d7ae532018-12-12 23:38:47 +0300217 void (*iotlb_sync_map)(struct iommu_domain *domain);
Joerg Roedeladd02cfd2017-08-23 15:50:04 +0200218 void (*iotlb_sync)(struct iommu_domain *domain);
Varun Sethibb5547a2013-03-29 01:23:58 +0530219 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600220 int (*add_device)(struct device *dev);
221 void (*remove_device)(struct device *dev);
Joerg Roedel46c6b2b2015-10-21 23:51:36 +0200222 struct iommu_group *(*device_group)(struct device *dev);
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100223 int (*domain_get_attr)(struct iommu_domain *domain,
224 enum iommu_attr attr, void *data);
225 int (*domain_set_attr)(struct iommu_domain *domain,
226 enum iommu_attr attr, void *data);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100227
Eric Augere5b52342017-01-19 20:57:47 +0000228 /* Request/Free a list of reserved regions for a device */
229 void (*get_resv_regions)(struct device *dev, struct list_head *list);
230 void (*put_resv_regions)(struct device *dev, struct list_head *list);
231 void (*apply_resv_region)(struct device *dev,
232 struct iommu_domain *domain,
233 struct iommu_resv_region *region);
Joerg Roedela1015c22015-05-28 18:41:33 +0200234
Joerg Roedeld7787d52013-01-29 14:26:20 +0100235 /* Window handling functions */
236 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530237 phys_addr_t paddr, u64 size, int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100238 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
239
Will Deacond0f60a42014-08-27 16:15:59 +0100240 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
Baoquan Hee01d1912017-08-09 16:33:40 +0800241 bool (*is_attach_deferred)(struct iommu_domain *domain, struct device *dev);
Will Deacond0f60a42014-08-27 16:15:59 +0100242
Lu Baolua3a19592019-03-25 09:30:28 +0800243 /* Per device IOMMU features */
244 bool (*dev_has_feat)(struct device *dev, enum iommu_dev_features f);
245 bool (*dev_feat_enabled)(struct device *dev, enum iommu_dev_features f);
246 int (*dev_enable_feat)(struct device *dev, enum iommu_dev_features f);
247 int (*dev_disable_feat)(struct device *dev, enum iommu_dev_features f);
248
249 /* Aux-domain specific attach/detach entries */
250 int (*aux_attach_dev)(struct iommu_domain *domain, struct device *dev);
251 void (*aux_detach_dev)(struct iommu_domain *domain, struct device *dev);
252 int (*aux_get_pasid)(struct iommu_domain *domain, struct device *dev);
253
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200254 unsigned long pgsize_bitmap;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100255};
256
Joerg Roedelb0119e82017-02-01 13:23:08 +0100257/**
258 * struct iommu_device - IOMMU core representation of one IOMMU hardware
259 * instance
260 * @list: Used by the iommu-core to keep a list of registered iommus
261 * @ops: iommu-ops for talking to this iommu
Joerg Roedel39ab9552017-02-01 16:56:46 +0100262 * @dev: struct device for sysfs handling
Joerg Roedelb0119e82017-02-01 13:23:08 +0100263 */
264struct iommu_device {
265 struct list_head list;
266 const struct iommu_ops *ops;
Joerg Roedelc73e1ac2017-02-07 18:18:46 +0100267 struct fwnode_handle *fwnode;
Joerg Roedel2926a2aa2017-08-14 17:19:26 +0200268 struct device *dev;
Joerg Roedelb0119e82017-02-01 13:23:08 +0100269};
270
271int iommu_device_register(struct iommu_device *iommu);
272void iommu_device_unregister(struct iommu_device *iommu);
Joerg Roedel39ab9552017-02-01 16:56:46 +0100273int iommu_device_sysfs_add(struct iommu_device *iommu,
274 struct device *parent,
275 const struct attribute_group **groups,
276 const char *fmt, ...) __printf(4, 5);
277void iommu_device_sysfs_remove(struct iommu_device *iommu);
Joerg Roedele3d10af2017-02-01 17:23:22 +0100278int iommu_device_link(struct iommu_device *iommu, struct device *link);
279void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
Joerg Roedelb0119e82017-02-01 13:23:08 +0100280
281static inline void iommu_device_set_ops(struct iommu_device *iommu,
282 const struct iommu_ops *ops)
283{
284 iommu->ops = ops;
285}
286
Joerg Roedelc73e1ac2017-02-07 18:18:46 +0100287static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
288 struct fwnode_handle *fwnode)
289{
290 iommu->fwnode = fwnode;
291}
292
Joerg Roedel2926a2aa2017-08-14 17:19:26 +0200293static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
294{
295 return (struct iommu_device *)dev_get_drvdata(dev);
296}
297
Alex Williamsond72e31c2012-05-30 14:18:53 -0600298#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
299#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
300#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
301#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
302#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
303#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
304
Thierry Redingb22f6432014-06-27 09:03:12 +0200305extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
Joerg Roedela1b60c12011-09-06 18:46:34 +0200306extern bool iommu_present(struct bus_type *bus);
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200307extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
Joerg Roedel905d66c2011-09-06 16:03:26 +0200308extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
Alexey Kardashevskiyaa16bea2013-03-25 10:23:49 +1100309extern struct iommu_group *iommu_group_get_by_id(int id);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100310extern void iommu_domain_free(struct iommu_domain *domain);
311extern int iommu_attach_device(struct iommu_domain *domain,
312 struct device *dev);
313extern void iommu_detach_device(struct iommu_domain *domain,
314 struct device *dev);
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200315extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
Robin Murphy6af588f2018-09-12 16:24:12 +0100316extern struct iommu_domain *iommu_get_dma_domain(struct device *dev);
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100317extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200318 phys_addr_t paddr, size_t size, int prot);
319extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
Joerg Roedeladd02cfd2017-08-23 15:50:04 +0200320 size_t size);
321extern size_t iommu_unmap_fast(struct iommu_domain *domain,
322 unsigned long iova, size_t size);
Christoph Hellwigd88e61f2018-07-30 09:36:26 +0200323extern size_t iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
324 struct scatterlist *sg,unsigned int nents, int prot);
Varun Sethibb5547a2013-03-29 01:23:58 +0530325extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400326extern void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300327 iommu_fault_handler_t handler, void *token);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600328
Eric Augere5b52342017-01-19 20:57:47 +0000329extern void iommu_get_resv_regions(struct device *dev, struct list_head *list);
330extern void iommu_put_resv_regions(struct device *dev, struct list_head *list);
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200331extern int iommu_request_dm_for_dev(struct device *dev);
Eric Auger2b20cbb2017-01-19 20:57:49 +0000332extern struct iommu_resv_region *
Robin Murphy9d3a4de2017-03-16 17:00:16 +0000333iommu_alloc_resv_region(phys_addr_t start, size_t length, int prot,
334 enum iommu_resv_type type);
Eric Auger6c65fb32017-01-19 20:57:51 +0000335extern int iommu_get_group_resv_regions(struct iommu_group *group,
336 struct list_head *head);
Joerg Roedela1015c22015-05-28 18:41:33 +0200337
Alex Williamsond72e31c2012-05-30 14:18:53 -0600338extern int iommu_attach_group(struct iommu_domain *domain,
339 struct iommu_group *group);
340extern void iommu_detach_group(struct iommu_domain *domain,
341 struct iommu_group *group);
342extern struct iommu_group *iommu_group_alloc(void);
343extern void *iommu_group_get_iommudata(struct iommu_group *group);
344extern void iommu_group_set_iommudata(struct iommu_group *group,
345 void *iommu_data,
346 void (*release)(void *iommu_data));
347extern int iommu_group_set_name(struct iommu_group *group, const char *name);
348extern int iommu_group_add_device(struct iommu_group *group,
349 struct device *dev);
350extern void iommu_group_remove_device(struct device *dev);
351extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
352 int (*fn)(struct device *, void *));
353extern struct iommu_group *iommu_group_get(struct device *dev);
Robin Murphy13f59a72016-11-11 17:59:21 +0000354extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600355extern void iommu_group_put(struct iommu_group *group);
356extern int iommu_group_register_notifier(struct iommu_group *group,
357 struct notifier_block *nb);
358extern int iommu_group_unregister_notifier(struct iommu_group *group,
359 struct notifier_block *nb);
360extern int iommu_group_id(struct iommu_group *group);
Alex Williamson104a1c12014-07-03 09:51:18 -0600361extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
Joerg Roedel6827ca82015-05-28 18:41:35 +0200362extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400363
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100364extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
365 void *data);
366extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
367 void *data);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400368
Joerg Roedeld7787d52013-01-29 14:26:20 +0100369/* Window handling function prototypes */
370extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530371 phys_addr_t offset, u64 size,
372 int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100373extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400374
Joerg Roedel207c6e32017-04-26 15:39:28 +0200375extern int report_iommu_fault(struct iommu_domain *domain, struct device *dev,
376 unsigned long iova, int flags);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100377
Joerg Roedeladd02cfd2017-08-23 15:50:04 +0200378static inline void iommu_flush_tlb_all(struct iommu_domain *domain)
379{
380 if (domain->ops->flush_iotlb_all)
381 domain->ops->flush_iotlb_all(domain);
382}
383
384static inline void iommu_tlb_range_add(struct iommu_domain *domain,
385 unsigned long iova, size_t size)
386{
387 if (domain->ops->iotlb_range_add)
388 domain->ops->iotlb_range_add(domain, iova, size);
389}
390
391static inline void iommu_tlb_sync(struct iommu_domain *domain)
392{
393 if (domain->ops->iotlb_sync)
394 domain->ops->iotlb_sync(domain);
395}
396
Joerg Roedel5e622922015-10-21 23:51:37 +0200397/* PCI device grouping function */
398extern struct iommu_group *pci_device_group(struct device *dev);
Joerg Roedel6eab5562015-10-21 23:51:38 +0200399/* Generic device grouping function */
400extern struct iommu_group *generic_device_group(struct device *dev);
Nipun Guptaeab03e22018-09-10 19:19:18 +0530401/* FSL-MC device grouping function */
402struct iommu_group *fsl_mc_device_group(struct device *dev);
Joerg Roedel5e622922015-10-21 23:51:37 +0200403
Robin Murphy57f98d22016-09-13 10:54:14 +0100404/**
405 * struct iommu_fwspec - per-device IOMMU instance data
406 * @ops: ops for this device's IOMMU
407 * @iommu_fwnode: firmware handle for this device's IOMMU
408 * @iommu_priv: IOMMU driver private data for this device
409 * @num_ids: number of associated device IDs
410 * @ids: IDs which this device may present to the IOMMU
411 */
412struct iommu_fwspec {
413 const struct iommu_ops *ops;
414 struct fwnode_handle *iommu_fwnode;
415 void *iommu_priv;
416 unsigned int num_ids;
417 u32 ids[1];
418};
419
420int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
421 const struct iommu_ops *ops);
422void iommu_fwspec_free(struct device *dev);
423int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
Joerg Roedel534766d2017-01-31 16:58:42 +0100424const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
Robin Murphy57f98d22016-09-13 10:54:14 +0100425
Joerg Roedelb4ef7252018-11-28 13:35:24 +0100426static inline struct iommu_fwspec *dev_iommu_fwspec_get(struct device *dev)
427{
428 return dev->iommu_fwspec;
429}
430
431static inline void dev_iommu_fwspec_set(struct device *dev,
432 struct iommu_fwspec *fwspec)
433{
434 dev->iommu_fwspec = fwspec;
435}
436
Joerg Roedelcc5aed42018-11-30 10:31:59 +0100437int iommu_probe_device(struct device *dev);
438void iommu_release_device(struct device *dev);
439
Lu Baolua3a19592019-03-25 09:30:28 +0800440bool iommu_dev_has_feature(struct device *dev, enum iommu_dev_features f);
441int iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features f);
442int iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features f);
443bool iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features f);
444int iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev);
445void iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev);
446int iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev);
447
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100448#else /* CONFIG_IOMMU_API */
449
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200450struct iommu_ops {};
Alex Williamsond72e31c2012-05-30 14:18:53 -0600451struct iommu_group {};
Robin Murphy57f98d22016-09-13 10:54:14 +0100452struct iommu_fwspec {};
Joerg Roedelb0119e82017-02-01 13:23:08 +0100453struct iommu_device {};
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100454
Joerg Roedela1b60c12011-09-06 18:46:34 +0200455static inline bool iommu_present(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100456{
457 return false;
458}
459
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200460static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
461{
462 return false;
463}
464
Joerg Roedel905d66c2011-09-06 16:03:26 +0200465static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100466{
467 return NULL;
468}
469
Alexey Kardashevskiyb62dfd22013-11-21 17:41:14 +1100470static inline struct iommu_group *iommu_group_get_by_id(int id)
471{
472 return NULL;
473}
474
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100475static inline void iommu_domain_free(struct iommu_domain *domain)
476{
477}
478
479static inline int iommu_attach_device(struct iommu_domain *domain,
480 struct device *dev)
481{
482 return -ENODEV;
483}
484
485static inline void iommu_detach_device(struct iommu_domain *domain,
486 struct device *dev)
487{
488}
489
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200490static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
491{
492 return NULL;
493}
494
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100495static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
Dmitry Osipenkoebae3e82017-07-05 20:27:53 +0300496 phys_addr_t paddr, size_t size, int prot)
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100497{
498 return -ENODEV;
499}
500
Suravee Suthikulpanitc5611a82018-02-05 05:45:53 -0500501static inline size_t iommu_unmap(struct iommu_domain *domain,
502 unsigned long iova, size_t size)
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100503{
Suravee Suthikulpanitc5611a82018-02-05 05:45:53 -0500504 return 0;
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100505}
506
Suravee Suthikulpanitc5611a82018-02-05 05:45:53 -0500507static inline size_t iommu_unmap_fast(struct iommu_domain *domain,
508 unsigned long iova, int gfp_order)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100509{
Suravee Suthikulpanitc5611a82018-02-05 05:45:53 -0500510 return 0;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100511}
512
Olav Haugan315786e2014-10-25 09:55:16 -0700513static inline size_t iommu_map_sg(struct iommu_domain *domain,
514 unsigned long iova, struct scatterlist *sg,
515 unsigned int nents, int prot)
516{
Suravee Suthikulpanitc5611a82018-02-05 05:45:53 -0500517 return 0;
Olav Haugan315786e2014-10-25 09:55:16 -0700518}
519
Joerg Roedeladd02cfd2017-08-23 15:50:04 +0200520static inline void iommu_flush_tlb_all(struct iommu_domain *domain)
521{
522}
523
524static inline void iommu_tlb_range_add(struct iommu_domain *domain,
525 unsigned long iova, size_t size)
526{
527}
528
529static inline void iommu_tlb_sync(struct iommu_domain *domain)
530{
531}
532
Joerg Roedeld7787d52013-01-29 14:26:20 +0100533static inline int iommu_domain_window_enable(struct iommu_domain *domain,
534 u32 wnd_nr, phys_addr_t paddr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530535 u64 size, int prot)
Joerg Roedeld7787d52013-01-29 14:26:20 +0100536{
537 return -ENODEV;
538}
539
540static inline void iommu_domain_window_disable(struct iommu_domain *domain,
541 u32 wnd_nr)
542{
543}
544
Varun Sethibb5547a2013-03-29 01:23:58 +0530545static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100546{
547 return 0;
548}
549
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400550static inline void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300551 iommu_fault_handler_t handler, void *token)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400552{
553}
554
Eric Augere5b52342017-01-19 20:57:47 +0000555static inline void iommu_get_resv_regions(struct device *dev,
Joerg Roedela1015c22015-05-28 18:41:33 +0200556 struct list_head *list)
557{
558}
559
Eric Augere5b52342017-01-19 20:57:47 +0000560static inline void iommu_put_resv_regions(struct device *dev,
Joerg Roedela1015c22015-05-28 18:41:33 +0200561 struct list_head *list)
562{
563}
564
Eric Auger6c65fb32017-01-19 20:57:51 +0000565static inline int iommu_get_group_resv_regions(struct iommu_group *group,
566 struct list_head *head)
567{
568 return -ENODEV;
569}
570
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200571static inline int iommu_request_dm_for_dev(struct device *dev)
572{
573 return -ENODEV;
574}
575
Alex Williamsonbef83de2012-09-24 21:23:25 -0600576static inline int iommu_attach_group(struct iommu_domain *domain,
577 struct iommu_group *group)
Alex Williamson14604322011-10-21 15:56:05 -0400578{
579 return -ENODEV;
580}
581
Alex Williamsonbef83de2012-09-24 21:23:25 -0600582static inline void iommu_detach_group(struct iommu_domain *domain,
583 struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600584{
585}
586
Alex Williamsonbef83de2012-09-24 21:23:25 -0600587static inline struct iommu_group *iommu_group_alloc(void)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600588{
589 return ERR_PTR(-ENODEV);
590}
591
Alex Williamsonbef83de2012-09-24 21:23:25 -0600592static inline void *iommu_group_get_iommudata(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600593{
594 return NULL;
595}
596
Alex Williamsonbef83de2012-09-24 21:23:25 -0600597static inline void iommu_group_set_iommudata(struct iommu_group *group,
598 void *iommu_data,
599 void (*release)(void *iommu_data))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600600{
601}
602
Alex Williamsonbef83de2012-09-24 21:23:25 -0600603static inline int iommu_group_set_name(struct iommu_group *group,
604 const char *name)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600605{
606 return -ENODEV;
607}
608
Alex Williamsonbef83de2012-09-24 21:23:25 -0600609static inline int iommu_group_add_device(struct iommu_group *group,
610 struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600611{
612 return -ENODEV;
613}
614
Alex Williamsonbef83de2012-09-24 21:23:25 -0600615static inline void iommu_group_remove_device(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600616{
617}
618
Alex Williamsonbef83de2012-09-24 21:23:25 -0600619static inline int iommu_group_for_each_dev(struct iommu_group *group,
620 void *data,
621 int (*fn)(struct device *, void *))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600622{
623 return -ENODEV;
624}
625
Alex Williamsonbef83de2012-09-24 21:23:25 -0600626static inline struct iommu_group *iommu_group_get(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600627{
628 return NULL;
629}
630
Alex Williamsonbef83de2012-09-24 21:23:25 -0600631static inline void iommu_group_put(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600632{
633}
634
Alex Williamsonbef83de2012-09-24 21:23:25 -0600635static inline int iommu_group_register_notifier(struct iommu_group *group,
636 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600637{
638 return -ENODEV;
639}
640
Alex Williamsonbef83de2012-09-24 21:23:25 -0600641static inline int iommu_group_unregister_notifier(struct iommu_group *group,
642 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600643{
644 return 0;
645}
646
Alex Williamsonbef83de2012-09-24 21:23:25 -0600647static inline int iommu_group_id(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600648{
649 return -ENODEV;
650}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100651
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100652static inline int iommu_domain_get_attr(struct iommu_domain *domain,
653 enum iommu_attr attr, void *data)
654{
655 return -EINVAL;
656}
657
658static inline int iommu_domain_set_attr(struct iommu_domain *domain,
659 enum iommu_attr attr, void *data)
660{
661 return -EINVAL;
662}
663
Joerg Roedelb0119e82017-02-01 13:23:08 +0100664static inline int iommu_device_register(struct iommu_device *iommu)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600665{
Joerg Roedelb0119e82017-02-01 13:23:08 +0100666 return -ENODEV;
Alex Williamsonc61959e2014-06-12 16:12:24 -0600667}
668
Joerg Roedelb0119e82017-02-01 13:23:08 +0100669static inline void iommu_device_set_ops(struct iommu_device *iommu,
670 const struct iommu_ops *ops)
671{
672}
673
Joerg Roedelc73e1ac2017-02-07 18:18:46 +0100674static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
675 struct fwnode_handle *fwnode)
676{
677}
678
Joerg Roedel2926a2aa2017-08-14 17:19:26 +0200679static inline struct iommu_device *dev_to_iommu_device(struct device *dev)
680{
681 return NULL;
682}
683
Joerg Roedelb0119e82017-02-01 13:23:08 +0100684static inline void iommu_device_unregister(struct iommu_device *iommu)
685{
686}
687
Joerg Roedel39ab9552017-02-01 16:56:46 +0100688static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
689 struct device *parent,
690 const struct attribute_group **groups,
691 const char *fmt, ...)
692{
693 return -ENODEV;
694}
695
696static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600697{
698}
699
Alex Williamsone09f8ea2014-07-07 14:31:36 -0600700static inline int iommu_device_link(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600701{
702 return -EINVAL;
703}
704
Alex Williamsone09f8ea2014-07-07 14:31:36 -0600705static inline void iommu_device_unlink(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600706{
707}
708
Robin Murphy57f98d22016-09-13 10:54:14 +0100709static inline int iommu_fwspec_init(struct device *dev,
710 struct fwnode_handle *iommu_fwnode,
711 const struct iommu_ops *ops)
712{
713 return -ENODEV;
714}
715
716static inline void iommu_fwspec_free(struct device *dev)
717{
718}
719
720static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
721 int num_ids)
722{
723 return -ENODEV;
724}
725
Lorenzo Pieralisie4f10ff2016-11-21 10:01:36 +0000726static inline
Joerg Roedel534766d2017-01-31 16:58:42 +0100727const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
Lorenzo Pieralisie4f10ff2016-11-21 10:01:36 +0000728{
729 return NULL;
730}
731
Lu Baolua3a19592019-03-25 09:30:28 +0800732static inline bool
733iommu_dev_has_feature(struct device *dev, enum iommu_dev_features feat)
734{
735 return false;
736}
737
738static inline bool
739iommu_dev_feature_enabled(struct device *dev, enum iommu_dev_features feat)
740{
741 return false;
742}
743
744static inline int
745iommu_dev_enable_feature(struct device *dev, enum iommu_dev_features feat)
746{
747 return -ENODEV;
748}
749
750static inline int
751iommu_dev_disable_feature(struct device *dev, enum iommu_dev_features feat)
752{
753 return -ENODEV;
754}
755
756static inline int
757iommu_aux_attach_device(struct iommu_domain *domain, struct device *dev)
758{
759 return -ENODEV;
760}
761
762static inline void
763iommu_aux_detach_device(struct iommu_domain *domain, struct device *dev)
764{
765}
766
767static inline int
768iommu_aux_get_pasid(struct iommu_domain *domain, struct device *dev)
769{
770 return -ENODEV;
771}
772
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100773#endif /* CONFIG_IOMMU_API */
774
Gary R Hookbad614b2018-06-12 16:41:21 -0500775#ifdef CONFIG_IOMMU_DEBUGFS
776extern struct dentry *iommu_debugfs_dir;
777void iommu_debugfs_setup(void);
778#else
779static inline void iommu_debugfs_setup(void) {}
780#endif
781
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100782#endif /* __LINUX_IOMMU_H */