i2c: i801: Fix resume bug
PATCH v2 1/2 i2c: i801: Fix resume bug
From: Volker Rümelin <[email protected]>
On suspend the original host configuration gets restored. The resume routine has to undo this, otherwise the SMBus master may be left in disabled state or in i2c mode.
[JD: Rebased on v5.8, moved the write into i801_setup_hstcfg.]
---
I noticed this bug in a QEMU x86_64 q35 VM booted with OVMF. OVMF doesn't inititialize the SMBus master. After 1s of SMBus inactivity autosuspend disables the SMBus master. To reproduce please note QEMU's ICH9 SMBus emulation does not handle interrupts and it's necessary to pass the parameter disable_features=0x10 to the i2c_i801 driver.
Changes since v1:
* Move the write into i801_setup_hstcfg() itself (suggested by Wolfram Sang).
* Pass struct i801_priv * as the parameter to i801_setup_hstcfg(). It includes everything we need.
drivers/i2c/busses/i2c-i801.c | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-)
drivers/i2c/busses/i2c-i801.c +14 -7
@@ -1709,6 +1709,16 @@ static inline int i801_acpi_probe(structstatic inline void i801_acpi_remove (struct i801_priv *priv) { }#endif +static unsigned char i801_setup_hstcfg (struct i801_priv *priv) +{ +unsigned char hstcfg = priv->original_hstcfg; + + hstcfg &= ~SMBHSTCFG_I2C_EN ;/* SMBus timing */ + hstcfg |=SMBHSTCFG_HST_EN ; +pci_write_config_byte (priv->pci_dev,SMBHSTCFG , hstcfg); +return hstcfg; +} +static int i801_probe (struct pci_dev *dev,const struct pci_device_id *id) {unsigned char temp;
@@ -1830,14 +1840,10 @@ static int i801_probe(struct pci_dev *dereturn err; } -pci_read_config_byte (priv->pci_dev,SMBHSTCFG , &temp); - priv->original_hstcfg = temp; - temp &= ~SMBHSTCFG_I2C_EN ;/* SMBus timing */ -if (!(temp &SMBHSTCFG_HST_EN )) { +pci_read_config_byte (priv->pci_dev,SMBHSTCFG , &priv->original_hstcfg); + temp =i801_setup_hstcfg (priv); +if (!(priv->original_hstcfg &SMBHSTCFG_HST_EN ))dev_info (&dev->dev,"Enabling SMBus device\n" ); - temp |=SMBHSTCFG_HST_EN ; - } -pci_write_config_byte (priv->pci_dev,SMBHSTCFG , temp);if (temp &SMBHSTCFG_SMB_SMI_EN ) {dev_dbg (&dev->dev,"SMBus using interrupt SMI#\n" );
@@ -1963,6 +1969,7 @@ static int i801_resume(struct device *de {struct i801_priv *priv =dev_get_drvdata (dev); +i801_setup_hstcfg (priv);i801_enable_host_notify (&priv->adapter);return 0 ;
Signature · 2 lines
Jean Delvare SUSE L3 Support
PATCH v2 2/2 i2c: i801: Simplify the suspend callback
We don't actually need to derive the PCI device from the device structure, as we already have a pointer to it in our private data structure.
--- drivers/i2c/busses/i2c-i801.c | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-)
This makes suspend and resume mostly symmetric again :-)
Changes since v1: New.
drivers/i2c/busses/i2c-i801.c +2 -3
@@ -1958,10 +1958,9 @@ static void i801_shutdown(struct pci_dev#ifdef CONFIG_PM_SLEEP static int i801_suspend (struct device *dev) { -struct pci_dev *pci_dev =to_pci_dev (dev); -struct i801_priv *priv =pci_get_drvdata (pci_dev); +struct i801_priv *priv =dev_get_drvdata (dev); -pci_write_config_byte (pci_dev,SMBHSTCFG , priv->original_hstcfg); +pci_write_config_byte (priv->pci_dev,SMBHSTCFG , priv->original_hstcfg);return 0 ; }
Signature · 2 lines
Jean Delvare SUSE L3 Support
Quoted 10 lines · Jean Delvare
From: Volker Rümelin <[email protected]>
On suspend the original host configuration gets restored. The resume routine has to undo this, otherwise the SMBus master may be left in disabled state or in i2c mode.
[JD: Rebased on v5.8, moved the write into
i801_setup_hstcfg.]Signed-off-by Volker Rümelin <[email protected]>Signed-off-by Jean Delvare <[email protected]>
Oh and by the way this deserves a Cc: stable@, methinks.
Signature · 2 lines
Jean Delvare SUSE L3 Support
Hi Jean,
with these two patches the code in i2c-i801.c looks really good.
But there is an issue with the reproducer.
Quoted 5 lines
I noticed this bug in a QEMU
x86_64q35 VM booted with OVMF. OVMF doesn't inititialize the SMBus master. After 1s of SMBus inactivity autosuspend disables the SMBus master. To reproduce please note QEMU's ICH9 SMBus emulation does not handle interrupts and it's necessary to pass the parameter disable_features=0x10 to thei2c_i801driver.
Since commit a9c8088c7988e "i2c: i801: Don't restore config registers on runtime PM" the reproducer doesn't work anymore. This is because commit a9c8088c7988e works as intended and the pm->runtime_* callbacks no longer call i801_suspend() and i801_resume().
But there is more. With the SMBus master in runtime suspended state the direct-complete mechanism skips the calls to the pm->suspend and pm->resume callbacks on system suspend/resume. I am convinced in nearly all cases this disables the fix from commit a5aaea37858fb "i2c-i801: Restore the device state before leaving".
At the moment I see two ways to fix this problem. One way is to revert a9c8088c7988e "i2c: i801: Don't restore config registers on runtime PM", the other is to set the driver flag DPM_FLAG_NO_DIRECT_COMPLETE in i801_probe(). I tested both, but I can't decide which way is better.
With best regards,
Volker
Hi Volker, hi Jean,
Quoted 5 lines · Volker Rümelin
Hi Jean,
with these two patches the code in
i2c-i801.clooks really good.But there is an issue with the reproducer.
I am not familiar with the HW; do we want these two patches here or does the issue below need to be solved first? And if we want them, is it still stable material?
Regards,
Wolfram
Quoted 28 lines
Quoted 6 lines
I noticed this bug in a QEMU
x86_64q35 VM booted with OVMF. OVMF doesn't inititialize the SMBus master. After 1s of SMBus inactivity autosuspend disables the SMBus master. To reproduce please note QEMU's ICH9 SMBus emulation does not handle interrupts and it's necessary to pass the parameter disable_features=0x10 to thei2c_i801driver.Since commit
a9c8088c7988e"i2c: i801: Don't restore config registers on runtime PM" the reproducer doesn't work anymore. This is because commita9c8088c7988eworks as intended and the pm->runtime_* callbacks no longer calli801_suspend()andi801_resume().But there is more. With the SMBus master in runtime suspended state the direct-complete mechanism skips the calls to the
pm->suspendandpm->resumecallbacks on system suspend/resume. I am convinced in nearly all cases this disables the fix from commita5aaea37858fb"i2c-i801: Restore the device state before leaving".At the moment I see two ways to fix this problem. One way is to revert
a9c8088c7988e"i2c: i801: Don't restore config registers on runtime PM", the other is to set the driver flagDPM_FLAG_NO_DIRECT_COMPLETEini801_probe(). I tested both, but I can't decide which way is better.With best regards,
Volker
Hi Volker,
Quoted 1 line · Volker Rümelin
with these two patches the code in
i2c-i801.clooks really good.
Great, thanks for the review.
Quoted 8 lines
But there is an issue with the reproducer.
Quoted 5 lines
I noticed this bug in a QEMU
x86_64q35 VM booted with OVMF. OVMF doesn't inititialize the SMBus master. After 1s of SMBus inactivity autosuspend disables the SMBus master. To reproduce please note QEMU's ICH9 SMBus emulation does not handle interrupts and it's necessary to pass the parameter disable_features=0x10 to thei2c_i801driver.
Quoted 5 lines
Since commit
a9c8088c7988e"i2c: i801: Don't restore config registers on runtime PM" the reproducer doesn't work anymore. This is because commita9c8088c7988eworks as intended and the pm->runtime_* callbacks no longer calli801_suspend()andi801_resume().
To be honest I was surprised that you were able to reproduce the resume bug with QEMU in the first place. I did not remember about commit a9c8088c7988e.
Quoted 5 lines
But there is more. With the SMBus master in runtime suspended state the direct-complete mechanism skips the calls to the
pm->suspendandpm->resumecallbacks on system suspend/resume. I am convinced in nearly all cases this disables the fix from commita5aaea37858fb"i2c-i801: Restore the device state before leaving".
My understanding of the PM subsystem is fairly limited (it evolves faster than my leaning curve I'm afraid) but you are most certainly right on that.
Quoted 5 lines
At the moment I see two ways to fix this problem. One way is to revert
a9c8088c7988e"i2c: i801: Don't restore config registers on runtime PM", the other is to set the driver flagDPM_FLAG_NO_DIRECT_COMPLETEini801_probe(). I tested both, but I can't decide which way is better.
Reverting a9c8088c7988e would make run-time PM inefficient again, so I am opposed to doing that. Flag DPM_FLAG_NO_DIRECT_COMPLETE seems to have been introduced for exactly this purpose, so I would just use that. To be honest I don't really understand why it is not the default, but again I don't know much about the PM subsystem.
Signature · 2 lines
Jean Delvare SUSE L3 Support
Hi Wolfram,
Quoted 8 lines · Wolfram Sang
Quoted 3 lines · Volker Rümelin
with these two patches the code in
i2c-i801.clooks really good.But there is an issue with the reproducer.
I am not familiar with the HW; do we want these two patches here or does the issue below need to be solved first? And if we want them, is it still stable material?
The new issue pointed out by Volker is independent from the bug being fixed here. We do want these 2 patches applied now, with the 1st one being stable material. The second patch is only a clean-up so it doesn't need to go to stable.
This new issue exists since April 2018. I'm surprised it wasn't reported as a regression earlier. Maybe newer BIOSes are getting better at not making assumptions about register states at suspend time (let me dream!) Anyway, it deserves its own fix, which also qualifies for stable in my opinion.
Signature · 2 lines
Jean Delvare SUSE L3 Support
Quoted 10 lines · Jean Delvare
From: Volker Rümelin <[email protected]>
On suspend the original host configuration gets restored. The resume routine has to undo this, otherwise the SMBus master may be left in disabled state or in i2c mode.
[JD: Rebased on v5.8, moved the write into
i801_setup_hstcfg.]Signed-off-by Volker Rümelin <[email protected]>Signed-off-by Jean Delvare <[email protected]>
Added stable and applied to for-current, thanks!
Re: [PATCH v2 2/2] i2c: i801: Simplify the suspend callback
In reply to Jean DelvareQuoted 5 lines · Jean Delvare
We don't actually need to derive the PCI device from the device structure, as we already have a pointer to it in our private data structure.
Signed-off-by Jean Delvare <[email protected]>
To reduce dependencies, this is also applied to for-current, thanks!