xref: /openbmc/linux/drivers/iommu/mtk_iommu.c (revision 4f6cce39)
1 /*
2  * Copyright (c) 2015-2016 MediaTek Inc.
3  * Author: Yong Wu <yong.wu@mediatek.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  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14 #include <linux/bootmem.h>
15 #include <linux/bug.h>
16 #include <linux/clk.h>
17 #include <linux/component.h>
18 #include <linux/device.h>
19 #include <linux/dma-iommu.h>
20 #include <linux/err.h>
21 #include <linux/interrupt.h>
22 #include <linux/io.h>
23 #include <linux/iommu.h>
24 #include <linux/iopoll.h>
25 #include <linux/list.h>
26 #include <linux/of_address.h>
27 #include <linux/of_iommu.h>
28 #include <linux/of_irq.h>
29 #include <linux/of_platform.h>
30 #include <linux/platform_device.h>
31 #include <linux/slab.h>
32 #include <linux/spinlock.h>
33 #include <asm/barrier.h>
34 #include <dt-bindings/memory/mt8173-larb-port.h>
35 #include <soc/mediatek/smi.h>
36 
37 #include "mtk_iommu.h"
38 
39 #define REG_MMU_PT_BASE_ADDR			0x000
40 
41 #define REG_MMU_INVALIDATE			0x020
42 #define F_ALL_INVLD				0x2
43 #define F_MMU_INV_RANGE				0x1
44 
45 #define REG_MMU_INVLD_START_A			0x024
46 #define REG_MMU_INVLD_END_A			0x028
47 
48 #define REG_MMU_INV_SEL				0x038
49 #define F_INVLD_EN0				BIT(0)
50 #define F_INVLD_EN1				BIT(1)
51 
52 #define REG_MMU_STANDARD_AXI_MODE		0x048
53 #define REG_MMU_DCM_DIS				0x050
54 
55 #define REG_MMU_CTRL_REG			0x110
56 #define F_MMU_PREFETCH_RT_REPLACE_MOD		BIT(4)
57 #define F_MMU_TF_PROTECT_SEL(prot)		(((prot) & 0x3) << 5)
58 
59 #define REG_MMU_IVRP_PADDR			0x114
60 #define F_MMU_IVRP_PA_SET(pa, ext)		(((pa) >> 1) | ((!!(ext)) << 31))
61 
62 #define REG_MMU_INT_CONTROL0			0x120
63 #define F_L2_MULIT_HIT_EN			BIT(0)
64 #define F_TABLE_WALK_FAULT_INT_EN		BIT(1)
65 #define F_PREETCH_FIFO_OVERFLOW_INT_EN		BIT(2)
66 #define F_MISS_FIFO_OVERFLOW_INT_EN		BIT(3)
67 #define F_PREFETCH_FIFO_ERR_INT_EN		BIT(5)
68 #define F_MISS_FIFO_ERR_INT_EN			BIT(6)
69 #define F_INT_CLR_BIT				BIT(12)
70 
71 #define REG_MMU_INT_MAIN_CONTROL		0x124
72 #define F_INT_TRANSLATION_FAULT			BIT(0)
73 #define F_INT_MAIN_MULTI_HIT_FAULT		BIT(1)
74 #define F_INT_INVALID_PA_FAULT			BIT(2)
75 #define F_INT_ENTRY_REPLACEMENT_FAULT		BIT(3)
76 #define F_INT_TLB_MISS_FAULT			BIT(4)
77 #define F_INT_MISS_TRANSACTION_FIFO_FAULT	BIT(5)
78 #define F_INT_PRETETCH_TRANSATION_FIFO_FAULT	BIT(6)
79 
80 #define REG_MMU_CPE_DONE			0x12C
81 
82 #define REG_MMU_FAULT_ST1			0x134
83 
84 #define REG_MMU_FAULT_VA			0x13c
85 #define F_MMU_FAULT_VA_MSK			0xfffff000
86 #define F_MMU_FAULT_VA_WRITE_BIT		BIT(1)
87 #define F_MMU_FAULT_VA_LAYER_BIT		BIT(0)
88 
89 #define REG_MMU_INVLD_PA			0x140
90 #define REG_MMU_INT_ID				0x150
91 #define F_MMU0_INT_ID_LARB_ID(a)		(((a) >> 7) & 0x7)
92 #define F_MMU0_INT_ID_PORT_ID(a)		(((a) >> 2) & 0x1f)
93 
94 #define MTK_PROTECT_PA_ALIGN			128
95 
96 struct mtk_iommu_domain {
97 	spinlock_t			pgtlock; /* lock for page table */
98 
99 	struct io_pgtable_cfg		cfg;
100 	struct io_pgtable_ops		*iop;
101 
102 	struct iommu_domain		domain;
103 };
104 
105 static struct iommu_ops mtk_iommu_ops;
106 
107 static struct mtk_iommu_domain *to_mtk_domain(struct iommu_domain *dom)
108 {
109 	return container_of(dom, struct mtk_iommu_domain, domain);
110 }
111 
112 static void mtk_iommu_tlb_flush_all(void *cookie)
113 {
114 	struct mtk_iommu_data *data = cookie;
115 
116 	writel_relaxed(F_INVLD_EN1 | F_INVLD_EN0, data->base + REG_MMU_INV_SEL);
117 	writel_relaxed(F_ALL_INVLD, data->base + REG_MMU_INVALIDATE);
118 	wmb(); /* Make sure the tlb flush all done */
119 }
120 
121 static void mtk_iommu_tlb_add_flush_nosync(unsigned long iova, size_t size,
122 					   size_t granule, bool leaf,
123 					   void *cookie)
124 {
125 	struct mtk_iommu_data *data = cookie;
126 
127 	writel_relaxed(F_INVLD_EN1 | F_INVLD_EN0, data->base + REG_MMU_INV_SEL);
128 
129 	writel_relaxed(iova, data->base + REG_MMU_INVLD_START_A);
130 	writel_relaxed(iova + size - 1, data->base + REG_MMU_INVLD_END_A);
131 	writel_relaxed(F_MMU_INV_RANGE, data->base + REG_MMU_INVALIDATE);
132 }
133 
134 static void mtk_iommu_tlb_sync(void *cookie)
135 {
136 	struct mtk_iommu_data *data = cookie;
137 	int ret;
138 	u32 tmp;
139 
140 	ret = readl_poll_timeout_atomic(data->base + REG_MMU_CPE_DONE, tmp,
141 					tmp != 0, 10, 100000);
142 	if (ret) {
143 		dev_warn(data->dev,
144 			 "Partial TLB flush timed out, falling back to full flush\n");
145 		mtk_iommu_tlb_flush_all(cookie);
146 	}
147 	/* Clear the CPE status */
148 	writel_relaxed(0, data->base + REG_MMU_CPE_DONE);
149 }
150 
151 static const struct iommu_gather_ops mtk_iommu_gather_ops = {
152 	.tlb_flush_all = mtk_iommu_tlb_flush_all,
153 	.tlb_add_flush = mtk_iommu_tlb_add_flush_nosync,
154 	.tlb_sync = mtk_iommu_tlb_sync,
155 };
156 
157 static irqreturn_t mtk_iommu_isr(int irq, void *dev_id)
158 {
159 	struct mtk_iommu_data *data = dev_id;
160 	struct mtk_iommu_domain *dom = data->m4u_dom;
161 	u32 int_state, regval, fault_iova, fault_pa;
162 	unsigned int fault_larb, fault_port;
163 	bool layer, write;
164 
165 	/* Read error info from registers */
166 	int_state = readl_relaxed(data->base + REG_MMU_FAULT_ST1);
167 	fault_iova = readl_relaxed(data->base + REG_MMU_FAULT_VA);
168 	layer = fault_iova & F_MMU_FAULT_VA_LAYER_BIT;
169 	write = fault_iova & F_MMU_FAULT_VA_WRITE_BIT;
170 	fault_iova &= F_MMU_FAULT_VA_MSK;
171 	fault_pa = readl_relaxed(data->base + REG_MMU_INVLD_PA);
172 	regval = readl_relaxed(data->base + REG_MMU_INT_ID);
173 	fault_larb = F_MMU0_INT_ID_LARB_ID(regval);
174 	fault_port = F_MMU0_INT_ID_PORT_ID(regval);
175 
176 	if (report_iommu_fault(&dom->domain, data->dev, fault_iova,
177 			       write ? IOMMU_FAULT_WRITE : IOMMU_FAULT_READ)) {
178 		dev_err_ratelimited(
179 			data->dev,
180 			"fault type=0x%x iova=0x%x pa=0x%x larb=%d port=%d layer=%d %s\n",
181 			int_state, fault_iova, fault_pa, fault_larb, fault_port,
182 			layer, write ? "write" : "read");
183 	}
184 
185 	/* Interrupt clear */
186 	regval = readl_relaxed(data->base + REG_MMU_INT_CONTROL0);
187 	regval |= F_INT_CLR_BIT;
188 	writel_relaxed(regval, data->base + REG_MMU_INT_CONTROL0);
189 
190 	mtk_iommu_tlb_flush_all(data);
191 
192 	return IRQ_HANDLED;
193 }
194 
195 static void mtk_iommu_config(struct mtk_iommu_data *data,
196 			     struct device *dev, bool enable)
197 {
198 	struct mtk_smi_larb_iommu    *larb_mmu;
199 	unsigned int                 larbid, portid;
200 	struct iommu_fwspec *fwspec = dev->iommu_fwspec;
201 	int i;
202 
203 	for (i = 0; i < fwspec->num_ids; ++i) {
204 		larbid = MTK_M4U_TO_LARB(fwspec->ids[i]);
205 		portid = MTK_M4U_TO_PORT(fwspec->ids[i]);
206 		larb_mmu = &data->smi_imu.larb_imu[larbid];
207 
208 		dev_dbg(dev, "%s iommu port: %d\n",
209 			enable ? "enable" : "disable", portid);
210 
211 		if (enable)
212 			larb_mmu->mmu |= MTK_SMI_MMU_EN(portid);
213 		else
214 			larb_mmu->mmu &= ~MTK_SMI_MMU_EN(portid);
215 	}
216 }
217 
218 static int mtk_iommu_domain_finalise(struct mtk_iommu_data *data)
219 {
220 	struct mtk_iommu_domain *dom = data->m4u_dom;
221 
222 	spin_lock_init(&dom->pgtlock);
223 
224 	dom->cfg = (struct io_pgtable_cfg) {
225 		.quirks = IO_PGTABLE_QUIRK_ARM_NS |
226 			IO_PGTABLE_QUIRK_NO_PERMS |
227 			IO_PGTABLE_QUIRK_TLBI_ON_MAP,
228 		.pgsize_bitmap = mtk_iommu_ops.pgsize_bitmap,
229 		.ias = 32,
230 		.oas = 32,
231 		.tlb = &mtk_iommu_gather_ops,
232 		.iommu_dev = data->dev,
233 	};
234 
235 	if (data->enable_4GB)
236 		dom->cfg.quirks |= IO_PGTABLE_QUIRK_ARM_MTK_4GB;
237 
238 	dom->iop = alloc_io_pgtable_ops(ARM_V7S, &dom->cfg, data);
239 	if (!dom->iop) {
240 		dev_err(data->dev, "Failed to alloc io pgtable\n");
241 		return -EINVAL;
242 	}
243 
244 	/* Update our support page sizes bitmap */
245 	dom->domain.pgsize_bitmap = dom->cfg.pgsize_bitmap;
246 
247 	writel(data->m4u_dom->cfg.arm_v7s_cfg.ttbr[0],
248 	       data->base + REG_MMU_PT_BASE_ADDR);
249 	return 0;
250 }
251 
252 static struct iommu_domain *mtk_iommu_domain_alloc(unsigned type)
253 {
254 	struct mtk_iommu_domain *dom;
255 
256 	if (type != IOMMU_DOMAIN_DMA)
257 		return NULL;
258 
259 	dom = kzalloc(sizeof(*dom), GFP_KERNEL);
260 	if (!dom)
261 		return NULL;
262 
263 	if (iommu_get_dma_cookie(&dom->domain)) {
264 		kfree(dom);
265 		return NULL;
266 	}
267 
268 	dom->domain.geometry.aperture_start = 0;
269 	dom->domain.geometry.aperture_end = DMA_BIT_MASK(32);
270 	dom->domain.geometry.force_aperture = true;
271 
272 	return &dom->domain;
273 }
274 
275 static void mtk_iommu_domain_free(struct iommu_domain *domain)
276 {
277 	iommu_put_dma_cookie(domain);
278 	kfree(to_mtk_domain(domain));
279 }
280 
281 static int mtk_iommu_attach_device(struct iommu_domain *domain,
282 				   struct device *dev)
283 {
284 	struct mtk_iommu_domain *dom = to_mtk_domain(domain);
285 	struct mtk_iommu_data *data = dev->iommu_fwspec->iommu_priv;
286 	int ret;
287 
288 	if (!data)
289 		return -ENODEV;
290 
291 	if (!data->m4u_dom) {
292 		data->m4u_dom = dom;
293 		ret = mtk_iommu_domain_finalise(data);
294 		if (ret) {
295 			data->m4u_dom = NULL;
296 			return ret;
297 		}
298 	} else if (data->m4u_dom != dom) {
299 		/* All the client devices should be in the same m4u domain */
300 		dev_err(dev, "try to attach into the error iommu domain\n");
301 		return -EPERM;
302 	}
303 
304 	mtk_iommu_config(data, dev, true);
305 	return 0;
306 }
307 
308 static void mtk_iommu_detach_device(struct iommu_domain *domain,
309 				    struct device *dev)
310 {
311 	struct mtk_iommu_data *data = dev->iommu_fwspec->iommu_priv;
312 
313 	if (!data)
314 		return;
315 
316 	mtk_iommu_config(data, dev, false);
317 }
318 
319 static int mtk_iommu_map(struct iommu_domain *domain, unsigned long iova,
320 			 phys_addr_t paddr, size_t size, int prot)
321 {
322 	struct mtk_iommu_domain *dom = to_mtk_domain(domain);
323 	unsigned long flags;
324 	int ret;
325 
326 	spin_lock_irqsave(&dom->pgtlock, flags);
327 	ret = dom->iop->map(dom->iop, iova, paddr, size, prot);
328 	spin_unlock_irqrestore(&dom->pgtlock, flags);
329 
330 	return ret;
331 }
332 
333 static size_t mtk_iommu_unmap(struct iommu_domain *domain,
334 			      unsigned long iova, size_t size)
335 {
336 	struct mtk_iommu_domain *dom = to_mtk_domain(domain);
337 	unsigned long flags;
338 	size_t unmapsz;
339 
340 	spin_lock_irqsave(&dom->pgtlock, flags);
341 	unmapsz = dom->iop->unmap(dom->iop, iova, size);
342 	spin_unlock_irqrestore(&dom->pgtlock, flags);
343 
344 	return unmapsz;
345 }
346 
347 static phys_addr_t mtk_iommu_iova_to_phys(struct iommu_domain *domain,
348 					  dma_addr_t iova)
349 {
350 	struct mtk_iommu_domain *dom = to_mtk_domain(domain);
351 	unsigned long flags;
352 	phys_addr_t pa;
353 
354 	spin_lock_irqsave(&dom->pgtlock, flags);
355 	pa = dom->iop->iova_to_phys(dom->iop, iova);
356 	spin_unlock_irqrestore(&dom->pgtlock, flags);
357 
358 	return pa;
359 }
360 
361 static int mtk_iommu_add_device(struct device *dev)
362 {
363 	struct mtk_iommu_data *data;
364 	struct iommu_group *group;
365 
366 	if (!dev->iommu_fwspec || dev->iommu_fwspec->ops != &mtk_iommu_ops)
367 		return -ENODEV; /* Not a iommu client device */
368 
369 	data = dev->iommu_fwspec->iommu_priv;
370 	iommu_device_link(&data->iommu, dev);
371 
372 	group = iommu_group_get_for_dev(dev);
373 	if (IS_ERR(group))
374 		return PTR_ERR(group);
375 
376 	iommu_group_put(group);
377 	return 0;
378 }
379 
380 static void mtk_iommu_remove_device(struct device *dev)
381 {
382 	struct mtk_iommu_data *data;
383 
384 	if (!dev->iommu_fwspec || dev->iommu_fwspec->ops != &mtk_iommu_ops)
385 		return;
386 
387 	data = dev->iommu_fwspec->iommu_priv;
388 	iommu_device_unlink(&data->iommu, dev);
389 
390 	iommu_group_remove_device(dev);
391 	iommu_fwspec_free(dev);
392 }
393 
394 static struct iommu_group *mtk_iommu_device_group(struct device *dev)
395 {
396 	struct mtk_iommu_data *data = dev->iommu_fwspec->iommu_priv;
397 
398 	if (!data)
399 		return ERR_PTR(-ENODEV);
400 
401 	/* All the client devices are in the same m4u iommu-group */
402 	if (!data->m4u_group) {
403 		data->m4u_group = iommu_group_alloc();
404 		if (IS_ERR(data->m4u_group))
405 			dev_err(dev, "Failed to allocate M4U IOMMU group\n");
406 	} else {
407 		iommu_group_ref_get(data->m4u_group);
408 	}
409 	return data->m4u_group;
410 }
411 
412 static int mtk_iommu_of_xlate(struct device *dev, struct of_phandle_args *args)
413 {
414 	struct platform_device *m4updev;
415 
416 	if (args->args_count != 1) {
417 		dev_err(dev, "invalid #iommu-cells(%d) property for IOMMU\n",
418 			args->args_count);
419 		return -EINVAL;
420 	}
421 
422 	if (!dev->iommu_fwspec->iommu_priv) {
423 		/* Get the m4u device */
424 		m4updev = of_find_device_by_node(args->np);
425 		if (WARN_ON(!m4updev))
426 			return -EINVAL;
427 
428 		dev->iommu_fwspec->iommu_priv = platform_get_drvdata(m4updev);
429 	}
430 
431 	return iommu_fwspec_add_ids(dev, args->args, 1);
432 }
433 
434 static struct iommu_ops mtk_iommu_ops = {
435 	.domain_alloc	= mtk_iommu_domain_alloc,
436 	.domain_free	= mtk_iommu_domain_free,
437 	.attach_dev	= mtk_iommu_attach_device,
438 	.detach_dev	= mtk_iommu_detach_device,
439 	.map		= mtk_iommu_map,
440 	.unmap		= mtk_iommu_unmap,
441 	.map_sg		= default_iommu_map_sg,
442 	.iova_to_phys	= mtk_iommu_iova_to_phys,
443 	.add_device	= mtk_iommu_add_device,
444 	.remove_device	= mtk_iommu_remove_device,
445 	.device_group	= mtk_iommu_device_group,
446 	.of_xlate	= mtk_iommu_of_xlate,
447 	.pgsize_bitmap	= SZ_4K | SZ_64K | SZ_1M | SZ_16M,
448 };
449 
450 static int mtk_iommu_hw_init(const struct mtk_iommu_data *data)
451 {
452 	u32 regval;
453 	int ret;
454 
455 	ret = clk_prepare_enable(data->bclk);
456 	if (ret) {
457 		dev_err(data->dev, "Failed to enable iommu bclk(%d)\n", ret);
458 		return ret;
459 	}
460 
461 	regval = F_MMU_PREFETCH_RT_REPLACE_MOD |
462 		F_MMU_TF_PROTECT_SEL(2);
463 	writel_relaxed(regval, data->base + REG_MMU_CTRL_REG);
464 
465 	regval = F_L2_MULIT_HIT_EN |
466 		F_TABLE_WALK_FAULT_INT_EN |
467 		F_PREETCH_FIFO_OVERFLOW_INT_EN |
468 		F_MISS_FIFO_OVERFLOW_INT_EN |
469 		F_PREFETCH_FIFO_ERR_INT_EN |
470 		F_MISS_FIFO_ERR_INT_EN;
471 	writel_relaxed(regval, data->base + REG_MMU_INT_CONTROL0);
472 
473 	regval = F_INT_TRANSLATION_FAULT |
474 		F_INT_MAIN_MULTI_HIT_FAULT |
475 		F_INT_INVALID_PA_FAULT |
476 		F_INT_ENTRY_REPLACEMENT_FAULT |
477 		F_INT_TLB_MISS_FAULT |
478 		F_INT_MISS_TRANSACTION_FIFO_FAULT |
479 		F_INT_PRETETCH_TRANSATION_FIFO_FAULT;
480 	writel_relaxed(regval, data->base + REG_MMU_INT_MAIN_CONTROL);
481 
482 	writel_relaxed(F_MMU_IVRP_PA_SET(data->protect_base, data->enable_4GB),
483 		       data->base + REG_MMU_IVRP_PADDR);
484 
485 	writel_relaxed(0, data->base + REG_MMU_DCM_DIS);
486 	writel_relaxed(0, data->base + REG_MMU_STANDARD_AXI_MODE);
487 
488 	if (devm_request_irq(data->dev, data->irq, mtk_iommu_isr, 0,
489 			     dev_name(data->dev), (void *)data)) {
490 		writel_relaxed(0, data->base + REG_MMU_PT_BASE_ADDR);
491 		clk_disable_unprepare(data->bclk);
492 		dev_err(data->dev, "Failed @ IRQ-%d Request\n", data->irq);
493 		return -ENODEV;
494 	}
495 
496 	return 0;
497 }
498 
499 static const struct component_master_ops mtk_iommu_com_ops = {
500 	.bind		= mtk_iommu_bind,
501 	.unbind		= mtk_iommu_unbind,
502 };
503 
504 static int mtk_iommu_probe(struct platform_device *pdev)
505 {
506 	struct mtk_iommu_data   *data;
507 	struct device           *dev = &pdev->dev;
508 	struct resource         *res;
509 	resource_size_t		ioaddr;
510 	struct component_match  *match = NULL;
511 	void                    *protect;
512 	int                     i, larb_nr, ret;
513 
514 	data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
515 	if (!data)
516 		return -ENOMEM;
517 	data->dev = dev;
518 
519 	/* Protect memory. HW will access here while translation fault.*/
520 	protect = devm_kzalloc(dev, MTK_PROTECT_PA_ALIGN * 2, GFP_KERNEL);
521 	if (!protect)
522 		return -ENOMEM;
523 	data->protect_base = ALIGN(virt_to_phys(protect), MTK_PROTECT_PA_ALIGN);
524 
525 	/* Whether the current dram is over 4GB */
526 	data->enable_4GB = !!(max_pfn > (0xffffffffUL >> PAGE_SHIFT));
527 
528 	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
529 	data->base = devm_ioremap_resource(dev, res);
530 	if (IS_ERR(data->base))
531 		return PTR_ERR(data->base);
532 	ioaddr = res->start;
533 
534 	data->irq = platform_get_irq(pdev, 0);
535 	if (data->irq < 0)
536 		return data->irq;
537 
538 	data->bclk = devm_clk_get(dev, "bclk");
539 	if (IS_ERR(data->bclk))
540 		return PTR_ERR(data->bclk);
541 
542 	larb_nr = of_count_phandle_with_args(dev->of_node,
543 					     "mediatek,larbs", NULL);
544 	if (larb_nr < 0)
545 		return larb_nr;
546 	data->smi_imu.larb_nr = larb_nr;
547 
548 	for (i = 0; i < larb_nr; i++) {
549 		struct device_node *larbnode;
550 		struct platform_device *plarbdev;
551 
552 		larbnode = of_parse_phandle(dev->of_node, "mediatek,larbs", i);
553 		if (!larbnode)
554 			return -EINVAL;
555 
556 		if (!of_device_is_available(larbnode))
557 			continue;
558 
559 		plarbdev = of_find_device_by_node(larbnode);
560 		if (!plarbdev) {
561 			plarbdev = of_platform_device_create(
562 						larbnode, NULL,
563 						platform_bus_type.dev_root);
564 			if (!plarbdev) {
565 				of_node_put(larbnode);
566 				return -EPROBE_DEFER;
567 			}
568 		}
569 		data->smi_imu.larb_imu[i].dev = &plarbdev->dev;
570 
571 		component_match_add_release(dev, &match, release_of,
572 					    compare_of, larbnode);
573 	}
574 
575 	platform_set_drvdata(pdev, data);
576 
577 	ret = mtk_iommu_hw_init(data);
578 	if (ret)
579 		return ret;
580 
581 	ret = iommu_device_sysfs_add(&data->iommu, dev, NULL,
582 				     "mtk-iommu.%pa", &ioaddr);
583 	if (ret)
584 		return ret;
585 
586 	iommu_device_set_ops(&data->iommu, &mtk_iommu_ops);
587 	iommu_device_set_fwnode(&data->iommu, &pdev->dev.of_node->fwnode);
588 
589 	ret = iommu_device_register(&data->iommu);
590 	if (ret)
591 		return ret;
592 
593 	if (!iommu_present(&platform_bus_type))
594 		bus_set_iommu(&platform_bus_type, &mtk_iommu_ops);
595 
596 	return component_master_add_with_match(dev, &mtk_iommu_com_ops, match);
597 }
598 
599 static int mtk_iommu_remove(struct platform_device *pdev)
600 {
601 	struct mtk_iommu_data *data = platform_get_drvdata(pdev);
602 
603 	iommu_device_sysfs_remove(&data->iommu);
604 	iommu_device_unregister(&data->iommu);
605 
606 	if (iommu_present(&platform_bus_type))
607 		bus_set_iommu(&platform_bus_type, NULL);
608 
609 	free_io_pgtable_ops(data->m4u_dom->iop);
610 	clk_disable_unprepare(data->bclk);
611 	devm_free_irq(&pdev->dev, data->irq, data);
612 	component_master_del(&pdev->dev, &mtk_iommu_com_ops);
613 	return 0;
614 }
615 
616 static int __maybe_unused mtk_iommu_suspend(struct device *dev)
617 {
618 	struct mtk_iommu_data *data = dev_get_drvdata(dev);
619 	struct mtk_iommu_suspend_reg *reg = &data->reg;
620 	void __iomem *base = data->base;
621 
622 	reg->standard_axi_mode = readl_relaxed(base +
623 					       REG_MMU_STANDARD_AXI_MODE);
624 	reg->dcm_dis = readl_relaxed(base + REG_MMU_DCM_DIS);
625 	reg->ctrl_reg = readl_relaxed(base + REG_MMU_CTRL_REG);
626 	reg->int_control0 = readl_relaxed(base + REG_MMU_INT_CONTROL0);
627 	reg->int_main_control = readl_relaxed(base + REG_MMU_INT_MAIN_CONTROL);
628 	return 0;
629 }
630 
631 static int __maybe_unused mtk_iommu_resume(struct device *dev)
632 {
633 	struct mtk_iommu_data *data = dev_get_drvdata(dev);
634 	struct mtk_iommu_suspend_reg *reg = &data->reg;
635 	void __iomem *base = data->base;
636 
637 	writel_relaxed(data->m4u_dom->cfg.arm_v7s_cfg.ttbr[0],
638 		       base + REG_MMU_PT_BASE_ADDR);
639 	writel_relaxed(reg->standard_axi_mode,
640 		       base + REG_MMU_STANDARD_AXI_MODE);
641 	writel_relaxed(reg->dcm_dis, base + REG_MMU_DCM_DIS);
642 	writel_relaxed(reg->ctrl_reg, base + REG_MMU_CTRL_REG);
643 	writel_relaxed(reg->int_control0, base + REG_MMU_INT_CONTROL0);
644 	writel_relaxed(reg->int_main_control, base + REG_MMU_INT_MAIN_CONTROL);
645 	writel_relaxed(F_MMU_IVRP_PA_SET(data->protect_base, data->enable_4GB),
646 		       base + REG_MMU_IVRP_PADDR);
647 	return 0;
648 }
649 
650 const struct dev_pm_ops mtk_iommu_pm_ops = {
651 	SET_SYSTEM_SLEEP_PM_OPS(mtk_iommu_suspend, mtk_iommu_resume)
652 };
653 
654 static const struct of_device_id mtk_iommu_of_ids[] = {
655 	{ .compatible = "mediatek,mt8173-m4u", },
656 	{}
657 };
658 
659 static struct platform_driver mtk_iommu_driver = {
660 	.probe	= mtk_iommu_probe,
661 	.remove	= mtk_iommu_remove,
662 	.driver	= {
663 		.name = "mtk-iommu",
664 		.of_match_table = mtk_iommu_of_ids,
665 		.pm = &mtk_iommu_pm_ops,
666 	}
667 };
668 
669 static int mtk_iommu_init_fn(struct device_node *np)
670 {
671 	int ret;
672 	struct platform_device *pdev;
673 
674 	pdev = of_platform_device_create(np, NULL, platform_bus_type.dev_root);
675 	if (!pdev)
676 		return -ENOMEM;
677 
678 	ret = platform_driver_register(&mtk_iommu_driver);
679 	if (ret) {
680 		pr_err("%s: Failed to register driver\n", __func__);
681 		return ret;
682 	}
683 
684 	return 0;
685 }
686 
687 IOMMU_OF_DECLARE(mtkm4u, "mediatek,mt8173-m4u", mtk_iommu_init_fn);
688