| Message ID | 20240306180241.83327-2-u.kleine-koenig@pengutronix.de |
|---|---|
| State | Accepted |
| Headers | show |
| Series | i2c: sprd: Convert to platform remove callback returning void | expand |
On Thu, 7 Mar 2024 at 02:02, Uwe Kleine-König <u.kleine-koenig@pengutronix.de> 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> Acked-by: Chunyan Zhang <zhang.lyra@gmail.com> Thanks, Chunyan > --- > drivers/i2c/busses/i2c-sprd.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/i2c/busses/i2c-sprd.c b/drivers/i2c/busses/i2c-sprd.c > index c52d1bec60b4..28c88901d9bc 100644 > --- a/drivers/i2c/busses/i2c-sprd.c > +++ b/drivers/i2c/busses/i2c-sprd.c > @@ -570,7 +570,7 @@ static int sprd_i2c_probe(struct platform_device *pdev) > return ret; > } > > -static int sprd_i2c_remove(struct platform_device *pdev) > +static void sprd_i2c_remove(struct platform_device *pdev) > { > struct sprd_i2c *i2c_dev = platform_get_drvdata(pdev); > int ret; > @@ -586,8 +586,6 @@ static int sprd_i2c_remove(struct platform_device *pdev) > > pm_runtime_put_noidle(i2c_dev->dev); > pm_runtime_disable(i2c_dev->dev); > - > - return 0; > } > > static int __maybe_unused sprd_i2c_suspend_noirq(struct device *dev) > @@ -645,7 +643,7 @@ MODULE_DEVICE_TABLE(of, sprd_i2c_of_match); > > static struct platform_driver sprd_i2c_driver = { > .probe = sprd_i2c_probe, > - .remove = sprd_i2c_remove, > + .remove_new = sprd_i2c_remove, > .driver = { > .name = "sprd-i2c", > .of_match_table = sprd_i2c_of_match, > > base-commit: 11afac187274a6177a7ac82997f8691c0f469e41 > -- > 2.43.0 >
Hi On Wed, 06 Mar 2024 19:02:41 +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(). > > [...] Applied to i2c/i2c-host on git://git.kernel.org/pub/scm/linux/kernel/git/andi.shyti/linux.git Thank you, Andi Patches applied =============== [1/1] i2c: sprd: Convert to platform remove callback returning void commit: 3fe30b74207a4da40064f16a02655d170978547c
diff --git a/drivers/i2c/busses/i2c-sprd.c b/drivers/i2c/busses/i2c-sprd.c index c52d1bec60b4..28c88901d9bc 100644 --- a/drivers/i2c/busses/i2c-sprd.c +++ b/drivers/i2c/busses/i2c-sprd.c @@ -570,7 +570,7 @@ static int sprd_i2c_probe(struct platform_device *pdev) return ret; } -static int sprd_i2c_remove(struct platform_device *pdev) +static void sprd_i2c_remove(struct platform_device *pdev) { struct sprd_i2c *i2c_dev = platform_get_drvdata(pdev); int ret; @@ -586,8 +586,6 @@ static int sprd_i2c_remove(struct platform_device *pdev) pm_runtime_put_noidle(i2c_dev->dev); pm_runtime_disable(i2c_dev->dev); - - return 0; } static int __maybe_unused sprd_i2c_suspend_noirq(struct device *dev) @@ -645,7 +643,7 @@ MODULE_DEVICE_TABLE(of, sprd_i2c_of_match); static struct platform_driver sprd_i2c_driver = { .probe = sprd_i2c_probe, - .remove = sprd_i2c_remove, + .remove_new = sprd_i2c_remove, .driver = { .name = "sprd-i2c", .of_match_table = sprd_i2c_of_match,
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/i2c/busses/i2c-sprd.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) base-commit: 11afac187274a6177a7ac82997f8691c0f469e41