[PATCH] ASoC: cs35l56: Must clear HALO_STATE before issuing SYSTEM_RESET

[PATCH] ASoC: cs35l56: Must clear HALO_STATE before issuing SYSTEM_RESET

[Richard Fitzgerald]

The driver must write 0 to HALO_STATE before sending the SYSTEM_RESET
command to the firmware.

HALO_STATE is in DSP memory, which is preserved across a soft reset.
The SYSTEM_RESET command does not change the value of HALO_STATE.
There is period of time while the CS35L56 is resetting, before the
firmware has started to boot, where a read of HALO_STATE will return
the value it had before the SYSTEM_RESET. If the driver does not
clear HALO_STATE, this would return BOOT_DONE status even though the
firmware has not booted.

Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
Fixes: 8a731fd37f8b ("ASoC: cs35l56: Move utility functions to shared file")
---
 sound/soc/codecs/cs35l56-shared.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/sound/soc/codecs/cs35l56-shared.c b/sound/soc/codecs/cs35l56-shared.c
index 995d979b6d87..cb4e83126b08 100644
--- a/sound/soc/codecs/cs35l56-shared.c
+++ b/sound/soc/codecs/cs35l56-shared.c
@@ -335,6 +335,7 @@ void cs35l56_wait_min_reset_pulse(void)
 EXPORT_SYMBOL_NS_GPL(cs35l56_wait_min_reset_pulse, SND_SOC_CS35L56_SHARED);
 
 static const struct reg_sequence cs35l56_system_reset_seq[] = {
+	REG_SEQ0(CS35L56_DSP1_HALO_STATE, 0),
 	REG_SEQ0(CS35L56_DSP_VIRTUAL1_MBOX_1, CS35L56_MBOX_CMD_SYSTEM_RESET),
 };
 
-- 
2.30.2

Re: [PATCH] ASoC: cs35l56: Must clear HALO_STATE before issuing SYSTEM_RESET

[Mark Brown]

On Fri, 16 Feb 2024 14:05:35 +0000, Richard Fitzgerald wrote:
> The driver must write 0 to HALO_STATE before sending the SYSTEM_RESET
> command to the firmware.
> 
> HALO_STATE is in DSP memory, which is preserved across a soft reset.
> The SYSTEM_RESET command does not change the value of HALO_STATE.
> There is period of time while the CS35L56 is resetting, before the
> firmware has started to boot, where a read of HALO_STATE will return
> the value it had before the SYSTEM_RESET. If the driver does not
> clear HALO_STATE, this would return BOOT_DONE status even though the
> firmware has not booted.
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next

Thanks!

[1/1] ASoC: cs35l56: Must clear HALO_STATE before issuing SYSTEM_RESET
      commit: e33625c84b75e4f078d7f9bf58f01fe71ab99642

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark