Skip to contentSkip to conversation

mfd: twl-core: Fix dangling twl_priv on teardown and probe failure

PATCH New Lee Jones 2 participants 5 messages Nov 19

Subsystems (3)
lore
Share & tools
lore

Lee Jones

author maintainer
#0 lore raw

v3 cover mfd: twl-core: Fix dangling twl_priv on teardown and probe failure

These issues were reported by Sashiko.

Patch 1 is the minimal, Stable-suitable fix from v2 (13/27), which was skipped when the rest of that series was applied due to a collision with "mfd: twl-core: Unregister the auxiliary platform device on unbind".

Patch 2 is the follow-up suggested by Andreas, converting the manual twl_priv reset to a devres action.

v2 => v3:
- Rebased patch 1 onto for-mfd-next
- Sent the previously standalone devres follow-up as patch 2

v2 (patch 1): https://lore.kernel.org/all/[email protected]/
v1 (patch 2): https://lore.kernel.org/all/[email protected]/

Cc Aaro Koskinen <[email protected]>
Cc Andreas Kemnade <[email protected]>
Cc Kai Svahn <[email protected]>
Cc Kevin Hilman <[email protected]>
Cc Peter Ujfalusi <[email protected]>
Cc Roger Quadros <[email protected]>
Cc Samuel Ortiz <[email protected]>
Cc syed khasim <[email protected]>
Cc Tony Lindgren <[email protected]>

Lee Jones (2):
mfd: twl-core: Clear twl_priv pointer on teardown and probe failure
mfd: twl-core: Reset twl_priv using devm_add_action_or_reset()

 drivers/mfd/twl-core.c | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)
Signature · 1 line
2.56.1.750.gf70dc682cf-goog
author maintainer
#1 lore raw

PATCH v3 1/2 mfd: twl-core: Clear twl_priv pointer on teardown and probe failure

twl_probe() allocates the file-scope twl_priv state with devm_kzalloc() and checks for a non-NULL twl_priv at entry to reject multiple device instances. However, twl_remove() and the early error paths in twl_probe() never reset twl_priv to NULL, a failure when adding MFD child devices bypasses twl_remove() by jumping to out instead of fail, and twl_remove() tears down the IRQ domain and dummy I2C clients before child devices are unregistered. After devres frees the underlying memory on probe failure or unbind, twl_priv remains a dangling pointer, causing subsequent exported API calls to dereference freed memory and blocking future probe attempts with -EBUSY.

Unregister DT-populated and MFD child devices at the start of twl_remove(), ensure mfd_add_devices() failures unwind via fail, and reset twl_priv to NULL in twl_remove() and on probe error exit.

Fixes 80a97ccd33be ("mfd: twl-core: Collect global variables behind one private structure (global)")

---

v2 => v3: Rebased onto for-mfd-next (the free: label is now out:)

 drivers/mfd/twl-core.c | 15 ++++++++++++---
 1 file changed, 12 insertions(+), 3 deletions(-)
drivers/mfd/twl-core.c +12 -3
index 55a7f579595c..7784e000b995 100644
@@ -691,6 +691,11 @@ static void twl_remove(struct i2c_client *client)
 {
 	unsigned i, num_slaves;
 
+	of_platform_depopulate(&client->dev);
+
+	if (twl_class_is_6030())
+		mfd_remove_devices(&client->dev);
+
 	if (pm_power_off == twl6030_power_off)
 		pm_power_off = NULL;
 
@@ -708,6 +713,7 @@ static void twl_remove(struct i2c_client *client)
 		twl->client = NULL;
 	}
 	twl_priv->ready = false;
+	twl_priv = NULL;
 }
 
 
@@ -883,10 +889,10 @@ twl_probe(struct i2c_client *client)
 			num_cells = ARRAY_SIZE(twl6030_cells);
 		}
 
-		status = devm_mfd_add_devices(&client->dev, PLATFORM_DEVID_NONE,
-					      cells, num_cells, NULL, 0, NULL);
+		status = mfd_add_devices(&client->dev, PLATFORM_DEVID_NONE,
+					 cells, num_cells, NULL, 0, NULL);
 		if (status < 0)
