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
18   Many LED devices expose more than one current output that can be connected
25   led-sources:
27       List of device current outputs the LED is connected to. The outputs are
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
67       will keep the LED at whatever its current state is, without producing a
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
108           - flash
110           - kbd-capslock
112           - mtd
115           - nand-disk
117           - netdev
120           - none
122           - torch
123             # LED indicates USB gadget activity
124           - usb-gadget
125             # LED indicates USB host activity
126           - usb-host
127             # LED indicates USB port state
128           - usbport
130       - pattern: "^cpu[0-9]*$"
132       - pattern: "^hci[0-9]+-power$"
134       - pattern: "^mmc[0-9]+$"
136       - pattern: "^phy[0-9]+tx$"
138   led-pattern:
143         - one-shot : two numbers specifying delay on and delay off (in ms),
144         - timer : two numbers specifying delay on and delay off (in ms),
145         - pattern : the pattern is given by a series of tuples, of
148           Documentation/devicetree/bindings/leds/leds-trigger-pattern.txt
149     $ref: /schemas/types.yaml#/definitions/uint32-matrix
154   led-max-microamp:
156       Maximum LED supply current in microamperes. This property can be made
158       damage in case an excessive current is set.
159       For flash LED controllers with configurable current this property is
160       mandatory for the LEDs in the non-flash modes (e.g. torch or indicator).
162   max-brightness:
165       property is not required. This property is used to set a software limit.
169       Note that this flag is mainly used for PWM-LEDs, where it is not possible
170       to map brightness to current. Drivers for other controllers should use
171       led-max-microamp.
174   panic-indicator:
180   retain-state-shutdown:
186   trigger-sources:
190       indicate its state. E.g. USB 2.0 LED may react to device(s) in a USB 2.0
198       In many cases LED can be related to more than one device (e.g. one USB LED
199       vs. multiple USB ports). Each source should be represented by a node in
202       #trigger-source-cells property in the source node.
203     $ref: /schemas/types.yaml#/definitions/phandle-array
205   active-low:
211   inactive-high-impedance:
214       Set LED to high-impedance mode to turn the LED OFF. LED might also
218   flash-max-microamp:
220       Maximum flash LED supply current in microamperes. Required for flash LED
221       nodes with configurable current.
223   flash-max-timeout-us:
231   - |
232     #include <dt-bindings/gpio/gpio.h>
233     #include <dt-bindings/leds/common.h>
235     led-controller {
236         compatible = "gpio-leds";
238         led-0 {
240             linux,default-trigger = "heartbeat";
244         led-1 {
247             trigger-sources = <&ohci_port1>, <&ehci_port1>;
251   - |
252     #include <dt-bindings/leds/common.h>
254     led-controller {
255         compatible = "maxim,max77693-led";
260             led-sources = <0>, <1>;
261             led-max-microamp = <50000>;
262             flash-max-microamp = <320000>;
263             flash-max-timeout-us = <500000>;
267   - |
268     #include <dt-bindings/leds/common.h>
271         #address-cells = <1>;
272         #size-cells = <0>;
274         led-controller@30 {
277             #address-cells = <1>;
278             #size-cells = <0>;
282                 linux,default-trigger = "heartbeat";
284                 function-enumerator = <1>;
290                 function-enumerator = <2>;
296                 function-enumerator = <3>;