]> www.infradead.org Git - users/dwmw2/linux.git/commitdiff
ASoC: doc: update clock api details
authoranish kumar <yesanishhere@gmail.com>
Thu, 31 Oct 2024 03:58:29 +0000 (20:58 -0700)
committerMark Brown <broonie@kernel.org>
Thu, 31 Oct 2024 12:00:57 +0000 (12:00 +0000)
Added ASoC clock api kernel doc in this
document.

Signed-off-by: anish kumar <yesanishhere@gmail.com>
Link: https://patch.msgid.link/20241031035829.54852-1-yesanishhere@gmail.com
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/sound/soc/clocking.rst

index 32122d6877a3d3682670eeeaeec43eb91c2e7ffe..25d016ea8b65f68bb9e7f3e5469b64803a11b5f7 100644 (file)
@@ -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