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

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

[Heiko Stuebner]

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

It was originally introduced into the Linux kernel in 2013 with
commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")

Signed-off-by: Heiko Stuebner <heiko@sntech.de>
---
changes in v2:
- put the entry in the correct position and comment above it (Pavel)

 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 bf9a101e4d42..9cd89f30fa7c 100644
--- a/Documentation/devicetree/bindings/leds/common.yaml
+++ b/Documentation/devicetree/bindings/leds/common.yaml
@@ -118,6 +118,8 @@ properties:
             # No trigger assigned to the LED. This is the default mode
             # if trigger is absent
           - none
+            # LED indicates remote control feedback
+          - rc-feedback
             # LED indicates camera torch state
           - torch
             # LED indicates USB gadget activity
-- 
2.43.0

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

[Rob Herring (Arm)]

On Mon, 07 Oct 2024 22:53:15 +0200, Heiko Stuebner wrote:
> Document the "rc-feedback" trigger which is used to control LEDs by
> remote control device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> It was originally introduced into the Linux kernel in 2013 with
> commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> 
> Signed-off-by: Heiko Stuebner <heiko@sntech.de>
> ---
> changes in v2:
> - put the entry in the correct position and comment above it (Pavel)
> 
>  Documentation/devicetree/bindings/leds/common.yaml | 2 ++
>  1 file changed, 2 insertions(+)
> 

Acked-by: Rob Herring (Arm) <robh@kernel.org>

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

[Pavel Machek]

