diff mbox series

dt-bindings: gpio: fairchild,74hc595: Convert to json-schema

Message ID df145e77bd124721f28cbc58fb3c58c138f13d86.1617365710.git.geert+renesas@glider.be
State Accepted
Commit 56b01acc1c79a4fc70d575ed7861f26a0d5d43ea
Headers show
Series dt-bindings: gpio: fairchild,74hc595: Convert to json-schema | expand

Commit Message

Geert Uytterhoeven April 2, 2021, 12:19 p.m. UTC 
Convert the Generic 8-bit shift register Device Tree binding
documentation to json-schema.

Rename from gpio-74x164 to fairchild,74hc595, as the former refers to
the Linux driver, and not to a hardware name.
Add the missing hog description.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
The original file did not contain license information, so I used the
most popular/recommended one for DT bindings.
I listed the original author of the bindings as maintainer.
---
 .../bindings/gpio/fairchild,74hc595.yaml      | 77 +++++++++++++++++++
 .../devicetree/bindings/gpio/gpio-74x164.txt  | 27 -------
 2 files changed, 77 insertions(+), 27 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml
 delete mode 100644 Documentation/devicetree/bindings/gpio/gpio-74x164.txt

Comments

Rob Herring April 9, 2021, 2:53 p.m. UTC | #1 
On Fri, 02 Apr 2021 14:19:58 +0200, Geert Uytterhoeven wrote:
> Convert the Generic 8-bit shift register Device Tree binding
> documentation to json-schema.
> 
> Rename from gpio-74x164 to fairchild,74hc595, as the former refers to
> the Linux driver, and not to a hardware name.
> Add the missing hog description.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
> The original file did not contain license information, so I used the
> most popular/recommended one for DT bindings.
> I listed the original author of the bindings as maintainer.
> ---
>  .../bindings/gpio/fairchild,74hc595.yaml      | 77 +++++++++++++++++++
>  .../devicetree/bindings/gpio/gpio-74x164.txt  | 27 -------
>  2 files changed, 77 insertions(+), 27 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml
>  delete mode 100644 Documentation/devicetree/bindings/gpio/gpio-74x164.txt
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Bartosz Golaszewski April 11, 2021, 12:59 p.m. UTC | #2 
On Fri, Apr 2, 2021 at 2:20 PM Geert Uytterhoeven
<geert+renesas@glider.be> wrote:
>
> Convert the Generic 8-bit shift register Device Tree binding
> documentation to json-schema.
>
> Rename from gpio-74x164 to fairchild,74hc595, as the former refers to
> the Linux driver, and not to a hardware name.
> Add the missing hog description.
>
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---

Patch applied, thanks!

Bartosz
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml b/Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml
new file mode 100644
index 0000000000000000..5fe19fa5f67c551f
--- /dev/null
+++ b/Documentation/devicetree/bindings/gpio/fairchild,74hc595.yaml
@@ -0,0 +1,77 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/gpio/fairchild,74hc595.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Generic 8-bit shift register
+
+maintainers:
+  - Maxime Ripard <mripard@kernel.org>
+
+properties:
+  compatible:
+    enum:
+      - fairchild,74hc595
+      - nxp,74lvc594
+
+  reg:
+    maxItems: 1
+
+  gpio-controller: true
+
+  '#gpio-cells':
+    description:
+      The second cell is only used to specify the GPIO polarity.
+    const: 2
+
+  registers-number:
+    description: Number of daisy-chained shift registers
+
+  enable-gpios:
+    description: GPIO connected to the OE (Output Enable) pin.
+    maxItems: 1
+
+  spi-max-frequency: true
+
+patternProperties:
+  "^(hog-[0-9]+|.+-hog(-[0-9]+)?)$":
+    type: object
+
+    properties:
+      gpio-hog: true
+      gpios: true
+      output-high: true
+      output-low: true
+      line-name: true
+
+    required:
+      - gpio-hog
+      - gpios
+
+    additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - gpio-controller
+  - '#gpio-cells'
+  - registers-number
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            gpio5: gpio5@0 {
+                    compatible = "fairchild,74hc595";
+                    reg = <0>;
+                    gpio-controller;
+                    #gpio-cells = <2>;
+                    registers-number = <4>;
+                    spi-max-frequency = <100000>;
+            };
+    };
diff --git a/Documentation/devicetree/bindings/gpio/gpio-74x164.txt b/Documentation/devicetree/bindings/gpio/gpio-74x164.txt
deleted file mode 100644
index 2a97553d8d76d9f5..0000000000000000
--- a/Documentation/devicetree/bindings/gpio/gpio-74x164.txt
+++ /dev/null
@@ -1,27 +0,0 @@ 
-* Generic 8-bits shift register GPIO driver
-
-Required properties:
-- compatible: Should contain one of the following:
-    "fairchild,74hc595"
-    "nxp,74lvc594"
-- reg : chip select number
-- gpio-controller : Marks the device node as a gpio controller.
-- #gpio-cells : Should be two.  The first cell is the pin number and
-  the second cell is used to specify the gpio polarity:
-      0 = active high
-      1 = active low
-- registers-number: Number of daisy-chained shift registers
-
-Optional properties:
-- enable-gpios: GPIO connected to the OE (Output Enable) pin.
-
-Example:
-
-gpio5: gpio5@0 {
-	compatible = "fairchild,74hc595";
-	reg = <0>;
-	gpio-controller;
-	#gpio-cells = <2>;
-	registers-number = <4>;
-	spi-max-frequency = <100000>;
-};