Re: [PATCH v6 1/4] dt-bindings: net: phy: Add subnode for LED configuration

Rob Herring
2019-08-27T16:12:39Z

On Tue, Aug 13, 2019 at 12:11:44PM -0700, Matthias Kaehlcke wrote:
> The LED behavior of some Ethernet PHYs is configurable. Add an
> optional 'leds' subnode with a child node for each LED to be
> configured. The binding aims to be compatible with the common
> LED binding (see devicetree/bindings/leds/common.txt).
>
> A LED can be configured to be:
>
> - 'on' when a link is active, some PHYs allow configuration for
> certain link speeds
> speeds
> - 'off'
> - blink on RX/TX activity, some PHYs allow configuration for
> certain link speeds
>
> For the configuration to be effective it needs to be supported by
> the hardware and the corresponding PHY driver.
>
> Suggested-by: Andrew Lunn <andrew@lunn.ch>
> Signed-off-by: Matthias Kaehlcke <mka@chromium.org>
> ---
> Changes in v6:
> - none
>
> Changes in v5:
> - renamed triggers from 'phy_link_<speed>_active' to 'phy-link-<speed>'
> - added entries for 'phy-link-<speed>-activity'
> - added 'phy-link' and 'phy-link-activity' for triggers with any link
> speed
> - added entry for trigger 'none'
>
> Changes in v4:
> - patch added to the series
> ---
> .../devicetree/bindings/net/ethernet-phy.yaml | 59 +++++++++++++++++++
> 1 file changed, 59 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/net/ethernet-phy.yaml b/Documentation/devicetree/bindings/net/ethernet-phy.yaml
> index f70f18ff821f..98ba320f828b 100644
> --- a/Documentation/devicetree/bindings/net/ethernet-phy.yaml
> +++ b/Documentation/devicetree/bindings/net/ethernet-phy.yaml
> @@ -153,6 +153,50 @@ properties:
> Delay after the reset was deasserted in microseconds. If
> this property is missing the delay will be skipped.
>
> +patternProperties:
> + "^leds$":
> + type: object
> + description:
> + Subnode with configuration of the PHY LEDs.

#address-cells and #size-cells needed.

> +
> + patternProperties:
> + "^led@[0-9]+$":

Need to allow for the case of 1 LED which doesn't need a unit-address
nor reg.

> + type: object
> + description:
> + Subnode with the configuration of a single PHY LED.
> +
> + properties:
> + reg:
> + description:
> + The ID number of the LED, typically corresponds to a hardware ID.
> + $ref: "/schemas/types.yaml#/definitions/uint32"

Standard properties already have a type definition. What's needed is
'maxItems: 1'.

> +
> + linux,default-trigger:
> + description:
> + This parameter, if present, is a string specifying the trigger
> + assigned to the LED. Supported triggers are:
> + "none" - LED will be solid off
> + "phy-link" - LED will be solid on when a link is active
> + "phy-link-10m" - LED will be solid on when a 10Mb/s link is active
> + "phy-link-100m" - LED will be solid on when a 100Mb/s link is active
> + "phy-link-1g" - LED will be solid on when a 1Gb/s link is active
> + "phy-link-10g" - LED will be solid on when a 10Gb/s link is active
> + "phy-link-activity" - LED will be on when link is active and blink
> + off with activity.
> + "phy-link-10m-activity" - LED will be on when 10Mb/s link is active
> + and blink off with activity.
> + "phy-link-100m-activity" - LED will be on when 100Mb/s link is
> + active and blink off with activity.
> + "phy-link-1g-activity" - LED will be on when 1Gb/s link is active
> + and blink off with activity.
> + "phy-link-10g-activity" - LED will be on when 10Gb/s link is active
> + and blink off with activity.

These strings all need to be in an enum.

The led binding is moving away from linux,default-trigger to 'function'
and 'color' properties. You probably want to do that here.

> +
> + $ref: "/schemas/types.yaml#/definitions/string"
> +
> + required:
> + - reg
> +
> required:
> - reg
>
> @@ -173,5 +217,20 @@ examples:
> reset-gpios = <&gpio1 4 1>;
> reset-assert-us = <1000>;
> reset-deassert-us = <2000>;
> +
> + leds {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + led@0 {
> + reg = <0>;
> + linux,default-trigger = "phy-link-1g";
> + };
> +
> + led@1 {
> + reg = <1>;
> + linux,default-trigger = "phy-link-100m-activity";
> + };
> + };
> };
> };
> --
> 2.23.0.rc1.153.gdeed80330f-goog
>