Unverified Commit 057acfb4 authored by Luca Ceresoli's avatar Luca Ceresoli Committed by Mark Brown
Browse files

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: default avatarAlexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: default avatarLuca Ceresoli <luca.ceresoli@bootlin.com>
Link: https://lore.kernel.org/r/20240426-dapm-docs-v2-10-87b07547eb5b@bootlin.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent d40e8219

Documentation/sound/soc/dapm.rst

+8 −11
Original line number Diff line number Diff line
@@ -306,18 +306,16 @@ 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

paths.



e.g., from the WM8731 output mixer (wm8731.c)



The WM8731 output mixer has 3 inputs (sources)

For example the WM8731 output mixer (wm8731.c) has 3 inputs (sources):



1. Line Bypass Input

2. DAC (HiFi playback)

3. Mic Sidetone Input



Each input in this example has a kcontrol associated with it (defined in example

above) and is connected to the output mixer via its kcontrol name. We can now

connect the destination widget (wrt audio signal) with its source widgets.

::

Each input in this example has a kcontrol associated with it (defined in

the example above) and is connected to the output mixer via its kcontrol

name. We can now connect the destination widget (wrt audio signal) with its

source widgets.  ::



	/* output mixer */

	{"Output Mixer", "Line Bypass Switch", "Line Input"},
@@ -333,12 +331,11 @@ So we have : 
When there is no path name connecting widgets (e.g. a direct connection) we

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);



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

scan the codec and machine so that the internal DAPM state matches the

physical state of the machine.