From: Luca Ceresoli <luca.ceresoli@bootlin.com>
To: Liam Girdwood <lgirdwood@gmail.com>,
Mark Brown <broonie@kernel.org>,
Jaroslav Kysela <perex@perex.cz>, Takashi Iwai <tiwai@suse.com>,
Jonathan Corbet <corbet@lwn.net>
Cc: Alexandre Belloni <alexandre.belloni@bootlin.com>,
Thomas Petazzoni <thomas.petazzoni@bootlin.com>,
linux-sound@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Luca Ceresoli <luca.ceresoli@bootlin.com>
Subject: [PATCH 10/12] ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections"
Date: Tue, 16 Apr 2024 07:56:16 +0200 [thread overview]
Message-ID: <20240416-dapm-docs-v1-10-a818d2819bf6@bootlin.com> (raw)
In-Reply-To: <20240416-dapm-docs-v1-0-a818d2819bf6@bootlin.com>
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(-)
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.
--
2.34.1
next prev parent reply other threads:[~2024-04-16 5:57 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-16 5:56 [PATCH 00/12] ASoC: doc: dapm: various improvements Luca Ceresoli
2024-04-16 5:56 ` [PATCH 01/12] ASoC: doc: dapm: fix typos Luca Ceresoli
2024-04-17 3:49 ` Bagas Sanjaya
2024-04-16 5:56 ` [PATCH 02/12] ASoC: doc: dapm: fix struct name Luca Ceresoli
2024-04-16 5:56 ` [PATCH 03/12] ASoC: doc: dapm: minor rewording Luca Ceresoli
2024-04-17 3:54 ` Bagas Sanjaya
2024-04-16 5:56 ` [PATCH 04/12] ASoC: doc: dapm: remove dash after colon Luca Ceresoli
2024-04-16 5:56 ` [PATCH 05/12] ASoC: doc: dapm: clarify it's an internal API Luca Ceresoli
2024-04-17 3:57 ` Bagas Sanjaya
2024-04-16 5:56 ` [PATCH 06/12] ASoC: doc: dapm: replace "map" with "graph" Luca Ceresoli
2024-04-16 5:56 ` [PATCH 07/12] ASoC: doc: dapm: extend initial descrption Luca Ceresoli
2024-04-17 4:05 ` Bagas Sanjaya
2024-04-16 5:56 ` [PATCH 08/12] ASoC: doc: dapm: describe how widgets and routes are registered Luca Ceresoli
2024-04-17 4:12 ` Bagas Sanjaya
2024-04-16 5:56 ` [PATCH 09/12] ASoC: doc: dapm: fix and improve section "Registering DAPM controls" Luca Ceresoli
2024-04-17 4:16 ` Bagas Sanjaya
2024-04-16 5:56 ` Luca Ceresoli [this message]
2024-04-17 4:33 ` [PATCH 10/12] ASoC: doc: dapm: improve section "Codec/DSP Widget Interconnections" Bagas Sanjaya
2024-04-17 5:08 ` Luca Ceresoli
2024-04-16 5:56 ` [PATCH 11/12] ASoC: doc: dapm: update section "DAPM Widget Events" Luca Ceresoli
2024-04-16 5:56 ` [PATCH 12/12] ASoC: doc: dapm: update event types Luca Ceresoli
2024-04-16 21:23 ` [PATCH 00/12] ASoC: doc: dapm: various improvements Alexandre Belloni
2024-04-17 5:07 ` Luca Ceresoli
2024-04-17 23:30 ` Luca Ceresoli
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240416-dapm-docs-v1-10-a818d2819bf6@bootlin.com \
--to=luca.ceresoli@bootlin.com \
--cc=alexandre.belloni@bootlin.com \
--cc=broonie@kernel.org \
--cc=corbet@lwn.net \
--cc=lgirdwood@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-sound@vger.kernel.org \
--cc=perex@perex.cz \
--cc=thomas.petazzoni@bootlin.com \
--cc=tiwai@suse.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox