[net-next,18/19] net: mdio: sun4i: Convert to platform remove callback returning void

Message ID 20230918195102.1302746-19-u.kleine-koenig@pengutronix.de
State New
Headers
Series net: mdio: Convert to platform remove callback returning void |

Commit Message

Uwe Kleine-König Sept. 18, 2023, 7:51 p.m. UTC
  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 this driver 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/mdio/mdio-sun4i.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
  

Comments

Jernej Škrabec Sept. 19, 2023, 5:22 p.m. UTC | #1
Dne ponedeljek, 18. september 2023 ob 21:51:01 CEST je Uwe Kleine-König 
napisal(a):
> 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 this driver 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>

Acked-by: Jernej Skrabec <jernej.skrabec@gmail.com>

Best regards,
Jernej

> ---
>  drivers/net/mdio/mdio-sun4i.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/net/mdio/mdio-sun4i.c b/drivers/net/mdio/mdio-sun4i.c
> index f798de3276dc..4511bcc73b36 100644
> --- a/drivers/net/mdio/mdio-sun4i.c
> +++ b/drivers/net/mdio/mdio-sun4i.c
> @@ -142,7 +142,7 @@ static int sun4i_mdio_probe(struct platform_device
> *pdev) return ret;
>  }
> 
> -static int sun4i_mdio_remove(struct platform_device *pdev)
> +static void sun4i_mdio_remove(struct platform_device *pdev)
>  {
>  	struct mii_bus *bus = platform_get_drvdata(pdev);
>  	struct sun4i_mdio_data *data = bus->priv;
> @@ -151,8 +151,6 @@ static int sun4i_mdio_remove(struct platform_device
> *pdev) if (data->regulator)
>  		regulator_disable(data->regulator);
>  	mdiobus_free(bus);
> -
> -	return 0;
>  }
> 
>  static const struct of_device_id sun4i_mdio_dt_ids[] = {
> @@ -166,7 +164,7 @@ MODULE_DEVICE_TABLE(of, sun4i_mdio_dt_ids);
> 
>  static struct platform_driver sun4i_mdio_driver = {
>  	.probe = sun4i_mdio_probe,
> -	.remove = sun4i_mdio_remove,
> +	.remove_new = sun4i_mdio_remove,
>  	.driver = {
>  		.name = "sun4i-mdio",
>  		.of_match_table = sun4i_mdio_dt_ids,
  

Patch

diff --git a/drivers/net/mdio/mdio-sun4i.c b/drivers/net/mdio/mdio-sun4i.c
index f798de3276dc..4511bcc73b36 100644
--- a/drivers/net/mdio/mdio-sun4i.c
+++ b/drivers/net/mdio/mdio-sun4i.c
@@ -142,7 +142,7 @@  static int sun4i_mdio_probe(struct platform_device *pdev)
 	return ret;
 }
 
-static int sun4i_mdio_remove(struct platform_device *pdev)
+static void sun4i_mdio_remove(struct platform_device *pdev)
 {
 	struct mii_bus *bus = platform_get_drvdata(pdev);
 	struct sun4i_mdio_data *data = bus->priv;
@@ -151,8 +151,6 @@  static int sun4i_mdio_remove(struct platform_device *pdev)
 	if (data->regulator)
 		regulator_disable(data->regulator);
 	mdiobus_free(bus);
-
-	return 0;
 }
 
 static const struct of_device_id sun4i_mdio_dt_ids[] = {
@@ -166,7 +164,7 @@  MODULE_DEVICE_TABLE(of, sun4i_mdio_dt_ids);
 
 static struct platform_driver sun4i_mdio_driver = {
 	.probe = sun4i_mdio_probe,
-	.remove = sun4i_mdio_remove,
+	.remove_new = sun4i_mdio_remove,
 	.driver = {
 		.name = "sun4i-mdio",
 		.of_match_table = sun4i_mdio_dt_ids,