[alsa-devel] [PATCH V4 1/2] ASoC: core: add API for registering DMI card names

[Takashi Iwai]

On Fri, 01 Apr 2016 07:46:31 +0200,
han.lu at intel.com wrote:
> 
> From: "Lu, Han" <han.lu at intel.com>
> 
> Add core API for registering DMI card names, so user space utils such
> as PA and UCM can distinguish various products.
> Previously on ASoC, the card short name, driver name and long name are
> all the same as the machine driver name.
> The patch adds more board information:
>   card driver name --->  machine driver name
>   card short name  --->  DMI_BOARD_NAME or DMI_PRODUCT_NAME
>   card long name and
>   card component   --->  short name:driver name:(DMI_SYS_VENDOR if
>                          available):(the firmware name if available)
> 
> Signed-off-by: Lu, Han <han.lu at intel.com>
> 
> diff --git a/include/sound/soc.h b/include/sound/soc.h
> index 02b4a21..4e80444 100644
> --- a/include/sound/soc.h
> +++ b/include/sound/soc.h
> @@ -486,6 +486,9 @@ void snd_soc_runtime_deactivate(struct snd_soc_pcm_runtime *rtd, int stream);
>  int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
>  	unsigned int dai_fmt);
>  
> +int snd_soc_set_card_names(struct snd_soc_card *card, const char *board,
> +		const char *vendor, const char *firmware);
> +
>  /* Utility functions to get clock rates from various things */
>  int snd_soc_calc_frame_size(int sample_size, int channels, int tdm_slots);
>  int snd_soc_params_to_frame_size(struct snd_pcm_hw_params *params);
> diff --git a/sound/soc/soc-core.c b/sound/soc/soc-core.c
> index d2e62b15..3faaa59 100644
> --- a/sound/soc/soc-core.c
> +++ b/sound/soc/soc-core.c
> @@ -1828,6 +1828,62 @@ int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
>  }
>  EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
>  
> +/**
> + * snd_soc_set_card_names() - Set the shortname/drivername/longname/component
> + * of a ASoC card.
> + * @card: The card to set names
> + * @board: DMI_BOARD_NAME or DMI_PRODUCT_NAME
> + * @vendor: DMI_SYS_VENDOR
> + * @firmware: The firmware name
> + *
> + * This function registers DMI names to card for the userspace to distinguish
> + * different boards/products:
> + *   card driver name --->  machine driver name
> + *   card short name  --->  DMI_BOARD_NAME or DMI_PRODUCT_NAME
> + *   card long name and
> + *   card component   --->  short name:driver name:(DMI_SYS_VENDOR)
> + *                          :(firmware name)
> + *
> + * Returns 0 on success, otherwise a negative error code.
> + */
> +int snd_soc_set_card_names(struct snd_soc_card *card, const char *board,
> +		const char *vendor, const char *firmware)
> +{
> +	int ret = 0;
> +	size_t buf_size, name_size;
> +	char *name;
> +
> +	if (!board) {
> +		dev_err(card->dev, "ASoC: the board/product name is empty!\n");
> +		return -EINVAL;
> +	}
> +
> +	/* card driver name */
> +	card->driver_name = card->name;
> +
> +	/* card short name */
> +	card->name = board;
> +
> +	/* card long name / card component */
> +	buf_size = sizeof(card->snd_card->longname);
> +	name_size = strlen(card->name) + strlen(card->driver_name)
> +			+ strlen(vendor) + strlen(firmware) + 4;
> +	if (buf_size < name_size + strlen(card->snd_card->components))
> +		return -ENOMEM;
> +
> +	name = kasprintf(GFP_KERNEL, "%s:%s:%s:%s", card->name,
> +			card->driver_name, vendor, firmware);
> +	if (!name)
> +		return -ENOMEM;
> +
> +	ret = snd_component_add(card->snd_card, name);
> +	card->long_name = card->snd_card->components;

This can't be used so.  First off, both have the different sizes.  And
a driver might have already put some string in components that is
irrelevant to long name.

And what if name strings contain ':' letter?

Also, in this version, firmware is no longer optional but mandatory?


Takashi