Merge tag 'ntb-5.11' of git://github.com/jonmason/ntb
[linux-2.6-microblaze.git] / Documentation / devicetree / bindings / regulator / pfuze100.yaml
1 # SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/regulator/pfuze100.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: PFUZE100 family of regulators
8
9 maintainers:
10   - Robin Gong <yibin.gong@nxp.com>
11
12 description: |
13   The valid names for regulators are:
14   --PFUZE100
15   sw1ab,sw1c,sw2,sw3a,sw3b,sw4,swbst,vsnvs,vrefddr,vgen1~vgen6
16   --PFUZE200
17   sw1ab,sw2,sw3a,sw3b,swbst,vsnvs,vrefddr,vgen1~vgen6,coin
18   --PFUZE3000
19   sw1a,sw1b,sw2,sw3,swbst,vsnvs,vrefddr,vldo1,vldo2,vccsd,v33,vldo3,vldo4
20   --PFUZE3001
21   sw1,sw2,sw3,vsnvs,vldo1,vldo2,vccsd,v33,vldo3,vldo4
22
23   Each regulator is defined using the standard binding for regulators.
24
25 properties:
26   $nodename:
27     pattern: "^pmic@[0-9]$"
28
29   compatible:
30     enum:
31       - fsl,pfuze100
32       - fsl,pfuze200
33       - fsl,pfuze3000
34       - fsl,pfuze3001
35
36   reg:
37     maxItems: 1
38
39   fsl,pfuze-support-disable-sw:
40     $ref: /schemas/types.yaml#/definitions/flag
41     description: |
42       Boolean, if present disable all unused switch regulators to save power
43       consumption. Attention, ensure that all important regulators
44       (e.g. DDR ref, DDR supply) has set the "regulator-always-on" property.
45       If not present, the switched regulators are always on and can't be
46       disabled. This binding is a workaround to keep backward compatibility
47       with old dtb's which rely on the fact that the switched regulators are
48       always on and don't mark them explicit as "regulator-always-on".
49
50   fsl,pmic-stby-poweroff:
51     $ref: /schemas/types.yaml#/definitions/flag
52     description: |
53       if present, configure the PMIC to shutdown all
54       power rails when PMIC_STBY_REQ line is asserted during the power off sequence.
55       Use this option if the SoC should be powered off by external power management
56       IC (PMIC) on PMIC_STBY_REQ signal.
57       As opposite to PMIC_STBY_REQ boards can implement PMIC_ON_REQ signal.
58
59   regulators:
60     type: object
61     description: |
62       list of regulators provided by this controller.
63
64     patternProperties:
65       "^sw([1-4]|[1-4][a-c]|[1-4][a-c][a-c])$":
66         $ref: "regulator.yaml#"
67         type: object
68
69       "^vgen[1-6]$":
70         $ref: "regulator.yaml#"
71         type: object
72
73       "^(vsnvs|vref|vrefddr|swbst|coin)$":
74         $ref: "regulator.yaml#"
75         type: object
76
77     additionalProperties: false
78
79 required:
80   - compatible
81   - reg
82
83 additionalProperties: false
84
85 examples:
86   - |
87     i2c {
88         #address-cells = <1>;
89         #size-cells = <0>;
90
91         pmic@8 {
92             compatible = "fsl,pfuze100";
93             reg = <0x08>;
94
95             regulators {
96                 sw1a_reg: sw1ab {
97                     regulator-min-microvolt = <300000>;
98                     regulator-max-microvolt = <1875000>;
99                     regulator-boot-on;
100                     regulator-always-on;
101                     regulator-ramp-delay = <6250>;
102                 };
103
104                 sw1c_reg: sw1c {
105                     regulator-min-microvolt = <300000>;
106                     regulator-max-microvolt = <1875000>;
107                     regulator-boot-on;
108                     regulator-always-on;
109                 };
110
111                 sw2_reg: sw2 {
112                     regulator-min-microvolt = <800000>;
113                     regulator-max-microvolt = <3300000>;
114                     regulator-boot-on;
115                     regulator-always-on;
116                 };
117
118                 sw3a_reg: sw3a {
119                     regulator-min-microvolt = <400000>;
120                     regulator-max-microvolt = <1975000>;
121                     regulator-boot-on;
122                     regulator-always-on;
123                 };
124
125                 sw3b_reg: sw3b {
126                     regulator-min-microvolt = <400000>;
127                     regulator-max-microvolt = <1975000>;
128                     regulator-boot-on;
129                     regulator-always-on;
130                 };
131
132                 sw4_reg: sw4 {
133                     regulator-min-microvolt = <800000>;
134                     regulator-max-microvolt = <3300000>;
135                 };
136
137                 swbst_reg: swbst {
138                     regulator-min-microvolt = <5000000>;
139                     regulator-max-microvolt = <5150000>;
140                 };
141
142                 snvs_reg: vsnvs {
143                     regulator-min-microvolt = <1000000>;
144                     regulator-max-microvolt = <3000000>;
145                     regulator-boot-on;
146                     regulator-always-on;
147                 };
148
149                 vref_reg: vrefddr {
150                     regulator-boot-on;
151                     regulator-always-on;
152                 };
153
154                 vgen1_reg: vgen1 {
155                     regulator-min-microvolt = <800000>;
156                     regulator-max-microvolt = <1550000>;
157                 };
158
159                 vgen2_reg: vgen2 {
160                     regulator-min-microvolt = <800000>;
161                     regulator-max-microvolt = <1550000>;
162                 };
163
164                 vgen3_reg: vgen3 {
165                     regulator-min-microvolt = <1800000>;
166                     regulator-max-microvolt = <3300000>;
167                 };
168
169                 vgen4_reg: vgen4 {
170                     regulator-min-microvolt = <1800000>;
171                     regulator-max-microvolt = <3300000>;
172                     regulator-always-on;
173                 };
174
175                 vgen5_reg: vgen5 {
176                     regulator-min-microvolt = <1800000>;
177                     regulator-max-microvolt = <3300000>;
178                     regulator-always-on;
179                 };
180
181                 vgen6_reg: vgen6 {
182                     regulator-min-microvolt = <1800000>;
183                     regulator-max-microvolt = <3300000>;
184                     regulator-always-on;
185                 };
186             };
187         };
188     };