xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/leds/leds-ktd2692.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun* Kinetic Technologies - KTD2692 Flash LED Driver
2*4882a593Smuzhiyun
3*4882a593SmuzhiyunKTD2692 is the ideal power solution for high-power flash LEDs.
4*4882a593SmuzhiyunIt uses ExpressWire single-wire programming for maximum flexibility.
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunThe ExpressWire interface through CTRL pin can control LED on/off and
7*4882a593Smuzhiyunenable/disable the IC, Movie(max 1/3 of Flash current) / Flash mode current,
8*4882a593SmuzhiyunFlash timeout, LVP(low voltage protection).
9*4882a593Smuzhiyun
10*4882a593SmuzhiyunAlso, When the AUX pin is pulled high while CTRL pin is high,
11*4882a593SmuzhiyunLED current will be ramped up to the flash-mode current level.
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunRequired properties:
14*4882a593Smuzhiyun- compatible : Should be "kinetic,ktd2692".
15*4882a593Smuzhiyun- ctrl-gpios : Specifier of the GPIO connected to CTRL pin.
16*4882a593Smuzhiyun- aux-gpios : Specifier of the GPIO connected to AUX pin.
17*4882a593Smuzhiyun
18*4882a593SmuzhiyunOptional properties:
19*4882a593Smuzhiyun- vin-supply : "vin" LED supply (2.7V to 5.5V).
20*4882a593Smuzhiyun  See Documentation/devicetree/bindings/regulator/regulator.txt
21*4882a593Smuzhiyun
22*4882a593SmuzhiyunA discrete LED element connected to the device must be represented by a child
23*4882a593Smuzhiyunnode - See Documentation/devicetree/bindings/leds/common.txt
24*4882a593Smuzhiyun
25*4882a593SmuzhiyunRequired properties for flash LED child nodes:
26*4882a593Smuzhiyun  See Documentation/devicetree/bindings/leds/common.txt
27*4882a593Smuzhiyun- led-max-microamp : Minimum Threshold for Timer protection
28*4882a593Smuzhiyun  is defined internally (Maximum 300mA).
29*4882a593Smuzhiyun- flash-max-microamp : Flash LED maximum current
30*4882a593Smuzhiyun  Formula : I(mA) = 15000 / Rset.
31*4882a593Smuzhiyun- flash-max-timeout-us : Flash LED maximum timeout.
32*4882a593Smuzhiyun
33*4882a593SmuzhiyunOptional properties for flash LED child nodes:
34*4882a593Smuzhiyun- label : See Documentation/devicetree/bindings/leds/common.txt
35*4882a593Smuzhiyun
36*4882a593SmuzhiyunExample:
37*4882a593Smuzhiyun
38*4882a593Smuzhiyunktd2692 {
39*4882a593Smuzhiyun	compatible = "kinetic,ktd2692";
40*4882a593Smuzhiyun	ctrl-gpios = <&gpc0 1 0>;
41*4882a593Smuzhiyun	aux-gpios = <&gpc0 2 0>;
42*4882a593Smuzhiyun	vin-supply = <&vbat>;
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun	flash-led {
45*4882a593Smuzhiyun		label = "ktd2692-flash";
46*4882a593Smuzhiyun		led-max-microamp = <300000>;
47*4882a593Smuzhiyun		flash-max-microamp = <1500000>;
48*4882a593Smuzhiyun		flash-max-timeout-us = <1835000>;
49*4882a593Smuzhiyun	};
50*4882a593Smuzhiyun};
51