Linux Sound subsystem development
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Wesley Cheng <quic_wcheng@quicinc.com>,
	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
Subject: Re: [PATCH v19 41/41] ASoC: doc: Add documentation for SOC USB
Date: Tue, 23 Apr 2024 08:43:23 +0700	[thread overview]
Message-ID: <ZicSOzE8KyaYGi0v@archie.me> (raw)
In-Reply-To: <20240422224906.15868-42-quic_wcheng@quicinc.com>

On Mon, Apr 22, 2024 at 03:49:06PM -0700, Wesley Cheng wrote:
> +.. code-block:: rst
> +
> +int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component,
> +					struct snd_soc_jack *jack)
> +..

You forget to indent snd_soc_usb_setup_offload_jack() prototype:

---- >8 ----
diff --git a/Documentation/sound/soc/usb.rst b/Documentation/sound/soc/usb.rst
index 3f7c3ef6a0c03c..0b6da0be9f317f 100644
--- a/Documentation/sound/soc/usb.rst
+++ b/Documentation/sound/soc/usb.rst
@@ -218,8 +218,8 @@ state.
 
 .. code-block:: rst
 
-int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component,
-					struct snd_soc_jack *jack)
+        int snd_soc_usb_setup_offload_jack(struct snd_soc_component *component,
+        					struct snd_soc_jack *jack)
 ..
 
   - ``component``: ASoC component to add the jack

> +USB Offload Playback Route Select Kcontrol
> +-----------------------------------

USB offload playback heading underlines are not long enough to cover heading
titles, so I have to extend them:

---- >8 ----
diff --git a/Documentation/sound/soc/usb.rst b/Documentation/sound/soc/usb.rst
index 0b6da0be9f317f..5e0e9fad131b24 100644
--- a/Documentation/sound/soc/usb.rst
+++ b/Documentation/sound/soc/usb.rst
@@ -482,7 +482,7 @@ into the physical USB port and enumerated.  The kcontrols are defined as:
     kcontrol exposed by the platform card.
 
 USB Offload Playback Route Select Kcontrol
------------------------------------
+------------------------------------------
 In order to allow for vendor specific implementations on audio offloading device
 selection, the SOC USB layer exposes the following:
 
@@ -545,7 +545,7 @@ along to the external DSP.
 
 
 USB Offload Playback Route Status
--------------------
+---------------------------------
 SOC USB exposes APIs for keeping track of the offloading state, and expects this
 to be maintained by the BE DAI link that created/added the SOC USB device.
 
@@ -573,7 +573,7 @@ When executing the kcontrol get callback, it will loop across the active_list ar
 and report to the application for active USB sound card and USB PCM device indexes.
 
 USB Offload Playback Capable Card
--------------------------------
+---------------------------------
 USB sound also creates a kcontrol for applications to help determine which platform
 sound card USB offloading is linked to.  This will allow applications to further
 query the platform sound card for specific information about the current USB offload

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

  reply	other threads:[~2024-04-23  1:43 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-04-22 22:48 [PATCH v19 00/41] Introduce QC USB SND audio offloading support Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 01/41] xhci: add helper to stop endpoint and wait for completion Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 02/41] usb: host: xhci: Export enable and disable interrupter APIs Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 03/41] usb: host: xhci: Repurpose event handler for skipping interrupter events Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 04/41] xhci: export XHCI IMOD setting helper for interrupters Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 05/41] xhci: sideband: add initial api to register a sideband entity Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 06/41] usb: host: xhci-sideband: Expose a sideband interrupter enable API Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 07/41] usb: host: xhci-mem: Cleanup pending secondary event ring events Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 08/41] usb: host: xhci-mem: Allow for interrupter clients to choose specific index Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 09/41] ASoC: Add SOC USB APIs for adding an USB backend Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 10/41] ASoC: dt-bindings: qcom,q6dsp-lpass-ports: Add USB_RX port Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 11/41] ASoC: qcom: qdsp6: Introduce USB AFE port to q6dsp Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 12/41] ASoC: qdsp6: q6afe: Increase APR timeout Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 13/41] ASoC: qcom: qdsp6: Add USB backend ASoC driver for Q6 Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 14/41] ALSA: usb-audio: Introduce USB SND platform op callbacks Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 15/41] ALSA: usb-audio: Export USB SND APIs for modules Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 16/41] ALSA: usb-audio: Save UAC sample size information Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 17/41] usb: dwc3: Specify maximum number of XHCI interrupters Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 18/41] usb: host: xhci-plat: Set XHCI max interrupters if property is present Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 19/41] ALSA: usb-audio: qcom: Add USB QMI definitions Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 20/41] ALSA: usb-audio: qcom: Introduce QC USB SND offloading support Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 21/41] ALSA: usb-audio: Check for support for requested audio format Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 22/41] ASoC: usb: Add PCM format check API for USB backend Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 23/41] ASoC: qcom: qdsp6: Ensure PCM format is supported by USB audio device Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 24/41] ALSA: usb-audio: Prevent starting of audio stream if in use Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 25/41] ALSA: usb-audio: Do not allow USB offload path if PCM device is " Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 26/41] ASoC: dt-bindings: Update example for enabling USB offload on SM8250 Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 27/41] ALSA: usb-audio: qcom: Populate PCM and USB chip information Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 28/41] ASoC: qcom: qdsp6: Add support to track available USB PCM devices Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 29/41] ASoC: Introduce SND kcontrols to select sound card and PCM device Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 30/41] ASoC: qcom: qdsp6: Add SOC USB offload select get/put callbacks Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 31/41] ASoC: Introduce SND kcontrols to track USB offloading state Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 32/41] ASoC: qcom: qdsp6: Add PCM ops to track current state Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 33/41] ASoC: usb: Create SOC USB SND jack kcontrol Wesley Cheng
2024-04-22 22:48 ` [PATCH v19 34/41] ASoC: qcom: qdsp6: Add headphone jack for offload connection status Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 35/41] ASoC: usb: Fetch ASoC sound card information Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 36/41] ALSA: usb-audio: Add USB offloading capable kcontrol Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 37/41] ALSA: usb-audio: Allow for rediscovery of connected USB SND devices Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 38/41] ALSA: usb-audio: qcom: Use card and PCM index from QMI request Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 39/41] ASoC: usb: Rediscover USB SND devices on USB port add Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 40/41] ASoC: qcom: Populate SoC components string Wesley Cheng
2024-04-22 22:49 ` [PATCH v19 41/41] ASoC: doc: Add documentation for SOC USB Wesley Cheng
2024-04-23  1:43   ` Bagas Sanjaya [this message]
2024-04-23 22:48     ` Wesley Cheng

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=ZicSOzE8KyaYGi0v@archie.me \
    --to=bagasdotme@gmail.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=quic_wcheng@quicinc.com \
    --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