2023-10-20 07:58:18

by Uwe Kleine-König

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

diff --git a/drivers/crypto/amlogic/amlogic-gxl-core.c b/drivers/crypto/amlogic/amlogic-gxl-core.c
index da6dfe0f9ac3..f54ab0d0b1e8 100644
--- a/drivers/crypto/amlogic/amlogic-gxl-core.c
+++ b/drivers/crypto/amlogic/amlogic-gxl-core.c
@@ -299,7 +299,7 @@ static int meson_crypto_probe(struct platform_device *pdev)
return err;
}

-static int meson_crypto_remove(struct platform_device *pdev)
+static void meson_crypto_remove(struct platform_device *pdev)
{
struct meson_dev *mc = platform_get_drvdata(pdev);

@@ -312,7 +312,6 @@ static int meson_crypto_remove(struct platform_device *pdev)
meson_free_chanlist(mc, MAXFLOW - 1);

clk_disable_unprepare(mc->busclk);
- return 0;
}

static const struct of_device_id meson_crypto_of_match_table[] = {
@@ -323,7 +322,7 @@ MODULE_DEVICE_TABLE(of, meson_crypto_of_match_table);

static struct platform_driver meson_crypto_driver = {
.probe = meson_crypto_probe,
- .remove = meson_crypto_remove,
+ .remove_new = meson_crypto_remove,
.driver = {
.name = "gxl-crypto",
.of_match_table = meson_crypto_of_match_table,
--
2.42.0


2023-10-25 13:31:19

by Corentin LABBE

[permalink] [raw]
Subject: Re: [PATCH 05/42] crypto: amlogic-gxl-core - Convert to platform remove callback returning void

Le Fri, Oct 20, 2023 at 09:55:27AM +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/amlogic/amlogic-gxl-core.c | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/crypto/amlogic/amlogic-gxl-core.c b/drivers/crypto/amlogic/amlogic-gxl-core.c
> index da6dfe0f9ac3..f54ab0d0b1e8 100644
> --- a/drivers/crypto/amlogic/amlogic-gxl-core.c
> +++ b/drivers/crypto/amlogic/amlogic-gxl-core.c
> @@ -299,7 +299,7 @@ static int meson_crypto_probe(struct platform_device *pdev)
> return err;
> }
>
> -static int meson_crypto_remove(struct platform_device *pdev)
> +static void meson_crypto_remove(struct platform_device *pdev)
> {
> struct meson_dev *mc = platform_get_drvdata(pdev);
>
> @@ -312,7 +312,6 @@ static int meson_crypto_remove(struct platform_device *pdev)
> meson_free_chanlist(mc, MAXFLOW - 1);
>
> clk_disable_unprepare(mc->busclk);
> - return 0;
> }
>
> static const struct of_device_id meson_crypto_of_match_table[] = {
> @@ -323,7 +322,7 @@ MODULE_DEVICE_TABLE(of, meson_crypto_of_match_table);
>
> static struct platform_driver meson_crypto_driver = {
> .probe = meson_crypto_probe,
> - .remove = meson_crypto_remove,
> + .remove_new = meson_crypto_remove,
> .driver = {
> .name = "gxl-crypto",
> .of_match_table = meson_crypto_of_match_table,
> --
> 2.42.0
>

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

Thanks