[PATCH v2] dt-bindings: clock: ti: Convert ti-clkctrl.txt to json-schema

[PATCH v2] dt-bindings: clock: ti: Convert ti-clkctrl.txt to json-schema

[Andreas Kemnade]

Convert the TI clkctrl clock device tree binding to json-schema.
Specify the creator of the original binding as a maintainer.

reg property is used mostly with one item, in am3xxx also with
an arbitrary number of items, so divert from the original binding
specifying two (probably meaning one address and one size).
The consumer part of the example is left out because the full consumer
node would be needed.

Signed-off-by: Andreas Kemnade <andreas@kemnade.info>
---
Changes in V2:
- additional maintainer
- remove txt binding
- dual licensing

 .../devicetree/bindings/clock/ti,clkctrl.yaml | 65 +++++++++++++++++++
 .../devicetree/bindings/clock/ti-clkctrl.txt  | 63 ------------------
 2 files changed, 65 insertions(+), 63 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/clock/ti,clkctrl.yaml
 delete mode 100644 Documentation/devicetree/bindings/clock/ti-clkctrl.txt

diff --git a/Documentation/devicetree/bindings/clock/ti,clkctrl.yaml b/Documentation/devicetree/bindings/clock/ti,clkctrl.yaml
new file mode 100644
index 0000000000000..49787550ce450
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/ti,clkctrl.yaml
@@ -0,0 +1,65 @@
+# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/clock/ti,clkctrl.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments clkctrl clock
+
+maintainers:
+  - Tony Lindgren <tony@atomide.com>
+  - Andreas Kemnade <andreas@kemnade.info>
+
+description: |
+  Texas Instruments SoCs can have a clkctrl clock controller for each
+  interconnect target module. The clkctrl clock controller manages functional
+  and interface clocks for each module. Each clkctrl controller can also
+  gate one or more optional functional clocks for a module, and can have one
+  or more clock muxes. There is a clkctrl clock controller typically for each
+  interconnect target module on omap4 and later variants.
+
+  The clock consumers can specify the index of the clkctrl clock using
+  the hardware offset from the clkctrl instance register space. The optional
+  clocks can be specified by clkctrl hardware offset and the index of the
+  optional clock.
+
+properties:
+  compatible:
+    enum:
+      - ti,clkctrl
+      - ti,clkctrl-l4-cfg
+      - ti,clkctrl-l4-per
+      - ti,clkctrl-l4-secure
+      - ti,clkctrl-l4-wkup
+
+  "#clock-cells":
+    const: 2
+
+  clock-output-names:
+    maxItems: 1
+
+  reg:
+    minItems: 1
+    maxItems: 8 # arbitrary, should be enough
+
+required:
+  - compatible
+  - "#clock-cells"
+  - clock-output-names
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    bus {
+      #address-cells = <1>;
+      #size-cells = <1>;
+
+      clock@20 {
+        compatible = "ti,clkctrl";
+        clock-output-names = "l4_per";
+        reg = <0x20 0x1b0>;
+        #clock-cells = <2>;
+      };
+    };
diff --git a/Documentation/devicetree/bindings/clock/ti-clkctrl.txt b/Documentation/devicetree/bindings/clock/ti-clkctrl.txt
deleted file mode 100644
index d20db7974a383..0000000000000
--- a/Documentation/devicetree/bindings/clock/ti-clkctrl.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-Texas Instruments clkctrl clock binding
-
-Texas Instruments SoCs can have a clkctrl clock controller for each
-interconnect target module. The clkctrl clock controller manages functional
-and interface clocks for each module. Each clkctrl controller can also
-gate one or more optional functional clocks for a module, and can have one
-or more clock muxes. There is a clkctrl clock controller typically for each
-interconnect target module on omap4 and later variants.
-
-The clock consumers can specify the index of the clkctrl clock using
-the hardware offset from the clkctrl instance register space. The optional
-clocks can be specified by clkctrl hardware offset and the index of the
-optional clock.
-
-For more information, please see the Linux clock framework binding at
-Documentation/devicetree/bindings/clock/clock-bindings.txt.
-
-Required properties :
-- compatible : shall be "ti,clkctrl" or a clock domain specific name:
-	       "ti,clkctrl-l4-cfg"
-	       "ti,clkctrl-l4-per"
-	       "ti,clkctrl-l4-secure"
-	       "ti,clkctrl-l4-wkup"
-- clock-output-names : from common clock binding
-- #clock-cells : shall contain 2 with the first entry being the instance
-		 offset from the clock domain base and the second being the
-		 clock index
-- reg : clock registers
-
-Example: Clock controller node on omap 4430:
-
-&cm2 {
-	l4per: cm@1400 {
-		cm_l4per@0 {
-			cm_l4per_clkctrl: clock@20 {
-				compatible = "ti,clkctrl";
-				clock-output-names = "l4_per";
-				reg = <0x20 0x1b0>;
-				#clock-cells = <2>;
-			};
-		};
-	};
-};
-
-Example: Preprocessor helper macros in dt-bindings/clock/ti-clkctrl.h
-
-#define OMAP4_CLKCTRL_OFFSET		0x20
-#define OMAP4_CLKCTRL_INDEX(offset)	((offset) - OMAP4_CLKCTRL_OFFSET)
-#define MODULEMODE_HWCTRL		1
-#define MODULEMODE_SWCTRL		2
-
-#define OMAP4_GPTIMER10_CLKTRL		OMAP4_CLKCTRL_INDEX(0x28)
-#define OMAP4_GPTIMER11_CLKTRL		OMAP4_CLKCTRL_INDEX(0x30)
-#define OMAP4_GPTIMER2_CLKTRL		OMAP4_CLKCTRL_INDEX(0x38)
-...
-#define OMAP4_GPIO2_CLKCTRL		OMAP_CLKCTRL_INDEX(0x60)
-
-Example: Clock consumer node for GPIO2:
-
-&gpio2 {
-       clocks = <&cm_l4per_clkctrl OMAP4_GPIO2_CLKCTRL 0
-		 &cm_l4per_clkctrl OMAP4_GPIO2_CLKCTRL 8>;
-};
-- 
2.39.5

