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/irq.h>
  29 #include <linux/mm.h>
  30 #include <linux/pci.h>
  31 #include <linux/scatterlist.h>
  32 #include <linux/vmalloc.h>
  33
  34 struct iommu_dma_msi_page {
  35         struct list_head        list;
  36         dma_addr_t              iova;
  37         phys_addr_t             phys;
  38 };
  39
  40 enum iommu_dma_cookie_type {
  41         IOMMU_DMA_IOVA_COOKIE,
  42         IOMMU_DMA_MSI_COOKIE,
  43 };
  44
  45 struct iommu_dma_cookie {
  46         enum iommu_dma_cookie_type      type;
  47         union {
  48                 /* Full allocator for IOMMU_DMA_IOVA_COOKIE */
  49                 struct iova_domain      iovad;
  50                 /* Trivial linear page allocator for IOMMU_DMA_MSI_COOKIE */
  51                 dma_addr_t              msi_iova;
  52         };
  53         struct list_head                msi_page_list;
  54         spinlock_t                      msi_lock;
  55 };
  56
  57 static inline size_t cookie_msi_granule(struct iommu_dma_cookie *cookie)
  58 {
  59         if (cookie->type == IOMMU_DMA_IOVA_COOKIE)
  60                 return cookie->iovad.granule;
  61         return PAGE_SIZE;
  62 }
  63
  64 static inline struct iova_domain *cookie_iovad(struct iommu_domain *domain)
  65 {
  66         struct iommu_dma_cookie *cookie = domain->iova_cookie;
  67
  68         if (cookie->type == IOMMU_DMA_IOVA_COOKIE)
  69                 return &cookie->iovad;
  70         return NULL;
  71 }
  72
  73 static struct iommu_dma_cookie *cookie_alloc(enum iommu_dma_cookie_type type)
  74 {
  75         struct iommu_dma_cookie *cookie;
  76
  77         cookie = kzalloc(sizeof(*cookie), GFP_KERNEL);
  78         if (cookie) {
  79                 spin_lock_init(&cookie->msi_lock);
  80                 INIT_LIST_HEAD(&cookie->msi_page_list);
  81                 cookie->type = type;
  82         }
  83         return cookie;
  84 }
  85
  86 int iommu_dma_init(void)
  87 {
  88         return iova_cache_get();
  89 }
  90
  91 /**
  92  * iommu_get_dma_cookie - Acquire DMA-API resources for a domain
  93  * @domain: IOMMU domain to prepare for DMA-API usage
  94  *
  95  * IOMMU drivers should normally call this from their domain_alloc
  96  * callback when domain->type == IOMMU_DOMAIN_DMA.
  97  */
  98 int iommu_get_dma_cookie(struct iommu_domain *domain)
  99 {
 100         if (domain->iova_cookie)
 101                 return -EEXIST;
 102
 103         domain->iova_cookie = cookie_alloc(IOMMU_DMA_IOVA_COOKIE);
 104         if (!domain->iova_cookie)
 105                 return -ENOMEM;
 106
 107         return 0;
 108 }
 109 EXPORT_SYMBOL(iommu_get_dma_cookie);
 110
 111 /**
 112  * iommu_get_msi_cookie - Acquire just MSI remapping resources
 113  * @domain: IOMMU domain to prepare
 114  * @base: Start address of IOVA region for MSI mappings
 115  *
 116  * Users who manage their own IOVA allocation and do not want DMA API support,
 117  * but would still like to take advantage of automatic MSI remapping, can use
 118  * this to initialise their own domain appropriately. Users should reserve a
 119  * contiguous IOVA region, starting at @base, large enough to accommodate the
 120  * number of PAGE_SIZE mappings necessary to cover every MSI doorbell address
 121  * used by the devices attached to @domain.
 122  */
 123 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
 124 {
 125         struct iommu_dma_cookie *cookie;
 126
 127         if (domain->type != IOMMU_DOMAIN_UNMANAGED)
 128                 return -EINVAL;
 129
 130         if (domain->iova_cookie)
 131                 return -EEXIST;
 132
 133         cookie = cookie_alloc(IOMMU_DMA_MSI_COOKIE);
 134         if (!cookie)
 135                 return -ENOMEM;
 136
 137         cookie->msi_iova = base;
 138         domain->iova_cookie = cookie;
 139         return 0;
 140 }
 141 EXPORT_SYMBOL(iommu_get_msi_cookie);
 142
 143 /**
 144  * iommu_put_dma_cookie - Release a domain's DMA mapping resources
 145  * @domain: IOMMU domain previously prepared by iommu_get_dma_cookie() or
 146  *          iommu_get_msi_cookie()
 147  *
 148  * IOMMU drivers should normally call this from their domain_free callback.
 149  */
 150 void iommu_put_dma_cookie(struct iommu_domain *domain)
 151 {
 152         struct iommu_dma_cookie *cookie = domain->iova_cookie;
 153         struct iommu_dma_msi_page *msi, *tmp;
 154
 155         if (!cookie)
 156                 return;
 157
 158         if (cookie->type == IOMMU_DMA_IOVA_COOKIE && cookie->iovad.granule)
 159                 put_iova_domain(&cookie->iovad);
 160
 161         list_for_each_entry_safe(msi, tmp, &cookie->msi_page_list, list) {
 162                 list_del(&msi->list);
 163                 kfree(msi);
 164         }
 165         kfree(cookie);
 166         domain->iova_cookie = NULL;
 167 }
 168 EXPORT_SYMBOL(iommu_put_dma_cookie);
 169
 170 static void iova_reserve_pci_windows(struct pci_dev *dev,
 171                 struct iova_domain *iovad)
 172 {
 173         struct pci_host_bridge *bridge = pci_find_host_bridge(dev->bus);
 174         struct resource_entry *window;
 175         unsigned long lo, hi;
 176
 177         resource_list_for_each_entry(window, &bridge->windows) {
 178                 if (resource_type(window->res) != IORESOURCE_MEM &&
 179                     resource_type(window->res) != IORESOURCE_IO)
 180                         continue;
 181
 182                 lo = iova_pfn(iovad, window->res->start - window->offset);
 183                 hi = iova_pfn(iovad, window->res->end - window->offset);
 184                 reserve_iova(iovad, lo, hi);
 185         }
 186 }
 187
 188 /**
 189  * iommu_dma_init_domain - Initialise a DMA mapping domain
 190  * @domain: IOMMU domain previously prepared by iommu_get_dma_cookie()
 191  * @base: IOVA at which the mappable address space starts
 192  * @size: Size of IOVA space
 193  * @dev: Device the domain is being initialised for
 194  *
 195  * @base and @size should be exact multiples of IOMMU page granularity to
 196  * avoid rounding surprises. If necessary, we reserve the page at address 0
 197  * to ensure it is an invalid IOVA. It is safe to reinitialise a domain, but
 198  * any change which could make prior IOVAs invalid will fail.
 199  */
 200 int iommu_dma_init_domain(struct iommu_domain *domain, dma_addr_t base,
 201                 u64 size, struct device *dev)
 202 {
 203         struct iommu_dma_cookie *cookie = domain->iova_cookie;
 204         struct iova_domain *iovad = &cookie->iovad;
 205         unsigned long order, base_pfn, end_pfn;
 206
 207         if (!cookie || cookie->type != IOMMU_DMA_IOVA_COOKIE)
 208                 return -EINVAL;
 209
 210         /* Use the smallest supported page size for IOVA granularity */
 211         order = __ffs(domain->pgsize_bitmap);
 212         base_pfn = max_t(unsigned long, 1, base >> order);
 213         end_pfn = (base + size - 1) >> order;
 214
 215         /* Check the domain allows at least some access to the device... */
 216         if (domain->geometry.force_aperture) {
 217                 if (base > domain->geometry.aperture_end ||
 218                     base + size <= domain->geometry.aperture_start) {
 219                         pr_warn("specified DMA range outside IOMMU capability\n");
 220                         return -EFAULT;
 221                 }
 222                 /* ...then finally give it a kicking to make sure it fits */
 223                 base_pfn = max_t(unsigned long, base_pfn,
 224                                 domain->geometry.aperture_start >> order);
 225                 end_pfn = min_t(unsigned long, end_pfn,
 226                                 domain->geometry.aperture_end >> order);
 227         }
 228
 229         /* All we can safely do with an existing domain is enlarge it */
 230         if (iovad->start_pfn) {
 231                 if (1UL << order != iovad->granule ||
 232                     base_pfn != iovad->start_pfn ||
 233                     end_pfn < iovad->dma_32bit_pfn) {
 234                         pr_warn("Incompatible range for DMA domain\n");
 235                         return -EFAULT;
 236                 }
 237                 iovad->dma_32bit_pfn = end_pfn;
 238         } else {
 239                 init_iova_domain(iovad, 1UL << order, base_pfn, end_pfn);
 240                 if (dev && dev_is_pci(dev))
 241                         iova_reserve_pci_windows(to_pci_dev(dev), iovad);
 242         }
 243         return 0;
 244 }
 245 EXPORT_SYMBOL(iommu_dma_init_domain);
 246
 247 /**
 248  * dma_direction_to_prot - Translate DMA API directions to IOMMU API page flags
 249  * @dir: Direction of DMA transfer
 250  * @coherent: Is the DMA master cache-coherent?
 251  *
 252  * Return: corresponding IOMMU API page protection flags
 253  */
 254 int dma_direction_to_prot(enum dma_data_direction dir, bool coherent)
 255 {
 256         int prot = coherent ? IOMMU_CACHE : 0;
 257
 258         switch (dir) {
 259         case DMA_BIDIRECTIONAL:
 260                 return prot | IOMMU_READ | IOMMU_WRITE;
 261         case DMA_TO_DEVICE:
 262                 return prot | IOMMU_READ;
 263         case DMA_FROM_DEVICE:
 264                 return prot | IOMMU_WRITE;
 265         default:
 266                 return 0;
 267         }
 268 }
 269
 270 static struct iova *__alloc_iova(struct iommu_domain *domain, size_t size,
 271                 dma_addr_t dma_limit)
 272 {
 273         struct iova_domain *iovad = cookie_iovad(domain);
 274         unsigned long shift = iova_shift(iovad);
 275         unsigned long length = iova_align(iovad, size) >> shift;
 276
 277         if (domain->geometry.force_aperture)
 278                 dma_limit = min(dma_limit, domain->geometry.aperture_end);
 279         /*
 280          * Enforce size-alignment to be safe - there could perhaps be an
 281          * attribute to control this per-device, or at least per-domain...
 282          */
 283         return alloc_iova(iovad, length, dma_limit >> shift, true);
 284 }
 285
 286 /* The IOVA allocator knows what we mapped, so just unmap whatever that was */
 287 static void __iommu_dma_unmap(struct iommu_domain *domain, dma_addr_t dma_addr)
 288 {
 289         struct iova_domain *iovad = cookie_iovad(domain);
 290         unsigned long shift = iova_shift(iovad);
 291         unsigned long pfn = dma_addr >> shift;
 292         struct iova *iova = find_iova(iovad, pfn);
 293         size_t size;
 294
 295         if (WARN_ON(!iova))
 296                 return;
 297
 298         size = iova_size(iova) << shift;
 299         size -= iommu_unmap(domain, pfn << shift, size);
 300         /* ...and if we can't, then something is horribly, horribly wrong */
 301         WARN_ON(size > 0);
 302         __free_iova(iovad, iova);
 303 }
 304
 305 static void __iommu_dma_free_pages(struct page **pages, int count)
 306 {
 307         while (count--)
 308                 __free_page(pages[count]);
 309         kvfree(pages);
 310 }
 311
 312 static struct page **__iommu_dma_alloc_pages(unsigned int count,
 313                 unsigned long order_mask, gfp_t gfp)
 314 {
 315         struct page **pages;
 316         unsigned int i = 0, array_size = count * sizeof(*pages);
 317
 318         order_mask &= (2U << MAX_ORDER) - 1;
 319         if (!order_mask)
 320                 return NULL;
 321
 322         if (array_size <= PAGE_SIZE)
 323                 pages = kzalloc(array_size, GFP_KERNEL);
 324         else
 325                 pages = vzalloc(array_size);
 326         if (!pages)
 327                 return NULL;
 328
 329         /* IOMMU can map any pages, so himem can also be used here */
 330         gfp |= __GFP_NOWARN | __GFP_HIGHMEM;
 331
 332         while (count) {
 333                 struct page *page = NULL;
 334                 unsigned int order_size;
 335
 336                 /*
 337                  * Higher-order allocations are a convenience rather
 338                  * than a necessity, hence using __GFP_NORETRY until
 339                  * falling back to minimum-order allocations.
 340                  */
 341                 for (order_mask &= (2U << __fls(count)) - 1;
 342                      order_mask; order_mask &= ~order_size) {
 343                         unsigned int order = __fls(order_mask);
 344
 345                         order_size = 1U << order;
 346                         page = alloc_pages((order_mask - order_size) ?
 347                                            gfp | __GFP_NORETRY : gfp, order);
 348                         if (!page)
 349                                 continue;
 350                         if (!order)
 351                                 break;
 352                         if (!PageCompound(page)) {
 353                                 split_page(page, order);
 354                                 break;
 355                         } else if (!split_huge_page(page)) {
 356                                 break;
 357                         }
 358                         __free_pages(page, order);
 359                 }
 360                 if (!page) {
 361                         __iommu_dma_free_pages(pages, i);
 362                         return NULL;
 363                 }
 364                 count -= order_size;
 365                 while (order_size--)
 366                         pages[i++] = page++;
 367         }
 368         return pages;
 369 }
 370
 371 /**
 372  * iommu_dma_free - Free a buffer allocated by iommu_dma_alloc()
 373  * @dev: Device which owns this buffer
 374  * @pages: Array of buffer pages as returned by iommu_dma_alloc()
 375  * @size: Size of buffer in bytes
 376  * @handle: DMA address of buffer
 377  *
 378  * Frees both the pages associated with the buffer, and the array
 379  * describing them
 380  */
 381 void iommu_dma_free(struct device *dev, struct page **pages, size_t size,
 382                 dma_addr_t *handle)
 383 {
 384         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), *handle);
 385         __iommu_dma_free_pages(pages, PAGE_ALIGN(size) >> PAGE_SHIFT);
 386         *handle = DMA_ERROR_CODE;
 387 }
 388
 389 /**
 390  * iommu_dma_alloc - Allocate and map a buffer contiguous in IOVA space
 391  * @dev: Device to allocate memory for. Must be a real device
 392  *       attached to an iommu_dma_domain
 393  * @size: Size of buffer in bytes
 394  * @gfp: Allocation flags
 395  * @attrs: DMA attributes for this allocation
 396  * @prot: IOMMU mapping flags
 397  * @handle: Out argument for allocated DMA handle
 398  * @flush_page: Arch callback which must ensure PAGE_SIZE bytes from the
 399  *              given VA/PA are visible to the given non-coherent device.
 400  *
 401  * If @size is less than PAGE_SIZE, then a full CPU page will be allocated,
 402  * but an IOMMU which supports smaller pages might not map the whole thing.
 403  *
 404  * Return: Array of struct page pointers describing the buffer,
 405  *         or NULL on failure.
 406  */
 407 struct page **iommu_dma_alloc(struct device *dev, size_t size, gfp_t gfp,
 408                 unsigned long attrs, int prot, dma_addr_t *handle,
 409                 void (*flush_page)(struct device *, const void *, phys_addr_t))
 410 {
 411         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 412         struct iova_domain *iovad = cookie_iovad(domain);
 413         struct iova *iova;
 414         struct page **pages;
 415         struct sg_table sgt;
 416         dma_addr_t dma_addr;
 417         unsigned int count, min_size, alloc_sizes = domain->pgsize_bitmap;
 418
 419         *handle = DMA_ERROR_CODE;
 420
 421         min_size = alloc_sizes & -alloc_sizes;
 422         if (min_size < PAGE_SIZE) {
 423                 min_size = PAGE_SIZE;
 424                 alloc_sizes |= PAGE_SIZE;
 425         } else {
 426                 size = ALIGN(size, min_size);
 427         }
 428         if (attrs & DMA_ATTR_ALLOC_SINGLE_PAGES)
 429                 alloc_sizes = min_size;
 430
 431         count = PAGE_ALIGN(size) >> PAGE_SHIFT;
 432         pages = __iommu_dma_alloc_pages(count, alloc_sizes >> PAGE_SHIFT, gfp);
 433         if (!pages)
 434                 return NULL;
 435
 436         iova = __alloc_iova(domain, size, dev->coherent_dma_mask);
 437         if (!iova)
 438                 goto out_free_pages;
 439
 440         size = iova_align(iovad, size);
 441         if (sg_alloc_table_from_pages(&sgt, pages, count, 0, size, GFP_KERNEL))
 442                 goto out_free_iova;
 443
 444         if (!(prot & IOMMU_CACHE)) {
 445                 struct sg_mapping_iter miter;
 446                 /*
 447                  * The CPU-centric flushing implied by SG_MITER_TO_SG isn't
 448                  * sufficient here, so skip it by using the "wrong" direction.
 449                  */
 450                 sg_miter_start(&miter, sgt.sgl, sgt.orig_nents, SG_MITER_FROM_SG);
 451                 while (sg_miter_next(&miter))
 452                         flush_page(dev, miter.addr, page_to_phys(miter.page));
 453                 sg_miter_stop(&miter);
 454         }
 455
 456         dma_addr = iova_dma_addr(iovad, iova);
 457         if (iommu_map_sg(domain, dma_addr, sgt.sgl, sgt.orig_nents, prot)
 458                         < size)
 459                 goto out_free_sg;
 460
 461         *handle = dma_addr;
 462         sg_free_table(&sgt);
 463         return pages;
 464
 465 out_free_sg:
 466         sg_free_table(&sgt);
 467 out_free_iova:
 468         __free_iova(iovad, iova);
 469 out_free_pages:
 470         __iommu_dma_free_pages(pages, count);
 471         return NULL;
 472 }
 473
 474 /**
 475  * iommu_dma_mmap - Map a buffer into provided user VMA
 476  * @pages: Array representing buffer from iommu_dma_alloc()
 477  * @size: Size of buffer in bytes
 478  * @vma: VMA describing requested userspace mapping
 479  *
 480  * Maps the pages of the buffer in @pages into @vma. The caller is responsible
 481  * for verifying the correct size and protection of @vma beforehand.
 482  */
 483
 484 int iommu_dma_mmap(struct page **pages, size_t size, struct vm_area_struct *vma)
 485 {
 486         unsigned long uaddr = vma->vm_start;
 487         unsigned int i, count = PAGE_ALIGN(size) >> PAGE_SHIFT;
 488         int ret = -ENXIO;
 489
 490         for (i = vma->vm_pgoff; i < count && uaddr < vma->vm_end; i++) {
 491                 ret = vm_insert_page(vma, uaddr, pages[i]);
 492                 if (ret)
 493                         break;
 494                 uaddr += PAGE_SIZE;
 495         }
 496         return ret;
 497 }
 498
 499 static dma_addr_t __iommu_dma_map(struct device *dev, phys_addr_t phys,
 500                 size_t size, int prot)
 501 {
 502         dma_addr_t dma_addr;
 503         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 504         struct iova_domain *iovad = cookie_iovad(domain);
 505         size_t iova_off = iova_offset(iovad, phys);
 506         size_t len = iova_align(iovad, size + iova_off);
 507         struct iova *iova = __alloc_iova(domain, len, dma_get_mask(dev));
 508
 509         if (!iova)
 510                 return DMA_ERROR_CODE;
 511
 512         dma_addr = iova_dma_addr(iovad, iova);
 513         if (iommu_map(domain, dma_addr, phys - iova_off, len, prot)) {
 514                 __free_iova(iovad, iova);
 515                 return DMA_ERROR_CODE;
 516         }
 517         return dma_addr + iova_off;
 518 }
 519
 520 dma_addr_t iommu_dma_map_page(struct device *dev, struct page *page,
 521                 unsigned long offset, size_t size, int prot)
 522 {
 523         return __iommu_dma_map(dev, page_to_phys(page) + offset, size, prot);
 524 }
 525
 526 void iommu_dma_unmap_page(struct device *dev, dma_addr_t handle, size_t size,
 527                 enum dma_data_direction dir, unsigned long attrs)
 528 {
 529         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), handle);
 530 }
 531
 532 /*
 533  * Prepare a successfully-mapped scatterlist to give back to the caller.
 534  *
 535  * At this point the segments are already laid out by iommu_dma_map_sg() to
 536  * avoid individually crossing any boundaries, so we merely need to check a
 537  * segment's start address to avoid concatenating across one.
 538  */
 539 static int __finalise_sg(struct device *dev, struct scatterlist *sg, int nents,
 540                 dma_addr_t dma_addr)
 541 {
 542         struct scatterlist *s, *cur = sg;
 543         unsigned long seg_mask = dma_get_seg_boundary(dev);
 544         unsigned int cur_len = 0, max_len = dma_get_max_seg_size(dev);
 545         int i, count = 0;
 546
 547         for_each_sg(sg, s, nents, i) {
 548                 /* Restore this segment's original unaligned fields first */
 549                 unsigned int s_iova_off = sg_dma_address(s);
 550                 unsigned int s_length = sg_dma_len(s);
 551                 unsigned int s_iova_len = s->length;
 552
 553                 s->offset += s_iova_off;
 554                 s->length = s_length;
 555                 sg_dma_address(s) = DMA_ERROR_CODE;
 556                 sg_dma_len(s) = 0;
 557
 558                 /*
 559                  * Now fill in the real DMA data. If...
 560                  * - there is a valid output segment to append to
 561                  * - and this segment starts on an IOVA page boundary
 562                  * - but doesn't fall at a segment boundary
 563                  * - and wouldn't make the resulting output segment too long
 564                  */
 565                 if (cur_len && !s_iova_off && (dma_addr & seg_mask) &&
 566                     (cur_len + s_length <= max_len)) {
 567                         /* ...then concatenate it with the previous one */
 568                         cur_len += s_length;
 569                 } else {
 570                         /* Otherwise start the next output segment */
 571                         if (i > 0)
 572                                 cur = sg_next(cur);
 573                         cur_len = s_length;
 574                         count++;
 575
 576                         sg_dma_address(cur) = dma_addr + s_iova_off;
 577                 }
 578
 579                 sg_dma_len(cur) = cur_len;
 580                 dma_addr += s_iova_len;
 581
 582                 if (s_length + s_iova_off < s_iova_len)
 583                         cur_len = 0;
 584         }
 585         return count;
 586 }
 587
 588 /*
 589  * If mapping failed, then just restore the original list,
 590  * but making sure the DMA fields are invalidated.
 591  */
 592 static void __invalidate_sg(struct scatterlist *sg, int nents)
 593 {
 594         struct scatterlist *s;
 595         int i;
 596
 597         for_each_sg(sg, s, nents, i) {
 598                 if (sg_dma_address(s) != DMA_ERROR_CODE)
 599                         s->offset += sg_dma_address(s);
 600                 if (sg_dma_len(s))
 601                         s->length = sg_dma_len(s);
 602                 sg_dma_address(s) = DMA_ERROR_CODE;
 603                 sg_dma_len(s) = 0;
 604         }
 605 }
 606
 607 /*
 608  * The DMA API client is passing in a scatterlist which could describe
 609  * any old buffer layout, but the IOMMU API requires everything to be
 610  * aligned to IOMMU pages. Hence the need for this complicated bit of
 611  * impedance-matching, to be able to hand off a suitably-aligned list,
 612  * but still preserve the original offsets and sizes for the caller.
 613  */
 614 int iommu_dma_map_sg(struct device *dev, struct scatterlist *sg,
 615                 int nents, int prot)
 616 {
 617         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 618         struct iova_domain *iovad = cookie_iovad(domain);
 619         struct iova *iova;
 620         struct scatterlist *s, *prev = NULL;
 621         dma_addr_t dma_addr;
 622         size_t iova_len = 0;
 623         unsigned long mask = dma_get_seg_boundary(dev);
 624         int i;
 625
 626         /*
 627          * Work out how much IOVA space we need, and align the segments to
 628          * IOVA granules for the IOMMU driver to handle. With some clever
 629          * trickery we can modify the list in-place, but reversibly, by
 630          * stashing the unaligned parts in the as-yet-unused DMA fields.
 631          */
 632         for_each_sg(sg, s, nents, i) {
 633                 size_t s_iova_off = iova_offset(iovad, s->offset);
 634                 size_t s_length = s->length;
 635                 size_t pad_len = (mask - iova_len + 1) & mask;
 636
 637                 sg_dma_address(s) = s_iova_off;
 638                 sg_dma_len(s) = s_length;
 639                 s->offset -= s_iova_off;
 640                 s_length = iova_align(iovad, s_length + s_iova_off);
 641                 s->length = s_length;
 642
 643                 /*
 644                  * Due to the alignment of our single IOVA allocation, we can
 645                  * depend on these assumptions about the segment boundary mask:
 646                  * - If mask size >= IOVA size, then the IOVA range cannot
 647                  *   possibly fall across a boundary, so we don't care.
 648                  * - If mask size < IOVA size, then the IOVA range must start
 649                  *   exactly on a boundary, therefore we can lay things out
 650                  *   based purely on segment lengths without needing to know
 651                  *   the actual addresses beforehand.
 652                  * - The mask must be a power of 2, so pad_len == 0 if
 653                  *   iova_len == 0, thus we cannot dereference prev the first
 654                  *   time through here (i.e. before it has a meaningful value).
 655                  */
 656                 if (pad_len && pad_len < s_length - 1) {
 657                         prev->length += pad_len;
 658                         iova_len += pad_len;
 659                 }
 660
 661                 iova_len += s_length;
 662                 prev = s;
 663         }
 664
 665         iova = __alloc_iova(domain, iova_len, dma_get_mask(dev));
 666         if (!iova)
 667                 goto out_restore_sg;
 668
 669         /*
 670          * We'll leave any physical concatenation to the IOMMU driver's
 671          * implementation - it knows better than we do.
 672          */
 673         dma_addr = iova_dma_addr(iovad, iova);
 674         if (iommu_map_sg(domain, dma_addr, sg, nents, prot) < iova_len)
 675                 goto out_free_iova;
 676
 677         return __finalise_sg(dev, sg, nents, dma_addr);
 678
 679 out_free_iova:
 680         __free_iova(iovad, iova);
 681 out_restore_sg:
 682         __invalidate_sg(sg, nents);
 683         return 0;
 684 }
 685
 686 void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg, int nents,
 687                 enum dma_data_direction dir, unsigned long attrs)
 688 {
 689         /*
 690          * The scatterlist segments are mapped into a single
 691          * contiguous IOVA allocation, so this is incredibly easy.
 692          */
 693         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), sg_dma_address(sg));
 694 }
 695
 696 dma_addr_t iommu_dma_map_resource(struct device *dev, phys_addr_t phys,
 697                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 698 {
 699         return __iommu_dma_map(dev, phys, size,
 700                         dma_direction_to_prot(dir, false) | IOMMU_MMIO);
 701 }
 702
 703 void iommu_dma_unmap_resource(struct device *dev, dma_addr_t handle,
 704                 size_t size, enum dma_data_direction dir, unsigned long attrs)
 705 {
 706         __iommu_dma_unmap(iommu_get_domain_for_dev(dev), handle);
 707 }
 708
 709 int iommu_dma_supported(struct device *dev, u64 mask)
 710 {
 711         /*
 712          * 'Special' IOMMUs which don't have the same addressing capability
 713          * as the CPU will have to wait until we have some way to query that
 714          * before they'll be able to use this framework.
 715          */
 716         return 1;
 717 }
 718
 719 int iommu_dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
 720 {
 721         return dma_addr == DMA_ERROR_CODE;
 722 }
 723
 724 static struct iommu_dma_msi_page *iommu_dma_get_msi_page(struct device *dev,
 725                 phys_addr_t msi_addr, struct iommu_domain *domain)
 726 {
 727         struct iommu_dma_cookie *cookie = domain->iova_cookie;
 728         struct iommu_dma_msi_page *msi_page;
 729         struct iova_domain *iovad = cookie_iovad(domain);
 730         struct iova *iova;
 731         int prot = IOMMU_WRITE | IOMMU_NOEXEC | IOMMU_MMIO;
 732         size_t size = cookie_msi_granule(cookie);
 733
 734         msi_addr &= ~(phys_addr_t)(size - 1);
 735         list_for_each_entry(msi_page, &cookie->msi_page_list, list)
 736                 if (msi_page->phys == msi_addr)
 737                         return msi_page;
 738
 739         msi_page = kzalloc(sizeof(*msi_page), GFP_ATOMIC);
 740         if (!msi_page)
 741                 return NULL;
 742
 743         msi_page->phys = msi_addr;
 744         if (iovad) {
 745                 iova = __alloc_iova(domain, size, dma_get_mask(dev));
 746                 if (!iova)
 747                         goto out_free_page;
 748                 msi_page->iova = iova_dma_addr(iovad, iova);
 749         } else {
 750                 msi_page->iova = cookie->msi_iova;
 751                 cookie->msi_iova += size;
 752         }
 753
 754         if (iommu_map(domain, msi_page->iova, msi_addr, size, prot))
 755                 goto out_free_iova;
 756
 757         INIT_LIST_HEAD(&msi_page->list);
 758         list_add(&msi_page->list, &cookie->msi_page_list);
 759         return msi_page;
 760
 761 out_free_iova:
 762         if (iovad)
 763                 __free_iova(iovad, iova);
 764         else
 765                 cookie->msi_iova -= size;
 766 out_free_page:
 767         kfree(msi_page);
 768         return NULL;
 769 }
 770
 771 void iommu_dma_map_msi_msg(int irq, struct msi_msg *msg)
 772 {
 773         struct device *dev = msi_desc_to_dev(irq_get_msi_desc(irq));
 774         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
 775         struct iommu_dma_cookie *cookie;
 776         struct iommu_dma_msi_page *msi_page;
 777         phys_addr_t msi_addr = (u64)msg->address_hi << 32 | msg->address_lo;
 778         unsigned long flags;
 779
 780         if (!domain || !domain->iova_cookie)
 781                 return;
 782
 783         cookie = domain->iova_cookie;
 784
 785         /*
 786          * We disable IRQs to rule out a possible inversion against
 787          * irq_desc_lock if, say, someone tries to retarget the affinity
 788          * of an MSI from within an IPI handler.
 789          */
 790         spin_lock_irqsave(&cookie->msi_lock, flags);
 791         msi_page = iommu_dma_get_msi_page(dev, msi_addr, domain);
 792         spin_unlock_irqrestore(&cookie->msi_lock, flags);
 793
 794         if (WARN_ON(!msi_page)) {
 795                 /*
 796                  * We're called from a void callback, so the best we can do is
 797                  * 'fail' by filling the message with obviously bogus values.
 798                  * Since we got this far due to an IOMMU being present, it's
 799                  * not like the existing address would have worked anyway...
 800                  */
 801                 msg->address_hi = ~0U;
 802                 msg->address_lo = ~0U;
 803                 msg->data = ~0U;
 804         } else {
 805                 msg->address_hi = upper_32_bits(msi_page->iova);
 806                 msg->address_lo &= cookie_msi_granule(cookie) - 1;
 807                 msg->address_lo += lower_32_bits(msi_page->iova);
 808         }
 809 }