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