[PATCH v2 1/2] ALSA: doc: pcmtest: Update to match the driver
From: HyeongJun An
Date: Wed Nov 11 2026 - 04:06:22 EST
The documentation does not match the driver in a few places.
The inject_open_err parameter is missing from the parameter list and
from the list of callbacks that can return an error. The fill_mode
parameter is a short, not a bool. The selftest is
alsa/test-pcmtest-driver.c, not alsa/pcmtest-test.sh. Pause support is
not listed.
Fix these.
Signed-off-by: HyeongJun An <sammiee5311@xxxxxxxxx>
---
Documentation/sound/cards/pcmtest.rst | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/Documentation/sound/cards/pcmtest.rst b/Documentation/sound/cards/pcmtest.rst
index e163522f3205..ed0b57f583b7 100644
--- a/Documentation/sound/cards/pcmtest.rst
+++ b/Documentation/sound/cards/pcmtest.rst
@@ -16,22 +16,24 @@ At this moment the driver can do the following things:
* Generate random or pattern-based capturing data
* Inject delays into the playback and capturing processes
* Inject errors during the PCM callbacks
+ * Pause the streams
It supports up to 8 substreams and 4 channels. Also it supports both interleaved and
non-interleaved access modes.
Also, this driver can check the playback stream for containing the predefined pattern,
-which is used in the corresponding selftest (alsa/pcmtest-test.sh) to check the PCM middle
-layer data transferring functionality. Additionally, this driver redefines the default
-RESET ioctl, and the selftest covers this PCM API functionality as well.
+which is used in the corresponding selftest (alsa/test-pcmtest-driver.c) to check the PCM
+middle layer data transferring functionality. Additionally, this driver redefines the
+default RESET ioctl, and the selftest covers this PCM API functionality as well.
Configuration
-------------
The driver has several parameters besides the common ALSA module parameters:
- * fill_mode (bool) - Buffer fill mode (see below)
+ * fill_mode (short) - Buffer fill mode (see below)
* inject_delay (int)
+ * inject_open_err (bool)
* inject_hwpars_err (bool)
* inject_prepare_err (bool)
* inject_trigger_err (bool)
@@ -93,6 +95,7 @@ writing '1' to the 'inject_hwpars_err' module parameter:
Errors can be injected into the following PCM callbacks:
+ * open (EBUSY)
* hw_params (EBUSY)
* prepare (EINVAL)
* trigger (EINVAL)
--
2.43.0