Re: [PATCH 2/3] dt-bindings: clock: Document MA35D1 clock controller bindings

[Jacky Huang]

On 2022/4/1 上午 04:37, Rob Herring wrote:
> On Thu, Mar 31, 2022 at 10:42:55AM +0800, Jacky Huang wrote:
> > Add documentation to describe Nuvoton MA35D1 clock driver bindings.
> >
> > Signed-off-by: Jacky Huang <ychuang3@xxxxxxxxxxx>
> > ---
> >   .../bindings/clock/nuvoton,ma35d1-clk.yaml    | 59 +++++++++++++++++++
> >   1 file changed, 59 insertions(+)
> >   create mode 100644 Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml
> >
> > diff --git a/Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml b/Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml
> > new file mode 100644
> > index 000000000000..bf5474b10420
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/clock/nuvoton,ma35d1-clk.yaml
> > @@ -0,0 +1,59 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: https://apc01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fschemas%2Fclock%2Fnuvoton%2Cma35d1-clk.yaml%23&amp;data=04%7C01%7Cychuang3%40nuvoton.com%7C2af0b5b253d14b24de4e08da1356520e%7Ca3f24931d4034b4a94f17d83ac638e07%7C0%7C0%7C637843795866047143%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&amp;sdata=imev20A0MjoKYaL8o%2FXx3b%2FeCbSnXxVEjs9XqCLQZo0%3D&amp;reserved=0
> > +$schema: https://apc01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdevicetree.org%2Fmeta-schemas%2Fcore.yaml%23&amp;data=04%7C01%7Cychuang3%40nuvoton.com%7C2af0b5b253d14b24de4e08da1356520e%7Ca3f24931d4034b4a94f17d83ac638e07%7C0%7C0%7C637843795866047143%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000&amp;sdata=zYcNQdhT2KPxQeVzPJ8Tm5gzRxk6Z0j7O6Cy01LWDRU%3D&amp;reserved=0
> > +
> > +title: Nuvoton MA35D1 Clock Control Module Binding
> > +
> > +maintainers:
> > +  - Chi-Fang Li <cfli0@xxxxxxxxxxx>
> > +  - Jacky Huang <ychuang3@xxxxxxxxxxx>
> > +
> > +description: |
> > +  The MA35D1 clock controller generates clocks for the whole chip,
> > +  including system clocks and all peripheral clocks.
> > +
> > +  See also:
> > +    dt-bindings/clock/ma35d1-clk.h
> > +
> > +properties:
> > +  compatible:
> > +    const: nuvoton,ma35d1-clk
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  "#clock-cells":
> > +    const: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  assigned-clocks:
> > +    maxItems: 4
> These aren't usually in the clock controller...

"clocks" is actually not used. I will remove it.

Does the "aren't usually" include "assigned-clocks"?
I saw it in other vendors.
For example rk3399.dtsi
It presents in cru: clock-controller@ff760000 node.

We use "assigned-clocks" to declare the four output PLLs of the clock 
controller.

> > +
> > +  assigned-clock-rates:
> > +    maxItems: 4
> > +
> > +  clock-pll-mode:
> > +    maxItems: 4
> What's this? Not a standard property. Needs a type, description, and
> vendor prefix.

clock-pll-mode is a vendor specific property.
I would modify it as the following:

  nuvoton,clk-pll-mode:
    A list of PLL operation mode corresponding to DDRPLL, APLL, EPLL, 
and VPLL
    in sequential.
    $ref: /schemas/types.yaml#/definitions/uint32-array
    minItems: 4
    maxItems: 4
    items:
      enum: [ 0, 1, 2 ]

Is it OK?


> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - "#clock-cells"
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  # clock control module node:
> > +  - |
> > +    #include <dt-bindings/clock/nuvoton,ma35d1-clk.h>
> > +
> > +    clk: clock-controller@40460200 {
> > +        compatible = "nuvoton,ma35d1-clk";
> > +        reg = <0x40460200 0x100>;
> > +        #clock-cells = <1>;
> > +    };
> > +...
> > --
> > 2.30.2