| Message ID | 20230517230239.187727-91-u.kleine-koenig@pengutronix.de (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 08cfceeeea1eebfe70b02d8f411398347a9a711d |
| Headers | show |
| Series | usb: Convert to platform remove callback returning void | expand |
On Thu, May 18, 2023 at 01:02:32AM +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() is > 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: Heikki Krogerus <heikki.krogerus@linux.intel.com> > --- > drivers/usb/typec/mux/gpio-sbu-mux.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/usb/typec/mux/gpio-sbu-mux.c b/drivers/usb/typec/mux/gpio-sbu-mux.c > index f62516dafe8f..94c5bc0f467d 100644 > --- a/drivers/usb/typec/mux/gpio-sbu-mux.c > +++ b/drivers/usb/typec/mux/gpio-sbu-mux.c > @@ -140,7 +140,7 @@ static int gpio_sbu_mux_probe(struct platform_device *pdev) > return 0; > } > > -static int gpio_sbu_mux_remove(struct platform_device *pdev) > +static void gpio_sbu_mux_remove(struct platform_device *pdev) > { > struct gpio_sbu_mux *sbu_mux = platform_get_drvdata(pdev); > > @@ -148,8 +148,6 @@ static int gpio_sbu_mux_remove(struct platform_device *pdev) > > typec_mux_unregister(sbu_mux->mux); > typec_switch_unregister(sbu_mux->sw); > - > - return 0; > } > > static const struct of_device_id gpio_sbu_mux_match[] = { > @@ -160,7 +158,7 @@ MODULE_DEVICE_TABLE(of, gpio_sbu_mux_match); > > static struct platform_driver gpio_sbu_mux_driver = { > .probe = gpio_sbu_mux_probe, > - .remove = gpio_sbu_mux_remove, > + .remove_new = gpio_sbu_mux_remove, > .driver = { > .name = "gpio_sbu_mux", > .of_match_table = gpio_sbu_mux_match, > -- > 2.39.2
On Thu, May 18, 2023 at 01:02:32AM +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() is > 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> Reviewed-by: Bjorn Andersson <andersson@kernel.org> Regards, Bjorn > --- > drivers/usb/typec/mux/gpio-sbu-mux.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/usb/typec/mux/gpio-sbu-mux.c b/drivers/usb/typec/mux/gpio-sbu-mux.c > index f62516dafe8f..94c5bc0f467d 100644 > --- a/drivers/usb/typec/mux/gpio-sbu-mux.c > +++ b/drivers/usb/typec/mux/gpio-sbu-mux.c > @@ -140,7 +140,7 @@ static int gpio_sbu_mux_probe(struct platform_device *pdev) > return 0; > } > > -static int gpio_sbu_mux_remove(struct platform_device *pdev) > +static void gpio_sbu_mux_remove(struct platform_device *pdev) > { > struct gpio_sbu_mux *sbu_mux = platform_get_drvdata(pdev); > > @@ -148,8 +148,6 @@ static int gpio_sbu_mux_remove(struct platform_device *pdev) > > typec_mux_unregister(sbu_mux->mux); > typec_switch_unregister(sbu_mux->sw); > - > - return 0; > } > > static const struct of_device_id gpio_sbu_mux_match[] = { > @@ -160,7 +158,7 @@ MODULE_DEVICE_TABLE(of, gpio_sbu_mux_match); > > static struct platform_driver gpio_sbu_mux_driver = { > .probe = gpio_sbu_mux_probe, > - .remove = gpio_sbu_mux_remove, > + .remove_new = gpio_sbu_mux_remove, > .driver = { > .name = "gpio_sbu_mux", > .of_match_table = gpio_sbu_mux_match, > -- > 2.39.2 >
On Thu, May 18, 2023 at 01:02:32AM +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() is > renamed to .remove(). > > Trivially convert this driver from always returning zero in the remove > callback to the void returning variant. > Reviewed-by: Bjorn Andersson <andersson@kernel.org> Regards, Bjorn > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > --- > drivers/usb/typec/mux/gpio-sbu-mux.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/usb/typec/mux/gpio-sbu-mux.c b/drivers/usb/typec/mux/gpio-sbu-mux.c > index f62516dafe8f..94c5bc0f467d 100644 > --- a/drivers/usb/typec/mux/gpio-sbu-mux.c > +++ b/drivers/usb/typec/mux/gpio-sbu-mux.c > @@ -140,7 +140,7 @@ static int gpio_sbu_mux_probe(struct platform_device *pdev) > return 0; > } > > -static int gpio_sbu_mux_remove(struct platform_device *pdev) > +static void gpio_sbu_mux_remove(struct platform_device *pdev) > { > struct gpio_sbu_mux *sbu_mux = platform_get_drvdata(pdev); > > @@ -148,8 +148,6 @@ static int gpio_sbu_mux_remove(struct platform_device *pdev) > > typec_mux_unregister(sbu_mux->mux); > typec_switch_unregister(sbu_mux->sw); > - > - return 0; > } > > static const struct of_device_id gpio_sbu_mux_match[] = { > @@ -160,7 +158,7 @@ MODULE_DEVICE_TABLE(of, gpio_sbu_mux_match); > > static struct platform_driver gpio_sbu_mux_driver = { > .probe = gpio_sbu_mux_probe, > - .remove = gpio_sbu_mux_remove, > + .remove_new = gpio_sbu_mux_remove, > .driver = { > .name = "gpio_sbu_mux", > .of_match_table = gpio_sbu_mux_match, > -- > 2.39.2 >
diff --git a/drivers/usb/typec/mux/gpio-sbu-mux.c b/drivers/usb/typec/mux/gpio-sbu-mux.c index f62516dafe8f..94c5bc0f467d 100644 --- a/drivers/usb/typec/mux/gpio-sbu-mux.c +++ b/drivers/usb/typec/mux/gpio-sbu-mux.c @@ -140,7 +140,7 @@ static int gpio_sbu_mux_probe(struct platform_device *pdev) return 0; } -static int gpio_sbu_mux_remove(struct platform_device *pdev) +static void gpio_sbu_mux_remove(struct platform_device *pdev) { struct gpio_sbu_mux *sbu_mux = platform_get_drvdata(pdev); @@ -148,8 +148,6 @@ static int gpio_sbu_mux_remove(struct platform_device *pdev) typec_mux_unregister(sbu_mux->mux); typec_switch_unregister(sbu_mux->sw); - - return 0; } static const struct of_device_id gpio_sbu_mux_match[] = { @@ -160,7 +158,7 @@ MODULE_DEVICE_TABLE(of, gpio_sbu_mux_match); static struct platform_driver gpio_sbu_mux_driver = { .probe = gpio_sbu_mux_probe, - .remove = gpio_sbu_mux_remove, + .remove_new = gpio_sbu_mux_remove, .driver = { .name = "gpio_sbu_mux", .of_match_table = gpio_sbu_mux_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() is 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/usb/typec/mux/gpio-sbu-mux.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-)