2021-05-21 08:59:47

by Russ Weight

[permalink] [raw]
Subject: [PATCH v1 1/3] fpga: mgr: Use standard dev_release for class driver

The FPGA manager class driver data structure is being treated as a
managed resource instead of using standard dev_release call-back
to release the class data structure. This change removes the
managed resource code and combines the create() and register()
functions into a single register() function.

Signed-off-by: Russ Weight <[email protected]>
---
drivers/fpga/altera-cvp.c | 12 +--
drivers/fpga/altera-pr-ip-core.c | 6 +-
drivers/fpga/altera-ps-spi.c | 8 +-
drivers/fpga/dfl-fme-mgr.c | 10 +-
drivers/fpga/fpga-mgr.c | 177 ++++---------------------------
drivers/fpga/ice40-spi.c | 8 +-
drivers/fpga/machxo2-spi.c | 8 +-
drivers/fpga/socfpga-a10.c | 16 ++-
drivers/fpga/socfpga.c | 8 +-
drivers/fpga/stratix10-soc.c | 15 +--
drivers/fpga/ts73xx-fpga.c | 8 +-
drivers/fpga/xilinx-spi.c | 10 +-
drivers/fpga/zynq-fpga.c | 16 ++-
drivers/fpga/zynqmp-fpga.c | 8 +-
include/linux/fpga/fpga-mgr.h | 14 +--
15 files changed, 74 insertions(+), 250 deletions(-)

diff --git a/drivers/fpga/altera-cvp.c b/drivers/fpga/altera-cvp.c
index 4e0edb60bfba..b61020ceb0a1 100644
--- a/drivers/fpga/altera-cvp.c
+++ b/drivers/fpga/altera-cvp.c
@@ -652,19 +652,15 @@ static int altera_cvp_probe(struct pci_dev *pdev,
snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s @%s",
ALTERA_CVP_MGR_NAME, pci_name(pdev));

- mgr = devm_fpga_mgr_create(&pdev->dev, conf->mgr_name,
- &altera_cvp_ops, conf);
- if (!mgr) {
- ret = -ENOMEM;
+ mgr = fpga_mgr_register(&pdev->dev, conf->mgr_name,
+ &altera_cvp_ops, conf);
+ if (IS_ERR(mgr)) {
+ ret = PTR_ERR(mgr);
goto err_unmap;
}

pci_set_drvdata(pdev, mgr);

- ret = fpga_mgr_register(mgr);
- if (ret)
- goto err_unmap;
-
return 0;

err_unmap:
diff --git a/drivers/fpga/altera-pr-ip-core.c b/drivers/fpga/altera-pr-ip-core.c
index 5b130c4d9882..2eb5505a7031 100644
--- a/drivers/fpga/altera-pr-ip-core.c
+++ b/drivers/fpga/altera-pr-ip-core.c
@@ -191,11 +191,9 @@ int alt_pr_register(struct device *dev, void __iomem *reg_base)
(val & ALT_PR_CSR_STATUS_MSK) >> ALT_PR_CSR_STATUS_SFT,
(int)(val & ALT_PR_CSR_PR_START));

- mgr = devm_fpga_mgr_create(dev, dev_name(dev), &alt_pr_ops, priv);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(dev, dev_name(dev), &alt_pr_ops, priv);

- return devm_fpga_mgr_register(dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}
EXPORT_SYMBOL_GPL(alt_pr_register);

diff --git a/drivers/fpga/altera-ps-spi.c b/drivers/fpga/altera-ps-spi.c
index 23bfd4d1ad0f..c9693d852a18 100644
--- a/drivers/fpga/altera-ps-spi.c
+++ b/drivers/fpga/altera-ps-spi.c
@@ -302,12 +302,10 @@ static int altera_ps_probe(struct spi_device *spi)
snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s %s",
dev_driver_string(&spi->dev), dev_name(&spi->dev));

- mgr = devm_fpga_mgr_create(&spi->dev, conf->mgr_name,
- &altera_ps_ops, conf);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(&spi->dev, conf->mgr_name,
+ &altera_ps_ops, conf);

- return devm_fpga_mgr_register(&spi->dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

static const struct spi_device_id altera_ps_spi_ids[] = {
diff --git a/drivers/fpga/dfl-fme-mgr.c b/drivers/fpga/dfl-fme-mgr.c
index d5861d13b306..dd8ff7c4ec10 100644
--- a/drivers/fpga/dfl-fme-mgr.c
+++ b/drivers/fpga/dfl-fme-mgr.c
@@ -308,14 +308,14 @@ static int fme_mgr_probe(struct platform_device *pdev)

fme_mgr_get_compat_id(priv->ioaddr, compat_id);

- mgr = devm_fpga_mgr_create(dev, "DFL FME FPGA Manager",
- &fme_mgr_ops, priv);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(dev, "DFL FME FPGA Manager",
+ &fme_mgr_ops, priv);
+ if (IS_ERR(mgr))
+ return PTR_ERR(mgr);

mgr->compat_id = compat_id;

- return devm_fpga_mgr_register(dev, mgr);
+ return 0;
}

static struct platform_driver fme_mgr_driver = {
diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
index b85bc47c91a9..e95226fbf18c 100644
--- a/drivers/fpga/fpga-mgr.c
+++ b/drivers/fpga/fpga-mgr.c
@@ -21,10 +21,6 @@
static DEFINE_IDA(fpga_mgr_ida);
static struct class *fpga_mgr_class;

-struct fpga_mgr_devres {
- struct fpga_manager *mgr;
-};
-
/**
* fpga_image_info_alloc - Allocate a FPGA image info struct
* @dev: owning device
@@ -550,20 +546,17 @@ void fpga_mgr_unlock(struct fpga_manager *mgr)
EXPORT_SYMBOL_GPL(fpga_mgr_unlock);

/**
- * fpga_mgr_create - create and initialize a FPGA manager struct
+ * fpga_mgr_register - create and register a FPGA manager struct
* @dev: fpga manager device from pdev
* @name: fpga manager name
* @mops: pointer to structure of fpga manager ops
* @priv: fpga manager private data
*
- * The caller of this function is responsible for freeing the struct with
- * fpga_mgr_free(). Using devm_fpga_mgr_create() instead is recommended.
- *
- * Return: pointer to struct fpga_manager or NULL
+ * Returns a struct fpga_manager pointer on success, or ERR_PTR() on error.
*/
-struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
- const struct fpga_manager_ops *mops,
- void *priv)
+struct fpga_manager *
+fpga_mgr_register(struct device *dev, const char *name,
+ const struct fpga_manager_ops *mops, void *priv)
{
struct fpga_manager *mgr;
int id, ret;
@@ -572,17 +565,17 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
!mops->write_init || (!mops->write && !mops->write_sg) ||
(mops->write && mops->write_sg)) {
dev_err(dev, "Attempt to register without fpga_manager_ops\n");
- return NULL;
+ return ERR_PTR(-EINVAL);
}

if (!name || !strlen(name)) {
dev_err(dev, "Attempt to register with no name!\n");
- return NULL;
+ return ERR_PTR(-EINVAL);
}

mgr = kzalloc(sizeof(*mgr), GFP_KERNEL);
if (!mgr)
- return NULL;
+ return ERR_PTR(-ENOMEM);

id = ida_simple_get(&fpga_mgr_ida, 0, 0, GFP_KERNEL);
if (id < 0)
@@ -594,7 +587,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
mgr->mops = mops;
mgr->priv = priv;

- device_initialize(&mgr->dev);
mgr->dev.class = fpga_mgr_class;
mgr->dev.groups = mops->groups;
mgr->dev.parent = dev;
@@ -605,84 +597,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
if (ret)
goto error_device;

- return mgr;
-
-error_device:
- ida_simple_remove(&fpga_mgr_ida, id);
-error_kfree:
- kfree(mgr);
-
- return NULL;
-}
-EXPORT_SYMBOL_GPL(fpga_mgr_create);
-
-/**
- * fpga_mgr_free - free a FPGA manager created with fpga_mgr_create()
- * @mgr: fpga manager struct
- */
-void fpga_mgr_free(struct fpga_manager *mgr)
-{
- ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
- kfree(mgr);
-}
-EXPORT_SYMBOL_GPL(fpga_mgr_free);
-
-static void devm_fpga_mgr_release(struct device *dev, void *res)
-{
- struct fpga_mgr_devres *dr = res;
-
- fpga_mgr_free(dr->mgr);
-}
-
-/**
- * devm_fpga_mgr_create - create and initialize a managed FPGA manager struct
- * @dev: fpga manager device from pdev
- * @name: fpga manager name
- * @mops: pointer to structure of fpga manager ops
- * @priv: fpga manager private data
- *
- * This function is intended for use in a FPGA manager driver's probe function.
- * After the manager driver creates the manager struct with
- * devm_fpga_mgr_create(), it should register it with fpga_mgr_register(). The
- * manager driver's remove function should call fpga_mgr_unregister(). The
- * manager struct allocated with this function will be freed automatically on
- * driver detach. This includes the case of a probe function returning error
- * before calling fpga_mgr_register(), the struct will still get cleaned up.
- *
- * Return: pointer to struct fpga_manager or NULL
- */
-struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
- const struct fpga_manager_ops *mops,
- void *priv)
-{
- struct fpga_mgr_devres *dr;
-
- dr = devres_alloc(devm_fpga_mgr_release, sizeof(*dr), GFP_KERNEL);
- if (!dr)
- return NULL;
-
- dr->mgr = fpga_mgr_create(dev, name, mops, priv);
- if (!dr->mgr) {
- devres_free(dr);
- return NULL;
- }
-
- devres_add(dev, dr);
-
- return dr->mgr;
-}
-EXPORT_SYMBOL_GPL(devm_fpga_mgr_create);
-
-/**
- * fpga_mgr_register - register a FPGA manager
- * @mgr: fpga manager struct
- *
- * Return: 0 on success, negative error code otherwise.
- */
-int fpga_mgr_register(struct fpga_manager *mgr)
-{
- int ret;
-
/*
* Initialize framework state by requesting low level driver read state
* from device. FPGA may be in reset mode or may have been programmed
@@ -690,18 +604,20 @@ int fpga_mgr_register(struct fpga_manager *mgr)
*/
mgr->state = mgr->mops->state(mgr);

- ret = device_add(&mgr->dev);
- if (ret)
- goto error_device;
-
- dev_info(&mgr->dev, "%s registered\n", mgr->name);
+ ret = device_register(&mgr->dev);
+ if (ret) {
+ put_device(&mgr->dev);
+ return ERR_PTR(ret);
+ }

- return 0;
+ return mgr;

error_device:
- ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
+ ida_simple_remove(&fpga_mgr_ida, id);
+error_kfree:
+ kfree(mgr);

- return ret;
+ return ERR_PTR(ret);
}
EXPORT_SYMBOL_GPL(fpga_mgr_register);

@@ -726,61 +642,12 @@ void fpga_mgr_unregister(struct fpga_manager *mgr)
}
EXPORT_SYMBOL_GPL(fpga_mgr_unregister);

-static int fpga_mgr_devres_match(struct device *dev, void *res,
- void *match_data)
-{
- struct fpga_mgr_devres *dr = res;
-
- return match_data == dr->mgr;
-}
-
-static void devm_fpga_mgr_unregister(struct device *dev, void *res)
-{
- struct fpga_mgr_devres *dr = res;
-
- fpga_mgr_unregister(dr->mgr);
-}
-
-/**
- * devm_fpga_mgr_register - resource managed variant of fpga_mgr_register()
- * @dev: managing device for this FPGA manager
- * @mgr: fpga manager struct
- *
- * This is the devres variant of fpga_mgr_register() for which the unregister
- * function will be called automatically when the managing device is detached.
- */
-int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr)
-{
- struct fpga_mgr_devres *dr;
- int ret;
-
- /*
- * Make sure that the struct fpga_manager * that is passed in is
- * managed itself.
- */
- if (WARN_ON(!devres_find(dev, devm_fpga_mgr_release,
- fpga_mgr_devres_match, mgr)))
- return -EINVAL;
-
- dr = devres_alloc(devm_fpga_mgr_unregister, sizeof(*dr), GFP_KERNEL);
- if (!dr)
- return -ENOMEM;
-
- ret = fpga_mgr_register(mgr);
- if (ret) {
- devres_free(dr);
- return ret;
- }
-
- dr->mgr = mgr;
- devres_add(dev, dr);
-
- return 0;
-}
-EXPORT_SYMBOL_GPL(devm_fpga_mgr_register);
-
static void fpga_mgr_dev_release(struct device *dev)
{
+ struct fpga_manager *mgr = to_fpga_manager(dev);
+
+ ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
+ kfree(mgr);
}

static int __init fpga_mgr_class_init(void)
diff --git a/drivers/fpga/ice40-spi.c b/drivers/fpga/ice40-spi.c
index 69dec5af23c3..665db9e68875 100644
--- a/drivers/fpga/ice40-spi.c
+++ b/drivers/fpga/ice40-spi.c
@@ -178,12 +178,10 @@ static int ice40_fpga_probe(struct spi_device *spi)
return ret;
}

- mgr = devm_fpga_mgr_create(dev, "Lattice iCE40 FPGA Manager",
- &ice40_fpga_ops, priv);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(dev, "Lattice iCE40 FPGA Manager",
+ &ice40_fpga_ops, priv);

