dt: Add bindings documentation for the ADI AXI-SPDIF audio controller
authorLars-Peter Clausen <lars@metafoo.de>
Fri, 6 Dec 2013 10:02:51 +0000 (11:02 +0100)
committerMark Brown <broonie@linaro.org>
Mon, 9 Dec 2013 17:57:36 +0000 (17:57 +0000)
This patch adds the devicetree documentation for the ADI AXI-SPDIF audio
controller. The controller has:
 * One set of memory mapped register
 * Two clocks, one for the memory mapped register interface, one used as the
   audio reference clock
 * A DMA interface for the transmit data

Signed-off-by: Lars-Peter Clausen <lars@metafoo.de>
Cc: Rob Herring <rob.herring@calxeda.com>
Cc: Pawel Moll <pawel.moll@arm.com>
Cc: Mark Rutland <mark.rutland@arm.com>
Cc: Stephen Warren <swarren@wwwdotorg.org>
Cc: Ian Campbell <ijc+devicetree@hellion.org.uk>
Cc: devicetree@vger.kernel.org
Signed-off-by: Mark Brown <broonie@linaro.org>
Documentation/devicetree/bindings/sound/adi,axi-spdif-tx.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/sound/adi,axi-spdif-tx.txt b/Documentation/devicetree/bindings/sound/adi,axi-spdif-tx.txt
new file mode 100644 (file)
index 0000000..46f3449
--- /dev/null
@@ -0,0 +1,30 @@
+ADI AXI-SPDIF controller
+
+Required properties:
+ - compatible : Must be "adi,axi-spdif-1.00.a"
+ - reg : Must contain SPDIF core's registers location and length
+ - clocks : Pairs of phandle and specifier referencing the controller's clocks.
+   The controller expects two clocks, the clock used for the AXI interface and
+   the clock used as the sampling rate reference clock sample.
+ - clock-names: "axi" for the clock to the AXI interface, "ref" for the sample
+   rate reference clock.
+ - dmas: Pairs of phandle and specifier for the DMA channel that is used by
+   the core. The core expects one dma channel for transmit.
+ - dma-names : Must be "tx"
+
+For more details on the 'dma', 'dma-names', 'clock' and 'clock-names' properties
+please check:
+       * resource-names.txt
+       * clock/clock-bindings.txt
+       * dma/dma.txt
+
+Example:
+
+       spdif: spdif@0x77400000 {
+               compatible = "adi,axi-spdif-tx-1.00.a";
+               reg = <0x77600000 0x1000>;
+               clocks = <&clk 15>, <&audio_clock>;
+               clock-names = "axi", "ref";
+               dmas = <&ps7_dma 0>;
+               dma-names = "tx";
+       };