Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
104struct 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 */
118struct regulator_bulk_data {
119 const char *supply;
120 struct regulator *consumer;
121};
122
123#if defined(CONFIG_REGULATOR)
124
125/* regulator get and put */
126struct regulator *__must_check regulator_get(struct device *dev,
127 const char *id);
128struct regulator *__must_check regulator_get_exclusive(struct device *dev,
129 const char *id);
130void regulator_put(struct regulator *regulator);
131
132/* regulator output control and status */
133int regulator_enable(struct regulator *regulator);
134int regulator_disable(struct regulator *regulator);
135int regulator_force_disable(struct regulator *regulator);
136int regulator_is_enabled(struct regulator *regulator);
137
138int regulator_bulk_get(struct device *dev, int num_consumers,
139 struct regulator_bulk_data *consumers);
140int regulator_bulk_enable(int num_consumers,
141 struct regulator_bulk_data *consumers);
142int regulator_bulk_disable(int num_consumers,
143 struct regulator_bulk_data *consumers);
144void regulator_bulk_free(int num_consumers,
145 struct regulator_bulk_data *consumers);
146
147int regulator_count_voltages(struct regulator *regulator);
148int regulator_list_voltage(struct regulator *regulator, unsigned selector);
149int regulator_is_supported_voltage(struct regulator *regulator,
150 int min_uV, int max_uV);
151int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
152int regulator_get_voltage(struct regulator *regulator);
153int regulator_set_current_limit(struct regulator *regulator,
154 int min_uA, int max_uA);
155int regulator_get_current_limit(struct regulator *regulator);
156
157int regulator_set_mode(struct regulator *regulator, unsigned int mode);
158unsigned int regulator_get_mode(struct regulator *regulator);
159int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
160
161/* regulator notifier block */
162int regulator_register_notifier(struct regulator *regulator,
163 struct notifier_block *nb);
164int regulator_unregister_notifier(struct regulator *regulator,
165 struct notifier_block *nb);
166
167/* driver data - core doesn't touch */
168void *regulator_get_drvdata(struct regulator *regulator);
169void regulator_set_drvdata(struct regulator *regulator, void *data);
170
171#else
172
173/*
174 * Make sure client drivers will still build on systems with no software
175 * controllable voltage or current regulators.
176 */
177static inline struct regulator *__must_check regulator_get(struct device *dev,
178 const char *id)
179{
180 /* Nothing except the stubbed out regulator API should be
181 * looking at the value except to check if it is an error
182 * value so the actual return value doesn't matter.
183 */
184 return (struct regulator *)id;
185}
186static inline void regulator_put(struct regulator *regulator)
187{
188}
189
190static inline int regulator_enable(struct regulator *regulator)
191{
192 return 0;
193}
194
195static inline int regulator_disable(struct regulator *regulator)
196{
197 return 0;
198}
199
200static inline int regulator_is_enabled(struct regulator *regulator)
201{
202 return 1;
203}
204
205static inline int regulator_bulk_get(struct device *dev,
206 int num_consumers,
207 struct regulator_bulk_data *consumers)
208{
209 return 0;
210}
211
212static inline int regulator_bulk_enable(int num_consumers,
213 struct regulator_bulk_data *consumers)
214{
215 return 0;
216}
217
218static inline int regulator_bulk_disable(int num_consumers,
219 struct regulator_bulk_data *consumers)
220{
221 return 0;
222}
223
224static inline void regulator_bulk_free(int num_consumers,
225 struct regulator_bulk_data *consumers)
226{
227}
228
229static inline int regulator_set_voltage(struct regulator *regulator,
230 int min_uV, int max_uV)
231{
232 return 0;
233}
234
235static inline int regulator_get_voltage(struct regulator *regulator)
236{
237 return 0;
238}
239
240static inline int regulator_set_current_limit(struct regulator *regulator,
241 int min_uA, int max_uA)
242{
243 return 0;
244}
245
246static inline int regulator_get_current_limit(struct regulator *regulator)
247{
248 return 0;
249}
250
251static inline int regulator_set_mode(struct regulator *regulator,
252 unsigned int mode)
253{
254 return 0;
255}
256
257static inline unsigned int regulator_get_mode(struct regulator *regulator)
258{
259 return REGULATOR_MODE_NORMAL;
260}
261
262static inline int regulator_set_optimum_mode(struct regulator *regulator,
263 int load_uA)
264{
265 return REGULATOR_MODE_NORMAL;
266}
267
268static inline int regulator_register_notifier(struct regulator *regulator,
269 struct notifier_block *nb)
270{
271 return 0;
272}
273
274static inline int regulator_unregister_notifier(struct regulator *regulator,
275 struct notifier_block *nb)
276{
277 return 0;
278}
279
280static inline void *regulator_get_drvdata(struct regulator *regulator)
281{
282 return NULL;
283}
284
285static inline void regulator_set_drvdata(struct regulator *regulator,
286 void *data)
287{
288}
289
290#endif
291
292#endif