-			goto out;
+			goto fail;
 
 		if (of_device_is_system_power_controller(node)) {
 			if (!pm_power_off)
@@ -903,6 +909,9 @@ twl_probe(struct i2c_client *client)
 	if (status < 0)
 		twl_remove(client);
 out:
+	if (status < 0)
+		twl_priv = NULL;
+
 	return status;
 }
 
Signature · 1 line
2.56.1.750.gf70dc682cf-goog
#2 lore raw

Re: [PATCH v3 1/2] mfd: twl-core: Clear twl_priv pointer on teardown and probe failure

Sashiko has reviewed this patch and found no issues.
Quoted 11 lines

twl_probe() allocates the file-scope twl_priv state with devm_kzalloc() and checks for a non-NULL twl_priv at entry to reject multiple device instances. However, twl_remove() and the early error paths in twl_probe() never reset twl_priv to NULL, a failure when adding MFD child devices bypasses twl_remove() by jumping to out instead of fail, and twl_remove() tears down the IRQ domain and dummy I2C clients before child devices are unregistered. After devres frees the underlying memory on probe failure or unbind, twl_priv remains a dangling pointer, causing subsequent exported API calls to dereference freed memory and blocking future probe attempts with -EBUSY.

Quoted 8 lines

Unregister DT-populated and MFD child devices at the start of twl_remove(), ensure mfd_add_devices() failures unwind via fail, and reset twl_priv to NULL in twl_remove() and on probe error exit.

Fixes 80a97ccd33be ("mfd: twl-core: Collect global variables behind one private structure (global)")

Sashiko has reviewed this patch and found no issues.

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=1
author maintainer
#3 lore raw

PATCH v3 2/2 mfd: twl-core: Reset twl_priv using devm_add_action_or_reset()

In reply to Lee Jones

Register a devres cleanup action immediately after allocating twl_priv with devm_kzalloc() so that twl_priv is automatically reset to NULL just before its underlying memory is released on probe failure or driver unbind. This removes the need to manually clear twl_priv in both twl_remove() and the probe error unwind path.

---

v1 => v3: Previously sent standalone - now rebased onto patch 1

 drivers/mfd/twl-core.c | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)
drivers/mfd/twl-core.c +9 -4
index 7784e000b995..cef729109126 100644
@@ -713,7 +713,6 @@ static void twl_remove(struct i2c_client *client)
 		twl->client = NULL;
 	}
 	twl_priv->ready = false;
-	twl_priv = NULL;
 }
 
 
@@ -735,6 +734,11 @@ static void twl_unregister_device(void *data)
 	platform_device_unregister(data);
 }
 
+static void twl_reset_priv(void *data)
+{
+	twl_priv = NULL;
+}
+
 /* NOTE: This driver only handles a single twl4030/tps659x0 chip */
 static int
 twl_probe(struct i2c_client *client)
@@ -788,6 +792,10 @@ twl_probe(struct i2c_client *client)
 		goto out;
 	}
 
+	status = devm_add_action_or_reset(&client->dev, twl_reset_priv, NULL);
+	if (status)
+		goto out;
+
 	if ((id->driver_data) & TWL6030_CLASS) {
 		twl_priv->twl_id = TWL6030_CLASS_ID;
 		twl_priv->twl_map = &twl6030_map[0];
@@ -909,9 +917,6 @@ twl_probe(struct i2c_client *client)
 	if (status < 0)
 		twl_remove(client);
 out:
-	if (status < 0)
-		twl_priv = NULL;
-
 	return status;
 }
 
Signature · 1 line
2.56.1.750.gf70dc682cf-goog
#4 lore raw

Re: [PATCH v3 2/2] mfd: twl-core: Reset twl_priv using devm_add_action_or_reset()

Sashiko has reviewed this patch and found no issues.
Quoted 9 lines

Register a devres cleanup action immediately after allocating twl_priv with devm_kzalloc() so that twl_priv is automatically reset to NULL just before its underlying memory is released on probe failure or driver unbind. This removes the need to manually clear twl_priv in both twl_remove() and the probe error unwind path.

Sashiko has reviewed this patch and found no issues.

Signature · 1 line
Sashiko AI review · https://sashiko.dev/#/patchset/[email protected]?part=2