Commit 944b074f authored by Andreas Kemnade's avatar Andreas Kemnade Committed by Stephen Boyd
Browse files

dt-bindings: clock: ti: Convert ti-clkctrl.txt to json-schema 



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: default avatarAndreas Kemnade <andreas@kemnade.info>
Link: https://lore.kernel.org/r/20250311180215.173634-1-andreas@kemnade.info


Reviewed-by: default avatarRob Herring (Arm) <robh@kernel.org>
Signed-off-by: default avatarStephen Boyd <sboyd@kernel.org>
parent 00153c64

Documentation/devicetree/bindings/clock/ti,clkctrl.yaml

0 → 100644
+65 −0
Original line number Diff line number Diff line 
# 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>;

      };

    };

Documentation/devicetree/bindings/clock/ti-clkctrl.txt

deleted100644 → 0
+0 −63
Original line number Diff line number Diff line 
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>;

};