GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / leds / leds-mt6323.txt
1 Device Tree Bindings for LED support on MT6323 PMIC
2
3 MT6323 LED controller is subfunction provided by MT6323 PMIC, so the LED
4 controllers are defined as the subnode of the function node provided by MT6323
5 PMIC controller that is being defined as one kind of Muti-Function Device (MFD)
6 using shared bus called PMIC wrapper for each subfunction to access remote
7 MT6323 PMIC hardware.
8
9 For MT6323 MFD bindings see:
10 Documentation/devicetree/bindings/mfd/mt6397.txt
11 For MediaTek PMIC wrapper bindings see:
12 Documentation/devicetree/bindings/soc/mediatek/pwrap.txt
13
14 Required properties:
15 - compatible : Must be "mediatek,mt6323-led"
16 - address-cells : Must be 1
17 - size-cells : Must be 0
18
19 Each led is represented as a child node of the mediatek,mt6323-led that
20 describes the initial behavior for each LED physically and currently only four
21 LED child nodes can be supported.
22
23 Required properties for the LED child node:
24 - reg : LED channel number (0..3)
25
26 Optional properties for the LED child node:
27 - label : See Documentation/devicetree/bindings/leds/common.txt
28 - linux,default-trigger : See Documentation/devicetree/bindings/leds/common.txt
29 - default-state: See Documentation/devicetree/bindings/leds/common.txt
30
31 Example:
32
33         mt6323: pmic {
34                 compatible = "mediatek,mt6323";
35
36                 ...
37
38                 mt6323led: leds {
39                         compatible = "mediatek,mt6323-led";
40                         #address-cells = <1>;
41                         #size-cells = <0>;
42
43                         led@0 {
44                                 reg = <0>;
45                                 label = "LED0";
46                                 linux,default-trigger = "timer";
47                                 default-state = "on";
48                         };
49                         led@1 {
50                                 reg = <1>;
51                                 label = "LED1";
52                                 default-state = "off";
53                         };
54                         led@2 {
55                                 reg = <2>;
56                                 label = "LED2";
57                                 default-state = "on";
58                         };
59                 };
60         };