diff options
Diffstat (limited to 'Documentation/devicetree/bindings/mailbox/omap-mailbox.txt')
-rw-r--r-- | Documentation/devicetree/bindings/mailbox/omap-mailbox.txt | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/mailbox/omap-mailbox.txt b/Documentation/devicetree/bindings/mailbox/omap-mailbox.txt index 48edc4b92afb..d1a043339c11 100644 --- a/Documentation/devicetree/bindings/mailbox/omap-mailbox.txt +++ b/Documentation/devicetree/bindings/mailbox/omap-mailbox.txt | |||
@@ -43,6 +43,9 @@ Required properties: | |||
43 | device. The format is dependent on which interrupt | 43 | device. The format is dependent on which interrupt |
44 | controller the OMAP device uses | 44 | controller the OMAP device uses |
45 | - ti,hwmods: Name of the hwmod associated with the mailbox | 45 | - ti,hwmods: Name of the hwmod associated with the mailbox |
46 | - #mbox-cells: Common mailbox binding property to identify the number | ||
47 | of cells required for the mailbox specifier. Should be | ||
48 | 1 | ||
46 | - ti,mbox-num-users: Number of targets (processor devices) that the mailbox | 49 | - ti,mbox-num-users: Number of targets (processor devices) that the mailbox |
47 | device can interrupt | 50 | device can interrupt |
48 | - ti,mbox-num-fifos: Number of h/w fifo queues within the mailbox IP block | 51 | - ti,mbox-num-fifos: Number of h/w fifo queues within the mailbox IP block |
@@ -72,6 +75,18 @@ data that represent the following: | |||
72 | Cell #3 (usr_id) - mailbox user id for identifying the interrupt line | 75 | Cell #3 (usr_id) - mailbox user id for identifying the interrupt line |
73 | associated with generating a tx/rx fifo interrupt. | 76 | associated with generating a tx/rx fifo interrupt. |
74 | 77 | ||
78 | Mailbox Users: | ||
79 | ============== | ||
80 | A device needing to communicate with a target processor device should specify | ||
81 | them using the common mailbox binding properties, "mboxes" and the optional | ||
82 | "mbox-names" (please see Documentation/devicetree/bindings/mailbox/mailbox.txt | ||
83 | for details). Each value of the mboxes property should contain a phandle to the | ||
84 | mailbox controller device node and an args specifier that will be the phandle to | ||
85 | the intended sub-mailbox child node to be used for communication. The equivalent | ||
86 | "mbox-names" property value can be used to give a name to the communication channel | ||
87 | to be used by the client user. | ||
88 | |||
89 | |||
75 | Example: | 90 | Example: |
76 | -------- | 91 | -------- |
77 | 92 | ||
@@ -81,6 +96,7 @@ mailbox: mailbox@4a0f4000 { | |||
81 | reg = <0x4a0f4000 0x200>; | 96 | reg = <0x4a0f4000 0x200>; |
82 | interrupts = <GIC_SPI 26 IRQ_TYPE_LEVEL_HIGH>; | 97 | interrupts = <GIC_SPI 26 IRQ_TYPE_LEVEL_HIGH>; |
83 | ti,hwmods = "mailbox"; | 98 | ti,hwmods = "mailbox"; |
99 | #mbox-cells = <1>; | ||
84 | ti,mbox-num-users = <3>; | 100 | ti,mbox-num-users = <3>; |
85 | ti,mbox-num-fifos = <8>; | 101 | ti,mbox-num-fifos = <8>; |
86 | mbox_ipu: mbox_ipu { | 102 | mbox_ipu: mbox_ipu { |
@@ -93,12 +109,19 @@ mailbox: mailbox@4a0f4000 { | |||
93 | }; | 109 | }; |
94 | }; | 110 | }; |
95 | 111 | ||
112 | dsp { | ||
113 | ... | ||
114 | mboxes = <&mailbox &mbox_dsp>; | ||
115 | ... | ||
116 | }; | ||
117 | |||
96 | /* AM33xx */ | 118 | /* AM33xx */ |
97 | mailbox: mailbox@480C8000 { | 119 | mailbox: mailbox@480C8000 { |
98 | compatible = "ti,omap4-mailbox"; | 120 | compatible = "ti,omap4-mailbox"; |
99 | reg = <0x480C8000 0x200>; | 121 | reg = <0x480C8000 0x200>; |
100 | interrupts = <77>; | 122 | interrupts = <77>; |
101 | ti,hwmods = "mailbox"; | 123 | ti,hwmods = "mailbox"; |
124 | #mbox-cells = <1>; | ||
102 | ti,mbox-num-users = <4>; | 125 | ti,mbox-num-users = <4>; |
103 | ti,mbox-num-fifos = <8>; | 126 | ti,mbox-num-fifos = <8>; |
104 | mbox_wkupm3: wkup_m3 { | 127 | mbox_wkupm3: wkup_m3 { |