2023-10-20 07:57:39

by Uwe Kleine-König

[permalink] [raw]
Subject: [PATCH 34/42] crypto: rockchip/rk3288 - 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/crypto/rockchip/rk3288_crypto.c | 5 ++---
1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/crypto/rockchip/rk3288_crypto.c b/drivers/crypto/rockchip/rk3288_crypto.c
index 77d5705a5d96..70edf40bc523 100644
--- a/drivers/crypto/rockchip/rk3288_crypto.c
+++ b/drivers/crypto/rockchip/rk3288_crypto.c
@@ -405,7 +405,7 @@ static int rk_crypto_probe(struct platform_device *pdev)
return err;
}

-static int rk_crypto_remove(struct platform_device *pdev)
+static void rk_crypto_remove(struct platform_device *pdev)
{
struct rk_crypto_info *crypto_tmp = platform_get_drvdata(pdev);
struct rk_crypto_info *first;
@@ -424,12 +424,11 @@ static int rk_crypto_remove(struct platform_device *pdev)
}
rk_crypto_pm_exit(crypto_tmp);
crypto_engine_exit(crypto_tmp->engine);
- return 0;
}

static struct platform_driver crypto_driver = {
.probe = rk_crypto_probe,
- .remove = rk_crypto_remove,
+ .remove_new = rk_crypto_remove,
.driver = {
.name = "rk3288-crypto",
.pm = &rk_crypto_pm_ops,
--
2.42.0


2023-10-20 08:14:07

by Heiko Stuebner

[permalink] [raw]
Subject: Re: [PATCH 34/42] crypto: rockchip/rk3288 - Convert to platform remove callback returning void

Am Freitag, 20. Oktober 2023, 09:55:56 CEST schrieb Uwe Kleine-K?nig:
> 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]>

Reviewed-by: Heiko Stuebner <[email protected]>


2023-10-25 13:32:09

by Corentin LABBE

[permalink] [raw]
Subject: Re: [PATCH 34/42] crypto: rockchip/rk3288 - Convert to platform remove callback returning void

Le Fri, Oct 20, 2023 at 09:55:56AM +0200, Uwe Kleine-K?nig a ?crit :
> 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/crypto/rockchip/rk3288_crypto.c | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/crypto/rockchip/rk3288_crypto.c b/drivers/crypto/rockchip/rk3288_crypto.c
> index 77d5705a5d96..70edf40bc523 100644
> --- a/drivers/crypto/rockchip/rk3288_crypto.c
> +++ b/drivers/crypto/rockchip/rk3288_crypto.c
> @@ -405,7 +405,7 @@ static int rk_crypto_probe(struct platform_device *pdev)
> return err;
> }
>
> -static int rk_crypto_remove(struct platform_device *pdev)
> +static void rk_crypto_remove(struct platform_device *pdev)
> {
> struct rk_crypto_info *crypto_tmp = platform_get_drvdata(pdev);
> struct rk_crypto_info *first;
> @@ -424,12 +424,11 @@ static int rk_crypto_remove(struct platform_device *pdev)
> }
> rk_crypto_pm_exit(crypto_tmp);
> crypto_engine_exit(crypto_tmp->engine);
> - return 0;
> }
>
> static struct platform_driver crypto_driver = {
> .probe = rk_crypto_probe,
> - .remove = rk_crypto_remove,
> + .remove_new = rk_crypto_remove,
> .driver = {
> .name = "rk3288-crypto",
> .pm = &rk_crypto_pm_ops,
> --
> 2.42.0
>

Acked-by: Corentin Labbe <[email protected]>

Thanks