diff mbox series

[net-next,v4,2/7] dt-bindings: net: mvusb: Fix up DSA example

Message ID 20231018-marvell-88e6152-wan-led-v4-2-3ee0c67383be@linaro.org
State New
Headers
Series Create a binding for the Marvell MV88E6xxx DSA switches |

Commit Message

Linus Walleij Oct. 18, 2023, 9:03 a.m. UTC 
  When adding a proper schema for the Marvell mx88e6xxx switch,
the scripts start complaining about this embedded example:

  dtschema/dtc warnings/errors:
  net/marvell,mvusb.example.dtb: switch@0: ports: '#address-cells'
  is a required property
  from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
  net/marvell,mvusb.example.dtb: switch@0: ports: '#size-cells'
  is a required property
  from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#

Fix this up by extending the example with those properties in
the ports node.

While we are at it, rename "ports" to "ethernet-ports" and rename
"switch" to "ethernet-switch" as this is recommended practice.

Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
---
 Documentation/devicetree/bindings/net/marvell,mvusb.yaml | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Rob Herring Oct. 18, 2023, 10:32 a.m. UTC | #1 
On Wed, 18 Oct 2023 11:03:41 +0200, Linus Walleij wrote:
> When adding a proper schema for the Marvell mx88e6xxx switch,
> the scripts start complaining about this embedded example:
> 
>   dtschema/dtc warnings/errors:
>   net/marvell,mvusb.example.dtb: switch@0: ports: '#address-cells'
>   is a required property
>   from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
>   net/marvell,mvusb.example.dtb: switch@0: ports: '#size-cells'
>   is a required property
>   from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
> 
> Fix this up by extending the example with those properties in
> the ports node.
> 
> While we are at it, rename "ports" to "ethernet-ports" and rename
> "switch" to "ethernet-switch" as this is recommended practice.
> 
> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
> ---
>  Documentation/devicetree/bindings/net/marvell,mvusb.yaml | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
Documentation/devicetree/bindings/net/marvell,mvusb.example.dtb: /example-0/usb/mdio@1/ethernet-switch@0: failed to match any schema with compatible: ['marvell,mv88e6190']

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/project/devicetree-bindings/patch/20231018-marvell-88e6152-wan-led-v4-2-3ee0c67383be@linaro.org

The base for the series is generally the latest rc1. A different dependency
should be noted in *this* patch.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit after running the above command yourself. Note
that DT_SCHEMA_FILES can be set to your schema file to speed up checking
your schema. However, it must be unset to test all examples with your schema.
Linus Walleij Oct. 18, 2023, 11:37 a.m. UTC | #2 
On Wed, Oct 18, 2023 at 12:32 PM Rob Herring <robh@kernel.org> wrote:

> dtschema/dtc warnings/errors:
> Documentation/devicetree/bindings/net/marvell,mvusb.example.dtb: /example-0/usb/mdio@1/ethernet-switch@0: failed to match any schema with compatible: ['marvell,mv88e6190']

Isn't that just because the bindings now come last in the series.
Which is in response to a review comment, hence this warning
didn't appear before.

Yours,
Linus Walleij
Andrew Lunn Oct. 18, 2023, 1:39 p.m. UTC | #3 
On Wed, Oct 18, 2023 at 11:03:41AM +0200, Linus Walleij wrote:
> When adding a proper schema for the Marvell mx88e6xxx switch,
> the scripts start complaining about this embedded example:
> 
>   dtschema/dtc warnings/errors:
>   net/marvell,mvusb.example.dtb: switch@0: ports: '#address-cells'
>   is a required property
>   from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
>   net/marvell,mvusb.example.dtb: switch@0: ports: '#size-cells'
>   is a required property
>   from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
> 
> Fix this up by extending the example with those properties in
> the ports node.
> 
> While we are at it, rename "ports" to "ethernet-ports" and rename
> "switch" to "ethernet-switch" as this is recommended practice.
> 
> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>

Reviewed-by: Andrew Lunn <andrew@lunn.ch>

    Andrew
Rob Herring Oct. 19, 2023, 1:45 p.m. UTC | #4 
On Wed, Oct 18, 2023 at 01:37:10PM +0200, Linus Walleij wrote:
> On Wed, Oct 18, 2023 at 12:32 PM Rob Herring <robh@kernel.org> wrote:
> 
> > dtschema/dtc warnings/errors:
> > Documentation/devicetree/bindings/net/marvell,mvusb.example.dtb: /example-0/usb/mdio@1/ethernet-switch@0: failed to match any schema with compatible: ['marvell,mv88e6190']
> 
> Isn't that just because the bindings now come last in the series.
> Which is in response to a review comment, hence this warning
> didn't appear before.

