Skip to contentSkip to conversation

i2c: designware: Ensure runtime suspend is invoked during rapid slave unregistration and registration

PATCH In review [email protected] 3 participants 8 messages Apr 12, 2025 – May 12, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 i2c: designware: Ensure runtime suspend is invoked during rapid slave unregistration and registration

From: Tan En De <[email protected]>

Replaced pm_runtime_put() with pm_runtime_put_sync_suspend() to ensure the runtime suspend is invoked immediately when unregistering a slave. This prevents a race condition where suspend was skipped when unregistering and registering slave in quick succession.

---
 drivers/i2c/busses/i2c-designware-slave.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/busses/i2c-designware-slave.c +1 -1
index 5cd4a5f7a472..b936a240db0a 100644
@@ -96,7 +96,7 @@ static int i2c_dw_unreg_slave(struct i2c_client *slave)
 	i2c_dw_disable(dev);
 	synchronize_irq(dev->irq);
 	dev->slave = NULL;
-	pm_runtime_put(dev->dev);
+	pm_runtime_put_sync_suspend(dev->dev);
 
 	return 0;
 }
Signature · 1 line
2.34.1
#1 lore raw

Hi

Quoted 17 lines · On 4/12/25 5:33 AM, [email protected] wrote:

From: Tan En De <[email protected]>

Replaced pm_runtime_put() with pm_runtime_put_sync_suspend() to ensure the runtime suspend is invoked immediately when unregistering a slave. This prevents a race condition where suspend was skipped when unregistering and registering slave in quick succession.

---
  drivers/i2c/busses/i2c-designware-slave.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/i2c/busses/i2c-designware-slave.c +0 -0
index 5cd4a5f7a472..b936a240db0a 100644

drivers/i2c/busses/i2c-designware-slave.c static int i2c_dw_unreg_slave(struct i2c_client *slave) · line 102

Quoted 8 lines
drivers/i2c/busses/i2c-designware-slave.c +1 -1
@@ -96,7 +96,7 @@ static int i2c_dw_unreg_slave(struct i2c_client *slave)
  	i2c_dw_disable(dev);
  	synchronize_irq(dev->irq);
  	dev->slave = NULL;
-	pm_runtime_put(dev->dev);
+	pm_runtime_put_sync_suspend(dev->dev);
 
  	return 0;
  }

What kind of issue you are seeing?

I tried to test with no delay and 1 second delays between registering and unregistering. Power state was changing between D0 and D3 if there was delay between unregister and register but I could not see any issue.

author
#2 lore raw

It appears that when performing a rapid sequence of delete_device -> new_device -> delete_device -> new_device, the dw_i2c_plat_runtime_suspend is not invoked for the second delete_device.

This seems to happen because when i2c_dw_unreg_slave is about to trigger suspend during the second delete_device, the second new_device operation cancels the suspend. As a result, dw_i2c_plat_runtime_resume is not called (since there was no suspend), which means i_dev->init (i.e., i2c_dw_init_slave) is skipped.

Because i2c_dw_init_slave is skipped, i2c_dw_configure_fifo_slave is not invoked, which leaves DW_IC_INTR_MASK unconfigured. If we inspect the interrupt mask register using devmem, it will show as zero.

Here's an example shell script to reproduce the issue:

```
#!/bin/sh

SLAVE_LADDR=0x1010
SLAVE_BUS=13
NEW_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/new_device
DELETE_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/delete_device

# Create initial device
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
sleep 2

# Rapid sequence of delete_device -> new_device -> delete_device -> new_device
echo $SLAVE_LADDR > $DELETE_DEVICE
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
echo $SLAVE_LADDR > $DELETE_DEVICE
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE

# If we use devmem to inspect IC_INTR_MASK, it will show as zero
```
#3 lore raw

Hi

Sorry the delay. Comment below.

Quoted 20 lines · EnDe Tan

It appears that when performing a rapid sequence of delete_device -> new_device -> delete_device -> new_device, the dw_i2c_plat_runtime_suspend is not invoked for the second delete_device.

This seems to happen because when i2c_dw_unreg_slave is about to trigger suspend during the second delete_device, the second new_device operation cancels the suspend. As a result, dw_i2c_plat_runtime_resume is not called (since there was no suspend), which means i_dev->init (i.e., i2c_dw_init_slave) is skipped.

Because i2c_dw_init_slave is skipped, i2c_dw_configure_fifo_slave is not invoked, which leaves DW_IC_INTR_MASK unconfigured. If we inspect the interrupt mask register using devmem, it will show as zero.

Here's an example shell script to reproduce the issue:

