xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/mailbox/hisilicon,hi3660-mailbox.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593SmuzhiyunHisilicon Hi3660 Mailbox Controller
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunHisilicon Hi3660 mailbox controller supports up to 32 channels.  Messages
4*4882a593Smuzhiyunare passed between processors, including application & communication
5*4882a593Smuzhiyunprocessors, MCU, HIFI, etc.  Each channel is unidirectional and accessed
6*4882a593Smuzhiyunby using MMIO registers; it supports maximum to 8 words message.
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunController
9*4882a593Smuzhiyun----------
10*4882a593Smuzhiyun
11*4882a593SmuzhiyunRequired properties:
12*4882a593Smuzhiyun- compatible:		: Shall be "hisilicon,hi3660-mbox"
13*4882a593Smuzhiyun- reg:			: Offset and length of the device's register set
14*4882a593Smuzhiyun- #mbox-cells:		: Must be 3
15*4882a593Smuzhiyun			  <&phandle channel dst_irq ack_irq>
16*4882a593Smuzhiyun			    phandle	: Label name of controller
17*4882a593Smuzhiyun			    channel	: Channel number
18*4882a593Smuzhiyun			    dst_irq	: Remote interrupt vector
19*4882a593Smuzhiyun			    ack_irq	: Local interrupt vector
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun- interrupts:		: Contains the two IRQ lines for mailbox.
22*4882a593Smuzhiyun
23*4882a593SmuzhiyunExample:
24*4882a593Smuzhiyun
25*4882a593Smuzhiyunmailbox: mailbox@e896b000 {
26*4882a593Smuzhiyun	compatible = "hisilicon,hi3660-mbox";
27*4882a593Smuzhiyun	reg = <0x0 0xe896b000 0x0 0x1000>;
28*4882a593Smuzhiyun	interrupts = <0x0 0xc0 0x4>,
29*4882a593Smuzhiyun		     <0x0 0xc1 0x4>;
30*4882a593Smuzhiyun	#mbox-cells = <3>;
31*4882a593Smuzhiyun};
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunClient
34*4882a593Smuzhiyun------
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunRequired properties:
37*4882a593Smuzhiyun- compatible		: See the client docs
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*4882a593Smuzhiyunstub_clock: stub_clock@e896b500 {
47*4882a593Smuzhiyun	compatible = "hisilicon,hi3660-stub-clk";
48*4882a593Smuzhiyun	reg = <0x0 0xe896b500 0x0 0x0100>;
49*4882a593Smuzhiyun	#clock-cells = <1>;
50*4882a593Smuzhiyun	mboxes = <&mailbox 13 3 0>;
51*4882a593Smuzhiyun};
52