media: bcm2835-unicam: Convert to platform remove callback returning void
Commit Message
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>
---
Hello,
this driver appeared in next-20240506. Given that I want to change struct
platform_driver::remove after the merge-window for v6.10 closes, it would be
great if this patch went in together with commit creating the drivers.
Thanks
Uwe
drivers/media/platform/broadcom/bcm2835-unicam.c | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
Comments
Hi Uwe,
Thank you for the patch.
On Mon, May 06, 2024 at 12:09:16PM +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: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
> Hello,
>
> this driver appeared in next-20240506. Given that I want to change struct
> platform_driver::remove after the merge-window for v6.10 closes, it would be
> great if this patch went in together with commit creating the drivers.
Hans, could you pick this up ?
> drivers/media/platform/broadcom/bcm2835-unicam.c | 6 ++----
> 1 file changed, 2 insertions(+), 4 deletions(-)
>
> diff --git a/drivers/media/platform/broadcom/bcm2835-unicam.c b/drivers/media/platform/broadcom/bcm2835-unicam.c
> index 3c7878d8d79b..b11bcec5b225 100644
> --- a/drivers/media/platform/broadcom/bcm2835-unicam.c
> +++ b/drivers/media/platform/broadcom/bcm2835-unicam.c
> @@ -2704,7 +2704,7 @@ static int unicam_probe(struct platform_device *pdev)
> return ret;
> }
>
> -static int unicam_remove(struct platform_device *pdev)
> +static void unicam_remove(struct platform_device *pdev)
> {
> struct unicam_device *unicam = platform_get_drvdata(pdev);
>
> @@ -2718,8 +2718,6 @@ static int unicam_remove(struct platform_device *pdev)
> unicam_put(unicam);
>
> pm_runtime_disable(&pdev->dev);
> -
> - return 0;
> }
>
> static const struct of_device_id unicam_of_match[] = {
> @@ -2730,7 +2728,7 @@ MODULE_DEVICE_TABLE(of, unicam_of_match);
>
> static struct platform_driver unicam_driver = {
> .probe = unicam_probe,
> - .remove = unicam_remove,
> + .remove_new = unicam_remove,
> .driver = {
> .name = UNICAM_MODULE_NAME,
> .pm = pm_ptr(&unicam_pm_ops),
@@ -2704,7 +2704,7 @@ static int unicam_probe(struct platform_device *pdev)
return ret;
}
-static int unicam_remove(struct platform_device *pdev)
+static void unicam_remove(struct platform_device *pdev)
{
struct unicam_device *unicam = platform_get_drvdata(pdev);
@@ -2718,8 +2718,6 @@ static int unicam_remove(struct platform_device *pdev)
unicam_put(unicam);
pm_runtime_disable(&pdev->dev);
-
- return 0;
}
static const struct of_device_id unicam_of_match[] = {
@@ -2730,7 +2728,7 @@ MODULE_DEVICE_TABLE(of, unicam_of_match);
static struct platform_driver unicam_driver = {
.probe = unicam_probe,
- .remove = unicam_remove,
+ .remove_new = unicam_remove,
.driver = {
.name = UNICAM_MODULE_NAME,
.pm = pm_ptr(&unicam_pm_ops),