Some platforms may have support for offloading USB audio devices to a
dedicated audio DSP. Introduce a set of APIs that allow for management of
USB sound card and PCM devices enumerated by the USB SND class driver.
This allows for the ASoC components to be aware of what USB devices are
available for offloading.
Signed-off-by: Wesley Cheng <[email protected]>
---
include/sound/soc-usb.h | 51 +++++++++
sound/soc/Makefile | 2 +-
sound/soc/soc-usb.c | 236 ++++++++++++++++++++++++++++++++++++++++
3 files changed, 288 insertions(+), 1 deletion(-)
create mode 100644 include/sound/soc-usb.h
create mode 100644 sound/soc/soc-usb.c
diff --git a/include/sound/soc-usb.h b/include/sound/soc-usb.h
new file mode 100644
index 000000000000..c0c6b5abacdf
--- /dev/null
+++ b/include/sound/soc-usb.h
@@ -0,0 +1,51 @@
+/* SPDX-License-Identifier: GPL-2.0
+ *
+ * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved.
+ */
+
+#ifndef __LINUX_SND_SOC_USB_H
+#define __LINUX_SND_SOC_USB_H
+
+/**
+ * struct snd_soc_usb_device
+ * @card_idx - sound card index associated with USB device
+ * @chip_idx - USB sound chip array index
+ * @num_playback - number of playback streams
+ * @num_capture - number of capture streams
+ **/
+struct snd_soc_usb_device {
+ int card_idx;
+ int chip_idx;
+ int num_playback;
+ int num_capture;
+};
+
+/**
+ * struct snd_soc_usb
+ * @list - list head for SND SOC struct list
+ * @dev - USB backend device reference
+ * @component - reference to ASoC component
+ * @connection_status_cb - callback to notify connection events
+ * @priv_data - driver data
+ **/
+struct snd_soc_usb {
+ struct list_head list;
+ struct device *dev;
+ struct snd_soc_component *component;
+ int (*connection_status_cb)(struct snd_soc_usb *usb,
+ struct snd_soc_usb_device *sdev, bool connected);
+ void *priv_data;
+};
+
+const char *snd_soc_usb_get_components_tag(bool playback);
+
+int snd_soc_usb_connect(struct device *usbdev, struct snd_soc_usb_device *sdev);
+int snd_soc_usb_disconnect(struct device *usbdev, struct snd_soc_usb_device *sdev);
+void *snd_soc_usb_find_priv_data(struct device *dev);
+
+struct snd_soc_usb *snd_soc_usb_allocate_port(struct snd_soc_component *component,
+ int num_supported_streams, void *data);
+void snd_soc_usb_free_port(struct snd_soc_usb *usb);
+int snd_soc_usb_add_port(struct snd_soc_usb *usb);
+int snd_soc_usb_remove_port(struct snd_soc_usb *usb);
+#endif
diff --git a/sound/soc/Makefile b/sound/soc/Makefile
index 8376fdb217ed..d597cda11abc 100644
--- a/sound/soc/Makefile
+++ b/sound/soc/Makefile
@@ -1,5 +1,5 @@
# SPDX-License-Identifier: GPL-2.0
-snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-utils.o soc-dai.o soc-component.o
+snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-usb.o soc-utils.o soc-dai.o soc-component.o
snd-soc-core-objs += soc-pcm.o soc-devres.o soc-ops.o soc-link.o soc-card.o
snd-soc-core-$(CONFIG_SND_SOC_COMPRESS) += soc-compress.o
diff --git a/sound/soc/soc-usb.c b/sound/soc/soc-usb.c
new file mode 100644
index 000000000000..ca92418501a3
--- /dev/null
+++ b/sound/soc/soc-usb.c
@@ -0,0 +1,236 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved.
+ */
+#include <linux/of.h>
+#include <linux/usb.h>
+#include <sound/soc.h>
+#include <sound/soc-usb.h>
+#include "../usb/card.h"
+
+static DEFINE_MUTEX(ctx_mutex);
+static LIST_HEAD(usb_ctx_list);
+
+static struct device_node *snd_soc_find_phandle(struct device *dev)
+{
+ struct device_node *node;
+
+ node = of_parse_phandle(dev->of_node, "usb-soc-be", 0);
+ if (!node)
+ return ERR_PTR(-ENODEV);
+
+ return node;
+}
+
+static struct snd_soc_usb *snd_soc_find_usb_ctx(struct device_node *node)
+{
+ struct snd_soc_usb *ctx;
+
+ mutex_lock(&ctx_mutex);
+ list_for_each_entry(ctx, &usb_ctx_list, list) {
+ if (ctx->component->dev->of_node == node) {
+ mutex_unlock(&ctx_mutex);
+ return ctx;
+ }
+ }
+ mutex_unlock(&ctx_mutex);
+
+ return NULL;
+}
+
+/**
+ * snd_soc_usb_get_components_tag() - Retrieve SOC USB component tag
+ * @playback: direction of audio stream
+ *
+ * Returns the USB offload component tag used in the ASoC components
+ * string.
+ *
+ */
+const char *snd_soc_usb_get_components_tag(bool playback)
+{
+ if (playback)
+ return "usbplybkoffld: 1";
+ else
+ return "usbcapoffld: 1";
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_get_components_tag);
+
+/**
+ * snd_soc_usb_find_priv_data() - Retrieve private data stored
+ * @dev: device reference
+ *
+ * Fetch the private data stored in the USB SND SOC structure.
+ *
+ */
+void *snd_soc_usb_find_priv_data(struct device *dev)
+{
+ struct snd_soc_usb *ctx;
+ struct device_node *node;
+
+ node = snd_soc_find_phandle(dev);
+ if (!IS_ERR(node)) {
+ ctx = snd_soc_find_usb_ctx(node);
+ of_node_put(node);
+ } else {
+ /* Check if backend device */
+ ctx = snd_soc_find_usb_ctx(dev->of_node);
+ }
+
+ return ctx ? ctx->priv_data : NULL;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_find_priv_data);
+
+/**
+ * snd_soc_usb_allocate_port() - allocate a SOC USB device
+ * @component: USB DPCM backend DAI component
+ * @num_streams: number of supported offload streams
+ * @data: private data
+ *
+ * Allocate and initialize a SOC USB device. This will populate parameters that
+ * are used in subsequent sequences.
+ *
+ */
+struct snd_soc_usb *snd_soc_usb_allocate_port(struct snd_soc_component *component,
+ int num_streams, void *data)
+{
+ struct snd_soc_usb *usb;
+
+ usb = kzalloc(sizeof(*usb), GFP_KERNEL);
+ if (!usb)
+ return ERR_PTR(-ENOMEM);
+
+ usb->component = component;
+ usb->priv_data = data;
+ usb->num_supported_streams = num_streams;
+
+ return usb;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_allocate_port);
+
+/**
+ * snd_soc_usb_free_port() - free a SOC USB device
+ * @usb: allocated SOC USB device
+
+ * Free and remove the SOC USB device from the available list of devices.
+ *
+ */
+void snd_soc_usb_free_port(struct snd_soc_usb *usb)
+{
+ snd_soc_usb_remove_port(usb);
+ kfree(usb);
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_free_port);
+
+/**
+ * snd_soc_usb_add_port() - Add a USB backend port
+ * @dev: USB backend device
+ * @priv: private data
+ * @connection_cb: connection status callback
+ *
+ * Register a USB backend device to the SND USB SOC framework. Memory is
+ * allocated as part of the USB backend device.
+ *
+ */
+int snd_soc_usb_add_port(struct snd_soc_usb *usb)
+{
+ mutex_lock(&ctx_mutex);
+ list_add_tail(&usb->list, &usb_ctx_list);
+ mutex_unlock(&ctx_mutex);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_add_port);
+
+/**
+ * snd_soc_usb_remove_port() - Remove a USB backend port
+ * @dev: USB backend device
+ *
+ * Remove a USB backend device from USB SND SOC. Memory is freed when USB
+ * backend is removed.
+ *
+ */
+int snd_soc_usb_remove_port(struct snd_soc_usb *usb)
+{
+ struct snd_soc_usb *ctx, *tmp;
+
+ mutex_lock(&ctx_mutex);
+ list_for_each_entry_safe(ctx, tmp, &usb_ctx_list, list) {
+ if (ctx == usb) {
+ list_del(&ctx->list);
+ break;
+ }
+ }
+ mutex_unlock(&ctx_mutex);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_remove_port);
+
+/**
+ * snd_soc_usb_connect() - Notification of USB device connection
+ * @usbdev: USB bus device
+ * @card_idx: USB SND card instance
+ *
+ * Notify of a new USB SND device connection. The card_idx can be used to
+ * handle how the DPCM backend selects, which device to enable USB offloading
+ * on.
+ *
+ */
+int snd_soc_usb_connect(struct device *usbdev, struct snd_soc_usb_device *sdev)
+{
+ struct snd_soc_usb *ctx;
+ struct device_node *node;
+
+ if (!usbdev)
+ return -ENODEV;
+
+ node = snd_soc_find_phandle(usbdev);
+ if (IS_ERR(node))
+ return -ENODEV;
+
+ ctx = snd_soc_find_usb_ctx(node);
+ of_node_put(node);
+ if (!ctx)
+ return -ENODEV;
+
+ mutex_lock(&ctx_mutex);
+ if (ctx->connection_status_cb)
+ ctx->connection_status_cb(ctx, sdev, true);
+ mutex_unlock(&ctx_mutex);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_connect);
+
+/**
+ * snd_soc_usb_disconnect() - Notification of USB device disconnection
+ * @usbdev: USB bus device
+ *
+ * Notify of a new USB SND device disconnection to the USB backend.
+ *
+ */
+int snd_soc_usb_disconnect(struct device *usbdev, struct snd_soc_usb_device *sdev)
+{
+ struct snd_soc_usb *ctx;
+ struct device_node *node;
+
+ if (!usbdev)
+ return -ENODEV;
+
+ node = snd_soc_find_phandle(usbdev);
+ if (IS_ERR(node))
+ return -ENODEV;
+
+ ctx = snd_soc_find_usb_ctx(node);
+ of_node_put(node);
+ if (!ctx)
+ return -ENODEV;
+
+ mutex_lock(&ctx_mutex);
+ if (ctx->connection_status_cb)
+ ctx->connection_status_cb(ctx, sdev, false);
+ mutex_unlock(&ctx_mutex);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_disconnect);
On Fri, 09 Feb 2024 00:13:33 +0100,
Wesley Cheng wrote:
>
> Some platforms may have support for offloading USB audio devices to a
> dedicated audio DSP. Introduce a set of APIs that allow for management of
> USB sound card and PCM devices enumerated by the USB SND class driver.
> This allows for the ASoC components to be aware of what USB devices are
> available for offloading.
>
> Signed-off-by: Wesley Cheng <[email protected]>
(snip)
> --- a/sound/soc/Makefile
> +++ b/sound/soc/Makefile
> @@ -1,5 +1,5 @@
> # SPDX-License-Identifier: GPL-2.0
> -snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-utils.o soc-dai.o soc-component.o
> +snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-usb.o soc-utils.o soc-dai.o soc-component.o
> snd-soc-core-objs += soc-pcm.o soc-devres.o soc-ops.o soc-link.o soc-card.o
> snd-soc-core-$(CONFIG_SND_SOC_COMPRESS) += soc-compress.o
Do we really want to build this into ASoC core unconditionally?
This is very specific to Qualcomm USB-offload stuff, so it's better to
factor out.
thanks,
Takashi
Hi Takashi,
On 2/9/2024 2:54 AM, Takashi Iwai wrote:
> On Fri, 09 Feb 2024 00:13:33 +0100,
> Wesley Cheng wrote:
>>
>> Some platforms may have support for offloading USB audio devices to a
>> dedicated audio DSP. Introduce a set of APIs that allow for management of
>> USB sound card and PCM devices enumerated by the USB SND class driver.
>> This allows for the ASoC components to be aware of what USB devices are
>> available for offloading.
>>
>> Signed-off-by: Wesley Cheng <[email protected]>
> (snip)
>> --- a/sound/soc/Makefile
>> +++ b/sound/soc/Makefile
>> @@ -1,5 +1,5 @@
>> # SPDX-License-Identifier: GPL-2.0
>> -snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-utils.o soc-dai.o soc-component.o
>> +snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-usb.o soc-utils.o soc-dai.o soc-component.o
>> snd-soc-core-objs += soc-pcm.o soc-devres.o soc-ops.o soc-link.o soc-card.o
>> snd-soc-core-$(CONFIG_SND_SOC_COMPRESS) += soc-compress.o
>
> Do we really want to build this into ASoC core unconditionally?
> This is very specific to Qualcomm USB-offload stuff, so it's better to
> factor out.
>
Ideally, the SOC USB part shouldn't be Qualcomm specific. Since I don't
have access or insight into how other vendors are achieving the same
thing, I can only base the soc-usb layer to work with the information
that is required to get the audio stream up and running on the QC
platforms. In its simplest form, its basically just a SW entity that
notifies ASoC components about changes occurring from USB SND, and I
think all vendors that have an ASoC based platform card handling the
offload will need this notification.
Thanks
Wesley Cheng
On Fri, 09 Feb 2024 21:34:39 +0100,
Wesley Cheng wrote:
>
> Hi Takashi,
>
> On 2/9/2024 2:54 AM, Takashi Iwai wrote:
> > On Fri, 09 Feb 2024 00:13:33 +0100,
> > Wesley Cheng wrote:
> >>
> >> Some platforms may have support for offloading USB audio devices to a
> >> dedicated audio DSP. Introduce a set of APIs that allow for management of
> >> USB sound card and PCM devices enumerated by the USB SND class driver.
> >> This allows for the ASoC components to be aware of what USB devices are
> >> available for offloading.
> >>
> >> Signed-off-by: Wesley Cheng <[email protected]>
> > (snip)
> >> --- a/sound/soc/Makefile
> >> +++ b/sound/soc/Makefile
> >> @@ -1,5 +1,5 @@
> >> # SPDX-License-Identifier: GPL-2.0
> >> -snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-utils.o soc-dai.o soc-component.o
> >> +snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-usb.o soc-utils.o soc-dai.o soc-component.o
> >> snd-soc-core-objs += soc-pcm.o soc-devres.o soc-ops.o soc-link.o soc-card.o
> >> snd-soc-core-$(CONFIG_SND_SOC_COMPRESS) += soc-compress.o
> >
> > Do we really want to build this into ASoC core unconditionally?
> > This is very specific to Qualcomm USB-offload stuff, so it's better to
> > factor out.
> >
>
> Ideally, the SOC USB part shouldn't be Qualcomm specific. Since I
> don't have access or insight into how other vendors are achieving the
> same thing, I can only base the soc-usb layer to work with the
> information that is required to get the audio stream up and running on
> the QC platforms. In its simplest form, its basically just a SW
> entity that notifies ASoC components about changes occurring from USB
> SND, and I think all vendors that have an ASoC based platform card
> handling the offload will need this notification.
Yes, but it's not necessarily built into the snd-soc-core module at
all, but can be split to another module, right? Otherwise all
machines must load this code even if it doesn't use at all.
If this were common among various chips, it'd be worth to be merged
into the default common module. But I don't think that's the case.
thanks,
Takashi
Hi Takashi,
On 2/10/2024 12:08 AM, Takashi Iwai wrote:
> On Fri, 09 Feb 2024 21:34:39 +0100,
> Wesley Cheng wrote:
>>
>> Hi Takashi,
>>
>> On 2/9/2024 2:54 AM, Takashi Iwai wrote:
>>> On Fri, 09 Feb 2024 00:13:33 +0100,
>>> Wesley Cheng wrote:
>>>>
>>>> Some platforms may have support for offloading USB audio devices to a
>>>> dedicated audio DSP. Introduce a set of APIs that allow for management of
>>>> USB sound card and PCM devices enumerated by the USB SND class driver.
>>>> This allows for the ASoC components to be aware of what USB devices are
>>>> available for offloading.
>>>>
>>>> Signed-off-by: Wesley Cheng <[email protected]>
>>> (snip)
>>>> --- a/sound/soc/Makefile
>>>> +++ b/sound/soc/Makefile
>>>> @@ -1,5 +1,5 @@
>>>> # SPDX-License-Identifier: GPL-2.0
>>>> -snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-utils.o soc-dai.o soc-component.o
>>>> +snd-soc-core-objs := soc-core.o soc-dapm.o soc-jack.o soc-usb.o soc-utils.o soc-dai.o soc-component.o
>>>> snd-soc-core-objs += soc-pcm.o soc-devres.o soc-ops.o soc-link.o soc-card.o
>>>> snd-soc-core-$(CONFIG_SND_SOC_COMPRESS) += soc-compress.o
>>>
>>> Do we really want to build this into ASoC core unconditionally?
>>> This is very specific to Qualcomm USB-offload stuff, so it's better to
>>> factor out.
>>>
>>
>> Ideally, the SOC USB part shouldn't be Qualcomm specific. Since I
>> don't have access or insight into how other vendors are achieving the
>> same thing, I can only base the soc-usb layer to work with the
>> information that is required to get the audio stream up and running on
>> the QC platforms. In its simplest form, its basically just a SW
>> entity that notifies ASoC components about changes occurring from USB
>> SND, and I think all vendors that have an ASoC based platform card
>> handling the offload will need this notification.
>
> Yes, but it's not necessarily built into the snd-soc-core module at
> all, but can be split to another module, right? Otherwise all
> machines must load this code even if it doesn't use at all.
> If this were common among various chips, it'd be worth to be merged
> into the default common module. But I don't think that's the case.
>
That's fair. I'll make it a separate module and upload v15 tomorrow.
Thanks for the explanation.
Thanks
Wesley Cheng