[PATCH] ASoC: soc-ops: Clarify kernel doc for snd_soc_info_volsw_xs()
From: Charles Keepax
Date: Tue Sep 01 2026 - 08:52:23 EST
The current comment describing the min member of struct
soc_mixer_control for SX controls is slightly open to
misinterpretation. It currently says "min is the minimum register
value", that could be interpreted as the lowest numerical value
the register can receive, whereas the intention is the value
equating to the lowest possible volume. These are often but
not always the same thing. Update the comment to be slightly
more explicit.
Signed-off-by: Charles Keepax <ckeepax@xxxxxxxxxxxxxxxxxxxxx>
---
sound/soc/soc-ops.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/sound/soc/soc-ops.c b/sound/soc/soc-ops.c
index c935571d43e9d..142f407e39399 100644
--- a/sound/soc/soc-ops.c
+++ b/sound/soc/soc-ops.c
@@ -305,8 +305,8 @@ EXPORT_SYMBOL_GPL(snd_soc_info_volsw);
* Callback to provide information about a single mixer control, or a double
* mixer control that spans 2 registers of the SX TLV type. SX TLV controls
* have a range that represents both positive and negative values either side
- * of zero but without a sign bit. min is the minimum register value, max is
- * the number of steps.
+ * of zero but without a sign bit. min is the register value representing the
+ * minimum volume, max is the number of volume steps.
*
* Returns 0 for success.
*/
--
2.47.3