iommu/exynos: Don't open-code loop unrolling
[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 */
d2c302b6
JR
279
280 struct iommu_device iommu; /* IOMMU core handle */
2a96536e
KC
281};
282
e1fd1eaa
JR
283static struct exynos_iommu_domain *to_exynos_domain(struct iommu_domain *dom)
284{
285 return container_of(dom, struct exynos_iommu_domain, domain);
286}
287
02cdc365 288static void sysmmu_unblock(struct sysmmu_drvdata *data)
2a96536e 289{
84bd0428 290 writel(CTRL_ENABLE, data->sfrbase + REG_MMU_CTRL);
2a96536e
KC
291}
292
02cdc365 293static bool sysmmu_block(struct sysmmu_drvdata *data)
2a96536e
KC
294{
295 int i = 120;
296
84bd0428
MS
297 writel(CTRL_BLOCK, data->sfrbase + REG_MMU_CTRL);
298 while ((i > 0) && !(readl(data->sfrbase + REG_MMU_STATUS) & 1))
2a96536e
KC
299 --i;
300
84bd0428 301 if (!(readl(data->sfrbase + REG_MMU_STATUS) & 1)) {
02cdc365 302 sysmmu_unblock(data);
2a96536e
KC
303 return false;
304 }
305
306 return true;
307}
308
02cdc365 309static void __sysmmu_tlb_invalidate(struct sysmmu_drvdata *data)
2a96536e 310{
740a01ee 311 if (MMU_MAJ_VER(data->version) < 5)
84bd0428 312 writel(0x1, data->sfrbase + REG_MMU_FLUSH);
740a01ee 313 else
84bd0428 314 writel(0x1, data->sfrbase + REG_V5_MMU_FLUSH_ALL);
2a96536e
KC
315}
316
02cdc365 317static void __sysmmu_tlb_invalidate_entry(struct sysmmu_drvdata *data,
d09d78fc 318 sysmmu_iova_t iova, unsigned int num_inv)
2a96536e 319{
3ad6b7f3 320 unsigned int i;
365409db 321
3ad6b7f3 322 for (i = 0; i < num_inv; i++) {
740a01ee 323 if (MMU_MAJ_VER(data->version) < 5)
84bd0428 324 writel((iova & SPAGE_MASK) | 1,
740a01ee
MS
325 data->sfrbase + REG_MMU_FLUSH_ENTRY);
326 else
84bd0428 327 writel((iova & SPAGE_MASK) | 1,
740a01ee 328 data->sfrbase + REG_V5_MMU_FLUSH_ENTRY);
3ad6b7f3
CK
329 iova += SPAGE_SIZE;
330 }
2a96536e
KC
331}
332
02cdc365 333static void __sysmmu_set_ptbase(struct sysmmu_drvdata *data, phys_addr_t pgd)
2a96536e 334{
740a01ee 335 if (MMU_MAJ_VER(data->version) < 5)
84bd0428 336 writel(pgd, data->sfrbase + REG_PT_BASE_ADDR);
740a01ee 337 else
84bd0428 338 writel(pgd >> PAGE_SHIFT,
740a01ee 339 data->sfrbase + REG_V5_PT_BASE_PFN);
2a96536e 340
02cdc365 341 __sysmmu_tlb_invalidate(data);
2a96536e
KC
342}
343
fecc49db
MS
344static void __sysmmu_enable_clocks(struct sysmmu_drvdata *data)
345{
346 BUG_ON(clk_prepare_enable(data->clk_master));
347 BUG_ON(clk_prepare_enable(data->clk));
348 BUG_ON(clk_prepare_enable(data->pclk));
349 BUG_ON(clk_prepare_enable(data->aclk));
350}
351
352static void __sysmmu_disable_clocks(struct sysmmu_drvdata *data)
353{
354 clk_disable_unprepare(data->aclk);
355 clk_disable_unprepare(data->pclk);
356 clk_disable_unprepare(data->clk);
357 clk_disable_unprepare(data->clk_master);
358}
359
850d313e
MS
360static void __sysmmu_get_version(struct sysmmu_drvdata *data)
361{
362 u32 ver;
363
fecc49db 364 __sysmmu_enable_clocks(data);
850d313e 365
84bd0428 366 ver = readl(data->sfrbase + REG_MMU_VERSION);
850d313e
MS
367
368 /* controllers on some SoCs don't report proper version */
369 if (ver == 0x80000001u)
370 data->version = MAKE_MMU_VER(1, 0);
371 else
372 data->version = MMU_RAW_VER(ver);
373
374 dev_dbg(data->sysmmu, "hardware version: %d.%d\n",
375 MMU_MAJ_VER(data->version), MMU_MIN_VER(data->version));
376
fecc49db 377 __sysmmu_disable_clocks(data);
850d313e
MS
378}
379
d093fc7e
MS
380static void show_fault_information(struct sysmmu_drvdata *data,
381 const struct sysmmu_fault_info *finfo,
382 sysmmu_iova_t fault_addr)
2a96536e 383{
d09d78fc 384 sysmmu_pte_t *ent;
2a96536e 385
ec5d241b
MS
386 dev_err(data->sysmmu, "%s: %s FAULT occurred at %#x\n",
387 dev_name(data->master), finfo->name, fault_addr);
388 dev_dbg(data->sysmmu, "Page table base: %pa\n", &data->pgtable);
d093fc7e 389 ent = section_entry(phys_to_virt(data->pgtable), fault_addr);
ec5d241b 390 dev_dbg(data->sysmmu, "\tLv1 entry: %#x\n", *ent);
2a96536e
KC
391 if (lv1ent_page(ent)) {
392 ent = page_entry(ent, fault_addr);
ec5d241b 393 dev_dbg(data->sysmmu, "\t Lv2 entry: %#x\n", *ent);
2a96536e 394 }
2a96536e
KC
395}
396
397static irqreturn_t exynos_sysmmu_irq(int irq, void *dev_id)
398{
f171abab 399 /* SYSMMU is in blocked state when interrupt occurred. */
2a96536e 400 struct sysmmu_drvdata *data = dev_id;
740a01ee
MS
401 const struct sysmmu_fault_info *finfo;
402 unsigned int i, n, itype;
d093fc7e 403 sysmmu_iova_t fault_addr = -1;
740a01ee 404 unsigned short reg_status, reg_clear;
7222e8db 405 int ret = -ENOSYS;
2a96536e 406
47a574ff 407 WARN_ON(!data->active);
2a96536e 408
740a01ee
MS
409 if (MMU_MAJ_VER(data->version) < 5) {
410 reg_status = REG_INT_STATUS;
411 reg_clear = REG_INT_CLEAR;
412 finfo = sysmmu_faults;
413 n = ARRAY_SIZE(sysmmu_faults);
414 } else {
415 reg_status = REG_V5_INT_STATUS;
416 reg_clear = REG_V5_INT_CLEAR;
417 finfo = sysmmu_v5_faults;
418 n = ARRAY_SIZE(sysmmu_v5_faults);
419 }
420
9d4e7a24
CK
421 spin_lock(&data->lock);
422
b398af21 423 clk_enable(data->clk_master);
9d4e7a24 424
84bd0428 425 itype = __ffs(readl(data->sfrbase + reg_status));
d093fc7e
MS
426 for (i = 0; i < n; i++, finfo++)
427 if (finfo->bit == itype)
428 break;
429 /* unknown/unsupported fault */
430 BUG_ON(i == n);
431
432 /* print debug message */
84bd0428 433 fault_addr = readl(data->sfrbase + finfo->addr_reg);
d093fc7e 434 show_fault_information(data, finfo, fault_addr);
2a96536e 435
d093fc7e
MS
436 if (data->domain)
437 ret = report_iommu_fault(&data->domain->domain,
438 data->master, fault_addr, finfo->type);
1fab7fa7
CK
439 /* fault is not recovered by fault handler */
440 BUG_ON(ret != 0);
2a96536e 441
84bd0428 442 writel(1 << itype, data->sfrbase + reg_clear);
1fab7fa7 443
02cdc365 444 sysmmu_unblock(data);
2a96536e 445
b398af21 446 clk_disable(data->clk_master);
70605870 447
9d4e7a24 448 spin_unlock(&data->lock);
2a96536e
KC
449
450 return IRQ_HANDLED;
451}
452
47a574ff 453static void __sysmmu_disable(struct sysmmu_drvdata *data)
2a96536e 454{
47a574ff
MS
455 unsigned long flags;
456
b398af21 457 clk_enable(data->clk_master);
70605870 458
47a574ff 459 spin_lock_irqsave(&data->lock, flags);
84bd0428
MS
460 writel(CTRL_DISABLE, data->sfrbase + REG_MMU_CTRL);
461 writel(0, data->sfrbase + REG_MMU_CFG);
47a574ff 462 data->active = false;
6b21a5db
CK
463 spin_unlock_irqrestore(&data->lock, flags);
464
47a574ff 465 __sysmmu_disable_clocks(data);
6b21a5db 466}
2a96536e 467
6b21a5db
CK
468static void __sysmmu_init_config(struct sysmmu_drvdata *data)
469{
83addecd
MS
470 unsigned int cfg;
471
83addecd
MS
472 if (data->version <= MAKE_MMU_VER(3, 1))
473 cfg = CFG_LRU | CFG_QOS(15);
474 else if (data->version <= MAKE_MMU_VER(3, 2))
475 cfg = CFG_LRU | CFG_QOS(15) | CFG_FLPDCACHE | CFG_SYSSEL;
476 else
477 cfg = CFG_QOS(15) | CFG_FLPDCACHE | CFG_ACGEN;
6b21a5db 478
1a0d8dac
MS
479 cfg |= CFG_EAP; /* enable access protection bits check */
480
84bd0428 481 writel(cfg, data->sfrbase + REG_MMU_CFG);
6b21a5db
CK
482}
483
47a574ff 484static void __sysmmu_enable(struct sysmmu_drvdata *data)
6b21a5db 485{
47a574ff
MS
486 unsigned long flags;
487
fecc49db 488 __sysmmu_enable_clocks(data);
70605870 489
47a574ff 490 spin_lock_irqsave(&data->lock, flags);
84bd0428 491 writel(CTRL_BLOCK, data->sfrbase + REG_MMU_CTRL);
6b21a5db 492 __sysmmu_init_config(data);
02cdc365 493 __sysmmu_set_ptbase(data, data->pgtable);
84bd0428 494 writel(CTRL_ENABLE, data->sfrbase + REG_MMU_CTRL);
47a574ff
MS
495 data->active = true;
496 spin_unlock_irqrestore(&data->lock, flags);
7222e8db 497
fecc49db
MS
498 /*
499 * SYSMMU driver keeps master's clock enabled only for the short
500 * time, while accessing the registers. For performing address
501 * translation during DMA transaction it relies on the client
502 * driver to enable it.
503 */
b398af21 504 clk_disable(data->clk_master);
6b21a5db 505}
70605870 506
469acebe 507static void sysmmu_tlb_invalidate_flpdcache(struct sysmmu_drvdata *data,
66a7ed84
CK
508 sysmmu_iova_t iova)
509{
510 unsigned long flags;
66a7ed84 511
66a7ed84 512 spin_lock_irqsave(&data->lock, flags);
47a574ff 513 if (data->active && data->version >= MAKE_MMU_VER(3, 3)) {
01324ab2
MS
514 clk_enable(data->clk_master);
515 __sysmmu_tlb_invalidate_entry(data, iova, 1);
516 clk_disable(data->clk_master);
d631ea98 517 }
66a7ed84 518 spin_unlock_irqrestore(&data->lock, flags);
66a7ed84
CK
519}
520
469acebe
MS
521static void sysmmu_tlb_invalidate_entry(struct sysmmu_drvdata *data,
522 sysmmu_iova_t iova, size_t size)
2a96536e
KC
523{
524 unsigned long flags;
2a96536e 525
6b21a5db 526 spin_lock_irqsave(&data->lock, flags);
47a574ff 527 if (data->active) {
3ad6b7f3 528 unsigned int num_inv = 1;
70605870 529
b398af21 530 clk_enable(data->clk_master);
70605870 531
3ad6b7f3
CK
532 /*
533 * L2TLB invalidation required
534 * 4KB page: 1 invalidation
f171abab
SK
535 * 64KB page: 16 invalidations
536 * 1MB page: 64 invalidations
3ad6b7f3
CK
537 * because it is set-associative TLB
538 * with 8-way and 64 sets.
539 * 1MB page can be cached in one of all sets.
540 * 64KB page can be one of 16 consecutive sets.
541 */
512bd0c6 542 if (MMU_MAJ_VER(data->version) == 2)
3ad6b7f3
CK
543 num_inv = min_t(unsigned int, size / PAGE_SIZE, 64);
544
02cdc365
MS
545 if (sysmmu_block(data)) {
546 __sysmmu_tlb_invalidate_entry(data, iova, num_inv);
547 sysmmu_unblock(data);
2a96536e 548 }
b398af21 549 clk_disable(data->clk_master);
2a96536e 550 }
9d4e7a24 551 spin_unlock_irqrestore(&data->lock, flags);
2a96536e
KC
552}
553
96f66557
MS
554static struct iommu_ops exynos_iommu_ops;
555
6b21a5db 556static int __init exynos_sysmmu_probe(struct platform_device *pdev)
2a96536e 557{
46c16d1e 558 int irq, ret;
7222e8db 559 struct device *dev = &pdev->dev;
2a96536e 560 struct sysmmu_drvdata *data;
7222e8db 561 struct resource *res;
2a96536e 562
46c16d1e
CK
563 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
564 if (!data)
565 return -ENOMEM;
2a96536e 566
7222e8db 567 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
46c16d1e
CK
568 data->sfrbase = devm_ioremap_resource(dev, res);
569 if (IS_ERR(data->sfrbase))
570 return PTR_ERR(data->sfrbase);
2a96536e 571
46c16d1e
CK
572 irq = platform_get_irq(pdev, 0);
573 if (irq <= 0) {
0bf4e54d 574 dev_err(dev, "Unable to find IRQ resource\n");
46c16d1e 575 return irq;
2a96536e
KC
576 }
577
46c16d1e 578 ret = devm_request_irq(dev, irq, exynos_sysmmu_irq, 0,
7222e8db
CK
579 dev_name(dev), data);
580 if (ret) {
46c16d1e
CK
581 dev_err(dev, "Unabled to register handler of irq %d\n", irq);
582 return ret;
2a96536e
KC
583 }
584
46c16d1e 585 data->clk = devm_clk_get(dev, "sysmmu");
0c2b063f 586 if (PTR_ERR(data->clk) == -ENOENT)
740a01ee 587 data->clk = NULL;
0c2b063f
MS
588 else if (IS_ERR(data->clk))
589 return PTR_ERR(data->clk);
740a01ee
MS
590
591 data->aclk = devm_clk_get(dev, "aclk");
0c2b063f 592 if (PTR_ERR(data->aclk) == -ENOENT)
740a01ee 593 data->aclk = NULL;
0c2b063f
MS
594 else if (IS_ERR(data->aclk))
595 return PTR_ERR(data->aclk);
740a01ee
MS
596
597 data->pclk = devm_clk_get(dev, "pclk");
0c2b063f 598 if (PTR_ERR(data->pclk) == -ENOENT)
740a01ee 599 data->pclk = NULL;
0c2b063f
MS
600 else if (IS_ERR(data->pclk))
601 return PTR_ERR(data->pclk);
740a01ee
MS
602
603 if (!data->clk && (!data->aclk || !data->pclk)) {
604 dev_err(dev, "Failed to get device clock(s)!\n");
605 return -ENOSYS;
2a96536e
KC
606 }
607
70605870 608 data->clk_master = devm_clk_get(dev, "master");
0c2b063f 609 if (PTR_ERR(data->clk_master) == -ENOENT)
b398af21 610 data->clk_master = NULL;
0c2b063f
MS
611 else if (IS_ERR(data->clk_master))
612 return PTR_ERR(data->clk_master);
70605870 613
2a96536e 614 data->sysmmu = dev;
9d4e7a24 615 spin_lock_init(&data->lock);
2a96536e 616
d2c302b6
JR
617 ret = iommu_device_sysfs_add(&data->iommu, &pdev->dev, NULL,
618 dev_name(data->sysmmu));
619 if (ret)
620 return ret;
621
622 iommu_device_set_ops(&data->iommu, &exynos_iommu_ops);
623 iommu_device_set_fwnode(&data->iommu, &dev->of_node->fwnode);
624
625 ret = iommu_device_register(&data->iommu);
626 if (ret)
627 return ret;
628
7222e8db
CK
629 platform_set_drvdata(pdev, data);
630
850d313e 631 __sysmmu_get_version(data);
740a01ee 632 if (PG_ENT_SHIFT < 0) {
1a0d8dac 633 if (MMU_MAJ_VER(data->version) < 5) {
740a01ee 634 PG_ENT_SHIFT = SYSMMU_PG_ENT_SHIFT;
1a0d8dac
MS
635 LV1_PROT = SYSMMU_LV1_PROT;
636 LV2_PROT = SYSMMU_LV2_PROT;
637 } else {
740a01ee 638 PG_ENT_SHIFT = SYSMMU_V5_PG_ENT_SHIFT;
1a0d8dac
MS
639 LV1_PROT = SYSMMU_V5_LV1_PROT;
640 LV2_PROT = SYSMMU_V5_LV2_PROT;
641 }
740a01ee
MS
642 }
643
f4723ec1 644 pm_runtime_enable(dev);
2a96536e 645
2a96536e 646 return 0;
2a96536e
KC
647}
648
9b265536 649static int __maybe_unused exynos_sysmmu_suspend(struct device *dev)
622015e4
MS
650{
651 struct sysmmu_drvdata *data = dev_get_drvdata(dev);
47a574ff 652 struct device *master = data->master;
622015e4 653
47a574ff 654 if (master) {
9b265536
MS
655 struct exynos_iommu_owner *owner = master->archdata.iommu;
656
657 mutex_lock(&owner->rpm_lock);
92798b45
MS
658 if (data->domain) {
659 dev_dbg(data->sysmmu, "saving state\n");
660 __sysmmu_disable(data);
661 }
9b265536 662 mutex_unlock(&owner->rpm_lock);
622015e4
MS
663 }
664 return 0;
665}
666
9b265536 667static int __maybe_unused exynos_sysmmu_resume(struct device *dev)
622015e4
MS
668{
669 struct sysmmu_drvdata *data = dev_get_drvdata(dev);
47a574ff 670 struct device *master = data->master;
622015e4 671
47a574ff 672 if (master) {
9b265536
MS
673 struct exynos_iommu_owner *owner = master->archdata.iommu;
674
675 mutex_lock(&owner->rpm_lock);
92798b45
MS
676 if (data->domain) {
677 dev_dbg(data->sysmmu, "restoring state\n");
678 __sysmmu_enable(data);
679 }
9b265536 680 mutex_unlock(&owner->rpm_lock);
622015e4
MS
681 }
682 return 0;
683}
622015e4
MS
684
685static const struct dev_pm_ops sysmmu_pm_ops = {
9b265536 686 SET_RUNTIME_PM_OPS(exynos_sysmmu_suspend, exynos_sysmmu_resume, NULL)
2f5f44f2
MS
687 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
688 pm_runtime_force_resume)
622015e4
MS
689};
690
6b21a5db
CK
691static const struct of_device_id sysmmu_of_match[] __initconst = {
692 { .compatible = "samsung,exynos-sysmmu", },
693 { },
694};
695
696static struct platform_driver exynos_sysmmu_driver __refdata = {
697 .probe = exynos_sysmmu_probe,
698 .driver = {
2a96536e 699 .name = "exynos-sysmmu",
6b21a5db 700 .of_match_table = sysmmu_of_match,
622015e4 701 .pm = &sysmmu_pm_ops,
b54b874f 702 .suppress_bind_attrs = true,
2a96536e
KC
703 }
704};
705
5e3435eb 706static inline void update_pte(sysmmu_pte_t *ent, sysmmu_pte_t val)
2a96536e 707{
5e3435eb
MS
708 dma_sync_single_for_cpu(dma_dev, virt_to_phys(ent), sizeof(*ent),
709 DMA_TO_DEVICE);
6ae5343c 710 *ent = cpu_to_le32(val);
5e3435eb
MS
711 dma_sync_single_for_device(dma_dev, virt_to_phys(ent), sizeof(*ent),
712 DMA_TO_DEVICE);
2a96536e
KC
713}
714
e1fd1eaa 715static struct iommu_domain *exynos_iommu_domain_alloc(unsigned type)
2a96536e 716{
bfa00489 717 struct exynos_iommu_domain *domain;
5e3435eb 718 dma_addr_t handle;
66a7ed84 719 int i;
2a96536e 720
740a01ee
MS
721 /* Check if correct PTE offsets are initialized */
722 BUG_ON(PG_ENT_SHIFT < 0 || !dma_dev);
e1fd1eaa 723
bfa00489
MS
724 domain = kzalloc(sizeof(*domain), GFP_KERNEL);
725 if (!domain)
e1fd1eaa 726 return NULL;
2a96536e 727
58c6f6a3
MS
728 if (type == IOMMU_DOMAIN_DMA) {
729 if (iommu_get_dma_cookie(&domain->domain) != 0)
730 goto err_pgtable;
731 } else if (type != IOMMU_DOMAIN_UNMANAGED) {
732 goto err_pgtable;
733 }
734
bfa00489
MS
735 domain->pgtable = (sysmmu_pte_t *)__get_free_pages(GFP_KERNEL, 2);
736 if (!domain->pgtable)
58c6f6a3 737 goto err_dma_cookie;
2a96536e 738
bfa00489
MS
739 domain->lv2entcnt = (short *)__get_free_pages(GFP_KERNEL | __GFP_ZERO, 1);
740 if (!domain->lv2entcnt)
2a96536e
KC
741 goto err_counter;
742
f171abab 743 /* Workaround for System MMU v3.3 to prevent caching 1MiB mapping */
e7527663
MS
744 for (i = 0; i < NUM_LV1ENTRIES; i++)
745 domain->pgtable[i] = ZERO_LV2LINK;
66a7ed84 746
5e3435eb
MS
747 handle = dma_map_single(dma_dev, domain->pgtable, LV1TABLE_SIZE,
748 DMA_TO_DEVICE);
749 /* For mapping page table entries we rely on dma == phys */
750 BUG_ON(handle != virt_to_phys(domain->pgtable));
0d6d3da4
MS
751 if (dma_mapping_error(dma_dev, handle))
752 goto err_lv2ent;
2a96536e 753
bfa00489
MS
754 spin_lock_init(&domain->lock);
755 spin_lock_init(&domain->pgtablelock);
756 INIT_LIST_HEAD(&domain->clients);
2a96536e 757
bfa00489
MS
758 domain->domain.geometry.aperture_start = 0;
759 domain->domain.geometry.aperture_end = ~0UL;
760 domain->domain.geometry.force_aperture = true;
3177bb76 761
bfa00489 762 return &domain->domain;
2a96536e 763
0d6d3da4
MS
764err_lv2ent:
765 free_pages((unsigned long)domain->lv2entcnt, 1);
2a96536e 766err_counter:
bfa00489 767 free_pages((unsigned long)domain->pgtable, 2);
58c6f6a3
MS
768err_dma_cookie:
769 if (type == IOMMU_DOMAIN_DMA)
770 iommu_put_dma_cookie(&domain->domain);
2a96536e 771err_pgtable:
bfa00489 772 kfree(domain);
e1fd1eaa 773 return NULL;
2a96536e
KC
774}
775
bfa00489 776static void exynos_iommu_domain_free(struct iommu_domain *iommu_domain)
2a96536e 777{
bfa00489 778 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
469acebe 779 struct sysmmu_drvdata *data, *next;
2a96536e
KC
780 unsigned long flags;
781 int i;
782
bfa00489 783 WARN_ON(!list_empty(&domain->clients));
2a96536e 784
bfa00489 785 spin_lock_irqsave(&domain->lock, flags);
2a96536e 786
bfa00489 787 list_for_each_entry_safe(data, next, &domain->clients, domain_node) {
e1172300 788 spin_lock(&data->lock);
b0d4c861 789 __sysmmu_disable(data);
47a574ff
MS
790 data->pgtable = 0;
791 data->domain = NULL;
469acebe 792 list_del_init(&data->domain_node);
e1172300 793 spin_unlock(&data->lock);
2a96536e
KC
794 }
795
bfa00489 796 spin_unlock_irqrestore(&domain->lock, flags);
2a96536e 797
58c6f6a3
MS
798 if (iommu_domain->type == IOMMU_DOMAIN_DMA)
799 iommu_put_dma_cookie(iommu_domain);
800
5e3435eb
MS
801 dma_unmap_single(dma_dev, virt_to_phys(domain->pgtable), LV1TABLE_SIZE,
802 DMA_TO_DEVICE);
803
2a96536e 804 for (i = 0; i < NUM_LV1ENTRIES; i++)
5e3435eb
MS
805 if (lv1ent_page(domain->pgtable + i)) {
806 phys_addr_t base = lv2table_base(domain->pgtable + i);
807
808 dma_unmap_single(dma_dev, base, LV2TABLE_SIZE,
809 DMA_TO_DEVICE);
734c3c73 810 kmem_cache_free(lv2table_kmem_cache,
5e3435eb
MS
811 phys_to_virt(base));
812 }
2a96536e 813
bfa00489
MS
814 free_pages((unsigned long)domain->pgtable, 2);
815 free_pages((unsigned long)domain->lv2entcnt, 1);
816 kfree(domain);
2a96536e
KC
817}
818
5fa61cbf
MS
819static void exynos_iommu_detach_device(struct iommu_domain *iommu_domain,
820 struct device *dev)
821{
822 struct exynos_iommu_owner *owner = dev->archdata.iommu;
823 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
824 phys_addr_t pagetable = virt_to_phys(domain->pgtable);
825 struct sysmmu_drvdata *data, *next;
826 unsigned long flags;
5fa61cbf
MS
827
828 if (!has_sysmmu(dev) || owner->domain != iommu_domain)
829 return;
830
9b265536
MS
831 mutex_lock(&owner->rpm_lock);
832
833 list_for_each_entry(data, &owner->controllers, owner_node) {
834 pm_runtime_get_noresume(data->sysmmu);
835 if (pm_runtime_active(data->sysmmu))
836 __sysmmu_disable(data);
e1172300
MS
837 pm_runtime_put(data->sysmmu);
838 }
839
5fa61cbf
MS
840 spin_lock_irqsave(&domain->lock, flags);
841 list_for_each_entry_safe(data, next, &domain->clients, domain_node) {
e1172300 842 spin_lock(&data->lock);
47a574ff
MS
843 data->pgtable = 0;
844 data->domain = NULL;
b0d4c861 845 list_del_init(&data->domain_node);
e1172300 846 spin_unlock(&data->lock);
5fa61cbf 847 }
e1172300 848 owner->domain = NULL;
5fa61cbf
MS
849 spin_unlock_irqrestore(&domain->lock, flags);
850
9b265536 851 mutex_unlock(&owner->rpm_lock);
5fa61cbf 852
b0d4c861
MS
853 dev_dbg(dev, "%s: Detached IOMMU with pgtable %pa\n", __func__,
854 &pagetable);
5fa61cbf
MS
855}
856
bfa00489 857static int exynos_iommu_attach_device(struct iommu_domain *iommu_domain,
2a96536e
KC
858 struct device *dev)
859{
6b21a5db 860 struct exynos_iommu_owner *owner = dev->archdata.iommu;
bfa00489 861 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
469acebe 862 struct sysmmu_drvdata *data;
bfa00489 863 phys_addr_t pagetable = virt_to_phys(domain->pgtable);
2a96536e 864 unsigned long flags;
2a96536e 865
469acebe
MS
866 if (!has_sysmmu(dev))
867 return -ENODEV;
2a96536e 868
5fa61cbf
MS
869 if (owner->domain)
870 exynos_iommu_detach_device(owner->domain, dev);
871
9b265536
MS
872 mutex_lock(&owner->rpm_lock);
873
e1172300 874 spin_lock_irqsave(&domain->lock, flags);
1b092054 875 list_for_each_entry(data, &owner->controllers, owner_node) {
e1172300 876 spin_lock(&data->lock);
47a574ff
MS
877 data->pgtable = pagetable;
878 data->domain = domain;
e1172300
MS
879 list_add_tail(&data->domain_node, &domain->clients);
880 spin_unlock(&data->lock);
881 }
882 owner->domain = iommu_domain;
883 spin_unlock_irqrestore(&domain->lock, flags);
884
9b265536
MS
885 list_for_each_entry(data, &owner->controllers, owner_node) {
886 pm_runtime_get_noresume(data->sysmmu);
887 if (pm_runtime_active(data->sysmmu))
888 __sysmmu_enable(data);
889 pm_runtime_put(data->sysmmu);
890 }
891
892 mutex_unlock(&owner->rpm_lock);
893
b0d4c861
MS
894 dev_dbg(dev, "%s: Attached IOMMU with pgtable %pa\n", __func__,
895 &pagetable);
7222e8db 896
b0d4c861 897 return 0;
2a96536e
KC
898}
899
bfa00489 900static sysmmu_pte_t *alloc_lv2entry(struct exynos_iommu_domain *domain,
66a7ed84 901 sysmmu_pte_t *sent, sysmmu_iova_t iova, short *pgcounter)
2a96536e 902{
61128f08 903 if (lv1ent_section(sent)) {
d09d78fc 904 WARN(1, "Trying mapping on %#08x mapped with 1MiB page", iova);
61128f08
CK
905 return ERR_PTR(-EADDRINUSE);
906 }
907
2a96536e 908 if (lv1ent_fault(sent)) {
0d6d3da4 909 dma_addr_t handle;
d09d78fc 910 sysmmu_pte_t *pent;
66a7ed84 911 bool need_flush_flpd_cache = lv1ent_zero(sent);
2a96536e 912
734c3c73 913 pent = kmem_cache_zalloc(lv2table_kmem_cache, GFP_ATOMIC);
dbf6c6ef 914 BUG_ON((uintptr_t)pent & (LV2TABLE_SIZE - 1));
2a96536e 915 if (!pent)
61128f08 916 return ERR_PTR(-ENOMEM);
2a96536e 917
5e3435eb 918 update_pte(sent, mk_lv1ent_page(virt_to_phys(pent)));
dc3814f4 919 kmemleak_ignore(pent);
2a96536e 920 *pgcounter = NUM_LV2ENTRIES;
0d6d3da4
MS
921 handle = dma_map_single(dma_dev, pent, LV2TABLE_SIZE,
922 DMA_TO_DEVICE);
923 if (dma_mapping_error(dma_dev, handle)) {
924 kmem_cache_free(lv2table_kmem_cache, pent);
925 return ERR_PTR(-EADDRINUSE);
926 }
66a7ed84
CK
927
928 /*
f171abab
SK
929 * If pre-fetched SLPD is a faulty SLPD in zero_l2_table,
930 * FLPD cache may cache the address of zero_l2_table. This
931 * function replaces the zero_l2_table with new L2 page table
932 * to write valid mappings.
66a7ed84 933 * Accessing the valid area may cause page fault since FLPD
f171abab
SK
934 * cache may still cache zero_l2_table for the valid area
935 * instead of new L2 page table that has the mapping
936 * information of the valid area.
66a7ed84
CK
937 * Thus any replacement of zero_l2_table with other valid L2
938 * page table must involve FLPD cache invalidation for System
939 * MMU v3.3.
940 * FLPD cache invalidation is performed with TLB invalidation
941 * by VPN without blocking. It is safe to invalidate TLB without
942 * blocking because the target address of TLB invalidation is
943 * not currently mapped.
944 */
945 if (need_flush_flpd_cache) {
469acebe 946 struct sysmmu_drvdata *data;
365409db 947
bfa00489
MS
948 spin_lock(&domain->lock);
949 list_for_each_entry(data, &domain->clients, domain_node)
469acebe 950 sysmmu_tlb_invalidate_flpdcache(data, iova);
bfa00489 951 spin_unlock(&domain->lock);
66a7ed84 952 }
2a96536e
KC
953 }
954
955 return page_entry(sent, iova);
956}
957
bfa00489 958static int lv1set_section(struct exynos_iommu_domain *domain,
66a7ed84 959 sysmmu_pte_t *sent, sysmmu_iova_t iova,
1a0d8dac 960 phys_addr_t paddr, int prot, short *pgcnt)
2a96536e 961{
61128f08 962 if (lv1ent_section(sent)) {
d09d78fc 963 WARN(1, "Trying mapping on 1MiB@%#08x that is mapped",
61128f08 964 iova);
2a96536e 965 return -EADDRINUSE;
61128f08 966 }
2a96536e
KC
967
968 if (lv1ent_page(sent)) {
61128f08 969 if (*pgcnt != NUM_LV2ENTRIES) {
d09d78fc 970 WARN(1, "Trying mapping on 1MiB@%#08x that is mapped",
61128f08 971 iova);
2a96536e 972 return -EADDRINUSE;
61128f08 973 }
2a96536e 974
734c3c73 975 kmem_cache_free(lv2table_kmem_cache, page_entry(sent, 0));
2a96536e
KC
976 *pgcnt = 0;
977 }
978
1a0d8dac 979 update_pte(sent, mk_lv1ent_sect(paddr, prot));
2a96536e 980
bfa00489 981 spin_lock(&domain->lock);
66a7ed84 982 if (lv1ent_page_zero(sent)) {
469acebe 983 struct sysmmu_drvdata *data;
66a7ed84
CK
984 /*
985 * Flushing FLPD cache in System MMU v3.3 that may cache a FLPD
986 * entry by speculative prefetch of SLPD which has no mapping.
987 */
bfa00489 988 list_for_each_entry(data, &domain->clients, domain_node)
469acebe 989 sysmmu_tlb_invalidate_flpdcache(data, iova);
66a7ed84 990 }
bfa00489 991 spin_unlock(&domain->lock);
66a7ed84 992
2a96536e
KC
993 return 0;
994}
995
d09d78fc 996static int lv2set_page(sysmmu_pte_t *pent, phys_addr_t paddr, size_t size,
1a0d8dac 997 int prot, short *pgcnt)
2a96536e
KC
998{
999 if (size == SPAGE_SIZE) {
0bf4e54d 1000 if (WARN_ON(!lv2ent_fault(pent)))
2a96536e
KC
1001 return -EADDRINUSE;
1002
1a0d8dac 1003 update_pte(pent, mk_lv2ent_spage(paddr, prot));
2a96536e
KC
1004 *pgcnt -= 1;
1005 } else { /* size == LPAGE_SIZE */
1006 int i;
5e3435eb 1007 dma_addr_t pent_base = virt_to_phys(pent);
365409db 1008
5e3435eb
MS
1009 dma_sync_single_for_cpu(dma_dev, pent_base,
1010 sizeof(*pent) * SPAGES_PER_LPAGE,
1011 DMA_TO_DEVICE);
2a96536e 1012 for (i = 0; i < SPAGES_PER_LPAGE; i++, pent++) {
0bf4e54d 1013 if (WARN_ON(!lv2ent_fault(pent))) {
61128f08
CK
1014 if (i > 0)
1015 memset(pent - i, 0, sizeof(*pent) * i);
2a96536e
KC
1016 return -EADDRINUSE;
1017 }
1018
1a0d8dac 1019 *pent = mk_lv2ent_lpage(paddr, prot);
2a96536e 1020 }
5e3435eb
MS
1021 dma_sync_single_for_device(dma_dev, pent_base,
1022 sizeof(*pent) * SPAGES_PER_LPAGE,
1023 DMA_TO_DEVICE);
2a96536e
KC
1024 *pgcnt -= SPAGES_PER_LPAGE;
1025 }
1026
1027 return 0;
1028}
1029
66a7ed84
CK
1030/*
1031 * *CAUTION* to the I/O virtual memory managers that support exynos-iommu:
1032 *
f171abab 1033 * System MMU v3.x has advanced logic to improve address translation
66a7ed84 1034 * performance with caching more page table entries by a page table walk.
f171abab
SK
1035 * However, the logic has a bug that while caching faulty page table entries,
1036 * System MMU reports page fault if the cached fault entry is hit even though
1037 * the fault entry is updated to a valid entry after the entry is cached.
1038 * To prevent caching faulty page table entries which may be updated to valid
1039 * entries later, the virtual memory manager should care about the workaround
1040 * for the problem. The following describes the workaround.
66a7ed84
CK
1041 *
1042 * Any two consecutive I/O virtual address regions must have a hole of 128KiB
f171abab 1043 * at maximum to prevent misbehavior of System MMU 3.x (workaround for h/w bug).
66a7ed84 1044 *
f171abab 1045 * Precisely, any start address of I/O virtual region must be aligned with
66a7ed84
CK
1046 * the following sizes for System MMU v3.1 and v3.2.
1047 * System MMU v3.1: 128KiB
1048 * System MMU v3.2: 256KiB
1049 *
1050 * Because System MMU v3.3 caches page table entries more aggressively, it needs
f171abab
SK
1051 * more workarounds.
1052 * - Any two consecutive I/O virtual regions must have a hole of size larger
1053 * than or equal to 128KiB.
66a7ed84
CK
1054 * - Start address of an I/O virtual region must be aligned by 128KiB.
1055 */
bfa00489
MS
1056static int exynos_iommu_map(struct iommu_domain *iommu_domain,
1057 unsigned long l_iova, phys_addr_t paddr, size_t size,
1058 int prot)
2a96536e 1059{
bfa00489 1060 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
d09d78fc
CK
1061 sysmmu_pte_t *entry;
1062 sysmmu_iova_t iova = (sysmmu_iova_t)l_iova;
2a96536e
KC
1063 unsigned long flags;
1064 int ret = -ENOMEM;
1065
bfa00489 1066 BUG_ON(domain->pgtable == NULL);
1a0d8dac 1067 prot &= SYSMMU_SUPPORTED_PROT_BITS;
2a96536e 1068
bfa00489 1069 spin_lock_irqsave(&domain->pgtablelock, flags);
2a96536e 1070
bfa00489 1071 entry = section_entry(domain->pgtable, iova);
2a96536e
KC
1072
1073 if (size == SECT_SIZE) {
1a0d8dac 1074 ret = lv1set_section(domain, entry, iova, paddr, prot,
bfa00489 1075 &domain->lv2entcnt[lv1ent_offset(iova)]);
2a96536e 1076 } else {
d09d78fc 1077 sysmmu_pte_t *pent;
2a96536e 1078
bfa00489
MS
1079 pent = alloc_lv2entry(domain, entry, iova,
1080 &domain->lv2entcnt[lv1ent_offset(iova)]);
2a96536e 1081
61128f08
CK
1082 if (IS_ERR(pent))
1083 ret = PTR_ERR(pent);
2a96536e 1084 else
1a0d8dac 1085 ret = lv2set_page(pent, paddr, size, prot,
bfa00489 1086 &domain->lv2entcnt[lv1ent_offset(iova)]);
2a96536e
KC
1087 }
1088
61128f08 1089 if (ret)
0bf4e54d
CK
1090 pr_err("%s: Failed(%d) to map %#zx bytes @ %#x\n",
1091 __func__, ret, size, iova);
2a96536e 1092
bfa00489 1093 spin_unlock_irqrestore(&domain->pgtablelock, flags);
2a96536e
KC
1094
1095 return ret;
1096}
1097
bfa00489
MS
1098static void exynos_iommu_tlb_invalidate_entry(struct exynos_iommu_domain *domain,
1099 sysmmu_iova_t iova, size_t size)
66a7ed84 1100{
469acebe 1101 struct sysmmu_drvdata *data;
66a7ed84
CK
1102 unsigned long flags;
1103
bfa00489 1104 spin_lock_irqsave(&domain->lock, flags);
66a7ed84 1105
bfa00489 1106 list_for_each_entry(data, &domain->clients, domain_node)
469acebe 1107 sysmmu_tlb_invalidate_entry(data, iova, size);
66a7ed84 1108
bfa00489 1109 spin_unlock_irqrestore(&domain->lock, flags);
66a7ed84
CK
1110}
1111
bfa00489
MS
1112static size_t exynos_iommu_unmap(struct iommu_domain *iommu_domain,
1113 unsigned long l_iova, size_t size)
2a96536e 1114{
bfa00489 1115 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
d09d78fc
CK
1116 sysmmu_iova_t iova = (sysmmu_iova_t)l_iova;
1117 sysmmu_pte_t *ent;
61128f08 1118 size_t err_pgsize;
d09d78fc 1119 unsigned long flags;
2a96536e 1120
bfa00489 1121 BUG_ON(domain->pgtable == NULL);
2a96536e 1122
bfa00489 1123 spin_lock_irqsave(&domain->pgtablelock, flags);
2a96536e 1124
bfa00489 1125 ent = section_entry(domain->pgtable, iova);
2a96536e
KC
1126
1127 if (lv1ent_section(ent)) {
0bf4e54d 1128 if (WARN_ON(size < SECT_SIZE)) {
61128f08
CK
1129 err_pgsize = SECT_SIZE;
1130 goto err;
1131 }
2a96536e 1132
f171abab 1133 /* workaround for h/w bug in System MMU v3.3 */
5e3435eb 1134 update_pte(ent, ZERO_LV2LINK);
2a96536e
KC
1135 size = SECT_SIZE;
1136 goto done;
1137 }
1138
1139 if (unlikely(lv1ent_fault(ent))) {
1140 if (size > SECT_SIZE)
1141 size = SECT_SIZE;
1142 goto done;
1143 }
1144
1145 /* lv1ent_page(sent) == true here */
1146
1147 ent = page_entry(ent, iova);
1148
1149 if (unlikely(lv2ent_fault(ent))) {
1150 size = SPAGE_SIZE;
1151 goto done;
1152 }
1153
1154 if (lv2ent_small(ent)) {
5e3435eb 1155 update_pte(ent, 0);
2a96536e 1156 size = SPAGE_SIZE;
bfa00489 1157 domain->lv2entcnt[lv1ent_offset(iova)] += 1;
2a96536e
KC
1158 goto done;
1159 }
1160
1161 /* lv1ent_large(ent) == true here */
0bf4e54d 1162 if (WARN_ON(size < LPAGE_SIZE)) {
61128f08
CK
1163 err_pgsize = LPAGE_SIZE;
1164 goto err;
1165 }
2a96536e 1166
5e3435eb
MS
1167 dma_sync_single_for_cpu(dma_dev, virt_to_phys(ent),
1168 sizeof(*ent) * SPAGES_PER_LPAGE,
1169 DMA_TO_DEVICE);
2a96536e 1170 memset(ent, 0, sizeof(*ent) * SPAGES_PER_LPAGE);
5e3435eb
MS
1171 dma_sync_single_for_device(dma_dev, virt_to_phys(ent),
1172 sizeof(*ent) * SPAGES_PER_LPAGE,
1173 DMA_TO_DEVICE);
2a96536e 1174 size = LPAGE_SIZE;
bfa00489 1175 domain->lv2entcnt[lv1ent_offset(iova)] += SPAGES_PER_LPAGE;
2a96536e 1176done:
bfa00489 1177 spin_unlock_irqrestore(&domain->pgtablelock, flags);
2a96536e 1178
bfa00489 1179 exynos_iommu_tlb_invalidate_entry(domain, iova, size);
2a96536e 1180
2a96536e 1181 return size;
61128f08 1182err:
bfa00489 1183 spin_unlock_irqrestore(&domain->pgtablelock, flags);
61128f08 1184
0bf4e54d
CK
1185 pr_err("%s: Failed: size(%#zx) @ %#x is smaller than page size %#zx\n",
1186 __func__, size, iova, err_pgsize);
61128f08
CK
1187
1188 return 0;
2a96536e
KC
1189}
1190
bfa00489 1191static phys_addr_t exynos_iommu_iova_to_phys(struct iommu_domain *iommu_domain,
bb5547ac 1192 dma_addr_t iova)
2a96536e 1193{
bfa00489 1194 struct exynos_iommu_domain *domain = to_exynos_domain(iommu_domain);
d09d78fc 1195 sysmmu_pte_t *entry;
2a96536e
KC
1196 unsigned long flags;
1197 phys_addr_t phys = 0;
1198
bfa00489 1199 spin_lock_irqsave(&domain->pgtablelock, flags);
2a96536e 1200
bfa00489 1201 entry = section_entry(domain->pgtable, iova);
2a96536e
KC
1202
1203 if (lv1ent_section(entry)) {
1204 phys = section_phys(entry) + section_offs(iova);
1205 } else if (lv1ent_page(entry)) {
1206 entry = page_entry(entry, iova);
1207
1208 if (lv2ent_large(entry))
1209 phys = lpage_phys(entry) + lpage_offs(iova);
1210 else if (lv2ent_small(entry))
1211 phys = spage_phys(entry) + spage_offs(iova);
1212 }
1213
bfa00489 1214 spin_unlock_irqrestore(&domain->pgtablelock, flags);
2a96536e
KC
1215
1216 return phys;
1217}
1218
6c2ae7e2
MS
1219static struct iommu_group *get_device_iommu_group(struct device *dev)
1220{
1221 struct iommu_group *group;
1222
1223 group = iommu_group_get(dev);
1224 if (!group)
1225 group = iommu_group_alloc();
1226
1227 return group;
1228}
1229
bf4a1c92
AM
1230static int exynos_iommu_add_device(struct device *dev)
1231{
1232 struct iommu_group *group;
bf4a1c92 1233
06801db0
MS
1234 if (!has_sysmmu(dev))
1235 return -ENODEV;
1236
6c2ae7e2 1237 group = iommu_group_get_for_dev(dev);
bf4a1c92 1238
6c2ae7e2
MS
1239 if (IS_ERR(group))
1240 return PTR_ERR(group);
bf4a1c92 1241
bf4a1c92
AM
1242 iommu_group_put(group);
1243
6c2ae7e2 1244 return 0;
bf4a1c92
AM
1245}
1246
1247static void exynos_iommu_remove_device(struct device *dev)
1248{
fff2fd1a
MS
1249 struct exynos_iommu_owner *owner = dev->archdata.iommu;
1250
06801db0
MS
1251 if (!has_sysmmu(dev))
1252 return;
1253
fff2fd1a
MS
1254 if (owner->domain) {
1255 struct iommu_group *group = iommu_group_get(dev);
1256
1257 if (group) {
1258 WARN_ON(owner->domain !=
1259 iommu_group_default_domain(group));
1260 exynos_iommu_detach_device(owner->domain, dev);
1261 iommu_group_put(group);
1262 }
1263 }
bf4a1c92
AM
1264 iommu_group_remove_device(dev);
1265}
1266
aa759fd3
MS
1267static int exynos_iommu_of_xlate(struct device *dev,
1268 struct of_phandle_args *spec)
1269{
1270 struct exynos_iommu_owner *owner = dev->archdata.iommu;
1271 struct platform_device *sysmmu = of_find_device_by_node(spec->np);
0bd5a0c7 1272 struct sysmmu_drvdata *data, *entry;
aa759fd3
MS
1273
1274 if (!sysmmu)
1275 return -ENODEV;
1276
1277 data = platform_get_drvdata(sysmmu);
1278 if (!data)
1279 return -ENODEV;
1280
1281 if (!owner) {
1282 owner = kzalloc(sizeof(*owner), GFP_KERNEL);
1283 if (!owner)
1284 return -ENOMEM;
1285
1286 INIT_LIST_HEAD(&owner->controllers);
9b265536 1287 mutex_init(&owner->rpm_lock);
aa759fd3
MS
1288 dev->archdata.iommu = owner;
1289 }
1290
0bd5a0c7
MS
1291 list_for_each_entry(entry, &owner->controllers, owner_node)
1292 if (entry == data)
1293 return 0;
1294
aa759fd3 1295 list_add_tail(&data->owner_node, &owner->controllers);
92798b45 1296 data->master = dev;
2f5f44f2
MS
1297
1298 /*
1299 * SYSMMU will be runtime activated via device link (dependency) to its
1300 * master device, so there are no direct calls to pm_runtime_get/put
1301 * in this driver.
1302 */
1303 device_link_add(dev, data->sysmmu, DL_FLAG_PM_RUNTIME);
1304
aa759fd3
MS
1305 return 0;
1306}
1307
8ed55c81 1308static struct iommu_ops exynos_iommu_ops = {
e1fd1eaa
JR
1309 .domain_alloc = exynos_iommu_domain_alloc,
1310 .domain_free = exynos_iommu_domain_free,
ba5fa6f6
BH
1311 .attach_dev = exynos_iommu_attach_device,
1312 .detach_dev = exynos_iommu_detach_device,
1313 .map = exynos_iommu_map,
1314 .unmap = exynos_iommu_unmap,
315786eb 1315 .map_sg = default_iommu_map_sg,
ba5fa6f6 1316 .iova_to_phys = exynos_iommu_iova_to_phys,
6c2ae7e2 1317 .device_group = get_device_iommu_group,
ba5fa6f6
BH
1318 .add_device = exynos_iommu_add_device,
1319 .remove_device = exynos_iommu_remove_device,
2a96536e 1320 .pgsize_bitmap = SECT_SIZE | LPAGE_SIZE | SPAGE_SIZE,
aa759fd3 1321 .of_xlate = exynos_iommu_of_xlate,
2a96536e
KC
1322};
1323
8ed55c81
MS
1324static bool init_done;
1325
2a96536e
KC
1326static int __init exynos_iommu_init(void)
1327{
1328 int ret;
1329
734c3c73
CK
1330 lv2table_kmem_cache = kmem_cache_create("exynos-iommu-lv2table",
1331 LV2TABLE_SIZE, LV2TABLE_SIZE, 0, NULL);
1332 if (!lv2table_kmem_cache) {
1333 pr_err("%s: Failed to create kmem cache\n", __func__);
1334 return -ENOMEM;
1335 }
1336
2a96536e 1337 ret = platform_driver_register(&exynos_sysmmu_driver);
734c3c73
CK
1338 if (ret) {
1339 pr_err("%s: Failed to register driver\n", __func__);
1340 goto err_reg_driver;
1341 }
2a96536e 1342
66a7ed84
CK
1343 zero_lv2_table = kmem_cache_zalloc(lv2table_kmem_cache, GFP_KERNEL);
1344 if (zero_lv2_table == NULL) {
1345 pr_err("%s: Failed to allocate zero level2 page table\n",
1346 __func__);
1347 ret = -ENOMEM;
1348 goto err_zero_lv2;
1349 }
1350
734c3c73
CK
1351 ret = bus_set_iommu(&platform_bus_type, &exynos_iommu_ops);
1352 if (ret) {
1353 pr_err("%s: Failed to register exynos-iommu driver.\n",
1354 __func__);
1355 goto err_set_iommu;
1356 }
2a96536e 1357
8ed55c81
MS
1358 init_done = true;
1359
734c3c73
CK
1360 return 0;
1361err_set_iommu:
66a7ed84
CK
1362 kmem_cache_free(lv2table_kmem_cache, zero_lv2_table);
1363err_zero_lv2:
734c3c73
CK
1364 platform_driver_unregister(&exynos_sysmmu_driver);
1365err_reg_driver:
1366 kmem_cache_destroy(lv2table_kmem_cache);
2a96536e
KC
1367 return ret;
1368}
8ed55c81
MS
1369
1370static int __init exynos_iommu_of_setup(struct device_node *np)
1371{
1372 struct platform_device *pdev;
1373
1374 if (!init_done)
1375 exynos_iommu_init();
1376
1377 pdev = of_platform_device_create(np, NULL, platform_bus_type.dev_root);
423595e8
AKC
1378 if (!pdev)
1379 return -ENODEV;
8ed55c81 1380
5e3435eb
MS
1381 /*
1382 * use the first registered sysmmu device for performing
1383 * dma mapping operations on iommu page tables (cpu cache flush)
1384 */
1385 if (!dma_dev)
1386 dma_dev = &pdev->dev;
1387
8ed55c81
MS
1388 return 0;
1389}
1390
1391IOMMU_OF_DECLARE(exynos_iommu_of, "samsung,exynos-sysmmu",
1392 exynos_iommu_of_setup);