diff mbox series

[v2,2/4] dt-bindings: clk: sprd: Add bindings for ums512 clock controller

Message ID 20210916084714.311048-3-zhang.lyra@gmail.com (mailing list archive)
State Superseded, archived
Headers show
Series Add Unisoc's UMS512 clock support | expand

Commit Message

Chunyan Zhang Sept. 16, 2021, 8:47 a.m. UTC
From: Chunyan Zhang <chunyan.zhang@unisoc.com>

Add a new bindings to describe ums512 clock compatible strings.

Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
---
 .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
 1 file changed, 106 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml

Comments

Rob Herring Sept. 16, 2021, 12:21 p.m. UTC | #1
On Thu, 16 Sep 2021 16:47:12 +0800, Chunyan Zhang wrote:
> From: Chunyan Zhang <chunyan.zhang@unisoc.com>
> 
> Add a new bindings to describe ums512 clock compatible strings.
> 
> Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
> ---
>  .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
>  1 file changed, 106 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/clock/sprd,ums512-clk.example.dt.yaml:0:0: /example-1/syscon@71000000: failed to match any schema with compatible: ['sprd,ums512-glbregs', 'syscon', 'simple-mfd']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1528692

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.
Rob Herring Sept. 16, 2021, 2:29 p.m. UTC | #2
On Thu, Sep 16, 2021 at 04:47:12PM +0800, Chunyan Zhang wrote:
> From: Chunyan Zhang <chunyan.zhang@unisoc.com>
> 
> Add a new bindings to describe ums512 clock compatible strings.
> 
> Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
> ---
>  .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
>  1 file changed, 106 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> 
> diff --git a/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> new file mode 100644
> index 000000000000..be3c37180279
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> @@ -0,0 +1,106 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright 2019-2021 Unisoc Inc.
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/clock/sprd,ums512-clk.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: UMS512 Clock Control Unit Device Tree Bindings
> +
> +maintainers:
> +  - Orson Zhai <orsonzhai@gmail.com>
> +  - Baolin Wang <baolin.wang7@gmail.com>
> +  - Chunyan Zhang <zhang.lyra@gmail.com>
> +
> +properties:
> +  "#clock-cells":
> +    const: 1
> +
> +  compatible:
> +    enum:
> +      - sprd,ums512-apahb-gate
> +      - sprd,ums512-ap-clk
> +      - sprd,ums512-aonapb-clk
> +      - sprd,ums512-pmu-gate
> +      - sprd,ums512-g0-pll
> +      - sprd,ums512-g2-pll
> +      - sprd,ums512-g3-pll
> +      - sprd,ums512-gc-pll
> +      - sprd,ums512-aon-gate
> +      - sprd,ums512-audcpapb-gate
> +      - sprd,ums512-audcpahb-gate
> +      - sprd,ums512-gpu-clk
> +      - sprd,ums512-mm-clk
> +      - sprd,ums512-mm-gate-clk
> +      - sprd,ums512-apapb-gate
> +
> +  clocks:
> +    minItems: 1
> +    maxItems: 4
> +    description: |
> +      The input parent clock(s) phandle for this clock, only list fixed
> +      clocks which are declared in devicetree.
> +
> +  clock-names:
> +    minItems: 1
> +    maxItems: 4
> +    items:
> +      - const: ext-26m
> +      - const: ext-32k
> +      - const: ext-4m
> +      - const: rco-100m
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - '#clock-cells'
> +
> +if:
> +  properties:
> +    compatible:
> +      enum:
> +        - sprd,ums512-ap-clk
> +        - sprd,ums512-aonapb-clk
> +        - sprd,ums512-mm-clk
> +then:
> +  required:
> +    - reg
> +
> +else:
> +  description: |
> +    Other UMS512 clock nodes should be the child of a syscon node in
> +    which compatible string should be:
> +            "sprd,ums512-glbregs", "syscon", "simple-mfd"
> +
> +    The 'reg' property for the clock node is also required if there is a sub
> +    range of registers for the clocks.

