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