From: Wesley Cheng <quic_wcheng@quicinc.com>
To: <srinivas.kandagatla@linaro.org>, <mathias.nyman@intel.com>,
<perex@perex.cz>, <conor+dt@kernel.org>, <corbet@lwn.net>,
<lgirdwood@gmail.com>, <andersson@kernel.org>,
<krzysztof.kozlowski+dt@linaro.org>, <gregkh@linuxfoundation.org>,
<Thinh.Nguyen@synopsys.com>, <broonie@kernel.org>,
<bgoswami@quicinc.com>, <tiwai@suse.com>, <robh@kernel.org>,
<konrad.dybcio@linaro.org>
Cc: <linux-kernel@vger.kernel.org>, <devicetree@vger.kernel.org>,
<linux-sound@vger.kernel.org>, <linux-usb@vger.kernel.org>,
<linux-arm-msm@vger.kernel.org>, <linux-doc@vger.kernel.org>,
<alsa-devel@alsa-project.org>,
Wesley Cheng <quic_wcheng@quicinc.com>
Subject: [PATCH v20 09/41] ASoC: Add SOC USB APIs for adding an USB backend
Date: Thu, 25 Apr 2024 14:50:53 -0700 [thread overview]
Message-ID: <20240425215125.29761-10-quic_wcheng@quicinc.com> (raw)
In-Reply-To: <20240425215125.29761-1-quic_wcheng@quicinc.com>
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 | 95 ++++++++++++++++
sound/soc/Kconfig | 10 ++
sound/soc/Makefile | 2 +
sound/soc/soc-usb.c | 239 ++++++++++++++++++++++++++++++++++++++++
4 files changed, 346 insertions(+)
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..5b2fa0877523
--- /dev/null
+++ b/include/sound/soc-usb.h
@@ -0,0 +1,95 @@
+/* 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
+ * @component - reference to ASoC component
+ * @num_supported_streams - number of supported concurrent sessions
+ * @connection_status_cb - callback to notify connection events
+ * @priv_data - driver data
+ **/
+struct snd_soc_usb {
+ struct list_head list;
+ struct snd_soc_component *component;
+ unsigned int num_supported_streams;
+ int (*connection_status_cb)(struct snd_soc_usb *usb,
+ struct snd_soc_usb_device *sdev, bool connected);
+ void *priv_data;
+};
+
+#if IS_ENABLED(CONFIG_SND_SOC_USB)
+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_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);
+#else
+static inline const char *snd_soc_usb_get_components_tag(bool playback)
+{
+ return "";
+}
+
+static inline int snd_soc_usb_connect(struct device *usbdev,
+ struct snd_soc_usb_device *sdev)
+{
+ return -ENODEV;
+}
+
+static inline int snd_soc_usb_disconnect(struct device *usbdev,
+ struct snd_soc_usb_device *sdev)
+{
+ return -EINVAL;
+}
+
+static inline void *snd_soc_usb_find_priv_data(struct device *dev)
+{
+ return NULL;
+}
+
+static inline struct snd_soc_usb *snd_soc_usb_allocate_port(
+ struct snd_soc_component *component,
+ int num_streams, void *data)
+{
+ return ERR_PTR(-ENOMEM);
+}
+
+static inline void snd_soc_usb_free_port(struct snd_soc_usb *usb)
+{ }
+
+static inline int snd_soc_usb_add_port(struct snd_soc_usb *usb)
+{
+ return -EINVAL;
+}
+
+static inline int snd_soc_usb_remove_port(struct snd_soc_usb *usb)
+{
+ return -ENODEV;
+}
+#endif /* IS_ENABLED(CONFIG_SND_SOC_USB) */
+#endif /*__LINUX_SND_SOC_USB_H */
diff --git a/sound/soc/Kconfig b/sound/soc/Kconfig
index 439fa631c342..848493a46831 100644
--- a/sound/soc/Kconfig
+++ b/sound/soc/Kconfig
@@ -76,6 +76,16 @@ config SND_SOC_UTILS_KUNIT_TEST
config SND_SOC_ACPI
tristate
+config SND_SOC_USB
+ tristate "SoC based USB audio offloading"
+ depends on SND_USB_AUDIO
+ help
+ Enable this option if an ASoC platform card has support to handle
+ USB audio offloading. This enables the SoC USB layer, which will
+ notifies the ASoC USB DPCM backend DAI link about available USB audio
+ devices. Based on the notifications, sequences to enable the audio
+ stream can be taken based on the design.
+
# All the supported SoCs
source "sound/soc/adi/Kconfig"
source "sound/soc/amd/Kconfig"
diff --git a/sound/soc/Makefile b/sound/soc/Makefile
index 8376fdb217ed..4c3d8b720d22 100644
--- a/sound/soc/Makefile
+++ b/sound/soc/Makefile
@@ -31,6 +31,8 @@ endif
obj-$(CONFIG_SND_SOC_ACPI) += snd-soc-acpi.o
+obj-$(CONFIG_SND_SOC_USB) += soc-usb.o
+
obj-$(CONFIG_SND_SOC) += snd-soc-core.o
obj-$(CONFIG_SND_SOC) += codecs/
obj-$(CONFIG_SND_SOC) += generic/
diff --git a/sound/soc/soc-usb.c b/sound/soc/soc-usb.c
new file mode 100644
index 000000000000..d21db2345966
--- /dev/null
+++ b/sound/soc/soc-usb.c
@@ -0,0 +1,239 @@
+// 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 offloading sessions supported
+ * @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);
+
+MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("SoC USB driver for offloading");
next prev parent reply other threads:[~2024-04-25 21:52 UTC|newest]
Thread overview: 55+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-25 21:50 [PATCH v20 00/41] Introduce QC USB SND audio offloading support Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 01/41] xhci: add helper to stop endpoint and wait for completion Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 02/41] usb: host: xhci: Export enable and disable interrupter APIs Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 03/41] usb: host: xhci: Repurpose event handler for skipping interrupter events Wesley Cheng
2024-04-30 11:02 ` Mathias Nyman
2024-04-30 21:57 ` Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 04/41] xhci: export XHCI IMOD setting helper for interrupters Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 05/41] xhci: sideband: add initial api to register a sideband entity Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 06/41] usb: host: xhci-sideband: Expose a sideband interrupter enable API Wesley Cheng
2024-05-02 11:07 ` Mathias Nyman
2024-05-02 23:37 ` Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 07/41] usb: host: xhci-mem: Cleanup pending secondary event ring events Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 08/41] usb: host: xhci-mem: Allow for interrupter clients to choose specific index Wesley Cheng
2024-04-26 13:24 ` Amadeusz Sławiński
2024-04-26 20:03 ` Wesley Cheng
2024-04-25 21:50 ` Wesley Cheng [this message]
2024-04-26 13:25 ` [PATCH v20 09/41] ASoC: Add SOC USB APIs for adding an USB backend Amadeusz Sławiński
2024-04-26 21:55 ` Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 10/41] ASoC: dt-bindings: qcom,q6dsp-lpass-ports: Add USB_RX port Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 11/41] ASoC: qcom: qdsp6: Introduce USB AFE port to q6dsp Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 12/41] ASoC: qdsp6: q6afe: Increase APR timeout Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 13/41] ASoC: qcom: qdsp6: Add USB backend ASoC driver for Q6 Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 14/41] ALSA: usb-audio: Introduce USB SND platform op callbacks Wesley Cheng
2024-04-25 21:50 ` [PATCH v20 15/41] ALSA: usb-audio: Export USB SND APIs for modules Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 16/41] ALSA: usb-audio: Save UAC sample size information Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 17/41] usb: dwc3: Specify maximum number of XHCI interrupters Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 18/41] usb: host: xhci-plat: Set XHCI max interrupters if property is present Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 19/41] ALSA: usb-audio: qcom: Add USB QMI definitions Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 20/41] ALSA: usb-audio: qcom: Introduce QC USB SND offloading support Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 21/41] ALSA: usb-audio: Check for support for requested audio format Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 22/41] ASoC: usb: Add PCM format check API for USB backend Wesley Cheng
2024-04-26 13:25 ` Amadeusz Sławiński
2024-04-30 8:01 ` Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 23/41] ASoC: qcom: qdsp6: Ensure PCM format is supported by USB audio device Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 24/41] ALSA: usb-audio: Prevent starting of audio stream if in use Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 25/41] ALSA: usb-audio: Do not allow USB offload path if PCM device is " Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 26/41] ASoC: dt-bindings: Update example for enabling USB offload on SM8250 Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 27/41] ALSA: usb-audio: qcom: Populate PCM and USB chip information Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 28/41] ASoC: qcom: qdsp6: Add support to track available USB PCM devices Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 29/41] ASoC: Introduce SND kcontrols to select sound card and PCM device Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 30/41] ASoC: qcom: qdsp6: Add SOC USB offload select get/put callbacks Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 31/41] ASoC: Introduce SND kcontrols to track USB offloading state Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 32/41] ASoC: qcom: qdsp6: Add PCM ops to track current state Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 33/41] ASoC: usb: Create SOC USB SND jack kcontrol Wesley Cheng
2024-04-26 13:26 ` Amadeusz Sławiński
2024-05-01 0:32 ` Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 34/41] ASoC: qcom: qdsp6: Add headphone jack for offload connection status Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 35/41] ASoC: usb: Fetch ASoC sound card information Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 36/41] ALSA: usb-audio: Add USB offloading capable kcontrol Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 37/41] ALSA: usb-audio: Allow for rediscovery of connected USB SND devices Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 38/41] ALSA: usb-audio: qcom: Use card and PCM index from QMI request Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 39/41] ASoC: usb: Rediscover USB SND devices on USB port add Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 40/41] ASoC: qcom: Populate SoC components string Wesley Cheng
2024-04-25 21:51 ` [PATCH v20 41/41] ASoC: doc: Add documentation for SOC USB Wesley Cheng
2024-04-26 3:36 ` Bagas Sanjaya
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240425215125.29761-10-quic_wcheng@quicinc.com \
--to=quic_wcheng@quicinc.com \
--cc=Thinh.Nguyen@synopsys.com \
--cc=alsa-devel@alsa-project.org \
--cc=andersson@kernel.org \
--cc=bgoswami@quicinc.com \
--cc=broonie@kernel.org \
--cc=conor+dt@kernel.org \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=gregkh@linuxfoundation.org \
--cc=konrad.dybcio@linaro.org \
--cc=krzysztof.kozlowski+dt@linaro.org \
--cc=lgirdwood@gmail.com \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=mathias.nyman@intel.com \
--cc=perex@perex.cz \
--cc=robh@kernel.org \
--cc=srinivas.kandagatla@linaro.org \
--cc=tiwai@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).