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 */
127 DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE
,
131 /* These are the possible reserved region types */
132 enum iommu_resv_type
{
133 /* Memory regions which must be mapped 1:1 at all times */
135 /* Arbitrary "never map this or give it to a device" address ranges */
137 /* Hardware MSI region (untranslated) */
139 /* Software-managed MSI translation window */
144 * struct iommu_resv_region - descriptor for a reserved memory region
145 * @list: Linked list pointers
146 * @start: System physical start address of the region
147 * @length: Length of the region in bytes
148 * @prot: IOMMU Protection flags (READ/WRITE/...)
149 * @type: Type of the reserved region
151 struct iommu_resv_region
{
152 struct list_head list
;
156 enum iommu_resv_type type
;
159 #ifdef CONFIG_IOMMU_API
162 * struct iommu_ops - iommu ops and capabilities
163 * @capable: check capability
164 * @domain_alloc: allocate iommu domain
165 * @domain_free: free iommu domain
166 * @attach_dev: attach device to an iommu domain
167 * @detach_dev: detach device from an iommu domain
168 * @map: map a physically contiguous memory region to an iommu domain
169 * @unmap: unmap a physically contiguous memory region from an iommu domain
170 * @map_sg: map a scatter-gather list of physically contiguous memory chunks
172 * @flush_tlb_all: Synchronously flush all hardware TLBs for this domain
173 * @tlb_range_add: Add a given iova range to the flush queue for this domain
174 * @tlb_sync: Flush all queued ranges from the hardware TLBs and empty flush
176 * @iova_to_phys: translate iova to physical address
177 * @add_device: add device to iommu grouping
178 * @remove_device: remove device from iommu grouping
179 * @device_group: find iommu group for a particular device
180 * @domain_get_attr: Query domain attributes
181 * @domain_set_attr: Change domain attributes
182 * @get_resv_regions: Request list of reserved regions for a device
183 * @put_resv_regions: Free list of reserved regions for a device
184 * @apply_resv_region: Temporary helper call-back for iova reserved ranges
185 * @domain_window_enable: Configure and enable a particular window for a domain
186 * @domain_window_disable: Disable a particular window for a domain
187 * @domain_set_windows: Set the number of windows for a domain
188 * @domain_get_windows: Return the number of windows for a domain
189 * @of_xlate: add OF master IDs to iommu grouping
190 * @pgsize_bitmap: bitmap of all possible supported page sizes
193 bool (*capable
)(enum iommu_cap
);
195 /* Domain allocation and freeing by the iommu driver */
196 struct iommu_domain
*(*domain_alloc
)(unsigned iommu_domain_type
);
197 void (*domain_free
)(struct iommu_domain
*);
199 int (*attach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
200 void (*detach_dev
)(struct iommu_domain
*domain
, struct device
*dev
);
201 int (*map
)(struct iommu_domain
*domain
, unsigned long iova
,
202 phys_addr_t paddr
, size_t size
, int prot
);
203 size_t (*unmap
)(struct iommu_domain
*domain
, unsigned long iova
,
205 size_t (*map_sg
)(struct iommu_domain
*domain
, unsigned long iova
,
206 struct scatterlist
*sg
, unsigned int nents
, int prot
);
207 void (*flush_iotlb_all
)(struct iommu_domain
*domain
);
208 void (*iotlb_range_add
)(struct iommu_domain
*domain
,
209 unsigned long iova
, size_t size
);
210 void (*iotlb_sync
)(struct iommu_domain
*domain
);
211 phys_addr_t (*iova_to_phys
)(struct iommu_domain
*domain
, dma_addr_t iova
);
212 int (*add_device
)(struct device
*dev
);
213 void (*remove_device
)(struct device
*dev
);
214 struct iommu_group
*(*device_group
)(struct device
*dev
);
215 int (*domain_get_attr
)(struct iommu_domain
*domain
,
216 enum iommu_attr attr
, void *data
);
217 int (*domain_set_attr
)(struct iommu_domain
*domain
,
218 enum iommu_attr attr
, void *data
);
220 /* Request/Free a list of reserved regions for a device */
221 void (*get_resv_regions
)(struct device
*dev
, struct list_head
*list
);
222 void (*put_resv_regions
)(struct device
*dev
, struct list_head
*list
);
223 void (*apply_resv_region
)(struct device
*dev
,
224 struct iommu_domain
*domain
,
225 struct iommu_resv_region
*region
);
227 /* Window handling functions */
228 int (*domain_window_enable
)(struct iommu_domain
*domain
, u32 wnd_nr
,
229 phys_addr_t paddr
, u64 size
, int prot
);
230 void (*domain_window_disable
)(struct iommu_domain
*domain
, u32 wnd_nr
);
231 /* Set the number of windows per domain */
232 int (*domain_set_windows
)(struct iommu_domain
*domain
, u32 w_count
);
233 /* Get the number of windows per domain */
234 u32 (*domain_get_windows
)(struct iommu_domain
*domain
);
236 int (*of_xlate
)(struct device
*dev
, struct of_phandle_args
*args
);
237 bool (*is_attach_deferred
)(struct iommu_domain
*domain
, struct device
*dev
);
239 unsigned long pgsize_bitmap
;
243 * struct iommu_device - IOMMU core representation of one IOMMU hardware
245 * @list: Used by the iommu-core to keep a list of registered iommus
246 * @ops: iommu-ops for talking to this iommu
247 * @dev: struct device for sysfs handling
249 struct iommu_device
{
250 struct list_head list
;
251 const struct iommu_ops
*ops
;
252 struct fwnode_handle
*fwnode
;
256 int iommu_device_register(struct iommu_device
*iommu
);
257 void iommu_device_unregister(struct iommu_device
*iommu
);
258 int iommu_device_sysfs_add(struct iommu_device
*iommu
,
259 struct device
*parent
,
260 const struct attribute_group
**groups
,
261 const char *fmt
, ...) __printf(4, 5);
262 void iommu_device_sysfs_remove(struct iommu_device
*iommu
);
263 int iommu_device_link(struct iommu_device
*iommu
, struct device
*link
);
264 void iommu_device_unlink(struct iommu_device
*iommu
, struct device
*link
);
266 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
267 const struct iommu_ops
*ops
)
272 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
273 struct fwnode_handle
*fwnode
)
275 iommu
->fwnode
= fwnode
;
278 static inline struct iommu_device
*dev_to_iommu_device(struct device
*dev
)
280 return (struct iommu_device
*)dev_get_drvdata(dev
);
283 #define IOMMU_GROUP_NOTIFY_ADD_DEVICE 1 /* Device added */
284 #define IOMMU_GROUP_NOTIFY_DEL_DEVICE 2 /* Pre Device removed */
285 #define IOMMU_GROUP_NOTIFY_BIND_DRIVER 3 /* Pre Driver bind */
286 #define IOMMU_GROUP_NOTIFY_BOUND_DRIVER 4 /* Post Driver bind */
287 #define IOMMU_GROUP_NOTIFY_UNBIND_DRIVER 5 /* Pre Driver unbind */
288 #define IOMMU_GROUP_NOTIFY_UNBOUND_DRIVER 6 /* Post Driver unbind */
290 extern int bus_set_iommu(struct bus_type
*bus
, const struct iommu_ops
*ops
);
291 extern bool iommu_present(struct bus_type
*bus
);
292 extern bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
);
293 extern struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
);
294 extern struct iommu_group
*iommu_group_get_by_id(int id
);
295 extern void iommu_domain_free(struct iommu_domain
*domain
);
296 extern int iommu_attach_device(struct iommu_domain
*domain
,
298 extern void iommu_detach_device(struct iommu_domain
*domain
,
300 extern struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
);
301 extern int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
302 phys_addr_t paddr
, size_t size
, int prot
);
303 extern size_t iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
305 extern size_t iommu_unmap_fast(struct iommu_domain
*domain
,
306 unsigned long iova
, size_t size
);
307 extern size_t default_iommu_map_sg(struct iommu_domain
*domain
, unsigned long iova
,
308 struct scatterlist
*sg
,unsigned int nents
,
310 extern phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
);
311 extern void iommu_set_fault_handler(struct iommu_domain
*domain
,
312 iommu_fault_handler_t handler
, void *token
);
314 extern void iommu_get_resv_regions(struct device
*dev
, struct list_head
*list
);
315 extern void iommu_put_resv_regions(struct device
*dev
, struct list_head
*list
);
316 extern int iommu_request_dm_for_dev(struct device
*dev
);
317 extern struct iommu_resv_region
*
318 iommu_alloc_resv_region(phys_addr_t start
, size_t length
, int prot
,
319 enum iommu_resv_type type
);
320 extern int iommu_get_group_resv_regions(struct iommu_group
*group
,
321 struct list_head
*head
);
323 extern int iommu_attach_group(struct iommu_domain
*domain
,
324 struct iommu_group
*group
);
325 extern void iommu_detach_group(struct iommu_domain
*domain
,
326 struct iommu_group
*group
);
327 extern struct iommu_group
*iommu_group_alloc(void);
328 extern void *iommu_group_get_iommudata(struct iommu_group
*group
);
329 extern void iommu_group_set_iommudata(struct iommu_group
*group
,
331 void (*release
)(void *iommu_data
));
332 extern int iommu_group_set_name(struct iommu_group
*group
, const char *name
);
333 extern int iommu_group_add_device(struct iommu_group
*group
,
335 extern void iommu_group_remove_device(struct device
*dev
);
336 extern int iommu_group_for_each_dev(struct iommu_group
*group
, void *data
,
337 int (*fn
)(struct device
*, void *));
338 extern struct iommu_group
*iommu_group_get(struct device
*dev
);
339 extern struct iommu_group
*iommu_group_ref_get(struct iommu_group
*group
);
340 extern void iommu_group_put(struct iommu_group
*group
);
341 extern int iommu_group_register_notifier(struct iommu_group
*group
,
342 struct notifier_block
*nb
);
343 extern int iommu_group_unregister_notifier(struct iommu_group
*group
,
344 struct notifier_block
*nb
);
345 extern int iommu_group_id(struct iommu_group
*group
);
346 extern struct iommu_group
*iommu_group_get_for_dev(struct device
*dev
);
347 extern struct iommu_domain
*iommu_group_default_domain(struct iommu_group
*);
349 extern int iommu_domain_get_attr(struct iommu_domain
*domain
, enum iommu_attr
,
351 extern int iommu_domain_set_attr(struct iommu_domain
*domain
, enum iommu_attr
,
354 /* Window handling function prototypes */
355 extern int iommu_domain_window_enable(struct iommu_domain
*domain
, u32 wnd_nr
,
356 phys_addr_t offset
, u64 size
,
358 extern void iommu_domain_window_disable(struct iommu_domain
*domain
, u32 wnd_nr
);
360 extern int report_iommu_fault(struct iommu_domain
*domain
, struct device
*dev
,
361 unsigned long iova
, int flags
);
363 static inline void iommu_flush_tlb_all(struct iommu_domain
*domain
)
365 if (domain
->ops
->flush_iotlb_all
)
366 domain
->ops
->flush_iotlb_all(domain
);
369 static inline void iommu_tlb_range_add(struct iommu_domain
*domain
,
370 unsigned long iova
, size_t size
)
372 if (domain
->ops
->iotlb_range_add
)
373 domain
->ops
->iotlb_range_add(domain
, iova
, size
);
376 static inline void iommu_tlb_sync(struct iommu_domain
*domain
)
378 if (domain
->ops
->iotlb_sync
)
379 domain
->ops
->iotlb_sync(domain
);
382 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
383 unsigned long iova
, struct scatterlist
*sg
,
384 unsigned int nents
, int prot
)
386 return domain
->ops
->map_sg(domain
, iova
, sg
, nents
, prot
);
389 /* PCI device grouping function */
390 extern struct iommu_group
*pci_device_group(struct device
*dev
);
391 /* Generic device grouping function */
392 extern struct iommu_group
*generic_device_group(struct device
*dev
);
395 * struct iommu_fwspec - per-device IOMMU instance data
396 * @ops: ops for this device's IOMMU
397 * @iommu_fwnode: firmware handle for this device's IOMMU
398 * @iommu_priv: IOMMU driver private data for this device
399 * @num_ids: number of associated device IDs
400 * @ids: IDs which this device may present to the IOMMU
402 struct iommu_fwspec
{
403 const struct iommu_ops
*ops
;
404 struct fwnode_handle
*iommu_fwnode
;
406 unsigned int num_ids
;
410 int iommu_fwspec_init(struct device
*dev
, struct fwnode_handle
*iommu_fwnode
,
411 const struct iommu_ops
*ops
);
412 void iommu_fwspec_free(struct device
*dev
);
413 int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
, int num_ids
);
414 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
);
416 #else /* CONFIG_IOMMU_API */
419 struct iommu_group
{};
420 struct iommu_fwspec
{};
421 struct iommu_device
{};
423 static inline bool iommu_present(struct bus_type
*bus
)
428 static inline bool iommu_capable(struct bus_type
*bus
, enum iommu_cap cap
)
433 static inline struct iommu_domain
*iommu_domain_alloc(struct bus_type
*bus
)
438 static inline struct iommu_group
*iommu_group_get_by_id(int id
)
443 static inline void iommu_domain_free(struct iommu_domain
*domain
)
447 static inline int iommu_attach_device(struct iommu_domain
*domain
,
453 static inline void iommu_detach_device(struct iommu_domain
*domain
,
458 static inline struct iommu_domain
*iommu_get_domain_for_dev(struct device
*dev
)
463 static inline int iommu_map(struct iommu_domain
*domain
, unsigned long iova
,
464 phys_addr_t paddr
, size_t size
, int prot
)
469 static inline int iommu_unmap(struct iommu_domain
*domain
, unsigned long iova
,
475 static inline int iommu_unmap_fast(struct iommu_domain
*domain
, unsigned long iova
,
481 static inline size_t iommu_map_sg(struct iommu_domain
*domain
,
482 unsigned long iova
, struct scatterlist
*sg
,
483 unsigned int nents
, int prot
)
488 static inline void iommu_flush_tlb_all(struct iommu_domain
*domain
)
492 static inline void iommu_tlb_range_add(struct iommu_domain
*domain
,
493 unsigned long iova
, size_t size
)
497 static inline void iommu_tlb_sync(struct iommu_domain
*domain
)
501 static inline int iommu_domain_window_enable(struct iommu_domain
*domain
,
502 u32 wnd_nr
, phys_addr_t paddr
,
508 static inline void iommu_domain_window_disable(struct iommu_domain
*domain
,
513 static inline phys_addr_t
iommu_iova_to_phys(struct iommu_domain
*domain
, dma_addr_t iova
)
518 static inline void iommu_set_fault_handler(struct iommu_domain
*domain
,
519 iommu_fault_handler_t handler
, void *token
)
523 static inline void iommu_get_resv_regions(struct device
*dev
,
524 struct list_head
*list
)
528 static inline void iommu_put_resv_regions(struct device
*dev
,
529 struct list_head
*list
)
533 static inline int iommu_get_group_resv_regions(struct iommu_group
*group
,
534 struct list_head
*head
)
539 static inline int iommu_request_dm_for_dev(struct device
*dev
)
544 static inline int iommu_attach_group(struct iommu_domain
*domain
,
545 struct iommu_group
*group
)
550 static inline void iommu_detach_group(struct iommu_domain
*domain
,
551 struct iommu_group
*group
)
555 static inline struct iommu_group
*iommu_group_alloc(void)
557 return ERR_PTR(-ENODEV
);
560 static inline void *iommu_group_get_iommudata(struct iommu_group
*group
)
565 static inline void iommu_group_set_iommudata(struct iommu_group
*group
,
567 void (*release
)(void *iommu_data
))
571 static inline int iommu_group_set_name(struct iommu_group
*group
,
577 static inline int iommu_group_add_device(struct iommu_group
*group
,
583 static inline void iommu_group_remove_device(struct device
*dev
)
587 static inline int iommu_group_for_each_dev(struct iommu_group
*group
,
589 int (*fn
)(struct device
*, void *))
594 static inline struct iommu_group
*iommu_group_get(struct device
*dev
)
599 static inline void iommu_group_put(struct iommu_group
*group
)
603 static inline int iommu_group_register_notifier(struct iommu_group
*group
,
604 struct notifier_block
*nb
)
609 static inline int iommu_group_unregister_notifier(struct iommu_group
*group
,
610 struct notifier_block
*nb
)
615 static inline int iommu_group_id(struct iommu_group
*group
)
620 static inline int iommu_domain_get_attr(struct iommu_domain
*domain
,
621 enum iommu_attr attr
, void *data
)
626 static inline int iommu_domain_set_attr(struct iommu_domain
*domain
,
627 enum iommu_attr attr
, void *data
)
632 static inline int iommu_device_register(struct iommu_device
*iommu
)
637 static inline void iommu_device_set_ops(struct iommu_device
*iommu
,
638 const struct iommu_ops
*ops
)
642 static inline void iommu_device_set_fwnode(struct iommu_device
*iommu
,
643 struct fwnode_handle
*fwnode
)
647 static inline struct iommu_device
*dev_to_iommu_device(struct device
*dev
)
652 static inline void iommu_device_unregister(struct iommu_device
*iommu
)
656 static inline int iommu_device_sysfs_add(struct iommu_device
*iommu
,
657 struct device
*parent
,
658 const struct attribute_group
**groups
,
659 const char *fmt
, ...)
664 static inline void iommu_device_sysfs_remove(struct iommu_device
*iommu
)
668 static inline int iommu_device_link(struct device
*dev
, struct device
*link
)
673 static inline void iommu_device_unlink(struct device
*dev
, struct device
*link
)
677 static inline int iommu_fwspec_init(struct device
*dev
,
678 struct fwnode_handle
*iommu_fwnode
,
679 const struct iommu_ops
*ops
)
684 static inline void iommu_fwspec_free(struct device
*dev
)
688 static inline int iommu_fwspec_add_ids(struct device
*dev
, u32
*ids
,
695 const struct iommu_ops
*iommu_ops_from_fwnode(struct fwnode_handle
*fwnode
)
700 #endif /* CONFIG_IOMMU_API */
702 #endif /* __LINUX_IOMMU_H */