2023-08-01 13:48:03

by Matti Vaittinen

[permalink] [raw]
Subject: [PATCH v8 0/8] fix fwnode_irq_get[_byname()] returnvalue

The fwnode_irq_get() and the fwnode_irq_get_byname() may have returned
zero if mapping the IRQ fails. This contradicts the
fwnode_irq_get_byname() documentation. Furthermore, returning zero or
errno on error is unepected and can easily lead to problems
like:

int probe(foo)
{
...
ret = fwnode_irq_get_byname(...);
if (ret < 0)
return ret;
...
}

or

int probe(foo)
{
...
ret = fwnode_irq_get_byname(...);
if (ret <= 0)
return ret;
...
}

which are both likely to be wrong. First treats zero as successful call and
misses the IRQ mapping failure. Second returns zero from probe even though
it detects the IRQ mapping failure correvtly.

Thus the fwnode_irq_get() and the fwnode_irq_get_byname() were changed to
always return a negative errno upon failure.

https://lore.kernel.org/all/[email protected]/

This is a clean-up patch to adjust callers. Please note that callers
were audited based on v6.4-rc2:

fwnode_irq_get_byname():
drivers/i2c/i2c-smbus.c
drivers/iio/accel/adxl355_core.c
drivers/iio/accel/kionix-kx022a.c
drivers/iio/adc/ad4130.c
drivers/iio/adc/max11410.c
drivers/iio/addac/ad74115.c
drivers/iio/gyro/fxas21002c_core.c
drivers/iio/imu/adis16480.c
drivers/iio/imu/bmi160/bmi160_core.c
drivers/iio/imu/bmi160/bmi160_core.c

fwnode_irq_get():
drivers/gpio/gpio-dwapb.c
drivers/iio/chemical/scd30_serial.c
drivers/iio/proximity/mb1232.c
drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c
drivers/net/mdio/fwnode_mdio.c
drivers/pinctrl/pinctrl-ingenic.c
drivers/pinctrl/pinctrl-microchip-sgpio.c
drivers/pinctrl/pinctrl-pistachio.c

and it seems to me these calls will be Ok after this clean-up. The
i2c-smbus.c and kionix-kx022a.c will gain a functional change (bugfix?) as
after this patch the probe will return -EINVAL should the IRQ mapping fail.
The series will also adjust the return value check for zero to be omitted.

NOTES:

Changes are compile-tested only.

drivers/pinctrl/nuvoton/pinctrl-wpcm450.c
will also gain a functional change. The pinctrl-wpcm450.c change is easy
to see - after this series the device-tree mapping failures will be
handled as any other errors - probe will be aborted with -EINVAL. Other
feasible option could be treating other errors in IRQ getting same way
as the DT mapping failures - just silently skip the IRQ. Please see
comment in the respective patch.

drivers/iio/cdc/ad7150.c
Changed logic so that all the IRQ getting errors jump to the same
'no-IRQ' branch as the DT mapping error did.

Revision history:
v7 => v8:
- drop ptach 1/N which was merged during 6.4 development.
- rebase on top of the v6.5-rc4.
v6 => v7:
- re-ordered patches per subsystem
- mvpp2 - added a patch for not shadowing the return value
v5 => v6:
- iio: cdc: ad7150 - never abort probe if IRQ getting fails
v4 => v5:
- Fix subject lines for mvpp2 and wpcm450
- drop unnecessary irqno assignment from mb1232
- add back the drivers/i2c/i2c-smbus.c change which was accidentally
dropped during v3 => v4 work
v3 => v4:
- Change also the fwnode_irq_get() as was suggested by Jonathan.
Changelog v2 => v3:
- rebase/resend/add kx022a fix.
Changelog v1 => v2:
- minor styling

---

Matti Vaittinen (8):
iio: mb1232: relax return value check for IRQ get
iio: cdc: ad7150: relax return value check for IRQ get
pinctrl: wpcm450: relax return value check for IRQ get
pinctrl: ingenic: relax return value check for IRQ get
pinctrl: pistachio: relax return value check for IRQ get
i2c: i2c-smbus: fwnode_irq_get_byname() return value fix
net-next: mvpp2: relax return value check for IRQ get
net-next: mvpp2: don't shadow error

drivers/i2c/i2c-smbus.c | 2 +-
drivers/iio/cdc/ad7150.c | 10 +++++-----
drivers/iio/proximity/mb1232.c | 7 ++-----
drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c | 12 ++++++------
drivers/pinctrl/nuvoton/pinctrl-wpcm450.c | 2 --
drivers/pinctrl/pinctrl-ingenic.c | 2 --
drivers/pinctrl/pinctrl-pistachio.c | 6 ------
7 files changed, 14 insertions(+), 27 deletions(-)


base-commit: 5d0c230f1de8c7515b6567d9afba1f196fb4e2f4
--
2.40.1


--
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND

~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =]


Attachments:
(No filename) (4.52 kB)
signature.asc (499.00 B)
Download all attachments

2023-08-01 13:48:59

by Matti Vaittinen

[permalink] [raw]
Subject: [PATCH v8 4/8] pinctrl: ingenic: relax return value check for IRQ get

fwnode_irq_get[_byname]() were changed to not return 0 anymore.

Drop check for return value 0.

