[PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Manivannan Sadhasivam]

Document the commonly used LED triggers by the SoCs. Not all triggers
are documented as some of them are very application specific. Most of the
triggers documented here are currently used in devicetrees of many SoCs.

Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
---

Changes in v4:

* Removed the sorting of triggers
* Removed the "items" as they were not needed
* Reworded the description
* Dropped Zhen Lei's tested-by tag as the patch has changed
* Added kbd-capslock trigger

Changes in v3:

* Rebased on top of v6.1-rc1
* Added WLAN Rx trigger
* Added tested tag from Zhen Lei

Changes in v2:

* Added more triggers, fixed the regex
* Sorted triggers in ascending order

 .../devicetree/bindings/leds/common.yaml      | 40 ++++++++++++++++++-
 1 file changed, 38 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
index 3c14a98430e1..68da651f29a8 100644
--- a/Documentation/devicetree/bindings/leds/common.yaml
+++ b/Documentation/devicetree/bindings/leds/common.yaml
@@ -98,8 +98,44 @@ properties:
             # LED alters the brightness for the specified duration with one software
             # timer (requires "led-pattern" property)
           - pattern
-        # LED is triggered by SD/MMC activity
-      - pattern: "^mmc[0-9]+$"
+            # LED indicates mic mute state
+          - audio-micmute
+            # LED indicates audio mute state
+          - audio-mute
+            # LED indicates bluetooth power state
+          - bluetooth-power
+            # LED indicates activity of all CPUs
+          - cpu
+            # LED indicates disk read activity
+          - disk-read
+            # LED indicates disk write activity
+          - disk-write
+            # LED indicates camera flash state
+          - flash
+            # LED indicated keyboard capslock
+          - kbd-capslock
+            # LED indicates MTD memory activity
+          - mtd
+            # LED indicates NAND memory activity (deprecated),
+            # in new implementations use "mtd"
+          - nand-disk
+            # No trigger assigned to the LED. This is the default mode
+            # if trigger is absent
+          - none
+            # LED indicates camera torch state
+          - torch
+            # LED indicates USB gadget activity
+          - usb-gadget
+            # LED indicates USB host activity
+          - usb-host
+        # LED indicates [N]th MMC storage activity
+      - pattern: "^mmc[0-9]{1,2}$"
+        # LED indicates activity of [N]th CPU
+      - pattern: "^cpu[0-9]{1,2}$"
+        # LED indicates power status of [N]th Bluetooth HCI device
+      - pattern: "^hci[0-9]{1,2}-power$"
+        # LED indicates [N]th WLAN Tx/Rx activity
+      - pattern: "^phy[0-9]{1,2}(tx|rx)$"
 
   led-pattern:
     description: |
-- 
2.25.1

Re: [PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Rob Herring]

On Tue, Nov 29, 2022 at 11:49 AM Manivannan Sadhasivam
<manivannan.sadhasivam@linaro.org> wrote:
>
> Document the commonly used LED triggers by the SoCs. Not all triggers
> are documented as some of them are very application specific. Most of the
> triggers documented here are currently used in devicetrees of many SoCs.
>
> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> ---
>
> Changes in v4:
>
> * Removed the sorting of triggers
> * Removed the "items" as they were not needed
> * Reworded the description
> * Dropped Zhen Lei's tested-by tag as the patch has changed
> * Added kbd-capslock trigger
>
> Changes in v3:
>
> * Rebased on top of v6.1-rc1
> * Added WLAN Rx trigger
> * Added tested tag from Zhen Lei
>
> Changes in v2:
>
> * Added more triggers, fixed the regex
> * Sorted triggers in ascending order
>
>  .../devicetree/bindings/leds/common.yaml      | 40 ++++++++++++++++++-
>  1 file changed, 38 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> index 3c14a98430e1..68da651f29a8 100644
> --- a/Documentation/devicetree/bindings/leds/common.yaml
> +++ b/Documentation/devicetree/bindings/leds/common.yaml
> @@ -98,8 +98,44 @@ properties:
>              # LED alters the brightness for the specified duration with one software
>              # timer (requires "led-pattern" property)
>            - pattern
> -        # LED is triggered by SD/MMC activity
> -      - pattern: "^mmc[0-9]+$"
> +            # LED indicates mic mute state
> +          - audio-micmute
> +            # LED indicates audio mute state
> +          - audio-mute
> +            # LED indicates bluetooth power state
> +          - bluetooth-power
> +            # LED indicates activity of all CPUs
> +          - cpu
> +            # LED indicates disk read activity
> +          - disk-read
> +            # LED indicates disk write activity
> +          - disk-write
> +            # LED indicates camera flash state
> +          - flash
> +            # LED indicated keyboard capslock
> +          - kbd-capslock
> +            # LED indicates MTD memory activity
> +          - mtd
> +            # LED indicates NAND memory activity (deprecated),
> +            # in new implementations use "mtd"
> +          - nand-disk
> +            # No trigger assigned to the LED. This is the default mode
> +            # if trigger is absent
> +          - none
> +            # LED indicates camera torch state
> +          - torch
> +            # LED indicates USB gadget activity
> +          - usb-gadget
> +            # LED indicates USB host activity
> +          - usb-host
> +        # LED indicates [N]th MMC storage activity
> +      - pattern: "^mmc[0-9]{1,2}$"
> +        # LED indicates activity of [N]th CPU
> +      - pattern: "^cpu[0-9]{1,2}$"

This will conflict with Pawel's tree because I already added this.
Mine covers 'cpu' and my 100 core system with 100 cpu leds. ;)

