Re: [PATCH v14 05/12] remoteproc: mediatek: Introduce cluster on single-core SCP

From: Mathieu Poirier
Date: Wed Jul 12 2023 - 16:41:08 EST


>From an overall perspective this patchset looks good. Now that we can clearly
see what is going on there are a few things to improve on. Please see below.

On Fri, Jul 07, 2023 at 01:26:05PM +0800, Tinghan Shen wrote:
> This is the preliminary step for probing multi-core SCP.
> The initialization procedure for remoteproc is similar for both
> single-core and multi-core architectures and is reusing to avoid
> redundant code.
>
> Rewrite the probing flow of single-core SCP to adapt with the 'cluster'
> concept needed by probing the multi-core SCP. The main differences
> are,
> - the SCP core object(s) is maintained at the cluster list instead of at
> the platform device driver data property.
> - save the cluster information at the platform device driver data property.
> - In order to keep the compatibility of exported SCP APIs which getting
> the SCP core object by SCP node phandle, move the SCP core object
> pointers to the platform device platform data property.
>
> The registers of config and l1tcm are shared for multi-core
> SCP. Reuse the mapped addresses for all cores.
>
> Signed-off-by: Tinghan Shen <tinghan.shen@xxxxxxxxxxxx>
> ---
> drivers/remoteproc/mtk_common.h | 2 +
> drivers/remoteproc/mtk_scp.c | 151 +++++++++++++++++++++++---------
> 2 files changed, 112 insertions(+), 41 deletions(-)
>
> diff --git a/drivers/remoteproc/mtk_common.h b/drivers/remoteproc/mtk_common.h
> index c0905aec3b4b..56395e8664cb 100644
> --- a/drivers/remoteproc/mtk_common.h
> +++ b/drivers/remoteproc/mtk_common.h
> @@ -128,6 +128,8 @@ struct mtk_scp {
> size_t dram_size;
>
> struct rproc_subdev *rpmsg_subdev;
> +
> + struct list_head elem;
> };
>
> /**
> diff --git a/drivers/remoteproc/mtk_scp.c b/drivers/remoteproc/mtk_scp.c
> index 48e759c2d486..3a8c8bcfa46b 100644
> --- a/drivers/remoteproc/mtk_scp.c
> +++ b/drivers/remoteproc/mtk_scp.c
> @@ -23,6 +23,14 @@
> #define MAX_CODE_SIZE 0x500000
> #define SECTION_NAME_IPI_BUFFER ".ipi_buffer"
>
> +struct mtk_scp_of_cluster {
> + void __iomem *reg_base;
> + void __iomem *l1tcm_base;
> + size_t l1tcm_size;
> + phys_addr_t l1tcm_phys;
> + struct list_head mtk_scp_list;
> +};
> +
> /**
> * scp_get() - get a reference to SCP.
> *
> @@ -51,7 +59,7 @@ struct mtk_scp *scp_get(struct platform_device *pdev)
> return NULL;
> }
>
> - return platform_get_drvdata(scp_pdev);
> + return *(struct mtk_scp **)dev_get_platdata(&scp_pdev->dev);
> }
> EXPORT_SYMBOL_GPL(scp_get);
>
> @@ -809,14 +817,14 @@ static void scp_unmap_memory_region(struct mtk_scp *scp)
> static int scp_register_ipi(struct platform_device *pdev, u32 id,
> ipi_handler_t handler, void *priv)
> {
> - struct mtk_scp *scp = platform_get_drvdata(pdev);
> + struct mtk_scp *scp = *(struct mtk_scp **)dev_get_platdata(&pdev->dev);
>
> return scp_ipi_register(scp, id, handler, priv);
> }
>
> static void scp_unregister_ipi(struct platform_device *pdev, u32 id)
> {
> - struct mtk_scp *scp = platform_get_drvdata(pdev);
> + struct mtk_scp *scp = *(struct mtk_scp **)dev_get_platdata(&pdev->dev);
>
> scp_ipi_unregister(scp, id);
> }
> @@ -824,7 +832,7 @@ static void scp_unregister_ipi(struct platform_device *pdev, u32 id)
> static int scp_send_ipi(struct platform_device *pdev, u32 id, void *buf,
> unsigned int len, unsigned int wait)
> {
> - struct mtk_scp *scp = platform_get_drvdata(pdev);
> + struct mtk_scp *scp = *(struct mtk_scp **)dev_get_platdata(&pdev->dev);
>
> return scp_ipi_send(scp, id, buf, len, wait);
> }
> @@ -854,7 +862,8 @@ static void scp_remove_rpmsg_subdev(struct mtk_scp *scp)
> }
> }
>
> -static int scp_probe(struct platform_device *pdev)
> +static struct mtk_scp *scp_rproc_init(struct platform_device *pdev,
> + struct mtk_scp_of_cluster *scp_cluster)
> {
> struct device *dev = &pdev->dev;
> struct device_node *np = dev->of_node;
> @@ -866,52 +875,42 @@ static int scp_probe(struct platform_device *pdev)
>
> ret = rproc_of_parse_firmware(dev, 0, &fw_name);
> if (ret < 0 && ret != -EINVAL)
> - return ret;
> + return ERR_PTR(ret);
>
> rproc = devm_rproc_alloc(dev, np->name, &scp_ops, fw_name, sizeof(*scp));
> - if (!rproc)
> - return dev_err_probe(dev, -ENOMEM, "unable to allocate remoteproc\n");
> + if (!rproc) {
> + dev_err(dev, "unable to allocate remoteproc\n");
> + return ERR_PTR(-ENOMEM);
> + }
>
> scp = rproc->priv;
> scp->rproc = rproc;
> scp->dev = dev;
> scp->data = of_device_get_match_data(dev);
> - platform_set_drvdata(pdev, scp);
> + platform_device_add_data(pdev, &scp, sizeof(scp));

Using platform_device_add_data() doesn't work because it creates a duplicate
copy of @scp. To fix this I suggest to:

1. Change mtk_scp_of_cluster::l2tcm_lock to mtk_scp_of_cluster::cluster_lock
2. Add a struct mtk_scp_of_cluster *cluster to struct mtk_scp
3. Don't call platform_set_drvdata(pdev, scp_cluster) in scp_probe()
4. Above do scp->cluster = scp_cluster and call platform_set_drvdata(pdev, scp)
instead of platform_device_add_data().
5. Every time you are modifying scp->cluster, scp->cluster->cluster_lock must be
held.

> +
> + scp->reg_base = scp_cluster->reg_base;
> + scp->l1tcm_base = scp_cluster->l1tcm_base;
> + scp->l1tcm_size = scp_cluster->l1tcm_size;
> + scp->l1tcm_phys = scp_cluster->l1tcm_phys;


Fields reg_base, l1tcm_base, l1tcm_size and l1tcm_phy don't belong in the
mtk_scp struct anymore but in the mtk_scp_of_cluster struct. With the above
changes they should be available in the same way.

Thanks,
Mathieu

>
> res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "sram");
> scp->sram_base = devm_ioremap_resource(dev, res);
> - if (IS_ERR(scp->sram_base))
> - return dev_err_probe(dev, PTR_ERR(scp->sram_base),
> - "Failed to parse and map sram memory\n");
> + if (IS_ERR(scp->sram_base)) {
> + dev_err(dev, "Failed to parse and map sram memory\n");
> + return ERR_CAST(scp->sram_base);
> + }
>
> scp->sram_size = resource_size(res);
> scp->sram_phys = res->start;
>
> - /* l1tcm is an optional memory region */
> - res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "l1tcm");
> - scp->l1tcm_base = devm_ioremap_resource(dev, res);
> - if (IS_ERR(scp->l1tcm_base)) {
> - ret = PTR_ERR(scp->l1tcm_base);
> - if (ret != -EINVAL) {
> - return dev_err_probe(dev, ret, "Failed to map l1tcm memory\n");
> - }
> - } else {
> - scp->l1tcm_size = resource_size(res);
> - scp->l1tcm_phys = res->start;
> - }
> -
> - scp->reg_base = devm_platform_ioremap_resource_byname(pdev, "cfg");
> - if (IS_ERR(scp->reg_base))
> - return dev_err_probe(dev, PTR_ERR(scp->reg_base),
> - "Failed to parse and map cfg memory\n");
> -
> ret = scp->data->scp_clk_get(scp);
> if (ret)
> - return ret;
> + return ERR_PTR(ret);
>
> ret = scp_map_memory_region(scp);
> if (ret)
> - return ret;
> + return ERR_PTR(ret);
>
> mutex_init(&scp->send_lock);
> for (i = 0; i < SCP_IPI_MAX; i++)
> @@ -938,11 +937,7 @@ static int scp_probe(struct platform_device *pdev)
> goto remove_subdev;
> }
>
> - ret = rproc_add(rproc);
> - if (ret)
> - goto remove_subdev;
> -
> - return 0;
> + return scp;
>
> remove_subdev:
> scp_remove_rpmsg_subdev(scp);
> @@ -953,15 +948,13 @@ static int scp_probe(struct platform_device *pdev)
> mutex_destroy(&scp->ipi_desc[i].lock);
> mutex_destroy(&scp->send_lock);
>
> - return ret;
> + return ERR_PTR(ret);
> }
>
> -static void scp_remove(struct platform_device *pdev)
> +static void scp_free(struct mtk_scp *scp)
> {
> - struct mtk_scp *scp = platform_get_drvdata(pdev);
> int i;
>
> - rproc_del(scp->rproc);
> scp_remove_rpmsg_subdev(scp);
> scp_ipi_unregister(scp, SCP_IPI_INIT);
> scp_unmap_memory_region(scp);
> @@ -970,6 +963,82 @@ static void scp_remove(struct platform_device *pdev)
> mutex_destroy(&scp->send_lock);
> }
>
> +static int scp_cluster_init(struct platform_device *pdev)
> +{
> + struct mtk_scp_of_cluster *scp_cluster = platform_get_drvdata(pdev);
> + struct list_head *cluster = &scp_cluster->mtk_scp_list;
> + struct mtk_scp *scp;
> + int ret;
> +
> + scp = scp_rproc_init(pdev, scp_cluster);
> + if (IS_ERR(scp))
> + return PTR_ERR(scp);
> +
> + ret = rproc_add(scp->rproc);
> + if (ret) {
> + dev_err(dev, "Failed to add rproc\n");
> + scp_free(scp);
> + return ret;
> + }
> +
> + list_add_tail(&scp->elem, cluster);
> +
> + return 0;
> +}
> +
> +static int scp_probe(struct platform_device *pdev)
> +{
> + struct device *dev = &pdev->dev;
> + struct mtk_scp_of_cluster *scp_cluster;
> + struct resource *res;
> + int ret;
> +
> + scp_cluster = devm_kzalloc(dev, sizeof(*scp_cluster), GFP_KERNEL);
> + if (!scp_cluster)
> + return -ENOMEM;
> +
> + res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "cfg");
> + scp_cluster->reg_base = devm_ioremap_resource(dev, res);
> + if (IS_ERR(scp_cluster->reg_base))
> + return dev_err_probe(dev, PTR_ERR(scp_cluster->reg_base),
> + "Failed to parse and map cfg memory\n");
> +
> + /* l1tcm is an optional memory region */
> + res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "l1tcm");
> + scp_cluster->l1tcm_base = devm_ioremap_resource(dev, res);
> + if (IS_ERR(scp_cluster->l1tcm_base)) {
> + ret = PTR_ERR(scp_cluster->l1tcm_base);
> + if (ret != -EINVAL)
> + return dev_err_probe(dev, ret, "Failed to map l1tcm memory\n");
> +
> + scp_cluster->l1tcm_base = NULL;
> + } else {
> + scp_cluster->l1tcm_size = resource_size(res);
> + scp_cluster->l1tcm_phys = res->start;
> + }
> +
> + INIT_LIST_HEAD(&scp_cluster->mtk_scp_list);
> + platform_set_drvdata(pdev, scp_cluster);
> +
> + ret = scp_cluster_init(pdev);
> + if (ret)
> + return ret;
> +
> + return 0;
> +}
> +
> +static void scp_remove(struct platform_device *pdev)
> +{
> + struct mtk_scp_of_cluster *scp_cluster = platform_get_drvdata(pdev);
> + struct mtk_scp *scp, *temp;
> +
> + list_for_each_entry_safe_reverse(scp, temp, &scp_cluster->mtk_scp_list, elem) {
> + list_del(&scp->elem);
> + rproc_del(scp->rproc);
> + scp_free(scp);
> + }
> +}
> +
> static const struct mtk_scp_of_data mt8183_of_data = {
> .scp_clk_get = mt8183_scp_clk_get,
> .scp_before_load = mt8183_scp_before_load,
> --
> 2.18.0
>