[PATCH 1/1] dt-bindings: net: convert nxp,lpc1850-dwmac.txt to yaml format

[PATCH 1/1] dt-bindings: net: convert nxp,lpc1850-dwmac.txt to yaml format

[Frank Li]

Convert nxp,lpc1850-dwmac.txt to yaml format.

Additional changes:
- compatible string add fallback as "nxp,lpc1850-dwmac", "snps,dwmac-3.611"
"snps,dwmac".
- add common interrupts, interrupt-names, clocks, clock-names, resets and
  reset-names properties.
- add ref snps,dwmac.yaml.
- add phy-mode in example to avoid dt_binding_check warning.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 .../bindings/net/nxp,lpc1850-dwmac.txt        | 20 -----
 .../bindings/net/nxp,lpc1850-dwmac.yaml       | 81 +++++++++++++++++++
 2 files changed, 81 insertions(+), 20 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.txt
 create mode 100644 Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.yaml

diff --git a/Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.txt b/Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.txt
deleted file mode 100644
index 7edba1264f6f2..0000000000000
--- a/Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-* NXP LPC1850 GMAC ethernet controller
-
-This device is a platform glue layer for stmmac.
-Please see stmmac.txt for the other unchanged properties.
-
-Required properties:
- - compatible:  Should contain "nxp,lpc1850-dwmac"
-
-Examples:
-
-mac: ethernet@40010000 {
-	compatible = "nxp,lpc1850-dwmac", "snps,dwmac-3.611", "snps,dwmac";
-	reg = <0x40010000 0x2000>;
-	interrupts = <5>;
-	interrupt-names = "macirq";
-	clocks = <&ccu1 CLK_CPU_ETHERNET>;
-	clock-names = "stmmaceth";
-	resets = <&rgu 22>;
-	reset-names = "stmmaceth";
-}
diff --git a/Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.yaml b/Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.yaml
new file mode 100644
index 0000000000000..c2bc0d80fabd7
--- /dev/null
+++ b/Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.yaml
@@ -0,0 +1,81 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/net/nxp,lpc1850-dwmac.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: NXP LPC1850 GMAC ethernet controller
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+# We need a select here so we don't match all nodes with 'snps,dwmac'
+select:
+  properties:
+    compatible:
+      contains:
+        enum:
+          - nxp,lpc1850-dwmac
+  required:
+    - compatible
+
+properties:
+  compatible:
+    items:
+      - enum:
+          - nxp,lpc1850-dwmac
+      - const: snps,dwmac-3.611
+      - const: snps,dwmac
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-names:
+    items:
+      - const: stmmaceth
+
+  interrupts:
+    maxItems: 1
+
+  interrupt-names:
+    items:
+      - const: macirq
+
+  resets:
+    maxItems: 1
+
+  reset-names:
+    items:
+      - const: stmmaceth
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - clock-names
+  - interrupts
+  - interrupt-names
+
+allOf:
+  - $ref: snps,dwmac.yaml#
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/lpc18xx-ccu.h>
+
+    ethernet@40010000 {
+        compatible = "nxp,lpc1850-dwmac", "snps,dwmac-3.611", "snps,dwmac";
+        reg = <0x40010000 0x2000>;
+        interrupts = <5>;
+        interrupt-names = "macirq";
+        clocks = <&ccu1 CLK_CPU_ETHERNET>;
+        clock-names = "stmmaceth";
+        resets = <&rgu 22>;
+        reset-names = "stmmaceth";
+        phy-mode = "rgmii";
+    };
-- 
2.34.1

Re: [PATCH 1/1] dt-bindings: net: convert nxp,lpc1850-dwmac.txt to yaml format

[Andrew Lunn]

> +examples:
> +  - |
> +    #include <dt-bindings/clock/lpc18xx-ccu.h>
> +
> +    ethernet@40010000 {
> +        compatible = "nxp,lpc1850-dwmac", "snps,dwmac-3.611", "snps,dwmac";
> +        reg = <0x40010000 0x2000>;
> +        interrupts = <5>;
> +        interrupt-names = "macirq";
> +        clocks = <&ccu1 CLK_CPU_ETHERNET>;
> +        clock-names = "stmmaceth";
> +        resets = <&rgu 22>;
> +        reset-names = "stmmaceth";
> +        phy-mode = "rgmii";

Please don't use 'rgmii' in an example, because it is 99% of the time
wrong. You are just encouraging developers to copy/paste this into
real DT blobs, and then i need to point out it is wrong. Use
'rgmii-id', which is much more likely to be correct.

	Andrew

Re: [PATCH 1/1] dt-bindings: net: convert nxp,lpc1850-dwmac.txt to yaml format

[Rob Herring (Arm)]

On Mon, 02 Jun 2025 10:16:36 -0400, Frank Li wrote:
> Convert nxp,lpc1850-dwmac.txt to yaml format.
> 
> Additional changes:
> - compatible string add fallback as "nxp,lpc1850-dwmac", "snps,dwmac-3.611"
> "snps,dwmac".
> - add common interrupts, interrupt-names, clocks, clock-names, resets and
>   reset-names properties.
> - add ref snps,dwmac.yaml.
> - add phy-mode in example to avoid dt_binding_check warning.
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../bindings/net/nxp,lpc1850-dwmac.txt        | 20 -----
>  .../bindings/net/nxp,lpc1850-dwmac.yaml       | 81 +++++++++++++++++++
>  2 files changed, 81 insertions(+), 20 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.txt
>  create mode 100644 Documentation/devicetree/bindings/net/nxp,lpc1850-dwmac.yaml
> 

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>