Skip to contentSkip to conversation

dt-bindings: clock: gpio-gate-clock: Convert to json-schema

PATCH Applied Conor Dooley 3 participants 4 messages Jul 27, 2022 – Aug 22, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 dt-bindings: clock: gpio-gate-clock: Convert to json-schema

Convert the simple GPIO clock gate Device Tree binding to json-schema and fix-up references to this file in other text format bindings. Jyri Sarha is the file's only editor/author so they have been added as maintainer of the new yaml binding.

---
The original file does not specifiy dual licensing, but when Geert did the gpio-mux-clock conversion the yaml binding was created with dual, so I have done the same thing here.

---
 .../bindings/clock/gpio-gate-clock.txt        | 21 ----------
 .../bindings/clock/gpio-gate-clock.yaml       | 42 +++++++++++++++++++
 .../devicetree/bindings/clock/ti/gate.txt     |  2 +-
 .../bindings/clock/ti/interface.txt           |  2 +-
 4 files changed, 44 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
 create mode 100644 Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
Documentation/devicetree/bindings/clock/gpio-gate-clock.txt deleted +0 -21
deleted file mode 100644
index d3379ff9b84b..000000000000
@@ -1,21 +0,0 @@
-Binding for simple gpio gated clock.
-
-This binding uses the common clock binding[1].
-
-[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
-
-Required properties:
-- compatible : shall be "gpio-gate-clock".
-- #clock-cells : from common clock binding; shall be set to 0.
-- enable-gpios : GPIO reference for enabling and disabling the clock.
-
-Optional properties:
-- clocks: Maximum of one parent clock is supported.
-
-Example:
-	clock {
-		compatible = "gpio-gate-clock";
-		clocks = <&parentclk>;
-		#clock-cells = <0>;
-		enable-gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
-	};
Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml new file +42 -0

42 lines not on this page · raw message

Documentation/devicetree/bindings/clock/ti/gate.txt +1 -1
index b4820b1de4f0..4982615c01b9 100644
@@ -10,7 +10,7 @@ will be controlled instead and the corresponding hw-ops for
 that is used.
 
 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
-[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
+[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
 [3] Documentation/devicetree/bindings/clock/ti/clockdomain.txt
 
 Required properties:
Documentation/devicetree/bindings/clock/ti/interface.txt +1 -1
index 94ec77dc3c59..d3eb5ca92a7f 100644
@@ -9,7 +9,7 @@ companion clock finding (match corresponding functional gate
 clock) and hardware autoidle enable / disable.
 
 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
-[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
+[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
 
 Required properties:
 - compatible : shall be one of:
Signature · 1 line
2.36.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 5 lines · Conor Dooley

Convert the simple GPIO clock gate Device Tree binding to json-schema and fix-up references to this file in other text format bindings. Jyri Sarha is the file's only editor/author so they have been added as maintainer of the new yaml binding.

Quoted 8 lines

---
The original file does not specifiy dual licensing, but when Geert did the gpio-mux-clock conversion the yaml binding was created with dual, so I have done the same thing here.

---
 .../bindings/clock/gpio-gate-clock.txt        | 21 ----------
 .../bindings/clock/gpio-gate-clock.yaml       | 42 +++++++++++++++++++

Best regards,
Krzysztof

#2 lore raw
In reply to Conor Dooley

On 27/07/2022 14:10, Conor Dooley wrote:

Hey Stephen,
Just a wee bump on this conversion.
Thanks,
Conor.

Quoted 120 lines

Convert the simple GPIO clock gate Device Tree binding to json-schema and fix-up references to this file in other text format bindings. Jyri Sarha is the file's only editor/author so they have been added as maintainer of the new yaml binding.

---
The original file does not specifiy dual licensing, but when Geert did the gpio-mux-clock conversion the yaml binding was created with dual, so I have done the same thing here.

---
 .../bindings/clock/gpio-gate-clock.txt        | 21 ----------
 .../bindings/clock/gpio-gate-clock.yaml       | 42 +++++++++++++++++++
 .../devicetree/bindings/clock/ti/gate.txt     |  2 +-
 .../bindings/clock/ti/interface.txt           |  2 +-
 4 files changed, 44 insertions(+), 23 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
 create mode 100644 Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
Documentation/devicetree/bindings/clock/gpio-gate-clock.txt deleted +0 -21
deleted file mode 100644
index d3379ff9b84b..000000000000
@@ -1,21 +0,0 @@
-Binding for simple gpio gated clock.
-
-This binding uses the common clock binding[1].
-
-[1] Documentation/devicetree/bindings/clock/clock-bindings.txt
-
-Required properties:
-- compatible : shall be "gpio-gate-clock".
-- #clock-cells : from common clock binding; shall be set to 0.
-- enable-gpios : GPIO reference for enabling and disabling the clock.
-
-Optional properties:
-- clocks: Maximum of one parent clock is supported.
-
-Example:
-	clock {
-		compatible = "gpio-gate-clock";
-		clocks = <&parentclk>;
-		#clock-cells = <0>;
-		enable-gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
-	};
Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml new file +42 -0
new file mode 100644
index 000000000000..d09d0e3f0c6e
@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/gpio-gate-clock.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Simple GPIO clock gate
+
+maintainers:
+  - Jyri Sarha <[email protected]>
+
+properties:
+  compatible:
+    const: gpio-gate-clock
+
+  clocks:
+    maxItems: 1
+
+  '#clock-cells':
+    const: 0
+
+  enable-gpios:
+    description: GPIO reference for enabling and disabling the clock.
+    maxItems: 1
+
+required:
+  - compatible
+  - '#clock-cells'
+  - enable-gpios
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/gpio/gpio.h>
+
+    clock {
+        compatible = "gpio-gate-clock";
+        clocks = <&parentclk>;
+        #clock-cells = <0>;
+        enable-gpios = <&gpio 1 GPIO_ACTIVE_HIGH>;
+    };
Documentation/devicetree/bindings/clock/ti/gate.txt +1 -1
index b4820b1de4f0..4982615c01b9 100644
@@ -10,7 +10,7 @@ will be controlled instead and the corresponding hw-ops for
 that is used.
 
 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
-[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
+[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
 [3] Documentation/devicetree/bindings/clock/ti/clockdomain.txt
 
 Required properties:
Documentation/devicetree/bindings/clock/ti/interface.txt +1 -1
index 94ec77dc3c59..d3eb5ca92a7f 100644
@@ -9,7 +9,7 @@ companion clock finding (match corresponding functional gate
 clock) and hardware autoidle enable / disable.
 
 [1] Documentation/devicetree/bindings/clock/clock-bindings.txt
-[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.txt
+[2] Documentation/devicetree/bindings/clock/gpio-gate-clock.yaml
 
 Required properties:
 - compatible : shall be one of:
maintainer Applied
#3 lore raw
In reply to Conor Dooley

Quoting Conor Dooley (2022-07-27 06:10:16)

Quoted 7 lines

Convert the simple GPIO clock gate Device Tree binding to json-schema and fix-up references to this file in other text format bindings. Jyri Sarha is the file's only editor/author so they have been added as maintainer of the new yaml binding.

---

Applied to clk-next