Re: [PATCH v4 net-next 8/9] dt-bindings: net: add generic ethernet-switch-port binding

Colin Foster
2022-12-07T02:49:44Z

On Tue, Dec 06, 2022 at 05:50:49PM +0200, Vladimir Oltean wrote:
> On Fri, Dec 02, 2022 at 12:45:58PM -0800, Colin Foster wrote:
> > --- a/Documentation/devicetree/bindings/net/dsa/dsa-port.yaml
> > +++ b/Documentation/devicetree/bindings/net/dsa/dsa-port.yaml
> > @@ -4,7 +4,7 @@
> > $id: http://devicetree.org/schemas/net/dsa/dsa-port.yaml#
> > $schema: http://devicetree.org/meta-schemas/core.yaml#
> >
> > -title: Ethernet Switch port Device Tree Bindings
> > +title: Generic DSA Switch port
>
> What are the capitalization rules in titles? Looks odd that "port" is
> lowercase but "switch" isn't.

Agreed. A quick grep for "title:\ " shows... a fair amount of
inconsistency. I'd lean toward Port. [insert nautical and/or fortified
wine joke here]

>
> >
> > maintainers:
> > - Andrew Lunn <andrew@lunn.ch>
> > @@ -14,8 +14,7 @@ maintainers:
> > description:
> > Ethernet switch port Description
> >
> > -allOf:
> > - - $ref: /schemas/net/ethernet-controller.yaml#
> > +$ref: /schemas/net/ethernet-switch-port.yaml#
> >
> > properties:
> > reg:
> > @@ -58,25 +57,6 @@ properties:
> > - rtl8_4t
> > - seville
> >
> > - phy-handle: true
> > -
> > - phy-mode: true
> > -
> > - fixed-link: true
> > -
> > - mac-address: true
> > -
> > - sfp: true
> > -
> > - managed: true
> > -
> > - rx-internal-delay-ps: true
> > -
> > - tx-internal-delay-ps: true
> > -
> > -required:
> > - - reg
> > -
> > # CPU and DSA ports must have phylink-compatible link descriptions
> > if:
> > oneOf:
> > diff --git a/Documentation/devicetree/bindings/net/ethernet-switch-port.yaml b/Documentation/devicetree/bindings/net/ethernet-switch-port.yaml
> > new file mode 100644
> > index 000000000000..3d7da6916fb8
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/net/ethernet-switch-port.yaml
> > @@ -0,0 +1,25 @@
> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/net/ethernet-switch-port.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Generic Ethernet Switch port
> > +
> > +maintainers:
> > + - Andrew Lunn <andrew@lunn.ch>
> > + - Florian Fainelli <f.fainelli@gmail.com>
> > + - Vivien Didelot <vivien.didelot@gmail.com>
> > +
> > +description:
> > + Ethernet switch port Description
>
> Sounds a bit too "lorem ipsum dolor sit amet". You can say that a port
> is a component of a switch which manages one MAC, and can pass Ethernet
> frames.

Good suggestion again. Happy to change this as well. I'm planning to
send an update late tomorrow (Wednesday) to give a couple days before
Sunday. Hopefully that's enough time for any suggestions on these last
couple issues.