xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/leds/leds-lm3697.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun* Texas Instruments - LM3697 Highly Efficient White LED Driver
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunThe LM3697 11-bit LED driver provides high-
4*4882a593Smuzhiyunperformance backlight dimming for 1, 2, or 3 series
5*4882a593SmuzhiyunLED strings while delivering up to 90% efficiency.
6*4882a593Smuzhiyun
7*4882a593SmuzhiyunThis device is suitable for display and keypad lighting
8*4882a593Smuzhiyun
9*4882a593SmuzhiyunRequired properties:
10*4882a593Smuzhiyun	- compatible:
11*4882a593Smuzhiyun		"ti,lm3697"
12*4882a593Smuzhiyun	- reg :  I2C slave address
13*4882a593Smuzhiyun	- #address-cells : 1
14*4882a593Smuzhiyun	- #size-cells : 0
15*4882a593Smuzhiyun
16*4882a593SmuzhiyunOptional properties:
17*4882a593Smuzhiyun	- enable-gpios : GPIO pin to enable/disable the device
18*4882a593Smuzhiyun	- vled-supply : LED supply
19*4882a593Smuzhiyun
20*4882a593SmuzhiyunRequired child properties:
21*4882a593Smuzhiyun	- reg : 0 - LED is Controlled by bank A
22*4882a593Smuzhiyun		1 - LED is Controlled by bank B
23*4882a593Smuzhiyun	- led-sources : Indicates which HVLED string is associated to which
24*4882a593Smuzhiyun			control bank.  This is a zero based property so
25*4882a593Smuzhiyun			HVLED1 = 0, HVLED2 = 1, HVLED3 = 2.
26*4882a593Smuzhiyun			Additional information is contained
27*4882a593Smuzhiyun			in Documentation/devicetree/bindings/leds/common.txt
28*4882a593Smuzhiyun
29*4882a593SmuzhiyunOptional child properties:
30*4882a593Smuzhiyun	- ti,brightness-resolution - see Documentation/devicetree/bindings/mfd/ti-lmu.txt
31*4882a593Smuzhiyun	- ramp-up-us: see Documentation/devicetree/bindings/mfd/ti-lmu.txt
32*4882a593Smuzhiyun	- ramp-down-us: see Documentation/devicetree/bindings/mfd/ti-lmu.txt
33*4882a593Smuzhiyun	- label : see Documentation/devicetree/bindings/leds/common.txt
34*4882a593Smuzhiyun	- linux,default-trigger :
35*4882a593Smuzhiyun	   see Documentation/devicetree/bindings/leds/common.txt
36*4882a593Smuzhiyun
37*4882a593SmuzhiyunExample:
38*4882a593Smuzhiyun
39*4882a593SmuzhiyunHVLED string 1 and 3 are controlled by control bank A and HVLED 2 string is
40*4882a593Smuzhiyuncontrolled by control bank B.
41*4882a593Smuzhiyun
42*4882a593Smuzhiyunled-controller@36 {
43*4882a593Smuzhiyun	compatible = "ti,lm3697";
44*4882a593Smuzhiyun	#address-cells = <1>;
45*4882a593Smuzhiyun	#size-cells = <0>;
46*4882a593Smuzhiyun	reg = <0x36>;
47*4882a593Smuzhiyun
48*4882a593Smuzhiyun	enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
49*4882a593Smuzhiyun	vled-supply = <&vbatt>;
50*4882a593Smuzhiyun
51*4882a593Smuzhiyun	led@0 {
52*4882a593Smuzhiyun		reg = <0>;
53*4882a593Smuzhiyun		led-sources = <0 2>;
54*4882a593Smuzhiyun		ti,brightness-resolution = <2047>;
55*4882a593Smuzhiyun		ramp-up-us = <5000>;
56*4882a593Smuzhiyun		ramp-down-us = <1000>;
57*4882a593Smuzhiyun		label = "white:first_backlight_cluster";
58*4882a593Smuzhiyun		linux,default-trigger = "backlight";
59*4882a593Smuzhiyun	};
60*4882a593Smuzhiyun
61*4882a593Smuzhiyun	led@1 {
62*4882a593Smuzhiyun		reg = <1>;
63*4882a593Smuzhiyun		led-sources = <1>;
64*4882a593Smuzhiyun		ti,brightness-resolution = <255>;
65*4882a593Smuzhiyun		ramp-up-us = <500>;
66*4882a593Smuzhiyun		ramp-down-us = <1000>;
67*4882a593Smuzhiyun		label = "white:second_backlight_cluster";
68*4882a593Smuzhiyun		linux,default-trigger = "backlight";
69*4882a593Smuzhiyun	};
70*4882a593Smuzhiyun}
71*4882a593Smuzhiyun
72*4882a593SmuzhiyunFor more product information please see the link below:
73*4882a593Smuzhiyunhttps://www.ti.com/lit/ds/symlink/lm3697.pdf
74