[PATCH v2] dt-bindings: leds: Document "netdev" trigger

[PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Marek Vasut]

Document the "netdev" trigger which is used to control LEDs by
network device activity. This is an existing trigger used in
existing DTs, document it so validation of those DTs would pass.

Signed-off-by: Marek Vasut <marex@denx.de>
---
Cc: Conor Dooley <conor+dt@kernel.org>
Cc: Jacek Anaszewski <jacek.anaszewski@gmail.com>
Cc: Krzysztof Kozlowski <krzk+dt@kernel.org>
Cc: Lee Jones <lee@kernel.org>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Rob Herring <robh@kernel.org>
Cc: devicetree@vger.kernel.org
Cc: linux-leds@vger.kernel.org
---
V2: Expand the commit message slightly
---
 Documentation/devicetree/bindings/leds/common.yaml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
index 8a3c2398b10ce..bf9a101e4d420 100644
--- a/Documentation/devicetree/bindings/leds/common.yaml
+++ b/Documentation/devicetree/bindings/leds/common.yaml
@@ -113,6 +113,8 @@ properties:
             # LED indicates NAND memory activity (deprecated),
             # in new implementations use "mtd"
           - nand-disk
+            # LED indicates network activity
+          - netdev
             # No trigger assigned to the LED. This is the default mode
             # if trigger is absent
           - none
-- 
2.43.0

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Krzysztof Kozlowski]

On 08/07/2024 13:46, Marek Vasut wrote:
> Document the "netdev" trigger which is used to control LEDs by
> network device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> Signed-off-by: Marek Vasut <marex@denx.de>

Acked-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Lee Jones]

Cc: Andrew and netdev

On Mon, 08 Jul 2024, Marek Vasut wrote:

> Document the "netdev" trigger which is used to control LEDs by
> network device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> Signed-off-by: Marek Vasut <marex@denx.de>
> ---
> Cc: Conor Dooley <conor+dt@kernel.org>
> Cc: Jacek Anaszewski <jacek.anaszewski@gmail.com>
> Cc: Krzysztof Kozlowski <krzk+dt@kernel.org>
> Cc: Lee Jones <lee@kernel.org>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Rob Herring <robh@kernel.org>
> Cc: devicetree@vger.kernel.org
> Cc: linux-leds@vger.kernel.org
> ---
> V2: Expand the commit message slightly
> ---
>  Documentation/devicetree/bindings/leds/common.yaml | 2 ++
>  1 file changed, 2 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> index 8a3c2398b10ce..bf9a101e4d420 100644
> --- a/Documentation/devicetree/bindings/leds/common.yaml
> +++ b/Documentation/devicetree/bindings/leds/common.yaml
> @@ -113,6 +113,8 @@ properties:
>              # LED indicates NAND memory activity (deprecated),
>              # in new implementations use "mtd"
>            - nand-disk
> +            # LED indicates network activity
> +          - netdev

netdev is the description of the network development ML/repo, right?

Seems like an odd name for an OS agnostic property?

>              # No trigger assigned to the LED. This is the default mode
>              # if trigger is absent
>            - none
> -- 
> 2.43.0
> 

-- 
Lee Jones [李琼斯]

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Andrew Lunn]

> > diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> > index 8a3c2398b10ce..bf9a101e4d420 100644
> > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > @@ -113,6 +113,8 @@ properties:
> >              # LED indicates NAND memory activity (deprecated),
> >              # in new implementations use "mtd"
> >            - nand-disk
> > +            # LED indicates network activity
> > +          - netdev
> 
> netdev is the description of the network development ML/repo, right?
> 
> Seems like an odd name for an OS agnostic property?

I agree that one meaning is the network development community within
Linux.

But it also means a network device, which is OS agnostic. I don't
really see it be any different to a memory technology device, mtd.

	Andrew

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Lee Jones]

On Thu, 25 Jul 2024, Andrew Lunn wrote:

> > > diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> > > index 8a3c2398b10ce..bf9a101e4d420 100644
> > > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > > @@ -113,6 +113,8 @@ properties:
> > >              # LED indicates NAND memory activity (deprecated),
> > >              # in new implementations use "mtd"
> > >            - nand-disk
> > > +            # LED indicates network activity
> > > +          - netdev
> > 
> > netdev is the description of the network development ML/repo, right?
> > 
> > Seems like an odd name for an OS agnostic property?
> 
> I agree that one meaning is the network development community within
> Linux.
> 
> But it also means a network device, which is OS agnostic. I don't
> really see it be any different to a memory technology device, mtd.

MTD is an acronym.

The only dodgy one I see in there is 'kbd-capslock'.

How about, now go with me here: 'network'?

I'd even suffer 'network-device' or 'net-device' if we really have to shorten.

Although, I'm not really sure the 'device' part needs to come into play'?

-- 
Lee Jones [李琼斯]

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Andrew Lunn]

