[v3,mailbox+firmware,6/6] dt-bindings: firmware: Document cznic, turris-mox-rwtm binding

Commit Message

Marek Behún March 15, 2019, 12:59 a.m. UTC

This adds device tree binding documentation for the driver communicating
with the rWTM firmware on Turris Mox.

Signed-off-by: Marek Behún <[e-mail]>
Cc: Rob Herring <[e-mail]>
Cc: [e-mail]
---
 .../firmware/cznic,turris-mox-rwtm.txt        | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/firmware/cznic,turris-mox-rwtm.txt

Comments

Rob Herring March 28, 2019, 5:49 p.m. UTC | #1

On Fri, 15 Mar 2019 01:59:26 +0100, =?UTF-8?q?Marek=20Beh=C3=BAn?= wrote:
> This adds device tree binding documentation for the driver communicating
> with the rWTM firmware on Turris Mox.
> 
> Signed-off-by: Marek Behún <[e-mail]>
> Cc: Rob Herring <[e-mail]>
> Cc: [e-mail]
> ---
>  .../firmware/cznic,turris-mox-rwtm.txt        | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/firmware/cznic,turris-mox-rwtm.txt
> 

Reviewed-by: Rob Herring <[e-mail]>

Patch

diff --git a/Documentation/devicetree/bindings/firmware/cznic,turris-mox-rwtm.txt b/Documentation/devicetree/bindings/firmware/cznic,turris-mox-rwtm.txt
new file mode 100644
index 000000000000..338169dea7bb
--- /dev/null
+++ b/Documentation/devicetree/bindings/firmware/cznic,turris-mox-rwtm.txt
@@ -0,0 +1,19 @@ 
+Turris Mox rWTM firmware driver
+
+Required properties:
+ - compatible		: Should be "cznic,turris-mox-rwtm"
+ - mboxes		: Must contain a reference to associated mailbox
+
+This device tree node should be used on Turris Mox, or potentially another A3700
+compatible device running the Mox's rWTM firmware in the secure processor (for
+example it is possible to flash this firmware into EspressoBin).
+
+Example:
+
+	firmware {
+		turris-mox-rwtm {
+			compatible = "cznic,turris-mox-rwtm";
+			mboxes = <&rwtm 0>;
+			status = "okay";
+		};
+	};