blob: 787eb31c8c256ac15b4de84b668f777438d9cdff [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,
Joerg Roedela8b8a882013-01-29 14:36:31 +0100142 DOMAIN_ATTR_MAX,
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100143};
144
Joerg Roedela1015c22015-05-28 18:41:33 +0200145/**
146 * struct iommu_dm_region - descriptor for a direct mapped memory region
147 * @list: Linked list pointers
148 * @start: System physical start address of the region
149 * @length: Length of the region in bytes
150 * @prot: IOMMU Protection flags (READ/WRITE/...)
151 */
152struct iommu_dm_region {
153 struct list_head list;
154 phys_addr_t start;
155 size_t length;
156 int prot;
157};
158
Mitchel Humpherysc75ae492015-07-15 18:27:36 -0700159extern struct dentry *iommu_debugfs_top;
160
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200161#ifdef CONFIG_IOMMU_API
162
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200163/**
164 * struct iommu_ops - iommu ops and capabilities
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900165 * @capable: check capability
166 * @domain_alloc: allocate iommu domain
167 * @domain_free: free iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200168 * @attach_dev: attach device to an iommu domain
169 * @detach_dev: detach device from an iommu domain
170 * @map: map a physically contiguous memory region to an iommu domain
171 * @unmap: unmap a physically contiguous memory region from an iommu domain
Olav Haugan315786e2014-10-25 09:55:16 -0700172 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
173 * to an iommu domain
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200174 * @iova_to_phys: translate iova to physical address
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700175 * @iova_to_phys_hard: translate iova to physical address using IOMMU hardware
Alex Williamsond72e31c2012-05-30 14:18:53 -0600176 * @add_device: add device to iommu grouping
177 * @remove_device: remove device from iommu grouping
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900178 * @device_group: find iommu group for a particular device
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100179 * @domain_get_attr: Query domain attributes
180 * @domain_set_attr: Change domain attributes
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900181 * @get_dm_regions: Request list of direct mapping requirements for a device
182 * @put_dm_regions: Free list of direct mapping requirements for a device
Joerg Roedel33b21a62016-07-05 13:07:53 +0200183 * @apply_dm_region: Temporary helper call-back for iova reserved ranges
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900184 * @domain_window_enable: Configure and enable a particular window for a domain
185 * @domain_window_disable: Disable a particular window for a domain
186 * @domain_set_windows: Set the number of windows for a domain
187 * @domain_get_windows: Return the number of windows for a domain
Will Deacond0f60a42014-08-27 16:15:59 +0100188 * @of_xlate: add OF master IDs to iommu grouping
Robin Murphyd16e0fa2016-04-07 18:42:06 +0100189 * @pgsize_bitmap: bitmap of all possible supported page sizes
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700190 * @trigger_fault: trigger a fault on the device attached to an iommu domain
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700191 * @reg_read: read an IOMMU register
192 * @reg_write: write an IOMMU register
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800193 * @tlbi_domain: Invalidate all TLBs covering an iommu domain
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800194 * @enable_config_clocks: Enable all config clocks for this domain's IOMMU
195 * @disable_config_clocks: Disable all config clocks for this domain's IOMMU
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200196 */
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100197struct iommu_ops {
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200198 bool (*capable)(enum iommu_cap);
Joerg Roedel938c4702015-03-26 13:43:04 +0100199
200 /* Domain allocation and freeing by the iommu driver */
Joerg Roedel8539c7c2015-03-26 13:43:05 +0100201 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
Joerg Roedel938c4702015-03-26 13:43:04 +0100202 void (*domain_free)(struct iommu_domain *);
203
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100204 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
205 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
Joerg Roedel67651782010-01-21 16:32:27 +0100206 int (*map)(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen50090652011-11-10 11:32:25 +0200207 phys_addr_t paddr, size_t size, int prot);
208 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
209 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700210 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
211 struct scatterlist *sg, unsigned int nents, int prot);
Varun Sethibb5547ac2013-03-29 01:23:58 +0530212 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700213 phys_addr_t (*iova_to_phys_hard)(struct iommu_domain *domain,
214 dma_addr_t iova);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600215 int (*add_device)(struct device *dev);
216 void (*remove_device)(struct device *dev);
Joerg Roedel46c6b2b2015-10-21 23:51:36 +0200217 struct iommu_group *(*device_group)(struct device *dev);
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100218 int (*domain_get_attr)(struct iommu_domain *domain,
219 enum iommu_attr attr, void *data);
220 int (*domain_set_attr)(struct iommu_domain *domain,
221 enum iommu_attr attr, void *data);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100222
Joerg Roedela1015c22015-05-28 18:41:33 +0200223 /* Request/Free a list of direct mapping requirements for a device */
224 void (*get_dm_regions)(struct device *dev, struct list_head *list);
225 void (*put_dm_regions)(struct device *dev, struct list_head *list);
Joerg Roedel33b21a62016-07-05 13:07:53 +0200226 void (*apply_dm_region)(struct device *dev, struct iommu_domain *domain,
227 struct iommu_dm_region *region);
Joerg Roedela1015c22015-05-28 18:41:33 +0200228
Joerg Roedeld7787d52013-01-29 14:26:20 +0100229 /* Window handling functions */
230 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530231 phys_addr_t paddr, u64 size, int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100232 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900233 /* Set the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100234 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
Magnus Damm0d9bacb2016-01-19 14:28:48 +0900235 /* Get the number of windows per domain */
Joerg Roedel69356712013-02-04 14:00:01 +0100236 u32 (*domain_get_windows)(struct iommu_domain *domain);
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700237 void (*trigger_fault)(struct iommu_domain *domain, unsigned long flags);
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700238 unsigned long (*reg_read)(struct iommu_domain *domain,
239 unsigned long offset);
240 void (*reg_write)(struct iommu_domain *domain, unsigned long val,
241 unsigned long offset);
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800242 void (*tlbi_domain)(struct iommu_domain *domain);
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800243 int (*enable_config_clocks)(struct iommu_domain *domain);
244 void (*disable_config_clocks)(struct iommu_domain *domain);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100245
Will Deacond0f60a42014-08-27 16:15:59 +0100246 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
Will Deacond0f60a42014-08-27 16:15:59 +0100247
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200248 unsigned long pgsize_bitmap;
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100249};
250
Alex Williamsond72e31c2012-05-30 14:18:53 -0600251#define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
252#define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
253#define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
254#define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
255#define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
256#define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
257
Thierry Redingb22f6432014-06-27 09:03:12 +0200258extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
Joerg Roedela1b60c12011-09-06 18:46:34 +0200259extern bool iommu_present(struct bus_type *bus);
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200260extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
Joerg Roedel905d66c2011-09-06 16:03:26 +0200261extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
Alexey Kardashevskiyaa16bea2013-03-25 10:23:49 +1100262extern struct iommu_group *iommu_group_get_by_id(int id);
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100263extern void iommu_domain_free(struct iommu_domain *domain);
264extern int iommu_attach_device(struct iommu_domain *domain,
265 struct device *dev);
266extern void iommu_detach_device(struct iommu_domain *domain,
267 struct device *dev);
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200268extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
Mitchel Humpherysfad25922015-05-01 17:13:21 -0700269extern size_t iommu_pgsize(unsigned long pgsize_bitmap,
270 unsigned long addr_merge, size_t size);
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100271extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
Ohad Ben-Cohen7d3002c2011-11-10 11:32:26 +0200272 phys_addr_t paddr, size_t size, int prot);
273extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
274 size_t size);
Olav Haugan315786e2014-10-25 09:55:16 -0700275extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
276 struct scatterlist *sg,unsigned int nents,
277 int prot);
Varun Sethibb5547ac2013-03-29 01:23:58 +0530278extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700279extern phys_addr_t iommu_iova_to_phys_hard(struct iommu_domain *domain,
280 dma_addr_t iova);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400281extern void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300282 iommu_fault_handler_t handler, void *token);
Alex Williamsond72e31c2012-05-30 14:18:53 -0600283
Joerg Roedela1015c22015-05-28 18:41:33 +0200284extern void iommu_get_dm_regions(struct device *dev, struct list_head *list);
285extern void iommu_put_dm_regions(struct device *dev, struct list_head *list);
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200286extern int iommu_request_dm_for_dev(struct device *dev);
Joerg Roedela1015c22015-05-28 18:41:33 +0200287
Alex Williamsond72e31c2012-05-30 14:18:53 -0600288extern int iommu_attach_group(struct iommu_domain *domain,
289 struct iommu_group *group);
290extern void iommu_detach_group(struct iommu_domain *domain,
291 struct iommu_group *group);
292extern struct iommu_group *iommu_group_alloc(void);
293extern void *iommu_group_get_iommudata(struct iommu_group *group);
294extern void iommu_group_set_iommudata(struct iommu_group *group,
295 void *iommu_data,
296 void (*release)(void *iommu_data));
297extern int iommu_group_set_name(struct iommu_group *group, const char *name);
298extern int iommu_group_add_device(struct iommu_group *group,
299 struct device *dev);
300extern void iommu_group_remove_device(struct device *dev);
301extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
302 int (*fn)(struct device *, void *));
303extern struct iommu_group *iommu_group_get(struct device *dev);
304extern void iommu_group_put(struct iommu_group *group);
305extern int iommu_group_register_notifier(struct iommu_group *group,
306 struct notifier_block *nb);
307extern int iommu_group_unregister_notifier(struct iommu_group *group,
308 struct notifier_block *nb);
309extern int iommu_group_id(struct iommu_group *group);
Alex Williamson104a1c12014-07-03 09:51:18 -0600310extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
Joerg Roedel6827ca82015-05-28 18:41:35 +0200311extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400312
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100313extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
314 void *data);
315extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
316 void *data);
Alex Williamsonc61959e2014-06-12 16:12:24 -0600317struct device *iommu_device_create(struct device *parent, void *drvdata,
318 const struct attribute_group **groups,
Nicolas Iooss8db14862015-07-17 16:23:42 -0700319 const char *fmt, ...) __printf(4, 5);
Alex Williamsonc61959e2014-06-12 16:12:24 -0600320void iommu_device_destroy(struct device *dev);
321int iommu_device_link(struct device *dev, struct device *link);
322void iommu_device_unlink(struct device *dev, struct device *link);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400323
Joerg Roedeld7787d52013-01-29 14:26:20 +0100324/* Window handling function prototypes */
325extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530326 phys_addr_t offset, u64 size,
327 int prot);
Joerg Roedeld7787d52013-01-29 14:26:20 +0100328extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400329/**
330 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
331 * @domain: the iommu domain where the fault has happened
332 * @dev: the device where the fault has happened
333 * @iova: the faulting address
334 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
335 *
336 * This function should be called by the low-level IOMMU implementations
337 * whenever IOMMU faults happen, to allow high-level users, that are
338 * interested in such events, to know about them.
339 *
340 * This event may be useful for several possible use cases:
341 * - mere logging of the event
342 * - dynamic TLB/PTE loading
343 * - if restarting of the faulting device is required
344 *
345 * Returns 0 on success and an appropriate error code otherwise (if dynamic
346 * PTE/TLB loading will one day be supported, implementations will be able
347 * to tell whether it succeeded or not according to this return value).
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400348 *
349 * Specifically, -ENOSYS is returned if a fault handler isn't installed
350 * (though fault handlers can also return -ENOSYS, in case they want to
351 * elicit the default behavior of the IOMMU drivers).
Sushmita Susheelendra5e36b912015-06-02 15:46:24 -0600352
353 * Client fault handler returns -EBUSY to signal to the IOMMU driver
354 * that the client will take responsibility for any further fault
355 * handling, including clearing fault status registers or retrying
356 * the faulting transaction.
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400357 */
358static inline int report_iommu_fault(struct iommu_domain *domain,
359 struct device *dev, unsigned long iova, int flags)
360{
Ohad Ben-Cohen0ed6d2d2011-09-27 07:36:40 -0400361 int ret = -ENOSYS;
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400362
363 /*
364 * if upper layers showed interest and installed a fault handler,
365 * invoke it.
366 */
367 if (domain->handler)
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300368 ret = domain->handler(domain, dev, iova, flags,
369 domain->handler_token);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400370
Shuah Khan56fa4842013-09-24 15:21:20 -0600371 trace_io_page_fault(dev, iova, flags);
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400372 return ret;
373}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100374
Olav Haugan315786e2014-10-25 09:55:16 -0700375static inline size_t iommu_map_sg(struct iommu_domain *domain,
376 unsigned long iova, struct scatterlist *sg,
377 unsigned int nents, int prot)
378{
379 return domain->ops->map_sg(domain, iova, sg, nents, prot);
380}
381
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700382extern void iommu_trigger_fault(struct iommu_domain *domain,
383 unsigned long flags);
384
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700385extern unsigned long iommu_reg_read(struct iommu_domain *domain,
386 unsigned long offset);
387extern void iommu_reg_write(struct iommu_domain *domain, unsigned long offset,
388 unsigned long val);
Joerg Roedel5e622922015-10-21 23:51:37 +0200389/* PCI device grouping function */
390extern struct iommu_group *pci_device_group(struct device *dev);
Joerg Roedel6eab5562015-10-21 23:51:38 +0200391/* Generic device grouping function */
392extern struct iommu_group *generic_device_group(struct device *dev);
Joerg Roedel5e622922015-10-21 23:51:37 +0200393
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800394static inline void iommu_tlbiall(struct iommu_domain *domain)
395{
396 if (domain->ops->tlbi_domain)
397 domain->ops->tlbi_domain(domain);
398}
399
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800400static inline int iommu_enable_config_clocks(struct iommu_domain *domain)
401{
402 if (domain->ops->enable_config_clocks)
403 return domain->ops->enable_config_clocks(domain);
404 return 0;
405}
406
407static inline void iommu_disable_config_clocks(struct iommu_domain *domain)
408{
409 if (domain->ops->disable_config_clocks)
410 domain->ops->disable_config_clocks(domain);
411}
412
Robin Murphy57f98d22016-09-13 10:54:14 +0100413/**
414 * struct iommu_fwspec - per-device IOMMU instance data
415 * @ops: ops for this device's IOMMU
416 * @iommu_fwnode: firmware handle for this device's IOMMU
417 * @iommu_priv: IOMMU driver private data for this device
418 * @num_ids: number of associated device IDs
419 * @ids: IDs which this device may present to the IOMMU
420 */
421struct iommu_fwspec {
422 const struct iommu_ops *ops;
423 struct fwnode_handle *iommu_fwnode;
424 void *iommu_priv;
425 unsigned int num_ids;
426 u32 ids[1];
427};
428
429int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
430 const struct iommu_ops *ops);
431void iommu_fwspec_free(struct device *dev);
432int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
433
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100434#else /* CONFIG_IOMMU_API */
435
Joerg Roedel39d4ebb2011-09-06 16:48:40 +0200436struct iommu_ops {};
Alex Williamsond72e31c2012-05-30 14:18:53 -0600437struct iommu_group {};
Robin Murphy57f98d22016-09-13 10:54:14 +0100438struct iommu_fwspec {};
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100439
Joerg Roedela1b60c12011-09-06 18:46:34 +0200440static inline bool iommu_present(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100441{
442 return false;
443}
444
Joerg Roedel3c0e0ca2014-09-03 18:47:25 +0200445static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
446{
447 return false;
448}
449
Joerg Roedel905d66c2011-09-06 16:03:26 +0200450static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100451{
452 return NULL;
453}
454
Alexey Kardashevskiyb62dfd22013-11-21 17:41:14 +1100455static inline struct iommu_group *iommu_group_get_by_id(int id)
456{
457 return NULL;
458}
459
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100460static inline void iommu_domain_free(struct iommu_domain *domain)
461{
462}
463
464static inline int iommu_attach_device(struct iommu_domain *domain,
465 struct device *dev)
466{
467 return -ENODEV;
468}
469
470static inline void iommu_detach_device(struct iommu_domain *domain,
471 struct device *dev)
472{
473}
474
Joerg Roedel2c1296d2015-05-28 18:41:32 +0200475static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
476{
477 return NULL;
478}
479
Joerg Roedelcefc53c2010-01-08 13:35:09 +0100480static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
481 phys_addr_t paddr, int gfp_order, int prot)
482{
483 return -ENODEV;
484}
485
486static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
487 int gfp_order)
488{
489 return -ENODEV;
490}
491
Olav Haugan315786e2014-10-25 09:55:16 -0700492static inline size_t iommu_map_sg(struct iommu_domain *domain,
493 unsigned long iova, struct scatterlist *sg,
494 unsigned int nents, int prot)
495{
496 return -ENODEV;
497}
498
Joerg Roedeld7787d52013-01-29 14:26:20 +0100499static inline int iommu_domain_window_enable(struct iommu_domain *domain,
500 u32 wnd_nr, phys_addr_t paddr,
Varun Sethi80f97f02013-03-29 01:24:00 +0530501 u64 size, int prot)
Joerg Roedeld7787d52013-01-29 14:26:20 +0100502{
503 return -ENODEV;
504}
505
506static inline void iommu_domain_window_disable(struct iommu_domain *domain,
507 u32 wnd_nr)
508{
509}
510
Varun Sethibb5547ac2013-03-29 01:23:58 +0530511static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100512{
513 return 0;
514}
515
Mitchel Humpherys36b8c322015-07-06 15:24:22 -0700516static inline phys_addr_t iommu_iova_to_phys_hard(struct iommu_domain *domain,
517 dma_addr_t iova)
518{
519 return 0;
520}
521
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400522static inline void iommu_set_fault_handler(struct iommu_domain *domain,
Ohad Ben-Cohen77ca2332012-05-21 20:20:05 +0300523 iommu_fault_handler_t handler, void *token)
Ohad Ben-Cohen4f3f8d92011-09-13 15:25:23 -0400524{
525}
526
Joerg Roedela1015c22015-05-28 18:41:33 +0200527static inline void iommu_get_dm_regions(struct device *dev,
528 struct list_head *list)
529{
530}
531
532static inline void iommu_put_dm_regions(struct device *dev,
533 struct list_head *list)
534{
535}
536
Joerg Roedeld290f1e2015-05-28 18:41:36 +0200537static inline int iommu_request_dm_for_dev(struct device *dev)
538{
539 return -ENODEV;
540}
541
Alex Williamsonbef83de2012-09-24 21:23:25 -0600542static inline int iommu_attach_group(struct iommu_domain *domain,
543 struct iommu_group *group)
Alex Williamson14604322011-10-21 15:56:05 -0400544{
545 return -ENODEV;
546}
547
Alex Williamsonbef83de2012-09-24 21:23:25 -0600548static inline void iommu_detach_group(struct iommu_domain *domain,
549 struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600550{
551}
552
Alex Williamsonbef83de2012-09-24 21:23:25 -0600553static inline struct iommu_group *iommu_group_alloc(void)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600554{
555 return ERR_PTR(-ENODEV);
556}
557
Alex Williamsonbef83de2012-09-24 21:23:25 -0600558static inline void *iommu_group_get_iommudata(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600559{
560 return NULL;
561}
562
Alex Williamsonbef83de2012-09-24 21:23:25 -0600563static inline void iommu_group_set_iommudata(struct iommu_group *group,
564 void *iommu_data,
565 void (*release)(void *iommu_data))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600566{
567}
568
Alex Williamsonbef83de2012-09-24 21:23:25 -0600569static inline int iommu_group_set_name(struct iommu_group *group,
570 const char *name)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600571{
572 return -ENODEV;
573}
574
Alex Williamsonbef83de2012-09-24 21:23:25 -0600575static inline int iommu_group_add_device(struct iommu_group *group,
576 struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600577{
578 return -ENODEV;
579}
580
Alex Williamsonbef83de2012-09-24 21:23:25 -0600581static inline void iommu_group_remove_device(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600582{
583}
584
Alex Williamsonbef83de2012-09-24 21:23:25 -0600585static inline int iommu_group_for_each_dev(struct iommu_group *group,
586 void *data,
587 int (*fn)(struct device *, void *))
Alex Williamsond72e31c2012-05-30 14:18:53 -0600588{
589 return -ENODEV;
590}
591
Alex Williamsonbef83de2012-09-24 21:23:25 -0600592static inline struct iommu_group *iommu_group_get(struct device *dev)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600593{
594 return NULL;
595}
596
Alex Williamsonbef83de2012-09-24 21:23:25 -0600597static inline void iommu_group_put(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600598{
599}
600
Alex Williamsonbef83de2012-09-24 21:23:25 -0600601static inline int iommu_group_register_notifier(struct iommu_group *group,
602 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600603{
604 return -ENODEV;
605}
606
Alex Williamsonbef83de2012-09-24 21:23:25 -0600607static inline int iommu_group_unregister_notifier(struct iommu_group *group,
608 struct notifier_block *nb)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600609{
610 return 0;
611}
612
Alex Williamsonbef83de2012-09-24 21:23:25 -0600613static inline int iommu_group_id(struct iommu_group *group)
Alex Williamsond72e31c2012-05-30 14:18:53 -0600614{
615 return -ENODEV;
616}
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100617
Joerg Roedel0cd76dd2012-01-26 19:40:52 +0100618static inline int iommu_domain_get_attr(struct iommu_domain *domain,
619 enum iommu_attr attr, void *data)
620{
621 return -EINVAL;
622}
623
624static inline int iommu_domain_set_attr(struct iommu_domain *domain,
625 enum iommu_attr attr, void *data)
626{
627 return -EINVAL;
628}
629
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600630static inline struct device *iommu_device_create(struct device *parent,
631 void *drvdata,
632 const struct attribute_group **groups,
633 const char *fmt, ...)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600634{
635 return ERR_PTR(-ENODEV);
636}
637
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600638static inline void iommu_device_destroy(struct device *dev)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600639{
640}
641
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600642static inline int iommu_device_link(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600643{
644 return -EINVAL;
645}
646
Alex Williamsone09f8ea52014-07-07 14:31:36 -0600647static inline void iommu_device_unlink(struct device *dev, struct device *link)
Alex Williamsonc61959e2014-06-12 16:12:24 -0600648{
649}
650
Mitchel Humpherys8488df22015-07-09 16:59:02 -0700651static inline void iommu_trigger_fault(struct iommu_domain *domain,
652 unsigned long flags)
653{
654}
655
Mitchel Humpherys3ede5d92015-08-21 14:06:14 -0700656static inline unsigned long iommu_reg_read(struct iommu_domain *domain,
657 unsigned long offset)
658{
659 return 0;
660}
661
662static inline void iommu_reg_write(struct iommu_domain *domain,
663 unsigned long val, unsigned long offset)
664{
665}
666
Mitchel Humpherys39bad0c2015-12-03 11:17:23 -0800667static inline void iommu_tlbiall(struct iommu_domain *domain)
668{
669}
670
Mitchel Humpherys4264f192015-12-14 16:04:46 -0800671static inline int iommu_enable_config_clocks(struct iommu_domain *domain)
672{
673 return 0;
674}
675
676static inline void iommu_disable_config_clocks(struct iommu_domain *domain)
677{
678}
679
Robin Murphy57f98d22016-09-13 10:54:14 +0100680static inline int iommu_fwspec_init(struct device *dev,
681 struct fwnode_handle *iommu_fwnode,
682 const struct iommu_ops *ops)
683{
684 return -ENODEV;
685}
686
687static inline void iommu_fwspec_free(struct device *dev)
688{
689}
690
691static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
692 int num_ids)
693{
694 return -ENODEV;
695}
696
Joerg Roedel4a77a6c2008-11-26 17:02:33 +0100697#endif /* CONFIG_IOMMU_API */
698
699#endif /* __LINUX_IOMMU_H */