[PATCHv5 1/2] dts: Adding docs for Xilinx LogiCORE IP mailbox driver.

From: Moritz Fischer
Date: Tue Jun 23 2015 - 14:00:59 EST


Changes from v4:
- Changed mbox cells property from 1 to 0
- Fixed interrupt property

Changes from v3:
- Changed reg size to 0x100

Changes from v2:
- Addressed Michal's stylistic comments
- Fixed typo in compatible string

Changes from v1:
- Added common clock framework support

Changes from v0:
- Fixed example bindings

Signed-off-by: Moritz Fischer <moritz.fischer@xxxxxxxxx>
Acked-by: Michal Simek <michal.simek@xxxxxxxxxx>
---
.../devicetree/bindings/mailbox/xilinx-mailbox.txt | 44 ++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt

diff --git a/Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt b/Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt
new file mode 100644
index 0000000..269c026
--- /dev/null
+++ b/Documentation/devicetree/bindings/mailbox/xilinx-mailbox.txt
@@ -0,0 +1,44 @@
+Xilinx Mailbox Driver
+=====================
+
+Required properties:
+- compatible : "xlnx,mailbox-2.1".
+- reg : physical base address of the mailbox and length of
+ memory mapped region.
+- #mbox-cells : common mailbox binding property to identify the number
+ of cells required for the mailbox specifier, should be 1
+- clocks : phandle to clock provider
+- clock-names : must be 'mbox'
+
+Optional properties:
+- interrupt-parent : interrupt source phandle
+- interrupts : interrupt number, The interrupt specifier format
+ depends on the interrupt controller parent.
+
+Example:
+ mbox: mailbox@40400000 {
+ compatible = "xlnx,mailbox-2.1";
+ reg = <0x40400000 0x100>;
+ interrupt-parent = <&intc>;
+ interrupts = <0 32 1>;
+ #mbox-cells = <0>;
+ clocks = <&clkc 15>;
+ clock-names = "mbox";
+ };
+
+Mailbox client
+===============
+"mboxes" and the optional "mbox-names" (please see
+Documentation/devicetree/bindings/mailbox/mailbox.txt for details). Each value
+of the mboxes property should contain a phandle to the mailbox controller
+device node and second argument is the channel index. It must be 0 (hardware
+support only one channel). The equivalent "mbox-names" property value can be
+used to give a name to the communication channel to be used by the client user.
+
+Example:
+ mclient0: mclient0@400 {
+ compatible = "client-1.0";
+ reg = <0x400 0x10>;
+ mbox-names = "mbox";
+ mboxes = <&mbox 0>;
+ };
--
2.4.2

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