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