diff mbox series

dt-bindings: auxdisplay: img-ascii-lcd: Convert to json-schema

Message ID 6e74aa466d39ddc9abe502e054d04e8cc7b76b40.1627402094.git.geert@linux-m68k.org (mailing list archive)
State Not Applicable
Headers show
Series dt-bindings: auxdisplay: img-ascii-lcd: Convert to json-schema | expand

Commit Message

Geert Uytterhoeven July 27, 2021, 4:10 p.m. UTC 
Convert the Device Tree binding documentation for ASCII LCD displays on
Imagination Technologies boards to json-schema.

Drop bogus regmap property.
Add example.

Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org>
---
 .../bindings/auxdisplay/img,ascii-lcd.yaml    | 54 +++++++++++++++++++
 .../bindings/auxdisplay/img-ascii-lcd.txt     | 17 ------
 MAINTAINERS                                   |  2 +-
 3 files changed, 55 insertions(+), 18 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/auxdisplay/img,ascii-lcd.yaml
 delete mode 100644 Documentation/devicetree/bindings/auxdisplay/img-ascii-lcd.txt

Comments

Rob Herring (Arm) Aug. 2, 2021, 8:52 p.m. UTC | #1 
On Tue, 27 Jul 2021 18:10:34 +0200, Geert Uytterhoeven wrote:
> Convert the Device Tree binding documentation for ASCII LCD displays on
> Imagination Technologies boards to json-schema.
> 
> Drop bogus regmap property.
> Add example.
> 
> Signed-off-by: Geert Uytterhoeven <geert@linux-m68k.org>
> ---
>  .../bindings/auxdisplay/img,ascii-lcd.yaml    | 54 +++++++++++++++++++
>  .../bindings/auxdisplay/img-ascii-lcd.txt     | 17 ------
>  MAINTAINERS                                   |  2 +-
>  3 files changed, 55 insertions(+), 18 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/auxdisplay/img,ascii-lcd.yaml
>  delete mode 100644 Documentation/devicetree/bindings/auxdisplay/img-ascii-lcd.txt
> 

Added a type to 'offset' and applied, thanks!
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/auxdisplay/img,ascii-lcd.yaml b/Documentation/devicetree/bindings/auxdisplay/img,ascii-lcd.yaml
new file mode 100644
index 0000000000000000..66e54f12f40f2f78
--- /dev/null
+++ b/Documentation/devicetree/bindings/auxdisplay/img,ascii-lcd.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/auxdisplay/img,ascii-lcd.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ASCII LCD displays on Imagination Technologies boards
+
+maintainers:
+  - Paul Burton <paulburton@kernel.org>
+
+properties:
+  compatible:
+    enum:
+      - img,boston-lcd
+      - mti,malta-lcd
+      - mti,sead3-lcd
+
+  reg:
+    maxItems: 1
+
+  offset:
+    description:
+      Offset in bytes to the LCD registers within the system controller
+
+required:
+  - compatible
+
+oneOf:
+  - required:
+      - reg
+  - required:
+      - offset
+
+if:
+  properties:
+    compatible:
+      contains:
+        const: img,boston-lcd
+then:
+  required:
+    - reg
+else:
+  required:
+    - offset
+
+additionalProperties: false
+
+examples:
+  - |
+    lcd: lcd@17fff000 {
+            compatible = "img,boston-lcd";
+            reg = <0x17fff000 0x8>;
+    };
diff --git a/Documentation/devicetree/bindings/auxdisplay/img-ascii-lcd.txt b/Documentation/devicetree/bindings/auxdisplay/img-ascii-lcd.txt
deleted file mode 100644
index b69bb68992fdf2a7..0000000000000000
--- a/Documentation/devicetree/bindings/auxdisplay/img-ascii-lcd.txt
+++ /dev/null
@@ -1,17 +0,0 @@ 
-Binding for ASCII LCD displays on Imagination Technologies boards
-
-Required properties:
-- compatible : should be one of:
-    "img,boston-lcd"
-    "mti,malta-lcd"
-    "mti,sead3-lcd"
-
-Required properties for "img,boston-lcd":
-- reg : memory region locating the device registers
-
-Required properties for "mti,malta-lcd" or "mti,sead3-lcd":
-- regmap: phandle of the system controller containing the LCD registers
-- offset: offset in bytes to the LCD registers within the system controller
-
-The layout of the registers & properties of the display are determined
-from the compatible string, making this binding somewhat trivial.
diff --git a/MAINTAINERS b/MAINTAINERS
index 7c2ca9c3809f0104..a8afc9238fd8e164 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9063,7 +9063,7 @@  F:	drivers/usb/atm/ueagle-atm.c
 IMGTEC ASCII LCD DRIVER
 M:	Paul Burton <paulburton@kernel.org>
 S:	Maintained
-F:	Documentation/devicetree/bindings/auxdisplay/img-ascii-lcd.txt
+F:	Documentation/devicetree/bindings/auxdisplay/img,ascii-lcd.yaml
 F:	drivers/auxdisplay/img-ascii-lcd.c
 
 IMGTEC IR DECODER DRIVER