Signed-off-by: Matti Vaittinen <[email protected]>
Reviewed-by: Paul Cercueil <[email protected]>
Acked-by: Linus Walleij <[email protected]>
Reviewed-by: Jonathan Cameron <[email protected]>

---
Revision history:
- No changes

Please note, I took Linus' reply to v4 cover-letter as ack && added the
tag. Please let me know if this was not Ok.

The patch changing the fwnode_irq_get() got merged during 5.4:
https://lore.kernel.org/all/[email protected]/
This is a clean-up as agreed.
---
drivers/pinctrl/pinctrl-ingenic.c | 2 --
1 file changed, 2 deletions(-)

diff --git a/drivers/pinctrl/pinctrl-ingenic.c b/drivers/pinctrl/pinctrl-ingenic.c
index 2f220a47b749..86e71ad703a5 100644
--- a/drivers/pinctrl/pinctrl-ingenic.c
+++ b/drivers/pinctrl/pinctrl-ingenic.c
@@ -4201,8 +4201,6 @@ static int __init ingenic_gpio_probe(struct ingenic_pinctrl *jzpc,
err = fwnode_irq_get(fwnode, 0);
if (err < 0)
return err;
- if (!err)
- return -EINVAL;
jzgc->irq = err;

girq = &jzgc->gc.irq;
--
2.40.1


--
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND

~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =]


Attachments:
(No filename) (1.51 kB)
signature.asc (499.00 B)
Download all attachments

2023-08-01 14:01:55

by Matti Vaittinen

[permalink] [raw]
Subject: [PATCH v8 7/8] net-next: mvpp2: relax return value check for IRQ get

fwnode_irq_get[_byname]() were changed to not return 0 anymore.

Drop check for return value 0.

Signed-off-by: Matti Vaittinen <[email protected]>

---
Revision history:
v5 =>:
- No changes
v4 = v5:
Fix the subject, mb1232 => mvpp2

The patch changing the fwnode_irq_get() got merged during 5.4:
https://lore.kernel.org/all/[email protected]/
This is a clean-up as agreed.
---
drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c b/drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c
index 1fec84b4c068..2632ffe91ca5 100644
--- a/drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c
+++ b/drivers/net/ethernet/marvell/mvpp2/mvpp2_main.c
@@ -5833,7 +5833,7 @@ static int mvpp2_multi_queue_vectors_init(struct mvpp2_port *port,
v->irq = of_irq_get_byname(port_node, irqname);
else
v->irq = fwnode_irq_get(port->fwnode, i);
- if (v->irq <= 0) {
+ if (v->irq < 0) {
ret = -EINVAL;
goto err;
}
@@ -6764,7 +6764,7 @@ static int mvpp2_port_probe(struct platform_device *pdev,
err = -EPROBE_DEFER;
goto err_deinit_qvecs;
}
- if (port->port_irq <= 0)
+ if (port->port_irq < 0)
/* the link irq is optional */
port->port_irq = 0;

--
2.40.1


--
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND

~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =]


Attachments:
(No filename) (1.66 kB)
signature.asc (499.00 B)
Download all attachments

2023-08-01 14:03:54

by Matti Vaittinen

[permalink] [raw]
Subject: [PATCH v8 5/8] pinctrl: pistachio: relax return value check for IRQ get

fwnode_irq_get[_byname]() were changed to not return 0 anymore.

Drop check for return value 0.

Signed-off-by: Matti Vaittinen <[email protected]>
Acked-by: Linus Walleij <[email protected]>
Reviewed-by: Jonathan Cameron <[email protected]>

---
Revision history:
- No changes

Please note, I took Linus' reply to v4 cover-letter as ack && added the
tag. Please let me know if this was not Ok.

The patch changing the fwnode_irq_get() got merged during 5.4:
https://lore.kernel.org/all/[email protected]/
This is a clean-up as agreed.
---
drivers/pinctrl/pinctrl-pistachio.c | 6 ------
1 file changed, 6 deletions(-)

diff --git a/drivers/pinctrl/pinctrl-pistachio.c b/drivers/pinctrl/pinctrl-pistachio.c
index 53408344927a..8c50e0091b32 100644
--- a/drivers/pinctrl/pinctrl-pistachio.c
+++ b/drivers/pinctrl/pinctrl-pistachio.c
@@ -1393,12 +1393,6 @@ static int pistachio_gpio_register(struct pistachio_pinctrl *pctl)
dev_err(pctl->dev, "Failed to retrieve IRQ for bank %u\n", i);
goto err;
}
- if (!ret) {
- fwnode_handle_put(child);
- dev_err(pctl->dev, "No IRQ for bank %u\n", i);
- ret = -EINVAL;
- goto err;
- }
irq = ret;

bank = &pctl->gpio_banks[i];
--
2.40.1


--
Matti Vaittinen, Linux device drivers
ROHM Semiconductors, Finland SWDC
Kiviharjunlenkki 1E
90220 OULU
FINLAND

~~~ "I don't think so," said Rene Descartes. Just then he vanished ~~~
Simon says - in Latin please.
~~~ "non cogito me" dixit Rene Descarte, deinde evanescavit ~~~
Thanks to Simon Glass for the translation =]


Attachments:
(No filename) (1.60 kB)
signature.asc (499.00 B)
Download all attachments