Re: [PATCH V3] ALSA: machine: update documentation

[Bagas Sanjaya <bagasdotme@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 2222 bytes --]

On Sat, Nov 09, 2024 at 11:22:31AM -0800, anish kumar wrote:
> diff --git a/Documentation/sound/soc/machine.rst b/Documentation/sound/soc/machine.rst
> index 515c9444deaf..9db132bc0070 100644
> --- a/Documentation/sound/soc/machine.rst
> +++ b/Documentation/sound/soc/machine.rst
> @@ -71,6 +71,18 @@ struct snd_soc_dai_link is used to set up each DAI in your machine. e.g.
>  	.ops = &corgi_ops,
>    };
>  
> +In the above struct, dai’s are registered using names but you can pass
> +either dai name or device tree node but not both. Also, names used here
> +for cpu/codec/platform dais should be globally unique.
> +
> +Additionaly below example macro can be used to register cpu, codec and
> +platform dai::
> +
> +  SND_SOC_DAILINK_DEFS(wm2200_cpu_dsp,
> +	DAILINK_COMP_ARRAY(COMP_CPU("samsung-i2s.0")),
> +	DAILINK_COMP_ARRAY(COMP_CODEC("spi0.0", "wm0010-sdi1")),
> +	DAILINK_COMP_ARRAY(COMP_PLATFORM("samsung-i2s.0")));
> +
>  struct snd_soc_card then sets up the machine with its DAIs. e.g.
>  ::
>  
> @@ -81,6 +93,10 @@ struct snd_soc_card then sets up the machine with its DAIs. e.g.
>  	.num_links = 1,
>    };
>  
> +Following this, ``devm_snd_soc_register_card`` can be used to register
> +the sound card. During the registration, the individual components
> +such as the codec, CPU, and platform are probed. If all these components
> +are successfully probed, the sound card gets registered.
>  
>  Machine Power Map
>  -----------------
> @@ -95,3 +111,13 @@ Machine Controls
>  ----------------
>  
>  Machine specific audio mixer controls can be added in the DAI init function.
> +
> +
> +Clocking Controls
> +-----------------
> +
> +As previously noted, clock configuration is handled within the machine driver.
> +For details on the clock APIs that the machine driver can utilize for
> +setup, please refer to Documentation/sound/soc/clocking.rst. However, the
> +callback needs to be registered by the CPU/Codec/Platform drivers to configure
> +the clocks that is needed for the corresponding device operation.

Looks good, thanks!

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

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]