[v2,09/61] mmc: sdhci-pic32: Convert to platform remove callback returning void

Message ID 20230726040041.26267-9-frank.li@vivo.com
State New
Headers
Series [v2,01/61] mmc: sunxi: Convert to platform remove callback returning void |

Commit Message

李扬韬 July 26, 2023, 3:59 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 (mostly) ignored
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.

Trivially convert this driver from always returning zero in the remove
callback to the void returning variant.

Cc: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
Signed-off-by: Yangtao Li <frank.li@vivo.com>
---
 drivers/mmc/host/sdhci-pic32.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)
  

Comments

Adrian Hunter July 26, 2023, 6:20 a.m. UTC | #1
On 26/07/23 06:59, Yangtao Li 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 (mostly) ignored
> 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.
> 
> Trivially convert this driver from always returning zero in the remove
> callback to the void returning variant.
> 
> Cc: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
> Signed-off-by: Yangtao Li <frank.li@vivo.com>

I already acked a number of patches:

https://lore.kernel.org/linux-mmc/af01d060-dbaa-aa54-8203-3da5fcbc0a79@intel.com/

Also there do not seem to be any changelogs?

> ---
>  drivers/mmc/host/sdhci-pic32.c | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/mmc/host/sdhci-pic32.c b/drivers/mmc/host/sdhci-pic32.c
> index 6696b6bdd88e..7a0351a9c74e 100644
> --- a/drivers/mmc/host/sdhci-pic32.c
> +++ b/drivers/mmc/host/sdhci-pic32.c
> @@ -210,7 +210,7 @@ static int pic32_sdhci_probe(struct platform_device *pdev)
>  	return ret;
>  }
>  
> -static int pic32_sdhci_remove(struct platform_device *pdev)
> +static void pic32_sdhci_remove(struct platform_device *pdev)
>  {
>  	struct sdhci_host *host = platform_get_drvdata(pdev);
>  	struct pic32_sdhci_priv *sdhci_pdata = sdhci_priv(host);
> @@ -221,8 +221,6 @@ static int pic32_sdhci_remove(struct platform_device *pdev)
>  	clk_disable_unprepare(sdhci_pdata->base_clk);
>  	clk_disable_unprepare(sdhci_pdata->sys_clk);
>  	sdhci_pltfm_free(pdev);
> -
> -	return 0;
>  }
>  
>  static const struct of_device_id pic32_sdhci_id_table[] = {
> @@ -238,7 +236,7 @@ static struct platform_driver pic32_sdhci_driver = {
>  		.of_match_table = of_match_ptr(pic32_sdhci_id_table),
>  	},
>  	.probe		= pic32_sdhci_probe,
> -	.remove		= pic32_sdhci_remove,
> +	.remove_new	= pic32_sdhci_remove,
>  };
>  
>  module_platform_driver(pic32_sdhci_driver);
  
李扬韬 July 26, 2023, 6:40 a.m. UTC | #2
On 2023/7/26 14:20, Adrian Hunter wrote:

> On 26/07/23 06:59, Yangtao Li 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 (mostly) ignored
>> 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.
>>
>> Trivially convert this driver from always returning zero in the remove
>> callback to the void returning variant.
>>
>> Cc: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
>> Signed-off-by: Yangtao Li <frank.li@vivo.com>
> I already acked a number of patches:
>
> https://lore.kernel.org/linux-mmc/af01d060-dbaa-aa54-8203-3da5fcbc0a79@intel.com/
>
> Also there do not seem to be any changelogs?


Why do I remember adding these just now, even though it was not sent out 
in the end. . .

Ulf, do I need to resend v3?


Thx,

Yangtao


>
>> ---
>>   drivers/mmc/host/sdhci-pic32.c | 6 ++----
>>   1 file changed, 2 insertions(+), 4 deletions(-)
>>
>> diff --git a/drivers/mmc/host/sdhci-pic32.c b/drivers/mmc/host/sdhci-pic32.c
>> index 6696b6bdd88e..7a0351a9c74e 100644
>> --- a/drivers/mmc/host/sdhci-pic32.c
>> +++ b/drivers/mmc/host/sdhci-pic32.c
>> @@ -210,7 +210,7 @@ static int pic32_sdhci_probe(struct platform_device *pdev)
>>   	return ret;
>>   }
>>   
>> -static int pic32_sdhci_remove(struct platform_device *pdev)
>> +static void pic32_sdhci_remove(struct platform_device *pdev)
>>   {
>>   	struct sdhci_host *host = platform_get_drvdata(pdev);
>>   	struct pic32_sdhci_priv *sdhci_pdata = sdhci_priv(host);
>> @@ -221,8 +221,6 @@ static int pic32_sdhci_remove(struct platform_device *pdev)
>>   	clk_disable_unprepare(sdhci_pdata->base_clk);
>>   	clk_disable_unprepare(sdhci_pdata->sys_clk);
>>   	sdhci_pltfm_free(pdev);
>> -
>> -	return 0;
>>   }
>>   
>>   static const struct of_device_id pic32_sdhci_id_table[] = {
>> @@ -238,7 +236,7 @@ static struct platform_driver pic32_sdhci_driver = {
>>   		.of_match_table = of_match_ptr(pic32_sdhci_id_table),
>>   	},
>>   	.probe		= pic32_sdhci_probe,
>> -	.remove		= pic32_sdhci_remove,
>> +	.remove_new	= pic32_sdhci_remove,
>>   };
>>   
>>   module_platform_driver(pic32_sdhci_driver);
  

Patch

diff --git a/drivers/mmc/host/sdhci-pic32.c b/drivers/mmc/host/sdhci-pic32.c
index 6696b6bdd88e..7a0351a9c74e 100644
--- a/drivers/mmc/host/sdhci-pic32.c
+++ b/drivers/mmc/host/sdhci-pic32.c
@@ -210,7 +210,7 @@  static int pic32_sdhci_probe(struct platform_device *pdev)
 	return ret;
 }
 
-static int pic32_sdhci_remove(struct platform_device *pdev)
+static void pic32_sdhci_remove(struct platform_device *pdev)
 {
 	struct sdhci_host *host = platform_get_drvdata(pdev);
 	struct pic32_sdhci_priv *sdhci_pdata = sdhci_priv(host);
@@ -221,8 +221,6 @@  static int pic32_sdhci_remove(struct platform_device *pdev)
 	clk_disable_unprepare(sdhci_pdata->base_clk);
 	clk_disable_unprepare(sdhci_pdata->sys_clk);
 	sdhci_pltfm_free(pdev);
-
-	return 0;
 }
 
 static const struct of_device_id pic32_sdhci_id_table[] = {
@@ -238,7 +236,7 @@  static struct platform_driver pic32_sdhci_driver = {
 		.of_match_table = of_match_ptr(pic32_sdhci_id_table),
 	},
 	.probe		= pic32_sdhci_probe,
-	.remove		= pic32_sdhci_remove,
+	.remove_new	= pic32_sdhci_remove,
 };
 
 module_platform_driver(pic32_sdhci_driver);