linux-kernel - Re: [PATCH V2] ASoC: doc: update clocking

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <fceef9c9-f928-47fe-a6e7-cdb28af62f71@sirena.org.uk>
Date: Wed, 30 Oct 2024 13:08:27 +0000
From: Mark Brown <broonie@...nel.org>
To: anish kumar <yesanishhere@...il.com>
Cc: lgirdwood@...il.com, perex@...ex.cz, tiwai@...e.com, corbet@....net,
	linux-kernel@...r.kernel.org, linux-sound@...r.kernel.org,
	linux-doc@...r.kernel.org
Subject: Re: [PATCH V2] ASoC: doc: update clocking

On Tue, Oct 29, 2024 at 04:56:23PM -0700, anish kumar wrote:

> Add ASoC clock api details to this document.

> +ASoC provided clock APIs
> +------------------------
> +
> +.. function:: int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai,
> +                                          int clk_id, unsigned int freq,
> +                                          int dir)
> +
> +   This function is generally called in the machine driver to set the
> +   sysclk or MCLK. This function in turn calls the codec or platform
> +   callbacks to set the sysclk/MCLK. If the call ends up in the codec
> +   driver and MCLK is provided by the codec, the direction should be
> +   :c:macro:`SND_SOC_CLOCK_IN`. If the processor is providing the clock,
> +   it should be set to :c:macro:`SND_SOC_CLOCK_OUT`. If the callback
> +   ends up in the platform/cpu driver, it can set up any clocks that are
> +   required for platform hardware.

This feels like it is (or should be) duplicating the kerneldoc generated
documentation - I'm not sure that we can cross reference the two
sensibly through?

Download attachment "signature.asc" of type "application/pgp-signature" (489 bytes)