diff mbox series

[16/97] usb: dwc3-keystone: Convert to platform remove callback returning void

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

Commit Message

Uwe Kleine-König May 17, 2023, 11:01 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/dwc3/dwc3-keystone.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Thinh Nguyen May 23, 2023, 12:21 a.m. UTC | #1
On Thu, May 18, 2023, 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>
> ---
>  drivers/usb/dwc3/dwc3-keystone.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/usb/dwc3/dwc3-keystone.c b/drivers/usb/dwc3/dwc3-keystone.c
> index 1317959294e6..0a09aedc2573 100644
> --- a/drivers/usb/dwc3/dwc3-keystone.c
> +++ b/drivers/usb/dwc3/dwc3-keystone.c
> @@ -181,7 +181,7 @@ static int kdwc3_remove_core(struct device *dev, void *c)
>  	return 0;
>  }
>  
> -static int kdwc3_remove(struct platform_device *pdev)
> +static void kdwc3_remove(struct platform_device *pdev)
>  {
>  	struct dwc3_keystone *kdwc = platform_get_drvdata(pdev);
>  	struct device_node *node = pdev->dev.of_node;
> @@ -198,8 +198,6 @@ static int kdwc3_remove(struct platform_device *pdev)
>  	phy_pm_runtime_put_sync(kdwc->usb3_phy);
>  
>  	platform_set_drvdata(pdev, NULL);
> -
> -	return 0;
>  }
>  
>  static const struct of_device_id kdwc3_of_match[] = {
> @@ -211,7 +209,7 @@ MODULE_DEVICE_TABLE(of, kdwc3_of_match);
>  
>  static struct platform_driver kdwc3_driver = {
>  	.probe		= kdwc3_probe,
> -	.remove		= kdwc3_remove,
> +	.remove_new	= kdwc3_remove,
>  	.driver		= {
>  		.name	= "keystone-dwc3",
>  		.of_match_table	= kdwc3_of_match,
> -- 
> 2.39.2
> 

Acked-by: Thinh Nguyen <Thinh.Nguyen@synopsys.com>

Thanks,
Thinh
diff mbox series

Patch

diff --git a/drivers/usb/dwc3/dwc3-keystone.c b/drivers/usb/dwc3/dwc3-keystone.c
index 1317959294e6..0a09aedc2573 100644
--- a/drivers/usb/dwc3/dwc3-keystone.c
+++ b/drivers/usb/dwc3/dwc3-keystone.c
@@ -181,7 +181,7 @@  static int kdwc3_remove_core(struct device *dev, void *c)
 	return 0;
 }
 
-static int kdwc3_remove(struct platform_device *pdev)
+static void kdwc3_remove(struct platform_device *pdev)
 {
 	struct dwc3_keystone *kdwc = platform_get_drvdata(pdev);
 	struct device_node *node = pdev->dev.of_node;
@@ -198,8 +198,6 @@  static int kdwc3_remove(struct platform_device *pdev)
 	phy_pm_runtime_put_sync(kdwc->usb3_phy);
 
 	platform_set_drvdata(pdev, NULL);
-
-	return 0;
 }
 
 static const struct of_device_id kdwc3_of_match[] = {
@@ -211,7 +209,7 @@  MODULE_DEVICE_TABLE(of, kdwc3_of_match);
 
 static struct platform_driver kdwc3_driver = {
 	.probe		= kdwc3_probe,
-	.remove		= kdwc3_remove,
+	.remove_new	= kdwc3_remove,
 	.driver		= {
 		.name	= "keystone-dwc3",
 		.of_match_table	= kdwc3_of_match,