Re: [PATCH v0 2/7] ASoC: codecs: ES8389: Fix the issue about mclk_src

[sashiko-bot@kernel.org]

Thank you for your contribution! Sashiko AI review found 1 potential issue(s) to consider:
- [High] Devicetree ABI Breakage and Hardware Leak in mclk_src Evaluation
--

commit 901f3e10a3b9643fed9b6bed617589331a04275d
Author: Zhang Yi <zhangyi@everest-semi.com>

ASoC: codecs: ES8389: Fix the issue about mclk_src

This commit addresses an issue with incorrect modifications to the mclk_src
configuration by updating the bitmask logic and hardware register definitions.

> diff --git a/sound/soc/codecs/es8389.c b/sound/soc/codecs/es8389.c
> index 9c816491648c7..638eb1f0462ea 100644
> --- a/sound/soc/codecs/es8389.c
> +++ b/sound/soc/codecs/es8389.c
> @@ -609,7 +609,7 @@ static int es8389_pcm_hw_params(struct snd_pcm_substream *substream,
>  
>  	if (es8389->mclk_src == ES8389_SCLK_PIN) {

[Severity: High]
Does this change break the devicetree ABI?

In es8389_probe(), the driver reads the "everest,mclk-src" devicetree property
directly into the es8389->mclk_src variable:

sound/soc/codecs/es8389.c:es8389_probe() {
    ...
    ret = device_property_read_u8(component->dev, "everest,mclk-src", 
                                  &es8389->mclk_src);
    ...
}

Since ES8389_SCLK_PIN is redefined below as (1 << 6), any existing device
trees using logical values like <0> or <1> will fail this equality check.
This will silently bypass the SCLK configuration and break audio functionality,
unless device tree authors now populate the property with the raw hardware
bitmask <64>.

>  		regmap_update_bits(es8389->regmap, ES8389_MASTER_CLK,
> -					ES8389_MCLK_SOURCE, es8389->mclk_src);
> +					ES8389_MCLK_MASK, es8389->mclk_src);
>  		es8389->sysclk = params_channels(params) * params_width(params) * params_rate(params);
>  	}

[ ... ]

> diff --git a/sound/soc/codecs/es8389.h b/sound/soc/codecs/es8389.h
> index d21e72f876a60..13ce241774dc8 100644
> --- a/sound/soc/codecs/es8389.h
> +++ b/sound/soc/codecs/es8389.h
> @@ -116,9 +116,10 @@
>  #define ES8389_TDM_SLOT               (0x70 << 0)
>  #define ES8389_TDM_SHIFT              4
>  
> -#define ES8389_MCLK_SOURCE            (1 << 6)
> -#define ES8389_MCLK_PIN               (1 << 6)
> -#define ES8389_SCLK_PIN               (0 << 6)
> +#define ES8389_MCLK_MASK              (3 << 6)
> +#define ES8389_MCLK_SOURCE            (0 << 6)
> +#define ES8389_MCLK_PIN               (0 << 6)
> +#define ES8389_SCLK_PIN               (1 << 6)

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20260608083540.12581-1-zhangyi@everest-semi.com?part=2