| Message ID | 20240416-dapm-docs-v1-10-a818d2819bf6@bootlin.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | ASoC: doc: dapm: various improvements | expand |
On Tue, Apr 16, 2024 at 07:56:16AM +0200, Luca Ceresoli wrote: > -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. :: > <snipped>... > -Interconnections are created with a call to: > -:: > +Interconnections are created with a call to:: > Not strictly related to this patch, but for consistency, I'd like to write remaining literal block markers at the end of previous paragraph: ---- >8 ---- diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst index f76fc97dd16219..e4c44d08c8380b 100644 --- a/Documentation/sound/soc/dapm.rst +++ b/Documentation/sound/soc/dapm.rst @@ -180,15 +180,13 @@ Path Domain Widgets ------------------- Path domain widgets have a ability to control or affect the audio signal or -audio paths within the audio subsystem. They have the following form: -:: +audio paths within the audio subsystem. They have the following form:: SND_SOC_DAPM_PGA(name, reg, shift, invert, controls, num_controls) Any widget kcontrols can be set using the controls and num_controls members. -e.g. Mixer widget (the kcontrols are declared first) -:: +e.g. Mixer widget (the kcontrols are declared first):: /* Output Mixer */ static const snd_kcontrol_new_t wm8731_output_mixer_controls[] = { @@ -244,8 +242,7 @@ Virtual Widgets Sometimes widgets exist in the codec or machine audio graph that don't have any corresponding soft power control. In this case it is necessary to create -a virtual widget - a widget with no control bits e.g. -:: +a virtual widget - a widget with no control bits e.g:: SND_SOC_DAPM_MIXER("AC97 Mixer", SND_SOC_NOPM, 0, 0, NULL, 0), @@ -316,7 +313,7 @@ For example the WM8731 output mixer (wm8731.c) has 3 inputs (sources): 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. :: +source widgets:: /* output mixer */ {"Output Mixer", "Line Bypass Switch", "Line Input"}, @@ -347,8 +344,7 @@ Machine Widget Interconnections Machine widget interconnections are created in the same way as codec ones and directly connect the codec pins to machine level widgets. -e.g. connects the speaker out codec pins to the internal speaker. -:: +e.g. connects the speaker out codec pins to the internal speaker:: /* ext speaker connected to codec pins LOUT2, ROUT2 */ {"Ext Spk", NULL , "ROUT2"}, Thanks.
Hello Bagas, thanks for reviewing! On Wed, 17 Apr 2024 11:33:12 +0700 Bagas Sanjaya <bagasdotme@gmail.com> wrote: > On Tue, Apr 16, 2024 at 07:56:16AM +0200, Luca Ceresoli wrote: > > -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. :: > > <snipped>... > > -Interconnections are created with a call to: > > -:: > > +Interconnections are created with a call to:: > > > > Not strictly related to this patch, but for consistency, I'd like > to write remaining literal block markers at the end of previous > paragraph: Makes sense, sure. I can add a patch doing this in v2, or send a separate patch after this series. Luca
diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/dapm.rst index ab7d48582cf7..5b370daed499 100644 --- a/Documentation/sound/soc/dapm.rst +++ b/Documentation/sound/soc/dapm.rst @@ -307,25 +307,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 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"}, {"Output Mixer", "HiFi Playback Switch", "DAC"}, {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"}, -So we have : +So we have: * Destination Widget <=== Path Name <=== Source Widget, or * Sink, Path, Source, or @@ -334,12 +332,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.
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). Signed-off-by: Luca Ceresoli <luca.ceresoli@bootlin.com> --- Documentation/sound/soc/dapm.rst | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-)