On Thu, Aug 01, 2024 at 01:53:09PM +0100, Lee Jones wrote:
> On Thu, 25 Jul 2024, Andrew Lunn wrote:
> 
> > > > diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> > > > index 8a3c2398b10ce..bf9a101e4d420 100644
> > > > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > > > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > > > @@ -113,6 +113,8 @@ properties:
> > > >              # LED indicates NAND memory activity (deprecated),
> > > >              # in new implementations use "mtd"
> > > >            - nand-disk
> > > > +            # LED indicates network activity
> > > > +          - netdev
> > > 
> > > netdev is the description of the network development ML/repo, right?
> > > 
> > > Seems like an odd name for an OS agnostic property?
> > 
> > I agree that one meaning is the network development community within
> > Linux.
> > 
> > But it also means a network device, which is OS agnostic. I don't
> > really see it be any different to a memory technology device, mtd.
> 
> MTD is an acronym.
> 
> The only dodgy one I see in there is 'kbd-capslock'.
> 
> How about, now go with me here: 'network'?

We could do, but we have to keep netdev around for backwards
compatibility. There are DT blobs using it which we cannot break.

	Andrew

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Lee Jones]

On Thu, 01 Aug 2024, Andrew Lunn wrote:

> On Thu, Aug 01, 2024 at 01:53:09PM +0100, Lee Jones wrote:
> > On Thu, 25 Jul 2024, Andrew Lunn wrote:
> > 
> > > > > diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> > > > > index 8a3c2398b10ce..bf9a101e4d420 100644
> > > > > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > > > > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > > > > @@ -113,6 +113,8 @@ properties:
> > > > >              # LED indicates NAND memory activity (deprecated),
> > > > >              # in new implementations use "mtd"
> > > > >            - nand-disk
> > > > > +            # LED indicates network activity
> > > > > +          - netdev
> > > > 
> > > > netdev is the description of the network development ML/repo, right?
> > > > 
> > > > Seems like an odd name for an OS agnostic property?
> > > 
> > > I agree that one meaning is the network development community within
> > > Linux.
> > > 
> > > But it also means a network device, which is OS agnostic. I don't
> > > really see it be any different to a memory technology device, mtd.
> > 
> > MTD is an acronym.
> > 
> > The only dodgy one I see in there is 'kbd-capslock'.
> > 
> > How about, now go with me here: 'network'?
> 
> We could do, but we have to keep netdev around for backwards
> compatibility. There are DT blobs using it which we cannot break.

Oh, this 'just' a documentation patch?  'netdev' is already in use?

-- 
Lee Jones [李琼斯]

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Andrew Lunn]

> > We could do, but we have to keep netdev around for backwards
> > compatibility. There are DT blobs using it which we cannot break.
> 
> Oh, this 'just' a documentation patch?  'netdev' is already in use?
> 

A few examples:

intel/ixp/intel-ixp42x-iomega-nas100d.dts:                      linux,default-trigger = "netdev";
intel/ixp/intel-ixp42x-dlink-dsm-g600.dts:                      linux,default-trigger = "netdev";
nxp/imx/imx53-m53menlo.dts:                     linux,default-trigger = "netdev";
rockchip/rk3128-xpi-3128.dts:                    * linux,default-trigger = "netdev";
ti/omap/am5729-beagleboneai.dts:                        linux,default-trigger = "netdev";
ti/omap/am335x-netcan-plus-1xx.dts:                     linux,default-trigger = "netdev";

	Andrew

Re: [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Lee Jones]

On Tue, 06 Aug 2024, Andrew Lunn wrote:

> > > We could do, but we have to keep netdev around for backwards
> > > compatibility. There are DT blobs using it which we cannot break.
> > 
> > Oh, this 'just' a documentation patch?  'netdev' is already in use?
> > 
> 
> A few examples:
> 
> intel/ixp/intel-ixp42x-iomega-nas100d.dts:                      linux,default-trigger = "netdev";
> intel/ixp/intel-ixp42x-dlink-dsm-g600.dts:                      linux,default-trigger = "netdev";
> nxp/imx/imx53-m53menlo.dts:                     linux,default-trigger = "netdev";
> rockchip/rk3128-xpi-3128.dts:                    * linux,default-trigger = "netdev";
> ti/omap/am5729-beagleboneai.dts:                        linux,default-trigger = "netdev";
> ti/omap/am335x-netcan-plus-1xx.dts:                     linux,default-trigger = "netdev";

Gross!  Okay.

-- 
Lee Jones [李琼斯]

Re: (subset) [PATCH v2] dt-bindings: leds: Document "netdev" trigger

[Lee Jones]

On Mon, 08 Jul 2024 13:46:27 +0200, Marek Vasut wrote:
> Document the "netdev" trigger which is used to control LEDs by
> network device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> 

Applied, thanks!

[1/1] dt-bindings: leds: Document "netdev" trigger
      commit: 616dbed65485c6e68325d00b6258a05369c14705

--
Lee Jones [李琼斯]