diff mbox series

[net-next,v2,2/2] dt-bindings: net: add schema for Microchip/SMSC LAN95xx USB Ethernet controllers

Message ID 20220209081025.2178435-3-o.rempel@pengutronix.de (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series provide yaml schema for some of USB ethernet controllers | expand

Checks

Context Check Description
netdev/tree_selection success Clearly marked for net-next
netdev/fixes_present success Fixes tag not required for -next series
netdev/subject_prefix success Link
netdev/cover_letter success Series has a cover letter
netdev/patch_count success Link
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 0 this patch: 0
netdev/cc_maintainers success CCed 6 of 6 maintainers
netdev/build_clang success Errors and warnings before: 0 this patch: 0
netdev/module_param success Was 0 now: 0
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 0 this patch: 0
netdev/checkpatch warning WARNING: added, moved or deleted file(s), does MAINTAINERS need updating?
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0

Commit Message

Oleksij Rempel Feb. 9, 2022, 8:10 a.m. UTC 
Create initial schema for Microchip/SMSC LAN95xx USB Ethernet controllers and
import all currently supported USB IDs form drivers/net/usb/smsc95xx.c

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
 .../bindings/net/microchip,lan95xx.yaml       | 80 +++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/net/microchip,lan95xx.yaml

Comments

Rob Herring Feb. 9, 2022, 3:35 p.m. UTC | #1 
On Wed, 09 Feb 2022 09:10:25 +0100, Oleksij Rempel wrote:
> Create initial schema for Microchip/SMSC LAN95xx USB Ethernet controllers and
> import all currently supported USB IDs form drivers/net/usb/smsc95xx.c
> 
> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> ---
>  .../bindings/net/microchip,lan95xx.yaml       | 80 +++++++++++++++++++
>  1 file changed, 80 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> 

Running 'make dtbs_check' with the schema in this patch gives the
following warnings. Consider if they are expected or the schema is
incorrect. These may not be new warnings.

Note that it is not yet a requirement to have 0 warnings for dtbs_check.
This will change in the future.

Full log is available here: https://patchwork.ozlabs.org/patch/1590223


smsc@2: $nodename:0: 'smsc@2' does not match '^ethernet(@.*)?$'
	arch/arm/boot/dts/tegra30-ouya.dt.yaml

usbether@1: $nodename:0: 'usbether@1' does not match '^ethernet(@.*)?$'
	arch/arm64/boot/dts/broadcom/bcm2837-rpi-3-b.dt.yaml
	arch/arm64/boot/dts/freescale/imx8mm-kontron-n801x-s.dt.yaml
	arch/arm/boot/dts/bcm2835-rpi-b.dt.yaml
	arch/arm/boot/dts/bcm2835-rpi-b-plus.dt.yaml
	arch/arm/boot/dts/bcm2835-rpi-b-rev2.dt.yaml
	arch/arm/boot/dts/bcm2836-rpi-2-b.dt.yaml
	arch/arm/boot/dts/bcm2837-rpi-3-b.dt.yaml
	arch/arm/boot/dts/omap3-beagle-xm-ab.dt.yaml
	arch/arm/boot/dts/omap3-beagle-xm.dt.yaml
	arch/arm/boot/dts/omap4-panda-a4.dt.yaml
	arch/arm/boot/dts/omap4-panda.dt.yaml
	arch/arm/boot/dts/omap4-panda-es.dt.yaml

usbether@3: $nodename:0: 'usbether@3' does not match '^ethernet(@.*)?$'
	arch/arm/boot/dts/omap5-uevm.dt.yaml
Rob Herring Feb. 9, 2022, 3:38 p.m. UTC | #2 
On Wed, Feb 9, 2022 at 9:35 AM Rob Herring <robh@kernel.org> wrote:
>
> On Wed, 09 Feb 2022 09:10:25 +0100, Oleksij Rempel wrote:
> > Create initial schema for Microchip/SMSC LAN95xx USB Ethernet controllers and
> > import all currently supported USB IDs form drivers/net/usb/smsc95xx.c
> >
> > Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> > ---
> >  .../bindings/net/microchip,lan95xx.yaml       | 80 +++++++++++++++++++
> >  1 file changed, 80 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> >
>
> Running 'make dtbs_check' with the schema in this patch gives the
> following warnings. Consider if they are expected or the schema is
> incorrect. These may not be new warnings.
>
> Note that it is not yet a requirement to have 0 warnings for dtbs_check.
> This will change in the future.
>
> Full log is available here: https://patchwork.ozlabs.org/patch/1590223
>
>
> smsc@2: $nodename:0: 'smsc@2' does not match '^ethernet(@.*)?$'
>         arch/arm/boot/dts/tegra30-ouya.dt.yaml
>
> usbether@1: $nodename:0: 'usbether@1' does not match '^ethernet(@.*)?$'
>         arch/arm64/boot/dts/broadcom/bcm2837-rpi-3-b.dt.yaml
>         arch/arm64/boot/dts/freescale/imx8mm-kontron-n801x-s.dt.yaml
>         arch/arm/boot/dts/bcm2835-rpi-b.dt.yaml
>         arch/arm/boot/dts/bcm2835-rpi-b-plus.dt.yaml
>         arch/arm/boot/dts/bcm2835-rpi-b-rev2.dt.yaml
>         arch/arm/boot/dts/bcm2836-rpi-2-b.dt.yaml
>         arch/arm/boot/dts/bcm2837-rpi-3-b.dt.yaml
>         arch/arm/boot/dts/omap3-beagle-xm-ab.dt.yaml
>         arch/arm/boot/dts/omap3-beagle-xm.dt.yaml
>         arch/arm/boot/dts/omap4-panda-a4.dt.yaml
>         arch/arm/boot/dts/omap4-panda.dt.yaml
>         arch/arm/boot/dts/omap4-panda-es.dt.yaml
>
> usbether@3: $nodename:0: 'usbether@3' does not match '^ethernet(@.*)?$'
>         arch/arm/boot/dts/omap5-uevm.dt.yaml

So this binding is already in use, but was undocumented? Or did you
forget to remove the .txt file? The commit message should highlight
all this.

(I don't expect you to fix all these warnings, I was just surprised to
see them given this is an 'initial schema'.)

Rob
Oleksij Rempel Feb. 9, 2022, 4:02 p.m. UTC | #3 
On Wed, Feb 09, 2022 at 09:38:57AM -0600, Rob Herring wrote:
> On Wed, Feb 9, 2022 at 9:35 AM Rob Herring <robh@kernel.org> wrote:
> >
> > On Wed, 09 Feb 2022 09:10:25 +0100, Oleksij Rempel wrote:
> > > Create initial schema for Microchip/SMSC LAN95xx USB Ethernet controllers and
> > > import all currently supported USB IDs form drivers/net/usb/smsc95xx.c
> > >
> > > Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> > > ---
> > >  .../bindings/net/microchip,lan95xx.yaml       | 80 +++++++++++++++++++
> > >  1 file changed, 80 insertions(+)
> > >  create mode 100644 Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> > >
> >
> > Running 'make dtbs_check' with the schema in this patch gives the
> > following warnings. Consider if they are expected or the schema is
> > incorrect. These may not be new warnings.
> >
> > Note that it is not yet a requirement to have 0 warnings for dtbs_check.
> > This will change in the future.
> >
> > Full log is available here: https://patchwork.ozlabs.org/patch/1590223
> >
> >
> > smsc@2: $nodename:0: 'smsc@2' does not match '^ethernet(@.*)?$'
> >         arch/arm/boot/dts/tegra30-ouya.dt.yaml
> >
> > usbether@1: $nodename:0: 'usbether@1' does not match '^ethernet(@.*)?$'
> >         arch/arm64/boot/dts/broadcom/bcm2837-rpi-3-b.dt.yaml
> >         arch/arm64/boot/dts/freescale/imx8mm-kontron-n801x-s.dt.yaml
> >         arch/arm/boot/dts/bcm2835-rpi-b.dt.yaml
> >         arch/arm/boot/dts/bcm2835-rpi-b-plus.dt.yaml
> >         arch/arm/boot/dts/bcm2835-rpi-b-rev2.dt.yaml
> >         arch/arm/boot/dts/bcm2836-rpi-2-b.dt.yaml
> >         arch/arm/boot/dts/bcm2837-rpi-3-b.dt.yaml
> >         arch/arm/boot/dts/omap3-beagle-xm-ab.dt.yaml
> >         arch/arm/boot/dts/omap3-beagle-xm.dt.yaml
> >         arch/arm/boot/dts/omap4-panda-a4.dt.yaml
> >         arch/arm/boot/dts/omap4-panda.dt.yaml
> >         arch/arm/boot/dts/omap4-panda-es.dt.yaml
> >
> > usbether@3: $nodename:0: 'usbether@3' does not match '^ethernet(@.*)?$'
> >         arch/arm/boot/dts/omap5-uevm.dt.yaml
> 
> So this binding is already in use, but was undocumented?

Ack.

> Or did you forget to remove the .txt file?

No, there was no documentation.

> The commit message should highlight all this.
> 
> (I don't expect you to fix all these warnings, I was just surprised to
> see them given this is an 'initial schema'.)

This patches was create before I needed to use it. Should I resent it
with new commit message?

Regards,
Oleksij
Rob Herring Feb. 11, 2022, 4:49 p.m. UTC | #4 
On Wed, Feb 09, 2022 at 05:02:52PM +0100, Oleksij Rempel wrote:
> On Wed, Feb 09, 2022 at 09:38:57AM -0600, Rob Herring wrote:
> > On Wed, Feb 9, 2022 at 9:35 AM Rob Herring <robh@kernel.org> wrote:
> > >
> > > On Wed, 09 Feb 2022 09:10:25 +0100, Oleksij Rempel wrote:
> > > > Create initial schema for Microchip/SMSC LAN95xx USB Ethernet controllers and
> > > > import all currently supported USB IDs form drivers/net/usb/smsc95xx.c
> > > >
> > > > Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> > > > ---
> > > >  .../bindings/net/microchip,lan95xx.yaml       | 80 +++++++++++++++++++
> > > >  1 file changed, 80 insertions(+)
> > > >  create mode 100644 Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> > > >
> > >
> > > Running 'make dtbs_check' with the schema in this patch gives the
> > > following warnings. Consider if they are expected or the schema is
> > > incorrect. These may not be new warnings.
> > >
> > > Note that it is not yet a requirement to have 0 warnings for dtbs_check.
> > > This will change in the future.
> > >
> > > Full log is available here: https://patchwork.ozlabs.org/patch/1590223
> > >
> > >
> > > smsc@2: $nodename:0: 'smsc@2' does not match '^ethernet(@.*)?$'
> > >         arch/arm/boot/dts/tegra30-ouya.dt.yaml
> > >
> > > usbether@1: $nodename:0: 'usbether@1' does not match '^ethernet(@.*)?$'
> > >         arch/arm64/boot/dts/broadcom/bcm2837-rpi-3-b.dt.yaml
> > >         arch/arm64/boot/dts/freescale/imx8mm-kontron-n801x-s.dt.yaml
> > >         arch/arm/boot/dts/bcm2835-rpi-b.dt.yaml
> > >         arch/arm/boot/dts/bcm2835-rpi-b-plus.dt.yaml
> > >         arch/arm/boot/dts/bcm2835-rpi-b-rev2.dt.yaml
> > >         arch/arm/boot/dts/bcm2836-rpi-2-b.dt.yaml
> > >         arch/arm/boot/dts/bcm2837-rpi-3-b.dt.yaml
> > >         arch/arm/boot/dts/omap3-beagle-xm-ab.dt.yaml
> > >         arch/arm/boot/dts/omap3-beagle-xm.dt.yaml
> > >         arch/arm/boot/dts/omap4-panda-a4.dt.yaml
> > >         arch/arm/boot/dts/omap4-panda.dt.yaml
> > >         arch/arm/boot/dts/omap4-panda-es.dt.yaml
> > >
> > > usbether@3: $nodename:0: 'usbether@3' does not match '^ethernet(@.*)?$'
> > >         arch/arm/boot/dts/omap5-uevm.dt.yaml
> > 
> > So this binding is already in use, but was undocumented?
> 
> Ack.
> 
> > Or did you forget to remove the .txt file?
> 
> No, there was no documentation.
> 
> > The commit message should highlight all this.
> > 
> > (I don't expect you to fix all these warnings, I was just surprised to
> > see them given this is an 'initial schema'.)
> 
> This patches was create before I needed to use it. Should I resent it
> with new commit message?

Yes, please.

Rob
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml b/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
new file mode 100644
index 000000000000..8521c65366b4
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
@@ -0,0 +1,80 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/microchip,lan95xx.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: The device tree bindings for the USB Ethernet controllers
+
+maintainers:
+  - Oleksij Rempel <o.rempel@pengutronix.de>
+
+description: |
+  Device tree properties for hard wired SMSC95xx compatible USB Ethernet
+  controller.
+
+allOf:
+  - $ref: ethernet-controller.yaml#
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - usb424,9500   # SMSC9500 USB Ethernet Device
+          - usb424,9505   # SMSC9505 USB Ethernet Device
+          - usb424,9530   # SMSC LAN9530 USB Ethernet Device
+          - usb424,9730   # SMSC LAN9730 USB Ethernet Device
+          - usb424,9900   # SMSC9500 USB Ethernet Device (SAL10)
+          - usb424,9901   # SMSC9505 USB Ethernet Device (SAL10)
+          - usb424,9902   # SMSC9500A USB Ethernet Device (SAL10)
+          - usb424,9903   # SMSC9505A USB Ethernet Device (SAL10)
+          - usb424,9904   # SMSC9512/9514 USB Hub & Ethernet Device (SAL10)
+          - usb424,9905   # SMSC9500A USB Ethernet Device (HAL)
+          - usb424,9906   # SMSC9505A USB Ethernet Device (HAL)
+          - usb424,9907   # SMSC9500 USB Ethernet Device (Alternate ID)
+          - usb424,9908   # SMSC9500A USB Ethernet Device (Alternate ID)
+          - usb424,9909   # SMSC9512/9514 USB Hub & Ethernet Devic.  ID)
+          - usb424,9e00   # SMSC9500A USB Ethernet Device
+          - usb424,9e01   # SMSC9505A USB Ethernet Device
+          - usb424,9e08   # SMSC LAN89530 USB Ethernet Device
+          - usb424,ec00   # SMSC9512/9514 USB Hub & Ethernet Device
+
+  reg: true
+  local-mac-address: true
+  mac-address: true
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    usb {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        ethernet@1 {
+            compatible = "usb424,ec00";
+            reg = <1>;
+            local-mac-address = [00 00 00 00 00 00];
+        };
+    };
+  - |
+    usb {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        usb1@1 {
+            compatible = "usb424,9514";
+            reg = <1>;
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            ethernet@1 {
+               compatible = "usb424,ec00";
+               reg = <1>;
+            };
+        };
+    };