Merge tag 'sound-3.18-rc2' of git://git.kernel.org/pub/scm/linux/kernel/git/tiwai...
[sfrench/cifs-2.6.git] / Documentation / devicetree / bindings / mailbox / mailbox.txt
1 * Generic Mailbox Controller and client driver bindings
2
3 Generic binding to provide a way for Mailbox controller drivers to
4 assign appropriate mailbox channel to client drivers.
5
6 * Mailbox Controller
7
8 Required property:
9 - #mbox-cells: Must be at least 1. Number of cells in a mailbox
10                 specifier.
11
12 Example:
13         mailbox: mailbox {
14                 ...
15                 #mbox-cells = <1>;
16         };
17
18
19 * Mailbox Client
20
21 Required property:
22 - mboxes: List of phandle and mailbox channel specifiers.
23
24 Optional property:
25 - mbox-names: List of identifier strings for each mailbox channel
26                 required by the client. The use of this property
27                 is discouraged in favor of using index in list of
28                 'mboxes' while requesting a mailbox. Instead the
29                 platforms may define channel indices, in DT headers,
30                 to something legible.
31
32 Example:
33         pwr_cntrl: power {
34                 ...
35                 mbox-names = "pwr-ctrl", "rpc";
36                 mboxes = <&mailbox 0
37                         &mailbox 1>;
38         };