xref: /openbmc/linux/Documentation/devicetree/bindings/leds/leds-lm3697.txt (revision 4b4193256c8d3bc3a5397b5cd9494c2ad386317d)
11372bbe6SDan Murphy* Texas Instruments - LM3697 Highly Efficient White LED Driver
21372bbe6SDan Murphy
31372bbe6SDan MurphyThe LM3697 11-bit LED driver provides high-
41372bbe6SDan Murphyperformance backlight dimming for 1, 2, or 3 series
51372bbe6SDan MurphyLED strings while delivering up to 90% efficiency.
61372bbe6SDan Murphy
71372bbe6SDan MurphyThis device is suitable for display and keypad lighting
81372bbe6SDan Murphy
91372bbe6SDan MurphyRequired properties:
101372bbe6SDan Murphy	- compatible:
111372bbe6SDan Murphy		"ti,lm3697"
121372bbe6SDan Murphy	- reg :  I2C slave address
131372bbe6SDan Murphy	- #address-cells : 1
141372bbe6SDan Murphy	- #size-cells : 0
151372bbe6SDan Murphy
161372bbe6SDan MurphyOptional properties:
171372bbe6SDan Murphy	- enable-gpios : GPIO pin to enable/disable the device
181372bbe6SDan Murphy	- vled-supply : LED supply
191372bbe6SDan Murphy
201372bbe6SDan MurphyRequired child properties:
211372bbe6SDan Murphy	- reg : 0 - LED is Controlled by bank A
221372bbe6SDan Murphy		1 - LED is Controlled by bank B
231372bbe6SDan Murphy	- led-sources : Indicates which HVLED string is associated to which
241372bbe6SDan Murphy			control bank.  This is a zero based property so
251372bbe6SDan Murphy			HVLED1 = 0, HVLED2 = 1, HVLED3 = 2.
261372bbe6SDan Murphy			Additional information is contained
271372bbe6SDan Murphy			in Documentation/devicetree/bindings/leds/common.txt
281372bbe6SDan Murphy
291372bbe6SDan MurphyOptional child properties:
301372bbe6SDan Murphy	- ti,brightness-resolution - see Documentation/devicetree/bindings/mfd/ti-lmu.txt
311372bbe6SDan Murphy	- ramp-up-us: see Documentation/devicetree/bindings/mfd/ti-lmu.txt
321372bbe6SDan Murphy	- ramp-down-us: see Documentation/devicetree/bindings/mfd/ti-lmu.txt
331372bbe6SDan Murphy	- label : see Documentation/devicetree/bindings/leds/common.txt
341372bbe6SDan Murphy	- linux,default-trigger :
351372bbe6SDan Murphy	   see Documentation/devicetree/bindings/leds/common.txt
361372bbe6SDan Murphy
371372bbe6SDan MurphyExample:
381372bbe6SDan Murphy
391372bbe6SDan MurphyHVLED string 1 and 3 are controlled by control bank A and HVLED 2 string is
401372bbe6SDan Murphycontrolled by control bank B.
411372bbe6SDan Murphy
421372bbe6SDan Murphyled-controller@36 {
431372bbe6SDan Murphy	compatible = "ti,lm3697";
441372bbe6SDan Murphy	#address-cells = <1>;
451372bbe6SDan Murphy	#size-cells = <0>;
461372bbe6SDan Murphy	reg = <0x36>;
471372bbe6SDan Murphy
481372bbe6SDan Murphy	enable-gpios = <&gpio1 28 GPIO_ACTIVE_HIGH>;
491372bbe6SDan Murphy	vled-supply = <&vbatt>;
501372bbe6SDan Murphy
511372bbe6SDan Murphy	led@0 {
521372bbe6SDan Murphy		reg = <0>;
531372bbe6SDan Murphy		led-sources = <0 2>;
541372bbe6SDan Murphy		ti,brightness-resolution = <2047>;
551372bbe6SDan Murphy		ramp-up-us = <5000>;
561372bbe6SDan Murphy		ramp-down-us = <1000>;
571372bbe6SDan Murphy		label = "white:first_backlight_cluster";
581372bbe6SDan Murphy		linux,default-trigger = "backlight";
591372bbe6SDan Murphy	};
601372bbe6SDan Murphy
611372bbe6SDan Murphy	led@1 {
621372bbe6SDan Murphy		reg = <1>;
631372bbe6SDan Murphy		led-sources = <1>;
641372bbe6SDan Murphy		ti,brightness-resolution = <255>;
651372bbe6SDan Murphy		ramp-up-us = <500>;
661372bbe6SDan Murphy		ramp-down-us = <1000>;
671372bbe6SDan Murphy		label = "white:second_backlight_cluster";
681372bbe6SDan Murphy		linux,default-trigger = "backlight";
691372bbe6SDan Murphy	};
701372bbe6SDan Murphy}
711372bbe6SDan Murphy
721372bbe6SDan MurphyFor more product information please see the link below:
73*c5437338SAlexander A. Klimovhttps://www.ti.com/lit/ds/symlink/lm3697.pdf
74