diff mbox series

[net-next,v1,3/4] dt-bindings: net: add "label" property for all usbnet Ethernet controllers

Message ID 20220127104905.899341-4-o.rempel@pengutronix.de (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series usbnet: add "label" support | 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 Jan. 27, 2022, 10:49 a.m. UTC 
For hard wired Ethernet controllers it is helpful to assign name related
to port description on the board. Or name, related to the special
internal function, if the USB ethernet controller attached to the CPU
port of some DSA switch.

This patch provides documentation for "label" property, reusable for all
usbnet controllers.

Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
---
 .../devicetree/bindings/net/asix,ax88178.yaml |  4 ++-
 .../bindings/net/microchip,lan95xx.yaml       |  4 ++-
 .../devicetree/bindings/net/usbnet.yaml       | 36 +++++++++++++++++++
 3 files changed, 42 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/net/usbnet.yaml

Comments

Rob Herring Feb. 9, 2022, 3:51 a.m. UTC | #1 
On Thu, Jan 27, 2022 at 11:49:04AM +0100, Oleksij Rempel wrote:
> For hard wired Ethernet controllers it is helpful to assign name related
> to port description on the board. Or name, related to the special
> internal function, if the USB ethernet controller attached to the CPU
> port of some DSA switch.

Yes, so add 'label' to ethernet-controller.yaml.

Then I don't think usbnet.yaml is needed.

> 
> This patch provides documentation for "label" property, reusable for all
> usbnet controllers.
> 
> Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de>
> ---
>  .../devicetree/bindings/net/asix,ax88178.yaml |  4 ++-
>  .../bindings/net/microchip,lan95xx.yaml       |  4 ++-
>  .../devicetree/bindings/net/usbnet.yaml       | 36 +++++++++++++++++++
>  3 files changed, 42 insertions(+), 2 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/net/usbnet.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/asix,ax88178.yaml b/Documentation/devicetree/bindings/net/asix,ax88178.yaml
> index 74b6806006e3..c8ad767a2e45 100644
> --- a/Documentation/devicetree/bindings/net/asix,ax88178.yaml
> +++ b/Documentation/devicetree/bindings/net/asix,ax88178.yaml
> @@ -13,7 +13,7 @@ description: |
>    Device tree properties for hard wired USB Ethernet devices.
>  
>  allOf:
> -  - $ref: ethernet-controller.yaml#
> +  - $ref: usbnet.yaml#
>  
>  properties:
>    compatible:
> @@ -58,6 +58,7 @@ properties:
>            - usb6189,182d  # Sitecom LN-029
>  
>    reg: true
> +  label: true
>    local-mac-address: true
>    mac-address: true
>  
> @@ -77,6 +78,7 @@ examples:
>          ethernet@1 {
>              compatible = "usbdb0,a877";
>              reg = <1>;
> +            label = "LAN0";
>              local-mac-address = [00 00 00 00 00 00];
>          };
>      };
> diff --git a/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml b/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> index b185c7068a8a..259879bba3a0 100644
> --- a/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> +++ b/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
> @@ -14,7 +14,7 @@ description: |
>    controller.
>  
>  allOf:
> -  - $ref: ethernet-controller.yaml#
> +  - $ref: usbnet.yaml#
>  
>  properties:
>    compatible:
> @@ -40,6 +40,7 @@ properties:
>            - usb424,ec00   # SMSC9512/9514 USB Hub & Ethernet Device
>  
>    reg: true
> +  label: true
>    local-mac-address: true
>    mac-address: true
>  
> @@ -59,6 +60,7 @@ examples:
>          ethernet@1 {
>              compatible = "usb424,ec00";
>              reg = <1>;
> +            label = "LAN0";
>              local-mac-address = [00 00 00 00 00 00];
>          };
>      };
> diff --git a/Documentation/devicetree/bindings/net/usbnet.yaml b/Documentation/devicetree/bindings/net/usbnet.yaml
> new file mode 100644
> index 000000000000..fe0848433263
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/usbnet.yaml
> @@ -0,0 +1,36 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/usbnet.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 USB Ethernet devices.
> +
> +allOf:
> +  - $ref: ethernet-controller.yaml#
> +
> +properties:
> +  compatible: true
> +
> +  reg:
> +    description: Port number
> +
> +  label:
> +    description:
> +      Describes the label associated with this port, which will become
> +      the netdev name
> +    $ref: /schemas/types.yaml#/definitions/string
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: true
> +
> +...
> -- 
> 2.30.2
> 
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/net/asix,ax88178.yaml b/Documentation/devicetree/bindings/net/asix,ax88178.yaml
index 74b6806006e3..c8ad767a2e45 100644
--- a/Documentation/devicetree/bindings/net/asix,ax88178.yaml
+++ b/Documentation/devicetree/bindings/net/asix,ax88178.yaml
@@ -13,7 +13,7 @@  description: |
   Device tree properties for hard wired USB Ethernet devices.
 
 allOf:
-  - $ref: ethernet-controller.yaml#
+  - $ref: usbnet.yaml#
 
 properties:
   compatible:
@@ -58,6 +58,7 @@  properties:
           - usb6189,182d  # Sitecom LN-029
 
   reg: true
+  label: true
   local-mac-address: true
   mac-address: true
 
@@ -77,6 +78,7 @@  examples:
         ethernet@1 {
             compatible = "usbdb0,a877";
             reg = <1>;
+            label = "LAN0";
             local-mac-address = [00 00 00 00 00 00];
         };
     };
diff --git a/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml b/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
index b185c7068a8a..259879bba3a0 100644
--- a/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
+++ b/Documentation/devicetree/bindings/net/microchip,lan95xx.yaml
@@ -14,7 +14,7 @@  description: |
   controller.
 
 allOf:
-  - $ref: ethernet-controller.yaml#
+  - $ref: usbnet.yaml#
 
 properties:
   compatible:
@@ -40,6 +40,7 @@  properties:
           - usb424,ec00   # SMSC9512/9514 USB Hub & Ethernet Device
 
   reg: true
+  label: true
   local-mac-address: true
   mac-address: true
 
@@ -59,6 +60,7 @@  examples:
         ethernet@1 {
             compatible = "usb424,ec00";
             reg = <1>;
+            label = "LAN0";
             local-mac-address = [00 00 00 00 00 00];
         };
     };
diff --git a/Documentation/devicetree/bindings/net/usbnet.yaml b/Documentation/devicetree/bindings/net/usbnet.yaml
new file mode 100644
index 000000000000..fe0848433263
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/usbnet.yaml
@@ -0,0 +1,36 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/usbnet.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 USB Ethernet devices.
+
+allOf:
+  - $ref: ethernet-controller.yaml#
+
+properties:
+  compatible: true
+
+  reg:
+    description: Port number
+
+  label:
+    description:
+      Describes the label associated with this port, which will become
+      the netdev name
+    $ref: /schemas/types.yaml#/definitions/string
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: true
+
+...