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