bindings/leds/common.yaml

1 # SPDX-License-Identifier: GPL-2.0-only
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
10   - Jacek Anaszewski <jacek.anaszewski@gmail.com>
11   - Pavel Machek <pavel@ucw.cz>
14   LED and flash LED devices provide the same basic functionality as current
15   regulators, but extended with LED and flash LED specific features like
16   blinking patterns, flash timeout, flash faults and external flash strobe mode.
25   led-sources:
30     $ref: /schemas/types.yaml#/definitions/uint32-array
35       from the header include/dt-bindings/leds/common.h. If there is no
42       the header include/dt-bindings/leds/common.h. If there is no matching
48   function-enumerator:
59       deprecated - use 'function' and 'color' properties instead.
60       function-enumerator has no effect when this property is present.
62   default-state:
65       default-state property is set the to same value, then no glitch should be
71       - on
72       - off
73       - keep
76   linux,default-trigger:
83       - enum:
84             # LED will act as a back-light, controlled by the framebuffer system
85           - backlight
86             # LED will turn on (see also "default-state" property)
87           - default-on
89           - heartbeat
91           - disk-activity
93           - disk-read
95           - disk-write
97           - timer
99             # timer (requires "led-pattern" property)
100           - pattern
102           - audio-micmute
104           - audio-mute
106           - bluetooth-power
107             # LED indicates camera flash state
108           - flash
110           - kbd-capslock
112           - mtd
115           - nand-disk
118           - none
120           - torch
122           - usb-gadget
124           - usb-host
126           - usbport
128       - pattern: "^cpu[0-9]*$"
130       - pattern: "^hci[0-9]+-power$"
132       - pattern: "^mmc[0-9]+$"
134       - pattern: "^phy[0-9]+tx$"
136   led-pattern:
141         - one-shot : two numbers specifying delay on and delay off (in ms),
142         - timer : two numbers specifying delay on and delay off (in ms),
143         - pattern : the pattern is given by a series of tuples, of
146           Documentation/devicetree/bindings/leds/leds-trigger-pattern.txt
147     $ref: /schemas/types.yaml#/definitions/uint32-matrix
152   led-max-microamp:
157       For flash LED controllers with configurable current this property is
158       mandatory for the LEDs in the non-flash modes (e.g. torch or indicator).
160   max-brightness:
167       Note that this flag is mainly used for PWM-LEDs, where it is not possible
169       led-max-microamp.
172   panic-indicator:
178   retain-state-shutdown:
184   trigger-sources:
200       #trigger-source-cells property in the source node.
201     $ref: /schemas/types.yaml#/definitions/phandle-array
203   # Required properties for flash LED child nodes:
204   flash-max-microamp:
206       Maximum flash LED supply current in microamperes. Required for flash LED
209   flash-max-timeout-us:
211       Maximum timeout in microseconds after which the flash LED is turned off.
212       Required for flash LED nodes with configurable timeout.
217   - |
218     #include <dt-bindings/gpio/gpio.h>
219     #include <dt-bindings/leds/common.h>
221     led-controller {
222         compatible = "gpio-leds";
224         led-0 {
226             linux,default-trigger = "heartbeat";
230         led-1 {
233             trigger-sources = <&ohci_port1>, <&ehci_port1>;
237   - |
238     #include <dt-bindings/leds/common.h>
240     led-controller {
241         compatible = "maxim,max77693-led";
246             led-sources = <0>, <1>;
247             led-max-microamp = <50000>;
248             flash-max-microamp = <320000>;
249             flash-max-timeout-us = <500000>;
253   - |
254     #include <dt-bindings/leds/common.h>
257         #address-cells = <1>;
258         #size-cells = <0>;
260         led-controller@30 {
263             #address-cells = <1>;
264             #size-cells = <0>;
268                 linux,default-trigger = "heartbeat";
270                 function-enumerator = <1>;
276                 function-enumerator = <2>;
282                 function-enumerator = <3>;