mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections" 

Improve wording in a few places, cleanup ReST colon syntax, remove space
before colon, and remove the "codec" parameter in the parentheses of
snd_soc_dapm_new_widgets() (there should be no parameters in the docs, and
that function takes a card, not a codec).

Reviewed-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com>
Link: https://lore.kernel.org/r/20240426-dapm-docs-v2-10-87b07547eb5b@bootlin.com
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Luca Ceresoli 2024-04-26 18:56:43 +02:00 committed by Mark Brown
parent d40e821944
commit 057acfb460
No known key found for this signature in database
GPG Key ID: 24D68B725D5487D0
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/sound/soc/dapm.rst
View File

@ -306,25 +306,23 @@ This is easiest with a diagram of the codec or DSP (and schematic of the machine
audio system), as it requires joining widgets together via their audio signal audio system), as it requires joining widgets together via their audio signal
paths. paths.
e.g., from the WM8731 output mixer (wm8731.c) For example the WM8731 output mixer (wm8731.c) has 3 inputs (sources):
The WM8731 output mixer has 3 inputs (sources)
1. Line Bypass Input 1. Line Bypass Input
2. DAC (HiFi playback) 2. DAC (HiFi playback)
3. Mic Sidetone Input 3. Mic Sidetone Input
Each input in this example has a kcontrol associated with it (defined in example Each input in this example has a kcontrol associated with it (defined in
above) and is connected to the output mixer via its kcontrol name. We can now the example above) and is connected to the output mixer via its kcontrol
connect the destination widget (wrt audio signal) with its source widgets. name. We can now connect the destination widget (wrt audio signal) with its
:: source widgets. ::
/* output mixer */ /* output mixer */
{"Output Mixer", "Line Bypass Switch", "Line Input"}, {"Output Mixer", "Line Bypass Switch", "Line Input"},
{"Output Mixer", "HiFi Playback Switch", "DAC"}, {"Output Mixer", "HiFi Playback Switch", "DAC"},
{"Output Mixer", "Mic Sidetone Switch", "Mic Bias"}, {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
So we have : So we have:
* Destination Widget <=== Path Name <=== Source Widget, or * Destination Widget <=== Path Name <=== Source Widget, or
* Sink, Path, Source, or * Sink, Path, Source, or
@ -333,12 +331,11 @@ So we have :
When there is no path name connecting widgets (e.g. a direct connection) we When there is no path name connecting widgets (e.g. a direct connection) we
pass NULL for the path name. pass NULL for the path name.
Interconnections are created with a call to: Interconnections are created with a call to::
::
snd_soc_dapm_connect_input(codec, sink, path, source); snd_soc_dapm_connect_input(codec, sink, path, source);
Finally, snd_soc_dapm_new_widgets(codec) must be called after all widgets and Finally, snd_soc_dapm_new_widgets() must be called after all widgets and
interconnections have been registered with the core. This causes the core to interconnections have been registered with the core. This causes the core to
scan the codec and machine so that the internal DAPM state matches the scan the codec and machine so that the internal DAPM state matches the
physical state of the machine. physical state of the machine.