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