Merge branches 'arm/omap', 'arm/exynos', 'arm/smmu', 'arm/mediatek', 'arm/qcom',...
[sfrench/cifs-2.6.git] / drivers / iommu / dma-iommu.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * A fairly generic DMA-API to IOMMU-API glue layer.
4  *
5  * Copyright (C) 2014-2015 ARM Ltd.
6  *
7  * based in part on arch/arm/mm/dma-mapping.c:
8  * Copyright (C) 2000-2004 Russell King
9  */
10
11 #include <linux/acpi_iort.h>
12 #include <linux/device.h>
13 #include <linux/dma-contiguous.h>
14 #include <linux/dma-iommu.h>
15 #include <linux/dma-noncoherent.h>
16 #include <linux/gfp.h>
17 #include <linux/huge_mm.h>
18 #include <linux/iommu.h>
19 #include <linux/iova.h>
20 #include <linux/irq.h>
21 #include <linux/mm.h>
22 #include <linux/pci.h>
23 #include <linux/scatterlist.h>
24 #include <linux/vmalloc.h>
25
26 struct iommu_dma_msi_page {
27         struct list_head        list;
28         dma_addr_t              iova;
29         phys_addr_t             phys;
30 };
31
32 enum iommu_dma_cookie_type {
33         IOMMU_DMA_IOVA_COOKIE,
34         IOMMU_DMA_MSI_COOKIE,
35 };
36
37 struct iommu_dma_cookie {
38         enum iommu_dma_cookie_type      type;
39         union {
40                 /* Full allocator for IOMMU_DMA_IOVA_COOKIE */
41                 struct iova_domain      iovad;
42                 /* Trivial linear page allocator for IOMMU_DMA_MSI_COOKIE */
43                 dma_addr_t              msi_iova;
44         };
45         struct list_head                msi_page_list;
46         spinlock_t                      msi_lock;
47
48         /* Domain for flush queue callback; NULL if flush queue not in use */
49         struct iommu_domain             *fq_domain;
50 };
51
52 static inline size_t cookie_msi_granule(struct iommu_dma_cookie *cookie)
53 {
54         if (cookie->type == IOMMU_DMA_IOVA_COOKIE)
55                 return cookie->iovad.granule;
56         return PAGE_SIZE;
57 }
58
59 static struct iommu_dma_cookie *cookie_alloc(enum iommu_dma_cookie_type type)
60 {
61         struct iommu_dma_cookie *cookie;
62
63         cookie = kzalloc(sizeof(*cookie), GFP_KERNEL);
64         if (cookie) {
65                 spin_lock_init(&cookie->msi_lock);
66                 INIT_LIST_HEAD(&cookie->msi_page_list);
67                 cookie->type = type;
68         }
69         return cookie;
70 }
71
72 /**
73  * iommu_get_dma_cookie - Acquire DMA-API resources for a domain
74  * @domain: IOMMU domain to prepare for DMA-API usage
75  *
76  * IOMMU drivers should normally call this from their domain_alloc
77  * callback when domain->type == IOMMU_DOMAIN_DMA.
78  */
79 int iommu_get_dma_cookie(struct iommu_domain *domain)
80 {
81         if (domain->iova_cookie)
82                 return -EEXIST;
83
84         domain->iova_cookie = cookie_alloc(IOMMU_DMA_IOVA_COOKIE);
85         if (!domain->iova_cookie)
86                 return -ENOMEM;
87
88         return 0;
89 }
90 EXPORT_SYMBOL(iommu_get_dma_cookie);
91
92 /**
93  * iommu_get_msi_cookie - Acquire just MSI remapping resources
94  * @domain: IOMMU domain to prepare
95  * @base: Start address of IOVA region for MSI mappings
96  *
97  * Users who manage their own IOVA allocation and do not want DMA API support,
98  * but would still like to take advantage of automatic MSI remapping, can use
99  * this to initialise their own domain appropriately. Users should reserve a
100  * contiguous IOVA region, starting at @base, large enough to accommodate the
101  * number of PAGE_SIZE mappings necessary to cover every MSI doorbell address
102  * used by the devices attached to @domain.
103  */
104 int iommu_get_msi_cookie(struct iommu_domain *domain, dma_addr_t base)
105 {
106         struct iommu_dma_cookie *cookie;
107
108         if (domain->type != IOMMU_DOMAIN_UNMANAGED)
109                 return -EINVAL;
110
111         if (domain->iova_cookie)
112                 return -EEXIST;
113
114         cookie = cookie_alloc(IOMMU_DMA_MSI_COOKIE);
115         if (!cookie)
116                 return -ENOMEM;
117
118         cookie->msi_iova = base;
119         domain->iova_cookie = cookie;
120         return 0;
121 }
122 EXPORT_SYMBOL(iommu_get_msi_cookie);
123
124 /**
125  * iommu_put_dma_cookie - Release a domain's DMA mapping resources
126  * @domain: IOMMU domain previously prepared by iommu_get_dma_cookie() or
127  *          iommu_get_msi_cookie()
128  *
129  * IOMMU drivers should normally call this from their domain_free callback.
130  */
131 void iommu_put_dma_cookie(struct iommu_domain *domain)
132 {
133         struct iommu_dma_cookie *cookie = domain->iova_cookie;
134         struct iommu_dma_msi_page *msi, *tmp;
135
136         if (!cookie)
137                 return;
138
139         if (cookie->type == IOMMU_DMA_IOVA_COOKIE && cookie->iovad.granule)
140                 put_iova_domain(&cookie->iovad);
141
142         list_for_each_entry_safe(msi, tmp, &cookie->msi_page_list, list) {
143                 list_del(&msi->list);
144                 kfree(msi);
145         }
146         kfree(cookie);
147         domain->iova_cookie = NULL;
148 }
149 EXPORT_SYMBOL(iommu_put_dma_cookie);
150
151 /**
152  * iommu_dma_get_resv_regions - Reserved region driver helper
153  * @dev: Device from iommu_get_resv_regions()
154  * @list: Reserved region list from iommu_get_resv_regions()
155  *
156  * IOMMU drivers can use this to implement their .get_resv_regions callback
157  * for general non-IOMMU-specific reservations. Currently, this covers GICv3
158  * ITS region reservation on ACPI based ARM platforms that may require HW MSI
159  * reservation.
160  */
161 void iommu_dma_get_resv_regions(struct device *dev, struct list_head *list)
162 {
163
164         if (!is_of_node(dev_iommu_fwspec_get(dev)->iommu_fwnode))
165                 iort_iommu_msi_get_resv_regions(dev, list);
166
167 }
168 EXPORT_SYMBOL(iommu_dma_get_resv_regions);
169
170 static int cookie_init_hw_msi_region(struct iommu_dma_cookie *cookie,
171                 phys_addr_t start, phys_addr_t end)
172 {
173         struct iova_domain *iovad = &cookie->iovad;
174         struct iommu_dma_msi_page *msi_page;
175         int i, num_pages;
176
177         start -= iova_offset(iovad, start);
178         num_pages = iova_align(iovad, end - start) >> iova_shift(iovad);
179
180         msi_page = kcalloc(num_pages, sizeof(*msi_page), GFP_KERNEL);
181         if (!msi_page)
182                 return -ENOMEM;
183
184         for (i = 0; i < num_pages; i++) {
185                 msi_page[i].phys = start;
186                 msi_page[i].iova = start;
187                 INIT_LIST_HEAD(&msi_page[i].list);
188                 list_add(&msi_page[i].list, &cookie->msi_page_list);
189                 start += iovad->granule;
190         }
191
192         return 0;
193 }
194
195 static int iova_reserve_pci_windows(struct pci_dev *dev,
196                 struct iova_domain *iovad)
197 {
198         struct pci_host_bridge *bridge = pci_find_host_bridge(dev->bus);
199         struct resource_entry *window;
200         unsigned long lo, hi;
201         phys_addr_t start = 0, end;
202
203         resource_list_for_each_entry(window, &bridge->windows) {
204                 if (resource_type(window->res) != IORESOURCE_MEM)
205                         continue;
206
207                 lo = iova_pfn(iovad, window->res->start - window->offset);
208                 hi = iova_pfn(iovad, window->res->end - window->offset);
209                 reserve_iova(iovad, lo, hi);
210         }
211
212         /* Get reserved DMA windows from host bridge */
213         resource_list_for_each_entry(window, &bridge->dma_ranges) {
214                 end = window->res->start - window->offset;
215 resv_iova:
216                 if (end > start) {
217                         lo = iova_pfn(iovad, start);
218                         hi = iova_pfn(iovad, end);
219                         reserve_iova(iovad, lo, hi);
220                 } else {
221                         /* dma_ranges list should be sorted */
222                         dev_err(&dev->dev, "Failed to reserve IOVA\n");
223                         return -EINVAL;
224                 }
225
226                 start = window->res->end - window->offset + 1;
227                 /* If window is last entry */
228                 if (window->node.next == &bridge->dma_ranges &&
229                     end != ~(phys_addr_t)0) {
230                         end = ~(phys_addr_t)0;
231                         goto resv_iova;
232                 }
233         }
234
235         return 0;
236 }
237
238 static int iova_reserve_iommu_regions(struct device *dev,
239                 struct iommu_domain *domain)
240 {
241         struct iommu_dma_cookie *cookie = domain->iova_cookie;
242         struct iova_domain *iovad = &cookie->iovad;
243         struct iommu_resv_region *region;
244         LIST_HEAD(resv_regions);
245         int ret = 0;
246
247         if (dev_is_pci(dev)) {
248                 ret = iova_reserve_pci_windows(to_pci_dev(dev), iovad);
249                 if (ret)
250                         return ret;
251         }
252
253         iommu_get_resv_regions(dev, &resv_regions);
254         list_for_each_entry(region, &resv_regions, list) {
255                 unsigned long lo, hi;
256
257                 /* We ARE the software that manages these! */
258                 if (region->type == IOMMU_RESV_SW_MSI)
259                         continue;
260
261                 lo = iova_pfn(iovad, region->start);
262                 hi = iova_pfn(iovad, region->start + region->length - 1);
263                 reserve_iova(iovad, lo, hi);
264
265                 if (region->type == IOMMU_RESV_MSI)
266                         ret = cookie_init_hw_msi_region(cookie, region->start,
267                                         region->start + region->length);
268                 if (ret)
269                         break;
270         }
271         iommu_put_resv_regions(dev, &resv_regions);
272
273         return ret;
274 }
275
276 static void iommu_dma_flush_iotlb_all(struct iova_domain *iovad)
277 {
278         struct iommu_dma_cookie *cookie;
279         struct iommu_domain *domain;
280
281         cookie = container_of(iovad, struct iommu_dma_cookie, iovad);
282         domain = cookie->fq_domain;
283         /*
284          * The IOMMU driver supporting DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE
285          * implies that ops->flush_iotlb_all must be non-NULL.
286          */
287         domain->ops->flush_iotlb_all(domain);
288 }
289
290 /**
291  * iommu_dma_init_domain - Initialise a DMA mapping domain
292  * @domain: IOMMU domain previously prepared by iommu_get_dma_cookie()
293  * @base: IOVA at which the mappable address space starts
294  * @size: Size of IOVA space
295  * @dev: Device the domain is being initialised for
296  *
297  * @base and @size should be exact multiples of IOMMU page granularity to
298  * avoid rounding surprises. If necessary, we reserve the page at address 0
299  * to ensure it is an invalid IOVA. It is safe to reinitialise a domain, but
300  * any change which could make prior IOVAs invalid will fail.
301  */
302 static int iommu_dma_init_domain(struct iommu_domain *domain, dma_addr_t base,
303                 u64 size, struct device *dev)
304 {
305         struct iommu_dma_cookie *cookie = domain->iova_cookie;
306         unsigned long order, base_pfn;
307         struct iova_domain *iovad;
308         int attr;
309
310         if (!cookie || cookie->type != IOMMU_DMA_IOVA_COOKIE)
311                 return -EINVAL;
312
313         iovad = &cookie->iovad;
314
315         /* Use the smallest supported page size for IOVA granularity */
316         order = __ffs(domain->pgsize_bitmap);
317         base_pfn = max_t(unsigned long, 1, base >> order);
318
319         /* Check the domain allows at least some access to the device... */
320         if (domain->geometry.force_aperture) {
321                 if (base > domain->geometry.aperture_end ||
322                     base + size <= domain->geometry.aperture_start) {
323                         pr_warn("specified DMA range outside IOMMU capability\n");
324                         return -EFAULT;
325                 }
326                 /* ...then finally give it a kicking to make sure it fits */
327                 base_pfn = max_t(unsigned long, base_pfn,
328                                 domain->geometry.aperture_start >> order);
329         }
330
331         /* start_pfn is always nonzero for an already-initialised domain */
332         if (iovad->start_pfn) {
333                 if (1UL << order != iovad->granule ||
334                     base_pfn != iovad->start_pfn) {
335                         pr_warn("Incompatible range for DMA domain\n");
336                         return -EFAULT;
337                 }
338
339                 return 0;
340         }
341
342         init_iova_domain(iovad, 1UL << order, base_pfn);
343
344         if (!cookie->fq_domain && !iommu_domain_get_attr(domain,
345                         DOMAIN_ATTR_DMA_USE_FLUSH_QUEUE, &attr) && attr) {
346                 cookie->fq_domain = domain;
347                 init_iova_flush_queue(iovad, iommu_dma_flush_iotlb_all, NULL);
348         }
349
350         if (!dev)
351                 return 0;
352
353         return iova_reserve_iommu_regions(dev, domain);
354 }
355
356 /**
357  * dma_info_to_prot - Translate DMA API directions and attributes to IOMMU API
358  *                    page flags.
359  * @dir: Direction of DMA transfer
360  * @coherent: Is the DMA master cache-coherent?
361  * @attrs: DMA attributes for the mapping
362  *
363  * Return: corresponding IOMMU API page protection flags
364  */
365 static int dma_info_to_prot(enum dma_data_direction dir, bool coherent,
366                      unsigned long attrs)
367 {
368         int prot = coherent ? IOMMU_CACHE : 0;
369
370         if (attrs & DMA_ATTR_PRIVILEGED)
371                 prot |= IOMMU_PRIV;
372
373         switch (dir) {
374         case DMA_BIDIRECTIONAL:
375                 return prot | IOMMU_READ | IOMMU_WRITE;
376         case DMA_TO_DEVICE:
377                 return prot | IOMMU_READ;
378         case DMA_FROM_DEVICE:
379                 return prot | IOMMU_WRITE;
380         default:
381                 return 0;
382         }
383 }
384
385 static dma_addr_t iommu_dma_alloc_iova(struct iommu_domain *domain,
386                 size_t size, dma_addr_t dma_limit, struct device *dev)
387 {
388         struct iommu_dma_cookie *cookie = domain->iova_cookie;
389         struct iova_domain *iovad = &cookie->iovad;
390         unsigned long shift, iova_len, iova = 0;
391
392         if (cookie->type == IOMMU_DMA_MSI_COOKIE) {
393                 cookie->msi_iova += size;
394                 return cookie->msi_iova - size;
395         }
396
397         shift = iova_shift(iovad);
398         iova_len = size >> shift;
399         /*
400          * Freeing non-power-of-two-sized allocations back into the IOVA caches
401          * will come back to bite us badly, so we have to waste a bit of space
402          * rounding up anything cacheable to make sure that can't happen. The
403          * order of the unadjusted size will still match upon freeing.
404          */
405         if (iova_len < (1 << (IOVA_RANGE_CACHE_MAX_SIZE - 1)))
406                 iova_len = roundup_pow_of_two(iova_len);
407
408         if (dev->bus_dma_mask)
409                 dma_limit &= dev->bus_dma_mask;
410
411         if (domain->geometry.force_aperture)
412                 dma_limit = min(dma_limit, domain->geometry.aperture_end);
413
414         /* Try to get PCI devices a SAC address */
415         if (dma_limit > DMA_BIT_MASK(32) && dev_is_pci(dev))
416                 iova = alloc_iova_fast(iovad, iova_len,
417                                        DMA_BIT_MASK(32) >> shift, false);
418
419         if (!iova)
420                 iova = alloc_iova_fast(iovad, iova_len, dma_limit >> shift,
421                                        true);
422
423         return (dma_addr_t)iova << shift;
424 }
425
426 static void iommu_dma_free_iova(struct iommu_dma_cookie *cookie,
427                 dma_addr_t iova, size_t size)
428 {
429         struct iova_domain *iovad = &cookie->iovad;
430
431         /* The MSI case is only ever cleaning up its most recent allocation */
432         if (cookie->type == IOMMU_DMA_MSI_COOKIE)
433                 cookie->msi_iova -= size;
434         else if (cookie->fq_domain)     /* non-strict mode */
435                 queue_iova(iovad, iova_pfn(iovad, iova),
436                                 size >> iova_shift(iovad), 0);
437         else
438                 free_iova_fast(iovad, iova_pfn(iovad, iova),
439                                 size >> iova_shift(iovad));
440 }
441
442 static void __iommu_dma_unmap(struct device *dev, dma_addr_t dma_addr,
443                 size_t size)
444 {
445         struct iommu_domain *domain = iommu_get_dma_domain(dev);
446         struct iommu_dma_cookie *cookie = domain->iova_cookie;
447         struct iova_domain *iovad = &cookie->iovad;
448         size_t iova_off = iova_offset(iovad, dma_addr);
449         struct iommu_iotlb_gather iotlb_gather;
450         size_t unmapped;
451
452         dma_addr -= iova_off;
453         size = iova_align(iovad, size + iova_off);
454         iommu_iotlb_gather_init(&iotlb_gather);
455
456         unmapped = iommu_unmap_fast(domain, dma_addr, size, &iotlb_gather);
457         WARN_ON(unmapped != size);
458
459         if (!cookie->fq_domain)
460                 iommu_tlb_sync(domain, &iotlb_gather);
461         iommu_dma_free_iova(cookie, dma_addr, size);
462 }
463
464 static dma_addr_t __iommu_dma_map(struct device *dev, phys_addr_t phys,
465                 size_t size, int prot)
466 {
467         struct iommu_domain *domain = iommu_get_dma_domain(dev);
468         struct iommu_dma_cookie *cookie = domain->iova_cookie;
469         struct iova_domain *iovad = &cookie->iovad;
470         size_t iova_off = iova_offset(iovad, phys);
471         dma_addr_t iova;
472
473         size = iova_align(iovad, size + iova_off);
474
475         iova = iommu_dma_alloc_iova(domain, size, dma_get_mask(dev), dev);
476         if (!iova)
477                 return DMA_MAPPING_ERROR;
478
479         if (iommu_map(domain, iova, phys - iova_off, size, prot)) {
480                 iommu_dma_free_iova(cookie, iova, size);
481                 return DMA_MAPPING_ERROR;
482         }
483         return iova + iova_off;
484 }
485
486 static void __iommu_dma_free_pages(struct page **pages, int count)
487 {
488         while (count--)
489                 __free_page(pages[count]);
490         kvfree(pages);
491 }
492
493 static struct page **__iommu_dma_alloc_pages(struct device *dev,
494                 unsigned int count, unsigned long order_mask, gfp_t gfp)
495 {
496         struct page **pages;
497         unsigned int i = 0, nid = dev_to_node(dev);
498
499         order_mask &= (2U << MAX_ORDER) - 1;
500         if (!order_mask)
501                 return NULL;
502
503         pages = kvzalloc(count * sizeof(*pages), GFP_KERNEL);
504         if (!pages)
505                 return NULL;
506
507         /* IOMMU can map any pages, so himem can also be used here */
508         gfp |= __GFP_NOWARN | __GFP_HIGHMEM;
509
510         while (count) {
511                 struct page *page = NULL;
512                 unsigned int order_size;
513
514                 /*
515                  * Higher-order allocations are a convenience rather
516                  * than a necessity, hence using __GFP_NORETRY until
517                  * falling back to minimum-order allocations.
518                  */
519                 for (order_mask &= (2U << __fls(count)) - 1;
520                      order_mask; order_mask &= ~order_size) {
521                         unsigned int order = __fls(order_mask);
522                         gfp_t alloc_flags = gfp;
523
524                         order_size = 1U << order;
525                         if (order_mask > order_size)
526                                 alloc_flags |= __GFP_NORETRY;
527                         page = alloc_pages_node(nid, alloc_flags, order);
528                         if (!page)
529                                 continue;
530                         if (!order)
531                                 break;
532                         if (!PageCompound(page)) {
533                                 split_page(page, order);
534                                 break;
535                         } else if (!split_huge_page(page)) {
536                                 break;
537                         }
538                         __free_pages(page, order);
539                 }
540                 if (!page) {
541                         __iommu_dma_free_pages(pages, i);
542                         return NULL;
543                 }
544                 count -= order_size;
545                 while (order_size--)
546                         pages[i++] = page++;
547         }
548         return pages;
549 }
550
551 static struct page **__iommu_dma_get_pages(void *cpu_addr)
552 {
553         struct vm_struct *area = find_vm_area(cpu_addr);
554
555         if (!area || !area->pages)
556                 return NULL;
557         return area->pages;
558 }
559
560 /**
561  * iommu_dma_alloc_remap - Allocate and map a buffer contiguous in IOVA space
562  * @dev: Device to allocate memory for. Must be a real device
563  *       attached to an iommu_dma_domain
564  * @size: Size of buffer in bytes
565  * @dma_handle: Out argument for allocated DMA handle
566  * @gfp: Allocation flags
567  * @attrs: DMA attributes for this allocation
568  *
569  * If @size is less than PAGE_SIZE, then a full CPU page will be allocated,
570  * but an IOMMU which supports smaller pages might not map the whole thing.
571  *
572  * Return: Mapped virtual address, or NULL on failure.
573  */
574 static void *iommu_dma_alloc_remap(struct device *dev, size_t size,
575                 dma_addr_t *dma_handle, gfp_t gfp, unsigned long attrs)
576 {
577         struct iommu_domain *domain = iommu_get_dma_domain(dev);
578         struct iommu_dma_cookie *cookie = domain->iova_cookie;
579         struct iova_domain *iovad = &cookie->iovad;
580         bool coherent = dev_is_dma_coherent(dev);
581         int ioprot = dma_info_to_prot(DMA_BIDIRECTIONAL, coherent, attrs);
582         pgprot_t prot = dma_pgprot(dev, PAGE_KERNEL, attrs);
583         unsigned int count, min_size, alloc_sizes = domain->pgsize_bitmap;
584         struct page **pages;
585         struct sg_table sgt;
586         dma_addr_t iova;
587         void *vaddr;
588
589         *dma_handle = DMA_MAPPING_ERROR;
590
591         min_size = alloc_sizes & -alloc_sizes;
592         if (min_size < PAGE_SIZE) {
593                 min_size = PAGE_SIZE;
594                 alloc_sizes |= PAGE_SIZE;
595         } else {
596                 size = ALIGN(size, min_size);
597         }
598         if (attrs & DMA_ATTR_ALLOC_SINGLE_PAGES)
599                 alloc_sizes = min_size;
600
601         count = PAGE_ALIGN(size) >> PAGE_SHIFT;
602         pages = __iommu_dma_alloc_pages(dev, count, alloc_sizes >> PAGE_SHIFT,
603                                         gfp);
604         if (!pages)
605                 return NULL;
606
607         size = iova_align(iovad, size);
608         iova = iommu_dma_alloc_iova(domain, size, dev->coherent_dma_mask, dev);
609         if (!iova)
610                 goto out_free_pages;
611
612         if (sg_alloc_table_from_pages(&sgt, pages, count, 0, size, GFP_KERNEL))
613                 goto out_free_iova;
614
615         if (!(ioprot & IOMMU_CACHE)) {
616                 struct scatterlist *sg;
617                 int i;
618
619                 for_each_sg(sgt.sgl, sg, sgt.orig_nents, i)
620                         arch_dma_prep_coherent(sg_page(sg), sg->length);
621         }
622
623         if (iommu_map_sg(domain, iova, sgt.sgl, sgt.orig_nents, ioprot)
624                         < size)
625                 goto out_free_sg;
626
627         vaddr = dma_common_pages_remap(pages, size, VM_USERMAP, prot,
628                         __builtin_return_address(0));
629         if (!vaddr)
630                 goto out_unmap;
631
632         *dma_handle = iova;
633         sg_free_table(&sgt);
634         return vaddr;
635
636 out_unmap:
637         __iommu_dma_unmap(dev, iova, size);
638 out_free_sg:
639         sg_free_table(&sgt);
640 out_free_iova:
641         iommu_dma_free_iova(cookie, iova, size);
642 out_free_pages:
643         __iommu_dma_free_pages(pages, count);
644         return NULL;
645 }
646
647 /**
648  * __iommu_dma_mmap - Map a buffer into provided user VMA
649  * @pages: Array representing buffer from __iommu_dma_alloc()
650  * @size: Size of buffer in bytes
651  * @vma: VMA describing requested userspace mapping
652  *
653  * Maps the pages of the buffer in @pages into @vma. The caller is responsible
654  * for verifying the correct size and protection of @vma beforehand.
655  */
656 static int __iommu_dma_mmap(struct page **pages, size_t size,
657                 struct vm_area_struct *vma)
658 {
659         return vm_map_pages(vma, pages, PAGE_ALIGN(size) >> PAGE_SHIFT);
660 }
661
662 static void iommu_dma_sync_single_for_cpu(struct device *dev,
663                 dma_addr_t dma_handle, size_t size, enum dma_data_direction dir)
664 {
665         phys_addr_t phys;
666
667         if (dev_is_dma_coherent(dev))
668                 return;
669
670         phys = iommu_iova_to_phys(iommu_get_dma_domain(dev), dma_handle);
671         arch_sync_dma_for_cpu(dev, phys, size, dir);
672 }
673
674 static void iommu_dma_sync_single_for_device(struct device *dev,
675                 dma_addr_t dma_handle, size_t size, enum dma_data_direction dir)
676 {
677         phys_addr_t phys;
678
679         if (dev_is_dma_coherent(dev))
680                 return;
681
682         phys = iommu_iova_to_phys(iommu_get_dma_domain(dev), dma_handle);
683         arch_sync_dma_for_device(dev, phys, size, dir);
684 }
685
686 static void iommu_dma_sync_sg_for_cpu(struct device *dev,
687                 struct scatterlist *sgl, int nelems,
688                 enum dma_data_direction dir)
689 {
690         struct scatterlist *sg;
691         int i;
692
693         if (dev_is_dma_coherent(dev))
694                 return;
695
696         for_each_sg(sgl, sg, nelems, i)
697                 arch_sync_dma_for_cpu(dev, sg_phys(sg), sg->length, dir);
698 }
699
700 static void iommu_dma_sync_sg_for_device(struct device *dev,
701                 struct scatterlist *sgl, int nelems,
702                 enum dma_data_direction dir)
703 {
704         struct scatterlist *sg;
705         int i;
706
707         if (dev_is_dma_coherent(dev))
708                 return;
709
710         for_each_sg(sgl, sg, nelems, i)
711                 arch_sync_dma_for_device(dev, sg_phys(sg), sg->length, dir);
712 }
713
714 static dma_addr_t iommu_dma_map_page(struct device *dev, struct page *page,
715                 unsigned long offset, size_t size, enum dma_data_direction dir,
716                 unsigned long attrs)
717 {
718         phys_addr_t phys = page_to_phys(page) + offset;
719         bool coherent = dev_is_dma_coherent(dev);
720         int prot = dma_info_to_prot(dir, coherent, attrs);
721         dma_addr_t dma_handle;
722
723         dma_handle =__iommu_dma_map(dev, phys, size, prot);
724         if (!coherent && !(attrs & DMA_ATTR_SKIP_CPU_SYNC) &&
725             dma_handle != DMA_MAPPING_ERROR)
726                 arch_sync_dma_for_device(dev, phys, size, dir);
727         return dma_handle;
728 }
729
730 static void iommu_dma_unmap_page(struct device *dev, dma_addr_t dma_handle,
731                 size_t size, enum dma_data_direction dir, unsigned long attrs)
732 {
733         if (!(attrs & DMA_ATTR_SKIP_CPU_SYNC))
734                 iommu_dma_sync_single_for_cpu(dev, dma_handle, size, dir);
735         __iommu_dma_unmap(dev, dma_handle, size);
736 }
737
738 /*
739  * Prepare a successfully-mapped scatterlist to give back to the caller.
740  *
741  * At this point the segments are already laid out by iommu_dma_map_sg() to
742  * avoid individually crossing any boundaries, so we merely need to check a
743  * segment's start address to avoid concatenating across one.
744  */
745 static int __finalise_sg(struct device *dev, struct scatterlist *sg, int nents,
746                 dma_addr_t dma_addr)
747 {
748         struct scatterlist *s, *cur = sg;
749         unsigned long seg_mask = dma_get_seg_boundary(dev);
750         unsigned int cur_len = 0, max_len = dma_get_max_seg_size(dev);
751         int i, count = 0;
752
753         for_each_sg(sg, s, nents, i) {
754                 /* Restore this segment's original unaligned fields first */
755                 unsigned int s_iova_off = sg_dma_address(s);
756                 unsigned int s_length = sg_dma_len(s);
757                 unsigned int s_iova_len = s->length;
758
759                 s->offset += s_iova_off;
760                 s->length = s_length;
761                 sg_dma_address(s) = DMA_MAPPING_ERROR;
762                 sg_dma_len(s) = 0;
763
764                 /*
765                  * Now fill in the real DMA data. If...
766                  * - there is a valid output segment to append to
767                  * - and this segment starts on an IOVA page boundary
768                  * - but doesn't fall at a segment boundary
769                  * - and wouldn't make the resulting output segment too long
770                  */
771                 if (cur_len && !s_iova_off && (dma_addr & seg_mask) &&
772                     (max_len - cur_len >= s_length)) {
773                         /* ...then concatenate it with the previous one */
774                         cur_len += s_length;
775                 } else {
776                         /* Otherwise start the next output segment */
777                         if (i > 0)
778                                 cur = sg_next(cur);
779                         cur_len = s_length;
780                         count++;
781
782                         sg_dma_address(cur) = dma_addr + s_iova_off;
783                 }
784
785                 sg_dma_len(cur) = cur_len;
786                 dma_addr += s_iova_len;
787
788                 if (s_length + s_iova_off < s_iova_len)
789                         cur_len = 0;
790         }
791         return count;
792 }
793
794 /*
795  * If mapping failed, then just restore the original list,
796  * but making sure the DMA fields are invalidated.
797  */
798 static void __invalidate_sg(struct scatterlist *sg, int nents)
799 {
800         struct scatterlist *s;
801         int i;
802
803         for_each_sg(sg, s, nents, i) {
804                 if (sg_dma_address(s) != DMA_MAPPING_ERROR)
805                         s->offset += sg_dma_address(s);
806                 if (sg_dma_len(s))
807                         s->length = sg_dma_len(s);
808                 sg_dma_address(s) = DMA_MAPPING_ERROR;
809                 sg_dma_len(s) = 0;
810         }
811 }
812
813 /*
814  * The DMA API client is passing in a scatterlist which could describe
815  * any old buffer layout, but the IOMMU API requires everything to be
816  * aligned to IOMMU pages. Hence the need for this complicated bit of
817  * impedance-matching, to be able to hand off a suitably-aligned list,
818  * but still preserve the original offsets and sizes for the caller.
819  */
820 static int iommu_dma_map_sg(struct device *dev, struct scatterlist *sg,
821                 int nents, enum dma_data_direction dir, unsigned long attrs)
822 {
823         struct iommu_domain *domain = iommu_get_dma_domain(dev);
824         struct iommu_dma_cookie *cookie = domain->iova_cookie;
825         struct iova_domain *iovad = &cookie->iovad;
826         struct scatterlist *s, *prev = NULL;
827         int prot = dma_info_to_prot(dir, dev_is_dma_coherent(dev), attrs);
828         dma_addr_t iova;
829         size_t iova_len = 0;
830         unsigned long mask = dma_get_seg_boundary(dev);
831         int i;
832
833         if (!(attrs & DMA_ATTR_SKIP_CPU_SYNC))
834                 iommu_dma_sync_sg_for_device(dev, sg, nents, dir);
835
836         /*
837          * Work out how much IOVA space we need, and align the segments to
838          * IOVA granules for the IOMMU driver to handle. With some clever
839          * trickery we can modify the list in-place, but reversibly, by
840          * stashing the unaligned parts in the as-yet-unused DMA fields.
841          */
842         for_each_sg(sg, s, nents, i) {
843                 size_t s_iova_off = iova_offset(iovad, s->offset);
844                 size_t s_length = s->length;
845                 size_t pad_len = (mask - iova_len + 1) & mask;
846
847                 sg_dma_address(s) = s_iova_off;
848                 sg_dma_len(s) = s_length;
849                 s->offset -= s_iova_off;
850                 s_length = iova_align(iovad, s_length + s_iova_off);
851                 s->length = s_length;
852
853                 /*
854                  * Due to the alignment of our single IOVA allocation, we can
855                  * depend on these assumptions about the segment boundary mask:
856                  * - If mask size >= IOVA size, then the IOVA range cannot
857                  *   possibly fall across a boundary, so we don't care.
858                  * - If mask size < IOVA size, then the IOVA range must start
859                  *   exactly on a boundary, therefore we can lay things out
860                  *   based purely on segment lengths without needing to know
861                  *   the actual addresses beforehand.
862                  * - The mask must be a power of 2, so pad_len == 0 if
863                  *   iova_len == 0, thus we cannot dereference prev the first
864                  *   time through here (i.e. before it has a meaningful value).
865                  */
866                 if (pad_len && pad_len < s_length - 1) {
867                         prev->length += pad_len;
868                         iova_len += pad_len;
869                 }
870
871                 iova_len += s_length;
872                 prev = s;
873         }
874
875         iova = iommu_dma_alloc_iova(domain, iova_len, dma_get_mask(dev), dev);
876         if (!iova)
877                 goto out_restore_sg;
878
879         /*
880          * We'll leave any physical concatenation to the IOMMU driver's
881          * implementation - it knows better than we do.
882          */
883         if (iommu_map_sg(domain, iova, sg, nents, prot) < iova_len)
884                 goto out_free_iova;
885
886         return __finalise_sg(dev, sg, nents, iova);
887
888 out_free_iova:
889         iommu_dma_free_iova(cookie, iova, iova_len);
890 out_restore_sg:
891         __invalidate_sg(sg, nents);
892         return 0;
893 }
894
895 static void iommu_dma_unmap_sg(struct device *dev, struct scatterlist *sg,
896                 int nents, enum dma_data_direction dir, unsigned long attrs)
897 {
898         dma_addr_t start, end;
899         struct scatterlist *tmp;
900         int i;
901
902         if (!(attrs & DMA_ATTR_SKIP_CPU_SYNC))
903                 iommu_dma_sync_sg_for_cpu(dev, sg, nents, dir);
904
905         /*
906          * The scatterlist segments are mapped into a single
907          * contiguous IOVA allocation, so this is incredibly easy.
908          */
909         start = sg_dma_address(sg);
910         for_each_sg(sg_next(sg), tmp, nents - 1, i) {
911                 if (sg_dma_len(tmp) == 0)
912                         break;
913                 sg = tmp;
914         }
915         end = sg_dma_address(sg) + sg_dma_len(sg);
916         __iommu_dma_unmap(dev, start, end - start);
917 }
918
919 static dma_addr_t iommu_dma_map_resource(struct device *dev, phys_addr_t phys,
920                 size_t size, enum dma_data_direction dir, unsigned long attrs)
921 {
922         return __iommu_dma_map(dev, phys, size,
923                         dma_info_to_prot(dir, false, attrs) | IOMMU_MMIO);
924 }
925
926 static void iommu_dma_unmap_resource(struct device *dev, dma_addr_t handle,
927                 size_t size, enum dma_data_direction dir, unsigned long attrs)
928 {
929         __iommu_dma_unmap(dev, handle, size);
930 }
931
932 static void __iommu_dma_free(struct device *dev, size_t size, void *cpu_addr)
933 {
934         size_t alloc_size = PAGE_ALIGN(size);
935         int count = alloc_size >> PAGE_SHIFT;
936         struct page *page = NULL, **pages = NULL;
937
938         /* Non-coherent atomic allocation? Easy */
939         if (IS_ENABLED(CONFIG_DMA_DIRECT_REMAP) &&
940             dma_free_from_pool(cpu_addr, alloc_size))
941                 return;
942
943         if (IS_ENABLED(CONFIG_DMA_REMAP) && is_vmalloc_addr(cpu_addr)) {
944                 /*
945                  * If it the address is remapped, then it's either non-coherent
946                  * or highmem CMA, or an iommu_dma_alloc_remap() construction.
947                  */
948                 pages = __iommu_dma_get_pages(cpu_addr);
949                 if (!pages)
950                         page = vmalloc_to_page(cpu_addr);
951                 dma_common_free_remap(cpu_addr, alloc_size, VM_USERMAP);
952         } else {
953                 /* Lowmem means a coherent atomic or CMA allocation */
954                 page = virt_to_page(cpu_addr);
955         }
956
957         if (pages)
958                 __iommu_dma_free_pages(pages, count);
959         if (page)
960                 dma_free_contiguous(dev, page, alloc_size);
961 }
962
963 static void iommu_dma_free(struct device *dev, size_t size, void *cpu_addr,
964                 dma_addr_t handle, unsigned long attrs)
965 {
966         __iommu_dma_unmap(dev, handle, size);
967         __iommu_dma_free(dev, size, cpu_addr);
968 }
969
970 static void *iommu_dma_alloc_pages(struct device *dev, size_t size,
971                 struct page **pagep, gfp_t gfp, unsigned long attrs)
972 {
973         bool coherent = dev_is_dma_coherent(dev);
974         size_t alloc_size = PAGE_ALIGN(size);
975         int node = dev_to_node(dev);
976         struct page *page = NULL;
977         void *cpu_addr;
978
979         page = dma_alloc_contiguous(dev, alloc_size, gfp);
980         if (!page)
981                 page = alloc_pages_node(node, gfp, get_order(alloc_size));
982         if (!page)
983                 return NULL;
984
985         if (IS_ENABLED(CONFIG_DMA_REMAP) && (!coherent || PageHighMem(page))) {
986                 pgprot_t prot = dma_pgprot(dev, PAGE_KERNEL, attrs);
987
988                 cpu_addr = dma_common_contiguous_remap(page, alloc_size,
989                                 VM_USERMAP, prot, __builtin_return_address(0));
990                 if (!cpu_addr)
991                         goto out_free_pages;
992
993                 if (!coherent)
994                         arch_dma_prep_coherent(page, size);
995         } else {
996                 cpu_addr = page_address(page);
997         }
998
999         *pagep = page;
1000         memset(cpu_addr, 0, alloc_size);
1001         return cpu_addr;
1002 out_free_pages:
1003         dma_free_contiguous(dev, page, alloc_size);
1004         return NULL;
1005 }
1006
1007 static void *iommu_dma_alloc(struct device *dev, size_t size,
1008                 dma_addr_t *handle, gfp_t gfp, unsigned long attrs)
1009 {
1010         bool coherent = dev_is_dma_coherent(dev);
1011         int ioprot = dma_info_to_prot(DMA_BIDIRECTIONAL, coherent, attrs);
1012         struct page *page = NULL;
1013         void *cpu_addr;
1014
1015         gfp |= __GFP_ZERO;
1016
1017         if (IS_ENABLED(CONFIG_DMA_REMAP) && gfpflags_allow_blocking(gfp) &&
1018             !(attrs & DMA_ATTR_FORCE_CONTIGUOUS))
1019                 return iommu_dma_alloc_remap(dev, size, handle, gfp, attrs);
1020
1021         if (IS_ENABLED(CONFIG_DMA_DIRECT_REMAP) &&
1022             !gfpflags_allow_blocking(gfp) && !coherent)
1023                 cpu_addr = dma_alloc_from_pool(PAGE_ALIGN(size), &page, gfp);
1024         else
1025                 cpu_addr = iommu_dma_alloc_pages(dev, size, &page, gfp, attrs);
1026         if (!cpu_addr)
1027                 return NULL;
1028
1029         *handle = __iommu_dma_map(dev, page_to_phys(page), size, ioprot);
1030         if (*handle == DMA_MAPPING_ERROR) {
1031                 __iommu_dma_free(dev, size, cpu_addr);
1032                 return NULL;
1033         }
1034
1035         return cpu_addr;
1036 }
1037
1038 static int iommu_dma_mmap(struct device *dev, struct vm_area_struct *vma,
1039                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
1040                 unsigned long attrs)
1041 {
1042         unsigned long nr_pages = PAGE_ALIGN(size) >> PAGE_SHIFT;
1043         unsigned long pfn, off = vma->vm_pgoff;
1044         int ret;
1045
1046         vma->vm_page_prot = dma_pgprot(dev, vma->vm_page_prot, attrs);
1047
1048         if (dma_mmap_from_dev_coherent(dev, vma, cpu_addr, size, &ret))
1049                 return ret;
1050
1051         if (off >= nr_pages || vma_pages(vma) > nr_pages - off)
1052                 return -ENXIO;
1053
1054         if (IS_ENABLED(CONFIG_DMA_REMAP) && is_vmalloc_addr(cpu_addr)) {
1055                 struct page **pages = __iommu_dma_get_pages(cpu_addr);
1056
1057                 if (pages)
1058                         return __iommu_dma_mmap(pages, size, vma);
1059                 pfn = vmalloc_to_pfn(cpu_addr);
1060         } else {
1061                 pfn = page_to_pfn(virt_to_page(cpu_addr));
1062         }
1063
1064         return remap_pfn_range(vma, vma->vm_start, pfn + off,
1065                                vma->vm_end - vma->vm_start,
1066                                vma->vm_page_prot);
1067 }
1068
1069 static int iommu_dma_get_sgtable(struct device *dev, struct sg_table *sgt,
1070                 void *cpu_addr, dma_addr_t dma_addr, size_t size,
1071                 unsigned long attrs)
1072 {
1073         struct page *page;
1074         int ret;
1075
1076         if (IS_ENABLED(CONFIG_DMA_REMAP) && is_vmalloc_addr(cpu_addr)) {
1077                 struct page **pages = __iommu_dma_get_pages(cpu_addr);
1078
1079                 if (pages) {
1080                         return sg_alloc_table_from_pages(sgt, pages,
1081                                         PAGE_ALIGN(size) >> PAGE_SHIFT,
1082                                         0, size, GFP_KERNEL);
1083                 }
1084
1085                 page = vmalloc_to_page(cpu_addr);
1086         } else {
1087                 page = virt_to_page(cpu_addr);
1088         }
1089
1090         ret = sg_alloc_table(sgt, 1, GFP_KERNEL);
1091         if (!ret)
1092                 sg_set_page(sgt->sgl, page, PAGE_ALIGN(size), 0);
1093         return ret;
1094 }
1095
1096 static const struct dma_map_ops iommu_dma_ops = {
1097         .alloc                  = iommu_dma_alloc,
1098         .free                   = iommu_dma_free,
1099         .mmap                   = iommu_dma_mmap,
1100         .get_sgtable            = iommu_dma_get_sgtable,
1101         .map_page               = iommu_dma_map_page,
1102         .unmap_page             = iommu_dma_unmap_page,
1103         .map_sg                 = iommu_dma_map_sg,
1104         .unmap_sg               = iommu_dma_unmap_sg,
1105         .sync_single_for_cpu    = iommu_dma_sync_single_for_cpu,
1106         .sync_single_for_device = iommu_dma_sync_single_for_device,
1107         .sync_sg_for_cpu        = iommu_dma_sync_sg_for_cpu,
1108         .sync_sg_for_device     = iommu_dma_sync_sg_for_device,
1109         .map_resource           = iommu_dma_map_resource,
1110         .unmap_resource         = iommu_dma_unmap_resource,
1111 };
1112
1113 /*
1114  * The IOMMU core code allocates the default DMA domain, which the underlying
1115  * IOMMU driver needs to support via the dma-iommu layer.
1116  */
1117 void iommu_setup_dma_ops(struct device *dev, u64 dma_base, u64 size)
1118 {
1119         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
1120
1121         if (!domain)
1122                 goto out_err;
1123
1124         /*
1125          * The IOMMU core code allocates the default DMA domain, which the
1126          * underlying IOMMU driver needs to support via the dma-iommu layer.
1127          */
1128         if (domain->type == IOMMU_DOMAIN_DMA) {
1129                 if (iommu_dma_init_domain(domain, dma_base, size, dev))
1130                         goto out_err;
1131                 dev->dma_ops = &iommu_dma_ops;
1132         }
1133
1134         return;
1135 out_err:
1136          pr_warn("Failed to set up IOMMU for device %s; retaining platform DMA ops\n",
1137                  dev_name(dev));
1138 }
1139
1140 static struct iommu_dma_msi_page *iommu_dma_get_msi_page(struct device *dev,
1141                 phys_addr_t msi_addr, struct iommu_domain *domain)
1142 {
1143         struct iommu_dma_cookie *cookie = domain->iova_cookie;
1144         struct iommu_dma_msi_page *msi_page;
1145         dma_addr_t iova;
1146         int prot = IOMMU_WRITE | IOMMU_NOEXEC | IOMMU_MMIO;
1147         size_t size = cookie_msi_granule(cookie);
1148
1149         msi_addr &= ~(phys_addr_t)(size - 1);
1150         list_for_each_entry(msi_page, &cookie->msi_page_list, list)
1151                 if (msi_page->phys == msi_addr)
1152                         return msi_page;
1153
1154         msi_page = kzalloc(sizeof(*msi_page), GFP_ATOMIC);
1155         if (!msi_page)
1156                 return NULL;
1157
1158         iova = iommu_dma_alloc_iova(domain, size, dma_get_mask(dev), dev);
1159         if (!iova)
1160                 goto out_free_page;
1161
1162         if (iommu_map(domain, iova, msi_addr, size, prot))
1163                 goto out_free_iova;
1164
1165         INIT_LIST_HEAD(&msi_page->list);
1166         msi_page->phys = msi_addr;
1167         msi_page->iova = iova;
1168         list_add(&msi_page->list, &cookie->msi_page_list);
1169         return msi_page;
1170
1171 out_free_iova:
1172         iommu_dma_free_iova(cookie, iova, size);
1173 out_free_page:
1174         kfree(msi_page);
1175         return NULL;
1176 }
1177
1178 int iommu_dma_prepare_msi(struct msi_desc *desc, phys_addr_t msi_addr)
1179 {
1180         struct device *dev = msi_desc_to_dev(desc);
1181         struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
1182         struct iommu_dma_cookie *cookie;
1183         struct iommu_dma_msi_page *msi_page;
1184         unsigned long flags;
1185
1186         if (!domain || !domain->iova_cookie) {
1187                 desc->iommu_cookie = NULL;
1188                 return 0;
1189         }
1190
1191         cookie = domain->iova_cookie;
1192
1193         /*
1194          * We disable IRQs to rule out a possible inversion against
1195          * irq_desc_lock if, say, someone tries to retarget the affinity
1196          * of an MSI from within an IPI handler.
1197          */
1198         spin_lock_irqsave(&cookie->msi_lock, flags);
1199         msi_page = iommu_dma_get_msi_page(dev, msi_addr, domain);
1200         spin_unlock_irqrestore(&cookie->msi_lock, flags);
1201
1202         msi_desc_set_iommu_cookie(desc, msi_page);
1203
1204         if (!msi_page)
1205                 return -ENOMEM;
1206         return 0;
1207 }
1208
1209 void iommu_dma_compose_msi_msg(struct msi_desc *desc,
1210                                struct msi_msg *msg)
1211 {
1212         struct device *dev = msi_desc_to_dev(desc);
1213         const struct iommu_domain *domain = iommu_get_domain_for_dev(dev);
1214         const struct iommu_dma_msi_page *msi_page;
1215
1216         msi_page = msi_desc_get_iommu_cookie(desc);
1217
1218         if (!domain || !domain->iova_cookie || WARN_ON(!msi_page))
1219                 return;
1220
1221         msg->address_hi = upper_32_bits(msi_page->iova);
1222         msg->address_lo &= cookie_msi_granule(domain->iova_cookie) - 1;
1223         msg->address_lo += lower_32_bits(msi_page->iova);
1224 }
1225
1226 static int iommu_dma_init(void)
1227 {
1228         return iova_cache_get();
1229 }
1230 arch_initcall(iommu_dma_init);