1 // SPDX-License-Identifier: GPL-2.0
3 // Copyright (c) 2019 MediaTek Inc.
5 #include <asm/barrier.h>
7 #include <linux/dma-mapping.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>
20 #include "mtk_common.h"
21 #include "remoteproc_internal.h"
23 #define MAX_CODE_SIZE 0x500000
24 #define SCP_FW_END 0x7C000
27 * scp_get() - get a reference to SCP.
29 * @pdev: the platform device of the module requesting SCP platform
30 * device for using SCP API.
32 * Return: Return NULL if failed. otherwise reference to SCP.
34 struct mtk_scp *scp_get(struct platform_device *pdev)
36 struct device *dev = &pdev->dev;
37 struct device_node *scp_node;
38 struct platform_device *scp_pdev;
40 scp_node = of_parse_phandle(dev->of_node, "mediatek,scp", 0);
42 dev_err(dev, "can't get SCP node\n");
46 scp_pdev = of_find_device_by_node(scp_node);
47 of_node_put(scp_node);
49 if (WARN_ON(!scp_pdev)) {
50 dev_err(dev, "SCP pdev failed\n");
54 return platform_get_drvdata(scp_pdev);
56 EXPORT_SYMBOL_GPL(scp_get);
59 * scp_put() - "free" the SCP
61 * @scp: mtk_scp structure from scp_get().
63 void scp_put(struct mtk_scp *scp)
67 EXPORT_SYMBOL_GPL(scp_put);
69 static void scp_wdt_handler(struct mtk_scp *scp, u32 scp_to_host)
71 dev_err(scp->dev, "SCP watchdog timeout! 0x%x", scp_to_host);
72 rproc_report_crash(scp->rproc, RPROC_WATCHDOG);
75 static void scp_init_ipi_handler(void *data, unsigned int len, void *priv)
77 struct mtk_scp *scp = (struct mtk_scp *)priv;
78 struct scp_run *run = (struct scp_run *)data;
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);
87 static void scp_ipi_handler(struct mtk_scp *scp)
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);
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);
101 if (id >= SCP_IPI_MAX) {
102 dev_err(scp->dev, "No such ipi id = %d\n", id);
106 scp_ipi_lock(scp, id);
107 handler = ipi_desc[id].handler;
109 dev_err(scp->dev, "No such ipi id = %d\n", id);
110 scp_ipi_unlock(scp, id);
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);
118 scp->ipi_id_ack[id] = true;
119 wake_up(&scp->ack_wq);
122 static int scp_ipi_init(struct mtk_scp *scp)
124 size_t send_offset = SCP_FW_END - sizeof(struct mtk_share_obj);
125 size_t recv_offset = send_offset - sizeof(struct mtk_share_obj);
127 /* shared buffer initialization */
129 (struct mtk_share_obj __iomem *)(scp->sram_base + recv_offset);
131 (struct mtk_share_obj __iomem *)(scp->sram_base + send_offset);
132 memset_io(scp->recv_buf, 0, sizeof(*scp->recv_buf));
133 memset_io(scp->send_buf, 0, sizeof(*scp->send_buf));
138 static void mt8183_scp_reset_assert(struct mtk_scp *scp)
142 val = readl(scp->reg_base + MT8183_SW_RSTN);
143 val &= ~MT8183_SW_RSTN_BIT;
144 writel(val, scp->reg_base + MT8183_SW_RSTN);
147 static void mt8183_scp_reset_deassert(struct mtk_scp *scp)
151 val = readl(scp->reg_base + MT8183_SW_RSTN);
152 val |= MT8183_SW_RSTN_BIT;
153 writel(val, scp->reg_base + MT8183_SW_RSTN);
156 static void mt8192_scp_reset_assert(struct mtk_scp *scp)
158 writel(1, scp->reg_base + MT8192_CORE0_SW_RSTN_SET);
161 static void mt8192_scp_reset_deassert(struct mtk_scp *scp)
163 writel(1, scp->reg_base + MT8192_CORE0_SW_RSTN_CLR);
166 static void mt8183_scp_irq_handler(struct mtk_scp *scp)
170 scp_to_host = readl(scp->reg_base + MT8183_SCP_TO_HOST);
171 if (scp_to_host & MT8183_SCP_IPC_INT_BIT)
172 scp_ipi_handler(scp);
174 scp_wdt_handler(scp, scp_to_host);
176 /* SCP won't send another interrupt until we set SCP_TO_HOST to 0. */
177 writel(MT8183_SCP_IPC_INT_BIT | MT8183_SCP_WDT_INT_BIT,
178 scp->reg_base + MT8183_SCP_TO_HOST);
181 static void mt8192_scp_irq_handler(struct mtk_scp *scp)
185 scp_to_host = readl(scp->reg_base + MT8192_SCP2APMCU_IPC_SET);
187 if (scp_to_host & MT8192_SCP_IPC_INT_BIT) {
188 scp_ipi_handler(scp);
191 * SCP won't send another interrupt until we clear
192 * MT8192_SCP2APMCU_IPC.
194 writel(MT8192_SCP_IPC_INT_BIT,
195 scp->reg_base + MT8192_SCP2APMCU_IPC_CLR);
197 scp_wdt_handler(scp, scp_to_host);
198 writel(1, scp->reg_base + MT8192_CORE0_WDT_IRQ);
202 static irqreturn_t scp_irq_handler(int irq, void *priv)
204 struct mtk_scp *scp = priv;
207 ret = clk_prepare_enable(scp->clk);
209 dev_err(scp->dev, "failed to enable clocks\n");
213 scp->data->scp_irq_handler(scp);
215 clk_disable_unprepare(scp->clk);
220 static int scp_elf_load_segments(struct rproc *rproc, const struct firmware *fw)
222 struct device *dev = &rproc->dev;
223 struct elf32_hdr *ehdr;
224 struct elf32_phdr *phdr;
226 const u8 *elf_data = fw->data;
228 ehdr = (struct elf32_hdr *)elf_data;
229 phdr = (struct elf32_phdr *)(elf_data + ehdr->e_phoff);
231 /* go through the available ELF segments */
232 for (i = 0; i < ehdr->e_phnum; i++, phdr++) {
233 u32 da = phdr->p_paddr;
234 u32 memsz = phdr->p_memsz;
235 u32 filesz = phdr->p_filesz;
236 u32 offset = phdr->p_offset;
239 if (phdr->p_type != PT_LOAD)
242 dev_dbg(dev, "phdr: type %d da 0x%x memsz 0x%x filesz 0x%x\n",
243 phdr->p_type, da, memsz, filesz);
245 if (filesz > memsz) {
246 dev_err(dev, "bad phdr filesz 0x%x memsz 0x%x\n",
252 if (offset + filesz > fw->size) {
253 dev_err(dev, "truncated fw: need 0x%x avail 0x%zx\n",
254 offset + filesz, fw->size);
259 /* grab the kernel address for this device address */
260 ptr = (void __iomem *)rproc_da_to_va(rproc, da, memsz);
262 dev_err(dev, "bad phdr da 0x%x mem 0x%x\n", da, memsz);
267 /* put the segment where the remote processor expects it */
269 scp_memcpy_aligned(ptr, elf_data + phdr->p_offset,
276 static int mt8183_scp_before_load(struct mtk_scp *scp)
278 /* Clear SCP to host interrupt */
279 writel(MT8183_SCP_IPC_INT_BIT, scp->reg_base + MT8183_SCP_TO_HOST);
281 /* Reset clocks before loading FW */
282 writel(0x0, scp->reg_base + MT8183_SCP_CLK_SW_SEL);
283 writel(0x0, scp->reg_base + MT8183_SCP_CLK_DIV_SEL);
285 /* Initialize TCM before loading FW. */
286 writel(0x0, scp->reg_base + MT8183_SCP_L1_SRAM_PD);
287 writel(0x0, scp->reg_base + MT8183_SCP_TCM_TAIL_SRAM_PD);
289 /* Turn on the power of SCP's SRAM before using it. */
290 writel(0x0, scp->reg_base + MT8183_SCP_SRAM_PDN);
293 * Set I-cache and D-cache size before loading SCP FW.
294 * SCP SRAM logical address may change when cache size setting differs.
296 writel(MT8183_SCP_CACHE_CON_WAYEN | MT8183_SCP_CACHESIZE_8KB,
297 scp->reg_base + MT8183_SCP_CACHE_CON);
298 writel(MT8183_SCP_CACHESIZE_8KB, scp->reg_base + MT8183_SCP_DCACHE_CON);
303 static void mt8192_power_on_sram(void *addr)
307 for (i = 31; i >= 0; i--)
308 writel(GENMASK(i, 0), addr);
312 static void mt8192_power_off_sram(void *addr)
317 for (i = 0; i < 32; i++)
318 writel(GENMASK(i, 0), addr);
321 static int mt8192_scp_before_load(struct mtk_scp *scp)
323 /* clear SPM interrupt, SCP2SPM_IPC_CLR */
324 writel(0xff, scp->reg_base + MT8192_SCP2SPM_IPC_CLR);
326 writel(1, scp->reg_base + MT8192_CORE0_SW_RSTN_SET);
328 /* enable SRAM clock */
329 mt8192_power_on_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_0);
330 mt8192_power_on_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_1);
331 mt8192_power_on_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_2);
332 mt8192_power_on_sram(scp->reg_base + MT8192_L1TCM_SRAM_PDN);
333 mt8192_power_on_sram(scp->reg_base + MT8192_CPU0_SRAM_PD);
338 static int scp_load(struct rproc *rproc, const struct firmware *fw)
340 struct mtk_scp *scp = rproc->priv;
341 struct device *dev = scp->dev;
344 ret = clk_prepare_enable(scp->clk);
346 dev_err(dev, "failed to enable clocks\n");
350 /* Hold SCP in reset while loading FW. */
351 scp->data->scp_reset_assert(scp);
353 ret = scp->data->scp_before_load(scp);
357 ret = scp_elf_load_segments(rproc, fw);
359 clk_disable_unprepare(scp->clk);
364 static int scp_start(struct rproc *rproc)
366 struct mtk_scp *scp = (struct mtk_scp *)rproc->priv;
367 struct device *dev = scp->dev;
368 struct scp_run *run = &scp->run;
371 ret = clk_prepare_enable(scp->clk);
373 dev_err(dev, "failed to enable clocks\n");
377 run->signaled = false;
379 scp->data->scp_reset_deassert(scp);
381 ret = wait_event_interruptible_timeout(
384 msecs_to_jiffies(2000));
387 dev_err(dev, "wait SCP initialization timeout!\n");
391 if (ret == -ERESTARTSYS) {
392 dev_err(dev, "wait SCP interrupted by a signal!\n");
396 clk_disable_unprepare(scp->clk);
397 dev_info(dev, "SCP is ready. FW version %s\n", run->fw_ver);
402 scp->data->scp_reset_assert(scp);
403 clk_disable_unprepare(scp->clk);
407 static void *scp_da_to_va(struct rproc *rproc, u64 da, size_t len)
409 struct mtk_scp *scp = (struct mtk_scp *)rproc->priv;
412 if (da < scp->sram_size) {
414 if (offset >= 0 && (offset + len) < scp->sram_size)
415 return (void __force *)scp->sram_base + offset;
416 } else if (scp->dram_size) {
417 offset = da - scp->dma_addr;
418 if (offset >= 0 && (offset + len) < scp->dram_size)
419 return (void __force *)scp->cpu_addr + offset;
425 static void mt8183_scp_stop(struct mtk_scp *scp)
427 /* Disable SCP watchdog */
428 writel(0, scp->reg_base + MT8183_WDT_CFG);
431 static void mt8192_scp_stop(struct mtk_scp *scp)
433 /* Disable SRAM clock */
434 mt8192_power_off_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_0);
435 mt8192_power_off_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_1);
436 mt8192_power_off_sram(scp->reg_base + MT8192_L2TCM_SRAM_PD_2);
437 mt8192_power_off_sram(scp->reg_base + MT8192_L1TCM_SRAM_PDN);
438 mt8192_power_off_sram(scp->reg_base + MT8192_CPU0_SRAM_PD);
440 /* Disable SCP watchdog */
441 writel(0, scp->reg_base + MT8192_CORE0_WDT_CFG);
444 static int scp_stop(struct rproc *rproc)
446 struct mtk_scp *scp = (struct mtk_scp *)rproc->priv;
449 ret = clk_prepare_enable(scp->clk);
451 dev_err(scp->dev, "failed to enable clocks\n");
455 scp->data->scp_reset_assert(scp);
456 scp->data->scp_stop(scp);
457 clk_disable_unprepare(scp->clk);
462 static const struct rproc_ops scp_ops = {
466 .da_to_va = scp_da_to_va,
470 * scp_get_device() - get device struct of SCP
472 * @scp: mtk_scp structure
474 struct device *scp_get_device(struct mtk_scp *scp)
478 EXPORT_SYMBOL_GPL(scp_get_device);
481 * scp_get_rproc() - get rproc struct of SCP
483 * @scp: mtk_scp structure
485 struct rproc *scp_get_rproc(struct mtk_scp *scp)
489 EXPORT_SYMBOL_GPL(scp_get_rproc);
492 * scp_get_vdec_hw_capa() - get video decoder hardware capability
494 * @scp: mtk_scp structure
496 * Return: video decoder hardware capability
498 unsigned int scp_get_vdec_hw_capa(struct mtk_scp *scp)
500 return scp->run.dec_capability;
502 EXPORT_SYMBOL_GPL(scp_get_vdec_hw_capa);
505 * scp_get_venc_hw_capa() - get video encoder hardware capability
507 * @scp: mtk_scp structure
509 * Return: video encoder hardware capability
511 unsigned int scp_get_venc_hw_capa(struct mtk_scp *scp)
513 return scp->run.enc_capability;
515 EXPORT_SYMBOL_GPL(scp_get_venc_hw_capa);
518 * scp_mapping_dm_addr() - Mapping SRAM/DRAM to kernel virtual address
520 * @scp: mtk_scp structure
521 * @mem_addr: SCP views memory address
523 * Mapping the SCP's SRAM address /
524 * DMEM (Data Extended Memory) memory address /
525 * Working buffer memory address to
526 * kernel virtual address.
528 * Return: Return ERR_PTR(-EINVAL) if mapping failed,
529 * otherwise the mapped kernel virtual address
531 void *scp_mapping_dm_addr(struct mtk_scp *scp, u32 mem_addr)
535 ptr = scp_da_to_va(scp->rproc, mem_addr, 0);
537 return ERR_PTR(-EINVAL);
541 EXPORT_SYMBOL_GPL(scp_mapping_dm_addr);
543 static int scp_map_memory_region(struct mtk_scp *scp)
547 ret = of_reserved_mem_device_init(scp->dev);
549 /* reserved memory is optional. */
550 if (ret == -ENODEV) {
551 dev_info(scp->dev, "skipping reserved memory initialization.");
556 dev_err(scp->dev, "failed to assign memory-region: %d\n", ret);
560 /* Reserved SCP code size */
561 scp->dram_size = MAX_CODE_SIZE;
562 scp->cpu_addr = dma_alloc_coherent(scp->dev, scp->dram_size,
563 &scp->dma_addr, GFP_KERNEL);
570 static void scp_unmap_memory_region(struct mtk_scp *scp)
572 if (scp->dram_size == 0)
575 dma_free_coherent(scp->dev, scp->dram_size, scp->cpu_addr,
577 of_reserved_mem_device_release(scp->dev);
580 static int scp_register_ipi(struct platform_device *pdev, u32 id,
581 ipi_handler_t handler, void *priv)
583 struct mtk_scp *scp = platform_get_drvdata(pdev);
585 return scp_ipi_register(scp, id, handler, priv);
588 static void scp_unregister_ipi(struct platform_device *pdev, u32 id)
590 struct mtk_scp *scp = platform_get_drvdata(pdev);
592 scp_ipi_unregister(scp, id);
595 static int scp_send_ipi(struct platform_device *pdev, u32 id, void *buf,
596 unsigned int len, unsigned int wait)
598 struct mtk_scp *scp = platform_get_drvdata(pdev);
600 return scp_ipi_send(scp, id, buf, len, wait);
603 static struct mtk_rpmsg_info mtk_scp_rpmsg_info = {
604 .send_ipi = scp_send_ipi,
605 .register_ipi = scp_register_ipi,
606 .unregister_ipi = scp_unregister_ipi,
607 .ns_ipi_id = SCP_IPI_NS_SERVICE,
610 static void scp_add_rpmsg_subdev(struct mtk_scp *scp)
613 mtk_rpmsg_create_rproc_subdev(to_platform_device(scp->dev),
614 &mtk_scp_rpmsg_info);
615 if (scp->rpmsg_subdev)
616 rproc_add_subdev(scp->rproc, scp->rpmsg_subdev);
619 static void scp_remove_rpmsg_subdev(struct mtk_scp *scp)
621 if (scp->rpmsg_subdev) {
622 rproc_remove_subdev(scp->rproc, scp->rpmsg_subdev);
623 mtk_rpmsg_destroy_rproc_subdev(scp->rpmsg_subdev);
624 scp->rpmsg_subdev = NULL;
628 static int scp_probe(struct platform_device *pdev)
630 struct device *dev = &pdev->dev;
631 struct device_node *np = dev->of_node;
634 struct resource *res;
635 char *fw_name = "/*(DEBLOBBED)*/";
638 rproc = rproc_alloc(dev,
644 dev_err(dev, "unable to allocate remoteproc\n");
648 scp = (struct mtk_scp *)rproc->priv;
651 scp->data = of_device_get_match_data(dev);
652 platform_set_drvdata(pdev, scp);
654 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "sram");
655 scp->sram_base = devm_ioremap_resource(dev, res);
656 if (IS_ERR((__force void *)scp->sram_base)) {
657 dev_err(dev, "Failed to parse and map sram memory\n");
658 ret = PTR_ERR((__force void *)scp->sram_base);
661 scp->sram_size = resource_size(res);
663 mutex_init(&scp->send_lock);
664 for (i = 0; i < SCP_IPI_MAX; i++)
665 mutex_init(&scp->ipi_desc[i].lock);
667 res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "cfg");
668 scp->reg_base = devm_ioremap_resource(dev, res);
669 if (IS_ERR((__force void *)scp->reg_base)) {
670 dev_err(dev, "Failed to parse and map cfg memory\n");
671 ret = PTR_ERR((__force void *)scp->reg_base);
675 ret = scp_map_memory_region(scp);
679 scp->clk = devm_clk_get(dev, "main");
680 if (IS_ERR(scp->clk)) {
681 dev_err(dev, "Failed to get clock\n");
682 ret = PTR_ERR(scp->clk);
683 goto release_dev_mem;
686 ret = clk_prepare_enable(scp->clk);
688 dev_err(dev, "failed to enable clocks\n");
689 goto release_dev_mem;
692 ret = scp_ipi_init(scp);
693 clk_disable_unprepare(scp->clk);
695 dev_err(dev, "Failed to init ipi\n");
696 goto release_dev_mem;
699 /* register SCP initialization IPI */
700 ret = scp_ipi_register(scp, SCP_IPI_INIT, scp_init_ipi_handler, scp);
702 dev_err(dev, "Failed to register IPI_SCP_INIT\n");
703 goto release_dev_mem;
706 init_waitqueue_head(&scp->run.wq);
707 init_waitqueue_head(&scp->ack_wq);
709 scp_add_rpmsg_subdev(scp);
711 ret = devm_request_threaded_irq(dev, platform_get_irq(pdev, 0), NULL,
712 scp_irq_handler, IRQF_ONESHOT,
716 dev_err(dev, "failed to request irq\n");
720 ret = rproc_add(rproc);
727 scp_remove_rpmsg_subdev(scp);
728 scp_ipi_unregister(scp, SCP_IPI_INIT);
730 scp_unmap_memory_region(scp);
732 for (i = 0; i < SCP_IPI_MAX; i++)
733 mutex_destroy(&scp->ipi_desc[i].lock);
734 mutex_destroy(&scp->send_lock);
741 static int scp_remove(struct platform_device *pdev)
743 struct mtk_scp *scp = platform_get_drvdata(pdev);
746 rproc_del(scp->rproc);
747 scp_remove_rpmsg_subdev(scp);
748 scp_ipi_unregister(scp, SCP_IPI_INIT);
749 scp_unmap_memory_region(scp);
750 for (i = 0; i < SCP_IPI_MAX; i++)
751 mutex_destroy(&scp->ipi_desc[i].lock);
752 mutex_destroy(&scp->send_lock);
753 rproc_free(scp->rproc);
758 static const struct mtk_scp_of_data mt8183_of_data = {
759 .scp_before_load = mt8183_scp_before_load,
760 .scp_irq_handler = mt8183_scp_irq_handler,
761 .scp_reset_assert = mt8183_scp_reset_assert,
762 .scp_reset_deassert = mt8183_scp_reset_deassert,
763 .scp_stop = mt8183_scp_stop,
764 .host_to_scp_reg = MT8183_HOST_TO_SCP,
765 .host_to_scp_int_bit = MT8183_HOST_IPC_INT_BIT,
768 static const struct mtk_scp_of_data mt8192_of_data = {
769 .scp_before_load = mt8192_scp_before_load,
770 .scp_irq_handler = mt8192_scp_irq_handler,
771 .scp_reset_assert = mt8192_scp_reset_assert,
772 .scp_reset_deassert = mt8192_scp_reset_deassert,
773 .scp_stop = mt8192_scp_stop,
774 .host_to_scp_reg = MT8192_GIPC_IN_SET,
775 .host_to_scp_int_bit = MT8192_HOST_IPC_INT_BIT,
778 static const struct of_device_id mtk_scp_of_match[] = {
779 { .compatible = "mediatek,mt8183-scp", .data = &mt8183_of_data },
780 { .compatible = "mediatek,mt8192-scp", .data = &mt8192_of_data },
783 MODULE_DEVICE_TABLE(of, mtk_scp_of_match);
785 static struct platform_driver mtk_scp_driver = {
787 .remove = scp_remove,
790 .of_match_table = mtk_scp_of_match,
794 module_platform_driver(mtk_scp_driver);
796 MODULE_LICENSE("GPL v2");
797 MODULE_DESCRIPTION("MediaTek SCP control driver");