Re: [PATCH] ASoC: Intel: boards: add max98390 2/4 speakers support

[Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>]

Fixed Bard's address.

Quik summary: there are multiple issues below with rather unclear
handling of two separate configurations.

On 9/7/21 4:33 AM, Mac Chiang wrote:
> Left/Right speakers and 4ch tdm playback
> add echo reference capture
> add bt offload support
> add DMI_OEM_STRING for board varients
> 
> Signed-off-by: Mark Hsieh <mark_hsieh@wistron.corp-partner.google.com>
> Signed-off-by: Mac Chiang <mac.chiang@intel.com>
> Signed-off-by: Kieth Tzeng <keith.tzeng@quantatw.com>

> diff --git a/sound/soc/intel/boards/Kconfig b/sound/soc/intel/boards/Kconfig
> index 61b71d6c44cf..2c24d8a929a2 100644
> --- a/sound/soc/intel/boards/Kconfig
> +++ b/sound/soc/intel/boards/Kconfig
> @@ -470,6 +470,7 @@ config SND_SOC_INTEL_SOF_RT5682_MACH
>  	select SND_SOC_RT1015
>  	select SND_SOC_RT1015P
>  	select SND_SOC_RT5682_I2C
> +	select SND_SOC_MAX98390

can you move this up below the select SND_SOC_MAX98373_I2C

>  	select SND_SOC_DMIC
>  	select SND_SOC_HDAC_HDMI
>  	select SND_SOC_INTEL_HDA_DSP_COMMON

[...]

> +static struct snd_soc_codec_conf max_98390_codec_conf[] = {
> +	{
> +		.dlc = COMP_CODEC_CONF(MAX_98390_DEV0_NAME),
> +		.name_prefix = "Right",
> +	},
> +	{
> +		.dlc = COMP_CODEC_CONF(MAX_98390_DEV1_NAME),
> +		.name_prefix = "Left",
> +	},
> +};
> +
> +static struct snd_soc_codec_conf max_98390_4spk_codec_conf[] = {
> +	{
> +		.dlc = COMP_CODEC_CONF(MAX_98390_DEV0_NAME),
> +		.name_prefix = "Right",
> +	},
> +	{
> +		.dlc = COMP_CODEC_CONF(MAX_98390_DEV1_NAME),
> +		.name_prefix = "Left",
> +	},
> +	{
> +		.dlc = COMP_CODEC_CONF(MAX_98390_DEV2_NAME),
> +		.name_prefix = "Tweeter Right",
> +	},
> +	{
> +		.dlc = COMP_CODEC_CONF(MAX_98390_DEV3_NAME),
> +		.name_prefix = "Tweeter Left",
> +	},
> +};
> +
> +struct snd_soc_dai_link_component max_98390_components[] = {
> +	{
> +		.name = MAX_98390_DEV0_NAME,
> +		.dai_name = MAX_98390_CODEC_DAI,
> +	},
> +	{
> +		.name = MAX_98390_DEV1_NAME,
> +		.dai_name = MAX_98390_CODEC_DAI,
> +	},
> +};
> +EXPORT_SYMBOL_NS(max_98390_components, SND_SOC_INTEL_SOF_MAXIM_COMMON);
> +
> +struct snd_soc_dai_link_component max_98390_4spk_components[] = {
> +	{
> +		.name = MAX_98390_DEV0_NAME,
> +		.dai_name = MAX_98390_CODEC_DAI,
> +	},
> +	{
> +		.name = MAX_98390_DEV1_NAME,
> +		.dai_name = MAX_98390_CODEC_DAI,
> +	},
> +	{
> +		.name = MAX_98390_DEV2_NAME,
> +		.dai_name = MAX_98390_CODEC_DAI,
> +	},
> +	{
> +		.name = MAX_98390_DEV3_NAME,
> +		.dai_name = MAX_98390_CODEC_DAI,
> +	},
> +};
> +EXPORT_SYMBOL_NS(max_98390_4spk_components, SND_SOC_INTEL_SOF_MAXIM_COMMON);

