[PATCH] ptp: fc3: Convert to platform remove callback returning void

[PATCH] ptp: fc3: 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>
---
Hello,

note this driver is currently only available in next.

Best regards
Uwe

 drivers/ptp/ptp_fc3.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/ptp/ptp_fc3.c b/drivers/ptp/ptp_fc3.c
index 0e2286ba088a..6ef982862e27 100644
--- a/drivers/ptp/ptp_fc3.c
+++ b/drivers/ptp/ptp_fc3.c
@@ -996,13 +996,11 @@ static int idtfc3_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int idtfc3_remove(struct platform_device *pdev)
+static void idtfc3_remove(struct platform_device *pdev)
 {
 	struct idtfc3 *idtfc3 = platform_get_drvdata(pdev);
 
 	ptp_clock_unregister(idtfc3->ptp_clock);
-
-	return 0;
 }
 
 static struct platform_driver idtfc3_driver = {
@@ -1010,7 +1008,7 @@ static struct platform_driver idtfc3_driver = {
 		.name = "rc38xxx-phc",
 	},
 	.probe = idtfc3_probe,
-	.remove	= idtfc3_remove,
+	.remove_new = idtfc3_remove,
 };
 
 module_platform_driver(idtfc3_driver);

base-commit: 67908bf6954b7635d33760ff6dfc189fc26ccc89
-- 
2.43.0

Re: [PATCH] ptp: fc3: Convert to platform remove callback returning void

[Simon Horman]

On Mon, Mar 04, 2024 at 10:13:25AM +0100, 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>
> ---
> Hello,
> 
> note this driver is currently only available in next.

Reviewed-by: Simon Horman <horms@kernel.org>

Re: [PATCH] ptp: fc3: Convert to platform remove callback returning void

[patchwork-bot+netdevbpf]

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Mon,  4 Mar 2024 10:13:25 +0100 you 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().
> 
> [...]

Here is the summary with links:
  - ptp: fc3: Convert to platform remove callback returning void
    https://git.kernel.org/netdev/net-next/c/60d06425e045

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html