[PATCH net-next 53/54] net: ethernet: xilinx: Convert to platform remove callback returning void

[Pandey, Radhey Shyam]

> -----Original Message-----
> From: Uwe Kleine-König <u.kleine-koenig at pengutronix.de>
> Sent: Tuesday, September 19, 2023 2:12 AM
> To: David S. Miller <davem at davemloft.net>; Eric Dumazet
> <edumazet at google.com>; Jakub Kicinski <kuba at kernel.org>; Paolo Abeni
> <pabeni at redhat.com>
> Cc: Simek, Michal <michal.simek at amd.com>; Pandey, Radhey Shyam
> <radhey.shyam.pandey at amd.com>; Katakam, Harini
> <harini.katakam at amd.com>; Haoyue Xu <xuhaoyue1 at hisilicon.com>;
> huangjunxian <huangjunxian6 at hisilicon.com>; Rob Herring
> <robh at kernel.org>; Yang Yingliang <yangyingliang at huawei.com>; Dan
> Carpenter <dan.carpenter at linaro.org>; Bhupesh Sharma
> <bhupesh.sharma at linaro.org>; Simon Horman <horms at kernel.org>; Alex
> Elder <elder at linaro.org>; Wei Fang <wei.fang at nxp.com>;
> netdev at vger.kernel.org; linux-arm-kernel at lists.infradead.org;
> kernel at 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 at 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