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