[PATCH] scsi: hisi_sas: Convert to platform remove callback returning void

[PATCH] scsi: hisi_sas: 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 (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.

hisi_sas_remove() returned zero unconditionally so this was changed to
return void. Then it has the right prototype to be used directly as
remove callback for the two hisi_sas drivers.

Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de>
---
 drivers/scsi/hisi_sas/hisi_sas.h       | 2 +-
 drivers/scsi/hisi_sas/hisi_sas_main.c  | 3 +--
 drivers/scsi/hisi_sas/hisi_sas_v1_hw.c | 7 +------
 drivers/scsi/hisi_sas/hisi_sas_v2_hw.c | 7 +------
 4 files changed, 4 insertions(+), 15 deletions(-)

diff --git a/drivers/scsi/hisi_sas/hisi_sas.h b/drivers/scsi/hisi_sas/hisi_sas.h
index fb7c52c119df..9e73e9cbbcfc 100644
--- a/drivers/scsi/hisi_sas/hisi_sas.h
+++ b/drivers/scsi/hisi_sas/hisi_sas.h
@@ -642,7 +642,7 @@ extern void hisi_sas_sata_done(struct sas_task *task,
 extern int hisi_sas_get_fw_info(struct hisi_hba *hisi_hba);
 extern int hisi_sas_probe(struct platform_device *pdev,
 			  const struct hisi_sas_hw *ops);
-extern int hisi_sas_remove(struct platform_device *pdev);
+extern void hisi_sas_remove(struct platform_device *pdev);
 
 extern int hisi_sas_slave_configure(struct scsi_device *sdev);
 extern int hisi_sas_slave_alloc(struct scsi_device *sdev);
diff --git a/drivers/scsi/hisi_sas/hisi_sas_main.c b/drivers/scsi/hisi_sas/hisi_sas_main.c
index 412431c901a7..8f22ece957bd 100644
--- a/drivers/scsi/hisi_sas/hisi_sas_main.c
+++ b/drivers/scsi/hisi_sas/hisi_sas_main.c
@@ -2560,7 +2560,7 @@ int hisi_sas_probe(struct platform_device *pdev,
 }
 EXPORT_SYMBOL_GPL(hisi_sas_probe);
 
-int hisi_sas_remove(struct platform_device *pdev)
+void hisi_sas_remove(struct platform_device *pdev)
 {
 	struct sas_ha_struct *sha = platform_get_drvdata(pdev);
 	struct hisi_hba *hisi_hba = sha->lldd_ha;
@@ -2573,7 +2573,6 @@ int hisi_sas_remove(struct platform_device *pdev)
 
 	hisi_sas_free(hisi_hba);
 	scsi_host_put(shost);
-	return 0;
 }
 EXPORT_SYMBOL_GPL(hisi_sas_remove);
 
diff --git a/drivers/scsi/hisi_sas/hisi_sas_v1_hw.c b/drivers/scsi/hisi_sas/hisi_sas_v1_hw.c
index 0aa8c9c88535..94fbbceddc2e 100644
--- a/drivers/scsi/hisi_sas/hisi_sas_v1_hw.c
+++ b/drivers/scsi/hisi_sas/hisi_sas_v1_hw.c
@@ -1790,11 +1790,6 @@ static int hisi_sas_v1_probe(struct platform_device *pdev)
 	return hisi_sas_probe(pdev, &hisi_sas_v1_hw);
 }
 
-static int hisi_sas_v1_remove(struct platform_device *pdev)
-{
-	return hisi_sas_remove(pdev);
-}
-
 static const struct of_device_id sas_v1_of_match[] = {
 	{ .compatible = "hisilicon,hip05-sas-v1",},
 	{},
@@ -1810,7 +1805,7 @@ MODULE_DEVICE_TABLE(acpi, sas_v1_acpi_match);
 
 static struct platform_driver hisi_sas_v1_driver = {
 	.probe = hisi_sas_v1_probe,
-	.remove = hisi_sas_v1_remove,
+	.remove_new = hisi_sas_remove,
 	.driver = {
 		.name = DRV_NAME,
 		.of_match_table = sas_v1_of_match,
diff --git a/drivers/scsi/hisi_sas/hisi_sas_v2_hw.c b/drivers/scsi/hisi_sas/hisi_sas_v2_hw.c
index cd78e4c983aa..87d8e408ccd1 100644
--- a/drivers/scsi/hisi_sas/hisi_sas_v2_hw.c
+++ b/drivers/scsi/hisi_sas/hisi_sas_v2_hw.c
@@ -3619,11 +3619,6 @@ static int hisi_sas_v2_probe(struct platform_device *pdev)
 	return hisi_sas_probe(pdev, &hisi_sas_v2_hw);
 }
 
-static int hisi_sas_v2_remove(struct platform_device *pdev)
-{
-	return hisi_sas_remove(pdev);
-}
-
 static const struct of_device_id sas_v2_of_match[] = {
 	{ .compatible = "hisilicon,hip06-sas-v2",},
 	{ .compatible = "hisilicon,hip07-sas-v2",},
@@ -3640,7 +3635,7 @@ MODULE_DEVICE_TABLE(acpi, sas_v2_acpi_match);
 
 static struct platform_driver hisi_sas_v2_driver = {
 	.probe = hisi_sas_v2_probe,
-	.remove = hisi_sas_v2_remove,
+	.remove_new = hisi_sas_remove,
 	.driver = {
 		.name = DRV_NAME,
 		.of_match_table = sas_v2_of_match,

base-commit: ac9a78681b921877518763ba0e89202254349d1b
-- 
2.39.2

Re: [PATCH] scsi: hisi_sas: Convert to platform remove callback returning void

[Martin K. Petersen]

Uwe,

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

Applied to 6.5/scsi-staging, thanks!

-- 
Martin K. Petersen	Oracle Linux Engineering

Re: [PATCH] scsi: hisi_sas: Convert to platform remove callback returning void

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 1145 bytes --]

Hello Martin,

On Wed, May 31, 2023 at 11:08:25AM -0400, Martin K. Petersen 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.
> 
> Applied to 6.5/scsi-staging, thanks!

I don't see it there:

	$ git fetch git://git.kernel.org/pub/scm/linux/kernel/git/mkp/scsi.git refs/heads/6.5/scsi-staging
	From https://git.kernel.org/pub/scm/linux/kernel/git/mkp/scsi
	 * branch                      6.5/scsi-staging -> FETCH_HEAD

	$ git log --oneline v6.3..FETCH_HEAD --author=Uwe --grep=hisi_sas | wc -l
	0

What am I missing?

Best regards
Uwe

-- 
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH] scsi: hisi_sas: Convert to platform remove callback returning void

[Martin K. Petersen]

Uwe,

>> Applied to 6.5/scsi-staging, thanks!
>
> I don't see it there:
>
> 	$ git fetch git://git.kernel.org/pub/scm/linux/kernel/git/mkp/scsi.git refs/heads/6.5/scsi-staging
> 	From https://git.kernel.org/pub/scm/linux/kernel/git/mkp/scsi
> 	 * branch                      6.5/scsi-staging -> FETCH_HEAD
>
> 	$ git log --oneline v6.3..FETCH_HEAD --author=Uwe --grep=hisi_sas | wc -l
> 	0
>
> What am I missing?

Must have fumbled the key presses. Sorry about that! I have reapplied
the patch.

-- 
Martin K. Petersen	Oracle Linux Engineering

Re: [PATCH] scsi: hisi_sas: Convert to platform remove callback returning void

[Martin K. Petersen]

On Thu, 18 May 2023 22:20:43 +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 (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.
> 
> [...]

Applied to 6.5/scsi-queue, thanks!

[1/1] scsi: hisi_sas: Convert to platform remove callback returning void
      https://git.kernel.org/mkp/scsi/c/8cd6d0a39452

-- 
Martin K. Petersen	Oracle Linux Engineering