[PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Lino Sanfilippo]

If interrupts are not activated the work struct 'free_irq_work' is not
initialized. This results in a warning splat at module shutdown.

Fix this by always initializing the work regardless of whether interrupts
are activated or not.

cc: stable@vger.kernel.org
Fixes: 481c2d14627d ("tpm,tpm_tis: Disable interrupts after 1000 unhandled IRQs")
Reported-by: Jarkko Sakkinen <jarkko@kernel.org>
Closes: https://lore.kernel.org/all/CX32RFOMJUQ0.3R4YCL9MDCB96@kernel.org/
Signed-off-by: Lino Sanfilippo <l.sanfilippo@kunbus.com>
---
 drivers/char/tpm/tpm_tis_core.c | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/drivers/char/tpm/tpm_tis_core.c b/drivers/char/tpm/tpm_tis_core.c
index 1b350412d8a6..64c875657687 100644
--- a/drivers/char/tpm/tpm_tis_core.c
+++ b/drivers/char/tpm/tpm_tis_core.c
@@ -919,8 +919,6 @@ static int tpm_tis_probe_irq_single(struct tpm_chip *chip, u32 intmask,
 	int rc;
 	u32 int_status;
 
-	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
-
 	rc = devm_request_threaded_irq(chip->dev.parent, irq, NULL,
 				       tis_int_handler, IRQF_ONESHOT | flags,
 				       dev_name(&chip->dev), chip);
@@ -1132,6 +1130,7 @@ int tpm_tis_core_init(struct device *dev, struct tpm_tis_data *priv, int irq,
 	priv->phy_ops = phy_ops;
 	priv->locality_count = 0;
 	mutex_init(&priv->locality_count_mutex);
+	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
 
 	dev_set_drvdata(&chip->dev, priv);
 

base-commit: 41bccc98fb7931d63d03f326a746ac4d429c1dd3
-- 
2.43.0

RE: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Elliott, Robert (Servers)]

> From: Lino Sanfilippo <l.sanfilippo@kunbus.com>
> Sent: Thursday, February 1, 2024 5:37 AM
> Subject: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown
> 
> If interrupts are not activated the work struct 'free_irq_work' is not
> initialized. This results in a warning splat at module shutdown.
> 
> Fix this by always initializing the work regardless of whether interrupts
> are activated or not.

That's using flush_work(), which just waits for one to complete. Is there
any case where multiple work entries could be queued, and cancel_work_sync() 
would be necessary?

tpm_tis_probe_irq() has a loop calling tpm_tis_probe_irq_single()
for 3 to 15. Could each of those could trigger an interrupt storm and
call tpm_tis_revert_interrupts(), which calls schedule_work()?

Re: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Jarkko Sakkinen]