In which cases is this not true?

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    ap_clk: clock-controller@20200000 {
> +      compatible = "sprd,ums512-ap-clk";
> +      reg = <0x20200000 0x1000>;
> +      clocks = <&ext_26m>;
> +      clock-names = "ext-26m";
> +      #clock-cells = <1>;
> +    };
> +
> +  - |
> +    ap_apb_regs: syscon@71000000 {
> +      compatible = "sprd,ums512-glbregs", "syscon", "simple-mfd";
> +      reg = <0x71000000 0x3000>;
> +      #address-cells = <1>;
> +      #size-cells = <1>;
> +      ranges = <0 0x71000000 0x3000>;
> +
> +      apahb_gate: clock-controller@0 {
> +        compatible = "sprd,ums512-apahb-gate";
> +        reg = <0x0 0x2000>;
> +        #clock-cells = <1>;
> +      };

We have this example in the MFD schema, so drop it here.
Chunyan Zhang Sept. 17, 2021, 8:40 a.m. UTC | #3
On Thu, 16 Sept 2021 at 22:29, Rob Herring <robh@kernel.org> wrote:
>
> On Thu, Sep 16, 2021 at 04:47:12PM +0800, Chunyan Zhang wrote:
> > From: Chunyan Zhang <chunyan.zhang@unisoc.com>
> >
> > Add a new bindings to describe ums512 clock compatible strings.
> >
> > Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > ---
> >  .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
> >  1 file changed, 106 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > new file mode 100644
> > index 000000000000..be3c37180279
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > @@ -0,0 +1,106 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +# Copyright 2019-2021 Unisoc Inc.
> > +%YAML 1.2
> > +---
> > +$id: "http://devicetree.org/schemas/clock/sprd,ums512-clk.yaml#"
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > +
> > +title: UMS512 Clock Control Unit Device Tree Bindings
> > +
> > +maintainers:
> > +  - Orson Zhai <orsonzhai@gmail.com>
> > +  - Baolin Wang <baolin.wang7@gmail.com>
> > +  - Chunyan Zhang <zhang.lyra@gmail.com>
> > +
> > +properties:
> > +  "#clock-cells":
> > +    const: 1
> > +
> > +  compatible:
> > +    enum:
> > +      - sprd,ums512-apahb-gate
> > +      - sprd,ums512-ap-clk
> > +      - sprd,ums512-aonapb-clk
> > +      - sprd,ums512-pmu-gate
> > +      - sprd,ums512-g0-pll
> > +      - sprd,ums512-g2-pll
> > +      - sprd,ums512-g3-pll
> > +      - sprd,ums512-gc-pll
> > +      - sprd,ums512-aon-gate
> > +      - sprd,ums512-audcpapb-gate
> > +      - sprd,ums512-audcpahb-gate
> > +      - sprd,ums512-gpu-clk
> > +      - sprd,ums512-mm-clk
> > +      - sprd,ums512-mm-gate-clk
> > +      - sprd,ums512-apapb-gate
> > +
> > +  clocks:
> > +    minItems: 1
> > +    maxItems: 4
> > +    description: |
> > +      The input parent clock(s) phandle for this clock, only list fixed
> > +      clocks which are declared in devicetree.
> > +
> > +  clock-names:
> > +    minItems: 1
> > +    maxItems: 4
> > +    items:
> > +      - const: ext-26m
> > +      - const: ext-32k
> > +      - const: ext-4m
> > +      - const: rco-100m
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - '#clock-cells'
> > +
> > +if:
> > +  properties:
> > +    compatible:
> > +      enum:
> > +        - sprd,ums512-ap-clk
> > +        - sprd,ums512-aonapb-clk
> > +        - sprd,ums512-mm-clk
> > +then:
> > +  required:
> > +    - reg
> > +
> > +else:
> > +  description: |
> > +    Other UMS512 clock nodes should be the child of a syscon node in
> > +    which compatible string should be:
> > +            "sprd,ums512-glbregs", "syscon", "simple-mfd"
> > +
> > +    The 'reg' property for the clock node is also required if there is a sub
> > +    range of registers for the clocks.
>
> In which cases is this not true?

Seems not needed, I will remove 'reg' property for this kind of cases.

>
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    ap_clk: clock-controller@20200000 {
> > +      compatible = "sprd,ums512-ap-clk";
> > +      reg = <0x20200000 0x1000>;
> > +      clocks = <&ext_26m>;
> > +      clock-names = "ext-26m";
> > +      #clock-cells = <1>;
> > +    };
> > +
> > +  - |
> > +    ap_apb_regs: syscon@71000000 {
> > +      compatible = "sprd,ums512-glbregs", "syscon", "simple-mfd";
> > +      reg = <0x71000000 0x3000>;
> > +      #address-cells = <1>;
> > +      #size-cells = <1>;
> > +      ranges = <0 0x71000000 0x3000>;
> > +
> > +      apahb_gate: clock-controller@0 {
> > +        compatible = "sprd,ums512-apahb-gate";
> > +        reg = <0x0 0x2000>;
> > +        #clock-cells = <1>;
> > +      };
>
> We have this example in the MFD schema, so drop it here.

Ok.

Thanks for your review and comments,
Chunyan
Rob Herring Sept. 20, 2021, 12:42 p.m. UTC | #4
On Fri, Sep 17, 2021 at 3:41 AM Chunyan Zhang <zhang.lyra@gmail.com> wrote:
>
> On Thu, 16 Sept 2021 at 22:29, Rob Herring <robh@kernel.org> wrote:
> >
> > On Thu, Sep 16, 2021 at 04:47:12PM +0800, Chunyan Zhang wrote:
> > > From: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > >
> > > Add a new bindings to describe ums512 clock compatible strings.
> > >
> > > Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > > ---
> > >  .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
> > >  1 file changed, 106 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > >
> > > diff --git a/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > new file mode 100644
> > > index 000000000000..be3c37180279
> > > --- /dev/null
> > > +++ b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > @@ -0,0 +1,106 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +# Copyright 2019-2021 Unisoc Inc.
> > > +%YAML 1.2
> > > +---
> > > +$id: "http://devicetree.org/schemas/clock/sprd,ums512-clk.yaml#"
> > > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > > +
> > > +title: UMS512 Clock Control Unit Device Tree Bindings
> > > +
> > > +maintainers:
> > > +  - Orson Zhai <orsonzhai@gmail.com>
> > > +  - Baolin Wang <baolin.wang7@gmail.com>
> > > +  - Chunyan Zhang <zhang.lyra@gmail.com>
> > > +
> > > +properties:
> > > +  "#clock-cells":
> > > +    const: 1
> > > +
> > > +  compatible:
> > > +    enum:
> > > +      - sprd,ums512-apahb-gate
> > > +      - sprd,ums512-ap-clk
> > > +      - sprd,ums512-aonapb-clk
> > > +      - sprd,ums512-pmu-gate
> > > +      - sprd,ums512-g0-pll
> > > +      - sprd,ums512-g2-pll
> > > +      - sprd,ums512-g3-pll
> > > +      - sprd,ums512-gc-pll
> > > +      - sprd,ums512-aon-gate
> > > +      - sprd,ums512-audcpapb-gate
> > > +      - sprd,ums512-audcpahb-gate
> > > +      - sprd,ums512-gpu-clk
> > > +      - sprd,ums512-mm-clk
> > > +      - sprd,ums512-mm-gate-clk
> > > +      - sprd,ums512-apapb-gate
> > > +
> > > +  clocks:
> > > +    minItems: 1
> > > +    maxItems: 4
> > > +    description: |
> > > +      The input parent clock(s) phandle for this clock, only list fixed
> > > +      clocks which are declared in devicetree.
> > > +
> > > +  clock-names:
> > > +    minItems: 1
> > > +    maxItems: 4
> > > +    items:
> > > +      - const: ext-26m
> > > +      - const: ext-32k
> > > +      - const: ext-4m
> > > +      - const: rco-100m
> > > +
> > > +  reg:
> > > +    maxItems: 1
> > > +
> > > +required:
> > > +  - compatible
> > > +  - '#clock-cells'
> > > +
> > > +if:
> > > +  properties:
> > > +    compatible:
> > > +      enum:
> > > +        - sprd,ums512-ap-clk
> > > +        - sprd,ums512-aonapb-clk
> > > +        - sprd,ums512-mm-clk
> > > +then:
> > > +  required:
> > > +    - reg
> > > +
> > > +else:
> > > +  description: |
> > > +    Other UMS512 clock nodes should be the child of a syscon node in
> > > +    which compatible string should be:
> > > +            "sprd,ums512-glbregs", "syscon", "simple-mfd"
> > > +
> > > +    The 'reg' property for the clock node is also required if there is a sub
> > > +    range of registers for the clocks.
> >
> > In which cases is this not true?
>
> Seems not needed, I will remove 'reg' property for this kind of cases.

Wrong direction. Please keep 'reg'. My question is why can't you
always have it? That is the preference.

Rob
Chunyan Zhang Sept. 22, 2021, 3:32 a.m. UTC | #5
On Mon, 20 Sept 2021 at 20:42, Rob Herring <robh@kernel.org> wrote:
>
> On Fri, Sep 17, 2021 at 3:41 AM Chunyan Zhang <zhang.lyra@gmail.com> wrote:
> >
> > On Thu, 16 Sept 2021 at 22:29, Rob Herring <robh@kernel.org> wrote:
> > >
> > > On Thu, Sep 16, 2021 at 04:47:12PM +0800, Chunyan Zhang wrote:
> > > > From: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > > >
> > > > Add a new bindings to describe ums512 clock compatible strings.
> > > >
> > > > Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > > > ---
> > > >  .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
> > > >  1 file changed, 106 insertions(+)
> > > >  create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > >
> > > > diff --git a/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > > new file mode 100644
> > > > index 000000000000..be3c37180279
> > > > --- /dev/null
> > > > +++ b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > > @@ -0,0 +1,106 @@
> > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > > +# Copyright 2019-2021 Unisoc Inc.
> > > > +%YAML 1.2
> > > > +---
> > > > +$id: "http://devicetree.org/schemas/clock/sprd,ums512-clk.yaml#"
> > > > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > > > +
> > > > +title: UMS512 Clock Control Unit Device Tree Bindings
> > > > +
> > > > +maintainers:
> > > > +  - Orson Zhai <orsonzhai@gmail.com>
> > > > +  - Baolin Wang <baolin.wang7@gmail.com>
> > > > +  - Chunyan Zhang <zhang.lyra@gmail.com>
> > > > +
> > > > +properties:
> > > > +  "#clock-cells":
> > > > +    const: 1
> > > > +
> > > > +  compatible:
> > > > +    enum:
> > > > +      - sprd,ums512-apahb-gate
> > > > +      - sprd,ums512-ap-clk
> > > > +      - sprd,ums512-aonapb-clk
> > > > +      - sprd,ums512-pmu-gate
> > > > +      - sprd,ums512-g0-pll
> > > > +      - sprd,ums512-g2-pll
> > > > +      - sprd,ums512-g3-pll
> > > > +      - sprd,ums512-gc-pll
> > > > +      - sprd,ums512-aon-gate
> > > > +      - sprd,ums512-audcpapb-gate
> > > > +      - sprd,ums512-audcpahb-gate
> > > > +      - sprd,ums512-gpu-clk
> > > > +      - sprd,ums512-mm-clk
> > > > +      - sprd,ums512-mm-gate-clk
> > > > +      - sprd,ums512-apapb-gate
> > > > +
> > > > +  clocks:
> > > > +    minItems: 1
> > > > +    maxItems: 4
> > > > +    description: |
> > > > +      The input parent clock(s) phandle for this clock, only list fixed
> > > > +      clocks which are declared in devicetree.
> > > > +
> > > > +  clock-names:
> > > > +    minItems: 1
> > > > +    maxItems: 4
> > > > +    items:
> > > > +      - const: ext-26m
> > > > +      - const: ext-32k
> > > > +      - const: ext-4m
> > > > +      - const: rco-100m
> > > > +
> > > > +  reg:
> > > > +    maxItems: 1
> > > > +
> > > > +required:
> > > > +  - compatible
> > > > +  - '#clock-cells'
> > > > +
> > > > +if:
> > > > +  properties:
> > > > +    compatible:
> > > > +      enum:
> > > > +        - sprd,ums512-ap-clk
> > > > +        - sprd,ums512-aonapb-clk
> > > > +        - sprd,ums512-mm-clk
> > > > +then:
> > > > +  required:
> > > > +    - reg
> > > > +
> > > > +else:
> > > > +  description: |
> > > > +    Other UMS512 clock nodes should be the child of a syscon node in
> > > > +    which compatible string should be:
> > > > +            "sprd,ums512-glbregs", "syscon", "simple-mfd"
> > > > +
> > > > +    The 'reg' property for the clock node is also required if there is a sub
> > > > +    range of registers for the clocks.
> > >
> > > In which cases is this not true?
> >
> > Seems not needed, I will remove 'reg' property for this kind of cases.
>
> Wrong direction. Please keep 'reg'. My question is why can't you
> always have it? That is the preference.

Ok. I will address. BTW, do we need 'reg' even though the driver
doesn't read this property? Does that because DT should reflect
hardware topology?

Thanks for the comments,
Chunyan

>
> Rob
Rob Herring Sept. 22, 2021, 8:35 p.m. UTC | #6
On Tue, Sep 21, 2021 at 10:33 PM Chunyan Zhang <zhang.lyra@gmail.com> wrote:
>
> On Mon, 20 Sept 2021 at 20:42, Rob Herring <robh@kernel.org> wrote:
> >
> > On Fri, Sep 17, 2021 at 3:41 AM Chunyan Zhang <zhang.lyra@gmail.com> wrote:
> > >
> > > On Thu, 16 Sept 2021 at 22:29, Rob Herring <robh@kernel.org> wrote:
> > > >
> > > > On Thu, Sep 16, 2021 at 04:47:12PM +0800, Chunyan Zhang wrote:
> > > > > From: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > > > >
> > > > > Add a new bindings to describe ums512 clock compatible strings.
> > > > >
> > > > > Signed-off-by: Chunyan Zhang <chunyan.zhang@unisoc.com>
> > > > > ---
> > > > >  .../bindings/clock/sprd,ums512-clk.yaml       | 106 ++++++++++++++++++
> > > > >  1 file changed, 106 insertions(+)
> > > > >  create mode 100644 Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > > >
> > > > > diff --git a/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > > > new file mode 100644
> > > > > index 000000000000..be3c37180279
> > > > > --- /dev/null
> > > > > +++ b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
> > > > > @@ -0,0 +1,106 @@
> > > > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > > > +# Copyright 2019-2021 Unisoc Inc.
> > > > > +%YAML 1.2
> > > > > +---
> > > > > +$id: "http://devicetree.org/schemas/clock/sprd,ums512-clk.yaml#"
> > > > > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > > > > +
> > > > > +title: UMS512 Clock Control Unit Device Tree Bindings
> > > > > +
> > > > > +maintainers:
> > > > > +  - Orson Zhai <orsonzhai@gmail.com>
> > > > > +  - Baolin Wang <baolin.wang7@gmail.com>
> > > > > +  - Chunyan Zhang <zhang.lyra@gmail.com>
> > > > > +
> > > > > +properties:
> > > > > +  "#clock-cells":
> > > > > +    const: 1
> > > > > +
> > > > > +  compatible:
> > > > > +    enum:
> > > > > +      - sprd,ums512-apahb-gate
> > > > > +      - sprd,ums512-ap-clk
> > > > > +      - sprd,ums512-aonapb-clk
> > > > > +      - sprd,ums512-pmu-gate
> > > > > +      - sprd,ums512-g0-pll
> > > > > +      - sprd,ums512-g2-pll
> > > > > +      - sprd,ums512-g3-pll
> > > > > +      - sprd,ums512-gc-pll
> > > > > +      - sprd,ums512-aon-gate
> > > > > +      - sprd,ums512-audcpapb-gate
> > > > > +      - sprd,ums512-audcpahb-gate
> > > > > +      - sprd,ums512-gpu-clk
> > > > > +      - sprd,ums512-mm-clk
> > > > > +      - sprd,ums512-mm-gate-clk
> > > > > +      - sprd,ums512-apapb-gate
> > > > > +
> > > > > +  clocks:
> > > > > +    minItems: 1
> > > > > +    maxItems: 4
> > > > > +    description: |
> > > > > +      The input parent clock(s) phandle for this clock, only list fixed
> > > > > +      clocks which are declared in devicetree.
> > > > > +
> > > > > +  clock-names:
> > > > > +    minItems: 1
> > > > > +    maxItems: 4
> > > > > +    items:
> > > > > +      - const: ext-26m
> > > > > +      - const: ext-32k
> > > > > +      - const: ext-4m
> > > > > +      - const: rco-100m
> > > > > +
> > > > > +  reg:
> > > > > +    maxItems: 1
> > > > > +
> > > > > +required:
> > > > > +  - compatible
> > > > > +  - '#clock-cells'
> > > > > +
> > > > > +if:
> > > > > +  properties:
> > > > > +    compatible:
> > > > > +      enum:
> > > > > +        - sprd,ums512-ap-clk
> > > > > +        - sprd,ums512-aonapb-clk
> > > > > +        - sprd,ums512-mm-clk
> > > > > +then:
> > > > > +  required:
> > > > > +    - reg
> > > > > +
> > > > > +else:
> > > > > +  description: |
> > > > > +    Other UMS512 clock nodes should be the child of a syscon node in
> > > > > +    which compatible string should be:
> > > > > +            "sprd,ums512-glbregs", "syscon", "simple-mfd"
> > > > > +
> > > > > +    The 'reg' property for the clock node is also required if there is a sub
> > > > > +    range of registers for the clocks.
> > > >
> > > > In which cases is this not true?
> > >
> > > Seems not needed, I will remove 'reg' property for this kind of cases.
> >
> > Wrong direction. Please keep 'reg'. My question is why can't you
> > always have it? That is the preference.
>
> Ok. I will address. BTW, do we need 'reg' even though the driver
> doesn't read this property? Does that because DT should reflect
> hardware topology?

Yes and yes.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
new file mode 100644
index 000000000000..be3c37180279
--- /dev/null
+++ b/Documentation/devicetree/bindings/clock/sprd,ums512-clk.yaml
@@ -0,0 +1,106 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+# Copyright 2019-2021 Unisoc Inc.
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/clock/sprd,ums512-clk.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: UMS512 Clock Control Unit Device Tree Bindings
+
+maintainers:
+  - Orson Zhai <orsonzhai@gmail.com>
+  - Baolin Wang <baolin.wang7@gmail.com>
+  - Chunyan Zhang <zhang.lyra@gmail.com>
+
+properties:
+  "#clock-cells":
+    const: 1
+
+  compatible:
+    enum:
+      - sprd,ums512-apahb-gate
+      - sprd,ums512-ap-clk
+      - sprd,ums512-aonapb-clk
+      - sprd,ums512-pmu-gate
+      - sprd,ums512-g0-pll
+      - sprd,ums512-g2-pll
+      - sprd,ums512-g3-pll
+      - sprd,ums512-gc-pll
+      - sprd,ums512-aon-gate
+      - sprd,ums512-audcpapb-gate
+      - sprd,ums512-audcpahb-gate
+      - sprd,ums512-gpu-clk
+      - sprd,ums512-mm-clk
+      - sprd,ums512-mm-gate-clk
+      - sprd,ums512-apapb-gate
+
+  clocks:
+    minItems: 1
+    maxItems: 4
+    description: |
+      The input parent clock(s) phandle for this clock, only list fixed
+      clocks which are declared in devicetree.
+
+  clock-names:
+    minItems: 1
+    maxItems: 4
+    items:
+      - const: ext-26m
+      - const: ext-32k
+      - const: ext-4m
+      - const: rco-100m
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - '#clock-cells'
+
+if:
+  properties:
+    compatible:
+      enum:
+        - sprd,ums512-ap-clk
+        - sprd,ums512-aonapb-clk
+        - sprd,ums512-mm-clk
+then:
+  required:
+    - reg
+
+else:
+  description: |
+    Other UMS512 clock nodes should be the child of a syscon node in
+    which compatible string should be:
+            "sprd,ums512-glbregs", "syscon", "simple-mfd"
+
+    The 'reg' property for the clock node is also required if there is a sub
+    range of registers for the clocks.
+
+additionalProperties: false
+
+examples:
+  - |
+    ap_clk: clock-controller@20200000 {
+      compatible = "sprd,ums512-ap-clk";
+      reg = <0x20200000 0x1000>;
+      clocks = <&ext_26m>;
+      clock-names = "ext-26m";
+      #clock-cells = <1>;
+    };
+
+  - |
+    ap_apb_regs: syscon@71000000 {
+      compatible = "sprd,ums512-glbregs", "syscon", "simple-mfd";
+      reg = <0x71000000 0x3000>;
+      #address-cells = <1>;
+      #size-cells = <1>;
+      ranges = <0 0x71000000 0x3000>;
+
+      apahb_gate: clock-controller@0 {
+        compatible = "sprd,ums512-apahb-gate";
+        reg = <0x0 0x2000>;
+        #clock-cells = <1>;
+      };
+    };
+...