Skip to content

Commit 057acfb

Browse files
lucaceresolibroonie
authored andcommitted
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 <[email protected]> Signed-off-by: Luca Ceresoli <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Mark Brown <[email protected]>
1 parent d40e821 commit 057acfb

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

Documentation/sound/soc/dapm.rst

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -306,25 +306,23 @@ This is easiest with a diagram of the codec or DSP (and schematic of the machine
306306
audio system), as it requires joining widgets together via their audio signal
307307
paths.
308308

309-
e.g., from the WM8731 output mixer (wm8731.c)
310-
311-
The WM8731 output mixer has 3 inputs (sources)
309+
For example the WM8731 output mixer (wm8731.c) has 3 inputs (sources):
312310

313311
1. Line Bypass Input
314312
2. DAC (HiFi playback)
315313
3. Mic Sidetone Input
316314

317-
Each input in this example has a kcontrol associated with it (defined in example
318-
above) and is connected to the output mixer via its kcontrol name. We can now
319-
connect the destination widget (wrt audio signal) with its source widgets.
320-
::
315+
Each input in this example has a kcontrol associated with it (defined in
316+
the example above) and is connected to the output mixer via its kcontrol
317+
name. We can now connect the destination widget (wrt audio signal) with its
318+
source widgets. ::
321319

322320
/* output mixer */
323321
{"Output Mixer", "Line Bypass Switch", "Line Input"},
324322
{"Output Mixer", "HiFi Playback Switch", "DAC"},
325323
{"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
326324

327-
So we have :
325+
So we have:
328326

329327
* Destination Widget <=== Path Name <=== Source Widget, or
330328
* Sink, Path, Source, or
@@ -333,12 +331,11 @@ So we have :
333331
When there is no path name connecting widgets (e.g. a direct connection) we
334332
pass NULL for the path name.
335333

336-
Interconnections are created with a call to:
337-
::
334+
Interconnections are created with a call to::
338335

339336
snd_soc_dapm_connect_input(codec, sink, path, source);
340337

341-
Finally, snd_soc_dapm_new_widgets(codec) must be called after all widgets and
338+
Finally, snd_soc_dapm_new_widgets() must be called after all widgets and
342339
interconnections have been registered with the core. This causes the core to
343340
scan the codec and machine so that the internal DAPM state matches the
344341
physical state of the machine.

0 commit comments

Comments
 (0)