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