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