Merge branch 'sglist-arch' into for-linus
[linux-2.6] / arch / powerpc / kernel / iommu.c
1 /*
2  * Copyright (C) 2001 Mike Corrigan & Dave Engebretsen, IBM Corporation
3  * 
4  * Rewrite, cleanup, new allocation schemes, virtual merging: 
5  * Copyright (C) 2004 Olof Johansson, IBM Corporation
6  *               and  Ben. Herrenschmidt, IBM Corporation
7  *
8  * Dynamic DMA mapping support, bus-independent parts.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  * 
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  * 
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
23  */
24
25
26 #include <linux/init.h>
27 #include <linux/types.h>
28 #include <linux/slab.h>
29 #include <linux/mm.h>
30 #include <linux/spinlock.h>
31 #include <linux/string.h>
32 #include <linux/dma-mapping.h>
33 #include <linux/bitops.h>
34 #include <asm/io.h>
35 #include <asm/prom.h>
36 #include <asm/iommu.h>
37 #include <asm/pci-bridge.h>
38 #include <asm/machdep.h>
39 #include <asm/kdump.h>
40
41 #define DBG(...)
42
43 #ifdef CONFIG_IOMMU_VMERGE
44 static int novmerge = 0;
45 #else
46 static int novmerge = 1;
47 #endif
48
49 static int protect4gb = 1;
50
51 static inline unsigned long iommu_num_pages(unsigned long vaddr,
52                                             unsigned long slen)
53 {
54         unsigned long npages;
55
56         npages = IOMMU_PAGE_ALIGN(vaddr + slen) - (vaddr & IOMMU_PAGE_MASK);
57         npages >>= IOMMU_PAGE_SHIFT;
58
59         return npages;
60 }
61
62 static int __init setup_protect4gb(char *str)
63 {
64         if (strcmp(str, "on") == 0)
65                 protect4gb = 1;
66         else if (strcmp(str, "off") == 0)
67                 protect4gb = 0;
68
69         return 1;
70 }
71
72 static int __init setup_iommu(char *str)
73 {
74         if (!strcmp(str, "novmerge"))
75                 novmerge = 1;
76         else if (!strcmp(str, "vmerge"))
77                 novmerge = 0;
78         return 1;
79 }
80
81 __setup("protect4gb=", setup_protect4gb);
82 __setup("iommu=", setup_iommu);
83
84 static unsigned long iommu_range_alloc(struct iommu_table *tbl,
85                                        unsigned long npages,
86                                        unsigned long *handle,
87                                        unsigned long mask,
88                                        unsigned int align_order)
89
90         unsigned long n, end, i, start;
91         unsigned long limit;
92         int largealloc = npages > 15;
93         int pass = 0;
94         unsigned long align_mask;
95
96         align_mask = 0xffffffffffffffffl >> (64 - align_order);
97
98         /* This allocator was derived from x86_64's bit string search */
99
100         /* Sanity check */
101         if (unlikely(npages == 0)) {
102                 if (printk_ratelimit())
103                         WARN_ON(1);
104                 return DMA_ERROR_CODE;
105         }
106
107         if (handle && *handle)
108                 start = *handle;
109         else
110                 start = largealloc ? tbl->it_largehint : tbl->it_hint;
111
112         /* Use only half of the table for small allocs (15 pages or less) */
113         limit = largealloc ? tbl->it_size : tbl->it_halfpoint;
114
115         if (largealloc && start < tbl->it_halfpoint)
116                 start = tbl->it_halfpoint;
117
118         /* The case below can happen if we have a small segment appended
119          * to a large, or when the previous alloc was at the very end of
120          * the available space. If so, go back to the initial start.
121          */
122         if (start >= limit)
123                 start = largealloc ? tbl->it_largehint : tbl->it_hint;
124
125  again:
126
127         if (limit + tbl->it_offset > mask) {
128                 limit = mask - tbl->it_offset + 1;
129                 /* If we're constrained on address range, first try
130                  * at the masked hint to avoid O(n) search complexity,
131                  * but on second pass, start at 0.
132                  */
133                 if ((start & mask) >= limit || pass > 0)
134                         start = 0;
135                 else
136                         start &= mask;
137         }
138
139         n = find_next_zero_bit(tbl->it_map, limit, start);
140
141         /* Align allocation */
142         n = (n + align_mask) & ~align_mask;
143
144         end = n + npages;
145
146         if (unlikely(end >= limit)) {
147                 if (likely(pass < 2)) {
148                         /* First failure, just rescan the half of the table.
149                          * Second failure, rescan the other half of the table.
150                          */
151                         start = (largealloc ^ pass) ? tbl->it_halfpoint : 0;
152                         limit = pass ? tbl->it_size : limit;
153                         pass++;
154                         goto again;
155                 } else {
156                         /* Third failure, give up */
157                         return DMA_ERROR_CODE;
158                 }
159         }
160
161         for (i = n; i < end; i++)
162                 if (test_bit(i, tbl->it_map)) {
163                         start = i+1;
164                         goto again;
165                 }
166
167         for (i = n; i < end; i++)
168                 __set_bit(i, tbl->it_map);
169
170         /* Bump the hint to a new block for small allocs. */
171         if (largealloc) {
172                 /* Don't bump to new block to avoid fragmentation */
173                 tbl->it_largehint = end;
174         } else {
175                 /* Overflow will be taken care of at the next allocation */
176                 tbl->it_hint = (end + tbl->it_blocksize - 1) &
177                                 ~(tbl->it_blocksize - 1);
178         }
179
180         /* Update handle for SG allocations */
181         if (handle)
182                 *handle = end;
183
184         return n;
185 }
186
187 static dma_addr_t iommu_alloc(struct iommu_table *tbl, void *page,
188                        unsigned int npages, enum dma_data_direction direction,
189                        unsigned long mask, unsigned int align_order)
190 {
191         unsigned long entry, flags;
192         dma_addr_t ret = DMA_ERROR_CODE;
193
194         spin_lock_irqsave(&(tbl->it_lock), flags);
195
196         entry = iommu_range_alloc(tbl, npages, NULL, mask, align_order);
197
198         if (unlikely(entry == DMA_ERROR_CODE)) {
199                 spin_unlock_irqrestore(&(tbl->it_lock), flags);
200                 return DMA_ERROR_CODE;
201         }
202
203         entry += tbl->it_offset;        /* Offset into real TCE table */
204         ret = entry << IOMMU_PAGE_SHIFT;        /* Set the return dma address */
205
206         /* Put the TCEs in the HW table */
207         ppc_md.tce_build(tbl, entry, npages, (unsigned long)page & IOMMU_PAGE_MASK,
208                          direction);
209
210
211         /* Flush/invalidate TLB caches if necessary */
212         if (ppc_md.tce_flush)
213                 ppc_md.tce_flush(tbl);
214
215         spin_unlock_irqrestore(&(tbl->it_lock), flags);
216
217         /* Make sure updates are seen by hardware */
218         mb();
219
220         return ret;
221 }
222
223 static void __iommu_free(struct iommu_table *tbl, dma_addr_t dma_addr, 
224                          unsigned int npages)
225 {
226         unsigned long entry, free_entry;
227         unsigned long i;
228
229         entry = dma_addr >> IOMMU_PAGE_SHIFT;
230         free_entry = entry - tbl->it_offset;
231
232         if (((free_entry + npages) > tbl->it_size) ||
233             (entry < tbl->it_offset)) {
234                 if (printk_ratelimit()) {
235                         printk(KERN_INFO "iommu_free: invalid entry\n");
236                         printk(KERN_INFO "\tentry     = 0x%lx\n", entry); 
237                         printk(KERN_INFO "\tdma_addr  = 0x%lx\n", (u64)dma_addr);
238                         printk(KERN_INFO "\tTable     = 0x%lx\n", (u64)tbl);
239                         printk(KERN_INFO "\tbus#      = 0x%lx\n", (u64)tbl->it_busno);
240                         printk(KERN_INFO "\tsize      = 0x%lx\n", (u64)tbl->it_size);
241                         printk(KERN_INFO "\tstartOff  = 0x%lx\n", (u64)tbl->it_offset);
242                         printk(KERN_INFO "\tindex     = 0x%lx\n", (u64)tbl->it_index);
243                         WARN_ON(1);
244                 }
245                 return;
246         }
247
248         ppc_md.tce_free(tbl, entry, npages);
249         
250         for (i = 0; i < npages; i++)
251                 __clear_bit(free_entry+i, tbl->it_map);
252 }
253
254 static void iommu_free(struct iommu_table *tbl, dma_addr_t dma_addr,
255                 unsigned int npages)
256 {
257         unsigned long flags;
258
259         spin_lock_irqsave(&(tbl->it_lock), flags);
260
261         __iommu_free(tbl, dma_addr, npages);
262
263         /* Make sure TLB cache is flushed if the HW needs it. We do
264          * not do an mb() here on purpose, it is not needed on any of
265          * the current platforms.
266          */
267         if (ppc_md.tce_flush)
268                 ppc_md.tce_flush(tbl);
269
270         spin_unlock_irqrestore(&(tbl->it_lock), flags);
271 }
272
273 int iommu_map_sg(struct iommu_table *tbl, struct scatterlist *sglist,
274                  int nelems, unsigned long mask,
275                  enum dma_data_direction direction)
276 {
277         dma_addr_t dma_next = 0, dma_addr;
278         unsigned long flags;
279         struct scatterlist *s, *outs, *segstart;
280         int outcount, incount, i;
281         unsigned long handle;
282
283         BUG_ON(direction == DMA_NONE);
284
285         if ((nelems == 0) || !tbl)
286                 return 0;
287
288         outs = s = segstart = &sglist[0];
289         outcount = 1;
290         incount = nelems;
291         handle = 0;
292
293         /* Init first segment length for backout at failure */
294         outs->dma_length = 0;
295
296         DBG("sg mapping %d elements:\n", nelems);
297
298         spin_lock_irqsave(&(tbl->it_lock), flags);
299
300         for_each_sg(sglist, s, nelems, i) {
301                 unsigned long vaddr, npages, entry, slen;
302
303                 slen = s->length;
304                 /* Sanity check */
305                 if (slen == 0) {
306                         dma_next = 0;
307                         continue;
308                 }
309                 /* Allocate iommu entries for that segment */
310                 vaddr = (unsigned long)page_address(s->page) + s->offset;
311                 npages = iommu_num_pages(vaddr, slen);
312                 entry = iommu_range_alloc(tbl, npages, &handle, mask >> IOMMU_PAGE_SHIFT, 0);
313
314                 DBG("  - vaddr: %lx, size: %lx\n", vaddr, slen);
315
316                 /* Handle failure */
317                 if (unlikely(entry == DMA_ERROR_CODE)) {
318                         if (printk_ratelimit())
319                                 printk(KERN_INFO "iommu_alloc failed, tbl %p vaddr %lx"
320                                        " npages %lx\n", tbl, vaddr, npages);
321                         goto failure;
322                 }
323
324                 /* Convert entry to a dma_addr_t */
325                 entry += tbl->it_offset;
326                 dma_addr = entry << IOMMU_PAGE_SHIFT;
327                 dma_addr |= (s->offset & ~IOMMU_PAGE_MASK);
328
329                 DBG("  - %lu pages, entry: %lx, dma_addr: %lx\n",
330                             npages, entry, dma_addr);
331
332                 /* Insert into HW table */
333                 ppc_md.tce_build(tbl, entry, npages, vaddr & IOMMU_PAGE_MASK, direction);
334
335                 /* If we are in an open segment, try merging */
336                 if (segstart != s) {
337                         DBG("  - trying merge...\n");
338                         /* We cannot merge if:
339                          * - allocated dma_addr isn't contiguous to previous allocation
340                          */
341                         if (novmerge || (dma_addr != dma_next)) {
342                                 /* Can't merge: create a new segment */
343                                 segstart = s;
344                                 outcount++;
345                                 outs = sg_next(outs);
346                                 DBG("    can't merge, new segment.\n");
347                         } else {
348                                 outs->dma_length += s->length;
349                                 DBG("    merged, new len: %ux\n", outs->dma_length);
350                         }
351                 }
352
353                 if (segstart == s) {
354                         /* This is a new segment, fill entries */
355                         DBG("  - filling new segment.\n");
356                         outs->dma_address = dma_addr;
357                         outs->dma_length = slen;
358                 }
359
360                 /* Calculate next page pointer for contiguous check */
361                 dma_next = dma_addr + slen;
362
363                 DBG("  - dma next is: %lx\n", dma_next);
364         }
365
366         /* Flush/invalidate TLB caches if necessary */
367         if (ppc_md.tce_flush)
368                 ppc_md.tce_flush(tbl);
369
370         spin_unlock_irqrestore(&(tbl->it_lock), flags);
371
372         DBG("mapped %d elements:\n", outcount);
373
374         /* For the sake of iommu_unmap_sg, we clear out the length in the
375          * next entry of the sglist if we didn't fill the list completely
376          */
377         if (outcount < incount) {
378                 outs = sg_next(outs);
379                 outs->dma_address = DMA_ERROR_CODE;
380                 outs->dma_length = 0;
381         }
382
383         /* Make sure updates are seen by hardware */
384         mb();
385
386         return outcount;
387
388  failure:
389         for_each_sg(sglist, s, nelems, i) {
390                 if (s->dma_length != 0) {
391                         unsigned long vaddr, npages;
392
393                         vaddr = s->dma_address & IOMMU_PAGE_MASK;
394                         npages = iommu_num_pages(s->dma_address, s->dma_length);
395                         __iommu_free(tbl, vaddr, npages);
396                         s->dma_address = DMA_ERROR_CODE;
397                         s->dma_length = 0;
398                 }
399                 if (s == outs)
400                         break;
401         }
402         spin_unlock_irqrestore(&(tbl->it_lock), flags);
403         return 0;
404 }
405
406
407 void iommu_unmap_sg(struct iommu_table *tbl, struct scatterlist *sglist,
408                 int nelems, enum dma_data_direction direction)
409 {
410         struct scatterlist *sg;
411         unsigned long flags;
412
413         BUG_ON(direction == DMA_NONE);
414
415         if (!tbl)
416                 return;
417
418         spin_lock_irqsave(&(tbl->it_lock), flags);
419
420         sg = sglist;
421         while (nelems--) {
422                 unsigned int npages;
423                 dma_addr_t dma_handle = sg->dma_address;
424
425                 if (sg->dma_length == 0)
426                         break;
427                 npages = iommu_num_pages(dma_handle, sg->dma_length);
428                 __iommu_free(tbl, dma_handle, npages);
429                 sg = sg_next(sg);
430         }
431
432         /* Flush/invalidate TLBs if necessary. As for iommu_free(), we
433          * do not do an mb() here, the affected platforms do not need it
434          * when freeing.
435          */
436         if (ppc_md.tce_flush)
437                 ppc_md.tce_flush(tbl);
438
439         spin_unlock_irqrestore(&(tbl->it_lock), flags);
440 }
441
442 /*
443  * Build a iommu_table structure.  This contains a bit map which
444  * is used to manage allocation of the tce space.
445  */
446 struct iommu_table *iommu_init_table(struct iommu_table *tbl, int nid)
447 {
448         unsigned long sz;
449         unsigned long start_index, end_index;
450         unsigned long entries_per_4g;
451         unsigned long index;
452         static int welcomed = 0;
453         struct page *page;
454
455         /* Set aside 1/4 of the table for large allocations. */
456         tbl->it_halfpoint = tbl->it_size * 3 / 4;
457
458         /* number of bytes needed for the bitmap */
459         sz = (tbl->it_size + 7) >> 3;
460
461         page = alloc_pages_node(nid, GFP_ATOMIC, get_order(sz));
462         if (!page)
463                 panic("iommu_init_table: Can't allocate %ld bytes\n", sz);
464         tbl->it_map = page_address(page);
465         memset(tbl->it_map, 0, sz);
466
467         tbl->it_hint = 0;
468         tbl->it_largehint = tbl->it_halfpoint;
469         spin_lock_init(&tbl->it_lock);
470
471 #ifdef CONFIG_CRASH_DUMP
472         if (ppc_md.tce_get) {
473                 unsigned long tceval;
474                 unsigned long tcecount = 0;
475
476                 /*
477                  * Reserve the existing mappings left by the first kernel.
478                  */
479                 for (index = 0; index < tbl->it_size; index++) {
480                         tceval = ppc_md.tce_get(tbl, index + tbl->it_offset);
481                         /*
482                          * Freed TCE entry contains 0x7fffffffffffffff on JS20
483                          */
484                         if (tceval && (tceval != 0x7fffffffffffffffUL)) {
485                                 __set_bit(index, tbl->it_map);
486                                 tcecount++;
487                         }
488                 }
489                 if ((tbl->it_size - tcecount) < KDUMP_MIN_TCE_ENTRIES) {
490                         printk(KERN_WARNING "TCE table is full; ");
491                         printk(KERN_WARNING "freeing %d entries for the kdump boot\n",
492                                 KDUMP_MIN_TCE_ENTRIES);
493                         for (index = tbl->it_size - KDUMP_MIN_TCE_ENTRIES;
494                                 index < tbl->it_size; index++)
495                                 __clear_bit(index, tbl->it_map);
496                 }
497         }
498 #else
499         /* Clear the hardware table in case firmware left allocations in it */
500         ppc_md.tce_free(tbl, tbl->it_offset, tbl->it_size);
501 #endif
502
503         /*
504          * DMA cannot cross 4 GB boundary.  Mark last entry of each 4
505          * GB chunk as reserved.
506          */
507         if (protect4gb) {
508                 entries_per_4g = 0x100000000l >> IOMMU_PAGE_SHIFT;
509
510                 /* Mark the last bit before a 4GB boundary as used */
511                 start_index = tbl->it_offset | (entries_per_4g - 1);
512                 start_index -= tbl->it_offset;
513
514                 end_index = tbl->it_size;
515
516                 for (index = start_index; index < end_index - 1; index += entries_per_4g)
517                         __set_bit(index, tbl->it_map);
518         }
519
520         if (!welcomed) {
521                 printk(KERN_INFO "IOMMU table initialized, virtual merging %s\n",
522                        novmerge ? "disabled" : "enabled");
523                 welcomed = 1;
524         }
525
526         return tbl;
527 }
528
529 void iommu_free_table(struct device_node *dn)
530 {
531         struct pci_dn *pdn = dn->data;
532         struct iommu_table *tbl = pdn->iommu_table;
533         unsigned long bitmap_sz, i;
534         unsigned int order;
535
536         if (!tbl || !tbl->it_map) {
537                 printk(KERN_ERR "%s: expected TCE map for %s\n", __FUNCTION__,
538                                 dn->full_name);
539                 return;
540         }
541
542         /* verify that table contains no entries */
543         /* it_size is in entries, and we're examining 64 at a time */
544         for (i = 0; i < (tbl->it_size/64); i++) {
545                 if (tbl->it_map[i] != 0) {
546                         printk(KERN_WARNING "%s: Unexpected TCEs for %s\n",
547                                 __FUNCTION__, dn->full_name);
548                         break;
549                 }
550         }
551
552         /* calculate bitmap size in bytes */
553         bitmap_sz = (tbl->it_size + 7) / 8;
554
555         /* free bitmap */
556         order = get_order(bitmap_sz);
557         free_pages((unsigned long) tbl->it_map, order);
558
559         /* free table */
560         kfree(tbl);
561 }
562
563 /* Creates TCEs for a user provided buffer.  The user buffer must be
564  * contiguous real kernel storage (not vmalloc).  The address of the buffer
565  * passed here is the kernel (virtual) address of the buffer.  The buffer
566  * need not be page aligned, the dma_addr_t returned will point to the same
567  * byte within the page as vaddr.
568  */
569 dma_addr_t iommu_map_single(struct iommu_table *tbl, void *vaddr,
570                 size_t size, unsigned long mask,
571                 enum dma_data_direction direction)
572 {
573         dma_addr_t dma_handle = DMA_ERROR_CODE;
574         unsigned long uaddr;
575         unsigned int npages;
576
577         BUG_ON(direction == DMA_NONE);
578
579         uaddr = (unsigned long)vaddr;
580         npages = iommu_num_pages(uaddr, size);
581
582         if (tbl) {
583                 dma_handle = iommu_alloc(tbl, vaddr, npages, direction,
584                                          mask >> IOMMU_PAGE_SHIFT, 0);
585                 if (dma_handle == DMA_ERROR_CODE) {
586                         if (printk_ratelimit())  {
587                                 printk(KERN_INFO "iommu_alloc failed, "
588                                                 "tbl %p vaddr %p npages %d\n",
589                                                 tbl, vaddr, npages);
590                         }
591                 } else
592                         dma_handle |= (uaddr & ~IOMMU_PAGE_MASK);
593         }
594
595         return dma_handle;
596 }
597
598 void iommu_unmap_single(struct iommu_table *tbl, dma_addr_t dma_handle,
599                 size_t size, enum dma_data_direction direction)
600 {
601         unsigned int npages;
602
603         BUG_ON(direction == DMA_NONE);
604
605         if (tbl) {
606                 npages = iommu_num_pages(dma_handle, size);
607                 iommu_free(tbl, dma_handle, npages);
608         }
609 }
610
611 /* Allocates a contiguous real buffer and creates mappings over it.
612  * Returns the virtual address of the buffer and sets dma_handle
613  * to the dma address (mapping) of the first page.
614  */
615 void *iommu_alloc_coherent(struct iommu_table *tbl, size_t size,
616                 dma_addr_t *dma_handle, unsigned long mask, gfp_t flag, int node)
617 {
618         void *ret = NULL;
619         dma_addr_t mapping;
620         unsigned int order;
621         unsigned int nio_pages, io_order;
622         struct page *page;
623
624         size = PAGE_ALIGN(size);
625         order = get_order(size);
626
627         /*
628          * Client asked for way too much space.  This is checked later
629          * anyway.  It is easier to debug here for the drivers than in
630          * the tce tables.
631          */
632         if (order >= IOMAP_MAX_ORDER) {
633                 printk("iommu_alloc_consistent size too large: 0x%lx\n", size);
634                 return NULL;
635         }
636
637         if (!tbl)
638                 return NULL;
639
640         /* Alloc enough pages (and possibly more) */
641         page = alloc_pages_node(node, flag, order);
642         if (!page)
643                 return NULL;
644         ret = page_address(page);
645         memset(ret, 0, size);
646
647         /* Set up tces to cover the allocated range */
648         nio_pages = size >> IOMMU_PAGE_SHIFT;
649         io_order = get_iommu_order(size);
650         mapping = iommu_alloc(tbl, ret, nio_pages, DMA_BIDIRECTIONAL,
651                               mask >> IOMMU_PAGE_SHIFT, io_order);
652         if (mapping == DMA_ERROR_CODE) {
653                 free_pages((unsigned long)ret, order);
654                 return NULL;
655         }
656         *dma_handle = mapping;
657         return ret;
658 }
659
660 void iommu_free_coherent(struct iommu_table *tbl, size_t size,
661                          void *vaddr, dma_addr_t dma_handle)
662 {
663         if (tbl) {
664                 unsigned int nio_pages;
665
666                 size = PAGE_ALIGN(size);
667                 nio_pages = size >> IOMMU_PAGE_SHIFT;
668                 iommu_free(tbl, dma_handle, nio_pages);
669                 size = PAGE_ALIGN(size);
670                 free_pages((unsigned long)vaddr, get_order(size));
671         }
672 }