drivers/iommu/rockchip-iommu.c

   1 /*
   2  * This program is free software; you can redistribute it and/or modify
   3  * it under the terms of the GNU General Public License version 2 as
   4  * published by the Free Software Foundation.
   5  */
   6
   7 #include <asm/cacheflush.h>
   8 #include <asm/pgtable.h>
   9 #include <linux/compiler.h>
  10 #include <linux/delay.h>
  11 #include <linux/device.h>
  12 #include <linux/errno.h>
  13 #include <linux/interrupt.h>
  14 #include <linux/io.h>
  15 #include <linux/iommu.h>
  16 #include <linux/jiffies.h>
  17 #include <linux/list.h>
  18 #include <linux/mm.h>
  19 #include <linux/module.h>
  20 #include <linux/of.h>
  21 #include <linux/of_platform.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/slab.h>
  24 #include <linux/spinlock.h>
  25
  26 /** MMU register offsets */
  27 #define RK_MMU_DTE_ADDR         0x00    /* Directory table address */
  28 #define RK_MMU_STATUS           0x04
  29 #define RK_MMU_COMMAND          0x08
  30 #define RK_MMU_PAGE_FAULT_ADDR  0x0C    /* IOVA of last page fault */
  31 #define RK_MMU_ZAP_ONE_LINE     0x10    /* Shootdown one IOTLB entry */
  32 #define RK_MMU_INT_RAWSTAT      0x14    /* IRQ status ignoring mask */
  33 #define RK_MMU_INT_CLEAR        0x18    /* Acknowledge and re-arm irq */
  34 #define RK_MMU_INT_MASK         0x1C    /* IRQ enable */
  35 #define RK_MMU_INT_STATUS       0x20    /* IRQ status after masking */
  36 #define RK_MMU_AUTO_GATING      0x24
  37
  38 #define DTE_ADDR_DUMMY          0xCAFEBABE
  39 #define FORCE_RESET_TIMEOUT     100     /* ms */
  40
  41 /* RK_MMU_STATUS fields */
  42 #define RK_MMU_STATUS_PAGING_ENABLED       BIT(0)
  43 #define RK_MMU_STATUS_PAGE_FAULT_ACTIVE    BIT(1)
  44 #define RK_MMU_STATUS_STALL_ACTIVE         BIT(2)
  45 #define RK_MMU_STATUS_IDLE                 BIT(3)
  46 #define RK_MMU_STATUS_REPLAY_BUFFER_EMPTY  BIT(4)
  47 #define RK_MMU_STATUS_PAGE_FAULT_IS_WRITE  BIT(5)
  48 #define RK_MMU_STATUS_STALL_NOT_ACTIVE     BIT(31)
  49
  50 /* RK_MMU_COMMAND command values */
  51 #define RK_MMU_CMD_ENABLE_PAGING    0  /* Enable memory translation */
  52 #define RK_MMU_CMD_DISABLE_PAGING   1  /* Disable memory translation */
  53 #define RK_MMU_CMD_ENABLE_STALL     2  /* Stall paging to allow other cmds */
  54 #define RK_MMU_CMD_DISABLE_STALL    3  /* Stop stall re-enables paging */
  55 #define RK_MMU_CMD_ZAP_CACHE        4  /* Shoot down entire IOTLB */
  56 #define RK_MMU_CMD_PAGE_FAULT_DONE  5  /* Clear page fault */
  57 #define RK_MMU_CMD_FORCE_RESET      6  /* Reset all registers */
  58
  59 /* RK_MMU_INT_* register fields */
  60 #define RK_MMU_IRQ_PAGE_FAULT    0x01  /* page fault */
  61 #define RK_MMU_IRQ_BUS_ERROR     0x02  /* bus read error */
  62 #define RK_MMU_IRQ_MASK          (RK_MMU_IRQ_PAGE_FAULT | RK_MMU_IRQ_BUS_ERROR)
  63
  64 #define NUM_DT_ENTRIES 1024
  65 #define NUM_PT_ENTRIES 1024
  66
  67 #define SPAGE_ORDER 12
  68 #define SPAGE_SIZE (1 << SPAGE_ORDER)
  69
  70  /*
  71   * Support mapping any size that fits in one page table:
  72   *   4 KiB to 4 MiB
  73   */
  74 #define RK_IOMMU_PGSIZE_BITMAP 0x007ff000
  75
  76 #define IOMMU_REG_POLL_COUNT_FAST 1000
  77
  78 struct rk_iommu_domain {
  79         struct list_head iommus;
  80         u32 *dt; /* page directory table */
  81         spinlock_t iommus_lock; /* lock for iommus list */
  82         spinlock_t dt_lock; /* lock for modifying page directory table */
  83
  84         struct iommu_domain domain;
  85 };
  86
  87 struct rk_iommu {
  88         struct device *dev;
  89         void __iomem **bases;
  90         int num_mmu;
  91         int irq;
  92         struct list_head node; /* entry in rk_iommu_domain.iommus */
  93         struct iommu_domain *domain; /* domain to which iommu is attached */
  94 };
  95
  96 static inline void rk_table_flush(u32 *va, unsigned int count)
  97 {
  98 #if defined(CONFIG_ARM)
  99         phys_addr_t pa_start = virt_to_phys(va);
 100         phys_addr_t pa_end = virt_to_phys(va + count);
 101         size_t size = pa_end - pa_start;
 102
 103         __cpuc_flush_dcache_area(va, size);
 104         outer_flush_range(pa_start, pa_end);
 105 #elif defined(CONFIG_ARM64)
 106         __dma_flush_range(va, va + count);
 107 #endif
 108 }
 109
 110 static struct rk_iommu_domain *to_rk_domain(struct iommu_domain *dom)
 111 {
 112         return container_of(dom, struct rk_iommu_domain, domain);
 113 }
 114
 115 /**
 116  * Inspired by _wait_for in intel_drv.h
 117  * This is NOT safe for use in interrupt context.
 118  *
 119  * Note that it's important that we check the condition again after having
 120  * timed out, since the timeout could be due to preemption or similar and
 121  * we've never had a chance to check the condition before the timeout.
 122  */
 123 #define rk_wait_for(COND, MS) ({ \
 124         unsigned long timeout__ = jiffies + msecs_to_jiffies(MS) + 1;   \
 125         int ret__ = 0;                                                  \
 126         while (!(COND)) {                                               \
 127                 if (time_after(jiffies, timeout__)) {                   \
 128                         ret__ = (COND) ? 0 : -ETIMEDOUT;                \
 129                         break;                                          \
 130                 }                                                       \
 131                 usleep_range(50, 100);                                  \
 132         }                                                               \
 133         ret__;                                                          \
 134 })
 135
 136 /*
 137  * The Rockchip rk3288 iommu uses a 2-level page table.
 138  * The first level is the "Directory Table" (DT).
 139  * The DT consists of 1024 4-byte Directory Table Entries (DTEs), each pointing
 140  * to a "Page Table".
 141  * The second level is the 1024 Page Tables (PT).
 142  * Each PT consists of 1024 4-byte Page Table Entries (PTEs), each pointing to
 143  * a 4 KB page of physical memory.
 144  *
 145  * The DT and each PT fits in a single 4 KB page (4-bytes * 1024 entries).
 146  * Each iommu device has a MMU_DTE_ADDR register that contains the physical
 147  * address of the start of the DT page.
 148  *
 149  * The structure of the page table is as follows:
 150  *
 151  *                   DT
 152  * MMU_DTE_ADDR -> +-----+
 153  *                 |     |
 154  *                 +-----+     PT
 155  *                 | DTE | -> +-----+
 156  *                 +-----+    |     |     Memory
 157  *                 |     |    +-----+     Page
 158  *                 |     |    | PTE | -> +-----+
 159  *                 +-----+    +-----+    |     |
 160  *                            |     |    |     |
 161  *                            |     |    |     |
 162  *                            +-----+    |     |
 163  *                                       |     |
 164  *                                       |     |
 165  *                                       +-----+
 166  */
 167
 168 /*
 169  * Each DTE has a PT address and a valid bit:
 170  * +---------------------+-----------+-+
 171  * | PT address          | Reserved  |V|
 172  * +---------------------+-----------+-+
 173  *  31:12 - PT address (PTs always starts on a 4 KB boundary)
 174  *  11: 1 - Reserved
 175  *      0 - 1 if PT @ PT address is valid
 176  */
 177 #define RK_DTE_PT_ADDRESS_MASK    0xfffff000
 178 #define RK_DTE_PT_VALID           BIT(0)
 179
 180 static inline phys_addr_t rk_dte_pt_address(u32 dte)
 181 {
 182         return (phys_addr_t)dte & RK_DTE_PT_ADDRESS_MASK;
 183 }
 184
 185 static inline bool rk_dte_is_pt_valid(u32 dte)
 186 {
 187         return dte & RK_DTE_PT_VALID;
 188 }
 189
 190 static u32 rk_mk_dte(u32 *pt)
 191 {
 192         phys_addr_t pt_phys = virt_to_phys(pt);
 193         return (pt_phys & RK_DTE_PT_ADDRESS_MASK) | RK_DTE_PT_VALID;
 194 }
 195
 196 /*
 197  * Each PTE has a Page address, some flags and a valid bit:
 198  * +---------------------+---+-------+-+
 199  * | Page address        |Rsv| Flags |V|
 200  * +---------------------+---+-------+-+
 201  *  31:12 - Page address (Pages always start on a 4 KB boundary)
 202  *  11: 9 - Reserved
 203  *   8: 1 - Flags
 204  *      8 - Read allocate - allocate cache space on read misses
 205  *      7 - Read cache - enable cache & prefetch of data
 206  *      6 - Write buffer - enable delaying writes on their way to memory
 207  *      5 - Write allocate - allocate cache space on write misses
 208  *      4 - Write cache - different writes can be merged together
 209  *      3 - Override cache attributes
 210  *          if 1, bits 4-8 control cache attributes
 211  *          if 0, the system bus defaults are used
 212  *      2 - Writable
 213  *      1 - Readable
 214  *      0 - 1 if Page @ Page address is valid
 215  */
 216 #define RK_PTE_PAGE_ADDRESS_MASK  0xfffff000
 217 #define RK_PTE_PAGE_FLAGS_MASK    0x000001fe
 218 #define RK_PTE_PAGE_WRITABLE      BIT(2)
 219 #define RK_PTE_PAGE_READABLE      BIT(1)
 220 #define RK_PTE_PAGE_VALID         BIT(0)
 221
 222 static inline phys_addr_t rk_pte_page_address(u32 pte)
 223 {
 224         return (phys_addr_t)pte & RK_PTE_PAGE_ADDRESS_MASK;
 225 }
 226
 227 static inline bool rk_pte_is_page_valid(u32 pte)
 228 {
 229         return pte & RK_PTE_PAGE_VALID;
 230 }
 231
 232 /* TODO: set cache flags per prot IOMMU_CACHE */
 233 static u32 rk_mk_pte(phys_addr_t page, int prot)
 234 {
 235         u32 flags = 0;
 236         flags |= (prot & IOMMU_READ) ? RK_PTE_PAGE_READABLE : 0;
 237         flags |= (prot & IOMMU_WRITE) ? RK_PTE_PAGE_WRITABLE : 0;
 238         page &= RK_PTE_PAGE_ADDRESS_MASK;
 239         return page | flags | RK_PTE_PAGE_VALID;
 240 }
 241
 242 static u32 rk_mk_pte_invalid(u32 pte)
 243 {
 244         return pte & ~RK_PTE_PAGE_VALID;
 245 }
 246
 247 /*
 248  * rk3288 iova (IOMMU Virtual Address) format
 249  *  31       22.21       12.11          0
 250  * +-----------+-----------+-------------+
 251  * | DTE index | PTE index | Page offset |
 252  * +-----------+-----------+-------------+
 253  *  31:22 - DTE index   - index of DTE in DT
 254  *  21:12 - PTE index   - index of PTE in PT @ DTE.pt_address
 255  *  11: 0 - Page offset - offset into page @ PTE.page_address
 256  */
 257 #define RK_IOVA_DTE_MASK    0xffc00000
 258 #define RK_IOVA_DTE_SHIFT   22
 259 #define RK_IOVA_PTE_MASK    0x003ff000
 260 #define RK_IOVA_PTE_SHIFT   12
 261 #define RK_IOVA_PAGE_MASK   0x00000fff
 262 #define RK_IOVA_PAGE_SHIFT  0
 263
 264 static u32 rk_iova_dte_index(dma_addr_t iova)
 265 {
 266         return (u32)(iova & RK_IOVA_DTE_MASK) >> RK_IOVA_DTE_SHIFT;
 267 }
 268
 269 static u32 rk_iova_pte_index(dma_addr_t iova)
 270 {
 271         return (u32)(iova & RK_IOVA_PTE_MASK) >> RK_IOVA_PTE_SHIFT;
 272 }
 273
 274 static u32 rk_iova_page_offset(dma_addr_t iova)
 275 {
 276         return (u32)(iova & RK_IOVA_PAGE_MASK) >> RK_IOVA_PAGE_SHIFT;
 277 }
 278
 279 static u32 rk_iommu_read(void __iomem *base, u32 offset)
 280 {
 281         return readl(base + offset);
 282 }
 283
 284 static void rk_iommu_write(void __iomem *base, u32 offset, u32 value)
 285 {
 286         writel(value, base + offset);
 287 }
 288
 289 static void rk_iommu_command(struct rk_iommu *iommu, u32 command)
 290 {
 291         int i;
 292
 293         for (i = 0; i < iommu->num_mmu; i++)
 294                 writel(command, iommu->bases[i] + RK_MMU_COMMAND);
 295 }
 296
 297 static void rk_iommu_base_command(void __iomem *base, u32 command)
 298 {
 299         writel(command, base + RK_MMU_COMMAND);
 300 }
 301 static void rk_iommu_zap_lines(struct rk_iommu *iommu, dma_addr_t iova,
 302                                size_t size)
 303 {
 304         int i;
 305
 306         dma_addr_t iova_end = iova + size;
 307         /*
 308          * TODO(djkurtz): Figure out when it is more efficient to shootdown the
 309          * entire iotlb rather than iterate over individual iovas.
 310          */
 311         for (i = 0; i < iommu->num_mmu; i++)
 312                 for (; iova < iova_end; iova += SPAGE_SIZE)
 313                         rk_iommu_write(iommu->bases[i], RK_MMU_ZAP_ONE_LINE, iova);
 314 }
 315
 316 static bool rk_iommu_is_stall_active(struct rk_iommu *iommu)
 317 {
 318         u32 active = RK_MMU_STATUS_STALL_ACTIVE;
 319         int i;
 320
 321         for (i = 0; i < iommu->num_mmu; i++)
 322                 active &= rk_iommu_read(iommu->bases[i], RK_MMU_STATUS);
 323
 324         return active;
 325 }
 326
 327 static bool rk_iommu_is_paging_enabled(struct rk_iommu *iommu)
 328 {
 329         u32 enable = RK_MMU_STATUS_PAGING_ENABLED;
 330         int i;
 331
 332         for (i = 0; i < iommu->num_mmu; i++)
 333                 enable &= rk_iommu_read(iommu->bases[i], RK_MMU_STATUS);
 334
 335         return enable;
 336 }
 337
 338 static int rk_iommu_enable_stall(struct rk_iommu *iommu)
 339 {
 340         int ret, i;
 341
 342         if (rk_iommu_is_stall_active(iommu))
 343                 return 0;
 344
 345         /* Stall can only be enabled if paging is enabled */
 346         if (!rk_iommu_is_paging_enabled(iommu))
 347                 return 0;
 348
 349         rk_iommu_command(iommu, RK_MMU_CMD_ENABLE_STALL);
 350
 351         ret = rk_wait_for(rk_iommu_is_stall_active(iommu), 1);
 352         if (ret)
 353                 for (i = 0; i < iommu->num_mmu; i++)
 354                         dev_err(iommu->dev, "Enable stall request timed out, status: %#08x\n",
 355                                 rk_iommu_read(iommu->bases[i], RK_MMU_STATUS));
 356
 357         return ret;
 358 }
 359
 360 static int rk_iommu_disable_stall(struct rk_iommu *iommu)
 361 {
 362         int ret, i;
 363
 364         if (!rk_iommu_is_stall_active(iommu))
 365                 return 0;
 366
 367         rk_iommu_command(iommu, RK_MMU_CMD_DISABLE_STALL);
 368
 369         ret = rk_wait_for(!rk_iommu_is_stall_active(iommu), 1);
 370         if (ret)
 371                 for (i = 0; i < iommu->num_mmu; i++)
 372                         dev_err(iommu->dev, "Disable stall request timed out, status: %#08x\n",
 373                                 rk_iommu_read(iommu->bases[i], RK_MMU_STATUS));
 374
 375         return ret;
 376 }
 377
 378 static int rk_iommu_enable_paging(struct rk_iommu *iommu)
 379 {
 380         int ret, i;
 381
 382         if (rk_iommu_is_paging_enabled(iommu))
 383                 return 0;
 384
 385         rk_iommu_command(iommu, RK_MMU_CMD_ENABLE_PAGING);
 386
 387         ret = rk_wait_for(rk_iommu_is_paging_enabled(iommu), 1);
 388         if (ret)
 389                 for (i = 0; i < iommu->num_mmu; i++)
 390                         dev_err(iommu->dev, "Enable paging request timed out, status: %#08x\n",
 391                                 rk_iommu_read(iommu->bases[i], RK_MMU_STATUS));
 392
 393         return ret;
 394 }
 395
 396 static int rk_iommu_disable_paging(struct rk_iommu *iommu)
 397 {
 398         int ret, i;
 399
 400         if (!rk_iommu_is_paging_enabled(iommu))
 401                 return 0;
 402
 403         rk_iommu_command(iommu, RK_MMU_CMD_DISABLE_PAGING);
 404
 405         ret = rk_wait_for(!rk_iommu_is_paging_enabled(iommu), 1);
 406         if (ret)
 407                 for (i = 0; i < iommu->num_mmu; i++)
 408                         dev_err(iommu->dev, "Disable paging request timed out, status: %#08x\n",
 409                                 rk_iommu_read(iommu->bases[i], RK_MMU_STATUS));
 410
 411         return ret;
 412 }
 413
 414 static int rk_iommu_force_reset(struct rk_iommu *iommu)
 415 {
 416         int ret, i;
 417         u32 dte_addr;
 418
 419         /*
 420          * Check if register DTE_ADDR is working by writing DTE_ADDR_DUMMY
 421          * and verifying that upper 5 nybbles are read back.
 422          */
 423         for (i = 0; i < iommu->num_mmu; i++) {
 424                 rk_iommu_write(iommu->bases[i], RK_MMU_DTE_ADDR, DTE_ADDR_DUMMY);
 425
 426                 dte_addr = rk_iommu_read(iommu->bases[i], RK_MMU_DTE_ADDR);
 427                 if (dte_addr != (DTE_ADDR_DUMMY & RK_DTE_PT_ADDRESS_MASK)) {
 428                         dev_err(iommu->dev, "Error during raw reset. MMU_DTE_ADDR is not functioning\n");
 429                         return -EFAULT;
 430                 }
 431         }
 432
 433         rk_iommu_command(iommu, RK_MMU_CMD_FORCE_RESET);
 434
 435         for (i = 0; i < iommu->num_mmu; i++) {
 436                 ret = rk_wait_for(rk_iommu_read(iommu->bases[i], RK_MMU_DTE_ADDR) == 0x00000000,
 437                                   FORCE_RESET_TIMEOUT);
 438                 if (ret) {
 439                         dev_err(iommu->dev, "FORCE_RESET command timed out\n");
 440                         return ret;
 441                 }
 442         }
 443
 444         return 0;
 445 }
 446
 447 static void log_iova(struct rk_iommu *iommu, int index, dma_addr_t iova)
 448 {
 449         void __iomem *base = iommu->bases[index];
 450         u32 dte_index, pte_index, page_offset;
 451         u32 mmu_dte_addr;
 452         phys_addr_t mmu_dte_addr_phys, dte_addr_phys;
 453         u32 *dte_addr;
 454         u32 dte;
 455         phys_addr_t pte_addr_phys = 0;
 456         u32 *pte_addr = NULL;
 457         u32 pte = 0;
 458         phys_addr_t page_addr_phys = 0;
 459         u32 page_flags = 0;
 460
 461         dte_index = rk_iova_dte_index(iova);
 462         pte_index = rk_iova_pte_index(iova);
 463         page_offset = rk_iova_page_offset(iova);
 464
 465         mmu_dte_addr = rk_iommu_read(base, RK_MMU_DTE_ADDR);
 466         mmu_dte_addr_phys = (phys_addr_t)mmu_dte_addr;
 467
 468         dte_addr_phys = mmu_dte_addr_phys + (4 * dte_index);
 469         dte_addr = phys_to_virt(dte_addr_phys);
 470         dte = *dte_addr;
 471
 472         if (!rk_dte_is_pt_valid(dte))
 473                 goto print_it;
 474
 475         pte_addr_phys = rk_dte_pt_address(dte) + (pte_index * 4);
 476         pte_addr = phys_to_virt(pte_addr_phys);
 477         pte = *pte_addr;
 478
 479         if (!rk_pte_is_page_valid(pte))
 480                 goto print_it;
 481
 482         page_addr_phys = rk_pte_page_address(pte) + page_offset;
 483         page_flags = pte & RK_PTE_PAGE_FLAGS_MASK;
 484
 485 print_it:
 486         dev_err(iommu->dev, "iova = %pad: dte_index: %#03x pte_index: %#03x page_offset: %#03x\n",
 487                 &iova, dte_index, pte_index, page_offset);
 488         dev_err(iommu->dev, "mmu_dte_addr: %pa dte@%pa: %#08x valid: %u pte@%pa: %#08x valid: %u page@%pa flags: %#03x\n",
 489                 &mmu_dte_addr_phys, &dte_addr_phys, dte,
 490                 rk_dte_is_pt_valid(dte), &pte_addr_phys, pte,
 491                 rk_pte_is_page_valid(pte), &page_addr_phys, page_flags);
 492 }
 493
 494 static irqreturn_t rk_iommu_irq(int irq, void *dev_id)
 495 {
 496         struct rk_iommu *iommu = dev_id;
 497         u32 status;
 498         u32 int_status;
 499         dma_addr_t iova;
 500         irqreturn_t ret = IRQ_NONE;
 501         int i;
 502
 503         for (i = 0; i < iommu->num_mmu; i++) {
 504                 int_status = rk_iommu_read(iommu->bases[i], RK_MMU_INT_STATUS);
 505                 if (int_status == 0)
 506                         continue;
 507
 508                 ret = IRQ_HANDLED;
 509                 iova = rk_iommu_read(iommu->bases[i], RK_MMU_PAGE_FAULT_ADDR);
 510
 511                 if (int_status & RK_MMU_IRQ_PAGE_FAULT) {
 512                         int flags;
 513
 514                         status = rk_iommu_read(iommu->bases[i], RK_MMU_STATUS);
 515                         flags = (status & RK_MMU_STATUS_PAGE_FAULT_IS_WRITE) ?
 516                                         IOMMU_FAULT_WRITE : IOMMU_FAULT_READ;
 517
 518                         dev_err(iommu->dev, "Page fault at %pad of type %s\n",
 519                                 &iova,
 520                                 (flags == IOMMU_FAULT_WRITE) ? "write" : "read");
 521
 522                         log_iova(iommu, i, iova);
 523
 524                         /*
 525                          * Report page fault to any installed handlers.
 526                          * Ignore the return code, though, since we always zap cache
 527                          * and clear the page fault anyway.
 528                          */
 529                         if (iommu->domain)
 530                                 report_iommu_fault(iommu->domain, iommu->dev, iova,
 531                                                    flags);
 532                         else
 533                                 dev_err(iommu->dev, "Page fault while iommu not attached to domain?\n");
 534
 535                         rk_iommu_base_command(iommu->bases[i], RK_MMU_CMD_ZAP_CACHE);
 536                         rk_iommu_base_command(iommu->bases[i], RK_MMU_CMD_PAGE_FAULT_DONE);
 537                 }
 538
 539                 if (int_status & RK_MMU_IRQ_BUS_ERROR)
 540                         dev_err(iommu->dev, "BUS_ERROR occurred at %pad\n", &iova);
 541
 542                 if (int_status & ~RK_MMU_IRQ_MASK)
 543                         dev_err(iommu->dev, "unexpected int_status: %#08x\n",
 544                                 int_status);
 545
 546                 rk_iommu_write(iommu->bases[i], RK_MMU_INT_CLEAR, int_status);
 547         }
 548
 549         return ret;
 550 }
 551
 552 static phys_addr_t rk_iommu_iova_to_phys(struct iommu_domain *domain,
 553                                          dma_addr_t iova)
 554 {
 555         struct rk_iommu_domain *rk_domain = to_rk_domain(domain);
 556         unsigned long flags;
 557         phys_addr_t pt_phys, phys = 0;
 558         u32 dte, pte;
 559         u32 *page_table;
 560
 561         spin_lock_irqsave(&rk_domain->dt_lock, flags);
 562
 563         dte = rk_domain->dt[rk_iova_dte_index(iova)];
 564         if (!rk_dte_is_pt_valid(dte))
 565                 goto out;
 566
 567         pt_phys = rk_dte_pt_address(dte);
 568         page_table = (u32 *)phys_to_virt(pt_phys);
 569         pte = page_table[rk_iova_pte_index(iova)];
 570         if (!rk_pte_is_page_valid(pte))
 571                 goto out;
 572
 573         phys = rk_pte_page_address(pte) + rk_iova_page_offset(iova);
 574 out:
 575         spin_unlock_irqrestore(&rk_domain->dt_lock, flags);
 576
 577         return phys;
 578 }
 579
 580 static void rk_iommu_zap_iova(struct rk_iommu_domain *rk_domain,
 581                               dma_addr_t iova, size_t size)
 582 {
 583         struct list_head *pos;
 584         unsigned long flags;
 585
 586         /* shootdown these iova from all iommus using this domain */
 587         spin_lock_irqsave(&rk_domain->iommus_lock, flags);
 588         list_for_each(pos, &rk_domain->iommus) {
 589                 struct rk_iommu *iommu;
 590                 iommu = list_entry(pos, struct rk_iommu, node);
 591                 rk_iommu_zap_lines(iommu, iova, size);
 592         }
 593         spin_unlock_irqrestore(&rk_domain->iommus_lock, flags);
 594 }
 595
 596 static void rk_iommu_zap_iova_first_last(struct rk_iommu_domain *rk_domain,
 597                                          dma_addr_t iova, size_t size)
 598 {
 599         rk_iommu_zap_iova(rk_domain, iova, SPAGE_SIZE);
 600         if (size > SPAGE_SIZE)
 601                 rk_iommu_zap_iova(rk_domain, iova + size - SPAGE_SIZE,
 602                                         SPAGE_SIZE);
 603 }
 604
 605 static u32 *rk_dte_get_page_table(struct rk_iommu_domain *rk_domain,
 606                                   dma_addr_t iova)
 607 {
 608         u32 *page_table, *dte_addr;
 609         u32 dte;
 610         phys_addr_t pt_phys;
 611
 612         assert_spin_locked(&rk_domain->dt_lock);
 613
 614         dte_addr = &rk_domain->dt[rk_iova_dte_index(iova)];
 615         dte = *dte_addr;
 616         if (rk_dte_is_pt_valid(dte))
 617                 goto done;
 618
 619         page_table = (u32 *)get_zeroed_page(GFP_ATOMIC | GFP_DMA32);
 620         if (!page_table)
 621                 return ERR_PTR(-ENOMEM);
 622
 623         dte = rk_mk_dte(page_table);
 624         *dte_addr = dte;
 625
 626         rk_table_flush(page_table, NUM_PT_ENTRIES);
 627         rk_table_flush(dte_addr, 1);
 628
 629 done:
 630         pt_phys = rk_dte_pt_address(dte);
 631         return (u32 *)phys_to_virt(pt_phys);
 632 }
 633
 634 static size_t rk_iommu_unmap_iova(struct rk_iommu_domain *rk_domain,
 635                                   u32 *pte_addr, dma_addr_t iova, size_t size)
 636 {
 637         unsigned int pte_count;
 638         unsigned int pte_total = size / SPAGE_SIZE;
 639
 640         assert_spin_locked(&rk_domain->dt_lock);
 641
 642         for (pte_count = 0; pte_count < pte_total; pte_count++) {
 643                 u32 pte = pte_addr[pte_count];
 644                 if (!rk_pte_is_page_valid(pte))
 645                         break;
 646
 647                 pte_addr[pte_count] = rk_mk_pte_invalid(pte);
 648         }
 649
 650         rk_table_flush(pte_addr, pte_count);
 651
 652         return pte_count * SPAGE_SIZE;
 653 }
 654
 655 static int rk_iommu_map_iova(struct rk_iommu_domain *rk_domain, u32 *pte_addr,
 656                              dma_addr_t iova, phys_addr_t paddr, size_t size,
 657                              int prot)
 658 {
 659         unsigned int pte_count;
 660         unsigned int pte_total = size / SPAGE_SIZE;
 661         phys_addr_t page_phys;
 662
 663         assert_spin_locked(&rk_domain->dt_lock);
 664
 665         for (pte_count = 0; pte_count < pte_total; pte_count++) {
 666                 u32 pte = pte_addr[pte_count];
 667
 668                 if (rk_pte_is_page_valid(pte))
 669                         goto unwind;
 670
 671                 pte_addr[pte_count] = rk_mk_pte(paddr, prot);
 672
 673                 paddr += SPAGE_SIZE;
 674         }
 675
 676         rk_table_flush(pte_addr, pte_count);
 677
 678         /*
 679          * Zap the first and last iova to evict from iotlb any previously
 680          * mapped cachelines holding stale values for its dte and pte.
 681          * We only zap the first and last iova, since only they could have
 682          * dte or pte shared with an existing mapping.
 683          */
 684         rk_iommu_zap_iova_first_last(rk_domain, iova, size);
 685
 686         return 0;
 687 unwind:
 688         /* Unmap the range of iovas that we just mapped */
 689         rk_iommu_unmap_iova(rk_domain, pte_addr, iova, pte_count * SPAGE_SIZE);
 690
 691         iova += pte_count * SPAGE_SIZE;
 692         page_phys = rk_pte_page_address(pte_addr[pte_count]);
 693         pr_err("iova: %pad already mapped to %pa cannot remap to phys: %pa prot: %#x\n",
 694                &iova, &page_phys, &paddr, prot);
 695
 696         return -EADDRINUSE;
 697 }
 698
 699 static int rk_iommu_map(struct iommu_domain *domain, unsigned long _iova,
 700                         phys_addr_t paddr, size_t size, int prot)
 701 {
 702         struct rk_iommu_domain *rk_domain = to_rk_domain(domain);
 703         unsigned long flags;
 704         dma_addr_t iova = (dma_addr_t)_iova;
 705         u32 *page_table, *pte_addr;
 706         int ret;
 707
 708         spin_lock_irqsave(&rk_domain->dt_lock, flags);
 709
 710         /*
 711          * pgsize_bitmap specifies iova sizes that fit in one page table
 712          * (1024 4-KiB pages = 4 MiB).
 713          * So, size will always be 4096 <= size <= 4194304.
 714          * Since iommu_map() guarantees that both iova and size will be
 715          * aligned, we will always only be mapping from a single dte here.
 716          */
 717         page_table = rk_dte_get_page_table(rk_domain, iova);
 718         if (IS_ERR(page_table)) {
 719                 spin_unlock_irqrestore(&rk_domain->dt_lock, flags);
 720                 return PTR_ERR(page_table);
 721         }
 722
 723         pte_addr = &page_table[rk_iova_pte_index(iova)];
 724         ret = rk_iommu_map_iova(rk_domain, pte_addr, iova, paddr, size, prot);
 725         spin_unlock_irqrestore(&rk_domain->dt_lock, flags);
 726
 727         return ret;
 728 }
 729
 730 static size_t rk_iommu_unmap(struct iommu_domain *domain, unsigned long _iova,
 731                              size_t size)
 732 {
 733         struct rk_iommu_domain *rk_domain = to_rk_domain(domain);
 734         unsigned long flags;
 735         dma_addr_t iova = (dma_addr_t)_iova;
 736         phys_addr_t pt_phys;
 737         u32 dte;
 738         u32 *pte_addr;
 739         size_t unmap_size;
 740
 741         spin_lock_irqsave(&rk_domain->dt_lock, flags);
 742
 743         /*
 744          * pgsize_bitmap specifies iova sizes that fit in one page table
 745          * (1024 4-KiB pages = 4 MiB).
 746          * So, size will always be 4096 <= size <= 4194304.
 747          * Since iommu_unmap() guarantees that both iova and size will be
 748          * aligned, we will always only be unmapping from a single dte here.
 749          */
 750         dte = rk_domain->dt[rk_iova_dte_index(iova)];
 751         /* Just return 0 if iova is unmapped */
 752         if (!rk_dte_is_pt_valid(dte)) {
 753                 spin_unlock_irqrestore(&rk_domain->dt_lock, flags);
 754                 return 0;
 755         }
 756
 757         pt_phys = rk_dte_pt_address(dte);
 758         pte_addr = (u32 *)phys_to_virt(pt_phys) + rk_iova_pte_index(iova);
 759         unmap_size = rk_iommu_unmap_iova(rk_domain, pte_addr, iova, size);
 760
 761         spin_unlock_irqrestore(&rk_domain->dt_lock, flags);
 762
 763         /* Shootdown iotlb entries for iova range that was just unmapped */
 764         rk_iommu_zap_iova(rk_domain, iova, unmap_size);
 765
 766         return unmap_size;
 767 }
 768
 769 static struct rk_iommu *rk_iommu_from_dev(struct device *dev)
 770 {
 771         struct iommu_group *group;
 772         struct device *iommu_dev;
 773         struct rk_iommu *rk_iommu;
 774
 775         group = iommu_group_get(dev);
 776         if (!group)
 777                 return NULL;
 778         iommu_dev = iommu_group_get_iommudata(group);
 779         if (!iommu_dev) {
 780                 dev_info(dev, "Possibly a virtual device\n");
 781                 return NULL;
 782         }
 783
 784         rk_iommu = dev_get_drvdata(iommu_dev);
 785         iommu_group_put(group);
 786
 787         return rk_iommu;
 788 }
 789
 790 static int rk_iommu_attach_device(struct iommu_domain *domain,
 791                                   struct device *dev)
 792 {
 793         struct rk_iommu *iommu;
 794         struct rk_iommu_domain *rk_domain = to_rk_domain(domain);
 795         unsigned long flags;
 796         int ret, i;
 797         phys_addr_t dte_addr;
 798
 799         /*
 800          * Allow 'virtual devices' (e.g., drm) to attach to domain.
 801          * Such a device does not belong to an iommu group.
 802          */
 803         iommu = rk_iommu_from_dev(dev);
 804         if (!iommu)
 805                 return 0;
 806
 807         ret = rk_iommu_enable_stall(iommu);
 808         if (ret)
 809                 return ret;
 810
 811         ret = rk_iommu_force_reset(iommu);
 812         if (ret)
 813                 return ret;
 814
 815         iommu->domain = domain;
 816
 817         ret = devm_request_irq(iommu->dev, iommu->irq, rk_iommu_irq,
 818                                IRQF_SHARED, dev_name(dev), iommu);
 819         if (ret)
 820                 return ret;
 821
 822         dte_addr = virt_to_phys(rk_domain->dt);
 823         for (i = 0; i < iommu->num_mmu; i++) {
 824                 rk_iommu_write(iommu->bases[i], RK_MMU_DTE_ADDR, dte_addr);
 825                 rk_iommu_command(iommu->bases[i], RK_MMU_CMD_ZAP_CACHE);
 826                 rk_iommu_write(iommu->bases[i], RK_MMU_INT_MASK, RK_MMU_IRQ_MASK);
 827         }
 828
 829         ret = rk_iommu_enable_paging(iommu);
 830         if (ret)
 831                 return ret;
 832
 833         spin_lock_irqsave(&rk_domain->iommus_lock, flags);
 834         list_add_tail(&iommu->node, &rk_domain->iommus);
 835         spin_unlock_irqrestore(&rk_domain->iommus_lock, flags);
 836
 837         dev_dbg(dev, "Attached to iommu domain\n");
 838
 839         rk_iommu_disable_stall(iommu);
 840
 841         return 0;
 842 }
 843
 844 static void rk_iommu_detach_device(struct iommu_domain *domain,
 845                                    struct device *dev)
 846 {
 847         struct rk_iommu *iommu;
 848         struct rk_iommu_domain *rk_domain = to_rk_domain(domain);
 849         unsigned long flags;
 850         int i;
 851
 852         /* Allow 'virtual devices' (eg drm) to detach from domain */
 853         iommu = rk_iommu_from_dev(dev);
 854         if (!iommu)
 855                 return;
 856
 857         spin_lock_irqsave(&rk_domain->iommus_lock, flags);
 858         list_del_init(&iommu->node);
 859         spin_unlock_irqrestore(&rk_domain->iommus_lock, flags);
 860
 861         /* Ignore error while disabling, just keep going */
 862         rk_iommu_enable_stall(iommu);
 863         rk_iommu_disable_paging(iommu);
 864         for (i = 0; i < iommu->num_mmu; i++) {
 865                 rk_iommu_write(iommu->bases[i], RK_MMU_INT_MASK, 0);
 866                 rk_iommu_write(iommu->bases[i], RK_MMU_DTE_ADDR, 0);
 867         }
 868         rk_iommu_disable_stall(iommu);
 869
 870         devm_free_irq(iommu->dev, iommu->irq, iommu);
 871
 872         iommu->domain = NULL;
 873
 874         dev_dbg(dev, "Detached from iommu domain\n");
 875 }
 876
 877 static struct iommu_domain *rk_iommu_domain_alloc(unsigned type)
 878 {
 879         struct rk_iommu_domain *rk_domain;
 880
 881         if (type != IOMMU_DOMAIN_UNMANAGED)
 882                 return NULL;
 883
 884         rk_domain = kzalloc(sizeof(*rk_domain), GFP_KERNEL);
 885         if (!rk_domain)
 886                 return NULL;
 887
 888         /*
 889          * rk32xx iommus use a 2 level pagetable.
 890          * Each level1 (dt) and level2 (pt) table has 1024 4-byte entries.
 891          * Allocate one 4 KiB page for each table.
 892          */
 893         rk_domain->dt = (u32 *)get_zeroed_page(GFP_KERNEL | GFP_DMA32);
 894         if (!rk_domain->dt)
 895                 goto err_dt;
 896
 897         rk_table_flush(rk_domain->dt, NUM_DT_ENTRIES);
 898
 899         spin_lock_init(&rk_domain->iommus_lock);
 900         spin_lock_init(&rk_domain->dt_lock);
 901         INIT_LIST_HEAD(&rk_domain->iommus);
 902
 903         return &rk_domain->domain;
 904
 905 err_dt:
 906         kfree(rk_domain);
 907         return NULL;
 908 }
 909
 910 static void rk_iommu_domain_free(struct iommu_domain *domain)
 911 {
 912         struct rk_iommu_domain *rk_domain = to_rk_domain(domain);
 913         int i;
 914
 915         WARN_ON(!list_empty(&rk_domain->iommus));
 916
 917         for (i = 0; i < NUM_DT_ENTRIES; i++) {
 918                 u32 dte = rk_domain->dt[i];
 919                 if (rk_dte_is_pt_valid(dte)) {
 920                         phys_addr_t pt_phys = rk_dte_pt_address(dte);
 921                         u32 *page_table = phys_to_virt(pt_phys);
 922                         free_page((unsigned long)page_table);
 923                 }
 924         }
 925
 926         free_page((unsigned long)rk_domain->dt);
 927         kfree(rk_domain);
 928 }
 929
 930 static bool rk_iommu_is_dev_iommu_master(struct device *dev)
 931 {
 932         struct device_node *np = dev->of_node;
 933         int ret;
 934
 935         /*
 936          * An iommu master has an iommus property containing a list of phandles
 937          * to iommu nodes, each with an #iommu-cells property with value 0.
 938          */
 939         ret = of_count_phandle_with_args(np, "iommus", "#iommu-cells");
 940         return (ret > 0);
 941 }
 942
 943 static int rk_iommu_group_set_iommudata(struct iommu_group *group,
 944                                         struct device *dev)
 945 {
 946         struct device_node *np = dev->of_node;
 947         struct platform_device *pd;
 948         int ret;
 949         struct of_phandle_args args;
 950
 951         /*
 952          * An iommu master has an iommus property containing a list of phandles
 953          * to iommu nodes, each with an #iommu-cells property with value 0.
 954          */
 955         ret = of_parse_phandle_with_args(np, "iommus", "#iommu-cells", 0,
 956                                          &args);
 957         if (ret) {
 958                 dev_err(dev, "of_parse_phandle_with_args(%s) => %d\n",
 959                         np->full_name, ret);
 960                 return ret;
 961         }
 962         if (args.args_count != 0) {
 963                 dev_err(dev, "incorrect number of iommu params found for %s (found %d, expected 0)\n",
 964                         args.np->full_name, args.args_count);
 965                 return -EINVAL;
 966         }
 967
 968         pd = of_find_device_by_node(args.np);
 969         of_node_put(args.np);
 970         if (!pd) {
 971                 dev_err(dev, "iommu %s not found\n", args.np->full_name);
 972                 return -EPROBE_DEFER;
 973         }
 974
 975         /* TODO(djkurtz): handle multiple slave iommus for a single master */
 976         iommu_group_set_iommudata(group, &pd->dev, NULL);
 977
 978         return 0;
 979 }
 980
 981 static int rk_iommu_add_device(struct device *dev)
 982 {
 983         struct iommu_group *group;
 984         int ret;
 985
 986         if (!rk_iommu_is_dev_iommu_master(dev))
 987                 return -ENODEV;
 988
 989         group = iommu_group_get(dev);
 990         if (!group) {
 991                 group = iommu_group_alloc();
 992                 if (IS_ERR(group)) {
 993                         dev_err(dev, "Failed to allocate IOMMU group\n");
 994                         return PTR_ERR(group);
 995                 }
 996         }
 997
 998         ret = iommu_group_add_device(group, dev);
 999         if (ret)
1000                 goto err_put_group;
1001
1002         ret = rk_iommu_group_set_iommudata(group, dev);
1003         if (ret)
1004                 goto err_remove_device;
1005
1006         iommu_group_put(group);
1007
1008         return 0;
1009
1010 err_remove_device:
1011         iommu_group_remove_device(dev);
1012 err_put_group:
1013         iommu_group_put(group);
1014         return ret;
1015 }
1016
1017 static void rk_iommu_remove_device(struct device *dev)
1018 {
1019         if (!rk_iommu_is_dev_iommu_master(dev))
1020                 return;
1021
1022         iommu_group_remove_device(dev);
1023 }
1024
1025 static const struct iommu_ops rk_iommu_ops = {
1026         .domain_alloc = rk_iommu_domain_alloc,
1027         .domain_free = rk_iommu_domain_free,
1028         .attach_dev = rk_iommu_attach_device,
1029         .detach_dev = rk_iommu_detach_device,
1030         .map = rk_iommu_map,
1031         .unmap = rk_iommu_unmap,
1032         .map_sg = default_iommu_map_sg,
1033         .add_device = rk_iommu_add_device,
1034         .remove_device = rk_iommu_remove_device,
1035         .iova_to_phys = rk_iommu_iova_to_phys,
1036         .pgsize_bitmap = RK_IOMMU_PGSIZE_BITMAP,
1037 };
1038
1039 static int rk_iommu_probe(struct platform_device *pdev)
1040 {
1041         struct device *dev = &pdev->dev;
1042         struct rk_iommu *iommu;
1043         struct resource *res;
1044         int i;
1045
1046         iommu = devm_kzalloc(dev, sizeof(*iommu), GFP_KERNEL);
1047         if (!iommu)
1048                 return -ENOMEM;
1049
1050         platform_set_drvdata(pdev, iommu);
1051         iommu->dev = dev;
1052         iommu->num_mmu = 0;
1053         iommu->bases = devm_kzalloc(dev, sizeof(*iommu->bases) * iommu->num_mmu,
1054                                     GFP_KERNEL);
1055         if (!iommu->bases)
1056                 return -ENOMEM;
1057
1058         for (i = 0; i < pdev->num_resources; i++) {
1059                 res = platform_get_resource(pdev, IORESOURCE_MEM, i);
1060                 if (!res)
1061                         continue;
1062                 iommu->bases[i] = devm_ioremap_resource(&pdev->dev, res);
1063                 iommu->num_mmu++;
1064         }
1065         if (iommu->num_mmu == 0)
1066                 return PTR_ERR(iommu->bases[0]);
1067
1068         iommu->irq = platform_get_irq(pdev, 0);
1069         if (iommu->irq < 0) {
1070                 dev_err(dev, "Failed to get IRQ, %d\n", iommu->irq);
1071                 return -ENXIO;
1072         }
1073
1074         return 0;
1075 }
1076
1077 static int rk_iommu_remove(struct platform_device *pdev)
1078 {
1079         return 0;
1080 }
1081
1082 static const struct of_device_id rk_iommu_dt_ids[] = {
1083         { .compatible = "rockchip,iommu" },
1084         { /* sentinel */ }
1085 };
1086 MODULE_DEVICE_TABLE(of, rk_iommu_dt_ids);
1087
1088 static struct platform_driver rk_iommu_driver = {
1089         .probe = rk_iommu_probe,
1090         .remove = rk_iommu_remove,
1091         .driver = {
1092                    .name = "rk_iommu",
1093                    .of_match_table = rk_iommu_dt_ids,
1094         },
1095 };
1096
1097 static int __init rk_iommu_init(void)
1098 {
1099         struct device_node *np;
1100         int ret;
1101
1102         np = of_find_matching_node(NULL, rk_iommu_dt_ids);
1103         if (!np)
1104                 return 0;
1105
1106         of_node_put(np);
1107
1108         ret = bus_set_iommu(&platform_bus_type, &rk_iommu_ops);
1109         if (ret)
1110                 return ret;
1111
1112         return platform_driver_register(&rk_iommu_driver);
1113 }
1114 static void __exit rk_iommu_exit(void)
1115 {
1116         platform_driver_unregister(&rk_iommu_driver);
1117 }
1118
1119 subsys_initcall(rk_iommu_init);
1120 module_exit(rk_iommu_exit);
1121
1122 MODULE_DESCRIPTION("IOMMU API for Rockchip");
1123 MODULE_AUTHOR("Simon Xue <xxm@rock-chips.com> and Daniel Kurtz <djkurtz@chromium.org>");
1124 MODULE_ALIAS("platform:rockchip-iommu");
1125 MODULE_LICENSE("GPL v2");