drivers/xen/swiotlb-xen.c

   1 /*
   2  *  Copyright 2010
   3  *  by Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
   4  *
   5  * This code provides a IOMMU for Xen PV guests with PCI passthrough.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License v2.0 as published by
   9  * the Free Software Foundation
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * PV guests under Xen are running in an non-contiguous memory architecture.
  17  *
  18  * When PCI pass-through is utilized, this necessitates an IOMMU for
  19  * translating bus (DMA) to virtual and vice-versa and also providing a
  20  * mechanism to have contiguous pages for device drivers operations (say DMA
  21  * operations).
  22  *
  23  * Specifically, under Xen the Linux idea of pages is an illusion. It
  24  * assumes that pages start at zero and go up to the available memory. To
  25  * help with that, the Linux Xen MMU provides a lookup mechanism to
  26  * translate the page frame numbers (PFN) to machine frame numbers (MFN)
  27  * and vice-versa. The MFN are the "real" frame numbers. Furthermore
  28  * memory is not contiguous. Xen hypervisor stitches memory for guests
  29  * from different pools, which means there is no guarantee that PFN==MFN
  30  * and PFN+1==MFN+1. Lastly with Xen 4.0, pages (in debug mode) are
  31  * allocated in descending order (high to low), meaning the guest might
  32  * never get any MFN's under the 4GB mark.
  33  *
  34  */
  35
  36 #include <linux/bootmem.h>
  37 #include <linux/dma-mapping.h>
  38 #include <linux/export.h>
  39 #include <xen/swiotlb-xen.h>
  40 #include <xen/page.h>
  41 #include <xen/xen-ops.h>
  42 #include <xen/hvc-console.h>
  43 /*
  44  * Used to do a quick range check in swiotlb_tbl_unmap_single and
  45  * swiotlb_tbl_sync_single_*, to see if the memory was in fact allocated by this
  46  * API.
  47  */
  48
  49 static char *xen_io_tlb_start, *xen_io_tlb_end;
  50 static unsigned long xen_io_tlb_nslabs;
  51 /*
  52  * Quick lookup value of the bus address of the IOTLB.
  53  */
  54
  55 u64 start_dma_addr;
  56
  57 static dma_addr_t xen_phys_to_bus(phys_addr_t paddr)
  58 {
  59         return phys_to_machine(XPADDR(paddr)).maddr;
  60 }
  61
  62 static phys_addr_t xen_bus_to_phys(dma_addr_t baddr)
  63 {
  64         return machine_to_phys(XMADDR(baddr)).paddr;
  65 }
  66
  67 static dma_addr_t xen_virt_to_bus(void *address)
  68 {
  69         return xen_phys_to_bus(virt_to_phys(address));
  70 }
  71
  72 static int check_pages_physically_contiguous(unsigned long pfn,
  73                                              unsigned int offset,
  74                                              size_t length)
  75 {
  76         unsigned long next_mfn;
  77         int i;
  78         int nr_pages;
  79
  80         next_mfn = pfn_to_mfn(pfn);
  81         nr_pages = (offset + length + PAGE_SIZE-1) >> PAGE_SHIFT;
  82
  83         for (i = 1; i < nr_pages; i++) {
  84                 if (pfn_to_mfn(++pfn) != ++next_mfn)
  85                         return 0;
  86         }
  87         return 1;
  88 }
  89
  90 static int range_straddles_page_boundary(phys_addr_t p, size_t size)
  91 {
  92         unsigned long pfn = PFN_DOWN(p);
  93         unsigned int offset = p & ~PAGE_MASK;
  94
  95         if (offset + size <= PAGE_SIZE)
  96                 return 0;
  97         if (check_pages_physically_contiguous(pfn, offset, size))
  98                 return 0;
  99         return 1;
 100 }
 101
 102 static int is_xen_swiotlb_buffer(dma_addr_t dma_addr)
 103 {
 104         unsigned long mfn = PFN_DOWN(dma_addr);
 105         unsigned long pfn = mfn_to_local_pfn(mfn);
 106         phys_addr_t paddr;
 107
 108         /* If the address is outside our domain, it CAN
 109          * have the same virtual address as another address
 110          * in our domain. Therefore _only_ check address within our domain.
 111          */
 112         if (pfn_valid(pfn)) {
 113                 paddr = PFN_PHYS(pfn);
 114                 return paddr >= virt_to_phys(xen_io_tlb_start) &&
 115                        paddr < virt_to_phys(xen_io_tlb_end);
 116         }
 117         return 0;
 118 }
 119
 120 static int max_dma_bits = 32;
 121
 122 static int
 123 xen_swiotlb_fixup(void *buf, size_t size, unsigned long nslabs)
 124 {
 125         int i, rc;
 126         int dma_bits;
 127
 128         dma_bits = get_order(IO_TLB_SEGSIZE << IO_TLB_SHIFT) + PAGE_SHIFT;
 129
 130         i = 0;
 131         do {
 132                 int slabs = min(nslabs - i, (unsigned long)IO_TLB_SEGSIZE);
 133
 134                 do {
 135                         rc = xen_create_contiguous_region(
 136                                 (unsigned long)buf + (i << IO_TLB_SHIFT),
 137                                 get_order(slabs << IO_TLB_SHIFT),
 138                                 dma_bits);
 139                 } while (rc && dma_bits++ < max_dma_bits);
 140                 if (rc)
 141                         return rc;
 142
 143                 i += slabs;
 144         } while (i < nslabs);
 145         return 0;
 146 }
 147 static unsigned long xen_set_nslabs(unsigned long nr_tbl)
 148 {
 149         if (!nr_tbl) {
 150                 xen_io_tlb_nslabs = (64 * 1024 * 1024 >> IO_TLB_SHIFT);
 151                 xen_io_tlb_nslabs = ALIGN(xen_io_tlb_nslabs, IO_TLB_SEGSIZE);
 152         } else
 153                 xen_io_tlb_nslabs = nr_tbl;
 154
 155         return xen_io_tlb_nslabs << IO_TLB_SHIFT;
 156 }
 157
 158 enum xen_swiotlb_err {
 159         XEN_SWIOTLB_UNKNOWN = 0,
 160         XEN_SWIOTLB_ENOMEM,
 161         XEN_SWIOTLB_EFIXUP
 162 };
 163
 164 static const char *xen_swiotlb_error(enum xen_swiotlb_err err)
 165 {
 166         switch (err) {
 167         case XEN_SWIOTLB_ENOMEM:
 168                 return "Cannot allocate Xen-SWIOTLB buffer\n";
 169         case XEN_SWIOTLB_EFIXUP:
 170                 return "Failed to get contiguous memory for DMA from Xen!\n"\
 171                     "You either: don't have the permissions, do not have"\
 172                     " enough free memory under 4GB, or the hypervisor memory"\
 173                     " is too fragmented!";
 174         default:
 175                 break;
 176         }
 177         return "";
 178 }
 179 void __init xen_swiotlb_init(int verbose)
 180 {
 181         unsigned long bytes;
 182         int rc = -ENOMEM;
 183         enum xen_swiotlb_err m_ret = XEN_SWIOTLB_UNKNOWN;
 184         unsigned int repeat = 3;
 185
 186         xen_io_tlb_nslabs = swiotlb_nr_tbl();
 187 retry:
 188         bytes = xen_set_nslabs(xen_io_tlb_nslabs);
 189         /*
 190          * Get IO TLB memory from any location.
 191          */
 192         xen_io_tlb_start = alloc_bootmem_pages(PAGE_ALIGN(bytes));
 193         if (!xen_io_tlb_start) {
 194                 m_ret = XEN_SWIOTLB_ENOMEM;
 195                 goto error;
 196         }
 197         xen_io_tlb_end = xen_io_tlb_start + bytes;
 198         /*
 199          * And replace that memory with pages under 4GB.
 200          */
 201         rc = xen_swiotlb_fixup(xen_io_tlb_start,
 202                                bytes,
 203                                xen_io_tlb_nslabs);
 204         if (rc) {
 205                 free_bootmem(__pa(xen_io_tlb_start), PAGE_ALIGN(bytes));
 206                 m_ret = XEN_SWIOTLB_EFIXUP;
 207                 goto error;
 208         }
 209         start_dma_addr = xen_virt_to_bus(xen_io_tlb_start);
 210         swiotlb_init_with_tbl(xen_io_tlb_start, xen_io_tlb_nslabs, verbose);
 211
 212         return;
 213 error:
 214         if (repeat--) {
 215                 xen_io_tlb_nslabs = max(1024UL, /* Min is 2MB */
 216                                         (xen_io_tlb_nslabs >> 1));
 217                 printk(KERN_INFO "Xen-SWIOTLB: Lowering to %luMB\n",
 218                       (xen_io_tlb_nslabs << IO_TLB_SHIFT) >> 20);
 219                 goto retry;
 220         }
 221         xen_raw_printk("%s (rc:%d)", xen_swiotlb_error(m_ret), rc);
 222         panic("%s (rc:%d)", xen_swiotlb_error(m_ret), rc);
 223 }
 224
 225 void *
 226 xen_swiotlb_alloc_coherent(struct device *hwdev, size_t size,
 227                            dma_addr_t *dma_handle, gfp_t flags,
 228                            struct dma_attrs *attrs)
 229 {
 230         void *ret;
 231         int order = get_order(size);
 232         u64 dma_mask = DMA_BIT_MASK(32);
 233         unsigned long vstart;
 234         phys_addr_t phys;
 235         dma_addr_t dev_addr;
 236
 237         /*
 238         * Ignore region specifiers - the kernel's ideas of
 239         * pseudo-phys memory layout has nothing to do with the
 240         * machine physical layout.  We can't allocate highmem
 241         * because we can't return a pointer to it.
 242         */
 243         flags &= ~(__GFP_DMA | __GFP_HIGHMEM);
 244
 245         if (dma_alloc_from_coherent(hwdev, size, dma_handle, &ret))
 246                 return ret;
 247
 248         vstart = __get_free_pages(flags, order);
 249         ret = (void *)vstart;
 250
 251         if (!ret)
 252                 return ret;
 253
 254         if (hwdev && hwdev->coherent_dma_mask)
 255                 dma_mask = hwdev->coherent_dma_mask;
 256
 257         phys = virt_to_phys(ret);
 258         dev_addr = xen_phys_to_bus(phys);
 259         if (((dev_addr + size - 1 <= dma_mask)) &&
 260             !range_straddles_page_boundary(phys, size))
 261                 *dma_handle = dev_addr;
 262         else {
 263                 if (xen_create_contiguous_region(vstart, order,
 264                                                  fls64(dma_mask)) != 0) {
 265                         free_pages(vstart, order);
 266                         return NULL;
 267                 }
 268                 *dma_handle = virt_to_machine(ret).maddr;
 269         }
 270         memset(ret, 0, size);
 271         return ret;
 272 }
 273 EXPORT_SYMBOL_GPL(xen_swiotlb_alloc_coherent);
 274
 275 void
 276 xen_swiotlb_free_coherent(struct device *hwdev, size_t size, void *vaddr,
 277                           dma_addr_t dev_addr, struct dma_attrs *attrs)
 278 {
 279         int order = get_order(size);
 280         phys_addr_t phys;
 281         u64 dma_mask = DMA_BIT_MASK(32);
 282
 283         if (dma_release_from_coherent(hwdev, order, vaddr))
 284                 return;
 285
 286         if (hwdev && hwdev->coherent_dma_mask)
 287                 dma_mask = hwdev->coherent_dma_mask;
 288
 289         phys = virt_to_phys(vaddr);
 290
 291         if (((dev_addr + size - 1 > dma_mask)) ||
 292             range_straddles_page_boundary(phys, size))
 293                 xen_destroy_contiguous_region((unsigned long)vaddr, order);
 294
 295         free_pages((unsigned long)vaddr, order);
 296 }
 297 EXPORT_SYMBOL_GPL(xen_swiotlb_free_coherent);
 298
 299
 300 /*
 301  * Map a single buffer of the indicated size for DMA in streaming mode.  The
 302  * physical address to use is returned.
 303  *
 304  * Once the device is given the dma address, the device owns this memory until
 305  * either xen_swiotlb_unmap_page or xen_swiotlb_dma_sync_single is performed.
 306  */
 307 dma_addr_t xen_swiotlb_map_page(struct device *dev, struct page *page,
 308                                 unsigned long offset, size_t size,
 309                                 enum dma_data_direction dir,
 310                                 struct dma_attrs *attrs)
 311 {
 312         phys_addr_t phys = page_to_phys(page) + offset;
 313         dma_addr_t dev_addr = xen_phys_to_bus(phys);
 314         void *map;
 315
 316         BUG_ON(dir == DMA_NONE);
 317         /*
 318          * If the address happens to be in the device's DMA window,
 319          * we can safely return the device addr and not worry about bounce
 320          * buffering it.
 321          */
 322         if (dma_capable(dev, dev_addr, size) &&
 323             !range_straddles_page_boundary(phys, size) && !swiotlb_force)
 324                 return dev_addr;
 325
 326         /*
 327          * Oh well, have to allocate and map a bounce buffer.
 328          */
 329         map = swiotlb_tbl_map_single(dev, start_dma_addr, phys, size, dir);
 330         if (!map)
 331                 return DMA_ERROR_CODE;
 332
 333         dev_addr = xen_virt_to_bus(map);
 334
 335         /*
 336          * Ensure that the address returned is DMA'ble
 337          */
 338         if (!dma_capable(dev, dev_addr, size)) {
 339                 swiotlb_tbl_unmap_single(dev, map, size, dir);
 340                 dev_addr = 0;
 341         }
 342         return dev_addr;
 343 }
 344 EXPORT_SYMBOL_GPL(xen_swiotlb_map_page);
 345
 346 /*
 347  * Unmap a single streaming mode DMA translation.  The dma_addr and size must
 348  * match what was provided for in a previous xen_swiotlb_map_page call.  All
 349  * other usages are undefined.
 350  *
 351  * After this call, reads by the cpu to the buffer are guaranteed to see
 352  * whatever the device wrote there.
 353  */
 354 static void xen_unmap_single(struct device *hwdev, dma_addr_t dev_addr,
 355                              size_t size, enum dma_data_direction dir)
 356 {
 357         phys_addr_t paddr = xen_bus_to_phys(dev_addr);
 358
 359         BUG_ON(dir == DMA_NONE);
 360
 361         /* NOTE: We use dev_addr here, not paddr! */
 362         if (is_xen_swiotlb_buffer(dev_addr)) {
 363                 swiotlb_tbl_unmap_single(hwdev, phys_to_virt(paddr), size, dir);
 364                 return;
 365         }
 366
 367         if (dir != DMA_FROM_DEVICE)
 368                 return;
 369
 370         /*
 371          * phys_to_virt doesn't work with hihgmem page but we could
 372          * call dma_mark_clean() with hihgmem page here. However, we
 373          * are fine since dma_mark_clean() is null on POWERPC. We can
 374          * make dma_mark_clean() take a physical address if necessary.
 375          */
 376         dma_mark_clean(phys_to_virt(paddr), size);
 377 }
 378
 379 void xen_swiotlb_unmap_page(struct device *hwdev, dma_addr_t dev_addr,
 380                             size_t size, enum dma_data_direction dir,
 381                             struct dma_attrs *attrs)
 382 {
 383         xen_unmap_single(hwdev, dev_addr, size, dir);
 384 }
 385 EXPORT_SYMBOL_GPL(xen_swiotlb_unmap_page);
 386
 387 /*
 388  * Make physical memory consistent for a single streaming mode DMA translation
 389  * after a transfer.
 390  *
 391  * If you perform a xen_swiotlb_map_page() but wish to interrogate the buffer
 392  * using the cpu, yet do not wish to teardown the dma mapping, you must
 393  * call this function before doing so.  At the next point you give the dma
 394  * address back to the card, you must first perform a
 395  * xen_swiotlb_dma_sync_for_device, and then the device again owns the buffer
 396  */
 397 static void
 398 xen_swiotlb_sync_single(struct device *hwdev, dma_addr_t dev_addr,
 399                         size_t size, enum dma_data_direction dir,
 400                         enum dma_sync_target target)
 401 {
 402         phys_addr_t paddr = xen_bus_to_phys(dev_addr);
 403
 404         BUG_ON(dir == DMA_NONE);
 405
 406         /* NOTE: We use dev_addr here, not paddr! */
 407         if (is_xen_swiotlb_buffer(dev_addr)) {
 408                 swiotlb_tbl_sync_single(hwdev, phys_to_virt(paddr), size, dir,
 409                                        target);
 410                 return;
 411         }
 412
 413         if (dir != DMA_FROM_DEVICE)
 414                 return;
 415
 416         dma_mark_clean(phys_to_virt(paddr), size);
 417 }
 418
 419 void
 420 xen_swiotlb_sync_single_for_cpu(struct device *hwdev, dma_addr_t dev_addr,
 421                                 size_t size, enum dma_data_direction dir)
 422 {
 423         xen_swiotlb_sync_single(hwdev, dev_addr, size, dir, SYNC_FOR_CPU);
 424 }
 425 EXPORT_SYMBOL_GPL(xen_swiotlb_sync_single_for_cpu);
 426
 427 void
 428 xen_swiotlb_sync_single_for_device(struct device *hwdev, dma_addr_t dev_addr,
 429                                    size_t size, enum dma_data_direction dir)
 430 {
 431         xen_swiotlb_sync_single(hwdev, dev_addr, size, dir, SYNC_FOR_DEVICE);
 432 }
 433 EXPORT_SYMBOL_GPL(xen_swiotlb_sync_single_for_device);
 434
 435 /*
 436  * Map a set of buffers described by scatterlist in streaming mode for DMA.
 437  * This is the scatter-gather version of the above xen_swiotlb_map_page
 438  * interface.  Here the scatter gather list elements are each tagged with the
 439  * appropriate dma address and length.  They are obtained via
 440  * sg_dma_{address,length}(SG).
 441  *
 442  * NOTE: An implementation may be able to use a smaller number of
 443  *       DMA address/length pairs than there are SG table elements.
 444  *       (for example via virtual mapping capabilities)
 445  *       The routine returns the number of addr/length pairs actually
 446  *       used, at most nents.
 447  *
 448  * Device ownership issues as mentioned above for xen_swiotlb_map_page are the
 449  * same here.
 450  */
 451 int
 452 xen_swiotlb_map_sg_attrs(struct device *hwdev, struct scatterlist *sgl,
 453                          int nelems, enum dma_data_direction dir,
 454                          struct dma_attrs *attrs)
 455 {
 456         struct scatterlist *sg;
 457         int i;
 458
 459         BUG_ON(dir == DMA_NONE);
 460
 461         for_each_sg(sgl, sg, nelems, i) {
 462                 phys_addr_t paddr = sg_phys(sg);
 463                 dma_addr_t dev_addr = xen_phys_to_bus(paddr);
 464
 465                 if (swiotlb_force ||
 466                     !dma_capable(hwdev, dev_addr, sg->length) ||
 467                     range_straddles_page_boundary(paddr, sg->length)) {
 468                         void *map = swiotlb_tbl_map_single(hwdev,
 469                                                            start_dma_addr,
 470                                                            sg_phys(sg),
 471                                                            sg->length, dir);
 472                         if (!map) {
 473                                 /* Don't panic here, we expect map_sg users
 474                                    to do proper error handling. */
 475                                 xen_swiotlb_unmap_sg_attrs(hwdev, sgl, i, dir,
 476                                                            attrs);
 477                                 sgl[0].dma_length = 0;
 478                                 return DMA_ERROR_CODE;
 479                         }
 480                         sg->dma_address = xen_virt_to_bus(map);
 481                 } else
 482                         sg->dma_address = dev_addr;
 483                 sg->dma_length = sg->length;
 484         }
 485         return nelems;
 486 }
 487 EXPORT_SYMBOL_GPL(xen_swiotlb_map_sg_attrs);
 488
 489 int
 490 xen_swiotlb_map_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
 491                    enum dma_data_direction dir)
 492 {
 493         return xen_swiotlb_map_sg_attrs(hwdev, sgl, nelems, dir, NULL);
 494 }
 495 EXPORT_SYMBOL_GPL(xen_swiotlb_map_sg);
 496
 497 /*
 498  * Unmap a set of streaming mode DMA translations.  Again, cpu read rules
 499  * concerning calls here are the same as for swiotlb_unmap_page() above.
 500  */
 501 void
 502 xen_swiotlb_unmap_sg_attrs(struct device *hwdev, struct scatterlist *sgl,
 503                            int nelems, enum dma_data_direction dir,
 504                            struct dma_attrs *attrs)
 505 {
 506         struct scatterlist *sg;
 507         int i;
 508
 509         BUG_ON(dir == DMA_NONE);
 510
 511         for_each_sg(sgl, sg, nelems, i)
 512                 xen_unmap_single(hwdev, sg->dma_address, sg->dma_length, dir);
 513
 514 }
 515 EXPORT_SYMBOL_GPL(xen_swiotlb_unmap_sg_attrs);
 516
 517 void
 518 xen_swiotlb_unmap_sg(struct device *hwdev, struct scatterlist *sgl, int nelems,
 519                      enum dma_data_direction dir)
 520 {
 521         return xen_swiotlb_unmap_sg_attrs(hwdev, sgl, nelems, dir, NULL);
 522 }
 523 EXPORT_SYMBOL_GPL(xen_swiotlb_unmap_sg);
 524
 525 /*
 526  * Make physical memory consistent for a set of streaming mode DMA translations
 527  * after a transfer.
 528  *
 529  * The same as swiotlb_sync_single_* but for a scatter-gather list, same rules
 530  * and usage.
 531  */
 532 static void
 533 xen_swiotlb_sync_sg(struct device *hwdev, struct scatterlist *sgl,
 534                     int nelems, enum dma_data_direction dir,
 535                     enum dma_sync_target target)
 536 {
 537         struct scatterlist *sg;
 538         int i;
 539
 540         for_each_sg(sgl, sg, nelems, i)
 541                 xen_swiotlb_sync_single(hwdev, sg->dma_address,
 542                                         sg->dma_length, dir, target);
 543 }
 544
 545 void
 546 xen_swiotlb_sync_sg_for_cpu(struct device *hwdev, struct scatterlist *sg,
 547                             int nelems, enum dma_data_direction dir)
 548 {
 549         xen_swiotlb_sync_sg(hwdev, sg, nelems, dir, SYNC_FOR_CPU);
 550 }
 551 EXPORT_SYMBOL_GPL(xen_swiotlb_sync_sg_for_cpu);
 552
 553 void
 554 xen_swiotlb_sync_sg_for_device(struct device *hwdev, struct scatterlist *sg,
 555                                int nelems, enum dma_data_direction dir)
 556 {
 557         xen_swiotlb_sync_sg(hwdev, sg, nelems, dir, SYNC_FOR_DEVICE);
 558 }
 559 EXPORT_SYMBOL_GPL(xen_swiotlb_sync_sg_for_device);
 560
 561 int
 562 xen_swiotlb_dma_mapping_error(struct device *hwdev, dma_addr_t dma_addr)
 563 {
 564         return !dma_addr;
 565 }
 566 EXPORT_SYMBOL_GPL(xen_swiotlb_dma_mapping_error);
 567
 568 /*
 569  * Return whether the given device DMA address mask can be supported
 570  * properly.  For example, if your device can only drive the low 24-bits
 571  * during bus mastering, then you would pass 0x00ffffff as the mask to
 572  * this function.
 573  */
 574 int
 575 xen_swiotlb_dma_supported(struct device *hwdev, u64 mask)
 576 {
 577         return xen_virt_to_bus(xen_io_tlb_end - 1) <= mask;
 578 }
 579 EXPORT_SYMBOL_GPL(xen_swiotlb_dma_supported);