swiotlb: add comment where we handle the overflow of a dma mask on 32 bit
[linux-3.10.git] / lib / swiotlb.c
1 /*
2  * Dynamic DMA mapping support.
3  *
4  * This implementation is a fallback for platforms that do not support
5  * I/O TLBs (aka DMA address translation hardware).
6  * Copyright (C) 2000 Asit Mallick <Asit.K.Mallick@intel.com>
7  * Copyright (C) 2000 Goutham Rao <goutham.rao@intel.com>
8  * Copyright (C) 2000, 2003 Hewlett-Packard Co
9  *      David Mosberger-Tang <davidm@hpl.hp.com>
10  *
11  * 03/05/07 davidm      Switch from PCI-DMA to generic device DMA API.
12  * 00/12/13 davidm      Rename to swiotlb.c and add mark_clean() to avoid
13  *                      unnecessary i-cache flushing.
14  * 04/07/.. ak          Better overflow handling. Assorted fixes.
15  * 05/09/10 linville    Add support for syncing ranges, support syncing for
16  *                      DMA_BIDIRECTIONAL mappings, miscellaneous cleanup.
17  */
18
19 #include <linux/cache.h>
20 #include <linux/dma-mapping.h>
21 #include <linux/mm.h>
22 #include <linux/module.h>
23 #include <linux/spinlock.h>
24 #include <linux/swiotlb.h>
25 #include <linux/string.h>
26 #include <linux/swiotlb.h>
27 #include <linux/types.h>
28 #include <linux/ctype.h>
29
30 #include <asm/io.h>
31 #include <asm/dma.h>
32 #include <asm/scatterlist.h>
33
34 #include <linux/init.h>
35 #include <linux/bootmem.h>
36 #include <linux/iommu-helper.h>
37
38 #define OFFSET(val,align) ((unsigned long)      \
39                            ( (val) & ( (align) - 1)))
40
41 #define SG_ENT_VIRT_ADDRESS(sg) (sg_virt((sg)))
42 #define SG_ENT_PHYS_ADDRESS(sg) virt_to_bus(SG_ENT_VIRT_ADDRESS(sg))
43
44 #define SLABS_PER_PAGE (1 << (PAGE_SHIFT - IO_TLB_SHIFT))
45
46 /*
47  * Minimum IO TLB size to bother booting with.  Systems with mainly
48  * 64bit capable cards will only lightly use the swiotlb.  If we can't
49  * allocate a contiguous 1MB, we're probably in trouble anyway.
50  */
51 #define IO_TLB_MIN_SLABS ((1<<20) >> IO_TLB_SHIFT)
52
53 /*
54  * Enumeration for sync targets
55  */
56 enum dma_sync_target {
57         SYNC_FOR_CPU = 0,
58         SYNC_FOR_DEVICE = 1,
59 };
60
61 int swiotlb_force;
62
63 /*
64  * Used to do a quick range check in swiotlb_unmap_single and
65  * swiotlb_sync_single_*, to see if the memory was in fact allocated by this
66  * API.
67  */
68 static char *io_tlb_start, *io_tlb_end;
69
70 /*
71  * The number of IO TLB blocks (in groups of 64) betweeen io_tlb_start and
72  * io_tlb_end.  This is command line adjustable via setup_io_tlb_npages.
73  */
74 static unsigned long io_tlb_nslabs;
75
76 /*
77  * When the IOMMU overflows we return a fallback buffer. This sets the size.
78  */
79 static unsigned long io_tlb_overflow = 32*1024;
80
81 void *io_tlb_overflow_buffer;
82
83 /*
84  * This is a free list describing the number of free entries available from
85  * each index
86  */
87 static unsigned int *io_tlb_list;
88 static unsigned int io_tlb_index;
89
90 /*
91  * We need to save away the original address corresponding to a mapped entry
92  * for the sync operations.
93  */
94 static unsigned char **io_tlb_orig_addr;
95
96 /*
97  * Protect the above data structures in the map and unmap calls
98  */
99 static DEFINE_SPINLOCK(io_tlb_lock);
100
101 static int __init
102 setup_io_tlb_npages(char *str)
103 {
104         if (isdigit(*str)) {
105                 io_tlb_nslabs = simple_strtoul(str, &str, 0);
106                 /* avoid tail segment of size < IO_TLB_SEGSIZE */
107                 io_tlb_nslabs = ALIGN(io_tlb_nslabs, IO_TLB_SEGSIZE);
108         }
109         if (*str == ',')
110                 ++str;
111         if (!strcmp(str, "force"))
112                 swiotlb_force = 1;
113         return 1;
114 }
115 __setup("swiotlb=", setup_io_tlb_npages);
116 /* make io_tlb_overflow tunable too? */
117
118 void * __weak swiotlb_alloc_boot(size_t size, unsigned long nslabs)
119 {
120         return alloc_bootmem_low_pages(size);
121 }
122
123 void * __weak swiotlb_alloc(unsigned order, unsigned long nslabs)
124 {
125         return (void *)__get_free_pages(GFP_DMA | __GFP_NOWARN, order);
126 }
127
128 /*
129  * Statically reserve bounce buffer space and initialize bounce buffer data
130  * structures for the software IO TLB used to implement the DMA API.
131  */
132 void __init
133 swiotlb_init_with_default_size(size_t default_size)
134 {
135         unsigned long i, bytes;
136
137         if (!io_tlb_nslabs) {
138                 io_tlb_nslabs = (default_size >> IO_TLB_SHIFT);
139                 io_tlb_nslabs = ALIGN(io_tlb_nslabs, IO_TLB_SEGSIZE);
140         }
141
142         bytes = io_tlb_nslabs << IO_TLB_SHIFT;
143
144         /*
145          * Get IO TLB memory from the low pages
146          */
147         io_tlb_start = swiotlb_alloc_boot(bytes, io_tlb_nslabs);
148         if (!io_tlb_start)
149                 panic("Cannot allocate SWIOTLB buffer");
150         io_tlb_end = io_tlb_start + bytes;
151
152         /*
153          * Allocate and initialize the free list array.  This array is used
154          * to find contiguous free memory regions of size up to IO_TLB_SEGSIZE
155          * between io_tlb_start and io_tlb_end.
156          */
157         io_tlb_list = alloc_bootmem(io_tlb_nslabs * sizeof(int));
158         for (i = 0; i < io_tlb_nslabs; i++)
159                 io_tlb_list[i] = IO_TLB_SEGSIZE - OFFSET(i, IO_TLB_SEGSIZE);
160         io_tlb_index = 0;
161         io_tlb_orig_addr = alloc_bootmem(io_tlb_nslabs * sizeof(char *));
162
163         /*
164          * Get the overflow emergency buffer
165          */
166         io_tlb_overflow_buffer = alloc_bootmem_low(io_tlb_overflow);
167         if (!io_tlb_overflow_buffer)
168                 panic("Cannot allocate SWIOTLB overflow buffer!\n");
169
170         printk(KERN_INFO "Placing software IO TLB between 0x%lx - 0x%lx\n",
171                virt_to_bus(io_tlb_start), virt_to_bus(io_tlb_end));
172 }
173
174 void __init
175 swiotlb_init(void)
176 {
177         swiotlb_init_with_default_size(64 * (1<<20));   /* default to 64MB */
178 }
179
180 /*
181  * Systems with larger DMA zones (those that don't support ISA) can
182  * initialize the swiotlb later using the slab allocator if needed.
183  * This should be just like above, but with some error catching.
184  */
185 int
186 swiotlb_late_init_with_default_size(size_t default_size)
187 {
188         unsigned long i, bytes, req_nslabs = io_tlb_nslabs;
189         unsigned int order;
190
191         if (!io_tlb_nslabs) {
192                 io_tlb_nslabs = (default_size >> IO_TLB_SHIFT);
193                 io_tlb_nslabs = ALIGN(io_tlb_nslabs, IO_TLB_SEGSIZE);
194         }
195
196         /*
197          * Get IO TLB memory from the low pages
198          */
199         order = get_order(io_tlb_nslabs << IO_TLB_SHIFT);
200         io_tlb_nslabs = SLABS_PER_PAGE << order;
201         bytes = io_tlb_nslabs << IO_TLB_SHIFT;
202
203         while ((SLABS_PER_PAGE << order) > IO_TLB_MIN_SLABS) {
204                 io_tlb_start = swiotlb_alloc(order, io_tlb_nslabs);
205                 if (io_tlb_start)
206                         break;
207                 order--;
208         }
209
210         if (!io_tlb_start)
211                 goto cleanup1;
212
213         if (order != get_order(bytes)) {
214                 printk(KERN_WARNING "Warning: only able to allocate %ld MB "
215                        "for software IO TLB\n", (PAGE_SIZE << order) >> 20);
216                 io_tlb_nslabs = SLABS_PER_PAGE << order;
217                 bytes = io_tlb_nslabs << IO_TLB_SHIFT;
218         }
219         io_tlb_end = io_tlb_start + bytes;
220         memset(io_tlb_start, 0, bytes);
221
222         /*
223          * Allocate and initialize the free list array.  This array is used
224          * to find contiguous free memory regions of size up to IO_TLB_SEGSIZE
225          * between io_tlb_start and io_tlb_end.
226          */
227         io_tlb_list = (unsigned int *)__get_free_pages(GFP_KERNEL,
228                                       get_order(io_tlb_nslabs * sizeof(int)));
229         if (!io_tlb_list)
230                 goto cleanup2;
231
232         for (i = 0; i < io_tlb_nslabs; i++)
233                 io_tlb_list[i] = IO_TLB_SEGSIZE - OFFSET(i, IO_TLB_SEGSIZE);
234         io_tlb_index = 0;
235
236         io_tlb_orig_addr = (unsigned char **)__get_free_pages(GFP_KERNEL,
237                                    get_order(io_tlb_nslabs * sizeof(char *)));
238         if (!io_tlb_orig_addr)
239                 goto cleanup3;
240
241         memset(io_tlb_orig_addr, 0, io_tlb_nslabs * sizeof(char *));
242
243         /*
244          * Get the overflow emergency buffer
245          */
246         io_tlb_overflow_buffer = (void *)__get_free_pages(GFP_DMA,
247                                                   get_order(io_tlb_overflow));
248         if (!io_tlb_overflow_buffer)
249                 goto cleanup4;
250
251         printk(KERN_INFO "Placing %luMB software IO TLB between 0x%lx - "
252                "0x%lx\n", bytes >> 20,
253                virt_to_bus(io_tlb_start), virt_to_bus(io_tlb_end));
254
255         return 0;
256
257 cleanup4:
258         free_pages((unsigned long)io_tlb_orig_addr, get_order(io_tlb_nslabs *
259                                                               sizeof(char *)));
260         io_tlb_orig_addr = NULL;
261 cleanup3:
262         free_pages((unsigned long)io_tlb_list, get_order(io_tlb_nslabs *
263                                                          sizeof(int)));
264         io_tlb_list = NULL;
265 cleanup2:
266         io_tlb_end = NULL;
267         free_pages((unsigned long)io_tlb_start, order);
268         io_tlb_start = NULL;
269 cleanup1:
270         io_tlb_nslabs = req_nslabs;
271         return -ENOMEM;
272 }
273
274 static int
275 address_needs_mapping(struct device *hwdev, dma_addr_t addr, size_t size)
276 {
277         return !is_buffer_dma_capable(dma_get_mask(hwdev), addr, size);
278 }
279
280 static int is_swiotlb_buffer(char *addr)
281 {
282         return addr >= io_tlb_start && addr < io_tlb_end;
283 }
284
285 /*
286  * Allocates bounce buffer and returns its kernel virtual address.
287  */
288 static void *
289 map_single(struct device *hwdev, char *buffer, size_t size, int dir)
290 {
291         unsigned long flags;
292         char *dma_addr;
293         unsigned int nslots, stride, index, wrap;
294         int i;
295         unsigned long start_dma_addr;
296         unsigned long mask;
297         unsigned long offset_slots;
298         unsigned long max_slots;
299
300         mask = dma_get_seg_boundary(hwdev);
301         start_dma_addr = virt_to_bus(io_tlb_start) & mask;
302
303         offset_slots = ALIGN(start_dma_addr, 1 << IO_TLB_SHIFT) >> IO_TLB_SHIFT;
304
305         /*
306          * Carefully handle integer overflow which can occur when mask == ~0UL.
307          */
308         max_slots = mask + 1
309                     ? ALIGN(mask + 1, 1 << IO_TLB_SHIFT) >> IO_TLB_SHIFT
310                     : 1UL << (BITS_PER_LONG - IO_TLB_SHIFT);
311
312         /*
313          * For mappings greater than a page, we limit the stride (and
314          * hence alignment) to a page size.
315          */
316         nslots = ALIGN(size, 1 << IO_TLB_SHIFT) >> IO_TLB_SHIFT;
317         if (size > PAGE_SIZE)
318                 stride = (1 << (PAGE_SHIFT - IO_TLB_SHIFT));
319         else
320                 stride = 1;
321
322         BUG_ON(!nslots);
323
324         /*
325          * Find suitable number of IO TLB entries size that will fit this
326          * request and allocate a buffer from that IO TLB pool.
327          */
328         spin_lock_irqsave(&io_tlb_lock, flags);
329         index = ALIGN(io_tlb_index, stride);
330         if (index >= io_tlb_nslabs)
331                 index = 0;
332         wrap = index;
333
334         do {
335                 while (iommu_is_span_boundary(index, nslots, offset_slots,
336                                               max_slots)) {
337                         index += stride;
338                         if (index >= io_tlb_nslabs)
339                                 index = 0;
340                         if (index == wrap)
341                                 goto not_found;
342                 }
343
344                 /*
345                  * If we find a slot that indicates we have 'nslots' number of
346                  * contiguous buffers, we allocate the buffers from that slot
347                  * and mark the entries as '0' indicating unavailable.
348                  */
349                 if (io_tlb_list[index] >= nslots) {
350                         int count = 0;
351
352                         for (i = index; i < (int) (index + nslots); i++)
353                                 io_tlb_list[i] = 0;
354                         for (i = index - 1; (OFFSET(i, IO_TLB_SEGSIZE) != IO_TLB_SEGSIZE - 1) && io_tlb_list[i]; i--)
355                                 io_tlb_list[i] = ++count;
356                         dma_addr = io_tlb_start + (index << IO_TLB_SHIFT);
357
358                         /*
359                          * Update the indices to avoid searching in the next
360                          * round.
361                          */
362                         io_tlb_index = ((index + nslots) < io_tlb_nslabs
363                                         ? (index + nslots) : 0);
364
365                         goto found;
366                 }
367                 index += stride;
368                 if (index >= io_tlb_nslabs)
369                         index = 0;
370         } while (index != wrap);
371
372 not_found:
373         spin_unlock_irqrestore(&io_tlb_lock, flags);
374         return NULL;
375 found:
376         spin_unlock_irqrestore(&io_tlb_lock, flags);
377
378         /*
379          * Save away the mapping from the original address to the DMA address.
380          * This is needed when we sync the memory.  Then we sync the buffer if
381          * needed.
382          */
383         for (i = 0; i < nslots; i++)
384                 io_tlb_orig_addr[index+i] = buffer + (i << IO_TLB_SHIFT);
385         if (dir == DMA_TO_DEVICE || dir == DMA_BIDIRECTIONAL)
386                 memcpy(dma_addr, buffer, size);
387
388         return dma_addr;
389 }
390
391 /*
392  * dma_addr is the kernel virtual address of the bounce buffer to unmap.
393  */
394 static void
395 unmap_single(struct device *hwdev, char *dma_addr, size_t size, int dir)
396 {
397         unsigned long flags;
398         int i, count, nslots = ALIGN(size, 1 << IO_TLB_SHIFT) >> IO_TLB_SHIFT;
399         int index = (dma_addr - io_tlb_start) >> IO_TLB_SHIFT;
400         char *buffer = io_tlb_orig_addr[index];
401
402         /*
403          * First, sync the memory before unmapping the entry
404          */
405         if (buffer && ((dir == DMA_FROM_DEVICE) || (dir == DMA_BIDIRECTIONAL)))
406                 /*
407                  * bounce... copy the data back into the original buffer * and
408                  * delete the bounce buffer.
409                  */
410                 memcpy(buffer, dma_addr, size);
411
412         /*
413          * Return the buffer to the free list by setting the corresponding
414          * entries to indicate the number of contigous entries available.
415          * While returning the entries to the free list, we merge the entries
416          * with slots below and above the pool being returned.
417          */
418         spin_lock_irqsave(&io_tlb_lock, flags);
419         {
420                 count = ((index + nslots) < ALIGN(index + 1, IO_TLB_SEGSIZE) ?
421                          io_tlb_list[index + nslots] : 0);
422                 /*
423                  * Step 1: return the slots to the free list, merging the
424                  * slots with superceeding slots
425                  */
426                 for (i = index + nslots - 1; i >= index; i--)
427                         io_tlb_list[i] = ++count;
428                 /*
429                  * Step 2: merge the returned slots with the preceding slots,
430                  * if available (non zero)
431                  */
432                 for (i = index - 1; (OFFSET(i, IO_TLB_SEGSIZE) != IO_TLB_SEGSIZE -1) && io_tlb_list[i]; i--)
433                         io_tlb_list[i] = ++count;
434         }
435         spin_unlock_irqrestore(&io_tlb_lock, flags);
436 }
437
438 static void
439 sync_single(struct device *hwdev, char *dma_addr, size_t size,
440             int dir, int target)
441 {
442         int index = (dma_addr - io_tlb_start) >> IO_TLB_SHIFT;
443         char *buffer = io_tlb_orig_addr[index];
444
445         buffer += ((unsigned long)dma_addr & ((1 << IO_TLB_SHIFT) - 1));
446
447         switch (target) {
448         case SYNC_FOR_CPU:
449                 if (likely(dir == DMA_FROM_DEVICE || dir == DMA_BIDIRECTIONAL))
450                         memcpy(buffer, dma_addr, size);
451                 else
452                         BUG_ON(dir != DMA_TO_DEVICE);
453                 break;
454         case SYNC_FOR_DEVICE:
455                 if (likely(dir == DMA_TO_DEVICE || dir == DMA_BIDIRECTIONAL))
456                         memcpy(dma_addr, buffer, size);
457                 else
458                         BUG_ON(dir != DMA_FROM_DEVICE);
459                 break;
460         default:
461                 BUG();
462         }
463 }
464
465 void *
466 swiotlb_alloc_coherent(struct device *hwdev, size_t size,
467                        dma_addr_t *dma_handle, gfp_t flags)
468 {
469         dma_addr_t dev_addr;
470         void *ret;
471         int order = get_order(size);
472         u64 dma_mask = DMA_32BIT_MASK;
473
474         if (hwdev && hwdev->coherent_dma_mask)
475                 dma_mask = hwdev->coherent_dma_mask;
476
477         ret = (void *)__get_free_pages(flags, order);
478         if (ret && !is_buffer_dma_capable(dma_mask, virt_to_bus(ret), size)) {
479                 /*
480                  * The allocated memory isn't reachable by the device.
481                  * Fall back on swiotlb_map_single().
482                  */
483                 free_pages((unsigned long) ret, order);
484                 ret = NULL;
485         }
486         if (!ret) {
487                 /*
488                  * We are either out of memory or the device can't DMA
489                  * to GFP_DMA memory; fall back on
490                  * swiotlb_map_single(), which will grab memory from
491                  * the lowest available address range.
492                  */
493                 ret = map_single(hwdev, NULL, size, DMA_FROM_DEVICE);
494                 if (!ret)
495                         return NULL;
496         }
497
498         memset(ret, 0, size);
499         dev_addr = virt_to_bus(ret);
500
501         /* Confirm address can be DMA'd by device */
502         if (!is_buffer_dma_capable(dma_mask, dev_addr, size)) {
503                 printk("hwdev DMA mask = 0x%016Lx, dev_addr = 0x%016Lx\n",
504                        (unsigned long long)dma_mask,
505                        (unsigned long long)dev_addr);
506
507                 /* DMA_TO_DEVICE to avoid memcpy in unmap_single */
508                 unmap_single(hwdev, ret, size, DMA_TO_DEVICE);
509                 return NULL;
510         }
511         *dma_handle = dev_addr;
512         return ret;
513 }
514
515 void
516 swiotlb_free_coherent(struct device *hwdev, size_t size, void *vaddr,
517                       dma_addr_t dma_handle)
518 {
519         WARN_ON(irqs_disabled());
520         if (!is_swiotlb_buffer(vaddr))
521                 free_pages((unsigned long) vaddr, get_order(size));
522         else
523                 /* DMA_TO_DEVICE to avoid memcpy in unmap_single */
524                 unmap_single(hwdev, vaddr, size, DMA_TO_DEVICE);
525 }
526
527 static void
528 swiotlb_full(struct device *dev, size_t size, int dir, int do_panic)
529 {
530         /*
531          * Ran out of IOMMU space for this operation. This is very bad.
532          * Unfortunately the drivers cannot handle this operation properly.
533          * unless they check for dma_mapping_error (most don't)
534          * When the mapping is small enough return a static buffer to limit
535          * the damage, or panic when the transfer is too big.
536          */
537         printk(KERN_ERR "DMA: Out of SW-IOMMU space for %zu bytes at "
538                "device %s\n", size, dev ? dev->bus_id : "?");
539
540         if (size > io_tlb_overflow && do_panic) {
541                 if (dir == DMA_FROM_DEVICE || dir == DMA_BIDIRECTIONAL)
542                         panic("DMA: Memory would be corrupted\n");
543                 if (dir == DMA_TO_DEVICE || dir == DMA_BIDIRECTIONAL)
544                         panic("DMA: Random memory would be DMAed\n");
545         }
546 }
547
548 /*
549  * Map a single buffer of the indicated size for DMA in streaming mode.  The
550  * physical address to use is returned.
551  *
552  * Once the device is given the dma address, the device owns this memory until
553  * either swiotlb_unmap_single or swiotlb_dma_sync_single is performed.
554  */
555 dma_addr_t
556 swiotlb_map_single_attrs(struct device *hwdev, void *ptr, size_t size,
557                          int dir, struct dma_attrs *attrs)
558 {
559         dma_addr_t dev_addr = virt_to_bus(ptr);
560         void *map;
561
562         BUG_ON(dir == DMA_NONE);
563         /*
564          * If the pointer passed in happens to be in the device's DMA window,
565          * we can safely return the device addr and not worry about bounce
566          * buffering it.
567          */
568         if (!address_needs_mapping(hwdev, dev_addr, size) && !swiotlb_force)
569                 return dev_addr;
570
571         /*
572          * Oh well, have to allocate and map a bounce buffer.
573          */
574         map = map_single(hwdev, ptr, size, dir);
575         if (!map) {
576                 swiotlb_full(hwdev, size, dir, 1);
577                 map = io_tlb_overflow_buffer;
578         }
579
580         dev_addr = virt_to_bus(map);
581
582         /*
583          * Ensure that the address returned is DMA'ble
584          */
585         if (address_needs_mapping(hwdev, dev_addr, size))
586                 panic("map_single: bounce buffer is not DMA'ble");
587
588         return dev_addr;
589 }
590 EXPORT_SYMBOL(swiotlb_map_single_attrs);
591
592 dma_addr_t
593 swiotlb_map_single(struct device *hwdev, void *ptr, size_t size, int dir)
594 {
595         return swiotlb_map_single_attrs(hwdev, ptr, size, dir, NULL);
596 }
597
598 /*
599  * Unmap a single streaming mode DMA translation.  The dma_addr and size must
600  * match what was provided for in a previous swiotlb_map_single call.  All
601  * other usages are undefined.
602  *
603  * After this call, reads by the cpu to the buffer are guaranteed to see
604  * whatever the device wrote there.
605  */
606 void
607 swiotlb_unmap_single_attrs(struct device *hwdev, dma_addr_t dev_addr,
608                            size_t size, int dir, struct dma_attrs *attrs)
609 {
610         char *dma_addr = bus_to_virt(dev_addr);
611
612         BUG_ON(dir == DMA_NONE);
613         if (is_swiotlb_buffer(dma_addr))
614                 unmap_single(hwdev, dma_addr, size, dir);
615         else if (dir == DMA_FROM_DEVICE)
616                 dma_mark_clean(dma_addr, size);
617 }
618 EXPORT_SYMBOL(swiotlb_unmap_single_attrs);
619
620 void
621 swiotlb_unmap_single(struct device *hwdev, dma_addr_t dev_addr, size_t size,
622                      int dir)
623 {
624         return swiotlb_unmap_single_attrs(hwdev, dev_addr, size, dir, NULL);
625 }
626 /*
627  * Make physical memory consistent for a single streaming mode DMA translation
628  * after a transfer.
629  *
630  * If you perform a swiotlb_map_single() but wish to interrogate the buffer
631  * using the cpu, yet do not wish to teardown the dma mapping, you must
632  * call this function before doing so.  At the next point you give the dma
633  * address back to the card, you must first perform a
634  * swiotlb_dma_sync_for_device, and then the device again owns the buffer
635  */
636 static void
637 swiotlb_sync_single(struct device *hwdev, dma_addr_t dev_addr,
638                     size_t size, int dir, int target)
639 {
640         char *dma_addr = bus_to_virt(dev_addr);
641
642         BUG_ON(dir == DMA_NONE);
643         if (is_swiotlb_buffer(dma_addr))
644                 sync_single(hwdev, dma_addr, size, dir, target);
645         else if (dir == DMA_FROM_DEVICE)
646                 dma_mark_clean(dma_addr, size);
647 }
648
649 void
650 swiotlb_sync_single_for_cpu(struct device *hwdev, dma_addr_t dev_addr,
651                             size_t size, int dir)
652 {
653         swiotlb_sync_single(hwdev, dev_addr, size, dir, SYNC_FOR_CPU);
654 }
655
656 void
657 swiotlb_sync_single_for_device(struct device *hwdev, dma_addr_t dev_addr,
658                                size_t size, int dir)
659 {
660         swiotlb_sync_single(hwdev, dev_addr, size, dir, SYNC_FOR_DEVICE);
661 }
662
663 /*
664  * Same as above, but for a sub-range of the mapping.
665  */
666 static void
667 swiotlb_sync_single_range(struct device *hwdev, dma_addr_t dev_addr,
668                           unsigned long offset, size_t size,
669                           int dir, int target)
670 {
671         char *dma_addr = bus_to_virt(dev_addr) + offset;
672
673         BUG_ON(dir == DMA_NONE);
674         if (is_swiotlb_buffer(dma_addr))
675                 sync_single(hwdev, dma_addr, size, dir, target);
676         else if (dir == DMA_FROM_DEVICE)
677                 dma_mark_clean(dma_addr, size);
678 }
679
680 void
681 swiotlb_sync_single_range_for_cpu(struct device *hwdev, dma_addr_t dev_addr,
682                                   unsigned long offset, size_t size, int dir)
683 {
684         swiotlb_sync_single_range(hwdev, dev_addr, offset, size, dir,
685                                   SYNC_FOR_CPU);
686 }
687
688 void
689 swiotlb_sync_single_range_for_device(struct device *hwdev, dma_addr_t dev_addr,
690                                      unsigned long offset, size_t size, int dir)
691 {
692         swiotlb_sync_single_range(hwdev, dev_addr, offset, size, dir,
693                                   SYNC_FOR_DEVICE);
694 }
695
696 void swiotlb_unmap_sg_attrs(struct device *, struct scatterlist *, int, int,
697                             struct dma_attrs *);
698 /*
699  * Map a set of buffers described by scatterlist in streaming mode for DMA.
700  * This is the scatter-gather version of the above swiotlb_map_single
701  * interface.  Here the scatter gather list elements are each tagged with the
702  * appropriate dma address and length.  They are obtained via
703  * sg_dma_{address,length}(SG).
704  *
705  * NOTE: An implementation may be able to use a smaller number of
706  *       DMA address/length pairs than there are SG table elements.
707  *       (for example via virtual mapping capabilities)
708  *       The routine returns the number of addr/length pairs actually
709  *       used, at most nents.
710  *
711  * Device ownership issues as mentioned above for swiotlb_map_single are the
712  * same here.
713  */
714 int
715 swiotlb_map_sg_attrs(struct device *hwdev, struct scatterlist *sgl, int nelems,
716                      int dir, struct dma_attrs *attrs)
717 {
718         struct scatterlist *sg;
719         void *addr;
720         dma_addr_t dev_addr;
721         int i;
722
723         BUG_ON(dir == DMA_NONE);
724
725         for_each_sg(sgl, sg, nelems, i) {
726                 addr = SG_ENT_VIRT_ADDRESS(sg);
727                 dev_addr = virt_to_bus(addr);
728                 if (swiotlb_force ||
729                     address_needs_mapping(hwdev, dev_addr, sg->length)) {
730                         void *map = map_single(hwdev, addr, sg->length, dir);
731                         if (!map) {
732                                 /* Don't panic here, we expect map_sg users
733                                    to do proper error handling. */
734                                 swiotlb_full(hwdev, sg->length, dir, 0);
735                                 swiotlb_unmap_sg_attrs(hwdev, sgl, i, dir,
736                                                        attrs);
737                                 sgl[0].dma_length = 0;
738                                 return 0;
739                         }
740                         sg->dma_address = virt_to_bus(map);
741                 } else
742                         sg->dma_address = dev_addr;
743                 sg->dma_length = sg->length;
744         }
745         return nelems;
746 }
747 EXPORT_SYMBOL(swiotlb_map_sg_attrs);
748
749 int
750 swiotlb_map_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
751                int dir)
752 {
753         return swiotlb_map_sg_attrs(hwdev, sgl, nelems, dir, NULL);
754 }
755
756 /*
757  * Unmap a set of streaming mode DMA translations.  Again, cpu read rules
758  * concerning calls here are the same as for swiotlb_unmap_single() above.
759  */
760 void
761 swiotlb_unmap_sg_attrs(struct device *hwdev, struct scatterlist *sgl,
762                        int nelems, int dir, struct dma_attrs *attrs)
763 {
764         struct scatterlist *sg;
765         int i;
766
767         BUG_ON(dir == DMA_NONE);
768
769         for_each_sg(sgl, sg, nelems, i) {
770                 if (sg->dma_address != SG_ENT_PHYS_ADDRESS(sg))
771                         unmap_single(hwdev, bus_to_virt(sg->dma_address),
772                                      sg->dma_length, dir);
773                 else if (dir == DMA_FROM_DEVICE)
774                         dma_mark_clean(SG_ENT_VIRT_ADDRESS(sg), sg->dma_length);
775         }
776 }
777 EXPORT_SYMBOL(swiotlb_unmap_sg_attrs);
778
779 void
780 swiotlb_unmap_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
781                  int dir)
782 {
783         return swiotlb_unmap_sg_attrs(hwdev, sgl, nelems, dir, NULL);
784 }
785
786 /*
787  * Make physical memory consistent for a set of streaming mode DMA translations
788  * after a transfer.
789  *
790  * The same as swiotlb_sync_single_* but for a scatter-gather list, same rules
791  * and usage.
792  */
793 static void
794 swiotlb_sync_sg(struct device *hwdev, struct scatterlist *sgl,
795                 int nelems, int dir, int target)
796 {
797         struct scatterlist *sg;
798         int i;
799
800         BUG_ON(dir == DMA_NONE);
801
802         for_each_sg(sgl, sg, nelems, i) {
803                 if (sg->dma_address != SG_ENT_PHYS_ADDRESS(sg))
804                         sync_single(hwdev, bus_to_virt(sg->dma_address),
805                                     sg->dma_length, dir, target);
806                 else if (dir == DMA_FROM_DEVICE)
807                         dma_mark_clean(SG_ENT_VIRT_ADDRESS(sg), sg->dma_length);
808         }
809 }
810
811 void
812 swiotlb_sync_sg_for_cpu(struct device *hwdev, struct scatterlist *sg,
813                         int nelems, int dir)
814 {
815         swiotlb_sync_sg(hwdev, sg, nelems, dir, SYNC_FOR_CPU);
816 }
817
818 void
819 swiotlb_sync_sg_for_device(struct device *hwdev, struct scatterlist *sg,
820                            int nelems, int dir)
821 {
822         swiotlb_sync_sg(hwdev, sg, nelems, dir, SYNC_FOR_DEVICE);
823 }
824
825 int
826 swiotlb_dma_mapping_error(struct device *hwdev, dma_addr_t dma_addr)
827 {
828         return (dma_addr == virt_to_bus(io_tlb_overflow_buffer));
829 }
830
831 /*
832  * Return whether the given device DMA address mask can be supported
833  * properly.  For example, if your device can only drive the low 24-bits
834  * during bus mastering, then you would pass 0x00ffffff as the mask to
835  * this function.
836  */
837 int
838 swiotlb_dma_supported(struct device *hwdev, u64 mask)
839 {
840         return virt_to_bus(io_tlb_end - 1) <= mask;
841 }
842
843 EXPORT_SYMBOL(swiotlb_map_single);
844 EXPORT_SYMBOL(swiotlb_unmap_single);
845 EXPORT_SYMBOL(swiotlb_map_sg);
846 EXPORT_SYMBOL(swiotlb_unmap_sg);
847 EXPORT_SYMBOL(swiotlb_sync_single_for_cpu);
848 EXPORT_SYMBOL(swiotlb_sync_single_for_device);
849 EXPORT_SYMBOL_GPL(swiotlb_sync_single_range_for_cpu);
850 EXPORT_SYMBOL_GPL(swiotlb_sync_single_range_for_device);
851 EXPORT_SYMBOL(swiotlb_sync_sg_for_cpu);
852 EXPORT_SYMBOL(swiotlb_sync_sg_for_device);
853 EXPORT_SYMBOL(swiotlb_dma_mapping_error);
854 EXPORT_SYMBOL(swiotlb_alloc_coherent);
855 EXPORT_SYMBOL(swiotlb_free_coherent);
856 EXPORT_SYMBOL(swiotlb_dma_supported);