[PATCH 00/31] thermal: Convert to platform remove callback returning void

[PATCH 00/31] thermal: Convert to platform remove callback returning void

[Uwe Kleine-König]

Hello,

this series converts all platform drivers below drivers/thermal to use
.remove_new(). The motivation is to get rid of an integer return code
that is (mostly) ignored by the platform driver core and error prone on
the driver side.

See commit 5c5a7680e67b ("platform: Provide a remove callback that
returns no value") for an extended explanation and the eventual goal.

There are no interdependencies between the patches. As there are still
quite a few drivers to convert, I'm happy about every patch that makes
it in. So even if there is a merge conflict with one patch until you
apply or a subject prefix is suboptimal, please apply the remainder of
this series anyhow.

Best regards
Uwe

Uwe Kleine-König (31):
  thermal: amlogic: Convert to platform remove callback returning void
  thermal: armada: Convert to platform remove callback returning void
  thermal: bcm2835: Convert to platform remove callback returning void
  thermal: ns: Convert to platform remove callback returning void
  thermal: da9062: Convert to platform remove callback returning void
  thermal: dove: Convert to platform remove callback returning void
  thermal: hisi: Convert to platform remove callback returning void
  thermal: imx8mm: Convert to platform remove callback returning void
  thermal: imx: Convert to platform remove callback returning void
  thermal: int3400: Convert to platform remove callback returning void
  thermal: int3401: Convert to platform remove callback returning void
  thermal: int3402: Convert to platform remove callback returning void
  thermal: int3403: Convert to platform remove callback returning void
  thermal: int3406: Convert to platform remove callback returning void
  thermal: k3_bandgap: Convert to platform remove callback returning void
  thermal: k3_j72xx_bandgap: Convert to platform remove callback returning void
  thermal: kirkwood: Convert to platform remove callback returning void
  thermal: lvts: Convert to platform remove callback returning void
  thermal: tsens: Convert to platform remove callback returning void
  thermal: rcar_gen3: Convert to platform remove callback returning void
  thermal: rcar: Convert to platform remove callback returning void
  thermal: rockchip: Convert to platform remove callback returning void
  thermal: rzg2l: Convert to platform remove callback returning void
  thermal: exynos_tmu: Convert to platform remove callback returning void
  thermal: spear: Convert to platform remove callback returning void
  thermal: sprd: Convert to platform remove callback returning void
  thermal: stm: Convert to platform remove callback returning void
  thermal: soctherm: Convert to platform remove callback returning void
  thermal: tegra-bpmp: Convert to platform remove callback returning void
  thermal: ti-bandgap: Convert to platform remove callback returning void
  thermal: uniphier: Convert to platform remove callback returning void

 drivers/thermal/amlogic_thermal.c                    | 12 +++++-------
 drivers/thermal/armada_thermal.c                     |  6 ++----
 drivers/thermal/broadcom/bcm2835_thermal.c           |  6 ++----
 drivers/thermal/broadcom/ns-thermal.c                |  6 ++----
 drivers/thermal/da9062-thermal.c                     |  5 ++---
 drivers/thermal/dove_thermal.c                       |  6 ++----
 drivers/thermal/hisi_thermal.c                       |  6 ++----
 drivers/thermal/imx8mm_thermal.c                     |  6 ++----
 drivers/thermal/imx_thermal.c                        |  6 ++----
 .../thermal/intel/int340x_thermal/int3400_thermal.c  |  5 ++---
 .../thermal/intel/int340x_thermal/int3401_thermal.c  |  6 ++----
 .../thermal/intel/int340x_thermal/int3402_thermal.c  |  6 ++----
 .../thermal/intel/int340x_thermal/int3403_thermal.c  |  6 ++----
 .../thermal/intel/int340x_thermal/int3406_thermal.c  |  5 ++---
 drivers/thermal/k3_bandgap.c                         |  6 ++----
 drivers/thermal/k3_j72xx_bandgap.c                   |  6 ++----
 drivers/thermal/kirkwood_thermal.c                   |  6 ++----
 drivers/thermal/mediatek/lvts_thermal.c              |  6 ++----
 drivers/thermal/qcom/tsens.c                         |  6 ++----
 drivers/thermal/rcar_gen3_thermal.c                  |  6 ++----
 drivers/thermal/rcar_thermal.c                       |  6 ++----
 drivers/thermal/rockchip_thermal.c                   |  6 ++----
 drivers/thermal/rzg2l_thermal.c                      |  6 ++----
 drivers/thermal/samsung/exynos_tmu.c                 |  6 ++----
 drivers/thermal/spear_thermal.c                      |  6 ++----
 drivers/thermal/sprd_thermal.c                       |  5 ++---
 drivers/thermal/st/stm_thermal.c                     |  6 ++----
 drivers/thermal/tegra/soctherm.c                     |  6 ++----
 drivers/thermal/tegra/tegra-bpmp-thermal.c           |  6 ++----
 drivers/thermal/ti-soc-thermal/ti-bandgap.c          |  6 ++----
 drivers/thermal/uniphier_thermal.c                   |  6 ++----
 31 files changed, 65 insertions(+), 123 deletions(-)

base-commit: 18030226a48de1fbfabf4ae16aaa2695a484254f
-- 
2.40.1

[PATCH 30/31] thermal: ti-bandgap: Convert to platform remove callback returning void

[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 <u.kleine-koenig@pengutronix.de>
---
 drivers/thermal/ti-soc-thermal/ti-bandgap.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/thermal/ti-soc-thermal/ti-bandgap.c b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
index 0c2eb9c6e58b..caadfc61be93 100644
--- a/drivers/thermal/ti-soc-thermal/ti-bandgap.c
+++ b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
@@ -1069,7 +1069,7 @@ int ti_bandgap_probe(struct platform_device *pdev)
 }
 
 static
-int ti_bandgap_remove(struct platform_device *pdev)
+void ti_bandgap_remove(struct platform_device *pdev)
 {
 	struct ti_bandgap *bgp = platform_get_drvdata(pdev);
 	int i;
@@ -1098,8 +1098,6 @@ int ti_bandgap_remove(struct platform_device *pdev)
 
 	if (TI_BANDGAP_HAS(bgp, TSHUT))
 		free_irq(gpiod_to_irq(bgp->tshut_gpiod), NULL);
-
-	return 0;
 }
 
 #ifdef CONFIG_PM_SLEEP
@@ -1283,7 +1281,7 @@ MODULE_DEVICE_TABLE(of, of_ti_bandgap_match);
 
 static struct platform_driver ti_bandgap_sensor_driver = {
 	.probe = ti_bandgap_probe,
-	.remove = ti_bandgap_remove,
+	.remove_new = ti_bandgap_remove,
 	.driver = {
 			.name = "ti-soc-thermal",
 			.pm = DEV_PM_OPS,
-- 
2.40.1

Re: [PATCH 00/31] thermal: Convert to platform remove callback returning void

[Rafael J. Wysocki]

Hi,

On Wed, Sep 27, 2023 at 9:38 PM Uwe Kleine-König
<u.kleine-koenig@pengutronix.de> wrote:
>
> Hello,
>
> this series converts all platform drivers below drivers/thermal to use
> .remove_new(). The motivation is to get rid of an integer return code
> that is (mostly) ignored by the platform driver core and error prone on
> the driver side.
>
> See commit 5c5a7680e67b ("platform: Provide a remove callback that
> returns no value") for an extended explanation and the eventual goal.
>
> There are no interdependencies between the patches. As there are still
> quite a few drivers to convert, I'm happy about every patch that makes
> it in. So even if there is a merge conflict with one patch until you
> apply or a subject prefix is suboptimal, please apply the remainder of
> this series anyhow.

I think I'll go ahead and apply all of this in one go (for 6.7).

Daniel, any objections?


> Uwe Kleine-König (31):
>   thermal: amlogic: Convert to platform remove callback returning void
>   thermal: armada: Convert to platform remove callback returning void
>   thermal: bcm2835: Convert to platform remove callback returning void
>   thermal: ns: Convert to platform remove callback returning void
>   thermal: da9062: Convert to platform remove callback returning void
>   thermal: dove: Convert to platform remove callback returning void
>   thermal: hisi: Convert to platform remove callback returning void
>   thermal: imx8mm: Convert to platform remove callback returning void
>   thermal: imx: Convert to platform remove callback returning void
>   thermal: int3400: Convert to platform remove callback returning void
>   thermal: int3401: Convert to platform remove callback returning void
>   thermal: int3402: Convert to platform remove callback returning void
>   thermal: int3403: Convert to platform remove callback returning void
>   thermal: int3406: Convert to platform remove callback returning void
>   thermal: k3_bandgap: Convert to platform remove callback returning void
>   thermal: k3_j72xx_bandgap: Convert to platform remove callback returning void
>   thermal: kirkwood: Convert to platform remove callback returning void
>   thermal: lvts: Convert to platform remove callback returning void
>   thermal: tsens: Convert to platform remove callback returning void
>   thermal: rcar_gen3: Convert to platform remove callback returning void
>   thermal: rcar: Convert to platform remove callback returning void
>   thermal: rockchip: Convert to platform remove callback returning void
>   thermal: rzg2l: Convert to platform remove callback returning void
>   thermal: exynos_tmu: Convert to platform remove callback returning void
>   thermal: spear: Convert to platform remove callback returning void
>   thermal: sprd: Convert to platform remove callback returning void
>   thermal: stm: Convert to platform remove callback returning void
>   thermal: soctherm: Convert to platform remove callback returning void
>   thermal: tegra-bpmp: Convert to platform remove callback returning void
>   thermal: ti-bandgap: Convert to platform remove callback returning void
>   thermal: uniphier: Convert to platform remove callback returning void
>
>  drivers/thermal/amlogic_thermal.c                    | 12 +++++-------
>  drivers/thermal/armada_thermal.c                     |  6 ++----
>  drivers/thermal/broadcom/bcm2835_thermal.c           |  6 ++----
>  drivers/thermal/broadcom/ns-thermal.c                |  6 ++----
>  drivers/thermal/da9062-thermal.c                     |  5 ++---
>  drivers/thermal/dove_thermal.c                       |  6 ++----
>  drivers/thermal/hisi_thermal.c                       |  6 ++----
>  drivers/thermal/imx8mm_thermal.c                     |  6 ++----
>  drivers/thermal/imx_thermal.c                        |  6 ++----
>  .../thermal/intel/int340x_thermal/int3400_thermal.c  |  5 ++---
>  .../thermal/intel/int340x_thermal/int3401_thermal.c  |  6 ++----
>  .../thermal/intel/int340x_thermal/int3402_thermal.c  |  6 ++----
>  .../thermal/intel/int340x_thermal/int3403_thermal.c  |  6 ++----
>  .../thermal/intel/int340x_thermal/int3406_thermal.c  |  5 ++---
>  drivers/thermal/k3_bandgap.c                         |  6 ++----
>  drivers/thermal/k3_j72xx_bandgap.c                   |  6 ++----
>  drivers/thermal/kirkwood_thermal.c                   |  6 ++----
>  drivers/thermal/mediatek/lvts_thermal.c              |  6 ++----
>  drivers/thermal/qcom/tsens.c                         |  6 ++----
>  drivers/thermal/rcar_gen3_thermal.c                  |  6 ++----
>  drivers/thermal/rcar_thermal.c                       |  6 ++----
>  drivers/thermal/rockchip_thermal.c                   |  6 ++----
>  drivers/thermal/rzg2l_thermal.c                      |  6 ++----
>  drivers/thermal/samsung/exynos_tmu.c                 |  6 ++----
>  drivers/thermal/spear_thermal.c                      |  6 ++----
>  drivers/thermal/sprd_thermal.c                       |  5 ++---
>  drivers/thermal/st/stm_thermal.c                     |  6 ++----
>  drivers/thermal/tegra/soctherm.c                     |  6 ++----
>  drivers/thermal/tegra/tegra-bpmp-thermal.c           |  6 ++----
>  drivers/thermal/ti-soc-thermal/ti-bandgap.c          |  6 ++----
>  drivers/thermal/uniphier_thermal.c                   |  6 ++----
>  31 files changed, 65 insertions(+), 123 deletions(-)
>
> base-commit: 18030226a48de1fbfabf4ae16aaa2695a484254f
> --
> 2.40.1
>

Re: [PATCH 00/31] thermal: Convert to platform remove callback returning void

[Daniel Lezcano]

On 27/09/2023 21:45, Rafael J. Wysocki wrote:
> Hi,
> 
> On Wed, Sep 27, 2023 at 9:38 PM Uwe Kleine-König
> <u.kleine-koenig@pengutronix.de> wrote:
>>
>> Hello,
>>
>> this series converts all platform drivers below drivers/thermal to use
>> .remove_new(). The motivation is to get rid of an integer return code
>> that is (mostly) ignored by the platform driver core and error prone on
>> the driver side.
>>
>> See commit 5c5a7680e67b ("platform: Provide a remove callback that
>> returns no value") for an extended explanation and the eventual goal.
>>
>> There are no interdependencies between the patches. As there are still
>> quite a few drivers to convert, I'm happy about every patch that makes
>> it in. So even if there is a merge conflict with one patch until you
>> apply or a subject prefix is suboptimal, please apply the remainder of
>> this series anyhow.
> 
> I think I'll go ahead and apply all of this in one go (for 6.7).
> 
> Daniel, any objections?

No objection, for the series:

Acked-by: Daniel Lezcano <daniel.lezcano@linaro.org>

-- 
<http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro:  <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog

Re: [PATCH 30/31] thermal: ti-bandgap: Convert to platform remove callback returning void

[Dhruva Gole]

On Sep 27, 2023 at 21:37:35 +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() 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/thermal/ti-soc-thermal/ti-bandgap.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/thermal/ti-soc-thermal/ti-bandgap.c b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
> index 0c2eb9c6e58b..caadfc61be93 100644
> --- a/drivers/thermal/ti-soc-thermal/ti-bandgap.c
> +++ b/drivers/thermal/ti-soc-thermal/ti-bandgap.c
> @@ -1069,7 +1069,7 @@ int ti_bandgap_probe(struct platform_device *pdev)
>  }
>  
>  static
> -int ti_bandgap_remove(struct platform_device *pdev)
> +void ti_bandgap_remove(struct platform_device *pdev)
>  {
>  	struct ti_bandgap *bgp = platform_get_drvdata(pdev);
>  	int i;
> @@ -1098,8 +1098,6 @@ int ti_bandgap_remove(struct platform_device *pdev)
>  
>  	if (TI_BANDGAP_HAS(bgp, TSHUT))
>  		free_irq(gpiod_to_irq(bgp->tshut_gpiod), NULL);
> -
> -	return 0;
>  }
>  
>  #ifdef CONFIG_PM_SLEEP
> @@ -1283,7 +1281,7 @@ MODULE_DEVICE_TABLE(of, of_ti_bandgap_match);
>  
>  static struct platform_driver ti_bandgap_sensor_driver = {
>  	.probe = ti_bandgap_probe,
> -	.remove = ti_bandgap_remove,
> +	.remove_new = ti_bandgap_remove,

LGTM,

Reviewed-by: Dhruva Gole <d-gole@ti.com>

>  	.driver = {
>  			.name = "ti-soc-thermal",
>  			.pm = DEV_PM_OPS,
> -- 
> 2.40.1
> 

-- 
Best regards,
Dhruva Gole <d-gole@ti.com>