xref: /openbmc/linux/arch/powerpc/sysdev/dart_iommu.c (revision 545e4006)
1 /*
2  * arch/powerpc/sysdev/dart_iommu.c
3  *
4  * Copyright (C) 2004 Olof Johansson <olof@lixom.net>, IBM Corporation
5  * Copyright (C) 2005 Benjamin Herrenschmidt <benh@kernel.crashing.org>,
6  *                    IBM Corporation
7  *
8  * Based on pSeries_iommu.c:
9  * Copyright (C) 2001 Mike Corrigan & Dave Engebretsen, IBM Corporation
10  * Copyright (C) 2004 Olof Johansson <olof@lixom.net>, IBM Corporation
11  *
12  * Dynamic DMA mapping support, Apple U3, U4 & IBM CPC925 "DART" iommu.
13  *
14  *
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
28  */
29 
30 #include <linux/init.h>
31 #include <linux/types.h>
32 #include <linux/slab.h>
33 #include <linux/mm.h>
34 #include <linux/spinlock.h>
35 #include <linux/string.h>
36 #include <linux/pci.h>
37 #include <linux/dma-mapping.h>
38 #include <linux/vmalloc.h>
39 #include <linux/suspend.h>
40 #include <linux/lmb.h>
41 #include <asm/io.h>
42 #include <asm/prom.h>
43 #include <asm/iommu.h>
44 #include <asm/pci-bridge.h>
45 #include <asm/machdep.h>
46 #include <asm/abs_addr.h>
47 #include <asm/cacheflush.h>
48 #include <asm/ppc-pci.h>
49 
50 #include "dart.h"
51 
52 /* Physical base address and size of the DART table */
53 unsigned long dart_tablebase; /* exported to htab_initialize */
54 static unsigned long dart_tablesize;
55 
56 /* Virtual base address of the DART table */
57 static u32 *dart_vbase;
58 #ifdef CONFIG_PM
59 static u32 *dart_copy;
60 #endif
61 
62 /* Mapped base address for the dart */
63 static unsigned int __iomem *dart;
64 
65 /* Dummy val that entries are set to when unused */
66 static unsigned int dart_emptyval;
67 
68 static struct iommu_table iommu_table_dart;
69 static int iommu_table_dart_inited;
70 static int dart_dirty;
71 static int dart_is_u4;
72 
73 #define DBG(...)
74 
75 static inline void dart_tlb_invalidate_all(void)
76 {
77 	unsigned long l = 0;
78 	unsigned int reg, inv_bit;
79 	unsigned long limit;
80 
81 	DBG("dart: flush\n");
82 
83 	/* To invalidate the DART, set the DARTCNTL_FLUSHTLB bit in the
84 	 * control register and wait for it to clear.
85 	 *
86 	 * Gotcha: Sometimes, the DART won't detect that the bit gets
87 	 * set. If so, clear it and set it again.
88 	 */
89 
90 	limit = 0;
91 
92 	inv_bit = dart_is_u4 ? DART_CNTL_U4_FLUSHTLB : DART_CNTL_U3_FLUSHTLB;
93 retry:
94 	l = 0;
95 	reg = DART_IN(DART_CNTL);
96 	reg |= inv_bit;
97 	DART_OUT(DART_CNTL, reg);
98 
99 	while ((DART_IN(DART_CNTL) & inv_bit) && l < (1L << limit))
100 		l++;
101 	if (l == (1L << limit)) {
102 		if (limit < 4) {
103 			limit++;
104 			reg = DART_IN(DART_CNTL);
105 			reg &= ~inv_bit;
106 			DART_OUT(DART_CNTL, reg);
107 			goto retry;
108 		} else
109 			panic("DART: TLB did not flush after waiting a long "
110 			      "time. Buggy U3 ?");
111 	}
112 }
113 
114 static inline void dart_tlb_invalidate_one(unsigned long bus_rpn)
115 {
116 	unsigned int reg;
117 	unsigned int l, limit;
118 
119 	reg = DART_CNTL_U4_ENABLE | DART_CNTL_U4_IONE |
120 		(bus_rpn & DART_CNTL_U4_IONE_MASK);
121 	DART_OUT(DART_CNTL, reg);
122 
123 	limit = 0;
124 wait_more:
125 	l = 0;
126 	while ((DART_IN(DART_CNTL) & DART_CNTL_U4_IONE) && l < (1L << limit)) {
127 		rmb();
128 		l++;
129 	}
130 
131 	if (l == (1L << limit)) {
132 		if (limit < 4) {
133 			limit++;
134 			goto wait_more;
135 		} else
136 			panic("DART: TLB did not flush after waiting a long "
137 			      "time. Buggy U4 ?");
138 	}
139 }
140 
141 static void dart_flush(struct iommu_table *tbl)
142 {
143 	mb();
144 	if (dart_dirty) {
145 		dart_tlb_invalidate_all();
146 		dart_dirty = 0;
147 	}
148 }
149 
150 static void dart_build(struct iommu_table *tbl, long index,
151 		       long npages, unsigned long uaddr,
152 		       enum dma_data_direction direction,
153 		       struct dma_attrs *attrs)
154 {
155 	unsigned int *dp;
156 	unsigned int rpn;
157 	long l;
158 
159 	DBG("dart: build at: %lx, %lx, addr: %x\n", index, npages, uaddr);
160 
161 	dp = ((unsigned int*)tbl->it_base) + index;
162 
163 	/* On U3, all memory is contigous, so we can move this
164 	 * out of the loop.
165 	 */
166 	l = npages;
167 	while (l--) {
168 		rpn = virt_to_abs(uaddr) >> DART_PAGE_SHIFT;
169 
170 		*(dp++) = DARTMAP_VALID | (rpn & DARTMAP_RPNMASK);
171 
172 		uaddr += DART_PAGE_SIZE;
173 	}
174 
175 	/* make sure all updates have reached memory */
176 	mb();
177 	in_be32((unsigned __iomem *)dp);
178 	mb();
179 
180 	if (dart_is_u4) {
181 		rpn = index;
182 		while (npages--)
183 			dart_tlb_invalidate_one(rpn++);
184 	} else {
185 		dart_dirty = 1;
186 	}
187 }
188 
189 
190 static void dart_free(struct iommu_table *tbl, long index, long npages)
191 {
192 	unsigned int *dp;
193 
194 	/* We don't worry about flushing the TLB cache. The only drawback of
195 	 * not doing it is that we won't catch buggy device drivers doing
196 	 * bad DMAs, but then no 32-bit architecture ever does either.
197 	 */
198 
199 	DBG("dart: free at: %lx, %lx\n", index, npages);
200 
201 	dp  = ((unsigned int *)tbl->it_base) + index;
202 
203 	while (npages--)
204 		*(dp++) = dart_emptyval;
205 }
206 
207 
208 static int __init dart_init(struct device_node *dart_node)
209 {
210 	unsigned int i;
211 	unsigned long tmp, base, size;
212 	struct resource r;
213 
214 	if (dart_tablebase == 0 || dart_tablesize == 0) {
215 		printk(KERN_INFO "DART: table not allocated, using "
216 		       "direct DMA\n");
217 		return -ENODEV;
218 	}
219 
220 	if (of_address_to_resource(dart_node, 0, &r))
221 		panic("DART: can't get register base ! ");
222 
223 	/* Make sure nothing from the DART range remains in the CPU cache
224 	 * from a previous mapping that existed before the kernel took
225 	 * over
226 	 */
227 	flush_dcache_phys_range(dart_tablebase,
228 				dart_tablebase + dart_tablesize);
229 
230 	/* Allocate a spare page to map all invalid DART pages. We need to do
231 	 * that to work around what looks like a problem with the HT bridge
232 	 * prefetching into invalid pages and corrupting data
233 	 */
234 	tmp = lmb_alloc(DART_PAGE_SIZE, DART_PAGE_SIZE);
235 	dart_emptyval = DARTMAP_VALID | ((tmp >> DART_PAGE_SHIFT) &
236 					 DARTMAP_RPNMASK);
237 
238 	/* Map in DART registers */
239 	dart = ioremap(r.start, r.end - r.start + 1);
240 	if (dart == NULL)
241 		panic("DART: Cannot map registers!");
242 
243 	/* Map in DART table */
244 	dart_vbase = ioremap(virt_to_abs(dart_tablebase), dart_tablesize);
245 
246 	/* Fill initial table */
247 	for (i = 0; i < dart_tablesize/4; i++)
248 		dart_vbase[i] = dart_emptyval;
249 
250 	/* Initialize DART with table base and enable it. */
251 	base = dart_tablebase >> DART_PAGE_SHIFT;
252 	size = dart_tablesize >> DART_PAGE_SHIFT;
253 	if (dart_is_u4) {
254 		size &= DART_SIZE_U4_SIZE_MASK;
255 		DART_OUT(DART_BASE_U4, base);
256 		DART_OUT(DART_SIZE_U4, size);
257 		DART_OUT(DART_CNTL, DART_CNTL_U4_ENABLE);
258 	} else {
259 		size &= DART_CNTL_U3_SIZE_MASK;
260 		DART_OUT(DART_CNTL,
261 			 DART_CNTL_U3_ENABLE |
262 			 (base << DART_CNTL_U3_BASE_SHIFT) |
263 			 (size << DART_CNTL_U3_SIZE_SHIFT));
264 	}
265 
266 	/* Invalidate DART to get rid of possible stale TLBs */
267 	dart_tlb_invalidate_all();
268 
269 	printk(KERN_INFO "DART IOMMU initialized for %s type chipset\n",
270 	       dart_is_u4 ? "U4" : "U3");
271 
272 	return 0;
273 }
274 
275 static void iommu_table_dart_setup(void)
276 {
277 	iommu_table_dart.it_busno = 0;
278 	iommu_table_dart.it_offset = 0;
279 	/* it_size is in number of entries */
280 	iommu_table_dart.it_size = dart_tablesize / sizeof(u32);
281 
282 	/* Initialize the common IOMMU code */
283 	iommu_table_dart.it_base = (unsigned long)dart_vbase;
284 	iommu_table_dart.it_index = 0;
285 	iommu_table_dart.it_blocksize = 1;
286 	iommu_init_table(&iommu_table_dart, -1);
287 
288 	/* Reserve the last page of the DART to avoid possible prefetch
289 	 * past the DART mapped area
290 	 */
291 	set_bit(iommu_table_dart.it_size - 1, iommu_table_dart.it_map);
292 }
293 
294 static void pci_dma_dev_setup_dart(struct pci_dev *dev)
295 {
296 	/* We only have one iommu table on the mac for now, which makes
297 	 * things simple. Setup all PCI devices to point to this table
298 	 */
299 	dev->dev.archdata.dma_data = &iommu_table_dart;
300 }
301 
302 static void pci_dma_bus_setup_dart(struct pci_bus *bus)
303 {
304 	struct device_node *dn;
305 
306 	if (!iommu_table_dart_inited) {
307 		iommu_table_dart_inited = 1;
308 		iommu_table_dart_setup();
309 	}
310 
311 	dn = pci_bus_to_OF_node(bus);
312 
313 	if (dn)
314 		PCI_DN(dn)->iommu_table = &iommu_table_dart;
315 }
316 
317 void __init iommu_init_early_dart(void)
318 {
319 	struct device_node *dn;
320 
321 	/* Find the DART in the device-tree */
322 	dn = of_find_compatible_node(NULL, "dart", "u3-dart");
323 	if (dn == NULL) {
324 		dn = of_find_compatible_node(NULL, "dart", "u4-dart");
325 		if (dn == NULL)
326 			goto bail;
327 		dart_is_u4 = 1;
328 	}
329 
330 	/* Setup low level TCE operations for the core IOMMU code */
331 	ppc_md.tce_build = dart_build;
332 	ppc_md.tce_free  = dart_free;
333 	ppc_md.tce_flush = dart_flush;
334 
335 	/* Initialize the DART HW */
336 	if (dart_init(dn) == 0) {
337 		ppc_md.pci_dma_dev_setup = pci_dma_dev_setup_dart;
338 		ppc_md.pci_dma_bus_setup = pci_dma_bus_setup_dart;
339 
340 		/* Setup pci_dma ops */
341 		set_pci_dma_ops(&dma_iommu_ops);
342 		return;
343 	}
344 
345  bail:
346 	/* If init failed, use direct iommu and null setup functions */
347 	ppc_md.pci_dma_dev_setup = NULL;
348 	ppc_md.pci_dma_bus_setup = NULL;
349 
350 	/* Setup pci_dma ops */
351 	set_pci_dma_ops(&dma_direct_ops);
352 }
353 
354 #ifdef CONFIG_PM
355 static void iommu_dart_save(void)
356 {
357 	memcpy(dart_copy, dart_vbase, 2*1024*1024);
358 }
359 
360 static void iommu_dart_restore(void)
361 {
362 	memcpy(dart_vbase, dart_copy, 2*1024*1024);
363 	dart_tlb_invalidate_all();
364 }
365 
366 static int __init iommu_init_late_dart(void)
367 {
368 	unsigned long tbasepfn;
369 	struct page *p;
370 
371 	/* if no dart table exists then we won't need to save it
372 	 * and the area has also not been reserved */
373 	if (!dart_tablebase)
374 		return 0;
375 
376 	tbasepfn = __pa(dart_tablebase) >> PAGE_SHIFT;
377 	register_nosave_region_late(tbasepfn,
378 				    tbasepfn + ((1<<24) >> PAGE_SHIFT));
379 
380 	/* For suspend we need to copy the dart contents because
381 	 * it is not part of the regular mapping (see above) and
382 	 * thus not saved automatically. The memory for this copy
383 	 * must be allocated early because we need 2 MB. */
384 	p = alloc_pages(GFP_KERNEL, 21 - PAGE_SHIFT);
385 	BUG_ON(!p);
386 	dart_copy = page_address(p);
387 
388 	ppc_md.iommu_save = iommu_dart_save;
389 	ppc_md.iommu_restore = iommu_dart_restore;
390 
391 	return 0;
392 }
393 
394 late_initcall(iommu_init_late_dart);
395 #endif
396 
397 void __init alloc_dart_table(void)
398 {
399 	/* Only reserve DART space if machine has more than 1GB of RAM
400 	 * or if requested with iommu=on on cmdline.
401 	 *
402 	 * 1GB of RAM is picked as limit because some default devices
403 	 * (i.e. Airport Extreme) have 30 bit address range limits.
404 	 */
405 
406 	if (iommu_is_off)
407 		return;
408 
409 	if (!iommu_force_on && lmb_end_of_DRAM() <= 0x40000000ull)
410 		return;
411 
412 	/* 512 pages (2MB) is max DART tablesize. */
413 	dart_tablesize = 1UL << 21;
414 	/* 16MB (1 << 24) alignment. We allocate a full 16Mb chuck since we
415 	 * will blow up an entire large page anyway in the kernel mapping
416 	 */
417 	dart_tablebase = (unsigned long)
418 		abs_to_virt(lmb_alloc_base(1UL<<24, 1UL<<24, 0x80000000L));
419 
420 	printk(KERN_INFO "DART table allocated at: %lx\n", dart_tablebase);
421 }
422