> +        # LED indicates power status of [N]th Bluetooth HCI device
> +      - pattern: "^hci[0-9]{1,2}-power$"
> +        # LED indicates [N]th WLAN Tx/Rx activity
> +      - pattern: "^phy[0-9]{1,2}(tx|rx)$"

And these are pending from Geert[1].

Rob

[1] https://lore.kernel.org/all/a85c256af01f64389a078c2b37c3b72a27d97536.1668005062.git.geert+renesas@glider.be/

Re: [PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Krzysztof Kozlowski]

On 29/11/2022 18:49, Manivannan Sadhasivam wrote:
> Document the commonly used LED triggers by the SoCs. Not all triggers
> are documented as some of them are very application specific. Most of the
> triggers documented here are currently used in devicetrees of many SoCs.
> 
> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> ---
> 
> Changes in v4:
> 
> * Removed the sorting of triggers
> * Removed the "items" as they were not needed
> * Reworded the description
> * Dropped Zhen Lei's tested-by tag as the patch has changed
> * Added kbd-capslock trigger

Any plans for this patch?

Best regards,
Krzysztof

Re: [PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Lee Jones]

On Tue, 07 Feb 2023, Krzysztof Kozlowski wrote:

> On 29/11/2022 18:49, Manivannan Sadhasivam wrote:
> > Document the commonly used LED triggers by the SoCs. Not all triggers
> > are documented as some of them are very application specific. Most of the
> > triggers documented here are currently used in devicetrees of many SoCs.
> > 
> > Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> > ---
> > 
> > Changes in v4:
> > 
> > * Removed the sorting of triggers
> > * Removed the "items" as they were not needed
> > * Reworded the description
> > * Dropped Zhen Lei's tested-by tag as the patch has changed
> > * Added kbd-capslock trigger
> 
> Any plans for this patch?

Who are you asking?

This patch is not in my inbox.

-- 
Lee Jones [李琼斯]

Re: [PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Krzysztof Kozlowski]

On 07/02/2023 19:46, Lee Jones wrote:
> On Tue, 07 Feb 2023, Krzysztof Kozlowski wrote:
> 
>> On 29/11/2022 18:49, Manivannan Sadhasivam wrote:
>>> Document the commonly used LED triggers by the SoCs. Not all triggers
>>> are documented as some of them are very application specific. Most of the
>>> triggers documented here are currently used in devicetrees of many SoCs.
>>>
>>> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
>>> ---
>>>
>>> Changes in v4:
>>>
>>> * Removed the sorting of triggers
>>> * Removed the "items" as they were not needed
>>> * Reworded the description
>>> * Dropped Zhen Lei's tested-by tag as the patch has changed
>>> * Added kbd-capslock trigger
>>
>> Any plans for this patch?
> 
> Who are you asking?
> 
> This patch is not in my inbox.

Mani and Pavel. I Cc-ed you just for completeness.

I would expect Mani to rebase and resend it.

Best regards,
Krzysztof

Re: [PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Lee Jones]

On Tue, 07 Feb 2023, Krzysztof Kozlowski wrote:

> On 07/02/2023 19:46, Lee Jones wrote:
> > On Tue, 07 Feb 2023, Krzysztof Kozlowski wrote:
> > 
> >> On 29/11/2022 18:49, Manivannan Sadhasivam wrote:
> >>> Document the commonly used LED triggers by the SoCs. Not all triggers
> >>> are documented as some of them are very application specific. Most of the
> >>> triggers documented here are currently used in devicetrees of many SoCs.
> >>>
> >>> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> >>> ---
> >>>
> >>> Changes in v4:
> >>>
> >>> * Removed the sorting of triggers
> >>> * Removed the "items" as they were not needed
> >>> * Reworded the description
> >>> * Dropped Zhen Lei's tested-by tag as the patch has changed
> >>> * Added kbd-capslock trigger
> >>
> >> Any plans for this patch?
> > 
> > Who are you asking?
> > 
> > This patch is not in my inbox.
> 
> Mani and Pavel. I Cc-ed you just for completeness.
> 
> I would expect Mani to rebase and resend it.

Yes, please do that.

-- 
Lee Jones [李琼斯]

Re: [PATCH v4] dt-bindings: leds: Document commonly used LED triggers

[Manivannan Sadhasivam]

On Tue, Feb 07, 2023 at 09:39:15PM +0100, Krzysztof Kozlowski wrote:
> On 07/02/2023 19:46, Lee Jones wrote:
> > On Tue, 07 Feb 2023, Krzysztof Kozlowski wrote:
> > 
> >> On 29/11/2022 18:49, Manivannan Sadhasivam wrote:
> >>> Document the commonly used LED triggers by the SoCs. Not all triggers
> >>> are documented as some of them are very application specific. Most of the
> >>> triggers documented here are currently used in devicetrees of many SoCs.
> >>>
> >>> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
> >>> ---
> >>>
> >>> Changes in v4:
> >>>
> >>> * Removed the sorting of triggers
> >>> * Removed the "items" as they were not needed
> >>> * Reworded the description
> >>> * Dropped Zhen Lei's tested-by tag as the patch has changed
> >>> * Added kbd-capslock trigger
> >>
> >> Any plans for this patch?
> > 
> > Who are you asking?
> > 
> > This patch is not in my inbox.
> 
> Mani and Pavel. I Cc-ed you just for completeness.
> 
> I would expect Mani to rebase and resend it.
> 

Sorry for the delay, sent now!

Thanks,
Mani

> Best regards,
> Krzysztof
> 

-- 
மணிவண்ணன் சதாசிவம்