```
#!/bin/sh

SLAVE_LADDR=0x1010
SLAVE_BUS=13
NEW_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/new_device
DELETE_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/delete_device

# Create initial device
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
sleep 2
Quoted 9 lines
# Rapid sequence of delete_device -> new_device -> delete_device -> new_device
echo $SLAVE_LADDR > $DELETE_DEVICE
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
echo $SLAVE_LADDR > $DELETE_DEVICE
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE

# If we use devmem to inspect IC_INTR_MASK, it will show as zero
```

Good explanation and could you add it the commit log together with the example?

maintainer
#4 lore raw

Hi EnDe,

Quoted 21 lines · Jarkko Nikula
Quoted 20 lines · EnDe Tan

It appears that when performing a rapid sequence of delete_device -> new_device -> delete_device -> new_device, the dw_i2c_plat_runtime_suspend is not invoked for the second delete_device.

This seems to happen because when i2c_dw_unreg_slave is about to trigger suspend during the second delete_device, the second new_device operation cancels the suspend. As a result, dw_i2c_plat_runtime_resume is not called (since there was no suspend), which means i_dev->init (i.e., i2c_dw_init_slave) is skipped.

Because i2c_dw_init_slave is skipped, i2c_dw_configure_fifo_slave is not invoked, which leaves DW_IC_INTR_MASK unconfigured. If we inspect the interrupt mask register using devmem, it will show as zero.

Here's an example shell script to reproduce the issue:
```
#!/bin/sh

SLAVE_LADDR=0x1010
SLAVE_BUS=13 NEW_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/new_device DELETE_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/delete_device

# Create initial device
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
sleep 2

Quoted 8 lines
Quoted 8 lines

# Rapid sequence of delete_device -> new_device -> delete_device -> new_device echo $SLAVE_LADDR > $DELETE_DEVICE
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
echo $SLAVE_LADDR > $DELETE_DEVICE
echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE

# If we use devmem to inspect IC_INTR_MASK, it will show as zero ```

Please, don't remove the interesting parts of the original email from your reply, otherwise it wouldn't be easy to follow the discussion. Please refer to the email netiquette[*].

Quoted 2 lines

Good explanation and could you add it the commit log together with the example?

If you want you can paste the new commit log as reply to this e-mail.

Thanks,
Andi

[*] https://www.ietf.org/rfc/rfc1855.txt

author
#5 lore raw

Hi Andi and Jarkko, thank you for the feedback.

Quoted 5 lines

-----Original Message-----
From: Andi Shyti <[email protected]>
Sent: Tuesday, 6 May, 2025 5:49 AM
To: Jarkko Nikula <[email protected]>
Cc: EnDe Tan <[email protected]>; [email protected];

...

Quoted 4 lines
Quoted 2 lines

Good explanation and could you add it the commit log together with the example?

If you want you can paste the new commit log as reply to this e-mail.

Here is the new commit log, feel free to let me know if further changes are required:

Replaced pm_runtime_put() with pm_runtime_put_sync_suspend() to ensure the runtime suspend is invoked immediately when unregistering a slave. This prevents a race condition where suspend was skipped when unregistering and registering slave in quick succession.

For example, consider the rapid sequence of
delete_device -> new_device -> delete_device -> new_device.
In this sequence, it is observed that the dw_i2c_plat_runtime_suspend() might not be invoked after delete_device operation.

This is because after delete_device operation, when the pm_runtime_put() is about to trigger suspend, the following new_device operation might race and cancel the suspend.

If that happens, during the new_device operation, dw_i2c_plat_runtime_resume() is skipped (since there was no suspend), which means i_dev->init(), i.e. i2c_dw_init_slave(), is skipped. Since i2c_dw_init_slave() is skipped, i2c_dw_configure_fifo_slave() is skipped too, which leaves DW_IC_INTR_MASK unconfigured. If we inspect the interrupt mask register using devmem, it will show as zero.

Example shell script to reproduce the issue:

```
  #!/bin/sh

  SLAVE_LADDR=0x1010
  SLAVE_BUS=13
  NEW_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/new_device
  DELETE_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/delete_device

  # Create initial device
  echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
  sleep 2

  # Rapid sequence of
  # delete_device -> new_device -> delete_device -> new_device
  echo $SLAVE_LADDR > $DELETE_DEVICE
  echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
  echo $SLAVE_LADDR > $DELETE_DEVICE
  echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE

  # Using devmem to inspect IC_INTR_MASK will show as zero
```
Acked-by
#6 lore raw
Quoted 50 lines · EnDe Tan

Hi Andi and Jarkko, thank you for the feedback.

Quoted 5 lines

