ASoC: sunxi: Add A10 I2S controller binding documentation
authorMaxime Ripard <maxime.ripard@free-electrons.com>
Wed, 15 Jun 2016 21:11:20 +0000 (23:11 +0200)
committerMark Brown <broonie@kernel.org>
Wed, 29 Jun 2016 21:42:43 +0000 (22:42 +0100)
Introduce the device tree binding for the I2S controller found in the
Allwinner A10 and later SoCs.

Signed-off-by: Maxime Ripard <maxime.ripard@free-electrons.com>
Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Mark Brown <broonie@kernel.org>
Documentation/devicetree/bindings/sound/sun4i-i2s.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/sound/sun4i-i2s.txt b/Documentation/devicetree/bindings/sound/sun4i-i2s.txt
new file mode 100644 (file)
index 0000000..7b526ec
--- /dev/null
@@ -0,0 +1,34 @@
+* Allwinner A10 I2S controller
+
+The I2S bus (Inter-IC sound bus) is a serial link for digital
+audio data transfer between devices in the system.
+
+Required properties:
+
+- compatible: should be one of the followings
+   - "allwinner,sun4i-a10-i2s"
+- reg: physical base address of the controller and length of memory mapped
+  region.
+- interrupts: should contain the I2S interrupt.
+- dmas: DMA specifiers for tx and rx dma. See the DMA client binding,
+       Documentation/devicetree/bindings/dma/dma.txt
+- dma-names: should include "tx" and "rx".
+- clocks: a list of phandle + clock-specifer pairs, one for each entry in clock-names.
+- clock-names: should contain followings:
+   - "apb" : clock for the I2S bus interface
+   - "mod" : module clock for the I2S controller
+- #sound-dai-cells : Must be equal to 0
+
+Example:
+
+i2s0: i2s@01c22400 {
+       #sound-dai-cells = <0>;
+       compatible = "allwinner,sun4i-a10-i2s";
+       reg = <0x01c22400 0x400>;
+       interrupts = <GIC_SPI 16 IRQ_TYPE_LEVEL_HIGH>;
+       clocks = <&apb0_gates 3>, <&i2s0_clk>;
+       clock-names = "apb", "mod";
+       dmas = <&dma SUN4I_DMA_NORMAL 3>,
+              <&dma SUN4I_DMA_NORMAL 3>;
+       dma-names = "rx", "tx";
+};