so until now you've described two possible configurations with 2 or 4
speakers, but below you assume 4?

> +static int max_98390_hw_params(struct snd_pcm_substream *substream,
> +				struct snd_pcm_hw_params *params)
> +{
> +	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
> +	struct snd_soc_dai *codec_dai;
> +	int j;
> +
> +	for_each_rtd_codec_dais(rtd, j, codec_dai) {
> +		if (!strcmp(codec_dai->component->name, MAX_98390_DEV0_NAME) ||
> +			!strcmp(codec_dai->component->name, MAX_98390_DEV2_NAME)) {
> +			snd_soc_dai_set_tdm_slot(codec_dai, 0x03, 3, 4, 32);
> +		}
> +		if (!strcmp(codec_dai->component->name, MAX_98390_DEV1_NAME) ||
> +			!strcmp(codec_dai->component->name, MAX_98390_DEV3_NAME)) {
> +			snd_soc_dai_set_tdm_slot(codec_dai, 0x0C, 3, 4, 32);
> +		}
> +	}
> +	return 0;
> +}

what happens here if you only have 2 devices in the hardware configuration?

This seems different to what was done e.g. in cml_rt1011_rt5682 where
the tdm slots were conditional on the quirk.

> +
> +int max_98390_spk_codec_init(struct snd_soc_pcm_runtime *rtd)
> +{
> +	struct snd_soc_card *card = rtd->card;
> +	int ret;
> +
> +	ret = snd_soc_dapm_new_controls(&card->dapm, max_98390_tt_dapm_widgets,
> +						ARRAY_SIZE(max_98390_tt_dapm_widgets));
> +	if (ret) {
> +		dev_err(rtd->dev, "unable to add dapm controls, ret %d\n", ret);
> +		/* Don't need to add routes if widget addition failed */
> +		return ret;
> +	}
> +
> +	ret = snd_soc_add_card_controls(card, max_98390_tt_kcontrols,
> +						ARRAY_SIZE(max_98390_tt_kcontrols));
> +	if (ret) {
> +		dev_err(rtd->dev, "unable to add card controls, ret %d\n", ret);
> +		return ret;
> +	}
> +
> +	ret = snd_soc_dapm_add_routes(&card->dapm, max_98373_dapm_routes,
> +					ARRAY_SIZE(max_98373_dapm_routes));
> +	if (ret) {
> +		dev_err(rtd->dev, "Speaker Left, Right  map addition failed: %d\n", ret);
> +		return ret;
> +	}
> +
> +	ret = snd_soc_dapm_add_routes(&card->dapm, max_98390_tt_dapm_routes,
> +						ARRAY_SIZE(max_98390_tt_dapm_routes));
> +	if (ret)
> +		dev_err(rtd->dev, "Tweeter Speaker Left, Right map addition failed: %d\n", ret);
> +
> +	return ret;
> +}
> +EXPORT_SYMBOL_NS(max_98390_spk_codec_init, SND_SOC_INTEL_SOF_MAXIM_COMMON);

again what happens if you don't have tweeters in the configuration? Why
would you add DAPM routes to a non-existent codec?

