[PATCH 00/52] input: Convert to platform remove callback returning void

[PATCH 00/52] input: Convert to platform remove callback returning void

[Uwe Kleine-König]

Hello,

this series converts all platform drivers below drivers/input to use
remove_new. The motivation is to get rid of an integer return code
that is (mostly) ignored by the platform driver core and error prone on
the driver side.

See commit 5c5a7680e67b ("platform: Provide a remove callback that
returns no value") for an extended explanation and the eventual goal.

There are no interdependencies between the patches. As there are still
quite a few drivers to convert, I'm happy about every patch that makes
it in. So even if there is a merge conflict with one patch until you
apply or a subject prefix is suboptimal, please apply the remainder of
this series anyhow.

Best regards
Uwe

Uwe Kleine-König (52):
  input: adp5520-keys - Convert to platform remove callback returning
    void
  input: cros_ec_keyb - Convert to platform remove callback returning
    void
  input: ep93xx_keypad - Convert to platform remove callback returning
    void
  input: iqs62x-keys - Convert to platform remove callback returning
    void
  input: matrix_keypad - Convert to platform remove callback returning
    void
  input: omap-keypad - Convert to platform remove callback returning
    void
  input: omap4-keypad - Convert to platform remove callback returning
    void
  input: samsung-keypad - Convert to platform remove callback returning
    void
  input: sh_keysc - Convert to platform remove callback returning void
  input: spear-keyboard - Convert to platform remove callback returning
    void
  input: stmpe-keypad - Convert to platform remove callback returning
    void
  input: 88pm80x_onkey - Convert to platform remove callback returning
    void
  input: da9052_onkey - Convert to platform remove callback returning
    void
  input: da9055_onkey - Convert to platform remove callback returning
    void
  input: ideapad_slidebar - Convert to platform remove callback
    returning void
  input: m68kspkr - Convert to platform remove callback returning void
  input: max8997_haptic - Convert to platform remove callback returning
    void
  input: mc13783-pwrbutton - Convert to platform remove callback
    returning void
  input: palmas-pwrbutton - Convert to platform remove callback
    returning void
  input: pcap_keys - Convert to platform remove callback returning void
  input: pcf50633-input - Convert to platform remove callback returning
    void
  input: pcspkr - Convert to platform remove callback returning void
  input: pm8941-pwrkey - Convert to platform remove callback returning
    void
  input: soc_button_array - Convert to platform remove callback
    returning void
  input: sparcspkr - Convert to platform remove callback returning void
  input: wistron_btns - Convert to platform remove callback returning
    void
  input: wm831x-on - Convert to platform remove callback returning void
  input: navpoint - Convert to platform remove callback returning void
  input: altera_ps2 - Convert to platform remove callback returning void
  input: ams_delta_serio - Convert to platform remove callback returning
    void
  input: apbps2 - Convert to platform remove callback returning void
  input: arc_ps2 - Convert to platform remove callback returning void
  input: ct82c710 - Convert to platform remove callback returning void
  drivers/input/serio/i8042-sparcio.h :: Convert to platform remove
    callback returning void
  input: i8042 - Convert to platform remove callback returning void
  input: ioc3kbd - Convert to platform remove callback returning void
  input: maceps2 - Convert to platform remove callback returning void
  input: olpc_apsp - Convert to platform remove callback returning void
  input: ps2-gpio - Convert to platform remove callback returning void
  input: q40kbd - Convert to platform remove callback returning void
  input: rpckbd - Convert to platform remove callback returning void
  input: sun4i-ps2 - Convert to platform remove callback returning void
  input: xilinx_ps2 - Convert to platform remove callback returning void
  input: da9052_tsi - Convert to platform remove callback returning void
  input: mainstone-wm97xx - Convert to platform remove callback
    returning void
  input: mc13783_ts - Convert to platform remove callback returning void
  input: pcap_ts - Convert to platform remove callback returning void
  input: stmpe-ts - Convert to platform remove callback returning void
  input: sun4i-ts - Convert to platform remove callback returning void
  input: ti_am335x_tsc - Convert to platform remove callback returning
    void
  input: wm831x-ts - Convert to platform remove callback returning void
  input: wm97xx-core - Convert to platform remove callback returning
    void

 drivers/input/keyboard/adp5520-keys.c        |  6 ++----
 drivers/input/keyboard/cros_ec_keyb.c        |  6 ++----
 drivers/input/keyboard/ep93xx_keypad.c       |  6 ++----
 drivers/input/keyboard/iqs62x-keys.c         |  6 ++----
 drivers/input/keyboard/matrix_keypad.c       |  6 ++----
 drivers/input/keyboard/omap-keypad.c         |  6 ++----
 drivers/input/keyboard/omap4-keypad.c        |  6 ++----
 drivers/input/keyboard/samsung-keypad.c      |  6 ++----
 drivers/input/keyboard/sh_keysc.c            |  6 ++----
 drivers/input/keyboard/spear-keyboard.c      |  6 ++----
 drivers/input/keyboard/stmpe-keypad.c        |  6 ++----
 drivers/input/misc/88pm80x_onkey.c           |  5 ++---
 drivers/input/misc/da9052_onkey.c            |  6 ++----
 drivers/input/misc/da9055_onkey.c            |  6 ++----
 drivers/input/misc/ideapad_slidebar.c        |  6 ++----
 drivers/input/misc/m68kspkr.c                |  6 ++----
 drivers/input/misc/max8997_haptic.c          |  6 ++----
 drivers/input/misc/mc13783-pwrbutton.c       |  6 ++----
 drivers/input/misc/palmas-pwrbutton.c        |  6 ++----
 drivers/input/misc/pcap_keys.c               |  6 ++----
 drivers/input/misc/pcf50633-input.c          |  6 ++----
 drivers/input/misc/pcspkr.c                  |  6 ++----
 drivers/input/misc/pm8941-pwrkey.c           |  6 ++----
 drivers/input/misc/soc_button_array.c        |  6 ++----
 drivers/input/misc/sparcspkr.c               | 12 ++++--------
 drivers/input/misc/wistron_btns.c            |  6 ++----
 drivers/input/misc/wm831x-on.c               |  6 ++----
 drivers/input/mouse/navpoint.c               |  6 ++----
 drivers/input/serio/altera_ps2.c             |  6 ++----
 drivers/input/serio/ams_delta_serio.c        |  6 ++----
 drivers/input/serio/apbps2.c                 |  6 ++----
 drivers/input/serio/arc_ps2.c                |  6 ++----
 drivers/input/serio/ct82c710.c               |  6 ++----
 drivers/input/serio/i8042-sparcio.h          |  6 ++----
 drivers/input/serio/i8042.c                  |  6 ++----
 drivers/input/serio/ioc3kbd.c                |  6 ++----
 drivers/input/serio/maceps2.c                |  6 ++----
 drivers/input/serio/olpc_apsp.c              |  6 ++----
 drivers/input/serio/ps2-gpio.c               |  5 ++---
 drivers/input/serio/q40kbd.c                 |  6 ++----
 drivers/input/serio/rpckbd.c                 |  6 ++----
 drivers/input/serio/sun4i-ps2.c              |  6 ++----
 drivers/input/serio/xilinx_ps2.c             |  6 ++----
 drivers/input/touchscreen/da9052_tsi.c       |  6 ++----
 drivers/input/touchscreen/mainstone-wm97xx.c |  6 ++----
 drivers/input/touchscreen/mc13783_ts.c       |  6 ++----
 drivers/input/touchscreen/pcap_ts.c          |  6 ++----
 drivers/input/touchscreen/stmpe-ts.c         |  6 ++----
 drivers/input/touchscreen/sun4i-ts.c         |  6 ++----
 drivers/input/touchscreen/ti_am335x_tsc.c    |  5 ++---
 drivers/input/touchscreen/wm831x-ts.c        |  6 ++----
 drivers/input/touchscreen/wm97xx-core.c      |  6 ++----
 52 files changed, 106 insertions(+), 209 deletions(-)

base-commit: 926f75c8a5ab70567eb4c2d82fbc96963313e564
-- 
2.40.1

[PATCH 02/52] input: cros_ec_keyb - 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>
---
 drivers/input/keyboard/cros_ec_keyb.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/input/keyboard/cros_ec_keyb.c b/drivers/input/keyboard/cros_ec_keyb.c
index 313b7a69dd69..30678a34cf64 100644
--- a/drivers/input/keyboard/cros_ec_keyb.c
+++ b/drivers/input/keyboard/cros_ec_keyb.c
@@ -743,14 +743,12 @@ static int cros_ec_keyb_probe(struct platform_device *pdev)
 	return 0;
 }
 
