Date:   Wed, 1 Feb 2023 13:02:53 -0600
From:   Rob Herring <robh@kernel.org>
To:     Frank Sae <Frank.Sae@motor-comm.com>
Cc:     Peter Geis <pgwipeout@gmail.com>, Andrew Lunn <andrew@lunn.ch>,
        Heiner Kallweit <hkallweit1@gmail.com>,
        Russell King <linux@armlinux.org.uk>,
        "David S . Miller" <davem@davemloft.net>,
        Eric Dumazet <edumazet@google.com>,
        Jakub Kicinski <kuba@kernel.org>,
        Paolo Abeni <pabeni@redhat.com>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        yanhong.wang@starfivetech.com, xiaogang.fan@motor-comm.com,
        fei.zhang@motor-comm.com, hua.sun@motor-comm.com,
        netdev@vger.kernel.org, linux-kernel@vger.kernel.org,
        devicetree@vger.kernel.org
Subject: Re: [PATCH net-next v4 1/5] dt-bindings: net: Add Motorcomm yt8xxx
 ethernet phy
Message-ID: <20230201190253.GA4148490-robh@kernel.org>
References: <20230201065811.3650-1-Frank.Sae@motor-comm.com>
 <20230201065811.3650-2-Frank.Sae@motor-comm.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20230201065811.3650-2-Frank.Sae@motor-comm.com>
Precedence: bulk

On Wed, Feb 01, 2023 at 02:58:07PM +0800, Frank Sae wrote:
>  Add a YAML binding document for the Motorcomm yt8xxx Ethernet phy.
>  
> Signed-off-by: Frank Sae <Frank.Sae@motor-comm.com>
> ---
>  .../bindings/net/motorcomm,yt8xxx.yaml        | 119 ++++++++++++++++++
>  .../devicetree/bindings/vendor-prefixes.yaml  |   2 +
>  MAINTAINERS                                   |   1 +
>  3 files changed, 122 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/net/motorcomm,yt8xxx.yaml
> 
> diff --git a/Documentation/devicetree/bindings/net/motorcomm,yt8xxx.yaml b/Documentation/devicetree/bindings/net/motorcomm,yt8xxx.yaml
> new file mode 100644
> index 000000000000..6ce93404e1f1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/net/motorcomm,yt8xxx.yaml
> @@ -0,0 +1,119 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/net/motorcomm,yt8xxx.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MotorComm yt8xxx Ethernet PHY
> +
> +maintainers:
> +  - frank sae <frank.sae@motor-comm.com>

Frank Sae

> +
> +allOf:
> +  - $ref: ethernet-phy.yaml#
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - const: ethernet-phy-id4f51.e91a
> +        description: Only needed for DT lint tools, yt8531s phy

linting doesn't care, validation does. But just drop the description.

