RE: [PATCH V4 1/4] dt-bindings: imx: Add clock binding doc for i.MX8MN

[Anson Huang <anson.huang@xxxxxxx>]

Hi, Maxime

> -----Original Message-----
> From: Maxime Ripard <maxime.ripard@xxxxxxxxxxx>
> Sent: Thursday, June 6, 2019 3:41 PM
> To: Anson Huang <anson.huang@xxxxxxx>
> Cc: mturquette@xxxxxxxxxxxx; sboyd@xxxxxxxxxx; robh+dt@xxxxxxxxxx;
> mark.rutland@xxxxxxx; shawnguo@xxxxxxxxxx; s.hauer@xxxxxxxxxxxxxx;
> kernel@xxxxxxxxxxxxxx; festevam@xxxxxxxxx; catalin.marinas@xxxxxxx;
> will.deacon@xxxxxxx; olof@xxxxxxxxx; jagan@xxxxxxxxxxxxxxxxxxxx;
> horms+renesas@xxxxxxxxxxxx; bjorn.andersson@xxxxxxxxxx; Leonard Crestez
> <leonard.crestez@xxxxxxx>; dinguyen@xxxxxxxxxx;
> enric.balletbo@xxxxxxxxxxxxx; Aisheng Dong <aisheng.dong@xxxxxxx>;
> Abel Vesa <abel.vesa@xxxxxxx>; Jacky Bai <ping.bai@xxxxxxx>;
> l.stach@xxxxxxxxxxxxxx; Peng Fan <peng.fan@xxxxxxx>; linux-
> clk@xxxxxxxxxxxxxxx; devicetree@xxxxxxxxxxxxxxx; linux-arm-
> kernel@xxxxxxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx; dl-linux-imx
> <linux-imx@xxxxxxx>
> Subject: Re: [PATCH V4 1/4] dt-bindings: imx: Add clock binding doc for
> i.MX8MN
> 
> Hi,
> 
> On Thu, Jun 06, 2019 at 09:33:20AM +0800, Anson.Huang@xxxxxxx wrote:
> > From: Anson Huang <Anson.Huang@xxxxxxx>
> >
> > Add the clock binding doc for i.MX8MN.
> >
> > Signed-off-by: Anson Huang <Anson.Huang@xxxxxxx>
> > ---
> > Changes since V3:
> > 	- switch binding doc from .txt to .yaml.
> > ---
> >  .../devicetree/bindings/clock/imx8mn-clock.yaml    | 115 +++++++++++
> >  include/dt-bindings/clock/imx8mn-clock.h           | 215
> +++++++++++++++++++++
> >  2 files changed, 330 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/clock/imx8mn-clock.yaml
> >  create mode 100644 include/dt-bindings/clock/imx8mn-clock.h
> >
> > diff --git a/Documentation/devicetree/bindings/clock/imx8mn-clock.yaml
> > b/Documentation/devicetree/bindings/clock/imx8mn-clock.yaml
> > new file mode 100644
> > index 0000000..8cb8fcf
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/clock/imx8mn-clock.yaml
> > @@ -0,0 +1,115 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/bindings/clock/imx8mn-clock.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: NXP i.MX8M Nano Clock Control Module Binding
> > +
> > +maintainers:
> > +  - Anson Huang <Anson.Huang@xxxxxxx>
> > +
> > +description: |
> > +  NXP i.MX8M Nano clock control module is an integrated clock
> > +controller, which
> > +  generates and supplies to all modules.
> > +
> > +  This binding uses common clock bindings  [1]
> > + Documentation/devicetree/bindings/clock/clock-bindings.txt
> 
> Which part exactly are you using?
> 
> I'm not sure it's worth referring to. Any provider property should be listed
> here, and the consumer properties are already checked.

Agreed, I will remove this reference statement in next version.

> 
> > +properties:
> > +  compatible:
> > +    const: fsl,imx8mn-ccm
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    items:
> > +      - description: 32k osc
> > +      - description: 24m osc
> > +      - description: ext1 clock input
> > +      - description: ext2 clock input
> > +      - description: ext3 clock input
> > +      - description: ext4 clock input
> > +
> > +  clock-names:
> > +    items:
> > +      - const: osc_32k
> > +      - const: osc_24m
> > +      - const: clk_ext1
> > +      - const: clk_ext2
> > +      - const: clk_ext3
> > +      - const: clk_ext4
> > +
> > +  '#clock-cells':
> > +    const: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - clocks
> > +  - clock-names
> > +  - '#clock-cells'
> > +
> > +examples:
> > +  # Clock Control Module node:
> > +  - |
> > +    clk: clock-controller@30380000 {
> > +        compatible = "fsl,imx8mn-ccm";
> > +        reg = <0x0 0x30380000 0x0 0x10000>;
> > +        #clock-cells = <1>;
> > +        clocks = <&osc_32k>, <&osc_24m>, <&clk_ext1>,
> > +                 <&clk_ext2>, <&clk_ext3>, <&clk_ext4>;
> > +        clock-names = "osc_32k", "osc_24m", "clk_ext1",
> > +                      "clk_ext2", "clk_ext3", "clk_ext4";
> > +    };
> > +
> > +  # Required external clocks for Clock Control Module node:
> > +  - |
> > +    osc_32k: clock-osc-32k {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency = <32768>;
> > +	clock-output-names = "osc_32k";
> > +    };
> > +
> > +    osc_24m: clock-osc-24m {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency = <24000000>;
> > +        clock-output-names = "osc_24m";
> > +    };
> > +
> > +    clk_ext1: clock-ext1 {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency = <133000000>;
> > +        clock-output-names = "clk_ext1";
> > +    };
> > +
> > +    clk_ext2: clock-ext2 {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency = <133000000>;
> > +        clock-output-names = "clk_ext2";
> > +    };
> > +
> > +    clk_ext3: clock-ext3 {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency = <133000000>;
> > +        clock-output-names = "clk_ext3";
> > +    };
> > +
> > +    clk_ext4: clock-ext4 {
> > +        compatible = "fixed-clock";
> > +        #clock-cells = <0>;
> > +        clock-frequency= <133000000>;
> > +        clock-output-names = "clk_ext4";
> > +    };
> > +
> > +  # The clock consumer should specify the desired clock by having the
> > + clock  # ID in its "clocks" phandle cell. See
> > + include/dt-bindings/clock/imx8mn-clock.h
> > +  # for the full list of i.MX8M Nano clock IDs.
> 
> I guess this could be part of the clock-cells description.
> 

OK.

Thanks,
Anson.

> Once fixed,
> Reviewed-by: Maxime Ripard <maxime.ripard@xxxxxxxxxxx>
> 
> Maxime
> 
> --
> Maxime Ripard, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com