drivers/iommu/omap-iommu.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * omap iommu: tlb and pagetable primitives
   4  *
   5  * Copyright (C) 2008-2010 Nokia Corporation
   6  * Copyright (C) 2013-2017 Texas Instruments Incorporated - http://www.ti.com/
   7  *
   8  * Written by Hiroshi DOYU <Hiroshi.DOYU@nokia.com>,
   9  *              Paul Mundt and Toshihiro Kobayashi
  10  */
  11
  12 #include <linux/dma-mapping.h>
  13 #include <linux/err.h>
  14 #include <linux/slab.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/ioport.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/iommu.h>
  19 #include <linux/omap-iommu.h>
  20 #include <linux/mutex.h>
  21 #include <linux/spinlock.h>
  22 #include <linux/io.h>
  23 #include <linux/pm_runtime.h>
  24 #include <linux/of.h>
  25 #include <linux/of_iommu.h>
  26 #include <linux/of_irq.h>
  27 #include <linux/of_platform.h>
  28 #include <linux/regmap.h>
  29 #include <linux/mfd/syscon.h>
  30
  31 #include <linux/platform_data/iommu-omap.h>
  32
  33 #include "omap-iopgtable.h"
  34 #include "omap-iommu.h"
  35
  36 static const struct iommu_ops omap_iommu_ops;
  37
  38 #define to_iommu(dev)   ((struct omap_iommu *)dev_get_drvdata(dev))
  39
  40 /* bitmap of the page sizes currently supported */
  41 #define OMAP_IOMMU_PGSIZES      (SZ_4K | SZ_64K | SZ_1M | SZ_16M)
  42
  43 #define MMU_LOCK_BASE_SHIFT     10
  44 #define MMU_LOCK_BASE_MASK      (0x1f << MMU_LOCK_BASE_SHIFT)
  45 #define MMU_LOCK_BASE(x)        \
  46         ((x & MMU_LOCK_BASE_MASK) >> MMU_LOCK_BASE_SHIFT)
  47
  48 #define MMU_LOCK_VICT_SHIFT     4
  49 #define MMU_LOCK_VICT_MASK      (0x1f << MMU_LOCK_VICT_SHIFT)
  50 #define MMU_LOCK_VICT(x)        \
  51         ((x & MMU_LOCK_VICT_MASK) >> MMU_LOCK_VICT_SHIFT)
  52
  53 static struct platform_driver omap_iommu_driver;
  54 static struct kmem_cache *iopte_cachep;
  55
  56 /**
  57  * to_omap_domain - Get struct omap_iommu_domain from generic iommu_domain
  58  * @dom:        generic iommu domain handle
  59  **/
  60 static struct omap_iommu_domain *to_omap_domain(struct iommu_domain *dom)
  61 {
  62         return container_of(dom, struct omap_iommu_domain, domain);
  63 }
  64
  65 /**
  66  * omap_iommu_save_ctx - Save registers for pm off-mode support
  67  * @dev:        client device
  68  **/
  69 void omap_iommu_save_ctx(struct device *dev)
  70 {
  71         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
  72         struct omap_iommu *obj;
  73         u32 *p;
  74         int i;
  75
  76         if (!arch_data)
  77                 return;
  78
  79         while (arch_data->iommu_dev) {
  80                 obj = arch_data->iommu_dev;
  81                 p = obj->ctx;
  82                 for (i = 0; i < (MMU_REG_SIZE / sizeof(u32)); i++) {
  83                         p[i] = iommu_read_reg(obj, i * sizeof(u32));
  84                         dev_dbg(obj->dev, "%s\t[%02d] %08x\n", __func__, i,
  85                                 p[i]);
  86                 }
  87                 arch_data++;
  88         }
  89 }
  90 EXPORT_SYMBOL_GPL(omap_iommu_save_ctx);
  91
  92 /**
  93  * omap_iommu_restore_ctx - Restore registers for pm off-mode support
  94  * @dev:        client device
  95  **/
  96 void omap_iommu_restore_ctx(struct device *dev)
  97 {
  98         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
  99         struct omap_iommu *obj;
 100         u32 *p;
 101         int i;
 102
 103         if (!arch_data)
 104                 return;
 105
 106         while (arch_data->iommu_dev) {
 107                 obj = arch_data->iommu_dev;
 108                 p = obj->ctx;
 109                 for (i = 0; i < (MMU_REG_SIZE / sizeof(u32)); i++) {
 110                         iommu_write_reg(obj, p[i], i * sizeof(u32));
 111                         dev_dbg(obj->dev, "%s\t[%02d] %08x\n", __func__, i,
 112                                 p[i]);
 113                 }
 114                 arch_data++;
 115         }
 116 }
 117 EXPORT_SYMBOL_GPL(omap_iommu_restore_ctx);
 118
 119 static void dra7_cfg_dspsys_mmu(struct omap_iommu *obj, bool enable)
 120 {
 121         u32 val, mask;
 122
 123         if (!obj->syscfg)
 124                 return;
 125
 126         mask = (1 << (obj->id * DSP_SYS_MMU_CONFIG_EN_SHIFT));
 127         val = enable ? mask : 0;
 128         regmap_update_bits(obj->syscfg, DSP_SYS_MMU_CONFIG, mask, val);
 129 }
 130
 131 static void __iommu_set_twl(struct omap_iommu *obj, bool on)
 132 {
 133         u32 l = iommu_read_reg(obj, MMU_CNTL);
 134
 135         if (on)
 136                 iommu_write_reg(obj, MMU_IRQ_TWL_MASK, MMU_IRQENABLE);
 137         else
 138                 iommu_write_reg(obj, MMU_IRQ_TLB_MISS_MASK, MMU_IRQENABLE);
 139
 140         l &= ~MMU_CNTL_MASK;
 141         if (on)
 142                 l |= (MMU_CNTL_MMU_EN | MMU_CNTL_TWL_EN);
 143         else
 144                 l |= (MMU_CNTL_MMU_EN);
 145
 146         iommu_write_reg(obj, l, MMU_CNTL);
 147 }
 148
 149 static int omap2_iommu_enable(struct omap_iommu *obj)
 150 {
 151         u32 l, pa;
 152
 153         if (!obj->iopgd || !IS_ALIGNED((u32)obj->iopgd,  SZ_16K))
 154                 return -EINVAL;
 155
 156         pa = virt_to_phys(obj->iopgd);
 157         if (!IS_ALIGNED(pa, SZ_16K))
 158                 return -EINVAL;
 159
 160         l = iommu_read_reg(obj, MMU_REVISION);
 161         dev_info(obj->dev, "%s: version %d.%d\n", obj->name,
 162                  (l >> 4) & 0xf, l & 0xf);
 163
 164         iommu_write_reg(obj, pa, MMU_TTB);
 165
 166         dra7_cfg_dspsys_mmu(obj, true);
 167
 168         if (obj->has_bus_err_back)
 169                 iommu_write_reg(obj, MMU_GP_REG_BUS_ERR_BACK_EN, MMU_GP_REG);
 170
 171         __iommu_set_twl(obj, true);
 172
 173         return 0;
 174 }
 175
 176 static void omap2_iommu_disable(struct omap_iommu *obj)
 177 {
 178         u32 l = iommu_read_reg(obj, MMU_CNTL);
 179
 180         l &= ~MMU_CNTL_MASK;
 181         iommu_write_reg(obj, l, MMU_CNTL);
 182         dra7_cfg_dspsys_mmu(obj, false);
 183
 184         dev_dbg(obj->dev, "%s is shutting down\n", obj->name);
 185 }
 186
 187 static int iommu_enable(struct omap_iommu *obj)
 188 {
 189         int err;
 190         struct platform_device *pdev = to_platform_device(obj->dev);
 191         struct iommu_platform_data *pdata = dev_get_platdata(&pdev->dev);
 192
 193         if (pdata && pdata->set_pwrdm_constraint) {
 194                 err = pdata->set_pwrdm_constraint(pdev, true, &obj->pwrst);
 195                 if (err) {
 196                         dev_warn(obj->dev, "pwrdm_constraint failed to be set, status = %d\n",
 197                                  err);
 198                 }
 199         }
 200
 201         if (pdata && pdata->deassert_reset) {
 202                 err = pdata->deassert_reset(pdev, pdata->reset_name);
 203                 if (err) {
 204                         dev_err(obj->dev, "deassert_reset failed: %d\n", err);
 205                         return err;
 206                 }
 207         }
 208
 209         pm_runtime_get_sync(obj->dev);
 210
 211         err = omap2_iommu_enable(obj);
 212
 213         return err;
 214 }
 215
 216 static void iommu_disable(struct omap_iommu *obj)
 217 {
 218         struct platform_device *pdev = to_platform_device(obj->dev);
 219         struct iommu_platform_data *pdata = dev_get_platdata(&pdev->dev);
 220         int ret;
 221
 222         omap2_iommu_disable(obj);
 223
 224         pm_runtime_put_sync(obj->dev);
 225
 226         if (pdata && pdata->assert_reset)
 227                 pdata->assert_reset(pdev, pdata->reset_name);
 228
 229         if (pdata && pdata->set_pwrdm_constraint) {
 230                 ret = pdata->set_pwrdm_constraint(pdev, false, &obj->pwrst);
 231                 if (ret) {
 232                         dev_warn(obj->dev, "pwrdm_constraint failed to be reset, status = %d\n",
 233                                  ret);
 234                 }
 235         }
 236 }
 237
 238 /*
 239  *      TLB operations
 240  */
 241 static u32 iotlb_cr_to_virt(struct cr_regs *cr)
 242 {
 243         u32 page_size = cr->cam & MMU_CAM_PGSZ_MASK;
 244         u32 mask = get_cam_va_mask(cr->cam & page_size);
 245
 246         return cr->cam & mask;
 247 }
 248
 249 static u32 get_iopte_attr(struct iotlb_entry *e)
 250 {
 251         u32 attr;
 252
 253         attr = e->mixed << 5;
 254         attr |= e->endian;
 255         attr |= e->elsz >> 3;
 256         attr <<= (((e->pgsz == MMU_CAM_PGSZ_4K) ||
 257                         (e->pgsz == MMU_CAM_PGSZ_64K)) ? 0 : 6);
 258         return attr;
 259 }
 260
 261 static u32 iommu_report_fault(struct omap_iommu *obj, u32 *da)
 262 {
 263         u32 status, fault_addr;
 264
 265         status = iommu_read_reg(obj, MMU_IRQSTATUS);
 266         status &= MMU_IRQ_MASK;
 267         if (!status) {
 268                 *da = 0;
 269                 return 0;
 270         }
 271
 272         fault_addr = iommu_read_reg(obj, MMU_FAULT_AD);
 273         *da = fault_addr;
 274
 275         iommu_write_reg(obj, status, MMU_IRQSTATUS);
 276
 277         return status;
 278 }
 279
 280 void iotlb_lock_get(struct omap_iommu *obj, struct iotlb_lock *l)
 281 {
 282         u32 val;
 283
 284         val = iommu_read_reg(obj, MMU_LOCK);
 285
 286         l->base = MMU_LOCK_BASE(val);
 287         l->vict = MMU_LOCK_VICT(val);
 288 }
 289
 290 void iotlb_lock_set(struct omap_iommu *obj, struct iotlb_lock *l)
 291 {
 292         u32 val;
 293
 294         val = (l->base << MMU_LOCK_BASE_SHIFT);
 295         val |= (l->vict << MMU_LOCK_VICT_SHIFT);
 296
 297         iommu_write_reg(obj, val, MMU_LOCK);
 298 }
 299
 300 static void iotlb_read_cr(struct omap_iommu *obj, struct cr_regs *cr)
 301 {
 302         cr->cam = iommu_read_reg(obj, MMU_READ_CAM);
 303         cr->ram = iommu_read_reg(obj, MMU_READ_RAM);
 304 }
 305
 306 static void iotlb_load_cr(struct omap_iommu *obj, struct cr_regs *cr)
 307 {
 308         iommu_write_reg(obj, cr->cam | MMU_CAM_V, MMU_CAM);
 309         iommu_write_reg(obj, cr->ram, MMU_RAM);
 310
 311         iommu_write_reg(obj, 1, MMU_FLUSH_ENTRY);
 312         iommu_write_reg(obj, 1, MMU_LD_TLB);
 313 }
 314
 315 /* only used in iotlb iteration for-loop */
 316 struct cr_regs __iotlb_read_cr(struct omap_iommu *obj, int n)
 317 {
 318         struct cr_regs cr;
 319         struct iotlb_lock l;
 320
 321         iotlb_lock_get(obj, &l);
 322         l.vict = n;
 323         iotlb_lock_set(obj, &l);
 324         iotlb_read_cr(obj, &cr);
 325
 326         return cr;
 327 }
 328
 329 #ifdef PREFETCH_IOTLB
 330 static struct cr_regs *iotlb_alloc_cr(struct omap_iommu *obj,
 331                                       struct iotlb_entry *e)
 332 {
 333         struct cr_regs *cr;
 334
 335         if (!e)
 336                 return NULL;
 337
 338         if (e->da & ~(get_cam_va_mask(e->pgsz))) {
 339                 dev_err(obj->dev, "%s:\twrong alignment: %08x\n", __func__,
 340                         e->da);
 341                 return ERR_PTR(-EINVAL);
 342         }
 343
 344         cr = kmalloc(sizeof(*cr), GFP_KERNEL);
 345         if (!cr)
 346                 return ERR_PTR(-ENOMEM);
 347
 348         cr->cam = (e->da & MMU_CAM_VATAG_MASK) | e->prsvd | e->pgsz | e->valid;
 349         cr->ram = e->pa | e->endian | e->elsz | e->mixed;
 350
 351         return cr;
 352 }
 353
 354 /**
 355  * load_iotlb_entry - Set an iommu tlb entry
 356  * @obj:        target iommu
 357  * @e:          an iommu tlb entry info
 358  **/
 359 static int load_iotlb_entry(struct omap_iommu *obj, struct iotlb_entry *e)
 360 {
 361         int err = 0;
 362         struct iotlb_lock l;
 363         struct cr_regs *cr;
 364
 365         if (!obj || !obj->nr_tlb_entries || !e)
 366                 return -EINVAL;
 367
 368         pm_runtime_get_sync(obj->dev);
 369
 370         iotlb_lock_get(obj, &l);
 371         if (l.base == obj->nr_tlb_entries) {
 372                 dev_warn(obj->dev, "%s: preserve entries full\n", __func__);
 373                 err = -EBUSY;
 374                 goto out;
 375         }
 376         if (!e->prsvd) {
 377                 int i;
 378                 struct cr_regs tmp;
 379
 380                 for_each_iotlb_cr(obj, obj->nr_tlb_entries, i, tmp)
 381                         if (!iotlb_cr_valid(&tmp))
 382                                 break;
 383
 384                 if (i == obj->nr_tlb_entries) {
 385                         dev_dbg(obj->dev, "%s: full: no entry\n", __func__);
 386                         err = -EBUSY;
 387                         goto out;
 388                 }
 389
 390                 iotlb_lock_get(obj, &l);
 391         } else {
 392                 l.vict = l.base;
 393                 iotlb_lock_set(obj, &l);
 394         }
 395
 396         cr = iotlb_alloc_cr(obj, e);
 397         if (IS_ERR(cr)) {
 398                 pm_runtime_put_sync(obj->dev);
 399                 return PTR_ERR(cr);
 400         }
 401
 402         iotlb_load_cr(obj, cr);
 403         kfree(cr);
 404
 405         if (e->prsvd)
 406                 l.base++;
 407         /* increment victim for next tlb load */
 408         if (++l.vict == obj->nr_tlb_entries)
 409                 l.vict = l.base;
 410         iotlb_lock_set(obj, &l);
 411 out:
 412         pm_runtime_put_sync(obj->dev);
 413         return err;
 414 }
 415
 416 #else /* !PREFETCH_IOTLB */
 417
 418 static int load_iotlb_entry(struct omap_iommu *obj, struct iotlb_entry *e)
 419 {
 420         return 0;
 421 }
 422
 423 #endif /* !PREFETCH_IOTLB */
 424
 425 static int prefetch_iotlb_entry(struct omap_iommu *obj, struct iotlb_entry *e)
 426 {
 427         return load_iotlb_entry(obj, e);
 428 }
 429
 430 /**
 431  * flush_iotlb_page - Clear an iommu tlb entry
 432  * @obj:        target iommu
 433  * @da:         iommu device virtual address
 434  *
 435  * Clear an iommu tlb entry which includes 'da' address.
 436  **/
 437 static void flush_iotlb_page(struct omap_iommu *obj, u32 da)
 438 {
 439         int i;
 440         struct cr_regs cr;
 441
 442         pm_runtime_get_sync(obj->dev);
 443
 444         for_each_iotlb_cr(obj, obj->nr_tlb_entries, i, cr) {
 445                 u32 start;
 446                 size_t bytes;
 447
 448                 if (!iotlb_cr_valid(&cr))
 449                         continue;
 450
 451                 start = iotlb_cr_to_virt(&cr);
 452                 bytes = iopgsz_to_bytes(cr.cam & 3);
 453
 454                 if ((start <= da) && (da < start + bytes)) {
 455                         dev_dbg(obj->dev, "%s: %08x<=%08x(%x)\n",
 456                                 __func__, start, da, bytes);
 457                         iotlb_load_cr(obj, &cr);
 458                         iommu_write_reg(obj, 1, MMU_FLUSH_ENTRY);
 459                         break;
 460                 }
 461         }
 462         pm_runtime_put_sync(obj->dev);
 463
 464         if (i == obj->nr_tlb_entries)
 465                 dev_dbg(obj->dev, "%s: no page for %08x\n", __func__, da);
 466 }
 467
 468 /**
 469  * flush_iotlb_all - Clear all iommu tlb entries
 470  * @obj:        target iommu
 471  **/
 472 static void flush_iotlb_all(struct omap_iommu *obj)
 473 {
 474         struct iotlb_lock l;
 475
 476         pm_runtime_get_sync(obj->dev);
 477
 478         l.base = 0;
 479         l.vict = 0;
 480         iotlb_lock_set(obj, &l);
 481
 482         iommu_write_reg(obj, 1, MMU_GFLUSH);
 483
 484         pm_runtime_put_sync(obj->dev);
 485 }
 486
 487 /*
 488  *      H/W pagetable operations
 489  */
 490 static void flush_iopte_range(struct device *dev, dma_addr_t dma,
 491                               unsigned long offset, int num_entries)
 492 {
 493         size_t size = num_entries * sizeof(u32);
 494
 495         dma_sync_single_range_for_device(dev, dma, offset, size, DMA_TO_DEVICE);
 496 }
 497
 498 static void iopte_free(struct omap_iommu *obj, u32 *iopte, bool dma_valid)
 499 {
 500         dma_addr_t pt_dma;
 501
 502         /* Note: freed iopte's must be clean ready for re-use */
 503         if (iopte) {
 504                 if (dma_valid) {
 505                         pt_dma = virt_to_phys(iopte);
 506                         dma_unmap_single(obj->dev, pt_dma, IOPTE_TABLE_SIZE,
 507                                          DMA_TO_DEVICE);
 508                 }
 509
 510                 kmem_cache_free(iopte_cachep, iopte);
 511         }
 512 }
 513
 514 static u32 *iopte_alloc(struct omap_iommu *obj, u32 *iopgd,
 515                         dma_addr_t *pt_dma, u32 da)
 516 {
 517         u32 *iopte;
 518         unsigned long offset = iopgd_index(da) * sizeof(da);
 519
 520         /* a table has already existed */
 521         if (*iopgd)
 522                 goto pte_ready;
 523
 524         /*
 525          * do the allocation outside the page table lock
 526          */
 527         spin_unlock(&obj->page_table_lock);
 528         iopte = kmem_cache_zalloc(iopte_cachep, GFP_KERNEL);
 529         spin_lock(&obj->page_table_lock);
 530
 531         if (!*iopgd) {
 532                 if (!iopte)
 533                         return ERR_PTR(-ENOMEM);
 534
 535                 *pt_dma = dma_map_single(obj->dev, iopte, IOPTE_TABLE_SIZE,
 536                                          DMA_TO_DEVICE);
 537                 if (dma_mapping_error(obj->dev, *pt_dma)) {
 538                         dev_err(obj->dev, "DMA map error for L2 table\n");
 539                         iopte_free(obj, iopte, false);
 540                         return ERR_PTR(-ENOMEM);
 541                 }
 542
 543                 /*
 544                  * we rely on dma address and the physical address to be
 545                  * the same for mapping the L2 table
 546                  */
 547                 if (WARN_ON(*pt_dma != virt_to_phys(iopte))) {
 548                         dev_err(obj->dev, "DMA translation error for L2 table\n");
 549                         dma_unmap_single(obj->dev, *pt_dma, IOPTE_TABLE_SIZE,
 550                                          DMA_TO_DEVICE);
 551                         iopte_free(obj, iopte, false);
 552                         return ERR_PTR(-ENOMEM);
 553                 }
 554
 555                 *iopgd = virt_to_phys(iopte) | IOPGD_TABLE;
 556
 557                 flush_iopte_range(obj->dev, obj->pd_dma, offset, 1);
 558                 dev_vdbg(obj->dev, "%s: a new pte:%p\n", __func__, iopte);
 559         } else {
 560                 /* We raced, free the reduniovant table */
 561                 iopte_free(obj, iopte, false);
 562         }
 563
 564 pte_ready:
 565         iopte = iopte_offset(iopgd, da);
 566         *pt_dma = iopgd_page_paddr(iopgd);
 567         dev_vdbg(obj->dev,
 568                  "%s: da:%08x pgd:%p *pgd:%08x pte:%p *pte:%08x\n",
 569                  __func__, da, iopgd, *iopgd, iopte, *iopte);
 570
 571         return iopte;
 572 }
 573
 574 static int iopgd_alloc_section(struct omap_iommu *obj, u32 da, u32 pa, u32 prot)
 575 {
 576         u32 *iopgd = iopgd_offset(obj, da);
 577         unsigned long offset = iopgd_index(da) * sizeof(da);
 578
 579         if ((da | pa) & ~IOSECTION_MASK) {
 580                 dev_err(obj->dev, "%s: %08x:%08x should aligned on %08lx\n",
 581                         __func__, da, pa, IOSECTION_SIZE);
 582                 return -EINVAL;
 583         }
 584
 585         *iopgd = (pa & IOSECTION_MASK) | prot | IOPGD_SECTION;
 586         flush_iopte_range(obj->dev, obj->pd_dma, offset, 1);
 587         return 0;
 588 }
 589
 590 static int iopgd_alloc_super(struct omap_iommu *obj, u32 da, u32 pa, u32 prot)
 591 {
 592         u32 *iopgd = iopgd_offset(obj, da);
 593         unsigned long offset = iopgd_index(da) * sizeof(da);
 594         int i;
 595
 596         if ((da | pa) & ~IOSUPER_MASK) {
 597                 dev_err(obj->dev, "%s: %08x:%08x should aligned on %08lx\n",
 598                         __func__, da, pa, IOSUPER_SIZE);
 599                 return -EINVAL;
 600         }
 601
 602         for (i = 0; i < 16; i++)
 603                 *(iopgd + i) = (pa & IOSUPER_MASK) | prot | IOPGD_SUPER;
 604         flush_iopte_range(obj->dev, obj->pd_dma, offset, 16);
 605         return 0;
 606 }
 607
 608 static int iopte_alloc_page(struct omap_iommu *obj, u32 da, u32 pa, u32 prot)
 609 {
 610         u32 *iopgd = iopgd_offset(obj, da);
 611         dma_addr_t pt_dma;
 612         u32 *iopte = iopte_alloc(obj, iopgd, &pt_dma, da);
 613         unsigned long offset = iopte_index(da) * sizeof(da);
 614
 615         if (IS_ERR(iopte))
 616                 return PTR_ERR(iopte);
 617
 618         *iopte = (pa & IOPAGE_MASK) | prot | IOPTE_SMALL;
 619         flush_iopte_range(obj->dev, pt_dma, offset, 1);
 620
 621         dev_vdbg(obj->dev, "%s: da:%08x pa:%08x pte:%p *pte:%08x\n",
 622                  __func__, da, pa, iopte, *iopte);
 623
 624         return 0;
 625 }
 626
 627 static int iopte_alloc_large(struct omap_iommu *obj, u32 da, u32 pa, u32 prot)
 628 {
 629         u32 *iopgd = iopgd_offset(obj, da);
 630         dma_addr_t pt_dma;
 631         u32 *iopte = iopte_alloc(obj, iopgd, &pt_dma, da);
 632         unsigned long offset = iopte_index(da) * sizeof(da);
 633         int i;
 634
 635         if ((da | pa) & ~IOLARGE_MASK) {
 636                 dev_err(obj->dev, "%s: %08x:%08x should aligned on %08lx\n",
 637                         __func__, da, pa, IOLARGE_SIZE);
 638                 return -EINVAL;
 639         }
 640
 641         if (IS_ERR(iopte))
 642                 return PTR_ERR(iopte);
 643
 644         for (i = 0; i < 16; i++)
 645                 *(iopte + i) = (pa & IOLARGE_MASK) | prot | IOPTE_LARGE;
 646         flush_iopte_range(obj->dev, pt_dma, offset, 16);
 647         return 0;
 648 }
 649
 650 static int
 651 iopgtable_store_entry_core(struct omap_iommu *obj, struct iotlb_entry *e)
 652 {
 653         int (*fn)(struct omap_iommu *, u32, u32, u32);
 654         u32 prot;
 655         int err;
 656
 657         if (!obj || !e)
 658                 return -EINVAL;
 659
 660         switch (e->pgsz) {
 661         case MMU_CAM_PGSZ_16M:
 662                 fn = iopgd_alloc_super;
 663                 break;
 664         case MMU_CAM_PGSZ_1M:
 665                 fn = iopgd_alloc_section;
 666                 break;
 667         case MMU_CAM_PGSZ_64K:
 668                 fn = iopte_alloc_large;
 669                 break;
 670         case MMU_CAM_PGSZ_4K:
 671                 fn = iopte_alloc_page;
 672                 break;
 673         default:
 674                 fn = NULL;
 675                 break;
 676         }
 677
 678         if (WARN_ON(!fn))
 679                 return -EINVAL;
 680
 681         prot = get_iopte_attr(e);
 682
 683         spin_lock(&obj->page_table_lock);
 684         err = fn(obj, e->da, e->pa, prot);
 685         spin_unlock(&obj->page_table_lock);
 686
 687         return err;
 688 }
 689
 690 /**
 691  * omap_iopgtable_store_entry - Make an iommu pte entry
 692  * @obj:        target iommu
 693  * @e:          an iommu tlb entry info
 694  **/
 695 static int
 696 omap_iopgtable_store_entry(struct omap_iommu *obj, struct iotlb_entry *e)
 697 {
 698         int err;
 699
 700         flush_iotlb_page(obj, e->da);
 701         err = iopgtable_store_entry_core(obj, e);
 702         if (!err)
 703                 prefetch_iotlb_entry(obj, e);
 704         return err;
 705 }
 706
 707 /**
 708  * iopgtable_lookup_entry - Lookup an iommu pte entry
 709  * @obj:        target iommu
 710  * @da:         iommu device virtual address
 711  * @ppgd:       iommu pgd entry pointer to be returned
 712  * @ppte:       iommu pte entry pointer to be returned
 713  **/
 714 static void
 715 iopgtable_lookup_entry(struct omap_iommu *obj, u32 da, u32 **ppgd, u32 **ppte)
 716 {
 717         u32 *iopgd, *iopte = NULL;
 718
 719         iopgd = iopgd_offset(obj, da);
 720         if (!*iopgd)
 721                 goto out;
 722
 723         if (iopgd_is_table(*iopgd))
 724                 iopte = iopte_offset(iopgd, da);
 725 out:
 726         *ppgd = iopgd;
 727         *ppte = iopte;
 728 }
 729
 730 static size_t iopgtable_clear_entry_core(struct omap_iommu *obj, u32 da)
 731 {
 732         size_t bytes;
 733         u32 *iopgd = iopgd_offset(obj, da);
 734         int nent = 1;
 735         dma_addr_t pt_dma;
 736         unsigned long pd_offset = iopgd_index(da) * sizeof(da);
 737         unsigned long pt_offset = iopte_index(da) * sizeof(da);
 738
 739         if (!*iopgd)
 740                 return 0;
 741
 742         if (iopgd_is_table(*iopgd)) {
 743                 int i;
 744                 u32 *iopte = iopte_offset(iopgd, da);
 745
 746                 bytes = IOPTE_SIZE;
 747                 if (*iopte & IOPTE_LARGE) {
 748                         nent *= 16;
 749                         /* rewind to the 1st entry */
 750                         iopte = iopte_offset(iopgd, (da & IOLARGE_MASK));
 751                 }
 752                 bytes *= nent;
 753                 memset(iopte, 0, nent * sizeof(*iopte));
 754                 pt_dma = iopgd_page_paddr(iopgd);
 755                 flush_iopte_range(obj->dev, pt_dma, pt_offset, nent);
 756
 757                 /*
 758                  * do table walk to check if this table is necessary or not
 759                  */
 760                 iopte = iopte_offset(iopgd, 0);
 761                 for (i = 0; i < PTRS_PER_IOPTE; i++)
 762                         if (iopte[i])
 763                                 goto out;
 764
 765                 iopte_free(obj, iopte, true);
 766                 nent = 1; /* for the next L1 entry */
 767         } else {
 768                 bytes = IOPGD_SIZE;
 769                 if ((*iopgd & IOPGD_SUPER) == IOPGD_SUPER) {
 770                         nent *= 16;
 771                         /* rewind to the 1st entry */
 772                         iopgd = iopgd_offset(obj, (da & IOSUPER_MASK));
 773                 }
 774                 bytes *= nent;
 775         }
 776         memset(iopgd, 0, nent * sizeof(*iopgd));
 777         flush_iopte_range(obj->dev, obj->pd_dma, pd_offset, nent);
 778 out:
 779         return bytes;
 780 }
 781
 782 /**
 783  * iopgtable_clear_entry - Remove an iommu pte entry
 784  * @obj:        target iommu
 785  * @da:         iommu device virtual address
 786  **/
 787 static size_t iopgtable_clear_entry(struct omap_iommu *obj, u32 da)
 788 {
 789         size_t bytes;
 790
 791         spin_lock(&obj->page_table_lock);
 792
 793         bytes = iopgtable_clear_entry_core(obj, da);
 794         flush_iotlb_page(obj, da);
 795
 796         spin_unlock(&obj->page_table_lock);
 797
 798         return bytes;
 799 }
 800
 801 static void iopgtable_clear_entry_all(struct omap_iommu *obj)
 802 {
 803         unsigned long offset;
 804         int i;
 805
 806         spin_lock(&obj->page_table_lock);
 807
 808         for (i = 0; i < PTRS_PER_IOPGD; i++) {
 809                 u32 da;
 810                 u32 *iopgd;
 811
 812                 da = i << IOPGD_SHIFT;
 813                 iopgd = iopgd_offset(obj, da);
 814                 offset = iopgd_index(da) * sizeof(da);
 815
 816                 if (!*iopgd)
 817                         continue;
 818
 819                 if (iopgd_is_table(*iopgd))
 820                         iopte_free(obj, iopte_offset(iopgd, 0), true);
 821
 822                 *iopgd = 0;
 823                 flush_iopte_range(obj->dev, obj->pd_dma, offset, 1);
 824         }
 825
 826         flush_iotlb_all(obj);
 827
 828         spin_unlock(&obj->page_table_lock);
 829 }
 830
 831 /*
 832  *      Device IOMMU generic operations
 833  */
 834 static irqreturn_t iommu_fault_handler(int irq, void *data)
 835 {
 836         u32 da, errs;
 837         u32 *iopgd, *iopte;
 838         struct omap_iommu *obj = data;
 839         struct iommu_domain *domain = obj->domain;
 840         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
 841
 842         if (!omap_domain->dev)
 843                 return IRQ_NONE;
 844
 845         errs = iommu_report_fault(obj, &da);
 846         if (errs == 0)
 847                 return IRQ_HANDLED;
 848
 849         /* Fault callback or TLB/PTE Dynamic loading */
 850         if (!report_iommu_fault(domain, obj->dev, da, 0))
 851                 return IRQ_HANDLED;
 852
 853         iommu_write_reg(obj, 0, MMU_IRQENABLE);
 854
 855         iopgd = iopgd_offset(obj, da);
 856
 857         if (!iopgd_is_table(*iopgd)) {
 858                 dev_err(obj->dev, "%s: errs:0x%08x da:0x%08x pgd:0x%p *pgd:px%08x\n",
 859                         obj->name, errs, da, iopgd, *iopgd);
 860                 return IRQ_NONE;
 861         }
 862
 863         iopte = iopte_offset(iopgd, da);
 864
 865         dev_err(obj->dev, "%s: errs:0x%08x da:0x%08x pgd:0x%p *pgd:0x%08x pte:0x%p *pte:0x%08x\n",
 866                 obj->name, errs, da, iopgd, *iopgd, iopte, *iopte);
 867
 868         return IRQ_NONE;
 869 }
 870
 871 /**
 872  * omap_iommu_attach() - attach iommu device to an iommu domain
 873  * @obj:        target omap iommu device
 874  * @iopgd:      page table
 875  **/
 876 static int omap_iommu_attach(struct omap_iommu *obj, u32 *iopgd)
 877 {
 878         int err;
 879
 880         spin_lock(&obj->iommu_lock);
 881
 882         obj->pd_dma = dma_map_single(obj->dev, iopgd, IOPGD_TABLE_SIZE,
 883                                      DMA_TO_DEVICE);
 884         if (dma_mapping_error(obj->dev, obj->pd_dma)) {
 885                 dev_err(obj->dev, "DMA map error for L1 table\n");
 886                 err = -ENOMEM;
 887                 goto out_err;
 888         }
 889
 890         obj->iopgd = iopgd;
 891         err = iommu_enable(obj);
 892         if (err)
 893                 goto out_err;
 894         flush_iotlb_all(obj);
 895
 896         spin_unlock(&obj->iommu_lock);
 897
 898         dev_dbg(obj->dev, "%s: %s\n", __func__, obj->name);
 899
 900         return 0;
 901
 902 out_err:
 903         spin_unlock(&obj->iommu_lock);
 904
 905         return err;
 906 }
 907
 908 /**
 909  * omap_iommu_detach - release iommu device
 910  * @obj:        target iommu
 911  **/
 912 static void omap_iommu_detach(struct omap_iommu *obj)
 913 {
 914         if (!obj || IS_ERR(obj))
 915                 return;
 916
 917         spin_lock(&obj->iommu_lock);
 918
 919         dma_unmap_single(obj->dev, obj->pd_dma, IOPGD_TABLE_SIZE,
 920                          DMA_TO_DEVICE);
 921         iommu_disable(obj);
 922         obj->pd_dma = 0;
 923         obj->iopgd = NULL;
 924
 925         spin_unlock(&obj->iommu_lock);
 926
 927         dev_dbg(obj->dev, "%s: %s\n", __func__, obj->name);
 928 }
 929
 930 static bool omap_iommu_can_register(struct platform_device *pdev)
 931 {
 932         struct device_node *np = pdev->dev.of_node;
 933
 934         if (!of_device_is_compatible(np, "ti,dra7-dsp-iommu"))
 935                 return true;
 936
 937         /*
 938          * restrict IOMMU core registration only for processor-port MDMA MMUs
 939          * on DRA7 DSPs
 940          */
 941         if ((!strcmp(dev_name(&pdev->dev), "40d01000.mmu")) ||
 942             (!strcmp(dev_name(&pdev->dev), "41501000.mmu")))
 943                 return true;
 944
 945         return false;
 946 }
 947
 948 static int omap_iommu_dra7_get_dsp_system_cfg(struct platform_device *pdev,
 949                                               struct omap_iommu *obj)
 950 {
 951         struct device_node *np = pdev->dev.of_node;
 952         int ret;
 953
 954         if (!of_device_is_compatible(np, "ti,dra7-dsp-iommu"))
 955                 return 0;
 956
 957         if (!of_property_read_bool(np, "ti,syscon-mmuconfig")) {
 958                 dev_err(&pdev->dev, "ti,syscon-mmuconfig property is missing\n");
 959                 return -EINVAL;
 960         }
 961
 962         obj->syscfg =
 963                 syscon_regmap_lookup_by_phandle(np, "ti,syscon-mmuconfig");
 964         if (IS_ERR(obj->syscfg)) {
 965                 /* can fail with -EPROBE_DEFER */
 966                 ret = PTR_ERR(obj->syscfg);
 967                 return ret;
 968         }
 969
 970         if (of_property_read_u32_index(np, "ti,syscon-mmuconfig", 1,
 971                                        &obj->id)) {
 972                 dev_err(&pdev->dev, "couldn't get the IOMMU instance id within subsystem\n");
 973                 return -EINVAL;
 974         }
 975
 976         if (obj->id != 0 && obj->id != 1) {
 977                 dev_err(&pdev->dev, "invalid IOMMU instance id\n");
 978                 return -EINVAL;
 979         }
 980
 981         return 0;
 982 }
 983
 984 /*
 985  *      OMAP Device MMU(IOMMU) detection
 986  */
 987 static int omap_iommu_probe(struct platform_device *pdev)
 988 {
 989         int err = -ENODEV;
 990         int irq;
 991         struct omap_iommu *obj;
 992         struct resource *res;
 993         struct device_node *of = pdev->dev.of_node;
 994
 995         if (!of) {
 996                 pr_err("%s: only DT-based devices are supported\n", __func__);
 997                 return -ENODEV;
 998         }
 999
1000         obj = devm_kzalloc(&pdev->dev, sizeof(*obj) + MMU_REG_SIZE, GFP_KERNEL);
1001         if (!obj)
1002                 return -ENOMEM;
1003
1004         obj->name = dev_name(&pdev->dev);
1005         obj->nr_tlb_entries = 32;
1006         err = of_property_read_u32(of, "ti,#tlb-entries", &obj->nr_tlb_entries);
1007         if (err && err != -EINVAL)
1008                 return err;
1009         if (obj->nr_tlb_entries != 32 && obj->nr_tlb_entries != 8)
1010                 return -EINVAL;
1011         if (of_find_property(of, "ti,iommu-bus-err-back", NULL))
1012                 obj->has_bus_err_back = MMU_GP_REG_BUS_ERR_BACK_EN;
1013
1014         obj->dev = &pdev->dev;
1015         obj->ctx = (void *)obj + sizeof(*obj);
1016
1017         spin_lock_init(&obj->iommu_lock);
1018         spin_lock_init(&obj->page_table_lock);
1019
1020         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
1021         obj->regbase = devm_ioremap_resource(obj->dev, res);
1022         if (IS_ERR(obj->regbase))
1023                 return PTR_ERR(obj->regbase);
1024
1025         err = omap_iommu_dra7_get_dsp_system_cfg(pdev, obj);
1026         if (err)
1027                 return err;
1028
1029         irq = platform_get_irq(pdev, 0);
1030         if (irq < 0)
1031                 return -ENODEV;
1032
1033         err = devm_request_irq(obj->dev, irq, iommu_fault_handler, IRQF_SHARED,
1034                                dev_name(obj->dev), obj);
1035         if (err < 0)
1036                 return err;
1037         platform_set_drvdata(pdev, obj);
1038
1039         if (omap_iommu_can_register(pdev)) {
1040                 obj->group = iommu_group_alloc();
1041                 if (IS_ERR(obj->group))
1042                         return PTR_ERR(obj->group);
1043
1044                 err = iommu_device_sysfs_add(&obj->iommu, obj->dev, NULL,
1045                                              obj->name);
1046                 if (err)
1047                         goto out_group;
1048
1049                 iommu_device_set_ops(&obj->iommu, &omap_iommu_ops);
1050
1051                 err = iommu_device_register(&obj->iommu);
1052                 if (err)
1053                         goto out_sysfs;
1054         }
1055
1056         pm_runtime_irq_safe(obj->dev);
1057         pm_runtime_enable(obj->dev);
1058
1059         omap_iommu_debugfs_add(obj);
1060
1061         dev_info(&pdev->dev, "%s registered\n", obj->name);
1062
1063         return 0;
1064
1065 out_sysfs:
1066         iommu_device_sysfs_remove(&obj->iommu);
1067 out_group:
1068         iommu_group_put(obj->group);
1069         return err;
1070 }
1071
1072 static int omap_iommu_remove(struct platform_device *pdev)
1073 {
1074         struct omap_iommu *obj = platform_get_drvdata(pdev);
1075
1076         if (obj->group) {
1077                 iommu_group_put(obj->group);
1078                 obj->group = NULL;
1079
1080                 iommu_device_sysfs_remove(&obj->iommu);
1081                 iommu_device_unregister(&obj->iommu);
1082         }
1083
1084         omap_iommu_debugfs_remove(obj);
1085
1086         pm_runtime_disable(obj->dev);
1087
1088         dev_info(&pdev->dev, "%s removed\n", obj->name);
1089         return 0;
1090 }
1091
1092 static const struct of_device_id omap_iommu_of_match[] = {
1093         { .compatible = "ti,omap2-iommu" },
1094         { .compatible = "ti,omap4-iommu" },
1095         { .compatible = "ti,dra7-iommu" },
1096         { .compatible = "ti,dra7-dsp-iommu" },
1097         {},
1098 };
1099
1100 static struct platform_driver omap_iommu_driver = {
1101         .probe  = omap_iommu_probe,
1102         .remove = omap_iommu_remove,
1103         .driver = {
1104                 .name   = "omap-iommu",
1105                 .of_match_table = of_match_ptr(omap_iommu_of_match),
1106         },
1107 };
1108
1109 static u32 iotlb_init_entry(struct iotlb_entry *e, u32 da, u32 pa, int pgsz)
1110 {
1111         memset(e, 0, sizeof(*e));
1112
1113         e->da           = da;
1114         e->pa           = pa;
1115         e->valid        = MMU_CAM_V;
1116         e->pgsz         = pgsz;
1117         e->endian       = MMU_RAM_ENDIAN_LITTLE;
1118         e->elsz         = MMU_RAM_ELSZ_8;
1119         e->mixed        = 0;
1120
1121         return iopgsz_to_bytes(e->pgsz);
1122 }
1123
1124 static int omap_iommu_map(struct iommu_domain *domain, unsigned long da,
1125                           phys_addr_t pa, size_t bytes, int prot)
1126 {
1127         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
1128         struct device *dev = omap_domain->dev;
1129         struct omap_iommu_device *iommu;
1130         struct omap_iommu *oiommu;
1131         struct iotlb_entry e;
1132         int omap_pgsz;
1133         u32 ret = -EINVAL;
1134         int i;
1135
1136         omap_pgsz = bytes_to_iopgsz(bytes);
1137         if (omap_pgsz < 0) {
1138                 dev_err(dev, "invalid size to map: %d\n", bytes);
1139                 return -EINVAL;
1140         }
1141
1142         dev_dbg(dev, "mapping da 0x%lx to pa %pa size 0x%x\n", da, &pa, bytes);
1143
1144         iotlb_init_entry(&e, da, pa, omap_pgsz);
1145
1146         iommu = omap_domain->iommus;
1147         for (i = 0; i < omap_domain->num_iommus; i++, iommu++) {
1148                 oiommu = iommu->iommu_dev;
1149                 ret = omap_iopgtable_store_entry(oiommu, &e);
1150                 if (ret) {
1151                         dev_err(dev, "omap_iopgtable_store_entry failed: %d\n",
1152                                 ret);
1153                         break;
1154                 }
1155         }
1156
1157         if (ret) {
1158                 while (i--) {
1159                         iommu--;
1160                         oiommu = iommu->iommu_dev;
1161                         iopgtable_clear_entry(oiommu, da);
1162                 }
1163         }
1164
1165         return ret;
1166 }
1167
1168 static size_t omap_iommu_unmap(struct iommu_domain *domain, unsigned long da,
1169                                size_t size)
1170 {
1171         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
1172         struct device *dev = omap_domain->dev;
1173         struct omap_iommu_device *iommu;
1174         struct omap_iommu *oiommu;
1175         bool error = false;
1176         size_t bytes = 0;
1177         int i;
1178
1179         dev_dbg(dev, "unmapping da 0x%lx size %u\n", da, size);
1180
1181         iommu = omap_domain->iommus;
1182         for (i = 0; i < omap_domain->num_iommus; i++, iommu++) {
1183                 oiommu = iommu->iommu_dev;
1184                 bytes = iopgtable_clear_entry(oiommu, da);
1185                 if (!bytes)
1186                         error = true;
1187         }
1188
1189         /*
1190          * simplify return - we are only checking if any of the iommus
1191          * reported an error, but not if all of them are unmapping the
1192          * same number of entries. This should not occur due to the
1193          * mirror programming.
1194          */
1195         return error ? 0 : bytes;
1196 }
1197
1198 static int omap_iommu_count(struct device *dev)
1199 {
1200         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
1201         int count = 0;
1202
1203         while (arch_data->iommu_dev) {
1204                 count++;
1205                 arch_data++;
1206         }
1207
1208         return count;
1209 }
1210
1211 /* caller should call cleanup if this function fails */
1212 static int omap_iommu_attach_init(struct device *dev,
1213                                   struct omap_iommu_domain *odomain)
1214 {
1215         struct omap_iommu_device *iommu;
1216         int i;
1217
1218         odomain->num_iommus = omap_iommu_count(dev);
1219         if (!odomain->num_iommus)
1220                 return -EINVAL;
1221
1222         odomain->iommus = kcalloc(odomain->num_iommus, sizeof(*iommu),
1223                                   GFP_ATOMIC);
1224         if (!odomain->iommus)
1225                 return -ENOMEM;
1226
1227         iommu = odomain->iommus;
1228         for (i = 0; i < odomain->num_iommus; i++, iommu++) {
1229                 iommu->pgtable = kzalloc(IOPGD_TABLE_SIZE, GFP_ATOMIC);
1230                 if (!iommu->pgtable)
1231                         return -ENOMEM;
1232
1233                 /*
1234                  * should never fail, but please keep this around to ensure
1235                  * we keep the hardware happy
1236                  */
1237                 if (WARN_ON(!IS_ALIGNED((long)iommu->pgtable,
1238                                         IOPGD_TABLE_SIZE)))
1239                         return -EINVAL;
1240         }
1241
1242         return 0;
1243 }
1244
1245 static void omap_iommu_detach_fini(struct omap_iommu_domain *odomain)
1246 {
1247         int i;
1248         struct omap_iommu_device *iommu = odomain->iommus;
1249
1250         for (i = 0; iommu && i < odomain->num_iommus; i++, iommu++)
1251                 kfree(iommu->pgtable);
1252
1253         kfree(odomain->iommus);
1254         odomain->num_iommus = 0;
1255         odomain->iommus = NULL;
1256 }
1257
1258 static int
1259 omap_iommu_attach_dev(struct iommu_domain *domain, struct device *dev)
1260 {
1261         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
1262         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
1263         struct omap_iommu_device *iommu;
1264         struct omap_iommu *oiommu;
1265         int ret = 0;
1266         int i;
1267
1268         if (!arch_data || !arch_data->iommu_dev) {
1269                 dev_err(dev, "device doesn't have an associated iommu\n");
1270                 return -EINVAL;
1271         }
1272
1273         spin_lock(&omap_domain->lock);
1274
1275         /* only a single client device can be attached to a domain */
1276         if (omap_domain->dev) {
1277                 dev_err(dev, "iommu domain is already attached\n");
1278                 ret = -EBUSY;
1279                 goto out;
1280         }
1281
1282         ret = omap_iommu_attach_init(dev, omap_domain);
1283         if (ret) {
1284                 dev_err(dev, "failed to allocate required iommu data %d\n",
1285                         ret);
1286                 goto init_fail;
1287         }
1288
1289         iommu = omap_domain->iommus;
1290         for (i = 0; i < omap_domain->num_iommus; i++, iommu++, arch_data++) {
1291                 /* configure and enable the omap iommu */
1292                 oiommu = arch_data->iommu_dev;
1293                 ret = omap_iommu_attach(oiommu, iommu->pgtable);
1294                 if (ret) {
1295                         dev_err(dev, "can't get omap iommu: %d\n", ret);
1296                         goto attach_fail;
1297                 }
1298
1299                 oiommu->domain = domain;
1300                 iommu->iommu_dev = oiommu;
1301         }
1302
1303         omap_domain->dev = dev;
1304
1305         goto out;
1306
1307 attach_fail:
1308         while (i--) {
1309                 iommu--;
1310                 arch_data--;
1311                 oiommu = iommu->iommu_dev;
1312                 omap_iommu_detach(oiommu);
1313                 iommu->iommu_dev = NULL;
1314                 oiommu->domain = NULL;
1315         }
1316 init_fail:
1317         omap_iommu_detach_fini(omap_domain);
1318 out:
1319         spin_unlock(&omap_domain->lock);
1320         return ret;
1321 }
1322
1323 static void _omap_iommu_detach_dev(struct omap_iommu_domain *omap_domain,
1324                                    struct device *dev)
1325 {
1326         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
1327         struct omap_iommu_device *iommu = omap_domain->iommus;
1328         struct omap_iommu *oiommu;
1329         int i;
1330
1331         if (!omap_domain->dev) {
1332                 dev_err(dev, "domain has no attached device\n");
1333                 return;
1334         }
1335
1336         /* only a single device is supported per domain for now */
1337         if (omap_domain->dev != dev) {
1338                 dev_err(dev, "invalid attached device\n");
1339                 return;
1340         }
1341
1342         /*
1343          * cleanup in the reverse order of attachment - this addresses
1344          * any h/w dependencies between multiple instances, if any
1345          */
1346         iommu += (omap_domain->num_iommus - 1);
1347         arch_data += (omap_domain->num_iommus - 1);
1348         for (i = 0; i < omap_domain->num_iommus; i++, iommu--, arch_data--) {
1349                 oiommu = iommu->iommu_dev;
1350                 iopgtable_clear_entry_all(oiommu);
1351
1352                 omap_iommu_detach(oiommu);
1353                 iommu->iommu_dev = NULL;
1354                 oiommu->domain = NULL;
1355         }
1356
1357         omap_iommu_detach_fini(omap_domain);
1358
1359         omap_domain->dev = NULL;
1360 }
1361
1362 static void omap_iommu_detach_dev(struct iommu_domain *domain,
1363                                   struct device *dev)
1364 {
1365         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
1366
1367         spin_lock(&omap_domain->lock);
1368         _omap_iommu_detach_dev(omap_domain, dev);
1369         spin_unlock(&omap_domain->lock);
1370 }
1371
1372 static struct iommu_domain *omap_iommu_domain_alloc(unsigned type)
1373 {
1374         struct omap_iommu_domain *omap_domain;
1375
1376         if (type != IOMMU_DOMAIN_UNMANAGED)
1377                 return NULL;
1378
1379         omap_domain = kzalloc(sizeof(*omap_domain), GFP_KERNEL);
1380         if (!omap_domain)
1381                 return NULL;
1382
1383         spin_lock_init(&omap_domain->lock);
1384
1385         omap_domain->domain.geometry.aperture_start = 0;
1386         omap_domain->domain.geometry.aperture_end   = (1ULL << 32) - 1;
1387         omap_domain->domain.geometry.force_aperture = true;
1388
1389         return &omap_domain->domain;
1390 }
1391
1392 static void omap_iommu_domain_free(struct iommu_domain *domain)
1393 {
1394         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
1395
1396         /*
1397          * An iommu device is still attached
1398          * (currently, only one device can be attached) ?
1399          */
1400         if (omap_domain->dev)
1401                 _omap_iommu_detach_dev(omap_domain, omap_domain->dev);
1402
1403         kfree(omap_domain);
1404 }
1405
1406 static phys_addr_t omap_iommu_iova_to_phys(struct iommu_domain *domain,
1407                                            dma_addr_t da)
1408 {
1409         struct omap_iommu_domain *omap_domain = to_omap_domain(domain);
1410         struct omap_iommu_device *iommu = omap_domain->iommus;
1411         struct omap_iommu *oiommu = iommu->iommu_dev;
1412         struct device *dev = oiommu->dev;
1413         u32 *pgd, *pte;
1414         phys_addr_t ret = 0;
1415
1416         /*
1417          * all the iommus within the domain will have identical programming,
1418          * so perform the lookup using just the first iommu
1419          */
1420         iopgtable_lookup_entry(oiommu, da, &pgd, &pte);
1421
1422         if (pte) {
1423                 if (iopte_is_small(*pte))
1424                         ret = omap_iommu_translate(*pte, da, IOPTE_MASK);
1425                 else if (iopte_is_large(*pte))
1426                         ret = omap_iommu_translate(*pte, da, IOLARGE_MASK);
1427                 else
1428                         dev_err(dev, "bogus pte 0x%x, da 0x%llx", *pte,
1429                                 (unsigned long long)da);
1430         } else {
1431                 if (iopgd_is_section(*pgd))
1432                         ret = omap_iommu_translate(*pgd, da, IOSECTION_MASK);
1433                 else if (iopgd_is_super(*pgd))
1434                         ret = omap_iommu_translate(*pgd, da, IOSUPER_MASK);
1435                 else
1436                         dev_err(dev, "bogus pgd 0x%x, da 0x%llx", *pgd,
1437                                 (unsigned long long)da);
1438         }
1439
1440         return ret;
1441 }
1442
1443 static int omap_iommu_add_device(struct device *dev)
1444 {
1445         struct omap_iommu_arch_data *arch_data, *tmp;
1446         struct omap_iommu *oiommu;
1447         struct iommu_group *group;
1448         struct device_node *np;
1449         struct platform_device *pdev;
1450         int num_iommus, i;
1451         int ret;
1452
1453         /*
1454          * Allocate the archdata iommu structure for DT-based devices.
1455          *
1456          * TODO: Simplify this when removing non-DT support completely from the
1457          * IOMMU users.
1458          */
1459         if (!dev->of_node)
1460                 return 0;
1461
1462         /*
1463          * retrieve the count of IOMMU nodes using phandle size as element size
1464          * since #iommu-cells = 0 for OMAP
1465          */
1466         num_iommus = of_property_count_elems_of_size(dev->of_node, "iommus",
1467                                                      sizeof(phandle));
1468         if (num_iommus < 0)
1469                 return 0;
1470
1471         arch_data = kcalloc(num_iommus + 1, sizeof(*arch_data), GFP_KERNEL);
1472         if (!arch_data)
1473                 return -ENOMEM;
1474
1475         for (i = 0, tmp = arch_data; i < num_iommus; i++, tmp++) {
1476                 np = of_parse_phandle(dev->of_node, "iommus", i);
1477                 if (!np) {
1478                         kfree(arch_data);
1479                         return -EINVAL;
1480                 }
1481
1482                 pdev = of_find_device_by_node(np);
1483                 if (WARN_ON(!pdev)) {
1484                         of_node_put(np);
1485                         kfree(arch_data);
1486                         return -EINVAL;
1487                 }
1488
1489                 oiommu = platform_get_drvdata(pdev);
1490                 if (!oiommu) {
1491                         of_node_put(np);
1492                         kfree(arch_data);
1493                         return -EINVAL;
1494                 }
1495
1496                 tmp->iommu_dev = oiommu;
1497
1498                 of_node_put(np);
1499         }
1500
1501         /*
1502          * use the first IOMMU alone for the sysfs device linking.
1503          * TODO: Evaluate if a single iommu_group needs to be
1504          * maintained for both IOMMUs
1505          */
1506         oiommu = arch_data->iommu_dev;
1507         ret = iommu_device_link(&oiommu->iommu, dev);
1508         if (ret) {
1509                 kfree(arch_data);
1510                 return ret;
1511         }
1512
1513         dev->archdata.iommu = arch_data;
1514
1515         /*
1516          * IOMMU group initialization calls into omap_iommu_device_group, which
1517          * needs a valid dev->archdata.iommu pointer
1518          */
1519         group = iommu_group_get_for_dev(dev);
1520         if (IS_ERR(group)) {
1521                 iommu_device_unlink(&oiommu->iommu, dev);
1522                 dev->archdata.iommu = NULL;
1523                 kfree(arch_data);
1524                 return PTR_ERR(group);
1525         }
1526         iommu_group_put(group);
1527
1528         return 0;
1529 }
1530
1531 static void omap_iommu_remove_device(struct device *dev)
1532 {
1533         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
1534
1535         if (!dev->of_node || !arch_data)
1536                 return;
1537
1538         iommu_device_unlink(&arch_data->iommu_dev->iommu, dev);
1539         iommu_group_remove_device(dev);
1540
1541         dev->archdata.iommu = NULL;
1542         kfree(arch_data);
1543
1544 }
1545
1546 static struct iommu_group *omap_iommu_device_group(struct device *dev)
1547 {
1548         struct omap_iommu_arch_data *arch_data = dev->archdata.iommu;
1549         struct iommu_group *group = ERR_PTR(-EINVAL);
1550
1551         if (arch_data->iommu_dev)
1552                 group = iommu_group_ref_get(arch_data->iommu_dev->group);
1553
1554         return group;
1555 }
1556
1557 static const struct iommu_ops omap_iommu_ops = {
1558         .domain_alloc   = omap_iommu_domain_alloc,
1559         .domain_free    = omap_iommu_domain_free,
1560         .attach_dev     = omap_iommu_attach_dev,
1561         .detach_dev     = omap_iommu_detach_dev,
1562         .map            = omap_iommu_map,
1563         .unmap          = omap_iommu_unmap,
1564         .iova_to_phys   = omap_iommu_iova_to_phys,
1565         .add_device     = omap_iommu_add_device,
1566         .remove_device  = omap_iommu_remove_device,
1567         .device_group   = omap_iommu_device_group,
1568         .pgsize_bitmap  = OMAP_IOMMU_PGSIZES,
1569 };
1570
1571 static int __init omap_iommu_init(void)
1572 {
1573         struct kmem_cache *p;
1574         const unsigned long flags = SLAB_HWCACHE_ALIGN;
1575         size_t align = 1 << 10; /* L2 pagetable alignement */
1576         struct device_node *np;
1577         int ret;
1578
1579         np = of_find_matching_node(NULL, omap_iommu_of_match);
1580         if (!np)
1581                 return 0;
1582
1583         of_node_put(np);
1584
1585         p = kmem_cache_create("iopte_cache", IOPTE_TABLE_SIZE, align, flags,
1586                               NULL);
1587         if (!p)
1588                 return -ENOMEM;
1589         iopte_cachep = p;
1590
1591         omap_iommu_debugfs_init();
1592
1593         ret = platform_driver_register(&omap_iommu_driver);
1594         if (ret) {
1595                 pr_err("%s: failed to register driver\n", __func__);
1596                 goto fail_driver;
1597         }
1598
1599         ret = bus_set_iommu(&platform_bus_type, &omap_iommu_ops);
1600         if (ret)
1601                 goto fail_bus;
1602
1603         return 0;
1604
1605 fail_bus:
1606         platform_driver_unregister(&omap_iommu_driver);
1607 fail_driver:
1608         kmem_cache_destroy(iopte_cachep);
1609         return ret;
1610 }
1611 subsys_initcall(omap_iommu_init);
1612 /* must be ready before omap3isp is probed */