diff mbox series

[1/2] ALSA: pcmtest: Convert to platform remove callback returning void

Message ID 20230707075058.3402832-1-u.kleine-koenig@pengutronix.de (mailing list archive)
State Accepted
Commit cb2bffdea267efad8d03eb680890e5fa2e93411c
Headers show
Series [1/2] ALSA: pcmtest: Convert to platform remove callback returning void | expand

Commit Message

Uwe Kleine-König July 7, 2023, 7:50 a.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>
---
 sound/drivers/pcmtest.c | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)


base-commit: 5133c9e51de41bfa902153888e11add3342ede18

Comments

Ivan Orlov July 7, 2023, 1:49 p.m. UTC | #1
On 7/7/23 11:50, 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>
> ---
>   sound/drivers/pcmtest.c | 5 ++---
>   1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/sound/drivers/pcmtest.c b/sound/drivers/pcmtest.c
> index 2ae912a64d16..1fff85feaf82 100644
> --- a/sound/drivers/pcmtest.c
> +++ b/sound/drivers/pcmtest.c
> @@ -576,10 +576,9 @@ static int pcmtst_probe(struct platform_device *pdev)
>   	return 0;
>   }
>   
> -static int pdev_remove(struct platform_device *dev)
> +static void pdev_remove(struct platform_device *dev)
>   {
>   	snd_pcmtst_free(pcmtst);
> -	return 0;
>   }
>   
>   static struct platform_device pcmtst_pdev = {
> @@ -589,7 +588,7 @@ static struct platform_device pcmtst_pdev = {
>   
>   static struct platform_driver pcmtst_pdrv = {
>   	.probe =	pcmtst_probe,
> -	.remove =	pdev_remove,
> +	.remove_new =	pdev_remove,
>   	.driver =	{
>   		.name = "pcmtest",
>   	},
> 
> base-commit: 5133c9e51de41bfa902153888e11add3342ede18

Looks good to me, thanks!
Ivan Orlov July 7, 2023, 1:52 p.m. UTC | #2
On 7/7/23 11:50, 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>
> ---
>   sound/drivers/pcmtest.c | 5 ++---
>   1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/sound/drivers/pcmtest.c b/sound/drivers/pcmtest.c
> index 2ae912a64d16..1fff85feaf82 100644
> --- a/sound/drivers/pcmtest.c
> +++ b/sound/drivers/pcmtest.c
> @@ -576,10 +576,9 @@ static int pcmtst_probe(struct platform_device *pdev)
>   	return 0;
>   }
>   
> -static int pdev_remove(struct platform_device *dev)
> +static void pdev_remove(struct platform_device *dev)
>   {
>   	snd_pcmtst_free(pcmtst);
> -	return 0;
>   }
>   
>   static struct platform_device pcmtst_pdev = {
> @@ -589,7 +588,7 @@ static struct platform_device pcmtst_pdev = {
>   
>   static struct platform_driver pcmtst_pdrv = {
>   	.probe =	pcmtst_probe,
> -	.remove =	pdev_remove,
> +	.remove_new =	pdev_remove,
>   	.driver =	{
>   		.name = "pcmtest",
>   	},
> 
> base-commit: 5133c9e51de41bfa902153888e11add3342ede18

Acked-by: Ivan Orlov <ivan.orlov0322@gmail.com>
Takashi Iwai July 10, 2023, 6:55 a.m. UTC | #3
On Fri, 07 Jul 2023 09:50:57 +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>

Applied both patches now.  Thanks!


Takashi
diff mbox series

Patch

diff --git a/sound/drivers/pcmtest.c b/sound/drivers/pcmtest.c
index 2ae912a64d16..1fff85feaf82 100644
--- a/sound/drivers/pcmtest.c
+++ b/sound/drivers/pcmtest.c
@@ -576,10 +576,9 @@  static int pcmtst_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int pdev_remove(struct platform_device *dev)
+static void pdev_remove(struct platform_device *dev)
 {
 	snd_pcmtst_free(pcmtst);
-	return 0;
 }
 
 static struct platform_device pcmtst_pdev = {
@@ -589,7 +588,7 @@  static struct platform_device pcmtst_pdev = {
 
 static struct platform_driver pcmtst_pdrv = {
 	.probe =	pcmtst_probe,
-	.remove =	pdev_remove,
+	.remove_new =	pdev_remove,
 	.driver =	{
 		.name = "pcmtest",
 	},