[v9,07/34] ASoC: Add SOC USB APIs for adding an USB backend
Commit Message
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 <quic_wcheng@quicinc.com>
---
include/sound/soc-usb.h | 48 +++++++++++
sound/soc/Makefile | 2 +-
sound/soc/soc-usb.c | 186 ++++++++++++++++++++++++++++++++++++++++
3 files changed, 235 insertions(+), 1 deletion(-)
create mode 100644 include/sound/soc-usb.h
create mode 100644 sound/soc/soc-usb.c
Comments
On 10/17/23 15:00, 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
USB devices or USB endpoints? or both?
> available for offloading.
> +/**
> + * 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
presumably excluding explicit feedback 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;
usbdev for consistency with the API below?
> + struct snd_soc_component *component;
could you use component only and infer the device from component->dev?
> + int (*connection_status_cb)(struct snd_soc_usb *usb,
> + struct snd_soc_usb_device *sdev, bool connected);
> + void *priv_data;
> +};
> +
> +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_get_priv_data(struct device *usbdev);
> +
> +struct snd_soc_usb *snd_soc_usb_add_port(struct device *dev, void *priv,
struct device *usbdev for consistency ?
> + int (*connection_cb)(struct snd_soc_usb *usb,
> + struct snd_soc_usb_device *sdev, bool connected));
> +int snd_soc_usb_remove_port(struct device *dev);
struct device *usbdev for consistency ?
> +struct snd_soc_usb *snd_soc_usb_add_port(struct device *dev, void *priv,
> + int (*connection_cb)(struct snd_soc_usb *usb,
> + struct snd_soc_usb_device *sdev, bool connected))> +{
> + struct snd_soc_usb *usb;
> +
> + usb = devm_kzalloc(dev, sizeof(*usb), GFP_KERNEL);
> + if (!usb)
> + return ERR_PTR(-ENOMEM);
> +
> + usb->connection_status_cb = connection_cb;
> + usb->dev = dev;
> + usb->priv_data = priv;
> +
> + mutex_lock(&ctx_mutex);
> + list_add_tail(&usb->list, &usb_ctx_list);
> + mutex_unlock(&ctx_mutex);
> +
> + return usb;
> +}
> +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.
when the USB backend driver is unbound?
> + *
> + */
> +int snd_soc_usb_remove_port(struct device *dev)
> +{
> + struct snd_soc_usb *ctx, *tmp;
> +
> + mutex_lock(&ctx_mutex);
> + list_for_each_entry_safe(ctx, tmp, &usb_ctx_list, list) {
> + if (ctx->dev == dev) {
> + list_del(&ctx->list);
> + break;
> + }
> + }
> + mutex_unlock(&ctx_mutex);
> +
> + return 0;
can this return void to align with the current trend?
> +}
> +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.
card_idx is not used below, and I don't see how this relates to a
notification?
> + *
> + */
> +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;
> +
> + if (ctx->connection_status_cb)
> + ctx->connection_status_cb(ctx, sdev, true);
> +
> + return 0;
> +}
Hi Pierre,
On 10/17/2023 2:48 PM, Pierre-Louis Bossart wrote:
>
>
> On 10/17/23 15:00, 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
>
> USB devices or USB endpoints? or both?
>
USB devices. At least in our case, which endpoints being used will be
part of handling of the stream start QMI request coming from the audio
DSP at a later stage.
>> available for offloading.
>
>> +/**
>> + * 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
>
> presumably excluding explicit feedback streams?
>
That's correct. This doesn't include explicit streams. This is going
to be done during the stage mentioned above. We find the alternate USB
interface that supports the requested audio profile. From there the USB
SND already checks for if any feedback mechanism is used.
>> + **/
>> +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;
>
> usbdev for consistency with the API below?
>
This is not the usbdev, but the device reference to the DPCM backend DAI
(q6usb)
>> + struct snd_soc_component *component;
>
> could you use component only and infer the device from component->dev?
>
True, will look into that.
>> + int (*connection_status_cb)(struct snd_soc_usb *usb,
>> + struct snd_soc_usb_device *sdev, bool connected);
>> + void *priv_data;
>> +};
>> +
>> +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_get_priv_data(struct device *usbdev);
>> +
>> +struct snd_soc_usb *snd_soc_usb_add_port(struct device *dev, void *priv,
>
> struct device *usbdev for consistency ?
>
>> + int (*connection_cb)(struct snd_soc_usb *usb,
>> + struct snd_soc_usb_device *sdev, bool connected));
>> +int snd_soc_usb_remove_port(struct device *dev);
>
> struct device *usbdev for consistency ?
>
>
>> +struct snd_soc_usb *snd_soc_usb_add_port(struct device *dev, void *priv,
>> + int (*connection_cb)(struct snd_soc_usb *usb,
>> + struct snd_soc_usb_device *sdev, bool connected))> +{
>> + struct snd_soc_usb *usb;
>> +
>> + usb = devm_kzalloc(dev, sizeof(*usb), GFP_KERNEL);
>> + if (!usb)
>> + return ERR_PTR(-ENOMEM);
>> +
>> + usb->connection_status_cb = connection_cb;
>> + usb->dev = dev;
>> + usb->priv_data = priv;
>> +
>> + mutex_lock(&ctx_mutex);
>> + list_add_tail(&usb->list, &usb_ctx_list);
>> + mutex_unlock(&ctx_mutex);
>> +
>> + return usb;
>> +}
>> +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.
>
> when the USB backend driver is unbound?
>
Will rename.
>> + *
>> + */
>> +int snd_soc_usb_remove_port(struct device *dev)
>> +{
>> + struct snd_soc_usb *ctx, *tmp;
>> +
>> + mutex_lock(&ctx_mutex);
>> + list_for_each_entry_safe(ctx, tmp, &usb_ctx_list, list) {
>> + if (ctx->dev == dev) {
>> + list_del(&ctx->list);
>> + break;
>> + }
>> + }
>> + mutex_unlock(&ctx_mutex);
>> +
>> + return 0;
>
> can this return void to align with the current trend?
>
Sure.
>> +}
>> +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.
>
> card_idx is not used below, and I don't see how this relates to a
> notification?
>
Will fix this comment.
Thanks
Wesley Cheng
new file mode 100644
@@ -0,0 +1,48 @@
+/* SPDX-License-Identifier: GPL-2.0
+ *
+ * Copyright (c) 2022-2023 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;
+};
+
+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_get_priv_data(struct device *usbdev);
+
+struct snd_soc_usb *snd_soc_usb_add_port(struct device *dev, void *priv,
+ int (*connection_cb)(struct snd_soc_usb *usb,
+ struct snd_soc_usb_device *sdev, bool connected));
+int snd_soc_usb_remove_port(struct device *dev);
+#endif
@@ -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
new file mode 100644
@@ -0,0 +1,186 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright (c) 2022-2023 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->dev->of_node == node) {
+ mutex_unlock(&ctx_mutex);
+ return ctx;
+ }
+ }
+ mutex_unlock(&ctx_mutex);
+
+ return NULL;
+}
+
+/**
+ * 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_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.
+ *
+ */
+struct snd_soc_usb *snd_soc_usb_add_port(struct device *dev, void *priv,
+ int (*connection_cb)(struct snd_soc_usb *usb,
+ struct snd_soc_usb_device *sdev, bool connected))
+{
+ struct snd_soc_usb *usb;
+
+ usb = devm_kzalloc(dev, sizeof(*usb), GFP_KERNEL);
+ if (!usb)
+ return ERR_PTR(-ENOMEM);
+
+ usb->connection_status_cb = connection_cb;
+ usb->dev = dev;
+ usb->priv_data = priv;
+
+ mutex_lock(&ctx_mutex);
+ list_add_tail(&usb->list, &usb_ctx_list);
+ mutex_unlock(&ctx_mutex);
+
+ return usb;
+}
+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 device *dev)
+{
+ struct snd_soc_usb *ctx, *tmp;
+
+ mutex_lock(&ctx_mutex);
+ list_for_each_entry_safe(ctx, tmp, &usb_ctx_list, list) {
+ if (ctx->dev == dev) {
+ 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;
+
+ if (ctx->connection_status_cb)
+ ctx->connection_status_cb(ctx, sdev, true);
+
+ 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;
+
+ if (ctx->connection_status_cb)
+ ctx->connection_status_cb(ctx, sdev, false);
+
+ return 0;
+}
+EXPORT_SYMBOL_GPL(snd_soc_usb_disconnect);