diff mbox series

dt-bindings: misc: Convert olpc,xo1.75-ec to json-schema

Message ID 20200718211244.187938-1-lkundrak@v3.sk
State Accepted, archived
Headers show
Series dt-bindings: misc: Convert olpc,xo1.75-ec to json-schema | expand

Checks

Context Check Description
robh/checkpatch warning total: 0 errors, 2 warnings, 52 lines checked

Commit Message

Lubomir Rintel July 18, 2020, 9:12 p.m. UTC 
Convert the OLPC XO-1.75 Embedded Controller binding to DT schema format
using json-schema.

Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
---
Hi,

please consider enqueueing this patch for 5.9. It is a straightforward
conversion of the olpc,xo1.75-ec binding doc to YAML.

It applies on top of v5.8-rc4 (where a fix into olpc,xo1.75-ec.txt
landed).

Thanks
Lubo

 .../bindings/misc/olpc,xo1.75-ec.txt          | 23 --------
 .../bindings/misc/olpc,xo1.75-ec.yaml         | 52 +++++++++++++++++++
 2 files changed, 52 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt
 create mode 100644 Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.yaml

Comments

Rob Herring July 23, 2020, 9:08 p.m. UTC | #1 
On Sat, 18 Jul 2020 23:12:44 +0200, Lubomir Rintel wrote:
> Convert the OLPC XO-1.75 Embedded Controller binding to DT schema format
> using json-schema.
> 
> Signed-off-by: Lubomir Rintel <lkundrak@v3.sk>
> ---
> Hi,
> 
> please consider enqueueing this patch for 5.9. It is a straightforward
> conversion of the olpc,xo1.75-ec binding doc to YAML.
> 
> It applies on top of v5.8-rc4 (where a fix into olpc,xo1.75-ec.txt
> landed).
> 
> Thanks
> Lubo
> 
>  .../bindings/misc/olpc,xo1.75-ec.txt          | 23 --------
>  .../bindings/misc/olpc,xo1.75-ec.yaml         | 52 +++++++++++++++++++
>  2 files changed, 52 insertions(+), 23 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt
>  create mode 100644 Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.yaml
> 

Applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt b/Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt
deleted file mode 100644
index 2d7cdf19a0d0f..0000000000000
--- a/Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.txt
+++ /dev/null
@@ -1,23 +0,0 @@ 
-OLPC XO-1.75 Embedded Controller
-
-Required properties:
-- compatible: Should be "olpc,xo1.75-ec".
-- cmd-gpios: gpio specifier of the CMD pin
-
-The embedded controller requires the SPI controller driver to signal readiness
-to receive a transfer (that is, when TX FIFO contains the response data) by
-strobing the ACK pin with the ready signal. See the "ready-gpios" property of the
-SSP binding as documented in:
-<Documentation/devicetree/bindings/spi/marvell,mmp2-ssp.yaml>.
-
-Example:
-	&ssp3 {
-		spi-slave;
-		ready-gpios = <&gpio 125 GPIO_ACTIVE_HIGH>;
-
-		slave {
-			compatible = "olpc,xo1.75-ec";
-			spi-cpha;
-			cmd-gpios = <&gpio 155 GPIO_ACTIVE_HIGH>;
-		};
-	};
diff --git a/Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.yaml b/Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.yaml
new file mode 100644
index 0000000000000..e75d77beec6a3
--- /dev/null
+++ b/Documentation/devicetree/bindings/misc/olpc,xo1.75-ec.yaml
@@ -0,0 +1,52 @@ 
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+# Copyright (C) 2019,2020 Lubomir Rintel <lkundrak@v3.sk>
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/misc/olpc,xo1.75-ec.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: OLPC XO-1.75 Embedded Controller bindings
+
+description: |
+  This binding describes the Embedded Controller acting as a SPI bus master
+  on a OLPC XO-1.75 laptop computer.
+
+  The embedded controller requires the SPI controller driver to signal
+  readiness to receive a transfer (that is, when TX FIFO contains the
+  response data) by strobing the ACK pin with the ready signal. See the
+  "ready-gpios" property of the SSP binding as documented in:
+  <Documentation/devicetree/bindings/spi/marvell,mmp2-ssp.yaml>.
+
+maintainers:
+  - Lubomir Rintel <lkundrak@v3.sk>
+
+properties:
+  compatible:
+    const: olpc,xo1.75-ec
+
+  cmd-gpios:
+    description: GPIO uspecifier of the CMD pin
+    maxItems: 1
+
+required:
+  - compatible
+  - cmd-gpios
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    spi {
+      spi-slave;
+      ready-gpios = <&gpio 125 GPIO_ACTIVE_HIGH>;
+
+      slave {
+        compatible = "olpc,xo1.75-ec";
+        spi-cpha;
+        cmd-gpios = <&gpio 155 GPIO_ACTIVE_HIGH>;
+      };
+    };
+
+...