summaryrefslogtreecommitdiffstats
path: root/Documentation/devicetree/bindings/mailbox/mailbox.txt
blob: 1a2cd3d266db0b59a5709bccecef737f9aadf139 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
* Generic Mailbox Controller and client driver bindings

Generic binding to provide a way for Mailbox controller drivers to
assign appropriate mailbox channel to client drivers.

* Mailbox Controller

Required property:
- #mbox-cells: Must be at least 1. Number of cells in a mailbox
		specifier.

Example:
	mailbox: mailbox {
		...
		#mbox-cells = <1>;
	};


* Mailbox Client

Required property:
- mboxes: List of phandle and mailbox channel specifiers.

Optional property:
- mbox-names: List of identifier strings for each mailbox channel
		required by the client. The use of this property
		is discouraged in favor of using index in list of
		'mboxes' while requesting a mailbox. Instead the
		platforms may define channel indices, in DT headers,
		to something legible.

Example:
	pwr_cntrl: power {
		...
		mbox-names = "pwr-ctrl", "rpc";
		mboxes = <&mailbox 0
			&mailbox 1>;
	};