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: <CABCoZhAgnkDReqdMTgEjKYX4b9y0XqocEheQR1DhsBCtp7zpHg@mail.gmail.com>
Date: Wed, 30 Oct 2024 08:56:38 -0700
From: anish kumar <yesanishhere@...il.com>
To: Jonathan Corbet <corbet@....net>, broonie@...nel.org
Cc: lgirdwood@...il.com, perex@...ex.cz, tiwai@...e.com, 
	linux-kernel@...r.kernel.org, linux-sound@...r.kernel.org, 
	linux-doc@...r.kernel.org
Subject: Re: [PATCH V2] ASoC: doc: update clocking

On Wed, Oct 30, 2024 at 6:08 AM Mark Brown <broonie@...nel.org> wrote:
>
> 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?

Jonathan, wondering if you know a way to link the clock functions defined
in https://github.com/torvalds/linux/blob/master/sound/soc/soc-dai.c here?