- return devm_fpga_mgr_register(dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

static const struct of_device_id ice40_fpga_of_match[] = {
diff --git a/drivers/fpga/machxo2-spi.c b/drivers/fpga/machxo2-spi.c
index 114a64d2b7a4..859750b6b578 100644
--- a/drivers/fpga/machxo2-spi.c
+++ b/drivers/fpga/machxo2-spi.c
@@ -366,12 +366,10 @@ static int machxo2_spi_probe(struct spi_device *spi)
return -EINVAL;
}

- mgr = devm_fpga_mgr_create(dev, "Lattice MachXO2 SPI FPGA Manager",
- &machxo2_ops, spi);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(dev, "Lattice MachXO2 SPI FPGA Manager",
+ &machxo2_ops, spi);

- return devm_fpga_mgr_register(dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

static const struct of_device_id of_match[] = {
diff --git a/drivers/fpga/socfpga-a10.c b/drivers/fpga/socfpga-a10.c
index 573d88bdf730..ac8e89b8a5cc 100644
--- a/drivers/fpga/socfpga-a10.c
+++ b/drivers/fpga/socfpga-a10.c
@@ -508,19 +508,15 @@ static int socfpga_a10_fpga_probe(struct platform_device *pdev)
return -EBUSY;
}

- mgr = devm_fpga_mgr_create(dev, "SoCFPGA Arria10 FPGA Manager",
- &socfpga_a10_fpga_mgr_ops, priv);
- if (!mgr)
- return -ENOMEM;
-
- platform_set_drvdata(pdev, mgr);
-
- ret = fpga_mgr_register(mgr);
- if (ret) {
+ mgr = fpga_mgr_register(dev, "SoCFPGA Arria10 FPGA Manager",
+ &socfpga_a10_fpga_mgr_ops, priv);
+ if (IS_ERR(mgr)) {
clk_disable_unprepare(priv->clk);
- return ret;
+ return PTR_ERR(mgr);
}

+ platform_set_drvdata(pdev, mgr);
+
return 0;
}

diff --git a/drivers/fpga/socfpga.c b/drivers/fpga/socfpga.c
index 1f467173fc1f..1dbe3b44418d 100644
--- a/drivers/fpga/socfpga.c
+++ b/drivers/fpga/socfpga.c
@@ -571,12 +571,10 @@ static int socfpga_fpga_probe(struct platform_device *pdev)
if (ret)
return ret;

- mgr = devm_fpga_mgr_create(dev, "Altera SOCFPGA FPGA Manager",
- &socfpga_fpga_ops, priv);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(dev, "Altera SOCFPGA FPGA Manager",
+ &socfpga_fpga_ops, priv);

- return devm_fpga_mgr_register(dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

#ifdef CONFIG_OF
diff --git a/drivers/fpga/stratix10-soc.c b/drivers/fpga/stratix10-soc.c
index 657a70c5fc99..e0bd91b3f7f8 100644
--- a/drivers/fpga/stratix10-soc.c
+++ b/drivers/fpga/stratix10-soc.c
@@ -425,18 +425,11 @@ static int s10_probe(struct platform_device *pdev)

init_completion(&priv->status_return_completion);

- mgr = fpga_mgr_create(dev, "Stratix10 SOC FPGA Manager",
- &s10_ops, priv);
- if (!mgr) {
- dev_err(dev, "unable to create FPGA manager\n");
- ret = -ENOMEM;
- goto probe_err;
- }
-
- ret = fpga_mgr_register(mgr);
- if (ret) {
+ mgr = fpga_mgr_register(dev, "Stratix10 SOC FPGA Manager",
+ &s10_ops, priv);
+ if (IS_ERR(mgr)) {
dev_err(dev, "unable to register FPGA manager\n");
- fpga_mgr_free(mgr);
+ ret = PTR_ERR(mgr);
goto probe_err;
}

diff --git a/drivers/fpga/ts73xx-fpga.c b/drivers/fpga/ts73xx-fpga.c
index 101f016c6ed8..581c561a8980 100644
--- a/drivers/fpga/ts73xx-fpga.c
+++ b/drivers/fpga/ts73xx-fpga.c
@@ -122,12 +122,10 @@ static int ts73xx_fpga_probe(struct platform_device *pdev)
if (IS_ERR(priv->io_base))
return PTR_ERR(priv->io_base);

- mgr = devm_fpga_mgr_create(kdev, "TS-73xx FPGA Manager",
- &ts73xx_fpga_ops, priv);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(kdev, "TS-73xx FPGA Manager",
+ &ts73xx_fpga_ops, priv);

- return devm_fpga_mgr_register(kdev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

static struct platform_driver ts73xx_fpga_driver = {
diff --git a/drivers/fpga/xilinx-spi.c b/drivers/fpga/xilinx-spi.c
index fee4d0abf6bf..720b8a78ffc6 100644
--- a/drivers/fpga/xilinx-spi.c
+++ b/drivers/fpga/xilinx-spi.c
@@ -247,13 +247,11 @@ static int xilinx_spi_probe(struct spi_device *spi)
return dev_err_probe(&spi->dev, PTR_ERR(conf->done),
"Failed to get DONE gpio\n");

- mgr = devm_fpga_mgr_create(&spi->dev,
- "Xilinx Slave Serial FPGA Manager",
- &xilinx_spi_ops, conf);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(&spi->dev,
+ "Xilinx Slave Serial FPGA Manager",
+ &xilinx_spi_ops, conf);

- return devm_fpga_mgr_register(&spi->dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

static const struct of_device_id xlnx_spi_of_match[] = {
diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
index 07fa8d9ec675..74bbb9710f4e 100644
--- a/drivers/fpga/zynq-fpga.c
+++ b/drivers/fpga/zynq-fpga.c
@@ -609,20 +609,16 @@ static int zynq_fpga_probe(struct platform_device *pdev)

clk_disable(priv->clk);

- mgr = devm_fpga_mgr_create(dev, "Xilinx Zynq FPGA Manager",
- &zynq_fpga_ops, priv);
- if (!mgr)
- return -ENOMEM;
-
- platform_set_drvdata(pdev, mgr);
-
- err = fpga_mgr_register(mgr);
- if (err) {
+ mgr = fpga_mgr_register(dev, "Xilinx Zynq FPGA Manager",
+ &zynq_fpga_ops, priv);
+ if (IS_ERR(mgr)) {
dev_err(dev, "unable to register FPGA manager\n");
clk_unprepare(priv->clk);
- return err;
+ return PTR_ERR(mgr);
}

+ platform_set_drvdata(pdev, mgr);
+
return 0;
}

diff --git a/drivers/fpga/zynqmp-fpga.c b/drivers/fpga/zynqmp-fpga.c
index 125743c9797f..1b2eae3f0e03 100644
--- a/drivers/fpga/zynqmp-fpga.c
+++ b/drivers/fpga/zynqmp-fpga.c
@@ -102,12 +102,10 @@ static int zynqmp_fpga_probe(struct platform_device *pdev)

priv->dev = dev;

- mgr = devm_fpga_mgr_create(dev, "Xilinx ZynqMP FPGA Manager",
- &zynqmp_fpga_ops, priv);
- if (!mgr)
- return -ENOMEM;
+ mgr = fpga_mgr_register(dev, "Xilinx ZynqMP FPGA Manager",
+ &zynqmp_fpga_ops, priv);

- return devm_fpga_mgr_register(dev, mgr);
+ return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
}

static const struct of_device_id zynqmp_fpga_of_match[] = {
diff --git a/include/linux/fpga/fpga-mgr.h b/include/linux/fpga/fpga-mgr.h
index 2bc3030a69e5..8ab5f4a67192 100644
--- a/include/linux/fpga/fpga-mgr.h
+++ b/include/linux/fpga/fpga-mgr.h
@@ -191,17 +191,9 @@ struct fpga_manager *fpga_mgr_get(struct device *dev);

void fpga_mgr_put(struct fpga_manager *mgr);

-struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
- const struct fpga_manager_ops *mops,
- void *priv);
-void fpga_mgr_free(struct fpga_manager *mgr);
-int fpga_mgr_register(struct fpga_manager *mgr);
+struct fpga_manager *fpga_mgr_register(struct device *dev, const char *name,
+ const struct fpga_manager_ops *mops,
+ void *priv);
void fpga_mgr_unregister(struct fpga_manager *mgr);

-int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr);
-
-struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
- const struct fpga_manager_ops *mops,
- void *priv);
-
#endif /*_LINUX_FPGA_MGR_H */
--
2.25.1


2021-05-21 20:20:38

by Xu Yilun

[permalink] [raw]
Subject: Re: [PATCH v1 1/3] fpga: mgr: Use standard dev_release for class driver

On Thu, May 20, 2021 at 06:03:57PM -0700, Russ Weight wrote:
> The FPGA manager class driver data structure is being treated as a
> managed resource instead of using standard dev_release call-back
> to release the class data structure. This change removes the
> managed resource code and combines the create() and register()
> functions into a single register() function.

Using the dev_release to release the class dev data is good to me, but I
think we don't have to remove the devm_fpga_mgr_register function, which
saves users from calling fpga_mgr_unregister every time.

>
> Signed-off-by: Russ Weight <[email protected]>
> ---
> drivers/fpga/altera-cvp.c | 12 +--
> drivers/fpga/altera-pr-ip-core.c | 6 +-
> drivers/fpga/altera-ps-spi.c | 8 +-
> drivers/fpga/dfl-fme-mgr.c | 10 +-
> drivers/fpga/fpga-mgr.c | 177 ++++---------------------------
> drivers/fpga/ice40-spi.c | 8 +-
> drivers/fpga/machxo2-spi.c | 8 +-
> drivers/fpga/socfpga-a10.c | 16 ++-
> drivers/fpga/socfpga.c | 8 +-
> drivers/fpga/stratix10-soc.c | 15 +--
> drivers/fpga/ts73xx-fpga.c | 8 +-
> drivers/fpga/xilinx-spi.c | 10 +-
> drivers/fpga/zynq-fpga.c | 16 ++-
> drivers/fpga/zynqmp-fpga.c | 8 +-
> include/linux/fpga/fpga-mgr.h | 14 +--
> 15 files changed, 74 insertions(+), 250 deletions(-)
>
> diff --git a/drivers/fpga/altera-cvp.c b/drivers/fpga/altera-cvp.c
> index 4e0edb60bfba..b61020ceb0a1 100644
> --- a/drivers/fpga/altera-cvp.c
> +++ b/drivers/fpga/altera-cvp.c
> @@ -652,19 +652,15 @@ static int altera_cvp_probe(struct pci_dev *pdev,
> snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s @%s",
> ALTERA_CVP_MGR_NAME, pci_name(pdev));
>
> - mgr = devm_fpga_mgr_create(&pdev->dev, conf->mgr_name,
> - &altera_cvp_ops, conf);
> - if (!mgr) {
> - ret = -ENOMEM;
> + mgr = fpga_mgr_register(&pdev->dev, conf->mgr_name,
> + &altera_cvp_ops, conf);
> + if (IS_ERR(mgr)) {
> + ret = PTR_ERR(mgr);
> goto err_unmap;
> }
>
> pci_set_drvdata(pdev, mgr);
>
> - ret = fpga_mgr_register(mgr);
> - if (ret)
> - goto err_unmap;
> -
> return 0;
>
> err_unmap:
> diff --git a/drivers/fpga/altera-pr-ip-core.c b/drivers/fpga/altera-pr-ip-core.c
> index 5b130c4d9882..2eb5505a7031 100644
> --- a/drivers/fpga/altera-pr-ip-core.c
> +++ b/drivers/fpga/altera-pr-ip-core.c
> @@ -191,11 +191,9 @@ int alt_pr_register(struct device *dev, void __iomem *reg_base)
> (val & ALT_PR_CSR_STATUS_MSK) >> ALT_PR_CSR_STATUS_SFT,
> (int)(val & ALT_PR_CSR_PR_START));
>
> - mgr = devm_fpga_mgr_create(dev, dev_name(dev), &alt_pr_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(dev, dev_name(dev), &alt_pr_ops, priv);
>
> - return devm_fpga_mgr_register(dev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;

Many maintainers don't prefer unnecessary ternery operators which makes code
hard to read. We may change to normal conditional statement.

Same below.

> }
> EXPORT_SYMBOL_GPL(alt_pr_register);
>
> diff --git a/drivers/fpga/altera-ps-spi.c b/drivers/fpga/altera-ps-spi.c
> index 23bfd4d1ad0f..c9693d852a18 100644
> --- a/drivers/fpga/altera-ps-spi.c
> +++ b/drivers/fpga/altera-ps-spi.c
> @@ -302,12 +302,10 @@ static int altera_ps_probe(struct spi_device *spi)
> snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s %s",
> dev_driver_string(&spi->dev), dev_name(&spi->dev));
>
> - mgr = devm_fpga_mgr_create(&spi->dev, conf->mgr_name,
> - &altera_ps_ops, conf);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(&spi->dev, conf->mgr_name,
> + &altera_ps_ops, conf);
>
> - return devm_fpga_mgr_register(&spi->dev, mgr);

You need to implement fpga_mgr_unregister on remove() for some drivers
after you delete the devm_ functions.

Or maybe better, implement the devm_fpga_mgr_register.

Same below.

> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> static const struct spi_device_id altera_ps_spi_ids[] = {
> diff --git a/drivers/fpga/dfl-fme-mgr.c b/drivers/fpga/dfl-fme-mgr.c
> index d5861d13b306..dd8ff7c4ec10 100644
> --- a/drivers/fpga/dfl-fme-mgr.c
> +++ b/drivers/fpga/dfl-fme-mgr.c
> @@ -308,14 +308,14 @@ static int fme_mgr_probe(struct platform_device *pdev)
>
> fme_mgr_get_compat_id(priv->ioaddr, compat_id);
>
> - mgr = devm_fpga_mgr_create(dev, "DFL FME FPGA Manager",
> - &fme_mgr_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(dev, "DFL FME FPGA Manager",
> + &fme_mgr_ops, priv);
> + if (IS_ERR(mgr))
> + return PTR_ERR(mgr);
>
> mgr->compat_id = compat_id;
>
> - return devm_fpga_mgr_register(dev, mgr);
> + return 0;
> }
>
> static struct platform_driver fme_mgr_driver = {
> diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
> index b85bc47c91a9..e95226fbf18c 100644
> --- a/drivers/fpga/fpga-mgr.c
> +++ b/drivers/fpga/fpga-mgr.c
> @@ -21,10 +21,6 @@
> static DEFINE_IDA(fpga_mgr_ida);
> static struct class *fpga_mgr_class;
>
> -struct fpga_mgr_devres {
> - struct fpga_manager *mgr;
> -};
> -
> /**
> * fpga_image_info_alloc - Allocate a FPGA image info struct
> * @dev: owning device
> @@ -550,20 +546,17 @@ void fpga_mgr_unlock(struct fpga_manager *mgr)
> EXPORT_SYMBOL_GPL(fpga_mgr_unlock);
>
> /**
> - * fpga_mgr_create - create and initialize a FPGA manager struct
> + * fpga_mgr_register - create and register a FPGA manager struct
> * @dev: fpga manager device from pdev
> * @name: fpga manager name
> * @mops: pointer to structure of fpga manager ops
> * @priv: fpga manager private data
> *
> - * The caller of this function is responsible for freeing the struct with
> - * fpga_mgr_free(). Using devm_fpga_mgr_create() instead is recommended.
> - *
> - * Return: pointer to struct fpga_manager or NULL
> + * Returns a struct fpga_manager pointer on success, or ERR_PTR() on error.
> */
> -struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> - const struct fpga_manager_ops *mops,
> - void *priv)
> +struct fpga_manager *
> +fpga_mgr_register(struct device *dev, const char *name,
> + const struct fpga_manager_ops *mops, void *priv)
> {
> struct fpga_manager *mgr;
> int id, ret;
> @@ -572,17 +565,17 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> !mops->write_init || (!mops->write && !mops->write_sg) ||
> (mops->write && mops->write_sg)) {
> dev_err(dev, "Attempt to register without fpga_manager_ops\n");
> - return NULL;
> + return ERR_PTR(-EINVAL);
> }
>
> if (!name || !strlen(name)) {
> dev_err(dev, "Attempt to register with no name!\n");
> - return NULL;
> + return ERR_PTR(-EINVAL);
> }
>
> mgr = kzalloc(sizeof(*mgr), GFP_KERNEL);
> if (!mgr)
> - return NULL;
> + return ERR_PTR(-ENOMEM);
>
> id = ida_simple_get(&fpga_mgr_ida, 0, 0, GFP_KERNEL);
> if (id < 0)
> @@ -594,7 +587,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> mgr->mops = mops;
> mgr->priv = priv;
>
> - device_initialize(&mgr->dev);
> mgr->dev.class = fpga_mgr_class;
> mgr->dev.groups = mops->groups;
> mgr->dev.parent = dev;
> @@ -605,84 +597,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> if (ret)
> goto error_device;
>
> - return mgr;
> -
> -error_device:
> - ida_simple_remove(&fpga_mgr_ida, id);
> -error_kfree:
> - kfree(mgr);
> -
> - return NULL;
> -}
> -EXPORT_SYMBOL_GPL(fpga_mgr_create);
> -
> -/**
> - * fpga_mgr_free - free a FPGA manager created with fpga_mgr_create()
> - * @mgr: fpga manager struct
> - */
> -void fpga_mgr_free(struct fpga_manager *mgr)
> -{
> - ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
> - kfree(mgr);
> -}
> -EXPORT_SYMBOL_GPL(fpga_mgr_free);
> -
> -static void devm_fpga_mgr_release(struct device *dev, void *res)
> -{
> - struct fpga_mgr_devres *dr = res;
> -
> - fpga_mgr_free(dr->mgr);
> -}
> -
> -/**
> - * devm_fpga_mgr_create - create and initialize a managed FPGA manager struct
> - * @dev: fpga manager device from pdev
> - * @name: fpga manager name
> - * @mops: pointer to structure of fpga manager ops
> - * @priv: fpga manager private data
> - *
> - * This function is intended for use in a FPGA manager driver's probe function.
> - * After the manager driver creates the manager struct with
> - * devm_fpga_mgr_create(), it should register it with fpga_mgr_register(). The
> - * manager driver's remove function should call fpga_mgr_unregister(). The
> - * manager struct allocated with this function will be freed automatically on
> - * driver detach. This includes the case of a probe function returning error
> - * before calling fpga_mgr_register(), the struct will still get cleaned up.
> - *
> - * Return: pointer to struct fpga_manager or NULL
> - */
> -struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
> - const struct fpga_manager_ops *mops,
> - void *priv)
> -{
> - struct fpga_mgr_devres *dr;
> -
> - dr = devres_alloc(devm_fpga_mgr_release, sizeof(*dr), GFP_KERNEL);
> - if (!dr)
> - return NULL;
> -
> - dr->mgr = fpga_mgr_create(dev, name, mops, priv);
> - if (!dr->mgr) {
> - devres_free(dr);
> - return NULL;
> - }
> -
> - devres_add(dev, dr);
> -
> - return dr->mgr;
> -}
> -EXPORT_SYMBOL_GPL(devm_fpga_mgr_create);
> -
> -/**
> - * fpga_mgr_register - register a FPGA manager
> - * @mgr: fpga manager struct
> - *
> - * Return: 0 on success, negative error code otherwise.
> - */
> -int fpga_mgr_register(struct fpga_manager *mgr)
> -{
> - int ret;
> -
> /*
> * Initialize framework state by requesting low level driver read state
> * from device. FPGA may be in reset mode or may have been programmed
> @@ -690,18 +604,20 @@ int fpga_mgr_register(struct fpga_manager *mgr)
> */
> mgr->state = mgr->mops->state(mgr);
>
> - ret = device_add(&mgr->dev);
> - if (ret)
> - goto error_device;
> -
> - dev_info(&mgr->dev, "%s registered\n", mgr->name);
> + ret = device_register(&mgr->dev);
> + if (ret) {
> + put_device(&mgr->dev);
> + return ERR_PTR(ret);
> + }
>
> - return 0;
> + return mgr;
>
> error_device:
> - ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
> + ida_simple_remove(&fpga_mgr_ida, id);
> +error_kfree:
> + kfree(mgr);
>
> - return ret;
> + return ERR_PTR(ret);
> }
> EXPORT_SYMBOL_GPL(fpga_mgr_register);
>
> @@ -726,61 +642,12 @@ void fpga_mgr_unregister(struct fpga_manager *mgr)
> }
> EXPORT_SYMBOL_GPL(fpga_mgr_unregister);
>
> -static int fpga_mgr_devres_match(struct device *dev, void *res,
> - void *match_data)
> -{
> - struct fpga_mgr_devres *dr = res;
> -
> - return match_data == dr->mgr;
> -}
> -
> -static void devm_fpga_mgr_unregister(struct device *dev, void *res)
> -{
> - struct fpga_mgr_devres *dr = res;
> -
> - fpga_mgr_unregister(dr->mgr);
> -}
> -
> -/**
> - * devm_fpga_mgr_register - resource managed variant of fpga_mgr_register()
> - * @dev: managing device for this FPGA manager
> - * @mgr: fpga manager struct
> - *
> - * This is the devres variant of fpga_mgr_register() for which the unregister
> - * function will be called automatically when the managing device is detached.
> - */
> -int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr)
> -{
> - struct fpga_mgr_devres *dr;
> - int ret;
> -
> - /*
> - * Make sure that the struct fpga_manager * that is passed in is
> - * managed itself.
> - */
> - if (WARN_ON(!devres_find(dev, devm_fpga_mgr_release,
> - fpga_mgr_devres_match, mgr)))
> - return -EINVAL;
> -
> - dr = devres_alloc(devm_fpga_mgr_unregister, sizeof(*dr), GFP_KERNEL);
> - if (!dr)
> - return -ENOMEM;
> -
> - ret = fpga_mgr_register(mgr);
> - if (ret) {
> - devres_free(dr);
> - return ret;
> - }
> -
> - dr->mgr = mgr;
> - devres_add(dev, dr);
> -
> - return 0;
> -}
> -EXPORT_SYMBOL_GPL(devm_fpga_mgr_register);
> -
> static void fpga_mgr_dev_release(struct device *dev)
> {
> + struct fpga_manager *mgr = to_fpga_manager(dev);
> +
> + ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
> + kfree(mgr);
> }
>
> static int __init fpga_mgr_class_init(void)
> diff --git a/drivers/fpga/ice40-spi.c b/drivers/fpga/ice40-spi.c
> index 69dec5af23c3..665db9e68875 100644
> --- a/drivers/fpga/ice40-spi.c
> +++ b/drivers/fpga/ice40-spi.c
> @@ -178,12 +178,10 @@ static int ice40_fpga_probe(struct spi_device *spi)
> return ret;
> }
>
> - mgr = devm_fpga_mgr_create(dev, "Lattice iCE40 FPGA Manager",
> - &ice40_fpga_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(dev, "Lattice iCE40 FPGA Manager",
> + &ice40_fpga_ops, priv);
>
> - return devm_fpga_mgr_register(dev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> static const struct of_device_id ice40_fpga_of_match[] = {
> diff --git a/drivers/fpga/machxo2-spi.c b/drivers/fpga/machxo2-spi.c
> index 114a64d2b7a4..859750b6b578 100644
> --- a/drivers/fpga/machxo2-spi.c
> +++ b/drivers/fpga/machxo2-spi.c
> @@ -366,12 +366,10 @@ static int machxo2_spi_probe(struct spi_device *spi)
> return -EINVAL;
> }
>
> - mgr = devm_fpga_mgr_create(dev, "Lattice MachXO2 SPI FPGA Manager",
> - &machxo2_ops, spi);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(dev, "Lattice MachXO2 SPI FPGA Manager",
> + &machxo2_ops, spi);
>
> - return devm_fpga_mgr_register(dev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> static const struct of_device_id of_match[] = {
> diff --git a/drivers/fpga/socfpga-a10.c b/drivers/fpga/socfpga-a10.c
> index 573d88bdf730..ac8e89b8a5cc 100644
> --- a/drivers/fpga/socfpga-a10.c
> +++ b/drivers/fpga/socfpga-a10.c
> @@ -508,19 +508,15 @@ static int socfpga_a10_fpga_probe(struct platform_device *pdev)
> return -EBUSY;
> }
>
> - mgr = devm_fpga_mgr_create(dev, "SoCFPGA Arria10 FPGA Manager",
> - &socfpga_a10_fpga_mgr_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> -
> - platform_set_drvdata(pdev, mgr);
> -
> - ret = fpga_mgr_register(mgr);
> - if (ret) {
> + mgr = fpga_mgr_register(dev, "SoCFPGA Arria10 FPGA Manager",
> + &socfpga_a10_fpga_mgr_ops, priv);
> + if (IS_ERR(mgr)) {
> clk_disable_unprepare(priv->clk);
> - return ret;
> + return PTR_ERR(mgr);
> }
>
> + platform_set_drvdata(pdev, mgr);
> +
> return 0;
> }
>
> diff --git a/drivers/fpga/socfpga.c b/drivers/fpga/socfpga.c
> index 1f467173fc1f..1dbe3b44418d 100644
> --- a/drivers/fpga/socfpga.c
> +++ b/drivers/fpga/socfpga.c
> @@ -571,12 +571,10 @@ static int socfpga_fpga_probe(struct platform_device *pdev)
> if (ret)
> return ret;
>
> - mgr = devm_fpga_mgr_create(dev, "Altera SOCFPGA FPGA Manager",
> - &socfpga_fpga_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(dev, "Altera SOCFPGA FPGA Manager",
> + &socfpga_fpga_ops, priv);
>
> - return devm_fpga_mgr_register(dev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> #ifdef CONFIG_OF
> diff --git a/drivers/fpga/stratix10-soc.c b/drivers/fpga/stratix10-soc.c
> index 657a70c5fc99..e0bd91b3f7f8 100644
> --- a/drivers/fpga/stratix10-soc.c
> +++ b/drivers/fpga/stratix10-soc.c
> @@ -425,18 +425,11 @@ static int s10_probe(struct platform_device *pdev)
>
> init_completion(&priv->status_return_completion);
>
> - mgr = fpga_mgr_create(dev, "Stratix10 SOC FPGA Manager",
> - &s10_ops, priv);
> - if (!mgr) {
> - dev_err(dev, "unable to create FPGA manager\n");
> - ret = -ENOMEM;
> - goto probe_err;
> - }
> -
> - ret = fpga_mgr_register(mgr);
> - if (ret) {
> + mgr = fpga_mgr_register(dev, "Stratix10 SOC FPGA Manager",
> + &s10_ops, priv);
> + if (IS_ERR(mgr)) {
> dev_err(dev, "unable to register FPGA manager\n");
> - fpga_mgr_free(mgr);
> + ret = PTR_ERR(mgr);
> goto probe_err;
> }
>
> diff --git a/drivers/fpga/ts73xx-fpga.c b/drivers/fpga/ts73xx-fpga.c
> index 101f016c6ed8..581c561a8980 100644
> --- a/drivers/fpga/ts73xx-fpga.c
> +++ b/drivers/fpga/ts73xx-fpga.c
> @@ -122,12 +122,10 @@ static int ts73xx_fpga_probe(struct platform_device *pdev)
> if (IS_ERR(priv->io_base))
> return PTR_ERR(priv->io_base);
>
> - mgr = devm_fpga_mgr_create(kdev, "TS-73xx FPGA Manager",
> - &ts73xx_fpga_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(kdev, "TS-73xx FPGA Manager",
> + &ts73xx_fpga_ops, priv);
>
> - return devm_fpga_mgr_register(kdev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> static struct platform_driver ts73xx_fpga_driver = {
> diff --git a/drivers/fpga/xilinx-spi.c b/drivers/fpga/xilinx-spi.c
> index fee4d0abf6bf..720b8a78ffc6 100644
> --- a/drivers/fpga/xilinx-spi.c
> +++ b/drivers/fpga/xilinx-spi.c
> @@ -247,13 +247,11 @@ static int xilinx_spi_probe(struct spi_device *spi)
> return dev_err_probe(&spi->dev, PTR_ERR(conf->done),
> "Failed to get DONE gpio\n");
>
> - mgr = devm_fpga_mgr_create(&spi->dev,
> - "Xilinx Slave Serial FPGA Manager",
> - &xilinx_spi_ops, conf);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(&spi->dev,
> + "Xilinx Slave Serial FPGA Manager",
> + &xilinx_spi_ops, conf);
>
> - return devm_fpga_mgr_register(&spi->dev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> static const struct of_device_id xlnx_spi_of_match[] = {
> diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
> index 07fa8d9ec675..74bbb9710f4e 100644
> --- a/drivers/fpga/zynq-fpga.c
> +++ b/drivers/fpga/zynq-fpga.c
> @@ -609,20 +609,16 @@ static int zynq_fpga_probe(struct platform_device *pdev)
>
> clk_disable(priv->clk);
>
> - mgr = devm_fpga_mgr_create(dev, "Xilinx Zynq FPGA Manager",
> - &zynq_fpga_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> -
> - platform_set_drvdata(pdev, mgr);
> -
> - err = fpga_mgr_register(mgr);
> - if (err) {
> + mgr = fpga_mgr_register(dev, "Xilinx Zynq FPGA Manager",
> + &zynq_fpga_ops, priv);
> + if (IS_ERR(mgr)) {
> dev_err(dev, "unable to register FPGA manager\n");
> clk_unprepare(priv->clk);
> - return err;
> + return PTR_ERR(mgr);
> }
>
> + platform_set_drvdata(pdev, mgr);
> +
> return 0;
> }
>
> diff --git a/drivers/fpga/zynqmp-fpga.c b/drivers/fpga/zynqmp-fpga.c
> index 125743c9797f..1b2eae3f0e03 100644
> --- a/drivers/fpga/zynqmp-fpga.c
> +++ b/drivers/fpga/zynqmp-fpga.c
> @@ -102,12 +102,10 @@ static int zynqmp_fpga_probe(struct platform_device *pdev)
>
> priv->dev = dev;
>
> - mgr = devm_fpga_mgr_create(dev, "Xilinx ZynqMP FPGA Manager",
> - &zynqmp_fpga_ops, priv);
> - if (!mgr)
> - return -ENOMEM;
> + mgr = fpga_mgr_register(dev, "Xilinx ZynqMP FPGA Manager",
> + &zynqmp_fpga_ops, priv);
>
> - return devm_fpga_mgr_register(dev, mgr);
> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> }
>
> static const struct of_device_id zynqmp_fpga_of_match[] = {
> diff --git a/include/linux/fpga/fpga-mgr.h b/include/linux/fpga/fpga-mgr.h
> index 2bc3030a69e5..8ab5f4a67192 100644
> --- a/include/linux/fpga/fpga-mgr.h
> +++ b/include/linux/fpga/fpga-mgr.h
> @@ -191,17 +191,9 @@ struct fpga_manager *fpga_mgr_get(struct device *dev);
>
> void fpga_mgr_put(struct fpga_manager *mgr);
>
> -struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> - const struct fpga_manager_ops *mops,
> - void *priv);
> -void fpga_mgr_free(struct fpga_manager *mgr);
> -int fpga_mgr_register(struct fpga_manager *mgr);
> +struct fpga_manager *fpga_mgr_register(struct device *dev, const char *name,
> + const struct fpga_manager_ops *mops,
> + void *priv);
> void fpga_mgr_unregister(struct fpga_manager *mgr);
>
> -int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr);
> -
> -struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
> - const struct fpga_manager_ops *mops,
> - void *priv);
> -
> #endif /*_LINUX_FPGA_MGR_H */

Thanks,
Yilun

> --
> 2.25.1

2021-05-21 20:22:25

by Moritz Fischer

[permalink] [raw]
Subject: Re: [PATCH v1 1/3] fpga: mgr: Use standard dev_release for class driver

On Fri, May 21, 2021 at 11:27:19PM +0800, Xu Yilun wrote:
> On Thu, May 20, 2021 at 06:03:57PM -0700, Russ Weight wrote:
> > The FPGA manager class driver data structure is being treated as a
> > managed resource instead of using standard dev_release call-back
> > to release the class data structure. This change removes the
> > managed resource code and combines the create() and register()
> > functions into a single register() function.
>
> Using the dev_release to release the class dev data is good to me, but I
> think we don't have to remove the devm_fpga_mgr_register function, which
> saves users from calling fpga_mgr_unregister every time.
>
> >
> > Signed-off-by: Russ Weight <[email protected]>
> > ---
> > drivers/fpga/altera-cvp.c | 12 +--
> > drivers/fpga/altera-pr-ip-core.c | 6 +-
> > drivers/fpga/altera-ps-spi.c | 8 +-
> > drivers/fpga/dfl-fme-mgr.c | 10 +-
> > drivers/fpga/fpga-mgr.c | 177 ++++---------------------------
> > drivers/fpga/ice40-spi.c | 8 +-
> > drivers/fpga/machxo2-spi.c | 8 +-
> > drivers/fpga/socfpga-a10.c | 16 ++-
> > drivers/fpga/socfpga.c | 8 +-
> > drivers/fpga/stratix10-soc.c | 15 +--
> > drivers/fpga/ts73xx-fpga.c | 8 +-
> > drivers/fpga/xilinx-spi.c | 10 +-
> > drivers/fpga/zynq-fpga.c | 16 ++-
> > drivers/fpga/zynqmp-fpga.c | 8 +-
> > include/linux/fpga/fpga-mgr.h | 14 +--
> > 15 files changed, 74 insertions(+), 250 deletions(-)
> >
> > diff --git a/drivers/fpga/altera-cvp.c b/drivers/fpga/altera-cvp.c
> > index 4e0edb60bfba..b61020ceb0a1 100644
> > --- a/drivers/fpga/altera-cvp.c
> > +++ b/drivers/fpga/altera-cvp.c
> > @@ -652,19 +652,15 @@ static int altera_cvp_probe(struct pci_dev *pdev,
> > snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s @%s",
> > ALTERA_CVP_MGR_NAME, pci_name(pdev));
> >
> > - mgr = devm_fpga_mgr_create(&pdev->dev, conf->mgr_name,
> > - &altera_cvp_ops, conf);
> > - if (!mgr) {
> > - ret = -ENOMEM;
> > + mgr = fpga_mgr_register(&pdev->dev, conf->mgr_name,
> > + &altera_cvp_ops, conf);
> > + if (IS_ERR(mgr)) {
> > + ret = PTR_ERR(mgr);
> > goto err_unmap;
> > }
> >
> > pci_set_drvdata(pdev, mgr);
> >
> > - ret = fpga_mgr_register(mgr);
> > - if (ret)
> > - goto err_unmap;
> > -
> > return 0;
> >
> > err_unmap:
> > diff --git a/drivers/fpga/altera-pr-ip-core.c b/drivers/fpga/altera-pr-ip-core.c
> > index 5b130c4d9882..2eb5505a7031 100644
> > --- a/drivers/fpga/altera-pr-ip-core.c
> > +++ b/drivers/fpga/altera-pr-ip-core.c
> > @@ -191,11 +191,9 @@ int alt_pr_register(struct device *dev, void __iomem *reg_base)
> > (val & ALT_PR_CSR_STATUS_MSK) >> ALT_PR_CSR_STATUS_SFT,
> > (int)(val & ALT_PR_CSR_PR_START));
> >
> > - mgr = devm_fpga_mgr_create(dev, dev_name(dev), &alt_pr_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(dev, dev_name(dev), &alt_pr_ops, priv);
> >
> > - return devm_fpga_mgr_register(dev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>
> Many maintainers don't prefer unnecessary ternery operators which makes code
> hard to read. We may change to normal conditional statement.
>
> Same below.
>
> > }
> > EXPORT_SYMBOL_GPL(alt_pr_register);
> >
> > diff --git a/drivers/fpga/altera-ps-spi.c b/drivers/fpga/altera-ps-spi.c
> > index 23bfd4d1ad0f..c9693d852a18 100644
> > --- a/drivers/fpga/altera-ps-spi.c
> > +++ b/drivers/fpga/altera-ps-spi.c
> > @@ -302,12 +302,10 @@ static int altera_ps_probe(struct spi_device *spi)
> > snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s %s",
> > dev_driver_string(&spi->dev), dev_name(&spi->dev));
> >
> > - mgr = devm_fpga_mgr_create(&spi->dev, conf->mgr_name,
> > - &altera_ps_ops, conf);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(&spi->dev, conf->mgr_name,
> > + &altera_ps_ops, conf);
> >
> > - return devm_fpga_mgr_register(&spi->dev, mgr);
>
> You need to implement fpga_mgr_unregister on remove() for some drivers
> after you delete the devm_ functions.
>
> Or maybe better, implement the devm_fpga_mgr_register.

Yes, I don't think we want to completely get rid of the devres code, we
just need to fix it.
>
> Same below.
>
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > static const struct spi_device_id altera_ps_spi_ids[] = {
> > diff --git a/drivers/fpga/dfl-fme-mgr.c b/drivers/fpga/dfl-fme-mgr.c
> > index d5861d13b306..dd8ff7c4ec10 100644
> > --- a/drivers/fpga/dfl-fme-mgr.c
> > +++ b/drivers/fpga/dfl-fme-mgr.c
> > @@ -308,14 +308,14 @@ static int fme_mgr_probe(struct platform_device *pdev)
> >
> > fme_mgr_get_compat_id(priv->ioaddr, compat_id);
> >
> > - mgr = devm_fpga_mgr_create(dev, "DFL FME FPGA Manager",
> > - &fme_mgr_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(dev, "DFL FME FPGA Manager",
> > + &fme_mgr_ops, priv);
> > + if (IS_ERR(mgr))
> > + return PTR_ERR(mgr);
> >
> > mgr->compat_id = compat_id;
> >
> > - return devm_fpga_mgr_register(dev, mgr);
> > + return 0;
> > }
> >
> > static struct platform_driver fme_mgr_driver = {
> > diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
> > index b85bc47c91a9..e95226fbf18c 100644
> > --- a/drivers/fpga/fpga-mgr.c
> > +++ b/drivers/fpga/fpga-mgr.c
> > @@ -21,10 +21,6 @@
> > static DEFINE_IDA(fpga_mgr_ida);
> > static struct class *fpga_mgr_class;
> >
> > -struct fpga_mgr_devres {
> > - struct fpga_manager *mgr;
> > -};
> > -
> > /**
> > * fpga_image_info_alloc - Allocate a FPGA image info struct
> > * @dev: owning device
> > @@ -550,20 +546,17 @@ void fpga_mgr_unlock(struct fpga_manager *mgr)
> > EXPORT_SYMBOL_GPL(fpga_mgr_unlock);
> >
> > /**
> > - * fpga_mgr_create - create and initialize a FPGA manager struct
> > + * fpga_mgr_register - create and register a FPGA manager struct
> > * @dev: fpga manager device from pdev
> > * @name: fpga manager name
> > * @mops: pointer to structure of fpga manager ops
> > * @priv: fpga manager private data
> > *
> > - * The caller of this function is responsible for freeing the struct with
> > - * fpga_mgr_free(). Using devm_fpga_mgr_create() instead is recommended.
> > - *
> > - * Return: pointer to struct fpga_manager or NULL
> > + * Returns a struct fpga_manager pointer on success, or ERR_PTR() on error.
> > */
> > -struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> > - const struct fpga_manager_ops *mops,
> > - void *priv)
> > +struct fpga_manager *
> > +fpga_mgr_register(struct device *dev, const char *name,
> > + const struct fpga_manager_ops *mops, void *priv)
> > {
> > struct fpga_manager *mgr;
> > int id, ret;
> > @@ -572,17 +565,17 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> > !mops->write_init || (!mops->write && !mops->write_sg) ||
> > (mops->write && mops->write_sg)) {
> > dev_err(dev, "Attempt to register without fpga_manager_ops\n");
> > - return NULL;
> > + return ERR_PTR(-EINVAL);
> > }
> >
> > if (!name || !strlen(name)) {
> > dev_err(dev, "Attempt to register with no name!\n");
> > - return NULL;
> > + return ERR_PTR(-EINVAL);
> > }
> >
> > mgr = kzalloc(sizeof(*mgr), GFP_KERNEL);
> > if (!mgr)
> > - return NULL;
> > + return ERR_PTR(-ENOMEM);
> >
> > id = ida_simple_get(&fpga_mgr_ida, 0, 0, GFP_KERNEL);
> > if (id < 0)
> > @@ -594,7 +587,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> > mgr->mops = mops;
> > mgr->priv = priv;
> >
> > - device_initialize(&mgr->dev);
> > mgr->dev.class = fpga_mgr_class;
> > mgr->dev.groups = mops->groups;
> > mgr->dev.parent = dev;
> > @@ -605,84 +597,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> > if (ret)
> > goto error_device;
> >
> > - return mgr;
> > -
> > -error_device:
> > - ida_simple_remove(&fpga_mgr_ida, id);
> > -error_kfree:
> > - kfree(mgr);
> > -
> > - return NULL;
> > -}
> > -EXPORT_SYMBOL_GPL(fpga_mgr_create);
> > -
> > -/**
> > - * fpga_mgr_free - free a FPGA manager created with fpga_mgr_create()
> > - * @mgr: fpga manager struct
> > - */
> > -void fpga_mgr_free(struct fpga_manager *mgr)
> > -{
> > - ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
> > - kfree(mgr);
> > -}
> > -EXPORT_SYMBOL_GPL(fpga_mgr_free);
> > -
> > -static void devm_fpga_mgr_release(struct device *dev, void *res)
> > -{
> > - struct fpga_mgr_devres *dr = res;
> > -
> > - fpga_mgr_free(dr->mgr);
> > -}
> > -
> > -/**
> > - * devm_fpga_mgr_create - create and initialize a managed FPGA manager struct
> > - * @dev: fpga manager device from pdev
> > - * @name: fpga manager name
> > - * @mops: pointer to structure of fpga manager ops
> > - * @priv: fpga manager private data
> > - *
> > - * This function is intended for use in a FPGA manager driver's probe function.
> > - * After the manager driver creates the manager struct with
> > - * devm_fpga_mgr_create(), it should register it with fpga_mgr_register(). The
> > - * manager driver's remove function should call fpga_mgr_unregister(). The
> > - * manager struct allocated with this function will be freed automatically on
> > - * driver detach. This includes the case of a probe function returning error
> > - * before calling fpga_mgr_register(), the struct will still get cleaned up.
> > - *
> > - * Return: pointer to struct fpga_manager or NULL
> > - */
> > -struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
> > - const struct fpga_manager_ops *mops,
> > - void *priv)
> > -{
> > - struct fpga_mgr_devres *dr;
> > -
> > - dr = devres_alloc(devm_fpga_mgr_release, sizeof(*dr), GFP_KERNEL);
> > - if (!dr)
> > - return NULL;
> > -
> > - dr->mgr = fpga_mgr_create(dev, name, mops, priv);
> > - if (!dr->mgr) {
> > - devres_free(dr);
> > - return NULL;
> > - }
> > -
> > - devres_add(dev, dr);
> > -
> > - return dr->mgr;
> > -}
> > -EXPORT_SYMBOL_GPL(devm_fpga_mgr_create);
> > -
> > -/**
> > - * fpga_mgr_register - register a FPGA manager
> > - * @mgr: fpga manager struct
> > - *
> > - * Return: 0 on success, negative error code otherwise.
> > - */
> > -int fpga_mgr_register(struct fpga_manager *mgr)
> > -{
> > - int ret;
> > -
> > /*
> > * Initialize framework state by requesting low level driver read state
> > * from device. FPGA may be in reset mode or may have been programmed
> > @@ -690,18 +604,20 @@ int fpga_mgr_register(struct fpga_manager *mgr)
> > */
> > mgr->state = mgr->mops->state(mgr);
> >
> > - ret = device_add(&mgr->dev);
> > - if (ret)
> > - goto error_device;
> > -
> > - dev_info(&mgr->dev, "%s registered\n", mgr->name);
> > + ret = device_register(&mgr->dev);
> > + if (ret) {
> > + put_device(&mgr->dev);
> > + return ERR_PTR(ret);
> > + }
> >
> > - return 0;
> > + return mgr;
> >
> > error_device:
> > - ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
> > + ida_simple_remove(&fpga_mgr_ida, id);
> > +error_kfree:
> > + kfree(mgr);
> >
> > - return ret;
> > + return ERR_PTR(ret);
> > }
> > EXPORT_SYMBOL_GPL(fpga_mgr_register);
> >
> > @@ -726,61 +642,12 @@ void fpga_mgr_unregister(struct fpga_manager *mgr)
> > }
> > EXPORT_SYMBOL_GPL(fpga_mgr_unregister);
> >
> > -static int fpga_mgr_devres_match(struct device *dev, void *res,
> > - void *match_data)
> > -{
> > - struct fpga_mgr_devres *dr = res;
> > -
> > - return match_data == dr->mgr;
> > -}
> > -
> > -static void devm_fpga_mgr_unregister(struct device *dev, void *res)
> > -{
> > - struct fpga_mgr_devres *dr = res;
> > -
> > - fpga_mgr_unregister(dr->mgr);
> > -}
> > -
> > -/**
> > - * devm_fpga_mgr_register - resource managed variant of fpga_mgr_register()
> > - * @dev: managing device for this FPGA manager
> > - * @mgr: fpga manager struct
> > - *
> > - * This is the devres variant of fpga_mgr_register() for which the unregister
> > - * function will be called automatically when the managing device is detached.
> > - */
> > -int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr)
> > -{
> > - struct fpga_mgr_devres *dr;
> > - int ret;
> > -
> > - /*
> > - * Make sure that the struct fpga_manager * that is passed in is
> > - * managed itself.
> > - */
> > - if (WARN_ON(!devres_find(dev, devm_fpga_mgr_release,
> > - fpga_mgr_devres_match, mgr)))
> > - return -EINVAL;
> > -
> > - dr = devres_alloc(devm_fpga_mgr_unregister, sizeof(*dr), GFP_KERNEL);
> > - if (!dr)
> > - return -ENOMEM;
> > -
> > - ret = fpga_mgr_register(mgr);
> > - if (ret) {
> > - devres_free(dr);
> > - return ret;
> > - }
> > -
> > - dr->mgr = mgr;
> > - devres_add(dev, dr);
> > -
> > - return 0;
> > -}
> > -EXPORT_SYMBOL_GPL(devm_fpga_mgr_register);
> > -
> > static void fpga_mgr_dev_release(struct device *dev)
> > {
> > + struct fpga_manager *mgr = to_fpga_manager(dev);
> > +
> > + ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
> > + kfree(mgr);
> > }
> >
> > static int __init fpga_mgr_class_init(void)
> > diff --git a/drivers/fpga/ice40-spi.c b/drivers/fpga/ice40-spi.c
> > index 69dec5af23c3..665db9e68875 100644
> > --- a/drivers/fpga/ice40-spi.c
> > +++ b/drivers/fpga/ice40-spi.c
> > @@ -178,12 +178,10 @@ static int ice40_fpga_probe(struct spi_device *spi)
> > return ret;
> > }
> >
> > - mgr = devm_fpga_mgr_create(dev, "Lattice iCE40 FPGA Manager",
> > - &ice40_fpga_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(dev, "Lattice iCE40 FPGA Manager",
> > + &ice40_fpga_ops, priv);
> >
> > - return devm_fpga_mgr_register(dev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > static const struct of_device_id ice40_fpga_of_match[] = {
> > diff --git a/drivers/fpga/machxo2-spi.c b/drivers/fpga/machxo2-spi.c
> > index 114a64d2b7a4..859750b6b578 100644
> > --- a/drivers/fpga/machxo2-spi.c
> > +++ b/drivers/fpga/machxo2-spi.c
> > @@ -366,12 +366,10 @@ static int machxo2_spi_probe(struct spi_device *spi)
> > return -EINVAL;
> > }
> >
> > - mgr = devm_fpga_mgr_create(dev, "Lattice MachXO2 SPI FPGA Manager",
> > - &machxo2_ops, spi);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(dev, "Lattice MachXO2 SPI FPGA Manager",
> > + &machxo2_ops, spi);
> >
> > - return devm_fpga_mgr_register(dev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > static const struct of_device_id of_match[] = {
> > diff --git a/drivers/fpga/socfpga-a10.c b/drivers/fpga/socfpga-a10.c
> > index 573d88bdf730..ac8e89b8a5cc 100644
> > --- a/drivers/fpga/socfpga-a10.c
> > +++ b/drivers/fpga/socfpga-a10.c
> > @@ -508,19 +508,15 @@ static int socfpga_a10_fpga_probe(struct platform_device *pdev)
> > return -EBUSY;
> > }
> >
> > - mgr = devm_fpga_mgr_create(dev, "SoCFPGA Arria10 FPGA Manager",
> > - &socfpga_a10_fpga_mgr_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > -
> > - platform_set_drvdata(pdev, mgr);
> > -
> > - ret = fpga_mgr_register(mgr);
> > - if (ret) {
> > + mgr = fpga_mgr_register(dev, "SoCFPGA Arria10 FPGA Manager",
> > + &socfpga_a10_fpga_mgr_ops, priv);
> > + if (IS_ERR(mgr)) {
> > clk_disable_unprepare(priv->clk);
> > - return ret;
> > + return PTR_ERR(mgr);
> > }
> >
> > + platform_set_drvdata(pdev, mgr);
> > +
> > return 0;
> > }
> >
> > diff --git a/drivers/fpga/socfpga.c b/drivers/fpga/socfpga.c
> > index 1f467173fc1f..1dbe3b44418d 100644
> > --- a/drivers/fpga/socfpga.c
> > +++ b/drivers/fpga/socfpga.c
> > @@ -571,12 +571,10 @@ static int socfpga_fpga_probe(struct platform_device *pdev)
> > if (ret)
> > return ret;
> >
> > - mgr = devm_fpga_mgr_create(dev, "Altera SOCFPGA FPGA Manager",
> > - &socfpga_fpga_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(dev, "Altera SOCFPGA FPGA Manager",
> > + &socfpga_fpga_ops, priv);
> >
> > - return devm_fpga_mgr_register(dev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > #ifdef CONFIG_OF
> > diff --git a/drivers/fpga/stratix10-soc.c b/drivers/fpga/stratix10-soc.c
> > index 657a70c5fc99..e0bd91b3f7f8 100644
> > --- a/drivers/fpga/stratix10-soc.c
> > +++ b/drivers/fpga/stratix10-soc.c
> > @@ -425,18 +425,11 @@ static int s10_probe(struct platform_device *pdev)
> >
> > init_completion(&priv->status_return_completion);
> >
> > - mgr = fpga_mgr_create(dev, "Stratix10 SOC FPGA Manager",
> > - &s10_ops, priv);
> > - if (!mgr) {
> > - dev_err(dev, "unable to create FPGA manager\n");
> > - ret = -ENOMEM;
> > - goto probe_err;
> > - }
> > -
> > - ret = fpga_mgr_register(mgr);
> > - if (ret) {
> > + mgr = fpga_mgr_register(dev, "Stratix10 SOC FPGA Manager",
> > + &s10_ops, priv);
> > + if (IS_ERR(mgr)) {
> > dev_err(dev, "unable to register FPGA manager\n");
> > - fpga_mgr_free(mgr);
> > + ret = PTR_ERR(mgr);
> > goto probe_err;
> > }
> >
> > diff --git a/drivers/fpga/ts73xx-fpga.c b/drivers/fpga/ts73xx-fpga.c
> > index 101f016c6ed8..581c561a8980 100644
> > --- a/drivers/fpga/ts73xx-fpga.c
> > +++ b/drivers/fpga/ts73xx-fpga.c
> > @@ -122,12 +122,10 @@ static int ts73xx_fpga_probe(struct platform_device *pdev)
> > if (IS_ERR(priv->io_base))
> > return PTR_ERR(priv->io_base);
> >
> > - mgr = devm_fpga_mgr_create(kdev, "TS-73xx FPGA Manager",
> > - &ts73xx_fpga_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(kdev, "TS-73xx FPGA Manager",
> > + &ts73xx_fpga_ops, priv);
> >
> > - return devm_fpga_mgr_register(kdev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > static struct platform_driver ts73xx_fpga_driver = {
> > diff --git a/drivers/fpga/xilinx-spi.c b/drivers/fpga/xilinx-spi.c
> > index fee4d0abf6bf..720b8a78ffc6 100644
> > --- a/drivers/fpga/xilinx-spi.c
> > +++ b/drivers/fpga/xilinx-spi.c
> > @@ -247,13 +247,11 @@ static int xilinx_spi_probe(struct spi_device *spi)
> > return dev_err_probe(&spi->dev, PTR_ERR(conf->done),
> > "Failed to get DONE gpio\n");
> >
> > - mgr = devm_fpga_mgr_create(&spi->dev,
> > - "Xilinx Slave Serial FPGA Manager",
> > - &xilinx_spi_ops, conf);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(&spi->dev,
> > + "Xilinx Slave Serial FPGA Manager",
> > + &xilinx_spi_ops, conf);
> >
> > - return devm_fpga_mgr_register(&spi->dev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > static const struct of_device_id xlnx_spi_of_match[] = {
> > diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
> > index 07fa8d9ec675..74bbb9710f4e 100644
> > --- a/drivers/fpga/zynq-fpga.c
> > +++ b/drivers/fpga/zynq-fpga.c
> > @@ -609,20 +609,16 @@ static int zynq_fpga_probe(struct platform_device *pdev)
> >
> > clk_disable(priv->clk);
> >
> > - mgr = devm_fpga_mgr_create(dev, "Xilinx Zynq FPGA Manager",
> > - &zynq_fpga_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > -
> > - platform_set_drvdata(pdev, mgr);
> > -
> > - err = fpga_mgr_register(mgr);
> > - if (err) {
> > + mgr = fpga_mgr_register(dev, "Xilinx Zynq FPGA Manager",
> > + &zynq_fpga_ops, priv);
> > + if (IS_ERR(mgr)) {
> > dev_err(dev, "unable to register FPGA manager\n");
> > clk_unprepare(priv->clk);
> > - return err;
> > + return PTR_ERR(mgr);
> > }
> >
> > + platform_set_drvdata(pdev, mgr);
> > +
> > return 0;
> > }
> >
> > diff --git a/drivers/fpga/zynqmp-fpga.c b/drivers/fpga/zynqmp-fpga.c
> > index 125743c9797f..1b2eae3f0e03 100644
> > --- a/drivers/fpga/zynqmp-fpga.c
> > +++ b/drivers/fpga/zynqmp-fpga.c
> > @@ -102,12 +102,10 @@ static int zynqmp_fpga_probe(struct platform_device *pdev)
> >
> > priv->dev = dev;
> >
> > - mgr = devm_fpga_mgr_create(dev, "Xilinx ZynqMP FPGA Manager",
> > - &zynqmp_fpga_ops, priv);
> > - if (!mgr)
> > - return -ENOMEM;
> > + mgr = fpga_mgr_register(dev, "Xilinx ZynqMP FPGA Manager",
> > + &zynqmp_fpga_ops, priv);
> >
> > - return devm_fpga_mgr_register(dev, mgr);
> > + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
> > }
> >
> > static const struct of_device_id zynqmp_fpga_of_match[] = {
> > diff --git a/include/linux/fpga/fpga-mgr.h b/include/linux/fpga/fpga-mgr.h
> > index 2bc3030a69e5..8ab5f4a67192 100644
> > --- a/include/linux/fpga/fpga-mgr.h
> > +++ b/include/linux/fpga/fpga-mgr.h
> > @@ -191,17 +191,9 @@ struct fpga_manager *fpga_mgr_get(struct device *dev);
> >
> > void fpga_mgr_put(struct fpga_manager *mgr);
> >
> > -struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
> > - const struct fpga_manager_ops *mops,
> > - void *priv);
> > -void fpga_mgr_free(struct fpga_manager *mgr);
> > -int fpga_mgr_register(struct fpga_manager *mgr);
> > +struct fpga_manager *fpga_mgr_register(struct device *dev, const char *name,
> > + const struct fpga_manager_ops *mops,
> > + void *priv);
> > void fpga_mgr_unregister(struct fpga_manager *mgr);
> >
> > -int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr);
> > -
> > -struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
> > - const struct fpga_manager_ops *mops,
> > - void *priv);
> > -
> > #endif /*_LINUX_FPGA_MGR_H */
>
> Thanks,
> Yilun
>
> > --
> > 2.25.1

- Moritz

2021-05-21 20:24:30

by Russ Weight

[permalink] [raw]
Subject: Re: [PATCH v1 1/3] fpga: mgr: Use standard dev_release for class driver



On 5/21/21 9:30 AM, Moritz Fischer wrote:
> On Fri, May 21, 2021 at 11:27:19PM +0800, Xu Yilun wrote:
>> On Thu, May 20, 2021 at 06:03:57PM -0700, Russ Weight wrote:
>>> The FPGA manager class driver data structure is being treated as a
>>> managed resource instead of using standard dev_release call-back
>>> to release the class data structure. This change removes the
>>> managed resource code and combines the create() and register()
>>> functions into a single register() function.
>> Using the dev_release to release the class dev data is good to me, but I
>> think we don't have to remove the devm_fpga_mgr_register function, which
>> saves users from calling fpga_mgr_unregister every time.
>>
>>> Signed-off-by: Russ Weight <[email protected]>
>>> ---
>>> drivers/fpga/altera-cvp.c | 12 +--
>>> drivers/fpga/altera-pr-ip-core.c | 6 +-
>>> drivers/fpga/altera-ps-spi.c | 8 +-
>>> drivers/fpga/dfl-fme-mgr.c | 10 +-
>>> drivers/fpga/fpga-mgr.c | 177 ++++---------------------------
>>> drivers/fpga/ice40-spi.c | 8 +-
>>> drivers/fpga/machxo2-spi.c | 8 +-
>>> drivers/fpga/socfpga-a10.c | 16 ++-
>>> drivers/fpga/socfpga.c | 8 +-
>>> drivers/fpga/stratix10-soc.c | 15 +--
>>> drivers/fpga/ts73xx-fpga.c | 8 +-
>>> drivers/fpga/xilinx-spi.c | 10 +-
>>> drivers/fpga/zynq-fpga.c | 16 ++-
>>> drivers/fpga/zynqmp-fpga.c | 8 +-
>>> include/linux/fpga/fpga-mgr.h | 14 +--
>>> 15 files changed, 74 insertions(+), 250 deletions(-)
>>>
>>> diff --git a/drivers/fpga/altera-cvp.c b/drivers/fpga/altera-cvp.c
>>> index 4e0edb60bfba..b61020ceb0a1 100644
>>> --- a/drivers/fpga/altera-cvp.c
>>> +++ b/drivers/fpga/altera-cvp.c
>>> @@ -652,19 +652,15 @@ static int altera_cvp_probe(struct pci_dev *pdev,
>>> snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s @%s",
>>> ALTERA_CVP_MGR_NAME, pci_name(pdev));
>>>
>>> - mgr = devm_fpga_mgr_create(&pdev->dev, conf->mgr_name,
>>> - &altera_cvp_ops, conf);
>>> - if (!mgr) {
>>> - ret = -ENOMEM;
>>> + mgr = fpga_mgr_register(&pdev->dev, conf->mgr_name,
>>> + &altera_cvp_ops, conf);
>>> + if (IS_ERR(mgr)) {
>>> + ret = PTR_ERR(mgr);
>>> goto err_unmap;
>>> }
>>>
>>> pci_set_drvdata(pdev, mgr);
>>>
>>> - ret = fpga_mgr_register(mgr);
>>> - if (ret)
>>> - goto err_unmap;
>>> -
>>> return 0;
>>>
>>> err_unmap:
>>> diff --git a/drivers/fpga/altera-pr-ip-core.c b/drivers/fpga/altera-pr-ip-core.c
>>> index 5b130c4d9882..2eb5505a7031 100644
>>> --- a/drivers/fpga/altera-pr-ip-core.c
>>> +++ b/drivers/fpga/altera-pr-ip-core.c
>>> @@ -191,11 +191,9 @@ int alt_pr_register(struct device *dev, void __iomem *reg_base)
>>> (val & ALT_PR_CSR_STATUS_MSK) >> ALT_PR_CSR_STATUS_SFT,
>>> (int)(val & ALT_PR_CSR_PR_START));
>>>
>>> - mgr = devm_fpga_mgr_create(dev, dev_name(dev), &alt_pr_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(dev, dev_name(dev), &alt_pr_ops, priv);
>>>
>>> - return devm_fpga_mgr_register(dev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>> Many maintainers don't prefer unnecessary ternery operators which makes code
>> hard to read. We may change to normal conditional statement.
>>
>> Same below.
>>
>>> }
>>> EXPORT_SYMBOL_GPL(alt_pr_register);
>>>
>>> diff --git a/drivers/fpga/altera-ps-spi.c b/drivers/fpga/altera-ps-spi.c
>>> index 23bfd4d1ad0f..c9693d852a18 100644
>>> --- a/drivers/fpga/altera-ps-spi.c
>>> +++ b/drivers/fpga/altera-ps-spi.c
>>> @@ -302,12 +302,10 @@ static int altera_ps_probe(struct spi_device *spi)
>>> snprintf(conf->mgr_name, sizeof(conf->mgr_name), "%s %s",
>>> dev_driver_string(&spi->dev), dev_name(&spi->dev));
>>>
>>> - mgr = devm_fpga_mgr_create(&spi->dev, conf->mgr_name,
>>> - &altera_ps_ops, conf);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(&spi->dev, conf->mgr_name,
>>> + &altera_ps_ops, conf);
>>>
>>> - return devm_fpga_mgr_register(&spi->dev, mgr);
>> You need to implement fpga_mgr_unregister on remove() for some drivers
>> after you delete the devm_ functions.
>>
>> Or maybe better, implement the devm_fpga_mgr_register.
> Yes, I don't think we want to completely get rid of the devres code, we
> just need to fix it.

Agreed. I'll create a second patch-set and restore the some of the devres
code.

Thanks,
- Russ
>> Same below.
>>
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> static const struct spi_device_id altera_ps_spi_ids[] = {
>>> diff --git a/drivers/fpga/dfl-fme-mgr.c b/drivers/fpga/dfl-fme-mgr.c
>>> index d5861d13b306..dd8ff7c4ec10 100644
>>> --- a/drivers/fpga/dfl-fme-mgr.c
>>> +++ b/drivers/fpga/dfl-fme-mgr.c
>>> @@ -308,14 +308,14 @@ static int fme_mgr_probe(struct platform_device *pdev)
>>>
>>> fme_mgr_get_compat_id(priv->ioaddr, compat_id);
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "DFL FME FPGA Manager",
>>> - &fme_mgr_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(dev, "DFL FME FPGA Manager",
>>> + &fme_mgr_ops, priv);
>>> + if (IS_ERR(mgr))
>>> + return PTR_ERR(mgr);
>>>
>>> mgr->compat_id = compat_id;
>>>
>>> - return devm_fpga_mgr_register(dev, mgr);
>>> + return 0;
>>> }
>>>
>>> static struct platform_driver fme_mgr_driver = {
>>> diff --git a/drivers/fpga/fpga-mgr.c b/drivers/fpga/fpga-mgr.c
>>> index b85bc47c91a9..e95226fbf18c 100644
>>> --- a/drivers/fpga/fpga-mgr.c
>>> +++ b/drivers/fpga/fpga-mgr.c
>>> @@ -21,10 +21,6 @@
>>> static DEFINE_IDA(fpga_mgr_ida);
>>> static struct class *fpga_mgr_class;
>>>
>>> -struct fpga_mgr_devres {
>>> - struct fpga_manager *mgr;
>>> -};
>>> -
>>> /**
>>> * fpga_image_info_alloc - Allocate a FPGA image info struct
>>> * @dev: owning device
>>> @@ -550,20 +546,17 @@ void fpga_mgr_unlock(struct fpga_manager *mgr)
>>> EXPORT_SYMBOL_GPL(fpga_mgr_unlock);
>>>
>>> /**
>>> - * fpga_mgr_create - create and initialize a FPGA manager struct
>>> + * fpga_mgr_register - create and register a FPGA manager struct
>>> * @dev: fpga manager device from pdev
>>> * @name: fpga manager name
>>> * @mops: pointer to structure of fpga manager ops
>>> * @priv: fpga manager private data
>>> *
>>> - * The caller of this function is responsible for freeing the struct with
>>> - * fpga_mgr_free(). Using devm_fpga_mgr_create() instead is recommended.
>>> - *
>>> - * Return: pointer to struct fpga_manager or NULL
>>> + * Returns a struct fpga_manager pointer on success, or ERR_PTR() on error.
>>> */
>>> -struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
>>> - const struct fpga_manager_ops *mops,
>>> - void *priv)
>>> +struct fpga_manager *
>>> +fpga_mgr_register(struct device *dev, const char *name,
>>> + const struct fpga_manager_ops *mops, void *priv)
>>> {
>>> struct fpga_manager *mgr;
>>> int id, ret;
>>> @@ -572,17 +565,17 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
>>> !mops->write_init || (!mops->write && !mops->write_sg) ||
>>> (mops->write && mops->write_sg)) {
>>> dev_err(dev, "Attempt to register without fpga_manager_ops\n");
>>> - return NULL;
>>> + return ERR_PTR(-EINVAL);
>>> }
>>>
>>> if (!name || !strlen(name)) {
>>> dev_err(dev, "Attempt to register with no name!\n");
>>> - return NULL;
>>> + return ERR_PTR(-EINVAL);
>>> }
>>>
>>> mgr = kzalloc(sizeof(*mgr), GFP_KERNEL);
>>> if (!mgr)
>>> - return NULL;
>>> + return ERR_PTR(-ENOMEM);
>>>
>>> id = ida_simple_get(&fpga_mgr_ida, 0, 0, GFP_KERNEL);
>>> if (id < 0)
>>> @@ -594,7 +587,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
>>> mgr->mops = mops;
>>> mgr->priv = priv;
>>>
>>> - device_initialize(&mgr->dev);
>>> mgr->dev.class = fpga_mgr_class;
>>> mgr->dev.groups = mops->groups;
>>> mgr->dev.parent = dev;
>>> @@ -605,84 +597,6 @@ struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
>>> if (ret)
>>> goto error_device;
>>>
>>> - return mgr;
>>> -
>>> -error_device:
>>> - ida_simple_remove(&fpga_mgr_ida, id);
>>> -error_kfree:
>>> - kfree(mgr);
>>> -
>>> - return NULL;
>>> -}
>>> -EXPORT_SYMBOL_GPL(fpga_mgr_create);
>>> -
>>> -/**
>>> - * fpga_mgr_free - free a FPGA manager created with fpga_mgr_create()
>>> - * @mgr: fpga manager struct
>>> - */
>>> -void fpga_mgr_free(struct fpga_manager *mgr)
>>> -{
>>> - ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
>>> - kfree(mgr);
>>> -}
>>> -EXPORT_SYMBOL_GPL(fpga_mgr_free);
>>> -
>>> -static void devm_fpga_mgr_release(struct device *dev, void *res)
>>> -{
>>> - struct fpga_mgr_devres *dr = res;
>>> -
>>> - fpga_mgr_free(dr->mgr);
>>> -}
>>> -
>>> -/**
>>> - * devm_fpga_mgr_create - create and initialize a managed FPGA manager struct
>>> - * @dev: fpga manager device from pdev
>>> - * @name: fpga manager name
>>> - * @mops: pointer to structure of fpga manager ops
>>> - * @priv: fpga manager private data
>>> - *
>>> - * This function is intended for use in a FPGA manager driver's probe function.
>>> - * After the manager driver creates the manager struct with
>>> - * devm_fpga_mgr_create(), it should register it with fpga_mgr_register(). The
>>> - * manager driver's remove function should call fpga_mgr_unregister(). The
>>> - * manager struct allocated with this function will be freed automatically on
>>> - * driver detach. This includes the case of a probe function returning error
>>> - * before calling fpga_mgr_register(), the struct will still get cleaned up.
>>> - *
>>> - * Return: pointer to struct fpga_manager or NULL
>>> - */
>>> -struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
>>> - const struct fpga_manager_ops *mops,
>>> - void *priv)
>>> -{
>>> - struct fpga_mgr_devres *dr;
>>> -
>>> - dr = devres_alloc(devm_fpga_mgr_release, sizeof(*dr), GFP_KERNEL);
>>> - if (!dr)
>>> - return NULL;
>>> -
>>> - dr->mgr = fpga_mgr_create(dev, name, mops, priv);
>>> - if (!dr->mgr) {
>>> - devres_free(dr);
>>> - return NULL;
>>> - }
>>> -
>>> - devres_add(dev, dr);
>>> -
>>> - return dr->mgr;
>>> -}
>>> -EXPORT_SYMBOL_GPL(devm_fpga_mgr_create);
>>> -
>>> -/**
>>> - * fpga_mgr_register - register a FPGA manager
>>> - * @mgr: fpga manager struct
>>> - *
>>> - * Return: 0 on success, negative error code otherwise.
>>> - */
>>> -int fpga_mgr_register(struct fpga_manager *mgr)
>>> -{
>>> - int ret;
>>> -
>>> /*
>>> * Initialize framework state by requesting low level driver read state
>>> * from device. FPGA may be in reset mode or may have been programmed
>>> @@ -690,18 +604,20 @@ int fpga_mgr_register(struct fpga_manager *mgr)
>>> */
>>> mgr->state = mgr->mops->state(mgr);
>>>
>>> - ret = device_add(&mgr->dev);
>>> - if (ret)
>>> - goto error_device;
>>> -
>>> - dev_info(&mgr->dev, "%s registered\n", mgr->name);
>>> + ret = device_register(&mgr->dev);
>>> + if (ret) {
>>> + put_device(&mgr->dev);
>>> + return ERR_PTR(ret);
>>> + }
>>>
>>> - return 0;
>>> + return mgr;
>>>
>>> error_device:
>>> - ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
>>> + ida_simple_remove(&fpga_mgr_ida, id);
>>> +error_kfree:
>>> + kfree(mgr);
>>>
>>> - return ret;
>>> + return ERR_PTR(ret);
>>> }
>>> EXPORT_SYMBOL_GPL(fpga_mgr_register);
>>>
>>> @@ -726,61 +642,12 @@ void fpga_mgr_unregister(struct fpga_manager *mgr)
>>> }
>>> EXPORT_SYMBOL_GPL(fpga_mgr_unregister);
>>>
>>> -static int fpga_mgr_devres_match(struct device *dev, void *res,
>>> - void *match_data)
>>> -{
>>> - struct fpga_mgr_devres *dr = res;
>>> -
>>> - return match_data == dr->mgr;
>>> -}
>>> -
>>> -static void devm_fpga_mgr_unregister(struct device *dev, void *res)
>>> -{
>>> - struct fpga_mgr_devres *dr = res;
>>> -
>>> - fpga_mgr_unregister(dr->mgr);
>>> -}
>>> -
>>> -/**
>>> - * devm_fpga_mgr_register - resource managed variant of fpga_mgr_register()
>>> - * @dev: managing device for this FPGA manager
>>> - * @mgr: fpga manager struct
>>> - *
>>> - * This is the devres variant of fpga_mgr_register() for which the unregister
>>> - * function will be called automatically when the managing device is detached.
>>> - */
>>> -int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr)
>>> -{
>>> - struct fpga_mgr_devres *dr;
>>> - int ret;
>>> -
>>> - /*
>>> - * Make sure that the struct fpga_manager * that is passed in is
>>> - * managed itself.
>>> - */
>>> - if (WARN_ON(!devres_find(dev, devm_fpga_mgr_release,
>>> - fpga_mgr_devres_match, mgr)))
>>> - return -EINVAL;
>>> -
>>> - dr = devres_alloc(devm_fpga_mgr_unregister, sizeof(*dr), GFP_KERNEL);
>>> - if (!dr)
>>> - return -ENOMEM;
>>> -
>>> - ret = fpga_mgr_register(mgr);
>>> - if (ret) {
>>> - devres_free(dr);
>>> - return ret;
>>> - }
>>> -
>>> - dr->mgr = mgr;
>>> - devres_add(dev, dr);
>>> -
>>> - return 0;
>>> -}
>>> -EXPORT_SYMBOL_GPL(devm_fpga_mgr_register);
>>> -
>>> static void fpga_mgr_dev_release(struct device *dev)
>>> {
>>> + struct fpga_manager *mgr = to_fpga_manager(dev);
>>> +
>>> + ida_simple_remove(&fpga_mgr_ida, mgr->dev.id);
>>> + kfree(mgr);
>>> }
>>>
>>> static int __init fpga_mgr_class_init(void)
>>> diff --git a/drivers/fpga/ice40-spi.c b/drivers/fpga/ice40-spi.c
>>> index 69dec5af23c3..665db9e68875 100644
>>> --- a/drivers/fpga/ice40-spi.c
>>> +++ b/drivers/fpga/ice40-spi.c
>>> @@ -178,12 +178,10 @@ static int ice40_fpga_probe(struct spi_device *spi)
>>> return ret;
>>> }
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "Lattice iCE40 FPGA Manager",
>>> - &ice40_fpga_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(dev, "Lattice iCE40 FPGA Manager",
>>> + &ice40_fpga_ops, priv);
>>>
>>> - return devm_fpga_mgr_register(dev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> static const struct of_device_id ice40_fpga_of_match[] = {
>>> diff --git a/drivers/fpga/machxo2-spi.c b/drivers/fpga/machxo2-spi.c
>>> index 114a64d2b7a4..859750b6b578 100644
>>> --- a/drivers/fpga/machxo2-spi.c
>>> +++ b/drivers/fpga/machxo2-spi.c
>>> @@ -366,12 +366,10 @@ static int machxo2_spi_probe(struct spi_device *spi)
>>> return -EINVAL;
>>> }
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "Lattice MachXO2 SPI FPGA Manager",
>>> - &machxo2_ops, spi);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(dev, "Lattice MachXO2 SPI FPGA Manager",
>>> + &machxo2_ops, spi);
>>>
>>> - return devm_fpga_mgr_register(dev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> static const struct of_device_id of_match[] = {
>>> diff --git a/drivers/fpga/socfpga-a10.c b/drivers/fpga/socfpga-a10.c
>>> index 573d88bdf730..ac8e89b8a5cc 100644
>>> --- a/drivers/fpga/socfpga-a10.c
>>> +++ b/drivers/fpga/socfpga-a10.c
>>> @@ -508,19 +508,15 @@ static int socfpga_a10_fpga_probe(struct platform_device *pdev)
>>> return -EBUSY;
>>> }
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "SoCFPGA Arria10 FPGA Manager",
>>> - &socfpga_a10_fpga_mgr_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> -
>>> - platform_set_drvdata(pdev, mgr);
>>> -
>>> - ret = fpga_mgr_register(mgr);
>>> - if (ret) {
>>> + mgr = fpga_mgr_register(dev, "SoCFPGA Arria10 FPGA Manager",
>>> + &socfpga_a10_fpga_mgr_ops, priv);
>>> + if (IS_ERR(mgr)) {
>>> clk_disable_unprepare(priv->clk);
>>> - return ret;
>>> + return PTR_ERR(mgr);
>>> }
>>>
>>> + platform_set_drvdata(pdev, mgr);
>>> +
>>> return 0;
>>> }
>>>
>>> diff --git a/drivers/fpga/socfpga.c b/drivers/fpga/socfpga.c
>>> index 1f467173fc1f..1dbe3b44418d 100644
>>> --- a/drivers/fpga/socfpga.c
>>> +++ b/drivers/fpga/socfpga.c
>>> @@ -571,12 +571,10 @@ static int socfpga_fpga_probe(struct platform_device *pdev)
>>> if (ret)
>>> return ret;
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "Altera SOCFPGA FPGA Manager",
>>> - &socfpga_fpga_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(dev, "Altera SOCFPGA FPGA Manager",
>>> + &socfpga_fpga_ops, priv);
>>>
>>> - return devm_fpga_mgr_register(dev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> #ifdef CONFIG_OF
>>> diff --git a/drivers/fpga/stratix10-soc.c b/drivers/fpga/stratix10-soc.c
>>> index 657a70c5fc99..e0bd91b3f7f8 100644
>>> --- a/drivers/fpga/stratix10-soc.c
>>> +++ b/drivers/fpga/stratix10-soc.c
>>> @@ -425,18 +425,11 @@ static int s10_probe(struct platform_device *pdev)
>>>
>>> init_completion(&priv->status_return_completion);
>>>
>>> - mgr = fpga_mgr_create(dev, "Stratix10 SOC FPGA Manager",
>>> - &s10_ops, priv);
>>> - if (!mgr) {
>>> - dev_err(dev, "unable to create FPGA manager\n");
>>> - ret = -ENOMEM;
>>> - goto probe_err;
>>> - }
>>> -
>>> - ret = fpga_mgr_register(mgr);
>>> - if (ret) {
>>> + mgr = fpga_mgr_register(dev, "Stratix10 SOC FPGA Manager",
>>> + &s10_ops, priv);
>>> + if (IS_ERR(mgr)) {
>>> dev_err(dev, "unable to register FPGA manager\n");
>>> - fpga_mgr_free(mgr);
>>> + ret = PTR_ERR(mgr);
>>> goto probe_err;
>>> }
>>>
>>> diff --git a/drivers/fpga/ts73xx-fpga.c b/drivers/fpga/ts73xx-fpga.c
>>> index 101f016c6ed8..581c561a8980 100644
>>> --- a/drivers/fpga/ts73xx-fpga.c
>>> +++ b/drivers/fpga/ts73xx-fpga.c
>>> @@ -122,12 +122,10 @@ static int ts73xx_fpga_probe(struct platform_device *pdev)
>>> if (IS_ERR(priv->io_base))
>>> return PTR_ERR(priv->io_base);
>>>
>>> - mgr = devm_fpga_mgr_create(kdev, "TS-73xx FPGA Manager",
>>> - &ts73xx_fpga_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(kdev, "TS-73xx FPGA Manager",
>>> + &ts73xx_fpga_ops, priv);
>>>
>>> - return devm_fpga_mgr_register(kdev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> static struct platform_driver ts73xx_fpga_driver = {
>>> diff --git a/drivers/fpga/xilinx-spi.c b/drivers/fpga/xilinx-spi.c
>>> index fee4d0abf6bf..720b8a78ffc6 100644
>>> --- a/drivers/fpga/xilinx-spi.c
>>> +++ b/drivers/fpga/xilinx-spi.c
>>> @@ -247,13 +247,11 @@ static int xilinx_spi_probe(struct spi_device *spi)
>>> return dev_err_probe(&spi->dev, PTR_ERR(conf->done),
>>> "Failed to get DONE gpio\n");
>>>
>>> - mgr = devm_fpga_mgr_create(&spi->dev,
>>> - "Xilinx Slave Serial FPGA Manager",
>>> - &xilinx_spi_ops, conf);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(&spi->dev,
>>> + "Xilinx Slave Serial FPGA Manager",
>>> + &xilinx_spi_ops, conf);
>>>
>>> - return devm_fpga_mgr_register(&spi->dev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> static const struct of_device_id xlnx_spi_of_match[] = {
>>> diff --git a/drivers/fpga/zynq-fpga.c b/drivers/fpga/zynq-fpga.c
>>> index 07fa8d9ec675..74bbb9710f4e 100644
>>> --- a/drivers/fpga/zynq-fpga.c
>>> +++ b/drivers/fpga/zynq-fpga.c
>>> @@ -609,20 +609,16 @@ static int zynq_fpga_probe(struct platform_device *pdev)
>>>
>>> clk_disable(priv->clk);
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "Xilinx Zynq FPGA Manager",
>>> - &zynq_fpga_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> -
>>> - platform_set_drvdata(pdev, mgr);
>>> -
>>> - err = fpga_mgr_register(mgr);
>>> - if (err) {
>>> + mgr = fpga_mgr_register(dev, "Xilinx Zynq FPGA Manager",
>>> + &zynq_fpga_ops, priv);
>>> + if (IS_ERR(mgr)) {
>>> dev_err(dev, "unable to register FPGA manager\n");
>>> clk_unprepare(priv->clk);
>>> - return err;
>>> + return PTR_ERR(mgr);
>>> }
>>>
>>> + platform_set_drvdata(pdev, mgr);
>>> +
>>> return 0;
>>> }
>>>
>>> diff --git a/drivers/fpga/zynqmp-fpga.c b/drivers/fpga/zynqmp-fpga.c
>>> index 125743c9797f..1b2eae3f0e03 100644
>>> --- a/drivers/fpga/zynqmp-fpga.c
>>> +++ b/drivers/fpga/zynqmp-fpga.c
>>> @@ -102,12 +102,10 @@ static int zynqmp_fpga_probe(struct platform_device *pdev)
>>>
>>> priv->dev = dev;
>>>
>>> - mgr = devm_fpga_mgr_create(dev, "Xilinx ZynqMP FPGA Manager",
>>> - &zynqmp_fpga_ops, priv);
>>> - if (!mgr)
>>> - return -ENOMEM;
>>> + mgr = fpga_mgr_register(dev, "Xilinx ZynqMP FPGA Manager",
>>> + &zynqmp_fpga_ops, priv);
>>>
>>> - return devm_fpga_mgr_register(dev, mgr);
>>> + return (IS_ERR(mgr)) ? PTR_ERR(mgr) : 0;
>>> }
>>>
>>> static const struct of_device_id zynqmp_fpga_of_match[] = {
>>> diff --git a/include/linux/fpga/fpga-mgr.h b/include/linux/fpga/fpga-mgr.h
>>> index 2bc3030a69e5..8ab5f4a67192 100644
>>> --- a/include/linux/fpga/fpga-mgr.h
>>> +++ b/include/linux/fpga/fpga-mgr.h
>>> @@ -191,17 +191,9 @@ struct fpga_manager *fpga_mgr_get(struct device *dev);
>>>
>>> void fpga_mgr_put(struct fpga_manager *mgr);
>>>
>>> -struct fpga_manager *fpga_mgr_create(struct device *dev, const char *name,
>>> - const struct fpga_manager_ops *mops,
>>> - void *priv);
>>> -void fpga_mgr_free(struct fpga_manager *mgr);
>>> -int fpga_mgr_register(struct fpga_manager *mgr);
>>> +struct fpga_manager *fpga_mgr_register(struct device *dev, const char *name,
>>> + const struct fpga_manager_ops *mops,
>>> + void *priv);
>>> void fpga_mgr_unregister(struct fpga_manager *mgr);
>>>
>>> -int devm_fpga_mgr_register(struct device *dev, struct fpga_manager *mgr);
>>> -
>>> -struct fpga_manager *devm_fpga_mgr_create(struct device *dev, const char *name,
>>> - const struct fpga_manager_ops *mops,
>>> - void *priv);
>>> -
>>> #endif /*_LINUX_FPGA_MGR_H */
>> Thanks,
>> Yilun
>>
>>> --
>>> 2.25.1
> - Moritz

2021-05-22 20:40:12

by kernel test robot

[permalink] [raw]
Subject: Re: [PATCH v1 1/3] fpga: mgr: Use standard dev_release for class driver

Hi Russ,

Thank you for the patch! Perhaps something to improve:

[auto build test WARNING on linux/master]
[also build test WARNING on linus/master v5.13-rc2 next-20210521]
[cannot apply to xlnx/master]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]

url: https://github.com/0day-ci/linux/commits/Russ-Weight/fpga-Use-standard-class-dev_release-function/20210522-205631
base: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git dd860052c99b1e088352bdd4fb7aef46f8d2ef47
config: x86_64-randconfig-a014-20210522 (attached as .config)
compiler: clang version 13.0.0 (https://github.com/llvm/llvm-project e84a9b9bb3051c35dea993cdad7b3d2575638f85)
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# install x86_64 cross compiling tool for clang build
# apt-get install binutils-x86-64-linux-gnu
# https://github.com/0day-ci/linux/commit/fe4ee184f8a9b9acbf00d536ec38d8d793f8dcee
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review Russ-Weight/fpga-Use-standard-class-dev_release-function/20210522-205631
git checkout fe4ee184f8a9b9acbf00d536ec38d8d793f8dcee
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=clang make.cross ARCH=x86_64

If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <[email protected]>

All warnings (new ones prefixed by >>):

>> drivers/fpga/fpga-mgr.c:581:6: warning: variable 'ret' is used uninitialized whenever 'if' condition is true [-Wsometimes-uninitialized]
if (id < 0)
^~~~~~
drivers/fpga/fpga-mgr.c:620:17: note: uninitialized use occurs here
return ERR_PTR(ret);
^~~
drivers/fpga/fpga-mgr.c:581:2: note: remove the 'if' if its condition is always false
if (id < 0)
^~~~~~~~~~~
drivers/fpga/fpga-mgr.c:562:13: note: initialize the variable 'ret' to silence this warning
int id, ret;
^
= 0
1 warning generated.


vim +581 drivers/fpga/fpga-mgr.c

ebf877a51ad7b6 Alan Tull 2017-11-15 547
6a8c3be7ec8eb3 Alan Tull 2015-10-07 548 /**
fe4ee184f8a9b9 Russ Weight 2021-05-20 549 * fpga_mgr_register - create and register a FPGA manager struct
6a8c3be7ec8eb3 Alan Tull 2015-10-07 550 * @dev: fpga manager device from pdev
6a8c3be7ec8eb3 Alan Tull 2015-10-07 551 * @name: fpga manager name
6a8c3be7ec8eb3 Alan Tull 2015-10-07 552 * @mops: pointer to structure of fpga manager ops
6a8c3be7ec8eb3 Alan Tull 2015-10-07 553 * @priv: fpga manager private data
6a8c3be7ec8eb3 Alan Tull 2015-10-07 554 *
fe4ee184f8a9b9 Russ Weight 2021-05-20 555 * Returns a struct fpga_manager pointer on success, or ERR_PTR() on error.
6a8c3be7ec8eb3 Alan Tull 2015-10-07 556 */
fe4ee184f8a9b9 Russ Weight 2021-05-20 557 struct fpga_manager *
fe4ee184f8a9b9 Russ Weight 2021-05-20 558 fpga_mgr_register(struct device *dev, const char *name,
fe4ee184f8a9b9 Russ Weight 2021-05-20 559 const struct fpga_manager_ops *mops, void *priv)
6a8c3be7ec8eb3 Alan Tull 2015-10-07 560 {
6a8c3be7ec8eb3 Alan Tull 2015-10-07 561 struct fpga_manager *mgr;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 562 int id, ret;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 563
baa6d396635129 Jason Gunthorpe 2017-02-01 564 if (!mops || !mops->write_complete || !mops->state ||
baa6d396635129 Jason Gunthorpe 2017-02-01 565 !mops->write_init || (!mops->write && !mops->write_sg) ||
baa6d396635129 Jason Gunthorpe 2017-02-01 566 (mops->write && mops->write_sg)) {
6a8c3be7ec8eb3 Alan Tull 2015-10-07 567 dev_err(dev, "Attempt to register without fpga_manager_ops\n");
fe4ee184f8a9b9 Russ Weight 2021-05-20 568 return ERR_PTR(-EINVAL);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 569 }
6a8c3be7ec8eb3 Alan Tull 2015-10-07 570
6a8c3be7ec8eb3 Alan Tull 2015-10-07 571 if (!name || !strlen(name)) {
6a8c3be7ec8eb3 Alan Tull 2015-10-07 572 dev_err(dev, "Attempt to register with no name!\n");
fe4ee184f8a9b9 Russ Weight 2021-05-20 573 return ERR_PTR(-EINVAL);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 574 }
6a8c3be7ec8eb3 Alan Tull 2015-10-07 575
6a8c3be7ec8eb3 Alan Tull 2015-10-07 576 mgr = kzalloc(sizeof(*mgr), GFP_KERNEL);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 577 if (!mgr)
fe4ee184f8a9b9 Russ Weight 2021-05-20 578 return ERR_PTR(-ENOMEM);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 579
6a8c3be7ec8eb3 Alan Tull 2015-10-07 580 id = ida_simple_get(&fpga_mgr_ida, 0, 0, GFP_KERNEL);
88aaab9218f87c Tom Rix 2020-06-08 @581 if (id < 0)
6a8c3be7ec8eb3 Alan Tull 2015-10-07 582 goto error_kfree;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 583
6a8c3be7ec8eb3 Alan Tull 2015-10-07 584 mutex_init(&mgr->ref_mutex);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 585
6a8c3be7ec8eb3 Alan Tull 2015-10-07 586 mgr->name = name;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 587 mgr->mops = mops;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 588 mgr->priv = priv;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 589
6a8c3be7ec8eb3 Alan Tull 2015-10-07 590 mgr->dev.class = fpga_mgr_class;
845089bbf589be Alan Tull 2017-11-15 591 mgr->dev.groups = mops->groups;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 592 mgr->dev.parent = dev;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 593 mgr->dev.of_node = dev->of_node;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 594 mgr->dev.id = id;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 595
6a8c3be7ec8eb3 Alan Tull 2015-10-07 596 ret = dev_set_name(&mgr->dev, "fpga%d", id);
07687c031d14a1 Alan Tull 2015-10-29 597 if (ret)
07687c031d14a1 Alan Tull 2015-10-29 598 goto error_device;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 599
7085e2a94f7df5 Alan Tull 2018-05-16 600 /*
7085e2a94f7df5 Alan Tull 2018-05-16 601 * Initialize framework state by requesting low level driver read state
7085e2a94f7df5 Alan Tull 2018-05-16 602 * from device. FPGA may be in reset mode or may have been programmed
7085e2a94f7df5 Alan Tull 2018-05-16 603 * by bootloader or EEPROM.
7085e2a94f7df5 Alan Tull 2018-05-16 604 */
7085e2a94f7df5 Alan Tull 2018-05-16 605 mgr->state = mgr->mops->state(mgr);
7085e2a94f7df5 Alan Tull 2018-05-16 606
fe4ee184f8a9b9 Russ Weight 2021-05-20 607 ret = device_register(&mgr->dev);
fe4ee184f8a9b9 Russ Weight 2021-05-20 608 if (ret) {
fe4ee184f8a9b9 Russ Weight 2021-05-20 609 put_device(&mgr->dev);
fe4ee184f8a9b9 Russ Weight 2021-05-20 610 return ERR_PTR(ret);
fe4ee184f8a9b9 Russ Weight 2021-05-20 611 }
6a8c3be7ec8eb3 Alan Tull 2015-10-07 612
fe4ee184f8a9b9 Russ Weight 2021-05-20 613 return mgr;
6a8c3be7ec8eb3 Alan Tull 2015-10-07 614
6a8c3be7ec8eb3 Alan Tull 2015-10-07 615 error_device:
fe4ee184f8a9b9 Russ Weight 2021-05-20 616 ida_simple_remove(&fpga_mgr_ida, id);
fe4ee184f8a9b9 Russ Weight 2021-05-20 617 error_kfree:
fe4ee184f8a9b9 Russ Weight 2021-05-20 618 kfree(mgr);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 619
fe4ee184f8a9b9 Russ Weight 2021-05-20 620 return ERR_PTR(ret);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 621 }
6a8c3be7ec8eb3 Alan Tull 2015-10-07 622 EXPORT_SYMBOL_GPL(fpga_mgr_register);
6a8c3be7ec8eb3 Alan Tull 2015-10-07 623

---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/[email protected]


Attachments:
(No filename) (7.96 kB)
.config.gz (39.82 kB)
Download all attachments

2021-05-24 01:01:28

by Chen, Rong A

[permalink] [raw]
Subject: Re: [PATCH v1 1/3] fpga: mgr: Use standard dev_release for class driver

_______________________________________________
kbuild mailing list -- [email protected]
To unsubscribe send an email to [email protected]


Attachments:
(No filename) (7.96 kB)
.config.gz (33.59 kB)
(No filename) (152.00 B)
Download all attachments