2 * Copyright (C) 2001 Mike Corrigan & Dave Engebretsen, IBM Corporation
4 * Copyright (C) 2004 Olof Johansson <olof@lixom.net>, IBM Corporation
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include <linux/compiler.h>
26 #include <linux/spinlock.h>
27 #include <linux/device.h>
28 #include <linux/dma-mapping.h>
29 #include <linux/bitops.h>
30 #include <asm/machdep.h>
31 #include <asm/types.h>
32 #include <asm/pci-bridge.h>
33 #include <asm/asm-const.h>
35 #define IOMMU_PAGE_SHIFT_4K 12
36 #define IOMMU_PAGE_SIZE_4K (ASM_CONST(1) << IOMMU_PAGE_SHIFT_4K)
37 #define IOMMU_PAGE_MASK_4K (~((1 << IOMMU_PAGE_SHIFT_4K) - 1))
38 #define IOMMU_PAGE_ALIGN_4K(addr) _ALIGN_UP(addr, IOMMU_PAGE_SIZE_4K)
40 #define IOMMU_PAGE_SIZE(tblptr) (ASM_CONST(1) << (tblptr)->it_page_shift)
41 #define IOMMU_PAGE_MASK(tblptr) (~((1 << (tblptr)->it_page_shift) - 1))
42 #define IOMMU_PAGE_ALIGN(addr, tblptr) _ALIGN_UP(addr, IOMMU_PAGE_SIZE(tblptr))
45 extern int iommu_is_off;
46 extern int iommu_force_on;
48 struct iommu_table_ops {
50 * When called with direction==DMA_NONE, it is equal to clear().
51 * uaddr is a linear map address.
53 int (*set)(struct iommu_table *tbl,
54 long index, long npages,
56 enum dma_data_direction direction,
58 #ifdef CONFIG_IOMMU_API
60 * Exchanges existing TCE with new TCE plus direction bits;
61 * returns old TCE and DMA direction mask.
62 * @tce is a physical address.
64 int (*exchange)(struct iommu_table *tbl,
67 enum dma_data_direction *direction);
69 int (*exchange_rm)(struct iommu_table *tbl,
72 enum dma_data_direction *direction);
74 __be64 *(*useraddrptr)(struct iommu_table *tbl, long index, bool alloc);
76 void (*clear)(struct iommu_table *tbl,
77 long index, long npages);
78 /* get() returns a physical address */
79 unsigned long (*get)(struct iommu_table *tbl, long index);
80 void (*flush)(struct iommu_table *tbl);
81 void (*free)(struct iommu_table *tbl);
84 /* These are used by VIO */
85 extern struct iommu_table_ops iommu_table_lpar_multi_ops;
86 extern struct iommu_table_ops iommu_table_pseries_ops;
89 * IOMAP_MAX_ORDER defines the largest contiguous block
90 * of dma space we can get. IOMAP_MAX_ORDER = 13
91 * allows up to 2**12 pages (4096 * 4096) = 16 MB
93 #define IOMAP_MAX_ORDER 13
95 #define IOMMU_POOL_HASHBITS 2
96 #define IOMMU_NR_POOLS (1 << IOMMU_POOL_HASHBITS)
103 } ____cacheline_aligned_in_smp;
106 unsigned long it_busno; /* Bus number this table belongs to */
107 unsigned long it_size; /* Size of iommu table in entries */
108 unsigned long it_indirect_levels;
109 unsigned long it_level_size;
110 unsigned long it_allocated_size;
111 unsigned long it_offset; /* Offset into global table */
112 unsigned long it_base; /* mapped address of tce table */
113 unsigned long it_index; /* which iommu table this is */
114 unsigned long it_type; /* type: PCI or Virtual Bus */
115 unsigned long it_blocksize; /* Entries in each block (cacheline) */
116 unsigned long poolsize;
117 unsigned long nr_pools;
118 struct iommu_pool large_pool;
119 struct iommu_pool pools[IOMMU_NR_POOLS];
120 unsigned long *it_map; /* A simple allocation bitmap for now */
121 unsigned long it_page_shift;/* table iommu page size */
122 struct list_head it_group_list;/* List of iommu_table_group_link */
123 __be64 *it_userspace; /* userspace view of the table */
124 struct iommu_table_ops *it_ops;
129 #define IOMMU_TABLE_USERSPACE_ENTRY_RO(tbl, entry) \
130 ((tbl)->it_ops->useraddrptr((tbl), (entry), false))
131 #define IOMMU_TABLE_USERSPACE_ENTRY(tbl, entry) \
132 ((tbl)->it_ops->useraddrptr((tbl), (entry), true))
134 /* Pure 2^n version of get_order */
135 static inline __attribute_const__
136 int get_iommu_order(unsigned long size, struct iommu_table *tbl)
138 return __ilog2((size - 1) >> tbl->it_page_shift) + 1;
146 static inline void set_iommu_table_base(struct device *dev,
147 struct iommu_table *base)
149 dev->archdata.iommu_table_base = base;
152 static inline void *get_iommu_table_base(struct device *dev)
154 return dev->archdata.iommu_table_base;
157 extern int dma_iommu_dma_supported(struct device *dev, u64 mask);
159 extern struct iommu_table *iommu_tce_table_get(struct iommu_table *tbl);
160 extern int iommu_tce_table_put(struct iommu_table *tbl);
162 /* Initializes an iommu_table based in values set in the passed-in
165 extern struct iommu_table *iommu_init_table(struct iommu_table * tbl,
167 #define IOMMU_TABLE_GROUP_MAX_TABLES 2
169 struct iommu_table_group;
171 struct iommu_table_group_ops {
172 unsigned long (*get_table_size)(
176 long (*create_table)(struct iommu_table_group *table_group,
181 struct iommu_table **ptbl);
182 long (*set_window)(struct iommu_table_group *table_group,
184 struct iommu_table *tblnew);
185 long (*unset_window)(struct iommu_table_group *table_group,
187 /* Switch ownership from platform code to external user (e.g. VFIO) */
188 void (*take_ownership)(struct iommu_table_group *table_group);
189 /* Switch ownership from external user (e.g. VFIO) back to core */
190 void (*release_ownership)(struct iommu_table_group *table_group);
193 struct iommu_table_group_link {
194 struct list_head next;
196 struct iommu_table_group *table_group;
199 struct iommu_table_group {
200 /* IOMMU properties */
203 __u64 pgsizes; /* Bitmap of supported page sizes */
204 __u32 max_dynamic_windows_supported;
207 struct iommu_group *group;
208 struct iommu_table *tables[IOMMU_TABLE_GROUP_MAX_TABLES];
209 struct iommu_table_group_ops *ops;
212 #ifdef CONFIG_IOMMU_API
214 extern void iommu_register_group(struct iommu_table_group *table_group,
215 int pci_domain_number, unsigned long pe_num);
216 extern int iommu_add_device(struct iommu_table_group *table_group,
218 extern void iommu_del_device(struct device *dev);
219 extern long iommu_tce_xchg(struct mm_struct *mm, struct iommu_table *tbl,
220 unsigned long entry, unsigned long *hpa,
221 enum dma_data_direction *direction);
223 static inline void iommu_register_group(struct iommu_table_group *table_group,
224 int pci_domain_number,
225 unsigned long pe_num)
229 static inline int iommu_add_device(struct iommu_table_group *table_group,
235 static inline void iommu_del_device(struct device *dev)
238 #endif /* !CONFIG_IOMMU_API */
240 u64 dma_iommu_get_required_mask(struct device *dev);
243 static inline void *get_iommu_table_base(struct device *dev)
248 static inline int dma_iommu_dma_supported(struct device *dev, u64 mask)
253 #endif /* CONFIG_PPC64 */
255 extern int ppc_iommu_map_sg(struct device *dev, struct iommu_table *tbl,
256 struct scatterlist *sglist, int nelems,
258 enum dma_data_direction direction,
259 unsigned long attrs);
260 extern void ppc_iommu_unmap_sg(struct iommu_table *tbl,
261 struct scatterlist *sglist,
263 enum dma_data_direction direction,
264 unsigned long attrs);
266 extern void *iommu_alloc_coherent(struct device *dev, struct iommu_table *tbl,
267 size_t size, dma_addr_t *dma_handle,
268 unsigned long mask, gfp_t flag, int node);
269 extern void iommu_free_coherent(struct iommu_table *tbl, size_t size,
270 void *vaddr, dma_addr_t dma_handle);
271 extern dma_addr_t iommu_map_page(struct device *dev, struct iommu_table *tbl,
272 struct page *page, unsigned long offset,
273 size_t size, unsigned long mask,
274 enum dma_data_direction direction,
275 unsigned long attrs);
276 extern void iommu_unmap_page(struct iommu_table *tbl, dma_addr_t dma_handle,
277 size_t size, enum dma_data_direction direction,
278 unsigned long attrs);
280 extern void iommu_init_early_pSeries(void);
281 extern void iommu_init_early_dart(struct pci_controller_ops *controller_ops);
282 extern void iommu_init_early_pasemi(void);
284 #if defined(CONFIG_PPC64) && defined(CONFIG_PM)
285 static inline void iommu_save(void)
287 if (ppc_md.iommu_save)
291 static inline void iommu_restore(void)
293 if (ppc_md.iommu_restore)
294 ppc_md.iommu_restore();
298 /* The API to support IOMMU operations for VFIO */
299 extern int iommu_tce_check_ioba(unsigned long page_shift,
300 unsigned long offset, unsigned long size,
301 unsigned long ioba, unsigned long npages);
302 extern int iommu_tce_check_gpa(unsigned long page_shift,
305 #define iommu_tce_clear_param_check(tbl, ioba, tce_value, npages) \
306 (iommu_tce_check_ioba((tbl)->it_page_shift, \
307 (tbl)->it_offset, (tbl)->it_size, \
308 (ioba), (npages)) || (tce_value))
309 #define iommu_tce_put_param_check(tbl, ioba, gpa) \
310 (iommu_tce_check_ioba((tbl)->it_page_shift, \
311 (tbl)->it_offset, (tbl)->it_size, \
313 iommu_tce_check_gpa((tbl)->it_page_shift, (gpa)))
315 extern void iommu_flush_tce(struct iommu_table *tbl);
316 extern int iommu_take_ownership(struct iommu_table *tbl);
317 extern void iommu_release_ownership(struct iommu_table *tbl);
319 extern enum dma_data_direction iommu_tce_direction(unsigned long tce);
320 extern unsigned long iommu_direction_to_tce_perm(enum dma_data_direction dir);
322 #ifdef CONFIG_PPC_CELL_NATIVE
323 extern bool iommu_fixed_is_weak;
325 #define iommu_fixed_is_weak false
328 #endif /* __KERNEL__ */
329 #endif /* _ASM_IOMMU_H */