GNU Linux-libre 4.14.266-gnu1
[releases.git] / Documentation / devicetree / bindings / mfd / max14577.txt
1 Maxim MAX14577/77836 Multi-Function Device
2
3 MAX14577 is a Multi-Function Device with Micro-USB Interface Circuit, Li+
4 Battery Charger and SFOUT LDO output for powering USB devices. It is
5 interfaced to host controller using I2C.
6
7 MAX77836 additionally contains PMIC (with two LDO regulators) and Fuel Gauge.
8
9
10 Required properties:
11 - compatible : Must be "maxim,max14577" or "maxim,max77836".
12 - reg : I2C slave address for the max14577 chip (0x25 for max14577/max77836)
13 - interrupts : IRQ line for the chip.
14 - interrupt-parent :  The parent interrupt controller.
15
16
17 Required nodes:
18  - charger :
19         Node for configuring the charger driver.
20         Required properties:
21                 - compatible : "maxim,max14577-charger"
22                         or "maxim,max77836-charger"
23                 - maxim,fast-charge-uamp : Current in uA for Fast Charge;
24                         Valid values:
25                         - for max14577: 90000 - 950000;
26                         - for max77836: 45000 - 475000;
27                 - maxim,eoc-uamp : Current in uA for End-Of-Charge mode;
28                         Valid values:
29                         - for max14577: 50000 - 200000;
30                         - for max77836: 5000 - 100000;
31                 - maxim,ovp-uvolt : OverVoltage Protection Threshold in uV;
32                         In an overvoltage condition, INT asserts and charging
33                         stops. Valid values:
34                         - 6000000, 6500000, 7000000, 7500000;
35                 - maxim,constant-uvolt : Battery Constant Voltage in uV;
36                         Valid values:
37                         - 4000000 - 4280000 (step by 20000);
38                         - 4350000;
39
40
41 Optional nodes:
42 - max14577-muic/max77836-muic :
43         Node used only by extcon consumers.
44         Required properties:
45                 - compatible : "maxim,max14577-muic" or "maxim,max77836-muic"
46
47 - regulators :
48         Required properties:
49                 - compatible : "maxim,max14577-regulator"
50                         or "maxim,max77836-regulator"
51
52         May contain a sub-node per regulator from the list below. Each
53         sub-node should contain the constraints and initialization information
54         for that regulator. See regulator.txt for a description of standard
55         properties for these sub-nodes.
56
57         List of valid regulator names:
58         - for max14577: CHARGER, SAFEOUT.
59         - for max77836: CHARGER, SAFEOUT, LDO1, LDO2.
60
61         The SAFEOUT is a fixed voltage regulator so there is no need to specify
62         voltages for it.
63
64
65 Example:
66
67 #include <dt-bindings/interrupt-controller/irq.h>
68
69 max14577@25 {
70         compatible = "maxim,max14577";
71         reg = <0x25>;
72         interrupt-parent = <&gpx1>;
73         interrupts = <5 IRQ_TYPE_NONE>;
74
75         muic: max14577-muic {
76                 compatible = "maxim,max14577-muic";
77         };
78
79         regulators {
80                 compatible = "maxim,max14577-regulator";
81
82                 SAFEOUT {
83                         regulator-name = "SAFEOUT";
84                 };
85                 CHARGER {
86                         regulator-name = "CHARGER";
87                         regulator-min-microamp = <90000>;
88                         regulator-max-microamp = <950000>;
89                         regulator-boot-on;
90                 };
91         };
92
93         charger {
94                 compatible = "maxim,max14577-charger";
95
96                 maxim,constant-uvolt = <4350000>;
97                 maxim,fast-charge-uamp = <450000>;
98                 maxim,eoc-uamp = <50000>;
99                 maxim,ovp-uvolt = <6500000>;
100         };
101 };
102
103
104 max77836@25 {
105         compatible = "maxim,max77836";
106         reg = <0x25>;
107         interrupt-parent = <&gpx1>;
108         interrupts = <5 IRQ_TYPE_NONE>;
109
110         muic: max77836-muic {
111                 compatible = "maxim,max77836-muic";
112         };
113
114         regulators {
115                 compatible = "maxim,max77836-regulator";
116
117                 SAFEOUT {
118                         regulator-name = "SAFEOUT";
119                 };
120                 CHARGER {
121                         regulator-name = "CHARGER";
122                         regulator-min-microamp = <90000>;
123                         regulator-max-microamp = <950000>;
124                         regulator-boot-on;
125                 };
126                 LDO1 {
127                         regulator-name = "LDO1";
128                         regulator-min-microvolt = <2700000>;
129                         regulator-max-microvolt = <2700000>;
130                 };
131                 LDO2 {
132                         regulator-name = "LDO2";
133                         regulator-min-microvolt = <800000>;
134                         regulator-max-microvolt = <3950000>;
135                 };
136         };
137
138         charger {
139                 compatible = "maxim,max77836-charger";
140
141                 maxim,constant-uvolt = <4350000>;
142                 maxim,fast-charge-uamp = <225000>;
143                 maxim,eoc-uamp = <7500>;
144                 maxim,ovp-uvolt = <6500000>;
145         };
146 };