regulator: provide missing regulator_ stubs
[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 #include <linux/device.h>
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  * PRE_ENABLE     Regulator is to be enabled
97  * POST_ENABLE    Regulator was enabled
98  * OUT_PRECHANGE  Regulator is enabled and its voltage is to be changed
99  * OUT_POSTCHANGE Regulator is enabled and its voltage was changed
100  *
101  * NOTE: These events can be OR'ed together when passed into handler.
102  */
103
104 #define REGULATOR_EVENT_UNDER_VOLTAGE           0x01
105 #define REGULATOR_EVENT_OVER_CURRENT            0x02
106 #define REGULATOR_EVENT_REGULATION_OUT          0x04
107 #define REGULATOR_EVENT_FAIL                    0x08
108 #define REGULATOR_EVENT_OVER_TEMP               0x10
109 #define REGULATOR_EVENT_FORCE_DISABLE           0x20
110 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
111 #define REGULATOR_EVENT_DISABLE                 0x80
112 #define REGULATOR_EVENT_PRE_ENABLE              0x100
113 #define REGULATOR_EVENT_POST_ENABLE             0x200
114 #define REGULATOR_EVENT_OUT_PRECHANGE           0x400
115 #define REGULATOR_EVENT_OUT_POSTCHANGE          0x800
116
117 struct regulator;
118
119 /**
120  * struct regulator_bulk_data - Data used for bulk regulator operations.
121  *
122  * @supply:   The name of the supply.  Initialised by the user before
123  *            using the bulk regulator APIs.
124  * @consumer: The regulator consumer for the supply.  This will be managed
125  *            by the bulk API.
126  *
127  * The regulator APIs provide a series of regulator_bulk_() API calls as
128  * a convenience to consumers which require multiple supplies.  This
129  * structure is used to manage data for these calls.
130  */
131 struct regulator_bulk_data {
132         const char *supply;
133         struct regulator *consumer;
134
135         /* private: Internal use */
136         int ret;
137 };
138
139 #if defined(CONFIG_REGULATOR)
140
141 /* regulator get and put */
142 struct regulator *__must_check regulator_get(struct device *dev,
143                                              const char *id);
144 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
145                                                        const char *id);
146 void regulator_put(struct regulator *regulator);
147
148 /* regulator output control and status */
149 int regulator_enable(struct regulator *regulator);
150 int regulator_disable(struct regulator *regulator);
151 int regulator_force_disable(struct regulator *regulator);
152 int regulator_is_enabled(struct regulator *regulator);
153
154 int regulator_bulk_get(struct device *dev, int num_consumers,
155                        struct regulator_bulk_data *consumers);
156 int regulator_bulk_enable(int num_consumers,
157                           struct regulator_bulk_data *consumers);
158 int regulator_bulk_disable(int num_consumers,
159                            struct regulator_bulk_data *consumers);
160 void regulator_bulk_free(int num_consumers,
161                          struct regulator_bulk_data *consumers);
162
163 int regulator_count_voltages(struct regulator *regulator);
164 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
165 int regulator_is_supported_voltage(struct regulator *regulator,
166                                    int min_uV, int max_uV);
167 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
168 int regulator_set_voltage_time(struct regulator *regulator,
169                                int old_uV, int new_uV);
170 int regulator_get_voltage(struct regulator *regulator);
171 int regulator_sync_voltage(struct regulator *regulator);
172 int regulator_set_current_limit(struct regulator *regulator,
173                                int min_uA, int max_uA);
174 int regulator_get_current_limit(struct regulator *regulator);
175
176 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
177 unsigned int regulator_get_mode(struct regulator *regulator);
178 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
179
180 /* regulator notifier block */
181 int regulator_register_notifier(struct regulator *regulator,
182                               struct notifier_block *nb);
183 int regulator_unregister_notifier(struct regulator *regulator,
184                                 struct notifier_block *nb);
185
186 /* driver data - core doesn't touch */
187 void *regulator_get_drvdata(struct regulator *regulator);
188 void regulator_set_drvdata(struct regulator *regulator, void *data);
189
190 #else
191
192 /*
193  * Make sure client drivers will still build on systems with no software
194  * controllable voltage or current regulators.
195  */
196 static inline struct regulator *__must_check regulator_get(struct device *dev,
197         const char *id)
198 {
199         /* Nothing except the stubbed out regulator API should be
200          * looking at the value except to check if it is an error
201          * value. Drivers are free to handle NULL specifically by
202          * skipping all regulator API calls, but they don't have to.
203          * Drivers which don't, should make sure they properly handle
204          * corner cases of the API, such as regulator_get_voltage()
205          * returning 0.
206          */
207         return NULL;
208 }
209 static inline struct regulator *__must_check regulator_get_exclusive(
210                 struct device *dev, const char *id)
211 {
212         /* See comment for regulator_get() stub, above */
213         return NULL;
214 }
215 static inline void regulator_put(struct regulator *regulator)
216 {
217 }
218
219 static inline int regulator_enable(struct regulator *regulator)
220 {
221         return 0;
222 }
223
224 static inline int regulator_disable(struct regulator *regulator)
225 {
226         return 0;
227 }
228
229 static inline int regulator_force_disable(struct regulator *regulator)
230 {
231         return 0;
232 }
233
234 static inline int regulator_is_enabled(struct regulator *regulator)
235 {
236         return 1;
237 }
238
239 static inline int regulator_bulk_get(struct device *dev,
240                                      int num_consumers,
241                                      struct regulator_bulk_data *consumers)
242 {
243         return 0;
244 }
245
246 static inline int regulator_bulk_enable(int num_consumers,
247                                         struct regulator_bulk_data *consumers)
248 {
249         return 0;
250 }
251
252 static inline int regulator_bulk_disable(int num_consumers,
253                                          struct regulator_bulk_data *consumers)
254 {
255         return 0;
256 }
257
258 static inline void regulator_bulk_free(int num_consumers,
259                                        struct regulator_bulk_data *consumers)
260 {
261 }
262
263 static inline int regulator_count_voltages(struct regulator *regulator)
264 {
265         return 0;
266 }
267
268 static inline int regulator_list_voltage(struct regulator *regulator,
269                                          unsigned selector)
270 {
271         return 0;
272 }
273
274 static inline int regulator_is_supported_voltage(struct regulator *regulator,
275                                                  int min_uV, int max_uV)
276 {
277         return 0;
278 }
279
280 static inline int regulator_set_voltage(struct regulator *regulator,
281                                         int min_uV, int max_uV)
282 {
283         return 0;
284 }
285
286 static inline int regulator_set_voltage_time(struct regulator *regulator,
287                                              int old_uV, int new_uV)
288 {
289         return 0;
290 }
291
292 static inline int regulator_get_voltage(struct regulator *regulator)
293 {
294         return 0;
295 }
296
297 static inline int regulator_sync_voltage(struct regulator *regulator)
298 {
299         return 0;
300 }
301
302 static inline int regulator_set_current_limit(struct regulator *regulator,
303                                              int min_uA, int max_uA)
304 {
305         return 0;
306 }
307
308 static inline int regulator_get_current_limit(struct regulator *regulator)
309 {
310         return 0;
311 }
312
313 static inline int regulator_set_mode(struct regulator *regulator,
314         unsigned int mode)
315 {
316         return 0;
317 }
318
319 static inline unsigned int regulator_get_mode(struct regulator *regulator)
320 {
321         return REGULATOR_MODE_NORMAL;
322 }
323
324 static inline int regulator_set_optimum_mode(struct regulator *regulator,
325                                         int load_uA)
326 {
327         return REGULATOR_MODE_NORMAL;
328 }
329
330 static inline int regulator_register_notifier(struct regulator *regulator,
331                               struct notifier_block *nb)
332 {
333         return 0;
334 }
335
336 static inline int regulator_unregister_notifier(struct regulator *regulator,
337                                 struct notifier_block *nb)
338 {
339         return 0;
340 }
341
342 static inline void *regulator_get_drvdata(struct regulator *regulator)
343 {
344         return NULL;
345 }
346
347 static inline void regulator_set_drvdata(struct regulator *regulator,
348         void *data)
349 {
350 }
351
352 #endif
353
354 #endif