-----Original Message-----
From: Andi Shyti <[email protected]>
Sent: Tuesday, 6 May, 2025 5:49 AM
To: Jarkko Nikula <[email protected]>
Cc: EnDe Tan <[email protected]>; [email protected];

...

Quoted 4 lines
Quoted 2 lines

Good explanation and could you add it the commit log together with the example?

If you want you can paste the new commit log as reply to this e-mail.

Here is the new commit log, feel free to let me know if further changes are required:

Replaced pm_runtime_put() with pm_runtime_put_sync_suspend() to ensure the runtime suspend is invoked immediately when unregistering a slave. This prevents a race condition where suspend was skipped when unregistering and registering slave in quick succession.

For example, consider the rapid sequence of
delete_device -> new_device -> delete_device -> new_device.
In this sequence, it is observed that the dw_i2c_plat_runtime_suspend() might not be invoked after delete_device operation.

This is because after delete_device operation, when the pm_runtime_put() is about to trigger suspend, the following new_device operation might race and cancel the suspend.

If that happens, during the new_device operation, dw_i2c_plat_runtime_resume() is skipped (since there was no suspend), which means i_dev->init(), i.e. i2c_dw_init_slave(), is skipped. Since i2c_dw_init_slave() is skipped, i2c_dw_configure_fifo_slave() is skipped too, which leaves DW_IC_INTR_MASK unconfigured. If we inspect the interrupt mask register using devmem, it will show as zero.

Example shell script to reproduce the issue:

```
   #!/bin/sh

   SLAVE_LADDR=0x1010
   SLAVE_BUS=13
   NEW_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/new_device
   DELETE_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/delete_device

   # Create initial device
   echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
   sleep 2

   # Rapid sequence of
Quoted 8 lines
   # delete_device -> new_device -> delete_device -> new_device
   echo $SLAVE_LADDR > $DELETE_DEVICE
   echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
   echo $SLAVE_LADDR > $DELETE_DEVICE
   echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE

   # Using devmem to inspect IC_INTR_MASK will show as zero
```
maintainer
#7 lore raw
In reply to EnDe Tan

Hi EnDe,

Quoted 50 lines · EnDe Tan

Hi Andi and Jarkko, thank you for the feedback.

Quoted 5 lines

-----Original Message-----
From: Andi Shyti <[email protected]>
Sent: Tuesday, 6 May, 2025 5:49 AM
To: Jarkko Nikula <[email protected]>
Cc: EnDe Tan <[email protected]>; [email protected];

...

Quoted 4 lines
Quoted 2 lines

Good explanation and could you add it the commit log together with the example?

If you want you can paste the new commit log as reply to this e-mail.

Here is the new commit log, feel free to let me know if further changes are required:

Replaced pm_runtime_put() with pm_runtime_put_sync_suspend() to ensure the runtime suspend is invoked immediately when unregistering a slave. This prevents a race condition where suspend was skipped when unregistering and registering slave in quick succession.

For example, consider the rapid sequence of
delete_device -> new_device -> delete_device -> new_device.
In this sequence, it is observed that the dw_i2c_plat_runtime_suspend() might not be invoked after delete_device operation.

This is because after delete_device operation, when the pm_runtime_put() is about to trigger suspend, the following new_device operation might race and cancel the suspend.

If that happens, during the new_device operation, dw_i2c_plat_runtime_resume() is skipped (since there was no suspend), which means i_dev->init(), i.e. i2c_dw_init_slave(), is skipped. Since i2c_dw_init_slave() is skipped, i2c_dw_configure_fifo_slave() is skipped too, which leaves DW_IC_INTR_MASK unconfigured. If we inspect the interrupt mask register using devmem, it will show as zero.

Example shell script to reproduce the issue:

```
  #!/bin/sh

  SLAVE_LADDR=0x1010
  SLAVE_BUS=13
  NEW_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/new_device
  DELETE_DEVICE=/sys/bus/i2c/devices/i2c-$SLAVE_BUS/delete_device

  # Create initial device
  echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
  sleep 2

  # Rapid sequence of
Quoted 8 lines
  # delete_device -> new_device -> delete_device -> new_device
  echo $SLAVE_LADDR > $DELETE_DEVICE
  echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE
  echo $SLAVE_LADDR > $DELETE_DEVICE
  echo slave-24c02 $SLAVE_LADDR > $NEW_DEVICE

  # Using devmem to inspect IC_INTR_MASK will show as zero
```

Thanks, merged to i2c/i2c-host.

I just reworded the title to:

i2c: designware: Invoke runtime suspend on quick slave re-registration

to keep it under 75 characters.

Thanks,
Andi