2024-03-05 21:33:05

by Uwe Kleine-König

[permalink] [raw]
Subject: [PATCH 3/3] reset: ti-sci: Convert to platform remove callback returning void

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 <[email protected]>
---
drivers/reset/reset-ti-sci.c | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/reset/reset-ti-sci.c b/drivers/reset/reset-ti-sci.c
index cc01fa5b0bea..d384da0982fa 100644
--- a/drivers/reset/reset-ti-sci.c
+++ b/drivers/reset/reset-ti-sci.c
@@ -235,20 +235,18 @@ static int ti_sci_reset_probe(struct platform_device *pdev)
return reset_controller_register(&data->rcdev);
}

-static int ti_sci_reset_remove(struct platform_device *pdev)
+static void ti_sci_reset_remove(struct platform_device *pdev)
{
struct ti_sci_reset_data *data = platform_get_drvdata(pdev);

reset_controller_unregister(&data->rcdev);

idr_destroy(&data->idr);
-
- return 0;
}

static struct platform_driver ti_sci_reset_driver = {
.probe = ti_sci_reset_probe,
- .remove = ti_sci_reset_remove,
+ .remove_new = ti_sci_reset_remove,
.driver = {
.name = "ti-sci-reset",
.of_match_table = ti_sci_reset_of_match,
--
2.43.0



2024-03-06 20:49:48

by Nishanth Menon

[permalink] [raw]
Subject: Re: [PATCH 3/3] reset: ti-sci: Convert to platform remove callback returning void

On 22:32-20240305, 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 <[email protected]>
> ---

Thanks.

Reviewed-by: Nishanth Menon <[email protected]>

> drivers/reset/reset-ti-sci.c | 6 ++----
> 1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/reset/reset-ti-sci.c b/drivers/reset/reset-ti-sci.c
> index cc01fa5b0bea..d384da0982fa 100644
> --- a/drivers/reset/reset-ti-sci.c
> +++ b/drivers/reset/reset-ti-sci.c
> @@ -235,20 +235,18 @@ static int ti_sci_reset_probe(struct platform_device *pdev)
> return reset_controller_register(&data->rcdev);
> }
>
> -static int ti_sci_reset_remove(struct platform_device *pdev)
> +static void ti_sci_reset_remove(struct platform_device *pdev)
> {
> struct ti_sci_reset_data *data = platform_get_drvdata(pdev);
>
> reset_controller_unregister(&data->rcdev);
>
> idr_destroy(&data->idr);
> -
> - return 0;
> }
>
> static struct platform_driver ti_sci_reset_driver = {
> .probe = ti_sci_reset_probe,
> - .remove = ti_sci_reset_remove,
> + .remove_new = ti_sci_reset_remove,
> .driver = {
> .name = "ti-sci-reset",
> .of_match_table = ti_sci_reset_of_match,
> --
> 2.43.0
>

--
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3 1A34 DDB5 849D 1736 249D