projects / linux-2.6-block.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Merge remote branch 'kumar/next' into merge
[linux-2.6-block.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;
125};
126
127#if defined(CONFIG_REGULATOR)
128
129/* regulator get and put */
130struct regulator *__must_check regulator_get(struct device *dev,
131 const char *id);
5ffbd136
MB		 132struct regulator *__must_check regulator_get_exclusive(struct device *dev,
133 const char *id);
e2ce4eaa
LG		 134void regulator_put(struct regulator *regulator);
135
136/* regulator output control and status */
137int regulator_enable(struct regulator *regulator);
138int regulator_disable(struct regulator *regulator);
139int regulator_force_disable(struct regulator *regulator);
140int regulator_is_enabled(struct regulator *regulator);
141
142int regulator_bulk_get(struct device *dev, int num_consumers,
143 struct regulator_bulk_data *consumers);
144int regulator_bulk_enable(int num_consumers,
145 struct regulator_bulk_data *consumers);
146int regulator_bulk_disable(int num_consumers,
147 struct regulator_bulk_data *consumers);
148void regulator_bulk_free(int num_consumers,
149 struct regulator_bulk_data *consumers);
150
4367cfdc
DB		 151int regulator_count_voltages(struct regulator *regulator);
152int regulator_list_voltage(struct regulator *regulator, unsigned selector);
a7a1ad90
MB		 153int regulator_is_supported_voltage(struct regulator *regulator,
154 int min_uV, int max_uV);
e2ce4eaa
LG		 155int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
156int regulator_get_voltage(struct regulator *regulator);
606a2562 157int regulator_sync_voltage(struct regulator *regulator);
e2ce4eaa
LG		 158int regulator_set_current_limit(struct regulator *regulator,
159 int min_uA, int max_uA);
160int regulator_get_current_limit(struct regulator *regulator);
161
162int regulator_set_mode(struct regulator *regulator, unsigned int mode);
163unsigned int regulator_get_mode(struct regulator *regulator);
164int regulator_set_optimum_mode(struct regulator *regulator, int load_uA);
165
166/* regulator notifier block */
167int regulator_register_notifier(struct regulator *regulator,
168 struct notifier_block *nb);
169int regulator_unregister_notifier(struct regulator *regulator,
170 struct notifier_block *nb);
171
172/* driver data - core doesn't touch */
173void *regulator_get_drvdata(struct regulator *regulator);
174void regulator_set_drvdata(struct regulator *regulator, void *data);
175
176#else
177
178/*
179 * Make sure client drivers will still build on systems with no software
180 * controllable voltage or current regulators.
181 */
182static inline struct regulator *__must_check regulator_get(struct device *dev,
183 const char *id)
184{
185 /* Nothing except the stubbed out regulator API should be
186 * looking at the value except to check if it is an error
be1a50d4
JD		 187 * value. Drivers are free to handle NULL specifically by
188 * skipping all regulator API calls, but they don't have to.
189 * Drivers which don't, should make sure they properly handle
190 * corner cases of the API, such as regulator_get_voltage()
191 * returning 0.
e2ce4eaa 192 */
be1a50d4 193 return NULL;
e2ce4eaa
LG		 194}
195static inline void regulator_put(struct regulator *regulator)
196{
197}
198
199static inline int regulator_enable(struct regulator *regulator)
200{
201 return 0;
202}
203
204static inline int regulator_disable(struct regulator *regulator)
205{
206 return 0;
207}
208
209static inline int regulator_is_enabled(struct regulator *regulator)
210{
211 return 1;
212}
213
214static inline int regulator_bulk_get(struct device *dev,
215 int num_consumers,
216 struct regulator_bulk_data *consumers)
217{
218 return 0;
219}
220
221static inline int regulator_bulk_enable(int num_consumers,
222 struct regulator_bulk_data *consumers)
223{
224 return 0;
225}
226
227static inline int regulator_bulk_disable(int num_consumers,
228 struct regulator_bulk_data *consumers)
229{
230 return 0;
231}
232
233static inline void regulator_bulk_free(int num_consumers,
234 struct regulator_bulk_data *consumers)
235{
236}
237
238static inline int regulator_set_voltage(struct regulator *regulator,
239 int min_uV, int max_uV)
240{
241 return 0;
242}
243
244static inline int regulator_get_voltage(struct regulator *regulator)
245{
246 return 0;
247}
248
249static inline int regulator_set_current_limit(struct regulator *regulator,
250 int min_uA, int max_uA)
251{
252 return 0;
253}
254
255static inline int regulator_get_current_limit(struct regulator *regulator)
256{
257 return 0;
258}
259
260static inline int regulator_set_mode(struct regulator *regulator,
261 unsigned int mode)
262{
263 return 0;
264}
265
266static inline unsigned int regulator_get_mode(struct regulator *regulator)
267{
268 return REGULATOR_MODE_NORMAL;
269}
270
271static inline int regulator_set_optimum_mode(struct regulator *regulator,
272 int load_uA)
273{
274 return REGULATOR_MODE_NORMAL;
275}
276
277static inline int regulator_register_notifier(struct regulator *regulator,
278 struct notifier_block *nb)
279{
280 return 0;
281}
282
283static inline int regulator_unregister_notifier(struct regulator *regulator,
284 struct notifier_block *nb)
285{
286 return 0;
287}
288
289static inline void *regulator_get_drvdata(struct regulator *regulator)
290{
291 return NULL;
292}
293
294static inline void regulator_set_drvdata(struct regulator *regulator,
295 void *data)
296{
297}
298
299#endif
300
301#endif
Linux 6.x block layer and io_uring tree(s)