blob: 99eb77ae61eb1a24058c5f45e49af4adca6fc929 [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 */
Mitchel Humpheryse038dfd2015-04-01 19:03:31 -070034#define IOMMU_PRIV (1 << 5)
Patrick Dalya0c45d42016-11-03 13:28:24 -070035/* Use upstream device's bus attribute */
36#define IOMMU_USE_UPSTREAM_HINT (1 << 6)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010037
Joerg Roedel905d66c2011-09-06 16:03:26 +020038struct iommu_ops;
Alex Williamsond72e31c2012-05-30 14:18:53 -060039struct iommu_group;
Joerg Roedelff217762011-08-26 16:48:26 +020040struct bus_type;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010041struct device;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040042struct iommu_domain;
Joerg Roedelba1eabfa2012-08-03 15:55:41 +020043struct notifier_block;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040044
45/* iommu fault flags */
Sushmita Susheelendra5e36b912015-06-02 15:46:24 -060046#define IOMMU_FAULT_READ (1 << 0)
47#define IOMMU_FAULT_WRITE (1 << 1)
48#define IOMMU_FAULT_TRANSLATION (1 << 2)
49#define IOMMU_FAULT_PERMISSION (1 << 3)
Mitchel Humpherys0cc54a22015-08-19 10:57:55 -070050#define IOMMU_FAULT_EXTERNAL (1 << 4)
51#define IOMMU_FAULT_TRANSACTION_STALLED (1 << 5)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040052
53typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030054 struct device *, unsigned long, int, void *);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010055
Joerg Roedel0ff64f82012-01-26 19:40:53 +010056struct iommu_domain_geometry {
57 dma_addr_t aperture_start; /* First address that can be mapped */
58 dma_addr_t aperture_end; /* Last address that can be mapped */
59 bool force_aperture; /* DMA only allowed in mappable range? */
60};
61
Mitchel Humpherys3679a502016-02-12 14:10:31 -080062struct iommu_pgtbl_info {
63 void *pmds;
64};
65
Joerg Roedel8539c7c2015-03-26 13:43:05 +010066/* Domain feature flags */
67#define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
68#define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
69 implementation */
70#define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
71
72/*
73 * This are the possible domain-types
74 *
75 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
76 * devices
77 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
78 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
79 * for VMs
80 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
81 * This flag allows IOMMU drivers to implement
82 * certain optimizations for these domains
83 */
84#define IOMMU_DOMAIN_BLOCKED (0U)
85#define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
86#define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
87#define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
88 __IOMMU_DOMAIN_DMA_API)
89
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010090struct iommu_domain {
Joerg Roedel8539c7c2015-03-26 13:43:05 +010091 unsigned type;
Thierry Redingb22f6432014-06-27 09:03:12 +020092 const struct iommu_ops *ops;
Robin Murphyd16e0fa2016-04-07 18:42:06 +010093 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -040094 iommu_fault_handler_t handler;
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +030095 void *handler_token;
Joerg Roedel0ff64f82012-01-26 19:40:53 +010096 struct iommu_domain_geometry geometry;
Robin Murphy0db2e5d2015-10-01 20:13:58 +010097 void *iova_cookie;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +010098};
99
Joerg Roedel1aed0742014-09-03 18:34:04 +0200100enum iommu_cap {
101 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
102 transactions */
103 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
Antonios Motakisc4986642014-10-13 14:06:17 +0100104 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
Joerg Roedel1aed0742014-09-03 18:34:04 +0200105};
Sheng Yangdbb9fd82009-03-18 15:33:06 +0800106
Varun Sethi7cabf492013-07-15 10:20:56 +0530107/*
108 * Following constraints are specifc to FSL_PAMUV1:
109 * -aperture must be power of 2, and naturally aligned
110 * -number of windows must be power of 2, and address space size
111 * of each window is determined by aperture size / # of windows
112 * -the actual size of the mapped region of a window must be power
113 * of 2 starting with 4KB and physical address must be naturally
114 * aligned.
115 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
116 * The caller can invoke iommu_domain_get_attr to check if the underlying
117 * iommu implementation supports these constraints.
118 */
119
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100120enum iommu_attr {
Joerg Roedel0ff64f82012-01-26 19:40:53 +0100121 DOMAIN_ATTR_GEOMETRY,
Joerg Roedeld2e12162013-01-29 13:49:04 +0100122 DOMAIN_ATTR_PAGING,
Joerg Roedel69356712013-02-04 14:00:01 +0100123 DOMAIN_ATTR_WINDOWS,
Varun Sethi7cabf492013-07-15 10:20:56 +0530124 DOMAIN_ATTR_FSL_PAMU_STASH,
125 DOMAIN_ATTR_FSL_PAMU_ENABLE,
126 DOMAIN_ATTR_FSL_PAMUV1,
Will Deaconc02607a2014-09-29 10:05:06 -0600127 DOMAIN_ATTR_NESTING, /* two stages of translation */
Mitchel Humpherys19f19d52014-11-24 12:31:02 -0800128 DOMAIN_ATTR_PT_BASE_ADDR,
Jeremy Gebbene352bb02015-06-16 10:54:01 -0600129 DOMAIN_ATTR_CONTEXT_BANK,
Jeremy Gebben1b34ee12015-07-10 16:43:23 -0600130 DOMAIN_ATTR_DYNAMIC,
Jeremy Gebbene70da582015-07-10 16:43:22 -0600131 DOMAIN_ATTR_TTBR0,
132 DOMAIN_ATTR_CONTEXTIDR,
133 DOMAIN_ATTR_PROCID,
Mitchel Humpheryse78b0a52015-09-25 17:26:31 -0700134 DOMAIN_ATTR_NON_FATAL_FAULTS,
Patrick Dalybb82f962016-03-10 15:25:51 -0800135 DOMAIN_ATTR_S1_BYPASS,
Patrick Daly023ffedb2016-07-06 17:39:30 -0700136 DOMAIN_ATTR_ATOMIC,
Patrick Daly67be3692016-07-08 15:09:41 -0700137 DOMAIN_ATTR_SECURE_VMID,
Mitchel Humpherys60581e12016-02-12 13:53:20 -0800138 DOMAIN_ATTR_FAST,
Mitchel Humpherys3679a502016-02-12 14:10:31 -0800139 DOMAIN_ATTR_PGTBL_INFO,
Patrick Daly0b37c5a2016-11-09 13:29:11 -0800140 DOMAIN_ATTR_USE_UPSTREAM_HINT,
Patrick Dalyef6c1dc2016-11-16 14:35:23 -0800141 DOMAIN_ATTR_EARLY_MAP,
Mitchel Humpherys67ec6272016-06-07 14:55:50 -0700142 DOMAIN_ATTR_PAGE_TABLE_IS_COHERENT,
Liam Mark07edfbf2016-12-20 11:35:44 -0800143 DOMAIN_ATTR_PAGE_TABLE_FORCE_COHERENT,
Charan Teja Reddyc682e472017-04-20 19:11:20 +0530144 DOMAIN_ATTR_CB_STALL_DISABLE,
Patrick Daly1e279922017-09-06 15:57:45 -0700145 DOMAIN_ATTR_UPSTREAM_IOVA_ALLOCATOR,
Joerg Roedela8b8a88a2013-01-29 14:36:31 +0100146 DOMAIN_ATTR_MAX,
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100147};
148
Joerg Roedela1015c22015-05-28 18:41:33 +0200149/**
150 * struct iommu_dm_region - descriptor for a direct mapped memory region
151 * @list: Linked list pointers
152 * @start: System physical start address of the region
153 * @length: Length of the region in bytes
154 * @prot: IOMMU Protection flags (READ/WRITE/...)
155 */
156struct iommu_dm_region {
157 struct list_head list;
158 phys_addr_t start;
159 size_t length;
160 int prot;
161};
162
Mitchel Humpherysc75ae492015-07-15 18:27:36 -0700163extern struct dentry *iommu_debugfs_top;
164
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200165#ifdef CONFIG_IOMMU_API
166
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200167/**
168 * struct iommu_ops - iommu ops and capabilities
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900169 * @capable: check capability
170 * @domain_alloc: allocate iommu domain
171 * @domain_free: free iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200172 * @attach_dev: attach device to an iommu domain
173 * @detach_dev: detach device from an iommu domain
174 * @map: map a physically contiguous memory region to an iommu domain
175 * @unmap: unmap a physically contiguous memory region from an iommu domain
Olav Haugan315786e2014-10-25 09:55:16 -0700176 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
177 * to an iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200178 * @iova_to_phys: translate iova to physical address
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700179 * @iova_to_phys_hard: translate iova to physical address using IOMMU hardware
Alex Williamsond72e31c2012-05-30 14:18:53 -0600180 * @add_device: add device to iommu grouping
181 * @remove_device: remove device from iommu grouping
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900182 * @device_group: find iommu group for a particular device
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100183 * @domain_get_attr: Query domain attributes
184 * @domain_set_attr: Change domain attributes
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900185 * @get_dm_regions: Request list of direct mapping requirements for a device
186 * @put_dm_regions: Free list of direct mapping requirements for a device
Joerg Roedel33b21a62016-07-05 13:07:53 +0200187 * @apply_dm_region: Temporary helper call-back for iova reserved ranges
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900188 * @domain_window_enable: Configure and enable a particular window for a domain
189 * @domain_window_disable: Disable a particular window for a domain
190 * @domain_set_windows: Set the number of windows for a domain
191 * @domain_get_windows: Return the number of windows for a domain
Will Deacond0f60a42014-08-27 16:15:59 +0100192 * @of_xlate: add OF master IDs to iommu grouping
Robin Murphyd16e0fa2016-04-07 18:42:06 +0100193 * @pgsize_bitmap: bitmap of all possible supported page sizes
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700194 * @trigger_fault: trigger a fault on the device attached to an iommu domain
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700195 * @reg_read: read an IOMMU register
196 * @reg_write: write an IOMMU register
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800197 * @tlbi_domain: Invalidate all TLBs covering an iommu domain
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800198 * @enable_config_clocks: Enable all config clocks for this domain's IOMMU
199 * @disable_config_clocks: Disable all config clocks for this domain's IOMMU
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);
Olav Haugan315786e2014-10-25 09:55:16 -0700214 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
215 struct scatterlist *sg, unsigned int nents, int prot);
Varun Sethibb5547ac2013-03-29 01:23:58 +0530216 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700217 phys_addr_t (*iova_to_phys_hard)(struct iommu_domain *domain,
218 dma_addr_t iova);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600219 int (*add_device)(struct device *dev);
220 void (*remove_device)(struct device *dev);
Joerg Roedel46c6b2b2015-10-21 23:51:36 +0200221 struct iommu_group *(*device_group)(struct device *dev);
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100222 int (*domain_get_attr)(struct iommu_domain *domain,
223 enum iommu_attr attr, void *data);
224 int (*domain_set_attr)(struct iommu_domain *domain,
225 enum iommu_attr attr, void *data);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100226
Joerg Roedela1015c22015-05-28 18:41:33 +0200227 /* Request/Free a list of direct mapping requirements for a device */
228 void (*get_dm_regions)(struct device *dev, struct list_head *list);
229 void (*put_dm_regions)(struct device *dev, struct list_head *list);
Joerg Roedel33b21a62016-07-05 13:07:53 +0200230 void (*apply_dm_region)(struct device *dev, struct iommu_domain *domain,
231 struct iommu_dm_region *region);
Joerg Roedela1015c22015-05-28 18:41:33 +0200232
Joerg Roedeld7787d52013-01-29 14:26:20 +0100233 /* Window handling functions */
234 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530235 phys_addr_t paddr, u64 size, int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100236 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900237 /* Set the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100238 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900239 /* Get the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100240 u32 (*domain_get_windows)(struct iommu_domain *domain);
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700241 void (*trigger_fault)(struct iommu_domain *domain, unsigned long flags);
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700242 unsigned long (*reg_read)(struct iommu_domain *domain,
243 unsigned long offset);
244 void (*reg_write)(struct iommu_domain *domain, unsigned long val,
245 unsigned long offset);
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800246 void (*tlbi_domain)(struct iommu_domain *domain);
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800247 int (*enable_config_clocks)(struct iommu_domain *domain);
248 void (*disable_config_clocks)(struct iommu_domain *domain);
Sudarshan Rajagopalan7a0b4bb2017-04-04 19:10:06 -0700249 uint64_t (*iova_to_pte)(struct iommu_domain *domain,
250 dma_addr_t iova);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100251
Will Deacond0f60a42014-08-27 16:15:59 +0100252 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
Will Deacond0f60a42014-08-27 16:15:59 +0100253
Liam Mark5bb64222016-12-09 14:36:07 -0800254 bool (*is_iova_coherent)(struct iommu_domain *domain, dma_addr_t iova);
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200255 unsigned long pgsize_bitmap;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100256};
257
Alex Williamsond72e31c2012-05-30 14:18:53 -0600258#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
259#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
260#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
261#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
262#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
263#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
264
Thierry Redingb22f6432014-06-27 09:03:12 +0200265extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
Joerg Roedela1b60c12011-09-06 18:46:34 +0200266extern bool iommu_present(struct bus_type *bus);
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200267extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
Joerg Roedel905d66c2011-09-06 16:03:26 +0200268extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
Alexey Kardashevskiyaa16bea2013-03-25 10:23:49 +1100269extern struct iommu_group *iommu_group_get_by_id(int id);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100270extern void iommu_domain_free(struct iommu_domain *domain);
271extern int iommu_attach_device(struct iommu_domain *domain,
272 struct device *dev);
273extern void iommu_detach_device(struct iommu_domain *domain,
274 struct device *dev);
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200275extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
Mitchel Humpherysfad25922015-05-01 17:13:21 -0700276extern size_t iommu_pgsize(unsigned long pgsize_bitmap,
277 unsigned long addr_merge, size_t size);
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100278extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200279 phys_addr_t paddr, size_t size, int prot);
280extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
281 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700282extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
283 struct scatterlist *sg,unsigned int nents,
284 int prot);
Varun Sethibb5547ac2013-03-29 01:23:58 +0530285extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700286extern phys_addr_t iommu_iova_to_phys_hard(struct iommu_domain *domain,
287 dma_addr_t iova);
Liam Mark5bb64222016-12-09 14:36:07 -0800288extern bool iommu_is_iova_coherent(struct iommu_domain *domain,
289 dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400290extern void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300291 iommu_fault_handler_t handler, void *token);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600292
Joerg Roedela1015c22015-05-28 18:41:33 +0200293extern void iommu_get_dm_regions(struct device *dev, struct list_head *list);
294extern void iommu_put_dm_regions(struct device *dev, struct list_head *list);
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200295extern int iommu_request_dm_for_dev(struct device *dev);
Joerg Roedela1015c22015-05-28 18:41:33 +0200296
Alex Williamsond72e31c2012-05-30 14:18:53 -0600297extern int iommu_attach_group(struct iommu_domain *domain,
298 struct iommu_group *group);
299extern void iommu_detach_group(struct iommu_domain *domain,
300 struct iommu_group *group);
301extern struct iommu_group *iommu_group_alloc(void);
302extern void *iommu_group_get_iommudata(struct iommu_group *group);
303extern void iommu_group_set_iommudata(struct iommu_group *group,
304 void *iommu_data,
305 void (*release)(void *iommu_data));
306extern int iommu_group_set_name(struct iommu_group *group, const char *name);
307extern int iommu_group_add_device(struct iommu_group *group,
308 struct device *dev);
309extern void iommu_group_remove_device(struct device *dev);
310extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
311 int (*fn)(struct device *, void *));
312extern struct iommu_group *iommu_group_get(struct device *dev);
313extern void iommu_group_put(struct iommu_group *group);
314extern int iommu_group_register_notifier(struct iommu_group *group,
315 struct notifier_block *nb);
316extern int iommu_group_unregister_notifier(struct iommu_group *group,
317 struct notifier_block *nb);
318extern int iommu_group_id(struct iommu_group *group);
Alex Williamson104a1c12014-07-03 09:51:18 -0600319extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
Joerg Roedel6827ca82015-05-28 18:41:35 +0200320extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400321
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100322extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
323 void *data);
324extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
325 void *data);
Alex Williamsonc61959e2014-06-12 16:12:24 -0600326struct device *iommu_device_create(struct device *parent, void *drvdata,
327 const struct attribute_group **groups,
Nicolas Iooss8db14862015-07-17 16:23:42 -0700328 const char *fmt, ...) __printf(4, 5);
Alex Williamsonc61959e2014-06-12 16:12:24 -0600329void iommu_device_destroy(struct device *dev);
330int iommu_device_link(struct device *dev, struct device *link);
331void iommu_device_unlink(struct device *dev, struct device *link);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400332
Joerg Roedeld7787d52013-01-29 14:26:20 +0100333/* Window handling function prototypes */
334extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530335 phys_addr_t offset, u64 size,
336 int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100337extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
Sudarshan Rajagopalan7a0b4bb2017-04-04 19:10:06 -0700338
339extern uint64_t iommu_iova_to_pte(struct iommu_domain *domain,
340 dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400341/**
342 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
343 * @domain: the iommu domain where the fault has happened
344 * @dev: the device where the fault has happened
345 * @iova: the faulting address
346 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
347 *
348 * This function should be called by the low-level IOMMU implementations
349 * whenever IOMMU faults happen, to allow high-level users, that are
350 * interested in such events, to know about them.
351 *
352 * This event may be useful for several possible use cases:
353 * - mere logging of the event
354 * - dynamic TLB/PTE loading
355 * - if restarting of the faulting device is required
356 *
357 * Returns 0 on success and an appropriate error code otherwise (if dynamic
358 * PTE/TLB loading will one day be supported, implementations will be able
359 * to tell whether it succeeded or not according to this return value).
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400360 *
361 * Specifically, -ENOSYS is returned if a fault handler isn't installed
362 * (though fault handlers can also return -ENOSYS, in case they want to
363 * elicit the default behavior of the IOMMU drivers).
Sushmita Susheelendra5e36b912015-06-02 15:46:24 -0600364
365 * Client fault handler returns -EBUSY to signal to the IOMMU driver
366 * that the client will take responsibility for any further fault
367 * handling, including clearing fault status registers or retrying
368 * the faulting transaction.
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400369 */
370static inline int report_iommu_fault(struct iommu_domain *domain,
371 struct device *dev, unsigned long iova, int flags)
372{
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400373 int ret = -ENOSYS;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400374
375 /*
376 * if upper layers showed interest and installed a fault handler,
377 * invoke it.
378 */
379 if (domain->handler)
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300380 ret = domain->handler(domain, dev, iova, flags,
381 domain->handler_token);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400382
Shuah Khan56fa4842013-09-24 15:21:20 -0600383 trace_io_page_fault(dev, iova, flags);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400384 return ret;
385}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100386
Olav Haugan315786e2014-10-25 09:55:16 -0700387static inline size_t iommu_map_sg(struct iommu_domain *domain,
388 unsigned long iova, struct scatterlist *sg,
389 unsigned int nents, int prot)
390{
391 return domain->ops->map_sg(domain, iova, sg, nents, prot);
392}
393
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700394extern void iommu_trigger_fault(struct iommu_domain *domain,
395 unsigned long flags);
396
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700397extern unsigned long iommu_reg_read(struct iommu_domain *domain,
398 unsigned long offset);
399extern void iommu_reg_write(struct iommu_domain *domain, unsigned long offset,
400 unsigned long val);
Joerg Roedel5e622922015-10-21 23:51:37 +0200401/* PCI device grouping function */
402extern struct iommu_group *pci_device_group(struct device *dev);
Joerg Roedel6eab5562015-10-21 23:51:38 +0200403/* Generic device grouping function */
404extern struct iommu_group *generic_device_group(struct device *dev);
Joerg Roedel5e622922015-10-21 23:51:37 +0200405
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800406static inline void iommu_tlbiall(struct iommu_domain *domain)
407{
408 if (domain->ops->tlbi_domain)
409 domain->ops->tlbi_domain(domain);
410}
411
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800412static inline int iommu_enable_config_clocks(struct iommu_domain *domain)
413{
414 if (domain->ops->enable_config_clocks)
415 return domain->ops->enable_config_clocks(domain);
416 return 0;
417}
418
419static inline void iommu_disable_config_clocks(struct iommu_domain *domain)
420{
421 if (domain->ops->disable_config_clocks)
422 domain->ops->disable_config_clocks(domain);
423}
424
Robin Murphy57f98d22016-09-13 10:54:14 +0100425/**
426 * struct iommu_fwspec - per-device IOMMU instance data
427 * @ops: ops for this device's IOMMU
428 * @iommu_fwnode: firmware handle for this device's IOMMU
429 * @iommu_priv: IOMMU driver private data for this device
430 * @num_ids: number of associated device IDs
431 * @ids: IDs which this device may present to the IOMMU
432 */
433struct iommu_fwspec {
434 const struct iommu_ops *ops;
435 struct fwnode_handle *iommu_fwnode;
436 void *iommu_priv;
437 unsigned int num_ids;
438 u32 ids[1];
439};
440
441int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
442 const struct iommu_ops *ops);
443void iommu_fwspec_free(struct device *dev);
444int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
Patrick Daly1e3c16c2017-04-12 17:59:07 -0700445int iommu_fwspec_get_id(struct device *dev, u32 *id);
Patrick Daly958973c2017-04-28 19:45:18 -0700446int iommu_is_available(struct device *dev);
Robin Murphy57f98d22016-09-13 10:54:14 +0100447
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 Roedel4a77a6c2008-11-26 17:02:33 +0100453
Joerg Roedela1b60c12011-09-06 18:46:34 +0200454static inline bool iommu_present(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100455{
456 return false;
457}
458
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200459static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
460{
461 return false;
462}
463
Joerg Roedel905d66c2011-09-06 16:03:26 +0200464static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100465{
466 return NULL;
467}
468
Alexey Kardashevskiyb62dfd22013-11-21 17:41:14 +1100469static inline struct iommu_group *iommu_group_get_by_id(int id)
470{
471 return NULL;
472}
473
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100474static inline void iommu_domain_free(struct iommu_domain *domain)
475{
476}
477
478static inline int iommu_attach_device(struct iommu_domain *domain,
479 struct device *dev)
480{
481 return -ENODEV;
482}
483
484static inline void iommu_detach_device(struct iommu_domain *domain,
485 struct device *dev)
486{
487}
488
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200489static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
490{
491 return NULL;
492}
493
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100494static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
495 phys_addr_t paddr, int gfp_order, int prot)
496{
497 return -ENODEV;
498}
499
500static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
501 int gfp_order)
502{
503 return -ENODEV;
504}
505
Olav Haugan315786e2014-10-25 09:55:16 -0700506static inline size_t iommu_map_sg(struct iommu_domain *domain,
507 unsigned long iova, struct scatterlist *sg,
508 unsigned int nents, int prot)
509{
510 return -ENODEV;
511}
512
Joerg Roedeld7787d52013-01-29 14:26:20 +0100513static inline int iommu_domain_window_enable(struct iommu_domain *domain,
514 u32 wnd_nr, phys_addr_t paddr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530515 u64 size, int prot)
Joerg Roedeld7787d52013-01-29 14:26:20 +0100516{
517 return -ENODEV;
518}
519
520static inline void iommu_domain_window_disable(struct iommu_domain *domain,
521 u32 wnd_nr)
522{
523}
524
Varun Sethibb5547ac2013-03-29 01:23:58 +0530525static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100526{
527 return 0;
528}
529
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700530static inline phys_addr_t iommu_iova_to_phys_hard(struct iommu_domain *domain,
531 dma_addr_t iova)
532{
533 return 0;
534}
535
Liam Mark5bb64222016-12-09 14:36:07 -0800536static inline bool iommu_is_iova_coherent(struct iommu_domain *domain,
537 dma_addr_t iova)
538{
539 return 0;
540}
541
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400542static inline void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300543 iommu_fault_handler_t handler, void *token)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400544{
545}
546
Joerg Roedela1015c22015-05-28 18:41:33 +0200547static inline void iommu_get_dm_regions(struct device *dev,
548 struct list_head *list)
549{
550}
551
552static inline void iommu_put_dm_regions(struct device *dev,
553 struct list_head *list)
554{
555}
556
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200557static inline int iommu_request_dm_for_dev(struct device *dev)
558{
559 return -ENODEV;
560}
561
Alex Williamsonbef83de2012-09-24 21:23:25 -0600562static inline int iommu_attach_group(struct iommu_domain *domain,
563 struct iommu_group *group)
Alex Williamson14604322011-10-21 15:56:05 -0400564{
565 return -ENODEV;
566}
567
Alex Williamsonbef83de2012-09-24 21:23:25 -0600568static inline void iommu_detach_group(struct iommu_domain *domain,
569 struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600570{
571}
572
Alex Williamsonbef83de2012-09-24 21:23:25 -0600573static inline struct iommu_group *iommu_group_alloc(void)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600574{
575 return ERR_PTR(-ENODEV);
576}
577
Alex Williamsonbef83de2012-09-24 21:23:25 -0600578static inline void *iommu_group_get_iommudata(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600579{
580 return NULL;
581}
582
Alex Williamsonbef83de2012-09-24 21:23:25 -0600583static inline void iommu_group_set_iommudata(struct iommu_group *group,
584 void *iommu_data,
585 void (*release)(void *iommu_data))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600586{
587}
588
Alex Williamsonbef83de2012-09-24 21:23:25 -0600589static inline int iommu_group_set_name(struct iommu_group *group,
590 const char *name)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600591{
592 return -ENODEV;
593}
594
Alex Williamsonbef83de2012-09-24 21:23:25 -0600595static inline int iommu_group_add_device(struct iommu_group *group,
596 struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600597{
598 return -ENODEV;
599}
600
Alex Williamsonbef83de2012-09-24 21:23:25 -0600601static inline void iommu_group_remove_device(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600602{
603}
604
Alex Williamsonbef83de2012-09-24 21:23:25 -0600605static inline int iommu_group_for_each_dev(struct iommu_group *group,
606 void *data,
607 int (*fn)(struct device *, void *))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600608{
609 return -ENODEV;
610}
611
Alex Williamsonbef83de2012-09-24 21:23:25 -0600612static inline struct iommu_group *iommu_group_get(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600613{
614 return NULL;
615}
616
Alex Williamsonbef83de2012-09-24 21:23:25 -0600617static inline void iommu_group_put(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600618{
619}
620
Alex Williamsonbef83de2012-09-24 21:23:25 -0600621static inline int iommu_group_register_notifier(struct iommu_group *group,
622 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600623{
624 return -ENODEV;
625}
626
Alex Williamsonbef83de2012-09-24 21:23:25 -0600627static inline int iommu_group_unregister_notifier(struct iommu_group *group,
628 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600629{
630 return 0;
631}
632
Alex Williamsonbef83de2012-09-24 21:23:25 -0600633static inline int iommu_group_id(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600634{
635 return -ENODEV;
636}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100637
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100638static inline int iommu_domain_get_attr(struct iommu_domain *domain,
639 enum iommu_attr attr, void *data)
640{
641 return -EINVAL;
642}
643
644static inline int iommu_domain_set_attr(struct iommu_domain *domain,
645 enum iommu_attr attr, void *data)
646{
647 return -EINVAL;
648}
649
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600650static inline struct device *iommu_device_create(struct device *parent,
651 void *drvdata,
652 const struct attribute_group **groups,
653 const char *fmt, ...)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600654{
655 return ERR_PTR(-ENODEV);
656}
657
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600658static inline void iommu_device_destroy(struct device *dev)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600659{
660}
661
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600662static inline int iommu_device_link(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600663{
664 return -EINVAL;
665}
666
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600667static inline void iommu_device_unlink(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600668{
669}
670
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700671static inline void iommu_trigger_fault(struct iommu_domain *domain,
672 unsigned long flags)
673{
674}
675
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700676static inline unsigned long iommu_reg_read(struct iommu_domain *domain,
677 unsigned long offset)
678{
679 return 0;
680}
681
682static inline void iommu_reg_write(struct iommu_domain *domain,
683 unsigned long val, unsigned long offset)
684{
685}
686
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800687static inline void iommu_tlbiall(struct iommu_domain *domain)
688{
689}
690
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800691static inline int iommu_enable_config_clocks(struct iommu_domain *domain)
692{
693 return 0;
694}
695
696static inline void iommu_disable_config_clocks(struct iommu_domain *domain)
697{
698}
699
Robin Murphy57f98d22016-09-13 10:54:14 +0100700static inline int iommu_fwspec_init(struct device *dev,
701 struct fwnode_handle *iommu_fwnode,
702 const struct iommu_ops *ops)
703{
704 return -ENODEV;
705}
706
707static inline void iommu_fwspec_free(struct device *dev)
708{
709}
710
711static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
712 int num_ids)
713{
714 return -ENODEV;
715}
716
Runmin Wang8cfebef2017-04-28 13:59:58 -0700717static inline int iommu_fwspec_get_id(struct device *dev, u32 *id)
Patrick Daly1e3c16c2017-04-12 17:59:07 -0700718{
719 return -ENODEV;
720}
721
Patrick Daly958973c2017-04-28 19:45:18 -0700722static inline int iommu_is_available(struct device *dev)
723{
724 return -ENODEV;
725}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100726#endif /* CONFIG_IOMMU_API */
727
728#endif /* __LINUX_IOMMU_H */