2 * omap iommu: tlb and pagetable primitives
4 * Copyright (C) 2008-2009 Nokia Corporation
6 * Written by Hiroshi DOYU <Hiroshi.DOYU@nokia.com>,
7 * Paul Mundt and Toshihiro Kobayashi
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.
14 #include <linux/err.h>
15 #include <linux/module.h>
16 #include <linux/interrupt.h>
17 #include <linux/ioport.h>
18 #include <linux/clk.h>
19 #include <linux/platform_device.h>
21 #include <asm/cacheflush.h>
23 #include <mach/iommu.h>
25 #include "iopgtable.h"
27 /* accommodate the difference between omap1 and omap2/3 */
28 static const struct iommu_functions *arch_iommu;
30 static struct platform_driver omap_iommu_driver;
31 static struct kmem_cache *iopte_cachep;
34 * install_iommu_arch - Install archtecure specific iommu functions
35 * @ops: a pointer to architecture specific iommu functions
37 * There are several kind of iommu algorithm(tlb, pagetable) among
38 * omap series. This interface installs such an iommu algorighm.
40 int install_iommu_arch(const struct iommu_functions *ops)
48 EXPORT_SYMBOL_GPL(install_iommu_arch);
51 * uninstall_iommu_arch - Uninstall archtecure specific iommu functions
52 * @ops: a pointer to architecture specific iommu functions
54 * This interface uninstalls the iommu algorighm installed previously.
56 void uninstall_iommu_arch(const struct iommu_functions *ops)
58 if (arch_iommu != ops)
59 pr_err("%s: not your arch\n", __func__);
63 EXPORT_SYMBOL_GPL(uninstall_iommu_arch);
66 * iommu_save_ctx - Save registers for pm off-mode support
69 void iommu_save_ctx(struct iommu *obj)
71 arch_iommu->save_ctx(obj);
73 EXPORT_SYMBOL_GPL(iommu_save_ctx);
76 * iommu_restore_ctx - Restore registers for pm off-mode support
79 void iommu_restore_ctx(struct iommu *obj)
81 arch_iommu->restore_ctx(obj);
83 EXPORT_SYMBOL_GPL(iommu_restore_ctx);
86 * iommu_arch_version - Return running iommu arch version
88 u32 iommu_arch_version(void)
90 return arch_iommu->version;
92 EXPORT_SYMBOL_GPL(iommu_arch_version);
94 static int iommu_enable(struct iommu *obj)
101 clk_enable(obj->clk);
103 err = arch_iommu->enable(obj);
105 clk_disable(obj->clk);
109 static void iommu_disable(struct iommu *obj)
114 clk_enable(obj->clk);
116 arch_iommu->disable(obj);
118 clk_disable(obj->clk);
124 void iotlb_cr_to_e(struct cr_regs *cr, struct iotlb_entry *e)
128 arch_iommu->cr_to_e(cr, e);
130 EXPORT_SYMBOL_GPL(iotlb_cr_to_e);
132 static inline int iotlb_cr_valid(struct cr_regs *cr)
137 return arch_iommu->cr_valid(cr);
140 static inline struct cr_regs *iotlb_alloc_cr(struct iommu *obj,
141 struct iotlb_entry *e)
146 return arch_iommu->alloc_cr(obj, e);
149 u32 iotlb_cr_to_virt(struct cr_regs *cr)
151 return arch_iommu->cr_to_virt(cr);
153 EXPORT_SYMBOL_GPL(iotlb_cr_to_virt);
155 static u32 get_iopte_attr(struct iotlb_entry *e)
157 return arch_iommu->get_pte_attr(e);
160 static u32 iommu_report_fault(struct iommu *obj, u32 *da)
162 return arch_iommu->fault_isr(obj, da);
165 static void iotlb_lock_get(struct iommu *obj, struct iotlb_lock *l)
169 val = iommu_read_reg(obj, MMU_LOCK);
171 l->base = MMU_LOCK_BASE(val);
172 l->vict = MMU_LOCK_VICT(val);
174 BUG_ON(l->base != 0); /* Currently no preservation is used */
177 static void iotlb_lock_set(struct iommu *obj, struct iotlb_lock *l)
181 BUG_ON(l->base != 0); /* Currently no preservation is used */
183 val = (l->base << MMU_LOCK_BASE_SHIFT);
184 val |= (l->vict << MMU_LOCK_VICT_SHIFT);
186 iommu_write_reg(obj, val, MMU_LOCK);
189 static void iotlb_read_cr(struct iommu *obj, struct cr_regs *cr)
191 arch_iommu->tlb_read_cr(obj, cr);
194 static void iotlb_load_cr(struct iommu *obj, struct cr_regs *cr)
196 arch_iommu->tlb_load_cr(obj, cr);
198 iommu_write_reg(obj, 1, MMU_FLUSH_ENTRY);
199 iommu_write_reg(obj, 1, MMU_LD_TLB);
203 * iotlb_dump_cr - Dump an iommu tlb entry into buf
205 * @cr: contents of cam and ram register
206 * @buf: output buffer
208 static inline ssize_t iotlb_dump_cr(struct iommu *obj, struct cr_regs *cr,
213 return arch_iommu->dump_cr(obj, cr, buf);
217 * load_iotlb_entry - Set an iommu tlb entry
219 * @e: an iommu tlb entry info
221 int load_iotlb_entry(struct iommu *obj, struct iotlb_entry *e)
228 if (!obj || !obj->nr_tlb_entries || !e)
231 clk_enable(obj->clk);
233 for (i = 0; i < obj->nr_tlb_entries; i++) {
236 iotlb_lock_get(obj, &l);
238 iotlb_lock_set(obj, &l);
239 iotlb_read_cr(obj, &tmp);
240 if (!iotlb_cr_valid(&tmp))
244 if (i == obj->nr_tlb_entries) {
245 dev_dbg(obj->dev, "%s: full: no entry\n", __func__);
250 cr = iotlb_alloc_cr(obj, e);
252 clk_disable(obj->clk);
256 iotlb_load_cr(obj, cr);
259 /* increment victim for next tlb load */
260 if (++l.vict == obj->nr_tlb_entries)
262 iotlb_lock_set(obj, &l);
264 clk_disable(obj->clk);
267 EXPORT_SYMBOL_GPL(load_iotlb_entry);
270 * flush_iotlb_page - Clear an iommu tlb entry
272 * @da: iommu device virtual address
274 * Clear an iommu tlb entry which includes 'da' address.
276 void flush_iotlb_page(struct iommu *obj, u32 da)
281 clk_enable(obj->clk);
283 for (i = 0; i < obj->nr_tlb_entries; i++) {
288 iotlb_lock_get(obj, &l);
290 iotlb_lock_set(obj, &l);
291 iotlb_read_cr(obj, &cr);
292 if (!iotlb_cr_valid(&cr))
295 start = iotlb_cr_to_virt(&cr);
296 bytes = iopgsz_to_bytes(cr.cam & 3);
298 if ((start <= da) && (da < start + bytes)) {
299 dev_dbg(obj->dev, "%s: %08x<=%08x(%x)\n",
300 __func__, start, da, bytes);
302 iommu_write_reg(obj, 1, MMU_FLUSH_ENTRY);
305 clk_disable(obj->clk);
307 if (i == obj->nr_tlb_entries)
308 dev_dbg(obj->dev, "%s: no page for %08x\n", __func__, da);
310 EXPORT_SYMBOL_GPL(flush_iotlb_page);
313 * flush_iotlb_range - Clear an iommu tlb entries
315 * @start: iommu device virtual address(start)
316 * @end: iommu device virtual address(end)
318 * Clear an iommu tlb entry which includes 'da' address.
320 void flush_iotlb_range(struct iommu *obj, u32 start, u32 end)
325 flush_iotlb_page(obj, da);
326 /* FIXME: Optimize for multiple page size */
330 EXPORT_SYMBOL_GPL(flush_iotlb_range);
333 * flush_iotlb_all - Clear all iommu tlb entries
336 void flush_iotlb_all(struct iommu *obj)
340 clk_enable(obj->clk);
344 iotlb_lock_set(obj, &l);
346 iommu_write_reg(obj, 1, MMU_GFLUSH);
348 clk_disable(obj->clk);
350 EXPORT_SYMBOL_GPL(flush_iotlb_all);
352 #if defined(CONFIG_OMAP_IOMMU_DEBUG_MODULE)
354 ssize_t iommu_dump_ctx(struct iommu *obj, char *buf)
361 clk_enable(obj->clk);
363 bytes = arch_iommu->dump_ctx(obj, buf);
365 clk_disable(obj->clk);
369 EXPORT_SYMBOL_GPL(iommu_dump_ctx);
371 static int __dump_tlb_entries(struct iommu *obj, struct cr_regs *crs)
374 struct iotlb_lock saved, l;
375 struct cr_regs *p = crs;
377 clk_enable(obj->clk);
379 iotlb_lock_get(obj, &saved);
380 memcpy(&l, &saved, sizeof(saved));
382 for (i = 0; i < obj->nr_tlb_entries; i++) {
385 iotlb_lock_get(obj, &l);
387 iotlb_lock_set(obj, &l);
388 iotlb_read_cr(obj, &tmp);
389 if (!iotlb_cr_valid(&tmp))
394 iotlb_lock_set(obj, &saved);
395 clk_disable(obj->clk);
401 * dump_tlb_entries - dump cr arrays to given buffer
403 * @buf: output buffer
405 size_t dump_tlb_entries(struct iommu *obj, char *buf)
411 cr = kcalloc(obj->nr_tlb_entries, sizeof(*cr), GFP_KERNEL);
415 n = __dump_tlb_entries(obj, cr);
416 for (i = 0; i < n; i++)
417 p += iotlb_dump_cr(obj, cr + i, p);
422 EXPORT_SYMBOL_GPL(dump_tlb_entries);
424 int foreach_iommu_device(void *data, int (*fn)(struct device *, void *))
426 return driver_for_each_device(&omap_iommu_driver.driver,
429 EXPORT_SYMBOL_GPL(foreach_iommu_device);
431 #endif /* CONFIG_OMAP_IOMMU_DEBUG_MODULE */
434 * H/W pagetable operations
436 static void flush_iopgd_range(u32 *first, u32 *last)
438 /* FIXME: L2 cache should be taken care of if it exists */
440 asm("mcr p15, 0, %0, c7, c10, 1 @ flush_pgd"
442 first += L1_CACHE_BYTES / sizeof(*first);
443 } while (first <= last);
446 static void flush_iopte_range(u32 *first, u32 *last)
448 /* FIXME: L2 cache should be taken care of if it exists */
450 asm("mcr p15, 0, %0, c7, c10, 1 @ flush_pte"
452 first += L1_CACHE_BYTES / sizeof(*first);
453 } while (first <= last);
456 static void iopte_free(u32 *iopte)
458 /* Note: freed iopte's must be clean ready for re-use */
459 kmem_cache_free(iopte_cachep, iopte);
462 static u32 *iopte_alloc(struct iommu *obj, u32 *iopgd, u32 da)
466 /* a table has already existed */
471 * do the allocation outside the page table lock
473 spin_unlock(&obj->page_table_lock);
474 iopte = kmem_cache_zalloc(iopte_cachep, GFP_KERNEL);
475 spin_lock(&obj->page_table_lock);
479 return ERR_PTR(-ENOMEM);
481 *iopgd = virt_to_phys(iopte) | IOPGD_TABLE;
482 flush_iopgd_range(iopgd, iopgd);
484 dev_vdbg(obj->dev, "%s: a new pte:%p\n", __func__, iopte);
486 /* We raced, free the reduniovant table */
491 iopte = iopte_offset(iopgd, da);
494 "%s: da:%08x pgd:%p *pgd:%08x pte:%p *pte:%08x\n",
495 __func__, da, iopgd, *iopgd, iopte, *iopte);
500 static int iopgd_alloc_section(struct iommu *obj, u32 da, u32 pa, u32 prot)
502 u32 *iopgd = iopgd_offset(obj, da);
504 *iopgd = (pa & IOSECTION_MASK) | prot | IOPGD_SECTION;
505 flush_iopgd_range(iopgd, iopgd);
509 static int iopgd_alloc_super(struct iommu *obj, u32 da, u32 pa, u32 prot)
511 u32 *iopgd = iopgd_offset(obj, da);
514 for (i = 0; i < 16; i++)
515 *(iopgd + i) = (pa & IOSUPER_MASK) | prot | IOPGD_SUPER;
516 flush_iopgd_range(iopgd, iopgd + 15);
520 static int iopte_alloc_page(struct iommu *obj, u32 da, u32 pa, u32 prot)
522 u32 *iopgd = iopgd_offset(obj, da);
523 u32 *iopte = iopte_alloc(obj, iopgd, da);
526 return PTR_ERR(iopte);
528 *iopte = (pa & IOPAGE_MASK) | prot | IOPTE_SMALL;
529 flush_iopte_range(iopte, iopte);
531 dev_vdbg(obj->dev, "%s: da:%08x pa:%08x pte:%p *pte:%08x\n",
532 __func__, da, pa, iopte, *iopte);
537 static int iopte_alloc_large(struct iommu *obj, u32 da, u32 pa, u32 prot)
539 u32 *iopgd = iopgd_offset(obj, da);
540 u32 *iopte = iopte_alloc(obj, iopgd, da);
544 return PTR_ERR(iopte);
546 for (i = 0; i < 16; i++)
547 *(iopte + i) = (pa & IOLARGE_MASK) | prot | IOPTE_LARGE;
548 flush_iopte_range(iopte, iopte + 15);
552 static int iopgtable_store_entry_core(struct iommu *obj, struct iotlb_entry *e)
554 int (*fn)(struct iommu *, u32, u32, u32);
562 case MMU_CAM_PGSZ_16M:
563 fn = iopgd_alloc_super;
565 case MMU_CAM_PGSZ_1M:
566 fn = iopgd_alloc_section;
568 case MMU_CAM_PGSZ_64K:
569 fn = iopte_alloc_large;
571 case MMU_CAM_PGSZ_4K:
572 fn = iopte_alloc_page;
580 prot = get_iopte_attr(e);
582 spin_lock(&obj->page_table_lock);
583 err = fn(obj, e->da, e->pa, prot);
584 spin_unlock(&obj->page_table_lock);
590 * iopgtable_store_entry - Make an iommu pte entry
592 * @e: an iommu tlb entry info
594 int iopgtable_store_entry(struct iommu *obj, struct iotlb_entry *e)
598 flush_iotlb_page(obj, e->da);
599 err = iopgtable_store_entry_core(obj, e);
600 #ifdef PREFETCH_IOTLB
602 load_iotlb_entry(obj, e);
606 EXPORT_SYMBOL_GPL(iopgtable_store_entry);
609 * iopgtable_lookup_entry - Lookup an iommu pte entry
611 * @da: iommu device virtual address
612 * @ppgd: iommu pgd entry pointer to be returned
613 * @ppte: iommu pte entry pointer to be returned
615 void iopgtable_lookup_entry(struct iommu *obj, u32 da, u32 **ppgd, u32 **ppte)
617 u32 *iopgd, *iopte = NULL;
619 iopgd = iopgd_offset(obj, da);
623 if (*iopgd & IOPGD_TABLE)
624 iopte = iopte_offset(iopgd, da);
629 EXPORT_SYMBOL_GPL(iopgtable_lookup_entry);
631 static size_t iopgtable_clear_entry_core(struct iommu *obj, u32 da)
634 u32 *iopgd = iopgd_offset(obj, da);
640 if (*iopgd & IOPGD_TABLE) {
642 u32 *iopte = iopte_offset(iopgd, da);
645 if (*iopte & IOPTE_LARGE) {
647 /* rewind to the 1st entry */
648 iopte = (u32 *)((u32)iopte & IOLARGE_MASK);
651 memset(iopte, 0, nent * sizeof(*iopte));
652 flush_iopte_range(iopte, iopte + (nent - 1) * sizeof(*iopte));
655 * do table walk to check if this table is necessary or not
657 iopte = iopte_offset(iopgd, 0);
658 for (i = 0; i < PTRS_PER_IOPTE; i++)
663 nent = 1; /* for the next L1 entry */
666 if (*iopgd & IOPGD_SUPER) {
668 /* rewind to the 1st entry */
669 iopgd = (u32 *)((u32)iopgd & IOSUPER_MASK);
673 memset(iopgd, 0, nent * sizeof(*iopgd));
674 flush_iopgd_range(iopgd, iopgd + (nent - 1) * sizeof(*iopgd));
680 * iopgtable_clear_entry - Remove an iommu pte entry
682 * @da: iommu device virtual address
684 size_t iopgtable_clear_entry(struct iommu *obj, u32 da)
688 spin_lock(&obj->page_table_lock);
690 bytes = iopgtable_clear_entry_core(obj, da);
691 flush_iotlb_page(obj, da);
693 spin_unlock(&obj->page_table_lock);
697 EXPORT_SYMBOL_GPL(iopgtable_clear_entry);
699 static void iopgtable_clear_entry_all(struct iommu *obj)
703 spin_lock(&obj->page_table_lock);
705 for (i = 0; i < PTRS_PER_IOPGD; i++) {
709 da = i << IOPGD_SHIFT;
710 iopgd = iopgd_offset(obj, da);
715 if (*iopgd & IOPGD_TABLE)
716 iopte_free(iopte_offset(iopgd, 0));
719 flush_iopgd_range(iopgd, iopgd);
722 flush_iotlb_all(obj);
724 spin_unlock(&obj->page_table_lock);
728 * Device IOMMU generic operations
730 static irqreturn_t iommu_fault_handler(int irq, void *data)
735 struct iommu *obj = data;
740 /* Dynamic loading TLB or PTE */
747 clk_enable(obj->clk);
748 stat = iommu_report_fault(obj, &da);
749 clk_disable(obj->clk);
753 iopgd = iopgd_offset(obj, da);
755 if (!(*iopgd & IOPGD_TABLE)) {
756 dev_err(obj->dev, "%s: da:%08x pgd:%p *pgd:%08x\n", __func__,
761 iopte = iopte_offset(iopgd, da);
763 dev_err(obj->dev, "%s: da:%08x pgd:%p *pgd:%08x pte:%p *pte:%08x\n",
764 __func__, da, iopgd, *iopgd, iopte, *iopte);
769 static int device_match_by_alias(struct device *dev, void *data)
771 struct iommu *obj = to_iommu(dev);
772 const char *name = data;
774 pr_debug("%s: %s %s\n", __func__, obj->name, name);
776 return strcmp(obj->name, name) == 0;
780 * iommu_get - Get iommu handler
781 * @name: target iommu name
783 struct iommu *iommu_get(const char *name)
789 dev = driver_find_device(&omap_iommu_driver.driver, NULL, (void *)name,
790 device_match_by_alias);
792 return ERR_PTR(-ENODEV);
796 mutex_lock(&obj->iommu_lock);
798 if (obj->refcount++ == 0) {
799 err = iommu_enable(obj);
802 flush_iotlb_all(obj);
805 if (!try_module_get(obj->owner))
808 mutex_unlock(&obj->iommu_lock);
810 dev_dbg(obj->dev, "%s: %s\n", __func__, obj->name);
814 if (obj->refcount == 1)
818 mutex_unlock(&obj->iommu_lock);
821 EXPORT_SYMBOL_GPL(iommu_get);
824 * iommu_put - Put back iommu handler
827 void iommu_put(struct iommu *obj)
829 if (!obj && IS_ERR(obj))
832 mutex_lock(&obj->iommu_lock);
834 if (--obj->refcount == 0)
837 module_put(obj->owner);
839 mutex_unlock(&obj->iommu_lock);
841 dev_dbg(obj->dev, "%s: %s\n", __func__, obj->name);
843 EXPORT_SYMBOL_GPL(iommu_put);
846 * OMAP Device MMU(IOMMU) detection
848 static int __devinit omap_iommu_probe(struct platform_device *pdev)
854 struct resource *res;
855 struct iommu_platform_data *pdata = pdev->dev.platform_data;
857 if (pdev->num_resources != 2)
860 obj = kzalloc(sizeof(*obj) + MMU_REG_SIZE, GFP_KERNEL);
864 obj->clk = clk_get(&pdev->dev, pdata->clk_name);
865 if (IS_ERR(obj->clk))
868 obj->nr_tlb_entries = pdata->nr_tlb_entries;
869 obj->name = pdata->name;
870 obj->dev = &pdev->dev;
871 obj->ctx = (void *)obj + sizeof(*obj);
873 mutex_init(&obj->iommu_lock);
874 mutex_init(&obj->mmap_lock);
875 spin_lock_init(&obj->page_table_lock);
876 INIT_LIST_HEAD(&obj->mmap);
878 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
883 obj->regbase = ioremap(res->start, resource_size(res));
889 res = request_mem_region(res->start, resource_size(res),
890 dev_name(&pdev->dev));
896 irq = platform_get_irq(pdev, 0);
901 err = request_irq(irq, iommu_fault_handler, IRQF_SHARED,
902 dev_name(&pdev->dev), obj);
905 platform_set_drvdata(pdev, obj);
907 p = (void *)__get_free_pages(GFP_KERNEL, get_order(IOPGD_TABLE_SIZE));
912 memset(p, 0, IOPGD_TABLE_SIZE);
913 clean_dcache_area(p, IOPGD_TABLE_SIZE);
916 BUG_ON(!IS_ALIGNED((unsigned long)obj->iopgd, IOPGD_TABLE_SIZE));
918 dev_info(&pdev->dev, "%s registered\n", obj->name);
924 release_mem_region(res->start, resource_size(res));
925 iounmap(obj->regbase);
933 static int __devexit omap_iommu_remove(struct platform_device *pdev)
936 struct resource *res;
937 struct iommu *obj = platform_get_drvdata(pdev);
939 platform_set_drvdata(pdev, NULL);
941 iopgtable_clear_entry_all(obj);
942 free_pages((unsigned long)obj->iopgd, get_order(IOPGD_TABLE_SIZE));
944 irq = platform_get_irq(pdev, 0);
946 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
947 release_mem_region(res->start, resource_size(res));
948 iounmap(obj->regbase);
951 dev_info(&pdev->dev, "%s removed\n", obj->name);
956 static struct platform_driver omap_iommu_driver = {
957 .probe = omap_iommu_probe,
958 .remove = __devexit_p(omap_iommu_remove),
960 .name = "omap-iommu",
964 static void iopte_cachep_ctor(void *iopte)
966 clean_dcache_area(iopte, IOPTE_TABLE_SIZE);
969 static int __init omap_iommu_init(void)
971 struct kmem_cache *p;
972 const unsigned long flags = SLAB_HWCACHE_ALIGN;
973 size_t align = 1 << 10; /* L2 pagetable alignement */
975 p = kmem_cache_create("iopte_cache", IOPTE_TABLE_SIZE, align, flags,
981 return platform_driver_register(&omap_iommu_driver);
983 module_init(omap_iommu_init);
985 static void __exit omap_iommu_exit(void)
987 kmem_cache_destroy(iopte_cachep);
989 platform_driver_unregister(&omap_iommu_driver);
991 module_exit(omap_iommu_exit);
993 MODULE_DESCRIPTION("omap iommu: tlb and pagetable primitives");
994 MODULE_ALIAS("platform:omap-iommu");
995 MODULE_AUTHOR("Hiroshi DOYU, Paul Mundt and Toshihiro Kobayashi");
996 MODULE_LICENSE("GPL v2");