~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/Documentation/ABI/testing/sysfs-class-regulator

Version: ~ [ linux-6.12-rc7 ] ~ [ linux-6.11.7 ] ~ [ linux-6.10.14 ] ~ [ linux-6.9.12 ] ~ [ linux-6.8.12 ] ~ [ linux-6.7.12 ] ~ [ linux-6.6.60 ] ~ [ linux-6.5.13 ] ~ [ linux-6.4.16 ] ~ [ linux-6.3.13 ] ~ [ linux-6.2.16 ] ~ [ linux-6.1.116 ] ~ [ linux-6.0.19 ] ~ [ linux-5.19.17 ] ~ [ linux-5.18.19 ] ~ [ linux-5.17.15 ] ~ [ linux-5.16.20 ] ~ [ linux-5.15.171 ] ~ [ linux-5.14.21 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.229 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.285 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.323 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.336 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.337 ] ~ [ linux-4.4.302 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.12 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 What:           /sys/class/regulator/.../state
  2 Date:           April 2008
  3 KernelVersion:  2.6.26
  4 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
  5 Description:
  6                 Some regulator directories will contain a field called
  7                 state. This reports the regulator enable control, for
  8                 regulators which can report that input value.
  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
 17                 power to the system (assuming no error prevents it).
 18 
 19                 'disabled' means the regulator output is OFF and is not
 20                 supplying power to the system (unless some non-Linux
 21                 control has enabled it).
 22 
 23                 'unknown' means software cannot determine the state, or
 24                 the reported state is invalid.
 25 
 26                 NOTE: this field can be used in conjunction with microvolts
 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.
 65 
 66 
 67 What:           /sys/class/regulator/.../type
 68 Date:           April 2008
 69 KernelVersion:  2.6.26
 70 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 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
 94 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 95 Description:
 96                 Some regulator directories will contain a field called
 97                 microvolts. This holds the regulator output voltage setting
 98                 measured in microvolts (i.e. E-6 Volts), for regulators
 99                 which can report the control input for voltage.
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
109 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
110 Description:
111                 Some regulator directories will contain a field called
112                 microamps. This holds the regulator output current limit
113                 setting measured in microamps (i.e. E-6 Amps), for regulators
114                 which can report the control input for a current limit.
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
124 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
125 Description:
126                 Some regulator directories will contain a field called
127                 opmode. This holds the current regulator operating mode,
128                 for regulators which can report that control input value.
129 
130                 The opmode value can be one of the following strings:
131 
132                 - 'fast'
133                 - 'normal'
134                 - 'idle'
135                 - 'standby'
136                 - 'unknown'
137 
138                 The modes are described in include/linux/regulator/consumer.h
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
142                 whether the regulator is enabled or disabled.  A "status"
143                 attribute may be available to determine the actual mode.
144 
145 
146 What:           /sys/class/regulator/.../min_microvolts
147 Date:           April 2008
148 KernelVersion:  2.6.26
149 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
150 Description:
151                 Some regulator directories will contain a field called
152                 min_microvolts. This holds the minimum safe working regulator
153                 output voltage setting for this domain measured in microvolts,
154                 for regulators which support voltage constraints.
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
164 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
165 Description:
166                 Some regulator directories will contain a field called
167                 max_microvolts. This holds the maximum safe working regulator
168                 output voltage setting for this domain measured in microvolts,
169                 for regulators which support voltage constraints.
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
179 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
180 Description:
181                 Some regulator directories will contain a field called
182                 min_microamps. This holds the minimum safe working regulator
183                 output current limit setting for this domain measured in
184                 microamps, for regulators which support current constraints.
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
194 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
195 Description:
196                 Some regulator directories will contain a field called
197                 max_microamps. This holds the maximum safe working regulator
198                 output current limit setting for this domain measured in
199                 microamps, for regulators which support current constraints.
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 
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 
219 What:           /sys/class/regulator/.../num_users
220 Date:           April 2008
221 KernelVersion:  2.6.26
222 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
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
232 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
233 Description:
234                 Some regulator directories will contain a field called
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
243 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
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
251 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
252 Description:
253                 Some regulator directories will contain a field called
254                 suspend_mem_microvolts. This holds the regulator output
255                 voltage setting for this domain measured in microvolts when
256                 the system is suspended to memory, for voltage regulators
257                 implementing suspend voltage configuration constraints.
258 
259 What:           /sys/class/regulator/.../suspend_disk_microvolts
260 Date:           May 2008
261 KernelVersion:  2.6.26
262 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
263 Description:
264                 Some regulator directories will contain a field called
265                 suspend_disk_microvolts. This holds the regulator output
266                 voltage setting for this domain measured in microvolts when
267                 the system is suspended to disk, for voltage regulators
268                 implementing suspend voltage configuration constraints.
269 
270 What:           /sys/class/regulator/.../suspend_standby_microvolts
271 Date:           May 2008
272 KernelVersion:  2.6.26
273 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
274 Description:
275                 Some regulator directories will contain a field called
276                 suspend_standby_microvolts. This holds the regulator output
277                 voltage setting for this domain measured in microvolts when
278                 the system is suspended to standby, for voltage regulators
279                 implementing suspend voltage configuration constraints.
280 
281 What:           /sys/class/regulator/.../suspend_mem_mode
282 Date:           May 2008
283 KernelVersion:  2.6.26
284 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
285 Description:
286                 Some regulator directories will contain a field called
287                 suspend_mem_mode. This holds the regulator operating mode
288                 setting for this domain when the system is suspended to
289                 memory, for regulators implementing suspend mode
290                 configuration constraints.
291 
292 What:           /sys/class/regulator/.../suspend_disk_mode
293 Date:           May 2008
294 KernelVersion:  2.6.26
295 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
296 Description:
297                 Some regulator directories will contain a field called
298                 suspend_disk_mode. This holds the regulator operating mode
299                 setting for this domain when the system is suspended to disk,
300                 for regulators implementing suspend mode configuration
301                 constraints.
302 
303 What:           /sys/class/regulator/.../suspend_standby_mode
304 Date:           May 2008
305 KernelVersion:  2.6.26
306 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
307 Description:
308                 Some regulator directories will contain a field called
309                 suspend_standby_mode. This holds the regulator operating mode
310                 setting for this domain when the system is suspended to
311                 standby, for regulators implementing suspend mode
312                 configuration constraints.
313 
314 What:           /sys/class/regulator/.../suspend_mem_state
315 Date:           May 2008
316 KernelVersion:  2.6.26
317 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
318 Description:
319                 Some regulator directories will contain a field called
320                 suspend_mem_state. This holds the regulator operating state
321                 when suspended to memory, for regulators implementing suspend
322                 configuration constraints.
323 
324                 This will be one of the same strings reported by
325                 the "state" attribute.
326 
327 What:           /sys/class/regulator/.../suspend_disk_state
328 Date:           May 2008
329 KernelVersion:  2.6.26
330 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
331 Description:
332                 Some regulator directories will contain a field called
333                 suspend_disk_state. This holds the regulator operating state
334                 when suspended to disk, for regulators implementing
335                 suspend configuration constraints.
336 
337                 This will be one of the same strings reported by
338                 the "state" attribute.
339 
340 What:           /sys/class/regulator/.../suspend_standby_state
341 Date:           May 2008
342 KernelVersion:  2.6.26
343 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
344 Description:
345                 Some regulator directories will contain a field called
346                 suspend_standby_state. This holds the regulator operating
347                 state when suspended to standby, for regulators implementing
348                 suspend configuration constraints.
349 
350                 This will be one of the same strings reported by
351                 the "state" attribute.
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.
373 
374 What:           /sys/class/regulator/.../under_voltage
375 Date:           April 2022
376 KernelVersion:  5.18
377 Contact:        Zev Weiss <zev@bewilderbeest.net>
378 Description:
379                 Some regulator directories will contain a field called
380                 under_voltage.  This indicates if the device reports an
381                 under-voltage fault (1) or not (0).
382 
383 What:           /sys/class/regulator/.../over_current
384 Date:           April 2022
385 KernelVersion:  5.18
386 Contact:        Zev Weiss <zev@bewilderbeest.net>
387 Description:
388                 Some regulator directories will contain a field called
389                 over_current.  This indicates if the device reports an
390                 over-current fault (1) or not (0).
391 
392 What:           /sys/class/regulator/.../regulation_out
393 Date:           April 2022
394 KernelVersion:  5.18
395 Contact:        Zev Weiss <zev@bewilderbeest.net>
396 Description:
397                 Some regulator directories will contain a field called
398                 regulation_out.  This indicates if the device reports an
399                 out-of-regulation fault (1) or not (0).
400 
401 What:           /sys/class/regulator/.../fail
402 Date:           April 2022
403 KernelVersion:  5.18
404 Contact:        Zev Weiss <zev@bewilderbeest.net>
405 Description:
406                 Some regulator directories will contain a field called
407                 fail.  This indicates if the device reports an output failure
408                 (1) or not (0).
409 
410 What:           /sys/class/regulator/.../over_temp
411 Date:           April 2022
412 KernelVersion:  5.18
413 Contact:        Zev Weiss <zev@bewilderbeest.net>
414 Description:
415                 Some regulator directories will contain a field called
416                 over_temp.  This indicates if the device reports an
417                 over-temperature fault (1) or not (0).
418 
419 What:           /sys/class/regulator/.../under_voltage_warn
420 Date:           April 2022
421 KernelVersion:  5.18
422 Contact:        Zev Weiss <zev@bewilderbeest.net>
423 Description:
424                 Some regulator directories will contain a field called
425                 under_voltage_warn.  This indicates if the device reports an
426                 under-voltage warning (1) or not (0).
427 
428 What:           /sys/class/regulator/.../over_current_warn
429 Date:           April 2022
430 KernelVersion:  5.18
431 Contact:        Zev Weiss <zev@bewilderbeest.net>
432 Description:
433                 Some regulator directories will contain a field called
434                 over_current_warn.  This indicates if the device reports an
435                 over-current warning (1) or not (0).
436 
437 What:           /sys/class/regulator/.../over_voltage_warn
438 Date:           April 2022
439 KernelVersion:  5.18
440 Contact:        Zev Weiss <zev@bewilderbeest.net>
441 Description:
442                 Some regulator directories will contain a field called
443                 over_voltage_warn.  This indicates if the device reports an
444                 over-voltage warning (1) or not (0).
445 
446 What:           /sys/class/regulator/.../over_temp_warn
447 Date:           April 2022
448 KernelVersion:  5.18
449 Contact:        Zev Weiss <zev@bewilderbeest.net>
450 Description:
451                 Some regulator directories will contain a field called
452                 over_temp_warn.  This indicates if the device reports an
453                 over-temperature warning (1) or not (0).

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

sflogo.php