[RFC 2/6] mailbox: document bindings

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Courtney Cavin <courtney.cavin@xxxxxxxxxxxxxx>
---
 .../devicetree/bindings/mailbox/mailbox.txt        | 44 ++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/mailbox/mailbox.txt

diff --git a/Documentation/devicetree/bindings/mailbox/mailbox.txt b/Documentation/devicetree/bindings/mailbox/mailbox.txt
new file mode 100644
index 0000000..846eb49
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/mailbox.txt
@@ -0,0 +1,44 @@
+Binding documentation for mailbox providers and consumers
+--
+
+Mailbox providers may be represented by any node in a device tree.  These
+nodes are designated as mailbox providers.  Consumers can then use a phandle
+to a mailbox provider, along with channel specifier information in order to
+get a mailbox.
+
+MAILBOX PROVIDERS
+
+#mbox-cells:
+	Usage: required
+	Type: u32
+	Desc: Number of cells in a mailbox specifier; Typically 1 for nodes
+	      which only need a channel index.
+
+
+Example:
+	mailbox: mailbox {
+		#mbox-cells = <1>;
+		...
+	};
+
+
+MAILBOX CONSUMERS
+
+mbox:
+	Usage: required
+	Type: < [phandle] [mailbox-specifier] >
+	Desc: List of phandle and mailbox specifier pairs, matching provider's
+	      #mbox-cells property
+
+mbox-names:
+	Usage: optional
+	Type: string array
+	Desc: List of mailbox input name strings sorted in the same order as
+	      the mbox property.  Consumer drivers should use mbox-names
+	      to match mailbox input names with mailbox specifiers.
+
+Example:
+	consumer {
+		mbox-names = "comms";
+		mbox = <&mailbox 0>;
+	};
-- 
1.8.1.5

--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux