1* Maxim MAX8997 Voltage and Current Regulator
2
3The Maxim MAX8997 is a multi-function device which includes voltage and
4current regulators, rtc, charger controller and other sub-blocks. It is
5interfaced to the host controller using a i2c interface. Each sub-block is
6addressed by the host system using different i2c slave address. This document
7describes the bindings for 'pmic' sub-block of max8997.
8
9Required properties:
10- compatible: Should be "maxim,max8997-pmic".
11- reg: Specifies the i2c slave address of the pmic block. It should be 0x66.
12
13- max8997,pmic-buck1-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
14  units for buck1 when changing voltage using gpio dvs. Refer to [1] below
15  for additional information.
16
17- max8997,pmic-buck2-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
18  units for buck2 when changing voltage using gpio dvs. Refer to [1] below
19  for additional information.
20
21- max8997,pmic-buck5-dvs-voltage: A set of 8 voltage values in micro-volt (uV)
22  units for buck5 when changing voltage using gpio dvs. Refer to [1] below
23  for additional information.
24
25[1] If none of the 'max8997,pmic-buck[1/2/5]-uses-gpio-dvs' optional
26    property is specified, the 'max8997,pmic-buck[1/2/5]-dvs-voltage'
27    property should specify atleast one voltage level (which would be a
28    safe operating voltage).
29
30    If either of the 'max8997,pmic-buck[1/2/5]-uses-gpio-dvs' optional
31    property is specified, then all the eight voltage values for the
32    'max8997,pmic-buck[1/2/5]-dvs-voltage' should be specified.
33
34Optional properties:
35- interrupts: Interrupt specifiers for two interrupt sources.
36  - First interrupt specifier is for 'irq1' interrupt.
37  - Second interrupt specifier is for 'alert' interrupt.
38- charger-supply: regulator node for charging current.
39- max8997,pmic-buck1-uses-gpio-dvs: 'buck1' can be controlled by gpio dvs.
40- max8997,pmic-buck2-uses-gpio-dvs: 'buck2' can be controlled by gpio dvs.
41- max8997,pmic-buck5-uses-gpio-dvs: 'buck5' can be controlled by gpio dvs.
42
43Additional properties required if either of the optional properties are used:
44- max8997,pmic-ignore-gpiodvs-side-effect: When GPIO-DVS mode is used for
45  multiple bucks, changing the voltage value of one of the bucks may affect
46  that of another buck, which is the side effect of the change (set_voltage).
47  Use this property to ignore such side effects and change the voltage.
48
49- max8997,pmic-buck125-default-dvs-idx: Default voltage setting selected from
50  the possible 8 options selectable by the dvs gpios. The value of this
51  property should be between 0 and 7. If not specified or if out of range, the
52  default value of this property is set to 0.
53
54- max8997,pmic-buck125-dvs-gpios: GPIO specifiers for three host gpio's used
55  for dvs. The format of the gpio specifier depends in the gpio controller.
56
57Regulators: The regulators of max8997 that have to be instantiated should be
58included in a sub-node named 'regulators'. Regulator nodes included in this
59sub-node should be of the format as listed below.
60
61	regulator_name {
62		standard regulator bindings here
63	};
64
65The following are the names of the regulators that the max8997 pmic block
66supports. Note: The 'n' in LDOn and BUCKn represents the LDO or BUCK number
67as per the datasheet of max8997.
68
69	- LDOn
70		  - valid values for n are 1 to 18 and 21
71		  - Example: LDO0, LD01, LDO2, LDO21
72	- BUCKn
73		  - valid values for n are 1 to 7.
74		  - Example: BUCK1, BUCK2, BUCK3, BUCK7
75
76	- ENVICHG: Battery Charging Current Monitor Output. This is a fixed
77		   voltage type regulator
78
79	- ESAFEOUT1: (ldo19)
80	- ESAFEOUT2: (ld020)
81
82	- CHARGER_CV: main battery charger voltage control
83	- CHARGER: main battery charger current control
84	- CHARGER_TOPOFF: end of charge current threshold level
85
86The bindings inside the regulator nodes use the standard regulator bindings
87which are documented elsewhere.
88
89Example:
90
91	max8997_pmic@66 {
92		compatible = "maxim,max8997-pmic";
93		interrupt-parent = <&wakeup_eint>;
94		reg = <0x66>;
95		interrupts = <4 0>, <3 0>;
96
97		max8997,pmic-buck1-uses-gpio-dvs;
98		max8997,pmic-buck2-uses-gpio-dvs;
99		max8997,pmic-buck5-uses-gpio-dvs;
100
101		max8997,pmic-ignore-gpiodvs-side-effect;
102		max8997,pmic-buck125-default-dvs-idx = <0>;
103
104		max8997,pmic-buck125-dvs-gpios = <&gpx0 0 1 0 0>, /* SET1 */
105						 <&gpx0 1 1 0 0>, /* SET2 */
106						 <&gpx0 2 1 0 0>; /* SET3 */
107
108		max8997,pmic-buck1-dvs-voltage = <1350000>, <1300000>,
109						 <1250000>, <1200000>,
110						 <1150000>, <1100000>,
111						 <1000000>, <950000>;
112
113		max8997,pmic-buck2-dvs-voltage = <1100000>, <1100000>,
114						 <1100000>, <1100000>,
115						 <1000000>, <1000000>,
116						 <1000000>, <1000000>;
117
118		max8997,pmic-buck5-dvs-voltage = <1200000>, <1200000>,
119						 <1200000>, <1200000>,
120						 <1200000>, <1200000>,
121						 <1200000>, <1200000>;
122
123		regulators {
124			ldo1_reg: LDO1 {
125				regulator-name = "VDD_ABB_3.3V";
126				regulator-min-microvolt = <3300000>;
127				regulator-max-microvolt = <3300000>;
128			};
129
130			ldo2_reg: LDO2 {
131				regulator-name = "VDD_ALIVE_1.1V";
132				regulator-min-microvolt = <1100000>;
133				regulator-max-microvolt = <1100000>;
134				regulator-always-on;
135			};
136
137			buck1_reg: BUCK1 {
138				regulator-name = "VDD_ARM_1.2V";
139				regulator-min-microvolt = <950000>;
140				regulator-max-microvolt = <1350000>;
141				regulator-always-on;
142				regulator-boot-on;
143			};
144		};
145	};
146