Merge tag 'compiler-attributes-for-linus-v5.4' of git://github.com/ojeda/linux
[sfrench/cifs-2.6.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 function        :  See Documentation/devicetree/bindings/leds/common.txt.
43 color           :  See Documentation/devicetree/bindings/leds/common.txt.
44 label           :  See Documentation/devicetree/bindings/leds/common.txt (deprecated).
45
46
47 Required properties of the indicator child node (1)
48 ===================================================
49
50 reg: 1
51 led-max-microamp: Maximum indicator current. The allowed values are
52                   2500, 5000, 7500 and 10000.
53
54 Optional properties of the indicator child node
55 ===============================================
56
57 function        :  See Documentation/devicetree/bindings/leds/common.txt.
58 color           :  See Documentation/devicetree/bindings/leds/common.txt.
59 label           :  See Documentation/devicetree/bindings/leds/common.txt (deprecated).
60
61
62 Example
63 =======
64
65 #include <dt-bindings/leds/common.h>
66
67         as3645a@30 {
68                 #address-cells = <1>;
69                 #size-cells = <0>;
70                 reg = <0x30>;
71                 compatible = "ams,as3645a";
72                 led@0 {
73                         reg = <0x0>;
74                         flash-timeout-us = <150000>;
75                         flash-max-microamp = <320000>;
76                         led-max-microamp = <60000>;
77                         ams,input-max-microamp = <1750000>;
78                         function = LED_FUNCTION_FLASH;
79                 };
80                 led@1 {
81                         reg = <0x1>;
82                         led-max-microamp = <10000>;
83                         function = LED_FUNCTION_INDICATOR;
84                 };
85         };