Re: [PATCH v4 2/2] dt-bindings: net: Convert SYSTEMPORT to YAML

[Rob Herring <robh@kernel.org>]

On Wed, Dec 08, 2021 at 12:28:01PM -0800, Florian Fainelli wrote:
> Convert the Broadcom SYSTEMPORT Ethernet controller Device Tree binding
> to YAML.
> 
> Signed-off-by: Florian Fainelli <f.fainelli@gmail.com>
> ---
>  .../bindings/net/brcm,systemport.txt          | 38 --------
>  .../bindings/net/brcm,systemport.yaml         | 88 +++++++++++++++++++
>  MAINTAINERS                                   |  1 +
>  3 files changed, 89 insertions(+), 38 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/net/brcm,systemport.txt
>  create mode 100644 Documentation/devicetree/bindings/net/brcm,systemport.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/brcm,systemport.txt b/Documentation/devicetree/bindings/net/brcm,systemport.txt
> deleted file mode 100644
> index 75736739bfdd..000000000000
> --- a/Documentation/devicetree/bindings/net/brcm,systemport.txt
> +++ /dev/null
> @@ -1,38 +0,0 @@
> -* Broadcom BCM7xxx Ethernet Systemport Controller (SYSTEMPORT)
> -
> -Required properties:
> -- compatible: should be one of:
> -	      "brcm,systemport-v1.00"
> -	      "brcm,systemportlite-v1.00" or
> -	      "brcm,systemport"
> -- reg: address and length of the register set for the device.
> -- interrupts: interrupts for the device, first cell must be for the rx
> -  interrupts, and the second cell should be for the transmit queues. An
> -  optional third interrupt cell for Wake-on-LAN can be specified
> -- local-mac-address: Ethernet MAC address (48 bits) of this adapter
> -- phy-mode: Should be a string describing the PHY interface to the
> -  Ethernet switch/PHY, see Documentation/devicetree/bindings/net/ethernet.txt
> -- fixed-link: see Documentation/devicetree/bindings/net/fixed-link.txt for
> -  the property specific details
> -
> -Optional properties:
> -- systemport,num-tier2-arb: number of tier 2 arbiters, an integer
> -- systemport,num-tier1-arb: number of tier 1 arbiters, an integer
> -- systemport,num-txq: number of HW transmit queues, an integer
> -- systemport,num-rxq: number of HW receive queues, an integer
> -- clocks: When provided, must be two phandles to the functional clocks nodes of
> -  the SYSTEMPORT block. The first phandle is the main SYSTEMPORT clock used
> -  during normal operation, while the second phandle is the Wake-on-LAN clock.
> -- clock-names: When provided, names of the functional clock phandles, first
> -  name should be "sw_sysport" and second should be "sw_sysportwol".
> -
> -Example:
> -ethernet@f04a0000 {
> -	compatible = "brcm,systemport-v1.00";
> -	reg = <0xf04a0000 0x4650>;
> -	local-mac-address = [ 00 11 22 33 44 55 ];
> -	fixed-link = <0 1 1000 0 0>;
> -	phy-mode = "gmii";
> -	interrupts = <0x0 0x16 0x0>,
> -		<0x0 0x17 0x0>;
> -};
> diff --git a/Documentation/devicetree/bindings/net/brcm,systemport.yaml b/Documentation/devicetree/bindings/net/brcm,systemport.yaml
> new file mode 100644
> index 000000000000..53ecec8c864e
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/brcm,systemport.yaml
> @@ -0,0 +1,88 @@
> +# SPDX-License-Identifier: GPL-2.0-only OR BSD-2-Clause
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/brcm,systemport.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Broadcom BCM7xxx Ethernet Systemport Controller (SYSTEMPORT)
> +
> +maintainers:
> +  - Florian Fainelli <f.fainelli@gmail.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - brcm,systemport-v1.00
> +      - brcm,systemportlite-v1.00
> +      - brcm,systemport
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    minItems: 2
> +    items:
> +      - description: interrupt line for RX queues
> +      - description: interrupt line for TX queues
> +      - description: interrupt line for Wake-on-LAN
> +
> +  clocks:
> +    items:
> +      - description: main clock
> +      - description: Wake-on-LAN clock
> +
> +  clock-names:
> +    items:
> +      - const: sw_sysport
> +      - const: sw_sysportwol
> +
> +  systemport,num-tier2-arb:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      Number of tier 2 arbiters
> +
> +  systemport,num-tier1-arb:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description:
> +      Number of tier 2 arbiters
> +
> +  systemport,num-txq:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    items:
> +      - minimum: 1
> +      - maximum: 32

This says you have an array of 2 entries. I'll fix up.

> +    description:
> +      Number of HW transmit queues
> +
> +  systemport,num-rxq:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    items:
> +      - minimum: 1
> +      - maximum: 32
> +    description:
> +      Number of HW receive queues
> +
> +required:
> +  - reg
> +  - interrupts
> +  - phy-mode
> +
> +allOf:
> +  - $ref: "ethernet-controller.yaml#"
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    ethernet@f04a0000 {
> +        compatible = "brcm,systemport-v1.00";
> +        reg = <0xf04a0000 0x4650>;
> +        local-mac-address = [ 00 11 22 33 44 55 ];
> +        phy-mode = "gmii";
> +        interrupts = <0x0 0x16 0x0>,
> +                     <0x0 0x17 0x0>;
> +        fixed-link {
> +            speed = <1000>;
> +            full-duplex;
> +        };
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 404e76d625f1..ed8de605fe4b 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3972,6 +3972,7 @@ L:	netdev@vger.kernel.org
>  S:	Supported
>  F:	drivers/net/ethernet/broadcom/bcmsysport.*
>  F:	drivers/net/ethernet/broadcom/unimac.h
> +F:	Documentation/devicetree/bindings/net/brcm,systemport.yaml
>  
>  BROADCOM TG3 GIGABIT ETHERNET DRIVER
>  M:	Siva Reddy Kallam <siva.kallam@broadcom.com>
> -- 
> 2.25.1
> 
>