blob: 26f6ea4444e39fedda935b5505439a6de3301f41 [file] [log] [blame]
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +01001/*
2 * consumer.h -- SoC Regulator consumer support.
3 *
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
5 *
Liam Girdwood1dd68f02009-02-02 21:43:31 +00006 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +01007 *
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
Liam Girdwoodb56daf12009-11-11 14:16:10 +000038#include <linux/device.h>
39
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +010040/*
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.
Mark Brown84b68262009-12-01 21:12:27 +000092 * FORCE_DISABLE Regulator forcibly shut down by software.
Jonathan Cameronb136fb42009-01-19 18:20:58 +000093 * VOLTAGE_CHANGE Regulator voltage changed.
Mark Brown84b68262009-12-01 21:12:27 +000094 * DISABLE Regulator was disabled.
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +010095 *
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
Jonathan Cameronb136fb42009-01-19 18:20:58 +0000105#define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
Mark Brown84b68262009-12-01 21:12:27 +0000106#define REGULATOR_EVENT_DISABLE 0x80
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100107
108struct regulator;
109
110/**
111 * struct regulator_bulk_data - Data used for bulk regulator operations.
112 *
Mark Brown69279fb2008-12-31 12:52:41 +0000113 * @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.
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100117 *
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;
Mark Brownf21e0e82011-05-24 08:12:40 +0800125
126 /* Internal use */
127 int ret;
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100128};
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);
Mark Brown5ffbd132009-07-21 16:00:23 +0100135struct regulator *__must_check regulator_get_exclusive(struct device *dev,
136 const char *id);
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100137void regulator_put(struct regulator *regulator);
138
139/* regulator output control and status */
140int regulator_enable(struct regulator *regulator);
141int regulator_disable(struct regulator *regulator);
142int regulator_force_disable(struct regulator *regulator);
143int regulator_is_enabled(struct regulator *regulator);
144
145int regulator_bulk_get(struct device *dev, int num_consumers,
146 struct regulator_bulk_data *consumers);
147int regulator_bulk_enable(int num_consumers,
148 struct regulator_bulk_data *consumers);
149int regulator_bulk_disable(int num_consumers,
150 struct regulator_bulk_data *consumers);
151void regulator_bulk_free(int num_consumers,
152 struct regulator_bulk_data *consumers);
153
David Brownell4367cfd2009-02-26 11:48:36 -0800154int regulator_count_voltages(struct regulator *regulator);
155int regulator_list_voltage(struct regulator *regulator, unsigned selector);
Mark Browna7a1ad92009-07-21 16:00:24 +0100156int regulator_is_supported_voltage(struct regulator *regulator,
157 int min_uV, int max_uV);
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100158int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
Linus Walleij88cd222b2011-03-17 13:24:52 +0100159int regulator_set_voltage_time(struct regulator *regulator,
160 int old_uV, int new_uV);
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100161int regulator_get_voltage(struct regulator *regulator);
Mark Brown606a2562010-12-16 15:49:36 +0000162int regulator_sync_voltage(struct regulator *regulator);
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100163int regulator_set_current_limit(struct regulator *regulator,
164 int min_uA, int max_uA);
165int regulator_get_current_limit(struct regulator *regulator);
166
167int regulator_set_mode(struct regulator *regulator, unsigned int mode);
168unsigned int regulator_get_mode(struct regulator *regulator);
169int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
170
171/* regulator notifier block */
172int regulator_register_notifier(struct regulator *regulator,
173 struct notifier_block *nb);
174int regulator_unregister_notifier(struct regulator *regulator,
175 struct notifier_block *nb);
176
177/* driver data - core doesn't touch */
178void *regulator_get_drvdata(struct regulator *regulator);
179void regulator_set_drvdata(struct regulator *regulator, void *data);
180
181#else
182
183/*
184 * Make sure client drivers will still build on systems with no software
185 * controllable voltage or current regulators.
186 */
187static inline struct regulator *__must_check regulator_get(struct device *dev,
188 const char *id)
189{
190 /* Nothing except the stubbed out regulator API should be
191 * looking at the value except to check if it is an error
Jean Delvarebe1a50d2010-04-03 17:37:45 +0200192 * value. Drivers are free to handle NULL specifically by
193 * skipping all regulator API calls, but they don't have to.
194 * Drivers which don't, should make sure they properly handle
195 * corner cases of the API, such as regulator_get_voltage()
196 * returning 0.
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100197 */
Jean Delvarebe1a50d2010-04-03 17:37:45 +0200198 return NULL;
Liam Girdwoode2ce4eaa2008-04-30 15:10:07 +0100199}
200static inline void regulator_put(struct regulator *regulator)
201{
202}
203
204static inline int regulator_enable(struct regulator *regulator)
205{
206 return 0;
207}
208
209static inline int regulator_disable(struct regulator *regulator)
210{
211 return 0;
212}
213
214static inline int regulator_is_enabled(struct regulator *regulator)
215{
216 return 1;
217}
218
219static inline int regulator_bulk_get(struct device *dev,
220 int num_consumers,
221 struct regulator_bulk_data *consumers)
222{
223 return 0;
224}
225
226static inline int regulator_bulk_enable(int num_consumers,
227 struct regulator_bulk_data *consumers)
228{
229 return 0;
230}
231
232static inline int regulator_bulk_disable(int num_consumers,
233 struct regulator_bulk_data *consumers)
234{
235 return 0;
236}
237
238static inline void regulator_bulk_free(int num_consumers,
239 struct regulator_bulk_data *consumers)
240{
241}
242
243static inline int regulator_set_voltage(struct regulator *regulator,
244 int min_uV, int max_uV)
245{
246 return 0;
247}
248
249static inline int regulator_get_voltage(struct regulator *regulator)
250{
251 return 0;
252}
253
254static inline int regulator_set_current_limit(struct regulator *regulator,
255 int min_uA, int max_uA)
256{
257 return 0;
258}
259
260static inline int regulator_get_current_limit(struct regulator *regulator)
261{
262 return 0;
263}
264
265static inline int regulator_set_mode(struct regulator *regulator,
266 unsigned int mode)
267{
268 return 0;
269}
270
271static inline unsigned int regulator_get_mode(struct regulator *regulator)
272{
273 return REGULATOR_MODE_NORMAL;
274}
275
276static inline int regulator_set_optimum_mode(struct regulator *regulator,
277 int load_uA)
278{
279 return REGULATOR_MODE_NORMAL;
280}
281
282static inline int regulator_register_notifier(struct regulator *regulator,
283 struct notifier_block *nb)
284{
285 return 0;
286}
287
288static inline int regulator_unregister_notifier(struct regulator *regulator,
289 struct notifier_block *nb)
290{
291 return 0;
292}
293
294static inline void *regulator_get_drvdata(struct regulator *regulator)
295{
296 return NULL;
297}
298
299static inline void regulator_set_drvdata(struct regulator *regulator,
300 void *data)
301{
302}
303
304#endif
305
306#endif