RE: [PATCH v2 1/1] dt-bindings: net: convert enetc to yaml

[Wei Fang]

> -----Original Message-----
> From: Frank Li <Frank.Li@xxxxxxx>
> Sent: 2024年6月27日 0:23
> To: krzk@xxxxxxxxxx
> Cc: Frank Li <frank.li@xxxxxxx>; conor+dt@xxxxxxxxxx;
> davem@xxxxxxxxxxxxx; devicetree@xxxxxxxxxxxxxxx; edumazet@xxxxxxxxxx;
> imx@xxxxxxxxxxxxxxx; krzk+dt@xxxxxxxxxx; kuba@xxxxxxxxxx;
> linux-kernel@xxxxxxxxxxxxxxx; netdev@xxxxxxxxxxxxxxx; pabeni@xxxxxxxxxx;
> robh@xxxxxxxxxx
> Subject: [PATCH v2 1/1] dt-bindings: net: convert enetc to yaml
> 
> Convert enetc device binding file to yaml. Split to 3 yaml files, 'fsl,enetc.yaml',
> 'fsl,enetc-mdio.yaml', 'fsl,enetc-ierb.yaml'.
> 

Sorry I didn't see this patch until now, I was planning to make this conversion
but didn't realize you had started it first. It's very nice, thanks!

> Additional Changes:
> - Add pci<vendor id>,<production id> in compatible string.
> - Ref to common ethernet-controller.yaml and mdio.yaml.
> - Remove fixed-link part.
> 
> Signed-off-by: Frank Li <Frank.Li@xxxxxxx>
> ---
> Change from v1 to v2
> - renamee file as fsl,enetc-mdio.yaml, fsl,enetc-ierb.yaml, fsl,enetc.yaml
> - example include pcie node
> ---
>  .../bindings/net/fsl,enetc-ierb.yaml          |  35 ++++++
>  .../bindings/net/fsl,enetc-mdio.yaml          |  53 ++++++++
>  .../devicetree/bindings/net/fsl,enetc.yaml    |  50 ++++++++
>  .../devicetree/bindings/net/fsl-enetc.txt     | 119 ------------------
>  4 files changed, 138 insertions(+), 119 deletions(-)  create mode 100644
> Documentation/devicetree/bindings/net/fsl,enetc-ierb.yaml
>  create mode 100644
> Documentation/devicetree/bindings/net/fsl,enetc-mdio.yaml
>  create mode 100644 Documentation/devicetree/bindings/net/fsl,enetc.yaml
>  delete mode 100644 Documentation/devicetree/bindings/net/fsl-enetc.txt
> 
> diff --git a/Documentation/devicetree/bindings/net/fsl,enetc-mdio.yaml
> b/Documentation/devicetree/bindings/net/fsl,enetc-mdio.yaml
> new file mode 100644
> index 0000000000000..60740ea56cb08
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/fsl,enetc-mdio.yaml

I suggest changing the file name to nxp,netc-emdio.yaml. "fsl" is a very outdated
prefix. For new files, I think "nxp" is a better prefix.

> @@ -0,0 +1,53 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2
> +---
> +
> +title: ENETC the central MDIO PCIe endpoint device
external is better, that is why we call it EMDIO.

> +
> +description:
> +  In this case, the mdio node should be defined as another PCIe
> +  endpoint node, at the same level with the ENETC port nodes
> +
This my local description, excerpted from NETC's block guide, FYI.
description: |
  NETC provides an external master MDIO interface (EMDIO) for managing external
  devices (PHYs). EMDIO supports both Clause 22 and 45 protocols. And the EMDIO
  provides a means for different software modules to share a single set of MDIO
  signals to access their PHYs.

> +maintainers:
> +  - Frank Li <Frank.Li@xxxxxxx>.
Vladimir and Claudiu as the driver maintainer, it is best to add them
to this list

> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - pci1957,ee01
> +      - const: fsl,enetc-mdio