-static int cros_ec_keyb_remove(struct platform_device *pdev)
+static void cros_ec_keyb_remove(struct platform_device *pdev)
 {
 	struct cros_ec_keyb *ckdev = dev_get_drvdata(&pdev->dev);
 
 	blocking_notifier_chain_unregister(&ckdev->ec->event_notifier,
 					   &ckdev->notifier);
-
-	return 0;
 }
 
 #ifdef CONFIG_ACPI
@@ -774,7 +772,7 @@ static DEFINE_SIMPLE_DEV_PM_OPS(cros_ec_keyb_pm_ops, NULL, cros_ec_keyb_resume);
 
 static struct platform_driver cros_ec_keyb_driver = {
 	.probe = cros_ec_keyb_probe,
-	.remove = cros_ec_keyb_remove,
+	.remove_new = cros_ec_keyb_remove,
 	.driver = {
 		.name = "cros-ec-keyb",
 		.dev_groups = cros_ec_keyb_groups,
-- 
2.40.1

Re: [PATCH 02/52] input: cros_ec_keyb - Convert to platform remove callback returning void

[Tzung-Bi Shih]

On Wed, Sep 20, 2023 at 02:57:39PM +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() 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>

Reviewed-by: Tzung-Bi Shih <tzungbi@kernel.org>

Re: [PATCH 00/52] input: Convert to platform remove callback returning void

[Dmitry Torokhov]

On Wed, Sep 20, 2023 at 02:57:37PM +0200, Uwe Kleine-König wrote:
> Hello,
> 
> this series converts all platform drivers below drivers/input to use
> remove_new. The motivation is to get rid of an integer return code
> that is (mostly) ignored by the platform driver core and error prone on
> the driver side.
> 
> See commit 5c5a7680e67b ("platform: Provide a remove callback that
> returns no value") for an extended explanation and the eventual goal.
> 
> There are no interdependencies between the patches. As there are still
> quite a few drivers to convert, I'm happy about every patch that makes
> it in. So even if there is a merge conflict with one patch until you
> apply or a subject prefix is suboptimal, please apply the remainder of
> this series anyhow.

Applied the lot (fixing the i8042-sparcio patch subject), thank you!

-- 
Dmitry

Re: [PATCH 00/52] input: Convert to platform remove callback returning void

[Uwe Kleine-König]

[-- Attachment #1: Type: text/plain, Size: 1511 bytes --]

Hello Dmitry,

On Sat, Sep 23, 2023 at 07:48:21PM -0700, Dmitry Torokhov wrote:
> On Wed, Sep 20, 2023 at 02:57:37PM +0200, Uwe Kleine-König wrote:
> > Hello,
> > 
> > this series converts all platform drivers below drivers/input to use
> > remove_new. The motivation is to get rid of an integer return code
> > that is (mostly) ignored by the platform driver core and error prone on
> > the driver side.
> > 
> > See commit 5c5a7680e67b ("platform: Provide a remove callback that
> > returns no value") for an extended explanation and the eventual goal.
> > 
> > There are no interdependencies between the patches. As there are still
> > quite a few drivers to convert, I'm happy about every patch that makes
> > it in. So even if there is a merge conflict with one patch until you
> > apply or a subject prefix is suboptimal, please apply the remainder of
> > this series anyhow.
> 
> Applied the lot (fixing the i8042-sparcio patch subject), thank you!

Thanks. In the meantime I found out why my process failed here: I only
fixed *.c, but this driver struct is defined in a header file
i8042-sparcio.h.

This file is only included by drivers/input/serio/i8042.h which in turn
is only included by drivers/input/serio/i8042.c. So there is only one
instance created, but I'd call that unusual anyhow.

Best regards
Uwe

-- 
Pengutronix e.K.                           | Uwe Kleine-König            |
Industrial Linux Solutions                 | https://www.pengutronix.de/ |

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

Re: [PATCH 00/52] input: Convert to platform remove callback returning void

[Dmitry Torokhov]

Hi Uwe,

Sorry for the spotty responses.

On Sun, Sep 24, 2023 at 05:50:57PM +0200, Uwe Kleine-König wrote:
> Hello Dmitry,
> 
> On Sat, Sep 23, 2023 at 07:48:21PM -0700, Dmitry Torokhov wrote:
> > On Wed, Sep 20, 2023 at 02:57:37PM +0200, Uwe Kleine-König wrote:
> > > Hello,
> > > 
> > > this series converts all platform drivers below drivers/input to use
> > > remove_new. The motivation is to get rid of an integer return code
> > > that is (mostly) ignored by the platform driver core and error prone on
> > > the driver side.
> > > 
> > > See commit 5c5a7680e67b ("platform: Provide a remove callback that
> > > returns no value") for an extended explanation and the eventual goal.
> > > 
> > > There are no interdependencies between the patches. As there are still
> > > quite a few drivers to convert, I'm happy about every patch that makes
> > > it in. So even if there is a merge conflict with one patch until you
> > > apply or a subject prefix is suboptimal, please apply the remainder of
> > > this series anyhow.
> > 
> > Applied the lot (fixing the i8042-sparcio patch subject), thank you!
> 
> Thanks. In the meantime I found out why my process failed here: I only
> fixed *.c, but this driver struct is defined in a header file
> i8042-sparcio.h.
> 
> This file is only included by drivers/input/serio/i8042.h which in turn
> is only included by drivers/input/serio/i8042.c. So there is only one
> instance created, but I'd call that unusual anyhow.

Right, i8042 is essentially a singleton, and what you see here is an
attempt to bolt OF onto a legacy driver that is largely predates the
current driver model. I wanted to clean it up, but it is still widely
used and I am hesitant to disturb it too much.

Thanks.

-- 
Dmitry

Re: [PATCH 00/52] input: Convert to platform remove callback returning void

[patchwork-bot+chrome-platform]

Hello:

This patch was applied to chrome-platform/linux.git (for-kernelci)
by Dmitry Torokhov <dmitry.torokhov@gmail.com>:

On Wed, 20 Sep 2023 14:57:37 +0200 you wrote:
> Hello,
> 
> this series converts all platform drivers below drivers/input to use
> remove_new. The motivation is to get rid of an integer return code
> that is (mostly) ignored by the platform driver core and error prone on
> the driver side.
> 
> [...]

Here is the summary with links:
  - [02/52] input: cros_ec_keyb - Convert to platform remove callback returning void
    https://git.kernel.org/chrome-platform/c/63ef64cb6453

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

Re: [PATCH 00/52] input: Convert to platform remove callback returning void

[patchwork-bot+chrome-platform]

Hello:

This patch was applied to chrome-platform/linux.git (for-next)
by Dmitry Torokhov <dmitry.torokhov@gmail.com>:

On Wed, 20 Sep 2023 14:57:37 +0200 you wrote:
> Hello,
> 
> this series converts all platform drivers below drivers/input to use
> remove_new. The motivation is to get rid of an integer return code
> that is (mostly) ignored by the platform driver core and error prone on
> the driver side.
> 
> [...]

Here is the summary with links:
  - [02/52] input: cros_ec_keyb - Convert to platform remove callback returning void
    https://git.kernel.org/chrome-platform/c/63ef64cb6453

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