[PATCH] ASoC: soc-ops: Clarify kernel doc for snd_soc_info_volsw_xs()

[PATCH] ASoC: soc-ops: Clarify kernel doc for snd_soc_info_volsw_xs()

[Charles Keepax]

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@opensource.cirrus.com>
---
 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

Re: [PATCH] ASoC: soc-ops: Clarify kernel doc for snd_soc_info_volsw_xs()

[Mark Brown]

On Tue, 01 Sep 2026 13:38:57 +0100, Charles Keepax wrote:
> ASoC: soc-ops: Clarify kernel doc for snd_soc_info_volsw_xs()

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-7.4

Thanks!

[1/1] ASoC: soc-ops: Clarify kernel doc for snd_soc_info_volsw_xs()
      https://git.kernel.org/broonie/sound/c/2bba6ea93e48

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark