drivers/iommu/dma-iommu.c

   1 /*
   2  * A fairly generic DMA-API to IOMMU-API glue layer.
   3  *
   4  * Copyright (C) 2014-2015 ARM Ltd.
   5  *
   6  * based in part on arch/arm/mm/dma-mapping.c:
   7  * Copyright (C) 2000-2004 Russell King
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 #include <linux/device.h>
  23 #include <linux/dma-iommu.h>
  24 #include <linux/gfp.h>
  25 #include <linux/huge_mm.h>
  26 #include <linux/iommu.h>
  27 #include <linux/iova.h>
  28 #include <linux/mm.h>
  29 #include <linux/scatterlist.h>
  30 #include <linux/vmalloc.h>
  31
  32 int iommu_dma_init(void)
  33 {
  34         return iova_cache_get();
  35 }
  36
  37 /**
  38  * iommu_get_dma_cookie - Acquire DMA-API resources for a domain
  39  * @domain: IOMMU domain to prepare for DMA-API usage
  40  *
  41  * IOMMU drivers should normally call this from their domain_alloc
  42  * callback when domain->type == IOMMU_DOMAIN_DMA.
  43  */
  44 int iommu_get_dma_cookie(struct iommu_domain *domain)
  45 {
  46         struct iova_domain *iovad;
  47
  48         if (domain->iova_cookie)
  49                 return -EEXIST;
  50
  51         iovad = kzalloc(sizeof(*iovad), GFP_KERNEL);
  52         domain->iova_cookie = iovad;
  53
  54         return iovad ? 0 : -ENOMEM;
  55 }
  56 EXPORT_SYMBOL(iommu_get_dma_cookie);
  57
  58 /**
  59  * iommu_put_dma_cookie - Release a domain's DMA mapping resources
  60  * @domain: IOMMU domain previously prepared by iommu_get_dma_cookie()
  61  *
  62  * IOMMU drivers should normally call this from their domain_free callback.
  63  */
  64 void iommu_put_dma_cookie(struct iommu_domain *domain)
  65 {
  66         struct iova_domain *iovad = domain->iova_cookie;
  67
  68         if (!iovad)
  69                 return;
  70
  71         if (iovad->granule)
  72                 put_iova_domain(iovad);
  73         kfree(iovad);
  74         domain->iova_cookie = NULL;
  75 }
  76 EXPORT_SYMBOL(iommu_put_dma_cookie);
  77
  78 /**
  79  * iommu_dma_init_domain - Initialise a DMA mapping domain
  80  * @domain: IOMMU domain previously prepared by iommu_get_dma_cookie()
  81  * @base: IOVA at which the mappable address space starts
  82  * @size: Size of IOVA space
  83  *
  84  * @base and @size should be exact multiples of IOMMU page granularity to
  85  * avoid rounding surprises. If necessary, we reserve the page at address 0
  86  * to ensure it is an invalid IOVA. It is safe to reinitialise a domain, but
  87  * any change which could make prior IOVAs invalid will fail.
  88  */
  89 int iommu_dma_init_domain(struct iommu_domain *domain, dma_addr_t base, u64 size)
  90 {
  91         struct iova_domain *iovad = domain->iova_cookie;
  92         unsigned long order, base_pfn, end_pfn;
  93
  94         if (!iovad)
  95                 return -ENODEV;
  96
  97         /* Use the smallest supported page size for IOVA granularity */
  98         order = __ffs(domain->ops->pgsize_bitmap);
  99         base_pfn = max_t(unsigned long, 1, base >> order);
 100         end_pfn = (base + size - 1) >> order;
 101
 102         /* Check the domain allows at least some access to the device... */
 103         if (domain->geometry.force_aperture) {
 104                 if (base > domain->geometry.aperture_end ||
 105                     base + size <= domain->geometry.aperture_start) {
 106                         pr_warn("specified DMA range outside IOMMU capability\n");
 107                         return -EFAULT;
 108                 }
 109                 /* ...then finally give it a kicking to make sure it fits */
 110                 base_pfn = max_t(unsigned long, base_pfn,
 111                                 domain->geometry.aperture_start >> order);
 112                 end_pfn = min_t(unsigned long, end_pfn,
 113                                 domain->geometry.aperture_end >> order);
 114         }
 115
 116         /* All we can safely do with an existing domain is enlarge it */
 117         if (iovad->start_pfn) {
 118                 if (1UL << order != iovad->granule ||
 119                     base_pfn != iovad->start_pfn ||
 120                     end_pfn < iovad->dma_32bit_pfn) {
 121                         pr_warn("Incompatible range for DMA domain\n");
 122                         return -EFAULT;
 123                 }
 124                 iovad->dma_32bit_pfn = end_pfn;
 125         } else {
 126                 init_iova_domain(iovad, 1UL << order, base_pfn, end_pfn);
 127         }
 128         return 0;
 129 }
 130 EXPORT_SYMBOL(iommu_dma_init_domain);
 131
 132 /**
 133  * dma_direction_to_prot - Translate DMA API directions to IOMMU API page flags
 134  * @dir: Direction of DMA transfer
 135  * @coherent: Is the DMA master cache-coherent?
 136  *
 137  * Return: corresponding IOMMU API page protection flags
 138  */
 139 int dma_direction_to_prot(enum dma_data_direction dir, bool coherent)
 140 {
 141         int prot = coherent ? IOMMU_CACHE : 0;
 142
 143         switch (dir) {
 144         case DMA_BIDIRECTIONAL:
 145                 return prot | IOMMU_READ | IOMMU_WRITE;
 146         case DMA_TO_DEVICE:
 147                 return prot | IOMMU_READ;
 148         case DMA_FROM_DEVICE:
 149                 return prot | IOMMU_WRITE;
 150         default:
 151                 return 0;
 152         }
 153 }
 154
 155 static struct iova *__alloc_iova(struct iova_domain *iovad, size_t size,
 156                 dma_addr_t dma_limit)
 157 {
 158         unsigned long shift = iova_shift(iovad);
 159         unsigned long length = iova_align(iovad, size) >> shift;
 160
 161         /*
 162          * Enforce size-alignment to be safe - there could perhaps be an
 163          * attribute to control this per-device, or at least per-domain...
 164          */
 165         return alloc_iova(iovad, length, dma_limit >> shift, true);
 166 }
 167
 168 /* The IOVA allocator knows what we mapped, so just unmap whatever that was */
 169 static void __iommu_dma_unmap(struct iommu_domain *domain, dma_addr_t dma_addr)
 170 {
 171         struct iova_domain *iovad = domain->iova_cookie;
 172         unsigned long shift = iova_shift(iovad);
 173         unsigned long pfn = dma_addr >> shift;
 174         struct iova *iova = find_iova(iovad, pfn);
 175         size_t size;
 176
 177         if (WARN_ON(!iova))
 178                 return;
 179
 180         size = iova_size(iova) << shift;
 181         size -= iommu_unmap(domain, pfn << shift, size);
 182         /* ...and if we can't, then something is horribly, horribly wrong */
 183         WARN_ON(size > 0);
 184         __free_iova(iovad, iova);
 185 }
 186
 187 static void __iommu_dma_free_pages(struct page **pages, int count)
 188 {
 189         while (count--)
 190                 __free_page(pages[count]);
 191         kvfree(pages);
 192 }
 193
 194 static struct page **__iommu_dma_alloc_pages(unsigned int count, gfp_t gfp)
 195 {
 196         struct page **pages;
 197         unsigned int i = 0, array_size = count * sizeof(*pages);
 198         unsigned int order = MAX_ORDER;
 199
 200         if (array_size <= PAGE_SIZE)
 201                 pages = kzalloc(array_size, GFP_KERNEL);
 202         else
 203                 pages = vzalloc(array_size);
 204         if (!pages)
 205                 return NULL;
 206
 207         /* IOMMU can map any pages, so himem can also be used here */
 208         gfp |= __GFP_NOWARN | __GFP_HIGHMEM;
 209
 210         while (count) {
 211                 struct page *page = NULL;
 212                 int j;
 213
 214                 /*
 215                  * Higher-order allocations are a convenience rather
 216                  * than a necessity, hence using __GFP_NORETRY until
 217                  * falling back to single-page allocations.
 218                  */
 219                 for (order = min_t(unsigned int, order, __fls(count));
 220                      order > 0; order--) {
 221                         page = alloc_pages(gfp | __GFP_NORETRY, order);
 222                         if (!page)
 223                                 continue;
 224                         if (PageCompound(page)) {
 225                                 if (!split_huge_page(page))
 226                                         break;
 227                                 __free_pages(page, order);
 228                         } else {
 229                                 split_page(page, order);
 230                                 break;
 231                         }
 232                 }
 233                 if (!page)
 234                         page = alloc_page(gfp);
 235                 if (!page) {
 236                         __iommu_dma_free_pages(pages, i);
 237                         return NULL;
 238                 }
 239                 j = 1 << order;
 240                 count -= j;
 241                 while (j--)
 242                         pages[i++] = page++;
 243         }
 244         return pages;
 245 }
 246
 247 /**
 248  * iommu_dma_free - Free a buffer allocated by iommu_dma_alloc()
 249  * @dev: Device which owns this buffer
 250  * @pages: Array of buffer pages as returned by iommu_dma_alloc()
 251  * @size: Size of buffer in bytes
 252  * @handle: DMA address of buffer
 253  *
 254  * Frees both the pages associated with the buffer, and the array
 255  * describing them
 256  */
 257 void iommu_dma_free(struct device *dev, struct page **pages, size_t size,
 258                 dma_addr_t *handle)
 259 {
 260         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), *handle);
 261         __iommu_dma_free_pages(pages, PAGE_ALIGN(size) >> PAGE_SHIFT);
 262         *handle = DMA_ERROR_CODE;
 263 }
 264
 265 /**
 266  * iommu_dma_alloc - Allocate and map a buffer contiguous in IOVA space
 267  * @dev: Device to allocate memory for. Must be a real device
 268  *       attached to an iommu_dma_domain
 269  * @size: Size of buffer in bytes
 270  * @gfp: Allocation flags
 271  * @prot: IOMMU mapping flags
 272  * @handle: Out argument for allocated DMA handle
 273  * @flush_page: Arch callback which must ensure PAGE_SIZE bytes from the
 274  *              given VA/PA are visible to the given non-coherent device.
 275  *
 276  * If @size is less than PAGE_SIZE, then a full CPU page will be allocated,
 277  * but an IOMMU which supports smaller pages might not map the whole thing.
 278  *
 279  * Return: Array of struct page pointers describing the buffer,
 280  *         or NULL on failure.
 281  */
 282 struct page **iommu_dma_alloc(struct device *dev, size_t size,
 283                 gfp_t gfp, int prot, dma_addr_t *handle,
 284                 void (*flush_page)(struct device *, const void *, phys_addr_t))
 285 {
 286         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 287         struct iova_domain *iovad = domain->iova_cookie;
 288         struct iova *iova;
 289         struct page **pages;
 290         struct sg_table sgt;
 291         dma_addr_t dma_addr;
 292         unsigned int count = PAGE_ALIGN(size) >> PAGE_SHIFT;
 293
 294         *handle = DMA_ERROR_CODE;
 295
 296         pages = __iommu_dma_alloc_pages(count, gfp);
 297         if (!pages)
 298                 return NULL;
 299
 300         iova = __alloc_iova(iovad, size, dev->coherent_dma_mask);
 301         if (!iova)
 302                 goto out_free_pages;
 303
 304         size = iova_align(iovad, size);
 305         if (sg_alloc_table_from_pages(&sgt, pages, count, 0, size, GFP_KERNEL))
 306                 goto out_free_iova;
 307
 308         if (!(prot & IOMMU_CACHE)) {
 309                 struct sg_mapping_iter miter;
 310                 /*
 311                  * The CPU-centric flushing implied by SG_MITER_TO_SG isn't
 312                  * sufficient here, so skip it by using the "wrong" direction.
 313                  */
 314                 sg_miter_start(&miter, sgt.sgl, sgt.orig_nents, SG_MITER_FROM_SG);
 315                 while (sg_miter_next(&miter))
 316                         flush_page(dev, miter.addr, page_to_phys(miter.page));
 317                 sg_miter_stop(&miter);
 318         }
 319
 320         dma_addr = iova_dma_addr(iovad, iova);
 321         if (iommu_map_sg(domain, dma_addr, sgt.sgl, sgt.orig_nents, prot)
 322                         < size)
 323                 goto out_free_sg;
 324
 325         *handle = dma_addr;
 326         sg_free_table(&sgt);
 327         return pages;
 328
 329 out_free_sg:
 330         sg_free_table(&sgt);
 331 out_free_iova:
 332         __free_iova(iovad, iova);
 333 out_free_pages:
 334         __iommu_dma_free_pages(pages, count);
 335         return NULL;
 336 }
 337
 338 /**
 339  * iommu_dma_mmap - Map a buffer into provided user VMA
 340  * @pages: Array representing buffer from iommu_dma_alloc()
 341  * @size: Size of buffer in bytes
 342  * @vma: VMA describing requested userspace mapping
 343  *
 344  * Maps the pages of the buffer in @pages into @vma. The caller is responsible
 345  * for verifying the correct size and protection of @vma beforehand.
 346  */
 347
 348 int iommu_dma_mmap(struct page **pages, size_t size, struct vm_area_struct *vma)
 349 {
 350         unsigned long uaddr = vma->vm_start;
 351         unsigned int i, count = PAGE_ALIGN(size) >> PAGE_SHIFT;
 352         int ret = -ENXIO;
 353
 354         for (i = vma->vm_pgoff; i < count && uaddr < vma->vm_end; i++) {
 355                 ret = vm_insert_page(vma, uaddr, pages[i]);
 356                 if (ret)
 357                         break;
 358                 uaddr += PAGE_SIZE;
 359         }
 360         return ret;
 361 }
 362
 363 dma_addr_t iommu_dma_map_page(struct device *dev, struct page *page,
 364                 unsigned long offset, size_t size, int prot)
 365 {
 366         dma_addr_t dma_addr;
 367         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 368         struct iova_domain *iovad = domain->iova_cookie;
 369         phys_addr_t phys = page_to_phys(page) + offset;
 370         size_t iova_off = iova_offset(iovad, phys);
 371         size_t len = iova_align(iovad, size + iova_off);
 372         struct iova *iova = __alloc_iova(iovad, len, dma_get_mask(dev));
 373
 374         if (!iova)
 375                 return DMA_ERROR_CODE;
 376
 377         dma_addr = iova_dma_addr(iovad, iova);
 378         if (iommu_map(domain, dma_addr, phys - iova_off, len, prot)) {
 379                 __free_iova(iovad, iova);
 380                 return DMA_ERROR_CODE;
 381         }
 382         return dma_addr + iova_off;
 383 }
 384
 385 void iommu_dma_unmap_page(struct device *dev, dma_addr_t handle, size_t size,
 386                 enum dma_data_direction dir, struct dma_attrs *attrs)
 387 {
 388         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), handle);
 389 }
 390
 391 /*
 392  * Prepare a successfully-mapped scatterlist to give back to the caller.
 393  *
 394  * At this point the segments are already laid out by iommu_dma_map_sg() to
 395  * avoid individually crossing any boundaries, so we merely need to check a
 396  * segment's start address to avoid concatenating across one.
 397  */
 398 static int __finalise_sg(struct device *dev, struct scatterlist *sg, int nents,
 399                 dma_addr_t dma_addr)
 400 {
 401         struct scatterlist *s, *cur = sg;
 402         unsigned long seg_mask = dma_get_seg_boundary(dev);
 403         unsigned int cur_len = 0, max_len = dma_get_max_seg_size(dev);
 404         int i, count = 0;
 405
 406         for_each_sg(sg, s, nents, i) {
 407                 /* Restore this segment's original unaligned fields first */
 408                 unsigned int s_iova_off = sg_dma_address(s);
 409                 unsigned int s_length = sg_dma_len(s);
 410                 unsigned int s_iova_len = s->length;
 411
 412                 s->offset += s_iova_off;
 413                 s->length = s_length;
 414                 sg_dma_address(s) = DMA_ERROR_CODE;
 415                 sg_dma_len(s) = 0;
 416
 417                 /*
 418                  * Now fill in the real DMA data. If...
 419                  * - there is a valid output segment to append to
 420                  * - and this segment starts on an IOVA page boundary
 421                  * - but doesn't fall at a segment boundary
 422                  * - and wouldn't make the resulting output segment too long
 423                  */
 424                 if (cur_len && !s_iova_off && (dma_addr & seg_mask) &&
 425                     (cur_len + s_length <= max_len)) {
 426                         /* ...then concatenate it with the previous one */
 427                         cur_len += s_length;
 428                 } else {
 429                         /* Otherwise start the next output segment */
 430                         if (i > 0)
 431                                 cur = sg_next(cur);
 432                         cur_len = s_length;
 433                         count++;
 434
 435                         sg_dma_address(cur) = dma_addr + s_iova_off;
 436                 }
 437
 438                 sg_dma_len(cur) = cur_len;
 439                 dma_addr += s_iova_len;
 440
 441                 if (s_length + s_iova_off < s_iova_len)
 442                         cur_len = 0;
 443         }
 444         return count;
 445 }
 446
 447 /*
 448  * If mapping failed, then just restore the original list,
 449  * but making sure the DMA fields are invalidated.
 450  */
 451 static void __invalidate_sg(struct scatterlist *sg, int nents)
 452 {
 453         struct scatterlist *s;
 454         int i;
 455
 456         for_each_sg(sg, s, nents, i) {
 457                 if (sg_dma_address(s) != DMA_ERROR_CODE)
 458                         s->offset += sg_dma_address(s);
 459                 if (sg_dma_len(s))
 460                         s->length = sg_dma_len(s);
 461                 sg_dma_address(s) = DMA_ERROR_CODE;
 462                 sg_dma_len(s) = 0;
 463         }
 464 }
 465
 466 /*
 467  * The DMA API client is passing in a scatterlist which could describe
 468  * any old buffer layout, but the IOMMU API requires everything to be
 469  * aligned to IOMMU pages. Hence the need for this complicated bit of
 470  * impedance-matching, to be able to hand off a suitably-aligned list,
 471  * but still preserve the original offsets and sizes for the caller.
 472  */
 473 int iommu_dma_map_sg(struct device *dev, struct scatterlist *sg,
 474                 int nents, int prot)
 475 {
 476         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 477         struct iova_domain *iovad = domain->iova_cookie;
 478         struct iova *iova;
 479         struct scatterlist *s, *prev = NULL;
 480         dma_addr_t dma_addr;
 481         size_t iova_len = 0;
 482         unsigned long mask = dma_get_seg_boundary(dev);
 483         int i;
 484
 485         /*
 486          * Work out how much IOVA space we need, and align the segments to
 487          * IOVA granules for the IOMMU driver to handle. With some clever
 488          * trickery we can modify the list in-place, but reversibly, by
 489          * stashing the unaligned parts in the as-yet-unused DMA fields.
 490          */
 491         for_each_sg(sg, s, nents, i) {
 492                 size_t s_iova_off = iova_offset(iovad, s->offset);
 493                 size_t s_length = s->length;
 494                 size_t pad_len = (mask - iova_len + 1) & mask;
 495
 496                 sg_dma_address(s) = s_iova_off;
 497                 sg_dma_len(s) = s_length;
 498                 s->offset -= s_iova_off;
 499                 s_length = iova_align(iovad, s_length + s_iova_off);
 500                 s->length = s_length;
 501
 502                 /*
 503                  * Due to the alignment of our single IOVA allocation, we can
 504                  * depend on these assumptions about the segment boundary mask:
 505                  * - If mask size >= IOVA size, then the IOVA range cannot
 506                  *   possibly fall across a boundary, so we don't care.
 507                  * - If mask size < IOVA size, then the IOVA range must start
 508                  *   exactly on a boundary, therefore we can lay things out
 509                  *   based purely on segment lengths without needing to know
 510                  *   the actual addresses beforehand.
 511                  * - The mask must be a power of 2, so pad_len == 0 if
 512                  *   iova_len == 0, thus we cannot dereference prev the first
 513                  *   time through here (i.e. before it has a meaningful value).
 514                  */
 515                 if (pad_len && pad_len < s_length - 1) {
 516                         prev->length += pad_len;
 517                         iova_len += pad_len;
 518                 }
 519
 520                 iova_len += s_length;
 521                 prev = s;
 522         }
 523
 524         iova = __alloc_iova(iovad, iova_len, dma_get_mask(dev));
 525         if (!iova)
 526                 goto out_restore_sg;
 527
 528         /*
 529          * We'll leave any physical concatenation to the IOMMU driver's
 530          * implementation - it knows better than we do.
 531          */
 532         dma_addr = iova_dma_addr(iovad, iova);
 533         if (iommu_map_sg(domain, dma_addr, sg, nents, prot) < iova_len)
 534                 goto out_free_iova;
 535
 536         return __finalise_sg(dev, sg, nents, dma_addr);
 537
 538 out_free_iova:
 539         __free_iova(iovad, iova);
 540 out_restore_sg:
 541         __invalidate_sg(sg, nents);
 542         return 0;
 543 }
 544
 545 void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg, int nents,
 546                 enum dma_data_direction dir, struct dma_attrs *attrs)
 547 {
 548         /*
 549          * The scatterlist segments are mapped into a single
 550          * contiguous IOVA allocation, so this is incredibly easy.
 551          */
 552         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), sg_dma_address(sg));
 553 }
 554
 555 int iommu_dma_supported(struct device *dev, u64 mask)
 556 {
 557         /*
 558          * 'Special' IOMMUs which don't have the same addressing capability
 559          * as the CPU will have to wait until we have some way to query that
 560          * before they'll be able to use this framework.
 561          */
 562         return 1;
 563 }
 564
 565 int iommu_dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 566 {
 567         return dma_addr == DMA_ERROR_CODE;
 568 }