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