aboutsummaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/mailbox/mailbox.txt
diff options
context:
space:
mode:
authorJassi Brar <jaswinder.singh@linaro.org>2014-06-12 22:31:54 +0530
committerShow Liu <show.liu@linaro.org>2014-06-18 12:05:34 +0800
commitf33c8f5e363b2edbdb9ba359355b34688cd069cb (patch)
treef01e7f9eb20afa6843b2985e6a90ddd84c5e4133 /Documentation/devicetree/bindings/mailbox/mailbox.txt
parent58940f09032fdf5b546bb88f20bf32336a5630e5 (diff)
downloadlinaro-lsk-f33c8f5e363b2edbdb9ba359355b34688cd069cb.tar.gz
Mailbox: Generic: Specify mailbox api bindings
Due to the platform specific nature of remote's firmware, we can't do much to facilitate shareable client drivers. So the Mailbox api is more like a bunch of useful functions put together. The only feature that can be abstracted out is mailbox channel assignment to client drivers, which this binding specifies. Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org> Signed-off-by: Mark Brown <broonie@linaro.org>
Diffstat (limited to 'Documentation/devicetree/bindings/mailbox/mailbox.txt')
-rw-r--r--Documentation/devicetree/bindings/mailbox/mailbox.txt33
1 files changed, 33 insertions, 0 deletions
diff --git a/Documentation/devicetree/bindings/mailbox/mailbox.txt b/Documentation/devicetree/bindings/mailbox/mailbox.txt
new file mode 100644
index 00000000000..3f009555f39
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/mailbox.txt
@@ -0,0 +1,33 @@
+* 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:
+- mbox: List of phandle and mailbox channel specifier.
+
+- mbox-names: List of identifier strings for each mailbox channel
+ required by the client.
+
+Example:
+ pwr_cntrl: power {
+ ...
+ mbox-names = "pwr-ctrl", "rpc";
+ mbox = <&mailbox 0
+ &mailbox 1>;
+ };