Re: [PATCH V2] ASoC: doc: update clocking

[Mark Brown <broonie@xxxxxxxxxx>]

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?

Attachment: signature.asc
Description: PGP signature