[v5] dt-bindings: leds: Document commonly used LED triggers
Commit Message
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 v5:
* Rebased on top of v6.2-rc1
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 | 35 +++++++++++++++++++
1 file changed, 35 insertions(+)
Comments
On Mon, Feb 13, 2023 at 12:38:27PM +0530, 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 v5:
>
> * Rebased on top of v6.2-rc1
Noticed that Lee is now maintaining LED subsystem after sending v5.
So rebased the patch on top of lee/for-leds-next branch and sent v6.
Thanks,
Mani
>
> 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 | 35 +++++++++++++++++++
> 1 file changed, 35 insertions(+)
>
> diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> index f5c57a580078..d01a52e9e982 100644
> --- a/Documentation/devicetree/bindings/leds/common.yaml
> +++ b/Documentation/devicetree/bindings/leds/common.yaml
> @@ -98,9 +98,44 @@ properties:
> # LED alters the brightness for the specified duration with one software
> # timer (requires "led-pattern" property)
> - pattern
> + # 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 is triggered by SD/MMC activity
> - pattern: "^mmc[0-9]+$"
> + # LED is triggered by CPU activity
> - pattern: "^cpu[0-9]*$"
> + # 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
>
On Mon, 13 Feb 2023, Manivannan Sadhasivam wrote:
> On Mon, Feb 13, 2023 at 12:38:27PM +0530, 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 v5:
> >
> > * Rebased on top of v6.2-rc1
>
> Noticed that Lee is now maintaining LED subsystem after sending v5.
> So rebased the patch on top of lee/for-leds-next branch and sent v6.
You can normally just work on top of -next.
On Mon, 13 Feb 2023, 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 v5:
>
> * Rebased on top of v6.2-rc1
>
> 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 | 35 +++++++++++++++++++
> 1 file changed, 35 insertions(+)
This version fails to apply, please rebase onto -next.
@@ -98,9 +98,44 @@ properties:
# LED alters the brightness for the specified duration with one software
# timer (requires "led-pattern" property)
- pattern
+ # 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 is triggered by SD/MMC activity
- pattern: "^mmc[0-9]+$"
+ # LED is triggered by CPU activity
- pattern: "^cpu[0-9]*$"
+ # 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: |