[PATCH 07/13] irqchip/mvebu-pic: Convert to platform remove callback returning void

Uwe Kleine-König posted 13 patches 1 year, 12 months ago
[PATCH 07/13] irqchip/mvebu-pic: Convert to platform remove callback returning void
Posted by Uwe Kleine-König 1 year, 12 months ago
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/irqchip/irq-mvebu-pic.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/irqchip/irq-mvebu-pic.c b/drivers/irqchip/irq-mvebu-pic.c
index ef3d3646ccc2..57e3f99b61f5 100644
--- a/drivers/irqchip/irq-mvebu-pic.c
+++ b/drivers/irqchip/irq-mvebu-pic.c
@@ -167,14 +167,12 @@ static int mvebu_pic_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int mvebu_pic_remove(struct platform_device *pdev)
+static void mvebu_pic_remove(struct platform_device *pdev)
 {
 	struct mvebu_pic *pic = platform_get_drvdata(pdev);
 
 	on_each_cpu(mvebu_pic_disable_percpu_irq, pic, 1);
 	irq_domain_remove(pic->domain);
-
-	return 0;
 }
 
 static const struct of_device_id mvebu_pic_of_match[] = {
@@ -185,7 +183,7 @@ MODULE_DEVICE_TABLE(of, mvebu_pic_of_match);
 
 static struct platform_driver mvebu_pic_driver = {
 	.probe  = mvebu_pic_probe,
-	.remove = mvebu_pic_remove,
+	.remove_new = mvebu_pic_remove,
 	.driver = {
 		.name = "mvebu-pic",
 		.of_match_table = mvebu_pic_of_match,
-- 
2.42.0

Re: [PATCH 07/13] irqchip/mvebu-pic: Convert to platform remove callback returning void
Posted by Gregory CLEMENT 1 year, 9 months ago
Uwe Kleine-König <u.kleine-koenig@pengutronix.de> writes:

> 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>

Acked-by: Gregory CLEMENT <gregory.clement@bootlin.com>

Thanks,

Gregory
> ---
>  drivers/irqchip/irq-mvebu-pic.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/irqchip/irq-mvebu-pic.c b/drivers/irqchip/irq-mvebu-pic.c
> index ef3d3646ccc2..57e3f99b61f5 100644
> --- a/drivers/irqchip/irq-mvebu-pic.c
> +++ b/drivers/irqchip/irq-mvebu-pic.c
> @@ -167,14 +167,12 @@ static int mvebu_pic_probe(struct platform_device *pdev)
>  	return 0;
>  }
>  
> -static int mvebu_pic_remove(struct platform_device *pdev)
> +static void mvebu_pic_remove(struct platform_device *pdev)
>  {
>  	struct mvebu_pic *pic = platform_get_drvdata(pdev);
>  
>  	on_each_cpu(mvebu_pic_disable_percpu_irq, pic, 1);
>  	irq_domain_remove(pic->domain);
> -
> -	return 0;
>  }
>  
>  static const struct of_device_id mvebu_pic_of_match[] = {
> @@ -185,7 +183,7 @@ MODULE_DEVICE_TABLE(of, mvebu_pic_of_match);
>  
>  static struct platform_driver mvebu_pic_driver = {
>  	.probe  = mvebu_pic_probe,
> -	.remove = mvebu_pic_remove,
> +	.remove_new = mvebu_pic_remove,
>  	.driver = {
>  		.name = "mvebu-pic",
>  		.of_match_table = mvebu_pic_of_match,
> -- 
> 2.42.0
>

-- 
Gregory Clement, Bootlin
Embedded Linux and Kernel engineering
http://bootlin.com