[PATCH 40/40] soc/xilinx: zynqmp_power: Convert to platform remove callback returning void

Uwe Kleine-König posted 40 patches 1 year, 1 month ago
[PATCH 40/40] soc/xilinx: zynqmp_power: Convert to platform remove callback returning void
Posted by Uwe Kleine-König 1 year, 1 month 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/soc/xilinx/zynqmp_power.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/soc/xilinx/zynqmp_power.c b/drivers/soc/xilinx/zynqmp_power.c
index c2c819701eec..9d27f850f491 100644
--- a/drivers/soc/xilinx/zynqmp_power.c
+++ b/drivers/soc/xilinx/zynqmp_power.c
@@ -275,7 +275,7 @@ static int zynqmp_pm_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int zynqmp_pm_remove(struct platform_device *pdev)
+static void zynqmp_pm_remove(struct platform_device *pdev)
 {
 	sysfs_remove_file(&pdev->dev.kobj, &dev_attr_suspend_mode.attr);
 	if (event_registered)
@@ -283,8 +283,6 @@ static int zynqmp_pm_remove(struct platform_device *pdev)
 
 	if (!rx_chan)
 		mbox_free_channel(rx_chan);
-
-	return 0;
 }
 
 static const struct of_device_id pm_of_match[] = {
@@ -295,7 +293,7 @@ MODULE_DEVICE_TABLE(of, pm_of_match);
 
 static struct platform_driver zynqmp_pm_platform_driver = {
 	.probe = zynqmp_pm_probe,
-	.remove = zynqmp_pm_remove,
+	.remove_new = zynqmp_pm_remove,
 	.driver = {
 		.name = "zynqmp_power",
 		.of_match_table = pm_of_match,
-- 
2.40.1

Re: [PATCH 40/40] soc/xilinx: zynqmp_power: Convert to platform remove callback returning void
Posted by Michal Simek 1 year, 1 month ago

On 9/25/23 11:55, 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 <u.kleine-koenig@pengutronix.de>
> ---
>   drivers/soc/xilinx/zynqmp_power.c | 6 ++----
>   1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/soc/xilinx/zynqmp_power.c b/drivers/soc/xilinx/zynqmp_power.c
> index c2c819701eec..9d27f850f491 100644
> --- a/drivers/soc/xilinx/zynqmp_power.c
> +++ b/drivers/soc/xilinx/zynqmp_power.c
> @@ -275,7 +275,7 @@ static int zynqmp_pm_probe(struct platform_device *pdev)
>   	return 0;
>   }
>   
> -static int zynqmp_pm_remove(struct platform_device *pdev)
> +static void zynqmp_pm_remove(struct platform_device *pdev)
>   {
>   	sysfs_remove_file(&pdev->dev.kobj, &dev_attr_suspend_mode.attr);
>   	if (event_registered)
> @@ -283,8 +283,6 @@ static int zynqmp_pm_remove(struct platform_device *pdev)
>   
>   	if (!rx_chan)
>   		mbox_free_channel(rx_chan);
> -
> -	return 0;
>   }
>   
>   static const struct of_device_id pm_of_match[] = {
> @@ -295,7 +293,7 @@ MODULE_DEVICE_TABLE(of, pm_of_match);
>   
>   static struct platform_driver zynqmp_pm_platform_driver = {
>   	.probe = zynqmp_pm_probe,
> -	.remove = zynqmp_pm_remove,
> +	.remove_new = zynqmp_pm_remove,
>   	.driver = {
>   		.name = "zynqmp_power",
>   		.of_match_table = pm_of_match,

Applied only this patch.
Thanks,
Michal