| Message ID | 20230508142637.1449363-7-u.kleine-koenig@pengutronix.de (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 5580b559a80a3559a3b395a053f83e196aa801af |
| Delegated to: | Netdev Maintainers |
| Headers | show |
| Series | net: stmmac: Convert to platform remove callback returning void | expand |
| Context | Check | Description |
|---|---|---|
| netdev/series_format | success | Posting correctly formatted |
| netdev/tree_selection | success | Clearly marked for net-next |
| netdev/fixes_present | success | Fixes tag not required for -next series |
| netdev/header_inline | success | No static functions without inline keyword in header files |
| netdev/build_32bit | success | Errors and warnings before: 8 this patch: 8 |
| netdev/cc_maintainers | success | CCed 13 of 13 maintainers |
| netdev/build_clang | success | Errors and warnings before: 8 this patch: 8 |
| netdev/verify_signedoff | success | Signed-off-by tag matches author and committer |
| netdev/deprecated_api | success | None detected |
| netdev/check_selftest | success | No net selftest shell script |
| netdev/verify_fixes | success | No Fixes tag |
| netdev/build_allmodconfig_warn | success | Errors and warnings before: 8 this patch: 8 |
| netdev/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 23 lines checked |
| netdev/kdoc | success | Errors and warnings before: 0 this patch: 0 |
| netdev/source_inline | success | Was 0 now: 0 |
Hi Uwe, On Mon, 8 May 2023 at 19:56, 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 (mostly) ignored ^^^ mostly, here seems confusing. Only if the return value is ignored marking the function as 'void' makes sense IMO. > 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. > > Trivially convert this driver from always returning zero in the remove > callback to the void returning variant. > > Reviewed-by: Simon Horman <simon.horman@corigine.com> > Signed-off-by: Uwe Kleine-König <u.kleine-koenig@pengutronix.de> > --- > drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c | 6 ++---- > 1 file changed, 2 insertions(+), 4 deletions(-) > > diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c b/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c > index bf17c6c8f2eb..1db97a5209c4 100644 > --- a/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c > +++ b/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c > @@ -665,14 +665,12 @@ static int qcom_ethqos_probe(struct platform_device *pdev) > return ret; > } > > -static int qcom_ethqos_remove(struct platform_device *pdev) > +static void qcom_ethqos_remove(struct platform_device *pdev) > { > struct qcom_ethqos *ethqos = get_stmmac_bsp_priv(&pdev->dev); > > stmmac_pltfr_remove(pdev); > ethqos_clks_config(ethqos, false); > - > - return 0; > } > > static const struct of_device_id qcom_ethqos_match[] = { > @@ -685,7 +683,7 @@ MODULE_DEVICE_TABLE(of, qcom_ethqos_match); > > static struct platform_driver qcom_ethqos_driver = { > .probe = qcom_ethqos_probe, > - .remove = qcom_ethqos_remove, > + .remove_new = qcom_ethqos_remove, > .driver = { > .name = "qcom-ethqos", > .pm = &stmmac_pltfr_pm_ops, > -- > 2.39.2 Also a small note (maybe a TBD) indicating that 'remove_new' will be eventually replaced with 'remove' would make reading this easier. Rest seems fine, so: Reviewed-by: Bhupesh Sharma <bhupesh.sharma@linaro.org> Thanks.
Hello Bhupesh, On Tue, May 09, 2023 at 01:21:56PM +0530, Bhupesh Sharma wrote: > On Mon, 8 May 2023 at 19:56, 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 (mostly) ignored > > ^^^ mostly, here seems confusing. Only if the return value is ignored > marking the function > as 'void' makes sense IMO. FTR: It's only mostly ignored because a message is emitted: dev_warn(_dev, "remove callback returned a non-zero value. This will be ignored.\n"); (see platform_remove() in drivers/base/platform.c). > Also a small note (maybe a TBD) indicating that 'remove_new' will be > eventually replaced with 'remove' would make reading this easier. I adapted the commit message for future similar submissions. Thanks for the feedback. Best regards Uwe
diff --git a/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c b/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c index bf17c6c8f2eb..1db97a5209c4 100644 --- a/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c +++ b/drivers/net/ethernet/stmicro/stmmac/dwmac-qcom-ethqos.c @@ -665,14 +665,12 @@ static int qcom_ethqos_probe(struct platform_device *pdev) return ret; } -static int qcom_ethqos_remove(struct platform_device *pdev) +static void qcom_ethqos_remove(struct platform_device *pdev) { struct qcom_ethqos *ethqos = get_stmmac_bsp_priv(&pdev->dev); stmmac_pltfr_remove(pdev); ethqos_clks_config(ethqos, false); - - return 0; } static const struct of_device_id qcom_ethqos_match[] = { @@ -685,7 +683,7 @@ MODULE_DEVICE_TABLE(of, qcom_ethqos_match); static struct platform_driver qcom_ethqos_driver = { .probe = qcom_ethqos_probe, - .remove = qcom_ethqos_remove, + .remove_new = qcom_ethqos_remove, .driver = { .name = "qcom-ethqos", .pm = &stmmac_pltfr_pm_ops,