ASoC: soc-utils: Improve kerneldoc for snd_soc_tdm_params_to_bclk()
authorRichard Fitzgerald <rf@opensource.cirrus.com>
Mon, 15 Aug 2022 11:33:46 +0000 (12:33 +0100)
committerMark Brown <broonie@kernel.org>
Mon, 15 Aug 2022 16:23:26 +0000 (17:23 +0100)
commitefe30e2cb6ff87467389cece8ce604f6601059f9
tree506ead9d9b6a72d882a3edfdaa5bcc63823df944
parent36b99942d4770e91d58e7578480db2be8e059c80
ASoC: soc-utils: Improve kerneldoc for snd_soc_tdm_params_to_bclk()

The statement that snd_soc_tdm_params_to_bclk() is equivalent to
snd_soc_params_to_bclk() if tdm_width==tdm_slots==0 is not accurate,
it is only true is slot_multiple is also <2.

However, the description of special-case behaviour in terms of pairs of
tdm_width and tdm_slot values is not particularly helpful so we might as
well take the opportunity to rework the description to say the same thing
in a simpler way. The behaviour of a pair of values is obvious from a
description of each argument. At the same time make a few edits to clarify
the rest of the description.

Signed-off-by: Richard Fitzgerald <rf@opensource.cirrus.com>
Link: https://lore.kernel.org/r/20220815113346.3805075-1-rf@opensource.cirrus.com
Signed-off-by: Mark Brown <broonie@kernel.org>
sound/soc/soc-utils.c