Skip to contentSkip to conversation

Fix i2c mux module refcount issues

PATCH Superseded Herve Codina 2 participants 10 messages Oct 19, 2023

Subsystems (3)

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

cover Fix i2c mux module refcount issues

Hi,

Some i2c mux drivers wrongly use the pair of_find_i2c_adapter_by_node() / i2c_put_adapter() to lock the parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Identified mux drivers impacted are:
- i2c-mux-gpmux
- i2c-demux-pinctrl
- i2c-mux-pinctrl

Commit 48e9743dd648 ("i2c: core: add and export of_get_i2c_adapter_by_node() interface") introduces of_get_i2c_adapter_by_node() to correctly handle this refcount issue.

This series fixes the 3 identified mux drivers replacing the of_find_i2c_adapter_by_node() call by an of_get_i2c_adapter_by_node() call.

Best regards,
Hervé

Herve Codina (3):
i2c: muxes: i2c-mux-pinctrl: Use of_get_i2c_adapter_by_node()
i2c: muxes: i2c-demux-pinctrl: Use of_get_i2c_adapter_by_node()
i2c: muxes: i2c-mux-gpmux: Use of_get_i2c_adapter_by_node()

 drivers/i2c/muxes/i2c-demux-pinctrl.c | 2 +-
 drivers/i2c/muxes/i2c-mux-gpmux.c     | 2 +-
 drivers/i2c/muxes/i2c-mux-pinctrl.c   | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)
Signature · 1 line
2.41.0
#1 lore raw

PATCH 1/3 i2c: muxes: i2c-mux-pinctrl: Use of_get_i2c_adapter_by_node()

i2c-mux-pinctrl uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle correctly the module refcount.

---
 drivers/i2c/muxes/i2c-mux-pinctrl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/muxes/i2c-mux-pinctrl.c +1 -1
index 18236b9fa14a..6ebca7bfd8a2 100644
@@ -62,7 +62,7 @@ static struct i2c_adapter *i2c_mux_pinctrl_parent_adapter(struct device *dev)
 		dev_err(dev, "Cannot parse i2c-parent\n");
 		return ERR_PTR(-ENODEV);
 	}
-	parent = of_find_i2c_adapter_by_node(parent_np);
+	parent = of_get_i2c_adapter_by_node(parent_np);
 	of_node_put(parent_np);
 	if (!parent)
 		return ERR_PTR(-EPROBE_DEFER);
Signature · 1 line
2.41.0
Acked-by on v1 1/3
#2 lore raw

Re: [PATCH 1/3] i2c: muxes: i2c-mux-pinctrl: Use of_get_i2c_adapter_by_node()

Hi!

Quoted 7 lines · Herve Codina

i2c-mux-pinctrl uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Perhaps "... underflow of the parent module refcount."?

Quoted 5 lines

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle correctly the module refcount.

Good find, and sorry about that!

Fixes c4aee3e1b0de ("i2c: mux: pinctrl: remove platform_data")

Cheers,
Peter

Quoted 17 lines
---
 drivers/i2c/muxes/i2c-mux-pinctrl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/muxes/i2c-mux-pinctrl.c +1 -1
index 18236b9fa14a..6ebca7bfd8a2 100644
@@ -62,7 +62,7 @@ static struct i2c_adapter *i2c_mux_pinctrl_parent_adapter(struct device *dev)
 		dev_err(dev, "Cannot parse i2c-parent\n");
 		return ERR_PTR(-ENODEV);
 	}
-	parent = of_find_i2c_adapter_by_node(parent_np);
+	parent = of_get_i2c_adapter_by_node(parent_np);
 	of_node_put(parent_np);
 	if (!parent)
 		return ERR_PTR(-EPROBE_DEFER);
#3 lore raw

Re: [PATCH 1/3] i2c: muxes: i2c-mux-pinctrl: Use of_get_i2c_adapter_by_node()

Hi Peter,

Quoted 7 lines · On Thu, 19 Oct 2023 11:25:35 +0200 Peter Rosin <[email protected]> wrote:

Hi!

Quoted 4 lines · Herve Codina

i2c-mux-pinctrl uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Quoted 5 lines
Quoted 3 lines

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Perhaps "... underflow of the parent module refcount."?

Yes, will be changed in the next iteration.

Quoted 5 lines
Quoted 5 lines

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle correctly the module refcount.

Quoted 7 lines
Quoted 1 line

Good find, and sorry about that!

Fixes c4aee3e1b0de ("i2c: mux: pinctrl: remove platform_data")

Will be added in the next iteration.

Thanks for the review,
Hervé

#4 lore raw

PATCH 2/3 i2c: muxes: i2c-demux-pinctrl: Use of_get_i2c_adapter_by_node()

In reply to Herve Codina

i2c-demux-pinctrl uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while
of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle
correctly the module refcount.

---
 drivers/i2c/muxes/i2c-demux-pinctrl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/muxes/i2c-demux-pinctrl.c +1 -1
index 22f2280eab7f..9f2e4aa28159 100644
@@ -61,7 +61,7 @@ static int i2c_demux_activate_master(struct i2c_demux_pinctrl_priv *priv, u32 ne
 	if (ret)
 		goto err;
 
-	adap = of_find_i2c_adapter_by_node(priv->chan[new_chan].parent_np);
+	adap = of_get_i2c_adapter_by_node(priv->chan[new_chan].parent_np);
 	if (!adap) {
 		ret = -ENODEV;
 		goto err_with_revert;
Signature · 1 line
2.41.0
Acked-by on v1 2/3
#5 lore raw

Re: [PATCH 2/3] i2c: muxes: i2c-demux-pinctrl: Use of_get_i2c_adapter_by_node()

Hi!

Quoted 7 lines · Herve Codina

i2c-demux-pinctrl uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while
of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Perhaps "... underflow of the parent module refcount."?

Quoted 5 lines

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle
correctly the module refcount.

Good find!

Fixes 50a5ba876908 ("i2c: mux: demux-pinctrl: add driver")

Cheers,
Peter

Quoted 17 lines
---
 drivers/i2c/muxes/i2c-demux-pinctrl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/muxes/i2c-demux-pinctrl.c +1 -1
index 22f2280eab7f..9f2e4aa28159 100644
@@ -61,7 +61,7 @@ static int i2c_demux_activate_master(struct i2c_demux_pinctrl_priv *priv, u32 ne
 	if (ret)
 		goto err;
 
-	adap = of_find_i2c_adapter_by_node(priv->chan[new_chan].parent_np);
+	adap = of_get_i2c_adapter_by_node(priv->chan[new_chan].parent_np);
 	if (!adap) {
 		ret = -ENODEV;
 		goto err_with_revert;
#6 lore raw

Re: [PATCH 2/3] i2c: muxes: i2c-demux-pinctrl: Use of_get_i2c_adapter_by_node()

Hi Peter,

Quoted 7 lines · On Thu, 19 Oct 2023 11:26:14 +0200 Peter Rosin <[email protected]> wrote:

Hi!

Quoted 4 lines · Herve Codina

i2c-demux-pinctrl uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Quoted 5 lines
Quoted 3 lines

Indeed, i2c_put_adapter() decrements the module refcount while
of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Perhaps "... underflow of the parent module refcount."?

Will be changed in the next iteration

Quoted 5 lines
Quoted 5 lines

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle
correctly the module refcount.

Quoted 7 lines
Quoted 1 line

Good find!

Fixes 50a5ba876908 ("i2c: mux: demux-pinctrl: add driver")

Will be added in the next iteration.

Thanks for the review,
Hervé

#7 lore raw

PATCH 3/3 i2c: muxes: i2c-mux-gpmux: Use of_get_i2c_adapter_by_node()

In reply to Herve Codina

i2c-mux-gpmux uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle correctly the module refcount.

---
 drivers/i2c/muxes/i2c-mux-gpmux.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/muxes/i2c-mux-gpmux.c +1 -1
index baccf4bfaf02..8305661e1253 100644
@@ -52,7 +52,7 @@ static struct i2c_adapter *mux_parent_adapter(struct device *dev)
 		dev_err(dev, "Cannot parse i2c-parent\n");
 		return ERR_PTR(-ENODEV);
 	}
-	parent = of_find_i2c_adapter_by_node(parent_np);
+	parent = of_get_i2c_adapter_by_node(parent_np);
 	of_node_put(parent_np);
 	if (!parent)
 		return ERR_PTR(-EPROBE_DEFER);
Signature · 1 line
2.41.0
Acked-by on v1 3/3
#8 lore raw

Re: [PATCH 3/3] i2c: muxes: i2c-mux-gpmux: Use of_get_i2c_adapter_by_node()

Hi!

Quoted 7 lines · Herve Codina

i2c-mux-gpmux uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Perhaps "... underflow of the parent module refcount."?

Quoted 5 lines

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle correctly the module refcount.

Good find, and sorry about that!

Fixes ac8498f0ce53 ("i2c: i2c-mux-gpmux: new driver")

Cheers,
Peter

Quoted 17 lines
---
 drivers/i2c/muxes/i2c-mux-gpmux.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/muxes/i2c-mux-gpmux.c +1 -1
index baccf4bfaf02..8305661e1253 100644
@@ -52,7 +52,7 @@ static struct i2c_adapter *mux_parent_adapter(struct device *dev)
 		dev_err(dev, "Cannot parse i2c-parent\n");
 		return ERR_PTR(-ENODEV);
 	}
-	parent = of_find_i2c_adapter_by_node(parent_np);
+	parent = of_get_i2c_adapter_by_node(parent_np);
 	of_node_put(parent_np);
 	if (!parent)
 		return ERR_PTR(-EPROBE_DEFER);
#9 lore raw

Re: [PATCH 3/3] i2c: muxes: i2c-mux-gpmux: Use of_get_i2c_adapter_by_node()

Hi Peter,

Quoted 7 lines · On Thu, 19 Oct 2023 11:26:41 +0200 Peter Rosin <[email protected]> wrote:

Hi!

Quoted 4 lines · Herve Codina

i2c-mux-gpmux uses the pair of_find_i2c_adapter_by_node() / i2c_put_adapter(). These pair alone is not correct to properly lock the I2C parent adapter.

Quoted 5 lines
Quoted 3 lines

Indeed, i2c_put_adapter() decrements the module refcount while of_find_i2c_adapter_by_node() does not increment it. This leads to an overflow over zero of the parent adapter user counter.

Perhaps "... underflow of the parent module refcount."?

Yes, will be changed in the next iteration.

Quoted 11 lines
Quoted 6 lines

Use the dedicated function, of_get_i2c_adapter_by_node(), to handle correctly the module refcount.

Good find, and sorry about that!

Fixes ac8498f0ce53 ("i2c: i2c-mux-gpmux: new driver")

Will be added in the next iteration.

Thanks for the review,
Hervé