iommu/exynos: Fix warnings from DMA-debug
[linux-block.git] / drivers / iommu / exynos-iommu.c
CommitLineData
740a01ee
MS
1/*
2 * Copyright (c) 2011,2016 Samsung Electronics Co., Ltd.
2a96536e
KC
3 * http://www.samsung.com
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 */
9
10#ifdef CONFIG_EXYNOS_IOMMU_DEBUG
11#define DEBUG
12#endif
13
2a96536e 14#include <linux/clk.h>
8ed55c81 15#include <linux/dma-mapping.h>
2a96536e 16#include <linux/err.h>
312900c6 17#include <linux/io.h>
2a96536e 18#include <linux/iommu.h>
312900c6 19#include <linux/interrupt.h>
2a96536e 20#include <linux/list.h>
8ed55c81
MS
21#include <linux/of.h>
22#include <linux/of_iommu.h>
23#include <linux/of_platform.h>
312900c6
MS
24#include <linux/platform_device.h>
25#include <linux/pm_runtime.h>
26#include <linux/slab.h>
58c6f6a3 27#include <linux/dma-iommu.h>
2a96536e 28
d09d78fc
CK
29typedef u32 sysmmu_iova_t;
30typedef u32 sysmmu_pte_t;
31
f171abab 32/* We do not consider super section mapping (16MB) */
2a96536e
KC
33#define SECT_ORDER 20
34#define LPAGE_ORDER 16
35#define SPAGE_ORDER 12
36
37#define SECT_SIZE (1 << SECT_ORDER)
38#define LPAGE_SIZE (1 << LPAGE_ORDER)
39#define SPAGE_SIZE (1 << SPAGE_ORDER)
40
41#define SECT_MASK (~(SECT_SIZE - 1))
42#define LPAGE_MASK (~(LPAGE_SIZE - 1))
43#define SPAGE_MASK (~(SPAGE_SIZE - 1))
44
66a7ed84
CK
45#define lv1ent_fault(sent) ((*(sent) == ZERO_LV2LINK) || \
46 ((*(sent) & 3) == 0) || ((*(sent) & 3) == 3))
47#define lv1ent_zero(sent) (*(sent) == ZERO_LV2LINK)
48#define lv1ent_page_zero(sent) ((*(sent) & 3) == 1)
49#define lv1ent_page(sent) ((*(sent) != ZERO_LV2LINK) && \
50 ((*(sent) & 3) == 1))
2a96536e
KC
51#define lv1ent_section(sent) ((*(sent) & 3) == 2)
52
53#define lv2ent_fault(pent) ((*(pent) & 3) == 0)
54#define lv2ent_small(pent) ((*(pent) & 2) == 2)
55#define lv2ent_large(pent) ((*(pent) & 3) == 1)
56
6ae5343c
BD
57#ifdef CONFIG_BIG_ENDIAN
58#warning "revisit driver if we can enable big-endian ptes"
59#endif
60
740a01ee
MS
61/*
62 * v1.x - v3.x SYSMMU supports 32bit physical and 32bit virtual address spaces
63 * v5.0 introduced support for 36bit physical address space by shifting
64 * all page entry values by 4 bits.
65 * All SYSMMU controllers in the system support the address spaces of the same
66 * size, so PG_ENT_SHIFT can be initialized on first SYSMMU probe to proper
67 * value (0 or 4).
68 */
69static short PG_ENT_SHIFT = -1;
70#define SYSMMU_PG_ENT_SHIFT 0
71#define SYSMMU_V5_PG_ENT_SHIFT 4
72
1a0d8dac
MS
73static const sysmmu_pte_t *LV1_PROT;
74static const sysmmu_pte_t SYSMMU_LV1_PROT[] = {
75 ((0 << 15) | (0 << 10)), /* no access */
76 ((1 << 15) | (1 << 10)), /* IOMMU_READ only */
77 ((0 << 15) | (1 << 10)), /* IOMMU_WRITE not supported, use read/write */
78 ((0 << 15) | (1 << 10)), /* IOMMU_READ | IOMMU_WRITE */
79};
80static const sysmmu_pte_t SYSMMU_V5_LV1_PROT[] = {
81 (0 << 4), /* no access */
82 (1 << 4), /* IOMMU_READ only */
83 (2 << 4), /* IOMMU_WRITE only */
84 (3 << 4), /* IOMMU_READ | IOMMU_WRITE */
85};
86
87static const sysmmu_pte_t *LV2_PROT;
88static const sysmmu_pte_t SYSMMU_LV2_PROT[] = {
89 ((0 << 9) | (0 << 4)), /* no access */
90 ((1 << 9) | (1 << 4)), /* IOMMU_READ only */
91 ((0 << 9) | (1 << 4)), /* IOMMU_WRITE not supported, use read/write */
92 ((0 << 9) | (1 << 4)), /* IOMMU_READ | IOMMU_WRITE */
93};
94static const sysmmu_pte_t SYSMMU_V5_LV2_PROT[] = {
95 (0 << 2), /* no access */
96 (1 << 2), /* IOMMU_READ only */
97 (2 << 2), /* IOMMU_WRITE only */
98 (3 << 2), /* IOMMU_READ | IOMMU_WRITE */
99};
100
101#define SYSMMU_SUPPORTED_PROT_BITS (IOMMU_READ | IOMMU_WRITE)
102
740a01ee
MS
103#define sect_to_phys(ent) (((phys_addr_t) ent) << PG_ENT_SHIFT)
104#define section_phys(sent) (sect_to_phys(*(sent)) & SECT_MASK)
105#define section_offs(iova) (iova & (SECT_SIZE - 1))
106#define lpage_phys(pent) (sect_to_phys(*(pent)) & LPAGE_MASK)
107#define lpage_offs(iova) (iova & (LPAGE_SIZE - 1))
108#define spage_phys(pent) (sect_to_phys(*(pent)) & SPAGE_MASK)
109#define spage_offs(iova) (iova & (SPAGE_SIZE - 1))
2a96536e
KC
110
111#define NUM_LV1ENTRIES 4096
d09d78fc 112#define NUM_LV2ENTRIES (SECT_SIZE / SPAGE_SIZE)
2a96536e 113
d09d78fc
CK
114static u32 lv1ent_offset(sysmmu_iova_t iova)
115{
116 return iova >> SECT_ORDER;
117}
118
119static u32 lv2ent_offset(sysmmu_iova_t iova)
120{
121 return (iova >> SPAGE_ORDER) & (NUM_LV2ENTRIES - 1);
122}
123
5e3435eb 124#define LV1TABLE_SIZE (NUM_LV1ENTRIES * sizeof(sysmmu_pte_t))
d09d78fc 125#define LV2TABLE_SIZE (NUM_LV2ENTRIES * sizeof(sysmmu_pte_t))
2a96536e
KC
126
127#define SPAGES_PER_LPAGE (LPAGE_SIZE / SPAGE_SIZE)
740a01ee 128#define lv2table_base(sent) (sect_to_phys(*(sent) & 0xFFFFFFC0))
2a96536e 129
1a0d8dac 130#define mk_lv1ent_sect(pa, prot) ((pa >> PG_ENT_SHIFT) | LV1_PROT[prot] | 2)
740a01ee 131#define mk_lv1ent_page(pa) ((pa >> PG_ENT_SHIFT) | 1)
1a0d8dac
MS
132#define mk_lv2ent_lpage(pa, prot) ((pa >> PG_ENT_SHIFT) | LV2_PROT[prot] | 1)
133#define mk_lv2ent_spage(pa, prot) ((pa >> PG_ENT_SHIFT) | LV2_PROT[prot] | 2)
2a96536e
KC
134
135#define CTRL_ENABLE 0x5
136#define CTRL_BLOCK 0x7
137#define CTRL_DISABLE 0x0
138
eeb5184b 139#define CFG_LRU 0x1
1a0d8dac 140#define CFG_EAP (1 << 2)
eeb5184b 141#define CFG_QOS(n) ((n & 0xF) << 7)
eeb5184b
CK
142#define CFG_ACGEN (1 << 24) /* System MMU 3.3 only */
143#define CFG_SYSSEL (1 << 22) /* System MMU 3.2 only */
144#define CFG_FLPDCACHE (1 << 20) /* System MMU 3.2+ only */
145
740a01ee 146/* common registers */
2a96536e
KC
147#define REG_MMU_CTRL 0x000
148#define REG_MMU_CFG 0x004
149#define REG_MMU_STATUS 0x008
740a01ee
MS
150#define REG_MMU_VERSION 0x034
151
152#define MMU_MAJ_VER(val) ((val) >> 7)
153#define MMU_MIN_VER(val) ((val) & 0x7F)
154#define MMU_RAW_VER(reg) (((reg) >> 21) & ((1 << 11) - 1)) /* 11 bits */
155
156#define MAKE_MMU_VER(maj, min) ((((maj) & 0xF) << 7) | ((min) & 0x7F))
157
158/* v1.x - v3.x registers */
2a96536e
KC
159#define REG_MMU_FLUSH 0x00C
160#define REG_MMU_FLUSH_ENTRY 0x010
161#define REG_PT_BASE_ADDR 0x014
162#define REG_INT_STATUS 0x018
163#define REG_INT_CLEAR 0x01C
164
165#define REG_PAGE_FAULT_ADDR 0x024
166#define REG_AW_FAULT_ADDR 0x028
167#define REG_AR_FAULT_ADDR 0x02C
168#define REG_DEFAULT_SLAVE_ADDR 0x030
169
740a01ee
MS
170/* v5.x registers */
171#define REG_V5_PT_BASE_PFN 0x00C
172#define REG_V5_MMU_FLUSH_ALL 0x010
173#define REG_V5_MMU_FLUSH_ENTRY 0x014
174#define REG_V5_INT_STATUS 0x060
175#define REG_V5_INT_CLEAR 0x064
176#define REG_V5_FAULT_AR_VA 0x070
177#define REG_V5_FAULT_AW_VA 0x080
2a96536e 178
6b21a5db
CK
179#define has_sysmmu(dev) (dev->archdata.iommu != NULL)
180
5e3435eb 181static struct device *dma_dev;
734c3c73 182static struct kmem_cache *lv2table_kmem_cache;
66a7ed84
CK
183static sysmmu_pte_t *zero_lv2_table;
184#define ZERO_LV2LINK mk_lv1ent_page(virt_to_phys(zero_lv2_table))
734c3c73 185
d09d78fc 186static sysmmu_pte_t *section_entry(sysmmu_pte_t *pgtable, sysmmu_iova_t iova)
2a96536e
KC
187{
188 return pgtable + lv1ent_offset(iova);
189}
190
d09d78fc 191static sysmmu_pte_t *page_entry(sysmmu_pte_t *sent, sysmmu_iova_t iova)
2a96536e 192{
d09d78fc 193 return (sysmmu_pte_t *)phys_to_virt(
7222e8db 194 lv2table_base(sent)) + lv2ent_offset(iova);
2a96536e
KC
195}
196
d093fc7e
MS
197/*
198 * IOMMU fault information register
199 */
200struct sysmmu_fault_info {
201 unsigned int bit; /* bit number in STATUS register */
202 unsigned short addr_reg; /* register to read VA fault address */
203 const char *name; /* human readable fault name */
204 unsigned int type; /* fault type for report_iommu_fault */
2a96536e
KC
205};
206
d093fc7e
MS
207static const struct sysmmu_fault_info sysmmu_faults[] = {
208 { 0, REG_PAGE_FAULT_ADDR, "PAGE", IOMMU_FAULT_READ },
209 { 1, REG_AR_FAULT_ADDR, "AR MULTI-HIT", IOMMU_FAULT_READ },
210 { 2, REG_AW_FAULT_ADDR, "AW MULTI-HIT", IOMMU_FAULT_WRITE },
211 { 3, REG_DEFAULT_SLAVE_ADDR, "BUS ERROR", IOMMU_FAULT_READ },
212 { 4, REG_AR_FAULT_ADDR, "AR SECURITY PROTECTION", IOMMU_FAULT_READ },
213 { 5, REG_AR_FAULT_ADDR, "AR ACCESS PROTECTION", IOMMU_FAULT_READ },
214 { 6, REG_AW_FAULT_ADDR, "AW SECURITY PROTECTION", IOMMU_FAULT_WRITE },
215 { 7, REG_AW_FAULT_ADDR, "AW ACCESS PROTECTION", IOMMU_FAULT_WRITE },
2a96536e
KC
216};
217
740a01ee
MS
218static const struct sysmmu_fault_info sysmmu_v5_faults[] = {
219 { 0, REG_V5_FAULT_AR_VA, "AR PTW", IOMMU_FAULT_READ },
220 { 1, REG_V5_FAULT_AR_VA, "AR PAGE", IOMMU_FAULT_READ },
221 { 2, REG_V5_FAULT_AR_VA, "AR MULTI-HIT", IOMMU_FAULT_READ },
222 { 3, REG_V5_FAULT_AR_VA, "AR ACCESS PROTECTION", IOMMU_FAULT_READ },
223 { 4, REG_V5_FAULT_AR_VA, "AR SECURITY PROTECTION", IOMMU_FAULT_READ },
224 { 16, REG_V5_FAULT_AW_VA, "AW PTW", IOMMU_FAULT_WRITE },
225 { 17, REG_V5_FAULT_AW_VA, "AW PAGE", IOMMU_FAULT_WRITE },
226 { 18, REG_V5_FAULT_AW_VA, "AW MULTI-HIT", IOMMU_FAULT_WRITE },
227 { 19, REG_V5_FAULT_AW_VA, "AW ACCESS PROTECTION", IOMMU_FAULT_WRITE },
228 { 20, REG_V5_FAULT_AW_VA, "AW SECURITY PROTECTION", IOMMU_FAULT_WRITE },
229};
230
2860af3c
MS
231/*
232 * This structure is attached to dev.archdata.iommu of the master device
233 * on device add, contains a list of SYSMMU controllers defined by device tree,
234 * which are bound to given master device. It is usually referenced by 'owner'
235 * pointer.
236*/
6b21a5db 237struct exynos_iommu_owner {
1b092054 238 struct list_head controllers; /* list of sysmmu_drvdata.owner_node */
5fa61cbf 239 struct iommu_domain *domain; /* domain this device is attached */
9b265536 240 struct mutex rpm_lock; /* for runtime pm of all sysmmus */
6b21a5db
CK
241};
242
2860af3c
MS
243/*
244 * This structure exynos specific generalization of struct iommu_domain.
245 * It contains list of SYSMMU controllers from all master devices, which has
246 * been attached to this domain and page tables of IO address space defined by
247 * it. It is usually referenced by 'domain' pointer.
248 */
2a96536e 249struct exynos_iommu_domain {
2860af3c
MS
250 struct list_head clients; /* list of sysmmu_drvdata.domain_node */
251 sysmmu_pte_t *pgtable; /* lv1 page table, 16KB */
252 short *lv2entcnt; /* free lv2 entry counter for each section */
253 spinlock_t lock; /* lock for modyfying list of clients */
254 spinlock_t pgtablelock; /* lock for modifying page table @ pgtable */
e1fd1eaa 255 struct iommu_domain domain; /* generic domain data structure */
2a96536e
KC
256};
257
2860af3c
MS
258/*
259 * This structure hold all data of a single SYSMMU controller, this includes
260 * hw resources like registers and clocks, pointers and list nodes to connect
261 * it to all other structures, internal state and parameters read from device
262 * tree. It is usually referenced by 'data' pointer.
263 */
2a96536e 264struct sysmmu_drvdata {
2860af3c
MS
265 struct device *sysmmu; /* SYSMMU controller device */
266 struct device *master; /* master device (owner) */
267 void __iomem *sfrbase; /* our registers */
268 struct clk *clk; /* SYSMMU's clock */
740a01ee
MS
269 struct clk *aclk; /* SYSMMU's aclk clock */
270 struct clk *pclk; /* SYSMMU's pclk clock */
2860af3c 271 struct clk *clk_master; /* master's device clock */
2860af3c 272 spinlock_t lock; /* lock for modyfying state */
47a574ff 273 bool active; /* current status */
2860af3c
MS
274 struct exynos_iommu_domain *domain; /* domain we belong to */
275 struct list_head domain_node; /* node for domain clients list */
1b092054 276 struct list_head owner_node; /* node for owner controllers list */
2860af3c
MS
277 phys_addr_t pgtable; /* assigned page table structure */
278 unsigned int version; /* our version */
2a96536e
KC
279};
280
e1fd1eaa
JR
281static struct exynos_iommu_domain *to_exynos_domain(struct iommu_domain *dom)
282{
283 return container_of(dom, struct exynos_iommu_domain, domain);
284}
285
02cdc365 286static void sysmmu_unblock(struct sysmmu_drvdata *data)
2a96536e 287{
84bd0428 288 writel(CTRL_ENABLE, data->sfrbase + REG_MMU_CTRL);
2a96536e
KC
289}
290
02cdc365 291static bool sysmmu_block(struct sysmmu_drvdata *data)
2a96536e
KC
292{
293 int i = 120;
294
84bd0428
MS
295 writel(CTRL_BLOCK, data->sfrbase + REG_MMU_CTRL);
296 while ((i > 0) && !(readl(data->sfrbase + REG_MMU_STATUS) & 1))
2a96536e
KC
297 --i;
298
84bd0428 299 if (!(readl(data->sfrbase + REG_MMU_STATUS) & 1)) {
02cdc365 300 sysmmu_unblock(data);
2a96536e
KC
301 return false;
302 }
303
304 return true;
305}
306
02cdc365 307static void __sysmmu_tlb_invalidate(struct sysmmu_drvdata *data)
2a96536e 308{
740a01ee 309 if (MMU_MAJ_VER(data->version) < 5)
84bd0428 310 writel(0x1, data->sfrbase + REG_MMU_FLUSH);
740a01ee 311 else
84bd0428 312 writel(0x1, data->sfrbase + REG_V5_MMU_FLUSH_ALL);
2a96536e
KC
313}
314
02cdc365 315static void __sysmmu_tlb_invalidate_entry(struct sysmmu_drvdata *data,
d09d78fc 316 sysmmu_iova_t iova, unsigned int num_inv)
2a96536e 317{
3ad6b7f3 318 unsigned int i;
365409db 319
3ad6b7f3 320 for (i = 0; i < num_inv; i++) {
740a01ee 321 if (MMU_MAJ_VER(data->version) < 5)
84bd0428 322 writel((iova & SPAGE_MASK) | 1,
740a01ee
MS
323 data->sfrbase + REG_MMU_FLUSH_ENTRY);
324 else
84bd0428 325 writel((iova & SPAGE_MASK) | 1,
740a01ee 326 data->sfrbase + REG_V5_MMU_FLUSH_ENTRY);
3ad6b7f3
CK
327 iova += SPAGE_SIZE;
328 }
2a96536e
KC
329}
330
02cdc365 331static void __sysmmu_set_ptbase(struct sysmmu_drvdata *data, phys_addr_t pgd)
2a96536e 332{
740a01ee 333 if (MMU_MAJ_VER(data->version) < 5)
84bd0428 334 writel(pgd, data->sfrbase + REG_PT_BASE_ADDR);
740a01ee 335 else
84bd0428 336 writel(pgd >> PAGE_SHIFT,
740a01ee 337 data->sfrbase + REG_V5_PT_BASE_PFN);
2a96536e 338
02cdc365 339 __sysmmu_tlb_invalidate(data);
2a96536e
KC
340}
341
fecc49db
MS
342static void __sysmmu_enable_clocks(struct sysmmu_drvdata *data)
343{
344 BUG_ON(clk_prepare_enable(data->clk_master));
345 BUG_ON(clk_prepare_enable(data->clk));
346 BUG_ON(clk_prepare_enable(data->pclk));
347 BUG_ON(clk_prepare_enable(data->aclk));
348}
349
350static void __sysmmu_disable_clocks(struct sysmmu_drvdata *data)
351{
352 clk_disable_unprepare(data->aclk);
353 clk_disable_unprepare(data->pclk);
354 clk_disable_unprepare(data->clk);
355 clk_disable_unprepare(data->clk_master);
356}
357
850d313e
MS
358static void __sysmmu_get_version(struct sysmmu_drvdata *data)
359{
360 u32 ver;
361
fecc49db 362 __sysmmu_enable_clocks(data);
850d313e 363
84bd0428 364 ver = readl(data->sfrbase + REG_MMU_VERSION);
850d313e
MS
365
366 /* controllers on some SoCs don't report proper version */
367 if (ver == 0x80000001u)
368 data->version = MAKE_MMU_VER(1, 0);
369 else
370 data->version = MMU_RAW_VER(ver);
371
372 dev_dbg(data->sysmmu, "hardware version: %d.%d\n",
373 MMU_MAJ_VER(data->version), MMU_MIN_VER(data->version));
374
fecc49db 375 __sysmmu_disable_clocks(data);
850d313e
MS
376}
377
d093fc7e
MS
378static void show_fault_information(struct sysmmu_drvdata *data,
379 const struct sysmmu_fault_info *finfo,
380 sysmmu_iova_t fault_addr)
2a96536e 381{
d09d78fc 382 sysmmu_pte_t *ent;
2a96536e 383
ec5d241b
MS
384 dev_err(data->sysmmu, "%s: %s FAULT occurred at %#x\n",
385 dev_name(data->master), finfo->name, fault_addr);
386 dev_dbg(data->sysmmu, "Page table base: %pa\n", &data->pgtable);
d093fc7e 387 ent = section_entry(phys_to_virt(data->pgtable), fault_addr);
ec5d241b 388 dev_dbg(data->sysmmu, "\tLv1 entry: %#x\n", *ent);
2a96536e
KC
389 if (lv1ent_page(ent)) {
390 ent = page_entry(ent, fault_addr);
ec5d241b 391 dev_dbg(data->sysmmu, "\t Lv2 entry: %#x\n", *ent);
2a96536e 392 }
2a96536e
KC
393}
394
395static irqreturn_t exynos_sysmmu_irq(int irq, void *dev_id)
396{
f171abab 397 /* SYSMMU is in blocked state when interrupt occurred. */
2a96536e 398 struct sysmmu_drvdata *data = dev_id;
740a01ee
MS
399 const struct sysmmu_fault_info *finfo;
400 unsigned int i, n, itype;
d093fc7e 401 sysmmu_iova_t fault_addr = -1;
740a01ee 402 unsigned short reg_status, reg_clear;
7222e8db 403 int ret = -ENOSYS;
2a96536e 404
47a574ff 405 WARN_ON(!data->active);
2a96536e 406
740a01ee
MS
407 if (MMU_MAJ_VER(data->version) < 5) {
408 reg_status = REG_INT_STATUS;
409 reg_clear = REG_INT_CLEAR;
410 finfo = sysmmu_faults;
411 n = ARRAY_SIZE(sysmmu_faults);
412 } else {
413 reg_status = REG_V5_INT_STATUS;
414 reg_clear = REG_V5_INT_CLEAR;
415 finfo = sysmmu_v5_faults;
416 n = ARRAY_SIZE(sysmmu_v5_faults);
417 }
418
9d4e7a24
CK
419 spin_lock(&data->lock);
420
b398af21 421 clk_enable(data->clk_master);
9d4e7a24 422
84bd0428 423 itype = __ffs(readl(data->sfrbase + reg_status));
d093fc7e
MS
424 for (i = 0; i < n; i++, finfo++)
425 if (finfo->bit == itype)
426 break;
427 /* unknown/unsupported fault */
428 BUG_ON(i == n);
429
430 /* print debug message */
84bd0428 431 fault_addr = readl(data->sfrbase + finfo->addr_reg);
d093fc7e 432 show_fault_information(data, finfo, fault_addr);
2a96536e 433
d093fc7e
MS
434 if (data->domain)
435 ret = report_iommu_fault(&data->domain->domain,
436 data->master, fault_addr, finfo->type);
1fab7fa7
CK
437 /* fault is not recovered by fault handler */
438 BUG_ON(ret != 0);
2a96536e 439
84bd0428 440 writel(1 << itype, data->sfrbase + reg_clear);
1fab7fa7 441
02cdc365 442 sysmmu_unblock(data);
2a96536e 443
b398af21 444 clk_disable(data->clk_master);
70605870 445
9d4e7a24 446 spin_unlock(&data->lock);
2a96536e
KC
447
448 return IRQ_HANDLED;
449}
450
47a574ff 451static void __sysmmu_disable(struct sysmmu_drvdata *data)
2a96536e 452{
47a574ff
MS
453 unsigned long flags;
454
b398af21 455 clk_enable(data->clk_master);
70605870 456
47a574ff 457 spin_lock_irqsave(&data->lock, flags);
84bd0428
MS
458 writel(CTRL_DISABLE, data->sfrbase + REG_MMU_CTRL);
459 writel(0, data->sfrbase + REG_MMU_CFG);
47a574ff 460 data->active = false;
6b21a5db
CK
461 spin_unlock_irqrestore(&data->lock, flags);
462
47a574ff 463 __sysmmu_disable_clocks(data);
6b21a5db 464}
2a96536e 465
6b21a5db
CK
466static void __sysmmu_init_config(struct sysmmu_drvdata *data)
467{
83addecd
MS
468 unsigned int cfg;
469
83addecd
MS
470 if (data->version <= MAKE_MMU_VER(3, 1))
471 cfg = CFG_LRU | CFG_QOS(15);
472 else if (data->version <= MAKE_MMU_VER(3, 2))
473 cfg = CFG_LRU | CFG_QOS(15) | CFG_FLPDCACHE | CFG_SYSSEL;
474 else
475 cfg = CFG_QOS(15) | CFG_FLPDCACHE | CFG_ACGEN;
6b21a5db 476
1a0d8dac
MS
477 cfg |= CFG_EAP; /* enable access protection bits check */
478
84bd0428 479 writel(cfg, data->sfrbase + REG_MMU_CFG);
6b21a5db
CK
480}
481
47a574ff 482static void __sysmmu_enable(struct sysmmu_drvdata *data)
6b21a5db 483{
47a574ff
MS
484 unsigned long flags;
485
fecc49db 486 __sysmmu_enable_clocks(data);
70605870 487
47a574ff 488 spin_lock_irqsave(&data->lock, flags);
84bd0428 489 writel(CTRL_BLOCK, data->sfrbase + REG_MMU_CTRL);
6b21a5db 490 __sysmmu_init_config(data);
02cdc365 491 __sysmmu_set_ptbase(data, data->pgtable);
84bd0428 492 writel(CTRL_ENABLE, data->sfrbase + REG_MMU_CTRL);
47a574ff
MS
493 data->active = true;
494 spin_unlock_irqrestore(&data->lock, flags);
7222e8db 495
fecc49db
MS
496 /*
497 * SYSMMU driver keeps master's clock enabled only for the short
498 * time, while accessing the registers. For performing address
499 * translation during DMA transaction it relies on the client
500 * driver to enable it.
501 */
b398af21 502 clk_disable(data->clk_master);
6b21a5db 503}
70605870 504
469acebe 505static void sysmmu_tlb_invalidate_flpdcache(struct sysmmu_drvdata *data,
66a7ed84
CK
506 sysmmu_iova_t iova)
507{
508 unsigned long flags;
66a7ed84 509
66a7ed84 510 spin_lock_irqsave(&data->lock, flags);
47a574ff 511 if (data->active && data->version >= MAKE_MMU_VER(3, 3)) {
01324ab2
MS
512 clk_enable(data->clk_master);
513 __sysmmu_tlb_invalidate_entry(data, iova, 1);
514 clk_disable(data->clk_master);
d631ea98 515 }
66a7ed84 516 spin_unlock_irqrestore(&data->lock, flags);
66a7ed84
CK
517}
518
469acebe
MS
519static void sysmmu_tlb_invalidate_entry(struct sysmmu_drvdata *data,
520 sysmmu_iova_t iova, size_t size)
2a96536e
KC
521{
522 unsigned long flags;
2a96536e 523
6b21a5db 524 spin_lock_irqsave(&data->lock, flags);
47a574ff 525 if (data->active) {
3ad6b7f3 526 unsigned int num_inv = 1;
70605870 527
b398af21 528 clk_enable(data->clk_master);
70605870 529
3ad6b7f3
CK
530 /*
531 * L2TLB invalidation required
532 * 4KB page: 1 invalidation
f171abab
SK
533 * 64KB page: 16 invalidations
534 * 1MB page: 64 invalidations
3ad6b7f3
CK
535 * because it is set-associative TLB
536 * with 8-way and 64 sets.
537 * 1MB page can be cached in one of all sets.
538 * 64KB page can be one of 16 consecutive sets.
539 */
512bd0c6 540 if (MMU_MAJ_VER(data->version) == 2)
3ad6b7f3
CK
541 num_inv = min_t(unsigned int, size / PAGE_SIZE, 64);
542
02cdc365
MS
543 if (sysmmu_block(data)) {
544 __sysmmu_tlb_invalidate_entry(data, iova, num_inv);
545 sysmmu_unblock(data);
2a96536e 546 }
b398af21 547 clk_disable(data->clk_master);
2a96536e 548 }
9d4e7a24 549 spin_unlock_irqrestore(&data->lock, flags);
2a96536e
KC
550}
551
96f66557
MS
552static struct iommu_ops exynos_iommu_ops;
553
6b21a5db 554static int __init exynos_sysmmu_probe(struct platform_device *pdev)
2a96536e 555{
46c16d1e 556 int irq, ret;
7222e8db 557 struct device *dev = &pdev->dev;
2a96536e 558 struct sysmmu_drvdata *data;
7222e8db 559 struct resource *res;
2a96536e 560
46c16d1e
CK
561 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
562 if (!data)
563 return -ENOMEM;
2a96536e 564
7222e8db 565 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
46c16d1e
CK
566 data->sfrbase = devm_ioremap_resource(dev, res);
567 if (IS_ERR(data->sfrbase))
568 return PTR_ERR(data->sfrbase);
2a96536e 569
46c16d1e
CK
570 irq = platform_get_irq(pdev, 0);
571 if (irq <= 0) {
0bf4e54d 572 dev_err(dev, "Unable to find IRQ resource\n");
46c16d1e 573 return irq;
2a96536e
KC
574 }
575
46c16d1e 576 ret = devm_request_irq(dev, irq, exynos_sysmmu_irq, 0,
7222e8db
CK
577 dev_name(dev), data);
578 if (ret) {
46c16d1e
CK
579 dev_err(dev, "Unabled to register handler of irq %d\n", irq);
580 return ret;
2a96536e
KC
581 }
582
46c16d1e 583 data->clk = devm_clk_get(dev, "sysmmu");
0c2b063f 584 if (PTR_ERR(data->clk) == -ENOENT)
740a01ee 585 data->clk = NULL;
0c2b063f
MS
586 else if (IS_ERR(data->clk))
587 return PTR_ERR(data->clk);
740a01ee
MS
588
589 data->aclk = devm_clk_get(dev, "aclk");
0c2b063f 590 if (PTR_ERR(data->aclk) == -ENOENT)
740a01ee 591 data->aclk = NULL;
0c2b063f
MS
592 else if (IS_ERR(data->aclk))
593 return PTR_ERR(data->aclk);
740a01ee
MS
594
595 data->pclk = devm_clk_get(dev, "pclk");
0c2b063f 596 if (PTR_ERR(data->pclk) == -ENOENT)
740a01ee 597 data->pclk = NULL;
0c2b063f
MS
598 else if (IS_ERR(data->pclk))
599 return PTR_ERR(data->pclk);
740a01ee
MS
600
601 if (!data->clk && (!data->aclk || !data->pclk)) {
602 dev_err(dev, "Failed to get device clock(s)!\n");
603 return -ENOSYS;
2a96536e
KC
604 }
605
70605870 606 data->clk_master = devm_clk_get(dev, "master");
0c2b063f 607 if (PTR_ERR(data->clk_master) == -ENOENT)
b398af21 608 data->clk_master = NULL;
0c2b063f
MS
609 else if (IS_ERR(data->clk_master))
610 return PTR_ERR(data->clk_master);
70605870 611
2a96536e 612 data->sysmmu = dev;
9d4e7a24 613 spin_lock_init(&data->lock);
2a96536e 614
7222e8db
CK
615 platform_set_drvdata(pdev, data);
616
850d313e 617 __sysmmu_get_version(data);
740a01ee 618 if (PG_ENT_SHIFT < 0) {
1a0d8dac 619 if (MMU_MAJ_VER(data->version) < 5) {
740a01ee 620 PG_ENT_SHIFT = SYSMMU_PG_ENT_SHIFT;
1a0d8dac
MS
621 LV1_PROT = SYSMMU_LV1_PROT;
622 LV2_PROT = SYSMMU_LV2_PROT;
623 } else {
740a01ee 624 PG_ENT_SHIFT = SYSMMU_V5_PG_ENT_SHIFT;
1a0d8dac
MS
625 LV1_PROT = SYSMMU_V5_LV1_PROT;
626 LV2_PROT = SYSMMU_V5_LV2_PROT;
627 }
740a01ee
MS
628 }
629
f4723ec1 630 pm_runtime_enable(dev);
2a96536e 631
96f66557
MS
632 of_iommu_set_ops(dev->of_node, &exynos_iommu_ops);
633
2a96536e 634 return 0;
2a96536e
KC
635}
636
9b265536 637static int __maybe_unused exynos_sysmmu_suspend(struct device *dev)
622015e4
MS
638{
639 struct sysmmu_drvdata *data = dev_get_drvdata(dev);
47a574ff 640 struct device *master = data->master;
622015e4 641
47a574ff 642 if (master) {
9b265536
MS
643 struct exynos_iommu_owner *owner = master->archdata.iommu;
644
645 mutex_lock(&owner->rpm_lock);
92798b45
MS
646 if (data->domain) {
647 dev_dbg(data->sysmmu, "saving state\n");
648 __sysmmu_disable(data);
649 }
9b265536 650 mutex_unlock(&owner->rpm_lock);
622015e4
MS
651 }
652 return 0;
653}
654
9b265536 655static int __maybe_unused exynos_sysmmu_resume(struct device *dev)
622015e4
MS
656{
657 struct sysmmu_drvdata *data = dev_get_drvdata(dev);
47a574ff 658 struct device *master = data->master;
622015e4 659
47a574ff 660 if (master) {
9b265536
MS
661 struct exynos_iommu_owner *owner = master->archdata.iommu;
662
663 mutex_lock(&owner->rpm_lock);
92798b45
MS
664 if (data->domain) {
665 dev_dbg(data->sysmmu, "restoring state\n");
666 __sysmmu_enable(data);
667 }
9b265536 668 mutex_unlock(&owner->rpm_lock);
622015e4
MS
669 }
670 return 0;
671}
622015e4
MS
672
673static const struct dev_pm_ops sysmmu_pm_ops = {
9b265536 674 SET_RUNTIME_PM_OPS(exynos_sysmmu_suspend, exynos_sysmmu_resume, NULL)
2f5f44f2
MS
675 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
676 pm_runtime_force_resume)
622015e4
MS
677};
678
6b21a5db
CK
679static const struct of_device_id sysmmu_of_match[] __initconst = {
680 { .compatible = "samsung,exynos-sysmmu", },
681 { },
682};
683
684static struct platform_driver exynos_sysmmu_driver __refdata = {
685 .probe = exynos_sysmmu_probe,
686 .driver = {
2a96536e 687 .name = "exynos-sysmmu",
6b21a5db 688 .of_match_table = sysmmu_of_match,
622015e4 689 .pm = &sysmmu_pm_ops,
b54b874f 690 .suppress_bind_attrs = true,
2a96536e
KC
691 }
692};
693
5e3435eb 694static inline void update_pte(sysmmu_pte_t *ent, sysmmu_pte_t val)
2a96536e 695{
5e3435eb
MS
696 dma_sync_single_for_cpu(dma_dev, virt_to_phys(ent), sizeof(*ent),
697 DMA_TO_DEVICE);
6ae5343c 698 *ent = cpu_to_le32(val);
5e3435eb
MS
699 dma_sync_single_for_device(dma_dev, virt_to_phys(ent), sizeof(*ent),
700 DMA_TO_DEVICE);
2a96536e
KC
701}
702
e1fd1eaa 703static struct iommu_domain *exynos_iommu_domain_alloc(unsigned type)
2a96536e 704{
bfa00489 705 struct exynos_iommu_domain *domain;
5e3435eb 706 dma_addr_t handle;
66a7ed84 707 int i;
2a96536e 708
740a01ee
MS
709 /* Check if correct PTE offsets are initialized */
710 BUG_ON(PG_ENT_SHIFT < 0 || !dma_dev);
e1fd1eaa 711
bfa00489
MS
712 domain = kzalloc(sizeof(*domain), GFP_KERNEL);
713 if (!domain)
e1fd1eaa 714 return NULL;
2a96536e 715
58c6f6a3
MS
716 if (type == IOMMU_DOMAIN_DMA) {
717 if (iommu_get_dma_cookie(&domain->domain) != 0)
718 goto err_pgtable;
719 } else if (type != IOMMU_DOMAIN_UNMANAGED) {
720 goto err_pgtable;
721 }
722
bfa00489
MS
723 domain->pgtable = (sysmmu_pte_t *)__get_free_pages(GFP_KERNEL, 2);
724 if (!domain->pgtable)
58c6f6a3 725 goto err_dma_cookie;
2a96536e 726
bfa00489
MS
727 domain->lv2entcnt = (short *)__get_free_pages(GFP_KERNEL | __GFP_ZERO, 1);
728 if (!domain->lv2entcnt)
2a96536e
KC
729 goto err_counter;
730
f171abab 731 /* Workaround for System MMU v3.3 to prevent caching 1MiB mapping */
66a7ed84 732 for (i = 0; i < NUM_LV1ENTRIES; i += 8) {
bfa00489
MS
733 domain->pgtable[i + 0] = ZERO_LV2LINK;
734 domain->pgtable[i + 1] = ZERO_LV2LINK;
735 domain->pgtable[i + 2] = ZERO_LV2LINK;
736 domain->pgtable[i + 3] = ZERO_LV2LINK;
737 domain->pgtable[i + 4] = ZERO_LV2LINK;
738 domain->pgtable[i + 5] = ZERO_LV2LINK;
739 domain->pgtable[i + 6] = ZERO_LV2LINK;
740 domain->pgtable[i + 7] = ZERO_LV2LINK;
66a7ed84
CK
741 }
742
5e3435eb
MS
743 handle = dma_map_single(dma_dev, domain->pgtable, LV1TABLE_SIZE,
744 DMA_TO_DEVICE);
745 /* For mapping page table entries we rely on dma == phys */
746 BUG_ON(handle != virt_to_phys(domain->pgtable));
0d6d3da4
MS
747 if (dma_mapping_error(dma_dev, handle))
748 goto err_lv2ent;
2a96536e 749
bfa00489
MS
750 spin_lock_init(&domain->lock);
751 spin_lock_init(&domain->pgtablelock);
752 INIT_LIST_HEAD(&domain->clients);
2a96536e 753
bfa00489
MS
754 domain->domain.geometry.aperture_start = 0;
755 domain->domain.geometry.aperture_end = ~0UL;
756 domain->domain.geometry.force_aperture = true;
3177bb76 757
bfa00489 758 return &domain->domain;
2a96536e 759
0d6d3da4
MS
760err_lv2ent:
761 free_pages((unsigned long)domain->lv2entcnt, 1);
2a96536e 762err_counter:
bfa00489 763 free_pages((unsigned long)domain->pgtable, 2);
58c6f6a3
MS
764err_dma_cookie:
765 if (type == IOMMU_DOMAIN_DMA)
766 iommu_put_dma_cookie(&domain->domain);
2a96536e 767err_pgtable:
bfa00489 768 kfree(domain);
e1fd1eaa 769 return NULL;
2a96536e
KC
770}
771
bfa00489 772static void exynos_iommu_domain_free(struct iommu_domain *iommu_domain)
2a96536e 773{
bfa00489 774 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
469acebe 775 struct sysmmu_drvdata *data, *next;
2a96536e
KC
776 unsigned long flags;
777 int i;
778
bfa00489 779 WARN_ON(!list_empty(&domain->clients));
2a96536e 780
bfa00489 781 spin_lock_irqsave(&domain->lock, flags);
2a96536e 782
bfa00489 783 list_for_each_entry_safe(data, next, &domain->clients, domain_node) {
e1172300 784 spin_lock(&data->lock);
b0d4c861 785 __sysmmu_disable(data);
47a574ff
MS
786 data->pgtable = 0;
787 data->domain = NULL;
469acebe 788 list_del_init(&data->domain_node);
e1172300 789 spin_unlock(&data->lock);
2a96536e
KC
790 }
791
bfa00489 792 spin_unlock_irqrestore(&domain->lock, flags);
2a96536e 793
58c6f6a3
MS
794 if (iommu_domain->type == IOMMU_DOMAIN_DMA)
795 iommu_put_dma_cookie(iommu_domain);
796
5e3435eb
MS
797 dma_unmap_single(dma_dev, virt_to_phys(domain->pgtable), LV1TABLE_SIZE,
798 DMA_TO_DEVICE);
799
2a96536e 800 for (i = 0; i < NUM_LV1ENTRIES; i++)
5e3435eb
MS
801 if (lv1ent_page(domain->pgtable + i)) {
802 phys_addr_t base = lv2table_base(domain->pgtable + i);
803
804 dma_unmap_single(dma_dev, base, LV2TABLE_SIZE,
805 DMA_TO_DEVICE);
734c3c73 806 kmem_cache_free(lv2table_kmem_cache,
5e3435eb
MS
807 phys_to_virt(base));
808 }
2a96536e 809
bfa00489
MS
810 free_pages((unsigned long)domain->pgtable, 2);
811 free_pages((unsigned long)domain->lv2entcnt, 1);
812 kfree(domain);
2a96536e
KC
813}
814
5fa61cbf
MS
815static void exynos_iommu_detach_device(struct iommu_domain *iommu_domain,
816 struct device *dev)
817{
818 struct exynos_iommu_owner *owner = dev->archdata.iommu;
819 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
820 phys_addr_t pagetable = virt_to_phys(domain->pgtable);
821 struct sysmmu_drvdata *data, *next;
822 unsigned long flags;
5fa61cbf
MS
823
824 if (!has_sysmmu(dev) || owner->domain != iommu_domain)
825 return;
826
9b265536
MS
827 mutex_lock(&owner->rpm_lock);
828
829 list_for_each_entry(data, &owner->controllers, owner_node) {
830 pm_runtime_get_noresume(data->sysmmu);
831 if (pm_runtime_active(data->sysmmu))
832 __sysmmu_disable(data);
e1172300
MS
833 pm_runtime_put(data->sysmmu);
834 }
835
5fa61cbf
MS
836 spin_lock_irqsave(&domain->lock, flags);
837 list_for_each_entry_safe(data, next, &domain->clients, domain_node) {
e1172300 838 spin_lock(&data->lock);
47a574ff
MS
839 data->pgtable = 0;
840 data->domain = NULL;
b0d4c861 841 list_del_init(&data->domain_node);
e1172300 842 spin_unlock(&data->lock);
5fa61cbf 843 }
e1172300 844 owner->domain = NULL;
5fa61cbf
MS
845 spin_unlock_irqrestore(&domain->lock, flags);
846
9b265536 847 mutex_unlock(&owner->rpm_lock);
5fa61cbf 848
b0d4c861
MS
849 dev_dbg(dev, "%s: Detached IOMMU with pgtable %pa\n", __func__,
850 &pagetable);
5fa61cbf
MS
851}
852
bfa00489 853static int exynos_iommu_attach_device(struct iommu_domain *iommu_domain,
2a96536e
KC
854 struct device *dev)
855{
6b21a5db 856 struct exynos_iommu_owner *owner = dev->archdata.iommu;
bfa00489 857 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
469acebe 858 struct sysmmu_drvdata *data;
bfa00489 859 phys_addr_t pagetable = virt_to_phys(domain->pgtable);
2a96536e 860 unsigned long flags;
2a96536e 861
469acebe
MS
862 if (!has_sysmmu(dev))
863 return -ENODEV;
2a96536e 864
5fa61cbf
MS
865 if (owner->domain)
866 exynos_iommu_detach_device(owner->domain, dev);
867
9b265536
MS
868 mutex_lock(&owner->rpm_lock);
869
e1172300 870 spin_lock_irqsave(&domain->lock, flags);
1b092054 871 list_for_each_entry(data, &owner->controllers, owner_node) {
e1172300 872 spin_lock(&data->lock);
47a574ff
MS
873 data->pgtable = pagetable;
874 data->domain = domain;
e1172300
MS
875 list_add_tail(&data->domain_node, &domain->clients);
876 spin_unlock(&data->lock);
877 }
878 owner->domain = iommu_domain;
879 spin_unlock_irqrestore(&domain->lock, flags);
880
9b265536
MS
881 list_for_each_entry(data, &owner->controllers, owner_node) {
882 pm_runtime_get_noresume(data->sysmmu);
883 if (pm_runtime_active(data->sysmmu))
884 __sysmmu_enable(data);
885 pm_runtime_put(data->sysmmu);
886 }
887
888 mutex_unlock(&owner->rpm_lock);
889
b0d4c861
MS
890 dev_dbg(dev, "%s: Attached IOMMU with pgtable %pa\n", __func__,
891 &pagetable);
7222e8db 892
b0d4c861 893 return 0;
2a96536e
KC
894}
895
bfa00489 896static sysmmu_pte_t *alloc_lv2entry(struct exynos_iommu_domain *domain,
66a7ed84 897 sysmmu_pte_t *sent, sysmmu_iova_t iova, short *pgcounter)
2a96536e 898{
61128f08 899 if (lv1ent_section(sent)) {
d09d78fc 900 WARN(1, "Trying mapping on %#08x mapped with 1MiB page", iova);
61128f08
CK
901 return ERR_PTR(-EADDRINUSE);
902 }
903
2a96536e 904 if (lv1ent_fault(sent)) {
0d6d3da4 905 dma_addr_t handle;
d09d78fc 906 sysmmu_pte_t *pent;
66a7ed84 907 bool need_flush_flpd_cache = lv1ent_zero(sent);
2a96536e 908
734c3c73 909 pent = kmem_cache_zalloc(lv2table_kmem_cache, GFP_ATOMIC);
dbf6c6ef 910 BUG_ON((uintptr_t)pent & (LV2TABLE_SIZE - 1));
2a96536e 911 if (!pent)
61128f08 912 return ERR_PTR(-ENOMEM);
2a96536e 913
5e3435eb 914 update_pte(sent, mk_lv1ent_page(virt_to_phys(pent)));
dc3814f4 915 kmemleak_ignore(pent);
2a96536e 916 *pgcounter = NUM_LV2ENTRIES;
0d6d3da4
MS
917 handle = dma_map_single(dma_dev, pent, LV2TABLE_SIZE,
918 DMA_TO_DEVICE);
919 if (dma_mapping_error(dma_dev, handle)) {
920 kmem_cache_free(lv2table_kmem_cache, pent);
921 return ERR_PTR(-EADDRINUSE);
922 }
66a7ed84
CK
923
924 /*
f171abab
SK
925 * If pre-fetched SLPD is a faulty SLPD in zero_l2_table,
926 * FLPD cache may cache the address of zero_l2_table. This
927 * function replaces the zero_l2_table with new L2 page table
928 * to write valid mappings.
66a7ed84 929 * Accessing the valid area may cause page fault since FLPD
f171abab
SK
930 * cache may still cache zero_l2_table for the valid area
931 * instead of new L2 page table that has the mapping
932 * information of the valid area.
66a7ed84
CK
933 * Thus any replacement of zero_l2_table with other valid L2
934 * page table must involve FLPD cache invalidation for System
935 * MMU v3.3.
936 * FLPD cache invalidation is performed with TLB invalidation
937 * by VPN without blocking. It is safe to invalidate TLB without
938 * blocking because the target address of TLB invalidation is
939 * not currently mapped.
940 */
941 if (need_flush_flpd_cache) {
469acebe 942 struct sysmmu_drvdata *data;
365409db 943
bfa00489
MS
944 spin_lock(&domain->lock);
945 list_for_each_entry(data, &domain->clients, domain_node)
469acebe 946 sysmmu_tlb_invalidate_flpdcache(data, iova);
bfa00489 947 spin_unlock(&domain->lock);
66a7ed84 948 }
2a96536e
KC
949 }
950
951 return page_entry(sent, iova);
952}
953
bfa00489 954static int lv1set_section(struct exynos_iommu_domain *domain,
66a7ed84 955 sysmmu_pte_t *sent, sysmmu_iova_t iova,
1a0d8dac 956 phys_addr_t paddr, int prot, short *pgcnt)
2a96536e 957{
61128f08 958 if (lv1ent_section(sent)) {
d09d78fc 959 WARN(1, "Trying mapping on 1MiB@%#08x that is mapped",
61128f08 960 iova);
2a96536e 961 return -EADDRINUSE;
61128f08 962 }
2a96536e
KC
963
964 if (lv1ent_page(sent)) {
61128f08 965 if (*pgcnt != NUM_LV2ENTRIES) {
d09d78fc 966 WARN(1, "Trying mapping on 1MiB@%#08x that is mapped",
61128f08 967 iova);
2a96536e 968 return -EADDRINUSE;
61128f08 969 }
2a96536e 970
734c3c73 971 kmem_cache_free(lv2table_kmem_cache, page_entry(sent, 0));
2a96536e
KC
972 *pgcnt = 0;
973 }
974
1a0d8dac 975 update_pte(sent, mk_lv1ent_sect(paddr, prot));
2a96536e 976
bfa00489 977 spin_lock(&domain->lock);
66a7ed84 978 if (lv1ent_page_zero(sent)) {
469acebe 979 struct sysmmu_drvdata *data;
66a7ed84
CK
980 /*
981 * Flushing FLPD cache in System MMU v3.3 that may cache a FLPD
982 * entry by speculative prefetch of SLPD which has no mapping.
983 */
bfa00489 984 list_for_each_entry(data, &domain->clients, domain_node)
469acebe 985 sysmmu_tlb_invalidate_flpdcache(data, iova);
66a7ed84 986 }
bfa00489 987 spin_unlock(&domain->lock);
66a7ed84 988
2a96536e
KC
989 return 0;
990}
991
d09d78fc 992static int lv2set_page(sysmmu_pte_t *pent, phys_addr_t paddr, size_t size,
1a0d8dac 993 int prot, short *pgcnt)
2a96536e
KC
994{
995 if (size == SPAGE_SIZE) {
0bf4e54d 996 if (WARN_ON(!lv2ent_fault(pent)))
2a96536e
KC
997 return -EADDRINUSE;
998
1a0d8dac 999 update_pte(pent, mk_lv2ent_spage(paddr, prot));
2a96536e
KC
1000 *pgcnt -= 1;
1001 } else { /* size == LPAGE_SIZE */
1002 int i;
5e3435eb 1003 dma_addr_t pent_base = virt_to_phys(pent);
365409db 1004
5e3435eb
MS
1005 dma_sync_single_for_cpu(dma_dev, pent_base,
1006 sizeof(*pent) * SPAGES_PER_LPAGE,
1007 DMA_TO_DEVICE);
2a96536e 1008 for (i = 0; i < SPAGES_PER_LPAGE; i++, pent++) {
0bf4e54d 1009 if (WARN_ON(!lv2ent_fault(pent))) {
61128f08
CK
1010 if (i > 0)
1011 memset(pent - i, 0, sizeof(*pent) * i);
2a96536e
KC
1012 return -EADDRINUSE;
1013 }
1014
1a0d8dac 1015 *pent = mk_lv2ent_lpage(paddr, prot);
2a96536e 1016 }
5e3435eb
MS
1017 dma_sync_single_for_device(dma_dev, pent_base,
1018 sizeof(*pent) * SPAGES_PER_LPAGE,
1019 DMA_TO_DEVICE);
2a96536e
KC
1020 *pgcnt -= SPAGES_PER_LPAGE;
1021 }
1022
1023 return 0;
1024}
1025
66a7ed84
CK
1026/*
1027 * *CAUTION* to the I/O virtual memory managers that support exynos-iommu:
1028 *
f171abab 1029 * System MMU v3.x has advanced logic to improve address translation
66a7ed84 1030 * performance with caching more page table entries by a page table walk.
f171abab
SK
1031 * However, the logic has a bug that while caching faulty page table entries,
1032 * System MMU reports page fault if the cached fault entry is hit even though
1033 * the fault entry is updated to a valid entry after the entry is cached.
1034 * To prevent caching faulty page table entries which may be updated to valid
1035 * entries later, the virtual memory manager should care about the workaround
1036 * for the problem. The following describes the workaround.
66a7ed84
CK
1037 *
1038 * Any two consecutive I/O virtual address regions must have a hole of 128KiB
f171abab 1039 * at maximum to prevent misbehavior of System MMU 3.x (workaround for h/w bug).
66a7ed84 1040 *
f171abab 1041 * Precisely, any start address of I/O virtual region must be aligned with
66a7ed84
CK
1042 * the following sizes for System MMU v3.1 and v3.2.
1043 * System MMU v3.1: 128KiB
1044 * System MMU v3.2: 256KiB
1045 *
1046 * Because System MMU v3.3 caches page table entries more aggressively, it needs
f171abab
SK
1047 * more workarounds.
1048 * - Any two consecutive I/O virtual regions must have a hole of size larger
1049 * than or equal to 128KiB.
66a7ed84
CK
1050 * - Start address of an I/O virtual region must be aligned by 128KiB.
1051 */
bfa00489
MS
1052static int exynos_iommu_map(struct iommu_domain *iommu_domain,
1053 unsigned long l_iova, phys_addr_t paddr, size_t size,
1054 int prot)
2a96536e 1055{
bfa00489 1056 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
d09d78fc
CK
1057 sysmmu_pte_t *entry;
1058 sysmmu_iova_t iova = (sysmmu_iova_t)l_iova;
2a96536e
KC
1059 unsigned long flags;
1060 int ret = -ENOMEM;
1061
bfa00489 1062 BUG_ON(domain->pgtable == NULL);
1a0d8dac 1063 prot &= SYSMMU_SUPPORTED_PROT_BITS;
2a96536e 1064
bfa00489 1065 spin_lock_irqsave(&domain->pgtablelock, flags);
2a96536e 1066
bfa00489 1067 entry = section_entry(domain->pgtable, iova);
2a96536e
KC
1068
1069 if (size == SECT_SIZE) {
1a0d8dac 1070 ret = lv1set_section(domain, entry, iova, paddr, prot,
bfa00489 1071 &domain->lv2entcnt[lv1ent_offset(iova)]);
2a96536e 1072 } else {
d09d78fc 1073 sysmmu_pte_t *pent;
2a96536e 1074
bfa00489
MS
1075 pent = alloc_lv2entry(domain, entry, iova,
1076 &domain->lv2entcnt[lv1ent_offset(iova)]);
2a96536e 1077
61128f08
CK
1078 if (IS_ERR(pent))
1079 ret = PTR_ERR(pent);
2a96536e 1080 else
1a0d8dac 1081 ret = lv2set_page(pent, paddr, size, prot,
bfa00489 1082 &domain->lv2entcnt[lv1ent_offset(iova)]);
2a96536e
KC
1083 }
1084
61128f08 1085 if (ret)
0bf4e54d
CK
1086 pr_err("%s: Failed(%d) to map %#zx bytes @ %#x\n",
1087 __func__, ret, size, iova);
2a96536e 1088
bfa00489 1089 spin_unlock_irqrestore(&domain->pgtablelock, flags);
2a96536e
KC
1090
1091 return ret;
1092}
1093
bfa00489
MS
1094static void exynos_iommu_tlb_invalidate_entry(struct exynos_iommu_domain *domain,
1095 sysmmu_iova_t iova, size_t size)
66a7ed84 1096{
469acebe 1097 struct sysmmu_drvdata *data;
66a7ed84
CK
1098 unsigned long flags;
1099
bfa00489 1100 spin_lock_irqsave(&domain->lock, flags);
66a7ed84 1101
bfa00489 1102 list_for_each_entry(data, &domain->clients, domain_node)
469acebe 1103 sysmmu_tlb_invalidate_entry(data, iova, size);
66a7ed84 1104
bfa00489 1105 spin_unlock_irqrestore(&domain->lock, flags);
66a7ed84
CK
1106}
1107
bfa00489
MS
1108static size_t exynos_iommu_unmap(struct iommu_domain *iommu_domain,
1109 unsigned long l_iova, size_t size)
2a96536e 1110{
bfa00489 1111 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
d09d78fc
CK
1112 sysmmu_iova_t iova = (sysmmu_iova_t)l_iova;
1113 sysmmu_pte_t *ent;
61128f08 1114 size_t err_pgsize;
d09d78fc 1115 unsigned long flags;
2a96536e 1116
bfa00489 1117 BUG_ON(domain->pgtable == NULL);
2a96536e 1118
bfa00489 1119 spin_lock_irqsave(&domain->pgtablelock, flags);
2a96536e 1120
bfa00489 1121 ent = section_entry(domain->pgtable, iova);
2a96536e
KC
1122
1123 if (lv1ent_section(ent)) {
0bf4e54d 1124 if (WARN_ON(size < SECT_SIZE)) {
61128f08
CK
1125 err_pgsize = SECT_SIZE;
1126 goto err;
1127 }
2a96536e 1128
f171abab 1129 /* workaround for h/w bug in System MMU v3.3 */
5e3435eb 1130 update_pte(ent, ZERO_LV2LINK);
2a96536e
KC
1131 size = SECT_SIZE;
1132 goto done;
1133 }
1134
1135 if (unlikely(lv1ent_fault(ent))) {
1136 if (size > SECT_SIZE)
1137 size = SECT_SIZE;
1138 goto done;
1139 }
1140
1141 /* lv1ent_page(sent) == true here */
1142
1143 ent = page_entry(ent, iova);
1144
1145 if (unlikely(lv2ent_fault(ent))) {
1146 size = SPAGE_SIZE;
1147 goto done;
1148 }
1149
1150 if (lv2ent_small(ent)) {
5e3435eb 1151 update_pte(ent, 0);
2a96536e 1152 size = SPAGE_SIZE;
bfa00489 1153 domain->lv2entcnt[lv1ent_offset(iova)] += 1;
2a96536e
KC
1154 goto done;
1155 }
1156
1157 /* lv1ent_large(ent) == true here */
0bf4e54d 1158 if (WARN_ON(size < LPAGE_SIZE)) {
61128f08
CK
1159 err_pgsize = LPAGE_SIZE;
1160 goto err;
1161 }
2a96536e 1162
5e3435eb
MS
1163 dma_sync_single_for_cpu(dma_dev, virt_to_phys(ent),
1164 sizeof(*ent) * SPAGES_PER_LPAGE,
1165 DMA_TO_DEVICE);
2a96536e 1166 memset(ent, 0, sizeof(*ent) * SPAGES_PER_LPAGE);
5e3435eb
MS
1167 dma_sync_single_for_device(dma_dev, virt_to_phys(ent),
1168 sizeof(*ent) * SPAGES_PER_LPAGE,
1169 DMA_TO_DEVICE);
2a96536e 1170 size = LPAGE_SIZE;
bfa00489 1171 domain->lv2entcnt[lv1ent_offset(iova)] += SPAGES_PER_LPAGE;
2a96536e 1172done:
bfa00489 1173 spin_unlock_irqrestore(&domain->pgtablelock, flags);
2a96536e 1174
bfa00489 1175 exynos_iommu_tlb_invalidate_entry(domain, iova, size);
2a96536e 1176
2a96536e 1177 return size;
61128f08 1178err:
bfa00489 1179 spin_unlock_irqrestore(&domain->pgtablelock, flags);
61128f08 1180
0bf4e54d
CK
1181 pr_err("%s: Failed: size(%#zx) @ %#x is smaller than page size %#zx\n",
1182 __func__, size, iova, err_pgsize);
61128f08
CK
1183
1184 return 0;
2a96536e
KC
1185}
1186
bfa00489 1187static phys_addr_t exynos_iommu_iova_to_phys(struct iommu_domain *iommu_domain,
bb5547ac 1188 dma_addr_t iova)
2a96536e 1189{
bfa00489 1190 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
d09d78fc 1191 sysmmu_pte_t *entry;
2a96536e
KC
1192 unsigned long flags;
1193 phys_addr_t phys = 0;
1194
bfa00489 1195 spin_lock_irqsave(&domain->pgtablelock, flags);
2a96536e 1196
bfa00489 1197 entry = section_entry(domain->pgtable, iova);
2a96536e
KC
1198
1199 if (lv1ent_section(entry)) {
1200 phys = section_phys(entry) + section_offs(iova);
1201 } else if (lv1ent_page(entry)) {
1202 entry = page_entry(entry, iova);
1203
1204 if (lv2ent_large(entry))
1205 phys = lpage_phys(entry) + lpage_offs(iova);
1206 else if (lv2ent_small(entry))
1207 phys = spage_phys(entry) + spage_offs(iova);
1208 }
1209
bfa00489 1210 spin_unlock_irqrestore(&domain->pgtablelock, flags);
2a96536e
KC
1211
1212 return phys;
1213}
1214
6c2ae7e2
MS
1215static struct iommu_group *get_device_iommu_group(struct device *dev)
1216{
1217 struct iommu_group *group;
1218
1219 group = iommu_group_get(dev);
1220 if (!group)
1221 group = iommu_group_alloc();
1222
1223 return group;
1224}
1225
bf4a1c92
AM
1226static int exynos_iommu_add_device(struct device *dev)
1227{
1228 struct iommu_group *group;
bf4a1c92 1229
06801db0
MS
1230 if (!has_sysmmu(dev))
1231 return -ENODEV;
1232
6c2ae7e2 1233 group = iommu_group_get_for_dev(dev);
bf4a1c92 1234
6c2ae7e2
MS
1235 if (IS_ERR(group))
1236 return PTR_ERR(group);
bf4a1c92 1237
bf4a1c92
AM
1238 iommu_group_put(group);
1239
6c2ae7e2 1240 return 0;
bf4a1c92
AM
1241}
1242
1243static void exynos_iommu_remove_device(struct device *dev)
1244{
06801db0
MS
1245 if (!has_sysmmu(dev))
1246 return;
1247
bf4a1c92
AM
1248 iommu_group_remove_device(dev);
1249}
1250
aa759fd3
MS
1251static int exynos_iommu_of_xlate(struct device *dev,
1252 struct of_phandle_args *spec)
1253{
1254 struct exynos_iommu_owner *owner = dev->archdata.iommu;
1255 struct platform_device *sysmmu = of_find_device_by_node(spec->np);
1256 struct sysmmu_drvdata *data;
1257
1258 if (!sysmmu)
1259 return -ENODEV;
1260
1261 data = platform_get_drvdata(sysmmu);
1262 if (!data)
1263 return -ENODEV;
1264
1265 if (!owner) {
1266 owner = kzalloc(sizeof(*owner), GFP_KERNEL);
1267 if (!owner)
1268 return -ENOMEM;
1269
1270 INIT_LIST_HEAD(&owner->controllers);
9b265536 1271 mutex_init(&owner->rpm_lock);
aa759fd3
MS
1272 dev->archdata.iommu = owner;
1273 }
1274
1275 list_add_tail(&data->owner_node, &owner->controllers);
92798b45 1276 data->master = dev;
2f5f44f2
MS
1277
1278 /*
1279 * SYSMMU will be runtime activated via device link (dependency) to its
1280 * master device, so there are no direct calls to pm_runtime_get/put
1281 * in this driver.
1282 */
1283 device_link_add(dev, data->sysmmu, DL_FLAG_PM_RUNTIME);
1284
aa759fd3
MS
1285 return 0;
1286}
1287
8ed55c81 1288static struct iommu_ops exynos_iommu_ops = {
e1fd1eaa
JR
1289 .domain_alloc = exynos_iommu_domain_alloc,
1290 .domain_free = exynos_iommu_domain_free,
ba5fa6f6
BH
1291 .attach_dev = exynos_iommu_attach_device,
1292 .detach_dev = exynos_iommu_detach_device,
1293 .map = exynos_iommu_map,
1294 .unmap = exynos_iommu_unmap,
315786eb 1295 .map_sg = default_iommu_map_sg,
ba5fa6f6 1296 .iova_to_phys = exynos_iommu_iova_to_phys,
6c2ae7e2 1297 .device_group = get_device_iommu_group,
ba5fa6f6
BH
1298 .add_device = exynos_iommu_add_device,
1299 .remove_device = exynos_iommu_remove_device,
2a96536e 1300 .pgsize_bitmap = SECT_SIZE | LPAGE_SIZE | SPAGE_SIZE,
aa759fd3 1301 .of_xlate = exynos_iommu_of_xlate,
2a96536e
KC
1302};
1303
8ed55c81
MS
1304static bool init_done;
1305
2a96536e
KC
1306static int __init exynos_iommu_init(void)
1307{
1308 int ret;
1309
734c3c73
CK
1310 lv2table_kmem_cache = kmem_cache_create("exynos-iommu-lv2table",
1311 LV2TABLE_SIZE, LV2TABLE_SIZE, 0, NULL);
1312 if (!lv2table_kmem_cache) {
1313 pr_err("%s: Failed to create kmem cache\n", __func__);
1314 return -ENOMEM;
1315 }
1316
2a96536e 1317 ret = platform_driver_register(&exynos_sysmmu_driver);
734c3c73
CK
1318 if (ret) {
1319 pr_err("%s: Failed to register driver\n", __func__);
1320 goto err_reg_driver;
1321 }
2a96536e 1322
66a7ed84
CK
1323 zero_lv2_table = kmem_cache_zalloc(lv2table_kmem_cache, GFP_KERNEL);
1324 if (zero_lv2_table == NULL) {
1325 pr_err("%s: Failed to allocate zero level2 page table\n",
1326 __func__);
1327 ret = -ENOMEM;
1328 goto err_zero_lv2;
1329 }
1330
734c3c73
CK
1331 ret = bus_set_iommu(&platform_bus_type, &exynos_iommu_ops);
1332 if (ret) {
1333 pr_err("%s: Failed to register exynos-iommu driver.\n",
1334 __func__);
1335 goto err_set_iommu;
1336 }
2a96536e 1337
8ed55c81
MS
1338 init_done = true;
1339
734c3c73
CK
1340 return 0;
1341err_set_iommu:
66a7ed84
CK
1342 kmem_cache_free(lv2table_kmem_cache, zero_lv2_table);
1343err_zero_lv2:
734c3c73
CK
1344 platform_driver_unregister(&exynos_sysmmu_driver);
1345err_reg_driver:
1346 kmem_cache_destroy(lv2table_kmem_cache);
2a96536e
KC
1347 return ret;
1348}
8ed55c81
MS
1349
1350static int __init exynos_iommu_of_setup(struct device_node *np)
1351{
1352 struct platform_device *pdev;
1353
1354 if (!init_done)
1355 exynos_iommu_init();
1356
1357 pdev = of_platform_device_create(np, NULL, platform_bus_type.dev_root);
423595e8
AKC
1358 if (!pdev)
1359 return -ENODEV;
8ed55c81 1360
5e3435eb
MS
1361 /*
1362 * use the first registered sysmmu device for performing
1363 * dma mapping operations on iommu page tables (cpu cache flush)
1364 */
1365 if (!dma_dev)
1366 dma_dev = &pdev->dev;
1367
8ed55c81
MS
1368 return 0;
1369}
1370
1371IOMMU_OF_DECLARE(exynos_iommu_of, "samsung,exynos-sysmmu",
1372 exynos_iommu_of_setup);