blob: bae3cfc8b4a34299ca621ca10554d9fc9654c7a5 [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
Laura Abbott74315cc2011-06-08 17:29:11 -040022#include <linux/errno.h>
Wang YanQing9a08d372013-04-19 09:38:04 +080023#include <linux/err.h>
Will Deacond0f60a42014-08-27 16:15:59 +010024#include <linux/of.h>
Thierry Reding76582d02012-07-25 16:24:49 +020025#include <linux/types.h>
Olav Haugan315786e2014-10-25 09:55:16 -070026#include <linux/scatterlist.h>
Shuah Khan56fa4842013-09-24 15:21:20 -060027#include <trace/events/iommu.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 */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010034
Joerg Roedel905d66c2011-09-06 16:03:26 +020035struct iommu_ops;
Alex Williamsond72e31c2012-05-30 14:18:53 -060036struct iommu_group;
Joerg Roedelff217762011-08-26 16:48:26 +020037struct bus_type;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010038struct device;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040039struct iommu_domain;
Joerg Roedelba1eabfa2012-08-03 15:55:41 +020040struct notifier_block;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040041
42/* iommu fault flags */
43#define IOMMU_FAULT_READ 0x0
44#define IOMMU_FAULT_WRITE 0x1
45
46typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030047 struct device *, unsigned long, int, void *);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010048
Joerg Roedel0ff64f82012-01-26 19:40:53 +010049struct iommu_domain_geometry {
50 dma_addr_t aperture_start; /* First address that can be mapped */
51 dma_addr_t aperture_end; /* Last address that can be mapped */
52 bool force_aperture; /* DMA only allowed in mappable range? */
53};
54
Joerg Roedel8539c7c2015-03-26 13:43:05 +010055/* Domain feature flags */
56#define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
57#define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
58 implementation */
59#define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
60
61/*
62 * This are the possible domain-types
63 *
64 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
65 * devices
66 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
67 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
68 * for VMs
69 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
70 * This flag allows IOMMU drivers to implement
71 * certain optimizations for these domains
72 */
73#define IOMMU_DOMAIN_BLOCKED (0U)
74#define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
75#define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
76#define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
77 __IOMMU_DOMAIN_DMA_API)
78
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010079struct iommu_domain {
Joerg Roedel8539c7c2015-03-26 13:43:05 +010080 unsigned type;
Thierry Redingb22f6432014-06-27 09:03:12 +020081 const struct iommu_ops *ops;
Robin Murphyd16e0fa2016-04-07 18:42:06 +010082 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040083 iommu_fault_handler_t handler;
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030084 void *handler_token;
Joerg Roedel0ff64f82012-01-26 19:40:53 +010085 struct iommu_domain_geometry geometry;
Robin Murphy0db2e5d2015-10-01 20:13:58 +010086 void *iova_cookie;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010087};
88
Joerg Roedel1aed0742014-09-03 18:34:04 +020089enum iommu_cap {
90 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
91 transactions */
92 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
Antonios Motakisc4986642014-10-13 14:06:17 +010093 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
Joerg Roedel1aed0742014-09-03 18:34:04 +020094};
Sheng Yangdbb9fd82009-03-18 15:33:06 +080095
Varun Sethi7cabf492013-07-15 10:20:56 +053096/*
97 * Following constraints are specifc to FSL_PAMUV1:
98 * -aperture must be power of 2, and naturally aligned
99 * -number of windows must be power of 2, and address space size
100 * of each window is determined by aperture size / # of windows
101 * -the actual size of the mapped region of a window must be power
102 * of 2 starting with 4KB and physical address must be naturally
103 * aligned.
104 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
105 * The caller can invoke iommu_domain_get_attr to check if the underlying
106 * iommu implementation supports these constraints.
107 */
108
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100109enum iommu_attr {
Joerg Roedel0ff64f82012-01-26 19:40:53 +0100110 DOMAIN_ATTR_GEOMETRY,
Joerg Roedeld2e12162013-01-29 13:49:04 +0100111 DOMAIN_ATTR_PAGING,
Joerg Roedel69356712013-02-04 14:00:01 +0100112 DOMAIN_ATTR_WINDOWS,
Varun Sethi7cabf492013-07-15 10:20:56 +0530113 DOMAIN_ATTR_FSL_PAMU_STASH,
114 DOMAIN_ATTR_FSL_PAMU_ENABLE,
115 DOMAIN_ATTR_FSL_PAMUV1,
Will Deaconc02607a2014-09-29 10:05:06 -0600116 DOMAIN_ATTR_NESTING, /* two stages of translation */
Joerg Roedela8b8a88a2013-01-29 14:36:31 +0100117 DOMAIN_ATTR_MAX,
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100118};
119
Joerg Roedela1015c22015-05-28 18:41:33 +0200120/**
121 * struct iommu_dm_region - descriptor for a direct mapped memory region
122 * @list: Linked list pointers
123 * @start: System physical start address of the region
124 * @length: Length of the region in bytes
125 * @prot: IOMMU Protection flags (READ/WRITE/...)
126 */
127struct iommu_dm_region {
128 struct list_head list;
129 phys_addr_t start;
130 size_t length;
131 int prot;
132};
133
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200134#ifdef CONFIG_IOMMU_API
135
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200136/**
137 * struct iommu_ops - iommu ops and capabilities
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900138 * @capable: check capability
139 * @domain_alloc: allocate iommu domain
140 * @domain_free: free iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200141 * @attach_dev: attach device to an iommu domain
142 * @detach_dev: detach device from an iommu domain
143 * @map: map a physically contiguous memory region to an iommu domain
144 * @unmap: unmap a physically contiguous memory region from an iommu domain
Olav Haugan315786e2014-10-25 09:55:16 -0700145 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
146 * to an iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200147 * @iova_to_phys: translate iova to physical address
Alex Williamsond72e31c2012-05-30 14:18:53 -0600148 * @add_device: add device to iommu grouping
149 * @remove_device: remove device from iommu grouping
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900150 * @device_group: find iommu group for a particular device
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100151 * @domain_get_attr: Query domain attributes
152 * @domain_set_attr: Change domain attributes
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900153 * @get_dm_regions: Request list of direct mapping requirements for a device
154 * @put_dm_regions: Free list of direct mapping requirements for a device
Joerg Roedel33b21a62016-07-05 13:07:53 +0200155 * @apply_dm_region: Temporary helper call-back for iova reserved ranges
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900156 * @domain_window_enable: Configure and enable a particular window for a domain
157 * @domain_window_disable: Disable a particular window for a domain
158 * @domain_set_windows: Set the number of windows for a domain
159 * @domain_get_windows: Return the number of windows for a domain
Will Deacond0f60a42014-08-27 16:15:59 +0100160 * @of_xlate: add OF master IDs to iommu grouping
Robin Murphyd16e0fa2016-04-07 18:42:06 +0100161 * @pgsize_bitmap: bitmap of all possible supported page sizes
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200162 */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100163struct iommu_ops {
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200164 bool (*capable)(enum iommu_cap);
Joerg Roedel938c4702015-03-26 13:43:04 +0100165
166 /* Domain allocation and freeing by the iommu driver */
Joerg Roedel8539c7c2015-03-26 13:43:05 +0100167 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
Joerg Roedel938c4702015-03-26 13:43:04 +0100168 void (*domain_free)(struct iommu_domain *);
169
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100170 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
171 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
Joerg Roedel67651782010-01-21 16:32:27 +0100172 int (*map)(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen50090652011-11-10 11:32:25 +0200173 phys_addr_t paddr, size_t size, int prot);
174 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
175 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700176 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
177 struct scatterlist *sg, unsigned int nents, int prot);
Varun Sethibb5547a2013-03-29 01:23:58 +0530178 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600179 int (*add_device)(struct device *dev);
180 void (*remove_device)(struct device *dev);
Joerg Roedel46c6b2b2015-10-21 23:51:36 +0200181 struct iommu_group *(*device_group)(struct device *dev);
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100182 int (*domain_get_attr)(struct iommu_domain *domain,
183 enum iommu_attr attr, void *data);
184 int (*domain_set_attr)(struct iommu_domain *domain,
185 enum iommu_attr attr, void *data);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100186
Joerg Roedela1015c22015-05-28 18:41:33 +0200187 /* Request/Free a list of direct mapping requirements for a device */
188 void (*get_dm_regions)(struct device *dev, struct list_head *list);
189 void (*put_dm_regions)(struct device *dev, struct list_head *list);
Joerg Roedel33b21a62016-07-05 13:07:53 +0200190 void (*apply_dm_region)(struct device *dev, struct iommu_domain *domain,
191 struct iommu_dm_region *region);
Joerg Roedela1015c22015-05-28 18:41:33 +0200192
Joerg Roedeld7787d52013-01-29 14:26:20 +0100193 /* Window handling functions */
194 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530195 phys_addr_t paddr, u64 size, int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100196 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900197 /* Set the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100198 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900199 /* Get the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100200 u32 (*domain_get_windows)(struct iommu_domain *domain);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100201
Will Deacond0f60a42014-08-27 16:15:59 +0100202 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
Will Deacond0f60a42014-08-27 16:15:59 +0100203
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200204 unsigned long pgsize_bitmap;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100205};
206
Joerg Roedelb0119e82017-02-01 13:23:08 +0100207/**
208 * struct iommu_device - IOMMU core representation of one IOMMU hardware
209 * instance
210 * @list: Used by the iommu-core to keep a list of registered iommus
211 * @ops: iommu-ops for talking to this iommu
Joerg Roedel39ab9552017-02-01 16:56:46 +0100212 * @dev: struct device for sysfs handling
Joerg Roedelb0119e82017-02-01 13:23:08 +0100213 */
214struct iommu_device {
215 struct list_head list;
216 const struct iommu_ops *ops;
Joerg Roedel39ab9552017-02-01 16:56:46 +0100217 struct device dev;
Joerg Roedelb0119e82017-02-01 13:23:08 +0100218};
219
220int iommu_device_register(struct iommu_device *iommu);
221void iommu_device_unregister(struct iommu_device *iommu);
Joerg Roedel39ab9552017-02-01 16:56:46 +0100222int iommu_device_sysfs_add(struct iommu_device *iommu,
223 struct device *parent,
224 const struct attribute_group **groups,
225 const char *fmt, ...) __printf(4, 5);
226void iommu_device_sysfs_remove(struct iommu_device *iommu);
Joerg Roedele3d10af2017-02-01 17:23:22 +0100227int iommu_device_link(struct iommu_device *iommu, struct device *link);
228void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
Joerg Roedelb0119e82017-02-01 13:23:08 +0100229
230static inline void iommu_device_set_ops(struct iommu_device *iommu,
231 const struct iommu_ops *ops)
232{
233 iommu->ops = ops;
234}
235
Alex Williamsond72e31c2012-05-30 14:18:53 -0600236#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
237#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
238#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
239#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
240#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
241#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
242
Thierry Redingb22f6432014-06-27 09:03:12 +0200243extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
Joerg Roedela1b60c12011-09-06 18:46:34 +0200244extern bool iommu_present(struct bus_type *bus);
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200245extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
Joerg Roedel905d66c2011-09-06 16:03:26 +0200246extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
Alexey Kardashevskiyaa16bea2013-03-25 10:23:49 +1100247extern struct iommu_group *iommu_group_get_by_id(int id);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100248extern void iommu_domain_free(struct iommu_domain *domain);
249extern int iommu_attach_device(struct iommu_domain *domain,
250 struct device *dev);
251extern void iommu_detach_device(struct iommu_domain *domain,
252 struct device *dev);
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200253extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100254extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200255 phys_addr_t paddr, size_t size, int prot);
256extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
257 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700258extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
259 struct scatterlist *sg,unsigned int nents,
260 int prot);
Varun Sethibb5547a2013-03-29 01:23:58 +0530261extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400262extern void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300263 iommu_fault_handler_t handler, void *token);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600264
Joerg Roedela1015c22015-05-28 18:41:33 +0200265extern void iommu_get_dm_regions(struct device *dev, struct list_head *list);
266extern void iommu_put_dm_regions(struct device *dev, struct list_head *list);
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200267extern int iommu_request_dm_for_dev(struct device *dev);
Joerg Roedela1015c22015-05-28 18:41:33 +0200268
Alex Williamsond72e31c2012-05-30 14:18:53 -0600269extern int iommu_attach_group(struct iommu_domain *domain,
270 struct iommu_group *group);
271extern void iommu_detach_group(struct iommu_domain *domain,
272 struct iommu_group *group);
273extern struct iommu_group *iommu_group_alloc(void);
274extern void *iommu_group_get_iommudata(struct iommu_group *group);
275extern void iommu_group_set_iommudata(struct iommu_group *group,
276 void *iommu_data,
277 void (*release)(void *iommu_data));
278extern int iommu_group_set_name(struct iommu_group *group, const char *name);
279extern int iommu_group_add_device(struct iommu_group *group,
280 struct device *dev);
281extern void iommu_group_remove_device(struct device *dev);
282extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
283 int (*fn)(struct device *, void *));
284extern struct iommu_group *iommu_group_get(struct device *dev);
Robin Murphy13f59a72016-11-11 17:59:21 +0000285extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600286extern void iommu_group_put(struct iommu_group *group);
287extern int iommu_group_register_notifier(struct iommu_group *group,
288 struct notifier_block *nb);
289extern int iommu_group_unregister_notifier(struct iommu_group *group,
290 struct notifier_block *nb);
291extern int iommu_group_id(struct iommu_group *group);
Alex Williamson104a1c12014-07-03 09:51:18 -0600292extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
Joerg Roedel6827ca82015-05-28 18:41:35 +0200293extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400294
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100295extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
296 void *data);
297extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
298 void *data);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400299
Joerg Roedeld7787d52013-01-29 14:26:20 +0100300/* Window handling function prototypes */
301extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530302 phys_addr_t offset, u64 size,
303 int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100304extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400305/**
306 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
307 * @domain: the iommu domain where the fault has happened
308 * @dev: the device where the fault has happened
309 * @iova: the faulting address
310 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
311 *
312 * This function should be called by the low-level IOMMU implementations
313 * whenever IOMMU faults happen, to allow high-level users, that are
314 * interested in such events, to know about them.
315 *
316 * This event may be useful for several possible use cases:
317 * - mere logging of the event
318 * - dynamic TLB/PTE loading
319 * - if restarting of the faulting device is required
320 *
321 * Returns 0 on success and an appropriate error code otherwise (if dynamic
322 * PTE/TLB loading will one day be supported, implementations will be able
323 * to tell whether it succeeded or not according to this return value).
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400324 *
325 * Specifically, -ENOSYS is returned if a fault handler isn't installed
326 * (though fault handlers can also return -ENOSYS, in case they want to
327 * elicit the default behavior of the IOMMU drivers).
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400328 */
329static inline int report_iommu_fault(struct iommu_domain *domain,
330 struct device *dev, unsigned long iova, int flags)
331{
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400332 int ret = -ENOSYS;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400333
334 /*
335 * if upper layers showed interest and installed a fault handler,
336 * invoke it.
337 */
338 if (domain->handler)
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300339 ret = domain->handler(domain, dev, iova, flags,
340 domain->handler_token);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400341
Shuah Khan56fa4842013-09-24 15:21:20 -0600342 trace_io_page_fault(dev, iova, flags);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400343 return ret;
344}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100345
Olav Haugan315786e2014-10-25 09:55:16 -0700346static inline size_t iommu_map_sg(struct iommu_domain *domain,
347 unsigned long iova, struct scatterlist *sg,
348 unsigned int nents, int prot)
349{
350 return domain->ops->map_sg(domain, iova, sg, nents, prot);
351}
352
Joerg Roedel5e622922015-10-21 23:51:37 +0200353/* PCI device grouping function */
354extern struct iommu_group *pci_device_group(struct device *dev);
Joerg Roedel6eab5562015-10-21 23:51:38 +0200355/* Generic device grouping function */
356extern struct iommu_group *generic_device_group(struct device *dev);
Joerg Roedel5e622922015-10-21 23:51:37 +0200357
Robin Murphy57f98d22016-09-13 10:54:14 +0100358/**
359 * struct iommu_fwspec - per-device IOMMU instance data
360 * @ops: ops for this device's IOMMU
361 * @iommu_fwnode: firmware handle for this device's IOMMU
362 * @iommu_priv: IOMMU driver private data for this device
363 * @num_ids: number of associated device IDs
364 * @ids: IDs which this device may present to the IOMMU
365 */
366struct iommu_fwspec {
367 const struct iommu_ops *ops;
368 struct fwnode_handle *iommu_fwnode;
369 void *iommu_priv;
370 unsigned int num_ids;
371 u32 ids[1];
372};
373
374int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
375 const struct iommu_ops *ops);
376void iommu_fwspec_free(struct device *dev);
377int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
Lorenzo Pieralisie4f10ff2016-11-21 10:01:36 +0000378void iommu_register_instance(struct fwnode_handle *fwnode,
379 const struct iommu_ops *ops);
Joerg Roedel534766d2017-01-31 16:58:42 +0100380const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
Robin Murphy57f98d22016-09-13 10:54:14 +0100381
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100382#else /* CONFIG_IOMMU_API */
383
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200384struct iommu_ops {};
Alex Williamsond72e31c2012-05-30 14:18:53 -0600385struct iommu_group {};
Robin Murphy57f98d22016-09-13 10:54:14 +0100386struct iommu_fwspec {};
Joerg Roedelb0119e82017-02-01 13:23:08 +0100387struct iommu_device {};
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100388
Joerg Roedela1b60c12011-09-06 18:46:34 +0200389static inline bool iommu_present(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100390{
391 return false;
392}
393
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200394static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
395{
396 return false;
397}
398
Joerg Roedel905d66c2011-09-06 16:03:26 +0200399static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100400{
401 return NULL;
402}
403
Alexey Kardashevskiyb62dfd22013-11-21 17:41:14 +1100404static inline struct iommu_group *iommu_group_get_by_id(int id)
405{
406 return NULL;
407}
408
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100409static inline void iommu_domain_free(struct iommu_domain *domain)
410{
411}
412
413static inline int iommu_attach_device(struct iommu_domain *domain,
414 struct device *dev)
415{
416 return -ENODEV;
417}
418
419static inline void iommu_detach_device(struct iommu_domain *domain,
420 struct device *dev)
421{
422}
423
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200424static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
425{
426 return NULL;
427}
428
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100429static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
430 phys_addr_t paddr, int gfp_order, int prot)
431{
432 return -ENODEV;
433}
434
435static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
436 int gfp_order)
437{
438 return -ENODEV;
439}
440
Olav Haugan315786e2014-10-25 09:55:16 -0700441static inline size_t iommu_map_sg(struct iommu_domain *domain,
442 unsigned long iova, struct scatterlist *sg,
443 unsigned int nents, int prot)
444{
445 return -ENODEV;
446}
447
Joerg Roedeld7787d52013-01-29 14:26:20 +0100448static inline int iommu_domain_window_enable(struct iommu_domain *domain,
449 u32 wnd_nr, phys_addr_t paddr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530450 u64 size, int prot)
Joerg Roedeld7787d52013-01-29 14:26:20 +0100451{
452 return -ENODEV;
453}
454
455static inline void iommu_domain_window_disable(struct iommu_domain *domain,
456 u32 wnd_nr)
457{
458}
459
Varun Sethibb5547a2013-03-29 01:23:58 +0530460static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100461{
462 return 0;
463}
464
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400465static inline void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300466 iommu_fault_handler_t handler, void *token)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400467{
468}
469
Joerg Roedela1015c22015-05-28 18:41:33 +0200470static inline void iommu_get_dm_regions(struct device *dev,
471 struct list_head *list)
472{
473}
474
475static inline void iommu_put_dm_regions(struct device *dev,
476 struct list_head *list)
477{
478}
479
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200480static inline int iommu_request_dm_for_dev(struct device *dev)
481{
482 return -ENODEV;
483}
484
Alex Williamsonbef83de2012-09-24 21:23:25 -0600485static inline int iommu_attach_group(struct iommu_domain *domain,
486 struct iommu_group *group)
Alex Williamson14604322011-10-21 15:56:05 -0400487{
488 return -ENODEV;
489}
490
Alex Williamsonbef83de2012-09-24 21:23:25 -0600491static inline void iommu_detach_group(struct iommu_domain *domain,
492 struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600493{
494}
495
Alex Williamsonbef83de2012-09-24 21:23:25 -0600496static inline struct iommu_group *iommu_group_alloc(void)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600497{
498 return ERR_PTR(-ENODEV);
499}
500
Alex Williamsonbef83de2012-09-24 21:23:25 -0600501static inline void *iommu_group_get_iommudata(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600502{
503 return NULL;
504}
505
Alex Williamsonbef83de2012-09-24 21:23:25 -0600506static inline void iommu_group_set_iommudata(struct iommu_group *group,
507 void *iommu_data,
508 void (*release)(void *iommu_data))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600509{
510}
511
Alex Williamsonbef83de2012-09-24 21:23:25 -0600512static inline int iommu_group_set_name(struct iommu_group *group,
513 const char *name)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600514{
515 return -ENODEV;
516}
517
Alex Williamsonbef83de2012-09-24 21:23:25 -0600518static inline int iommu_group_add_device(struct iommu_group *group,
519 struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600520{
521 return -ENODEV;
522}
523
Alex Williamsonbef83de2012-09-24 21:23:25 -0600524static inline void iommu_group_remove_device(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600525{
526}
527
Alex Williamsonbef83de2012-09-24 21:23:25 -0600528static inline int iommu_group_for_each_dev(struct iommu_group *group,
529 void *data,
530 int (*fn)(struct device *, void *))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600531{
532 return -ENODEV;
533}
534
Alex Williamsonbef83de2012-09-24 21:23:25 -0600535static inline struct iommu_group *iommu_group_get(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600536{
537 return NULL;
538}
539
Alex Williamsonbef83de2012-09-24 21:23:25 -0600540static inline void iommu_group_put(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600541{
542}
543
Alex Williamsonbef83de2012-09-24 21:23:25 -0600544static inline int iommu_group_register_notifier(struct iommu_group *group,
545 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600546{
547 return -ENODEV;
548}
549
Alex Williamsonbef83de2012-09-24 21:23:25 -0600550static inline int iommu_group_unregister_notifier(struct iommu_group *group,
551 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600552{
553 return 0;
554}
555
Alex Williamsonbef83de2012-09-24 21:23:25 -0600556static inline int iommu_group_id(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600557{
558 return -ENODEV;
559}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100560
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100561static inline int iommu_domain_get_attr(struct iommu_domain *domain,
562 enum iommu_attr attr, void *data)
563{
564 return -EINVAL;
565}
566
567static inline int iommu_domain_set_attr(struct iommu_domain *domain,
568 enum iommu_attr attr, void *data)
569{
570 return -EINVAL;
571}
572
Joerg Roedelb0119e82017-02-01 13:23:08 +0100573static inline int iommu_device_register(struct iommu_device *iommu)
574{
575 return -ENODEV;
576}
577
578static inline void iommu_device_set_ops(struct iommu_device *iommu,
579 const struct iommu_ops *ops)
580{
581}
582
583static inline void iommu_device_unregister(struct iommu_device *iommu)
584{
585}
586
Joerg Roedel39ab9552017-02-01 16:56:46 +0100587static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
588 struct device *parent,
589 const struct attribute_group **groups,
590 const char *fmt, ...)
591{
592 return -ENODEV;
593}
594
595static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
596{
597}
598
Alex Williamsone09f8ea2014-07-07 14:31:36 -0600599static inline int iommu_device_link(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600600{
601 return -EINVAL;
602}
603
Alex Williamsone09f8ea2014-07-07 14:31:36 -0600604static inline void iommu_device_unlink(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600605{
606}
607
Robin Murphy57f98d22016-09-13 10:54:14 +0100608static inline int iommu_fwspec_init(struct device *dev,
609 struct fwnode_handle *iommu_fwnode,
610 const struct iommu_ops *ops)
611{
612 return -ENODEV;
613}
614
615static inline void iommu_fwspec_free(struct device *dev)
616{
617}
618
619static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
620 int num_ids)
621{
622 return -ENODEV;
623}
624
Lorenzo Pieralisie4f10ff2016-11-21 10:01:36 +0000625static inline void iommu_register_instance(struct fwnode_handle *fwnode,
626 const struct iommu_ops *ops)
627{
628}
629
630static inline
Joerg Roedel534766d2017-01-31 16:58:42 +0100631const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
Lorenzo Pieralisie4f10ff2016-11-21 10:01:36 +0000632{
633 return NULL;
634}
635
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100636#endif /* CONFIG_IOMMU_API */
637
638#endif /* __LINUX_IOMMU_H */