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

[Rob Herring]

On Thu, Dec 10, 2020 at 01:54:49PM +0530, Manivannan Sadhasivam wrote:
> This commit documents the LED triggers used commonly in 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.

The idea with recent LED binding changes is to move away from 
'linux,default-trigger' to 'function' and 'trigger-sources' and to have 
some sort of standardized names.

> 
> While at it, let's also sort the triggers in ascending order.

I'm not sure we want that. Probably better to keep related functions 
together.

> 
> Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@xxxxxxxxxx>
> ---
> 
> Changes in v2:
> 
> * Added more triggers, fixed the regex
> * Sorted triggers in ascending order
> 
>  .../devicetree/bindings/leds/common.yaml      | 78 ++++++++++++++-----
>  1 file changed, 60 insertions(+), 18 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/leds/common.yaml b/Documentation/devicetree/bindings/leds/common.yaml
> index f1211e7045f1..3c2e2208c1da 100644
> --- a/Documentation/devicetree/bindings/leds/common.yaml
> +++ b/Documentation/devicetree/bindings/leds/common.yaml
> @@ -79,24 +79,66 @@ properties:
>        the LED.
>      $ref: /schemas/types.yaml#definitions/string
>  
> -    enum:
> -        # LED will act as a back-light, controlled by the framebuffer system
> -      - backlight
> -        # LED will turn on (but for leds-gpio see "default-state" property in
> -        # Documentation/devicetree/bindings/leds/leds-gpio.yaml)
> -      - default-on
> -        # LED "double" flashes at a load average based rate
> -      - heartbeat
> -        # LED indicates disk activity
> -      - disk-activity
> -        # LED indicates IDE disk activity (deprecated), in new implementations
> -        # use "disk-activity"
> -      - ide-disk
> -        # LED flashes at a fixed, configurable rate
> -      - timer
> -        # LED alters the brightness for the specified duration with one software
> -        # timer (requires "led-pattern" property)
> -      - pattern
> +    oneOf:
> +      - items:
> +          - enum:
> +                # LED indicates mic mute state
> +              - audio-micmute
> +                # LED indicates audio mute state
> +              - audio-mute
> +                # LED will act as a back-light, controlled by the framebuffer system
> +              - backlight
> +                # LED indicates bluetooth power state
> +              - bluetooth-power
> +                # LED indicates activity of all CPUs
> +              - cpu
> +                # LED will turn on (but for leds-gpio see "default-state" property in
> +                # Documentation/devicetree/bindings/leds/leds-gpio.yaml)
> +              - default-on
> +                # LED indicates disk activity
> +              - disk-activity
> +                # LED indicates disk read activity
> +              - disk-read
> +                # LED indicates disk write activity
> +              - disk-write
> +                # LED indicates camera flash state
> +              - flash
> +                # LED "double" flashes at a load average based rate
> +              - heartbeat
> +                # LED indicates IDE disk activity (deprecated), in new implementations
> +                # use "disk-activity"
> +              - ide-disk
> +                # 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 alters the brightness for the specified duration with one software
> +                # timer (requires "led-pattern" property)
> +              - pattern
> +                # LED flashes at a fixed, configurable rate
> +              - timer
> +                # LED indicates camera torch state
> +              - torch
> +                # LED indicates USB gadget activity
> +              - usb-gadget
> +                # LED indicates USB host activity
> +              - usb-host
> +      - items:
> +            # LED indicates activity of [N]th CPU
> +          - pattern: "^cpu[0-9]{1,2}$"
> +      - items:
> +            # LED indicates power status of [N]th Bluetooth HCI device
> +          - pattern: "^hci[0-9]{1,2}-power$"
> +      - items:
> +            # LED indicates [N]th MMC storage activity
> +          - pattern: "^mmc[0-9]{1,2}$"
> +      - items:
> +            # LED indicates [N]th WLAN Tx activity
> +          - pattern: "^phy[0-9]{1,2}tx$"
>  
>    led-pattern:
>      description: |
> -- 
> 2.25.1
>