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         /*
 536          * When dir == DMA_FROM_DEVICE we could omit the copy from the orig
 537          * to the tlb buffer, if we knew for sure the device will
 538          * overwirte the entire current content. But we don't. Thus
 539          * unconditional bounce may prevent leaking swiotlb content (i.e.
 540          * kernel memory) to user-space.
 541          */
 542         if (orig_addr)
 543                 swiotlb_bounce(orig_addr, tlb_addr, size, DMA_TO_DEVICE);
 544         return tlb_addr;
 545 }
 546 EXPORT_SYMBOL_GPL(swiotlb_tbl_map_single);
 547
 548 /*
 549  * Allocates bounce buffer and returns its kernel virtual address.
 550  */
 551
 552 static phys_addr_t
 553 map_single(struct device *hwdev, phys_addr_t phys, size_t size,
 554            enum dma_data_direction dir)
 555 {
 556         dma_addr_t start_dma_addr;
 557
 558         if (swiotlb_force == SWIOTLB_NO_FORCE) {
 559                 dev_warn_ratelimited(hwdev, "Cannot do DMA to address %pa\n",
 560                                      &phys);
 561                 return SWIOTLB_MAP_ERROR;
 562         }
 563
 564         start_dma_addr = phys_to_dma(hwdev, io_tlb_start);
 565         return swiotlb_tbl_map_single(hwdev, start_dma_addr, phys, size, dir);
 566 }
 567
 568 /*
 569  * dma_addr is the kernel virtual address of the bounce buffer to unmap.
 570  */
 571 void swiotlb_tbl_unmap_single(struct device *hwdev, phys_addr_t tlb_addr,
 572                               size_t size, enum dma_data_direction dir)
 573 {
 574         unsigned long flags;
 575         int i, count, nslots = ALIGN(size, 1 << IO_TLB_SHIFT) >> IO_TLB_SHIFT;
 576         int index = (tlb_addr - io_tlb_start) >> IO_TLB_SHIFT;
 577         phys_addr_t orig_addr = io_tlb_orig_addr[index];
 578
 579         /*
 580          * First, sync the memory before unmapping the entry
 581          */
 582         if (orig_addr != INVALID_PHYS_ADDR &&
 583             ((dir == DMA_FROM_DEVICE) || (dir == DMA_BIDIRECTIONAL)))
 584                 swiotlb_bounce(orig_addr, tlb_addr, size, DMA_FROM_DEVICE);
 585
 586         /*
 587          * Return the buffer to the free list by setting the corresponding
 588          * entries to indicate the number of contiguous entries available.
 589          * While returning the entries to the free list, we merge the entries
 590          * with slots below and above the pool being returned.
 591          */
 592         spin_lock_irqsave(&io_tlb_lock, flags);
 593         {
 594                 count = ((index + nslots) < ALIGN(index + 1, IO_TLB_SEGSIZE) ?
 595                          io_tlb_list[index + nslots] : 0);
 596                 /*
 597                  * Step 1: return the slots to the free list, merging the
 598                  * slots with superceeding slots
 599                  */
 600                 for (i = index + nslots - 1; i >= index; i--) {
 601                         io_tlb_list[i] = ++count;
 602                         io_tlb_orig_addr[i] = INVALID_PHYS_ADDR;
 603                 }
 604                 /*
 605                  * Step 2: merge the returned slots with the preceding slots,
 606                  * if available (non zero)
 607                  */
 608                 for (i = index - 1; (OFFSET(i, IO_TLB_SEGSIZE) != IO_TLB_SEGSIZE -1) && io_tlb_list[i]; i--)
 609                         io_tlb_list[i] = ++count;
 610         }
 611         spin_unlock_irqrestore(&io_tlb_lock, flags);
 612 }
 613 EXPORT_SYMBOL_GPL(swiotlb_tbl_unmap_single);
 614
 615 void swiotlb_tbl_sync_single(struct device *hwdev, phys_addr_t tlb_addr,
 616                              size_t size, enum dma_data_direction dir,
 617                              enum dma_sync_target target)
 618 {
 619         int index = (tlb_addr - io_tlb_start) >> IO_TLB_SHIFT;
 620         phys_addr_t orig_addr = io_tlb_orig_addr[index];
 621
 622         if (orig_addr == INVALID_PHYS_ADDR)
 623                 return;
 624         orig_addr += (unsigned long)tlb_addr & ((1 << IO_TLB_SHIFT) - 1);
 625
 626         switch (target) {
 627         case SYNC_FOR_CPU:
 628                 if (likely(dir == DMA_FROM_DEVICE || dir == DMA_BIDIRECTIONAL))
 629                         swiotlb_bounce(orig_addr, tlb_addr,
 630                                        size, DMA_FROM_DEVICE);
 631                 else
 632                         BUG_ON(dir != DMA_TO_DEVICE);
 633                 break;
 634         case SYNC_FOR_DEVICE:
 635                 if (likely(dir == DMA_TO_DEVICE || dir == DMA_BIDIRECTIONAL))
 636                         swiotlb_bounce(orig_addr, tlb_addr,
 637                                        size, DMA_TO_DEVICE);
 638                 else
 639                         BUG_ON(dir != DMA_FROM_DEVICE);
 640                 break;
 641         default:
 642                 BUG();
 643         }
 644 }
 645 EXPORT_SYMBOL_GPL(swiotlb_tbl_sync_single);
 646
 647 void *
 648 swiotlb_alloc_coherent(struct device *hwdev, size_t size,
 649                        dma_addr_t *dma_handle, gfp_t flags)
 650 {
 651         dma_addr_t dev_addr;
 652         void *ret;
 653         int order = get_order(size);
 654         u64 dma_mask = DMA_BIT_MASK(32);
 655
 656         if (hwdev && hwdev->coherent_dma_mask)
 657                 dma_mask = hwdev->coherent_dma_mask;
 658
 659         ret = (void *)__get_free_pages(flags, order);
 660         if (ret) {
 661                 dev_addr = swiotlb_virt_to_bus(hwdev, ret);
 662                 if (dev_addr + size - 1 > dma_mask) {
 663                         /*
 664                          * The allocated memory isn't reachable by the device.
 665                          */
 666                         free_pages((unsigned long) ret, order);
 667                         ret = NULL;
 668                 }
 669         }
 670         if (!ret) {
 671                 /*
 672                  * We are either out of memory or the device can't DMA to
 673                  * GFP_DMA memory; fall back on map_single(), which
 674                  * will grab memory from the lowest available address range.
 675                  */
 676                 phys_addr_t paddr = map_single(hwdev, 0, size, DMA_FROM_DEVICE);
 677                 if (paddr == SWIOTLB_MAP_ERROR)
 678                         goto err_warn;
 679
 680                 ret = phys_to_virt(paddr);
 681                 dev_addr = phys_to_dma(hwdev, paddr);
 682
 683                 /* Confirm address can be DMA'd by device */
 684                 if (dev_addr + size - 1 > dma_mask) {
 685                         printk("hwdev DMA mask = 0x%016Lx, dev_addr = 0x%016Lx\n",
 686                                (unsigned long long)dma_mask,
 687                                (unsigned long long)dev_addr);
 688
 689                         /* DMA_TO_DEVICE to avoid memcpy in unmap_single */
 690                         swiotlb_tbl_unmap_single(hwdev, paddr,
 691                                                  size, DMA_TO_DEVICE);
 692                         goto err_warn;
 693                 }
 694         }
 695
 696         *dma_handle = dev_addr;
 697         memset(ret, 0, size);
 698
 699         return ret;
 700
 701 err_warn:
 702         pr_warn("coherent allocation failed for device %s size=%zu\n",
 703                 dev_name(hwdev), size);
 704         dump_stack();
 705
 706         return NULL;
 707 }
 708 EXPORT_SYMBOL(swiotlb_alloc_coherent);
 709
 710 void
 711 swiotlb_free_coherent(struct device *hwdev, size_t size, void *vaddr,
 712                       dma_addr_t dev_addr)
 713 {
 714         phys_addr_t paddr = dma_to_phys(hwdev, dev_addr);
 715
 716         WARN_ON(irqs_disabled());
 717         if (!is_swiotlb_buffer(paddr))
 718                 free_pages((unsigned long)vaddr, get_order(size));
 719         else
 720                 /* DMA_TO_DEVICE to avoid memcpy in swiotlb_tbl_unmap_single */
 721                 swiotlb_tbl_unmap_single(hwdev, paddr, size, DMA_TO_DEVICE);
 722 }
 723 EXPORT_SYMBOL(swiotlb_free_coherent);
 724
 725 static void
 726 swiotlb_full(struct device *dev, size_t size, enum dma_data_direction dir,
 727              int do_panic)
 728 {
 729         if (swiotlb_force == SWIOTLB_NO_FORCE)
 730                 return;
 731
 732         /*
 733          * Ran out of IOMMU space for this operation. This is very bad.
 734          * Unfortunately the drivers cannot handle this operation properly.
 735          * unless they check for dma_mapping_error (most don't)
 736          * When the mapping is small enough return a static buffer to limit
 737          * the damage, or panic when the transfer is too big.
 738          */
 739         printk(KERN_ERR "DMA: Out of SW-IOMMU space for %zu bytes at "
 740                "device %s\n", size, dev ? dev_name(dev) : "?");
 741
 742         if (size <= io_tlb_overflow || !do_panic)
 743                 return;
 744
 745         if (dir == DMA_BIDIRECTIONAL)
 746                 panic("DMA: Random memory could be DMA accessed\n");
 747         if (dir == DMA_FROM_DEVICE)
 748                 panic("DMA: Random memory could be DMA written\n");
 749         if (dir == DMA_TO_DEVICE)
 750                 panic("DMA: Random memory could be DMA read\n");
 751 }
 752
 753 /*
 754  * Map a single buffer of the indicated size for DMA in streaming mode.  The
 755  * physical address to use is returned.
 756  *
 757  * Once the device is given the dma address, the device owns this memory until
 758  * either swiotlb_unmap_page or swiotlb_dma_sync_single is performed.
 759  */
 760 dma_addr_t swiotlb_map_page(struct device *dev, struct page *page,
 761                             unsigned long offset, size_t size,
 762                             enum dma_data_direction dir,
 763                             unsigned long attrs)
 764 {
 765         phys_addr_t map, phys = page_to_phys(page) + offset;
 766         dma_addr_t dev_addr = phys_to_dma(dev, phys);
 767
 768         BUG_ON(dir == DMA_NONE);
 769         /*
 770          * If the address happens to be in the device's DMA window,
 771          * we can safely return the device addr and not worry about bounce
 772          * buffering it.
 773          */
 774         if (dma_capable(dev, dev_addr, size) && swiotlb_force != SWIOTLB_FORCE)
 775                 return dev_addr;
 776
 777         trace_swiotlb_bounced(dev, dev_addr, size, swiotlb_force);
 778
 779         /* Oh well, have to allocate and map a bounce buffer. */
 780         map = map_single(dev, phys, size, dir);
 781         if (map == SWIOTLB_MAP_ERROR) {
 782                 swiotlb_full(dev, size, dir, 1);
 783                 return phys_to_dma(dev, io_tlb_overflow_buffer);
 784         }
 785
 786         dev_addr = phys_to_dma(dev, map);
 787
 788         /* Ensure that the address returned is DMA'ble */
 789         if (!dma_capable(dev, dev_addr, size)) {
 790                 swiotlb_tbl_unmap_single(dev, map, size, dir);
 791                 return phys_to_dma(dev, io_tlb_overflow_buffer);
 792         }
 793
 794         return dev_addr;
 795 }
 796 EXPORT_SYMBOL_GPL(swiotlb_map_page);
 797
 798 /*
 799  * Unmap a single streaming mode DMA translation.  The dma_addr and size must
 800  * match what was provided for in a previous swiotlb_map_page call.  All
 801  * other usages are undefined.
 802  *
 803  * After this call, reads by the cpu to the buffer are guaranteed to see
 804  * whatever the device wrote there.
 805  */
 806 static void unmap_single(struct device *hwdev, dma_addr_t dev_addr,
 807                          size_t size, enum dma_data_direction dir)
 808 {
 809         phys_addr_t paddr = dma_to_phys(hwdev, dev_addr);
 810
 811         BUG_ON(dir == DMA_NONE);
 812
 813         if (is_swiotlb_buffer(paddr)) {
 814                 swiotlb_tbl_unmap_single(hwdev, paddr, size, dir);
 815                 return;
 816         }
 817
 818         if (dir != DMA_FROM_DEVICE)
 819                 return;
 820
 821         /*
 822          * phys_to_virt doesn't work with hihgmem page but we could
 823          * call dma_mark_clean() with hihgmem page here. However, we
 824          * are fine since dma_mark_clean() is null on POWERPC. We can
 825          * make dma_mark_clean() take a physical address if necessary.
 826          */
 827         dma_mark_clean(phys_to_virt(paddr), size);
 828 }
 829
 830 void swiotlb_unmap_page(struct device *hwdev, dma_addr_t dev_addr,
 831                         size_t size, enum dma_data_direction dir,
 832                         unsigned long attrs)
 833 {
 834         unmap_single(hwdev, dev_addr, size, dir);
 835 }
 836 EXPORT_SYMBOL_GPL(swiotlb_unmap_page);
 837
 838 /*
 839  * Make physical memory consistent for a single streaming mode DMA translation
 840  * after a transfer.
 841  *
 842  * If you perform a swiotlb_map_page() but wish to interrogate the buffer
 843  * using the cpu, yet do not wish to teardown the dma mapping, you must
 844  * call this function before doing so.  At the next point you give the dma
 845  * address back to the card, you must first perform a
 846  * swiotlb_dma_sync_for_device, and then the device again owns the buffer
 847  */
 848 static void
 849 swiotlb_sync_single(struct device *hwdev, dma_addr_t dev_addr,
 850                     size_t size, enum dma_data_direction dir,
 851                     enum dma_sync_target target)
 852 {
 853         phys_addr_t paddr = dma_to_phys(hwdev, dev_addr);
 854
 855         BUG_ON(dir == DMA_NONE);
 856
 857         if (is_swiotlb_buffer(paddr)) {
 858                 swiotlb_tbl_sync_single(hwdev, paddr, size, dir, target);
 859                 return;
 860         }
 861
 862         if (dir != DMA_FROM_DEVICE)
 863                 return;
 864
 865         dma_mark_clean(phys_to_virt(paddr), size);
 866 }
 867
 868 void
 869 swiotlb_sync_single_for_cpu(struct device *hwdev, dma_addr_t dev_addr,
 870                             size_t size, enum dma_data_direction dir)
 871 {
 872         swiotlb_sync_single(hwdev, dev_addr, size, dir, SYNC_FOR_CPU);
 873 }
 874 EXPORT_SYMBOL(swiotlb_sync_single_for_cpu);
 875
 876 void
 877 swiotlb_sync_single_for_device(struct device *hwdev, dma_addr_t dev_addr,
 878                                size_t size, enum dma_data_direction dir)
 879 {
 880         swiotlb_sync_single(hwdev, dev_addr, size, dir, SYNC_FOR_DEVICE);
 881 }
 882 EXPORT_SYMBOL(swiotlb_sync_single_for_device);
 883
 884 /*
 885  * Map a set of buffers described by scatterlist in streaming mode for DMA.
 886  * This is the scatter-gather version of the above swiotlb_map_page
 887  * interface.  Here the scatter gather list elements are each tagged with the
 888  * appropriate dma address and length.  They are obtained via
 889  * sg_dma_{address,length}(SG).
 890  *
 891  * NOTE: An implementation may be able to use a smaller number of
 892  *       DMA address/length pairs than there are SG table elements.
 893  *       (for example via virtual mapping capabilities)
 894  *       The routine returns the number of addr/length pairs actually
 895  *       used, at most nents.
 896  *
 897  * Device ownership issues as mentioned above for swiotlb_map_page are the
 898  * same here.
 899  */
 900 int
 901 swiotlb_map_sg_attrs(struct device *hwdev, struct scatterlist *sgl, int nelems,
 902                      enum dma_data_direction dir, unsigned long attrs)
 903 {
 904         struct scatterlist *sg;
 905         int i;
 906
 907         BUG_ON(dir == DMA_NONE);
 908
 909         for_each_sg(sgl, sg, nelems, i) {
 910                 phys_addr_t paddr = sg_phys(sg);
 911                 dma_addr_t dev_addr = phys_to_dma(hwdev, paddr);
 912
 913                 if (swiotlb_force == SWIOTLB_FORCE ||
 914                     !dma_capable(hwdev, dev_addr, sg->length)) {
 915                         phys_addr_t map = map_single(hwdev, sg_phys(sg),
 916                                                      sg->length, dir);
 917                         if (map == SWIOTLB_MAP_ERROR) {
 918                                 /* Don't panic here, we expect map_sg users
 919                                    to do proper error handling. */
 920                                 swiotlb_full(hwdev, sg->length, dir, 0);
 921                                 swiotlb_unmap_sg_attrs(hwdev, sgl, i, dir,
 922                                                        attrs);
 923                                 sg_dma_len(sgl) = 0;
 924                                 return 0;
 925                         }
 926                         sg->dma_address = phys_to_dma(hwdev, map);
 927                 } else
 928                         sg->dma_address = dev_addr;
 929                 sg_dma_len(sg) = sg->length;
 930         }
 931         return nelems;
 932 }
 933 EXPORT_SYMBOL(swiotlb_map_sg_attrs);
 934
 935 int
 936 swiotlb_map_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
 937                enum dma_data_direction dir)
 938 {
 939         return swiotlb_map_sg_attrs(hwdev, sgl, nelems, dir, 0);
 940 }
 941 EXPORT_SYMBOL(swiotlb_map_sg);
 942
 943 /*
 944  * Unmap a set of streaming mode DMA translations.  Again, cpu read rules
 945  * concerning calls here are the same as for swiotlb_unmap_page() above.
 946  */
 947 void
 948 swiotlb_unmap_sg_attrs(struct device *hwdev, struct scatterlist *sgl,
 949                        int nelems, enum dma_data_direction dir,
 950                        unsigned long attrs)
 951 {
 952         struct scatterlist *sg;
 953         int i;
 954
 955         BUG_ON(dir == DMA_NONE);
 956
 957         for_each_sg(sgl, sg, nelems, i)
 958                 unmap_single(hwdev, sg->dma_address, sg_dma_len(sg), dir);
 959
 960 }
 961 EXPORT_SYMBOL(swiotlb_unmap_sg_attrs);
 962
 963 void
 964 swiotlb_unmap_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
 965                  enum dma_data_direction dir)
 966 {
 967         return swiotlb_unmap_sg_attrs(hwdev, sgl, nelems, dir, 0);
 968 }
 969 EXPORT_SYMBOL(swiotlb_unmap_sg);
 970
 971 /*
 972  * Make physical memory consistent for a set of streaming mode DMA translations
 973  * after a transfer.
 974  *
 975  * The same as swiotlb_sync_single_* but for a scatter-gather list, same rules
 976  * and usage.
 977  */
 978 static void
 979 swiotlb_sync_sg(struct device *hwdev, struct scatterlist *sgl,
 980                 int nelems, enum dma_data_direction dir,
 981                 enum dma_sync_target target)
 982 {
 983         struct scatterlist *sg;
 984         int i;
 985
 986         for_each_sg(sgl, sg, nelems, i)
 987                 swiotlb_sync_single(hwdev, sg->dma_address,
 988                                     sg_dma_len(sg), dir, target);
 989 }
 990
 991 void
 992 swiotlb_sync_sg_for_cpu(struct device *hwdev, struct scatterlist *sg,
 993                         int nelems, enum dma_data_direction dir)
 994 {
 995         swiotlb_sync_sg(hwdev, sg, nelems, dir, SYNC_FOR_CPU);
 996 }
 997 EXPORT_SYMBOL(swiotlb_sync_sg_for_cpu);
 998
 999 void
1000 swiotlb_sync_sg_for_device(struct device *hwdev, struct scatterlist *sg,
1001                            int nelems, enum dma_data_direction dir)
1002 {
1003         swiotlb_sync_sg(hwdev, sg, nelems, dir, SYNC_FOR_DEVICE);
1004 }
1005 EXPORT_SYMBOL(swiotlb_sync_sg_for_device);
1006
1007 int
1008 swiotlb_dma_mapping_error(struct device *hwdev, dma_addr_t dma_addr)
1009 {
1010         return (dma_addr == phys_to_dma(hwdev, io_tlb_overflow_buffer));
1011 }
1012 EXPORT_SYMBOL(swiotlb_dma_mapping_error);
1013
1014 /*
1015  * Return whether the given device DMA address mask can be supported
1016  * properly.  For example, if your device can only drive the low 24-bits
1017  * during bus mastering, then you would pass 0x00ffffff as the mask to
1018  * this function.
1019  */
1020 int
1021 swiotlb_dma_supported(struct device *hwdev, u64 mask)
1022 {
1023         return phys_to_dma(hwdev, io_tlb_end - 1) <= mask;
1024 }
1025 EXPORT_SYMBOL(swiotlb_dma_supported);