Re: [PATCH] rtc: max77686: Do not allow interrupt to fire before system resume

[Alexandre Belloni]

Hi,

On 15/06/2020 18:14:55+0200, Krzysztof Kozlowski wrote:
> The rtc-max77686 device shares the main interrupt line with parent MFD
> device (max77686 driver).  During the system suspend, the parent MFD
> device disables this IRQ to prevent an early event happening before
> resuming I2C bus controller.
> 
> The same should be done by rtc-max77686 driver because otherwise the
> interrupt handler max77686_rtc_alarm_irq() will be called before its
> resume function (max77686_rtc_resume()).  Such issue is not fatal but
> disabling shared IRQ by all users ensures correct behavior.
> 
> Signed-off-by: Krzysztof Kozlowski <krzk@xxxxxxxxxx>
> 
> ---
> 
> If this looks ok, I guess all maxim RTC drivers should be updated?

But then, shouldn't that means that this affects all RTCs on an i2c bus?

I'm not completely proficient with PM but shouldn't using _noirq
propagate to the parents? Then you are sure that the resume is called
with interrupts disabled and this also means that the i2c driver has
resumed (hopefully with interrupts disabled).

I must admit that I don't know and I hope that the answer would also
answer whether moving all the RTC resume to resume_early is safe. (See
https://lore.kernel.org/linux-rtc/20200610132403.2539519-1-martin@xxxxxxxxxx/#t)

> ---
>  drivers/rtc/rtc-max77686.c | 20 ++++++++++++++++++--
>  1 file changed, 18 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/rtc/rtc-max77686.c b/drivers/rtc/rtc-max77686.c
> index 03ebcf1c0f3d..645de5af707b 100644
> --- a/drivers/rtc/rtc-max77686.c
> +++ b/drivers/rtc/rtc-max77686.c
> @@ -805,17 +805,33 @@ static int max77686_rtc_remove(struct platform_device *pdev)
>  #ifdef CONFIG_PM_SLEEP
>  static int max77686_rtc_suspend(struct device *dev)
>  {
> +	struct max77686_rtc_info *info = dev_get_drvdata(dev);
> +	int ret = 0;
> +
>  	if (device_may_wakeup(dev)) {
>  		struct max77686_rtc_info *info = dev_get_drvdata(dev);
>  
> -		return enable_irq_wake(info->virq);
> +		ret = enable_irq_wake(info->virq);
>  	}
>  
> -	return 0;
> +	/*
> +	 * Main IRQ (not virtual) must be disabled during suspend because if it
> +	 * happens while suspended it will be handled before resuming I2C.
> +	 *
> +	 * Since Main IRQ is shared, all its users should disable it to be sure
> +	 * it won't fire while one of them is still suspended.
> +	 */
> +	disable_irq(info->rtc_irq);
> +
> +	return ret;
>  }
>  
>  static int max77686_rtc_resume(struct device *dev)
>  {
> +	struct max77686_rtc_info *info = dev_get_drvdata(dev);
> +
> +	enable_irq(info->rtc_irq);
> +
>  	if (device_may_wakeup(dev)) {
>  		struct max77686_rtc_info *info = dev_get_drvdata(dev);
>  
> -- 
> 2.17.1
> 

-- 
Alexandre Belloni, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com