Merge tag 'ntb-4.8' of git://github.com/jonmason/ntb
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / mailbox / brcm,iproc-pdc-mbox.txt
1 The PDC driver manages data transfer to and from various offload engines
2 on some Broadcom SoCs. An SoC may have multiple PDC hardware blocks. There is
3 one device tree entry per block.
4
5 Required properties:
6 - compatible : Should be "brcm,iproc-pdc-mbox".
7 - reg: Should contain PDC registers location and length.
8 - interrupts: Should contain the IRQ line for the PDC.
9 - #mbox-cells: 1
10 - brcm,rx-status-len: Length of metadata preceding received frames, in bytes.
11
12 Optional properties:
13 - brcm,use-bcm-hdr:  present if a BCM header precedes each frame.
14
15 Example:
16         pdc0: iproc-pdc0@0x612c0000 {
17                 compatible = "brcm,iproc-pdc-mbox";
18                 reg = <0 0x612c0000 0 0x445>;  /* PDC FS0 regs */
19                 interrupts = <GIC_SPI 187 IRQ_TYPE_LEVEL_HIGH>;
20                 #mbox-cells = <1>;   /* one cell per mailbox channel */
21                 brcm,rx-status-len = <32>;
22                 brcm,use-bcm-hdr;
23         };