Merge branch 'pm-cpufreq'
[linux-2.6-block.git] / include / linux / regulator / consumer.h
CommitLineData
e2ce4eaa
LG
1/*
2 * consumer.h -- SoC Regulator consumer support.
3 *
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
5 *
1dd68f01 6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
e2ce4eaa
LG
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
12 * Regulator Consumer Interface.
13 *
14 * A Power Management Regulator framework for SoC based devices.
15 * Features:-
16 * o Voltage and current level control.
17 * o Operating mode control.
18 * o Regulator status.
19 * o sysfs entries for showing client devices and status
20 *
21 * EXPERIMENTAL FEATURES:
22 * Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
23 * to use most efficient operating mode depending upon voltage and load and
24 * is transparent to client drivers.
25 *
26 * e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
27 * IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
28 * idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
29 * but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
30 * efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
31 * in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
32 *
33 */
34
35#ifndef __LINUX_REGULATOR_CONSUMER_H_
36#define __LINUX_REGULATOR_CONSUMER_H_
37
313162d0
PG
38struct device;
39struct notifier_block;
b56daf13 40
e2ce4eaa
LG
41/*
42 * Regulator operating modes.
43 *
44 * Regulators can run in a variety of different operating modes depending on
45 * output load. This allows further system power savings by selecting the
46 * best (and most efficient) regulator mode for a desired load.
47 *
48 * Most drivers will only care about NORMAL. The modes below are generic and
49 * will probably not match the naming convention of your regulator data sheet
50 * but should match the use cases in the datasheet.
51 *
52 * In order of power efficiency (least efficient at top).
53 *
54 * Mode Description
55 * FAST Regulator can handle fast changes in it's load.
56 * e.g. useful in CPU voltage & frequency scaling where
57 * load can quickly increase with CPU frequency increases.
58 *
59 * NORMAL Normal regulator power supply mode. Most drivers will
60 * use this mode.
61 *
62 * IDLE Regulator runs in a more efficient mode for light
63 * loads. Can be used for devices that have a low power
64 * requirement during periods of inactivity. This mode
65 * may be more noisy than NORMAL and may not be able
66 * to handle fast load switching.
67 *
68 * STANDBY Regulator runs in the most efficient mode for very
69 * light loads. Can be used by devices when they are
70 * in a sleep/standby state. This mode is likely to be
71 * the most noisy and may not be able to handle fast load
72 * switching.
73 *
74 * NOTE: Most regulators will only support a subset of these modes. Some
75 * will only just support NORMAL.
76 *
77 * These modes can be OR'ed together to make up a mask of valid register modes.
78 */
79
80#define REGULATOR_MODE_FAST 0x1
81#define REGULATOR_MODE_NORMAL 0x2
82#define REGULATOR_MODE_IDLE 0x4
83#define REGULATOR_MODE_STANDBY 0x8
84
85/*
86 * Regulator notifier events.
87 *
88 * UNDER_VOLTAGE Regulator output is under voltage.
89 * OVER_CURRENT Regulator output current is too high.
90 * REGULATION_OUT Regulator output is out of regulation.
91 * FAIL Regulator output has failed.
92 * OVER_TEMP Regulator over temp.
84b68263 93 * FORCE_DISABLE Regulator forcibly shut down by software.
b136fb44 94 * VOLTAGE_CHANGE Regulator voltage changed.
84b68263 95 * DISABLE Regulator was disabled.
e2ce4eaa
LG
96 *
97 * NOTE: These events can be OR'ed together when passed into handler.
98 */
99
100#define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
101#define REGULATOR_EVENT_OVER_CURRENT 0x02
102#define REGULATOR_EVENT_REGULATION_OUT 0x04
103#define REGULATOR_EVENT_FAIL 0x08
104#define REGULATOR_EVENT_OVER_TEMP 0x10
105#define REGULATOR_EVENT_FORCE_DISABLE 0x20
b136fb44 106#define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
84b68263 107#define REGULATOR_EVENT_DISABLE 0x80
e2ce4eaa
LG
108
109struct regulator;
110
111/**
112 * struct regulator_bulk_data - Data used for bulk regulator operations.
113 *
69279fb9
MB
114 * @supply: The name of the supply. Initialised by the user before
115 * using the bulk regulator APIs.
116 * @consumer: The regulator consumer for the supply. This will be managed
117 * by the bulk API.
e2ce4eaa
LG
118 *
119 * The regulator APIs provide a series of regulator_bulk_() API calls as
120 * a convenience to consumers which require multiple supplies. This
121 * structure is used to manage data for these calls.
122 */
123struct regulator_bulk_data {
124 const char *supply;
125 struct regulator *consumer;
f21e0e81 126
bff747c5 127 /* private: Internal use */
f21e0e81 128 int ret;
e2ce4eaa
LG
129};
130
131#if defined(CONFIG_REGULATOR)
132
133/* regulator get and put */
134struct regulator *__must_check regulator_get(struct device *dev,
135 const char *id);
070b9079
SB
136struct regulator *__must_check devm_regulator_get(struct device *dev,
137 const char *id);
5ffbd136
MB
138struct regulator *__must_check regulator_get_exclusive(struct device *dev,
139 const char *id);
9efdd276
MK
140struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
141 const char *id);
de1dd9fd
MB
142struct regulator *__must_check regulator_get_optional(struct device *dev,
143 const char *id);
144struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
145 const char *id);
e2ce4eaa 146void regulator_put(struct regulator *regulator);
2950c4bb 147void devm_regulator_put(struct regulator *regulator);
e2ce4eaa 148
a06ccd9c
CK
149int regulator_register_supply_alias(struct device *dev, const char *id,
150 struct device *alias_dev,
151 const char *alias_id);
152void regulator_unregister_supply_alias(struct device *dev, const char *id);
153
154int regulator_bulk_register_supply_alias(struct device *dev, const char **id,
155 struct device *alias_dev,
156 const char **alias_id, int num_id);
157void regulator_bulk_unregister_supply_alias(struct device *dev,
158 const char **id, int num_id);
159
160int devm_regulator_register_supply_alias(struct device *dev, const char *id,
161 struct device *alias_dev,
162 const char *alias_id);
163void devm_regulator_unregister_supply_alias(struct device *dev,
164 const char *id);
165
166int devm_regulator_bulk_register_supply_alias(struct device *dev,
167 const char **id,
168 struct device *alias_dev,
169 const char **alias_id,
170 int num_id);
171void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
172 const char **id,
173 int num_id);
174
e2ce4eaa 175/* regulator output control and status */
c8801a8e 176int __must_check regulator_enable(struct regulator *regulator);
e2ce4eaa
LG
177int regulator_disable(struct regulator *regulator);
178int regulator_force_disable(struct regulator *regulator);
179int regulator_is_enabled(struct regulator *regulator);
da07ecd9 180int regulator_disable_deferred(struct regulator *regulator, int ms);
e2ce4eaa 181
c8801a8e
MB
182int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
183 struct regulator_bulk_data *consumers);
184int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
185 struct regulator_bulk_data *consumers);
186int __must_check regulator_bulk_enable(int num_consumers,
187 struct regulator_bulk_data *consumers);
e2ce4eaa
LG
188int regulator_bulk_disable(int num_consumers,
189 struct regulator_bulk_data *consumers);
e1de2f42
DK
190int regulator_bulk_force_disable(int num_consumers,
191 struct regulator_bulk_data *consumers);
e2ce4eaa
LG
192void regulator_bulk_free(int num_consumers,
193 struct regulator_bulk_data *consumers);
194
d1e7de30 195int regulator_can_change_voltage(struct regulator *regulator);
4367cfdc
DB
196int regulator_count_voltages(struct regulator *regulator);
197int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90
MB
198int regulator_is_supported_voltage(struct regulator *regulator,
199 int min_uV, int max_uV);
2a668a8b 200unsigned int regulator_get_linear_step(struct regulator *regulator);
e2ce4eaa 201int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
88cd222b
LW
202int regulator_set_voltage_time(struct regulator *regulator,
203 int old_uV, int new_uV);
e2ce4eaa 204int regulator_get_voltage(struct regulator *regulator);
606a2562 205int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa
LG
206int regulator_set_current_limit(struct regulator *regulator,
207 int min_uA, int max_uA);
208int regulator_get_current_limit(struct regulator *regulator);
209
210int regulator_set_mode(struct regulator *regulator, unsigned int mode);
211unsigned int regulator_get_mode(struct regulator *regulator);
212int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
213
f59c8f9f
MB
214int regulator_allow_bypass(struct regulator *regulator, bool allow);
215
e2ce4eaa
LG
216/* regulator notifier block */
217int regulator_register_notifier(struct regulator *regulator,
218 struct notifier_block *nb);
219int regulator_unregister_notifier(struct regulator *regulator,
220 struct notifier_block *nb);
221
222/* driver data - core doesn't touch */
223void *regulator_get_drvdata(struct regulator *regulator);
224void regulator_set_drvdata(struct regulator *regulator, void *data);
225
226#else
227
228/*
229 * Make sure client drivers will still build on systems with no software
230 * controllable voltage or current regulators.
231 */
232static inline struct regulator *__must_check regulator_get(struct device *dev,
233 const char *id)
234{
235 /* Nothing except the stubbed out regulator API should be
236 * looking at the value except to check if it is an error
be1a50d4
JD
237 * value. Drivers are free to handle NULL specifically by
238 * skipping all regulator API calls, but they don't have to.
239 * Drivers which don't, should make sure they properly handle
240 * corner cases of the API, such as regulator_get_voltage()
241 * returning 0.
e2ce4eaa 242 */
be1a50d4 243 return NULL;
e2ce4eaa 244}
070b9079
SB
245
246static inline struct regulator *__must_check
247devm_regulator_get(struct device *dev, const char *id)
248{
249 return NULL;
250}
251
4bdfb272
MB
252static inline struct regulator *__must_check
253regulator_get_exclusive(struct device *dev, const char *id)
254{
255 return NULL;
256}
257
de1dd9fd
MB
258static inline struct regulator *__must_check
259regulator_get_optional(struct device *dev, const char *id)
260{
261 return NULL;
262}
263
4bdfb272 264
070b9079 265static inline struct regulator *__must_check
de1dd9fd 266devm_regulator_get_optional(struct device *dev, const char *id)
070b9079
SB
267{
268 return NULL;
269}
270
e2ce4eaa
LG
271static inline void regulator_put(struct regulator *regulator)
272{
273}
274
2950c4bb
AL
275static inline void devm_regulator_put(struct regulator *regulator)
276{
277}
278
a06ccd9c
CK
279static inline int regulator_register_supply_alias(struct device *dev,
280 const char *id,
281 struct device *alias_dev,
282 const char *alias_id)
283{
284 return 0;
285}
286
287static inline void regulator_unregister_supply_alias(struct device *dev,
288 const char *id)
289{
290}
291
292static inline int regulator_bulk_register_supply_alias(struct device *dev,
293 const char **id,
294 struct device *alias_dev,
295 const char **alias_id,
296 int num_id)
297{
298 return 0;
299}
300
301static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
302 const char **id,
303 int num_id)
304{
305}
306
307static inline int devm_regulator_register_supply_alias(struct device *dev,
308 const char *id,
309 struct device *alias_dev,
310 const char *alias_id)
311{
312 return 0;
313}
314
315static inline void devm_regulator_unregister_supply_alias(struct device *dev,
316 const char *id)
317{
318}
319
320static inline int devm_regulator_bulk_register_supply_alias(
321 struct device *dev, const char **id, struct device *alias_dev,
322 const char **alias_id, int num_id)
323{
324 return 0;
325}
326
327static inline void devm_regulator_bulk_unregister_supply_alias(
328 struct device *dev, const char **id, int num_id)
329{
330}
331
e2ce4eaa
LG
332static inline int regulator_enable(struct regulator *regulator)
333{
334 return 0;
335}
336
337static inline int regulator_disable(struct regulator *regulator)
338{
339 return 0;
340}
341
935a5210
MH
342static inline int regulator_force_disable(struct regulator *regulator)
343{
344 return 0;
345}
346
da07ecd9
MB
347static inline int regulator_disable_deferred(struct regulator *regulator,
348 int ms)
349{
350 return 0;
351}
352
e2ce4eaa
LG
353static inline int regulator_is_enabled(struct regulator *regulator)
354{
355 return 1;
356}
357
358static inline int regulator_bulk_get(struct device *dev,
359 int num_consumers,
360 struct regulator_bulk_data *consumers)
361{
362 return 0;
363}
364
e24abd6e
AL
365static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
366 struct regulator_bulk_data *consumers)
367{
368 return 0;
369}
370
e2ce4eaa
LG
371static inline int regulator_bulk_enable(int num_consumers,
372 struct regulator_bulk_data *consumers)
373{
374 return 0;
375}
376
377static inline int regulator_bulk_disable(int num_consumers,
378 struct regulator_bulk_data *consumers)
379{
380 return 0;
381}
382
e1de2f42
DK
383static inline int regulator_bulk_force_disable(int num_consumers,
384 struct regulator_bulk_data *consumers)
385{
386 return 0;
387}
388
e2ce4eaa
LG
389static inline void regulator_bulk_free(int num_consumers,
390 struct regulator_bulk_data *consumers)
391{
392}
393
394static inline int regulator_set_voltage(struct regulator *regulator,
395 int min_uV, int max_uV)
396{
397 return 0;
398}
399
400static inline int regulator_get_voltage(struct regulator *regulator)
401{
08aed2f6 402 return -EINVAL;
e2ce4eaa
LG
403}
404
4fe23791
PR
405static inline int regulator_is_supported_voltage(struct regulator *regulator,
406 int min_uV, int max_uV)
407{
408 return 0;
409}
410
e2ce4eaa
LG
411static inline int regulator_set_current_limit(struct regulator *regulator,
412 int min_uA, int max_uA)
413{
414 return 0;
415}
416
417static inline int regulator_get_current_limit(struct regulator *regulator)
418{
419 return 0;
420}
421
422static inline int regulator_set_mode(struct regulator *regulator,
423 unsigned int mode)
424{
425 return 0;
426}
427
428static inline unsigned int regulator_get_mode(struct regulator *regulator)
429{
430 return REGULATOR_MODE_NORMAL;
431}
432
433static inline int regulator_set_optimum_mode(struct regulator *regulator,
434 int load_uA)
435{
436 return REGULATOR_MODE_NORMAL;
437}
438
f59c8f9f
MB
439static inline int regulator_allow_bypass(struct regulator *regulator,
440 bool allow)
441{
442 return 0;
443}
444
e2ce4eaa
LG
445static inline int regulator_register_notifier(struct regulator *regulator,
446 struct notifier_block *nb)
447{
448 return 0;
449}
450
451static inline int regulator_unregister_notifier(struct regulator *regulator,
452 struct notifier_block *nb)
453{
454 return 0;
455}
456
457static inline void *regulator_get_drvdata(struct regulator *regulator)
458{
459 return NULL;
460}
461
462static inline void regulator_set_drvdata(struct regulator *regulator,
463 void *data)
464{
465}
466
1a8f85d4
PR
467static inline int regulator_count_voltages(struct regulator *regulator)
468{
469 return 0;
470}
e2ce4eaa
LG
471#endif
472
3f196577
SG
473static inline int regulator_set_voltage_tol(struct regulator *regulator,
474 int new_uV, int tol_uV)
475{
dc9ceed6
MB
476 if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
477 return 0;
478 else
479 return regulator_set_voltage(regulator,
480 new_uV - tol_uV, new_uV + tol_uV);
3f196577
SG
481}
482
fe1e43f7
MB
483static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
484 int target_uV, int tol_uV)
485{
486 return regulator_is_supported_voltage(regulator,
487 target_uV - tol_uV,
488 target_uV + tol_uV);
489}
490
e2ce4eaa 491#endif