2 * Copyright (C) 2007-2008 Advanced Micro Devices, Inc.
3 * Author: Joerg Roedel <joerg.roedel@amd.com>
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/scatterlist.h>
23 #include <linux/device.h>
24 #include <linux/types.h>
25 #include <linux/errno.h>
26 #include <linux/err.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 */
35 * Where the bus hardware includes a privilege level as part of its access type
36 * markings, and certain devices are capable of issuing transactions marked as
37 * either 'supervisor' or 'user', the IOMMU_PRIV flag requests that the other
38 * given permission flags only apply to accesses at the higher privilege level,
39 * and that unprivileged transactions should have as little access as possible.
40 * This would usually imply the same permissions as kernel mappings on the CPU,
41 * if the IOMMU page table format is equivalent.
43 #define IOMMU_PRIV (1 << 5)
50 struct notifier_block
;
52 /* iommu fault flags */
53 #define IOMMU_FAULT_READ 0x0
54 #define IOMMU_FAULT_WRITE 0x1
56 typedef int (*iommu_fault_handler_t
)(struct iommu_domain
*,
57 struct device
*, unsigned long, int, void *);
59 struct iommu_domain_geometry
{
60 dma_addr_t aperture_start
; /* First address that can be mapped */
61 dma_addr_t aperture_end
; /* Last address that can be mapped */
62 bool force_aperture
; /* DMA only allowed in mappable range? */
65 /* Domain feature flags */
66 #define __IOMMU_DOMAIN_PAGING (1U << 0) /* Support for iommu_map/unmap */
67 #define __IOMMU_DOMAIN_DMA_API (1U << 1) /* Domain for use in DMA-API
69 #define __IOMMU_DOMAIN_PT (1U << 2) /* Domain is identity mapped */
72 * This are the possible domain-types
74 * IOMMU_DOMAIN_BLOCKED - All DMA is blocked, can be used to isolate
76 * IOMMU_DOMAIN_IDENTITY - DMA addresses are system physical addresses
77 * IOMMU_DOMAIN_UNMANAGED - DMA mappings managed by IOMMU-API user, used
79 * IOMMU_DOMAIN_DMA - Internally used for DMA-API implementations.
80 * This flag allows IOMMU drivers to implement
81 * certain optimizations for these domains
83 #define IOMMU_DOMAIN_BLOCKED (0U)
84 #define IOMMU_DOMAIN_IDENTITY (__IOMMU_DOMAIN_PT)
85 #define IOMMU_DOMAIN_UNMANAGED (__IOMMU_DOMAIN_PAGING)
86 #define IOMMU_DOMAIN_DMA (__IOMMU_DOMAIN_PAGING | \
87 __IOMMU_DOMAIN_DMA_API)
91 const struct iommu_ops
*ops
;
92 unsigned long pgsize_bitmap
; /* Bitmap of page sizes in use */
93 iommu_fault_handler_t handler
;
95 struct iommu_domain_geometry geometry
;
100 IOMMU_CAP_CACHE_COHERENCY
, /* IOMMU can enforce cache coherent DMA
102 IOMMU_CAP_INTR_REMAP
, /* IOMMU supports interrupt isolation */
103 IOMMU_CAP_NOEXEC
, /* IOMMU_NOEXEC flag */
107 * Following constraints are specifc to FSL_PAMUV1:
108 * -aperture must be power of 2, and naturally aligned
109 * -number of windows must be power of 2, and address space size
110 * of each window is determined by aperture size / # of windows
111 * -the actual size of the mapped region of a window must be power
112 * of 2 starting with 4KB and physical address must be naturally
114 * DOMAIN_ATTR_FSL_PAMUV1 corresponds to the above mentioned contraints.
115 * The caller can invoke iommu_domain_get_attr to check if the underlying
116 * iommu implementation supports these constraints.
120 DOMAIN_ATTR_GEOMETRY
,
123 DOMAIN_ATTR_FSL_PAMU_STASH
,
124 DOMAIN_ATTR_FSL_PAMU_ENABLE
,
125 DOMAIN_ATTR_FSL_PAMUV1
,
126 DOMAIN_ATTR_NESTING
, /* two stages of translation */
130 /* These are the possible reserved region types */
131 enum iommu_resv_type
{
132 /* Memory regions which must be mapped 1:1 at all times */
134 /* Arbitrary "never map this or give it to a device" address ranges */
136 /* Hardware MSI region (untranslated) */
138 /* Software-managed MSI translation window */
143 * struct iommu_resv_region - descriptor for a reserved memory region
144 * @list: Linked list pointers
145 * @start: System physical start address of the region
146 * @length: Length of the region in bytes
147 * @prot: IOMMU Protection flags (READ/WRITE/...)
148 * @type: Type of the reserved region
150 struct iommu_resv_region
{
151 struct list_head list
;
155 enum iommu_resv_type type
;
158 #ifdef CONFIG_IOMMU_API
161 * struct iommu_ops - iommu ops and capabilities
162 * @capable: check capability
163 * @domain_alloc: allocate iommu domain
164 * @domain_free: free iommu domain
165 * @attach_dev: attach device to an iommu domain
166 * @detach_dev: detach device from an iommu domain
167 * @map: map a physically contiguous memory region to an iommu domain
168 * @unmap: unmap a physically contiguous memory region from an iommu domain
169 * @flush_tlb_all: Synchronously flush all hardware TLBs for this domain
170 * @tlb_range_add: Add a given iova range to the flush queue for this domain
171 * @tlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
173 * @iova_to_phys: translate iova to physical address
174 * @add_device: add device to iommu grouping
175 * @remove_device: remove device from iommu grouping
176 * @device_group: find iommu group for a particular device
177 * @domain_get_attr: Query domain attributes
178 * @domain_set_attr: Change domain attributes
179 * @get_resv_regions: Request list of reserved regions for a device
180 * @put_resv_regions: Free list of reserved regions for a device
181 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
182 * @domain_window_enable: Configure and enable a particular window for a domain
183 * @domain_window_disable: Disable a particular window for a domain
184 * @domain_set_windows: Set the number of windows for a domain
185 * @domain_get_windows: Return the number of windows for a domain
186 * @of_xlate: add OF master IDs to iommu grouping
187 * @pgsize_bitmap: bitmap of all possible supported page sizes
190 bool (*capable
)(enum iommu_cap
);
192 /* Domain allocation and freeing by the iommu driver */
193 struct iommu_domain
*(*domain_alloc
)(unsigned iommu_domain_type
);
194 void (*domain_free
)(struct iommu_domain
*);
196 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
197 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
198 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
199 phys_addr_t paddr
, size_t size
, int prot
);
200 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
202 void (*flush_iotlb_all
)(struct iommu_domain
*domain
);
203 void (*iotlb_range_add
)(struct iommu_domain
*domain
,
204 unsigned long iova
, size_t size
);
205 void (*iotlb_sync
)(struct iommu_domain
*domain
);
206 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
207 int (*add_device
)(struct device
*dev
);
208 void (*remove_device
)(struct device
*dev
);
209 struct iommu_group
*(*device_group
)(struct device
*dev
);
210 int (*domain_get_attr
)(struct iommu_domain
*domain
,
211 enum iommu_attr attr
, void *data
);
212 int (*domain_set_attr
)(struct iommu_domain
*domain
,
213 enum iommu_attr attr
, void *data
);
215 /* Request/Free a list of reserved regions for a device */
216 void (*get_resv_regions
)(struct device
*dev
, struct list_head
*list
);
217 void (*put_resv_regions
)(struct device
*dev
, struct list_head
*list
);
218 void (*apply_resv_region
)(struct device
*dev
,
219 struct iommu_domain
*domain
,
220 struct iommu_resv_region
*region
);
222 /* Window handling functions */
223 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
224 phys_addr_t paddr
, u64 size
, int prot
);
225 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
226 /* Set the number of windows per domain */
227 int (*domain_set_windows
)(struct iommu_domain
*domain
, u32 w_count
);
228 /* Get the number of windows per domain */
229 u32 (*domain_get_windows
)(struct iommu_domain
*domain
);
231 int (*of_xlate
)(struct device
*dev
, struct of_phandle_args
*args
);
232 bool (*is_attach_deferred
)(struct iommu_domain
*domain
, struct device
*dev
);
234 unsigned long pgsize_bitmap
;
238 * struct iommu_device - IOMMU core representation of one IOMMU hardware
240 * @list: Used by the iommu-core to keep a list of registered iommus
241 * @ops: iommu-ops for talking to this iommu
242 * @dev: struct device for sysfs handling
244 struct iommu_device
{
245 struct list_head list
;
246 const struct iommu_ops
*ops
;
247 struct fwnode_handle
*fwnode
;
251 int iommu_device_register(struct iommu_device
*iommu
);
252 void iommu_device_unregister(struct iommu_device
*iommu
);
253 int iommu_device_sysfs_add(struct iommu_device
*iommu
,
254 struct device
*parent
,
255 const struct attribute_group
**groups
,
256 const char *fmt
, ...) __printf(4, 5);
257 void iommu_device_sysfs_remove(struct iommu_device
*iommu
);
258 int iommu_device_link(struct iommu_device
*iommu
, struct device
*link
);
259 void iommu_device_unlink(struct iommu_device
*iommu
, struct device
*link
);
261 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
262 const struct iommu_ops
*ops
)
267 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
268 struct fwnode_handle
*fwnode
)
270 iommu
->fwnode
= fwnode
;
273 static inline struct iommu_device
*dev_to_iommu_device(struct device
*dev
)
275 return (struct iommu_device
*)dev_get_drvdata(dev
);
278 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
279 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
280 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
281 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
282 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
283 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
285 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
286 extern bool iommu_present(struct bus_type
*bus
);
287 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
288 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
289 extern struct iommu_group
*iommu_group_get_by_id(int id
);
290 extern void iommu_domain_free(struct iommu_domain
*domain
);
291 extern int iommu_attach_device(struct iommu_domain
*domain
,
293 extern void iommu_detach_device(struct iommu_domain
*domain
,
295 extern struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
);
296 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
297 phys_addr_t paddr
, size_t size
, int prot
);
298 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
300 extern size_t iommu_unmap_fast(struct iommu_domain
*domain
,
301 unsigned long iova
, size_t size
);
302 extern size_t iommu_map_sg(struct iommu_domain
*domain
, unsigned long iova
,
303 struct scatterlist
*sg
,unsigned int nents
, int prot
);
304 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
305 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
306 iommu_fault_handler_t handler
, void *token
);
308 extern void iommu_get_resv_regions(struct device
*dev
, struct list_head
*list
);
309 extern void iommu_put_resv_regions(struct device
*dev
, struct list_head
*list
);
310 extern int iommu_request_dm_for_dev(struct device
*dev
);
311 extern struct iommu_resv_region
*
312 iommu_alloc_resv_region(phys_addr_t start
, size_t length
, int prot
,
313 enum iommu_resv_type type
);
314 extern int iommu_get_group_resv_regions(struct iommu_group
*group
,
315 struct list_head
*head
);
317 extern int iommu_attach_group(struct iommu_domain
*domain
,
318 struct iommu_group
*group
);
319 extern void iommu_detach_group(struct iommu_domain
*domain
,
320 struct iommu_group
*group
);
321 extern struct iommu_group
*iommu_group_alloc(void);
322 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
323 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
325 void (*release
)(void *iommu_data
));
326 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
327 extern int iommu_group_add_device(struct iommu_group
*group
,
329 extern void iommu_group_remove_device(struct device
*dev
);
330 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
331 int (*fn
)(struct device
*, void *));
332 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
333 extern struct iommu_group
*iommu_group_ref_get(struct iommu_group
*group
);
334 extern void iommu_group_put(struct iommu_group
*group
);
335 extern int iommu_group_register_notifier(struct iommu_group
*group
,
336 struct notifier_block
*nb
);
337 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
338 struct notifier_block
*nb
);
339 extern int iommu_group_id(struct iommu_group
*group
);
340 extern struct iommu_group
*iommu_group_get_for_dev(struct device
*dev
);
341 extern struct iommu_domain
*iommu_group_default_domain(struct iommu_group
*);
343 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
345 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
348 /* Window handling function prototypes */
349 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
350 phys_addr_t offset
, u64 size
,
352 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
354 extern int report_iommu_fault(struct iommu_domain
*domain
, struct device
*dev
,
355 unsigned long iova
, int flags
);
357 static inline void iommu_flush_tlb_all(struct iommu_domain
*domain
)
359 if (domain
->ops
->flush_iotlb_all
)
360 domain
->ops
->flush_iotlb_all(domain
);
363 static inline void iommu_tlb_range_add(struct iommu_domain
*domain
,
364 unsigned long iova
, size_t size
)
366 if (domain
->ops
->iotlb_range_add
)
367 domain
->ops
->iotlb_range_add(domain
, iova
, size
);
370 static inline void iommu_tlb_sync(struct iommu_domain
*domain
)
372 if (domain
->ops
->iotlb_sync
)
373 domain
->ops
->iotlb_sync(domain
);
376 /* PCI device grouping function */
377 extern struct iommu_group
*pci_device_group(struct device
*dev
);
378 /* Generic device grouping function */
379 extern struct iommu_group
*generic_device_group(struct device
*dev
);
382 * struct iommu_fwspec - per-device IOMMU instance data
383 * @ops: ops for this device's IOMMU
384 * @iommu_fwnode: firmware handle for this device's IOMMU
385 * @iommu_priv: IOMMU driver private data for this device
386 * @num_ids: number of associated device IDs
387 * @ids: IDs which this device may present to the IOMMU
389 struct iommu_fwspec
{
390 const struct iommu_ops
*ops
;
391 struct fwnode_handle
*iommu_fwnode
;
393 unsigned int num_ids
;
397 int iommu_fwspec_init(struct device
*dev
, struct fwnode_handle
*iommu_fwnode
,
398 const struct iommu_ops
*ops
);
399 void iommu_fwspec_free(struct device
*dev
);
400 int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
, int num_ids
);
401 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
);
403 #else /* CONFIG_IOMMU_API */
406 struct iommu_group
{};
407 struct iommu_fwspec
{};
408 struct iommu_device
{};
410 static inline bool iommu_present(struct bus_type
*bus
)
415 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
420 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
425 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
430 static inline void iommu_domain_free(struct iommu_domain
*domain
)
434 static inline int iommu_attach_device(struct iommu_domain
*domain
,
440 static inline void iommu_detach_device(struct iommu_domain
*domain
,
445 static inline struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
)
450 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
451 phys_addr_t paddr
, size_t size
, int prot
)
456 static inline size_t iommu_unmap(struct iommu_domain
*domain
,
457 unsigned long iova
, size_t size
)
462 static inline size_t iommu_unmap_fast(struct iommu_domain
*domain
,
463 unsigned long iova
, int gfp_order
)
468 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
469 unsigned long iova
, struct scatterlist
*sg
,
470 unsigned int nents
, int prot
)
475 static inline void iommu_flush_tlb_all(struct iommu_domain
*domain
)
479 static inline void iommu_tlb_range_add(struct iommu_domain
*domain
,
480 unsigned long iova
, size_t size
)
484 static inline void iommu_tlb_sync(struct iommu_domain
*domain
)
488 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
489 u32 wnd_nr
, phys_addr_t paddr
,
495 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
500 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
505 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
506 iommu_fault_handler_t handler
, void *token
)
510 static inline void iommu_get_resv_regions(struct device
*dev
,
511 struct list_head
*list
)
515 static inline void iommu_put_resv_regions(struct device
*dev
,
516 struct list_head
*list
)
520 static inline int iommu_get_group_resv_regions(struct iommu_group
*group
,
521 struct list_head
*head
)
526 static inline int iommu_request_dm_for_dev(struct device
*dev
)
531 static inline int iommu_attach_group(struct iommu_domain
*domain
,
532 struct iommu_group
*group
)
537 static inline void iommu_detach_group(struct iommu_domain
*domain
,
538 struct iommu_group
*group
)
542 static inline struct iommu_group
*iommu_group_alloc(void)
544 return ERR_PTR(-ENODEV
);
547 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
552 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
554 void (*release
)(void *iommu_data
))
558 static inline int iommu_group_set_name(struct iommu_group
*group
,
564 static inline int iommu_group_add_device(struct iommu_group
*group
,
570 static inline void iommu_group_remove_device(struct device
*dev
)
574 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
576 int (*fn
)(struct device
*, void *))
581 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
586 static inline void iommu_group_put(struct iommu_group
*group
)
590 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
591 struct notifier_block
*nb
)
596 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
597 struct notifier_block
*nb
)
602 static inline int iommu_group_id(struct iommu_group
*group
)
607 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
608 enum iommu_attr attr
, void *data
)
613 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
614 enum iommu_attr attr
, void *data
)
619 static inline int iommu_device_register(struct iommu_device
*iommu
)
624 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
625 const struct iommu_ops
*ops
)
629 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
630 struct fwnode_handle
*fwnode
)
634 static inline struct iommu_device
*dev_to_iommu_device(struct device
*dev
)
639 static inline void iommu_device_unregister(struct iommu_device
*iommu
)
643 static inline int iommu_device_sysfs_add(struct iommu_device
*iommu
,
644 struct device
*parent
,
645 const struct attribute_group
**groups
,
646 const char *fmt
, ...)
651 static inline void iommu_device_sysfs_remove(struct iommu_device
*iommu
)
655 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
660 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
664 static inline int iommu_fwspec_init(struct device
*dev
,
665 struct fwnode_handle
*iommu_fwnode
,
666 const struct iommu_ops
*ops
)
671 static inline void iommu_fwspec_free(struct device
*dev
)
675 static inline int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
,
682 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
)
687 #endif /* CONFIG_IOMMU_API */
689 #ifdef CONFIG_IOMMU_DEBUGFS
690 extern struct dentry
*iommu_debugfs_dir
;
691 void iommu_debugfs_setup(void);
693 static inline void iommu_debugfs_setup(void) {}
696 #endif /* __LINUX_IOMMU_H */