xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/mailbox/sti-mailbox.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunST Microelectronics Mailbox Driver
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunEach ST Mailbox IP currently consists of 4 instances of 32 channels.  Messages
4*4882a593Smuzhiyunare passed between Application and Remote processors using shared memory.
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunController
7*4882a593Smuzhiyun----------
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunRequired properties:
10*4882a593Smuzhiyun- compatible		: Should be "st,stih407-mailbox"
11*4882a593Smuzhiyun- reg			: Offset and length of the device's register set
12*4882a593Smuzhiyun- mbox-name		: Name of the mailbox
13*4882a593Smuzhiyun- #mbox-cells:		: Must be 2
14*4882a593Smuzhiyun			  <&phandle instance channel direction>
15*4882a593Smuzhiyun			    phandle   : Label name of controller
16*4882a593Smuzhiyun			    instance  : Instance number
17*4882a593Smuzhiyun			    channel   : Channel number
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunOptional properties
20*4882a593Smuzhiyun- interrupts		: Contains the IRQ line for a Rx mailbox
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunExample:
23*4882a593Smuzhiyun
24*4882a593Smuzhiyunmailbox0: mailbox@0  {
25*4882a593Smuzhiyun	compatible	= "st,stih407-mailbox";
26*4882a593Smuzhiyun	reg		= <0x08f00000 0x1000>;
27*4882a593Smuzhiyun	interrupts	= <GIC_SPI 1 IRQ_TYPE_NONE>;
28*4882a593Smuzhiyun	#mbox-cells	= <2>;
29*4882a593Smuzhiyun	mbox-name	= "a9";
30*4882a593Smuzhiyun};
31*4882a593Smuzhiyun
32*4882a593SmuzhiyunClient
33*4882a593Smuzhiyun------
34*4882a593Smuzhiyun
35*4882a593SmuzhiyunRequired properties:
36*4882a593Smuzhiyun- compatible		: Many (See the client docs)
37*4882a593Smuzhiyun- reg			: Shared (between Application and Remote) memory address
38*4882a593Smuzhiyun- mboxes		: Standard property to specify a Mailbox (See ./mailbox.txt)
39*4882a593Smuzhiyun			  Cells must match 'mbox-cells' (See Controller docs above)
40*4882a593Smuzhiyun
41*4882a593SmuzhiyunOptional properties
42*4882a593Smuzhiyun- mbox-names		: Name given to channels seen in the 'mboxes' property.
43*4882a593Smuzhiyun
44*4882a593SmuzhiyunExample:
45*4882a593Smuzhiyun
46*4882a593Smuzhiyunmailbox_test {
47*4882a593Smuzhiyun	compatible	= "mailbox-test";
48*4882a593Smuzhiyun	reg		= <0x[shared_memory_address], [shared_memory_size]>;
49*4882a593Smuzhiyun	mboxes		= <&mailbox2 0 1>, <&mailbox0 2 1>;
50*4882a593Smuzhiyun	mbox-names	= "tx",	"rx";
51*4882a593Smuzhiyun};
52