> +
> +struct snd_soc_ops max_98390_ops = {
> +	.hw_params = max_98390_hw_params,
> +};
> +EXPORT_SYMBOL_NS(max_98390_ops, SND_SOC_INTEL_SOF_MAXIM_COMMON);
> +
> +void max_98390_set_codec_conf(struct snd_soc_card *card, int ch)
> +{
> +	if (ch == ARRAY_SIZE(max_98390_4spk_codec_conf)) {
> +		card->codec_conf = max_98390_4spk_codec_conf;
> +		card->num_configs = ARRAY_SIZE(max_98390_4spk_codec_conf);
> +	} else {
> +		card->codec_conf = max_98390_codec_conf;
> +		card->num_configs = ARRAY_SIZE(max_98390_codec_conf);
> +	}
> +}
> +EXPORT_SYMBOL_NS(max_98390_set_codec_conf, SND_SOC_INTEL_SOF_MAXIM_COMMON);
> +
>  /*
>   * Maxim MAX98357A/MAX98360A
>   */
> diff --git a/sound/soc/intel/boards/sof_maxim_common.h b/sound/soc/intel/boards/sof_maxim_common.h
> index 3ff5e8fec4de..412b9dd06bad 100644
> --- a/sound/soc/intel/boards/sof_maxim_common.h
> +++ b/sound/soc/intel/boards/sof_maxim_common.h
> @@ -24,6 +24,22 @@ int max_98373_spk_codec_init(struct snd_soc_pcm_runtime *rtd);
>  void max_98373_set_codec_conf(struct snd_soc_card *card);
>  int max_98373_trigger(struct snd_pcm_substream *substream, int cmd);
>  
> +/*
> + * Maxim MAX98390
> + */
> +#define MAX_98390_CODEC_DAI     "max98390-aif1"
> +#define MAX_98390_DEV0_NAME     "i2c-MX98390:00"
> +#define MAX_98390_DEV1_NAME     "i2c-MX98390:01"
> +#define MAX_98390_DEV2_NAME     "i2c-MX98390:02"
> +#define MAX_98390_DEV3_NAME     "i2c-MX98390:03"
> +
> +extern struct snd_soc_dai_link_component max_98390_components[2];
> +extern struct snd_soc_dai_link_component max_98390_4spk_components[4];
> +extern struct snd_soc_ops max_98390_ops;
> +extern const struct snd_soc_dapm_route max_98390_dapm_routes[];
> +void max_98390_set_codec_conf(struct snd_soc_card *card, int ch);
> +int max_98390_spk_codec_init(struct snd_soc_pcm_runtime *rtd);
> +
>  /*
>   * Maxim MAX98357A/MAX98360A
>   */
> diff --git a/sound/soc/intel/boards/sof_rt5682.c b/sound/soc/intel/boards/sof_rt5682.c
> index f096bd6d69be..e46438cca643 100644
> --- a/sound/soc/intel/boards/sof_rt5682.c
> +++ b/sound/soc/intel/boards/sof_rt5682.c
> @@ -49,6 +49,8 @@
>  #define SOF_RT1015P_SPEAKER_AMP_PRESENT		BIT(16)
>  #define SOF_MAX98373_SPEAKER_AMP_PRESENT	BIT(17)
>  #define SOF_MAX98360A_SPEAKER_AMP_PRESENT	BIT(18)
> +#define SOF_MAX98390_SPEAKER_AMP_PRESENT	BIT(23)
> +#define SOF_MAX98390_TWEETER_SPEAKER_PRESENT	BIT(24)
>  
>  /* BT audio offload: reserve 3 bits for future */
>  #define SOF_BT_OFFLOAD_SSP_SHIFT		19
> @@ -176,6 +178,36 @@ static const struct dmi_system_id sof_rt5682_quirk_table[] = {
>  					SOF_RT5682_SSP_AMP(2) |
>  					SOF_RT5682_NUM_HDMIDEV(4)),
>  	},
> +	{
> +		.callback = sof_rt5682_quirk_cb,
> +		.matches = {
> +			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
> +			DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98390_ALC5682I_I2S"),
> +		},
> +		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
> +					SOF_RT5682_SSP_CODEC(0) |
> +					SOF_SPEAKER_AMP_PRESENT |
> +					SOF_MAX98373_SPEAKER_AMP_PRESENT |
> +					SOF_RT5682_SSP_AMP(2) |
> +					SOF_RT5682_NUM_HDMIDEV(4)),
> +	},
> +	{
> +		.callback = sof_rt5682_quirk_cb,
> +		.matches = {
> +			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
> +			DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98390_ALC5682I_I2S_4SPK"),
> +		},
> +		.driver_data = (void *)(SOF_RT5682_MCLK_EN |
> +					SOF_RT5682_SSP_CODEC(0) |
> +					SOF_SPEAKER_AMP_PRESENT |
> +					SOF_MAX98390_SPEAKER_AMP_PRESENT |
> +					SOF_MAX98390_TWEETER_SPEAKER_PRESENT |
> +					SOF_RT5682_SSP_AMP(1) |
> +					SOF_RT5682_NUM_HDMIDEV(4) |
> +					SOF_BT_OFFLOAD_SSP(2) |
> +					SOF_SSP_BT_OFFLOAD_PRESENT),
> +
> +	},

