GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / mailbox / xgene-slimpro-mailbox.txt
1 The APM X-Gene SLIMpro mailbox is used to communicate messages between
2 the ARM64 processors and the Cortex M3 (dubbed SLIMpro). It uses a simple
3 interrupt based door bell mechanism and can exchange simple messages using the
4 internal registers.
5
6 There are total of 8 interrupts in this mailbox. Each used for an individual
7 door bell (or mailbox channel).
8
9 Required properties:
10 - compatible:   Should be as "apm,xgene-slimpro-mbox".
11
12 - reg:          Contains the mailbox register address range.
13
14 - interrupts:   8 interrupts must be from 0 to 7, interrupt 0 define the
15                 the interrupt for mailbox channel 0 and interrupt 1 for
16                 mailbox channel 1 and so likewise for the reminder.
17
18 - #mbox-cells:  only one to specify the mailbox channel number.
19
20 Example:
21
22 Mailbox Node:
23                 mailbox: mailbox@10540000 {
24                         compatible = "apm,xgene-slimpro-mbox";
25                         reg = <0x0 0x10540000 0x0 0xa000>;
26                         #mbox-cells = <1>;
27                         interrupts =    <0x0 0x0 0x4>,
28                                         <0x0 0x1 0x4>,
29                                         <0x0 0x2 0x4>,
30                                         <0x0 0x3 0x4>,
31                                         <0x0 0x4 0x4>,
32                                         <0x0 0x5 0x4>,
33                                         <0x0 0x6 0x4>,
34                                         <0x0 0x7 0x4>,
35                 };