Yes. The only option that avoids this is squashing the 2 patches. I 
think it is fine to leave this as-is.

Rob
Vladimir Oltean Oct. 19, 2023, 2:26 p.m. UTC | #5 
On Thu, Oct 19, 2023 at 08:45:14AM -0500, Rob Herring wrote:
> On Wed, Oct 18, 2023 at 01:37:10PM +0200, Linus Walleij wrote:
> > On Wed, Oct 18, 2023 at 12:32 PM Rob Herring <robh@kernel.org> wrote:
> > 
> > > dtschema/dtc warnings/errors:
> > > Documentation/devicetree/bindings/net/marvell,mvusb.example.dtb: /example-0/usb/mdio@1/ethernet-switch@0: failed to match any schema with compatible: ['marvell,mv88e6190']
> > 
> > Isn't that just because the bindings now come last in the series.
> > Which is in response to a review comment, hence this warning
> > didn't appear before.
> 
> Yes. The only option that avoids this is squashing the 2 patches. I 
> think it is fine to leave this as-is.
> 
> Rob

Anyway, I'm surprised that the bot would send this email, since the
warning existed prior to this patch, and I would expect that the bot
only notifies of newly introduced issues.
Vladimir Oltean Oct. 19, 2023, 2:28 p.m. UTC | #6 
On Wed, Oct 18, 2023 at 11:03:41AM +0200, Linus Walleij wrote:
> When adding a proper schema for the Marvell mx88e6xxx switch,
> the scripts start complaining about this embedded example:
> 
>   dtschema/dtc warnings/errors:
>   net/marvell,mvusb.example.dtb: switch@0: ports: '#address-cells'
>   is a required property
>   from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
>   net/marvell,mvusb.example.dtb: switch@0: ports: '#size-cells'
>   is a required property
>   from schema $id: http://devicetree.org/schemas/net/dsa/marvell,mv88e6xxx.yaml#
> 
> Fix this up by extending the example with those properties in
> the ports node.
> 
> While we are at it, rename "ports" to "ethernet-ports" and rename
> "switch" to "ethernet-switch" as this is recommended practice.
> 
> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
> ---

Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Rob Herring Oct. 19, 2023, 8:23 p.m. UTC | #7 
On Thu, Oct 19, 2023 at 05:26:46PM +0300, Vladimir Oltean wrote:
> On Thu, Oct 19, 2023 at 08:45:14AM -0500, Rob Herring wrote:
> > On Wed, Oct 18, 2023 at 01:37:10PM +0200, Linus Walleij wrote:
> > > On Wed, Oct 18, 2023 at 12:32 PM Rob Herring <robh@kernel.org> wrote:
> > > 
> > > > dtschema/dtc warnings/errors:
> > > > Documentation/devicetree/bindings/net/marvell,mvusb.example.dtb: /example-0/usb/mdio@1/ethernet-switch@0: failed to match any schema with compatible: ['marvell,mv88e6190']
> > > 
> > > Isn't that just because the bindings now come last in the series.
> > > Which is in response to a review comment, hence this warning
> > > didn't appear before.
> > 
> > Yes. The only option that avoids this is squashing the 2 patches. I 
> > think it is fine to leave this as-is.
> > 
> > Rob
> 
> Anyway, I'm surprised that the bot would send this email, since the
> warning existed prior to this patch, and I would expect that the bot
> only notifies of newly introduced issues.

Oh right. Except that the node name changed in this patch and that 
changed the error message.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/marvell,mvusb.yaml b/Documentation/devicetree/bindings/net/marvell,mvusb.yaml
index 3a3325168048..ab838c1ffeed 100644
--- a/Documentation/devicetree/bindings/net/marvell,mvusb.yaml
+++ b/Documentation/devicetree/bindings/net/marvell,mvusb.yaml
@@ -50,11 +50,14 @@  examples:
                     #address-cells = <1>;
                     #size-cells = <0>;
 
-                    switch@0 {
+                    ethernet-switch@0 {
                             compatible = "marvell,mv88e6190";
                             reg = <0x0>;
 
-                            ports {
+                            ethernet-ports {
+                                    #address-cells = <1>;
+                                    #size-cells = <0>;
+
                                     /* Port definitions */
                             };