Merge tag 'xtensa-20161005' of git://github.com/jcmvbkbc/linux-xtensa
[cascardo/linux.git] / Documentation / devicetree / bindings / mfd / axp20x.txt
1 AXP family PMIC device tree bindings
2
3 The axp20x family current members :
4 axp152 (X-Powers)
5 axp202 (X-Powers)
6 axp209 (X-Powers)
7 axp221 (X-Powers)
8 axp223 (X-Powers)
9 axp809 (X-Powers)
10
11 Required properties:
12 - compatible: "x-powers,axp152", "x-powers,axp202", "x-powers,axp209",
13               "x-powers,axp221", "x-powers,axp223", "x-powers,axp809"
14 - reg: The I2C slave address or RSB hardware address for the AXP chip
15 - interrupt-parent: The parent interrupt controller
16 - interrupts: SoC NMI / GPIO interrupt connected to the PMIC's IRQ pin
17 - interrupt-controller: The PMIC has its own internal IRQs
18 - #interrupt-cells: Should be set to 1
19
20 Optional properties:
21 - x-powers,dcdc-freq: defines the work frequency of DC-DC in KHz
22                       AXP152/20X: range:  750-1875, Default: 1.5 MHz
23                       AXP22X/80X: range: 1800-4050, Default: 3   MHz
24
25 - x-powers,drive-vbus-en: axp221 / axp223 only boolean, set this when the
26                   N_VBUSEN pin is used as an output pin to control an external
27                   regulator to drive the OTG VBus, rather then as an input pin
28                   which signals whether the board is driving OTG VBus or not.
29
30 - <input>-supply: a phandle to the regulator supply node. May be omitted if
31                   inputs are unregulated, such as using the IPSOUT output
32                   from the PMIC.
33
34 - regulators: A node that houses a sub-node for each regulator. Regulators
35               not used but preferred to be managed by the OS should be
36               listed as well.
37               See Documentation/devicetree/bindings/regulator/regulator.txt
38               for more information on standard regulator bindings.
39
40 Optional properties for DCDC regulators:
41 - x-powers,dcdc-workmode: 1 for PWM mode, 0 for AUTO (PWM/PFM) mode
42                           Default: Current hardware setting
43                           The DCDC regulators work in a mixed PWM/PFM mode,
44                           using PFM under light loads and switching to PWM
45                           for heavier loads. Forcing PWM mode trades efficiency
46                           under light loads for lower output noise. This
47                           probably makes sense for HiFi audio related
48                           applications that aren't battery constrained.
49
50
51 AXP202/AXP209 regulators, type, and corresponding input supply names:
52
53 Regulator         Type            Supply Name             Notes
54 ---------         ----            -----------             -----
55 DCDC2           : DC-DC buck    : vin2-supply
56 DCDC3           : DC-DC buck    : vin3-supply
57 LDO1            : LDO           : acin-supply           : always on
58 LDO2            : LDO           : ldo24in-supply        : shared supply
59 LDO3            : LDO           : ldo3in-supply
60 LDO4            : LDO           : ldo24in-supply        : shared supply
61 LDO5            : LDO           : ldo5in-supply
62
63 AXP221/AXP223 regulators, type, and corresponding input supply names:
64
65 Regulator         Type            Supply Name             Notes
66 ---------         ----            -----------             -----
67 DCDC1           : DC-DC buck    : vin1-supply
68 DCDC2           : DC-DC buck    : vin2-supply
69 DCDC3           : DC-DC buck    : vin3-supply
70 DCDC4           : DC-DC buck    : vin4-supply
71 DCDC5           : DC-DC buck    : vin5-supply
72 DC1SW           : On/Off Switch :                       : DCDC1 secondary output
73 DC5LDO          : LDO           :                       : input from DCDC5
74 ALDO1           : LDO           : aldoin-supply         : shared supply
75 ALDO2           : LDO           : aldoin-supply         : shared supply
76 ALDO3           : LDO           : aldoin-supply         : shared supply
77 DLDO1           : LDO           : dldoin-supply         : shared supply
78 DLDO2           : LDO           : dldoin-supply         : shared supply
79 DLDO3           : LDO           : dldoin-supply         : shared supply
80 DLDO4           : LDO           : dldoin-supply         : shared supply
81 ELDO1           : LDO           : eldoin-supply         : shared supply
82 ELDO2           : LDO           : eldoin-supply         : shared supply
83 ELDO3           : LDO           : eldoin-supply         : shared supply
84 LDO_IO0         : LDO           : ips-supply            : GPIO 0
85 LDO_IO1         : LDO           : ips-supply            : GPIO 1
86 RTC_LDO         : LDO           : ips-supply            : always on
87 DRIVEVBUS       : Enable output : drivevbus-supply      : external regulator
88
89 AXP809 regulators, type, and corresponding input supply names:
90
91 Regulator         Type            Supply Name             Notes
92 ---------         ----            -----------             -----
93 DCDC1           : DC-DC buck    : vin1-supply
94 DCDC2           : DC-DC buck    : vin2-supply
95 DCDC3           : DC-DC buck    : vin3-supply
96 DCDC4           : DC-DC buck    : vin4-supply
97 DCDC5           : DC-DC buck    : vin5-supply
98 DC1SW           : On/Off Switch :                       : DCDC1 secondary output
99 DC5LDO          : LDO           :                       : input from DCDC5
100 ALDO1           : LDO           : aldoin-supply         : shared supply
101 ALDO2           : LDO           : aldoin-supply         : shared supply
102 ALDO3           : LDO           : aldoin-supply         : shared supply
103 DLDO1           : LDO           : dldoin-supply         : shared supply
104 DLDO2           : LDO           : dldoin-supply         : shared supply
105 ELDO1           : LDO           : eldoin-supply         : shared supply
106 ELDO2           : LDO           : eldoin-supply         : shared supply
107 ELDO3           : LDO           : eldoin-supply         : shared supply
108 LDO_IO0         : LDO           : ips-supply            : GPIO 0
109 LDO_IO1         : LDO           : ips-supply            : GPIO 1
110 RTC_LDO         : LDO           : ips-supply            : always on
111 SW              : On/Off Switch : swin-supply
112
113 Example:
114
115 axp209: pmic@34 {
116         compatible = "x-powers,axp209";
117         reg = <0x34>;
118         interrupt-parent = <&nmi_intc>;
119         interrupts = <0 IRQ_TYPE_LEVEL_LOW>;
120         interrupt-controller;
121         #interrupt-cells = <1>;
122
123         regulators {
124                 x-powers,dcdc-freq = <1500>;
125
126                 vdd_cpu: dcdc2 {
127                         regulator-always-on;
128                         regulator-min-microvolt = <1000000>;
129                         regulator-max-microvolt = <1450000>;
130                         regulator-name = "vdd-cpu";
131                 };
132
133                 vdd_int_dll: dcdc3 {
134                         regulator-always-on;
135                         regulator-min-microvolt = <1000000>;
136                         regulator-max-microvolt = <1400000>;
137                         regulator-name = "vdd-int-dll";
138                 };
139
140                 vdd_rtc: ldo1 {
141                         regulator-always-on;
142                         regulator-min-microvolt = <1200000>;
143                         regulator-max-microvolt = <1400000>;
144                         regulator-name = "vdd-rtc";
145                 };
146
147                 avcc: ldo2 {
148                         regulator-always-on;
149                         regulator-min-microvolt = <2700000>;
150                         regulator-max-microvolt = <3300000>;
151                         regulator-name = "avcc";
152                 };
153
154                 ldo3 {
155                         /* unused but preferred to be managed by OS */
156                 };
157         };
158 };