| Message ID | 20230918204227.1316886-54-u.kleine-koenig@pengutronix.de (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 2e0ec0afa9025abaff214e1023fb11742e7a5cc8 |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | net: ethernet: Convert to platform remove callback returning void | expand |
> -----Original Message----- > From: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > Sent: Tuesday, September 19, 2023 2:12 AM > To: David S. Miller <davem@davemloft.net>; Eric Dumazet > <edumazet@google.com>; Jakub Kicinski <kuba@kernel.org>; Paolo Abeni > <pabeni@redhat.com> > Cc: Simek, Michal <michal.simek@amd.com>; Pandey, Radhey Shyam > <radhey.shyam.pandey@amd.com>; Katakam, Harini > <harini.katakam@amd.com>; Haoyue Xu <xuhaoyue1@hisilicon.com>; > huangjunxian <huangjunxian6@hisilicon.com>; Rob Herring > <robh@kernel.org>; Yang Yingliang <yangyingliang@huawei.com>; Dan > Carpenter <dan.carpenter@linaro.org>; Bhupesh Sharma > <bhupesh.sharma@linaro.org>; Simon Horman <horms@kernel.org>; Alex > Elder <elder@linaro.org>; Wei Fang <wei.fang@nxp.com>; > netdev@vger.kernel.org; linux-arm-kernel@lists.infradead.org; > kernel@pengutronix.de > Subject: [PATCH net-next 53/54] net: ethernet: xilinx: Convert to platform > remove callback returning void > > The .remove() callback for a platform driver returns an int which makes > many driver authors wrongly assume it's possible to do error handling by > returning an error code. However the value returned is ignored (apart > from emitting a warning) and this typically results in resource leaks. > To improve here there is a quest to make the remove callback return > void. In the first step of this quest all drivers are converted to > .remove_new() which already returns void. Eventually after all drivers > are converted, .remove_new() is renamed to .remove(). > > Trivially convert these drivers from always returning zero in the remove > callback to the void returning variant. > > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > --- > drivers/net/ethernet/xilinx/ll_temac_main.c | 5 ++--- > drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 6 ++---- > drivers/net/ethernet/xilinx/xilinx_emaclite.c | 6 ++---- > 3 files changed, 6 insertions(+), 11 deletions(-) > > diff --git a/drivers/net/ethernet/xilinx/ll_temac_main.c > b/drivers/net/ethernet/xilinx/ll_temac_main.c > index 1444b855e7aa..9df39cf8b097 100644 > --- a/drivers/net/ethernet/xilinx/ll_temac_main.c > +++ b/drivers/net/ethernet/xilinx/ll_temac_main.c > @@ -1626,7 +1626,7 @@ static int temac_probe(struct platform_device > *pdev) > return rc; > } > > -static int temac_remove(struct platform_device *pdev) > +static void temac_remove(struct platform_device *pdev) > { > struct net_device *ndev = platform_get_drvdata(pdev); > struct temac_local *lp = netdev_priv(ndev); > @@ -1636,7 +1636,6 @@ static int temac_remove(struct platform_device > *pdev) > if (lp->phy_node) > of_node_put(lp->phy_node); > temac_mdio_teardown(lp); > - return 0; > } > > static const struct of_device_id temac_of_match[] = { > @@ -1650,7 +1649,7 @@ MODULE_DEVICE_TABLE(of, temac_of_match); > > static struct platform_driver temac_driver = { > .probe = temac_probe, > - .remove = temac_remove, > + .remove_new = temac_remove, > .driver = { > .name = "xilinx_temac", > .of_match_table = temac_of_match, > diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > index b7ec4dafae90..82d0d44b2b02 100644 > --- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > +++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > @@ -2183,7 +2183,7 @@ static int axienet_probe(struct platform_device > *pdev) > return ret; > } > > -static int axienet_remove(struct platform_device *pdev) > +static void axienet_remove(struct platform_device *pdev) > { > struct net_device *ndev = platform_get_drvdata(pdev); > struct axienet_local *lp = netdev_priv(ndev); > @@ -2202,8 +2202,6 @@ static int axienet_remove(struct platform_device > *pdev) > clk_disable_unprepare(lp->axi_clk); > > free_netdev(ndev); > - > - return 0; > } > > static void axienet_shutdown(struct platform_device *pdev) > @@ -2256,7 +2254,7 @@ static > DEFINE_SIMPLE_DEV_PM_OPS(axienet_pm_ops, > > static struct platform_driver axienet_driver = { > .probe = axienet_probe, > - .remove = axienet_remove, > + .remove_new = axienet_remove, > .shutdown = axienet_shutdown, > .driver = { > .name = "xilinx_axienet", > diff --git a/drivers/net/ethernet/xilinx/xilinx_emaclite.c > b/drivers/net/ethernet/xilinx/xilinx_emaclite.c > index b358ecc67227..32a502e7318b 100644 > --- a/drivers/net/ethernet/xilinx/xilinx_emaclite.c > +++ b/drivers/net/ethernet/xilinx/xilinx_emaclite.c > @@ -1183,7 +1183,7 @@ static int xemaclite_of_probe(struct > platform_device *ofdev) > * > * Return: 0, always. > */ Nit - kernel-doc return documentation needs to be updated. > -static int xemaclite_of_remove(struct platform_device *of_dev) > +static void xemaclite_of_remove(struct platform_device *of_dev) > { > struct net_device *ndev = platform_get_drvdata(of_dev); > > @@ -1202,8 +1202,6 @@ static int xemaclite_of_remove(struct > platform_device *of_dev) > lp->phy_node = NULL; > > free_netdev(ndev); > - > - return 0; > } > > #ifdef CONFIG_NET_POLL_CONTROLLER > @@ -1262,7 +1260,7 @@ static struct platform_driver xemaclite_of_driver = > { > .of_match_table = xemaclite_of_match, > }, > .probe = xemaclite_of_probe, > - .remove = xemaclite_of_remove, > + .remove_new = xemaclite_of_remove, > }; > > module_platform_driver(xemaclite_of_driver); > -- > 2.40.1
Hello, [dropped Bhupesh Sharma from the list of recipents, usage of their email address resulted in a bounce.] On Tue, Sep 19, 2023 at 04:45:04AM +0000, Pandey, Radhey Shyam wrote: > > -----Original Message----- > > From: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > > Sent: Tuesday, September 19, 2023 2:12 AM > > To: David S. Miller <davem@davemloft.net>; Eric Dumazet > > <edumazet@google.com>; Jakub Kicinski <kuba@kernel.org>; Paolo Abeni > > <pabeni@redhat.com> > > Cc: Simek, Michal <michal.simek@amd.com>; Pandey, Radhey Shyam > > <radhey.shyam.pandey@amd.com>; Katakam, Harini > > <harini.katakam@amd.com>; Haoyue Xu <xuhaoyue1@hisilicon.com>; > > huangjunxian <huangjunxian6@hisilicon.com>; Rob Herring > > <robh@kernel.org>; Yang Yingliang <yangyingliang@huawei.com>; Dan > > Carpenter <dan.carpenter@linaro.org>; Bhupesh Sharma > > <bhupesh.sharma@linaro.org>; Simon Horman <horms@kernel.org>; Alex > > Elder <elder@linaro.org>; Wei Fang <wei.fang@nxp.com>; > > netdev@vger.kernel.org; linux-arm-kernel@lists.infradead.org; > > kernel@pengutronix.de > > Subject: [PATCH net-next 53/54] net: ethernet: xilinx: Convert to platform > > remove callback returning void > > > > The .remove() callback for a platform driver returns an int which makes > > many driver authors wrongly assume it's possible to do error handling by > > returning an error code. However the value returned is ignored (apart > > from emitting a warning) and this typically results in resource leaks. > > To improve here there is a quest to make the remove callback return > > void. In the first step of this quest all drivers are converted to > > .remove_new() which already returns void. Eventually after all drivers > > are converted, .remove_new() is renamed to .remove(). > > > > Trivially convert these drivers from always returning zero in the remove > > callback to the void returning variant. > > > > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > > --- > > drivers/net/ethernet/xilinx/ll_temac_main.c | 5 ++--- > > drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 6 ++---- > > drivers/net/ethernet/xilinx/xilinx_emaclite.c | 6 ++---- > > 3 files changed, 6 insertions(+), 11 deletions(-) > > > > diff --git a/drivers/net/ethernet/xilinx/ll_temac_main.c > > b/drivers/net/ethernet/xilinx/ll_temac_main.c > > index 1444b855e7aa..9df39cf8b097 100644 > > --- a/drivers/net/ethernet/xilinx/ll_temac_main.c > > +++ b/drivers/net/ethernet/xilinx/ll_temac_main.c > > @@ -1626,7 +1626,7 @@ static int temac_probe(struct platform_device > > *pdev) > > return rc; > > } > > > > -static int temac_remove(struct platform_device *pdev) > > +static void temac_remove(struct platform_device *pdev) > > { > > struct net_device *ndev = platform_get_drvdata(pdev); > > struct temac_local *lp = netdev_priv(ndev); > > @@ -1636,7 +1636,6 @@ static int temac_remove(struct platform_device > > *pdev) > > if (lp->phy_node) > > of_node_put(lp->phy_node); > > temac_mdio_teardown(lp); > > - return 0; > > } > > > > static const struct of_device_id temac_of_match[] = { > > @@ -1650,7 +1649,7 @@ MODULE_DEVICE_TABLE(of, temac_of_match); > > > > static struct platform_driver temac_driver = { > > .probe = temac_probe, > > - .remove = temac_remove, > > + .remove_new = temac_remove, > > .driver = { > > .name = "xilinx_temac", > > .of_match_table = temac_of_match, > > diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > > b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > > index b7ec4dafae90..82d0d44b2b02 100644 > > --- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > > +++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c > > @@ -2183,7 +2183,7 @@ static int axienet_probe(struct platform_device > > *pdev) > > return ret; > > } > > > > -static int axienet_remove(struct platform_device *pdev) > > +static void axienet_remove(struct platform_device *pdev) > > { > > struct net_device *ndev = platform_get_drvdata(pdev); > > struct axienet_local *lp = netdev_priv(ndev); > > @@ -2202,8 +2202,6 @@ static int axienet_remove(struct platform_device > > *pdev) > > clk_disable_unprepare(lp->axi_clk); > > > > free_netdev(ndev); > > - > > - return 0; > > } > > > > static void axienet_shutdown(struct platform_device *pdev) > > @@ -2256,7 +2254,7 @@ static > > DEFINE_SIMPLE_DEV_PM_OPS(axienet_pm_ops, > > > > static struct platform_driver axienet_driver = { > > .probe = axienet_probe, > > - .remove = axienet_remove, > > + .remove_new = axienet_remove, > > .shutdown = axienet_shutdown, > > .driver = { > > .name = "xilinx_axienet", > > diff --git a/drivers/net/ethernet/xilinx/xilinx_emaclite.c > > b/drivers/net/ethernet/xilinx/xilinx_emaclite.c > > index b358ecc67227..32a502e7318b 100644 > > --- a/drivers/net/ethernet/xilinx/xilinx_emaclite.c > > +++ b/drivers/net/ethernet/xilinx/xilinx_emaclite.c > > @@ -1183,7 +1183,7 @@ static int xemaclite_of_probe(struct > > platform_device *ofdev) > > * > > * Return: 0, always. > > */ > > Nit - kernel-doc return documentation needs to be updated. Indeed, I fixed that in my tree and so it will be addressed if and when I resend this patch. Thanks Uwe
diff --git a/drivers/net/ethernet/xilinx/ll_temac_main.c b/drivers/net/ethernet/xilinx/ll_temac_main.c index 1444b855e7aa..9df39cf8b097 100644 --- a/drivers/net/ethernet/xilinx/ll_temac_main.c +++ b/drivers/net/ethernet/xilinx/ll_temac_main.c @@ -1626,7 +1626,7 @@ static int temac_probe(struct platform_device *pdev) return rc; } -static int temac_remove(struct platform_device *pdev) +static void temac_remove(struct platform_device *pdev) { struct net_device *ndev = platform_get_drvdata(pdev); struct temac_local *lp = netdev_priv(ndev); @@ -1636,7 +1636,6 @@ static int temac_remove(struct platform_device *pdev) if (lp->phy_node) of_node_put(lp->phy_node); temac_mdio_teardown(lp); - return 0; } static const struct of_device_id temac_of_match[] = { @@ -1650,7 +1649,7 @@ MODULE_DEVICE_TABLE(of, temac_of_match); static struct platform_driver temac_driver = { .probe = temac_probe, - .remove = temac_remove, + .remove_new = temac_remove, .driver = { .name = "xilinx_temac", .of_match_table = temac_of_match, diff --git a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c index b7ec4dafae90..82d0d44b2b02 100644 --- a/drivers/net/ethernet/xilinx/xilinx_axienet_main.c +++ b/drivers/net/ethernet/xilinx/xilinx_axienet_main.c @@ -2183,7 +2183,7 @@ static int axienet_probe(struct platform_device *pdev) return ret; } -static int axienet_remove(struct platform_device *pdev) +static void axienet_remove(struct platform_device *pdev) { struct net_device *ndev = platform_get_drvdata(pdev); struct axienet_local *lp = netdev_priv(ndev); @@ -2202,8 +2202,6 @@ static int axienet_remove(struct platform_device *pdev) clk_disable_unprepare(lp->axi_clk); free_netdev(ndev); - - return 0; } static void axienet_shutdown(struct platform_device *pdev) @@ -2256,7 +2254,7 @@ static DEFINE_SIMPLE_DEV_PM_OPS(axienet_pm_ops, static struct platform_driver axienet_driver = { .probe = axienet_probe, - .remove = axienet_remove, + .remove_new = axienet_remove, .shutdown = axienet_shutdown, .driver = { .name = "xilinx_axienet", diff --git a/drivers/net/ethernet/xilinx/xilinx_emaclite.c b/drivers/net/ethernet/xilinx/xilinx_emaclite.c index b358ecc67227..32a502e7318b 100644 --- a/drivers/net/ethernet/xilinx/xilinx_emaclite.c +++ b/drivers/net/ethernet/xilinx/xilinx_emaclite.c @@ -1183,7 +1183,7 @@ static int xemaclite_of_probe(struct platform_device *ofdev) * * Return: 0, always. */ -static int xemaclite_of_remove(struct platform_device *of_dev) +static void xemaclite_of_remove(struct platform_device *of_dev) { struct net_device *ndev = platform_get_drvdata(of_dev); @@ -1202,8 +1202,6 @@ static int xemaclite_of_remove(struct platform_device *of_dev) lp->phy_node = NULL; free_netdev(ndev); - - return 0; } #ifdef CONFIG_NET_POLL_CONTROLLER @@ -1262,7 +1260,7 @@ static struct platform_driver xemaclite_of_driver = { .of_match_table = xemaclite_of_match, }, .probe = xemaclite_of_probe, - .remove = xemaclite_of_remove, + .remove_new = xemaclite_of_remove, }; module_platform_driver(xemaclite_of_driver);
The .remove() callback for a platform driver returns an int which makes many driver authors wrongly assume it's possible to do error handling by returning an error code. However the value returned is ignored (apart from emitting a warning) and this typically results in resource leaks. To improve here there is a quest to make the remove callback return void. In the first step of this quest all drivers are converted to .remove_new() which already returns void. Eventually after all drivers are converted, .remove_new() is renamed to .remove(). Trivially convert these drivers from always returning zero in the remove callback to the void returning variant. Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> --- drivers/net/ethernet/xilinx/ll_temac_main.c | 5 ++--- drivers/net/ethernet/xilinx/xilinx_axienet_main.c | 6 ++---- drivers/net/ethernet/xilinx/xilinx_emaclite.c | 6 ++---- 3 files changed, 6 insertions(+), 11 deletions(-)