xref: /freebsd/sys/contrib/device-tree/Bindings/leds/ams,as3645a.txt (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1Analog devices AS3645A device tree bindings
2
3The AS3645A flash LED controller can drive two LEDs, one high current
4flash LED and one indicator LED. The high current flash LED can be
5used in torch mode as well.
6
7Ranges below noted as [a, b] are closed ranges between a and b, i.e. a
8and b are included in the range.
9
10Please also see common.txt in the same directory.
11
12
13Required properties
14===================
15
16compatible	: Must be "ams,as3645a".
17reg		: The I2C address of the device. Typically 0x30.
18#address-cells	: 1
19#size-cells	: 0
20
21
22Required properties of the flash child node (0)
23===============================================
24
25reg: 0
26flash-timeout-us: Flash timeout in microseconds. The value must be in
27		  the range [100000, 850000] and divisible by 50000.
28flash-max-microamp: Maximum flash current in microamperes. Has to be
29		    in the range between [200000, 500000] and
30		    divisible by 20000.
31led-max-microamp: Maximum torch (assist) current in microamperes. The
32		  value must be in the range between [20000, 160000] and
33		  divisible by 20000.
34ams,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
39Optional properties of the flash child node
40===========================================
41
42function	:  See Documentation/devicetree/bindings/leds/common.txt.
43color		:  See Documentation/devicetree/bindings/leds/common.txt.
44label		:  See Documentation/devicetree/bindings/leds/common.txt (deprecated).
45
46
47Required properties of the indicator child node (1)
48===================================================
49
50reg: 1
51led-max-microamp: Maximum indicator current. The allowed values are
52		  2500, 5000, 7500 and 10000.
53
54Optional properties of the indicator child node
55===============================================
56
57function	:  See Documentation/devicetree/bindings/leds/common.txt.
58color		:  See Documentation/devicetree/bindings/leds/common.txt.
59label		:  See Documentation/devicetree/bindings/leds/common.txt (deprecated).
60
61
62Example
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	};
86