0001 What: /sys/class/regulator/.../state
0002 Date: April 2008
0003 KernelVersion: 2.6.26
0004 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0005 Description:
0006 Some regulator directories will contain a field called
0007 state. This reports the regulator enable control, for
0008 regulators which can report that input value.
0009
0010 This will be one of the following strings:
0011
0012 'enabled'
0013 'disabled'
0014 'unknown'
0015
0016 'enabled' means the regulator output is ON and is supplying
0017 power to the system (assuming no error prevents it).
0018
0019 'disabled' means the regulator output is OFF and is not
0020 supplying power to the system (unless some non-Linux
0021 control has enabled it).
0022
0023 'unknown' means software cannot determine the state, or
0024 the reported state is invalid.
0025
0026 NOTE: this field can be used in conjunction with microvolts
0027 or microamps to determine configured regulator output levels.
0028
0029
0030 What: /sys/class/regulator/.../status
0031 Description:
0032 Some regulator directories will contain a field called
0033 "status". This reports the current regulator status, for
0034 regulators which can report that output value.
0035
0036 This will be one of the following strings:
0037
0038 - off
0039 - on
0040 - error
0041 - fast
0042 - normal
0043 - idle
0044 - standby
0045
0046 "off" means the regulator is not supplying power to the
0047 system.
0048
0049 "on" means the regulator is supplying power to the system,
0050 and the regulator can't report a detailed operation mode.
0051
0052 "error" indicates an out-of-regulation status such as being
0053 disabled due to thermal shutdown, or voltage being unstable
0054 because of problems with the input power supply.
0055
0056 "fast", "normal", "idle", and "standby" are all detailed
0057 regulator operation modes (described elsewhere). They
0058 imply "on", but provide more detail.
0059
0060 Note that regulator status is a function of many inputs,
0061 not limited to control inputs from Linux. For example,
0062 the actual load presented may trigger "error" status; or
0063 a regulator may be enabled by another user, even though
0064 Linux did not enable it.
0065
0066
0067 What: /sys/class/regulator/.../type
0068 Date: April 2008
0069 KernelVersion: 2.6.26
0070 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0071 Description:
0072 Each regulator directory will contain a field called
0073 type. This holds the regulator type.
0074
0075 This will be one of the following strings:
0076
0077 - 'voltage'
0078 - 'current'
0079 - 'unknown'
0080
0081 'voltage' means the regulator output voltage can be controlled
0082 by software.
0083
0084 'current' means the regulator output current limit can be
0085 controlled by software.
0086
0087 'unknown' means software cannot control either voltage or
0088 current limit.
0089
0090
0091 What: /sys/class/regulator/.../microvolts
0092 Date: April 2008
0093 KernelVersion: 2.6.26
0094 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0095 Description:
0096 Some regulator directories will contain a field called
0097 microvolts. This holds the regulator output voltage setting
0098 measured in microvolts (i.e. E-6 Volts), for regulators
0099 which can report the control input for voltage.
0100
0101 NOTE: This value should not be used to determine the regulator
0102 output voltage level as this value is the same regardless of
0103 whether the regulator is enabled or disabled.
0104
0105
0106 What: /sys/class/regulator/.../microamps
0107 Date: April 2008
0108 KernelVersion: 2.6.26
0109 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0110 Description:
0111 Some regulator directories will contain a field called
0112 microamps. This holds the regulator output current limit
0113 setting measured in microamps (i.e. E-6 Amps), for regulators
0114 which can report the control input for a current limit.
0115
0116 NOTE: This value should not be used to determine the regulator
0117 output current level as this value is the same regardless of
0118 whether the regulator is enabled or disabled.
0119
0120
0121 What: /sys/class/regulator/.../opmode
0122 Date: April 2008
0123 KernelVersion: 2.6.26
0124 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0125 Description:
0126 Some regulator directories will contain a field called
0127 opmode. This holds the current regulator operating mode,
0128 for regulators which can report that control input value.
0129
0130 The opmode value can be one of the following strings:
0131
0132 - 'fast'
0133 - 'normal'
0134 - 'idle'
0135 - 'standby'
0136 - 'unknown'
0137
0138 The modes are described in include/linux/regulator/consumer.h
0139
0140 NOTE: This value should not be used to determine the regulator
0141 output operating mode as this value is the same regardless of
0142 whether the regulator is enabled or disabled. A "status"
0143 attribute may be available to determine the actual mode.
0144
0145
0146 What: /sys/class/regulator/.../min_microvolts
0147 Date: April 2008
0148 KernelVersion: 2.6.26
0149 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0150 Description:
0151 Some regulator directories will contain a field called
0152 min_microvolts. This holds the minimum safe working regulator
0153 output voltage setting for this domain measured in microvolts,
0154 for regulators which support voltage constraints.
0155
0156 NOTE: this will return the string 'constraint not defined' if
0157 the power domain has no min microvolts constraint defined by
0158 platform code.
0159
0160
0161 What: /sys/class/regulator/.../max_microvolts
0162 Date: April 2008
0163 KernelVersion: 2.6.26
0164 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0165 Description:
0166 Some regulator directories will contain a field called
0167 max_microvolts. This holds the maximum safe working regulator
0168 output voltage setting for this domain measured in microvolts,
0169 for regulators which support voltage constraints.
0170
0171 NOTE: this will return the string 'constraint not defined' if
0172 the power domain has no max microvolts constraint defined by
0173 platform code.
0174
0175
0176 What: /sys/class/regulator/.../min_microamps
0177 Date: April 2008
0178 KernelVersion: 2.6.26
0179 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0180 Description:
0181 Some regulator directories will contain a field called
0182 min_microamps. This holds the minimum safe working regulator
0183 output current limit setting for this domain measured in
0184 microamps, for regulators which support current constraints.
0185
0186 NOTE: this will return the string 'constraint not defined' if
0187 the power domain has no min microamps constraint defined by
0188 platform code.
0189
0190
0191 What: /sys/class/regulator/.../max_microamps
0192 Date: April 2008
0193 KernelVersion: 2.6.26
0194 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0195 Description:
0196 Some regulator directories will contain a field called
0197 max_microamps. This holds the maximum safe working regulator
0198 output current limit setting for this domain measured in
0199 microamps, for regulators which support current constraints.
0200
0201 NOTE: this will return the string 'constraint not defined' if
0202 the power domain has no max microamps constraint defined by
0203 platform code.
0204
0205
0206 What: /sys/class/regulator/.../name
0207 Date: October 2008
0208 KernelVersion: 2.6.28
0209 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0210 Description:
0211 Each regulator directory will contain a field called
0212 name. This holds a string identifying the regulator for
0213 display purposes.
0214
0215 NOTE: this will be empty if no suitable name is provided
0216 by platform or regulator drivers.
0217
0218
0219 What: /sys/class/regulator/.../num_users
0220 Date: April 2008
0221 KernelVersion: 2.6.26
0222 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0223 Description:
0224 Each regulator directory will contain a field called
0225 num_users. This holds the number of consumer devices that
0226 have called regulator_enable() on this regulator.
0227
0228
0229 What: /sys/class/regulator/.../requested_microamps
0230 Date: April 2008
0231 KernelVersion: 2.6.26
0232 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0233 Description:
0234 Some regulator directories will contain a field called
0235 requested_microamps. This holds the total requested load
0236 current in microamps for this regulator from all its consumer
0237 devices.
0238
0239
0240 What: /sys/class/regulator/.../parent
0241 Date: April 2008
0242 KernelVersion: 2.6.26
0243 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0244 Description:
0245 Some regulator directories will contain a link called parent.
0246 This points to the parent or supply regulator if one exists.
0247
0248 What: /sys/class/regulator/.../suspend_mem_microvolts
0249 Date: May 2008
0250 KernelVersion: 2.6.26
0251 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0252 Description:
0253 Some regulator directories will contain a field called
0254 suspend_mem_microvolts. This holds the regulator output
0255 voltage setting for this domain measured in microvolts when
0256 the system is suspended to memory, for voltage regulators
0257 implementing suspend voltage configuration constraints.
0258
0259 What: /sys/class/regulator/.../suspend_disk_microvolts
0260 Date: May 2008
0261 KernelVersion: 2.6.26
0262 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0263 Description:
0264 Some regulator directories will contain a field called
0265 suspend_disk_microvolts. This holds the regulator output
0266 voltage setting for this domain measured in microvolts when
0267 the system is suspended to disk, for voltage regulators
0268 implementing suspend voltage configuration constraints.
0269
0270 What: /sys/class/regulator/.../suspend_standby_microvolts
0271 Date: May 2008
0272 KernelVersion: 2.6.26
0273 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0274 Description:
0275 Some regulator directories will contain a field called
0276 suspend_standby_microvolts. This holds the regulator output
0277 voltage setting for this domain measured in microvolts when
0278 the system is suspended to standby, for voltage regulators
0279 implementing suspend voltage configuration constraints.
0280
0281 What: /sys/class/regulator/.../suspend_mem_mode
0282 Date: May 2008
0283 KernelVersion: 2.6.26
0284 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0285 Description:
0286 Some regulator directories will contain a field called
0287 suspend_mem_mode. This holds the regulator operating mode
0288 setting for this domain when the system is suspended to
0289 memory, for regulators implementing suspend mode
0290 configuration constraints.
0291
0292 What: /sys/class/regulator/.../suspend_disk_mode
0293 Date: May 2008
0294 KernelVersion: 2.6.26
0295 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0296 Description:
0297 Some regulator directories will contain a field called
0298 suspend_disk_mode. This holds the regulator operating mode
0299 setting for this domain when the system is suspended to disk,
0300 for regulators implementing suspend mode configuration
0301 constraints.
0302
0303 What: /sys/class/regulator/.../suspend_standby_mode
0304 Date: May 2008
0305 KernelVersion: 2.6.26
0306 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0307 Description:
0308 Some regulator directories will contain a field called
0309 suspend_standby_mode. This holds the regulator operating mode
0310 setting for this domain when the system is suspended to
0311 standby, for regulators implementing suspend mode
0312 configuration constraints.
0313
0314 What: /sys/class/regulator/.../suspend_mem_state
0315 Date: May 2008
0316 KernelVersion: 2.6.26
0317 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0318 Description:
0319 Some regulator directories will contain a field called
0320 suspend_mem_state. This holds the regulator operating state
0321 when suspended to memory, for regulators implementing suspend
0322 configuration constraints.
0323
0324 This will be one of the same strings reported by
0325 the "state" attribute.
0326
0327 What: /sys/class/regulator/.../suspend_disk_state
0328 Date: May 2008
0329 KernelVersion: 2.6.26
0330 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0331 Description:
0332 Some regulator directories will contain a field called
0333 suspend_disk_state. This holds the regulator operating state
0334 when suspended to disk, for regulators implementing
0335 suspend configuration constraints.
0336
0337 This will be one of the same strings reported by
0338 the "state" attribute.
0339
0340 What: /sys/class/regulator/.../suspend_standby_state
0341 Date: May 2008
0342 KernelVersion: 2.6.26
0343 Contact: Liam Girdwood <lrg@slimlogic.co.uk>
0344 Description:
0345 Some regulator directories will contain a field called
0346 suspend_standby_state. This holds the regulator operating
0347 state when suspended to standby, for regulators implementing
0348 suspend configuration constraints.
0349
0350 This will be one of the same strings reported by
0351 the "state" attribute.
0352
0353 What: /sys/class/regulator/.../bypass
0354 Date: September 2012
0355 KernelVersion: 3.7
0356 Contact: Mark Brown <broonie@opensource.wolfsonmicro.com>
0357 Description:
0358 Some regulator directories will contain a field called
0359 bypass. This indicates if the device is in bypass mode.
0360
0361 This will be one of the following strings:
0362
0363 - 'enabled'
0364 - 'disabled'
0365 - 'unknown'
0366
0367 'enabled' means the regulator is in bypass mode.
0368
0369 'disabled' means that the regulator is regulating.
0370
0371 'unknown' means software cannot determine the state, or
0372 the reported state is invalid.
0373
0374 What: /sys/class/regulator/.../under_voltage
0375 Date: April 2022
0376 KernelVersion: 5.18
0377 Contact: Zev Weiss <zev@bewilderbeest.net>
0378 Description:
0379 Some regulator directories will contain a field called
0380 under_voltage. This indicates if the device reports an
0381 under-voltage fault (1) or not (0).
0382
0383 What: /sys/class/regulator/.../over_current
0384 Date: April 2022
0385 KernelVersion: 5.18
0386 Contact: Zev Weiss <zev@bewilderbeest.net>
0387 Description:
0388 Some regulator directories will contain a field called
0389 over_current. This indicates if the device reports an
0390 over-current fault (1) or not (0).
0391
0392 What: /sys/class/regulator/.../regulation_out
0393 Date: April 2022
0394 KernelVersion: 5.18
0395 Contact: Zev Weiss <zev@bewilderbeest.net>
0396 Description:
0397 Some regulator directories will contain a field called
0398 regulation_out. This indicates if the device reports an
0399 out-of-regulation fault (1) or not (0).
0400
0401 What: /sys/class/regulator/.../fail
0402 Date: April 2022
0403 KernelVersion: 5.18
0404 Contact: Zev Weiss <zev@bewilderbeest.net>
0405 Description:
0406 Some regulator directories will contain a field called
0407 fail. This indicates if the device reports an output failure
0408 (1) or not (0).
0409
0410 What: /sys/class/regulator/.../over_temp
0411 Date: April 2022
0412 KernelVersion: 5.18
0413 Contact: Zev Weiss <zev@bewilderbeest.net>
0414 Description:
0415 Some regulator directories will contain a field called
0416 over_temp. This indicates if the device reports an
0417 over-temperature fault (1) or not (0).
0418
0419 What: /sys/class/regulator/.../under_voltage_warn
0420 Date: April 2022
0421 KernelVersion: 5.18
0422 Contact: Zev Weiss <zev@bewilderbeest.net>
0423 Description:
0424 Some regulator directories will contain a field called
0425 under_voltage_warn. This indicates if the device reports an
0426 under-voltage warning (1) or not (0).
0427
0428 What: /sys/class/regulator/.../over_current_warn
0429 Date: April 2022
0430 KernelVersion: 5.18
0431 Contact: Zev Weiss <zev@bewilderbeest.net>
0432 Description:
0433 Some regulator directories will contain a field called
0434 over_current_warn. This indicates if the device reports an
0435 over-current warning (1) or not (0).
0436
0437 What: /sys/class/regulator/.../over_voltage_warn
0438 Date: April 2022
0439 KernelVersion: 5.18
0440 Contact: Zev Weiss <zev@bewilderbeest.net>
0441 Description:
0442 Some regulator directories will contain a field called
0443 over_voltage_warn. This indicates if the device reports an
0444 over-voltage warning (1) or not (0).
0445
0446 What: /sys/class/regulator/.../over_temp_warn
0447 Date: April 2022
0448 KernelVersion: 5.18
0449 Contact: Zev Weiss <zev@bewilderbeest.net>
0450 Description:
0451 Some regulator directories will contain a field called
0452 over_temp_warn. This indicates if the device reports an
0453 over-temperature warning (1) or not (0).
