diff mbox series

[93/97] usb: typec: tcpci_mt6360: Convert to platform remove callback returning void

Message ID 20230517230239.187727-94-u.kleine-koenig@pengutronix.de (mailing list archive)
State Accepted
Commit 42c78cfa003dd3f6c86d9baa7f167ed085f773e7
Headers show
Series usb: Convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König May 17, 2023, 11:02 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/usb/typec/tcpm/tcpci_mt6360.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

Comments

Guenter Roeck May 18, 2023, 12:28 p.m. UTC | #1
On Thu, May 18, 2023 at 01:02:35AM +0200, Uwe Kleine-König wrote:
> 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: Guenter Roeck <linux@roeck-us.net>

> ---
>  drivers/usb/typec/tcpm/tcpci_mt6360.c | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/usb/typec/tcpm/tcpci_mt6360.c b/drivers/usb/typec/tcpm/tcpci_mt6360.c
> index 6fa8fd5c8041..02b7fd302265 100644
> --- a/drivers/usb/typec/tcpm/tcpci_mt6360.c
> +++ b/drivers/usb/typec/tcpm/tcpci_mt6360.c
> @@ -178,13 +178,12 @@ static int mt6360_tcpc_probe(struct platform_device *pdev)
>  	return 0;
>  }
>  
> -static int mt6360_tcpc_remove(struct platform_device *pdev)
> +static void mt6360_tcpc_remove(struct platform_device *pdev)
>  {
>  	struct mt6360_tcpc_info *mti = platform_get_drvdata(pdev);
>  
>  	disable_irq(mti->irq);
>  	tcpci_unregister_port(mti->tcpci);
> -	return 0;
>  }
>  
>  static int __maybe_unused mt6360_tcpc_suspend(struct device *dev)
> @@ -222,7 +221,7 @@ static struct platform_driver mt6360_tcpc_driver = {
>  		.of_match_table = mt6360_tcpc_of_id,
>  	},
>  	.probe = mt6360_tcpc_probe,
> -	.remove = mt6360_tcpc_remove,
> +	.remove_new = mt6360_tcpc_remove,
>  };
>  module_platform_driver(mt6360_tcpc_driver);
>  
> -- 
> 2.39.2
>
Heikki Krogerus May 19, 2023, 8:16 a.m. UTC | #2
On Thu, May 18, 2023 at 01:02:35AM +0200, Uwe Kleine-König wrote:
> 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: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  drivers/usb/typec/tcpm/tcpci_mt6360.c | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/usb/typec/tcpm/tcpci_mt6360.c b/drivers/usb/typec/tcpm/tcpci_mt6360.c
> index 6fa8fd5c8041..02b7fd302265 100644
> --- a/drivers/usb/typec/tcpm/tcpci_mt6360.c
> +++ b/drivers/usb/typec/tcpm/tcpci_mt6360.c
> @@ -178,13 +178,12 @@ static int mt6360_tcpc_probe(struct platform_device *pdev)
>  	return 0;
>  }
>  
> -static int mt6360_tcpc_remove(struct platform_device *pdev)
> +static void mt6360_tcpc_remove(struct platform_device *pdev)
>  {
>  	struct mt6360_tcpc_info *mti = platform_get_drvdata(pdev);
>  
>  	disable_irq(mti->irq);
>  	tcpci_unregister_port(mti->tcpci);
> -	return 0;
>  }
>  
>  static int __maybe_unused mt6360_tcpc_suspend(struct device *dev)
> @@ -222,7 +221,7 @@ static struct platform_driver mt6360_tcpc_driver = {
>  		.of_match_table = mt6360_tcpc_of_id,
>  	},
>  	.probe = mt6360_tcpc_probe,
> -	.remove = mt6360_tcpc_remove,
> +	.remove_new = mt6360_tcpc_remove,
>  };
>  module_platform_driver(mt6360_tcpc_driver);
>  
> -- 
> 2.39.2
diff mbox series

Patch

diff --git a/drivers/usb/typec/tcpm/tcpci_mt6360.c b/drivers/usb/typec/tcpm/tcpci_mt6360.c
index 6fa8fd5c8041..02b7fd302265 100644
--- a/drivers/usb/typec/tcpm/tcpci_mt6360.c
+++ b/drivers/usb/typec/tcpm/tcpci_mt6360.c
@@ -178,13 +178,12 @@  static int mt6360_tcpc_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int mt6360_tcpc_remove(struct platform_device *pdev)
+static void mt6360_tcpc_remove(struct platform_device *pdev)
 {
 	struct mt6360_tcpc_info *mti = platform_get_drvdata(pdev);
 
 	disable_irq(mti->irq);
 	tcpci_unregister_port(mti->tcpci);
-	return 0;
 }
 
 static int __maybe_unused mt6360_tcpc_suspend(struct device *dev)
@@ -222,7 +221,7 @@  static struct platform_driver mt6360_tcpc_driver = {
 		.of_match_table = mt6360_tcpc_of_id,
 	},
 	.probe = mt6360_tcpc_probe,
-	.remove = mt6360_tcpc_remove,
+	.remove_new = mt6360_tcpc_remove,
 };
 module_platform_driver(mt6360_tcpc_driver);