drivers/iommu/qcom_iommu.c

   1 /*
   2  * IOMMU API for QCOM secure IOMMUs.  Somewhat based on arm-smmu.c
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  *
  16  * Copyright (C) 2013 ARM Limited
  17  * Copyright (C) 2017 Red Hat
  18  */
  19
  20 #include <linux/atomic.h>
  21 #include <linux/clk.h>
  22 #include <linux/delay.h>
  23 #include <linux/dma-iommu.h>
  24 #include <linux/dma-mapping.h>
  25 #include <linux/err.h>
  26 #include <linux/interrupt.h>
  27 #include <linux/io.h>
  28 #include <linux/io-64-nonatomic-hi-lo.h>
  29 #include <linux/iommu.h>
  30 #include <linux/iopoll.h>
  31 #include <linux/kconfig.h>
  32 #include <linux/module.h>
  33 #include <linux/mutex.h>
  34 #include <linux/of.h>
  35 #include <linux/of_address.h>
  36 #include <linux/of_device.h>
  37 #include <linux/of_iommu.h>
  38 #include <linux/platform_device.h>
  39 #include <linux/pm.h>
  40 #include <linux/pm_runtime.h>
  41 #include <linux/qcom_scm.h>
  42 #include <linux/slab.h>
  43 #include <linux/spinlock.h>
  44
  45 #include "io-pgtable.h"
  46 #include "arm-smmu-regs.h"
  47
  48 #define SMMU_INTR_SEL_NS     0x2000
  49
  50 struct qcom_iommu_ctx;
  51
  52 struct qcom_iommu_dev {
  53         /* IOMMU core code handle */
  54         struct iommu_device      iommu;
  55         struct device           *dev;
  56         struct clk              *iface_clk;
  57         struct clk              *bus_clk;
  58         void __iomem            *local_base;
  59         u32                      sec_id;
  60         u8                       num_ctxs;
  61         struct qcom_iommu_ctx   *ctxs[0];   /* indexed by asid-1 */
  62 };
  63
  64 struct qcom_iommu_ctx {
  65         struct device           *dev;
  66         void __iomem            *base;
  67         bool                     secure_init;
  68         u8                       asid;      /* asid and ctx bank # are 1:1 */
  69 };
  70
  71 struct qcom_iommu_domain {
  72         struct io_pgtable_ops   *pgtbl_ops;
  73         spinlock_t               pgtbl_lock;
  74         struct mutex             init_mutex; /* Protects iommu pointer */
  75         struct iommu_domain      domain;
  76         struct qcom_iommu_dev   *iommu;
  77 };
  78
  79 static struct qcom_iommu_domain *to_qcom_iommu_domain(struct iommu_domain *dom)
  80 {
  81         return container_of(dom, struct qcom_iommu_domain, domain);
  82 }
  83
  84 static const struct iommu_ops qcom_iommu_ops;
  85
  86 static struct qcom_iommu_dev * to_iommu(struct iommu_fwspec *fwspec)
  87 {
  88         if (!fwspec || fwspec->ops != &qcom_iommu_ops)
  89                 return NULL;
  90         return fwspec->iommu_priv;
  91 }
  92
  93 static struct qcom_iommu_ctx * to_ctx(struct iommu_fwspec *fwspec, unsigned asid)
  94 {
  95         struct qcom_iommu_dev *qcom_iommu = to_iommu(fwspec);
  96         if (!qcom_iommu)
  97                 return NULL;
  98         return qcom_iommu->ctxs[asid - 1];
  99 }
 100
 101 static inline void
 102 iommu_writel(struct qcom_iommu_ctx *ctx, unsigned reg, u32 val)
 103 {
 104         writel_relaxed(val, ctx->base + reg);
 105 }
 106
 107 static inline void
 108 iommu_writeq(struct qcom_iommu_ctx *ctx, unsigned reg, u64 val)
 109 {
 110         writeq_relaxed(val, ctx->base + reg);
 111 }
 112
 113 static inline u32
 114 iommu_readl(struct qcom_iommu_ctx *ctx, unsigned reg)
 115 {
 116         return readl_relaxed(ctx->base + reg);
 117 }
 118
 119 static inline u64
 120 iommu_readq(struct qcom_iommu_ctx *ctx, unsigned reg)
 121 {
 122         return readq_relaxed(ctx->base + reg);
 123 }
 124
 125 static void qcom_iommu_tlb_sync(void *cookie)
 126 {
 127         struct iommu_fwspec *fwspec = cookie;
 128         unsigned i;
 129
 130         for (i = 0; i < fwspec->num_ids; i++) {
 131                 struct qcom_iommu_ctx *ctx = to_ctx(fwspec, fwspec->ids[i]);
 132                 unsigned int val, ret;
 133
 134                 iommu_writel(ctx, ARM_SMMU_CB_TLBSYNC, 0);
 135
 136                 ret = readl_poll_timeout(ctx->base + ARM_SMMU_CB_TLBSTATUS, val,
 137                                          (val & 0x1) == 0, 0, 5000000);
 138                 if (ret)
 139                         dev_err(ctx->dev, "timeout waiting for TLB SYNC\n");
 140         }
 141 }
 142
 143 static void qcom_iommu_tlb_inv_context(void *cookie)
 144 {
 145         struct iommu_fwspec *fwspec = cookie;
 146         unsigned i;
 147
 148         for (i = 0; i < fwspec->num_ids; i++) {
 149                 struct qcom_iommu_ctx *ctx = to_ctx(fwspec, fwspec->ids[i]);
 150                 iommu_writel(ctx, ARM_SMMU_CB_S1_TLBIASID, ctx->asid);
 151         }
 152
 153         qcom_iommu_tlb_sync(cookie);
 154 }
 155
 156 static void qcom_iommu_tlb_inv_range_nosync(unsigned long iova, size_t size,
 157                                             size_t granule, bool leaf, void *cookie)
 158 {
 159         struct iommu_fwspec *fwspec = cookie;
 160         unsigned i, reg;
 161
 162         reg = leaf ? ARM_SMMU_CB_S1_TLBIVAL : ARM_SMMU_CB_S1_TLBIVA;
 163
 164         for (i = 0; i < fwspec->num_ids; i++) {
 165                 struct qcom_iommu_ctx *ctx = to_ctx(fwspec, fwspec->ids[i]);
 166                 size_t s = size;
 167
 168                 iova &= ~12UL;
 169                 iova |= ctx->asid;
 170                 do {
 171                         iommu_writel(ctx, reg, iova);
 172                         iova += granule;
 173                 } while (s -= granule);
 174         }
 175 }
 176
 177 static const struct iommu_gather_ops qcom_gather_ops = {
 178         .tlb_flush_all  = qcom_iommu_tlb_inv_context,
 179         .tlb_add_flush  = qcom_iommu_tlb_inv_range_nosync,
 180         .tlb_sync       = qcom_iommu_tlb_sync,
 181 };
 182
 183 static irqreturn_t qcom_iommu_fault(int irq, void *dev)
 184 {
 185         struct qcom_iommu_ctx *ctx = dev;
 186         u32 fsr, fsynr;
 187         u64 iova;
 188
 189         fsr = iommu_readl(ctx, ARM_SMMU_CB_FSR);
 190
 191         if (!(fsr & FSR_FAULT))
 192                 return IRQ_NONE;
 193
 194         fsynr = iommu_readl(ctx, ARM_SMMU_CB_FSYNR0);
 195         iova = iommu_readq(ctx, ARM_SMMU_CB_FAR);
 196
 197         dev_err_ratelimited(ctx->dev,
 198                             "Unhandled context fault: fsr=0x%x, "
 199                             "iova=0x%016llx, fsynr=0x%x, cb=%d\n",
 200                             fsr, iova, fsynr, ctx->asid);
 201
 202         iommu_writel(ctx, ARM_SMMU_CB_FSR, fsr);
 203
 204         return IRQ_HANDLED;
 205 }
 206
 207 static int qcom_iommu_init_domain(struct iommu_domain *domain,
 208                                   struct qcom_iommu_dev *qcom_iommu,
 209                                   struct iommu_fwspec *fwspec)
 210 {
 211         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 212         struct io_pgtable_ops *pgtbl_ops;
 213         struct io_pgtable_cfg pgtbl_cfg;
 214         int i, ret = 0;
 215         u32 reg;
 216
 217         mutex_lock(&qcom_domain->init_mutex);
 218         if (qcom_domain->iommu)
 219                 goto out_unlock;
 220
 221         pgtbl_cfg = (struct io_pgtable_cfg) {
 222                 .pgsize_bitmap  = qcom_iommu_ops.pgsize_bitmap,
 223                 .ias            = 32,
 224                 .oas            = 40,
 225                 .tlb            = &qcom_gather_ops,
 226                 .iommu_dev      = qcom_iommu->dev,
 227         };
 228
 229         qcom_domain->iommu = qcom_iommu;
 230         pgtbl_ops = alloc_io_pgtable_ops(ARM_32_LPAE_S1, &pgtbl_cfg, fwspec);
 231         if (!pgtbl_ops) {
 232                 dev_err(qcom_iommu->dev, "failed to allocate pagetable ops\n");
 233                 ret = -ENOMEM;
 234                 goto out_clear_iommu;
 235         }
 236
 237         /* Update the domain's page sizes to reflect the page table format */
 238         domain->pgsize_bitmap = pgtbl_cfg.pgsize_bitmap;
 239         domain->geometry.aperture_end = (1ULL << pgtbl_cfg.ias) - 1;
 240         domain->geometry.force_aperture = true;
 241
 242         for (i = 0; i < fwspec->num_ids; i++) {
 243                 struct qcom_iommu_ctx *ctx = to_ctx(fwspec, fwspec->ids[i]);
 244
 245                 if (!ctx->secure_init) {
 246                         ret = qcom_scm_restore_sec_cfg(qcom_iommu->sec_id, ctx->asid);
 247                         if (ret) {
 248                                 dev_err(qcom_iommu->dev, "secure init failed: %d\n", ret);
 249                                 goto out_clear_iommu;
 250                         }
 251                         ctx->secure_init = true;
 252                 }
 253
 254                 /* TTBRs */
 255                 iommu_writeq(ctx, ARM_SMMU_CB_TTBR0,
 256                                 pgtbl_cfg.arm_lpae_s1_cfg.ttbr[0] |
 257                                 ((u64)ctx->asid << TTBRn_ASID_SHIFT));
 258                 iommu_writeq(ctx, ARM_SMMU_CB_TTBR1,
 259                                 pgtbl_cfg.arm_lpae_s1_cfg.ttbr[1] |
 260                                 ((u64)ctx->asid << TTBRn_ASID_SHIFT));
 261
 262                 /* TTBCR */
 263                 iommu_writel(ctx, ARM_SMMU_CB_TTBCR2,
 264                                 (pgtbl_cfg.arm_lpae_s1_cfg.tcr >> 32) |
 265                                 TTBCR2_SEP_UPSTREAM);
 266                 iommu_writel(ctx, ARM_SMMU_CB_TTBCR,
 267                                 pgtbl_cfg.arm_lpae_s1_cfg.tcr);
 268
 269                 /* MAIRs (stage-1 only) */
 270                 iommu_writel(ctx, ARM_SMMU_CB_S1_MAIR0,
 271                                 pgtbl_cfg.arm_lpae_s1_cfg.mair[0]);
 272                 iommu_writel(ctx, ARM_SMMU_CB_S1_MAIR1,
 273                                 pgtbl_cfg.arm_lpae_s1_cfg.mair[1]);
 274
 275                 /* SCTLR */
 276                 reg = SCTLR_CFIE | SCTLR_CFRE | SCTLR_AFE | SCTLR_TRE |
 277                         SCTLR_M | SCTLR_S1_ASIDPNE;
 278
 279                 if (IS_ENABLED(CONFIG_BIG_ENDIAN))
 280                         reg |= SCTLR_E;
 281
 282                 iommu_writel(ctx, ARM_SMMU_CB_SCTLR, reg);
 283         }
 284
 285         mutex_unlock(&qcom_domain->init_mutex);
 286
 287         /* Publish page table ops for map/unmap */
 288         qcom_domain->pgtbl_ops = pgtbl_ops;
 289
 290         return 0;
 291
 292 out_clear_iommu:
 293         qcom_domain->iommu = NULL;
 294 out_unlock:
 295         mutex_unlock(&qcom_domain->init_mutex);
 296         return ret;
 297 }
 298
 299 static struct iommu_domain *qcom_iommu_domain_alloc(unsigned type)
 300 {
 301         struct qcom_iommu_domain *qcom_domain;
 302
 303         if (type != IOMMU_DOMAIN_UNMANAGED && type != IOMMU_DOMAIN_DMA)
 304                 return NULL;
 305         /*
 306          * Allocate the domain and initialise some of its data structures.
 307          * We can't really do anything meaningful until we've added a
 308          * master.
 309          */
 310         qcom_domain = kzalloc(sizeof(*qcom_domain), GFP_KERNEL);
 311         if (!qcom_domain)
 312                 return NULL;
 313
 314         if (type == IOMMU_DOMAIN_DMA &&
 315             iommu_get_dma_cookie(&qcom_domain->domain)) {
 316                 kfree(qcom_domain);
 317                 return NULL;
 318         }
 319
 320         mutex_init(&qcom_domain->init_mutex);
 321         spin_lock_init(&qcom_domain->pgtbl_lock);
 322
 323         return &qcom_domain->domain;
 324 }
 325
 326 static void qcom_iommu_domain_free(struct iommu_domain *domain)
 327 {
 328         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 329
 330         if (WARN_ON(qcom_domain->iommu))    /* forgot to detach? */
 331                 return;
 332
 333         iommu_put_dma_cookie(domain);
 334
 335         /* NOTE: unmap can be called after client device is powered off,
 336          * for example, with GPUs or anything involving dma-buf.  So we
 337          * cannot rely on the device_link.  Make sure the IOMMU is on to
 338          * avoid unclocked accesses in the TLB inv path:
 339          */
 340         pm_runtime_get_sync(qcom_domain->iommu->dev);
 341
 342         free_io_pgtable_ops(qcom_domain->pgtbl_ops);
 343
 344         pm_runtime_put_sync(qcom_domain->iommu->dev);
 345
 346         kfree(qcom_domain);
 347 }
 348
 349 static int qcom_iommu_attach_dev(struct iommu_domain *domain, struct device *dev)
 350 {
 351         struct qcom_iommu_dev *qcom_iommu = to_iommu(dev->iommu_fwspec);
 352         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 353         int ret;
 354
 355         if (!qcom_iommu) {
 356                 dev_err(dev, "cannot attach to IOMMU, is it on the same bus?\n");
 357                 return -ENXIO;
 358         }
 359
 360         /* Ensure that the domain is finalized */
 361         pm_runtime_get_sync(qcom_iommu->dev);
 362         ret = qcom_iommu_init_domain(domain, qcom_iommu, dev->iommu_fwspec);
 363         pm_runtime_put_sync(qcom_iommu->dev);
 364         if (ret < 0)
 365                 return ret;
 366
 367         /*
 368          * Sanity check the domain. We don't support domains across
 369          * different IOMMUs.
 370          */
 371         if (qcom_domain->iommu != qcom_iommu) {
 372                 dev_err(dev, "cannot attach to IOMMU %s while already "
 373                         "attached to domain on IOMMU %s\n",
 374                         dev_name(qcom_domain->iommu->dev),
 375                         dev_name(qcom_iommu->dev));
 376                 return -EINVAL;
 377         }
 378
 379         return 0;
 380 }
 381
 382 static void qcom_iommu_detach_dev(struct iommu_domain *domain, struct device *dev)
 383 {
 384         struct iommu_fwspec *fwspec = dev->iommu_fwspec;
 385         struct qcom_iommu_dev *qcom_iommu = to_iommu(fwspec);
 386         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 387         unsigned i;
 388
 389         if (!qcom_domain->iommu)
 390                 return;
 391
 392         pm_runtime_get_sync(qcom_iommu->dev);
 393         for (i = 0; i < fwspec->num_ids; i++) {
 394                 struct qcom_iommu_ctx *ctx = to_ctx(fwspec, fwspec->ids[i]);
 395
 396                 /* Disable the context bank: */
 397                 iommu_writel(ctx, ARM_SMMU_CB_SCTLR, 0);
 398         }
 399         pm_runtime_put_sync(qcom_iommu->dev);
 400
 401         qcom_domain->iommu = NULL;
 402 }
 403
 404 static int qcom_iommu_map(struct iommu_domain *domain, unsigned long iova,
 405                           phys_addr_t paddr, size_t size, int prot)
 406 {
 407         int ret;
 408         unsigned long flags;
 409         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 410         struct io_pgtable_ops *ops = qcom_domain->pgtbl_ops;
 411
 412         if (!ops)
 413                 return -ENODEV;
 414
 415         spin_lock_irqsave(&qcom_domain->pgtbl_lock, flags);
 416         ret = ops->map(ops, iova, paddr, size, prot);
 417         spin_unlock_irqrestore(&qcom_domain->pgtbl_lock, flags);
 418         return ret;
 419 }
 420
 421 static size_t qcom_iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 422                                size_t size)
 423 {
 424         size_t ret;
 425         unsigned long flags;
 426         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 427         struct io_pgtable_ops *ops = qcom_domain->pgtbl_ops;
 428
 429         if (!ops)
 430                 return 0;
 431
 432         /* NOTE: unmap can be called after client device is powered off,
 433          * for example, with GPUs or anything involving dma-buf.  So we
 434          * cannot rely on the device_link.  Make sure the IOMMU is on to
 435          * avoid unclocked accesses in the TLB inv path:
 436          */
 437         pm_runtime_get_sync(qcom_domain->iommu->dev);
 438         spin_lock_irqsave(&qcom_domain->pgtbl_lock, flags);
 439         ret = ops->unmap(ops, iova, size);
 440         spin_unlock_irqrestore(&qcom_domain->pgtbl_lock, flags);
 441         pm_runtime_put_sync(qcom_domain->iommu->dev);
 442
 443         return ret;
 444 }
 445
 446 static void qcom_iommu_iotlb_sync(struct iommu_domain *domain)
 447 {
 448         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 449         struct io_pgtable *pgtable = container_of(qcom_domain->pgtbl_ops,
 450                                                   struct io_pgtable, ops);
 451         if (!qcom_domain->pgtbl_ops)
 452                 return;
 453
 454         pm_runtime_get_sync(qcom_domain->iommu->dev);
 455         qcom_iommu_tlb_sync(pgtable->cookie);
 456         pm_runtime_put_sync(qcom_domain->iommu->dev);
 457 }
 458
 459 static phys_addr_t qcom_iommu_iova_to_phys(struct iommu_domain *domain,
 460                                            dma_addr_t iova)
 461 {
 462         phys_addr_t ret;
 463         unsigned long flags;
 464         struct qcom_iommu_domain *qcom_domain = to_qcom_iommu_domain(domain);
 465         struct io_pgtable_ops *ops = qcom_domain->pgtbl_ops;
 466
 467         if (!ops)
 468                 return 0;
 469
 470         spin_lock_irqsave(&qcom_domain->pgtbl_lock, flags);
 471         ret = ops->iova_to_phys(ops, iova);
 472         spin_unlock_irqrestore(&qcom_domain->pgtbl_lock, flags);
 473
 474         return ret;
 475 }
 476
 477 static bool qcom_iommu_capable(enum iommu_cap cap)
 478 {
 479         switch (cap) {
 480         case IOMMU_CAP_CACHE_COHERENCY:
 481                 /*
 482                  * Return true here as the SMMU can always send out coherent
 483                  * requests.
 484                  */
 485                 return true;
 486         case IOMMU_CAP_NOEXEC:
 487                 return true;
 488         default:
 489                 return false;
 490         }
 491 }
 492
 493 static int qcom_iommu_add_device(struct device *dev)
 494 {
 495         struct qcom_iommu_dev *qcom_iommu = to_iommu(dev->iommu_fwspec);
 496         struct iommu_group *group;
 497         struct device_link *link;
 498
 499         if (!qcom_iommu)
 500                 return -ENODEV;
 501
 502         /*
 503          * Establish the link between iommu and master, so that the
 504          * iommu gets runtime enabled/disabled as per the master's
 505          * needs.
 506          */
 507         link = device_link_add(dev, qcom_iommu->dev, DL_FLAG_PM_RUNTIME);
 508         if (!link) {
 509                 dev_err(qcom_iommu->dev, "Unable to create device link between %s and %s\n",
 510                         dev_name(qcom_iommu->dev), dev_name(dev));
 511                 return -ENODEV;
 512         }
 513
 514         group = iommu_group_get_for_dev(dev);
 515         if (IS_ERR_OR_NULL(group))
 516                 return PTR_ERR_OR_ZERO(group);
 517
 518         iommu_group_put(group);
 519         iommu_device_link(&qcom_iommu->iommu, dev);
 520
 521         return 0;
 522 }
 523
 524 static void qcom_iommu_remove_device(struct device *dev)
 525 {
 526         struct qcom_iommu_dev *qcom_iommu = to_iommu(dev->iommu_fwspec);
 527
 528         if (!qcom_iommu)
 529                 return;
 530
 531         iommu_device_unlink(&qcom_iommu->iommu, dev);
 532         iommu_group_remove_device(dev);
 533         iommu_fwspec_free(dev);
 534 }
 535
 536 static int qcom_iommu_of_xlate(struct device *dev, struct of_phandle_args *args)
 537 {
 538         struct qcom_iommu_dev *qcom_iommu;
 539         struct platform_device *iommu_pdev;
 540         unsigned asid = args->args[0];
 541
 542         if (args->args_count != 1) {
 543                 dev_err(dev, "incorrect number of iommu params found for %s "
 544                         "(found %d, expected 1)\n",
 545                         args->np->full_name, args->args_count);
 546                 return -EINVAL;
 547         }
 548
 549         iommu_pdev = of_find_device_by_node(args->np);
 550         if (WARN_ON(!iommu_pdev))
 551                 return -EINVAL;
 552
 553         qcom_iommu = platform_get_drvdata(iommu_pdev);
 554
 555         /* make sure the asid specified in dt is valid, so we don't have
 556          * to sanity check this elsewhere, since 'asid - 1' is used to
 557          * index into qcom_iommu->ctxs:
 558          */
 559         if (WARN_ON(asid < 1) ||
 560             WARN_ON(asid > qcom_iommu->num_ctxs))
 561                 return -EINVAL;
 562
 563         if (!dev->iommu_fwspec->iommu_priv) {
 564                 dev->iommu_fwspec->iommu_priv = qcom_iommu;
 565         } else {
 566                 /* make sure devices iommus dt node isn't referring to
 567                  * multiple different iommu devices.  Multiple context
 568                  * banks are ok, but multiple devices are not:
 569                  */
 570                 if (WARN_ON(qcom_iommu != dev->iommu_fwspec->iommu_priv))
 571                         return -EINVAL;
 572         }
 573
 574         return iommu_fwspec_add_ids(dev, &asid, 1);
 575 }
 576
 577 static const struct iommu_ops qcom_iommu_ops = {
 578         .capable        = qcom_iommu_capable,
 579         .domain_alloc   = qcom_iommu_domain_alloc,
 580         .domain_free    = qcom_iommu_domain_free,
 581         .attach_dev     = qcom_iommu_attach_dev,
 582         .detach_dev     = qcom_iommu_detach_dev,
 583         .map            = qcom_iommu_map,
 584         .unmap          = qcom_iommu_unmap,
 585         .map_sg         = default_iommu_map_sg,
 586         .flush_iotlb_all = qcom_iommu_iotlb_sync,
 587         .iotlb_sync     = qcom_iommu_iotlb_sync,
 588         .iova_to_phys   = qcom_iommu_iova_to_phys,
 589         .add_device     = qcom_iommu_add_device,
 590         .remove_device  = qcom_iommu_remove_device,
 591         .device_group   = generic_device_group,
 592         .of_xlate       = qcom_iommu_of_xlate,
 593         .pgsize_bitmap  = SZ_4K | SZ_64K | SZ_1M | SZ_16M,
 594 };
 595
 596 static int qcom_iommu_enable_clocks(struct qcom_iommu_dev *qcom_iommu)
 597 {
 598         int ret;
 599
 600         ret = clk_prepare_enable(qcom_iommu->iface_clk);
 601         if (ret) {
 602                 dev_err(qcom_iommu->dev, "Couldn't enable iface_clk\n");
 603                 return ret;
 604         }
 605
 606         ret = clk_prepare_enable(qcom_iommu->bus_clk);
 607         if (ret) {
 608                 dev_err(qcom_iommu->dev, "Couldn't enable bus_clk\n");
 609                 clk_disable_unprepare(qcom_iommu->iface_clk);
 610                 return ret;
 611         }
 612
 613         return 0;
 614 }
 615
 616 static void qcom_iommu_disable_clocks(struct qcom_iommu_dev *qcom_iommu)
 617 {
 618         clk_disable_unprepare(qcom_iommu->bus_clk);
 619         clk_disable_unprepare(qcom_iommu->iface_clk);
 620 }
 621
 622 static int qcom_iommu_sec_ptbl_init(struct device *dev)
 623 {
 624         size_t psize = 0;
 625         unsigned int spare = 0;
 626         void *cpu_addr;
 627         dma_addr_t paddr;
 628         unsigned long attrs;
 629         static bool allocated = false;
 630         int ret;
 631
 632         if (allocated)
 633                 return 0;
 634
 635         ret = qcom_scm_iommu_secure_ptbl_size(spare, &psize);
 636         if (ret) {
 637                 dev_err(dev, "failed to get iommu secure pgtable size (%d)\n",
 638                         ret);
 639                 return ret;
 640         }
 641
 642         dev_info(dev, "iommu sec: pgtable size: %zu\n", psize);
 643
 644         attrs = DMA_ATTR_NO_KERNEL_MAPPING;
 645
 646         cpu_addr = dma_alloc_attrs(dev, psize, &paddr, GFP_KERNEL, attrs);
 647         if (!cpu_addr) {
 648                 dev_err(dev, "failed to allocate %zu bytes for pgtable\n",
 649                         psize);
 650                 return -ENOMEM;
 651         }
 652
 653         ret = qcom_scm_iommu_secure_ptbl_init(paddr, psize, spare);
 654         if (ret) {
 655                 dev_err(dev, "failed to init iommu pgtable (%d)\n", ret);
 656                 goto free_mem;
 657         }
 658
 659         allocated = true;
 660         return 0;
 661
 662 free_mem:
 663         dma_free_attrs(dev, psize, cpu_addr, paddr, attrs);
 664         return ret;
 665 }
 666
 667 static int get_asid(const struct device_node *np)
 668 {
 669         u32 reg;
 670
 671         /* read the "reg" property directly to get the relative address
 672          * of the context bank, and calculate the asid from that:
 673          */
 674         if (of_property_read_u32_index(np, "reg", 0, &reg))
 675                 return -ENODEV;
 676
 677         return reg / 0x1000;      /* context banks are 0x1000 apart */
 678 }
 679
 680 static int qcom_iommu_ctx_probe(struct platform_device *pdev)
 681 {
 682         struct qcom_iommu_ctx *ctx;
 683         struct device *dev = &pdev->dev;
 684         struct qcom_iommu_dev *qcom_iommu = dev_get_drvdata(dev->parent);
 685         struct resource *res;
 686         int ret, irq;
 687
 688         ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
 689         if (!ctx)
 690                 return -ENOMEM;
 691
 692         ctx->dev = dev;
 693         platform_set_drvdata(pdev, ctx);
 694
 695         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 696         ctx->base = devm_ioremap_resource(dev, res);
 697         if (IS_ERR(ctx->base))
 698                 return PTR_ERR(ctx->base);
 699
 700         irq = platform_get_irq(pdev, 0);
 701         if (irq < 0) {
 702                 dev_err(dev, "failed to get irq\n");
 703                 return -ENODEV;
 704         }
 705
 706         /* clear IRQs before registering fault handler, just in case the
 707          * boot-loader left us a surprise:
 708          */
 709         iommu_writel(ctx, ARM_SMMU_CB_FSR, iommu_readl(ctx, ARM_SMMU_CB_FSR));
 710
 711         ret = devm_request_irq(dev, irq,
 712                                qcom_iommu_fault,
 713                                IRQF_SHARED,
 714                                "qcom-iommu-fault",
 715                                ctx);
 716         if (ret) {
 717                 dev_err(dev, "failed to request IRQ %u\n", irq);
 718                 return ret;
 719         }
 720
 721         ret = get_asid(dev->of_node);
 722         if (ret < 0) {
 723                 dev_err(dev, "missing reg property\n");
 724                 return ret;
 725         }
 726
 727         ctx->asid = ret;
 728
 729         dev_dbg(dev, "found asid %u\n", ctx->asid);
 730
 731         qcom_iommu->ctxs[ctx->asid - 1] = ctx;
 732
 733         return 0;
 734 }
 735
 736 static int qcom_iommu_ctx_remove(struct platform_device *pdev)
 737 {
 738         struct qcom_iommu_dev *qcom_iommu = dev_get_drvdata(pdev->dev.parent);
 739         struct qcom_iommu_ctx *ctx = platform_get_drvdata(pdev);
 740
 741         platform_set_drvdata(pdev, NULL);
 742
 743         qcom_iommu->ctxs[ctx->asid - 1] = NULL;
 744
 745         return 0;
 746 }
 747
 748 static const struct of_device_id ctx_of_match[] = {
 749         { .compatible = "qcom,msm-iommu-v1-ns" },
 750         { .compatible = "qcom,msm-iommu-v1-sec" },
 751         { /* sentinel */ }
 752 };
 753
 754 static struct platform_driver qcom_iommu_ctx_driver = {
 755         .driver = {
 756                 .name           = "qcom-iommu-ctx",
 757                 .of_match_table = of_match_ptr(ctx_of_match),
 758         },
 759         .probe  = qcom_iommu_ctx_probe,
 760         .remove = qcom_iommu_ctx_remove,
 761 };
 762
 763 static bool qcom_iommu_has_secure_context(struct qcom_iommu_dev *qcom_iommu)
 764 {
 765         struct device_node *child;
 766
 767         for_each_child_of_node(qcom_iommu->dev->of_node, child)
 768                 if (of_device_is_compatible(child, "qcom,msm-iommu-v1-sec"))
 769                         return true;
 770
 771         return false;
 772 }
 773
 774 static int qcom_iommu_device_probe(struct platform_device *pdev)
 775 {
 776         struct device_node *child;
 777         struct qcom_iommu_dev *qcom_iommu;
 778         struct device *dev = &pdev->dev;
 779         struct resource *res;
 780         int ret, sz, max_asid = 0;
 781
 782         /* find the max asid (which is 1:1 to ctx bank idx), so we know how
 783          * many child ctx devices we have:
 784          */
 785         for_each_child_of_node(dev->of_node, child)
 786                 max_asid = max(max_asid, get_asid(child));
 787
 788         sz = sizeof(*qcom_iommu) + (max_asid * sizeof(qcom_iommu->ctxs[0]));
 789
 790         qcom_iommu = devm_kzalloc(dev, sz, GFP_KERNEL);
 791         if (!qcom_iommu)
 792                 return -ENOMEM;
 793         qcom_iommu->num_ctxs = max_asid;
 794         qcom_iommu->dev = dev;
 795
 796         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 797         if (res)
 798                 qcom_iommu->local_base = devm_ioremap_resource(dev, res);
 799
 800         qcom_iommu->iface_clk = devm_clk_get(dev, "iface");
 801         if (IS_ERR(qcom_iommu->iface_clk)) {
 802                 dev_err(dev, "failed to get iface clock\n");
 803                 return PTR_ERR(qcom_iommu->iface_clk);
 804         }
 805
 806         qcom_iommu->bus_clk = devm_clk_get(dev, "bus");
 807         if (IS_ERR(qcom_iommu->bus_clk)) {
 808                 dev_err(dev, "failed to get bus clock\n");
 809                 return PTR_ERR(qcom_iommu->bus_clk);
 810         }
 811
 812         if (of_property_read_u32(dev->of_node, "qcom,iommu-secure-id",
 813                                  &qcom_iommu->sec_id)) {
 814                 dev_err(dev, "missing qcom,iommu-secure-id property\n");
 815                 return -ENODEV;
 816         }
 817
 818         if (qcom_iommu_has_secure_context(qcom_iommu)) {
 819                 ret = qcom_iommu_sec_ptbl_init(dev);
 820                 if (ret) {
 821                         dev_err(dev, "cannot init secure pg table(%d)\n", ret);
 822                         return ret;
 823                 }
 824         }
 825
 826         platform_set_drvdata(pdev, qcom_iommu);
 827
 828         pm_runtime_enable(dev);
 829
 830         /* register context bank devices, which are child nodes: */
 831         ret = devm_of_platform_populate(dev);
 832         if (ret) {
 833                 dev_err(dev, "Failed to populate iommu contexts\n");
 834                 return ret;
 835         }
 836
 837         ret = iommu_device_sysfs_add(&qcom_iommu->iommu, dev, NULL,
 838                                      dev_name(dev));
 839         if (ret) {
 840                 dev_err(dev, "Failed to register iommu in sysfs\n");
 841                 return ret;
 842         }
 843
 844         iommu_device_set_ops(&qcom_iommu->iommu, &qcom_iommu_ops);
 845         iommu_device_set_fwnode(&qcom_iommu->iommu, dev->fwnode);
 846
 847         ret = iommu_device_register(&qcom_iommu->iommu);
 848         if (ret) {
 849                 dev_err(dev, "Failed to register iommu\n");
 850                 return ret;
 851         }
 852
 853         bus_set_iommu(&platform_bus_type, &qcom_iommu_ops);
 854
 855         if (qcom_iommu->local_base) {
 856                 pm_runtime_get_sync(dev);
 857                 writel_relaxed(0xffffffff, qcom_iommu->local_base + SMMU_INTR_SEL_NS);
 858                 pm_runtime_put_sync(dev);
 859         }
 860
 861         return 0;
 862 }
 863
 864 static int qcom_iommu_device_remove(struct platform_device *pdev)
 865 {
 866         struct qcom_iommu_dev *qcom_iommu = platform_get_drvdata(pdev);
 867
 868         bus_set_iommu(&platform_bus_type, NULL);
 869
 870         pm_runtime_force_suspend(&pdev->dev);
 871         platform_set_drvdata(pdev, NULL);
 872         iommu_device_sysfs_remove(&qcom_iommu->iommu);
 873         iommu_device_unregister(&qcom_iommu->iommu);
 874
 875         return 0;
 876 }
 877
 878 static int __maybe_unused qcom_iommu_resume(struct device *dev)
 879 {
 880         struct platform_device *pdev = to_platform_device(dev);
 881         struct qcom_iommu_dev *qcom_iommu = platform_get_drvdata(pdev);
 882
 883         return qcom_iommu_enable_clocks(qcom_iommu);
 884 }
 885
 886 static int __maybe_unused qcom_iommu_suspend(struct device *dev)
 887 {
 888         struct platform_device *pdev = to_platform_device(dev);
 889         struct qcom_iommu_dev *qcom_iommu = platform_get_drvdata(pdev);
 890
 891         qcom_iommu_disable_clocks(qcom_iommu);
 892
 893         return 0;
 894 }
 895
 896 static const struct dev_pm_ops qcom_iommu_pm_ops = {
 897         SET_RUNTIME_PM_OPS(qcom_iommu_suspend, qcom_iommu_resume, NULL)
 898         SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
 899                                 pm_runtime_force_resume)
 900 };
 901
 902 static const struct of_device_id qcom_iommu_of_match[] = {
 903         { .compatible = "qcom,msm-iommu-v1" },
 904         { /* sentinel */ }
 905 };
 906 MODULE_DEVICE_TABLE(of, qcom_iommu_of_match);
 907
 908 static struct platform_driver qcom_iommu_driver = {
 909         .driver = {
 910                 .name           = "qcom-iommu",
 911                 .of_match_table = of_match_ptr(qcom_iommu_of_match),
 912                 .pm             = &qcom_iommu_pm_ops,
 913         },
 914         .probe  = qcom_iommu_device_probe,
 915         .remove = qcom_iommu_device_remove,
 916 };
 917
 918 static int __init qcom_iommu_init(void)
 919 {
 920         int ret;
 921
 922         ret = platform_driver_register(&qcom_iommu_ctx_driver);
 923         if (ret)
 924                 return ret;
 925
 926         ret = platform_driver_register(&qcom_iommu_driver);
 927         if (ret)
 928                 platform_driver_unregister(&qcom_iommu_ctx_driver);
 929
 930         return ret;
 931 }
 932
 933 static void __exit qcom_iommu_exit(void)
 934 {
 935         platform_driver_unregister(&qcom_iommu_driver);
 936         platform_driver_unregister(&qcom_iommu_ctx_driver);
 937 }
 938
 939 module_init(qcom_iommu_init);
 940 module_exit(qcom_iommu_exit);
 941
 942 IOMMU_OF_DECLARE(qcom_iommu_dev, "qcom,msm-iommu-v1", NULL);
 943
 944 MODULE_DESCRIPTION("IOMMU API for QCOM IOMMU v1 implementations");
 945 MODULE_LICENSE("GPL v2");