2 * omap iommu: simple virtual address space management
4 * Copyright (C) 2008-2009 Nokia Corporation
6 * Written by Hiroshi DOYU <Hiroshi.DOYU@nokia.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/err.h>
14 #include <linux/slab.h>
15 #include <linux/vmalloc.h>
16 #include <linux/device.h>
17 #include <linux/scatterlist.h>
19 #include <asm/cacheflush.h>
20 #include <asm/mach/map.h>
22 #include <plat/iommu.h>
23 #include <plat/iovmm.h>
25 #include "iopgtable.h"
28 * A device driver needs to create address mappings between:
30 * - iommu/device address
32 * - mpu virtual address
34 * There are 4 possible patterns for them:
36 * |iova/ mapping iommu_ page
37 * | da pa va (d)-(p)-(v) function type
38 * ---------------------------------------------------------------------------
39 * 1 | c c c 1 - 1 - 1 _kmap() / _kunmap() s
40 * 2 | c c,a c 1 - 1 - 1 _kmalloc()/ _kfree() s
41 * 3 | c d c 1 - n - 1 _vmap() / _vunmap() s
42 * 4 | c d,a c 1 - n - 1 _vmalloc()/ _vfree() n*
45 * 'iova': device iommu virtual address
46 * 'da': alias of 'iova'
47 * 'pa': physical address
48 * 'va': mpu virtual address
50 * 'c': contiguous memory area
51 * 'd': discontiguous memory area
52 * 'a': anonymous memory allocation
53 * '()': optional feature
55 * 'n': a normal page(4KB) size is used.
56 * 's': multiple iommu superpage(16MB, 1MB, 64KB, 4KB) size is used.
58 * '*': not yet, but feasible.
61 static struct kmem_cache
*iovm_area_cachep
;
63 /* return total bytes of sg buffers */
64 static size_t sgtable_len(const struct sg_table
*sgt
)
66 unsigned int i
, total
= 0;
67 struct scatterlist
*sg
;
72 for_each_sg(sgt
->sgl
, sg
, sgt
->nents
, i
) {
75 bytes
= sg_dma_len(sg
);
77 if (!iopgsz_ok(bytes
)) {
78 pr_err("%s: sg[%d] not iommu pagesize(%x)\n",
88 #define sgtable_ok(x) (!!sgtable_len(x))
91 * calculate the optimal number sg elements from total bytes based on
94 static unsigned int sgtable_nents(size_t bytes
)
97 unsigned int nr_entries
;
98 const unsigned long pagesize
[] = { SZ_16M
, SZ_1M
, SZ_64K
, SZ_4K
, };
100 if (!IS_ALIGNED(bytes
, PAGE_SIZE
)) {
101 pr_err("%s: wrong size %08x\n", __func__
, bytes
);
106 for (i
= 0; i
< ARRAY_SIZE(pagesize
); i
++) {
107 if (bytes
>= pagesize
[i
]) {
108 nr_entries
+= (bytes
/ pagesize
[i
]);
109 bytes
%= pagesize
[i
];
117 /* allocate and initialize sg_table header(a kind of 'superblock') */
118 static struct sg_table
*sgtable_alloc(const size_t bytes
, u32 flags
)
120 unsigned int nr_entries
;
122 struct sg_table
*sgt
;
125 return ERR_PTR(-EINVAL
);
127 if (!IS_ALIGNED(bytes
, PAGE_SIZE
))
128 return ERR_PTR(-EINVAL
);
130 /* FIXME: IOVMF_DA_FIXED should support 'superpages' */
131 if ((flags
& IOVMF_LINEAR
) && (flags
& IOVMF_DA_ANON
)) {
132 nr_entries
= sgtable_nents(bytes
);
134 return ERR_PTR(-EINVAL
);
136 nr_entries
= bytes
/ PAGE_SIZE
;
138 sgt
= kzalloc(sizeof(*sgt
), GFP_KERNEL
);
140 return ERR_PTR(-ENOMEM
);
142 err
= sg_alloc_table(sgt
, nr_entries
, GFP_KERNEL
);
146 pr_debug("%s: sgt:%p(%d entries)\n", __func__
, sgt
, nr_entries
);
151 /* free sg_table header(a kind of superblock) */
152 static void sgtable_free(struct sg_table
*sgt
)
160 pr_debug("%s: sgt:%p\n", __func__
, sgt
);
163 /* map 'sglist' to a contiguous mpu virtual area and return 'va' */
164 static void *vmap_sg(const struct sg_table
*sgt
)
169 struct scatterlist
*sg
;
170 struct vm_struct
*new;
171 const struct mem_type
*mtype
;
173 mtype
= get_mem_type(MT_DEVICE
);
175 return ERR_PTR(-EINVAL
);
177 total
= sgtable_len(sgt
);
179 return ERR_PTR(-EINVAL
);
181 new = __get_vm_area(total
, VM_IOREMAP
, VMALLOC_START
, VMALLOC_END
);
183 return ERR_PTR(-ENOMEM
);
186 for_each_sg(sgt
->sgl
, sg
, sgt
->nents
, i
) {
192 bytes
= sg_dma_len(sg
);
194 BUG_ON(bytes
!= PAGE_SIZE
);
196 err
= ioremap_page(va
, pa
, mtype
);
203 flush_cache_vmap((unsigned long)new->addr
,
204 (unsigned long)(new->addr
+ total
));
208 WARN_ON(1); /* FIXME: cleanup some mpu mappings */
210 return ERR_PTR(-EAGAIN
);
213 static inline void vunmap_sg(const void *va
)
218 static struct iovm_struct
*__find_iovm_area(struct iommu
*obj
, const u32 da
)
220 struct iovm_struct
*tmp
;
222 list_for_each_entry(tmp
, &obj
->mmap
, list
) {
223 if ((da
>= tmp
->da_start
) && (da
< tmp
->da_end
)) {
226 len
= tmp
->da_end
- tmp
->da_start
;
228 dev_dbg(obj
->dev
, "%s: %08x-%08x-%08x(%x) %08x\n",
229 __func__
, tmp
->da_start
, da
, tmp
->da_end
, len
,
240 * find_iovm_area - find iovma which includes @da
241 * @da: iommu device virtual address
243 * Find the existing iovma starting at @da
245 struct iovm_struct
*find_iovm_area(struct iommu
*obj
, u32 da
)
247 struct iovm_struct
*area
;
249 mutex_lock(&obj
->mmap_lock
);
250 area
= __find_iovm_area(obj
, da
);
251 mutex_unlock(&obj
->mmap_lock
);
255 EXPORT_SYMBOL_GPL(find_iovm_area
);
258 * This finds the hole(area) which fits the requested address and len
259 * in iovmas mmap, and returns the new allocated iovma.
261 static struct iovm_struct
*alloc_iovm_area(struct iommu
*obj
, u32 da
,
262 size_t bytes
, u32 flags
)
264 struct iovm_struct
*new, *tmp
;
265 u32 start
, prev_end
, alignement
;
268 return ERR_PTR(-EINVAL
);
271 alignement
= PAGE_SIZE
;
273 if (flags
& IOVMF_DA_ANON
) {
275 * Reserve the first page for NULL
278 if (flags
& IOVMF_LINEAR
)
279 alignement
= iopgsz_max(bytes
);
280 start
= roundup(start
, alignement
);
284 if (list_empty(&obj
->mmap
))
288 list_for_each_entry(tmp
, &obj
->mmap
, list
) {
290 if ((prev_end
<= start
) && (start
+ bytes
< tmp
->da_start
))
293 if (flags
& IOVMF_DA_ANON
)
294 start
= roundup(tmp
->da_end
, alignement
);
296 prev_end
= tmp
->da_end
;
299 if ((start
>= prev_end
) && (ULONG_MAX
- start
>= bytes
))
302 dev_dbg(obj
->dev
, "%s: no space to fit %08x(%x) flags: %08x\n",
303 __func__
, da
, bytes
, flags
);
305 return ERR_PTR(-EINVAL
);
308 new = kmem_cache_zalloc(iovm_area_cachep
, GFP_KERNEL
);
310 return ERR_PTR(-ENOMEM
);
313 new->da_start
= start
;
314 new->da_end
= start
+ bytes
;
318 * keep ascending order of iovmas
321 list_add_tail(&new->list
, &tmp
->list
);
323 list_add(&new->list
, &obj
->mmap
);
325 dev_dbg(obj
->dev
, "%s: found %08x-%08x-%08x(%x) %08x\n",
326 __func__
, new->da_start
, start
, new->da_end
, bytes
, flags
);
331 static void free_iovm_area(struct iommu
*obj
, struct iovm_struct
*area
)
335 BUG_ON(!obj
|| !area
);
337 bytes
= area
->da_end
- area
->da_start
;
339 dev_dbg(obj
->dev
, "%s: %08x-%08x(%x) %08x\n",
340 __func__
, area
->da_start
, area
->da_end
, bytes
, area
->flags
);
342 list_del(&area
->list
);
343 kmem_cache_free(iovm_area_cachep
, area
);
347 * da_to_va - convert (d) to (v)
348 * @obj: objective iommu
349 * @da: iommu device virtual address
350 * @va: mpu virtual address
352 * Returns mpu virtual addr which corresponds to a given device virtual addr
354 void *da_to_va(struct iommu
*obj
, u32 da
)
357 struct iovm_struct
*area
;
359 mutex_lock(&obj
->mmap_lock
);
361 area
= __find_iovm_area(obj
, da
);
363 dev_dbg(obj
->dev
, "%s: no da area(%08x)\n", __func__
, da
);
368 mutex_unlock(&obj
->mmap_lock
);
372 EXPORT_SYMBOL_GPL(da_to_va
);
374 static void sgtable_fill_vmalloc(struct sg_table
*sgt
, void *_va
)
377 struct scatterlist
*sg
;
381 for_each_sg(sgt
->sgl
, sg
, sgt
->nents
, i
) {
383 const size_t bytes
= PAGE_SIZE
;
386 * iommu 'superpage' isn't supported with 'iommu_vmalloc()'
388 pg
= vmalloc_to_page(va
);
390 sg_set_page(sg
, pg
, bytes
, 0);
395 va_end
= _va
+ PAGE_SIZE
* i
;
398 static inline void sgtable_drain_vmalloc(struct sg_table
*sgt
)
401 * Actually this is not necessary at all, just exists for
402 * consistency of the code readability.
407 static void sgtable_fill_kmalloc(struct sg_table
*sgt
, u32 pa
, size_t len
)
410 struct scatterlist
*sg
;
413 va
= phys_to_virt(pa
);
415 for_each_sg(sgt
->sgl
, sg
, sgt
->nents
, i
) {
418 bytes
= iopgsz_max(len
);
420 BUG_ON(!iopgsz_ok(bytes
));
422 sg_set_buf(sg
, phys_to_virt(pa
), bytes
);
424 * 'pa' is cotinuous(linear).
432 static inline void sgtable_drain_kmalloc(struct sg_table
*sgt
)
435 * Actually this is not necessary at all, just exists for
436 * consistency of the code readability
441 /* create 'da' <-> 'pa' mapping from 'sgt' */
442 static int map_iovm_area(struct iommu
*obj
, struct iovm_struct
*new,
443 const struct sg_table
*sgt
, u32 flags
)
447 struct scatterlist
*sg
;
448 u32 da
= new->da_start
;
453 BUG_ON(!sgtable_ok(sgt
));
455 for_each_sg(sgt
->sgl
, sg
, sgt
->nents
, i
) {
459 struct iotlb_entry e
;
462 bytes
= sg_dma_len(sg
);
464 flags
&= ~IOVMF_PGSZ_MASK
;
465 pgsz
= bytes_to_iopgsz(bytes
);
470 pr_debug("%s: [%d] %08x %08x(%x)\n", __func__
,
473 iotlb_init_entry(&e
, da
, pa
, flags
);
474 err
= iopgtable_store_entry(obj
, &e
);
485 for_each_sg(sgt
->sgl
, sg
, i
, j
) {
488 bytes
= iopgtable_clear_entry(obj
, da
);
490 BUG_ON(!iopgsz_ok(bytes
));
497 /* release 'da' <-> 'pa' mapping */
498 static void unmap_iovm_area(struct iommu
*obj
, struct iovm_struct
*area
)
501 size_t total
= area
->da_end
- area
->da_start
;
503 BUG_ON((!total
) || !IS_ALIGNED(total
, PAGE_SIZE
));
505 start
= area
->da_start
;
509 bytes
= iopgtable_clear_entry(obj
, start
);
513 dev_dbg(obj
->dev
, "%s: unmap %08x(%x) %08x\n",
514 __func__
, start
, bytes
, area
->flags
);
516 BUG_ON(!IS_ALIGNED(bytes
, PAGE_SIZE
));
524 /* template function for all unmapping */
525 static struct sg_table
*unmap_vm_area(struct iommu
*obj
, const u32 da
,
526 void (*fn
)(const void *), u32 flags
)
528 struct sg_table
*sgt
= NULL
;
529 struct iovm_struct
*area
;
531 if (!IS_ALIGNED(da
, PAGE_SIZE
)) {
532 dev_err(obj
->dev
, "%s: alignment err(%08x)\n", __func__
, da
);
536 mutex_lock(&obj
->mmap_lock
);
538 area
= __find_iovm_area(obj
, da
);
540 dev_dbg(obj
->dev
, "%s: no da area(%08x)\n", __func__
, da
);
544 if ((area
->flags
& flags
) != flags
) {
545 dev_err(obj
->dev
, "%s: wrong flags(%08x)\n", __func__
,
549 sgt
= (struct sg_table
*)area
->sgt
;
551 unmap_iovm_area(obj
, area
);
555 dev_dbg(obj
->dev
, "%s: %08x-%08x-%08x(%x) %08x\n", __func__
,
556 area
->da_start
, da
, area
->da_end
,
557 area
->da_end
- area
->da_start
, area
->flags
);
559 free_iovm_area(obj
, area
);
561 mutex_unlock(&obj
->mmap_lock
);
566 static u32
map_iommu_region(struct iommu
*obj
, u32 da
,
567 const struct sg_table
*sgt
, void *va
, size_t bytes
, u32 flags
)
570 struct iovm_struct
*new;
572 mutex_lock(&obj
->mmap_lock
);
574 new = alloc_iovm_area(obj
, da
, bytes
, flags
);
577 goto err_alloc_iovma
;
582 if (map_iovm_area(obj
, new, sgt
, new->flags
))
585 mutex_unlock(&obj
->mmap_lock
);
587 dev_dbg(obj
->dev
, "%s: da:%08x(%x) flags:%08x va:%p\n",
588 __func__
, new->da_start
, bytes
, new->flags
, va
);
590 return new->da_start
;
593 free_iovm_area(obj
, new);
595 mutex_unlock(&obj
->mmap_lock
);
599 static inline u32
__iommu_vmap(struct iommu
*obj
, u32 da
,
600 const struct sg_table
*sgt
, void *va
, size_t bytes
, u32 flags
)
602 return map_iommu_region(obj
, da
, sgt
, va
, bytes
, flags
);
606 * iommu_vmap - (d)-(p)-(v) address mapper
607 * @obj: objective iommu
608 * @sgt: address of scatter gather table
609 * @flags: iovma and page property
611 * Creates 1-n-1 mapping with given @sgt and returns @da.
612 * All @sgt element must be io page size aligned.
614 u32
iommu_vmap(struct iommu
*obj
, u32 da
, const struct sg_table
*sgt
,
620 if (!obj
|| !obj
->dev
|| !sgt
)
623 bytes
= sgtable_len(sgt
);
626 bytes
= PAGE_ALIGN(bytes
);
628 if (flags
& IOVMF_MMIO
) {
634 flags
&= IOVMF_HW_MASK
;
635 flags
|= IOVMF_DISCONT
;
637 flags
|= (da
? IOVMF_DA_FIXED
: IOVMF_DA_ANON
);
639 da
= __iommu_vmap(obj
, da
, sgt
, va
, bytes
, flags
);
640 if (IS_ERR_VALUE(da
))
645 EXPORT_SYMBOL_GPL(iommu_vmap
);
648 * iommu_vunmap - release virtual mapping obtained by 'iommu_vmap()'
649 * @obj: objective iommu
650 * @da: iommu device virtual address
652 * Free the iommu virtually contiguous memory area starting at
653 * @da, which was returned by 'iommu_vmap()'.
655 struct sg_table
*iommu_vunmap(struct iommu
*obj
, u32 da
)
657 struct sg_table
*sgt
;
659 * 'sgt' is allocated before 'iommu_vmalloc()' is called.
660 * Just returns 'sgt' to the caller to free
662 sgt
= unmap_vm_area(obj
, da
, vunmap_sg
, IOVMF_DISCONT
| IOVMF_MMIO
);
664 dev_dbg(obj
->dev
, "%s: No sgt\n", __func__
);
667 EXPORT_SYMBOL_GPL(iommu_vunmap
);
670 * iommu_vmalloc - (d)-(p)-(v) address allocator and mapper
671 * @obj: objective iommu
672 * @da: contiguous iommu virtual memory
673 * @bytes: allocation size
674 * @flags: iovma and page property
676 * Allocate @bytes linearly and creates 1-n-1 mapping and returns
677 * @da again, which might be adjusted if 'IOVMF_DA_ANON' is set.
679 u32
iommu_vmalloc(struct iommu
*obj
, u32 da
, size_t bytes
, u32 flags
)
682 struct sg_table
*sgt
;
684 if (!obj
|| !obj
->dev
|| !bytes
)
687 bytes
= PAGE_ALIGN(bytes
);
693 sgt
= sgtable_alloc(bytes
, flags
);
698 sgtable_fill_vmalloc(sgt
, va
);
700 flags
&= IOVMF_HW_MASK
;
701 flags
|= IOVMF_DISCONT
;
702 flags
|= IOVMF_ALLOC
;
703 flags
|= (da
? IOVMF_DA_FIXED
: IOVMF_DA_ANON
);
705 da
= __iommu_vmap(obj
, da
, sgt
, va
, bytes
, flags
);
706 if (IS_ERR_VALUE(da
))
712 sgtable_drain_vmalloc(sgt
);
718 EXPORT_SYMBOL_GPL(iommu_vmalloc
);
721 * iommu_vfree - release memory allocated by 'iommu_vmalloc()'
722 * @obj: objective iommu
723 * @da: iommu device virtual address
725 * Frees the iommu virtually continuous memory area starting at
726 * @da, as obtained from 'iommu_vmalloc()'.
728 void iommu_vfree(struct iommu
*obj
, const u32 da
)
730 struct sg_table
*sgt
;
732 sgt
= unmap_vm_area(obj
, da
, vfree
, IOVMF_DISCONT
| IOVMF_ALLOC
);
734 dev_dbg(obj
->dev
, "%s: No sgt\n", __func__
);
737 EXPORT_SYMBOL_GPL(iommu_vfree
);
739 static u32
__iommu_kmap(struct iommu
*obj
, u32 da
, u32 pa
, void *va
,
740 size_t bytes
, u32 flags
)
742 struct sg_table
*sgt
;
744 sgt
= sgtable_alloc(bytes
, flags
);
748 sgtable_fill_kmalloc(sgt
, pa
, bytes
);
750 da
= map_iommu_region(obj
, da
, sgt
, va
, bytes
, flags
);
751 if (IS_ERR_VALUE(da
)) {
752 sgtable_drain_kmalloc(sgt
);
760 * iommu_kmap - (d)-(p)-(v) address mapper
761 * @obj: objective iommu
762 * @da: contiguous iommu virtual memory
763 * @pa: contiguous physical memory
764 * @flags: iovma and page property
766 * Creates 1-1-1 mapping and returns @da again, which can be
767 * adjusted if 'IOVMF_DA_ANON' is set.
769 u32
iommu_kmap(struct iommu
*obj
, u32 da
, u32 pa
, size_t bytes
,
774 if (!obj
|| !obj
->dev
|| !bytes
)
777 bytes
= PAGE_ALIGN(bytes
);
779 va
= ioremap(pa
, bytes
);
783 flags
&= IOVMF_HW_MASK
;
784 flags
|= IOVMF_LINEAR
;
786 flags
|= (da
? IOVMF_DA_FIXED
: IOVMF_DA_ANON
);
788 da
= __iommu_kmap(obj
, da
, pa
, va
, bytes
, flags
);
789 if (IS_ERR_VALUE(da
))
794 EXPORT_SYMBOL_GPL(iommu_kmap
);
797 * iommu_kunmap - release virtual mapping obtained by 'iommu_kmap()'
798 * @obj: objective iommu
799 * @da: iommu device virtual address
801 * Frees the iommu virtually contiguous memory area starting at
802 * @da, which was passed to and was returned by'iommu_kmap()'.
804 void iommu_kunmap(struct iommu
*obj
, u32 da
)
806 struct sg_table
*sgt
;
807 typedef void (*func_t
)(const void *);
809 sgt
= unmap_vm_area(obj
, da
, (func_t
)__iounmap
,
810 IOVMF_LINEAR
| IOVMF_MMIO
);
812 dev_dbg(obj
->dev
, "%s: No sgt\n", __func__
);
815 EXPORT_SYMBOL_GPL(iommu_kunmap
);
818 * iommu_kmalloc - (d)-(p)-(v) address allocator and mapper
819 * @obj: objective iommu
820 * @da: contiguous iommu virtual memory
821 * @bytes: bytes for allocation
822 * @flags: iovma and page property
824 * Allocate @bytes linearly and creates 1-1-1 mapping and returns
825 * @da again, which might be adjusted if 'IOVMF_DA_ANON' is set.
827 u32
iommu_kmalloc(struct iommu
*obj
, u32 da
, size_t bytes
, u32 flags
)
832 if (!obj
|| !obj
->dev
|| !bytes
)
835 bytes
= PAGE_ALIGN(bytes
);
837 va
= kmalloc(bytes
, GFP_KERNEL
| GFP_DMA
);
840 pa
= virt_to_phys(va
);
842 flags
&= IOVMF_HW_MASK
;
843 flags
|= IOVMF_LINEAR
;
844 flags
|= IOVMF_ALLOC
;
845 flags
|= (da
? IOVMF_DA_FIXED
: IOVMF_DA_ANON
);
847 da
= __iommu_kmap(obj
, da
, pa
, va
, bytes
, flags
);
848 if (IS_ERR_VALUE(da
))
853 EXPORT_SYMBOL_GPL(iommu_kmalloc
);
856 * iommu_kfree - release virtual mapping obtained by 'iommu_kmalloc()'
857 * @obj: objective iommu
858 * @da: iommu device virtual address
860 * Frees the iommu virtually contiguous memory area starting at
861 * @da, which was passed to and was returned by'iommu_kmalloc()'.
863 void iommu_kfree(struct iommu
*obj
, u32 da
)
865 struct sg_table
*sgt
;
867 sgt
= unmap_vm_area(obj
, da
, kfree
, IOVMF_LINEAR
| IOVMF_ALLOC
);
869 dev_dbg(obj
->dev
, "%s: No sgt\n", __func__
);
872 EXPORT_SYMBOL_GPL(iommu_kfree
);
875 static int __init
iovmm_init(void)
877 const unsigned long flags
= SLAB_HWCACHE_ALIGN
;
878 struct kmem_cache
*p
;
880 p
= kmem_cache_create("iovm_area_cache", sizeof(struct iovm_struct
), 0,
884 iovm_area_cachep
= p
;
888 module_init(iovmm_init
);
890 static void __exit
iovmm_exit(void)
892 kmem_cache_destroy(iovm_area_cachep
);
894 module_exit(iovmm_exit
);
896 MODULE_DESCRIPTION("omap iommu: simple virtual address space management");
897 MODULE_AUTHOR("Hiroshi DOYU <Hiroshi.DOYU@nokia.com>");
898 MODULE_LICENSE("GPL v2");