Re: [PATCH v3 4/4] remoteproc: ingenic: Added remoteproc driver

[Paul Cercueil <paul@crapouillou.net>]

Hi Mathieu,


Le lun., nov. 18, 2019 at 15:56, Mathieu Poirier 
<mathieu.poirier@linaro.org> a écrit :
> Hi Paul,
> 
> On Sat, Nov 16, 2019 at 06:08:46PM +0100, Paul Cercueil wrote:
>>  This driver is used to boot, communicate with and load firmwares to 
>> the
>>  MIPS co-processor found in the VPU hardware of the JZ47xx SoCs from
>>  Ingenic.
>> 
>>  Signed-off-by: Paul Cercueil <paul@crapouillou.net>
>>  ---
>> 
>>  Notes:
>>      v2: Remove exception for always-mapped memories
>>      v3: - Use clk_bulk API
>>          - Move device-managed code to its own patch [3/4]
>>      	- Move devicetree table right above ingenic_rproc_driver
>>      	- Removed #ifdef CONFIG_OF around devicetree table
>>      	- Removed .owner = THIS_MODULE in ingenic_rproc_driver
>>      	- Removed useless platform_set_drvdata()
>> 
>>   drivers/remoteproc/Kconfig         |   8 +
>>   drivers/remoteproc/Makefile        |   1 +
>>   drivers/remoteproc/ingenic_rproc.c | 242 
>> +++++++++++++++++++++++++++++
>>   3 files changed, 251 insertions(+)
>>   create mode 100644 drivers/remoteproc/ingenic_rproc.c
>> 
>>  diff --git a/drivers/remoteproc/Kconfig b/drivers/remoteproc/Kconfig
>>  index 94afdde4bc9f..f7d4b183d152 100644
>>  --- a/drivers/remoteproc/Kconfig
>>  +++ b/drivers/remoteproc/Kconfig
>>  @@ -214,6 +214,14 @@ config STM32_RPROC
>> 
>>   	  This can be either built-in or a loadable module.
>> 
>>  +config INGENIC_RPROC
> 
> Are you sure you don't want to make this something like
> INGENIC_RPROC_JZ47XX_VPU so that future remote proc system from 
> Ingenic can be
> added easily?

Ingenic SoCs aren't named JZ47xx anymore; I'll name the symbol 
INGENIC_VPU_RPROC then.

>>  +	tristate "Ingenic JZ47xx VPU remoteproc support"
>>  +	depends on MIPS || COMPILE_TEST
>>  +	help
>>  +	  Say y or m here to support the VPU in the JZ47xx SoCs from 
>> Ingenic.
>>  +	  This can be either built-in or a loadable module.
>>  +	  If unsure say N.
>>  +
>>   endif # REMOTEPROC
>> 
>>   endmenu
>>  diff --git a/drivers/remoteproc/Makefile 
>> b/drivers/remoteproc/Makefile
>>  index 00f09e658cb3..6eb0137abbc7 100644
>>  --- a/drivers/remoteproc/Makefile
>>  +++ b/drivers/remoteproc/Makefile
>>  @@ -10,6 +10,7 @@ remoteproc-y				+= remoteproc_sysfs.o
>>   remoteproc-y				+= remoteproc_virtio.o
>>   remoteproc-y				+= remoteproc_elf_loader.o
>>   obj-$(CONFIG_IMX_REMOTEPROC)		+= imx_rproc.o
>>  +obj-$(CONFIG_INGENIC_RPROC)			+= ingenic_rproc.a
> 
> This comes out as one tab to many on my side.
> 
>>   obj-$(CONFIG_OMAP_REMOTEPROC)		+= omap_remoteproc.o
>>   obj-$(CONFIG_WKUP_M3_RPROC)		+= wkup_m3_rproc.o
>>   obj-$(CONFIG_DA8XX_REMOTEPROC)		+= da8xx_remoteproc.o
>>  diff --git a/drivers/remoteproc/ingenic_rproc.c 
>> b/drivers/remoteproc/ingenic_rproc.c
>>  new file mode 100644
>>  index 000000000000..5a7c7d8d9a90
>>  --- /dev/null
>>  +++ b/drivers/remoteproc/ingenic_rproc.c
>>  @@ -0,0 +1,242 @@
>>  +// SPDX-License-Identifier: GPL-2.0+
>>  +/*
>>  + * Ingenic JZ47xx remoteproc driver
>>  + * Copyright 2019, Paul Cercueil <paul@crapouillou.net>
>>  + */
>>  +
>>  +#include <linux/bitops.h>
>>  +#include <linux/clk.h>
>>  +#include <linux/err.h>
>>  +#include <linux/interrupt.h>
>>  +#include <linux/io.h>
>>  +#include <linux/module.h>
>>  +#include <linux/platform_device.h>
>>  +#include <linux/remoteproc.h>
>>  +
>>  +#include "remoteproc_internal.h"
>>  +
>>  +#define REG_AUX_CTRL		0x0
>>  +#define REG_AUX_MSG_ACK		0x10
>>  +#define REG_AUX_MSG		0x14
>>  +#define REG_CORE_MSG_ACK	0x18
>>  +#define REG_CORE_MSG		0x1C
>>  +
>>  +#define AUX_CTRL_SLEEP		BIT(31)
>>  +#define AUX_CTRL_MSG_IRQ_EN	BIT(3)
>>  +#define AUX_CTRL_NMI_RESETS	BIT(2)
>>  +#define AUX_CTRL_NMI		BIT(1)
>>  +#define AUX_CTRL_SW_RESET	BIT(0)
>>  +
>>  +struct vpu_mem_map {
>>  +	const char *name;
>>  +	unsigned int da;
>>  +};
>>  +
>>  +struct vpu_mem_info {
>>  +	const struct vpu_mem_map *map;
>>  +	unsigned long len;
>>  +	void __iomem *base;
>>  +};
>>  +
>>  +static const struct vpu_mem_map vpu_mem_map[] = {
>>  +	{ "tcsm0", 0x132b0000 },
>>  +	{ "tcsm1", 0xf4000000 },
>>  +	{ "sram",  0x132f0000 },
>>  +};
>>  +
>>  +/* Device data */
>>  +struct vpu {
>>  +	int irq;
>>  +	struct clk_bulk_data clks[2];
>>  +	void __iomem *aux_base;
>>  +	struct vpu_mem_info mem_info[ARRAY_SIZE(vpu_mem_map)];
>>  +	struct device *dev;
>>  +};
> 
> Documentation of structure fields is always appreciated but it is up 
> to Bjorn to
> decide on this one.