> +      - const: ethernet-phy-id4f51.e91b
> +        description: Only needed for DT lint tools, yt8531 phy
> +
> +  rx-internal-delay-ps:
> +    description: |
> +      RGMII RX Clock Delay used only when PHY operates in RGMII mode with
> +      internal delay (phy-mode is 'rgmii-id' or 'rgmii-rxid') in pico-seconds.
> +    enum: [ 0, 150, 300, 450, 600, 750, 900, 1050, 1200, 1350, 1500, 1650,
> +            1800, 1900, 1950, 2050, 2100, 2200, 2250, 2350, 2500, 2650, 2800,
> +            2950, 3100, 3250, 3400, 3550, 3700, 3850, 4000, 4150 ]
> +    default: 1950
> +
> +  tx-internal-delay-ps:
> +    description: |
> +      RGMII TX Clock Delay used only when PHY operates in RGMII mode with
> +      internal delay (phy-mode is 'rgmii-id' or 'rgmii-txid') in pico-seconds.
> +    enum: [ 0, 150, 300, 450, 600, 750, 900, 1050, 1200, 1350, 1500, 1650, 1800,
> +            1950, 2100, 2250 ]
> +    default: 1950
> +
> +  motorcomm,clk-out-frequency-hz:
> +    description: clock output on clock output pin.
> +    enum: [0, 25000000, 125000000]
> +    default: 0
> +
> +  motorcomm,keep-pll-enabled:
> +    description: |
> +      If set, keep the PLL enabled even if there is no link. Useful if you
> +      want to use the clock output without an ethernet link.
> +    type: boolean
> +
> +  motorcomm,auto-sleep-disabled:
> +    description: |
> +      If set, PHY will not enter sleep mode and close AFE after unplug cable
> +      for a timer.
> +    type: boolean
> +
> +  motorcomm,tx-clk-adj-enabled:
> +    description: |
> +      This configuration is mainly to adapt to VF2 with JH7110 SoC.
> +      Useful if you want to use tx-clk-xxxx-inverted to adj the delay of tx clk.
> +    type: boolean
> +
> +  motorcomm,tx-clk-10-inverted:
> +    description: |
> +      Use original or inverted RGMII Transmit PHY Clock to drive the RGMII
> +      Transmit PHY Clock delay train configuration when speed is 10Mbps.
> +    type: boolean
> +
> +  motorcomm,tx-clk-100-inverted:
> +    description: |
> +      Use original or inverted RGMII Transmit PHY Clock to drive the RGMII
> +      Transmit PHY Clock delay train configuration when speed is 100Mbps.
> +    type: boolean
> +
> +  motorcomm,tx-clk-1000-inverted:
> +    description: |
> +      Use original or inverted RGMII Transmit PHY Clock to drive the RGMII
> +      Transmit PHY Clock delay train configuration when speed is 1000Mbps.
> +    type: boolean
> +
> +unevaluatedProperties: false
> +
> +examples:
> +  - |
> +    mdio {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        phy-mode = "rgmii-id";
> +        ethernet-phy@4 {
> +            /*  Only needed to make DT lint tools work. Do not copy/paste
> +             *  into real DTS files.
> +             */
> +            compatible = "ethernet-phy-id4f51.e91a";
> +
> +            reg = <4>;
> +            rx-internal-delay-ps = <2100>;
> +            tx-internal-delay-ps = <150>;
> +            motorcomm,clk-out-frequency-hz = <0>;
> +            motorcomm,keep-pll-enabled;
> +            motorcomm,auto-sleep-disabled;
> +        };
> +    };
> +  - |
> +    mdio {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        phy-mode = "rgmii";
> +        ethernet-phy@5 {
> +            /*  Only needed to make DT lint tools work. Do not copy/paste
> +             *  into real DTS files.
> +             */
> +            compatible = "ethernet-phy-id4f51.e91a";
> +
> +            reg = <5>;
> +            motorcomm,clk-out-frequency-hz = <125000000>;
> +            motorcomm,keep-pll-enabled;
> +            motorcomm,auto-sleep-disabled;
> +        };
> +    };
> diff --git a/Documentation/devicetree/bindings/vendor-prefixes.yaml b/Documentation/devicetree/bindings/vendor-prefixes.yaml
> index 161766b1de50..99bb8594753c 100644
> --- a/Documentation/devicetree/bindings/vendor-prefixes.yaml
> +++ b/Documentation/devicetree/bindings/vendor-prefixes.yaml
> @@ -847,6 +847,8 @@ patternProperties:
>      description: Moortec Semiconductor Ltd.
>    "^mosaixtech,.*":
>      description: Mosaix Technologies, Inc.
> +  "^motorcomm,.*":
> +    description: MotorComm, Inc.
>    "^motorola,.*":
>      description: Motorola, Inc.
>    "^moxa,.*":
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 8cdba0580cb8..1da8c3b52108 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -14161,6 +14161,7 @@ M:	Peter Geis <pgwipeout@gmail.com>
>  M:	Frank <Frank.Sae@motor-comm.com>
>  L:	netdev@vger.kernel.org
>  S:	Maintained
> +F:	Documentation/devicetree/bindings/net/motorcomm,yt8xxx.yaml
>  F:	drivers/net/phy/motorcomm.c
>  
>  MOXA SMARTIO/INDUSTIO/INTELLIO SERIAL CARD
> -- 
> 2.34.1
>