[PATCH V4 0/2] ASoC: share more product information with user space

[PATCH V4 0/2] ASoC: share more product information with user space

[han.lu]

From: "Lu, Han" <han.lu@intel.com>

 Share more product information, so user space utils such as PA and UCM can
 distinguish different products.
  1. Add a core API.
  2. Apply the API to bytcr-rt5640 driver.
    
 changes on V4:
  1. Replace kmalloc() and snprintf() with ksaprintf() to simplify code

 changes on V3:
  1. Split the core API and the API call to two patches
  2. Replace misused strcat() with snprintf()
  3. Code and comment fix 
	  
Lu, Han (2):
  ASoC: core: add API for registering DMI card names
  ASoC: bytcr-rt5640: register DMI names to card

 include/sound/soc.h                   |  3 ++
 sound/soc/intel/boards/bytcr_rt5640.c | 15 ++++++++++
 sound/soc/soc-core.c                  | 56 +++++++++++++++++++++++++++++++++++
 3 files changed, 74 insertions(+)

-- 
2.5.0

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

[han.lu]

From: "Lu, Han" <han.lu@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@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;
+
+	kfree(name);
+	return ret;
+}
+EXPORT_SYMBOL_GPL(snd_soc_set_card_names);
+
 static int snd_soc_instantiate_card(struct snd_soc_card *card)
 {
 	struct snd_soc_codec *codec;
-- 
2.5.0

Re: [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@intel.com wrote:
> 
> From: "Lu, Han" <han.lu@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@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

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

[Han Lu]

On 04/01/2016 01:52 PM, Takashi Iwai wrote:
> On Fri, 01 Apr 2016 07:46:31 +0200,
> han.lu@intel.com wrote:
>> From: "Lu, Han" <han.lu@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@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.
OK, I can assign static buffer in rt5640 driver to store 
card->long_name, so no
need to share the space of card->snd_card->components.
>
> And what if name strings contain ':' letter?
This is indeed the problem and I have no good idea so far. Maybe use some
less common characters or brackets/braces to separate strings?
>
> Also, in this version, firmware is no longer optional but mandatory?
Sorry, I only tested empty string "" but ignored NULL string. Will fix it.

BR,
Han
>
> Takashi
> _______________________________________________
> Alsa-devel mailing list
> Alsa-devel@alsa-project.org
> http://mailman.alsa-project.org/mailman/listinfo/alsa-devel
>

[PATCH V4 2/2] ASoC: bytcr-rt5640: register DMI names to card

[han.lu]

From: "Lu, Han" <han.lu@intel.com>

Register DMI names for products using bytcr-rt5640 driver, such as ASUS
T100TA and Dell Venue 8 Pro 5830, for user space utils to distinguish
different products.

For example, previously on T100TA:
  $ cat /proc/asound/cards
    0 [bytcrrt5640 ]: bytcr-rt5640 -  bytcr-rt5640
                      bytcr-rt5640
  $ amixer -c0 info
  Card hw:0 'bytcrrt5640'/'bytcr-rt5640'
    Mixer name    : ''
    Components    : ''
    Controls      : 256
    Simple ctrls  : 228

After apply the patch:
  $ cat /proc/asound/cards
    0 [T100TA      ]: bytcr-rt5640 -  T100TA
                      T100TA:bytcr-rt5640:ASUSTek COMPUTER INC.:intel/fw_
  sst_0f28.bin
  $ amixer -c0 info
  Card hw:0 'T100TA'/'T100TA:bytcr-rt5640:ASUSTek COMPUTER INC.:intel/fw_
  sst_0f28.bin'
    Mixer name    : ''
    Components    : 'T100TA:bytcr-rt5640:ASUSTek COMPUTER INC.:intel/fw_s
  st_0f28.bin'
    Controls      : 256
    Simple ctrls  : 228

Signed-off-by: Lu, Han <han.lu@intel.com>

diff --git a/sound/soc/intel/boards/bytcr_rt5640.c b/sound/soc/intel/boards/bytcr_rt5640.c
index 032a2e7..468a724 100644
--- a/sound/soc/intel/boards/bytcr_rt5640.c
+++ b/sound/soc/intel/boards/bytcr_rt5640.c
@@ -152,6 +152,8 @@ static const struct dmi_system_id byt_rt5640_quirk_table[] = {
 	{}
 };
 
+static struct snd_soc_card byt_rt5640_card;
+
 static int byt_rt5640_init(struct snd_soc_pcm_runtime *runtime)
 {
 	int ret;
@@ -159,6 +161,19 @@ static int byt_rt5640_init(struct snd_soc_pcm_runtime *runtime)
 	struct snd_soc_card *card = runtime->card;
 	const struct snd_soc_dapm_route *custom_map;
 	int num_routes;
+	const char *board, *vendor;
+	struct sst_acpi_mach *mach = byt_rt5640_card.dev->platform_data;
+
+	/* Add board/product/vendor/firmware name for userspace */
+	board = dmi_get_system_info(DMI_BOARD_NAME);
+	if (!board)
+		board = dmi_get_system_info(DMI_PRODUCT_NAME);
+	vendor = dmi_get_system_info(DMI_SYS_VENDOR);
+	ret = snd_soc_set_card_names(card, board, vendor, mach->fw_filename);
+	if (ret < 0) {
+		dev_err(card->dev, "unable to set card names\n");
+		return ret;
+	}
 
 	card->dapm.idle_bias_off = true;
 
-- 
2.5.0