It's a private structure within a driver, does it matter that much?
Besides, it's pretty much self-explanatory.

>>  +
>>  +static int ingenic_rproc_prepare(struct rproc *rproc)
>>  +{
>>  +	struct vpu *vpu = rproc->priv;
>>  +	int ret;
>>  +
>>  +	/* The clocks must be enabled for the firmware to be loaded in 
>> TCSM */
>>  +	ret = clk_bulk_prepare_enable(ARRAY_SIZE(vpu->clks), vpu->clks);
>>  +	if (ret)
>>  +		dev_err(vpu->dev, "Unable to start clocks: %d", ret);
>>  +
>>  +	return ret;
>>  +}
>>  +
>>  +static void ingenic_rproc_unprepare(struct rproc *rproc)
>>  +{
>>  +	struct vpu *vpu = rproc->priv;
>>  +
>>  +	clk_bulk_disable_unprepare(ARRAY_SIZE(vpu->clks), vpu->clks);
>>  +}
>>  +
>>  +static int ingenic_rproc_start(struct rproc *rproc)
>>  +{
>>  +	struct vpu *vpu = rproc->priv;
>>  +	u32 ctrl;
>>  +
>>  +	enable_irq(vpu->irq);
>>  +
>>  +	/* Reset the AUX and enable message IRQ */
>>  +	ctrl = AUX_CTRL_NMI_RESETS | AUX_CTRL_NMI | AUX_CTRL_MSG_IRQ_EN;
>>  +	writel(ctrl, vpu->aux_base + REG_AUX_CTRL);
> 
> Out of curiosity, there is no power domain associated with this
> co-processor?  Clocks are all you need?

That's correct.

>>  +
>>  +	return 0;
>>  +}
>>  +
>>  +static int ingenic_rproc_stop(struct rproc *rproc)
>>  +{
>>  +	struct vpu *vpu = rproc->priv;
>>  +
>>  +	/* Keep AUX in reset mode */
>>  +	writel(AUX_CTRL_SW_RESET, vpu->aux_base + REG_AUX_CTRL);
>>  +
>>  +	disable_irq_nosync(vpu->irq);
> 
> Also out of curiosity, why the need for _nosync()?

It probably doesn't need it. I'll remove it.

>>  +
>>  +	return 0;
>>  +}
>>  +
>>  +static void ingenic_rproc_kick(struct rproc *rproc, int vqid)
>>  +{
>>  +	struct vpu *vpu = rproc->priv;
>>  +
>>  +	writel(vqid, vpu->aux_base + REG_CORE_MSG);
>>  +}
>>  +
>>  +static void *ingenic_rproc_da_to_va(struct rproc *rproc, u64 da, 
>> int len)
>>  +{
>>  +	struct vpu *vpu = rproc->priv;
>>  +	void __iomem *va = NULL;
>>  +	unsigned int i;
>>  +
>>  +	if (len <= 0)
>>  +		return NULL;
>>  +
>>  +	for (i = 0; i < ARRAY_SIZE(vpu_mem_map); i++) {
>>  +		const struct vpu_mem_info *info = &vpu->mem_info[i];
>>  +		const struct vpu_mem_map *map = info->map;
>>  +
>>  +		if (da >= map->da && (da + len) < (map->da + info->len)) {
>>  +			va = info->base + (da - map->da);
>>  +			break;
>>  +		}
>>  +	}
>>  +
>>  +	return (__force void *)va;
>>  +}
>>  +
>>  +static struct rproc_ops ingenic_rproc_ops = {
>>  +	.prepare = ingenic_rproc_prepare,
>>  +	.unprepare = ingenic_rproc_unprepare,
>>  +	.start = ingenic_rproc_start,
>>  +	.stop = ingenic_rproc_stop,
>>  +	.kick = ingenic_rproc_kick,
>>  +	.da_to_va = ingenic_rproc_da_to_va,
>>  +};
>>  +
>>  +static irqreturn_t vpu_interrupt(int irq, void *data)
>>  +{
>>  +	struct rproc *rproc = data;
>>  +	struct vpu *vpu = rproc->priv;
>>  +	u32 vring;
>>  +
>>  +	vring = readl(vpu->aux_base + REG_AUX_MSG);
>>  +
>>  +	/* Ack the interrupt */
>>  +	writel(0, vpu->aux_base + REG_AUX_MSG_ACK);
>>  +
>>  +	return rproc_vq_interrupt(rproc, vring);
>>  +}
>>  +
>>  +static int ingenic_rproc_probe(struct platform_device *pdev)
>>  +{
>>  +	struct device *dev = &pdev->dev;
>>  +	struct resource *mem;
>>  +	struct rproc *rproc;
>>  +	struct vpu *vpu;
>>  +	unsigned int i;
>>  +	int ret;
>>  +
>>  +	rproc = devm_rproc_alloc(dev, "ingenic-vpu",
>>  +				 &ingenic_rproc_ops, NULL, sizeof(*vpu));
>>  +	if (!rproc)
>>  +		return -ENOMEM;
>>  +
>>  +	vpu = rproc->priv;
>>  +	vpu->dev = &pdev->dev;
>>  +
>>  +	mem = platform_get_resource_byname(pdev, IORESOURCE_MEM, "aux");
>>  +	vpu->aux_base = devm_ioremap_resource(dev, mem);
>>  +	if (IS_ERR(vpu->aux_base)) {
>>  +		dev_err(dev, "Failed to ioremap");
>>  +		return PTR_ERR(vpu->aux_base);
>>  +	}
>>  +
>>  +	for (i = 0; i < ARRAY_SIZE(vpu_mem_map); i++) {
>>  +		mem = platform_get_resource_byname(pdev, IORESOURCE_MEM,
>>  +						   vpu_mem_map[i].name);
>>  +
>>  +		vpu->mem_info[i].base = devm_ioremap_resource(dev, mem);
>>  +		if (IS_ERR(vpu->mem_info[i].base)) {
>>  +			ret = PTR_ERR(vpu->mem_info[i].base);
>>  +			dev_err(dev, "Failed to ioremap");
>>  +			return ret;
>>  +		}
>>  +
>>  +		vpu->mem_info[i].len = resource_size(mem);
>>  +		vpu->mem_info[i].map = &vpu_mem_map[i];
>>  +	}
>>  +
>>  +	vpu->clks[0].id = "vpu";
>>  +	vpu->clks[1].id = "aux";
>>  +
>>  +	ret = devm_clk_bulk_get(dev, ARRAY_SIZE(vpu->clks), vpu->clks);
>>  +	if (ret) {
>>  +		dev_err(dev, "Failed to get clocks");
>>  +		return ret;
>>  +	}
>>  +
>>  +	vpu->irq = platform_get_irq(pdev, 0);
>>  +	if (vpu->irq < 0) {
>>  +		dev_err(dev, "Failed to get platform IRQ");
>>  +		return vpu->irq;
>>  +	}
>>  +
>>  +	ret = devm_request_irq(dev, vpu->irq, vpu_interrupt, 0, "VPU", 
>> rproc);
>>  +	if (ret < 0) {
>>  +		dev_err(dev, "Failed to request IRQ");
>>  +		return ret;
>>  +	}
>>  +
>>  +	disable_irq_nosync(vpu->irq);
>>  +
>>  +	ret = devm_rproc_add(dev, rproc);
>>  +	if (ret) {
>>  +		dev_err(dev, "Failed to register remote processor");
>>  +		return ret;
>>  +	}
>>  +
>>  +	return 0;
>>  +}
>>  +
>>  +static const struct of_device_id ingenic_rproc_of_matches[] = {
>>  +	{ .compatible = "ingenic,jz4770-vpu-rproc", },
>>  +	{}
>>  +};
>>  +MODULE_DEVICE_TABLE(of, ingenic_rproc_of_matches);
>>  +
>>  +static struct platform_driver ingenic_rproc_driver = {
>>  +	.probe = ingenic_rproc_probe,
>>  +	.driver = {
>>  +		.name = "ingenic-vpu",
>>  +		.of_match_table = of_match_ptr(ingenic_rproc_of_matches),
>>  +	},
>>  +};
>>  +module_platform_driver(ingenic_rproc_driver);
>>  +
>>  +MODULE_LICENSE("GPL");
>>  +MODULE_AUTHOR("Paul Cercueil <paul@crapouillou.net>");
>>  +MODULE_DESCRIPTION("Ingenic JZ47xx Remote Processor control 
>> driver");
> 
> Nice, clean and simple driver.  With the above and after rolling in 
> Julia's
> patch:
> 
> Acked-by: Mathieu Poirier <mathieu.poirier@linaro.org>

Thanks!

Cheers,
-Paul