device.h: audit and cleanup users in main include dir
[linux-2.6.git] / include / linux / regulator / consumer.h
1 /*
2  * consumer.h -- SoC Regulator consumer support.
3  *
4  * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
5  *
6  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
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
38 struct device;
39 struct notifier_block;
40
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.
93  * FORCE_DISABLE  Regulator forcibly shut down by software.
94  * VOLTAGE_CHANGE Regulator voltage changed.
95  * DISABLE        Regulator was disabled.
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
106 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
107 #define REGULATOR_EVENT_DISABLE                 0x80
108
109 struct regulator;
110
111 /**
112  * struct regulator_bulk_data - Data used for bulk regulator operations.
113  *
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.
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  */
123 struct regulator_bulk_data {
124         const char *supply;
125         struct regulator *consumer;
126
127         /* private: Internal use */
128         int ret;
129 };
130
131 #if defined(CONFIG_REGULATOR)
132
133 /* regulator get and put */
134 struct regulator *__must_check regulator_get(struct device *dev,
135                                              const char *id);
136 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
137                                                        const char *id);
138 void regulator_put(struct regulator *regulator);
139
140 /* regulator output control and status */
141 int regulator_enable(struct regulator *regulator);
142 int regulator_disable(struct regulator *regulator);
143 int regulator_force_disable(struct regulator *regulator);
144 int regulator_is_enabled(struct regulator *regulator);
145 int regulator_disable_deferred(struct regulator *regulator, int ms);
146
147 int regulator_bulk_get(struct device *dev, int num_consumers,
148                        struct regulator_bulk_data *consumers);
149 int regulator_bulk_enable(int num_consumers,
150                           struct regulator_bulk_data *consumers);
151 int regulator_bulk_disable(int num_consumers,
152                            struct regulator_bulk_data *consumers);
153 int regulator_bulk_force_disable(int num_consumers,
154                            struct regulator_bulk_data *consumers);
155 void regulator_bulk_free(int num_consumers,
156                          struct regulator_bulk_data *consumers);
157
158 int regulator_count_voltages(struct regulator *regulator);
159 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
160 int regulator_is_supported_voltage(struct regulator *regulator,
161                                    int min_uV, int max_uV);
162 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
163 int regulator_set_voltage_time(struct regulator *regulator,
164                                int old_uV, int new_uV);
165 int regulator_get_voltage(struct regulator *regulator);
166 int regulator_sync_voltage(struct regulator *regulator);
167 int regulator_set_current_limit(struct regulator *regulator,
168                                int min_uA, int max_uA);
169 int regulator_get_current_limit(struct regulator *regulator);
170
171 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
172 unsigned int regulator_get_mode(struct regulator *regulator);
173 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
174
175 /* regulator notifier block */
176 int regulator_register_notifier(struct regulator *regulator,
177                               struct notifier_block *nb);
178 int regulator_unregister_notifier(struct regulator *regulator,
179                                 struct notifier_block *nb);
180
181 /* driver data - core doesn't touch */
182 void *regulator_get_drvdata(struct regulator *regulator);
183 void regulator_set_drvdata(struct regulator *regulator, void *data);
184
185 #else
186
187 /*
188  * Make sure client drivers will still build on systems with no software
189  * controllable voltage or current regulators.
190  */
191 static inline struct regulator *__must_check regulator_get(struct device *dev,
192         const char *id)
193 {
194         /* Nothing except the stubbed out regulator API should be
195          * looking at the value except to check if it is an error
196          * value. Drivers are free to handle NULL specifically by
197          * skipping all regulator API calls, but they don't have to.
198          * Drivers which don't, should make sure they properly handle
199          * corner cases of the API, such as regulator_get_voltage()
200          * returning 0.
201          */
202         return NULL;
203 }
204 static inline void regulator_put(struct regulator *regulator)
205 {
206 }
207
208 static inline int regulator_enable(struct regulator *regulator)
209 {
210         return 0;
211 }
212
213 static inline int regulator_disable(struct regulator *regulator)
214 {
215         return 0;
216 }
217
218 static inline int regulator_force_disable(struct regulator *regulator)
219 {
220         return 0;
221 }
222
223 static inline int regulator_disable_deferred(struct regulator *regulator,
224                                              int ms)
225 {
226         return 0;
227 }
228
229 static inline int regulator_is_enabled(struct regulator *regulator)
230 {
231         return 1;
232 }
233
234 static inline int regulator_bulk_get(struct device *dev,
235                                      int num_consumers,
236                                      struct regulator_bulk_data *consumers)
237 {
238         return 0;
239 }
240
241 static inline int regulator_bulk_enable(int num_consumers,
242                                         struct regulator_bulk_data *consumers)
243 {
244         return 0;
245 }
246
247 static inline int regulator_bulk_disable(int num_consumers,
248                                          struct regulator_bulk_data *consumers)
249 {
250         return 0;
251 }
252
253 static inline int regulator_bulk_force_disable(int num_consumers,
254                                         struct regulator_bulk_data *consumers)
255 {
256         return 0;
257 }
258
259 static inline void regulator_bulk_free(int num_consumers,
260                                        struct regulator_bulk_data *consumers)
261 {
262 }
263
264 static inline int regulator_set_voltage(struct regulator *regulator,
265                                         int min_uV, int max_uV)
266 {
267         return 0;
268 }
269
270 static inline int regulator_get_voltage(struct regulator *regulator)
271 {
272         return 0;
273 }
274
275 static inline int regulator_set_current_limit(struct regulator *regulator,
276                                              int min_uA, int max_uA)
277 {
278         return 0;
279 }
280
281 static inline int regulator_get_current_limit(struct regulator *regulator)
282 {
283         return 0;
284 }
285
286 static inline int regulator_set_mode(struct regulator *regulator,
287         unsigned int mode)
288 {
289         return 0;
290 }
291
292 static inline unsigned int regulator_get_mode(struct regulator *regulator)
293 {
294         return REGULATOR_MODE_NORMAL;
295 }
296
297 static inline int regulator_set_optimum_mode(struct regulator *regulator,
298                                         int load_uA)
299 {
300         return REGULATOR_MODE_NORMAL;
301 }
302
303 static inline int regulator_register_notifier(struct regulator *regulator,
304                               struct notifier_block *nb)
305 {
306         return 0;
307 }
308
309 static inline int regulator_unregister_notifier(struct regulator *regulator,
310                                 struct notifier_block *nb)
311 {
312         return 0;
313 }
314
315 static inline void *regulator_get_drvdata(struct regulator *regulator)
316 {
317         return NULL;
318 }
319
320 static inline void regulator_set_drvdata(struct regulator *regulator,
321         void *data)
322 {
323 }
324
325 #endif
326
327 #endif