Documentation/ABI/testing/sysfs-class-regulator

   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                 Each regulator directory will contain a field called
   7                 state. This holds the regulator output state.
   8
   9                 This will be one of the following strings:
  10
  11                 'enabled'
  12                 'disabled'
  13                 'unknown'
  14
  15                 'enabled' means the regulator output is ON and is supplying
  16                 power to the system.
  17
  18                 'disabled' means the regulator output is OFF and is not
  19                 supplying power to the system..
  20
  21                 'unknown' means software cannot determine the state.
  22
  23                 NOTE: this field can be used in conjunction with microvolts
  24                 and microamps to determine regulator output levels.
  25
  26
  27 What:           /sys/class/regulator/.../type
  28 Date:           April 2008
  29 KernelVersion:  2.6.26
  30 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
  31 Description:
  32                 Each regulator directory will contain a field called
  33                 type. This holds the regulator type.
  34
  35                 This will be one of the following strings:
  36
  37                 'voltage'
  38                 'current'
  39                 'unknown'
  40
  41                 'voltage' means the regulator output voltage can be controlled
  42                 by software.
  43
  44                 'current' means the regulator output current limit can be
  45                 controlled by software.
  46
  47                 'unknown' means software cannot control either voltage or
  48                 current limit.
  49
  50
  51 What:           /sys/class/regulator/.../microvolts
  52 Date:           April 2008
  53 KernelVersion:  2.6.26
  54 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
  55 Description:
  56                 Each regulator directory will contain a field called
  57                 microvolts. This holds the regulator output voltage setting
  58                 measured in microvolts (i.e. E-6 Volts).
  59
  60                 NOTE: This value should not be used to determine the regulator
  61                 output voltage level as this value is the same regardless of
  62                 whether the regulator is enabled or disabled.
  63
  64
  65 What:           /sys/class/regulator/.../microamps
  66 Date:           April 2008
  67 KernelVersion:  2.6.26
  68 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
  69 Description:
  70                 Each regulator directory will contain a field called
  71                 microamps. This holds the regulator output current limit
  72                 setting measured in microamps (i.e. E-6 Amps).
  73
  74                 NOTE: This value should not be used to determine the regulator
  75                 output current level as this value is the same regardless of
  76                 whether the regulator is enabled or disabled.
  77
  78
  79 What:           /sys/class/regulator/.../opmode
  80 Date:           April 2008
  81 KernelVersion:  2.6.26
  82 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
  83 Description:
  84                 Each regulator directory will contain a field called
  85                 opmode. This holds the regulator operating mode setting.
  86
  87                 The opmode value can be one of the following strings:
  88
  89                 'fast'
  90                 'normal'
  91                 'idle'
  92                 'standby'
  93                 'unknown'
  94
  95                 The modes are described in include/linux/regulator/regulator.h
  96
  97                 NOTE: This value should not be used to determine the regulator
  98                 output operating mode as this value is the same regardless of
  99                 whether the regulator is enabled or disabled.
 100
 101
 102 What:           /sys/class/regulator/.../min_microvolts
 103 Date:           April 2008
 104 KernelVersion:  2.6.26
 105 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 106 Description:
 107                 Each regulator directory will contain a field called
 108                 min_microvolts. This holds the minimum safe working regulator
 109                 output voltage setting for this domain measured in microvolts.
 110
 111                 NOTE: this will return the string 'constraint not defined' if
 112                 the power domain has no min microvolts constraint defined by
 113                 platform code.
 114
 115
 116 What:           /sys/class/regulator/.../max_microvolts
 117 Date:           April 2008
 118 KernelVersion:  2.6.26
 119 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 120 Description:
 121                 Each regulator directory will contain a field called
 122                 max_microvolts. This holds the maximum safe working regulator
 123                 output voltage setting for this domain measured in microvolts.
 124
 125                 NOTE: this will return the string 'constraint not defined' if
 126                 the power domain has no max microvolts constraint defined by
 127                 platform code.
 128
 129
 130 What:           /sys/class/regulator/.../min_microamps
 131 Date:           April 2008
 132 KernelVersion:  2.6.26
 133 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 134 Description:
 135                 Each regulator directory will contain a field called
 136                 min_microamps. This holds the minimum safe working regulator
 137                 output current limit setting for this domain measured in
 138                 microamps.
 139
 140                 NOTE: this will return the string 'constraint not defined' if
 141                 the power domain has no min microamps constraint defined by
 142                 platform code.
 143
 144
 145 What:           /sys/class/regulator/.../max_microamps
 146 Date:           April 2008
 147 KernelVersion:  2.6.26
 148 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 149 Description:
 150                 Each regulator directory will contain a field called
 151                 max_microamps. This holds the maximum safe working regulator
 152                 output current limit setting for this domain measured in
 153                 microamps.
 154
 155                 NOTE: this will return the string 'constraint not defined' if
 156                 the power domain has no max microamps constraint defined by
 157                 platform code.
 158
 159
 160 What:           /sys/class/regulator/.../name
 161 Date:           October 2008
 162 KernelVersion:  2.6.28
 163 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 164 Description:
 165                 Each regulator directory will contain a field called
 166                 name. This holds a string identifying the regulator for
 167                 display purposes.
 168
 169                 NOTE: this will be empty if no suitable name is provided
 170                 by platform or regulator drivers.
 171
 172
 173 What:           /sys/class/regulator/.../num_users
 174 Date:           April 2008
 175 KernelVersion:  2.6.26
 176 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 177 Description:
 178                 Each regulator directory will contain a field called
 179                 num_users. This holds the number of consumer devices that
 180                 have called regulator_enable() on this regulator.
 181
 182
 183 What:           /sys/class/regulator/.../requested_microamps
 184 Date:           April 2008
 185 KernelVersion:  2.6.26
 186 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 187 Description:
 188                 Each regulator directory will contain a field called
 189                 requested_microamps. This holds the total requested load
 190                 current in microamps for this regulator from all its consumer
 191                 devices.
 192
 193
 194 What:           /sys/class/regulator/.../parent
 195 Date:           April 2008
 196 KernelVersion:  2.6.26
 197 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 198 Description:
 199                 Some regulator directories will contain a link called parent.
 200                 This points to the parent or supply regulator if one exists.
 201
 202 What:           /sys/class/regulator/.../suspend_mem_microvolts
 203 Date:           May 2008
 204 KernelVersion:  2.6.26
 205 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 206 Description:
 207                 Each regulator directory will contain a field called
 208                 suspend_mem_microvolts. This holds the regulator output
 209                 voltage setting for this domain measured in microvolts when
 210                 the system is suspended to memory.
 211
 212                 NOTE: this will return the string 'not defined' if
 213                 the power domain has no suspend to memory voltage defined by
 214                 platform code.
 215
 216 What:           /sys/class/regulator/.../suspend_disk_microvolts
 217 Date:           May 2008
 218 KernelVersion:  2.6.26
 219 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 220 Description:
 221                 Each regulator directory will contain a field called
 222                 suspend_disk_microvolts. This holds the regulator output
 223                 voltage setting for this domain measured in microvolts when
 224                 the system is suspended to disk.
 225
 226                 NOTE: this will return the string 'not defined' if
 227                 the power domain has no suspend to disk voltage defined by
 228                 platform code.
 229
 230 What:           /sys/class/regulator/.../suspend_standby_microvolts
 231 Date:           May 2008
 232 KernelVersion:  2.6.26
 233 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 234 Description:
 235                 Each regulator directory will contain a field called
 236                 suspend_standby_microvolts. This holds the regulator output
 237                 voltage setting for this domain measured in microvolts when
 238                 the system is suspended to standby.
 239
 240                 NOTE: this will return the string 'not defined' if
 241                 the power domain has no suspend to standby voltage defined by
 242                 platform code.
 243
 244 What:           /sys/class/regulator/.../suspend_mem_mode
 245 Date:           May 2008
 246 KernelVersion:  2.6.26
 247 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 248 Description:
 249                 Each regulator directory will contain a field called
 250                 suspend_mem_mode. This holds the regulator operating mode
 251                 setting for this domain when the system is suspended to
 252                 memory.
 253
 254                 NOTE: this will return the string 'not defined' if
 255                 the power domain has no suspend to memory mode defined by
 256                 platform code.
 257
 258 What:           /sys/class/regulator/.../suspend_disk_mode
 259 Date:           May 2008
 260 KernelVersion:  2.6.26
 261 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 262 Description:
 263                 Each regulator directory will contain a field called
 264                 suspend_disk_mode. This holds the regulator operating mode
 265                 setting for this domain when the system is suspended to disk.
 266
 267                 NOTE: this will return the string 'not defined' if
 268                 the power domain has no suspend to disk mode defined by
 269                 platform code.
 270
 271 What:           /sys/class/regulator/.../suspend_standby_mode
 272 Date:           May 2008
 273 KernelVersion:  2.6.26
 274 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 275 Description:
 276                 Each regulator directory will contain a field called
 277                 suspend_standby_mode. This holds the regulator operating mode
 278                 setting for this domain when the system is suspended to
 279                 standby.
 280
 281                 NOTE: this will return the string 'not defined' if
 282                 the power domain has no suspend to standby mode defined by
 283                 platform code.
 284
 285 What:           /sys/class/regulator/.../suspend_mem_state
 286 Date:           May 2008
 287 KernelVersion:  2.6.26
 288 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 289 Description:
 290                 Each regulator directory will contain a field called
 291                 suspend_mem_state. This holds the regulator operating state
 292                 when suspended to memory.
 293
 294                 This will be one of the following strings:
 295
 296                 'enabled'
 297                 'disabled'
 298                 'not defined'
 299
 300 What:           /sys/class/regulator/.../suspend_disk_state
 301 Date:           May 2008
 302 KernelVersion:  2.6.26
 303 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 304 Description:
 305                 Each regulator directory will contain a field called
 306                 suspend_disk_state. This holds the regulator operating state
 307                 when suspended to disk.
 308
 309                 This will be one of the following strings:
 310
 311                 'enabled'
 312                 'disabled'
 313                 'not defined'
 314
 315 What:           /sys/class/regulator/.../suspend_standby_state
 316 Date:           May 2008
 317 KernelVersion:  2.6.26
 318 Contact:        Liam Girdwood <lrg@slimlogic.co.uk>
 319 Description:
 320                 Each regulator directory will contain a field called
 321                 suspend_standby_state. This holds the regulator operating
 322                 state when suspended to standby.
 323
 324                 This will be one of the following strings:
 325
 326                 'enabled'
 327                 'disabled'
 328                 'not defined'