2 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
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.
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.
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
19 #ifndef __LINUX_IOMMU_H
20 #define __LINUX_IOMMU_H
22 #include <linux/errno.h>
23 #include <linux/err.h>
25 #include <linux/types.h>
26 #include <linux/scatterlist.h>
27 #include <trace/events/iommu.h>
29 #define IOMMU_READ (1 << 0)
30 #define IOMMU_WRITE (1 << 1)
31 #define IOMMU_CACHE (1 << 2) /* DMA cache coherency */
32 #define IOMMU_NOEXEC (1 << 3)
33 #define IOMMU_MMIO (1 << 4) /* e.g. things like MSI doorbells */
40 struct notifier_block;
42 /* iommu fault flags */
43 #define IOMMU_FAULT_READ 0x0
44 #define IOMMU_FAULT_WRITE 0x1
46 typedef int (*iommu_fault_handler_t)(struct iommu_domain *,
47 struct device *, unsigned long, int, void *);
49 struct iommu_domain_geometry {
50 dma_addr_t aperture_start; /* First address that can be mapped */
51 dma_addr_t aperture_end; /* Last address that can be mapped */
52 bool force_aperture; /* DMA only allowed in mappable range? */
55 /* Domain feature flags */
56 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
57 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
59 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
62 * This are the possible domain-types
64 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
66 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
67 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
69 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
70 * This flag allows IOMMU drivers to implement
71 * certain optimizations for these domains
73 #define IOMMU_DOMAIN_BLOCKED (0U)
74 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
75 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
76 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
77 __IOMMU_DOMAIN_DMA_API)
81 const struct iommu_ops *ops;
82 unsigned long pgsize_bitmap; /* Bitmap of page sizes in use */
83 iommu_fault_handler_t handler;
85 struct iommu_domain_geometry geometry;
90 IOMMU_CAP_CACHE_COHERENCY, /* IOMMU can enforce cache coherent DMA
92 IOMMU_CAP_INTR_REMAP, /* IOMMU supports interrupt isolation */
93 IOMMU_CAP_NOEXEC, /* IOMMU_NOEXEC flag */
97 * Following constraints are specifc to FSL_PAMUV1:
98 * -aperture must be power of 2, and naturally aligned
99 * -number of windows must be power of 2, and address space size
100 * of each window is determined by aperture size / # of windows
101 * -the actual size of the mapped region of a window must be power
102 * of 2 starting with 4KB and physical address must be naturally
104 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
105 * The caller can invoke iommu_domain_get_attr to check if the underlying
106 * iommu implementation supports these constraints.
110 DOMAIN_ATTR_GEOMETRY,
113 DOMAIN_ATTR_FSL_PAMU_STASH,
114 DOMAIN_ATTR_FSL_PAMU_ENABLE,
115 DOMAIN_ATTR_FSL_PAMUV1,
116 DOMAIN_ATTR_NESTING, /* two stages of translation */
121 * struct iommu_dm_region - descriptor for a direct mapped memory region
122 * @list: Linked list pointers
123 * @start: System physical start address of the region
124 * @length: Length of the region in bytes
125 * @prot: IOMMU Protection flags (READ/WRITE/...)
127 struct iommu_dm_region {
128 struct list_head list;
134 #ifdef CONFIG_IOMMU_API
137 * struct iommu_ops - iommu ops and capabilities
138 * @capable: check capability
139 * @domain_alloc: allocate iommu domain
140 * @domain_free: free iommu domain
141 * @attach_dev: attach device to an iommu domain
142 * @detach_dev: detach device from an iommu domain
143 * @map: map a physically contiguous memory region to an iommu domain
144 * @unmap: unmap a physically contiguous memory region from an iommu domain
145 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
147 * @iova_to_phys: translate iova to physical address
148 * @add_device: add device to iommu grouping
149 * @remove_device: remove device from iommu grouping
150 * @device_group: find iommu group for a particular device
151 * @domain_get_attr: Query domain attributes
152 * @domain_set_attr: Change domain attributes
153 * @get_dm_regions: Request list of direct mapping requirements for a device
154 * @put_dm_regions: Free list of direct mapping requirements for a device
155 * @apply_dm_region: Temporary helper call-back for iova reserved ranges
156 * @domain_window_enable: Configure and enable a particular window for a domain
157 * @domain_window_disable: Disable a particular window for a domain
158 * @domain_set_windows: Set the number of windows for a domain
159 * @domain_get_windows: Return the number of windows for a domain
160 * @of_xlate: add OF master IDs to iommu grouping
161 * @pgsize_bitmap: bitmap of all possible supported page sizes
164 bool (*capable)(enum iommu_cap);
166 /* Domain allocation and freeing by the iommu driver */
167 struct iommu_domain *(*domain_alloc)(unsigned iommu_domain_type);
168 void (*domain_free)(struct iommu_domain *);
170 int (*attach_dev)(struct iommu_domain *domain, struct device *dev);
171 void (*detach_dev)(struct iommu_domain *domain, struct device *dev);
172 int (*map)(struct iommu_domain *domain, unsigned long iova,
173 phys_addr_t paddr, size_t size, int prot);
174 size_t (*unmap)(struct iommu_domain *domain, unsigned long iova,
176 size_t (*map_sg)(struct iommu_domain *domain, unsigned long iova,
177 struct scatterlist *sg, unsigned int nents, int prot);
178 phys_addr_t (*iova_to_phys)(struct iommu_domain *domain, dma_addr_t iova);
179 int (*add_device)(struct device *dev);
180 void (*remove_device)(struct device *dev);
181 struct iommu_group *(*device_group)(struct device *dev);
182 int (*domain_get_attr)(struct iommu_domain *domain,
183 enum iommu_attr attr, void *data);
184 int (*domain_set_attr)(struct iommu_domain *domain,
185 enum iommu_attr attr, void *data);
187 /* Request/Free a list of direct mapping requirements for a device */
188 void (*get_dm_regions)(struct device *dev, struct list_head *list);
189 void (*put_dm_regions)(struct device *dev, struct list_head *list);
190 void (*apply_dm_region)(struct device *dev, struct iommu_domain *domain,
191 struct iommu_dm_region *region);
193 /* Window handling functions */
194 int (*domain_window_enable)(struct iommu_domain *domain, u32 wnd_nr,
195 phys_addr_t paddr, u64 size, int prot);
196 void (*domain_window_disable)(struct iommu_domain *domain, u32 wnd_nr);
197 /* Set the number of windows per domain */
198 int (*domain_set_windows)(struct iommu_domain *domain, u32 w_count);
199 /* Get the number of windows per domain */
200 u32 (*domain_get_windows)(struct iommu_domain *domain);
202 int (*of_xlate)(struct device *dev, struct of_phandle_args *args);
204 unsigned long pgsize_bitmap;
208 * struct iommu_device - IOMMU core representation of one IOMMU hardware
210 * @list: Used by the iommu-core to keep a list of registered iommus
211 * @ops: iommu-ops for talking to this iommu
212 * @dev: struct device for sysfs handling
214 struct iommu_device {
215 struct list_head list;
216 const struct iommu_ops *ops;
217 struct fwnode_handle *fwnode;
221 int iommu_device_register(struct iommu_device *iommu);
222 void iommu_device_unregister(struct iommu_device *iommu);
223 int iommu_device_sysfs_add(struct iommu_device *iommu,
224 struct device *parent,
225 const struct attribute_group **groups,
226 const char *fmt, ...) __printf(4, 5);
227 void iommu_device_sysfs_remove(struct iommu_device *iommu);
228 int iommu_device_link(struct iommu_device *iommu, struct device *link);
229 void iommu_device_unlink(struct iommu_device *iommu, struct device *link);
231 static inline void iommu_device_set_ops(struct iommu_device *iommu,
232 const struct iommu_ops *ops)
237 static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
238 struct fwnode_handle *fwnode)
240 iommu->fwnode = fwnode;
243 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
244 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
245 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
246 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
247 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
248 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
250 extern int bus_set_iommu(struct bus_type *bus, const struct iommu_ops *ops);
251 extern bool iommu_present(struct bus_type *bus);
252 extern bool iommu_capable(struct bus_type *bus, enum iommu_cap cap);
253 extern struct iommu_domain *iommu_domain_alloc(struct bus_type *bus);
254 extern struct iommu_group *iommu_group_get_by_id(int id);
255 extern void iommu_domain_free(struct iommu_domain *domain);
256 extern int iommu_attach_device(struct iommu_domain *domain,
258 extern void iommu_detach_device(struct iommu_domain *domain,
260 extern struct iommu_domain *iommu_get_domain_for_dev(struct device *dev);
261 extern int iommu_map(struct iommu_domain *domain, unsigned long iova,
262 phys_addr_t paddr, size_t size, int prot);
263 extern size_t iommu_unmap(struct iommu_domain *domain, unsigned long iova,
265 extern size_t default_iommu_map_sg(struct iommu_domain *domain, unsigned long iova,
266 struct scatterlist *sg,unsigned int nents,
268 extern phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova);
269 extern void iommu_set_fault_handler(struct iommu_domain *domain,
270 iommu_fault_handler_t handler, void *token);
272 extern void iommu_get_dm_regions(struct device *dev, struct list_head *list);
273 extern void iommu_put_dm_regions(struct device *dev, struct list_head *list);
274 extern int iommu_request_dm_for_dev(struct device *dev);
276 extern int iommu_attach_group(struct iommu_domain *domain,
277 struct iommu_group *group);
278 extern void iommu_detach_group(struct iommu_domain *domain,
279 struct iommu_group *group);
280 extern struct iommu_group *iommu_group_alloc(void);
281 extern void *iommu_group_get_iommudata(struct iommu_group *group);
282 extern void iommu_group_set_iommudata(struct iommu_group *group,
284 void (*release)(void *iommu_data));
285 extern int iommu_group_set_name(struct iommu_group *group, const char *name);
286 extern int iommu_group_add_device(struct iommu_group *group,
288 extern void iommu_group_remove_device(struct device *dev);
289 extern int iommu_group_for_each_dev(struct iommu_group *group, void *data,
290 int (*fn)(struct device *, void *));
291 extern struct iommu_group *iommu_group_get(struct device *dev);
292 extern struct iommu_group *iommu_group_ref_get(struct iommu_group *group);
293 extern void iommu_group_put(struct iommu_group *group);
294 extern int iommu_group_register_notifier(struct iommu_group *group,
295 struct notifier_block *nb);
296 extern int iommu_group_unregister_notifier(struct iommu_group *group,
297 struct notifier_block *nb);
298 extern int iommu_group_id(struct iommu_group *group);
299 extern struct iommu_group *iommu_group_get_for_dev(struct device *dev);
300 extern struct iommu_domain *iommu_group_default_domain(struct iommu_group *);
302 extern int iommu_domain_get_attr(struct iommu_domain *domain, enum iommu_attr,
304 extern int iommu_domain_set_attr(struct iommu_domain *domain, enum iommu_attr,
307 /* Window handling function prototypes */
308 extern int iommu_domain_window_enable(struct iommu_domain *domain, u32 wnd_nr,
309 phys_addr_t offset, u64 size,
311 extern void iommu_domain_window_disable(struct iommu_domain *domain, u32 wnd_nr);
313 * report_iommu_fault() - report about an IOMMU fault to the IOMMU framework
314 * @domain: the iommu domain where the fault has happened
315 * @dev: the device where the fault has happened
316 * @iova: the faulting address
317 * @flags: mmu fault flags (e.g. IOMMU_FAULT_READ/IOMMU_FAULT_WRITE/...)
319 * This function should be called by the low-level IOMMU implementations
320 * whenever IOMMU faults happen, to allow high-level users, that are
321 * interested in such events, to know about them.
323 * This event may be useful for several possible use cases:
324 * - mere logging of the event
325 * - dynamic TLB/PTE loading
326 * - if restarting of the faulting device is required
328 * Returns 0 on success and an appropriate error code otherwise (if dynamic
329 * PTE/TLB loading will one day be supported, implementations will be able
330 * to tell whether it succeeded or not according to this return value).
332 * Specifically, -ENOSYS is returned if a fault handler isn't installed
333 * (though fault handlers can also return -ENOSYS, in case they want to
334 * elicit the default behavior of the IOMMU drivers).
336 static inline int report_iommu_fault(struct iommu_domain *domain,
337 struct device *dev, unsigned long iova, int flags)
342 * if upper layers showed interest and installed a fault handler,
346 ret = domain->handler(domain, dev, iova, flags,
347 domain->handler_token);
349 trace_io_page_fault(dev, iova, flags);
353 static inline size_t iommu_map_sg(struct iommu_domain *domain,
354 unsigned long iova, struct scatterlist *sg,
355 unsigned int nents, int prot)
357 return domain->ops->map_sg(domain, iova, sg, nents, prot);
360 /* PCI device grouping function */
361 extern struct iommu_group *pci_device_group(struct device *dev);
362 /* Generic device grouping function */
363 extern struct iommu_group *generic_device_group(struct device *dev);
366 * struct iommu_fwspec - per-device IOMMU instance data
367 * @ops: ops for this device's IOMMU
368 * @iommu_fwnode: firmware handle for this device's IOMMU
369 * @iommu_priv: IOMMU driver private data for this device
370 * @num_ids: number of associated device IDs
371 * @ids: IDs which this device may present to the IOMMU
373 struct iommu_fwspec {
374 const struct iommu_ops *ops;
375 struct fwnode_handle *iommu_fwnode;
377 unsigned int num_ids;
381 int iommu_fwspec_init(struct device *dev, struct fwnode_handle *iommu_fwnode,
382 const struct iommu_ops *ops);
383 void iommu_fwspec_free(struct device *dev);
384 int iommu_fwspec_add_ids(struct device *dev, u32 *ids, int num_ids);
385 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode);
387 #else /* CONFIG_IOMMU_API */
390 struct iommu_group {};
391 struct iommu_fwspec {};
392 struct iommu_device {};
394 static inline bool iommu_present(struct bus_type *bus)
399 static inline bool iommu_capable(struct bus_type *bus, enum iommu_cap cap)
404 static inline struct iommu_domain *iommu_domain_alloc(struct bus_type *bus)
409 static inline struct iommu_group *iommu_group_get_by_id(int id)
414 static inline void iommu_domain_free(struct iommu_domain *domain)
418 static inline int iommu_attach_device(struct iommu_domain *domain,
424 static inline void iommu_detach_device(struct iommu_domain *domain,
429 static inline struct iommu_domain *iommu_get_domain_for_dev(struct device *dev)
434 static inline int iommu_map(struct iommu_domain *domain, unsigned long iova,
435 phys_addr_t paddr, int gfp_order, int prot)
440 static inline int iommu_unmap(struct iommu_domain *domain, unsigned long iova,
446 static inline size_t iommu_map_sg(struct iommu_domain *domain,
447 unsigned long iova, struct scatterlist *sg,
448 unsigned int nents, int prot)
453 static inline int iommu_domain_window_enable(struct iommu_domain *domain,
454 u32 wnd_nr, phys_addr_t paddr,
460 static inline void iommu_domain_window_disable(struct iommu_domain *domain,
465 static inline phys_addr_t iommu_iova_to_phys(struct iommu_domain *domain, dma_addr_t iova)
470 static inline void iommu_set_fault_handler(struct iommu_domain *domain,
471 iommu_fault_handler_t handler, void *token)
475 static inline void iommu_get_dm_regions(struct device *dev,
476 struct list_head *list)
480 static inline void iommu_put_dm_regions(struct device *dev,
481 struct list_head *list)
485 static inline int iommu_request_dm_for_dev(struct device *dev)
490 static inline int iommu_attach_group(struct iommu_domain *domain,
491 struct iommu_group *group)
496 static inline void iommu_detach_group(struct iommu_domain *domain,
497 struct iommu_group *group)
501 static inline struct iommu_group *iommu_group_alloc(void)
503 return ERR_PTR(-ENODEV);
506 static inline void *iommu_group_get_iommudata(struct iommu_group *group)
511 static inline void iommu_group_set_iommudata(struct iommu_group *group,
513 void (*release)(void *iommu_data))
517 static inline int iommu_group_set_name(struct iommu_group *group,
523 static inline int iommu_group_add_device(struct iommu_group *group,
529 static inline void iommu_group_remove_device(struct device *dev)
533 static inline int iommu_group_for_each_dev(struct iommu_group *group,
535 int (*fn)(struct device *, void *))
540 static inline struct iommu_group *iommu_group_get(struct device *dev)
545 static inline void iommu_group_put(struct iommu_group *group)
549 static inline int iommu_group_register_notifier(struct iommu_group *group,
550 struct notifier_block *nb)
555 static inline int iommu_group_unregister_notifier(struct iommu_group *group,
556 struct notifier_block *nb)
561 static inline int iommu_group_id(struct iommu_group *group)
566 static inline int iommu_domain_get_attr(struct iommu_domain *domain,
567 enum iommu_attr attr, void *data)
572 static inline int iommu_domain_set_attr(struct iommu_domain *domain,
573 enum iommu_attr attr, void *data)
578 static inline int iommu_device_register(struct iommu_device *iommu)
583 static inline void iommu_device_set_ops(struct iommu_device *iommu,
584 const struct iommu_ops *ops)
588 static inline void iommu_device_set_fwnode(struct iommu_device *iommu,
589 struct fwnode_handle *fwnode)
593 static inline void iommu_device_unregister(struct iommu_device *iommu)
597 static inline int iommu_device_sysfs_add(struct iommu_device *iommu,
598 struct device *parent,
599 const struct attribute_group **groups,
600 const char *fmt, ...)
605 static inline void iommu_device_sysfs_remove(struct iommu_device *iommu)
609 static inline int iommu_device_link(struct device *dev, struct device *link)
614 static inline void iommu_device_unlink(struct device *dev, struct device *link)
618 static inline int iommu_fwspec_init(struct device *dev,
619 struct fwnode_handle *iommu_fwnode,
620 const struct iommu_ops *ops)
625 static inline void iommu_fwspec_free(struct device *dev)
629 static inline int iommu_fwspec_add_ids(struct device *dev, u32 *ids,
636 const struct iommu_ops *iommu_ops_from_fwnode(struct fwnode_handle *fwnode)
641 #endif /* CONFIG_IOMMU_API */
643 #endif /* __LINUX_IOMMU_H */