blob: 7bdddb3637b1d98e22e703f8ee300db46c35dd86 [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,
Joerg Roedela8b8a882013-01-29 14:36:31 +0100144 DOMAIN_ATTR_MAX,
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100145};
146
Joerg Roedela1015c22015-05-28 18:41:33 +0200147/**
148 * struct iommu_dm_region - descriptor for a direct mapped memory region
149 * @list: Linked list pointers
150 * @start: System physical start address of the region
151 * @length: Length of the region in bytes
152 * @prot: IOMMU Protection flags (READ/WRITE/...)
153 */
154struct iommu_dm_region {
155 struct list_head list;
156 phys_addr_t start;
157 size_t length;
158 int prot;
159};
160
Mitchel Humpherysc75ae492015-07-15 18:27:36 -0700161extern struct dentry *iommu_debugfs_top;
162
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200163#ifdef CONFIG_IOMMU_API
164
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200165/**
166 * struct iommu_ops - iommu ops and capabilities
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900167 * @capable: check capability
168 * @domain_alloc: allocate iommu domain
169 * @domain_free: free iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200170 * @attach_dev: attach device to an iommu domain
171 * @detach_dev: detach device from an iommu domain
172 * @map: map a physically contiguous memory region to an iommu domain
173 * @unmap: unmap a physically contiguous memory region from an iommu domain
Olav Haugan315786e2014-10-25 09:55:16 -0700174 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
175 * to an iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200176 * @iova_to_phys: translate iova to physical address
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700177 * @iova_to_phys_hard: translate iova to physical address using IOMMU hardware
Alex Williamsond72e31c2012-05-30 14:18:53 -0600178 * @add_device: add device to iommu grouping
179 * @remove_device: remove device from iommu grouping
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900180 * @device_group: find iommu group for a particular device
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100181 * @domain_get_attr: Query domain attributes
182 * @domain_set_attr: Change domain attributes
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900183 * @get_dm_regions: Request list of direct mapping requirements for a device
184 * @put_dm_regions: Free list of direct mapping requirements for a device
Joerg Roedel33b21a62016-07-05 13:07:53 +0200185 * @apply_dm_region: Temporary helper call-back for iova reserved ranges
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900186 * @domain_window_enable: Configure and enable a particular window for a domain
187 * @domain_window_disable: Disable a particular window for a domain
188 * @domain_set_windows: Set the number of windows for a domain
189 * @domain_get_windows: Return the number of windows for a domain
Will Deacond0f60a42014-08-27 16:15:59 +0100190 * @of_xlate: add OF master IDs to iommu grouping
Robin Murphyd16e0fa2016-04-07 18:42:06 +0100191 * @pgsize_bitmap: bitmap of all possible supported page sizes
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700192 * @trigger_fault: trigger a fault on the device attached to an iommu domain
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700193 * @reg_read: read an IOMMU register
194 * @reg_write: write an IOMMU register
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800195 * @tlbi_domain: Invalidate all TLBs covering an iommu domain
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800196 * @enable_config_clocks: Enable all config clocks for this domain's IOMMU
197 * @disable_config_clocks: Disable all config clocks for this domain's IOMMU
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200198 */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100199struct iommu_ops {
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200200 bool (*capable)(enum iommu_cap);
Joerg Roedel938c4702015-03-26 13:43:04 +0100201
202 /* Domain allocation and freeing by the iommu driver */
Joerg Roedel8539c7c2015-03-26 13:43:05 +0100203 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
Joerg Roedel938c4702015-03-26 13:43:04 +0100204 void (*domain_free)(struct iommu_domain *);
205
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100206 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
207 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
Joerg Roedel67651782010-01-21 16:32:27 +0100208 int (*map)(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen50090652011-11-10 11:32:25 +0200209 phys_addr_t paddr, size_t size, int prot);
210 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
211 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700212 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
213 struct scatterlist *sg, unsigned int nents, int prot);
Varun Sethibb5547ac2013-03-29 01:23:58 +0530214 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700215 phys_addr_t (*iova_to_phys_hard)(struct iommu_domain *domain,
216 dma_addr_t iova);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600217 int (*add_device)(struct device *dev);
218 void (*remove_device)(struct device *dev);
Joerg Roedel46c6b2b2015-10-21 23:51:36 +0200219 struct iommu_group *(*device_group)(struct device *dev);
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100220 int (*domain_get_attr)(struct iommu_domain *domain,
221 enum iommu_attr attr, void *data);
222 int (*domain_set_attr)(struct iommu_domain *domain,
223 enum iommu_attr attr, void *data);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100224
Joerg Roedela1015c22015-05-28 18:41:33 +0200225 /* Request/Free a list of direct mapping requirements for a device */
226 void (*get_dm_regions)(struct device *dev, struct list_head *list);
227 void (*put_dm_regions)(struct device *dev, struct list_head *list);
Joerg Roedel33b21a62016-07-05 13:07:53 +0200228 void (*apply_dm_region)(struct device *dev, struct iommu_domain *domain,
229 struct iommu_dm_region *region);
Joerg Roedela1015c22015-05-28 18:41:33 +0200230
Joerg Roedeld7787d52013-01-29 14:26:20 +0100231 /* Window handling functions */
232 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530233 phys_addr_t paddr, u64 size, int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100234 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900235 /* Set the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100236 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900237 /* Get the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100238 u32 (*domain_get_windows)(struct iommu_domain *domain);
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700239 void (*trigger_fault)(struct iommu_domain *domain, unsigned long flags);
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700240 unsigned long (*reg_read)(struct iommu_domain *domain,
241 unsigned long offset);
242 void (*reg_write)(struct iommu_domain *domain, unsigned long val,
243 unsigned long offset);
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800244 void (*tlbi_domain)(struct iommu_domain *domain);
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800245 int (*enable_config_clocks)(struct iommu_domain *domain);
246 void (*disable_config_clocks)(struct iommu_domain *domain);
Sudarshan Rajagopalan7a0b4bb2017-04-04 19:10:06 -0700247 uint64_t (*iova_to_pte)(struct iommu_domain *domain,
248 dma_addr_t iova);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100249
Will Deacond0f60a42014-08-27 16:15:59 +0100250 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
Will Deacond0f60a42014-08-27 16:15:59 +0100251
Liam Mark5bb64222016-12-09 14:36:07 -0800252 bool (*is_iova_coherent)(struct iommu_domain *domain, dma_addr_t iova);
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200253 unsigned long pgsize_bitmap;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100254};
255
Alex Williamsond72e31c2012-05-30 14:18:53 -0600256#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
257#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
258#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
259#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
260#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
261#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
262
Thierry Redingb22f6432014-06-27 09:03:12 +0200263extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
Joerg Roedela1b60c12011-09-06 18:46:34 +0200264extern bool iommu_present(struct bus_type *bus);
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200265extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
Joerg Roedel905d66c2011-09-06 16:03:26 +0200266extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
Alexey Kardashevskiyaa16bea2013-03-25 10:23:49 +1100267extern struct iommu_group *iommu_group_get_by_id(int id);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100268extern void iommu_domain_free(struct iommu_domain *domain);
269extern int iommu_attach_device(struct iommu_domain *domain,
270 struct device *dev);
271extern void iommu_detach_device(struct iommu_domain *domain,
272 struct device *dev);
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200273extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
Mitchel Humpherysfad25922015-05-01 17:13:21 -0700274extern size_t iommu_pgsize(unsigned long pgsize_bitmap,
275 unsigned long addr_merge, size_t size);
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100276extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200277 phys_addr_t paddr, size_t size, int prot);
278extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
279 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700280extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
281 struct scatterlist *sg,unsigned int nents,
282 int prot);
Varun Sethibb5547ac2013-03-29 01:23:58 +0530283extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700284extern phys_addr_t iommu_iova_to_phys_hard(struct iommu_domain *domain,
285 dma_addr_t iova);
Liam Mark5bb64222016-12-09 14:36:07 -0800286extern bool iommu_is_iova_coherent(struct iommu_domain *domain,
287 dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400288extern void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300289 iommu_fault_handler_t handler, void *token);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600290
Joerg Roedela1015c22015-05-28 18:41:33 +0200291extern void iommu_get_dm_regions(struct device *dev, struct list_head *list);
292extern void iommu_put_dm_regions(struct device *dev, struct list_head *list);
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200293extern int iommu_request_dm_for_dev(struct device *dev);
Joerg Roedela1015c22015-05-28 18:41:33 +0200294
Alex Williamsond72e31c2012-05-30 14:18:53 -0600295extern int iommu_attach_group(struct iommu_domain *domain,
296 struct iommu_group *group);
297extern void iommu_detach_group(struct iommu_domain *domain,
298 struct iommu_group *group);
299extern struct iommu_group *iommu_group_alloc(void);
300extern void *iommu_group_get_iommudata(struct iommu_group *group);
301extern void iommu_group_set_iommudata(struct iommu_group *group,
302 void *iommu_data,
303 void (*release)(void *iommu_data));
304extern int iommu_group_set_name(struct iommu_group *group, const char *name);
305extern int iommu_group_add_device(struct iommu_group *group,
306 struct device *dev);
307extern void iommu_group_remove_device(struct device *dev);
308extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
309 int (*fn)(struct device *, void *));
310extern struct iommu_group *iommu_group_get(struct device *dev);
311extern void iommu_group_put(struct iommu_group *group);
312extern int iommu_group_register_notifier(struct iommu_group *group,
313 struct notifier_block *nb);
314extern int iommu_group_unregister_notifier(struct iommu_group *group,
315 struct notifier_block *nb);
316extern int iommu_group_id(struct iommu_group *group);
Alex Williamson104a1c12014-07-03 09:51:18 -0600317extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
Joerg Roedel6827ca82015-05-28 18:41:35 +0200318extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400319
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100320extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
321 void *data);
322extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
323 void *data);
Alex Williamsonc61959e2014-06-12 16:12:24 -0600324struct device *iommu_device_create(struct device *parent, void *drvdata,
325 const struct attribute_group **groups,
Nicolas Iooss8db14862015-07-17 16:23:42 -0700326 const char *fmt, ...) __printf(4, 5);
Alex Williamsonc61959e2014-06-12 16:12:24 -0600327void iommu_device_destroy(struct device *dev);
328int iommu_device_link(struct device *dev, struct device *link);
329void iommu_device_unlink(struct device *dev, struct device *link);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400330
Joerg Roedeld7787d52013-01-29 14:26:20 +0100331/* Window handling function prototypes */
332extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530333 phys_addr_t offset, u64 size,
334 int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100335extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
Sudarshan Rajagopalan7a0b4bb2017-04-04 19:10:06 -0700336
337extern uint64_t iommu_iova_to_pte(struct iommu_domain *domain,
338 dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400339/**
340 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
341 * @domain: the iommu domain where the fault has happened
342 * @dev: the device where the fault has happened
343 * @iova: the faulting address
344 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
345 *
346 * This function should be called by the low-level IOMMU implementations
347 * whenever IOMMU faults happen, to allow high-level users, that are
348 * interested in such events, to know about them.
349 *
350 * This event may be useful for several possible use cases:
351 * - mere logging of the event
352 * - dynamic TLB/PTE loading
353 * - if restarting of the faulting device is required
354 *
355 * Returns 0 on success and an appropriate error code otherwise (if dynamic
356 * PTE/TLB loading will one day be supported, implementations will be able
357 * to tell whether it succeeded or not according to this return value).
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400358 *
359 * Specifically, -ENOSYS is returned if a fault handler isn't installed
360 * (though fault handlers can also return -ENOSYS, in case they want to
361 * elicit the default behavior of the IOMMU drivers).
Sushmita Susheelendra5e36b912015-06-02 15:46:24 -0600362
363 * Client fault handler returns -EBUSY to signal to the IOMMU driver
364 * that the client will take responsibility for any further fault
365 * handling, including clearing fault status registers or retrying
366 * the faulting transaction.
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400367 */
368static inline int report_iommu_fault(struct iommu_domain *domain,
369 struct device *dev, unsigned long iova, int flags)
370{
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400371 int ret = -ENOSYS;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400372
373 /*
374 * if upper layers showed interest and installed a fault handler,
375 * invoke it.
376 */
377 if (domain->handler)
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300378 ret = domain->handler(domain, dev, iova, flags,
379 domain->handler_token);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400380
Shuah Khan56fa4842013-09-24 15:21:20 -0600381 trace_io_page_fault(dev, iova, flags);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400382 return ret;
383}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100384
Olav Haugan315786e2014-10-25 09:55:16 -0700385static inline size_t iommu_map_sg(struct iommu_domain *domain,
386 unsigned long iova, struct scatterlist *sg,
387 unsigned int nents, int prot)
388{
389 return domain->ops->map_sg(domain, iova, sg, nents, prot);
390}
391
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700392extern void iommu_trigger_fault(struct iommu_domain *domain,
393 unsigned long flags);
394
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700395extern unsigned long iommu_reg_read(struct iommu_domain *domain,
396 unsigned long offset);
397extern void iommu_reg_write(struct iommu_domain *domain, unsigned long offset,
398 unsigned long val);
Joerg Roedel5e622922015-10-21 23:51:37 +0200399/* PCI device grouping function */
400extern struct iommu_group *pci_device_group(struct device *dev);
Joerg Roedel6eab5562015-10-21 23:51:38 +0200401/* Generic device grouping function */
402extern struct iommu_group *generic_device_group(struct device *dev);
Joerg Roedel5e622922015-10-21 23:51:37 +0200403
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800404static inline void iommu_tlbiall(struct iommu_domain *domain)
405{
406 if (domain->ops->tlbi_domain)
407 domain->ops->tlbi_domain(domain);
408}
409
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800410static inline int iommu_enable_config_clocks(struct iommu_domain *domain)
411{
412 if (domain->ops->enable_config_clocks)
413 return domain->ops->enable_config_clocks(domain);
414 return 0;
415}
416
417static inline void iommu_disable_config_clocks(struct iommu_domain *domain)
418{
419 if (domain->ops->disable_config_clocks)
420 domain->ops->disable_config_clocks(domain);
421}
422
Robin Murphy57f98d22016-09-13 10:54:14 +0100423/**
424 * struct iommu_fwspec - per-device IOMMU instance data
425 * @ops: ops for this device's IOMMU
426 * @iommu_fwnode: firmware handle for this device's IOMMU
427 * @iommu_priv: IOMMU driver private data for this device
428 * @num_ids: number of associated device IDs
429 * @ids: IDs which this device may present to the IOMMU
430 */
431struct iommu_fwspec {
432 const struct iommu_ops *ops;
433 struct fwnode_handle *iommu_fwnode;
434 void *iommu_priv;
435 unsigned int num_ids;
436 u32 ids[1];
437};
438
439int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
440 const struct iommu_ops *ops);
441void iommu_fwspec_free(struct device *dev);
442int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
Patrick Daly1e3c16c2017-04-12 17:59:07 -0700443int iommu_fwspec_get_id(struct device *dev, u32 *id);
Patrick Daly958973c2017-04-28 19:45:18 -0700444int iommu_is_available(struct device *dev);
Robin Murphy57f98d22016-09-13 10:54:14 +0100445
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100446#else /* CONFIG_IOMMU_API */
447
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200448struct iommu_ops {};
Alex Williamsond72e31c2012-05-30 14:18:53 -0600449struct iommu_group {};
Robin Murphy57f98d22016-09-13 10:54:14 +0100450struct iommu_fwspec {};
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100451
Joerg Roedela1b60c12011-09-06 18:46:34 +0200452static inline bool iommu_present(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100453{
454 return false;
455}
456
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200457static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
458{
459 return false;
460}
461
Joerg Roedel905d66c2011-09-06 16:03:26 +0200462static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100463{
464 return NULL;
465}
466
Alexey Kardashevskiyb62dfd22013-11-21 17:41:14 +1100467static inline struct iommu_group *iommu_group_get_by_id(int id)
468{
469 return NULL;
470}
471
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100472static inline void iommu_domain_free(struct iommu_domain *domain)
473{
474}
475
476static inline int iommu_attach_device(struct iommu_domain *domain,
477 struct device *dev)
478{
479 return -ENODEV;
480}
481
482static inline void iommu_detach_device(struct iommu_domain *domain,
483 struct device *dev)
484{
485}
486
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200487static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
488{
489 return NULL;
490}
491
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100492static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
493 phys_addr_t paddr, int gfp_order, int prot)
494{
495 return -ENODEV;
496}
497
498static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
499 int gfp_order)
500{
501 return -ENODEV;
502}
503
Olav Haugan315786e2014-10-25 09:55:16 -0700504static inline size_t iommu_map_sg(struct iommu_domain *domain,
505 unsigned long iova, struct scatterlist *sg,
506 unsigned int nents, int prot)
507{
508 return -ENODEV;
509}
510
Joerg Roedeld7787d52013-01-29 14:26:20 +0100511static inline int iommu_domain_window_enable(struct iommu_domain *domain,
512 u32 wnd_nr, phys_addr_t paddr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530513 u64 size, int prot)
Joerg Roedeld7787d52013-01-29 14:26:20 +0100514{
515 return -ENODEV;
516}
517
518static inline void iommu_domain_window_disable(struct iommu_domain *domain,
519 u32 wnd_nr)
520{
521}
522
Varun Sethibb5547ac2013-03-29 01:23:58 +0530523static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100524{
525 return 0;
526}
527
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700528static inline phys_addr_t iommu_iova_to_phys_hard(struct iommu_domain *domain,
529 dma_addr_t iova)
530{
531 return 0;
532}
533
Liam Mark5bb64222016-12-09 14:36:07 -0800534static inline bool iommu_is_iova_coherent(struct iommu_domain *domain,
535 dma_addr_t iova)
536{
537 return 0;
538}
539
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400540static inline void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300541 iommu_fault_handler_t handler, void *token)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400542{
543}
544
Joerg Roedela1015c22015-05-28 18:41:33 +0200545static inline void iommu_get_dm_regions(struct device *dev,
546 struct list_head *list)
547{
548}
549
550static inline void iommu_put_dm_regions(struct device *dev,
551 struct list_head *list)
552{
553}
554
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200555static inline int iommu_request_dm_for_dev(struct device *dev)
556{
557 return -ENODEV;
558}
559
Alex Williamsonbef83de2012-09-24 21:23:25 -0600560static inline int iommu_attach_group(struct iommu_domain *domain,
561 struct iommu_group *group)
Alex Williamson14604322011-10-21 15:56:05 -0400562{
563 return -ENODEV;
564}
565
Alex Williamsonbef83de2012-09-24 21:23:25 -0600566static inline void iommu_detach_group(struct iommu_domain *domain,
567 struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600568{
569}
570
Alex Williamsonbef83de2012-09-24 21:23:25 -0600571static inline struct iommu_group *iommu_group_alloc(void)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600572{
573 return ERR_PTR(-ENODEV);
574}
575
Alex Williamsonbef83de2012-09-24 21:23:25 -0600576static inline void *iommu_group_get_iommudata(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600577{
578 return NULL;
579}
580
Alex Williamsonbef83de2012-09-24 21:23:25 -0600581static inline void iommu_group_set_iommudata(struct iommu_group *group,
582 void *iommu_data,
583 void (*release)(void *iommu_data))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600584{
585}
586
Alex Williamsonbef83de2012-09-24 21:23:25 -0600587static inline int iommu_group_set_name(struct iommu_group *group,
588 const char *name)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600589{
590 return -ENODEV;
591}
592
Alex Williamsonbef83de2012-09-24 21:23:25 -0600593static inline int iommu_group_add_device(struct iommu_group *group,
594 struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600595{
596 return -ENODEV;
597}
598
Alex Williamsonbef83de2012-09-24 21:23:25 -0600599static inline void iommu_group_remove_device(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600600{
601}
602
Alex Williamsonbef83de2012-09-24 21:23:25 -0600603static inline int iommu_group_for_each_dev(struct iommu_group *group,
604 void *data,
605 int (*fn)(struct device *, void *))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600606{
607 return -ENODEV;
608}
609
Alex Williamsonbef83de2012-09-24 21:23:25 -0600610static inline struct iommu_group *iommu_group_get(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600611{
612 return NULL;
613}
614
Alex Williamsonbef83de2012-09-24 21:23:25 -0600615static inline void iommu_group_put(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600616{
617}
618
Alex Williamsonbef83de2012-09-24 21:23:25 -0600619static inline int iommu_group_register_notifier(struct iommu_group *group,
620 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600621{
622 return -ENODEV;
623}
624
Alex Williamsonbef83de2012-09-24 21:23:25 -0600625static inline int iommu_group_unregister_notifier(struct iommu_group *group,
626 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600627{
628 return 0;
629}
630
Alex Williamsonbef83de2012-09-24 21:23:25 -0600631static inline int iommu_group_id(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600632{
633 return -ENODEV;
634}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100635
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100636static inline int iommu_domain_get_attr(struct iommu_domain *domain,
637 enum iommu_attr attr, void *data)
638{
639 return -EINVAL;
640}
641
642static inline int iommu_domain_set_attr(struct iommu_domain *domain,
643 enum iommu_attr attr, void *data)
644{
645 return -EINVAL;
646}
647
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600648static inline struct device *iommu_device_create(struct device *parent,
649 void *drvdata,
650 const struct attribute_group **groups,
651 const char *fmt, ...)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600652{
653 return ERR_PTR(-ENODEV);
654}
655
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600656static inline void iommu_device_destroy(struct device *dev)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600657{
658}
659
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600660static inline int iommu_device_link(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600661{
662 return -EINVAL;
663}
664
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600665static inline void iommu_device_unlink(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600666{
667}
668
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700669static inline void iommu_trigger_fault(struct iommu_domain *domain,
670 unsigned long flags)
671{
672}
673
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700674static inline unsigned long iommu_reg_read(struct iommu_domain *domain,
675 unsigned long offset)
676{
677 return 0;
678}
679
680static inline void iommu_reg_write(struct iommu_domain *domain,
681 unsigned long val, unsigned long offset)
682{
683}
684
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800685static inline void iommu_tlbiall(struct iommu_domain *domain)
686{
687}
688
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800689static inline int iommu_enable_config_clocks(struct iommu_domain *domain)
690{
691 return 0;
692}
693
694static inline void iommu_disable_config_clocks(struct iommu_domain *domain)
695{
696}
697
Robin Murphy57f98d22016-09-13 10:54:14 +0100698static inline int iommu_fwspec_init(struct device *dev,
699 struct fwnode_handle *iommu_fwnode,
700 const struct iommu_ops *ops)
701{
702 return -ENODEV;
703}
704
705static inline void iommu_fwspec_free(struct device *dev)
706{
707}
708
709static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
710 int num_ids)
711{
712 return -ENODEV;
713}
714
Runmin Wang8cfebef2017-04-28 13:59:58 -0700715static inline int iommu_fwspec_get_id(struct device *dev, u32 *id)
Patrick Daly1e3c16c2017-04-12 17:59:07 -0700716{
717 return -ENODEV;
718}
719
Patrick Daly958973c2017-04-28 19:45:18 -0700720static inline int iommu_is_available(struct device *dev)
721{
722 return -ENODEV;
723}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100724#endif /* CONFIG_IOMMU_API */
725
726#endif /* __LINUX_IOMMU_H */