ASoC: meson: add axg tdm interface DT bindings documentation
authorJerome Brunet <jbrunet@baylibre.com>
Tue, 17 Jul 2018 15:42:57 +0000 (17:42 +0200)
committerMark Brown <broonie@kernel.org>
Fri, 20 Jul 2018 16:38:19 +0000 (17:38 +0100)
Add the DT bindings documentation for axg's TDM interfaces

Signed-off-by: Jerome Brunet <jbrunet@baylibre.com>
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/sound/amlogic,axg-tdm-iface.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/sound/amlogic,axg-tdm-iface.txt b/Documentation/devicetree/bindings/sound/amlogic,axg-tdm-iface.txt
new file mode 100644 (file)
index 0000000..cabfb26
--- /dev/null
@@ -0,0 +1,22 @@
+* Amlogic Audio TDM Interfaces
+
+Required properties:
+- compatible: 'amlogic,axg-tdm-iface'
+- clocks: list of clock phandle, one for each entry clock-names.
+- clock-names: should contain the following:
+  * "sclk" : bit clock.
+  * "lrclk": sample clock
+  * "mclk" : master clock
+            -> optional if the interface is in clock slave mode.
+- #sound-dai-cells: must be 0.
+
+Example of TDM_A on the A113 SoC:
+
+tdmif_a: audio-controller@0 {
+       compatible = "amlogic,axg-tdm-iface";
+       #sound-dai-cells = <0>;
+       clocks = <&clkc_audio AUD_CLKID_MST_A_MCLK>,
+                <&clkc_audio AUD_CLKID_MST_A_SCLK>,
+                <&clkc_audio AUD_CLKID_MST_A_LRCLK>;
+       clock-names = "mclk", "sclk", "lrclk";
+};