[PATCH] ASoC: mediatek: Allow setting readable driver names through kconfig

AngeloGioacchino Del Regno angelogioacchino.delregno at collabora.com
Wed Jun 26 00:49:55 PDT 2024


Il 25/06/24 22:23, Nícolas F. R. A. Prado ha scritto:
> Commit c8d18e440225 ("ASoC: core: clarify the driver name
> initialization") introduced an error message when driver names are
> automatically generated and result in truncated names.
> 
> For example, this error message is printed on mt8195-cherry-tomato-rev2:
> 
>    mt8195_mt6359 mt8195-sound: ASoC: driver name too long 'sof-mt8195_r1019_5682' -> 'sof-mt8195_r101'
> 
> Since that truncated driver name is already used by userspace (eg UCM),
> it can't be unconditionally updated.
> 
> As suggested by Jaroslav, update the driver name but hide it behind a
> kernel config option, which Linux distributions can enable once the
> corresponding support in userspace audio configuration software lands.
> This ensures that audio doesn't regress, while still allowing the error
> to be fixed.

I can propose the following plan of action for such a rename:
  1. Temporarily have both UCMs
  2. Wait until distros update their packages
  3. Change the name in kernel without extra config options
  4. Remove the now deprecated UCMs

...that's requiring a bit of time, yes, but I think this is the best way to
ensure that no breakage happens in the meantime for any users.

Anyone disagreeing? Does anyone have any better idea?

Cheers,
Angelo

> 
> Suggested-by: Jaroslav Kysela <perex at perex.cz>
> Link: https://lore.kernel.org/all/8d0ccf4a-a6d9-f914-70a9-c2ad55af3a04@perex.cz
> Signed-off-by: Nícolas F. R. A. Prado <nfraprado at collabora.com>
> ---
>   sound/soc/mediatek/Kconfig                         | 10 ++++++++++
>   sound/soc/mediatek/mt8173/mt8173-rt5650-rt5514.c   |  3 +++
>   sound/soc/mediatek/mt8173/mt8173-rt5650-rt5676.c   |  3 +++
>   sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c | 13 ++++++++++++-
>   sound/soc/mediatek/mt8186/mt8186-mt6366.c          | 16 +++++++++++++++-
>   sound/soc/mediatek/mt8188/mt8188-mt6359.c          |  7 ++++++-
>   sound/soc/mediatek/mt8195/mt8195-mt6359.c          |  7 ++++++-
>   7 files changed, 55 insertions(+), 4 deletions(-)
> 
> diff --git a/sound/soc/mediatek/Kconfig b/sound/soc/mediatek/Kconfig
> index 5a8476e1ecca..396d558bc75b 100644
> --- a/sound/soc/mediatek/Kconfig
> +++ b/sound/soc/mediatek/Kconfig
> @@ -281,6 +281,16 @@ config SND_SOC_MT8195
>   	  Select Y if you have such device.
>   	  If unsure select "N".
>   
> +config SND_SOC_MTK_READABLE_DRIVER_NAME
> +	bool "Readable driver name for MediaTek sound cards"
> +	help
> +	  This explicitly sets the driver name for the MediaTek sound cards to
> +	  prevent it from potentially being truncated and harder to read. The
> +	  new names require support in the audio configuration userspace
> +	  utilities (like UCM), so only select this once they have been updated
> +	  to support the new names to ensure working audio.
> +	  If unsure select "N".
> +
>   config SND_SOC_MT8195_MT6359
>   	tristate "ASoC Audio driver for MT8195 with MT6359 and I2S codecs"
>   	depends on I2C && GPIOLIB
> diff --git a/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5514.c b/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5514.c
> index 4ed06c269065..9155bb29c0a2 100644
> --- a/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5514.c
> +++ b/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5514.c
> @@ -173,6 +173,9 @@ static struct snd_soc_codec_conf mt8173_rt5650_rt5514_codec_conf[] = {
>   
>   static struct snd_soc_card mt8173_rt5650_rt5514_card = {
>   	.name = "mtk-rt5650-rt5514",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = "mtk-rt5514",
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8173_rt5650_rt5514_dais,
>   	.num_links = ARRAY_SIZE(mt8173_rt5650_rt5514_dais),
> diff --git a/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5676.c b/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5676.c
> index 763067c21153..212b36a0559f 100644
> --- a/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5676.c
> +++ b/sound/soc/mediatek/mt8173/mt8173-rt5650-rt5676.c
> @@ -229,6 +229,9 @@ static struct snd_soc_codec_conf mt8173_rt5650_rt5676_codec_conf[] = {
>   
>   static struct snd_soc_card mt8173_rt5650_rt5676_card = {
>   	.name = "mtk-rt5650-rt5676",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = "mtk-rt5676",
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8173_rt5650_rt5676_dais,
>   	.num_links = ARRAY_SIZE(mt8173_rt5650_rt5676_dais),
> diff --git a/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c b/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c
> index f848e14b091a..2664e3d14fec 100644
> --- a/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c
> +++ b/sound/soc/mediatek/mt8183/mt8183-da7219-max98357.c
> @@ -19,6 +19,8 @@
>   #include "../common/mtk-afe-platform-driver.h"
>   #include "mt8183-afe-common.h"
>   
> +#define DRIVER_NAME "mt8183_da7219"
> +
>   #define DA7219_CODEC_DAI "da7219-hifi"
>   #define DA7219_DEV_NAME "da7219.5-001a"
>   #define RT1015_CODEC_DAI "rt1015-aif"
> @@ -649,6 +651,9 @@ static const struct snd_soc_dapm_route mt8183_da7219_max98357_dapm_routes[] = {
>   
>   static struct snd_soc_card mt8183_da7219_max98357_card = {
>   	.name = "mt8183_da7219_max98357",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.controls = mt8183_da7219_max98357_snd_controls,
>   	.num_controls = ARRAY_SIZE(mt8183_da7219_max98357_snd_controls),
> @@ -706,6 +711,9 @@ static const struct snd_soc_dapm_route mt8183_da7219_rt1015_dapm_routes[] = {
>   
>   static struct snd_soc_card mt8183_da7219_rt1015_card = {
>   	.name = "mt8183_da7219_rt1015",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.controls = mt8183_da7219_rt1015_snd_controls,
>   	.num_controls = ARRAY_SIZE(mt8183_da7219_rt1015_snd_controls),
> @@ -723,6 +731,9 @@ static struct snd_soc_card mt8183_da7219_rt1015_card = {
>   
>   static struct snd_soc_card mt8183_da7219_rt1015p_card = {
>   	.name = "mt8183_da7219_rt1015p",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.controls = mt8183_da7219_max98357_snd_controls,
>   	.num_controls = ARRAY_SIZE(mt8183_da7219_max98357_snd_controls),
> @@ -875,7 +886,7 @@ MODULE_DEVICE_TABLE(of, mt8183_da7219_max98357_dt_match);
>   
>   static struct platform_driver mt8183_da7219_max98357_driver = {
>   	.driver = {
> -		.name = "mt8183_da7219",
> +		.name = DRIVER_NAME,
>   #ifdef CONFIG_OF
>   		.of_match_table = mt8183_da7219_max98357_dt_match,
>   #endif
> diff --git a/sound/soc/mediatek/mt8186/mt8186-mt6366.c b/sound/soc/mediatek/mt8186/mt8186-mt6366.c
> index 771d53611c2a..29f17dfb8f1b 100644
> --- a/sound/soc/mediatek/mt8186/mt8186-mt6366.c
> +++ b/sound/soc/mediatek/mt8186/mt8186-mt6366.c
> @@ -31,6 +31,8 @@
>   #include "mt8186-afe-gpio.h"
>   #include "mt8186-mt6366-common.h"
>   
> +#define DRIVER_NAME "mt8186_mt6366"
> +
>   #define RT1019_CODEC_DAI	"HiFi"
>   #define RT1019_DEV0_NAME	"rt1019p"
>   
> @@ -1119,6 +1121,9 @@ mt8186_mt6366_rt1019_rt5682s_controls[] = {
>   
>   static struct snd_soc_card mt8186_mt6366_da7219_max98357_soc_card = {
>   	.name = "mt8186_da7219_max98357",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8186_mt6366_rt1019_rt5682s_dai_links,
>   	.num_links = ARRAY_SIZE(mt8186_mt6366_rt1019_rt5682s_dai_links),
> @@ -1134,6 +1139,9 @@ static struct snd_soc_card mt8186_mt6366_da7219_max98357_soc_card = {
>   
>   static struct snd_soc_card mt8186_mt6366_rt1019_rt5682s_soc_card = {
>   	.name = "mt8186_rt1019_rt5682s",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8186_mt6366_rt1019_rt5682s_dai_links,
>   	.num_links = ARRAY_SIZE(mt8186_mt6366_rt1019_rt5682s_dai_links),
> @@ -1149,6 +1157,9 @@ static struct snd_soc_card mt8186_mt6366_rt1019_rt5682s_soc_card = {
>   
>   static struct snd_soc_card mt8186_mt6366_rt5682s_max98360_soc_card = {
>   	.name = "mt8186_rt5682s_max98360",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8186_mt6366_rt1019_rt5682s_dai_links,
>   	.num_links = ARRAY_SIZE(mt8186_mt6366_rt1019_rt5682s_dai_links),
> @@ -1164,6 +1175,9 @@ static struct snd_soc_card mt8186_mt6366_rt5682s_max98360_soc_card = {
>   
>   static struct snd_soc_card mt8186_mt6366_rt5650_soc_card = {
>   	.name = "mt8186_rt5650",
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8186_mt6366_rt1019_rt5682s_dai_links,
>   	.num_links = ARRAY_SIZE(mt8186_mt6366_rt1019_rt5682s_dai_links),
> @@ -1380,7 +1394,7 @@ MODULE_DEVICE_TABLE(of, mt8186_mt6366_dt_match);
>   
>   static struct platform_driver mt8186_mt6366_driver = {
>   	.driver = {
> -		.name = "mt8186_mt6366",
> +		.name = DRIVER_NAME,
>   #if IS_ENABLED(CONFIG_OF)
>   		.of_match_table = mt8186_mt6366_dt_match,
>   #endif
> diff --git a/sound/soc/mediatek/mt8188/mt8188-mt6359.c b/sound/soc/mediatek/mt8188/mt8188-mt6359.c
> index eba6f4c445ff..2640981a2463 100644
> --- a/sound/soc/mediatek/mt8188/mt8188-mt6359.c
> +++ b/sound/soc/mediatek/mt8188/mt8188-mt6359.c
> @@ -23,6 +23,8 @@
>   #include "../common/mtk-dsp-sof-common.h"
>   #include "../common/mtk-soc-card.h"
>   
> +#define DRIVER_NAME "mt8188_mt6359"
> +
>   #define CKSYS_AUD_TOP_CFG	0x032c
>    #define RG_TEST_ON		BIT(0)
>    #define RG_TEST_TYPE		BIT(2)
> @@ -1240,6 +1242,9 @@ static void mt8188_fixup_controls(struct snd_soc_card *card)
>   }
>   
>   static struct snd_soc_card mt8188_mt6359_soc_card = {
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8188_mt6359_dai_links,
>   	.num_links = ARRAY_SIZE(mt8188_mt6359_dai_links),
> @@ -1392,7 +1397,7 @@ MODULE_DEVICE_TABLE(of, mt8188_mt6359_dt_match);
>   
>   static struct platform_driver mt8188_mt6359_driver = {
>   	.driver = {
> -		.name = "mt8188_mt6359",
> +		.name = DRIVER_NAME,
>   		.of_match_table = mt8188_mt6359_dt_match,
>   		.pm = &snd_soc_pm_ops,
>   	},
> diff --git a/sound/soc/mediatek/mt8195/mt8195-mt6359.c b/sound/soc/mediatek/mt8195/mt8195-mt6359.c
> index ca8751190520..da406cbb40f6 100644
> --- a/sound/soc/mediatek/mt8195/mt8195-mt6359.c
> +++ b/sound/soc/mediatek/mt8195/mt8195-mt6359.c
> @@ -26,6 +26,8 @@
>   #include "mt8195-afe-clk.h"
>   #include "mt8195-afe-common.h"
>   
> +#define DRIVER_NAME "mt8195_mt6359"
> +
>   #define RT1011_SPEAKER_AMP_PRESENT		BIT(0)
>   #define RT1019_SPEAKER_AMP_PRESENT		BIT(1)
>   #define MAX98390_SPEAKER_AMP_PRESENT		BIT(2)
> @@ -1231,6 +1233,9 @@ static struct snd_soc_codec_conf max98390_codec_conf[] = {
>   };
>   
>   static struct snd_soc_card mt8195_mt6359_soc_card = {
> +#if IS_ENABLED(CONFIG_SND_SOC_MTK_READABLE_DRIVER_NAME)
> +	.driver_name = DRIVER_NAME,
> +#endif
>   	.owner = THIS_MODULE,
>   	.dai_link = mt8195_mt6359_dai_links,
>   	.num_links = ARRAY_SIZE(mt8195_mt6359_dai_links),
> @@ -1530,7 +1535,7 @@ MODULE_DEVICE_TABLE(of, mt8195_mt6359_dt_match);
>   
>   static struct platform_driver mt8195_mt6359_driver = {
>   	.driver = {
> -		.name = "mt8195_mt6359",
> +		.name = DRIVER_NAME,
>   		.of_match_table = mt8195_mt6359_dt_match,
>   		.pm = &snd_soc_pm_ops,
>   	},
> 
> ---
> base-commit: 0fc4bfab2cd45f9acb86c4f04b5191e114e901ed
> change-id: 20240625-mt8195-driver-name-too-long-095a030a2e86
> 
> Best regards,






More information about the Linux-mediatek mailing list