Re: [PATCH v2] dt-bindings: clock: ti: Convert ti-clkctrl.txt to json-schema

[Rob Herring (Arm)]

On Tue, 11 Mar 2025 19:02:15 +0100, Andreas Kemnade wrote:
> Convert the TI clkctrl clock device tree binding to json-schema.
> Specify the creator of the original binding as a maintainer.
> 
> reg property is used mostly with one item, in am3xxx also with
> an arbitrary number of items, so divert from the original binding
> specifying two (probably meaning one address and one size).
> The consumer part of the example is left out because the full consumer
> node would be needed.
> 
> Signed-off-by: Andreas Kemnade <andreas@kemnade.info>
> ---
> Changes in V2:
> - additional maintainer
> - remove txt binding
> - dual licensing
> 
>  .../devicetree/bindings/clock/ti,clkctrl.yaml | 65 +++++++++++++++++++
>  .../devicetree/bindings/clock/ti-clkctrl.txt  | 63 ------------------
>  2 files changed, 65 insertions(+), 63 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/clock/ti,clkctrl.yaml
>  delete mode 100644 Documentation/devicetree/bindings/clock/ti-clkctrl.txt
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>

Re: [PATCH v2] dt-bindings: clock: ti: Convert ti-clkctrl.txt to json-schema

[Stephen Boyd]

Quoting Andreas Kemnade (2025-03-11 11:02:15)
> Convert the TI clkctrl clock device tree binding to json-schema.
> Specify the creator of the original binding as a maintainer.
> 
> reg property is used mostly with one item, in am3xxx also with
> an arbitrary number of items, so divert from the original binding
> specifying two (probably meaning one address and one size).
> The consumer part of the example is left out because the full consumer
> node would be needed.
> 
> Signed-off-by: Andreas Kemnade <andreas@kemnade.info>
> ---

Applied to clk-next