| Message ID | 20240829194105.1504814-1-quic_wcheng@quicinc.com |
|---|---|
| Headers | show |
| Series | Introduce QC USB SND audio offloading support | expand |
On 8/29/24 21:40, Wesley Cheng wrote: > Allow for checks on a specific USB audio device to see if a requested PCM > format is supported. This is needed for support when playback is > initiated by the ASoC USB backend path. > > Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
On 8/29/24 21:40, Wesley Cheng wrote: > USB SND needs to know how the USB offload path is being routed. This would > allow for applications to open the corresponding sound card and pcm device > when it wants to take the audio offload path. This callback should return > the mapped indexes based on the USB SND device information. > > Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> Reviewed-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> > diff --git a/include/sound/soc-usb.h b/include/sound/soc-usb.h > index 5c788cbfa82e..86876098a2b7 100644 > --- a/include/sound/soc-usb.h > +++ b/include/sound/soc-usb.h > @@ -36,6 +36,7 @@ struct snd_soc_usb_device { > * @list - list head for SND SOC struct list > * @component - reference to ASoC component > * @connection_status_cb - callback to notify connection events > + * @update_offload_route_info - callback to fetch mapped ASoC device nit-pick: explain that 'route' refers to the (card, device) pair and isn't related to the concept of DAPM route. > * @priv_data - driver data > **/ > struct snd_soc_usb { > @@ -44,6 +45,9 @@ struct snd_soc_usb { > int (*connection_status_cb)(struct snd_soc_usb *usb, > struct snd_soc_usb_device *sdev, > bool connected); > + int (*update_offload_route_info)(struct snd_soc_component *component, > + int card, int pcm, int direction, > + long *route); nit-pick: also explain the format used for the (card, device) pair stored in the long > void *priv_data; > }; > > @@ -59,6 +63,8 @@ void *snd_soc_usb_find_priv_data(struct device *dev); > int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component, > struct snd_soc_jack *jack); > int snd_soc_usb_disable_offload_jack(struct snd_soc_component *component); > +int snd_soc_usb_update_offload_route(struct device *dev, int card, int pcm, > + int direction, long *route); > > struct snd_soc_usb *snd_soc_usb_allocate_port(struct snd_soc_component *component, > void *data); > @@ -101,6 +107,12 @@ static inline int snd_soc_usb_disable_offload_jack(struct snd_soc_component *com > return 0; > } > > +static int snd_soc_usb_update_offload_route(struct device *dev, int card, int pcm, > + int direction, long *route) > +{ > + return -ENODEV; > +} > + > static inline struct snd_soc_usb * > snd_soc_usb_allocate_port(struct snd_soc_component *component, void *data) > { > diff --git a/sound/soc/soc-usb.c b/sound/soc/soc-usb.c > index 3d5354298206..de249e8a28cb 100644 > --- a/sound/soc/soc-usb.c > +++ b/sound/soc/soc-usb.c > @@ -117,6 +117,37 @@ int snd_soc_usb_disable_offload_jack(struct snd_soc_component *component) > } > EXPORT_SYMBOL_GPL(snd_soc_usb_disable_offload_jack); > > +/** > + * snd_soc_usb_update_offload_route - Find active USB offload path > + * @dev - USB device to get offload status > + * @card - USB card index > + * @pcm - USB PCM device index > + * @direction - playback or capture direction > + * @route - pointer to route output array > + * > + * Fetch the current status for the USB SND card and PCM device indexes > + * specified. > + */ > +int snd_soc_usb_update_offload_route(struct device *dev, int card, int pcm, > + int direction, long *route) > +{ > + struct snd_soc_usb *ctx; > + int ret; > + > + ctx = snd_soc_find_usb_ctx(dev); > + if (!ctx) > + return -ENODEV; > + > + mutex_lock(&ctx_mutex); > + if (ctx && ctx->update_offload_route_info) > + ret = ctx->update_offload_route_info(ctx->component, card, pcm, > + direction, route); > + mutex_unlock(&ctx_mutex); > + > + return ret; > +} > +EXPORT_SYMBOL_GPL(snd_soc_usb_update_offload_route); > + > /** > * snd_soc_usb_find_priv_data() - Retrieve private data stored > * @dev: device reference
On 8/29/24 21:40, Wesley Cheng wrote: > The QC ADSP is able to support USB playback endpoints, so that the main > application processor can be placed into lower CPU power modes. This adds > the required AFE port configurations and port start command to start an > audio session. > > Specifically, the QC ADSP can support all potential endpoints that are > exposed by the audio data interface. This includes, feedback endpoints > (both implicit and explicit) as well as the isochronous (data) endpoints. I think you meant " this includes isochronous data endpoints, in either synchronous mode or asynchronous mode. In the latter case both implicit or explicit feedback endpoints are supported. " And now I don't remember how *controls* are handled. Is this the case that all controls exposed by endpoint zero are visible in both the regular USB-audio card AND the offloaded card, with changes mirrored? It's important to explain so that the volumes are consistent no matter which path is used. This should be added to the documentation. > +static const struct snd_soc_dai_ops q6afe_usb_ops = { > + .probe = msm_dai_q6_dai_probe, > + .prepare = q6afe_dai_prepare, > + .hw_params = q6afe_usb_hw_params, > + /* > + * Shutdown callback required to stop the USB AFE port, which is enabled > + * by the prepare() stage. This stops the audio traffic on the USB AFE > + * port on the Q6DSP. > + */ > + .shutdown = q6afe_dai_shutdown, > + /* > + * Startup callback not needed, as AFE port start command passes the PCM > + * parameters within the AFE command, which is provided by the PCM core > + * during the prepare() stage. > + */ Humm, now this is a bit confusing. Why would you need a shutdown, can't you use the hw_free() callback for symmetry with prepare()?
On 8/29/24 21:40, Wesley Cheng wrote: > Create a USB BE component that will register a new USB port to the ASoC USB > framework. This will handle determination on if the requested audio > profile is supported by the USB device currently selected. > > Check for if the PCM format is supported during the hw_params callback. If > the profile is not supported then the userspace ALSA entity will receive an > error, and can take further action. > > Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> > --- > include/sound/q6usboffload.h | 20 +++ > sound/soc/qcom/Kconfig | 10 ++ > sound/soc/qcom/qdsp6/Makefile | 1 + > sound/soc/qcom/qdsp6/q6usb.c | 246 ++++++++++++++++++++++++++++++++++ > 4 files changed, 277 insertions(+) > create mode 100644 include/sound/q6usboffload.h > create mode 100644 sound/soc/qcom/qdsp6/q6usb.c > > diff --git a/include/sound/q6usboffload.h b/include/sound/q6usboffload.h > new file mode 100644 > index 000000000000..49ab2c34b84c > --- /dev/null > +++ b/include/sound/q6usboffload.h > @@ -0,0 +1,20 @@ > +/* SPDX-License-Identifier: GPL-2.0 > + * > + * linux/sound/q6usboffload.h -- QDSP6 USB offload not sure about the linux/ prefix? > + * > + * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved. > + */ > + > +/** > + * struct q6usb_offload > + * @dev - dev handle to usb be > + * @sid - streamID for iommu > + * @intr_num - usb interrupter number > + * @domain - allocated iommu domain > + **/ > +struct q6usb_offload { > + struct device *dev; > + long long sid; > + u16 intr_num; > + struct iommu_domain *domain; > +}; consider reordering to avoid holes/alignment issues, e.g. all pointers first, then long long then u16 > +static int q6usb_hw_params(struct snd_pcm_substream *substream, > + struct snd_pcm_hw_params *params, > + struct snd_soc_dai *dai) > +{ > + struct q6usb_port_data *data = dev_get_drvdata(dai->dev); > + struct snd_soc_pcm_runtime *rtd = substream->private_data; > + struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0); > + int direction = substream->stream; > + struct q6afe_port *q6usb_afe; > + struct snd_soc_usb_device *sdev; > + int ret = -EINVAL; > + > + mutex_lock(&data->mutex); > + > + /* No active chip index */ > + if (list_empty(&data->devices)) > + goto out; -ENODEV for the default return value>? > + > + sdev = list_last_entry(&data->devices, struct snd_soc_usb_device, list); > + > + ret = snd_soc_usb_find_supported_format(sdev->chip_idx, params, direction); > + if (ret < 0) > + goto out; > + > + q6usb_afe = q6afe_port_get_from_id(cpu_dai->dev, USB_RX); > + if (IS_ERR(q6usb_afe)) > + goto out; > + > + /* Notify audio DSP about the devices being offloaded */ > + ret = afe_port_send_usb_dev_param(q6usb_afe, sdev->card_idx, > + sdev->ppcm_idx[sdev->num_playback - 1]); don't you need a symmetrical notification upon hw_free()? Also what happens if there are multiple calls to hw_params, which is quite legit in ALSA/ASoC?
On 8/29/24 21:40, Wesley Cheng wrote: > The USB SND path may need to know how the USB offload path is routed, so > that applications can open the proper sound card and PCM device. The > implementation for the QC ASoC design has a "USB Mixer" kcontrol for each > possible FE (Q6ASM) DAI, which can be utilized to know which front end link > is enabled. > > When an application/userspace queries for the mapped offload devices, the > logic will lookup the USB mixer status though the following path: > > MultiMedia* <-> MM_DL* <-> USB Mixer* > > The "USB Mixer" is a DAPM widget, and the q6routing entity will set the > DAPM connect status accordingly if the USB mixer is enabled. If enabled, > the Q6USB backend link can fetch the PCM device number from the FE DAI > link (Multimedia*). With respects to the card number, that is > straightforward, as the ASoC components have direct references to the ASoC > platform sound card. > > An example output can be shown below: > > Number of controls: 9 > name value > Capture Channel Map 0, 0 (range 0->36) > Playback Channel Map 0, 0 (range 0->36) > Headset Capture Switch On > Headset Capture Volume 1 (range 0->4) > Sidetone Playback Switch On > Sidetone Playback Volume 4096 (range 0->8192) > Headset Playback Switch On > Headset Playback Volume 20, 20 (range 0->24) > USB Offload Playback Route PCM#0 0, 1 (range -1->255) > > The "USB Offload Playback Route PCM#*" kcontrol will signify the > corresponding card and pcm device it is offload to. (card#0 pcm - device#1) > If the USB SND device supports multiple audio interfaces, then it will > contain several PCM streams, hence in those situations, it is expected > that there will be multiple playback route kcontrols created. > > Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> > --- > sound/soc/qcom/qdsp6/q6usb.c | 104 +++++++++++++++++++++++++++++++++++ > 1 file changed, 104 insertions(+) > > diff --git a/sound/soc/qcom/qdsp6/q6usb.c b/sound/soc/qcom/qdsp6/q6usb.c > index 10337d70eb27..c2fc0dedf430 100644 > --- a/sound/soc/qcom/qdsp6/q6usb.c > +++ b/sound/soc/qcom/qdsp6/q6usb.c > @@ -132,6 +132,109 @@ static int q6usb_audio_ports_of_xlate_dai_name(struct snd_soc_component *compone > return ret; > } > > +static int q6usb_get_pcm_id_from_widget(struct snd_soc_dapm_widget *w) > +{ > + struct snd_soc_pcm_runtime *rtd; > + struct snd_soc_dai *dai; > + > + for_each_card_rtds(w->dapm->card, rtd) { > + dai = snd_soc_rtd_to_cpu(rtd, 0); > + /* > + * Only look for playback widget. RTD number carries the assigned > + * PCM index. > + */ > + if (dai->stream[0].widget == w) > + return rtd->num; > + } > + > + return -1; > +} > + > +static int q6usb_usb_mixer_enabled(struct snd_soc_dapm_widget *w) > +{ > + struct snd_soc_dapm_path *p; > + > + /* Checks to ensure USB path is enabled/connected */ > + snd_soc_dapm_widget_for_each_sink_path(w, p) > + if (!strcmp(p->sink->name, "USB Mixer") && p->connect) > + return 1; > + > + return 0; > +} > + > +static int q6usb_get_pcm_id(struct snd_soc_component *component) > +{ > + struct snd_soc_dapm_widget *w; > + struct snd_soc_dapm_path *p; > + int pidx; > + > + /* > + * Traverse widgets to find corresponding FE widget. The DAI links are > + * built like the following: > + * MultiMedia* <-> MM_DL* <-> USB Mixer* > + */ > + for_each_card_widgets(component->card, w) { > + if (!strncmp(w->name, "MultiMedia", 10)) { > + /* > + * Look up all paths associated with the FE widget to see if > + * the USB BE is enabled. The sink widget is responsible to > + * link with the USB mixers. > + */ > + snd_soc_dapm_widget_for_each_sink_path(w, p) { > + if (q6usb_usb_mixer_enabled(p->sink)) { > + pidx = q6usb_get_pcm_id_from_widget(w); > + return pidx; > + } > + } Humm, there should be a note that the design assumes that the USB offload path exposes a single PCM per endpoints - same as the non-offloaded path. If the ASoC card has multiple PCMs for each endpoint, possibly with different processing on each PCM, then the mapping would fail. The other question is whether you need to walk in the DAPM graph, in theory DPCM has helpers to find which FEs are connected to which BE.
On 8/29/24 21:41, Wesley Cheng wrote: > Utilize the card and PCM index coming from the USB QMI stream request. > This field follows what is set by the ASoC USB backend, and could > potentially carry information about a specific device selected through the > ASoC USB backend. The backend also has information about the last USB > sound device plugged in, so it can choose to select the last device plugged > in, accordingly. > > Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> > --- > sound/usb/qcom/qc_audio_offload.c | 8 ++------ > 1 file changed, 2 insertions(+), 6 deletions(-) > > diff --git a/sound/usb/qcom/qc_audio_offload.c b/sound/usb/qcom/qc_audio_offload.c > index 0bd533f539e4..a7ad15404fd1 100644 > --- a/sound/usb/qcom/qc_audio_offload.c > +++ b/sound/usb/qcom/qc_audio_offload.c > @@ -106,8 +106,6 @@ struct uaudio_qmi_dev { > bool er_mapped; > /* reference count to number of possible consumers */ > atomic_t qdev_in_use; > - /* idx to last udev card number plugged in */ > - unsigned int last_card_num; > }; > > struct uaudio_dev { > @@ -1261,7 +1259,7 @@ static int prepare_qmi_response(struct snd_usb_substream *subs, > > pcm_dev_num = (req_msg->usb_token & QMI_STREAM_REQ_DEV_NUM_MASK) >> 8; > xfer_buf_len = req_msg->xfer_buff_size; > - card_num = uaudio_qdev->last_card_num; > + card_num = (req_msg->usb_token & QMI_STREAM_REQ_CARD_NUM_MASK) >> 16; > > if (!uadev[card_num].ctrl_intf) { > dev_err(&subs->dev->dev, "audio ctrl intf info not cached\n"); > @@ -1455,8 +1453,7 @@ static void handle_uaudio_stream_req(struct qmi_handle *handle, > > direction = (req_msg->usb_token & QMI_STREAM_REQ_DIRECTION); > pcm_dev_num = (req_msg->usb_token & QMI_STREAM_REQ_DEV_NUM_MASK) >> 8; > - pcm_card_num = req_msg->enable ? uaudio_qdev->last_card_num : > - ffs(uaudio_qdev->card_slot) - 1; > + pcm_card_num = (req_msg->usb_token & QMI_STREAM_REQ_CARD_NUM_MASK) >> 16; > if (pcm_card_num >= SNDRV_CARDS) { > ret = -EINVAL; > goto response; > @@ -1706,7 +1703,6 @@ static void qc_usb_audio_offload_probe(struct snd_usb_audio *chip) > sdev->card_idx = chip->card->number; > sdev->chip_idx = chip->index; > > - uaudio_qdev->last_card_num = chip->card->number; > snd_soc_usb_connect(usb_get_usb_backend(udev), sdev); > } This entire path seems like a bad split/merge, it removes stuff that was done earlier. Also it's not clear what this has to do with 'QMI', card and PCM device management is usually done at a higher level. not following, please be mindful of reviewer fatigue when adding such changes in patch 30/33....
On 8/30/2024 2:12 AM, Pierre-Louis Bossart wrote: > > On 8/29/24 21:40, Wesley Cheng wrote: >> The QC ADSP is able to support USB playback endpoints, so that the main >> application processor can be placed into lower CPU power modes. This adds >> the required AFE port configurations and port start command to start an >> audio session. >> >> Specifically, the QC ADSP can support all potential endpoints that are >> exposed by the audio data interface. This includes, feedback endpoints >> (both implicit and explicit) as well as the isochronous (data) endpoints. > I think you meant > > " > this includes isochronous data endpoints, in either synchronous mode or > asynchronous mode. In the latter case both implicit or explicit feedback > endpoints are supported. > " > > And now I don't remember how *controls* are handled. > > Is this the case that all controls exposed by endpoint zero are visible > in both the regular USB-audio card AND the offloaded card, with changes > mirrored? I think we had a discussion about this previously, but can't seem to find it. The USB volume controls (ie controls still handled by the control EP) are going to still reside only within the USB SND card. As of now, there aren't any kcontrols that are being added to the ASoC platform card for offload. > It's important to explain so that the volumes are consistent no matter > which path is used. This should be added to the documentation. > > >> +static const struct snd_soc_dai_ops q6afe_usb_ops = { >> + .probe = msm_dai_q6_dai_probe, >> + .prepare = q6afe_dai_prepare, >> + .hw_params = q6afe_usb_hw_params, >> + /* >> + * Shutdown callback required to stop the USB AFE port, which is enabled >> + * by the prepare() stage. This stops the audio traffic on the USB AFE >> + * port on the Q6DSP. >> + */ >> + .shutdown = q6afe_dai_shutdown, >> + /* >> + * Startup callback not needed, as AFE port start command passes the PCM >> + * parameters within the AFE command, which is provided by the PCM core >> + * during the prepare() stage. >> + */ > Humm, now this is a bit confusing. Why would you need a shutdown, can't > you use the hw_free() callback for symmetry with prepare()? I thought that it was hw_params() -- hw_free() and prepare() -- shutdown()? "DPCM runs the PCM trigger(stop), hw_free(), shutdown() operations on DAI0 for headset since the path is now disabled. DPCM runs the PCM ops for startup(), hw_params(), prepare() and trigger(start) for DAI1 Speakers since the path is enabled." https://www.kernel.org/doc/html/v6.10/sound/soc/dpcm.html Thanks Wesley Cheng >
Hi Pierre, On 8/30/2024 2:21 AM, Pierre-Louis Bossart wrote: > > On 8/29/24 21:40, Wesley Cheng wrote: >> Create a USB BE component that will register a new USB port to the ASoC USB >> framework. This will handle determination on if the requested audio >> profile is supported by the USB device currently selected. >> >> Check for if the PCM format is supported during the hw_params callback. If >> the profile is not supported then the userspace ALSA entity will receive an >> error, and can take further action. >> >> Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> >> --- >> include/sound/q6usboffload.h | 20 +++ >> sound/soc/qcom/Kconfig | 10 ++ >> sound/soc/qcom/qdsp6/Makefile | 1 + >> sound/soc/qcom/qdsp6/q6usb.c | 246 ++++++++++++++++++++++++++++++++++ >> 4 files changed, 277 insertions(+) >> create mode 100644 include/sound/q6usboffload.h >> create mode 100644 sound/soc/qcom/qdsp6/q6usb.c >> >> diff --git a/include/sound/q6usboffload.h b/include/sound/q6usboffload.h >> new file mode 100644 >> index 000000000000..49ab2c34b84c >> --- /dev/null >> +++ b/include/sound/q6usboffload.h >> @@ -0,0 +1,20 @@ >> +/* SPDX-License-Identifier: GPL-2.0 >> + * >> + * linux/sound/q6usboffload.h -- QDSP6 USB offload > not sure about the linux/ prefix? > >> + * >> + * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved. >> + */ >> + >> +/** >> + * struct q6usb_offload >> + * @dev - dev handle to usb be >> + * @sid - streamID for iommu >> + * @intr_num - usb interrupter number >> + * @domain - allocated iommu domain >> + **/ >> +struct q6usb_offload { >> + struct device *dev; >> + long long sid; >> + u16 intr_num; >> + struct iommu_domain *domain; >> +}; > consider reordering to avoid holes/alignment issues, e.g. all pointers > first, then long long then u16 > Will fix these. >> +static int q6usb_hw_params(struct snd_pcm_substream *substream, >> + struct snd_pcm_hw_params *params, >> + struct snd_soc_dai *dai) >> +{ >> + struct q6usb_port_data *data = dev_get_drvdata(dai->dev); >> + struct snd_soc_pcm_runtime *rtd = substream->private_data; >> + struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0); >> + int direction = substream->stream; >> + struct q6afe_port *q6usb_afe; >> + struct snd_soc_usb_device *sdev; >> + int ret = -EINVAL; >> + >> + mutex_lock(&data->mutex); >> + >> + /* No active chip index */ >> + if (list_empty(&data->devices)) >> + goto out; > -ENODEV for the default return value>? Sure. >> + >> + sdev = list_last_entry(&data->devices, struct snd_soc_usb_device, list); >> + >> + ret = snd_soc_usb_find_supported_format(sdev->chip_idx, params, direction); >> + if (ret < 0) >> + goto out; >> + >> + q6usb_afe = q6afe_port_get_from_id(cpu_dai->dev, USB_RX); >> + if (IS_ERR(q6usb_afe)) >> + goto out; >> + >> + /* Notify audio DSP about the devices being offloaded */ >> + ret = afe_port_send_usb_dev_param(q6usb_afe, sdev->card_idx, >> + sdev->ppcm_idx[sdev->num_playback - 1]); > don't you need a symmetrical notification upon hw_free()? > > Also what happens if there are multiple calls to hw_params, which is > quite legit in ALSA/ASoC? The afe_port_send_usb_dev_param() is meant to just update the device selected for offload on the audio DSP end, and this won't be referenced until our Q6AFE DAI sends the port start command in its prepare() callback. Don't think we need to handle anything specific in the hw_free() case. As long as the hw_params() callback is called before any audio session is started, then we'll ensure that the device selected is always updated to the audio DSP. Thanks Wesley Cheng
Hi Pierre, On 8/30/2024 2:34 AM, Pierre-Louis Bossart wrote: > > On 8/29/24 21:40, Wesley Cheng wrote: >> The USB SND path may need to know how the USB offload path is routed, so >> that applications can open the proper sound card and PCM device. The >> implementation for the QC ASoC design has a "USB Mixer" kcontrol for each >> possible FE (Q6ASM) DAI, which can be utilized to know which front end link >> is enabled. >> >> When an application/userspace queries for the mapped offload devices, the >> logic will lookup the USB mixer status though the following path: >> >> MultiMedia* <-> MM_DL* <-> USB Mixer* >> >> The "USB Mixer" is a DAPM widget, and the q6routing entity will set the >> DAPM connect status accordingly if the USB mixer is enabled. If enabled, >> the Q6USB backend link can fetch the PCM device number from the FE DAI >> link (Multimedia*). With respects to the card number, that is >> straightforward, as the ASoC components have direct references to the ASoC >> platform sound card. >> >> An example output can be shown below: >> >> Number of controls: 9 >> name value >> Capture Channel Map 0, 0 (range 0->36) >> Playback Channel Map 0, 0 (range 0->36) >> Headset Capture Switch On >> Headset Capture Volume 1 (range 0->4) >> Sidetone Playback Switch On >> Sidetone Playback Volume 4096 (range 0->8192) >> Headset Playback Switch On >> Headset Playback Volume 20, 20 (range 0->24) >> USB Offload Playback Route PCM#0 0, 1 (range -1->255) >> >> The "USB Offload Playback Route PCM#*" kcontrol will signify the >> corresponding card and pcm device it is offload to. (card#0 pcm - device#1) >> If the USB SND device supports multiple audio interfaces, then it will >> contain several PCM streams, hence in those situations, it is expected >> that there will be multiple playback route kcontrols created. >> >> Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> >> --- >> sound/soc/qcom/qdsp6/q6usb.c | 104 +++++++++++++++++++++++++++++++++++ >> 1 file changed, 104 insertions(+) >> >> diff --git a/sound/soc/qcom/qdsp6/q6usb.c b/sound/soc/qcom/qdsp6/q6usb.c >> index 10337d70eb27..c2fc0dedf430 100644 >> --- a/sound/soc/qcom/qdsp6/q6usb.c >> +++ b/sound/soc/qcom/qdsp6/q6usb.c >> @@ -132,6 +132,109 @@ static int q6usb_audio_ports_of_xlate_dai_name(struct snd_soc_component *compone >> return ret; >> } >> >> +static int q6usb_get_pcm_id_from_widget(struct snd_soc_dapm_widget *w) >> +{ >> + struct snd_soc_pcm_runtime *rtd; >> + struct snd_soc_dai *dai; >> + >> + for_each_card_rtds(w->dapm->card, rtd) { >> + dai = snd_soc_rtd_to_cpu(rtd, 0); >> + /* >> + * Only look for playback widget. RTD number carries the assigned >> + * PCM index. >> + */ >> + if (dai->stream[0].widget == w) >> + return rtd->num; >> + } >> + >> + return -1; >> +} >> + >> +static int q6usb_usb_mixer_enabled(struct snd_soc_dapm_widget *w) >> +{ >> + struct snd_soc_dapm_path *p; >> + >> + /* Checks to ensure USB path is enabled/connected */ >> + snd_soc_dapm_widget_for_each_sink_path(w, p) >> + if (!strcmp(p->sink->name, "USB Mixer") && p->connect) >> + return 1; >> + >> + return 0; >> +} >> + >> +static int q6usb_get_pcm_id(struct snd_soc_component *component) >> +{ >> + struct snd_soc_dapm_widget *w; >> + struct snd_soc_dapm_path *p; >> + int pidx; >> + >> + /* >> + * Traverse widgets to find corresponding FE widget. The DAI links are >> + * built like the following: >> + * MultiMedia* <-> MM_DL* <-> USB Mixer* >> + */ >> + for_each_card_widgets(component->card, w) { >> + if (!strncmp(w->name, "MultiMedia", 10)) { >> + /* >> + * Look up all paths associated with the FE widget to see if >> + * the USB BE is enabled. The sink widget is responsible to >> + * link with the USB mixers. >> + */ >> + snd_soc_dapm_widget_for_each_sink_path(w, p) { >> + if (q6usb_usb_mixer_enabled(p->sink)) { >> + pidx = q6usb_get_pcm_id_from_widget(w); >> + return pidx; >> + } >> + } > Humm, there should be a note that the design assumes that the USB > offload path exposes a single PCM per endpoints - same as the > non-offloaded path. If the ASoC card has multiple PCMs for each > endpoint, possibly with different processing on each PCM, then the > mapping would fail. Sure I'll add a note within the comments on the above. > The other question is whether you need to walk in the DAPM graph, in > theory DPCM has helpers to find which FEs are connected to which BE. Hmm...Yes, I've tried to see if I could utilize some of the helpers that were present, but none of them was able to fetch the DAPM widget that was associated with the FE, hence why I had to implement the lookup that would work for our current design. Thanks Wesley Cheng
Hi Pierre, On 8/30/2024 3:05 AM, Pierre-Louis Bossart wrote: > > On 8/29/24 21:41, Wesley Cheng wrote: >> In order to allow userspace/applications know about USB offloading status, >> expose a sound kcontrol that fetches information about which sound card >> and PCM index the USB device is mapped to for supporting offloading. In >> the USB audio offloading framework, the ASoC BE DAI link is the entity >> responsible for registering to the SOC USB layer. >> >> It is expected for the USB SND offloading driver to add the kcontrol to the >> sound card associated with the USB audio device. An example output would >> look like: > this is very odd, the offloading driver adds a control to another card? > > That seems like a rather important layering violation. > > I thought it was done the other way, the USB audio card created a > control that would point to the other card/device. The USB SND offloading vendor driver (qc_audio_offload), which technically co-exists with USB SND core, is the entity that will add the offload kcontrol to the USB audio device's sound card. Initially, I had the kcontrol creation as part of the USB SND mixer, but I believe Takashi preferred if the vendor driver did it instead. > >> tinymix -D 1 get 'USB Offload Playback Route PCM#0' >> -1, -1 (range -1->255) >> >> This example signifies that there is no mapped ASoC path available for the >> USB SND device. > but that control would not even exist if the ASoC-based driver isn't probed. > > It's become really hard to follow, I've been on all this for 1.5hrs and > losing track of the design. Hence why it probably is a good idea to leave it within the USB offload vendor driver. There are checks to ensure that the ASoC based driver is probed/available before the kcontrols are created for a device. If there are devices that were identified before the ASoC components were probed, then the snd_usb_rediscover_devices() is triggered as part of soc-usb, and that would call the connect_cb() callback to the USB SND vendor offload driver to create the kcontrol. Thanks Wesley Cheng >> tinymix -D 1 get 'USB Offload Playback Route PCM#0' >> 0, 0 (range -1->255) >> >> This example signifies that the offload path is available over ASoC sound >> card index#0 and PCM device#0. >> >> Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> >> --- >> sound/usb/Kconfig | 10 +++ >> sound/usb/Makefile | 2 + >> sound/usb/mixer_usb_offload.c | 102 ++++++++++++++++++++++++++++++ >> sound/usb/mixer_usb_offload.h | 17 +++++ >> sound/usb/qcom/Makefile | 2 +- >> sound/usb/qcom/qc_audio_offload.c | 2 + >> 6 files changed, 134 insertions(+), 1 deletion(-) >> create mode 100644 sound/usb/mixer_usb_offload.c >> create mode 100644 sound/usb/mixer_usb_offload.h >> >> diff --git a/sound/usb/Kconfig b/sound/usb/Kconfig >> index 5cc3eaf53e6b..e3fbf9541d0b 100644 >> --- a/sound/usb/Kconfig >> +++ b/sound/usb/Kconfig >> @@ -176,10 +176,20 @@ config SND_BCD2000 >> To compile this driver as a module, choose M here: the module >> will be called snd-bcd2000. >> >> +config SND_USB_OFFLOAD_MIXER >> + tristate "USB Audio Offload mixer control" >> + help >> + Say Y to enable the USB audio offloading mixer controls. This >> + exposes an USB offload capable kcontrol to signal to applications >> + about which platform sound card can support USB audio offload. >> + The returning values specify the mapped ASoC card and PCM device >> + the USB audio device is associated to. >> + >> config SND_USB_AUDIO_QMI >> tristate "Qualcomm Audio Offload driver" >> depends on QCOM_QMI_HELPERS && SND_USB_AUDIO && USB_XHCI_SIDEBAND && SND_SOC_USB >> select SND_PCM >> + select SND_USB_OFFLOAD_MIXER >> help >> Say Y here to enable the Qualcomm USB audio offloading feature. >> >> diff --git a/sound/usb/Makefile b/sound/usb/Makefile >> index 54a06a2f73ca..2f19f854944c 100644 >> --- a/sound/usb/Makefile >> +++ b/sound/usb/Makefile >> @@ -36,3 +36,5 @@ obj-$(CONFIG_SND_USB_US122L) += snd-usbmidi-lib.o >> >> obj-$(CONFIG_SND) += misc/ usx2y/ caiaq/ 6fire/ hiface/ bcd2000/ qcom/ >> obj-$(CONFIG_SND_USB_LINE6) += line6/ >> + >> +obj-$(CONFIG_SND_USB_OFFLOAD_MIXER) += mixer_usb_offload.o >> diff --git a/sound/usb/mixer_usb_offload.c b/sound/usb/mixer_usb_offload.c >> new file mode 100644 >> index 000000000000..16e2fd634684 >> --- /dev/null >> +++ b/sound/usb/mixer_usb_offload.c >> @@ -0,0 +1,102 @@ >> +// SPDX-License-Identifier: GPL-2.0 >> +/* >> + * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved. >> + */ >> + >> +#include <linux/usb.h> >> + >> +#include <sound/core.h> >> +#include <sound/control.h> >> +#include <sound/soc-usb.h> >> + >> +#include "usbaudio.h" >> +#include "card.h" >> +#include "helper.h" >> +#include "mixer.h" >> + >> +#include "mixer_usb_offload.h" >> + >> +#define PCM_IDX(n) ((n) & 0xffff) >> +#define CARD_IDX(n) ((n) >> 16) >> + >> +static int >> +snd_usb_offload_route_get(struct snd_kcontrol *kcontrol, >> + struct snd_ctl_elem_value *ucontrol) >> +{ >> + struct device *sysdev = snd_kcontrol_chip(kcontrol); >> + int ret; >> + >> + ret = snd_soc_usb_update_offload_route(sysdev, >> + CARD_IDX(kcontrol->private_value), >> + PCM_IDX(kcontrol->private_value), >> + SNDRV_PCM_STREAM_PLAYBACK, >> + ucontrol->value.integer.value); >> + if (ret < 0) { >> + ucontrol->value.integer.value[0] = -1; >> + ucontrol->value.integer.value[1] = -1; >> + } >> + >> + return 0; >> +} >> + >> +static int snd_usb_offload_route_info(struct snd_kcontrol *kcontrol, >> + struct snd_ctl_elem_info *uinfo) >> +{ >> + uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER; >> + uinfo->count = 2; >> + uinfo->value.integer.min = -1; >> + /* Arbitrary max value, as there is no 'limit' on number of PCM devices */ >> + uinfo->value.integer.max = 0xff; >> + >> + return 0; >> +} >> + >> +static struct snd_kcontrol_new snd_usb_offload_mapped_ctl = { >> + .iface = SNDRV_CTL_ELEM_IFACE_CARD, >> + .access = SNDRV_CTL_ELEM_ACCESS_READ, >> + .info = snd_usb_offload_route_info, >> + .get = snd_usb_offload_route_get, >> +}; >> + >> +/** >> + * snd_usb_offload_create_ctl() - Add USB offload bounded mixer >> + * @chip - USB SND chip device >> + * >> + * Creates a sound control for a USB audio device, so that applications can >> + * query for if there is an available USB audio offload path, and which >> + * card is managing it. >> + */ >> +int snd_usb_offload_create_ctl(struct snd_usb_audio *chip) >> +{ >> + struct usb_device *udev = chip->dev; >> + struct snd_kcontrol_new *chip_kctl; >> + struct snd_usb_substream *subs; >> + struct snd_usb_stream *as; >> + char ctl_name[37]; >> + int ret; >> + >> + list_for_each_entry(as, &chip->pcm_list, list) { >> + subs = &as->substream[SNDRV_PCM_STREAM_PLAYBACK]; >> + if (!subs->ep_num) >> + continue; >> + >> + chip_kctl = &snd_usb_offload_mapped_ctl; >> + chip_kctl->count = 1; >> + /* >> + * Store the associated USB SND card number and PCM index for >> + * the kctl. >> + */ >> + chip_kctl->private_value = as->pcm_index | >> + chip->card->number << 16; >> + sprintf(ctl_name, "USB Offload Playback Route PCM#%d", >> + as->pcm_index); >> + chip_kctl->name = ctl_name; >> + ret = snd_ctl_add(chip->card, snd_ctl_new1(chip_kctl, >> + udev->bus->sysdev)); >> + if (ret < 0) >> + break; >> + } >> + >> + return ret; >> +} >> +EXPORT_SYMBOL_GPL(snd_usb_offload_create_ctl); >> diff --git a/sound/usb/mixer_usb_offload.h b/sound/usb/mixer_usb_offload.h >> new file mode 100644 >> index 000000000000..3f6e2a8b19c8 >> --- /dev/null >> +++ b/sound/usb/mixer_usb_offload.h >> @@ -0,0 +1,17 @@ >> +/* SPDX-License-Identifier: GPL-2.0 >> + * >> + * Copyright (c) 2022-2024 Qualcomm Innovation Center, Inc. All rights reserved. >> + */ >> + >> +#ifndef __USB_OFFLOAD_MIXER_H >> +#define __USB_OFFLOAD_MIXER_H >> + >> +#if IS_ENABLED(CONFIG_SND_USB_OFFLOAD_MIXER) >> +int snd_usb_offload_create_ctl(struct snd_usb_audio *chip); >> +#else >> +static inline int snd_usb_offload_create_ctl(struct snd_usb_audio *chip) >> +{ >> + return 0; >> +} >> +#endif >> +#endif /* __USB_OFFLOAD_MIXER_H */ >> diff --git a/sound/usb/qcom/Makefile b/sound/usb/qcom/Makefile >> index a81c9b28d484..4005e8391ab9 100644 >> --- a/sound/usb/qcom/Makefile >> +++ b/sound/usb/qcom/Makefile >> @@ -1,2 +1,2 @@ >> snd-usb-audio-qmi-objs := usb_audio_qmi_v01.o qc_audio_offload.o >> -obj-$(CONFIG_SND_USB_AUDIO_QMI) += snd-usb-audio-qmi.o >> \ No newline at end of file >> +obj-$(CONFIG_SND_USB_AUDIO_QMI) += snd-usb-audio-qmi.o >> diff --git a/sound/usb/qcom/qc_audio_offload.c b/sound/usb/qcom/qc_audio_offload.c >> index a7ad15404fd1..5b9262a116be 100644 >> --- a/sound/usb/qcom/qc_audio_offload.c >> +++ b/sound/usb/qcom/qc_audio_offload.c >> @@ -36,6 +36,7 @@ >> #include "../helper.h" >> #include "../pcm.h" >> #include "../power.h" >> +#include "../mixer_usb_offload.h" >> >> #include "usb_audio_qmi_v01.h" >> >> @@ -1703,6 +1704,7 @@ static void qc_usb_audio_offload_probe(struct snd_usb_audio *chip) >> sdev->card_idx = chip->card->number; >> sdev->chip_idx = chip->index; >> >> + snd_usb_offload_create_ctl(chip); >> snd_soc_usb_connect(usb_get_usb_backend(udev), sdev); >> } >>
Hi Pierre, On 8/30/2024 2:58 AM, Pierre-Louis Bossart wrote: > > On 8/29/24 21:41, Wesley Cheng wrote: >> Utilize the card and PCM index coming from the USB QMI stream request. >> This field follows what is set by the ASoC USB backend, and could >> potentially carry information about a specific device selected through the >> ASoC USB backend. The backend also has information about the last USB >> sound device plugged in, so it can choose to select the last device plugged >> in, accordingly. >> >> Signed-off-by: Wesley Cheng <quic_wcheng@quicinc.com> >> --- >> sound/usb/qcom/qc_audio_offload.c | 8 ++------ >> 1 file changed, 2 insertions(+), 6 deletions(-) >> >> diff --git a/sound/usb/qcom/qc_audio_offload.c b/sound/usb/qcom/qc_audio_offload.c >> index 0bd533f539e4..a7ad15404fd1 100644 >> --- a/sound/usb/qcom/qc_audio_offload.c >> +++ b/sound/usb/qcom/qc_audio_offload.c >> @@ -106,8 +106,6 @@ struct uaudio_qmi_dev { >> bool er_mapped; >> /* reference count to number of possible consumers */ >> atomic_t qdev_in_use; >> - /* idx to last udev card number plugged in */ >> - unsigned int last_card_num; >> }; >> >> struct uaudio_dev { >> @@ -1261,7 +1259,7 @@ static int prepare_qmi_response(struct snd_usb_substream *subs, >> >> pcm_dev_num = (req_msg->usb_token & QMI_STREAM_REQ_DEV_NUM_MASK) >> 8; >> xfer_buf_len = req_msg->xfer_buff_size; >> - card_num = uaudio_qdev->last_card_num; >> + card_num = (req_msg->usb_token & QMI_STREAM_REQ_CARD_NUM_MASK) >> 16; >> >> if (!uadev[card_num].ctrl_intf) { >> dev_err(&subs->dev->dev, "audio ctrl intf info not cached\n"); >> @@ -1455,8 +1453,7 @@ static void handle_uaudio_stream_req(struct qmi_handle *handle, >> >> direction = (req_msg->usb_token & QMI_STREAM_REQ_DIRECTION); >> pcm_dev_num = (req_msg->usb_token & QMI_STREAM_REQ_DEV_NUM_MASK) >> 8; >> - pcm_card_num = req_msg->enable ? uaudio_qdev->last_card_num : >> - ffs(uaudio_qdev->card_slot) - 1; >> + pcm_card_num = (req_msg->usb_token & QMI_STREAM_REQ_CARD_NUM_MASK) >> 16; >> if (pcm_card_num >= SNDRV_CARDS) { >> ret = -EINVAL; >> goto response; >> @@ -1706,7 +1703,6 @@ static void qc_usb_audio_offload_probe(struct snd_usb_audio *chip) >> sdev->card_idx = chip->card->number; >> sdev->chip_idx = chip->index; >> >> - uaudio_qdev->last_card_num = chip->card->number; >> snd_soc_usb_connect(usb_get_usb_backend(udev), sdev); >> } > This entire path seems like a bad split/merge, it removes stuff that was > done earlier. Also it's not clear what this has to do with 'QMI', card > and PCM device management is usually done at a higher level. > > not following, please be mindful of reviewer fatigue when adding such > changes in patch 30/33.... I'll just add this as part of patch#28. I think before I did the reordering of the series, this made a bit more sense to have as a patch on its own. Now that the entire framework for the audio dsp to know about the card and pcm index is already done in previous patches, the plumbing is done for the qc_audio_offload to utilize the fields coming from the audio DSP, as they will carry valid values. Thanks Wesley Cheng
Requesting to see if we can get some Acked-By tags, and merge on usb-next. Several Qualcomm based chipsets can support USB audio offloading to a dedicated audio DSP, which can take over issuing transfers to the USB host controller. The intention is to reduce the load on the main processors in the SoC, and allow them to be placed into lower power modes. There are several parts to this design: 1. Adding ASoC binding layer 2. Create a USB backend for Q6DSP 3. Introduce XHCI interrupter support 4. Create vendor ops for the USB SND driver USB | ASoC -------------------------------------------------------------------- | _________________________ | |sm8250 platform card | | |_________________________| | | | | ___V____ ____V____ | |Q6USB | |Q6AFE | | |"codec" | |"cpu" | | |________| |_________| | ^ ^ ^ | | |________| | ___V____ | | |SOC-USB | | ________ ________ | | | |USB SND |<--->|QC offld|<------------>|________| | |(card.c)| | |<---------- | |________| |________|___ | | | ^ ^ | | | ____________V_________ | | | | | |APR/GLINK | __ V_______________V_____ | | | |______________________| |USB SND (endpoint.c) | | | | ^ |_________________________| | | | | ^ | | | ___________V___________ | | | |->|audio DSP | ___________V_____________ | | |_______________________| |XHCI HCD |<- | |_________________________| | Adding ASoC binding layer ========================= soc-usb: Intention is to treat a USB port similar to a headphone jack. The port is always present on the device, but cable/pin status can be enabled/disabled. Expose mechanisms for USB backend ASoC drivers to communicate with USB SND. Create a USB backend for Q6DSP ============================== q6usb: Basic backend driver that will be responsible for maintaining the resources needed to initiate a playback stream using the Q6DSP. Will be the entity that checks to make sure the connected USB audio device supports the requested PCM format. If it does not, the PCM open call will fail, and userspace ALSA can take action accordingly. Introduce XHCI interrupter support ================================== XHCI HCD supports multiple interrupters, which allows for events to be routed to different event rings. This is determined by "Interrupter Target" field specified in Section "6.4.1.1 Normal TRB" of the XHCI specification. Events in the offloading case will be routed to an event ring that is assigned to the audio DSP. Create vendor ops for the USB SND driver ======================================== qc_audio_offload: This particular driver has several components associated with it: - QMI stream request handler - XHCI interrupter and resource management - audio DSP memory management When the audio DSP wants to enable a playback stream, the request is first received by the ASoC platform sound card. Depending on the selected route, ASoC will bring up the individual DAIs in the path. The Q6USB backend DAI will send an AFE port start command (with enabling the USB playback path), and the audio DSP will handle the request accordingly. Part of the AFE USB port start handling will have an exchange of control messages using the QMI protocol. The qc_audio_offload driver will populate the buffer information: - Event ring base address - EP transfer ring base address and pass it along to the audio DSP. All endpoint management will now be handed over to the DSP, and the main processor is not involved in transfers. Overall, implementing this feature will still expose separate sound card and PCM devices for both the platform card and USB audio device: 0 [SM8250MTPWCD938]: sm8250 - SM8250-MTP-WCD9380-WSA8810-VA-D SM8250-MTP-WCD9380-WSA8810-VA-DMIC 1 [Audio ]: USB-Audio - USB Audio Generic USB Audio at usb-xhci-hcd.1.auto-1.4, high speed This is to ensure that userspace ALSA entities can decide which route to take when executing the audio playback. In the above, if card#1 is selected, then USB audio data will take the legacy path over the USB PCM drivers, etc... The current limitation is that the latest USB audio device that is identified will be automatically selected by the Q6USB BE DAI for offloading. Future patches can be added to possibly add for more flexibility, but until the userpace applications can be better defined, having these mechanisms will complicate the overall implementation. USB offload Kcontrols ===================== Part of the vendor offload package will have a mixer driver associated with it (mixer_usb_offload.c). This entity will be responsible for coordinating with SOC USB and the Q6USB backend DAI to fetch information about the sound card and PCM device indices associated with the offload path. The logic is done based on the current implementation of how paths are controlled within the QC ASoC implementation. QC ASoC Q6Routing ----------------- Within the Q6 ASOC design, the registered ASoC platform card will expose a set of kcontrols for enabling the BE DAI links to the FE DAI link. For example: tinymix -D 0 contents Number of controls: 1033 ctl type num name value ... 1025 BOOL 1 USB Mixer MultiMedia1 Off 1026 BOOL 1 USB Mixer MultiMedia2 Off 1027 BOOL 1 USB Mixer MultiMedia3 Off 1028 BOOL 1 USB Mixer MultiMedia4 Off 1029 BOOL 1 USB Mixer MultiMedia5 Off 1030 BOOL 1 USB Mixer MultiMedia6 Off 1031 BOOL 1 USB Mixer MultiMedia7 Off 1032 BOOL 1 USB Mixer MultiMedia8 Off Each of these kcontrols will enable the USB BE DAI link (q6usb) to be connected to a FE DAI link (q6asm). Since each of these controls are DAPM widgets, when it is enabled, the DAPM widget's "connect" flag is updated accordingly. USB Offload Mapping ------------------- Based on the Q6routing, the USB BE DAI link can determine which sound card and PCM device is enabled for offloading. Fetching the ASoC platform sound card's information is fairly straightforward, and the bulk of the work goes to finding the corresponding PCM device index. As mentioned above, the USB BE DAI can traverse the DAPM widgets to find the DAPM path that is related to the control for the "USB Mixer." Based on which "USB Mixer" is enabled, it can find the corresponding DAPM widget associated w/ the FE DAI link (Multimedia*). From there it can find the PCM device created for the Multimedia* stream. Only one BE DAI link can be enabled per FE DAI. For example, if the HDMI path is enabled for Multimedia1, the USB Mixer will be disabled and switched over. Examples of kcontrol -------------------- tinymix -D 0 contents Number of controls: 1033 ctl type num name ... 1025 BOOL 1 USB Mixer MultiMedia1 Off 1026 BOOL 1 USB Mixer MultiMedia2 On 1027 BOOL 1 USB Mixer MultiMedia3 Off 1028 BOOL 1 USB Mixer MultiMedia4 Off 1029 BOOL 1 USB Mixer MultiMedia5 Off 1030 BOOL 1 USB Mixer MultiMedia6 Off 1031 BOOL 1 USB Mixer MultiMedia7 Off 1032 BOOL 1 USB Mixer MultiMedia8 Off tinymix -D 2 contents Number of controls: 7 ctl type num name value 0 INT 2 Playback Channel Map 0, 0 (range 0->36) 1 BOOL 2 MDR-1ADAC Playback Switch On, On 2 BOOL 1 MDR-1ADAC Playback Switch On 3 INT 2 MDR-1ADAC Playback Volume 127, 127 (range 0->127) 4 INT 1 MDR-1ADAC Playback Volume 127 (range 0->127) 5 BOOL 1 Sony Internal Clock Validity On 6 INT 2 USB Offload Playback Route PCM#0 0, 1 (range -1->255) The example highlights that the userspace/application can utilize the offload path for the USB device on card#0 PCM device#1. When dealing with multiple USB audio devices, only the latest USB device identified is going to be selected for offload capable. tinymix -D 1 contents Number of controls: 9 ctl type num name value 0 INT 2 Capture Channel Map 0, 0 (range 0->36) 1 INT 2 Playback Channel Map 0, 0 (range 0->36) 2 BOOL 1 Headset Capture Switch On 3 INT 1 Headset Capture Volume 1 (range 0->4) 4 BOOL 1 Sidetone Playback Switch On 5 INT 1 Sidetone Playback Volume 4096 (range 0->8192) 6 BOOL 1 Headset Playback Switch On 7 INT 2 Headset Playback Volume 20, 20 (range 0->24) 8 INT 2 USB Offload Playback Route PCM#0 -1, -1 (range -1->255) "-1, -1" shows that this device has no route to the offload path. This feature was validated using: - tinymix: set/enable the multimedia path to route to USB backend - tinyplay: issue playback on platform card Changelog -------------------------------------------- Changes in v26: - Cleaned up drivers based on errors from checkpatch - Fixed several typos using codespell - Removed any vendor specific notation from USB SND offload mixer patch Changes in v25: - Cleanups on typos mentioned within the xHCI layers - Modified the xHCI interrupter search if clients specify interrupter index - Moved mixer_usb_offload into its own module, so that other vendor offload USB modules can utilize it also. - Added support for USB audio devices that may have multiple PCM streams, as previous implementation only assumed a single PCM device. SOC USB will be able to handle an array of PCM indexes supported by the USB audio device. - Added some additional checks in the QC USB offload driver to check that device has at least one playback stream before allowing to bind - Reordered DT bindings to fix the error found by Rob's bot. The patch that added USB_RX was after the example was updated. - Updated comments within SOC USB to clarify terminology and to keep it consistent - Added SND_USB_JACK type for notifying of USB device audio connections Changes in v24: - Simplified the kcontrols involved in determining how to utilize the offload path. - There is one kcontrol registered to each USB audio device that will output which card/pcm device it is mapped to for the offload route. - Removed kcontrols to track offload status and device selection. - Default to last USB audio device plugged in as offload capable. - kcontrol will reside on USB SND device. - Reworked the tracking of connected USB devices from the Q6USB BE DAI link. Previously, it was convoluted by doing it over an array, but moved to using a list made it much simpler. Logic is still unchanged in that the last USB headset plugged in will be selected for offloading. - Updated the USB SOC RST documentation accordingly with new kcontrol updates. - Added logic to fetch mapped ASoC card and pcm device index that the offload path is mapped to for the USB SND kcontrol (for offload route). - Re-ordered series to hopefully make reviews more readable by combining patches based on the layer modified (ie QC ASoC, ASoC, USB sound, and USB XHCI). Changes in v23: - Added MODULE_DESCRIPTION() fields to drivers that needed it. Changes in v22: - Removed components tag for the ASoC platform card, as the USB SND kcontrol for notifying userspace of offload capable card achieves similar results. - Due to the above, had to remove the review-by tag for the RST documentation, as changes were made to remove the components tag section. - Took in feedback to make the SOC USB add/remove ports void. - Fixed an issue w/ the USB SND kcontrol management for devices that have multi UAC interfaces. (would attempt to create the kcontrol more than once) - Modified SOC USB card and PCM index select to be based off the num_supported streams that is specified by the USB BE DAI. - Modified comments on selecting the latest USB headset for offloading. Changes in v21: - Added an offload jack disable path from the ASoC platform driver and SOC USB. - Refactored some of the existing SOC USB context look up APIs and created some new helpers to search for the USB context. - Renamed snd_soc_usb_find_format to snd_soc_usb_find_supported_format - Removed some XHCI sideband calls that would allow clients to actually enable the IRQ line associated w/ the secondary interrupter. This is removed because there are other dependencies that are required for that to happen, which are not covered as part of this series, and to avoid confusion. - Due to the above, removed the need to export IMOD setting, and enable/disable interrupter APIs. Changes in v20: - Fixed up some formatting changes pointed out in the usb.rst - Added SB null check during XHCI sideband unregister in case caller passes improper argument (xhci_sideband_unregister()) Changes in v19: - Rebased to usb-next to account for some new changes in dependent drivers. Changes in v18: - Rebased to usb-next, which merged in part of the series. Removed these patches. - Reworked Kconfigs for the ASoC USB related components from QCOM Q6DSP drivers to keep dependencies in place for SoC USB and USB SND. - Removed the repurposing of the stop ep sync API into existing XHCI operations. This will be solely used by the XHCI sideband for now. Changes in v17: - Fixed an issue where one patch was squashed into another. - Re-added some kconfig checks for helpers exposed in USB SND for the soc usb driver, after running different kconfigs. Changes in v16: - Modified some code layer dependencies so that soc usb can be split as a separate module. - Split the kcontrols from ASoC QCOM common layer into a separate driver - Reworked SOC USB kcontrols for controlling card + pcm offload routing and status so that there are individual controls for card and pcm devices. - Added a kcontrol remove API in SOC USB to remove the controls on the fly. This required to add some kcontrol management to SOC USB. - Removed the disconnect work and workqueue for the QC USB offload as it is not required, since QMI interface driver ensures events are handled in its own WQ. Changes in v15: - Removed some already merged XHCI changes - Separated SOC USB driver from being always compiled into SOC core. Now configurable from kconfig. - Fixed up ASoC kcontrol naming to fit guidelines. - Removed some unnecessary dummy ifdefs. - Moved usb snd offload capable kcontrol to be initialized by the platform offloading driver. Changes in v14: - Cleaned up some USB SND related feedback: - Renamed SNDUSB OFFLD playback available --> USB offload capable card - Fixed locking while checking if stream is in use - Replaced some mutex pairs with guard(mutex) Changes in v13: - Pulled in secondary/primary interrupter rework from Mathias from: https://git.kernel.org/pub/scm/linux/kernel/git/mnyman/xhci.git/log/drivers/usb/host?h=fix_eventhandling - Did some cleanup and commit message updates, and tested on current code base. - Added mutex locking to xhci sideband to help prevent any race conditions, esp. for when accessing shared references. - Addressed concerns from Hillf about gfp_flags and locking used in qc_usb_audio_offload. - Rebased onto usb-next Changes in v12: - Updated copyright year to 2024. Happy new years! - Fixed newline format on mixer offload driver. Changes in v11: - Modified QMI format structures to be const Changes in v10: - Added new mixer for exposing kcontrol for sound card created by USB SND. This allows for applications to know which platform sound card has offload support. Will return the card number. - Broke down and cleaned up some functions/APIs within qc_audio_offload driver. - Exported xhci_initialize_ring_info(), and modified XHCI makefile to allow for the XHCI sideband to exist as a module. - Reworked the jack registration and moved it to the QCOM platform card driver, ie sm8250. - Added an SOC USB API to fetch a standard component tag that can be appended to the platform sound card. Added this tag to sm8250 if any USB path exists within the DT node. - Moved kcontrols that existed in the Q6USB driver, and made it a bit more generic, so that naming can be standardized across solutions. SOC USB is now responsible for creation of these kcontrols. - Added a SOC USB RST document explaining some code flows and implementation details so that other vendors can utilize the framework. - Addressed a case where USB device connection events are lost if usb offload driver (qc_audio_offload) is not probed when everything else has been initialized, ie USB SND, SOC USB and ASoC sound card. Add a rediscover device call during module init, to ensure that connection events will be propagated. - Rebased to usb-next. Changes in v9: - Fixed the dt binding check issue with regards to num-hc-interrupters. Changes in v8: - Cleaned up snd_soc_usb_find_priv_data() based on Mark's feedback. Removed some of the duplicate looping code that was present on previous patches. Also renamed the API. - Integrated Mathias' suggestions on his new sideband changes: https://git.kernel.org/pub/scm/linux/kernel/git/mnyman/xhci.git/log/?h=feature_interrupters - Addressed some of Mathias' fixme tags, such as: - Resetting transfer ring dequeue/enqueue pointers - Issuing stop endpoint command during ep removal - Reset ERDP properly to first segment ring during interrupter removal. (this is currently just being cleared to 0, but should be pointing to a valid segment if controller is still running. Changes in v7: - Fixed dt check error for q6usb bindings - Updated q6usb property from qcom,usb-audio-intr-num --> qcom,usb-audio-intr-idx - Removed separate DWC3 HC interrupters num property, and place limits to XHCI one. - Modified xhci_ring_to_sgtable() to use assigned IOVA/DMA address to fetch pages, as it is not ensured event ring allocated is always done in the vmalloc range. Changes in v6: - Fixed limits and description on several DT bindings (XHCI and Q6USB) - Fixed patch subjects to follow other ALSA/ASoC notations. USB SND - Addressed devices which expose multiple audio (UAC) interfaces. These devices will create a single USB sound card with multiple audio streams, and receive multiple interface probe routines. QC offload was not properly considering cases with multiple probe calls. - Renamed offload module name and kconfig to fit within the SND domain. - Renamed attach/detach endpoint API to keep the hw_params notation. Changes in v5: - Removed some unnecessary files that were included - Fixed some typos mentioned - Addressed dt-binding issues and added hc-interrupters definition to usb-xhci.yaml XHCI: - Moved secondary skip events API to xhci-ring and updated implementation - Utilized existing XHCI APIs, such as inc_deq and xhci_update_erst_dequeue() USB SND - Renamed and reworked the APIs in "sound: usb: Export USB SND APIs for modules" patch to include suggestions to utilize snd_usb_hw_params/free and to avoid generic naming. - Added a resume_cb() op for completion sake. - Addressed some locking concerns with regards to when registering for platform hooks. - Added routine to disconnect all offloaded devices during module unbind. ASoC - Replaced individual PCM parameter arguments in snd_soc_usb_connect() with new snd_soc_usb_device structure to pass along PCM info. - Modified snd_jack set report to notify HEADPHONE event, as we do not support record path. Changes in v4: - Rebased to xhci/for-usb-next - Addressed some dt-bindings comments XHCI: - Pulled in latest changes from Mathias' feature_interrupters branch: https://git.kernel.org/pub/scm/linux/kernel/git/mnyman/xhci.git/log/?h=feature_interrupters - Fixed commit text and signage for the XHCI sideband/interrupter related changes - Added some logic to address the FIXME tags mentioned throughout the commits, such as handling multi segment rings and building the SGT, locking concerns, and ep cleanup operations. - Removed some fixme tags for conditions that may not be needed/addressed. - Repurposed the new endpoint stop sync API to be utilized in other places. - Fixed potential compile issue if XHCI sideband config is not defined. ASoC: - Added sound jack control into the Q6USB driver. Allows for userspsace to know when an offload capable device is connected. USB SND: - Avoided exporting _snd_pcm_hw_param_set based on Takashi's recommendation. - Split USB QMI packet header definitions into a separate commit. This is used to properly allow the QMI interface driver to parse and route QMI packets accordingly - Added a "depends on" entry when enabling QC audio offload to avoid compile time issues. Changes in v3: - Changed prefix from RFC to PATCH - Rebased entire series to usb-next - Updated copyright years XHCI: - Rebased changes on top of XHCI changes merged into usb-next, and only added changes that were still under discussion. - Added change to read in the "num-hc-interrupters" device property. ASoC: - qusb6 USB backend - Incorporated suggestions to fetch iommu information with existing APIs - Added two new sound kcontrols to fetch offload status and offload device selection. - offload status - will return the card and pcm device in use tinymix -D 0 get 1 --> 1, 0 (offload in progress on card#1 pcm#0) - device selection - set the card and pcm device to enable offload on. Ex.: tinymix -D 0 set 1 2 0 --> sets offload on card#2 pcm#0 (this should be the USB card) USB SND: - Fixed up some locking related concerns for registering platform ops. - Moved callbacks under the register_mutex, so that - Modified APIs to properly pass more information about the USB SND device, so that the Q6USB backend can build a device list/map, in order to monitor offload status and device selection. Changes in v2: XHCI: - Replaced XHCI and HCD changes with Mathias' XHCI interrupter changes in his tree: https://git.kernel.org/pub/scm/linux/kernel/git/mnyman/xhci.git/log/?h=feature_interrupters Adjustments made to Mathias' changes: - Created xhci-intr.h to export/expose interrupter APIs versus exposing xhci.h. Moved dependent structures to this file as well. (so clients can parse out information from "struct xhci_interrupter") - Added some basic locking when requesting interrupters. - Fixed up some sanity checks. - Removed clearing of the ERSTBA during freeing of the interrupter. (pending issue where SMMU fault occurs if DMA addr returned is 64b - TODO) - Clean up pending events in the XHCI secondary interrupter. While testing USB bus suspend, it was seen that on bus resume, the xHCI HC would run into a command timeout. - Added offloading APIs to xHCI to fetch transfer and event ring information. ASoC: - Modified soc-usb to allow for multiple USB port additions. For this to work, the USB offload driver has to have a reference to the USB backend by adding a "usb-soc-be" DT entry to the device saved into XHCI sysdev. - Created separate dt-bindings for defining USB_RX port. - Increased APR timeout to accommodate the situation where the AFE port start command could be delayed due to having to issue a USB bus resume while handling the QMI stream start command. Mathias Nyman (2): xhci: add helper to stop endpoint and wait for completion xhci: sideband: add initial api to register a sideband entity Wesley Cheng (31): usb: host: xhci: Repurpose event handler for skipping interrupter events usb: xhci: Allow for secondary interrupter to set IMOD usb: host: xhci-mem: Cleanup pending secondary event ring events usb: host: xhci-mem: Allow for interrupter clients to choose specific index usb: host: xhci-plat: Set XHCI max interrupters if property is present usb: dwc3: Specify maximum number of XHCI interrupters ALSA: Add USB audio device jack type ALSA: usb-audio: Export USB SND APIs for modules ALSA: usb-audio: Check for support for requested audio format ASoC: Add SOC USB APIs for adding an USB backend ASoC: usb: Add PCM format check API for USB backend ASoC: usb: Create SOC USB SND jack kcontrol ASoC: usb: Fetch ASoC card and pcm device information ASoC: doc: Add documentation for SOC USB ASoC: dt-bindings: qcom,q6dsp-lpass-ports: Add USB_RX port ASoC: dt-bindings: Update example for enabling USB offload on SM8250 ASoC: qcom: qdsp6: Introduce USB AFE port to q6dsp ASoC: qcom: qdsp6: q6afe: Increase APR timeout ASoC: qcom: qdsp6: Add USB backend ASoC driver for Q6 ASoC: qcom: qdsp6: Add headphone jack for offload connection status ASoC: qcom: qdsp6: Fetch USB offload mapped card and PCM device ALSA: usb-audio: Introduce USB SND platform op callbacks ALSA: usb-audio: Save UAC sample size information ALSA: usb-audio: Prevent starting of audio stream if in use ALSA: usb-audio: qcom: Add USB QMI definitions ALSA: usb-audio: qcom: Introduce QC USB SND offloading support ALSA: usb-audio: qcom: Don't allow USB offload path if PCM device is in use ALSA: usb-audio: qcom: Use card and PCM index from QMI request ALSA: usb-audio: Add USB offload route kcontrol ALSA: usb-audio: Allow for rediscovery of connected USB SND devices ASoC: usb: Rediscover USB SND devices on USB port add .../bindings/sound/qcom,sm8250.yaml | 15 + Documentation/sound/soc/index.rst | 1 + Documentation/sound/soc/usb.rst | 429 ++++ drivers/usb/dwc3/core.c | 12 + drivers/usb/dwc3/core.h | 2 + drivers/usb/dwc3/host.c | 3 + drivers/usb/host/Kconfig | 9 + drivers/usb/host/Makefile | 2 + drivers/usb/host/xhci-mem.c | 34 +- drivers/usb/host/xhci-plat.c | 2 + drivers/usb/host/xhci-ring.c | 54 +- drivers/usb/host/xhci-sideband.c | 425 ++++ drivers/usb/host/xhci.c | 45 +- drivers/usb/host/xhci.h | 19 +- .../sound/qcom,q6dsp-lpass-ports.h | 1 + include/linux/mod_devicetable.h | 2 +- include/linux/usb/xhci-sideband.h | 71 + include/sound/jack.h | 4 +- include/sound/q6usboffload.h | 20 + include/sound/soc-usb.h | 135 ++ include/uapi/linux/input-event-codes.h | 3 +- sound/core/jack.c | 6 +- sound/soc/Kconfig | 10 + sound/soc/Makefile | 2 + sound/soc/qcom/Kconfig | 15 + sound/soc/qcom/Makefile | 2 + sound/soc/qcom/qdsp6/Makefile | 1 + sound/soc/qcom/qdsp6/q6afe-dai.c | 60 + sound/soc/qcom/qdsp6/q6afe.c | 194 +- sound/soc/qcom/qdsp6/q6afe.h | 36 +- sound/soc/qcom/qdsp6/q6dsp-lpass-ports.c | 23 + sound/soc/qcom/qdsp6/q6dsp-lpass-ports.h | 1 + sound/soc/qcom/qdsp6/q6routing.c | 9 + sound/soc/qcom/qdsp6/q6usb.c | 391 ++++ sound/soc/qcom/sm8250.c | 24 +- sound/soc/qcom/usb_offload_utils.c | 56 + sound/soc/qcom/usb_offload_utils.h | 30 + sound/soc/soc-usb.c | 338 +++ sound/usb/Kconfig | 25 + sound/usb/Makefile | 4 +- sound/usb/card.c | 110 + sound/usb/card.h | 17 + sound/usb/endpoint.c | 1 + sound/usb/format.c | 1 + sound/usb/helper.c | 1 + sound/usb/mixer_usb_offload.c | 102 + sound/usb/mixer_usb_offload.h | 17 + sound/usb/pcm.c | 104 +- sound/usb/pcm.h | 11 + sound/usb/qcom/Makefile | 2 + sound/usb/qcom/qc_audio_offload.c | 1968 +++++++++++++++++ sound/usb/qcom/usb_audio_qmi_v01.c | 863 ++++++++ sound/usb/qcom/usb_audio_qmi_v01.h | 164 ++ 53 files changed, 5820 insertions(+), 56 deletions(-) create mode 100644 Documentation/sound/soc/usb.rst create mode 100644 drivers/usb/host/xhci-sideband.c create mode 100644 include/linux/usb/xhci-sideband.h create mode 100644 include/sound/q6usboffload.h create mode 100644 include/sound/soc-usb.h create mode 100644 sound/soc/qcom/qdsp6/q6usb.c create mode 100644 sound/soc/qcom/usb_offload_utils.c create mode 100644 sound/soc/qcom/usb_offload_utils.h create mode 100644 sound/soc/soc-usb.c create mode 100644 sound/usb/mixer_usb_offload.c create mode 100644 sound/usb/mixer_usb_offload.h create mode 100644 sound/usb/qcom/Makefile create mode 100644 sound/usb/qcom/qc_audio_offload.c create mode 100644 sound/usb/qcom/usb_audio_qmi_v01.c create mode 100644 sound/usb/qcom/usb_audio_qmi_v01.h