]> git.openfabrics.org - ~shefty/rdma-dev.git/blob - Documentation/ABI/testing/sysfs-class-regulator
79a4a75b2d2ceb7af8e07c3efa6289c3722d6342
[~shefty/rdma-dev.git] / 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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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 <lg@opensource.wolfsonmicro.com>
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/.../num_users
161 Date:           April 2008
162 KernelVersion:  2.6.26
163 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
164 Description:
165                 Each regulator directory will contain a field called
166                 num_users. This holds the number of consumer devices that
167                 have called regulator_enable() on this regulator.
168
169
170 What:           /sys/class/regulator/.../requested_microamps
171 Date:           April 2008
172 KernelVersion:  2.6.26
173 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
174 Description:
175                 Each regulator directory will contain a field called
176                 requested_microamps. This holds the total requested load
177                 current in microamps for this regulator from all its consumer
178                 devices.
179
180
181 What:           /sys/class/regulator/.../parent
182 Date:           April 2008
183 KernelVersion:  2.6.26
184 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
185 Description:
186                 Some regulator directories will contain a link called parent.
187                 This points to the parent or supply regulator if one exists.
188
189 What:           /sys/class/regulator/.../suspend_mem_microvolts
190 Date:           May 2008
191 KernelVersion:  2.6.26
192 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
193 Description:
194                 Each regulator directory will contain a field called
195                 suspend_mem_microvolts. This holds the regulator output
196                 voltage setting for this domain measured in microvolts when
197                 the system is suspended to memory.
198
199                 NOTE: this will return the string 'not defined' if
200                 the power domain has no suspend to memory voltage defined by
201                 platform code.
202
203 What:           /sys/class/regulator/.../suspend_disk_microvolts
204 Date:           May 2008
205 KernelVersion:  2.6.26
206 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
207 Description:
208                 Each regulator directory will contain a field called
209                 suspend_disk_microvolts. This holds the regulator output
210                 voltage setting for this domain measured in microvolts when
211                 the system is suspended to disk.
212
213                 NOTE: this will return the string 'not defined' if
214                 the power domain has no suspend to disk voltage defined by
215                 platform code.
216
217 What:           /sys/class/regulator/.../suspend_standby_microvolts
218 Date:           May 2008
219 KernelVersion:  2.6.26
220 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
221 Description:
222                 Each regulator directory will contain a field called
223                 suspend_standby_microvolts. This holds the regulator output
224                 voltage setting for this domain measured in microvolts when
225                 the system is suspended to standby.
226
227                 NOTE: this will return the string 'not defined' if
228                 the power domain has no suspend to standby voltage defined by
229                 platform code.
230
231 What:           /sys/class/regulator/.../suspend_mem_mode
232 Date:           May 2008
233 KernelVersion:  2.6.26
234 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
235 Description:
236                 Each regulator directory will contain a field called
237                 suspend_mem_mode. This holds the regulator operating mode
238                 setting for this domain when the system is suspended to
239                 memory.
240
241                 NOTE: this will return the string 'not defined' if
242                 the power domain has no suspend to memory mode defined by
243                 platform code.
244
245 What:           /sys/class/regulator/.../suspend_disk_mode
246 Date:           May 2008
247 KernelVersion:  2.6.26
248 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
249 Description:
250                 Each regulator directory will contain a field called
251                 suspend_disk_mode. This holds the regulator operating mode
252                 setting for this domain when the system is suspended to disk.
253
254                 NOTE: this will return the string 'not defined' if
255                 the power domain has no suspend to disk mode defined by
256                 platform code.
257
258 What:           /sys/class/regulator/.../suspend_standby_mode
259 Date:           May 2008
260 KernelVersion:  2.6.26
261 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
262 Description:
263                 Each regulator directory will contain a field called
264                 suspend_standby_mode. This holds the regulator operating mode
265                 setting for this domain when the system is suspended to
266                 standby.
267
268                 NOTE: this will return the string 'not defined' if
269                 the power domain has no suspend to standby mode defined by
270                 platform code.
271
272 What:           /sys/class/regulator/.../suspend_mem_state
273 Date:           May 2008
274 KernelVersion:  2.6.26
275 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
276 Description:
277                 Each regulator directory will contain a field called
278                 suspend_mem_state. This holds the regulator operating state
279                 when suspended to memory.
280
281                 This will be one of the following strings:
282
283                 'enabled'
284                 'disabled'
285                 'not defined'
286
287 What:           /sys/class/regulator/.../suspend_disk_state
288 Date:           May 2008
289 KernelVersion:  2.6.26
290 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
291 Description:
292                 Each regulator directory will contain a field called
293                 suspend_disk_state. This holds the regulator operating state
294                 when suspended to disk.
295
296                 This will be one of the following strings:
297
298                 'enabled'
299                 'disabled'
300                 'not defined'
301
302 What:           /sys/class/regulator/.../suspend_standby_state
303 Date:           May 2008
304 KernelVersion:  2.6.26
305 Contact:        Liam Girdwood <lg@opensource.wolfsonmicro.com>
306 Description:
307                 Each regulator directory will contain a field called
308                 suspend_standby_state. This holds the regulator operating
309                 state when suspended to standby.
310
311                 This will be one of the following strings:
312
313                 'enabled'
314                 'disabled'
315                 'not defined'