ASoC: meson: add axg pdm input DT binding documentation
authorJerome Brunet <jbrunet@baylibre.com>
Wed, 29 Aug 2018 15:00:50 +0000 (17:00 +0200)
committerMark Brown <broonie@kernel.org>
Wed, 29 Aug 2018 15:04:16 +0000 (16:04 +0100)
Add the DT binding documentation for axg's PDM input

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

diff --git a/Documentation/devicetree/bindings/sound/amlogic,axg-pdm.txt b/Documentation/devicetree/bindings/sound/amlogic,axg-pdm.txt
new file mode 100644 (file)
index 0000000..5672d0b
--- /dev/null
@@ -0,0 +1,24 @@
+* Amlogic Audio PDM input
+
+Required properties:
+- compatible: 'amlogic,axg-pdm'
+- reg: physical base address of the controller and length of memory
+       mapped region.
+- clocks: list of clock phandle, one for each entry clock-names.
+- clock-names: should contain the following:
+  * "pclk"   : peripheral clock.
+  * "dclk"   : pdm digital clock
+  * "sysclk" : dsp system clock
+- #sound-dai-cells: must be 0.
+
+Example of PDM on the A113 SoC:
+
+pdm: audio-controller@ff632000 {
+       compatible = "amlogic,axg-pdm";
+       reg = <0x0 0xff632000 0x0 0x34>;
+       #sound-dai-cells = <0>;
+       clocks = <&clkc_audio AUD_CLKID_PDM>,
+                <&clkc_audio AUD_CLKID_PDM_DCLK>,
+                <&clkc_audio AUD_CLKID_PDM_SYSCLK>;
+       clock-names = "pclk", "dclk", "sysclk";
+};