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>
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:
64       The initial state of the LED. If the LED is already on or off and the
65       default-state property is set the to same value, then no glitch should be
66       produced where the LED momentarily turns off (or on). The "keep" setting
71       - on
72       - off
73       - keep
74     default: off
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
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
144           brightness and duration (in ms).  The exact format is
146           Documentation/devicetree/bindings/leds/leds-trigger-pattern.txt
147     $ref: /schemas/types.yaml#/definitions/uint32-matrix
152   led-max-microamp:
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:
180       This property specifies that the LED should not be turned off or changed
184   trigger-sources:
198       #trigger-source-cells property in the source node.
199     $ref: /schemas/types.yaml#/definitions/phandle-array
202   flash-max-microamp:
207   flash-max-timeout-us:
209       Maximum timeout in microseconds after which the flash LED is turned off.
215   - |
216     #include <dt-bindings/gpio/gpio.h>
217     #include <dt-bindings/leds/common.h>
219     led-controller {
220         compatible = "gpio-leds";
222         led-0 {
224             linux,default-trigger = "heartbeat";
228         led-1 {
231             trigger-sources = <&ohci_port1>, <&ehci_port1>;
235   - |
236     #include <dt-bindings/leds/common.h>
238     led-controller {
239         compatible = "maxim,max77693-led";
244             led-sources = <0>, <1>;
245             led-max-microamp = <50000>;
246             flash-max-microamp = <320000>;
247             flash-max-timeout-us = <500000>;
251   - |
252     #include <dt-bindings/leds/common.h>
255         #address-cells = <1>;
256         #size-cells = <0>;
258         led-controller@30 {
261             #address-cells = <1>;
262             #size-cells = <0>;
266                 linux,default-trigger = "heartbeat";
268                 function-enumerator = <1>;
274                 function-enumerator = <2>;
280                 function-enumerator = <3>;