pinctrl: wpcm450: Correct the fwnode_irq_get() return value check
Subsystems (3)
PATCH 1/1 pinctrl: wpcm450: Correct the fwnode_irq_get() return value check
fwnode_irq_get() may return all possible signed values, such as Linux error code. Fix the code to handle this properly.
--- drivers/pinctrl/nuvoton/pinctrl-wpcm450.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +4 -1
@@ -1081,10 +1081,13 @@ static int wpcm450_gpio_register(struct platform_device *pdev, girq->num_parents =0 ;for (i =0 ; i <WPCM450_NUM_GPIO_IRQS ; i++) { -int irq =fwnode_irq_get (child, i); +int irq; + irq =fwnode_irq_get (child, i);if (irq <0 )break ; +if (!irq) +continue ; girq->parents[i] = irq; girq->num_parents++;
Signature · 1 line
2.35.1
Jonathan Neuschäfer
maintainerHello,
Quoted 2 lines · Andy Shevchenko
fwnode_irq_get()may return all possible signed values, such as Linux error code. Fix the code to handle this properly.
It would be good to note explicitly here what a return value of zero means, i.e., as the documentation of of_irq_get says, "IRQ mapping failure", and why it should result in skipping this IRQ.
Quoted 11 lines
Fixes a1d1e0e3d80a ("pinctrl: nuvoton: Add driver for WPCM450")Signed-off-by Andy Shevchenko <[email protected]>--- drivers/pinctrl/nuvoton/pinctrl-wpcm450.c | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +0
-0
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c static int wpcm450_gpio_register(struct platform_device *pdev, · line 1086
Quoted 7 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +2
-1@@ -1081,10 +1081,13 @@ static int wpcm450_gpio_register(struct platform_device *pdev, girq->num_parents =0 ;for (i =0 ; i <WPCM450_NUM_GPIO_IRQS ; i++) { -int irq =fwnode_irq_get (child, i); +int irq; + irq =fwnode_irq_get (child, i);
(Unneccesary churn, but I'll allow it)
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c static int wpcm450_gpio_register(struct platform_device *pdev, · line 1090
Quoted 4 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +2
-0if (irq <0 )break ; +if (!irq) +continue ;
Since irq == 0 seems to be an error condition, the following seems fine to me, and simpler:
- if (irq < 0)
+ if (irq <= 0)
break;
Thanks,
Jonathan
Quoted 7 lines · Jonathan Neuschäfer
Quoted 2 lines · Andy Shevchenko
fwnode_irq_get()may return all possible signed values, such as Linux error code. Fix the code to handle this properly.It would be good to note explicitly here what a return value of zero means, i.e., as the documentation of
of_irq_getsays, "IRQ mapping failure", and why it should result in skipping this IRQ.
Not that I'm fun of duplicating documentation in the commit message, but it won't take much in this case.
...
Quoted 7 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c static int wpcm450_gpio_register(struct platform_device *pdev, · line 1086
Quoted 5 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +2
-1for (i =0 ; i <WPCM450_NUM_GPIO_IRQS ; i++) { -int irq =fwnode_irq_get (child, i); +int irq; + irq =fwnode_irq_get (child, i);(Unneccesary churn, but I'll allow it)
The point here is to see that we actually check something that we just got from somewhere else. It's slightly better for reading and maintaining the code as I explained in [1].
And there is a difference to the cases like
static int foo(struct platform_device *pdev, ...)
{
struct device *dev = &pdev->dev;
...
}when we know ahead that if pdev is NULL, something is _so_ wrong that it's not even our issue.
[1]: https://lore.kernel.org/lkml/CAHp75Vda5KX5pVrNeueQEODoEy405eTb9SYJtts-Lm9jMNocHQ@mail.gmail.com/
Review
Quoted 11 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c static int wpcm450_gpio_register(struct platform_device *pdev, · line 1090
Quoted 4 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +2
-0if (irq <0 )break ; +if (!irq) +continue ;Since irq == 0 seems to be an error condition, the following seems fine to me, and simpler:
(quoted diff) +1
-1- if (irq < 0) + if (irq <= 0) break;
Not sure it's the same by two reasons:
1) break != continue;
2) we might need to convert 0 to error if we ever go to report this
So, to me mapping error shouldn't be fatal to continue, but I would like to hear your interpretation since you know this case much better than me.
Thanks for the review!
Signature · 2 lines
With Best Regards, Andy Shevchenko
Jonathan Neuschäfer
maintainerHello,
Quoted 11 lines · Andy Shevchenko
Quoted 7 lines · Jonathan Neuschäfer
Quoted 2 lines · Andy Shevchenko
fwnode_irq_get()may return all possible signed values, such as Linux error code. Fix the code to handle this properly.It would be good to note explicitly here what a return value of zero means, i.e., as the documentation of
of_irq_getsays, "IRQ mapping failure", and why it should result in skipping this IRQ.Not that I'm fun of duplicating documentation in the commit message, but it won't take much in this case.
My problem with the description is that handling "all possible signed values" is fairly meaningless: The code arguably did that already, it did *something* for every possible value. The significant change of your patch is that the value zero is handled differently.
IOW, what I miss is something along the lines of: "fwnode_irq_get can return zero to indicate some errors. Handle this case like other errors."
Quoted 22 lines
...
Quoted 7 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c static int wpcm450_gpio_register(struct platform_device *pdev, · line 1086
Quoted 5 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +2
-1for (i =0 ; i <WPCM450_NUM_GPIO_IRQS ; i++) { -int irq =fwnode_irq_get (child, i); +int irq; + irq =fwnode_irq_get (child, i);(Unneccesary churn, but I'll allow it)
The point here is to see that we actually check something that we just got from somewhere else. It's slightly better for reading and maintaining the code as I explained in [1].
And there is a difference to the cases like
static int
foo(struct platform_device *pdev, ...){ struct device *dev = &pdev->dev; ... }
Quoted 4 lines
when we know ahead that if pdev is NULL, something is _so_ wrong that it's not even our issue.
[1]: https://lore.kernel.org/lkml/CAHp75Vda5KX5pVrNeueQEODoEy405eTb9SYJtts-Lm9jMNocHQ@mail.gmail.com/
Ok, fair enough.
Quoted 9 lines
Quoted 9 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c static int wpcm450_gpio_register(struct platform_device *pdev, · line 1090
Quoted 5 lines
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c +2
-0if (irq <0 )break ; +if (!irq) +continue ;Since irq == 0 seems to be an error condition, the following seems fine to me, and simpler:
Quoted 6 lines
Review
Quoted 3 lines
(quoted diff) +1
-1- if (irq < 0) + if (irq <= 0) break;Not sure it's the same by two reasons:
1) break != continue;
Right, hence why I asked for reasoning why zero should be handled the way you propose to handle it.
Quoted 1 line
2) we might need to convert 0 to error if we ever go to report this
Good point.
Quoted 4 lines
So, to me mapping error shouldn't be fatal to continue, but I would like to hear your interpretation since you know this case much better than me.
However: In wpcm450_gpio_register, there is currently no reporting for mapping errors in this loop.
I'm fine with either break or continue.
Thanks,
Jonathan