Merge tag 'tegra-for-4.8-i2c' of git://git.kernel.org/pub/scm/linux/kernel/git/tegra...
[cascardo/linux.git] / Documentation / devicetree / bindings / mailbox / meson-mhu.txt
1 Amlogic Meson MHU Mailbox Driver
2 ================================
3
4 The Amlogic's Meson SoCs Message-Handling-Unit (MHU) is a mailbox controller
5 that has 3 independent channels/links to communicate with remote processor(s).
6 MHU links are hardwired on a platform. A link raises interrupt for any
7 received data. However, there is no specified way of knowing if the sent
8 data has been read by the remote. This driver assumes the sender polls
9 STAT register and the remote clears it after having read the data.
10
11 Mailbox Device Node:
12 ====================
13
14 Required properties:
15 --------------------
16 - compatible:           Shall be "amlogic,meson-gxbb-mhu"
17 - reg:                  Contains the mailbox register address range (base
18                         address and length)
19 - #mbox-cells           Shall be 1 - the index of the channel needed.
20 - interrupts:           Contains the interrupt information corresponding to
21                         each of the 2 links of MHU.
22
23 Example:
24 --------
25
26         mailbox: mailbox@c883c404 {
27                 #mbox-cells = <1>;
28                 compatible = "amlogic,meson-gxbb-mhu";
29                 reg = <0 0xc883c404 0 0x4c>;
30                 interrupts = <0 208 IRQ_TYPE_EDGE_RISING>,
31                              <0 209 IRQ_TYPE_EDGE_RISING>,
32                              <0 210 IRQ_TYPE_EDGE_RISING>;
33                 #mbox-cells = <1>;
34         };