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