Re: [PATCH v2 6/6] drivers: remoteproc: Add Xilinx r5 remoteproc driver

[Tanmay Shah]

Thanks Mathieu for reviews.

[...]

> > + * zynqmp_r5_set_mode - set RPU operation mode
> > + *
> > + * set RPU operation mode
> > + *
> > + * Return: 0 for success, negative value for failure
> > + */
> > +static int zynqmp_r5_set_mode(struct zynqmp_r5_core *r5_core,
> > +			      enum zynqmp_r5_cluster_mode rpu_mode)
> > +{
> > +	enum rpu_tcm_comb tcm_mode;
> > +	int ret, reg_val;
> > +
> > +	reg_val = (rpu_mode == LOCKSTEP_MODE ? 0 : 1);
> Here split and single-cpu mode are treated the same... Is this an omission or
> really how the HW works?  A good dose of documentation is definitely needed.

In this patchset, driver probe is failing in zynqmp_r5_cluster_init

if single-cpu mode is set in device-tree with message that

single-cpu mode is not supported by driver. So, here it is only for 
split mode.

Later when single-cpu mode is supported, this will be modified accordingly.

Sure adding comments sounds good idea. I will take care it in next revision.

Also, I agree with all the comments in this email. I will address them 
in next revision.

If I have any question while development, I will ask before posting next 
revision.

> > +
> > +	ret = zynqmp_pm_set_rpu_mode(r5_core->pm_domain_id, reg_val);
> > +	if (ret < 0) {
> > +		pr_err("failed to set RPU mode\n");
> > +		return ret;
> > +	}
> > +
> > +	tcm_mode = (rpu_mode == LOCKSTEP_MODE) ?
> > +		    PM_RPU_TCM_COMB : PM_RPU_TCM_SPLIT;
> > +	ret = zynqmp_pm_set_tcm_config(r5_core->pm_domain_id, tcm_mode);
> > +	if (ret < 0)
> > +		pr_err("failed to configure TCM\n");
> > +
> > +	return ret;
> > +}
> > +
> > +/*
> > + * zynqmp_r5_rproc_start
> > + * @rproc: single R5 core's corresponding rproc instance
> > + *
> > + * Start R5 Core from designated boot address.
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int zynqmp_r5_rproc_start(struct rproc *rproc)
> > +{
> > +	struct zynqmp_r5_core *r5_core = rproc->priv;
> > +	enum rpu_boot_mem bootmem;
> > +	int ret;
> > +
> > +	if (!r5_core) {
> > +		pr_err("can't get r5 core\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	bootmem = (rproc->bootaddr >= 0xFFFC0000) ?
> > +		   PM_RPU_BOOTMEM_HIVEC : PM_RPU_BOOTMEM_LOVEC;
> > +
> > +	dev_dbg(r5_core->dev, "RPU boot addr 0x%llx from %s.", rproc->bootaddr,
> > +		bootmem == PM_RPU_BOOTMEM_HIVEC ? "OCM" : "TCM");
> > +
> > +	ret = zynqmp_pm_request_wake(r5_core->pm_domain_id, 1,
> > +				     bootmem, ZYNQMP_PM_REQUEST_ACK_NO);
> > +	if (ret)
> > +		pr_err("failed to start RPU = %d\n", r5_core->pm_domain_id);
> > +	return ret;
> > +}
> > +
> > +/*
> > + * zynqmp_r5_rproc_stop
> > + * @rproc: single R5 core's corresponding rproc instance
> > + *
> > + * Power down  R5 Core.
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int zynqmp_r5_rproc_stop(struct rproc *rproc)
> > +{
> > +	struct zynqmp_r5_core *r5_core = rproc->priv;
> > +	int ret;
> > +
> > +	ret = zynqmp_pm_force_pwrdwn(r5_core->pm_domain_id,
> > +				     ZYNQMP_PM_REQUEST_ACK_BLOCKING);
> > +	if (ret)
> > +		pr_err("failed to stop remoteproc RPU %d\n", ret);
> > +
> > +	return ret;
> > +}
> > +
> > +/*
> > + * zynqmp_r5_rproc_mem_map
> > + * @rproc: single R5 core's corresponding rproc instance
> > + * @mem: mem entry to map
> > + *
> > + * Callback to map va for memory-region's carveout.
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int zynqmp_r5_rproc_mem_map(struct rproc *rproc,
> > +				   struct rproc_mem_entry *mem)
> > +{
> > +	void __iomem *va;
> > +
> > +	va = ioremap_wc(mem->dma, mem->len);
> > +	if (IS_ERR_OR_NULL(va))
> > +		return -ENOMEM;
> > +
> > +	mem->va = (void *)va;
> > +
> > +	return 0;
> > +}
> > +
> > +/*
> > + * zynqmp_r5_rproc_mem_unmap
> > + * @rproc: single R5 core's corresponding rproc instance
> > + * @mem: mem entry to unmap
> > + *
> > + * Unmap memory-region carveout
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int zynqmp_r5_rproc_mem_unmap(struct rproc *rproc,
> > +				     struct rproc_mem_entry *mem)
> > +{
> > +	iounmap((void __iomem *)mem->va);
> > +	return 0;
> > +}
> > +
> > +/*
> > + * add_mem_regions
> > + * @rproc: single R5 core's corresponding rproc instance
> > + *
> > + * Construct rproc mem carveouts from carveout provided in
> > + * memory-region property
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int add_mem_regions(struct rproc *rproc)
> > +{
> > +	struct device *dev;
> > +	struct rproc_mem_entry *mem;
> > +	struct reserved_mem *rmem;
> > +	struct zynqmp_r5_core *r5_core;
> > +	int i;
> > +
> > +	r5_core = rproc->priv;
> > +	dev = r5_core->dev;
> > +
> > +	/* Register associated reserved memory regions */
> > +	for (i = 0; i < r5_core->res_mem_count; i++) {
> > +		rmem = &r5_core->res_mem[i];
> > +		mem = rproc_mem_entry_init(dev, NULL,
> > +					   (dma_addr_t)rmem->base,
> > +					   rmem->size, rmem->base,
> > +					   zynqmp_r5_rproc_mem_map,
> > +					   zynqmp_r5_rproc_mem_unmap,
> > +					   rmem->name);
> > +		if (IS_ERR_OR_NULL(mem))
> > +			return -ENOMEM;
> > +
> > +		rproc_add_carveout(rproc, mem);
> > +	}
> > +
> > +	return 0;
> > +}
> > +
> > +/*
> > + * zynqmp_r5_rproc_mem_unmap
> > + * @rproc: single R5 core's corresponding rproc instance
> > + * @mem: mem entry to unmap
> > + *
> > + * Unmap TCM banks when powering down R5 core.
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int tcm_mem_unmap(struct rproc *rproc, struct rproc_mem_entry *mem)
> > +{
> > +	struct zynqmp_r5_core *r5_core;
> > +	int i;
> > +	enum pm_node_id pm_domain_id;
> > +
> > +	r5_core = rproc->priv;
> > +	if (!r5_core) {
> > +		pr_err("r5 core is not available\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	iounmap((void __iomem *)mem->va);
> > +
> > +	for (i = 0; i < r5_core->tcm_bank_count; i++) {
> > +		pm_domain_id = r5_core->tcm_banks[i].pm_domain_id;
> > +		if (zynqmp_pm_release_node(pm_domain_id))
> > +			pr_warn("can't turn off TCM bank %d", pm_domain_id);
> > +	}
> > +
> > +	return 0;
> > +}
> > +
> > +/*
> > + * tcm_mem_map
> > + * @rproc: single R5 core's corresponding rproc instance
> > + * @mem: mem entry to initialize the va and da fields of
> > + *
> > + * Given TCM bank entry, this callback will set device address for R5
> > + * running on TCM and also setup virtual address for TCM bank
> > + * remoteproc carveout.
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int tcm_mem_map(struct rproc *rproc,
> > +			 struct rproc_mem_entry *mem)
> > +{
> > +	void __iomem *va;
> > +
> > +	va = ioremap_wc(mem->dma, mem->len);
> > +	if (IS_ERR_OR_NULL(va))
> > +		return -ENOMEM;
> > +
> > +	/* Update memory entry va */
> > +	mem->va = (void *)va;
> > +
> > +	/* clear TCMs */
> > +	memset_io(va, 0, mem->len);
> > +
> > +	/*
> > +	 * The R5s expect their TCM banks to be at address 0x0 and 0x2000,
> > +	 * while on the Linux side they are at 0xffexxxxx.
> > +	 *
> > +	 * Zero out the high 12 bits of the address. This will give
> > +	 * expected values for TCM Banks 0A and 0B (0x0 and 0x20000).
> > +	 */
> > +	mem->da &= 0x000fffff;
> > +
> > +	/*
> > +	 * TCM Banks 1A and 1B still have to be translated.
> > +	 *
> > +	 * Below handle these two banks' absolute addresses (0xffe90000 and
> > +	 * 0xffeb0000) and convert to the expected relative addresses
> > +	 * (0x0 and 0x20000).
> > +	 */
> > +	if (mem->da == 0x90000 || mem->da == 0xB0000)
> > +		mem->da -= 0x90000;
> > +
> > +	/* if translated TCM bank address is not valid report error */
> > +	if (mem->da != 0x0 && mem->da != 0x20000) {
> > +		dev_err(&rproc->dev, "invalid TCM address: %x\n", mem->da);
> > +		return -EINVAL;
> > +	}
> > +	return 0;
> > +}
> > +
> > +static int add_tcm_carveout_split_mode(struct rproc *rproc)
> > +{
> > +	int i, num_banks, ret;
> > +	struct rproc_mem_entry *mem;
> > +	enum pm_node_id pm_domain_id;
> > +	u32 bank_addr;
> > +	size_t bank_size = 0;
> > +	char *bank_name;
> > +	struct device *dev;
> > +	struct zynqmp_r5_core *r5_core;
> > +
> > +	r5_core = (struct zynqmp_r5_core *)rproc->priv;
> > +	if (!r5_core)
> > +		return -EINVAL;
> > +
> > +	dev = r5_core->dev;
> > +
> > +	/* go through zynqmp banks for r5 node */
> > +	num_banks = r5_core->tcm_bank_count;
> > +	if (num_banks <= 0) {
> > +		dev_err(dev, "need to specify TCM banks\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	for (i = 0; i < num_banks; i++) {
> > +		bank_addr = (u32)r5_core->tcm_banks[i].addr;
> > +		bank_name = r5_core->tcm_banks[i].bank_name;
> > +		bank_size = r5_core->tcm_banks[i].size;
> > +		pm_domain_id = r5_core->tcm_banks[i].pm_domain_id;
> > +
> > +		ret = zynqmp_pm_request_node(pm_domain_id,
> > +					     ZYNQMP_PM_CAPABILITY_ACCESS, 0,
> > +					     ZYNQMP_PM_REQUEST_ACK_BLOCKING);
> > +		if (ret < 0) {
> > +			dev_err(dev, "failed to turn on TCM %d", pm_domain_id);
> > +			return ret;
> > +		}
> > +
> > +		dev_dbg(dev, "TCM carveout split mode %s addr=%x, size=0x%lx",
> > +			bank_name, bank_addr, bank_size);
> > +
> > +		/* add carveout */
> > +		mem = rproc_mem_entry_init(dev, NULL, bank_addr,
> > +					   bank_size, bank_addr,
> > +					   tcm_mem_map, tcm_mem_unmap,
> > +					   bank_name);
> > +		if (IS_ERR_OR_NULL(mem)) {
> > +			/* Turn off all TCM banks turned on before */
> > +			do {
> > +				pm_domain_id = r5_core->tcm_banks[i].pm_domain_id;
> > +				ret = zynqmp_pm_release_node((u32)pm_domain_id);
> > +				if (ret)
> > +					dev_warn(dev,
> > +						 "fail to release node: %x, %x\n",
> > +						 (u32)pm_domain_id, ret);
> > +			} while (i--);
> > +			return -ENOMEM;
> > +		}
> > +
> > +		rproc_add_carveout(rproc, mem);
> > +	}
> > +
> > +	return 0;
> > +}
> > +
> > +static int add_tcm_carveout_lockstep_mode(struct rproc *rproc)
> > +{
> > +	int i, num_banks, ret;
> > +	struct rproc_mem_entry *mem;
> > +	enum pm_node_id pm_domain_id;
> > +	u32 bank_addr;
> > +	size_t bank_size = 0;
> > +	char *bank_name;
> > +	struct device *dev;
> > +	struct platform_device *parent_pdev;
> > +	struct zynqmp_r5_cluster *cluster;
> > +	struct zynqmp_r5_core *r5_core;
> > +
> > +	r5_core = (struct zynqmp_r5_core *)rproc->priv;
> > +	if (!r5_core)
> > +		return -EINVAL;
> > +
> > +	dev = r5_core->dev;
> > +	if (!dev) {
> > +		pr_err("r5 core device unavailable\n");
> > +		return -ENODEV;
> > +	}
> > +
> > +	/* go through zynqmp banks for r5 node */
> > +	num_banks = r5_core->tcm_bank_count;
> > +	if (num_banks <= 0) {
> > +		dev_err(dev, "need to specify TCM banks\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	bank_addr = (u32)r5_core->tcm_banks[0].addr;
> > +	bank_name = r5_core->tcm_banks[0].bank_name;
> > +	for (i = 0; i < num_banks; i++) {
> > +		bank_size += r5_core->tcm_banks[i].size;
> > +		pm_domain_id = r5_core->tcm_banks[i].pm_domain_id;
> > +
> > +		ret = zynqmp_pm_request_node(pm_domain_id,
> > +					     ZYNQMP_PM_CAPABILITY_ACCESS, 0,
> > +					     ZYNQMP_PM_REQUEST_ACK_BLOCKING);
> > +		if (ret < 0) {
> > +			dev_err(dev, "failed to turn on TCM %d", pm_domain_id);
> > +			return ret;
> > +		}
> > +	}
> > +
> > +	dev_dbg(dev, "TCM add carveout lockstep mode %s addr=0x%x, size=0x%lx",
> > +		bank_name, bank_addr, bank_size);
> > +
> > +	/* add carveout */
> > +	mem = rproc_mem_entry_init(dev, NULL, bank_addr,
> > +				   bank_size, bank_addr,
> > +				   tcm_mem_map, tcm_mem_unmap,
> > +				   bank_name);
> > +	if (IS_ERR_OR_NULL(mem)) {
> > +		for (i = 0; i < num_banks; i++) {
> > +			pm_domain_id = r5_core->tcm_banks[i].pm_domain_id;
> > +			ret = zynqmp_pm_release_node((u32)pm_domain_id);
> > +			if (ret)
> > +				dev_warn(dev,
> > +					 "fail to release node: %x ret: %x\n",
> > +					 (u32)pm_domain_id, ret);
> > +		}
> > +		return -ENOMEM;
> > +	}
> > +
> > +	rproc_add_carveout(rproc, mem);
> > +
> > +	return 0;
> > +}
> > +
> > +/*
> > + * add_tcm_banks()
> > + * @rproc: single R5 core's corresponding rproc instance
> > + *
> > + * Given R5 node in remoteproc instance
> > + * allocate remoteproc carveout for TCM memory
> > + * needed for firmware to be loaded
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int add_tcm_banks(struct rproc *rproc)
> > +{
> > +	struct device *dev;
> > +	struct platform_device *parent_pdev;
> > +	struct zynqmp_r5_cluster *cluster;
> > +	struct zynqmp_r5_core *r5_core;
> > +
> > +	r5_core = (struct zynqmp_r5_core *)rproc->priv;
> > +	if (!r5_core)
> > +		return -EINVAL;
> > +
> > +	dev = r5_core->dev;
> > +	if (!dev) {
> > +		pr_err("r5 core device unavailable\n");
> > +		return -ENODEV;
> > +	}
> > +
> > +	parent_pdev = to_platform_device(dev->parent);
> > +	if (!parent_pdev) {
> > +		dev_err(dev, "parent platform dev unavailable\n");
> > +		return -ENODEV;
> > +	}
> > +
> > +	cluster = platform_get_drvdata(parent_pdev);
> > +	if (!cluster) {
> > +		dev_err(&parent_pdev->dev, "Invalid driver data\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	if (cluster->mode == SPLIT_MODE)
> > +		return add_tcm_carveout_split_mode(rproc);
> > +	else if (cluster->mode == LOCKSTEP_MODE)
> > +		return add_tcm_carveout_lockstep_mode(rproc);
> > +
> > +	dev_err(cluster->dev, "invalid cluster mode\n");
> > +	return -EINVAL;
> > +}
> > +
> > +/*
> > + * zynqmp_r5_parse_fw()
> > + * @rproc: single R5 core's corresponding rproc instance
> > + * @fw: ptr to firmware to be loaded onto r5 core
> > + *
> > + * When loading firmware, ensure the necessary carveouts are in remoteproc
> > + *
> > + * return 0 on success, otherwise non-zero value on failure
> > + */
> > +static int zynqmp_r5_parse_fw(struct rproc *rproc, const struct firmware *fw)
> > +{
> > +	int ret;
> > +	struct zynqmp_r5_core *r5_core;
> > +	struct device *dev;
> > +
> > +	r5_core = rproc->priv;
> > +	if (!r5_core) {
> > +		dev_err(&rproc->dev, "r5 core not available\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	dev = r5_core->dev;
> > +
> > +	ret = add_tcm_banks(rproc);
> > +	if (ret) {
> > +		dev_err(dev, "failed to get TCM banks, err %d\n", ret);
> > +		return ret;
> > +	}
> > +
> > +	ret = add_mem_regions(rproc);
> > +	if (ret)
> > +		dev_warn(dev, "failed to get reserve mem regions %d\n", ret);
> > +
> > +	ret = rproc_elf_load_rsc_table(rproc, fw);
> > +	if (ret == -EINVAL) {
> > +		/*
> > +		 * resource table only required for IPC.
> > +		 * if not present, this is not necessarily an error;
> > +		 * for example, loading r5 hello world application
> > +		 * so simply inform user and keep going.
> > +		 */
> > +		dev_info(&rproc->dev, "no resource table found.\n");
> > +		ret = 0;
> > +	}
> > +	return ret;
> > +}
> > +
> > +static struct rproc_ops zynqmp_r5_rproc_ops = {
> > +	.start		= zynqmp_r5_rproc_start,
> > +	.stop		= zynqmp_r5_rproc_stop,
> > +	.load		= rproc_elf_load_segments,
> > +	.parse_fw	= zynqmp_r5_parse_fw,
> > +	.find_loaded_rsc_table = rproc_elf_find_loaded_rsc_table,
> > +	.sanity_check	= rproc_elf_sanity_check,
> > +	.get_boot_addr	= rproc_elf_get_boot_addr,
> > +};
> > +
> > +static void zynqmp_r5_print_dt_node_info(struct zynqmp_r5_cluster *cluster)
> > +{
> > +	int i, j, k;
> > +	struct zynqmp_r5_core *r5_core;
> > +
> > +	dev_dbg(cluster->dev, "Printing dt node info\n");
> > +
> > +	pr_debug("cluster mode = %d\n", cluster->mode);
> > +	pr_debug("r5f cluster in %s mode\n", (cluster->mode == 0) ? "SPLIT" :
> > +		 cluster->mode == 1 ? "LOCKSTEP" : "SINGLE_CPU");
> > +	pr_debug("r5f num cores = %d\n", cluster->core_count);
> > +
> > +	for (i = 0; i < cluster->core_count; i++) {
> > +		r5_core = &cluster->r5_cores[i];
> > +		if (!r5_core) {
> > +			pr_err("can't get r5_core\n");
> > +			continue;
> > +		}
> > +
> > +		pr_debug("r5 core %d nodes\n", i);
> > +		pr_debug("TCM banks = %d\n", r5_core->tcm_bank_count);
> > +		for (k = 0; k < r5_core->tcm_bank_count; k++) {
> > +			pr_debug("tcm %d addr=0x%llx size=0x%lx, pm_id=%d, %s\n",
> > +				 k, r5_core->tcm_banks[k].addr,
> > +				 r5_core->tcm_banks[k].size,
> > +				 r5_core->tcm_banks[k].pm_domain_id,
> > +				 r5_core->tcm_banks[k].bank_name);
> > +		}
> > +
> > +		pr_debug("reserve mem regions = %d\n", r5_core->res_mem_count);
> > +
> > +		for (j = 0; j < r5_core->res_mem_count; j++) {
> > +			pr_debug("mem %d addr=0x%llx, size=0x%llx, name=%s\n",
> > +				 j, r5_core->res_mem[j].base,
> > +				 r5_core->res_mem[j].size,
> > +				 r5_core->res_mem[j].name);
> > +		}
> > +	}
> > +}
> > +
> > +/**
> > + * zynqmp_r5_add_rproc_core() - Probes ZynqMP R5 processor device node
> > + *		       this is called for each individual R5 core to
> > + *		       set up mailbox, Xilinx platform manager unique ID,
> > + *		       add to rproc core
> > + *
> Please get rid of the indentations.  That way it conforms to the rest of the
> style in this file.
>
> > + * @r5_core: zynqmp_r5_core r5 core object to initialize
> > + *
> > + * Return: 0 for success, negative value for failure.
> > + */
> > +static int zynqmp_r5_add_rproc_core(struct zynqmp_r5_core *r5_core)
> > +{
> > +	int ret;
> > +	struct rproc *r5_rproc;
> > +	struct device *dev;
> > +
> > +	dev = r5_core->dev;
> > +
> > +	/* Set up DMA mask */
> > +	ret = dma_set_coherent_mask(dev, DMA_BIT_MASK(32));
> > +	if (ret)
> > +		return ret;
> > +
> > +	/* Allocate remoteproc instance */
> > +	r5_rproc = devm_rproc_alloc(dev, dev_name(dev), &zynqmp_r5_rproc_ops,
> > +				    NULL, sizeof(struct zynqmp_r5_core));
> > +	if (IS_ERR_OR_NULL(r5_rproc))
> > +		return -ENOMEM;
> devm_rproc_alloc() doesn't return an error code.
>
> > +
> > +	r5_rproc->auto_boot = false;
> > +	r5_rproc->priv = r5_core;
> Here the original value of rproc->priv allocated by rproc_alloc() is replaced by
> @r5_core, resulting in a memory leak.
>
> > +
> > +	/* Add R5 remoteproc */
> > +	ret = devm_rproc_add(dev, r5_rproc);
> > +	if (ret) {
> > +		pr_err("failed to add r5 remoteproc\n");
> > +		return ret;
> > +	}
> > +
> > +	return 0;
> > +}
> > +
> > +static int zynqmp_r5_get_tcm_node(struct zynqmp_r5_cluster *cluster)
> > +{
> > +	int tcm_bank_count, tcm_node;
> > +	int i = 0, j;
> > +	struct zynqmp_r5_core *r5_core;
> > +	const struct mem_bank_data *tcm = zynqmp_tcm_banks;
> > +	struct device *dev = cluster->dev;
> > +
> > +	/* ToDo: Use predefined TCM address space values from driver until
> > +	 * system-dt spec is not final fot TCM
> > +	 */
> > +	tcm_bank_count = ARRAY_SIZE(zynqmp_tcm_banks);
> > +
> > +	/* count per core tcm banks */
> > +	tcm_bank_count = tcm_bank_count / cluster->core_count;
> > +
> > +	/* r5 core 0 will use all of TCM banks in lockstep mode.
> > +	 * In split mode, r5 core0 will use 128k and r5 core1 will use another
> > +	 * 128k. Assign TCM banks to each core accordingly
> > +	 */
> > +	tcm_node = 0;
> > +	for (j = 0; j < cluster->core_count; j++) {
> > +		r5_core = &cluster->r5_cores[j];
> > +		r5_core->tcm_banks = devm_kzalloc(dev, sizeof(struct mem_bank_data) *
> > +						  tcm_bank_count, GFP_KERNEL);
> > +		if (IS_ERR_OR_NULL(r5_core->tcm_banks))
> > +			return -ENOMEM;
> > +
> > +		for (i = 0; i < tcm_bank_count; i++) {
> > +			/* Use pre-defined TCM reg values.
> > +			 * Eventually this should be replaced by values
> > +			 * parsed from dts.
> > +			 */
> > +			r5_core->tcm_banks[i].addr = tcm[tcm_node].addr;
> > +			r5_core->tcm_banks[i].size = tcm[tcm_node].size;
> > +			r5_core->tcm_banks[i].pm_domain_id = tcm[tcm_node].pm_domain_id;
> > +			r5_core->tcm_banks[i].bank_name = tcm[tcm_node].bank_name;
> > +			tcm_node++;
> > +		}
> > +
> > +		r5_core->tcm_bank_count = tcm_bank_count;
> > +	}
> Please use 'i' for the outer loop and 'j' for the inner one.  Otherwise people
> are looking for a subtlety that isn't here.
>
> > +
> > +	return 0;
> > +}
> > +
> > +static int zynqmp_r5_get_mem_region_node(struct zynqmp_r5_core *r5_core)
> > +{
> > +	int res_mem_count, i;
> > +	struct device *dev;
> > +	struct device_node *np, *rmem_np;
> > +	struct reserved_mem *rmem;
> > +
> > +	dev = r5_core->dev;
> > +
> > +	np = r5_core->np;
> > +	if (IS_ERR_OR_NULL(np)) {
> > +		pr_err("invalid device node of r5 core\n");
> > +		return -EINVAL;
> > +	}
> In normal cases this kind of defensive programming makes sense but here
> r5_core->np has just been set in zynqmp_r5_cluster_init() where there is
> plenty of gards against errors.  Please remove.
> > +
> > +	res_mem_count = of_property_count_elems_of_size(np, "memory-region",
> > +							sizeof(phandle));
> > +	if (res_mem_count <= 0) {
> > +		dev_warn(dev, "failed to get memory-region property %d\n",
> > +			 res_mem_count);
> > +		return -EINVAL;
> > +	}
> > +
> > +	r5_core->res_mem = devm_kzalloc(dev,
> > +					res_mem_count * sizeof(struct reserved_mem),
> > +					GFP_KERNEL);
> Use devm_kcalloc() when more than one element is required.  Here and throughout
> the driver.
>
> > +	if (!r5_core->res_mem) {
> > +		dev_err(dev, "failed to allocate mem region memory\n");
> > +		return -ENOMEM;
> > +	}
> > +
> > +	for (i = 0; i < res_mem_count; i++) {
> > +		rmem_np = of_parse_phandle(np, "memory-region", i);
> > +		if (!rmem_np)
> > +			return -EINVAL;
> > +
> > +		rmem = of_reserved_mem_lookup(rmem_np);
> > +		if (!rmem) {
> > +			of_node_put(rmem_np);
> > +			return -EINVAL;
> > +		}
> > +
> > +		memcpy(&r5_core->res_mem[i], rmem,
> > +		       sizeof(struct reserved_mem));
> Why is the whole reserved_mem is duplicated when only ->base, ->size and ->name
> are used?  And even those I'm not sure about really needing them...
>
> > +		of_node_put(rmem_np);
> > +	}
> > +
> > +	r5_core->res_mem_count = res_mem_count;
> > +
> > +	return 0;
> > +}
> > +
> > +static int zynqmp_r5_core_init(struct zynqmp_r5_cluster *cluster)
> > +{
> > +	int ret, i;
> > +	struct zynqmp_r5_core *r5_core;
> > +	struct device *dev = cluster->dev;
> > +
> > +	ret = zynqmp_r5_get_tcm_node(cluster);
> > +	if (ret < 0) {
> > +		dev_err(dev, "can't get tcm node, err %d\n", ret);
> > +		return ret;
> > +	}
> > +
> > +	for (i = 0; i < cluster->core_count; i++) {
> > +		r5_core = &cluster->r5_cores[i];
> > +		if (!r5_core) {
> > +			pr_err("invalid r5 core\n");
> > +			return -EINVAL;
> > +		}
> Same here - please remove.
>
> > +
> > +		ret = zynqmp_r5_get_mem_region_node(r5_core);
> > +		if (ret)
> > +			dev_warn(dev, "memory-region prop failed %d\n", ret);
> > +
> > +		ret = of_property_read_u32_index(r5_core->np, "power-domains",
> > +						 1, &r5_core->pm_domain_id);
> > +		if (ret) {
> > +			dev_err(dev, "failed to get power-domains property\n");
> > +			return ret;
> > +		}
> > +
> > +		ret = zynqmp_r5_set_mode(r5_core, cluster->mode);
> > +		if (ret)
> > +			return ret;
> > +
> > +		ret = zynqmp_r5_add_rproc_core(r5_core);
> > +		if (ret) {
> > +			dev_err(dev, "failed to init r5 core %d\n", i);
> > +			return ret;
> > +		}
> > +	}
> > +
> > +	return 0;
> > +}
> > +
> > +static int zynqmp_r5_cluster_init(struct zynqmp_r5_cluster *cluster)
> > +{
> > +	struct device *dev = cluster->dev;
> > +	struct device_node *dev_node = dev_of_node(dev);
> > +	struct device_node *child;
> > +	struct platform_device *child_pdev;
> > +	int core_count = 0, ret, i;
> > +	enum zynqmp_r5_cluster_mode cluster_mode = LOCKSTEP_MODE;
> > +	struct zynqmp_r5_core *r5_cores;
> > +
> > +	ret = of_property_read_u32(dev_node, "xlnx,cluster-mode", &cluster_mode);
> > +
> > +	/* on success returns 0, if not defined then returns -EINVAL,
> > +	 * In that case, default is LOCKSTEP mode
> > +	 */
> > +	if (ret != -EINVAL && ret != 0) {
> > +		dev_err(dev, "Invalid xlnx,cluster-mode property\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	if (cluster_mode == SINGLE_CPU_MODE) {
> > +		dev_err(dev, "driver does not support single cpu mode\n");
> > +		return -EINVAL;
> > +	} else if ((cluster_mode != SPLIT_MODE &&
> > +		   cluster_mode != LOCKSTEP_MODE)) {
> > +		dev_err(dev, "Invalid cluster mode\n");
> > +		return -EINVAL;
> > +	}
> > +
> > +	core_count = of_get_available_child_count(dev_node);
> > +	if (core_count <= 0) {
> > +		dev_err(dev, "Invalid number of r5 cores %d", core_count);
> > +		return -EINVAL;
> > +	} else if (cluster_mode == SPLIT_MODE && core_count != 2) {
> > +		dev_err(dev, "Invalid number of r5 cores for split mode\n");
> > +		return -EINVAL;
> > +	} else if (cluster_mode == LOCKSTEP_MODE && core_count == 2) {
> > +		dev_warn(dev, "Only r5 core0 will be used\n");
> > +		core_count = 1;
> > +	}
> > +
> > +	r5_cores = devm_kzalloc(dev, sizeof(struct zynqmp_r5_core) *
> > +						 core_count, GFP_KERNEL);
> > +	if (IS_ERR_OR_NULL(r5_cores)) {
> > +		dev_err(dev, "can't allocate memory for cores\n");
> > +		return -ENOMEM;
> > +	}
> > +
> > +	i = 0;
> > +	for_each_available_child_of_node(dev_node, child) {
> > +		child_pdev = of_find_device_by_node(child);
> > +		if (!child_pdev)
> > +			return -ENODEV;
> > +
> > +		r5_cores[i].dev = &child_pdev->dev;
> > +		if (!r5_cores[i].dev) {
> > +			pr_err("can't get device for r5 core %d\n", i);
> > +			return -ENODEV;
> > +		}
> > +
> > +		r5_cores[i].np = dev_of_node(r5_cores[i].dev);
> > +		if (!r5_cores[i].np) {
> > +			pr_err("can't get device node for r5 core %d\n", i);
> > +			return -ENODEV;
> > +		}
> The error path for both if() conditions above needs to release the
> child_pdev->dev, as instructed by the documentation for
> of_find_device_by_node().  The same needs to be done when there is no errors.
>
> More comments to come tomorrow.
>
> Thanks,
> Mathieu
>
> > +
> > +		i++;
> > +		if (i == core_count)
> > +			break;
> > +	}
> > +
> > +	cluster->mode = cluster_mode;
> > +	cluster->core_count = core_count;
> > +	cluster->r5_cores = r5_cores;
> > +
> > +	ret = zynqmp_r5_core_init(cluster);
> > +	if (ret < 0) {
> > +		dev_err(dev, "failed to init r5 core err %d\n", ret);
> > +		return ret;
> > +	}
> > +
> > +	zynqmp_r5_print_dt_node_info(cluster);
> > +
> > +	return 0;
> > +}
> > +
> > +static void zynqmp_r5_cluster_exit(void *data)
> > +{
> > +	struct platform_device *pdev = (struct platform_device *)data;
> > +
> > +	platform_set_drvdata(pdev, NULL);
> > +
> > +	pr_info("Exit r5f subsystem driver\n");
> > +}
> > +
> > +/*
> > + * zynqmp_r5_remoteproc_probe()
> > + *
> > + * @pdev: domain platform device for R5 cluster
> > + *
> > + * called when driver is probed, for each R5 core specified in DT,
> > + * setup as needed to do remoteproc-related operations
> > + *
> > + * Return: 0 for success, negative value for failure.
> > + */
> > +static int zynqmp_r5_remoteproc_probe(struct platform_device *pdev)
> > +{
> > +	int ret;
> > +	struct zynqmp_r5_cluster *cluster;
> > +	struct device *dev = &pdev->dev;
> > +
> > +	cluster = devm_kzalloc(dev, sizeof(*cluster), GFP_KERNEL);
> > +	if (IS_ERR_OR_NULL(cluster))
> > +		return -ENOMEM;
> > +
> > +	cluster->dev = dev;
> > +
> > +	ret = devm_of_platform_populate(dev);
> > +	if (ret) {
> > +		dev_err(dev, "failed to populate platform dev %d\n", ret);
> > +		return ret;
> > +	}
> > +
> > +	/* wire in so each core can be cleaned up at driver remove */
> > +	platform_set_drvdata(pdev, cluster);
> > +
> > +	ret = devm_add_action_or_reset(dev, zynqmp_r5_cluster_exit, pdev);
> > +	if (ret)
> > +		return ret;
> > +
> > +	ret = zynqmp_r5_cluster_init(cluster);
> > +	if (ret) {
> > +		dev_err(dev, "Invalid r5f subsystem device tree\n");
> > +		return ret;
> > +	}
> > +
> > +	dev_info(dev, "Xilinx r5f remoteproc driver probe success\n");
> > +	return 0;
> > +}
> > +
> > +/* Match table for OF platform binding */
> > +static const struct of_device_id zynqmp_r5_remoteproc_match[] = {
> > +	{ .compatible = "xlnx,zynqmp-r5fss", },
> > +	{ /* end of list */ },
> > +};
> > +MODULE_DEVICE_TABLE(of, zynqmp_r5_remoteproc_match);
> > +
> > +static struct platform_driver zynqmp_r5_remoteproc_driver = {
> > +	.probe = zynqmp_r5_remoteproc_probe,
> > +	.driver = {
> > +		.name = "zynqmp_r5_remoteproc",
> > +		.of_match_table = zynqmp_r5_remoteproc_match,
> > +	},
> > +};
> > +module_platform_driver(zynqmp_r5_remoteproc_driver);
> > +
> > +MODULE_DESCRIPTION("Xilinx R5F remote processor driver");
> > +MODULE_AUTHOR("Xilinx Inc.");
> > +MODULE_LICENSE("GPL v2");
> > --
> > 2.25.1