On Thu Feb 1, 2024 at 1:36 PM EET, Lino Sanfilippo wrote:
> If interrupts are not activated the work struct 'free_irq_work' is not
> initialized. This results in a warning splat at module shutdown.
>
> Fix this by always initializing the work regardless of whether interrupts
> are activated or not.
>
> cc: stable@vger.kernel.org
> Fixes: 481c2d14627d ("tpm,tpm_tis: Disable interrupts after 1000 unhandled IRQs")
> Reported-by: Jarkko Sakkinen <jarkko@kernel.org>
> Closes: https://lore.kernel.org/all/CX32RFOMJUQ0.3R4YCL9MDCB96@kernel.org/
> Signed-off-by: Lino Sanfilippo <l.sanfilippo@kunbus.com>
> ---
>  drivers/char/tpm/tpm_tis_core.c | 3 +--
>  1 file changed, 1 insertion(+), 2 deletions(-)
>
> diff --git a/drivers/char/tpm/tpm_tis_core.c b/drivers/char/tpm/tpm_tis_core.c
> index 1b350412d8a6..64c875657687 100644
> --- a/drivers/char/tpm/tpm_tis_core.c
> +++ b/drivers/char/tpm/tpm_tis_core.c
> @@ -919,8 +919,6 @@ static int tpm_tis_probe_irq_single(struct tpm_chip *chip, u32 intmask,
>  	int rc;
>  	u32 int_status;
>  
> -	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
> -
>  	rc = devm_request_threaded_irq(chip->dev.parent, irq, NULL,
>  				       tis_int_handler, IRQF_ONESHOT | flags,
>  				       dev_name(&chip->dev), chip);
> @@ -1132,6 +1130,7 @@ int tpm_tis_core_init(struct device *dev, struct tpm_tis_data *priv, int irq,
>  	priv->phy_ops = phy_ops;
>  	priv->locality_count = 0;
>  	mutex_init(&priv->locality_count_mutex);
> +	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
>  
>  	dev_set_drvdata(&chip->dev, priv);
>  
>
> base-commit: 41bccc98fb7931d63d03f326a746ac4d429c1dd3

Thank you had forgotten about this.

Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org>

BR, Jarkko

Re: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Jarkko Sakkinen]

On Thu Feb 1, 2024 at 6:40 PM EET, Elliott, Robert (Servers) wrote:
> > From: Lino Sanfilippo <l.sanfilippo@kunbus.com>
> > Sent: Thursday, February 1, 2024 5:37 AM
> > Subject: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown
> > 
> > If interrupts are not activated the work struct 'free_irq_work' is not
> > initialized. This results in a warning splat at module shutdown.
> > 
> > Fix this by always initializing the work regardless of whether interrupts
> > are activated or not.
>
> That's using flush_work(), which just waits for one to complete. Is there
> any case where multiple work entries could be queued, and cancel_work_sync() 
> would be necessary?

Questions are cool but please explain how this aligns with the patch
review because I already accepted the patch.

Should I drop it based on this question, and if so, why?

> tpm_tis_probe_irq() has a loop calling tpm_tis_probe_irq_single()
> for 3 to 15. Could each of those could trigger an interrupt storm and
> call tpm_tis_revert_interrupts(), which calls schedule_work()?

AFAIK no based on that TPM_CHIP_FLAG_IRQ should take care of this.

BR, Jarkko

Re: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Lino Sanfilippo]

On 01.02.24 17:40, Elliott, Robert (Servers) wrote:
> ATTENTION: This e-mail is from an external sender. Please check attachments and links before opening e.g. with mouseover.
> 
> 
>> From: Lino Sanfilippo <l.sanfilippo@kunbus.com>
>> Sent: Thursday, February 1, 2024 5:37 AM
>> Subject: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown
>>
>> If interrupts are not activated the work struct 'free_irq_work' is not
>> initialized. This results in a warning splat at module shutdown.
>>
>> Fix this by always initializing the work regardless of whether interrupts
>> are activated or not.
> 
> That's using flush_work(), which just waits for one to complete. Is there
> any case where multiple work entries could be queued, and cancel_work_sync()
> would be necessary?
> 

No. There is only one work struct (namely free_irq_work) and it can only be
queued once at a time (note that schedule_work() does not queue the same work
again if it is already queued).   

> tpm_tis_probe_irq() has a loop calling tpm_tis_probe_irq_single()
> for 3 to 15. Could each of those could trigger an interrupt storm and
> call tpm_tis_revert_interrupts(), which calls schedule_work()?
> 
> 

The iteration stops as soon as there is an interrupt found that "works" (i.e.
as soon as one interrupt fires, see the "irq test" in tpm_tis_send()). If this
irq starts a storm it is handled by the implemented irq storm handling and
deactivated. No other interrupts are activated afterwards. So no,
I do not see that multiple interrupt storms are possible at the same time.

Regards,
Lino

Re: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Paul Menzel]

Dear Lino,


Thank you for the patch.