" fsl,enetc-mdio" is meaningless, we did not use it ever.
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +allOf:
> +  - $ref: mdio.yaml
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    pcie@1f0000000 {
> +        compatible = "pci-host-ecam-generic";
> +        reg = <0x01 0xf0000000 0x0 0x100000>;
> +        #address-cells = <3>;
> +        #size-cells = <2>;
> +
> +        mdio@0,3 {
> +            compatible = "pci1957,ee01", "fsl,enetc-mdio";
> +            reg = <0x000300 0 0 0 0>;
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +
> +            ethernet-phy@2 {
> +                reg = <0x2>;
> +            };
> +        };
> +    };
> diff --git a/Documentation/devicetree/bindings/net/fsl,enetc.yaml
> b/Documentation/devicetree/bindings/net/fsl,enetc.yaml
> new file mode 100644
> index 0000000000000..843c27e357f2d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/fsl,enetc.yaml
Same as above, nxp,enetc.yaml or nxp,netc-enetc.yaml is better.

> @@ -0,0 +1,50 @@
> +title: ENETC ethernet
title: The NIC functionality of NXP NETC

> +
> +description:
> +  Depending on board design and ENETC port type (internal or
> +  external) there are two supported link modes specified by
> +  below device tree bindings.
description: |
  The NIC functionality in NETC is known as EtherNET Controller (ENETC). ENETC
  supports virtualization/isolation based on PCIe Single Root IO Virtualization
  (SR-IOV), advanced QoS with 8 traffic classes and 4 drop resilience levels,
  and a full range of TSN standards and NIC offload capabilities.

> +
> +maintainers:
> +  - Frank Li <Frank.Li@xxxxxxx>
Save as above.

> +
> +properties:
> +  compatible:
> +    items:
> +      - enum:
> +          - pci1957,e100
> +      - const: fsl,enetc
Should be removed.

> +
> +  reg:
> +    maxItems: 1
> +

This is an example I see in fsl-enetc.txt
ethernet@0,0 {
	compatible = "fsl,enetc";
	reg = <0x000000 0 0 0 0>;
	phy-handle = <&sgmii_phy0>;
	phy-connection-type = "sgmii";

	mdio {
		#address-cells = <1>;
		#size-cells = <0>;
		sgmii_phy0: ethernet-phy@2 {
			reg = <0x2>;
		};
	};
};
But here I don't see any description of the mdio child node.
I think you need to add it, just like below.
mdio:
    $ref: mdio.yaml#
    unevaluatedProperties: false
    description: |
      Optional child node for ENETC instance, otherwise use NETC EMDIO.

