1 /* 2 * Copyright (C) 2001 Mike Corrigan & Dave Engebretsen, IBM Corporation 3 * Rewrite, cleanup: 4 * Copyright (C) 2004 Olof Johansson <olof@lixom.net>, IBM Corporation 5 * 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. 10 * 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. 15 * 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 19 */ 20 21 #ifndef _ASM_IOMMU_H 22 #define _ASM_IOMMU_H 23 #ifdef __KERNEL__ 24 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 34 #define IOMMU_PAGE_SHIFT_4K 12 35 #define IOMMU_PAGE_SIZE_4K (ASM_CONST(1) << IOMMU_PAGE_SHIFT_4K) 36 #define IOMMU_PAGE_MASK_4K (~((1 << IOMMU_PAGE_SHIFT_4K) - 1)) 37 #define IOMMU_PAGE_ALIGN_4K(addr) _ALIGN_UP(addr, IOMMU_PAGE_SIZE_4K) 38 39 #define IOMMU_PAGE_SIZE(tblptr) (ASM_CONST(1) << (tblptr)->it_page_shift) 40 #define IOMMU_PAGE_MASK(tblptr) (~((1 << (tblptr)->it_page_shift) - 1)) 41 #define IOMMU_PAGE_ALIGN(addr, tblptr) _ALIGN_UP(addr, IOMMU_PAGE_SIZE(tblptr)) 42 43 /* Boot time flags */ 44 extern int iommu_is_off; 45 extern int iommu_force_on; 46 47 struct iommu_table_ops { 48 /* 49 * When called with direction==DMA_NONE, it is equal to clear(). 50 * uaddr is a linear map address. 51 */ 52 int (*set)(struct iommu_table *tbl, 53 long index, long npages, 54 unsigned long uaddr, 55 enum dma_data_direction direction, 56 unsigned long attrs); 57 #ifdef CONFIG_IOMMU_API 58 /* 59 * Exchanges existing TCE with new TCE plus direction bits; 60 * returns old TCE and DMA direction mask. 61 * @tce is a physical address. 62 */ 63 int (*exchange)(struct iommu_table *tbl, 64 long index, 65 unsigned long *hpa, 66 enum dma_data_direction *direction); 67 /* Real mode */ 68 int (*exchange_rm)(struct iommu_table *tbl, 69 long index, 70 unsigned long *hpa, 71 enum dma_data_direction *direction); 72 #endif 73 void (*clear)(struct iommu_table *tbl, 74 long index, long npages); 75 /* get() returns a physical address */ 76 unsigned long (*get)(struct iommu_table *tbl, long index); 77 void (*flush)(struct iommu_table *tbl); 78 void (*free)(struct iommu_table *tbl); 79 }; 80 81 /* These are used by VIO */ 82 extern struct iommu_table_ops iommu_table_lpar_multi_ops; 83 extern struct iommu_table_ops iommu_table_pseries_ops; 84 85 /* 86 * IOMAP_MAX_ORDER defines the largest contiguous block 87 * of dma space we can get. IOMAP_MAX_ORDER = 13 88 * allows up to 2**12 pages (4096 * 4096) = 16 MB 89 */ 90 #define IOMAP_MAX_ORDER 13 91 92 #define IOMMU_POOL_HASHBITS 2 93 #define IOMMU_NR_POOLS (1 << IOMMU_POOL_HASHBITS) 94 95 struct iommu_pool { 96 unsigned long start; 97 unsigned long end; 98 unsigned long hint; 99 spinlock_t lock; 100 } ____cacheline_aligned_in_smp; 101 102 struct iommu_table { 103 unsigned long it_busno; /* Bus number this table belongs to */ 104 unsigned long it_size; /* Size of iommu table in entries */ 105 unsigned long it_indirect_levels; 106 unsigned long it_level_size; 107 unsigned long it_allocated_size; 108 unsigned long it_offset; /* Offset into global table */ 109 unsigned long it_base; /* mapped address of tce table */ 110 unsigned long it_index; /* which iommu table this is */ 111 unsigned long it_type; /* type: PCI or Virtual Bus */ 112 unsigned long it_blocksize; /* Entries in each block (cacheline) */ 113 unsigned long poolsize; 114 unsigned long nr_pools; 115 struct iommu_pool large_pool; 116 struct iommu_pool pools[IOMMU_NR_POOLS]; 117 unsigned long *it_map; /* A simple allocation bitmap for now */ 118 unsigned long it_page_shift;/* table iommu page size */ 119 struct list_head it_group_list;/* List of iommu_table_group_link */ 120 unsigned long *it_userspace; /* userspace view of the table */ 121 struct iommu_table_ops *it_ops; 122 struct kref it_kref; 123 }; 124 125 #define IOMMU_TABLE_USERSPACE_ENTRY(tbl, entry) \ 126 ((tbl)->it_userspace ? \ 127 &((tbl)->it_userspace[(entry) - (tbl)->it_offset]) : \ 128 NULL) 129 130 /* Pure 2^n version of get_order */ 131 static inline __attribute_const__ 132 int get_iommu_order(unsigned long size, struct iommu_table *tbl) 133 { 134 return __ilog2((size - 1) >> tbl->it_page_shift) + 1; 135 } 136 137 138 struct scatterlist; 139 140 #ifdef CONFIG_PPC64 141 142 static inline void set_iommu_table_base(struct device *dev, 143 struct iommu_table *base) 144 { 145 dev->archdata.iommu_table_base = base; 146 } 147 148 static inline void *get_iommu_table_base(struct device *dev) 149 { 150 return dev->archdata.iommu_table_base; 151 } 152 153 extern int dma_iommu_dma_supported(struct device *dev, u64 mask); 154 155 extern struct iommu_table *iommu_tce_table_get(struct iommu_table *tbl); 156 extern int iommu_tce_table_put(struct iommu_table *tbl); 157 158 /* Initializes an iommu_table based in values set in the passed-in 159 * structure 160 */ 161 extern struct iommu_table *iommu_init_table(struct iommu_table * tbl, 162 int nid); 163 #define IOMMU_TABLE_GROUP_MAX_TABLES 2 164 165 struct iommu_table_group; 166 167 struct iommu_table_group_ops { 168 unsigned long (*get_table_size)( 169 __u32 page_shift, 170 __u64 window_size, 171 __u32 levels); 172 long (*create_table)(struct iommu_table_group *table_group, 173 int num, 174 __u32 page_shift, 175 __u64 window_size, 176 __u32 levels, 177 struct iommu_table **ptbl); 178 long (*set_window)(struct iommu_table_group *table_group, 179 int num, 180 struct iommu_table *tblnew); 181 long (*unset_window)(struct iommu_table_group *table_group, 182 int num); 183 /* Switch ownership from platform code to external user (e.g. VFIO) */ 184 void (*take_ownership)(struct iommu_table_group *table_group); 185 /* Switch ownership from external user (e.g. VFIO) back to core */ 186 void (*release_ownership)(struct iommu_table_group *table_group); 187 }; 188 189 struct iommu_table_group_link { 190 struct list_head next; 191 struct rcu_head rcu; 192 struct iommu_table_group *table_group; 193 }; 194 195 struct iommu_table_group { 196 /* IOMMU properties */ 197 __u32 tce32_start; 198 __u32 tce32_size; 199 __u64 pgsizes; /* Bitmap of supported page sizes */ 200 __u32 max_dynamic_windows_supported; 201 __u32 max_levels; 202 203 struct iommu_group *group; 204 struct iommu_table *tables[IOMMU_TABLE_GROUP_MAX_TABLES]; 205 struct iommu_table_group_ops *ops; 206 }; 207 208 #ifdef CONFIG_IOMMU_API 209 210 extern void iommu_register_group(struct iommu_table_group *table_group, 211 int pci_domain_number, unsigned long pe_num); 212 extern int iommu_add_device(struct device *dev); 213 extern void iommu_del_device(struct device *dev); 214 extern int __init tce_iommu_bus_notifier_init(void); 215 extern long iommu_tce_xchg(struct iommu_table *tbl, unsigned long entry, 216 unsigned long *hpa, enum dma_data_direction *direction); 217 extern long iommu_tce_xchg_rm(struct iommu_table *tbl, unsigned long entry, 218 unsigned long *hpa, enum dma_data_direction *direction); 219 #else 220 static inline void iommu_register_group(struct iommu_table_group *table_group, 221 int pci_domain_number, 222 unsigned long pe_num) 223 { 224 } 225 226 static inline int iommu_add_device(struct device *dev) 227 { 228 return 0; 229 } 230 231 static inline void iommu_del_device(struct device *dev) 232 { 233 } 234 235 static inline int __init tce_iommu_bus_notifier_init(void) 236 { 237 return 0; 238 } 239 #endif /* !CONFIG_IOMMU_API */ 240 241 #else 242 243 static inline void *get_iommu_table_base(struct device *dev) 244 { 245 return NULL; 246 } 247 248 static inline int dma_iommu_dma_supported(struct device *dev, u64 mask) 249 { 250 return 0; 251 } 252 253 #endif /* CONFIG_PPC64 */ 254 255 extern int ppc_iommu_map_sg(struct device *dev, struct iommu_table *tbl, 256 struct scatterlist *sglist, int nelems, 257 unsigned long mask, 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, 262 int nelems, 263 enum dma_data_direction direction, 264 unsigned long attrs); 265 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); 279 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); 283 284 #if defined(CONFIG_PPC64) && defined(CONFIG_PM) 285 static inline void iommu_save(void) 286 { 287 if (ppc_md.iommu_save) 288 ppc_md.iommu_save(); 289 } 290 291 static inline void iommu_restore(void) 292 { 293 if (ppc_md.iommu_restore) 294 ppc_md.iommu_restore(); 295 } 296 #endif 297 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, 303 unsigned long gpa); 304 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, \ 312 (ioba), 1) || \ 313 iommu_tce_check_gpa((tbl)->it_page_shift, (gpa))) 314 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); 318 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); 321 322 #endif /* __KERNEL__ */ 323 #endif /* _ASM_IOMMU_H */ 324