drivers/iommu/sprd-iommu.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Unisoc IOMMU driver
   4  *
   5  * Copyright (C) 2020 Unisoc, Inc.
   6  * Author: Chunyan Zhang <chunyan.zhang@unisoc.com>
   7  */
   8
   9 #include <linux/clk.h>
  10 #include <linux/device.h>
  11 #include <linux/dma-mapping.h>
  12 #include <linux/errno.h>
  13 #include <linux/iommu.h>
  14 #include <linux/mfd/syscon.h>
  15 #include <linux/module.h>
  16 #include <linux/of_platform.h>
  17 #include <linux/regmap.h>
  18 #include <linux/slab.h>
  19
  20 #define SPRD_IOMMU_PAGE_SHIFT   12
  21 #define SPRD_IOMMU_PAGE_SIZE    SZ_4K
  22
  23 #define SPRD_EX_CFG             0x0
  24 #define SPRD_IOMMU_VAOR_BYPASS  BIT(4)
  25 #define SPRD_IOMMU_GATE_EN      BIT(1)
  26 #define SPRD_IOMMU_EN           BIT(0)
  27 #define SPRD_EX_UPDATE          0x4
  28 #define SPRD_EX_FIRST_VPN       0x8
  29 #define SPRD_EX_VPN_RANGE       0xc
  30 #define SPRD_EX_FIRST_PPN       0x10
  31 #define SPRD_EX_DEFAULT_PPN     0x14
  32
  33 #define SPRD_IOMMU_VERSION      0x0
  34 #define SPRD_VERSION_MASK       GENMASK(15, 8)
  35 #define SPRD_VERSION_SHIFT      0x8
  36 #define SPRD_VAU_CFG            0x4
  37 #define SPRD_VAU_UPDATE         0x8
  38 #define SPRD_VAU_AUTH_CFG       0xc
  39 #define SPRD_VAU_FIRST_PPN      0x10
  40 #define SPRD_VAU_DEFAULT_PPN_RD 0x14
  41 #define SPRD_VAU_DEFAULT_PPN_WR 0x18
  42 #define SPRD_VAU_FIRST_VPN      0x1c
  43 #define SPRD_VAU_VPN_RANGE      0x20
  44
  45 enum sprd_iommu_version {
  46         SPRD_IOMMU_EX,
  47         SPRD_IOMMU_VAU,
  48 };
  49
  50 /*
  51  * struct sprd_iommu_device - high-level sprd IOMMU device representation,
  52  * including hardware information and configuration, also driver data, etc
  53  *
  54  * @ver: sprd IOMMU IP version
  55  * @prot_page_va: protect page base virtual address
  56  * @prot_page_pa: protect page base physical address, data would be
  57  *                written to here while translation fault
  58  * @base: mapped base address for accessing registers
  59  * @dev: pointer to basic device structure
  60  * @iommu: IOMMU core representation
  61  * @group: IOMMU group
  62  * @eb: gate clock which controls IOMMU access
  63  */
  64 struct sprd_iommu_device {
  65         enum sprd_iommu_version ver;
  66         u32                     *prot_page_va;
  67         dma_addr_t              prot_page_pa;
  68         void __iomem            *base;
  69         struct device           *dev;
  70         struct iommu_device     iommu;
  71         struct iommu_group      *group;
  72         struct clk              *eb;
  73 };
  74
  75 struct sprd_iommu_domain {
  76         spinlock_t              pgtlock; /* lock for page table */
  77         struct iommu_domain     domain;
  78         u32                     *pgt_va; /* page table virtual address base */
  79         dma_addr_t              pgt_pa; /* page table physical address base */
  80         struct sprd_iommu_device        *sdev;
  81 };
  82
  83 static const struct iommu_ops sprd_iommu_ops;
  84
  85 static struct sprd_iommu_domain *to_sprd_domain(struct iommu_domain *dom)
  86 {
  87         return container_of(dom, struct sprd_iommu_domain, domain);
  88 }
  89
  90 static inline void
  91 sprd_iommu_write(struct sprd_iommu_device *sdev, unsigned int reg, u32 val)
  92 {
  93         writel_relaxed(val, sdev->base + reg);
  94 }
  95
  96 static inline u32
  97 sprd_iommu_read(struct sprd_iommu_device *sdev, unsigned int reg)
  98 {
  99         return readl_relaxed(sdev->base + reg);
 100 }
 101
 102 static inline void
 103 sprd_iommu_update_bits(struct sprd_iommu_device *sdev, unsigned int reg,
 104                   u32 mask, u32 shift, u32 val)
 105 {
 106         u32 t = sprd_iommu_read(sdev, reg);
 107
 108         t = (t & (~(mask << shift))) | ((val & mask) << shift);
 109         sprd_iommu_write(sdev, reg, t);
 110 }
 111
 112 static inline int
 113 sprd_iommu_get_version(struct sprd_iommu_device *sdev)
 114 {
 115         int ver = (sprd_iommu_read(sdev, SPRD_IOMMU_VERSION) &
 116                    SPRD_VERSION_MASK) >> SPRD_VERSION_SHIFT;
 117
 118         switch (ver) {
 119         case SPRD_IOMMU_EX:
 120         case SPRD_IOMMU_VAU:
 121                 return ver;
 122         default:
 123                 return -EINVAL;
 124         }
 125 }
 126
 127 static size_t
 128 sprd_iommu_pgt_size(struct iommu_domain *domain)
 129 {
 130         return ((domain->geometry.aperture_end -
 131                  domain->geometry.aperture_start + 1) >>
 132                 SPRD_IOMMU_PAGE_SHIFT) * sizeof(u32);
 133 }
 134
 135 static struct iommu_domain *sprd_iommu_domain_alloc(unsigned int domain_type)
 136 {
 137         struct sprd_iommu_domain *dom;
 138
 139         if (domain_type != IOMMU_DOMAIN_DMA && domain_type != IOMMU_DOMAIN_UNMANAGED)
 140                 return NULL;
 141
 142         dom = kzalloc(sizeof(*dom), GFP_KERNEL);
 143         if (!dom)
 144                 return NULL;
 145
 146         spin_lock_init(&dom->pgtlock);
 147
 148         dom->domain.geometry.aperture_start = 0;
 149         dom->domain.geometry.aperture_end = SZ_256M - 1;
 150
 151         return &dom->domain;
 152 }
 153
 154 static void sprd_iommu_domain_free(struct iommu_domain *domain)
 155 {
 156         struct sprd_iommu_domain *dom = to_sprd_domain(domain);
 157
 158         kfree(dom);
 159 }
 160
 161 static void sprd_iommu_first_vpn(struct sprd_iommu_domain *dom)
 162 {
 163         struct sprd_iommu_device *sdev = dom->sdev;
 164         u32 val;
 165         unsigned int reg;
 166
 167         if (sdev->ver == SPRD_IOMMU_EX)
 168                 reg = SPRD_EX_FIRST_VPN;
 169         else
 170                 reg = SPRD_VAU_FIRST_VPN;
 171
 172         val = dom->domain.geometry.aperture_start >> SPRD_IOMMU_PAGE_SHIFT;
 173         sprd_iommu_write(sdev, reg, val);
 174 }
 175
 176 static void sprd_iommu_vpn_range(struct sprd_iommu_domain *dom)
 177 {
 178         struct sprd_iommu_device *sdev = dom->sdev;
 179         u32 val;
 180         unsigned int reg;
 181
 182         if (sdev->ver == SPRD_IOMMU_EX)
 183                 reg = SPRD_EX_VPN_RANGE;
 184         else
 185                 reg = SPRD_VAU_VPN_RANGE;
 186
 187         val = (dom->domain.geometry.aperture_end -
 188                dom->domain.geometry.aperture_start) >> SPRD_IOMMU_PAGE_SHIFT;
 189         sprd_iommu_write(sdev, reg, val);
 190 }
 191
 192 static void sprd_iommu_first_ppn(struct sprd_iommu_domain *dom)
 193 {
 194         u32 val = dom->pgt_pa >> SPRD_IOMMU_PAGE_SHIFT;
 195         struct sprd_iommu_device *sdev = dom->sdev;
 196         unsigned int reg;
 197
 198         if (sdev->ver == SPRD_IOMMU_EX)
 199                 reg = SPRD_EX_FIRST_PPN;
 200         else
 201                 reg = SPRD_VAU_FIRST_PPN;
 202
 203         sprd_iommu_write(sdev, reg, val);
 204 }
 205
 206 static void sprd_iommu_default_ppn(struct sprd_iommu_device *sdev)
 207 {
 208         u32 val = sdev->prot_page_pa >> SPRD_IOMMU_PAGE_SHIFT;
 209
 210         if (sdev->ver == SPRD_IOMMU_EX) {
 211                 sprd_iommu_write(sdev, SPRD_EX_DEFAULT_PPN, val);
 212         } else if (sdev->ver == SPRD_IOMMU_VAU) {
 213                 sprd_iommu_write(sdev, SPRD_VAU_DEFAULT_PPN_RD, val);
 214                 sprd_iommu_write(sdev, SPRD_VAU_DEFAULT_PPN_WR, val);
 215         }
 216 }
 217
 218 static void sprd_iommu_hw_en(struct sprd_iommu_device *sdev, bool en)
 219 {
 220         unsigned int reg_cfg;
 221         u32 mask, val;
 222
 223         if (sdev->ver == SPRD_IOMMU_EX)
 224                 reg_cfg = SPRD_EX_CFG;
 225         else
 226                 reg_cfg = SPRD_VAU_CFG;
 227
 228         mask = SPRD_IOMMU_EN | SPRD_IOMMU_GATE_EN;
 229         val = en ? mask : 0;
 230         sprd_iommu_update_bits(sdev, reg_cfg, mask, 0, val);
 231 }
 232
 233 static int sprd_iommu_attach_device(struct iommu_domain *domain,
 234                                     struct device *dev)
 235 {
 236         struct sprd_iommu_device *sdev = dev_iommu_priv_get(dev);
 237         struct sprd_iommu_domain *dom = to_sprd_domain(domain);
 238         size_t pgt_size = sprd_iommu_pgt_size(domain);
 239
 240         if (dom->sdev)
 241                 return -EINVAL;
 242
 243         dom->pgt_va = dma_alloc_coherent(sdev->dev, pgt_size, &dom->pgt_pa, GFP_KERNEL);
 244         if (!dom->pgt_va)
 245                 return -ENOMEM;
 246
 247         dom->sdev = sdev;
 248
 249         sprd_iommu_first_ppn(dom);
 250         sprd_iommu_first_vpn(dom);
 251         sprd_iommu_vpn_range(dom);
 252         sprd_iommu_default_ppn(sdev);
 253         sprd_iommu_hw_en(sdev, true);
 254
 255         return 0;
 256 }
 257
 258 static int sprd_iommu_map(struct iommu_domain *domain, unsigned long iova,
 259                           phys_addr_t paddr, size_t pgsize, size_t pgcount,
 260                           int prot, gfp_t gfp, size_t *mapped)
 261 {
 262         struct sprd_iommu_domain *dom = to_sprd_domain(domain);
 263         size_t size = pgcount * SPRD_IOMMU_PAGE_SIZE;
 264         unsigned long flags;
 265         unsigned int i;
 266         u32 *pgt_base_iova;
 267         u32 pabase = (u32)paddr;
 268         unsigned long start = domain->geometry.aperture_start;
 269         unsigned long end = domain->geometry.aperture_end;
 270
 271         if (!dom->sdev) {
 272                 pr_err("No sprd_iommu_device attached to the domain\n");
 273                 return -EINVAL;
 274         }
 275
 276         if (iova < start || (iova + size) > (end + 1)) {
 277                 dev_err(dom->sdev->dev, "(iova(0x%lx) + size(%zx)) are not in the range!\n",
 278                         iova, size);
 279                 return -EINVAL;
 280         }
 281
 282         pgt_base_iova = dom->pgt_va + ((iova - start) >> SPRD_IOMMU_PAGE_SHIFT);
 283
 284         spin_lock_irqsave(&dom->pgtlock, flags);
 285         for (i = 0; i < pgcount; i++) {
 286                 pgt_base_iova[i] = pabase >> SPRD_IOMMU_PAGE_SHIFT;
 287                 pabase += SPRD_IOMMU_PAGE_SIZE;
 288         }
 289         spin_unlock_irqrestore(&dom->pgtlock, flags);
 290
 291         *mapped = size;
 292         return 0;
 293 }
 294
 295 static size_t sprd_iommu_unmap(struct iommu_domain *domain, unsigned long iova,
 296                                size_t pgsize, size_t pgcount,
 297                                struct iommu_iotlb_gather *iotlb_gather)
 298 {
 299         struct sprd_iommu_domain *dom = to_sprd_domain(domain);
 300         unsigned long flags;
 301         u32 *pgt_base_iova;
 302         size_t size = pgcount * SPRD_IOMMU_PAGE_SIZE;
 303         unsigned long start = domain->geometry.aperture_start;
 304         unsigned long end = domain->geometry.aperture_end;
 305
 306         if (iova < start || (iova + size) > (end + 1))
 307                 return 0;
 308
 309         pgt_base_iova = dom->pgt_va + ((iova - start) >> SPRD_IOMMU_PAGE_SHIFT);
 310
 311         spin_lock_irqsave(&dom->pgtlock, flags);
 312         memset(pgt_base_iova, 0, pgcount * sizeof(u32));
 313         spin_unlock_irqrestore(&dom->pgtlock, flags);
 314
 315         return size;
 316 }
 317
 318 static void sprd_iommu_sync_map(struct iommu_domain *domain,
 319                                 unsigned long iova, size_t size)
 320 {
 321         struct sprd_iommu_domain *dom = to_sprd_domain(domain);
 322         unsigned int reg;
 323
 324         if (dom->sdev->ver == SPRD_IOMMU_EX)
 325                 reg = SPRD_EX_UPDATE;
 326         else
 327                 reg = SPRD_VAU_UPDATE;
 328
 329         /* clear IOMMU TLB buffer after page table updated */
 330         sprd_iommu_write(dom->sdev, reg, 0xffffffff);
 331 }
 332
 333 static void sprd_iommu_sync(struct iommu_domain *domain,
 334                             struct iommu_iotlb_gather *iotlb_gather)
 335 {
 336         sprd_iommu_sync_map(domain, 0, 0);
 337 }
 338
 339 static phys_addr_t sprd_iommu_iova_to_phys(struct iommu_domain *domain,
 340                                            dma_addr_t iova)
 341 {
 342         struct sprd_iommu_domain *dom = to_sprd_domain(domain);
 343         unsigned long flags;
 344         phys_addr_t pa;
 345         unsigned long start = domain->geometry.aperture_start;
 346         unsigned long end = domain->geometry.aperture_end;
 347
 348         if (WARN_ON(iova < start || iova > end))
 349                 return 0;
 350
 351         spin_lock_irqsave(&dom->pgtlock, flags);
 352         pa = *(dom->pgt_va + ((iova - start) >> SPRD_IOMMU_PAGE_SHIFT));
 353         pa = (pa << SPRD_IOMMU_PAGE_SHIFT) + ((iova - start) & (SPRD_IOMMU_PAGE_SIZE - 1));
 354         spin_unlock_irqrestore(&dom->pgtlock, flags);
 355
 356         return pa;
 357 }
 358
 359 static struct iommu_device *sprd_iommu_probe_device(struct device *dev)
 360 {
 361         struct iommu_fwspec *fwspec = dev_iommu_fwspec_get(dev);
 362         struct sprd_iommu_device *sdev;
 363
 364         if (!fwspec || fwspec->ops != &sprd_iommu_ops)
 365                 return ERR_PTR(-ENODEV);
 366
 367         sdev = dev_iommu_priv_get(dev);
 368
 369         return &sdev->iommu;
 370 }
 371
 372 static struct iommu_group *sprd_iommu_device_group(struct device *dev)
 373 {
 374         struct sprd_iommu_device *sdev = dev_iommu_priv_get(dev);
 375
 376         return iommu_group_ref_get(sdev->group);
 377 }
 378
 379 static int sprd_iommu_of_xlate(struct device *dev, struct of_phandle_args *args)
 380 {
 381         struct platform_device *pdev;
 382
 383         if (!dev_iommu_priv_get(dev)) {
 384                 pdev = of_find_device_by_node(args->np);
 385                 dev_iommu_priv_set(dev, platform_get_drvdata(pdev));
 386                 platform_device_put(pdev);
 387         }
 388
 389         return 0;
 390 }
 391
 392
 393 static const struct iommu_ops sprd_iommu_ops = {
 394         .domain_alloc   = sprd_iommu_domain_alloc,
 395         .probe_device   = sprd_iommu_probe_device,
 396         .device_group   = sprd_iommu_device_group,
 397         .of_xlate       = sprd_iommu_of_xlate,
 398         .pgsize_bitmap  = SPRD_IOMMU_PAGE_SIZE,
 399         .owner          = THIS_MODULE,
 400         .default_domain_ops = &(const struct iommu_domain_ops) {
 401                 .attach_dev     = sprd_iommu_attach_device,
 402                 .map_pages      = sprd_iommu_map,
 403                 .unmap_pages    = sprd_iommu_unmap,
 404                 .iotlb_sync_map = sprd_iommu_sync_map,
 405                 .iotlb_sync     = sprd_iommu_sync,
 406                 .iova_to_phys   = sprd_iommu_iova_to_phys,
 407                 .free           = sprd_iommu_domain_free,
 408         }
 409 };
 410
 411 static const struct of_device_id sprd_iommu_of_match[] = {
 412         { .compatible = "sprd,iommu-v1" },
 413         { },
 414 };
 415 MODULE_DEVICE_TABLE(of, sprd_iommu_of_match);
 416
 417 /*
 418  * Clock is not required, access to some of IOMMUs is controlled by gate
 419  * clk, enabled clocks for that kind of IOMMUs before accessing.
 420  * Return 0 for success or no clocks found.
 421  */
 422 static int sprd_iommu_clk_enable(struct sprd_iommu_device *sdev)
 423 {
 424         struct clk *eb;
 425
 426         eb = devm_clk_get_optional(sdev->dev, NULL);
 427         if (!eb)
 428                 return 0;
 429
 430         if (IS_ERR(eb))
 431                 return PTR_ERR(eb);
 432
 433         sdev->eb = eb;
 434         return clk_prepare_enable(eb);
 435 }
 436
 437 static void sprd_iommu_clk_disable(struct sprd_iommu_device *sdev)
 438 {
 439         if (sdev->eb)
 440                 clk_disable_unprepare(sdev->eb);
 441 }
 442
 443 static int sprd_iommu_probe(struct platform_device *pdev)
 444 {
 445         struct sprd_iommu_device *sdev;
 446         struct device *dev = &pdev->dev;
 447         void __iomem *base;
 448         int ret;
 449
 450         sdev = devm_kzalloc(dev, sizeof(*sdev), GFP_KERNEL);
 451         if (!sdev)
 452                 return -ENOMEM;
 453
 454         base = devm_platform_ioremap_resource(pdev, 0);
 455         if (IS_ERR(base)) {
 456                 dev_err(dev, "Failed to get ioremap resource.\n");
 457                 return PTR_ERR(base);
 458         }
 459         sdev->base = base;
 460
 461         sdev->prot_page_va = dma_alloc_coherent(dev, SPRD_IOMMU_PAGE_SIZE,
 462                                                 &sdev->prot_page_pa, GFP_KERNEL);
 463         if (!sdev->prot_page_va)
 464                 return -ENOMEM;
 465
 466         platform_set_drvdata(pdev, sdev);
 467         sdev->dev = dev;
 468
 469         /* All the client devices are in the same iommu-group */
 470         sdev->group = iommu_group_alloc();
 471         if (IS_ERR(sdev->group)) {
 472                 ret = PTR_ERR(sdev->group);
 473                 goto free_page;
 474         }
 475
 476         ret = iommu_device_sysfs_add(&sdev->iommu, dev, NULL, dev_name(dev));
 477         if (ret)
 478                 goto put_group;
 479
 480         ret = iommu_device_register(&sdev->iommu, &sprd_iommu_ops, dev);
 481         if (ret)
 482                 goto remove_sysfs;
 483
 484         ret = sprd_iommu_clk_enable(sdev);
 485         if (ret)
 486                 goto unregister_iommu;
 487
 488         ret = sprd_iommu_get_version(sdev);
 489         if (ret < 0) {
 490                 dev_err(dev, "IOMMU version(%d) is invalid.\n", ret);
 491                 goto disable_clk;
 492         }
 493         sdev->ver = ret;
 494
 495         return 0;
 496
 497 disable_clk:
 498         sprd_iommu_clk_disable(sdev);
 499 unregister_iommu:
 500         iommu_device_unregister(&sdev->iommu);
 501 remove_sysfs:
 502         iommu_device_sysfs_remove(&sdev->iommu);
 503 put_group:
 504         iommu_group_put(sdev->group);
 505 free_page:
 506         dma_free_coherent(sdev->dev, SPRD_IOMMU_PAGE_SIZE, sdev->prot_page_va, sdev->prot_page_pa);
 507         return ret;
 508 }
 509
 510 static int sprd_iommu_remove(struct platform_device *pdev)
 511 {
 512         struct sprd_iommu_device *sdev = platform_get_drvdata(pdev);
 513
 514         dma_free_coherent(sdev->dev, SPRD_IOMMU_PAGE_SIZE, sdev->prot_page_va, sdev->prot_page_pa);
 515
 516         iommu_group_put(sdev->group);
 517         sdev->group = NULL;
 518
 519         platform_set_drvdata(pdev, NULL);
 520         iommu_device_sysfs_remove(&sdev->iommu);
 521         iommu_device_unregister(&sdev->iommu);
 522
 523         return 0;
 524 }
 525
 526 static struct platform_driver sprd_iommu_driver = {
 527         .driver = {
 528                 .name           = "sprd-iommu",
 529                 .of_match_table = sprd_iommu_of_match,
 530                 .suppress_bind_attrs = true,
 531         },
 532         .probe  = sprd_iommu_probe,
 533         .remove = sprd_iommu_remove,
 534 };
 535 module_platform_driver(sprd_iommu_driver);
 536
 537 MODULE_DESCRIPTION("IOMMU driver for Unisoc SoCs");
 538 MODULE_ALIAS("platform:sprd-iommu");
 539 MODULE_LICENSE("GPL");