Am 01.02.24 um 12:36 schrieb Lino Sanfilippo:
> If interrupts are not activated the work struct 'free_irq_work' is not
> initialized. This results in a warning splat at module shutdown.
> 
> Fix this by always initializing the work regardless of whether interrupts
> are activated or not.
> 
> cc: stable@vger.kernel.org
> Fixes: 481c2d14627d ("tpm,tpm_tis: Disable interrupts after 1000 unhandled IRQs")
> Reported-by: Jarkko Sakkinen <jarkko@kernel.org>
> Closes: https://lore.kernel.org/all/CX32RFOMJUQ0.3R4YCL9MDCB96@kernel.org/
> Signed-off-by: Lino Sanfilippo <l.sanfilippo@kunbus.com>
> ---
>   drivers/char/tpm/tpm_tis_core.c | 3 +--
>   1 file changed, 1 insertion(+), 2 deletions(-)
> 
> diff --git a/drivers/char/tpm/tpm_tis_core.c b/drivers/char/tpm/tpm_tis_core.c
> index 1b350412d8a6..64c875657687 100644
> --- a/drivers/char/tpm/tpm_tis_core.c
> +++ b/drivers/char/tpm/tpm_tis_core.c
> @@ -919,8 +919,6 @@ static int tpm_tis_probe_irq_single(struct tpm_chip *chip, u32 intmask,
>   	int rc;
>   	u32 int_status;
>   
> -	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
> -
>   	rc = devm_request_threaded_irq(chip->dev.parent, irq, NULL,
>   				       tis_int_handler, IRQF_ONESHOT | flags,
>   				       dev_name(&chip->dev), chip);
> @@ -1132,6 +1130,7 @@ int tpm_tis_core_init(struct device *dev, struct tpm_tis_data *priv, int irq,
>   	priv->phy_ops = phy_ops;
>   	priv->locality_count = 0;
>   	mutex_init(&priv->locality_count_mutex);
> +	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
>   
>   	dev_set_drvdata(&chip->dev, priv);

This is commit d6fb14208e22 in jarkko/next.

I tested this patch on top of Linux 6.8-rc7 on a Dell OptiPlex 5055 [1] 
and it fixes the issue there too.


Kind regards,

Paul


[1]: https://lore.kernel.org/all/CYJ163J3I09U.2XMVZ0BLWV1Y1@seitikki/

Re: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Jarkko Sakkinen]

On Tue Mar 5, 2024 at 5:43 PM EET, Paul Menzel wrote:
> Dear Lino,
>
>
> Thank you for the patch.
>
> Am 01.02.24 um 12:36 schrieb Lino Sanfilippo:
> > If interrupts are not activated the work struct 'free_irq_work' is not
> > initialized. This results in a warning splat at module shutdown.
> > 
> > Fix this by always initializing the work regardless of whether interrupts
> > are activated or not.
> > 
> > cc: stable@vger.kernel.org
> > Fixes: 481c2d14627d ("tpm,tpm_tis: Disable interrupts after 1000 unhandled IRQs")
> > Reported-by: Jarkko Sakkinen <jarkko@kernel.org>
> > Closes: https://lore.kernel.org/all/CX32RFOMJUQ0.3R4YCL9MDCB96@kernel.org/
> > Signed-off-by: Lino Sanfilippo <l.sanfilippo@kunbus.com>
> > ---
> >   drivers/char/tpm/tpm_tis_core.c | 3 +--
> >   1 file changed, 1 insertion(+), 2 deletions(-)
> > 
> > diff --git a/drivers/char/tpm/tpm_tis_core.c b/drivers/char/tpm/tpm_tis_core.c
> > index 1b350412d8a6..64c875657687 100644
> > --- a/drivers/char/tpm/tpm_tis_core.c
> > +++ b/drivers/char/tpm/tpm_tis_core.c
> > @@ -919,8 +919,6 @@ static int tpm_tis_probe_irq_single(struct tpm_chip *chip, u32 intmask,
> >   	int rc;
> >   	u32 int_status;
> >   
> > -	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
> > -
> >   	rc = devm_request_threaded_irq(chip->dev.parent, irq, NULL,
> >   				       tis_int_handler, IRQF_ONESHOT | flags,
> >   				       dev_name(&chip->dev), chip);
> > @@ -1132,6 +1130,7 @@ int tpm_tis_core_init(struct device *dev, struct tpm_tis_data *priv, int irq,
> >   	priv->phy_ops = phy_ops;
> >   	priv->locality_count = 0;
> >   	mutex_init(&priv->locality_count_mutex);
> > +	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
> >   
> >   	dev_set_drvdata(&chip->dev, priv);
>
> This is commit d6fb14208e22 in jarkko/next.
>
> I tested this patch on top of Linux 6.8-rc7 on a Dell OptiPlex 5055 [1] 
> and it fixes the issue there too.

Thanks!

If you don't mind I'll add your tested-by to the commit before I send
my next pull request to Linus?

BR, Jarkko

Re: [PATCH] tpm,tpm_tis: Avoid warning splat at shutdown

[Paul Menzel]

Dear Jarkko,


Am 07.03.24 um 21:05 schrieb Jarkko Sakkinen:
> On Tue Mar 5, 2024 at 5:43 PM EET, Paul Menzel wrote:

>> Am 01.02.24 um 12:36 schrieb Lino Sanfilippo:
>>> If interrupts are not activated the work struct 'free_irq_work' is not
>>> initialized. This results in a warning splat at module shutdown.
>>>
>>> Fix this by always initializing the work regardless of whether interrupts
>>> are activated or not.
>>>
>>> cc: stable@vger.kernel.org
>>> Fixes: 481c2d14627d ("tpm,tpm_tis: Disable interrupts after 1000 unhandled IRQs")
>>> Reported-by: Jarkko Sakkinen <jarkko@kernel.org>
>>> Closes: https://lore.kernel.org/all/CX32RFOMJUQ0.3R4YCL9MDCB96@kernel.org/
>>> Signed-off-by: Lino Sanfilippo <l.sanfilippo@kunbus.com>
>>> ---
>>>    drivers/char/tpm/tpm_tis_core.c | 3 +--
>>>    1 file changed, 1 insertion(+), 2 deletions(-)
>>>
>>> diff --git a/drivers/char/tpm/tpm_tis_core.c b/drivers/char/tpm/tpm_tis_core.c
>>> index 1b350412d8a6..64c875657687 100644
>>> --- a/drivers/char/tpm/tpm_tis_core.c
>>> +++ b/drivers/char/tpm/tpm_tis_core.c
>>> @@ -919,8 +919,6 @@ static int tpm_tis_probe_irq_single(struct tpm_chip *chip, u32 intmask,
>>>    	int rc;
>>>    	u32 int_status;
>>>    
>>> -	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
>>> -
>>>    	rc = devm_request_threaded_irq(chip->dev.parent, irq, NULL,
>>>    				       tis_int_handler, IRQF_ONESHOT | flags,
>>>    				       dev_name(&chip->dev), chip);
>>> @@ -1132,6 +1130,7 @@ int tpm_tis_core_init(struct device *dev, struct tpm_tis_data *priv, int irq,
>>>    	priv->phy_ops = phy_ops;
>>>    	priv->locality_count = 0;
>>>    	mutex_init(&priv->locality_count_mutex);
>>> +	INIT_WORK(&priv->free_irq_work, tpm_tis_free_irq_func);
>>>    
>>>    	dev_set_drvdata(&chip->dev, priv);
>>
>> This is commit d6fb14208e22 in jarkko/next.
>>
>> I tested this patch on top of Linux 6.8-rc7 on a Dell OptiPlex 5055 [1]
>> and it fixes the issue there too.
> 
> Thanks!
> 
> If you don't mind I'll add your tested-by to the commit before I send
> my next pull request to Linus?

Sure, go ahead. I thought, it’s not going to be amended, and therefore 
didn’t add the tag.

Tested-by: Paul Menzel <pmenzel@molgen.mpg.de>


Kind regards,

Paul