regulator: Add regulator_get_exclusive() API
[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 /*
39  * Regulator operating modes.
40  *
41  * Regulators can run in a variety of different operating modes depending on
42  * output load. This allows further system power savings by selecting the
43  * best (and most efficient) regulator mode for a desired load.
44  *
45  * Most drivers will only care about NORMAL. The modes below are generic and
46  * will probably not match the naming convention of your regulator data sheet
47  * but should match the use cases in the datasheet.
48  *
49  * In order of power efficiency (least efficient at top).
50  *
51  *  Mode       Description
52  *  FAST       Regulator can handle fast changes in it's load.
53  *             e.g. useful in CPU voltage & frequency scaling where
54  *             load can quickly increase with CPU frequency increases.
55  *
56  *  NORMAL     Normal regulator power supply mode. Most drivers will
57  *             use this mode.
58  *
59  *  IDLE       Regulator runs in a more efficient mode for light
60  *             loads. Can be used for devices that have a low power
61  *             requirement during periods of inactivity. This mode
62  *             may be more noisy than NORMAL and may not be able
63  *             to handle fast load switching.
64  *
65  *  STANDBY    Regulator runs in the most efficient mode for very
66  *             light loads. Can be used by devices when they are
67  *             in a sleep/standby state. This mode is likely to be
68  *             the most noisy and may not be able to handle fast load
69  *             switching.
70  *
71  * NOTE: Most regulators will only support a subset of these modes. Some
72  * will only just support NORMAL.
73  *
74  * These modes can be OR'ed together to make up a mask of valid register modes.
75  */
76
77 #define REGULATOR_MODE_FAST                     0x1
78 #define REGULATOR_MODE_NORMAL                   0x2
79 #define REGULATOR_MODE_IDLE                     0x4
80 #define REGULATOR_MODE_STANDBY                  0x8
81
82 /*
83  * Regulator notifier events.
84  *
85  * UNDER_VOLTAGE  Regulator output is under voltage.
86  * OVER_CURRENT   Regulator output current is too high.
87  * REGULATION_OUT Regulator output is out of regulation.
88  * FAIL           Regulator output has failed.
89  * OVER_TEMP      Regulator over temp.
90  * FORCE_DISABLE  Regulator shut down by software.
91  * VOLTAGE_CHANGE Regulator voltage changed.
92  *
93  * NOTE: These events can be OR'ed together when passed into handler.
94  */
95
96 #define REGULATOR_EVENT_UNDER_VOLTAGE           0x01
97 #define REGULATOR_EVENT_OVER_CURRENT            0x02
98 #define REGULATOR_EVENT_REGULATION_OUT          0x04
99 #define REGULATOR_EVENT_FAIL                    0x08
100 #define REGULATOR_EVENT_OVER_TEMP               0x10
101 #define REGULATOR_EVENT_FORCE_DISABLE           0x20
102 #define REGULATOR_EVENT_VOLTAGE_CHANGE          0x40
103
104 struct regulator;
105
106 /**
107  * struct regulator_bulk_data - Data used for bulk regulator operations.
108  *
109  * @supply:   The name of the supply.  Initialised by the user before
110  *            using the bulk regulator APIs.
111  * @consumer: The regulator consumer for the supply.  This will be managed
112  *            by the bulk API.
113  *
114  * The regulator APIs provide a series of regulator_bulk_() API calls as
115  * a convenience to consumers which require multiple supplies.  This
116  * structure is used to manage data for these calls.
117  */
118 struct regulator_bulk_data {
119         const char *supply;
120         struct regulator *consumer;
121 };
122
123 #if defined(CONFIG_REGULATOR)
124
125 /* regulator get and put */
126 struct regulator *__must_check regulator_get(struct device *dev,
127                                              const char *id);
128 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
129                                                        const char *id);
130 void regulator_put(struct regulator *regulator);
131
132 /* regulator output control and status */
133 int regulator_enable(struct regulator *regulator);
134 int regulator_disable(struct regulator *regulator);
135 int regulator_force_disable(struct regulator *regulator);
136 int regulator_is_enabled(struct regulator *regulator);
137
138 int regulator_bulk_get(struct device *dev, int num_consumers,
139                        struct regulator_bulk_data *consumers);
140 int regulator_bulk_enable(int num_consumers,
141                           struct regulator_bulk_data *consumers);
142 int regulator_bulk_disable(int num_consumers,
143                            struct regulator_bulk_data *consumers);
144 void regulator_bulk_free(int num_consumers,
145                          struct regulator_bulk_data *consumers);
146
147 int regulator_count_voltages(struct regulator *regulator);
148 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
149 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
150 int regulator_get_voltage(struct regulator *regulator);
151 int regulator_set_current_limit(struct regulator *regulator,
152                                int min_uA, int max_uA);
153 int regulator_get_current_limit(struct regulator *regulator);
154
155 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
156 unsigned int regulator_get_mode(struct regulator *regulator);
157 int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
158
159 /* regulator notifier block */
160 int regulator_register_notifier(struct regulator *regulator,
161                               struct notifier_block *nb);
162 int regulator_unregister_notifier(struct regulator *regulator,
163                                 struct notifier_block *nb);
164
165 /* driver data - core doesn't touch */
166 void *regulator_get_drvdata(struct regulator *regulator);
167 void regulator_set_drvdata(struct regulator *regulator, void *data);
168
169 #else
170
171 /*
172  * Make sure client drivers will still build on systems with no software
173  * controllable voltage or current regulators.
174  */
175 static inline struct regulator *__must_check regulator_get(struct device *dev,
176         const char *id)
177 {
178         /* Nothing except the stubbed out regulator API should be
179          * looking at the value except to check if it is an error
180          * value so the actual return value doesn't matter.
181          */
182         return (struct regulator *)id;
183 }
184 static inline void regulator_put(struct regulator *regulator)
185 {
186 }
187
188 static inline int regulator_enable(struct regulator *regulator)
189 {
190         return 0;
191 }
192
193 static inline int regulator_disable(struct regulator *regulator)
194 {
195         return 0;
196 }
197
198 static inline int regulator_is_enabled(struct regulator *regulator)
199 {
200         return 1;
201 }
202
203 static inline int regulator_bulk_get(struct device *dev,
204                                      int num_consumers,
205                                      struct regulator_bulk_data *consumers)
206 {
207         return 0;
208 }
209
210 static inline int regulator_bulk_enable(int num_consumers,
211                                         struct regulator_bulk_data *consumers)
212 {
213         return 0;
214 }
215
216 static inline int regulator_bulk_disable(int num_consumers,
217                                          struct regulator_bulk_data *consumers)
218 {
219         return 0;
220 }
221
222 static inline void regulator_bulk_free(int num_consumers,
223                                        struct regulator_bulk_data *consumers)
224 {
225 }
226
227 static inline int regulator_set_voltage(struct regulator *regulator,
228                                         int min_uV, int max_uV)
229 {
230         return 0;
231 }
232
233 static inline int regulator_get_voltage(struct regulator *regulator)
234 {
235         return 0;
236 }
237
238 static inline int regulator_set_current_limit(struct regulator *regulator,
239                                              int min_uA, int max_uA)
240 {
241         return 0;
242 }
243
244 static inline int regulator_get_current_limit(struct regulator *regulator)
245 {
246         return 0;
247 }
248
249 static inline int regulator_set_mode(struct regulator *regulator,
250         unsigned int mode)
251 {
252         return 0;
253 }
254
255 static inline unsigned int regulator_get_mode(struct regulator *regulator)
256 {
257         return REGULATOR_MODE_NORMAL;
258 }
259
260 static inline int regulator_set_optimum_mode(struct regulator *regulator,
261                                         int load_uA)
262 {
263         return REGULATOR_MODE_NORMAL;
264 }
265
266 static inline int regulator_register_notifier(struct regulator *regulator,
267                               struct notifier_block *nb)
268 {
269         return 0;
270 }
271
272 static inline int regulator_unregister_notifier(struct regulator *regulator,
273                                 struct notifier_block *nb)
274 {
275         return 0;
276 }
277
278 static inline void *regulator_get_drvdata(struct regulator *regulator)
279 {
280         return NULL;
281 }
282
283 static inline void regulator_set_drvdata(struct regulator *regulator,
284         void *data)
285 {
286 }
287
288 #endif
289
290 #endif