so here the interesting part is that the amplifiers are not present on
the same link, which means you need different topologies.

>  	{}
>  };
>  
> @@ -459,6 +491,7 @@ static int sof_card_late_probe(struct snd_soc_card *card)
>  		if (err < 0)
>  			return err;
>  	}
> +
>  	return hdac_hdmi_jack_port_init(component, &card->dapm);
>  }
>  
> @@ -745,6 +778,21 @@ static struct snd_soc_dai_link *sof_card_dai_links_create(struct device *dev,
>  		} else if (sof_rt5682_quirk &
>  				SOF_RT1011_SPEAKER_AMP_PRESENT) {
>  			sof_rt1011_dai_link(&links[id]);
> +		} else if (sof_rt5682_quirk &
> +				SOF_MAX98390_SPEAKER_AMP_PRESENT) {
> +			if (sof_rt5682_quirk &
> +				SOF_MAX98390_TWEETER_SPEAKER_PRESENT) {
> +				links[id].codecs = max_98390_4spk_components;
> +				links[id].num_codecs = ARRAY_SIZE(max_98390_4spk_components);
> +				links[id].init = max_98390_spk_codec_init;
> +			} else {
> +				links[id].codecs = max_98390_components;
> +				links[id].num_codecs = ARRAY_SIZE(max_98390_components);
> +				links[id].init = max_98373_spk_codec_init;

Not sure again how this works since you are using the same init function
that internally does not check how many speakers there are.

> +			}
> +			links[id].ops = &max_98390_ops;
> +			links[id].dpcm_capture = 1;
> +
>  		} else {
>  			max_98357a_dai_link(&links[id]);
>  		}
> @@ -881,6 +929,14 @@ static int sof_audio_probe(struct platform_device *pdev)
>  		sof_rt1011_codec_conf(&sof_audio_card_rt5682);
>  	else if (sof_rt5682_quirk & SOF_RT1015P_SPEAKER_AMP_PRESENT)
>  		sof_rt1015p_codec_conf(&sof_audio_card_rt5682);
> +	else if (sof_rt5682_quirk & SOF_MAX98390_SPEAKER_AMP_PRESENT) {
> +		if (sof_rt5682_quirk & SOF_MAX98390_TWEETER_SPEAKER_PRESENT)
> +			max_98390_set_codec_conf(&sof_audio_card_rt5682,
> +						ARRAY_SIZE(max_98390_4spk_components));
> +		else
> +			max_98390_set_codec_conf(&sof_audio_card_rt5682,
> +						ARRAY_SIZE(max_98390_components));
> +	}
>  
>  	if (sof_rt5682_quirk & SOF_SSP_BT_OFFLOAD_PRESENT)
>  		sof_audio_card_rt5682.num_links++;
> @@ -1007,6 +1063,18 @@ static const struct platform_device_id board_ids[] = {
>  					SOF_RT5682_SSP_AMP(2) |
>  					SOF_RT5682_NUM_HDMIDEV(4)),
>  	},
> +	{
> +		.name = "adl_max98390_rt5682",
> +		.driver_data = (kernel_ulong_t)(SOF_RT5682_MCLK_EN |
> +					SOF_RT5682_SSP_CODEC(0) |
> +					SOF_SPEAKER_AMP_PRESENT |
> +					SOF_MAX98390_SPEAKER_AMP_PRESENT |
> +					SOF_RT5682_SSP_AMP(1) |
> +					SOF_RT5682_NUM_HDMIDEV(4) |
> +					SOF_BT_OFFLOAD_SSP(2) |
> +					SOF_SSP_BT_OFFLOAD_PRESENT),
> +	},
> +
>  	{ }
>  };
>  MODULE_DEVICE_TABLE(platform, board_ids);
> @@ -1026,6 +1094,7 @@ MODULE_DESCRIPTION("SOF Audio Machine driver");
>  MODULE_AUTHOR("Bard Liao <bard.liao@intel.com>");
>  MODULE_AUTHOR("Sathya Prakash M R <sathya.prakash.m.r@intel.com>");
>  MODULE_AUTHOR("Brent Lu <brent.lu@intel.com>");
> +MODULE_AUTHOR("Mac Chiang <mac.chiang@intel.com>");
>  MODULE_LICENSE("GPL v2");
>  MODULE_IMPORT_NS(SND_SOC_INTEL_HDA_DSP_COMMON);
>  MODULE_IMPORT_NS(SND_SOC_INTEL_SOF_MAXIM_COMMON);
> diff --git a/sound/soc/intel/common/soc-acpi-intel-adl-match.c b/sound/soc/intel/common/soc-acpi-intel-adl-match.c
> index a0f6a69c7038..2db152998e4a 100644
> --- a/sound/soc/intel/common/soc-acpi-intel-adl-match.c
> +++ b/sound/soc/intel/common/soc-acpi-intel-adl-match.c
> @@ -280,6 +280,11 @@ static const struct snd_soc_acpi_codecs adl_max98357a_amp = {
>  	.codecs = {"MX98357A"}
>  };
>  
> +static const struct snd_soc_acpi_codecs adl_max98390_amp = {
> +	.num_codecs = 1,
> +	.codecs = {"MX98390"}
> +};
> +
>  struct snd_soc_acpi_mach snd_soc_acpi_intel_adl_machines[] = {
>  	{
>  		.id = "10EC5682",
> @@ -297,6 +302,14 @@ struct snd_soc_acpi_mach snd_soc_acpi_intel_adl_machines[] = {
>  		.sof_fw_filename = "sof-adl.ri",
>  		.sof_tplg_filename = "sof-adl-max98357a-rt5682.tplg",
>  	},
> +	{
> +		.id = "10EC5682",
> +		.drv_name = "adl_max98390_rt5682",
> +		.machine_quirk = snd_soc_acpi_codec_list,
> +		.quirk_data = &adl_max98390_amp,
> +		.sof_fw_filename = "sof-adl.ri",
> +		.sof_tplg_filename = "sof-adl-max98390-rt5682.tplg",
> +	},

that seems to be problematic, you are using the *same* topology for two
different hardware configurations, where the amplifiers can be on SSP 1
or SSP2.

This entry will be selected no matter how many MAX98390 amps are present
on the board.

How does this work?

>  	{},
>  };
>  EXPORT_SYMBOL_GPL(snd_soc_acpi_intel_adl_machines);
> diff --git a/sound/soc/sof/sof-pci-dev.c b/sound/soc/sof/sof-pci-dev.c
> index bc9e70765678..eee73a91b7ff 100644
> --- a/sound/soc/sof/sof-pci-dev.c
> +++ b/sound/soc/sof/sof-pci-dev.c
> @@ -59,6 +59,15 @@ static const struct dmi_system_id sof_tplg_table[] = {
>  		},
>  		.driver_data = "sof-adl-rt5682-ssp0-max98373-ssp2.tplg",
>  	},
> +	{
> +		.callback = sof_tplg_cb,
> +		.matches = {
> +			DMI_MATCH(DMI_PRODUCT_FAMILY, "Google_Brya"),
> +			DMI_MATCH(DMI_OEM_STRING, "AUDIO-ADL_MAX98390_ALC5682I_I2S"),
> +		},
> +		.driver_data = "sof-adl-rt5682-ssp0-max98390-ssp2.tplg",
> +	},
> +

And here you don't have a quirk to select the 4-channel version?

>  	{}
>  };
>  
> 

It really feels like part of the code is a placeholder that was never
tested...