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