| Message ID | 20241031035829.54852-1-yesanishhere@gmail.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 019610566757a749dde7e0c92777d2c1613afef8 |
| Headers | show |
| Series | [V2] ASoC: doc: update clock api details | expand |
On Wed, 30 Oct 2024 20:58:29 -0700, anish kumar wrote: > Added ASoC clock api kernel doc in this > document. > > Applied to https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next Thanks! [1/1] ASoC: doc: update clock api details commit: 019610566757a749dde7e0c92777d2c1613afef8 All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted. You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed. If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced. Please add any relevant lists and maintainers to the CCs when replying to this mail. Thanks, Mark
diff --git a/Documentation/sound/soc/clocking.rst b/Documentation/sound/soc/clocking.rst index 32122d6877a3..25d016ea8b65 100644 --- a/Documentation/sound/soc/clocking.rst +++ b/Documentation/sound/soc/clocking.rst @@ -42,5 +42,17 @@ rate, number of channels and word size) to save on power. It is also desirable to use the codec (if possible) to drive (or master) the audio clocks as it usually gives more accurate sample rates than the CPU. +ASoC provided clock APIs +------------------------ +.. kernel-doc:: sound/soc/soc-dai.c + :identifiers: snd_soc_dai_set_sysclk +.. kernel-doc:: sound/soc/soc-dai.c + :identifiers: snd_soc_dai_set_clkdiv + +.. kernel-doc:: sound/soc/soc-dai.c + :identifiers: snd_soc_dai_set_pll + +.. kernel-doc:: sound/soc/soc-dai.c + :identifiers: snd_soc_dai_set_bclk_ratio
Added ASoC clock api kernel doc in this document. Signed-off-by: anish kumar <yesanishhere@gmail.com> --- v2: converted to use kernel doc based on comment from Jonathan and Mark. Documentation/sound/soc/clocking.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+)