diff mbox series

[95/97] usb: typec: wcove: Convert to platform remove callback returning void

Message ID 20230517230239.187727-96-u.kleine-koenig@pengutronix.de (mailing list archive)
State Accepted
Commit 72d70bf73cfc616ad5f439f57b215cbbe69ec3e0
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/wcove.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Guenter Roeck May 18, 2023, 12:29 p.m. UTC | #1
On Thu, May 18, 2023 at 01:02:37AM +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/wcove.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/usb/typec/tcpm/wcove.c b/drivers/usb/typec/tcpm/wcove.c
> index 20917d85d6f4..87d4abde0ea2 100644
> --- a/drivers/usb/typec/tcpm/wcove.c
> +++ b/drivers/usb/typec/tcpm/wcove.c
> @@ -671,7 +671,7 @@ static int wcove_typec_probe(struct platform_device *pdev)
>  	return 0;
>  }
>  
> -static int wcove_typec_remove(struct platform_device *pdev)
> +static void wcove_typec_remove(struct platform_device *pdev)
>  {
>  	struct wcove_typec *wcove = platform_get_drvdata(pdev);
>  	unsigned int val;
> @@ -684,8 +684,6 @@ static int wcove_typec_remove(struct platform_device *pdev)
>  
>  	tcpm_unregister_port(wcove->tcpm);
>  	fwnode_remove_software_node(wcove->tcpc.fwnode);
> -
> -	return 0;
>  }
>  
>  static struct platform_driver wcove_typec_driver = {
> @@ -693,7 +691,7 @@ static struct platform_driver wcove_typec_driver = {
>  		.name		= "bxt_wcove_usbc",
>  	},
>  	.probe			= wcove_typec_probe,
> -	.remove			= wcove_typec_remove,
> +	.remove_new		= wcove_typec_remove,
>  };
>  
>  module_platform_driver(wcove_typec_driver);
> -- 
> 2.39.2
>
Heikki Krogerus May 19, 2023, 8:17 a.m. UTC | #2
On Thu, May 18, 2023 at 01:02:37AM +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/wcove.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/usb/typec/tcpm/wcove.c b/drivers/usb/typec/tcpm/wcove.c
> index 20917d85d6f4..87d4abde0ea2 100644
> --- a/drivers/usb/typec/tcpm/wcove.c
> +++ b/drivers/usb/typec/tcpm/wcove.c
> @@ -671,7 +671,7 @@ static int wcove_typec_probe(struct platform_device *pdev)
>  	return 0;
>  }
>  
> -static int wcove_typec_remove(struct platform_device *pdev)
> +static void wcove_typec_remove(struct platform_device *pdev)
>  {
>  	struct wcove_typec *wcove = platform_get_drvdata(pdev);
>  	unsigned int val;
> @@ -684,8 +684,6 @@ static int wcove_typec_remove(struct platform_device *pdev)
>  
>  	tcpm_unregister_port(wcove->tcpm);
>  	fwnode_remove_software_node(wcove->tcpc.fwnode);
> -
> -	return 0;
>  }
>  
>  static struct platform_driver wcove_typec_driver = {
> @@ -693,7 +691,7 @@ static struct platform_driver wcove_typec_driver = {
>  		.name		= "bxt_wcove_usbc",
>  	},
>  	.probe			= wcove_typec_probe,
> -	.remove			= wcove_typec_remove,
> +	.remove_new		= wcove_typec_remove,
>  };
>  
>  module_platform_driver(wcove_typec_driver);
> -- 
> 2.39.2
diff mbox series

Patch

diff --git a/drivers/usb/typec/tcpm/wcove.c b/drivers/usb/typec/tcpm/wcove.c
index 20917d85d6f4..87d4abde0ea2 100644
--- a/drivers/usb/typec/tcpm/wcove.c
+++ b/drivers/usb/typec/tcpm/wcove.c
@@ -671,7 +671,7 @@  static int wcove_typec_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int wcove_typec_remove(struct platform_device *pdev)
+static void wcove_typec_remove(struct platform_device *pdev)
 {
 	struct wcove_typec *wcove = platform_get_drvdata(pdev);
 	unsigned int val;
@@ -684,8 +684,6 @@  static int wcove_typec_remove(struct platform_device *pdev)
 
 	tcpm_unregister_port(wcove->tcpm);
 	fwnode_remove_software_node(wcove->tcpc.fwnode);
-
-	return 0;
 }
 
 static struct platform_driver wcove_typec_driver = {
@@ -693,7 +691,7 @@  static struct platform_driver wcove_typec_driver = {
 		.name		= "bxt_wcove_usbc",
 	},
 	.probe			= wcove_typec_probe,
-	.remove			= wcove_typec_remove,
+	.remove_new		= wcove_typec_remove,
 };
 
 module_platform_driver(wcove_typec_driver);