projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
regulator: Add empty devm_regulator_bulk_get for !CONFIG_REGULATOR
[deliverable/linux.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
b56daf13
LG		 38#include <linux/device.h>
39
e2ce4eaa
LG		 40/*
41 * Regulator operating modes.
42 *
43 * Regulators can run in a variety of different operating modes depending on
44 * output load. This allows further system power savings by selecting the
45 * best (and most efficient) regulator mode for a desired load.
46 *
47 * Most drivers will only care about NORMAL. The modes below are generic and
48 * will probably not match the naming convention of your regulator data sheet
49 * but should match the use cases in the datasheet.
50 *
51 * In order of power efficiency (least efficient at top).
52 *
53 * Mode Description
54 * FAST Regulator can handle fast changes in it's load.
55 * e.g. useful in CPU voltage & frequency scaling where
56 * load can quickly increase with CPU frequency increases.
57 *
58 * NORMAL Normal regulator power supply mode. Most drivers will
59 * use this mode.
60 *
61 * IDLE Regulator runs in a more efficient mode for light
62 * loads. Can be used for devices that have a low power
63 * requirement during periods of inactivity. This mode
64 * may be more noisy than NORMAL and may not be able
65 * to handle fast load switching.
66 *
67 * STANDBY Regulator runs in the most efficient mode for very
68 * light loads. Can be used by devices when they are
69 * in a sleep/standby state. This mode is likely to be
70 * the most noisy and may not be able to handle fast load
71 * switching.
72 *
73 * NOTE: Most regulators will only support a subset of these modes. Some
74 * will only just support NORMAL.
75 *
76 * These modes can be OR'ed together to make up a mask of valid register modes.
77 */
78
79#define REGULATOR_MODE_FAST 0x1
80#define REGULATOR_MODE_NORMAL 0x2
81#define REGULATOR_MODE_IDLE 0x4
82#define REGULATOR_MODE_STANDBY 0x8
83
84/*
85 * Regulator notifier events.
86 *
87 * UNDER_VOLTAGE Regulator output is under voltage.
88 * OVER_CURRENT Regulator output current is too high.
89 * REGULATION_OUT Regulator output is out of regulation.
90 * FAIL Regulator output has failed.
91 * OVER_TEMP Regulator over temp.
84b68263 92 * FORCE_DISABLE Regulator forcibly shut down by software.
b136fb44 93 * VOLTAGE_CHANGE Regulator voltage changed.
84b68263 94 * DISABLE Regulator was disabled.
e2ce4eaa
LG		 95 *
96 * NOTE: These events can be OR'ed together when passed into handler.
97 */
98
99#define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
100#define REGULATOR_EVENT_OVER_CURRENT 0x02
101#define REGULATOR_EVENT_REGULATION_OUT 0x04
102#define REGULATOR_EVENT_FAIL 0x08
103#define REGULATOR_EVENT_OVER_TEMP 0x10
104#define REGULATOR_EVENT_FORCE_DISABLE 0x20
b136fb44 105#define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
84b68263 106#define REGULATOR_EVENT_DISABLE 0x80
e2ce4eaa
LG		 107
108struct regulator;
109
110/**
111 * struct regulator_bulk_data - Data used for bulk regulator operations.
112 *
69279fb9
MB		 113 * @supply: The name of the supply. Initialised by the user before
114 * using the bulk regulator APIs.
115 * @consumer: The regulator consumer for the supply. This will be managed
116 * by the bulk API.
e2ce4eaa
LG		 117 *
118 * The regulator APIs provide a series of regulator_bulk_() API calls as
119 * a convenience to consumers which require multiple supplies. This
120 * structure is used to manage data for these calls.
121 */
122struct regulator_bulk_data {
123 const char *supply;
124 struct regulator *consumer;
f21e0e81 125
bff747c5 126 /* private: Internal use */
f21e0e81 127 int ret;
e2ce4eaa
LG		 128};
129
130#if defined(CONFIG_REGULATOR)
131
132/* regulator get and put */
133struct regulator *__must_check regulator_get(struct device *dev,
134 const char *id);
070b9079
SB		 135struct regulator *__must_check devm_regulator_get(struct device *dev,
136 const char *id);
5ffbd136
MB		 137struct regulator *__must_check regulator_get_exclusive(struct device *dev,
138 const char *id);
e2ce4eaa 139void regulator_put(struct regulator *regulator);
d5ad34f7 140void devm_regulator_free(struct regulator *regulator);
e2ce4eaa
LG		 141
142/* regulator output control and status */
143int regulator_enable(struct regulator *regulator);
144int regulator_disable(struct regulator *regulator);
145int regulator_force_disable(struct regulator *regulator);
146int regulator_is_enabled(struct regulator *regulator);
da07ecd9 147int regulator_disable_deferred(struct regulator *regulator, int ms);
e2ce4eaa
LG		 148
149int regulator_bulk_get(struct device *dev, int num_consumers,
150 struct regulator_bulk_data *consumers);
e6e74030
MB		 151int devm_regulator_bulk_get(struct device *dev, int num_consumers,
152 struct regulator_bulk_data *consumers);
e2ce4eaa
LG		 153int regulator_bulk_enable(int num_consumers,
154 struct regulator_bulk_data *consumers);
155int regulator_bulk_disable(int num_consumers,
156 struct regulator_bulk_data *consumers);
e1de2f42
DK		 157int regulator_bulk_force_disable(int num_consumers,
158 struct regulator_bulk_data *consumers);
e2ce4eaa
LG		 159void regulator_bulk_free(int num_consumers,
160 struct regulator_bulk_data *consumers);
161
4367cfdc
DB		 162int regulator_count_voltages(struct regulator *regulator);
163int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90
MB		 164int regulator_is_supported_voltage(struct regulator *regulator,
165 int min_uV, int max_uV);
e2ce4eaa 166int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
88cd222b
LW		 167int regulator_set_voltage_time(struct regulator *regulator,
168 int old_uV, int new_uV);
e2ce4eaa 169int regulator_get_voltage(struct regulator *regulator);
606a2562 170int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa
LG		 171int regulator_set_current_limit(struct regulator *regulator,
172 int min_uA, int max_uA);
173int regulator_get_current_limit(struct regulator *regulator);
174
175int regulator_set_mode(struct regulator *regulator, unsigned int mode);
176unsigned int regulator_get_mode(struct regulator *regulator);
177int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
178
179/* regulator notifier block */
180int regulator_register_notifier(struct regulator *regulator,
181 struct notifier_block *nb);
182int regulator_unregister_notifier(struct regulator *regulator,
183 struct notifier_block *nb);
184
185/* driver data - core doesn't touch */
186void *regulator_get_drvdata(struct regulator *regulator);
187void regulator_set_drvdata(struct regulator *regulator, void *data);
188
189#else
190
191/*
192 * Make sure client drivers will still build on systems with no software
193 * controllable voltage or current regulators.
194 */
195static inline struct regulator *__must_check regulator_get(struct device *dev,
196 const char *id)
197{
198 /* Nothing except the stubbed out regulator API should be
199 * looking at the value except to check if it is an error
be1a50d4
JD		 200 * value. Drivers are free to handle NULL specifically by
201 * skipping all regulator API calls, but they don't have to.
202 * Drivers which don't, should make sure they properly handle
203 * corner cases of the API, such as regulator_get_voltage()
204 * returning 0.
e2ce4eaa 205 */
be1a50d4 206 return NULL;
e2ce4eaa 207}
070b9079
SB		 208
209static inline struct regulator *__must_check
210devm_regulator_get(struct device *dev, const char *id)
211{
212 return NULL;
213}
214
e2ce4eaa
LG		 215static inline void regulator_put(struct regulator *regulator)
216{
217}
218
219static inline int regulator_enable(struct regulator *regulator)
220{
221 return 0;
222}
223
224static inline int regulator_disable(struct regulator *regulator)
225{
226 return 0;
227}
228
935a5210
MH		 229static inline int regulator_force_disable(struct regulator *regulator)
230{
231 return 0;
232}
233
da07ecd9
MB		 234static inline int regulator_disable_deferred(struct regulator *regulator,
235 int ms)
236{
237 return 0;
238}
239
e2ce4eaa
LG		 240static inline int regulator_is_enabled(struct regulator *regulator)
241{
242 return 1;
243}
244
245static inline int regulator_bulk_get(struct device *dev,
246 int num_consumers,
247 struct regulator_bulk_data *consumers)
248{
249 return 0;
250}
251
e24abd6e
AL		 252static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
253 struct regulator_bulk_data *consumers)
254{
255 return 0;
256}
257
e2ce4eaa
LG		 258static inline int regulator_bulk_enable(int num_consumers,
259 struct regulator_bulk_data *consumers)
260{
261 return 0;
262}
263
264static inline int regulator_bulk_disable(int num_consumers,
265 struct regulator_bulk_data *consumers)
266{
267 return 0;
268}
269
e1de2f42
DK		 270static inline int regulator_bulk_force_disable(int num_consumers,
271 struct regulator_bulk_data *consumers)
272{
273 return 0;
274}
275
e2ce4eaa
LG		 276static inline void regulator_bulk_free(int num_consumers,
277 struct regulator_bulk_data *consumers)
278{
279}
280
281static inline int regulator_set_voltage(struct regulator *regulator,
282 int min_uV, int max_uV)
283{
284 return 0;
285}
286
287static inline int regulator_get_voltage(struct regulator *regulator)
288{
289 return 0;
290}
291
292static inline int regulator_set_current_limit(struct regulator *regulator,
293 int min_uA, int max_uA)
294{
295 return 0;
296}
297
298static inline int regulator_get_current_limit(struct regulator *regulator)
299{
300 return 0;
301}
302
303static inline int regulator_set_mode(struct regulator *regulator,
304 unsigned int mode)
305{
306 return 0;
307}
308
309static inline unsigned int regulator_get_mode(struct regulator *regulator)
310{
311 return REGULATOR_MODE_NORMAL;
312}
313
314static inline int regulator_set_optimum_mode(struct regulator *regulator,
315 int load_uA)
316{
317 return REGULATOR_MODE_NORMAL;
318}
319
320static inline int regulator_register_notifier(struct regulator *regulator,
321 struct notifier_block *nb)
322{
323 return 0;
324}
325
326static inline int regulator_unregister_notifier(struct regulator *regulator,
327 struct notifier_block *nb)
328{
329 return 0;
330}
331
332static inline void *regulator_get_drvdata(struct regulator *regulator)
333{
334 return NULL;
335}
336
337static inline void regulator_set_drvdata(struct regulator *regulator,
338 void *data)
339{
340}
341
342#endif
343
344#endif
Linux kernel - Deliverables
This page took 0.477821 seconds and 5 git commands to generate.