i2c: i801: Fix interrupt storm from SMB_ALERT signal
PATCH v3 1/1 i2c: i801: Fix interrupt storm from SMB_ALERT signal
Currently interrupt storm will occur from i2c-i801 after first transaction if SMB_ALERT signal is enabled and ever asserted. It is enough if the signal is asserted once even before the driver is loaded and does not recover because that interrupt is not acknowledged.
This fix aims to fix it by two ways:
- Add acknowledging for the SMB_ALERT interrupt status
- Disable the SMB_ALERT interrupt on platforms where possible since the driver currently does not make use for it
Acknowledging resets the SMB_ALERT interrupt status on all platforms and also should help to avoid interrupt storm on older platforms where the SMB_ALERT interrupt disabling is not available.
For simplicity this fix reuses the host notify feature for disabling and restoring original register value.
---
v3: Add comment from Jean Delvare why SMB_ALERT interrupt is blocked for
now. Simplify comment about SMB_ALERT status clearing
v2: More verbose commenting around interrupt acknowledging, reporting
and SMB_ALERT disabling. Fix typo in commit log and split the first sentence.
v1:
Hi Conrad and Stephane. This patch is otherwise the same than the one I had in bugzilla but this adds also acknowledging for the SMB_ALERT interrupt. There is short time window during driver load and unload where interrupt storm will still occur if signal was asserted. Also interrupt disabling is possible only on ICH3 and later so interrupt acknowledging should also help those old platforms.
--- drivers/i2c/busses/i2c-i801.c | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-)
drivers/i2c/busses/i2c-i801.c +19 -6
@@ -191,6 +191,7 @@#define SMBSLVSTS_HST_NTFY_STS BIT(0)/* Host Notify Command register bits */ +#define SMBSLVCMD_SMBALERT_DISABLE BIT(2)#define SMBSLVCMD_HST_NTFY_INTREN BIT(0)#define STATUS_ERROR_FLAGS (SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
@@ -642,12 +643,20 @@ static irqreturn_t i801_isr(int irq, void *dev_id)i801_isr_byte_done (priv);/* -* Clear irq sources and report transaction result. +* Clear remaining irq sources: Completion of last command, errors +* and the SMB_ALERT signal. SMB_ALERT status is set after signal +* assertion independently is the interrupt generation blocked or not +* so clear it always when the status is set. +*/ + status &=SMBHSTSTS_INTR |STATUS_ERROR_FLAGS |SMBHSTSTS_SMBALERT_STS ; +if (status) +outb_p (status,SMBHSTSTS (priv)); + status &= ~SMBHSTSTS_SMBALERT_STS ;/* SMB_ALERT not reported */ +/* +* Report transaction result. * ->status must be cleared before the next transaction is started. */ - status &=SMBHSTSTS_INTR |STATUS_ERROR_FLAGS ;if (status) { -outb_p (status,SMBHSTSTS (priv)); priv->status = status;complete (&priv->done); }
@@ -975,9 +984,13 @@ static void i801_enable_host_notify(struct i2c_adapter *adapter)if (!(priv->features &FEATURE_HOST_NOTIFY ))return ; -if (!(SMBSLVCMD_HST_NTFY_INTREN & priv->original_slvcmd)) -outb_p (SMBSLVCMD_HST_NTFY_INTREN | priv->original_slvcmd, -SMBSLVCMD (priv)); +/* +* Enable host notify interrupt and block the generation of interrupt +* from the SMB_ALERT signal because the driver does not support +* SMBus Alert yet. +*/ +outb_p (SMBSLVCMD_HST_NTFY_INTREN |SMBSLVCMD_SMBALERT_DISABLE | + priv->original_slvcmd,SMBSLVCMD (priv));/* clear Host Notify bit to allow a new notification */ outb_p (SMBSLVSTS_HST_NTFY_STS ,SMBSLVSTS (priv));
Signature · 1 line
2.33.0
Quoted 10 lines · Jarkko Nikula
Currently interrupt storm will occur from i2c-i801 after first transaction if
SMB_ALERTsignal is enabled and ever asserted. It is enough if the signal is asserted once even before the driver is loaded and does not recover because that interrupt is not acknowledged.This fix aims to fix it by two ways:
- Add acknowledging for theSMB_ALERTinterrupt status
- Disable theSMB_ALERTinterrupt on platforms where possible since the driver currently does not make use for it
Quoted 6 lines
Acknowledging resets the
SMB_ALERTinterrupt status on all platforms and also should help to avoid interrupt storm on older platforms where theSMB_ALERTinterrupt disabling is not available.For simplicity this fix reuses the host notify feature for disabling and restoring original register value.
With proposed modification (to the text) below, FWIW,
Quoted 34 lines
Reported-by [email protected]Reported-by [email protected]Signed-off-by Jarkko Nikula <[email protected]>---
v3: Add comment from Jean Delvare whySMB_ALERTinterrupt is blocked for
now. Simplify comment aboutSMB_ALERTstatus clearing
v2: More verbose commenting around interrupt acknowledging, reporting
andSMB_ALERTdisabling. Fix typo in commit log and split the first sentence.
v1:
Hi Conrad and Stephane. This patch is otherwise the same than the one I had in bugzilla but this adds also acknowledging for theSMB_ALERTinterrupt. There is short time window during driver load and unload where interrupt storm will still occur if signal was asserted. Also interrupt disabling is possible only on ICH3 and later so interrupt acknowledging should also help those old platforms.--- drivers/i2c/busses/i2c-i801.c | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-)drivers/i2c/busses/i2c-i801.c +1
-0@@ -191,6 +191,7 @@#define SMBSLVSTS_HST_NTFY_STS BIT(0)/* Host Notify Command register bits */ +#define SMBSLVCMD_SMBALERT_DISABLE BIT(2)#define SMBSLVCMD_HST_NTFY_INTREN BIT(0)#define STATUS_ERROR_FLAGS (SMBHSTSTS_FAILED | SMBHSTSTS_BUS_ERR | \
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 646
Quoted 5 lines
drivers/i2c/busses/i2c-i801.c +1
-1@@ -642,12 +643,20 @@ static irqreturn_t i801_isr(int irq, void *dev_id)i801_isr_byte_done (priv);/* -* Clear irq sources and report transaction result. +* Clear remaining irq sources: Completion of last command, errors
irq --> IRQ
of last --> of the last
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 648
Quoted 2 lines
drivers/i2c/busses/i2c-i801.c +2
-0+* and the SMB_ALERT signal. SMB_ALERT status is set after signal +* assertion independently is the interrupt generation blocked or not
is --> if ?
Quoted 17 lines
drivers/i2c/busses/i2c-i801.c +8
-2+* so clear it always when the status is set. +*/ + status &=SMBHSTSTS_INTR |STATUS_ERROR_FLAGS |SMBHSTSTS_SMBALERT_STS ; +if (status) +outb_p (status,SMBHSTSTS (priv)); + status &= ~SMBHSTSTS_SMBALERT_STS ;/* SMB_ALERT not reported */ +/* +* Report transaction result. * ->status must be cleared before the next transaction is started. */ - status &=SMBHSTSTS_INTR |STATUS_ERROR_FLAGS ;if (status) { -outb_p (status,SMBHSTSTS (priv)); priv->status = status;complete (&priv->done); }
drivers/i2c/busses/i2c-i801.c static void i801_enable_host_notify(struct i2c_adapter *adapter) · line 990
Quoted 10 lines
drivers/i2c/busses/i2c-i801.c +4
-3@@ -975,9 +984,13 @@ static void i801_enable_host_notify(struct i2c_adapter *adapter)if (!(priv->features &FEATURE_HOST_NOTIFY ))return ; -if (!(SMBSLVCMD_HST_NTFY_INTREN & priv->original_slvcmd)) -outb_p (SMBSLVCMD_HST_NTFY_INTREN | priv->original_slvcmd, -SMBSLVCMD (priv)); +/* +* Enable host notify interrupt and block the generation of interrupt +* from the SMB_ALERT signal because the driver does not support +* SMBus Alert yet.
does not support ... yet -->
has not supported ... yet
does not support
?
Quoted 9 lines
drivers/i2c/busses/i2c-i801.c +3
-0+*/ +outb_p (SMBSLVCMD_HST_NTFY_INTREN |SMBSLVCMD_SMBALERT_DISABLE | + priv->original_slvcmd,SMBSLVCMD (priv));/* clear Host Notify bit to allow a new notification */ outb_p (SMBSLVSTS_HST_NTFY_STS ,SMBSLVSTS (priv));Signature · 1 line
2.33.0
Signature · 2 lines
With Best Regards, Andy Shevchenko
Hi
Quoted 8 lines · Andy Shevchenko
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 646
Quoted 3 lines · Jarkko Nikula
/*
drivers/i2c/busses/i2c-i801.c +1
-1-* Clear irq sources and report transaction result. +* Clear remaining irq sources: Completion of last command, errors irq --> IRQ
of last --> of the last
Ah, worth of changing while changing the line.
Quoted 5 lines
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 648
Quoted 2 lines
drivers/i2c/busses/i2c-i801.c +2
-0+* and the SMB_ALERT signal. SMB_ALERT status is set after signal +* assertion independently is the interrupt generation blocked or not is --> if ?
hmm, I don't know which one is correct or neither. Or should it be something like "independently of whether the interrupt generation is blocked or not"? Grammar polices, please help me :-)
Quoted 16 lines
drivers/i2c/busses/i2c-i801.c static void i801_enable_host_notify(struct i2c_adapter *adapter) · line 990
Quoted 11 lines
drivers/i2c/busses/i2c-i801.c +4
-3@@ -975,9 +984,13 @@ static void i801_enable_host_notify(struct i2c_adapter *adapter)if (!(priv->features &FEATURE_HOST_NOTIFY ))return ; -if (!(SMBSLVCMD_HST_NTFY_INTREN & priv->original_slvcmd)) -outb_p (SMBSLVCMD_HST_NTFY_INTREN | priv->original_slvcmd, -SMBSLVCMD (priv)); +/* +* Enable host notify interrupt and block the generation of interrupt +* from the SMB_ALERT signal because the driver does not support +* SMBus Alert yet. does not support ... yet -->
has not supported ... yet
does not support
Quoted 1 line
?
yeah, yet is speculative, perhaps better to drop.
Jarkko
Quoted 10 lines · Jarkko Nikula
Quoted 8 lines · Andy Shevchenko
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 648
Quoted 5 lines · Jarkko Nikula
drivers/i2c/busses/i2c-i801.c +3
-1/* -* Clear irq sources and report transaction result. +* Clear remaining irq sources: Completion of last command, errors +* and the SMB_ALERT signal. SMB_ALERT status is set after signal +* assertion independently is the interrupt generation blocked or not is --> if ?
Quoted 3 lines
hmm, I don't know which one is correct or neither. Or should it be something like "independently of whether the interrupt generation is blocked or not"? Grammar polices, please help me :-)
... independently of the interrupt generation being blocked or not.
Sounds better?
(I think your "of whether" variant is grammatically correct too, if you prefer that.)
Signature · 2 lines
Jean Delvare SUSE L3 Support
Quoted 15 lines · Jean Delvare
Quoted 10 lines · Jarkko Nikula
Quoted 8 lines · Andy Shevchenko
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 648
Quoted 5 lines · Jarkko Nikula
drivers/i2c/busses/i2c-i801.c +3
-1/* -* Clear irq sources and report transaction result. +* Clear remaining irq sources: Completion of last command, errors +* and the SMB_ALERT signal. SMB_ALERT status is set after signal +* assertion independently is the interrupt generation blocked or not is --> if ?
Quoted 3 lines
hmm, I don't know which one is correct or neither. Or should it be something like "independently of whether the interrupt generation is blocked or not"? Grammar polices, please help me :-)
Quoted 6 lines
... independently of the interrupt generation being blocked or not.
Sounds better?
(I think your "of whether" variant is grammatically correct too, if you prefer that.)
For the sake of bikeshedding :-) I lean to "whether" variant, because I think the determiner usage is decreasing over time, while its presence makes language richer.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 4 lines · Andy Shevchenko
Quoted 3 lines · Jean Delvare
Quoted 2 lines · Jarkko Nikula
Quoted 1 line · Andy Shevchenko
On Wed, Nov 10, 2021 at 04:10:32PM +0200, Jarkko Nikula wrote:
...
Quoted 10 lines
Quoted 10 lines
Quoted 9 lines
Quoted 5 lines
drivers/i2c/busses/i2c-i801.c static irqreturn_t i801_isr(int irq, void *dev_id) · line 648
Quoted 3 lines
drivers/i2c/busses/i2c-i801.c +3
-0+* Clear remaining irq sources: Completion of last command, errors +* and the SMB_ALERT signal. SMB_ALERT status is set after signal +* assertion independently is the interrupt generation blocked or not is --> if ?
hmm, I don't know which one is correct or neither. Or should it be something like "independently of whether the interrupt generation is blocked or not"? Grammar polices, please help me :-)
Quoted 8 lines
Quoted 6 lines
... independently of the interrupt generation being blocked or not.
Sounds better?
(I think your "of whether" variant is grammatically correct too, if you prefer that.)
For the sake of bikeshedding :-) I lean to "whether" variant, because I think
s/"whether"/"of whether"/
Quoted 2 lines
the determiner usage is decreasing over time, while its presence makes language richer.
Signature · 2 lines
With Best Regards, Andy Shevchenko