diff mbox

[V7,1/2] ASoC: core: add API for registering and cleaning up DMI card names

Message ID 61f4ce19dfebc462623ef95d959f49e98c09cd2a.1459926898.git.han.lu@intel.com (mailing list archive)
State New, archived
Headers show

Commit Message

han.lu@intel.com April 6, 2016, 7:29 a.m. UTC
From: "Lu, Han" <han.lu@intel.com>

Add core API for registering and cleaning up 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 were
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,
                             optional);(the firmware name, optional)

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

Comments

Takashi Sakamoto April 6, 2016, 9:48 a.m. UTC | #1
Hi,

On Apr 6 2016 16:29, han.lu@intel.com wrote:
> From: "Lu, Han" <han.lu@intel.com>
> 
> Add core API for registering and cleaning up 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 were
> 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,
>                              optional);(the firmware name, optional)
> 
> Signed-off-by: Lu, Han <han.lu@intel.com>
> 
> diff --git a/include/sound/soc.h b/include/sound/soc.h
> index 02b4a21..911d09e 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 *firmware);
> +void snd_soc_cleanup_card_names(struct snd_soc_card *card);
> +
>  /* 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..c1f3520 100644
> --- a/sound/soc/soc-core.c
> +++ b/sound/soc/soc-core.c
> (omit)
> +/**
> + * snd_soc_cleanup_card_names() - cleanup registered DMI names
> + * @card: The card to cleanup
> + *
> + * This function cleanup the registered DMI names from card
> + */
> +void snd_soc_cleanup_card_names(struct snd_soc_card *card)
> +{
> +	kfree(card->long_name);
> +}
> +EXPORT_SYMBOL_GPL(snd_soc_cleanup_card_names);
> +

In linux kernel development, such a function with a little statements
tends to be 'static inline function' defined in a header, instead of
maintaining more symbols. I think some APIs of Linux workqueue are good
examples to you. See 'include/linux/workqueue.h'.


Regards

Takashi Sakamoto
Han Lu April 7, 2016, 9:43 a.m. UTC | #2
On 04/06/2016 05:48 PM, Takashi Sakamoto wrote:
> Hi,
>
> On Apr 6 2016 16:29, han.lu@intel.com wrote:
>> From: "Lu, Han" <han.lu@intel.com>
>>
>> Add core API for registering and cleaning up 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 were
>> 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,
>>                               optional);(the firmware name, optional)
>>
>> Signed-off-by: Lu, Han <han.lu@intel.com>
>>
>> diff --git a/include/sound/soc.h b/include/sound/soc.h
>> index 02b4a21..911d09e 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 *firmware);
>> +void snd_soc_cleanup_card_names(struct snd_soc_card *card);
>> +
>>   /* 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..c1f3520 100644
>> --- a/sound/soc/soc-core.c
>> +++ b/sound/soc/soc-core.c
>> (omit)
>> +/**
>> + * snd_soc_cleanup_card_names() - cleanup registered DMI names
>> + * @card: The card to cleanup
>> + *
>> + * This function cleanup the registered DMI names from card
>> + */
>> +void snd_soc_cleanup_card_names(struct snd_soc_card *card)
>> +{
>> +	kfree(card->long_name);
>> +}
>> +EXPORT_SYMBOL_GPL(snd_soc_cleanup_card_names);
>> +
> In linux kernel development, such a function with a little statements
> tends to be 'static inline function' defined in a header, instead of
> maintaining more symbols. I think some APIs of Linux workqueue are good
> examples to you. See 'include/linux/workqueue.h'.

Thanks. Since we need to pass the string (firmware name) from machine
driver to core anyway, I guess one API is a must, but the cleanup API may
not necessary if there's no allocation. I'll rethink of it.

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

Patch

diff --git a/include/sound/soc.h b/include/sound/soc.h
index 02b4a21..911d09e 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 *firmware);
+void snd_soc_cleanup_card_names(struct snd_soc_card *card);
+
 /* 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..c1f3520 100644
--- a/sound/soc/soc-core.c
+++ b/sound/soc/soc-core.c
@@ -34,6 +34,7 @@ 
 #include <linux/ctype.h>
 #include <linux/slab.h>
 #include <linux/of.h>
+#include <linux/dmi.h>
 #include <sound/core.h>
 #include <sound/jack.h>
 #include <sound/pcm.h>
@@ -1828,6 +1829,90 @@  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() - Register DMI names to card
+ * @card: The card to register DMI names
+ * @firmware: The firmware name, optional
+ *
+ * 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,
+ *                              optional);(firmware name, optional)
+ *
+ * Returns 0 on success, otherwise a negative error code.
+ */
+int snd_soc_set_card_names(struct snd_soc_card *card, const char *firmware)
+{
+	int ret = 0;
+	size_t buf_size, name_size;
+	const char *board, *vendor;
+	char *longname;
+
+	board = dmi_get_system_info(DMI_BOARD_NAME);
+	if (!board)
+		board = dmi_get_system_info(DMI_PRODUCT_NAME);
+	if (!board) {
+		dev_err(card->dev, "ASoC: the board/product name is empty!\n");
+		return -EINVAL;
+	}
+
+	vendor = dmi_get_system_info(DMI_SYS_VENDOR);
+
+	/* card driver name */
+	card->driver_name = card->name;
+
+	/* card short name */
+	card->name = board;
+
+	/* card long name */
+	buf_size = sizeof(card->snd_card->longname);
+	name_size = strlen(card->name) + strlen(card->driver_name) + 4;
+	if (vendor)
+		name_size += strlen(vendor);
+	if (firmware)
+		name_size += strlen(firmware);
+	if (name_size > buf_size)
+		return -ENOMEM;
+
+	longname = kmalloc(buf_size, GFP_KERNEL);
+	if (!longname)
+		return -ENOMEM;
+	snprintf(longname, buf_size, "%s;%s;",
+			card->name, card->driver_name);
+	if (vendor)
+		strlcat(longname, vendor, buf_size);
+	strlcat(longname, ";", buf_size);
+	if (firmware)
+		strlcat(longname, firmware, buf_size);
+
+	card->long_name = longname;
+
+	/* card component */
+	if (sizeof(card->snd_card->components) < name_size
+			+ strlen(card->snd_card->components))
+		return -ENOMEM;
+
+	ret = snd_component_add(card->snd_card, card->long_name);
+
+	return ret;
+}
+EXPORT_SYMBOL_GPL(snd_soc_set_card_names);
+
+/**
+ * snd_soc_cleanup_card_names() - cleanup registered DMI names
+ * @card: The card to cleanup
+ *
+ * This function cleanup the registered DMI names from card
+ */
+void snd_soc_cleanup_card_names(struct snd_soc_card *card)
+{
+	kfree(card->long_name);
+}
+EXPORT_SYMBOL_GPL(snd_soc_cleanup_card_names);
+
 static int snd_soc_instantiate_card(struct snd_soc_card *card)
 {
 	struct snd_soc_codec *codec;