[alsa-devel] [PATCH 02/11] dt: bindings: add AXD Audio Processing IP binding document

[Qais Yousef]

Add device tree support for AXD Audio Processing IP

Signed-off-by: Qais Yousef <qais.yousef at imgtec.com>
Cc: Arnd Bergmann <arnd at arndb.de>
Cc: Greg Kroah-Hartman <gregkh at linuxfoundation.org>
Cc: Rob Herring <robh+dt at kernel.org>
Cc: Pawel Moll <pawel.moll at arm.com>
Cc: Mark Rutland <mark.rutland at arm.com>
Cc: Ian Campbell <ijc+devicetree at hellion.org.uk>
Cc: Kumar Gala <galak at codeaurora.org>
Cc: <devicetree at vger.kernel.org>
Cc: <alsa-devel at alsa-project.org>
---
 Documentation/devicetree/bindings/axd.txt | 39 +++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/axd.txt

diff --git a/Documentation/devicetree/bindings/axd.txt b/Documentation/devicetree/bindings/axd.txt
new file mode 100644
index 000000000000..694fc40613fb
--- /dev/null
+++ b/Documentation/devicetree/bindings/axd.txt
@@ -0,0 +1,39 @@
+* AXD Audio Processing IP Binding *
+
+Required properties:
+- compatible: "img,axd"
+- clocks: phandle for the clock that drives AXD.
+- interrupts: the GIC interrupt where AXD is connected or software interrupt
+  1 (not recommended).
+
+Optional properties:
+- gic-irq: it takes two non-zero values, the first one is the host hwirq and
+           the second one is axd's. Host's hwirq should match the value in
+           interrupts.
+           If not using GIC, then axd will revert to using software interrupt 1
+           which is a fallback mechanism for systems without GIC. It is
+           recommended to use GIC whenever possible. Some systems will only work
+           with GIC so this property will not be optional then.
+- vpe: VPE number on which axd should start. Must be provided if axd is
+       running as a single VPE along Linux on the same core.
+       It can't be VPE0.
+       The VPE must be offlined by Linux before axd is loaded.
+- inbuf-size: size of shared input buffers area. by default it's 0x7800 bytes.
+- outbuf-size: size of shared output buffers area. by default it's 0x3c000 bytes.
+
+
+Example:
+
+		axdclk: axdclk at 400M {
+			#clock-cells = <0>;
+			compatible = "fixed-clock";
+			clock-frequency = <400000000>;
+		};
+
+		axd: axd at 07800000 {
+			compatible = "img,axd";
+			clocks = <&axdclk>;
+			interrupts = <36 IRQ_TYPE_EDGE_RISING>
+			gic-irq = <36 37>;
+			vpe = <1>;
+		};
-- 
2.1.0