> +required:
> +  - compatible
> +  - reg
> +
> +allOf:
> +  - $ref: ethernet-controller.yaml
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    pcie@1f0000000 {
> +        compatible = "pci-host-ecam-generic";
> +        reg = <0x01 0xf0000000 0x0 0x100000>;
> +        #address-cells = <3>;
> +        #size-cells = <2>;
> +
> +        ethernet@0,0 {
> +            compatible = "pci1957,e100", "fsl,enetc";
> +            reg = <0x000000 0 0 0 0>;
> +            phy-handle = <&sgmii_phy0>;
> +            phy-connection-type = "sgmii";
> +        };
> +    };
> diff --git a/Documentation/devicetree/bindings/net/fsl-enetc.txt
> b/Documentation/devicetree/bindings/net/fsl-enetc.txt
> deleted file mode 100644
> index 9b9a3f197e2d3..0000000000000
> --- a/Documentation/devicetree/bindings/net/fsl-enetc.txt
> +++ /dev/null
> @@ -1,119 +0,0 @@
> -* ENETC ethernet device tree bindings
> -
> -Depending on board design and ENETC port type (internal or
> -external) there are two supported link modes specified by -below device tree
> bindings.
> -
> -Required properties:
> -
> -- reg		: Specifies PCIe Device Number and Function
> -		  Number of the ENETC endpoint device, according
> -		  to parent node bindings.
> -- compatible	: Should be "fsl,enetc".
> -
> -1. The ENETC external port is connected to a MDIO configurable phy
> -
> -1.1. Using the local ENETC Port MDIO interface
> -
> -In this case, the ENETC node should include a "mdio" sub-node -that in turn
> should contain the "ethernet-phy" node describing the -external phy.  Below
> properties are required, their bindings -already defined in
> Documentation/devicetree/bindings/net/ethernet.txt or
> -Documentation/devicetree/bindings/net/phy.txt.
> -
> -Required:
> -
> -- phy-handle		: Phandle to a PHY on the MDIO bus.
> -			  Defined in ethernet.txt.
> -
> -- phy-connection-type	: Defined in ethernet.txt.
> -
> -- mdio			: "mdio" node, defined in mdio.txt.
> -
> -- ethernet-phy		: "ethernet-phy" node, defined in phy.txt.
> -
> -Example:
> -
> -	ethernet@0,0 {
> -		compatible = "fsl,enetc";
> -		reg = <0x000000 0 0 0 0>;
> -		phy-handle = <&sgmii_phy0>;
> -		phy-connection-type = "sgmii";
> -
> -		mdio {
> -			#address-cells = <1>;
> -			#size-cells = <0>;
> -			sgmii_phy0: ethernet-phy@2 {
> -				reg = <0x2>;
> -			};
> -		};
> -	};
> -
> -1.2. Using the central MDIO PCIe endpoint device
> -
> -In this case, the mdio node should be defined as another PCIe -endpoint node,
> at the same level with the ENETC port nodes.
> -
> -Required properties:
> -
> -- reg		: Specifies PCIe Device Number and Function
> -		  Number of the ENETC endpoint device, according
> -		  to parent node bindings.
> -- compatible	: Should be "fsl,enetc-mdio".
> -
> -The remaining required mdio bus properties are standard, their bindings
> -already defined in Documentation/devicetree/bindings/net/mdio.txt.
> -
> -Example:
> -
> -	ethernet@0,0 {
> -		compatible = "fsl,enetc";
> -		reg = <0x000000 0 0 0 0>;
> -		phy-handle = <&sgmii_phy0>;
> -		phy-connection-type = "sgmii";
> -	};
> -
> -	mdio@0,3 {
> -		compatible = "fsl,enetc-mdio";
> -		reg = <0x000300 0 0 0 0>;
> -		#address-cells = <1>;
> -		#size-cells = <0>;
> -		sgmii_phy0: ethernet-phy@2 {
> -			reg = <0x2>;
> -		};
> -	};
> -
> -2. The ENETC port is an internal port or has a fixed-link external -connection
> -
> -In this case, the ENETC port node defines a fixed link connection, -as specified
> by Documentation/devicetree/bindings/net/fixed-link.txt.
> -
> -Required:
> -
> -- fixed-link	: "fixed-link" node, defined in "fixed-link.txt".
> -
> -Example:
> -	ethernet@0,2 {
> -		compatible = "fsl,enetc";
> -		reg = <0x000200 0 0 0 0>;
> -		fixed-link {
> -			speed = <1000>;
> -			full-duplex;
> -		};
> -	};
> -
> -* Integrated Endpoint Register Block bindings
> -
> -Optionally, the fsl_enetc driver can probe on the Integrated Endpoint Register
> -Block, which preconfigures the FIFO limits for the ENETC ports. This is a node
> -with the following properties:
> -
> -- reg		: Specifies the address in the SoC memory space.
> -- compatible	: Must be "fsl,ls1028a-enetc-ierb".
> -
> -Example:
> -	ierb@1f0800000 {
> -		compatible = "fsl,ls1028a-enetc-ierb";
> -		reg = <0x01 0xf0800000 0x0 0x10000>;
> -	};
> --
> 2.34.1
>