diff mbox series

[05/14] power: reset: at91-poweroff: Convert to platform remove callback returning void

Message ID 20231104211501.3676352-21-u.kleine-koenig@pengutronix.de
State Accepted
Commit a31438ece3ec27057c77822b0b0bc0614798c425
Headers show
Series power: reset: Drop platform_driver_probe() and convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König Nov. 4, 2023, 9:15 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() will be 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/power/reset/at91-poweroff.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

Comments

Claudiu Nov. 8, 2023, 6:55 a.m. UTC | #1
On 04.11.2023 23:15, 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() will be 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>

Reviewed-by: Claudiu Beznea <claudiu.beznea@tuxon.dev>


> ---
>  drivers/power/reset/at91-poweroff.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/power/reset/at91-poweroff.c b/drivers/power/reset/at91-poweroff.c
> index 83567428ab43..126e774e210c 100644
> --- a/drivers/power/reset/at91-poweroff.c
> +++ b/drivers/power/reset/at91-poweroff.c
> @@ -202,7 +202,7 @@ static int at91_poweroff_probe(struct platform_device *pdev)
>  	return ret;
>  }
>  
> -static int at91_poweroff_remove(struct platform_device *pdev)
> +static void at91_poweroff_remove(struct platform_device *pdev)
>  {
>  	if (pm_power_off == at91_poweroff)
>  		pm_power_off = NULL;
> @@ -211,8 +211,6 @@ static int at91_poweroff_remove(struct platform_device *pdev)
>  		iounmap(at91_shdwc.mpddrc_base);
>  
>  	clk_disable_unprepare(at91_shdwc.sclk);
> -
> -	return 0;
>  }
>  
>  static const struct of_device_id at91_poweroff_of_match[] = {
> @@ -225,7 +223,7 @@ MODULE_DEVICE_TABLE(of, at91_poweroff_of_match);
>  
>  static struct platform_driver at91_poweroff_driver = {
>  	.probe = at91_poweroff_probe,
> -	.remove = at91_poweroff_remove,
> +	.remove_new = at91_poweroff_remove,
>  	.driver = {
>  		.name = "at91-poweroff",
>  		.of_match_table = at91_poweroff_of_match,
diff mbox series

Patch

diff --git a/drivers/power/reset/at91-poweroff.c b/drivers/power/reset/at91-poweroff.c
index 83567428ab43..126e774e210c 100644
--- a/drivers/power/reset/at91-poweroff.c
+++ b/drivers/power/reset/at91-poweroff.c
@@ -202,7 +202,7 @@  static int at91_poweroff_probe(struct platform_device *pdev)
 	return ret;
 }
 
-static int at91_poweroff_remove(struct platform_device *pdev)
+static void at91_poweroff_remove(struct platform_device *pdev)
 {
 	if (pm_power_off == at91_poweroff)
 		pm_power_off = NULL;
@@ -211,8 +211,6 @@  static int at91_poweroff_remove(struct platform_device *pdev)
 		iounmap(at91_shdwc.mpddrc_base);
 
 	clk_disable_unprepare(at91_shdwc.sclk);
-
-	return 0;
 }
 
 static const struct of_device_id at91_poweroff_of_match[] = {
@@ -225,7 +223,7 @@  MODULE_DEVICE_TABLE(of, at91_poweroff_of_match);
 
 static struct platform_driver at91_poweroff_driver = {
 	.probe = at91_poweroff_probe,
-	.remove = at91_poweroff_remove,
+	.remove_new = at91_poweroff_remove,
 	.driver = {
 		.name = "at91-poweroff",
 		.of_match_table = at91_poweroff_of_match,