]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blob - Documentation/devicetree/bindings/leds/leds-gpio.txt
crypto: qat - change the adf_ctl_stop_devices to void
[mirror_ubuntu-hirsute-kernel.git] / Documentation / devicetree / bindings / leds / leds-gpio.txt
1 LEDs connected to GPIO lines
2
3 Required properties:
4 - compatible : should be "gpio-leds".
5
6 Each LED is represented as a sub-node of the gpio-leds device. Each
7 node's name represents the name of the corresponding LED.
8
9 LED sub-node properties:
10 - gpios : Should specify the LED's GPIO, see "gpios property" in
11 Documentation/devicetree/bindings/gpio/gpio.txt. Active low LEDs should be
12 indicated using flags in the GPIO specifier.
13 - label : (optional)
14 see Documentation/devicetree/bindings/leds/common.txt
15 - linux,default-trigger : (optional)
16 see Documentation/devicetree/bindings/leds/common.txt
17 - default-state: (optional) The initial state of the LED. Valid
18 values are "on", "off", and "keep". If the LED is already on or off
19 and the default-state property is set the to same value, then no
20 glitch should be produced where the LED momentarily turns off (or
21 on). The "keep" setting will keep the LED at whatever its current
22 state is, without producing a glitch. The default is off if this
23 property is not present.
24 - retain-state-suspended: (optional) The suspend state can be retained.Such
25 as charge-led gpio.
26
27 Examples:
28
29 #include <dt-bindings/gpio/gpio.h>
30
31 leds {
32 compatible = "gpio-leds";
33 hdd {
34 label = "IDE Activity";
35 gpios = <&mcu_pio 0 GPIO_ACTIVE_LOW>;
36 linux,default-trigger = "ide-disk";
37 };
38
39 fault {
40 gpios = <&mcu_pio 1 GPIO_ACTIVE_HIGH>;
41 /* Keep LED on if BIOS detected hardware fault */
42 default-state = "keep";
43 };
44 };
45
46 run-control {
47 compatible = "gpio-leds";
48 red {
49 gpios = <&mpc8572 6 GPIO_ACTIVE_HIGH>;
50 default-state = "off";
51 };
52 green {
53 gpios = <&mpc8572 7 GPIO_ACTIVE_HIGH>;
54 default-state = "on";
55 };
56 };
57
58 leds {
59 compatible = "gpio-leds";
60
61 charger-led {
62 gpios = <&gpio1 2 GPIO_ACTIVE_HIGH>;
63 linux,default-trigger = "max8903-charger-charging";
64 retain-state-suspended;
65 };
66 };