From: Joonho Lee <joon@deeply.co.kr>
To: linux-sound@vger.kernel.org
Cc: tiwai@suse.com, perex@perex.cz, anton.yakovlev@opensynergy.com,
mst@redhat.com, virtualization@lists.linux.dev,
linux-kernel@vger.kernel.org, corbet@lwn.net,
skhan@linuxfoundation.org, rdunlap@infradead.org,
linux-doc@vger.kernel.org, mynameisjune111@gmail.com
Subject: [PATCH v28 14/17] docs: describe virtio-sound capture options
Date: Thu, 12 Nov 2026 05:18:44 -0000 [thread overview]
Message-ID: <20261112043516.37010-15-mynameisjune111@gmail.com> (raw)
In-Reply-To: <20261112043516.37010-1-mynameisjune111@gmail.com>
From: Joonho Lee <mynameisjune111@gmail.com>
Document request-owned capture in the ALSA configuration guide. Describe
`capture_packed_status` as default-off, reading a packed trailer after
returned data while the fixed status scatterlist remains the default.
Describe default-off `capture_pause_restart`: pause uses STOP and
RELEASE, then resume uses PREPARE and START; disabled mode uses STOP and
START while retaining the prepared stream.
Note that on MMU systems request buffers are vmalloc-backed and
page-rounded individually. They remain allocated from hw_params through
hw_free, and capture data is copied into the ALSA ring.
Assisted-by: LLM
Signed-off-by: Joonho Lee <mynameisjune111@gmail.com>
---
Documentation/admin-guide/kernel-parameters.txt | 14 +++++++++++++
Documentation/sound/alsa-configuration.rst | 25 +++++++++++++++++++++++
2 files changed, 39 insertions(+)
diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -8344,6 +8344,20 @@
Can be used multiple times for multiple devices.
+ virtio_snd.capture_packed_status= [HW,ALSA]
+ Read an explicitly enabled packed status trailer after
+ the returned capture data. The fixed status scatterlist is
+ used by default.
+ Format: <bool>
+ Default: false.
+
+ virtio_snd.capture_pause_restart= [HW,ALSA]
+ Stop and release the stream when pausing capture. On
+ resume, send PREPARE and START. If disabled, pause uses
+ STOP and START while retaining the prepared stream.
+ Format: <bool>
+ Default: false.
+
vga= [BOOT,X86-32] Select a particular video mode
See Documentation/arch/x86/boot.rst and
Documentation/admin-guide/svga.rst.
diff --git a/Documentation/sound/alsa-configuration.rst b/Documentation/sound/alsa-configuration.rst
--- a/Documentation/sound/alsa-configuration.rst
+++ b/Documentation/sound/alsa-configuration.rst
@@ -2537,6 +2537,31 @@
This module supports multiple cards.
+Module virtio-snd
+-----------------
+
+Virtio-sound capture receives data into a separate request buffer for each
+PCM period. The driver validates the responses and appends frame-aligned audio
+to the ALSA ring in request order. Valid short responses are retained. Empty
+responses are accepted only during bounded startup or for requests already in
+flight at STOP or PAUSE.
+
+capture_packed_status
+ Read an explicitly enabled packed status trailer after returned capture
+ data. The fixed status scatterlist is used by default.
+ (default = false)
+
+capture_pause_restart
+ Stop and release capture on pause. Resume with PREPARE and START. When
+ disabled, pause uses STOP and START while retaining the prepared stream.
+ (default = false)
+
+On MMU systems, the request buffers are vmalloc-backed and page-rounded
+individually. Allocator rounding can make total additional memory exceed the
+ALSA ring size, especially with small periods. The request buffers remain
+allocated from hw_params until hw_free.
+Captured audio is copied from each request buffer into the ALSA ring.
+
Module snd-virtuoso
-------------------
prev parent reply other threads:[~2026-11-12 5:18 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-12 4:34 [PATCH v28 00/17] ALSA: virtio: preserve PCM progress Joonho Lee
2026-11-12 4:35 ` [PATCH v28 01/17] ALSA: pcm: mark stop-threshold accesses for capture policy sampling Joonho Lee
2026-11-12 4:35 ` [PATCH v28 02/17] ALSA: pcm: report partial progress under the stream lock Joonho Lee
2026-11-12 4:35 ` [PATCH v28 03/17] ALSA: pcm: add an optional reset operation " Joonho Lee
2026-11-12 4:35 ` [PATCH v28 04/17] ALSA: pcm: notify drivers after linked prepare completes Joonho Lee
2026-11-12 4:35 ` [PATCH v28 05/17] ALSA: pcm: serialize linked buffer actions Joonho Lee
2026-11-12 4:35 ` [PATCH v28 06/17] ALSA: virtio: propagate playback send failures through ACK Joonho Lee
2026-11-12 4:35 ` [PATCH v28 07/17] ALSA: virtio: Recover PCM state after a failed start Joonho Lee
2026-11-12 4:35 ` [PATCH v28 08/17] ALSA: virtio: Retain queued messages through device reset Joonho Lee
2026-11-12 4:35 ` [PATCH v28 09/17] ALSA: virtio: bound PCM transfers and retain DMA buffers Joonho Lee
2026-11-12 4:35 ` [PATCH v28 10/17] ALSA: virtio: Keep control payloads alive through DMA completion Joonho Lee
2026-11-12 4:35 ` [PATCH v28 11/17] ALSA: virtio: wait through signals for PCM teardown Joonho Lee
2026-11-12 4:35 ` [PATCH v28 12/17] ALSA: virtio: use request-owned capture and serialize recovery Joonho Lee
2026-11-12 4:35 ` [PATCH v28 13/17] ALSA: virtio: prioritize capture period work Joonho Lee
2026-11-12 4:35 ` [PATCH v28 15/17] ALSA: virtio: reject invalid playback completions Joonho Lee
2026-11-12 4:35 ` [PATCH v28 16/17] ALSA: pcm: add an explicit application pointer to indirect playback transfer Joonho Lee
2026-11-12 4:35 ` [PATCH v28 17/17] ALSA: virtio: preserve playback progress across pause and buffer access Joonho Lee
2026-11-12 5:18 ` Joonho Lee [this message]
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=20261112043516.37010-15-mynameisjune111@gmail.com \
--to=joon@deeply.co.kr \
--cc=anton.yakovlev@opensynergy.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=mst@redhat.com \
--cc=mynameisjune111@gmail.com \
--cc=perex@perex.cz \
--cc=rdunlap@infradead.org \
--cc=skhan@linuxfoundation.org \
--cc=tiwai@suse.com \
--cc=virtualization@lists.linux.dev \
/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
all inboxes | Powered by JetHome®