Re: [PATCH v3] ASoC: Intel: sof_rt5682: Ignore the speaker amp when there isn't one.

[Pierre-Louis Bossart]

On 1/2/20 7:50 PM, Sam McNally wrote:
> Some members of the Google_Hatch family include a rt5682 jack codec, but
> no speaker amplifier. This uses the same driver (sof_rt5682) as a
> combination of rt5682 jack codec and max98357a speaker amplifier. Within
> the sof_rt5682 driver, these cases are not currently distinguishable,
> relying on a DMI quirk to decide the configuration. This causes an
> incorrect configuration when only the rt5682 is present on a
> Google_Hatch device.
>
> For CML, the jack codec is used as the primary key when matching,
> with a possible speaker amplifier described in quirk_data. The two cases
> of interest are the second and third 10EC5682 entries in
> snd_soc_acpi_intel_cml_machines[]. The second entry matches the
> combination of rt5682 and max98357a, resulting in the quirk_data field
> in the snd_soc_acpi_mach being non-null, pointing at
> max98357a_spk_codecs, the snd_soc_acpi_codecs for the matched speaker
> amplifier. The third entry matches just the rt5682, resulting in a null
> quirk_data.
>
> The sof_rt5682 driver's DMI data matching identifies that a speaker
> amplifier is present for all Google_Hatch family devices. Detect cases
> where there is no speaker amplifier by checking for a null quirk_data in
> the snd_soc_acpi_mach and remove the speaker amplifier bit in that case.
>
> Signed-off-by: Sam McNally <sammc@xxxxxxxxxxxx>

thanks, this is a great explanation

Acked-by: Pierre-Louis Bossart <pierre-louis.bossart@xxxxxxxxxxxxxxx>


> ---
>
> Changes in v3:
> - Rewrote commit message to refer to correct
>    snd_soc_acpi_intel_cml_machines[] entries and better describe the
>    change
>
> Changes in v2:
> - Added details about the relevant ACPI matches to the description
>
>   sound/soc/intel/boards/sof_rt5682.c | 9 ++++++++-
>   1 file changed, 8 insertions(+), 1 deletion(-)
>
> diff --git a/sound/soc/intel/boards/sof_rt5682.c b/sound/soc/intel/boards/sof_rt5682.c
> index ad8a2b4bc709..8a13231dee15 100644
> --- a/sound/soc/intel/boards/sof_rt5682.c
> +++ b/sound/soc/intel/boards/sof_rt5682.c
> @@ -603,6 +603,14 @@ static int sof_audio_probe(struct platform_device *pdev)
>   
>   	dmi_check_system(sof_rt5682_quirk_table);
>   
> +	mach = (&pdev->dev)->platform_data;
> +
> +	/* A speaker amp might not be present when the quirk claims one is.
> +	 * Detect this via whether the machine driver match includes quirk_data.
> +	 */
> +	if ((sof_rt5682_quirk & SOF_SPEAKER_AMP_PRESENT) && !mach->quirk_data)
> +		sof_rt5682_quirk &= ~SOF_SPEAKER_AMP_PRESENT;
> +
>   	if (soc_intel_is_byt() || soc_intel_is_cht()) {
>   		is_legacy_cpu = 1;
>   		dmic_be_num = 0;
> @@ -663,7 +671,6 @@ static int sof_audio_probe(struct platform_device *pdev)
>   	INIT_LIST_HEAD(&ctx->hdmi_pcm_list);
>   
>   	sof_audio_card_rt5682.dev = &pdev->dev;
> -	mach = (&pdev->dev)->platform_data;
>   
>   	/* set platform name for each dailink */
>   	ret = snd_soc_fixup_dai_links_platform_name(&sof_audio_card_rt5682,