| Message ID | 20250404014500.2789830-4-sbellary@baylibre.com (mailing list archive) |
|---|---|
| State | Under Review |
| Headers | show |
| Series | dt-bindings: clock: ti: convert to yaml | expand |
On Thu, Apr 03, 2025 at 06:44:59PM -0700, Sukrut Bellary wrote: > Convert TI fixed-factor-clock binding to yaml. > > This uses the ti,autoidle.yaml for clock autoidle support. > Clean up the example to meet the current standards. > > Add the creator of the original binding as a maintainer. > > Signed-off-by: Sukrut Bellary <sbellary@baylibre.com> > --- > .../bindings/clock/ti/fixed-factor-clock.txt | 42 ---------- > .../clock/ti/ti,fixed-factor-clock.yaml | 77 +++++++++++++++++++ > 2 files changed, 77 insertions(+), 42 deletions(-) > delete mode 100644 Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt > create mode 100644 Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml > > diff --git a/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt b/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt > deleted file mode 100644 > index dc69477b6e98..000000000000 > --- a/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt > +++ /dev/null > @@ -1,42 +0,0 @@ > -Binding for TI fixed factor rate clock sources. > - > -This binding uses the common clock binding[1], and also uses the autoidle > -support from TI autoidle clock [2]. > - > -[1] Documentation/devicetree/bindings/clock/clock-bindings.txt > -[2] Documentation/devicetree/bindings/clock/ti/autoidle.txt > - > -Required properties: > -- compatible : shall be "ti,fixed-factor-clock". > -- #clock-cells : from common clock binding; shall be set to 0. > -- ti,clock-div: fixed divider. > -- ti,clock-mult: fixed multiplier. > -- clocks: parent clock. > - > -Optional properties: > -- clock-output-names : from common clock binding. > -- ti,autoidle-shift: bit shift of the autoidle enable bit for the clock, > - see [2] > -- reg: offset for the autoidle register of this clock, see [2] > -- ti,invert-autoidle-bit: autoidle is enabled by setting the bit to 0, see [2] > -- ti,set-rate-parent: clk_set_rate is propagated to parent > - > -Example: > - clock { > - compatible = "ti,fixed-factor-clock"; > - clocks = <&parentclk>; > - #clock-cells = <0>; > - ti,clock-div = <2>; > - ti,clock-mult = <1>; > - }; > - > - dpll_usb_clkdcoldo_ck: dpll_usb_clkdcoldo_ck { > - #clock-cells = <0>; > - compatible = "ti,fixed-factor-clock"; > - clocks = <&dpll_usb_ck>; > - ti,clock-div = <1>; > - ti,autoidle-shift = <8>; > - reg = <0x01b4>; > - ti,clock-mult = <1>; > - ti,invert-autoidle-bit; > - }; > diff --git a/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml b/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml > new file mode 100644 > index 000000000000..f597aedbad05 > --- /dev/null > +++ b/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml > @@ -0,0 +1,77 @@ > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > +%YAML 1.2 > +--- > +$id: http://devicetree.org/schemas/clock/ti/ti,fixed-factor-clock.yaml# > +$schema: http://devicetree.org/meta-schemas/core.yaml# > + > +title: TI fixed factor rate clock sources > + > +maintainers: > + - Tero Kristo <kristo@kernel.org> > + - Sukrut Bellary <sbellary@baylibre.com> > + > +description: | Don't need '|'. > + This consists of a divider and a multiplier used to generate > + a fixed rate clock. This also uses the autoidle support from > + TI autoidle clock. > + > +allOf: > + - $ref: /schemas/clock/ti/ti,autoidle.yaml# You can drop '/schemas/clock/ti/' > + > +properties: > + compatible: > + const: ti,fixed-factor-clock > + > + "#clock-cells": > + const: 0 > + > + reg: > + maxItems: 1 > + > + ti,clock-div: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: Fixed divider Constraints? > + > + ti,clock-mult: > + $ref: /schemas/types.yaml#/definitions/uint32 > + description: Fixed multiplier Constraints? > + > + clocks: maxItems: 1 > + description: > + Link to phandle of parent clock. Drop the description > + > + clock-output-names: maxItems: 1 > + description: > + From common clock binding Drop > + > + ti,set-rate-parent: > + description: > + Propagate to parent clock > + type: boolean > + > +required: > + - compatible > + - clocks > + - "#clock-cells" > + - ti,clock-mult > + - ti,clock-div > + > +unevaluatedProperties: false > + > +examples: > + - | > + bus{ > + #address-cells = <1>; > + #size-cells = <0>; > + > + clock@1b4 { > + compatible = "ti,fixed-factor-clock"; > + reg = <0x1b4>; > + clocks = <&dpll_usb_ck>; > + #clock-cells = <0>; > + ti,clock-mult = <1>; > + ti,clock-div = <1>; > + ti,autoidle-shift = <8>; > + ti,invert-autoidle-bit; > + }; > + }; > -- > 2.34.1 >
On Fri, Apr 04, 2025 at 02:40:46PM -0500, Rob Herring wrote: > On Thu, Apr 03, 2025 at 06:44:59PM -0700, Sukrut Bellary wrote: > > Convert TI fixed-factor-clock binding to yaml. > > > > This uses the ti,autoidle.yaml for clock autoidle support. > > Clean up the example to meet the current standards. > > > > Add the creator of the original binding as a maintainer. > > > > Signed-off-by: Sukrut Bellary <sbellary@baylibre.com> > > --- > > .../bindings/clock/ti/fixed-factor-clock.txt | 42 ---------- > > .../clock/ti/ti,fixed-factor-clock.yaml | 77 +++++++++++++++++++ > > 2 files changed, 77 insertions(+), 42 deletions(-) > > delete mode 100644 Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt > > create mode 100644 Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml > > > > diff --git a/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt b/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt > > deleted file mode 100644 > > index dc69477b6e98..000000000000 > > --- a/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt > > +++ /dev/null > > @@ -1,42 +0,0 @@ > > -Binding for TI fixed factor rate clock sources. > > - > > -This binding uses the common clock binding[1], and also uses the autoidle > > -support from TI autoidle clock [2]. > > - > > -[1] Documentation/devicetree/bindings/clock/clock-bindings.txt > > -[2] Documentation/devicetree/bindings/clock/ti/autoidle.txt > > - > > -Required properties: > > -- compatible : shall be "ti,fixed-factor-clock". > > -- #clock-cells : from common clock binding; shall be set to 0. > > -- ti,clock-div: fixed divider. > > -- ti,clock-mult: fixed multiplier. > > -- clocks: parent clock. > > - > > -Optional properties: > > -- clock-output-names : from common clock binding. > > -- ti,autoidle-shift: bit shift of the autoidle enable bit for the clock, > > - see [2] > > -- reg: offset for the autoidle register of this clock, see [2] > > -- ti,invert-autoidle-bit: autoidle is enabled by setting the bit to 0, see [2] > > -- ti,set-rate-parent: clk_set_rate is propagated to parent > > - > > -Example: > > - clock { > > - compatible = "ti,fixed-factor-clock"; > > - clocks = <&parentclk>; > > - #clock-cells = <0>; > > - ti,clock-div = <2>; > > - ti,clock-mult = <1>; > > - }; > > - > > - dpll_usb_clkdcoldo_ck: dpll_usb_clkdcoldo_ck { > > - #clock-cells = <0>; > > - compatible = "ti,fixed-factor-clock"; > > - clocks = <&dpll_usb_ck>; > > - ti,clock-div = <1>; > > - ti,autoidle-shift = <8>; > > - reg = <0x01b4>; > > - ti,clock-mult = <1>; > > - ti,invert-autoidle-bit; > > - }; > > diff --git a/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml b/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml > > new file mode 100644 > > index 000000000000..f597aedbad05 > > --- /dev/null > > +++ b/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml > > @@ -0,0 +1,77 @@ > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) > > +%YAML 1.2 > > +--- > > +$id: http://devicetree.org/schemas/clock/ti/ti,fixed-factor-clock.yaml# > > +$schema: http://devicetree.org/meta-schemas/core.yaml# > > + > > +title: TI fixed factor rate clock sources > > + > > +maintainers: > > + - Tero Kristo <kristo@kernel.org> > > + - Sukrut Bellary <sbellary@baylibre.com> > > + > > +description: | > > Don't need '|'. > > > + This consists of a divider and a multiplier used to generate > > + a fixed rate clock. This also uses the autoidle support from > > + TI autoidle clock. > > + > > +allOf: > > + - $ref: /schemas/clock/ti/ti,autoidle.yaml# > > You can drop '/schemas/clock/ti/' > > > + > > +properties: > > + compatible: > > + const: ti,fixed-factor-clock > > + > > + "#clock-cells": > > + const: 0 > > + > > + reg: > > + maxItems: 1 > > + > > + ti,clock-div: > > + $ref: /schemas/types.yaml#/definitions/uint32 > > + description: Fixed divider > > Constraints? > > > + > > + ti,clock-mult: > > + $ref: /schemas/types.yaml#/definitions/uint32 > > + description: Fixed multiplier > > Constraints? > > > + > > + clocks: > > maxItems: 1 > > > + description: > > + Link to phandle of parent clock. > > Drop the description > > > + > > + clock-output-names: > > maxItems: 1 > > > + description: > > + From common clock binding > > Drop Thanks for the review. I will fix all of the above issues. > > + > > + ti,set-rate-parent: > > + description: > > + Propagate to parent clock > > + type: boolean > > + > > +required: > > + - compatible > > + - clocks > > + - "#clock-cells" > > + - ti,clock-mult > > + - ti,clock-div > > + > > +unevaluatedProperties: false > > + > > +examples: > > + - | > > + bus{ > > + #address-cells = <1>; > > + #size-cells = <0>; > > + > > + clock@1b4 { > > + compatible = "ti,fixed-factor-clock"; > > + reg = <0x1b4>; > > + clocks = <&dpll_usb_ck>; > > + #clock-cells = <0>; > > + ti,clock-mult = <1>; > > + ti,clock-div = <1>; > > + ti,autoidle-shift = <8>; > > + ti,invert-autoidle-bit; > > + }; > > + }; > > -- > > 2.34.1 > >
diff --git a/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt b/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt deleted file mode 100644 index dc69477b6e98..000000000000 --- a/Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt +++ /dev/null @@ -1,42 +0,0 @@ -Binding for TI fixed factor rate clock sources. - -This binding uses the common clock binding[1], and also uses the autoidle -support from TI autoidle clock [2]. - -[1] Documentation/devicetree/bindings/clock/clock-bindings.txt -[2] Documentation/devicetree/bindings/clock/ti/autoidle.txt - -Required properties: -- compatible : shall be "ti,fixed-factor-clock". -- #clock-cells : from common clock binding; shall be set to 0. -- ti,clock-div: fixed divider. -- ti,clock-mult: fixed multiplier. -- clocks: parent clock. - -Optional properties: -- clock-output-names : from common clock binding. -- ti,autoidle-shift: bit shift of the autoidle enable bit for the clock, - see [2] -- reg: offset for the autoidle register of this clock, see [2] -- ti,invert-autoidle-bit: autoidle is enabled by setting the bit to 0, see [2] -- ti,set-rate-parent: clk_set_rate is propagated to parent - -Example: - clock { - compatible = "ti,fixed-factor-clock"; - clocks = <&parentclk>; - #clock-cells = <0>; - ti,clock-div = <2>; - ti,clock-mult = <1>; - }; - - dpll_usb_clkdcoldo_ck: dpll_usb_clkdcoldo_ck { - #clock-cells = <0>; - compatible = "ti,fixed-factor-clock"; - clocks = <&dpll_usb_ck>; - ti,clock-div = <1>; - ti,autoidle-shift = <8>; - reg = <0x01b4>; - ti,clock-mult = <1>; - ti,invert-autoidle-bit; - }; diff --git a/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml b/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml new file mode 100644 index 000000000000..f597aedbad05 --- /dev/null +++ b/Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml @@ -0,0 +1,77 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) +%YAML 1.2 +--- +$id: http://devicetree.org/schemas/clock/ti/ti,fixed-factor-clock.yaml# +$schema: http://devicetree.org/meta-schemas/core.yaml# + +title: TI fixed factor rate clock sources + +maintainers: + - Tero Kristo <kristo@kernel.org> + - Sukrut Bellary <sbellary@baylibre.com> + +description: | + This consists of a divider and a multiplier used to generate + a fixed rate clock. This also uses the autoidle support from + TI autoidle clock. + +allOf: + - $ref: /schemas/clock/ti/ti,autoidle.yaml# + +properties: + compatible: + const: ti,fixed-factor-clock + + "#clock-cells": + const: 0 + + reg: + maxItems: 1 + + ti,clock-div: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Fixed divider + + ti,clock-mult: + $ref: /schemas/types.yaml#/definitions/uint32 + description: Fixed multiplier + + clocks: + description: + Link to phandle of parent clock. + + clock-output-names: + description: + From common clock binding + + ti,set-rate-parent: + description: + Propagate to parent clock + type: boolean + +required: + - compatible + - clocks + - "#clock-cells" + - ti,clock-mult + - ti,clock-div + +unevaluatedProperties: false + +examples: + - | + bus{ + #address-cells = <1>; + #size-cells = <0>; + + clock@1b4 { + compatible = "ti,fixed-factor-clock"; + reg = <0x1b4>; + clocks = <&dpll_usb_ck>; + #clock-cells = <0>; + ti,clock-mult = <1>; + ti,clock-div = <1>; + ti,autoidle-shift = <8>; + ti,invert-autoidle-bit; + }; + };
Convert TI fixed-factor-clock binding to yaml. This uses the ti,autoidle.yaml for clock autoidle support. Clean up the example to meet the current standards. Add the creator of the original binding as a maintainer. Signed-off-by: Sukrut Bellary <sbellary@baylibre.com> --- .../bindings/clock/ti/fixed-factor-clock.txt | 42 ---------- .../clock/ti/ti,fixed-factor-clock.yaml | 77 +++++++++++++++++++ 2 files changed, 77 insertions(+), 42 deletions(-) delete mode 100644 Documentation/devicetree/bindings/clock/ti/fixed-factor-clock.txt create mode 100644 Documentation/devicetree/bindings/clock/ti/ti,fixed-factor-clock.yaml