linux-kernel - [PATCH net-next v2 2/2] dt-bindings: net: microchip,ksz: document microchip,rmii-clk-internal

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20231017073548.15050-1-ante.knezic@helmholz.de>
Date:   Tue, 17 Oct 2023 09:35:48 +0200
From:   Ante Knezic <ante.knezic@...mholz.de>
To:     <olteanv@...il.com>
CC:     <andrew@...n.ch>, <ante.knezic@...mholz.de>, <conor+dt@...nel.org>,
        <davem@...emloft.net>, <devicetree@...r.kernel.org>,
        <edumazet@...gle.com>, <f.fainelli@...il.com>,
        <krzysztof.kozlowski+dt@...aro.org>, <kuba@...nel.org>,
        <linux-kernel@...r.kernel.org>, <marex@...x.de>,
        <netdev@...r.kernel.org>, <pabeni@...hat.com>,
        <robh+dt@...nel.org>, <woojung.huh@...rochip.com>
Subject: [PATCH net-next v2 2/2] dt-bindings: net: microchip,ksz: document microchip,rmii-clk-internal

> > +  microchip,rmii-clk-internal:
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description:
> > +      Set if the RMII reference clock is provided internally. Otherwise
> > +      reference clock should be provided externally.
> > +
> > +if:
> > +  not:
> > +    properties:
> > +      compatible:
> > +        enum:
> > +          - microchip,ksz8863
> > +          - microchip,ksz8873
> > +then:
> > +  not:
> > +    required:
> > +      - microchip,rmii-clk-internal
> 
> I think that what you want to express is that microchip,rmii-clk-internal
> is only defined for microchip,ksz8863 and microchip,ksz8873.
> Can't you describe that as "if: properties: compatible: (...) then:
> properties: microchip,rmii-clk-internal"?

If I understood you correctly you are refering to a solution like
if:
  properties:
    compatible:
      enum:
        - microchip,ksz8863
        - microchip,ksz8873
then:
  properties:
    microchip,rmii-clk-internal:
      $ref: /schemas/types.yaml#/definitions/flag
      description:
        Set if the RMII reference clock is provided internally. Otherwise
        reference clock should be provided externally.

This was already suggested in v1, but was not a satisfactory solution
according to Mr. Conor Dooley:

>> On Tue, 10 Oct 2023 16:25:55 +0100, Conor Dooley wrote:
>> > On Tue, Oct 10, 2023 at 03:18:54PM +0200, Ante Knezic wrote:
>> > > Add documentation for selecting reference rmii clock on KSZ88X3 devices
>> > > 
>> > > Signed-off-by: Ante Knezic <ante.knezic@...mholz.de>
>> > > ---
>> > >  Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml | 6 ++++++
>> > >  1 file changed, 6 insertions(+)
>> > > 
>> > > diff --git a/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml b/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
>> > > index e51be1ac0362..3df5d2e72dba 100644
>> > > --- a/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
>> > > +++ b/Documentation/devicetree/bindings/net/dsa/microchip,ksz.yaml
>> > > @@ -49,6 +49,12 @@ properties:
>> > >        Set if the output SYNCLKO clock should be disabled. Do not mix with
>> > >        microchip,synclko-125.
>> > >  
>> > > +  microchip,rmii-clk-internal:
>> > > +    $ref: /schemas/types.yaml#/definitions/flag
>> > > +    description:
>> > > +      Set if the RMII reference clock should be provided internally.
>> > 
>> > > Applies only
>> > > +      to KSZ88X3 devices.
>> > 
>> > This should be enforced by the schema, the example schema in the docs
>> > should show you how to do this.
>> 
>> I am guessing you are refering to limiting the property to ksz88x3 devices?
>> Something like:
>> 
>> if:
>>   properties:
>>     compatible:
>>       enum:
>>         - microchip,ksz8863
>>         - microchip,ksz8873
>> then:
>>   properties:
>>     microchip,rmii-clk-internal:
>>       $ref: /schemas/types.yaml#/definitions/flag
>>       description:
>>         Set if the RMII reference clock is provided internally. Otherwise
>>         reference clock should be provided externally.
>
>Not quite. The definition of the property should be outside the if/then,
>but one should be used to allow/disallow the property.