1What:		/sys/class/regulator/.../state
2Date:		April 2008
3KernelVersion:	2.6.26
4Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
5Description:
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
27What:		/sys/class/regulator/.../type
28Date:		April 2008
29KernelVersion:	2.6.26
30Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
31Description:
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
51What:		/sys/class/regulator/.../microvolts
52Date:		April 2008
53KernelVersion:	2.6.26
54Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
55Description:
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
65What:		/sys/class/regulator/.../microamps
66Date:		April 2008
67KernelVersion:	2.6.26
68Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
69Description:
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
79What:		/sys/class/regulator/.../opmode
80Date:		April 2008
81KernelVersion:	2.6.26
82Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
83Description:
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
102What:		/sys/class/regulator/.../min_microvolts
103Date:		April 2008
104KernelVersion:	2.6.26
105Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
106Description:
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
116What:		/sys/class/regulator/.../max_microvolts
117Date:		April 2008
118KernelVersion:	2.6.26
119Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
120Description:
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
130What:		/sys/class/regulator/.../min_microamps
131Date:		April 2008
132KernelVersion:	2.6.26
133Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
134Description:
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
145What:		/sys/class/regulator/.../max_microamps
146Date:		April 2008
147KernelVersion:	2.6.26
148Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
149Description:
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
160What:		/sys/class/regulator/.../num_users
161Date:		April 2008
162KernelVersion:	2.6.26
163Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
164Description:
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
170What:		/sys/class/regulator/.../requested_microamps
171Date:		April 2008
172KernelVersion:	2.6.26
173Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
174Description:
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
181What:		/sys/class/regulator/.../parent
182Date:		April 2008
183KernelVersion:	2.6.26
184Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
185Description:
186		Some regulator directories will contain a link called parent.
187		This points to the parent or supply regulator if one exists.
188
189What:		/sys/class/regulator/.../suspend_mem_microvolts
190Date:		May 2008
191KernelVersion:	2.6.26
192Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
193Description:
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
203What:		/sys/class/regulator/.../suspend_disk_microvolts
204Date:		May 2008
205KernelVersion:	2.6.26
206Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
207Description:
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
217What:		/sys/class/regulator/.../suspend_standby_microvolts
218Date:		May 2008
219KernelVersion:	2.6.26
220Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
221Description:
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
231What:		/sys/class/regulator/.../suspend_mem_mode
232Date:		May 2008
233KernelVersion:	2.6.26
234Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
235Description:
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
245What:		/sys/class/regulator/.../suspend_disk_mode
246Date:		May 2008
247KernelVersion:	2.6.26
248Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
249Description:
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
258What:		/sys/class/regulator/.../suspend_standby_mode
259Date:		May 2008
260KernelVersion:	2.6.26
261Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
262Description:
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
272What:		/sys/class/regulator/.../suspend_mem_state
273Date:		May 2008
274KernelVersion:	2.6.26
275Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
276Description:
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
287What:		/sys/class/regulator/.../suspend_disk_state
288Date:		May 2008
289KernelVersion:	2.6.26
290Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
291Description:
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
302What:		/sys/class/regulator/.../suspend_standby_state
303Date:		May 2008
304KernelVersion:	2.6.26
305Contact:	Liam Girdwood <lg@opensource.wolfsonmicro.com>
306Description:
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'
316