Merge tag 'tegra-for-4.8-i2c' of git://git.kernel.org/pub/scm/linux/kernel/git/tegra...
[cascardo/linux.git] / Documentation / devicetree / bindings / leds / leds-pm8058.txt
1 Qualcomm PM8058 LED driver
2
3 The Qualcomm PM8058 is a multi-functional device which contains
4 an LED driver block for up to six LEDs: three normal LEDs, two
5 "flash" LEDs and one "keypad backlight" LED. The names are
6 quoted because sometimes these LED drivers are used for wildly
7 different things than flash or keypad backlight: their names
8 are more of a suggestion than a hard-wired usecase.
9
10 Hardware-wise the different LEDs support slightly different
11 output currents. The "flash" LEDs do not need to charge nor
12 do they support external triggers. They are just powerful LED
13 drivers.
14
15 The LEDs appear as children to the PM8058 device, with the
16 proper compatible string. For the PM8058 bindings see:
17 mfd/qcom-pm8xxx.txt.
18
19 Each LED is represented as a sub-node of the syscon device. Each
20 node's name represents the name of the corresponding LED.
21
22 LED sub-node properties:
23
24 Required properties:
25 - compatible: one of
26   "qcom,pm8058-led" (for the normal LEDs at 0x131, 0x132 and 0x133)
27   "qcom,pm8058-keypad-led" (for the "keypad" LED at 0x48)
28   "qcom,pm8058-flash-led" (for the "flash" LEDs at 0x49 and 0xFB)
29
30 Optional properties:
31 - label: see Documentation/devicetree/bindings/leds/common.txt
32 - default-state: see Documentation/devicetree/bindings/leds/common.txt
33 - linux,default-trigger: see Documentation/devicetree/bindings/leds/common.txt
34
35 Example:
36
37 qcom,ssbi@500000 {
38         pmicintc: pmic@0 {
39                 compatible = "qcom,pm8058";
40                 led@48 {
41                         compatible = "qcom,pm8058-keypad-led";
42                         reg = <0x48>;
43                         label = "pm8050:white:keypad";
44                         default-state = "off";
45                 };
46                 led@131 {
47                         compatible = "qcom,pm8058-led";
48                         reg = <0x131>;
49                         label = "pm8058:red";
50                         default-state = "off";
51                 };
52                 led@132 {
53                         compatible = "qcom,pm8058-led";
54                         reg = <0x132>;
55                         label = "pm8058:yellow";
56                         default-state = "off";
57                         linux,default-trigger = "mmc0";
58                 };
59                 led@133 {
60                         compatible = "qcom,pm8058-led";
61                         reg = <0x133>;
62                         label = "pm8058:green";
63                         default-state = "on";
64                         linux,default-trigger = "heartbeat";
65                 };
66         };
67 };