Commit | Line | Data |
---|---|---|
e941d0ce LG |
1 | What: /sys/class/regulator/.../state |
2 | Date: April 2008 | |
3 | KernelVersion: 2.6.26 | |
8a62ab4c | 4 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 5 | Description: |
7ad68e2f | 6 | Some regulator directories will contain a field called |
853116a1 DB |
7 | state. This reports the regulator enable control, for |
8 | regulators which can report that input value. | |
e941d0ce LG |
9 | |
10 | This will be one of the following strings: | |
11 | ||
12 | 'enabled' | |
13 | 'disabled' | |
14 | 'unknown' | |
15 | ||
16 | 'enabled' means the regulator output is ON and is supplying | |
853116a1 | 17 | power to the system (assuming no error prevents it). |
e941d0ce LG |
18 | |
19 | 'disabled' means the regulator output is OFF and is not | |
853116a1 DB |
20 | supplying power to the system (unless some non-Linux |
21 | control has enabled it). | |
e941d0ce | 22 | |
7ad68e2f DB |
23 | 'unknown' means software cannot determine the state, or |
24 | the reported state is invalid. | |
e941d0ce LG |
25 | |
26 | NOTE: this field can be used in conjunction with microvolts | |
853116a1 DB |
27 | or microamps to determine configured regulator output levels. |
28 | ||
29 | ||
30 | What: /sys/class/regulator/.../status | |
31 | Description: | |
32 | Some regulator directories will contain a field called | |
33 | "status". This reports the current regulator status, for | |
34 | regulators which can report that output value. | |
35 | ||
36 | This will be one of the following strings: | |
37 | ||
38 | off | |
39 | on | |
40 | error | |
41 | fast | |
42 | normal | |
43 | idle | |
44 | standby | |
45 | ||
46 | "off" means the regulator is not supplying power to the | |
47 | system. | |
48 | ||
49 | "on" means the regulator is supplying power to the system, | |
50 | and the regulator can't report a detailed operation mode. | |
51 | ||
52 | "error" indicates an out-of-regulation status such as being | |
53 | disabled due to thermal shutdown, or voltage being unstable | |
54 | because of problems with the input power supply. | |
55 | ||
56 | "fast", "normal", "idle", and "standby" are all detailed | |
57 | regulator operation modes (described elsewhere). They | |
58 | imply "on", but provide more detail. | |
59 | ||
60 | Note that regulator status is a function of many inputs, | |
61 | not limited to control inputs from Linux. For example, | |
62 | the actual load presented may trigger "error" status; or | |
63 | a regulator may be enabled by another user, even though | |
64 | Linux did not enable it. | |
e941d0ce LG |
65 | |
66 | ||
67 | What: /sys/class/regulator/.../type | |
68 | Date: April 2008 | |
69 | KernelVersion: 2.6.26 | |
8a62ab4c | 70 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce LG |
71 | Description: |
72 | Each regulator directory will contain a field called | |
73 | type. This holds the regulator type. | |
74 | ||
75 | This will be one of the following strings: | |
76 | ||
77 | 'voltage' | |
78 | 'current' | |
79 | 'unknown' | |
80 | ||
81 | 'voltage' means the regulator output voltage can be controlled | |
82 | by software. | |
83 | ||
84 | 'current' means the regulator output current limit can be | |
85 | controlled by software. | |
86 | ||
87 | 'unknown' means software cannot control either voltage or | |
88 | current limit. | |
89 | ||
90 | ||
91 | What: /sys/class/regulator/.../microvolts | |
92 | Date: April 2008 | |
93 | KernelVersion: 2.6.26 | |
8a62ab4c | 94 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 95 | Description: |
7ad68e2f | 96 | Some regulator directories will contain a field called |
e941d0ce | 97 | microvolts. This holds the regulator output voltage setting |
7ad68e2f | 98 | measured in microvolts (i.e. E-6 Volts), for regulators |
853116a1 | 99 | which can report the control input for voltage. |
e941d0ce LG |
100 | |
101 | NOTE: This value should not be used to determine the regulator | |
102 | output voltage level as this value is the same regardless of | |
103 | whether the regulator is enabled or disabled. | |
104 | ||
105 | ||
106 | What: /sys/class/regulator/.../microamps | |
107 | Date: April 2008 | |
108 | KernelVersion: 2.6.26 | |
8a62ab4c | 109 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 110 | Description: |
7ad68e2f | 111 | Some regulator directories will contain a field called |
e941d0ce | 112 | microamps. This holds the regulator output current limit |
7ad68e2f | 113 | setting measured in microamps (i.e. E-6 Amps), for regulators |
853116a1 | 114 | which can report the control input for a current limit. |
e941d0ce LG |
115 | |
116 | NOTE: This value should not be used to determine the regulator | |
117 | output current level as this value is the same regardless of | |
118 | whether the regulator is enabled or disabled. | |
119 | ||
120 | ||
121 | What: /sys/class/regulator/.../opmode | |
122 | Date: April 2008 | |
123 | KernelVersion: 2.6.26 | |
8a62ab4c | 124 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 125 | Description: |
7ad68e2f DB |
126 | Some regulator directories will contain a field called |
127 | opmode. This holds the current regulator operating mode, | |
853116a1 | 128 | for regulators which can report that control input value. |
e941d0ce LG |
129 | |
130 | The opmode value can be one of the following strings: | |
131 | ||
132 | 'fast' | |
133 | 'normal' | |
134 | 'idle' | |
135 | 'standby' | |
136 | 'unknown' | |
137 | ||
7ad68e2f | 138 | The modes are described in include/linux/regulator/consumer.h |
e941d0ce LG |
139 | |
140 | NOTE: This value should not be used to determine the regulator | |
141 | output operating mode as this value is the same regardless of | |
853116a1 DB |
142 | whether the regulator is enabled or disabled. A "status" |
143 | attribute may be available to determine the actual mode. | |
e941d0ce LG |
144 | |
145 | ||
146 | What: /sys/class/regulator/.../min_microvolts | |
147 | Date: April 2008 | |
148 | KernelVersion: 2.6.26 | |
8a62ab4c | 149 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 150 | Description: |
7ad68e2f | 151 | Some regulator directories will contain a field called |
e941d0ce | 152 | min_microvolts. This holds the minimum safe working regulator |
7ad68e2f DB |
153 | output voltage setting for this domain measured in microvolts, |
154 | for regulators which support voltage constraints. | |
e941d0ce LG |
155 | |
156 | NOTE: this will return the string 'constraint not defined' if | |
157 | the power domain has no min microvolts constraint defined by | |
158 | platform code. | |
159 | ||
160 | ||
161 | What: /sys/class/regulator/.../max_microvolts | |
162 | Date: April 2008 | |
163 | KernelVersion: 2.6.26 | |
8a62ab4c | 164 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 165 | Description: |
7ad68e2f | 166 | Some regulator directories will contain a field called |
e941d0ce | 167 | max_microvolts. This holds the maximum safe working regulator |
7ad68e2f DB |
168 | output voltage setting for this domain measured in microvolts, |
169 | for regulators which support voltage constraints. | |
e941d0ce LG |
170 | |
171 | NOTE: this will return the string 'constraint not defined' if | |
172 | the power domain has no max microvolts constraint defined by | |
173 | platform code. | |
174 | ||
175 | ||
176 | What: /sys/class/regulator/.../min_microamps | |
177 | Date: April 2008 | |
178 | KernelVersion: 2.6.26 | |
8a62ab4c | 179 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 180 | Description: |
7ad68e2f | 181 | Some regulator directories will contain a field called |
e941d0ce LG |
182 | min_microamps. This holds the minimum safe working regulator |
183 | output current limit setting for this domain measured in | |
7ad68e2f | 184 | microamps, for regulators which support current constraints. |
e941d0ce LG |
185 | |
186 | NOTE: this will return the string 'constraint not defined' if | |
187 | the power domain has no min microamps constraint defined by | |
188 | platform code. | |
189 | ||
190 | ||
191 | What: /sys/class/regulator/.../max_microamps | |
192 | Date: April 2008 | |
193 | KernelVersion: 2.6.26 | |
8a62ab4c | 194 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 195 | Description: |
7ad68e2f | 196 | Some regulator directories will contain a field called |
e941d0ce LG |
197 | max_microamps. This holds the maximum safe working regulator |
198 | output current limit setting for this domain measured in | |
7ad68e2f | 199 | microamps, for regulators which support current constraints. |
e941d0ce LG |
200 | |
201 | NOTE: this will return the string 'constraint not defined' if | |
202 | the power domain has no max microamps constraint defined by | |
203 | platform code. | |
204 | ||
205 | ||
bc558a60 MB |
206 | What: /sys/class/regulator/.../name |
207 | Date: October 2008 | |
208 | KernelVersion: 2.6.28 | |
209 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> | |
210 | Description: | |
211 | Each regulator directory will contain a field called | |
212 | name. This holds a string identifying the regulator for | |
213 | display purposes. | |
214 | ||
215 | NOTE: this will be empty if no suitable name is provided | |
216 | by platform or regulator drivers. | |
217 | ||
218 | ||
e941d0ce LG |
219 | What: /sys/class/regulator/.../num_users |
220 | Date: April 2008 | |
221 | KernelVersion: 2.6.26 | |
8a62ab4c | 222 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce LG |
223 | Description: |
224 | Each regulator directory will contain a field called | |
225 | num_users. This holds the number of consumer devices that | |
226 | have called regulator_enable() on this regulator. | |
227 | ||
228 | ||
229 | What: /sys/class/regulator/.../requested_microamps | |
230 | Date: April 2008 | |
231 | KernelVersion: 2.6.26 | |
8a62ab4c | 232 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 233 | Description: |
7ad68e2f | 234 | Some regulator directories will contain a field called |
e941d0ce LG |
235 | requested_microamps. This holds the total requested load |
236 | current in microamps for this regulator from all its consumer | |
237 | devices. | |
238 | ||
239 | ||
240 | What: /sys/class/regulator/.../parent | |
241 | Date: April 2008 | |
242 | KernelVersion: 2.6.26 | |
8a62ab4c | 243 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce LG |
244 | Description: |
245 | Some regulator directories will contain a link called parent. | |
246 | This points to the parent or supply regulator if one exists. | |
247 | ||
248 | What: /sys/class/regulator/.../suspend_mem_microvolts | |
249 | Date: May 2008 | |
250 | KernelVersion: 2.6.26 | |
8a62ab4c | 251 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 252 | Description: |
7ad68e2f | 253 | Some regulator directories will contain a field called |
e941d0ce LG |
254 | suspend_mem_microvolts. This holds the regulator output |
255 | voltage setting for this domain measured in microvolts when | |
7ad68e2f DB |
256 | the system is suspended to memory, for voltage regulators |
257 | implementing suspend voltage configuration constraints. | |
e941d0ce LG |
258 | |
259 | What: /sys/class/regulator/.../suspend_disk_microvolts | |
260 | Date: May 2008 | |
261 | KernelVersion: 2.6.26 | |
8a62ab4c | 262 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 263 | Description: |
7ad68e2f | 264 | Some regulator directories will contain a field called |
e941d0ce LG |
265 | suspend_disk_microvolts. This holds the regulator output |
266 | voltage setting for this domain measured in microvolts when | |
7ad68e2f DB |
267 | the system is suspended to disk, for voltage regulators |
268 | implementing suspend voltage configuration constraints. | |
e941d0ce LG |
269 | |
270 | What: /sys/class/regulator/.../suspend_standby_microvolts | |
271 | Date: May 2008 | |
272 | KernelVersion: 2.6.26 | |
8a62ab4c | 273 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 274 | Description: |
7ad68e2f | 275 | Some regulator directories will contain a field called |
e941d0ce LG |
276 | suspend_standby_microvolts. This holds the regulator output |
277 | voltage setting for this domain measured in microvolts when | |
7ad68e2f DB |
278 | the system is suspended to standby, for voltage regulators |
279 | implementing suspend voltage configuration constraints. | |
e941d0ce LG |
280 | |
281 | What: /sys/class/regulator/.../suspend_mem_mode | |
282 | Date: May 2008 | |
283 | KernelVersion: 2.6.26 | |
8a62ab4c | 284 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 285 | Description: |
7ad68e2f | 286 | Some regulator directories will contain a field called |
e941d0ce LG |
287 | suspend_mem_mode. This holds the regulator operating mode |
288 | setting for this domain when the system is suspended to | |
7ad68e2f DB |
289 | memory, for regulators implementing suspend mode |
290 | configuration constraints. | |
e941d0ce LG |
291 | |
292 | What: /sys/class/regulator/.../suspend_disk_mode | |
293 | Date: May 2008 | |
294 | KernelVersion: 2.6.26 | |
8a62ab4c | 295 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 296 | Description: |
7ad68e2f | 297 | Some regulator directories will contain a field called |
e941d0ce | 298 | suspend_disk_mode. This holds the regulator operating mode |
7ad68e2f DB |
299 | setting for this domain when the system is suspended to disk, |
300 | for regulators implementing suspend mode configuration | |
301 | constraints. | |
e941d0ce LG |
302 | |
303 | What: /sys/class/regulator/.../suspend_standby_mode | |
304 | Date: May 2008 | |
305 | KernelVersion: 2.6.26 | |
8a62ab4c | 306 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 307 | Description: |
7ad68e2f | 308 | Some regulator directories will contain a field called |
e941d0ce LG |
309 | suspend_standby_mode. This holds the regulator operating mode |
310 | setting for this domain when the system is suspended to | |
7ad68e2f DB |
311 | standby, for regulators implementing suspend mode |
312 | configuration constraints. | |
e941d0ce LG |
313 | |
314 | What: /sys/class/regulator/.../suspend_mem_state | |
315 | Date: May 2008 | |
316 | KernelVersion: 2.6.26 | |
8a62ab4c | 317 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 318 | Description: |
7ad68e2f | 319 | Some regulator directories will contain a field called |
e941d0ce | 320 | suspend_mem_state. This holds the regulator operating state |
7ad68e2f DB |
321 | when suspended to memory, for regulators implementing suspend |
322 | configuration constraints. | |
e941d0ce | 323 | |
7ad68e2f DB |
324 | This will be one of the same strings reported by |
325 | the "state" attribute. | |
e941d0ce LG |
326 | |
327 | What: /sys/class/regulator/.../suspend_disk_state | |
328 | Date: May 2008 | |
329 | KernelVersion: 2.6.26 | |
8a62ab4c | 330 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 331 | Description: |
7ad68e2f | 332 | Some regulator directories will contain a field called |
e941d0ce | 333 | suspend_disk_state. This holds the regulator operating state |
7ad68e2f DB |
334 | when suspended to disk, for regulators implementing |
335 | suspend configuration constraints. | |
e941d0ce | 336 | |
7ad68e2f DB |
337 | This will be one of the same strings reported by |
338 | the "state" attribute. | |
e941d0ce LG |
339 | |
340 | What: /sys/class/regulator/.../suspend_standby_state | |
341 | Date: May 2008 | |
342 | KernelVersion: 2.6.26 | |
8a62ab4c | 343 | Contact: Liam Girdwood <lrg@slimlogic.co.uk> |
e941d0ce | 344 | Description: |
7ad68e2f | 345 | Some regulator directories will contain a field called |
e941d0ce | 346 | suspend_standby_state. This holds the regulator operating |
7ad68e2f DB |
347 | state when suspended to standby, for regulators implementing |
348 | suspend configuration constraints. | |
e941d0ce | 349 | |
7ad68e2f DB |
350 | This will be one of the same strings reported by |
351 | the "state" attribute. | |
f59c8f9f MB |
352 | |
353 | What: /sys/class/regulator/.../bypass | |
354 | Date: September 2012 | |
355 | KernelVersion: 3.7 | |
356 | Contact: Mark Brown <broonie@opensource.wolfsonmicro.com> | |
357 | Description: | |
358 | Some regulator directories will contain a field called | |
359 | bypass. This indicates if the device is in bypass mode. | |
360 | ||
361 | This will be one of the following strings: | |
362 | ||
363 | 'enabled' | |
364 | 'disabled' | |
365 | 'unknown' | |
366 | ||
367 | 'enabled' means the regulator is in bypass mode. | |
368 | ||
369 | 'disabled' means that the regulator is regulating. | |
370 | ||
371 | 'unknown' means software cannot determine the state, or | |
372 | the reported state is invalid. |