Merge remote-tracking branch 'drm/drm-next' into drm-misc-next
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / mailbox / hisilicon,hi3660-mailbox.txt
1 Hisilicon Hi3660 Mailbox Controller
2
3 Hisilicon Hi3660 mailbox controller supports up to 32 channels.  Messages
4 are passed between processors, including application & communication
5 processors, MCU, HIFI, etc.  Each channel is unidirectional and accessed
6 by using MMIO registers; it supports maximum to 8 words message.
7
8 Controller
9 ----------
10
11 Required properties:
12 - compatible:           : Shall be "hisilicon,hi3660-mbox"
13 - reg:                  : Offset and length of the device's register set
14 - #mbox-cells:          : Must be 3
15                           <&phandle channel dst_irq ack_irq>
16                             phandle     : Label name of controller
17                             channel     : Channel number
18                             dst_irq     : Remote interrupt vector
19                             ack_irq     : Local interrupt vector
20
21 - interrupts:           : Contains the two IRQ lines for mailbox.
22
23 Example:
24
25 mailbox: mailbox@e896b000 {
26         compatible = "hisilicon,hi3660-mbox";
27         reg = <0x0 0xe896b000 0x0 0x1000>;
28         interrupts = <0x0 0xc0 0x4>,
29                      <0x0 0xc1 0x4>;
30         #mbox-cells = <3>;
31 };
32
33 Client
34 ------
35
36 Required properties:
37 - compatible            : See the client docs
38 - mboxes                : Standard property to specify a Mailbox (See ./mailbox.txt)
39                           Cells must match 'mbox-cells' (See Controller docs above)
40
41 Optional properties
42 - mbox-names            : Name given to channels seen in the 'mboxes' property.
43
44 Example:
45
46 stub_clock: stub_clock@e896b500 {
47         compatible = "hisilicon,hi3660-stub-clk";
48         reg = <0x0 0xe896b500 0x0 0x0100>;
49         #clock-cells = <1>;
50         mboxes = <&mailbox 13 3 0>;
51 };