[-- Attachment #1: Type: text/plain, Size: 1248 bytes --]

On Mon 2024-10-07 22:53:15, Heiko Stuebner wrote:
> Document the "rc-feedback" trigger which is used to control LEDs by
> remote control device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> It was originally introduced into the Linux kernel in 2013 with
> commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> 
> Signed-off-by: Heiko Stuebner <heiko@sntech.de>

Acked-by: Pavel Machek <pavel@ucw.cz>

> diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> index bf9a101e4d42..9cd89f30fa7c 100644
> --- a/Documentation/devicetree/bindings/leds/common.yaml
> +++ b/Documentation/devicetree/bindings/leds/common.yaml
> @@ -118,6 +118,8 @@ properties:
>              # No trigger assigned to the LED. This is the default mode
>              # if trigger is absent
>            - none
> +            # LED indicates remote control feedback
> +          - rc-feedback
>              # LED indicates camera torch state
>            - torch
>              # LED indicates USB gadget activity

-- 
People of Russia, stop Putin before his war on Ukraine escalates.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

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

[Lee Jones]

On Mon, 07 Oct 2024, Heiko Stuebner wrote:

> Document the "rc-feedback" trigger which is used to control LEDs by
> remote control device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> It was originally introduced into the Linux kernel in 2013 with
> commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> 
> Signed-off-by: Heiko Stuebner <heiko@sntech.de>
> ---
> changes in v2:
> - put the entry in the correct position and comment above it (Pavel)
> 
>  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 bf9a101e4d42..9cd89f30fa7c 100644
> --- a/Documentation/devicetree/bindings/leds/common.yaml
> +++ b/Documentation/devicetree/bindings/leds/common.yaml
> @@ -118,6 +118,8 @@ properties:
>              # No trigger assigned to the LED. This is the default mode
>              # if trigger is absent
>            - none
> +            # LED indicates remote control feedback
> +          - rc-feedback

Is 'rc' a recognised and well known abbreviation for remote control?

How about we people some (look-up) time and say:

  - remote-control-feedback

?

>              # LED indicates camera torch state
>            - torch
>              # LED indicates USB gadget activity
> -- 
> 2.43.0
> 

-- 
Lee Jones [李琼斯]

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

[Heiko Stübner]

Hi Lee,

Am Mittwoch, 9. Oktober 2024, 16:48:36 CEST schrieb Lee Jones:
> On Mon, 07 Oct 2024, Heiko Stuebner wrote:
> 
> > Document the "rc-feedback" trigger which is used to control LEDs by
> > remote control device activity. This is an existing trigger used in
> > existing DTs, document it so validation of those DTs would pass.
> > 
> > It was originally introduced into the Linux kernel in 2013 with
> > commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> > 
> > Signed-off-by: Heiko Stuebner <heiko@sntech.de>
> > ---
> > changes in v2:
> > - put the entry in the correct position and comment above it (Pavel)
> > 
> >  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 bf9a101e4d42..9cd89f30fa7c 100644
> > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > @@ -118,6 +118,8 @@ properties:
> >              # No trigger assigned to the LED. This is the default mode
> >              # if trigger is absent
> >            - none
> > +            # LED indicates remote control feedback
> > +          - rc-feedback
> 
> Is 'rc' a recognised and well known abbreviation for remote control?
> 
> How about we people some (look-up) time and say:
> 
>   - remote-control-feedback

The issue being that this exact trigger rc-feedback is in the kernel for
11 years already - see the commit link in the description, and used in
a number of boards in the wild since then.

So the naming-ship has sailed for a while now, and this change
"simply" documents the status quo. And judging from Rob's Ack
it looks like he's okay with the naming too.


Heiko

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

[Lee Jones]

On Wed, 09 Oct 2024, Heiko Stübner wrote:

> Hi Lee,
> 
> Am Mittwoch, 9. Oktober 2024, 16:48:36 CEST schrieb Lee Jones:
> > On Mon, 07 Oct 2024, Heiko Stuebner wrote:
> > 
> > > Document the "rc-feedback" trigger which is used to control LEDs by
> > > remote control device activity. This is an existing trigger used in
> > > existing DTs, document it so validation of those DTs would pass.
> > > 
> > > It was originally introduced into the Linux kernel in 2013 with
> > > commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> > > 
> > > Signed-off-by: Heiko Stuebner <heiko@sntech.de>
> > > ---
> > > changes in v2:
> > > - put the entry in the correct position and comment above it (Pavel)
> > > 
> > >  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 bf9a101e4d42..9cd89f30fa7c 100644
> > > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > > @@ -118,6 +118,8 @@ properties:
> > >              # No trigger assigned to the LED. This is the default mode
> > >              # if trigger is absent
> > >            - none
> > > +            # LED indicates remote control feedback
> > > +          - rc-feedback
> > 
> > Is 'rc' a recognised and well known abbreviation for remote control?
> > 
> > How about we people some (look-up) time and say:
> > 
> >   - remote-control-feedback
> 
> The issue being that this exact trigger rc-feedback is in the kernel for
> 11 years already - see the commit link in the description, and used in
> a number of boards in the wild since then.
> 
> So the naming-ship has sailed for a while now, and this change
> "simply" documents the status quo. And judging from Rob's Ack
> it looks like he's okay with the naming too.

This is why it's important for people to document things when they're
introduced. :(

-- 
Lee Jones [李琼斯]

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

[Heiko Stübner]

Am Donnerstag, 10. Oktober 2024, 10:37:38 CEST schrieb Lee Jones:
> On Wed, 09 Oct 2024, Heiko Stübner wrote:
> 
> > Hi Lee,
> > 
> > Am Mittwoch, 9. Oktober 2024, 16:48:36 CEST schrieb Lee Jones:
> > > On Mon, 07 Oct 2024, Heiko Stuebner wrote:
> > > 
> > > > Document the "rc-feedback" trigger which is used to control LEDs by
> > > > remote control device activity. This is an existing trigger used in
> > > > existing DTs, document it so validation of those DTs would pass.
> > > > 
> > > > It was originally introduced into the Linux kernel in 2013 with
> > > > commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> > > > 
> > > > Signed-off-by: Heiko Stuebner <heiko@sntech.de>
> > > > ---
> > > > changes in v2:
> > > > - put the entry in the correct position and comment above it (Pavel)
> > > > 
> > > >  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 bf9a101e4d42..9cd89f30fa7c 100644
> > > > --- a/Documentation/devicetree/bindings/leds/common.yaml
> > > > +++ b/Documentation/devicetree/bindings/leds/common.yaml
> > > > @@ -118,6 +118,8 @@ properties:
> > > >              # No trigger assigned to the LED. This is the default mode
> > > >              # if trigger is absent
> > > >            - none
> > > > +            # LED indicates remote control feedback
> > > > +          - rc-feedback
> > > 
> > > Is 'rc' a recognised and well known abbreviation for remote control?
> > > 
> > > How about we people some (look-up) time and say:
> > > 
> > >   - remote-control-feedback
> > 
> > The issue being that this exact trigger rc-feedback is in the kernel for
> > 11 years already - see the commit link in the description, and used in
> > a number of boards in the wild since then.
> > 
> > So the naming-ship has sailed for a while now, and this change
> > "simply" documents the status quo. And judging from Rob's Ack
> > it looks like he's okay with the naming too.
> 
> This is why it's important for people to document things when they're
> introduced. :(

I fully agree with you on that :-) .

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

[Lee Jones]

On Mon, 07 Oct 2024 22:53:15 +0200, Heiko Stuebner wrote:
> Document the "rc-feedback" trigger which is used to control LEDs by
> remote control device activity. This is an existing trigger used in
> existing DTs, document it so validation of those DTs would pass.
> 
> It was originally introduced into the Linux kernel in 2013 with
> commit 153a60bb0fac ("[media] rc: add feedback led trigger for rc keypresses")
> 
> [...]

Applied, thanks!

[1/1] dt-bindings: leds: Document "rc-feedback" trigger
      commit: 267f1ad6fa0c45ba39d60c33949605820f791ae7

--
Lee Jones [李琼斯]