projects / deliverable / linux.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
regulator: Implement devm_regulator_free()
[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);
151int regulator_bulk_enable(int num_consumers,
152 struct regulator_bulk_data *consumers);
153int regulator_bulk_disable(int num_consumers,
154 struct regulator_bulk_data *consumers);
e1de2f42
DK		 155int regulator_bulk_force_disable(int num_consumers,
156 struct regulator_bulk_data *consumers);
e2ce4eaa
LG		 157void regulator_bulk_free(int num_consumers,
158 struct regulator_bulk_data *consumers);
159
4367cfdc
DB		 160int regulator_count_voltages(struct regulator *regulator);
161int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90
MB		 162int regulator_is_supported_voltage(struct regulator *regulator,
163 int min_uV, int max_uV);
e2ce4eaa 164int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
88cd222b
LW		 165int regulator_set_voltage_time(struct regulator *regulator,
166 int old_uV, int new_uV);
e2ce4eaa 167int regulator_get_voltage(struct regulator *regulator);
606a2562 168int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa
LG		 169int regulator_set_current_limit(struct regulator *regulator,
170 int min_uA, int max_uA);
171int regulator_get_current_limit(struct regulator *regulator);
172
173int regulator_set_mode(struct regulator *regulator, unsigned int mode);
174unsigned int regulator_get_mode(struct regulator *regulator);
175int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
176
177/* regulator notifier block */
178int regulator_register_notifier(struct regulator *regulator,
179 struct notifier_block *nb);
180int regulator_unregister_notifier(struct regulator *regulator,
181 struct notifier_block *nb);
182
183/* driver data - core doesn't touch */
184void *regulator_get_drvdata(struct regulator *regulator);
185void regulator_set_drvdata(struct regulator *regulator, void *data);
186
187#else
188
189/*
190 * Make sure client drivers will still build on systems with no software
191 * controllable voltage or current regulators.
192 */
193static inline struct regulator *__must_check regulator_get(struct device *dev,
194 const char *id)
195{
196 /* Nothing except the stubbed out regulator API should be
197 * looking at the value except to check if it is an error
be1a50d4
JD		 198 * value. Drivers are free to handle NULL specifically by
199 * skipping all regulator API calls, but they don't have to.
200 * Drivers which don't, should make sure they properly handle
201 * corner cases of the API, such as regulator_get_voltage()
202 * returning 0.
e2ce4eaa 203 */
be1a50d4 204 return NULL;
e2ce4eaa 205}
070b9079
SB		 206
207static inline struct regulator *__must_check
208devm_regulator_get(struct device *dev, const char *id)
209{
210 return NULL;
211}
212
e2ce4eaa
LG		 213static inline void regulator_put(struct regulator *regulator)
214{
215}
216
217static inline int regulator_enable(struct regulator *regulator)
218{
219 return 0;
220}
221
222static inline int regulator_disable(struct regulator *regulator)
223{
224 return 0;
225}
226
935a5210
MH		 227static inline int regulator_force_disable(struct regulator *regulator)
228{
229 return 0;
230}
231
da07ecd9
MB		 232static inline int regulator_disable_deferred(struct regulator *regulator,
233 int ms)
234{
235 return 0;
236}
237
e2ce4eaa
LG		 238static inline int regulator_is_enabled(struct regulator *regulator)
239{
240 return 1;
241}
242
243static inline int regulator_bulk_get(struct device *dev,
244 int num_consumers,
245 struct regulator_bulk_data *consumers)
246{
247 return 0;
248}
249
250static inline int regulator_bulk_enable(int num_consumers,
251 struct regulator_bulk_data *consumers)
252{
253 return 0;
254}
255
256static inline int regulator_bulk_disable(int num_consumers,
257 struct regulator_bulk_data *consumers)
258{
259 return 0;
260}
261
e1de2f42
DK		 262static inline int regulator_bulk_force_disable(int num_consumers,
263 struct regulator_bulk_data *consumers)
264{
265 return 0;
266}
267
e2ce4eaa
LG		 268static inline void regulator_bulk_free(int num_consumers,
269 struct regulator_bulk_data *consumers)
270{
271}
272
273static inline int regulator_set_voltage(struct regulator *regulator,
274 int min_uV, int max_uV)
275{
276 return 0;
277}
278
279static inline int regulator_get_voltage(struct regulator *regulator)
280{
281 return 0;
282}
283
284static inline int regulator_set_current_limit(struct regulator *regulator,
285 int min_uA, int max_uA)
286{
287 return 0;
288}
289
290static inline int regulator_get_current_limit(struct regulator *regulator)
291{
292 return 0;
293}
294
295static inline int regulator_set_mode(struct regulator *regulator,
296 unsigned int mode)
297{
298 return 0;
299}
300
301static inline unsigned int regulator_get_mode(struct regulator *regulator)
302{
303 return REGULATOR_MODE_NORMAL;
304}
305
306static inline int regulator_set_optimum_mode(struct regulator *regulator,
307 int load_uA)
308{
309 return REGULATOR_MODE_NORMAL;
310}
311
312static inline int regulator_register_notifier(struct regulator *regulator,
313 struct notifier_block *nb)
314{
315 return 0;
316}
317
318static inline int regulator_unregister_notifier(struct regulator *regulator,
319 struct notifier_block *nb)
320{
321 return 0;
322}
323
324static inline void *regulator_get_drvdata(struct regulator *regulator)
325{
326 return NULL;
327}
328
329static inline void regulator_set_drvdata(struct regulator *regulator,
330 void *data)
331{
332}
333
334#endif
335
336#endif
Linux kernel - Deliverables
This page took 0.482862 seconds and 5 git commands to generate.