2024-01-09 17:08:43

by Rob Herring (Arm)

[permalink] [raw]
Subject: Re: [PATCH v22 1/8] dt-bindings: clock: npcm845: Add reference 25m clock property

On Mon, Jan 08, 2024 at 03:54:14PM +0200, Tomer Maimon wrote:
> The NPCM8XX clock driver uses 25Mhz external clock, therefor adding

therefore

> refclk property.

'refclk' is not a property.

>
> Signed-off-by: Tomer Maimon <[email protected]>
> ---
> .../bindings/clock/nuvoton,npcm845-clk.yaml | 16 ++++++++++++++++
> 1 file changed, 16 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml b/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml
> index b901ca13cd25..0b642bfce292 100644
> --- a/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml
> +++ b/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml
> @@ -21,6 +21,14 @@ properties:
> reg:
> maxItems: 1
>
> + clocks:
> + items:
> + - description: 25Mhz referance clock

reference

> +
> + clock-names:
> + items:
> + - const: refclk
> +
> '#clock-cells':
> const: 1
> description:
> @@ -30,12 +38,20 @@ properties:
> required:
> - compatible
> - reg
> + - clocks
> + - clock-names

New required properties are an ABI break. That's fine if you explain why
that's okay in the commit msg.


> - '#clock-cells'
>
> additionalProperties: false
>
> examples:
> - |
> + refclk: refclk-25mhz {
> + compatible = "fixed-clock";
> + #clock-cells = <0>;
> + clock-frequency = <25000000>;
> + };

Examples don't need to show providers.

> +
> ahb {
> #address-cells = <2>;
> #size-cells = <2>;
> --
> 2.34.1
>


2024-01-10 13:48:31

by Tomer Maimon

[permalink] [raw]
Subject: Re: [PATCH v22 1/8] dt-bindings: clock: npcm845: Add reference 25m clock property

Hi Rob,

Thanks for your comment.

On Tue, 9 Jan 2024 at 19:08, Rob Herring <[email protected]> wrote:
>
> On Mon, Jan 08, 2024 at 03:54:14PM +0200, Tomer Maimon wrote:
> > The NPCM8XX clock driver uses 25Mhz external clock, therefor adding
>
> therefore
>
> > refclk property.
>
> 'refclk' is not a property.
>
> >
> > Signed-off-by: Tomer Maimon <[email protected]>
> > ---
> > .../bindings/clock/nuvoton,npcm845-clk.yaml | 16 ++++++++++++++++
> > 1 file changed, 16 insertions(+)
> >
> > diff --git a/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml b/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml
> > index b901ca13cd25..0b642bfce292 100644
> > --- a/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml
> > +++ b/Documentation/devicetree/bindings/clock/nuvoton,npcm845-clk.yaml
> > @@ -21,6 +21,14 @@ properties:
> > reg:
> > maxItems: 1
> >
> > + clocks:
> > + items:
> > + - description: 25Mhz referance clock
>
> reference
>
> > +
> > + clock-names:
> > + items:
> > + - const: refclk
> > +
> > '#clock-cells':
> > const: 1
> > description:
> > @@ -30,12 +38,20 @@ properties:
> > required:
> > - compatible
> > - reg
> > + - clocks
> > + - clock-names
>
> New required properties are an ABI break. That's fine if you explain why
> that's okay in the commit msg.
What do you mean?
Could I add the new required properties to the required list?
>
>
> > - '#clock-cells'
> >
> > additionalProperties: false
> >
> > examples:
> > - |
> > + refclk: refclk-25mhz {
> > + compatible = "fixed-clock";
> > + #clock-cells = <0>;
> > + clock-frequency = <25000000>;
> > + };
>
> Examples don't need to show providers.
>
> > +
> > ahb {
> > #address-cells = <2>;
> > #size-cells = <2>;
> > --
> > 2.34.1
> >

Best regards,

Tomer

2024-01-10 20:54:28

by Krzysztof Kozlowski

[permalink] [raw]
Subject: Re: [PATCH v22 1/8] dt-bindings: clock: npcm845: Add reference 25m clock property

On 10/01/2024 14:47, Tomer Maimon wrote:
>>> +
>>> + clock-names:
>>> + items:
>>> + - const: refclk
>>> +
>>> '#clock-cells':
>>> const: 1
>>> description:
>>> @@ -30,12 +38,20 @@ properties:
>>> required:
>>> - compatible
>>> - reg
>>> + - clocks
>>> + - clock-names
>>
>> New required properties are an ABI break. That's fine if you explain why
>> that's okay in the commit msg.
> What do you mean?

I think it was clear. Which part is not clear?

> Could I add the new required properties to the required list?

You just did, didn't you? And received feedback that you are breaking
the ABI.

Best regards,
Krzysztof


2024-01-10 21:48:10

by Stephen Boyd

[permalink] [raw]
Subject: Re: [PATCH v22 1/8] dt-bindings: clock: npcm845: Add reference 25m clock property

Quoting Krzysztof Kozlowski (2024-01-10 12:54:14)
> On 10/01/2024 14:47, Tomer Maimon wrote:
> >>> +
> >>> + clock-names:
> >>> + items:
> >>> + - const: refclk
> >>> +
> >>> '#clock-cells':
> >>> const: 1
> >>> description:
> >>> @@ -30,12 +38,20 @@ properties:
> >>> required:
> >>> - compatible
> >>> - reg
> >>> + - clocks
> >>> + - clock-names
> >>
> >> New required properties are an ABI break. That's fine if you explain why
> >> that's okay in the commit msg.
> > What do you mean?
>
> I think it was clear. Which part is not clear?
>
> > Could I add the new required properties to the required list?
>
> You just did, didn't you? And received feedback that you are breaking
> the ABI.
>

It's fine to break the ABI as long as the commit message explains that
the driver isn't merged yet.

2024-01-16 15:22:09

by Tomer Maimon

[permalink] [raw]
Subject: Re: [PATCH v22 1/8] dt-bindings: clock: npcm845: Add reference 25m clock property

Hi Stephen,

On Wed, 10 Jan 2024 at 23:46, Stephen Boyd <[email protected]> wrote:
>
> Quoting Krzysztof Kozlowski (2024-01-10 12:54:14)
> > On 10/01/2024 14:47, Tomer Maimon wrote:
> > >>> +
> > >>> + clock-names:
> > >>> + items:
> > >>> + - const: refclk
> > >>> +
> > >>> '#clock-cells':
> > >>> const: 1
> > >>> description:
> > >>> @@ -30,12 +38,20 @@ properties:
> > >>> required:
> > >>> - compatible
> > >>> - reg
> > >>> + - clocks
> > >>> + - clock-names
> > >>
> > >> New required properties are an ABI break. That's fine if you explain why
> > >> that's okay in the commit msg.
> > > What do you mean?
> >
> > I think it was clear. Which part is not clear?
> >
> > > Could I add the new required properties to the required list?
> >
> > You just did, didn't you? And received feedback that you are breaking
> > the ABI.
> >
>
> It's fine to break the ABI as long as the commit message explains that
> the driver isn't merged yet.

Thanks for your clarification.

Best regards,

Tomer