Received-SPF: pass (google.com: domain of linux-kernel+bounces-147915-linux.lists.archive=gmail.com@vger.kernel.org designates 147.75.199.223 as permitted sender) client-ip=147.75.199.223;
Date: Wed, 17 Apr 2024 11:12:24 +0700
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Luca Ceresoli <luca.ceresoli@bootlin.com>,
	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>,
	Mao Zhu <zhumao001@208suo.com>, Ran Sun <sunran001@208suo.com>,
	Xiang wangx <wangxiang@cdjrlc.com>,
	Shaomin Deng <dengshaomin@cdjrlc.com>,
	Charles Han <hanchunchao@inspur.com>,
	Attreyee M <tintinm2017@gmail.com>,
	Linux Sound System <linux-sound@vger.kernel.org>,
	Linux Documentation <linux-doc@vger.kernel.org>,
	Linux Kernel Mailing List <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH 08/12] ASoC: doc: dapm: describe how widgets and routes
 are registered
Message-ID: <Zh9MKK20Sf9Hu8AU@archie.me>
References: <20240416-dapm-docs-v1-0-a818d2819bf6@bootlin.com>
 <20240416-dapm-docs-v1-8-a818d2819bf6@bootlin.com>
Precedence: bulk
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
	protocol="application/pgp-signature"; boundary="awLH51WHILFbIBpJ"
Content-Disposition: inline
In-Reply-To: <20240416-dapm-docs-v1-8-a818d2819bf6@bootlin.com>


--awLH51WHILFbIBpJ
Content-Type: text/plain; charset=utf-8
Content-Disposition: inline
Content-Transfer-Encoding: quoted-printable

On Tue, Apr 16, 2024 at 07:56:14AM +0200, Luca Ceresoli wrote:
> diff --git a/Documentation/sound/soc/dapm.rst b/Documentation/sound/soc/d=
apm.rst
> index 3a2fde1d31bf..3aca913c99fc 100644
> --- a/Documentation/sound/soc/dapm.rst
> +++ b/Documentation/sound/soc/dapm.rst
> @@ -251,8 +251,42 @@ a virtual widget - a widget with no control bits e.g.
> =20
>  This can be used to merge two signal paths together in software.
> =20
> -After all the widgets have been defined, they can then be added to the D=
APM
> -subsystem individually with a call to snd_soc_dapm_new_control().
> +Registering DAPM controls
> +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D
> +
> +In many cases the DAPM widgets implemented statically in a ``static const
> +struct snd_soc_dapm_widget`` array and the routes connecting them in a
> +``static const struct snd_soc_dapm_route`` array in a codec driver, and
> +simply declared via the ``dapm_widgets`` and ``num_dapm_widgets`` fields=
 of
> +the ``struct snd_soc_component_driver`` so the driver registration will
> +take care of populating them::
> +
> +  static const struct snd_soc_dapm_widget wm2000_dapm_widgets[] =3D {
> +  	SND_SOC_DAPM_OUTPUT("SPKN"),
> +  	SND_SOC_DAPM_OUTPUT("SPKP"),
> +  	...
> +  };
> +
> +  /* Target, Path, Source */
> +  static const struct snd_soc_dapm_route wm2000_audio_map[] =3D {
> +  	{ "SPKN", NULL, "ANC Engine" },
> +  	{ "SPKP", NULL, "ANC Engine" },
> +	...
> +  };
> +
> +  static const struct snd_soc_component_driver soc_component_dev_wm2000 =
=3D {
> +	...
> +  	.dapm_widgets		=3D wm2000_dapm_widgets,
> +  	.num_dapm_widgets	=3D ARRAY_SIZE(wm2000_dapm_widgets),
> +	...
> +  };
> +
> +In more complex cases the list of DAPM widgets and/or routes can be only
> +known at build time. This happens for example when a driver supports
> +different models having a different set of features. In those cases
> +separate widgets and routes arrays implementing the case-specific featur=
es
> +can be registered programmatically by calling snd_soc_dapm_new_controls()
> +and snd_soc_dapm_add_routes().
> =20
> =20
>  Codec/DSP Widget Interconnections
>=20

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

--=20
An old man doll... just what I always wanted! - Clara

--awLH51WHILFbIBpJ
Content-Type: application/pgp-signature; name="signature.asc"

-----BEGIN PGP SIGNATURE-----

iHUEABYKAB0WIQSSYQ6Cy7oyFNCHrUH2uYlJVVFOowUCZh9MJwAKCRD2uYlJVVFO
o33kAP41KG431lltgPQpDCbTxsQtcEoh+C2ynC6FPJvYCr6JcwD+LATHVFcQsdB8
7DX108eTl0+2iV0olAuT870LaKZGEQ8=
=ryaT
-----END PGP SIGNATURE-----

--awLH51WHILFbIBpJ--