GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / leds / ams,as3645a.txt
1 Analog devices AS3645A device tree bindings
2
3 The AS3645A flash LED controller can drive two LEDs, one high current
4 flash LED and one indicator LED. The high current flash LED can be
5 used in torch mode as well.
6
7 Ranges below noted as [a, b] are closed ranges between a and b, i.e. a
8 and b are included in the range.
9
10 Please also see common.txt in the same directory.
11
12
13 Required properties
14 ===================
15
16 compatible      : Must be "ams,as3645a".
17 reg             : The I2C address of the device. Typically 0x30.
18 #address-cells  : 1
19 #size-cells     : 0
20
21
22 Required properties of the flash child node (0)
23 ===============================================
24
25 reg: 0
26 flash-timeout-us: Flash timeout in microseconds. The value must be in
27                   the range [100000, 850000] and divisible by 50000.
28 flash-max-microamp: Maximum flash current in microamperes. Has to be
29                     in the range between [200000, 500000] and
30                     divisible by 20000.
31 led-max-microamp: Maximum torch (assist) current in microamperes. The
32                   value must be in the range between [20000, 160000] and
33                   divisible by 20000.
34 ams,input-max-microamp: Maximum flash controller input current. The
35                         value must be in the range [1250000, 2000000]
36                         and divisible by 50000.
37
38
39 Optional properties of the flash child node
40 ===========================================
41
42 label           : The label of the flash LED.
43
44
45 Required properties of the indicator child node (1)
46 ===================================================
47
48 reg: 1
49 led-max-microamp: Maximum indicator current. The allowed values are
50                   2500, 5000, 7500 and 10000.
51
52 Optional properties of the indicator child node
53 ===============================================
54
55 label           : The label of the indicator LED.
56
57
58 Example
59 =======
60
61         as3645a@30 {
62                 #address-cells: 1
63                 #size-cells: 0
64                 reg = <0x30>;
65                 compatible = "ams,as3645a";
66                 flash@0 {
67                         reg = <0x0>;
68                         flash-timeout-us = <150000>;
69                         flash-max-microamp = <320000>;
70                         led-max-microamp = <60000>;
71                         ams,input-max-microamp = <1750000>;
72                         label = "as3645a:flash";
73                 };
74                 indicator@1 {
75                         reg = <0x1>;
76                         led-max-microamp = <10000>;
77                         label = "as3645a:indicator";
78                 };
79         };