dt-bindings: add bindings documentation for PDC driver.
authorRob Rice <rrice@broadcom.com>
Thu, 30 Jun 2016 19:59:22 +0000 (15:59 -0400)
committerJassi Brar <jaswinder.singh@linaro.org>
Thu, 28 Jul 2016 04:04:46 +0000 (09:34 +0530)
Add the device tree binding documentation for the PDC hardware
in Broadcom iProc SoCs.

Signed-off-by: Rob Rice <rob.rice@broadcom.com>
Acked-by: Rob Herring <robh@kernel.org>
Reviewed-by: Ray Jui <ray.jui@broadcom.com>
Reviewed-by: Anup Patel <anup.patel@broadcom.com>
Reviewed-by: Scott Branden <scott.branden@broadcom.com>
Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>
Documentation/devicetree/bindings/mailbox/brcm,iproc-pdc-mbox.txt [new file with mode: 0644]

diff --git a/Documentation/devicetree/bindings/mailbox/brcm,iproc-pdc-mbox.txt b/Documentation/devicetree/bindings/mailbox/brcm,iproc-pdc-mbox.txt
new file mode 100644 (file)
index 0000000..411ccf4
--- /dev/null
@@ -0,0 +1,23 @@
+The PDC driver manages data transfer to and from various offload engines
+on some Broadcom SoCs. An SoC may have multiple PDC hardware blocks. There is
+one device tree entry per block.
+
+Required properties:
+- compatible : Should be "brcm,iproc-pdc-mbox".
+- reg: Should contain PDC registers location and length.
+- interrupts: Should contain the IRQ line for the PDC.
+- #mbox-cells: 1
+- brcm,rx-status-len: Length of metadata preceding received frames, in bytes.
+
+Optional properties:
+- brcm,use-bcm-hdr:  present if a BCM header precedes each frame.
+
+Example:
+       pdc0: iproc-pdc0@0x612c0000 {
+               compatible = "brcm,iproc-pdc-mbox";
+               reg = <0 0x612c0000 0 0x445>;  /* PDC FS0 regs */
+               interrupts = <GIC_SPI 187 IRQ_TYPE_LEVEL_HIGH>;
+               #mbox-cells = <1>;   /* one cell per mailbox channel */
+               brcm,rx-status-len = <32>;
+               brcm,use-bcm-hdr;
+       };