[PATCH] ASoc: SOF: Fix sof-audio-pci-intel-tgl shutdown timeout during hibernation

[Takashi Iwai]

On Wed, 07 Dec 2022 11:22:29 +0100,
Zhen Ni wrote:
> 
> On Dell Latitude 3420 Notebook, sof-audio-pci-intel-tgl may fail to shutdown
> sporadically during hibernation as following log:
> 
> [   43.281110] PM: Image saving done
> [   43.281699] PM: hibernation: Wrote 2828852 kbytes in 2.78 seconds(1017.57 MB/s)
> [   43.282359] PM: SI
> [   43.345156] kvm: exiting hardware virtualization
> [   43.345865] auxiliary snd_sof.hda-probes.0: shutdown
> [   43.346359] skl_hda_dsp_generic skl_hda_dsp_generic: shutdown
> [   43.346849] skl_hda_codec hdmi ehdaudio0D2: shutdown
> [   43.398204] snd_hda_codec_realtek ehdaudio0DO: shutdown
> [   43.419621] dmic-codec dmic-codec: shutdown
> [   43.420194] sof-audio-pci-intel-tgl 0000:00:1f.3: shutdown
> 
> Call wait_xxx_timeout() to process the timeout.
> 
> Signed-off-by: Zhen Ni <nizhen at uniontech.com>

It's a known problem and being discussed (although it's a slightly
different code path):
  https://lore.kernel.org/r/20221127-snd-freeze-v4-0-51ca64b7f2ab@chromium.org

We need the proper fix for ASoC shutdown.
Adding relevant people to Cc.

And, the unconditional exit from the sync is dangerous.  It may lead
to use-after-free or such.


thanks,

Takashi

> ---
>  sound/core/init.c | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
> 
> diff --git a/sound/core/init.c b/sound/core/init.c
> index 5377f94eb211..9bd674d7a0fd 100644
> --- a/sound/core/init.c
> +++ b/sound/core/init.c
> @@ -574,9 +574,10 @@ void snd_card_disconnect_sync(struct snd_card *card)
>  	}
>  
>  	spin_lock_irq(&card->files_lock);
> -	wait_event_lock_irq(card->remove_sleep,
> +	wait_event_lock_irq_timeout(card->remove_sleep,
>  			    list_empty(&card->files_list),
> -			    card->files_lock);
> +			    card->files_lock,
> +			    msecs_to_jiffies(2000));
>  	spin_unlock_irq(&card->files_lock);
>  }
>  EXPORT_SYMBOL_GPL(snd_card_disconnect_sync);
> @@ -659,7 +660,7 @@ int snd_card_free(struct snd_card *card)
>  	if (ret)
>  		return ret;
>  	/* wait, until all devices are ready for the free operation */
> -	wait_for_completion(&released);
> +	wait_for_completion_timeout(&released, msecs_to_jiffies(2000))
>  
>  	return 0;
>  }
> -- 
> 2.20.1
> 
>