xref: /linux/drivers/remoteproc/mtk_scp.c (revision 68550cbc6129159b7a6434796b721e8b66ee12f6)
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Copyright (c) 2019 MediaTek Inc.
4 
5 #include <asm/barrier.h>
6 #include <linux/clk.h>
7 #include <linux/dma-mapping.h>
8 #include <linux/err.h>
9 #include <linux/interrupt.h>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/of_address.h>
13 #include <linux/of_platform.h>
14 #include <linux/of_reserved_mem.h>
15 #include <linux/platform_device.h>
16 #include <linux/remoteproc.h>
17 #include <linux/remoteproc/mtk_scp.h>
18 #include <linux/rpmsg/mtk_rpmsg.h>
19 
20 #include "mtk_common.h"
21 #include "remoteproc_internal.h"
22 
23 #define MAX_CODE_SIZE 0x500000
24 #define SECTION_NAME_IPI_BUFFER ".ipi_buffer"
25 
26 /**
27  * scp_get() - get a reference to SCP.
28  *
29  * @pdev:	the platform device of the module requesting SCP platform
30  *		device for using SCP API.
31  *
32  * Return: Return NULL if failed.  otherwise reference to SCP.
33  **/
34 struct mtk_scp *scp_get(struct platform_device *pdev)
35 {
36 	struct device *dev = &pdev->dev;
37 	struct device_node *scp_node;
38 	struct platform_device *scp_pdev;
39 
40 	scp_node = of_parse_phandle(dev->of_node, "mediatek,scp", 0);
41 	if (!scp_node) {
42 		dev_err(dev, "can't get SCP node\n");
43 		return NULL;
44 	}
45 
46 	scp_pdev = of_find_device_by_node(scp_node);
47 	of_node_put(scp_node);
48 
49 	if (WARN_ON(!scp_pdev)) {
50 		dev_err(dev, "SCP pdev failed\n");
51 		return NULL;
52 	}
53 
54 	return platform_get_drvdata(scp_pdev);
55 }
56 EXPORT_SYMBOL_GPL(scp_get);
57 
58 /**
59  * scp_put() - "free" the SCP
60  *
61  * @scp:	mtk_scp structure from scp_get().
62  **/
63 void scp_put(struct mtk_scp *scp)
64 {
65 	put_device(scp->dev);
66 }
67 EXPORT_SYMBOL_GPL(scp_put);
68 
69 static void scp_wdt_handler(struct mtk_scp *scp, u32 scp_to_host)
70 {
71 	dev_err(scp->dev, "SCP watchdog timeout! 0x%x", scp_to_host);
72 	rproc_report_crash(scp->rproc, RPROC_WATCHDOG);
73 }
74 
75 static void scp_init_ipi_handler(void *data, unsigned int len, void *priv)
76 {
77 	struct mtk_scp *scp = (struct mtk_scp *)priv;
78 	struct scp_run *run = (struct scp_run *)data;
79 
80 	scp->run.signaled = run->signaled;
81 	strscpy(scp->run.fw_ver, run->fw_ver, SCP_FW_VER_LEN);
82 	scp->run.dec_capability = run->dec_capability;
83 	scp->run.enc_capability = run->enc_capability;
84 	wake_up_interruptible(&scp->run.wq);
85 }
86 
87 static void scp_ipi_handler(struct mtk_scp *scp)
88 {
89 	struct mtk_share_obj __iomem *rcv_obj = scp->recv_buf;
90 	struct scp_ipi_desc *ipi_desc = scp->ipi_desc;
91 	u8 tmp_data[SCP_SHARE_BUFFER_SIZE];
92 	scp_ipi_handler_t handler;
93 	u32 id = readl(&rcv_obj->id);
94 	u32 len = readl(&rcv_obj->len);
95 
96 	if (len > SCP_SHARE_BUFFER_SIZE) {
97 		dev_err(scp->dev, "ipi message too long (len %d, max %d)", len,
98 			SCP_SHARE_BUFFER_SIZE);
99 		return;
100 	}
101 	if (id >= SCP_IPI_MAX) {
102 		dev_err(scp->dev, "No such ipi id = %d\n", id);
103 		return;
104 	}
105 
106 	scp_ipi_lock(scp, id);
107 	handler = ipi_desc[id].handler;
108 	if (!handler) {
109 		dev_err(scp->dev, "No such ipi id = %d\n", id);
110 		scp_ipi_unlock(scp, id);
111 		return;
112 	}
113 
114 	memcpy_fromio(tmp_data, &rcv_obj->share_buf, len);
115 	handler(tmp_data, len, ipi_desc[id].priv);
116 	scp_ipi_unlock(scp, id);
117 
118 	scp->ipi_id_ack[id] = true;
119 	wake_up(&scp->ack_wq);
120 }
121 
122 static int scp_elf_read_ipi_buf_addr(struct mtk_scp *scp,
123 				     const struct firmware *fw,
124 				     size_t *offset);
125 
126 static int scp_ipi_init(struct mtk_scp *scp, const struct firmware *fw)
127 {
128 	int ret;
129 	size_t offset;
130 
131 	/* read the ipi buf addr from FW itself first */
132 	ret = scp_elf_read_ipi_buf_addr(scp, fw, &offset);
133 	if (ret) {
134 		/* use default ipi buf addr if the FW doesn't have it */
135 		offset = scp->data->ipi_buf_offset;
136 		if (!offset)
137 			return ret;
138 	}
139 	dev_info(scp->dev, "IPI buf addr %#010zx\n", offset);
140 
141 	scp->recv_buf = (struct mtk_share_obj __iomem *)
142 			(scp->sram_base + offset);
143 	scp->send_buf = (struct mtk_share_obj __iomem *)
144 			(scp->sram_base + offset + sizeof(*scp->recv_buf));
145 	memset_io(scp->recv_buf, 0, sizeof(*scp->recv_buf));
146 	memset_io(scp->send_buf, 0, sizeof(*scp->send_buf));
147 
148 	return 0;
149 }
150 
151 static void mt8183_scp_reset_assert(struct mtk_scp *scp)
152 {
153 	u32 val;
154 
155 	val = readl(scp->reg_base + MT8183_SW_RSTN);
156 	val &= ~MT8183_SW_RSTN_BIT;
157 	writel(val, scp->reg_base + MT8183_SW_RSTN);
158 }
159 
160 static void mt8183_scp_reset_deassert(struct mtk_scp *scp)
161 {
162 	u32 val;
163 
164 	val = readl(scp->reg_base + MT8183_SW_RSTN);
165 	val |= MT8183_SW_RSTN_BIT;
166 	writel(val, scp->reg_base + MT8183_SW_RSTN);
167 }
168 
169 static void mt8192_scp_reset_assert(struct mtk_scp *scp)
170 {
171 	writel(1, scp->reg_base + MT8192_CORE0_SW_RSTN_SET);
172 }
173 
174 static void mt8192_scp_reset_deassert(struct mtk_scp *scp)
175 {
176 	writel(1, scp->reg_base + MT8192_CORE0_SW_RSTN_CLR);
177 }
178 
179 static void mt8183_scp_irq_handler(struct mtk_scp *scp)
180 {
181 	u32 scp_to_host;
182 
183 	scp_to_host = readl(scp->reg_base + MT8183_SCP_TO_HOST);
184 	if (scp_to_host & MT8183_SCP_IPC_INT_BIT)
185 		scp_ipi_handler(scp);
186 	else
187 		scp_wdt_handler(scp, scp_to_host);
188 
189 	/* SCP won't send another interrupt until we set SCP_TO_HOST to 0. */
190 	writel(MT8183_SCP_IPC_INT_BIT | MT8183_SCP_WDT_INT_BIT,
191 	       scp->reg_base + MT8183_SCP_TO_HOST);
192 }
193 
194 static void mt8192_scp_irq_handler(struct mtk_scp *scp)
195 {
196 	u32 scp_to_host;
197 
198 	scp_to_host = readl(scp->reg_base + MT8192_SCP2APMCU_IPC_SET);
199 
200 	if (scp_to_host & MT8192_SCP_IPC_INT_BIT) {
201 		scp_ipi_handler(scp);
202 
203 		/*
204 		 * SCP won't send another interrupt until we clear
205 		 * MT8192_SCP2APMCU_IPC.
206 		 */
207 		writel(MT8192_SCP_IPC_INT_BIT,
208 		       scp->reg_base + MT8192_SCP2APMCU_IPC_CLR);
209 	} else {
210 		scp_wdt_handler(scp, scp_to_host);
211 		writel(1, scp->reg_base + MT8192_CORE0_WDT_IRQ);
212 	}
213 }
214 
215 static irqreturn_t scp_irq_handler(int irq, void *priv)
216 {
217 	struct mtk_scp *scp = priv;
218 	int ret;
219 
220 	ret = clk_prepare_enable(scp->clk);
221 	if (ret) {
222 		dev_err(scp->dev, "failed to enable clocks\n");
223 		return IRQ_NONE;
224 	}
225 
226 	scp->data->scp_irq_handler(scp);
227 
228 	clk_disable_unprepare(scp->clk);
229 
230 	return IRQ_HANDLED;
231 }
232 
233 static int scp_elf_load_segments(struct rproc *rproc, const struct firmware *fw)
234 {
235 	struct device *dev = &rproc->dev;
236 	struct elf32_hdr *ehdr;
237 	struct elf32_phdr *phdr;
238 	int i, ret = 0;
239 	const u8 *elf_data = fw->data;
240 
241 	ehdr = (struct elf32_hdr *)elf_data;
242 	phdr = (struct elf32_phdr *)(elf_data + ehdr->e_phoff);
243 
244 	/* go through the available ELF segments */
245 	for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
246 		u32 da = phdr->p_paddr;
247 		u32 memsz = phdr->p_memsz;
248 		u32 filesz = phdr->p_filesz;
249 		u32 offset = phdr->p_offset;
250 		void __iomem *ptr;
251 
252 		dev_dbg(dev, "phdr: type %d da 0x%x memsz 0x%x filesz 0x%x\n",
253 			phdr->p_type, da, memsz, filesz);
254 
255 		if (phdr->p_type != PT_LOAD)
256 			continue;
257 		if (!filesz)
258 			continue;
259 
260 		if (filesz > memsz) {
261 			dev_err(dev, "bad phdr filesz 0x%x memsz 0x%x\n",
262 				filesz, memsz);
263 			ret = -EINVAL;
264 			break;
265 		}
266 
267 		if (offset + filesz > fw->size) {
268 			dev_err(dev, "truncated fw: need 0x%x avail 0x%zx\n",
269 				offset + filesz, fw->size);
270 			ret = -EINVAL;
271 			break;
272 		}
273 
274 		/* grab the kernel address for this device address */
275 		ptr = (void __iomem *)rproc_da_to_va(rproc, da, memsz, NULL);
276 		if (!ptr) {
277 			dev_err(dev, "bad phdr da 0x%x mem 0x%x\n", da, memsz);
278 			ret = -EINVAL;
279 			break;
280 		}
281 
282 		/* put the segment where the remote processor expects it */
283 		scp_memcpy_aligned(ptr, elf_data + phdr->p_offset, filesz);
284 	}
285 
286 	return ret;
287 }
288 
289 static int scp_elf_read_ipi_buf_addr(struct mtk_scp *scp,
290 				     const struct firmware *fw,
291 				     size_t *offset)
292 {
293 	struct elf32_hdr *ehdr;
294 	struct elf32_shdr *shdr, *shdr_strtab;
295 	int i;
296 	const u8 *elf_data = fw->data;
297 	const char *strtab;
298 
299 	ehdr = (struct elf32_hdr *)elf_data;
300 	shdr = (struct elf32_shdr *)(elf_data + ehdr->e_shoff);
301 	shdr_strtab = shdr + ehdr->e_shstrndx;
302 	strtab = (const char *)(elf_data + shdr_strtab->sh_offset);
303 
304 	for (i = 0; i < ehdr->e_shnum; i++, shdr++) {
305 		if (strcmp(strtab + shdr->sh_name,
306 			   SECTION_NAME_IPI_BUFFER) == 0) {
307 			*offset = shdr->sh_addr;
308 			return 0;
309 		}
310 	}
311 
312 	return -ENOENT;
313 }
314 
315 static int mt8183_scp_clk_get(struct mtk_scp *scp)
316 {
317 	struct device *dev = scp->dev;
318 	int ret = 0;
319 
320 	scp->clk = devm_clk_get(dev, "main");
321 	if (IS_ERR(scp->clk)) {
322 		dev_err(dev, "Failed to get clock\n");
323 		ret = PTR_ERR(scp->clk);
324 	}
325 
326 	return ret;
327 }
328 
329 static int mt8192_scp_clk_get(struct mtk_scp *scp)
330 {
331 	return mt8183_scp_clk_get(scp);
332 }
333 
334 static int mt8195_scp_clk_get(struct mtk_scp *scp)
335 {
336 	scp->clk = NULL;
337 
338 	return 0;
339 }
340 
341 static int mt8183_scp_before_load(struct mtk_scp *scp)
342 {
343 	/* Clear SCP to host interrupt */
344 	writel(MT8183_SCP_IPC_INT_BIT, scp->reg_base + MT8183_SCP_TO_HOST);
345 
346 	/* Reset clocks before loading FW */
347 	writel(0x0, scp->reg_base + MT8183_SCP_CLK_SW_SEL);
348 	writel(0x0, scp->reg_base + MT8183_SCP_CLK_DIV_SEL);
349 
350 	/* Initialize TCM before loading FW. */
351 	writel(0x0, scp->reg_base + MT8183_SCP_L1_SRAM_PD);
352 	writel(0x0, scp->reg_base + MT8183_SCP_TCM_TAIL_SRAM_PD);
353 
354 	/* Turn on the power of SCP's SRAM before using it. */
355 	writel(0x0, scp->reg_base + MT8183_SCP_SRAM_PDN);
356 
357 	/*
358 	 * Set I-cache and D-cache size before loading SCP FW.
359 	 * SCP SRAM logical address may change when cache size setting differs.
360 	 */
361 	writel(MT8183_SCP_CACHE_CON_WAYEN | MT8183_SCP_CACHESIZE_8KB,
362 	       scp->reg_base + MT8183_SCP_CACHE_CON);
363 	writel(MT8183_SCP_CACHESIZE_8KB, scp->reg_base + MT8183_SCP_DCACHE_CON);
364 
365 	return 0;
366 }
367 
368 static void mt8192_power_on_sram(void __iomem *addr)
369 {
370 	int i;
371 
372 	for (i = 31; i >= 0; i--)
373 		writel(GENMASK(i, 0), addr);
374 	writel(0, addr);
375 }
376 
377 static void mt8192_power_off_sram(void __iomem *addr)
378 {
379 	int i;
380 
381 	writel(0, addr);
382 	for (i = 0; i < 32; i++)
383 		writel(GENMASK(i, 0), addr);
384 }
385 
386 static int mt8192_scp_before_load(struct mtk_scp *scp)
387 {
388 	/* clear SPM interrupt, SCP2SPM_IPC_CLR */
389 	writel(0xff, scp->reg_base + MT8192_SCP2SPM_IPC_CLR);
390 
391 	writel(1, scp->reg_base + MT8192_CORE0_SW_RSTN_SET);
392 
393 	/* enable SRAM clock */
394 	mt8192_power_on_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_0);
395 	mt8192_power_on_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_1);
396 	mt8192_power_on_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_2);
397 	mt8192_power_on_sram(scp->reg_base + MT8192_L1TCM_SRAM_PDN);
398 	mt8192_power_on_sram(scp->reg_base + MT8192_CPU0_SRAM_PD);
399 
400 	/* enable MPU for all memory regions */
401 	writel(0xff, scp->reg_base + MT8192_CORE0_MEM_ATT_PREDEF);
402 
403 	return 0;
404 }
405 
406 static int scp_load(struct rproc *rproc, const struct firmware *fw)
407 {
408 	struct mtk_scp *scp = rproc->priv;
409 	struct device *dev = scp->dev;
410 	int ret;
411 
412 	ret = clk_prepare_enable(scp->clk);
413 	if (ret) {
414 		dev_err(dev, "failed to enable clocks\n");
415 		return ret;
416 	}
417 
418 	/* Hold SCP in reset while loading FW. */
419 	scp->data->scp_reset_assert(scp);
420 
421 	ret = scp->data->scp_before_load(scp);
422 	if (ret < 0)
423 		goto leave;
424 
425 	ret = scp_elf_load_segments(rproc, fw);
426 leave:
427 	clk_disable_unprepare(scp->clk);
428 
429 	return ret;
430 }
431 
432 static int scp_parse_fw(struct rproc *rproc, const struct firmware *fw)
433 {
434 	struct mtk_scp *scp = rproc->priv;
435 	struct device *dev = scp->dev;
436 	int ret;
437 
438 	ret = clk_prepare_enable(scp->clk);
439 	if (ret) {
440 		dev_err(dev, "failed to enable clocks\n");
441 		return ret;
442 	}
443 
444 	ret = scp_ipi_init(scp, fw);
445 	clk_disable_unprepare(scp->clk);
446 	return ret;
447 }
448 
449 static int scp_start(struct rproc *rproc)
450 {
451 	struct mtk_scp *scp = (struct mtk_scp *)rproc->priv;
452 	struct device *dev = scp->dev;
453 	struct scp_run *run = &scp->run;
454 	int ret;
455 
456 	ret = clk_prepare_enable(scp->clk);
457 	if (ret) {
458 		dev_err(dev, "failed to enable clocks\n");
459 		return ret;
460 	}
461 
462 	run->signaled = false;
463 
464 	scp->data->scp_reset_deassert(scp);
465 
466 	ret = wait_event_interruptible_timeout(
467 					run->wq,
468 					run->signaled,
469 					msecs_to_jiffies(2000));
470 
471 	if (ret == 0) {
472 		dev_err(dev, "wait SCP initialization timeout!\n");
473 		ret = -ETIME;
474 		goto stop;
475 	}
476 	if (ret == -ERESTARTSYS) {
477 		dev_err(dev, "wait SCP interrupted by a signal!\n");
478 		goto stop;
479 	}
480 
481 	clk_disable_unprepare(scp->clk);
482 	dev_info(dev, "SCP is ready. FW version %s\n", run->fw_ver);
483 
484 	return 0;
485 
486 stop:
487 	scp->data->scp_reset_assert(scp);
488 	clk_disable_unprepare(scp->clk);
489 	return ret;
490 }
491 
492 static void *mt8183_scp_da_to_va(struct mtk_scp *scp, u64 da, size_t len)
493 {
494 	int offset;
495 
496 	if (da < scp->sram_size) {
497 		offset = da;
498 		if (offset >= 0 && (offset + len) <= scp->sram_size)
499 			return (void __force *)scp->sram_base + offset;
500 	} else if (scp->dram_size) {
501 		offset = da - scp->dma_addr;
502 		if (offset >= 0 && (offset + len) <= scp->dram_size)
503 			return scp->cpu_addr + offset;
504 	}
505 
506 	return NULL;
507 }
508 
509 static void *mt8192_scp_da_to_va(struct mtk_scp *scp, u64 da, size_t len)
510 {
511 	int offset;
512 
513 	if (da >= scp->sram_phys &&
514 	    (da + len) <= scp->sram_phys + scp->sram_size) {
515 		offset = da - scp->sram_phys;
516 		return (void __force *)scp->sram_base + offset;
517 	}
518 
519 	/* optional memory region */
520 	if (scp->l1tcm_size &&
521 	    da >= scp->l1tcm_phys &&
522 	    (da + len) <= scp->l1tcm_phys + scp->l1tcm_size) {
523 		offset = da - scp->l1tcm_phys;
524 		return (void __force *)scp->l1tcm_base + offset;
525 	}
526 
527 	/* optional memory region */
528 	if (scp->dram_size &&
529 	    da >= scp->dma_addr &&
530 	    (da + len) <= scp->dma_addr + scp->dram_size) {
531 		offset = da - scp->dma_addr;
532 		return scp->cpu_addr + offset;
533 	}
534 
535 	return NULL;
536 }
537 
538 static void *scp_da_to_va(struct rproc *rproc, u64 da, size_t len, bool *is_iomem)
539 {
540 	struct mtk_scp *scp = (struct mtk_scp *)rproc->priv;
541 
542 	return scp->data->scp_da_to_va(scp, da, len);
543 }
544 
545 static void mt8183_scp_stop(struct mtk_scp *scp)
546 {
547 	/* Disable SCP watchdog */
548 	writel(0, scp->reg_base + MT8183_WDT_CFG);
549 }
550 
551 static void mt8192_scp_stop(struct mtk_scp *scp)
552 {
553 	/* Disable SRAM clock */
554 	mt8192_power_off_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_0);
555 	mt8192_power_off_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_1);
556 	mt8192_power_off_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_2);
557 	mt8192_power_off_sram(scp->reg_base + MT8192_L1TCM_SRAM_PDN);
558 	mt8192_power_off_sram(scp->reg_base + MT8192_CPU0_SRAM_PD);
559 
560 	/* Disable SCP watchdog */
561 	writel(0, scp->reg_base + MT8192_CORE0_WDT_CFG);
562 }
563 
564 static int scp_stop(struct rproc *rproc)
565 {
566 	struct mtk_scp *scp = (struct mtk_scp *)rproc->priv;
567 	int ret;
568 
569 	ret = clk_prepare_enable(scp->clk);
570 	if (ret) {
571 		dev_err(scp->dev, "failed to enable clocks\n");
572 		return ret;
573 	}
574 
575 	scp->data->scp_reset_assert(scp);
576 	scp->data->scp_stop(scp);
577 	clk_disable_unprepare(scp->clk);
578 
579 	return 0;
580 }
581 
582 static const struct rproc_ops scp_ops = {
583 	.start		= scp_start,
584 	.stop		= scp_stop,
585 	.load		= scp_load,
586 	.da_to_va	= scp_da_to_va,
587 	.parse_fw	= scp_parse_fw,
588 };
589 
590 /**
591  * scp_get_device() - get device struct of SCP
592  *
593  * @scp:	mtk_scp structure
594  **/
595 struct device *scp_get_device(struct mtk_scp *scp)
596 {
597 	return scp->dev;
598 }
599 EXPORT_SYMBOL_GPL(scp_get_device);
600 
601 /**
602  * scp_get_rproc() - get rproc struct of SCP
603  *
604  * @scp:	mtk_scp structure
605  **/
606 struct rproc *scp_get_rproc(struct mtk_scp *scp)
607 {
608 	return scp->rproc;
609 }
610 EXPORT_SYMBOL_GPL(scp_get_rproc);
611 
612 /**
613  * scp_get_vdec_hw_capa() - get video decoder hardware capability
614  *
615  * @scp:	mtk_scp structure
616  *
617  * Return: video decoder hardware capability
618  **/
619 unsigned int scp_get_vdec_hw_capa(struct mtk_scp *scp)
620 {
621 	return scp->run.dec_capability;
622 }
623 EXPORT_SYMBOL_GPL(scp_get_vdec_hw_capa);
624 
625 /**
626  * scp_get_venc_hw_capa() - get video encoder hardware capability
627  *
628  * @scp:	mtk_scp structure
629  *
630  * Return: video encoder hardware capability
631  **/
632 unsigned int scp_get_venc_hw_capa(struct mtk_scp *scp)
633 {
634 	return scp->run.enc_capability;
635 }
636 EXPORT_SYMBOL_GPL(scp_get_venc_hw_capa);
637 
638 /**
639  * scp_mapping_dm_addr() - Mapping SRAM/DRAM to kernel virtual address
640  *
641  * @scp:	mtk_scp structure
642  * @mem_addr:	SCP views memory address
643  *
644  * Mapping the SCP's SRAM address /
645  * DMEM (Data Extended Memory) memory address /
646  * Working buffer memory address to
647  * kernel virtual address.
648  *
649  * Return: Return ERR_PTR(-EINVAL) if mapping failed,
650  * otherwise the mapped kernel virtual address
651  **/
652 void *scp_mapping_dm_addr(struct mtk_scp *scp, u32 mem_addr)
653 {
654 	void *ptr;
655 
656 	ptr = scp_da_to_va(scp->rproc, mem_addr, 0, NULL);
657 	if (!ptr)
658 		return ERR_PTR(-EINVAL);
659 
660 	return ptr;
661 }
662 EXPORT_SYMBOL_GPL(scp_mapping_dm_addr);
663 
664 static int scp_map_memory_region(struct mtk_scp *scp)
665 {
666 	int ret;
667 
668 	ret = of_reserved_mem_device_init(scp->dev);
669 
670 	/* reserved memory is optional. */
671 	if (ret == -ENODEV) {
672 		dev_info(scp->dev, "skipping reserved memory initialization.");
673 		return 0;
674 	}
675 
676 	if (ret) {
677 		dev_err(scp->dev, "failed to assign memory-region: %d\n", ret);
678 		return -ENOMEM;
679 	}
680 
681 	/* Reserved SCP code size */
682 	scp->dram_size = MAX_CODE_SIZE;
683 	scp->cpu_addr = dma_alloc_coherent(scp->dev, scp->dram_size,
684 					   &scp->dma_addr, GFP_KERNEL);
685 	if (!scp->cpu_addr)
686 		return -ENOMEM;
687 
688 	return 0;
689 }
690 
691 static void scp_unmap_memory_region(struct mtk_scp *scp)
692 {
693 	if (scp->dram_size == 0)
694 		return;
695 
696 	dma_free_coherent(scp->dev, scp->dram_size, scp->cpu_addr,
697 			  scp->dma_addr);
698 	of_reserved_mem_device_release(scp->dev);
699 }
700 
701 static int scp_register_ipi(struct platform_device *pdev, u32 id,
702 			    ipi_handler_t handler, void *priv)
703 {
704 	struct mtk_scp *scp = platform_get_drvdata(pdev);
705 
706 	return scp_ipi_register(scp, id, handler, priv);
707 }
708 
709 static void scp_unregister_ipi(struct platform_device *pdev, u32 id)
710 {
711 	struct mtk_scp *scp = platform_get_drvdata(pdev);
712 
713 	scp_ipi_unregister(scp, id);
714 }
715 
716 static int scp_send_ipi(struct platform_device *pdev, u32 id, void *buf,
717 			unsigned int len, unsigned int wait)
718 {
719 	struct mtk_scp *scp = platform_get_drvdata(pdev);
720 
721 	return scp_ipi_send(scp, id, buf, len, wait);
722 }
723 
724 static struct mtk_rpmsg_info mtk_scp_rpmsg_info = {
725 	.send_ipi = scp_send_ipi,
726 	.register_ipi = scp_register_ipi,
727 	.unregister_ipi = scp_unregister_ipi,
728 	.ns_ipi_id = SCP_IPI_NS_SERVICE,
729 };
730 
731 static void scp_add_rpmsg_subdev(struct mtk_scp *scp)
732 {
733 	scp->rpmsg_subdev =
734 		mtk_rpmsg_create_rproc_subdev(to_platform_device(scp->dev),
735 					      &mtk_scp_rpmsg_info);
736 	if (scp->rpmsg_subdev)
737 		rproc_add_subdev(scp->rproc, scp->rpmsg_subdev);
738 }
739 
740 static void scp_remove_rpmsg_subdev(struct mtk_scp *scp)
741 {
742 	if (scp->rpmsg_subdev) {
743 		rproc_remove_subdev(scp->rproc, scp->rpmsg_subdev);
744 		mtk_rpmsg_destroy_rproc_subdev(scp->rpmsg_subdev);
745 		scp->rpmsg_subdev = NULL;
746 	}
747 }
748 
749 static int scp_probe(struct platform_device *pdev)
750 {
751 	struct device *dev = &pdev->dev;
752 	struct device_node *np = dev->of_node;
753 	struct mtk_scp *scp;
754 	struct rproc *rproc;
755 	struct resource *res;
756 	char *fw_name = "scp.img";
757 	int ret, i;
758 
759 	rproc = rproc_alloc(dev,
760 			    np->name,
761 			    &scp_ops,
762 			    fw_name,
763 			    sizeof(*scp));
764 	if (!rproc) {
765 		dev_err(dev, "unable to allocate remoteproc\n");
766 		return -ENOMEM;
767 	}
768 
769 	scp = (struct mtk_scp *)rproc->priv;
770 	scp->rproc = rproc;
771 	scp->dev = dev;
772 	scp->data = of_device_get_match_data(dev);
773 	platform_set_drvdata(pdev, scp);
774 
775 	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "sram");
776 	scp->sram_base = devm_ioremap_resource(dev, res);
777 	if (IS_ERR((__force void *)scp->sram_base)) {
778 		dev_err(dev, "Failed to parse and map sram memory\n");
779 		ret = PTR_ERR((__force void *)scp->sram_base);
780 		goto free_rproc;
781 	}
782 	scp->sram_size = resource_size(res);
783 	scp->sram_phys = res->start;
784 
785 	/* l1tcm is an optional memory region */
786 	res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "l1tcm");
787 	scp->l1tcm_base = devm_ioremap_resource(dev, res);
788 	if (IS_ERR((__force void *)scp->l1tcm_base)) {
789 		ret = PTR_ERR((__force void *)scp->l1tcm_base);
790 		if (ret != -EINVAL) {
791 			dev_err(dev, "Failed to map l1tcm memory\n");
792 			goto free_rproc;
793 		}
794 	} else {
795 		scp->l1tcm_size = resource_size(res);
796 		scp->l1tcm_phys = res->start;
797 	}
798 
799 	mutex_init(&scp->send_lock);
800 	for (i = 0; i < SCP_IPI_MAX; i++)
801 		mutex_init(&scp->ipi_desc[i].lock);
802 
803 	scp->reg_base = devm_platform_ioremap_resource_byname(pdev, "cfg");
804 	if (IS_ERR((__force void *)scp->reg_base)) {
805 		dev_err(dev, "Failed to parse and map cfg memory\n");
806 		ret = PTR_ERR((__force void *)scp->reg_base);
807 		goto destroy_mutex;
808 	}
809 
810 	ret = scp_map_memory_region(scp);
811 	if (ret)
812 		goto destroy_mutex;
813 
814 	ret = scp->data->scp_clk_get(scp);
815 	if (ret)
816 		goto release_dev_mem;
817 
818 	/* register SCP initialization IPI */
819 	ret = scp_ipi_register(scp, SCP_IPI_INIT, scp_init_ipi_handler, scp);
820 	if (ret) {
821 		dev_err(dev, "Failed to register IPI_SCP_INIT\n");
822 		goto release_dev_mem;
823 	}
824 
825 	init_waitqueue_head(&scp->run.wq);
826 	init_waitqueue_head(&scp->ack_wq);
827 
828 	scp_add_rpmsg_subdev(scp);
829 
830 	ret = devm_request_threaded_irq(dev, platform_get_irq(pdev, 0), NULL,
831 					scp_irq_handler, IRQF_ONESHOT,
832 					pdev->name, scp);
833 
834 	if (ret) {
835 		dev_err(dev, "failed to request irq\n");
836 		goto remove_subdev;
837 	}
838 
839 	ret = rproc_add(rproc);
840 	if (ret)
841 		goto remove_subdev;
842 
843 	return 0;
844 
845 remove_subdev:
846 	scp_remove_rpmsg_subdev(scp);
847 	scp_ipi_unregister(scp, SCP_IPI_INIT);
848 release_dev_mem:
849 	scp_unmap_memory_region(scp);
850 destroy_mutex:
851 	for (i = 0; i < SCP_IPI_MAX; i++)
852 		mutex_destroy(&scp->ipi_desc[i].lock);
853 	mutex_destroy(&scp->send_lock);
854 free_rproc:
855 	rproc_free(rproc);
856 
857 	return ret;
858 }
859 
860 static int scp_remove(struct platform_device *pdev)
861 {
862 	struct mtk_scp *scp = platform_get_drvdata(pdev);
863 	int i;
864 
865 	rproc_del(scp->rproc);
866 	scp_remove_rpmsg_subdev(scp);
867 	scp_ipi_unregister(scp, SCP_IPI_INIT);
868 	scp_unmap_memory_region(scp);
869 	for (i = 0; i < SCP_IPI_MAX; i++)
870 		mutex_destroy(&scp->ipi_desc[i].lock);
871 	mutex_destroy(&scp->send_lock);
872 	rproc_free(scp->rproc);
873 
874 	return 0;
875 }
876 
877 static const struct mtk_scp_of_data mt8183_of_data = {
878 	.scp_clk_get = mt8183_scp_clk_get,
879 	.scp_before_load = mt8183_scp_before_load,
880 	.scp_irq_handler = mt8183_scp_irq_handler,
881 	.scp_reset_assert = mt8183_scp_reset_assert,
882 	.scp_reset_deassert = mt8183_scp_reset_deassert,
883 	.scp_stop = mt8183_scp_stop,
884 	.scp_da_to_va = mt8183_scp_da_to_va,
885 	.host_to_scp_reg = MT8183_HOST_TO_SCP,
886 	.host_to_scp_int_bit = MT8183_HOST_IPC_INT_BIT,
887 	.ipi_buf_offset = 0x7bdb0,
888 };
889 
890 static const struct mtk_scp_of_data mt8192_of_data = {
891 	.scp_clk_get = mt8192_scp_clk_get,
892 	.scp_before_load = mt8192_scp_before_load,
893 	.scp_irq_handler = mt8192_scp_irq_handler,
894 	.scp_reset_assert = mt8192_scp_reset_assert,
895 	.scp_reset_deassert = mt8192_scp_reset_deassert,
896 	.scp_stop = mt8192_scp_stop,
897 	.scp_da_to_va = mt8192_scp_da_to_va,
898 	.host_to_scp_reg = MT8192_GIPC_IN_SET,
899 	.host_to_scp_int_bit = MT8192_HOST_IPC_INT_BIT,
900 };
901 
902 static const struct mtk_scp_of_data mt8195_of_data = {
903 	.scp_clk_get = mt8195_scp_clk_get,
904 	.scp_before_load = mt8192_scp_before_load,
905 	.scp_irq_handler = mt8192_scp_irq_handler,
906 	.scp_reset_assert = mt8192_scp_reset_assert,
907 	.scp_reset_deassert = mt8192_scp_reset_deassert,
908 	.scp_stop = mt8192_scp_stop,
909 	.scp_da_to_va = mt8192_scp_da_to_va,
910 	.host_to_scp_reg = MT8192_GIPC_IN_SET,
911 	.host_to_scp_int_bit = MT8192_HOST_IPC_INT_BIT,
912 };
913 
914 static const struct of_device_id mtk_scp_of_match[] = {
915 	{ .compatible = "mediatek,mt8183-scp", .data = &mt8183_of_data },
916 	{ .compatible = "mediatek,mt8192-scp", .data = &mt8192_of_data },
917 	{ .compatible = "mediatek,mt8195-scp", .data = &mt8195_of_data },
918 	{},
919 };
920 MODULE_DEVICE_TABLE(of, mtk_scp_of_match);
921 
922 static struct platform_driver mtk_scp_driver = {
923 	.probe = scp_probe,
924 	.remove = scp_remove,
925 	.driver = {
926 		.name = "mtk-scp",
927 		.of_match_table = mtk_scp_of_match,
928 	},
929 };
930 
931 module_platform_driver(mtk_scp_driver);
932 
933 MODULE_LICENSE("GPL v2");
934 MODULE_DESCRIPTION("MediaTek SCP control driver");
935