eaca73abdc17b1a1dbbee7871226b1e42b5e1e71
[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  * Copyright (C) 2012 NVIDIA Corporation
6  *
7  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License version 2 as
11  * published by the Free Software Foundation.
12  *
13  * Regulator Consumer Interface.
14  *
15  * A Power Management Regulator framework for SoC based devices.
16  * Features:-
17  *   o Voltage and current level control.
18  *   o Operating mode control.
19  *   o Regulator status.
20  *   o sysfs entries for showing client devices and status
21  *
22  * EXPERIMENTAL FEATURES:
23  *   Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
24  *   to use most efficient operating mode depending upon voltage and load and
25  *   is transparent to client drivers.
26  *
27  *   e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
28  *   IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
29  *   idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
30  *   but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
31  *   efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
32  *   in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
33  *
34  */
35
36 #ifndef __LINUX_REGULATOR_CONSUMER_H_
37 #define __LINUX_REGULATOR_CONSUMER_H_
38
39 struct device;
40 struct notifier_block;
41
42 /*
43  * Regulator operating modes.
44  *
45  * Regulators can run in a variety of different operating modes depending on
46  * output load. This allows further system power savings by selecting the
47  * best (and most efficient) regulator mode for a desired load.
48  *
49  * Most drivers will only care about NORMAL. The modes below are generic and
50  * will probably not match the naming convention of your regulator data sheet
51  * but should match the use cases in the datasheet.
52  *
53  * In order of power efficiency (least efficient at top).
54  *
55  *  Mode       Description
56  *  FAST       Regulator can handle fast changes in it's load.
57  *             e.g. useful in CPU voltage & frequency scaling where
58  *             load can quickly increase with CPU frequency increases.
59  *
60  *  NORMAL     Normal regulator power supply mode. Most drivers will
61  *             use this mode.
62  *
63  *  IDLE       Regulator runs in a more efficient mode for light
64  *             loads. Can be used for devices that have a low power
65  *             requirement during periods of inactivity. This mode
66  *             may be more noisy than NORMAL and may not be able
67  *             to handle fast load switching.
68  *
69  *  STANDBY    Regulator runs in the most efficient mode for very
70  *             light loads. Can be used by devices when they are
71  *             in a sleep/standby state. This mode is likely to be
72  *             the most noisy and may not be able to handle fast load
73  *             switching.
74  *
75  * NOTE: Most regulators will only support a subset of these modes. Some
76  * will only just support NORMAL.
77  *
78  * These modes can be OR'ed together to make up a mask of valid register modes.
79  */
80
81 #define REGULATOR_MODE_FAST                     0x1
82 #define REGULATOR_MODE_NORMAL                   0x2
83 #define REGULATOR_MODE_IDLE                     0x4
84 #define REGULATOR_MODE_STANDBY                  0x8
85
86 /*
87  * Regulator notifier events.
88  *
89  * UNDER_VOLTAGE  Regulator output is under voltage.
90  * OVER_CURRENT   Regulator output current is too high.
91  * REGULATION_OUT Regulator output is out of regulation.
92  * FAIL           Regulator output has failed.
93  * OVER_TEMP      Regulator over temp.
94  * FORCE_DISABLE  Regulator forcibly shut down by software.
95  * VOLTAGE_CHANGE Regulator voltage changed.
96  * DISABLE        Regulator was disabled.
97  * PRE_ENABLE     Regulator is to be enabled
98  * POST_ENABLE    Regulator was enabled
99  * OUT_PRECHANGE  Regulator is enabled and its voltage is to be changed
100  * OUT_POSTCHANGE Regulator is enabled and its voltage was changed
101  *
102  * NOTE: These events can be OR'ed together when passed into handler.
103  */
104
105 #define REGULATOR_EVENT_UNDER_VOLTAGE           0x01
106 #define REGULATOR_EVENT_OVER_CURRENT            0x02
107 #define REGULATOR_EVENT_REGULATION_OUT          0x04
108 #define REGULATOR_EVENT_FAIL                    0x08
109 #define REGULATOR_EVENT_OVER_TEMP               0x10
110 #define REGULATOR_EVENT_FORCE_DISABLE           0x20
111 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
112 #define REGULATOR_EVENT_DISABLE                 0x80
113 #define REGULATOR_EVENT_PRE_ENABLE              0x100
114 #define REGULATOR_EVENT_POST_ENABLE             0x200
115 #define REGULATOR_EVENT_OUT_PRECHANGE           0x400
116 #define REGULATOR_EVENT_OUT_POSTCHANGE          0x800
117
118 struct regulator;
119
120 /**
121  * struct regulator_bulk_data - Data used for bulk regulator operations.
122  *
123  * @supply:   The name of the supply.  Initialised by the user before
124  *            using the bulk regulator APIs.
125  * @consumer: The regulator consumer for the supply.  This will be managed
126  *            by the bulk API.
127  *
128  * The regulator APIs provide a series of regulator_bulk_() API calls as
129  * a convenience to consumers which require multiple supplies.  This
130  * structure is used to manage data for these calls.
131  */
132 struct regulator_bulk_data {
133         const char *supply;
134         struct regulator *consumer;
135
136         /* private: Internal use */
137         int ret;
138 };
139
140 #if defined(CONFIG_REGULATOR)
141
142 /* regulator get and put */
143 struct regulator *__must_check regulator_get(struct device *dev,
144                                              const char *id);
145 struct regulator *__must_check devm_regulator_get(struct device *dev,
146                                              const char *id);
147 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
148                                                        const char *id);
149 void regulator_put(struct regulator *regulator);
150 void devm_regulator_put(struct regulator *regulator);
151
152 /* regulator output control and status */
153 int regulator_enable(struct regulator *regulator);
154 int regulator_disable(struct regulator *regulator);
155 int regulator_force_disable(struct regulator *regulator);
156 int regulator_is_enabled(struct regulator *regulator);
157 int regulator_disable_deferred(struct regulator *regulator, int ms);
158
159 int regulator_bulk_get(struct device *dev, int num_consumers,
160                        struct regulator_bulk_data *consumers);
161 int devm_regulator_bulk_get(struct device *dev, int num_consumers,
162                             struct regulator_bulk_data *consumers);
163 int regulator_bulk_enable(int num_consumers,
164                           struct regulator_bulk_data *consumers);
165 int regulator_bulk_disable(int num_consumers,
166                            struct regulator_bulk_data *consumers);
167 int regulator_bulk_force_disable(int num_consumers,
168                            struct regulator_bulk_data *consumers);
169 void regulator_bulk_free(int num_consumers,
170                          struct regulator_bulk_data *consumers);
171
172 int regulator_count_voltages(struct regulator *regulator);
173 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
174 int regulator_is_supported_voltage(struct regulator *regulator,
175                                    int min_uV, int max_uV);
176 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
177 int regulator_set_voltage_time(struct regulator *regulator,
178                                int old_uV, int new_uV);
179 int regulator_get_voltage(struct regulator *regulator);
180 int regulator_sync_voltage(struct regulator *regulator);
181 int regulator_set_current_limit(struct regulator *regulator,
182                                int min_uA, int max_uA);
183 int regulator_get_current_limit(struct regulator *regulator);
184
185 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
186 unsigned int regulator_get_mode(struct regulator *regulator);
187 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
188
189 /* regulator notifier block */
190 int regulator_register_notifier(struct regulator *regulator,
191                               struct notifier_block *nb);
192 int regulator_unregister_notifier(struct regulator *regulator,
193                                 struct notifier_block *nb);
194
195 /* driver data - core doesn't touch */
196 void *regulator_get_drvdata(struct regulator *regulator);
197 void regulator_set_drvdata(struct regulator *regulator, void *data);
198
199 #else
200
201 /*
202  * Make sure client drivers will still build on systems with no software
203  * controllable voltage or current regulators.
204  */
205 static inline struct regulator *__must_check regulator_get(struct device *dev,
206         const char *id)
207 {
208         /* Nothing except the stubbed out regulator API should be
209          * looking at the value except to check if it is an error
210          * value. Drivers are free to handle NULL specifically by
211          * skipping all regulator API calls, but they don't have to.
212          * Drivers which don't, should make sure they properly handle
213          * corner cases of the API, such as regulator_get_voltage()
214          * returning 0.
215          */
216         return NULL;
217 }
218
219 static inline struct regulator *__must_check regulator_get_exclusive(
220                 struct device *dev, const char *id)
221 {
222         /* See comment for regulator_get() stub, above */
223         return NULL;
224 }
225
226 static inline struct regulator *__must_check
227 devm_regulator_get(struct device *dev, const char *id)
228 {
229         return NULL;
230 }
231
232 static inline void regulator_put(struct regulator *regulator)
233 {
234 }
235
236 static inline void devm_regulator_put(struct regulator *regulator)
237 {
238 }
239
240 static inline int regulator_enable(struct regulator *regulator)
241 {
242         return 0;
243 }
244
245 static inline int regulator_disable(struct regulator *regulator)
246 {
247         return 0;
248 }
249
250 static inline int regulator_force_disable(struct regulator *regulator)
251 {
252         return 0;
253 }
254
255 static inline int regulator_disable_deferred(struct regulator *regulator,
256                                              int ms)
257 {
258         return 0;
259 }
260
261 static inline int regulator_force_disable(struct regulator *regulator)
262 {
263         return 0;
264 }
265
266 static inline int regulator_is_enabled(struct regulator *regulator)
267 {
268         return 1;
269 }
270
271 static inline int regulator_bulk_get(struct device *dev,
272                                      int num_consumers,
273                                      struct regulator_bulk_data *consumers)
274 {
275         return 0;
276 }
277
278 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
279                                           struct regulator_bulk_data *consumers)
280 {
281         return 0;
282 }
283
284 static inline int regulator_bulk_enable(int num_consumers,
285                                         struct regulator_bulk_data *consumers)
286 {
287         return 0;
288 }
289
290 static inline int regulator_bulk_disable(int num_consumers,
291                                          struct regulator_bulk_data *consumers)
292 {
293         return 0;
294 }
295
296 static inline int regulator_bulk_force_disable(int num_consumers,
297                                         struct regulator_bulk_data *consumers)
298 {
299         return 0;
300 }
301
302 static inline void regulator_bulk_free(int num_consumers,
303                                        struct regulator_bulk_data *consumers)
304 {
305 }
306
307 static inline int regulator_count_voltages(struct regulator *regulator)
308 {
309         return 0;
310 }
311
312 static inline int regulator_list_voltage(struct regulator *regulator,
313                                          unsigned selector)
314 {
315         return 0;
316 }
317
318 static inline int regulator_is_supported_voltage(struct regulator *regulator,
319                                                  int min_uV, int max_uV)
320 {
321         return 0;
322 }
323
324 static inline int regulator_set_voltage(struct regulator *regulator,
325                                         int min_uV, int max_uV)
326 {
327         return 0;
328 }
329
330 static inline int regulator_set_voltage_time(struct regulator *regulator,
331                                              int old_uV, int new_uV)
332 {
333         return 0;
334 }
335
336 static inline int regulator_get_voltage(struct regulator *regulator)
337 {
338         return 0;
339 }
340
341 static inline int regulator_sync_voltage(struct regulator *regulator)
342 {
343         return 0;
344 }
345
346 static inline int regulator_set_current_limit(struct regulator *regulator,
347                                              int min_uA, int max_uA)
348 {
349         return 0;
350 }
351
352 static inline int regulator_get_current_limit(struct regulator *regulator)
353 {
354         return 0;
355 }
356
357 static inline int regulator_set_mode(struct regulator *regulator,
358         unsigned int mode)
359 {
360         return 0;
361 }
362
363 static inline unsigned int regulator_get_mode(struct regulator *regulator)
364 {
365         return REGULATOR_MODE_NORMAL;
366 }
367
368 static inline int regulator_set_optimum_mode(struct regulator *regulator,
369                                         int load_uA)
370 {
371         return REGULATOR_MODE_NORMAL;
372 }
373
374 static inline int regulator_register_notifier(struct regulator *regulator,
375                               struct notifier_block *nb)
376 {
377         return 0;
378 }
379
380 static inline int regulator_unregister_notifier(struct regulator *regulator,
381                                 struct notifier_block *nb)
382 {
383         return 0;
384 }
385
386 static inline void *regulator_get_drvdata(struct regulator *regulator)
387 {
388         return NULL;
389 }
390
391 static inline void regulator_set_drvdata(struct regulator *regulator,
392         void *data)
393 {
394 }
395
396 #endif
397
398 #endif