[deliverable/linux.git] / Documentation / devicetree / bindings / mailbox / mailbox.txt

* 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.

Example:
	pwr_cntrl: power {
		...
		mbox-names = "pwr-ctrl", "rpc";
		mboxes = <&mailbox 0 &mailbox 1>;
	};
Commit	Line	Data
9f3e3cac JB	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:
07a7dba1	25	- mbox-names: List of identifier strings for each mailbox channel.
9f3e3cac JB	26
	27	Example:
	28	pwr_cntrl: power {
	29	...
	30	mbox-names = "pwr-ctrl", "rpc";
07a7dba1	31	mboxes = <&mailbox 0 &mailbox 1>;
9f3e3cac	32	};