| Message ID | 20230517230239.187727-93-u.kleine-koenig@pengutronix.de (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | usb: Convert to platform remove callback returning void | expand |
On 18.05.2023 01:02, 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: Konrad Dybcio <konrad.dybcio@linaro.org> Konrad > drivers/usb/typec/qcom-pmic-typec.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/usb/typec/qcom-pmic-typec.c b/drivers/usb/typec/qcom-pmic-typec.c > index 432ea62f1bab..924af87fb26d 100644 > --- a/drivers/usb/typec/qcom-pmic-typec.c > +++ b/drivers/usb/typec/qcom-pmic-typec.c > @@ -228,7 +228,7 @@ static int qcom_pmic_typec_probe(struct platform_device *pdev) > return ret; > } > > -static int qcom_pmic_typec_remove(struct platform_device *pdev) > +static void qcom_pmic_typec_remove(struct platform_device *pdev) > { > struct qcom_pmic_typec *qcom_usb = platform_get_drvdata(pdev); > > @@ -237,8 +237,6 @@ static int qcom_pmic_typec_remove(struct platform_device *pdev) > > typec_unregister_port(qcom_usb->port); > usb_role_switch_put(qcom_usb->role_sw); > - > - return 0; > } > > static const struct of_device_id qcom_pmic_typec_table[] = { > @@ -253,7 +251,7 @@ static struct platform_driver qcom_pmic_typec = { > .of_match_table = qcom_pmic_typec_table, > }, > .probe = qcom_pmic_typec_probe, > - .remove = qcom_pmic_typec_remove, > + .remove_new = qcom_pmic_typec_remove, > }; > module_platform_driver(qcom_pmic_typec); >
On 18/05/2023 00:02, 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> > --- > drivers/usb/typec/qcom-pmic-typec.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/usb/typec/qcom-pmic-typec.c b/drivers/usb/typec/qcom-pmic-typec.c > index 432ea62f1bab..924af87fb26d 100644 > --- a/drivers/usb/typec/qcom-pmic-typec.c > +++ b/drivers/usb/typec/qcom-pmic-typec.c > @@ -228,7 +228,7 @@ static int qcom_pmic_typec_probe(struct platform_device *pdev) > return ret; > } > > -static int qcom_pmic_typec_remove(struct platform_device *pdev) > +static void qcom_pmic_typec_remove(struct platform_device *pdev) > { > struct qcom_pmic_typec *qcom_usb = platform_get_drvdata(pdev); > > @@ -237,8 +237,6 @@ static int qcom_pmic_typec_remove(struct platform_device *pdev) > > typec_unregister_port(qcom_usb->port); > usb_role_switch_put(qcom_usb->role_sw); > - > - return 0; > } > > static const struct of_device_id qcom_pmic_typec_table[] = { > @@ -253,7 +251,7 @@ static struct platform_driver qcom_pmic_typec = { > .of_match_table = qcom_pmic_typec_table, > }, > .probe = qcom_pmic_typec_probe, > - .remove = qcom_pmic_typec_remove, > + .remove_new = qcom_pmic_typec_remove, > }; > module_platform_driver(qcom_pmic_typec); > Acked-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org>
On Thu, May 18, 2023 at 01:02:34AM +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/qcom-pmic-typec.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/usb/typec/qcom-pmic-typec.c b/drivers/usb/typec/qcom-pmic-typec.c > index 432ea62f1bab..924af87fb26d 100644 > --- a/drivers/usb/typec/qcom-pmic-typec.c > +++ b/drivers/usb/typec/qcom-pmic-typec.c > @@ -228,7 +228,7 @@ static int qcom_pmic_typec_probe(struct platform_device *pdev) > return ret; > } > > -static int qcom_pmic_typec_remove(struct platform_device *pdev) > +static void qcom_pmic_typec_remove(struct platform_device *pdev) > { > struct qcom_pmic_typec *qcom_usb = platform_get_drvdata(pdev); > > @@ -237,8 +237,6 @@ static int qcom_pmic_typec_remove(struct platform_device *pdev) > > typec_unregister_port(qcom_usb->port); > usb_role_switch_put(qcom_usb->role_sw); > - > - return 0; > } > > static const struct of_device_id qcom_pmic_typec_table[] = { > @@ -253,7 +251,7 @@ static struct platform_driver qcom_pmic_typec = { > .of_match_table = qcom_pmic_typec_table, > }, > .probe = qcom_pmic_typec_probe, > - .remove = qcom_pmic_typec_remove, > + .remove_new = qcom_pmic_typec_remove, > }; > module_platform_driver(qcom_pmic_typec); > > -- > 2.39.2
diff --git a/drivers/usb/typec/qcom-pmic-typec.c b/drivers/usb/typec/qcom-pmic-typec.c index 432ea62f1bab..924af87fb26d 100644 --- a/drivers/usb/typec/qcom-pmic-typec.c +++ b/drivers/usb/typec/qcom-pmic-typec.c @@ -228,7 +228,7 @@ static int qcom_pmic_typec_probe(struct platform_device *pdev) return ret; } -static int qcom_pmic_typec_remove(struct platform_device *pdev) +static void qcom_pmic_typec_remove(struct platform_device *pdev) { struct qcom_pmic_typec *qcom_usb = platform_get_drvdata(pdev); @@ -237,8 +237,6 @@ static int qcom_pmic_typec_remove(struct platform_device *pdev) typec_unregister_port(qcom_usb->port); usb_role_switch_put(qcom_usb->role_sw); - - return 0; } static const struct of_device_id qcom_pmic_typec_table[] = { @@ -253,7 +251,7 @@ static struct platform_driver qcom_pmic_typec = { .of_match_table = qcom_pmic_typec_table, }, .probe = qcom_pmic_typec_probe, - .remove = qcom_pmic_typec_remove, + .remove_new = qcom_pmic_typec_remove, }; module_platform_driver(qcom_pmic_typec);
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/qcom-pmic-typec.c | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-)