Commit | Line | Data |
---|---|---|
e2ce4eaa LG |
1 | /* |
2 | * consumer.h -- SoC Regulator consumer support. | |
3 | * | |
4 | * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC. | |
5 | * | |
6 | * Author: Liam Girdwood <lg@opensource.wolfsonmicro.com> | |
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. | |
b136fb44 | 91 | * VOLTAGE_CHANGE Regulator voltage changed. |
e2ce4eaa LG |
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 | |
b136fb44 | 102 | #define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40 |
e2ce4eaa LG |
103 | |
104 | struct regulator; | |
105 | ||
106 | /** | |
107 | * struct regulator_bulk_data - Data used for bulk regulator operations. | |
108 | * | |
69279fb9 MB |
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. | |
e2ce4eaa LG |
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 | void regulator_put(struct regulator *regulator); | |
129 | ||
130 | /* regulator output control and status */ | |
131 | int regulator_enable(struct regulator *regulator); | |
132 | int regulator_disable(struct regulator *regulator); | |
133 | int regulator_force_disable(struct regulator *regulator); | |
134 | int regulator_is_enabled(struct regulator *regulator); | |
135 | ||
136 | int regulator_bulk_get(struct device *dev, int num_consumers, | |
137 | struct regulator_bulk_data *consumers); | |
138 | int regulator_bulk_enable(int num_consumers, | |
139 | struct regulator_bulk_data *consumers); | |
140 | int regulator_bulk_disable(int num_consumers, | |
141 | struct regulator_bulk_data *consumers); | |
142 | void regulator_bulk_free(int num_consumers, | |
143 | struct regulator_bulk_data *consumers); | |
144 | ||
145 | int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV); | |
146 | int regulator_get_voltage(struct regulator *regulator); | |
147 | int regulator_set_current_limit(struct regulator *regulator, | |
148 | int min_uA, int max_uA); | |
149 | int regulator_get_current_limit(struct regulator *regulator); | |
150 | ||
151 | int regulator_set_mode(struct regulator *regulator, unsigned int mode); | |
152 | unsigned int regulator_get_mode(struct regulator *regulator); | |
153 | int regulator_set_optimum_mode(struct regulator *regulator, int load_uA); | |
154 | ||
155 | /* regulator notifier block */ | |
156 | int regulator_register_notifier(struct regulator *regulator, | |
157 | struct notifier_block *nb); | |
158 | int regulator_unregister_notifier(struct regulator *regulator, | |
159 | struct notifier_block *nb); | |
160 | ||
161 | /* driver data - core doesn't touch */ | |
162 | void *regulator_get_drvdata(struct regulator *regulator); | |
163 | void regulator_set_drvdata(struct regulator *regulator, void *data); | |
164 | ||
165 | #else | |
166 | ||
167 | /* | |
168 | * Make sure client drivers will still build on systems with no software | |
169 | * controllable voltage or current regulators. | |
170 | */ | |
171 | static inline struct regulator *__must_check regulator_get(struct device *dev, | |
172 | const char *id) | |
173 | { | |
174 | /* Nothing except the stubbed out regulator API should be | |
175 | * looking at the value except to check if it is an error | |
176 | * value so the actual return value doesn't matter. | |
177 | */ | |
178 | return (struct regulator *)id; | |
179 | } | |
180 | static inline void regulator_put(struct regulator *regulator) | |
181 | { | |
182 | } | |
183 | ||
184 | static inline int regulator_enable(struct regulator *regulator) | |
185 | { | |
186 | return 0; | |
187 | } | |
188 | ||
189 | static inline int regulator_disable(struct regulator *regulator) | |
190 | { | |
191 | return 0; | |
192 | } | |
193 | ||
194 | static inline int regulator_is_enabled(struct regulator *regulator) | |
195 | { | |
196 | return 1; | |
197 | } | |
198 | ||
199 | static inline int regulator_bulk_get(struct device *dev, | |
200 | int num_consumers, | |
201 | struct regulator_bulk_data *consumers) | |
202 | { | |
203 | return 0; | |
204 | } | |
205 | ||
206 | static inline int regulator_bulk_enable(int num_consumers, | |
207 | struct regulator_bulk_data *consumers) | |
208 | { | |
209 | return 0; | |
210 | } | |
211 | ||
212 | static inline int regulator_bulk_disable(int num_consumers, | |
213 | struct regulator_bulk_data *consumers) | |
214 | { | |
215 | return 0; | |
216 | } | |
217 | ||
218 | static inline void regulator_bulk_free(int num_consumers, | |
219 | struct regulator_bulk_data *consumers) | |
220 | { | |
221 | } | |
222 | ||
223 | static inline int regulator_set_voltage(struct regulator *regulator, | |
224 | int min_uV, int max_uV) | |
225 | { | |
226 | return 0; | |
227 | } | |
228 | ||
229 | static inline int regulator_get_voltage(struct regulator *regulator) | |
230 | { | |
231 | return 0; | |
232 | } | |
233 | ||
234 | static inline int regulator_set_current_limit(struct regulator *regulator, | |
235 | int min_uA, int max_uA) | |
236 | { | |
237 | return 0; | |
238 | } | |
239 | ||
240 | static inline int regulator_get_current_limit(struct regulator *regulator) | |
241 | { | |
242 | return 0; | |
243 | } | |
244 | ||
245 | static inline int regulator_set_mode(struct regulator *regulator, | |
246 | unsigned int mode) | |
247 | { | |
248 | return 0; | |
249 | } | |
250 | ||
251 | static inline unsigned int regulator_get_mode(struct regulator *regulator) | |
252 | { | |
253 | return REGULATOR_MODE_NORMAL; | |
254 | } | |
255 | ||
256 | static inline int regulator_set_optimum_mode(struct regulator *regulator, | |
257 | int load_uA) | |
258 | { | |
259 | return REGULATOR_MODE_NORMAL; | |
260 | } | |
261 | ||
262 | static inline int regulator_register_notifier(struct regulator *regulator, | |
263 | struct notifier_block *nb) | |
264 | { | |
265 | return 0; | |
266 | } | |
267 | ||
268 | static inline int regulator_unregister_notifier(struct regulator *regulator, | |
269 | struct notifier_block *nb) | |
270 | { | |
271 | return 0; | |
272 | } | |
273 | ||
274 | static inline void *regulator_get_drvdata(struct regulator *regulator) | |
275 | { | |
276 | return NULL; | |
277 | } | |
278 | ||
279 | static inline void regulator_set_drvdata(struct regulator *regulator, | |
280 | void *data) | |
281 | { | |
282 | } | |
283 | ||
284 | #endif | |
285 | ||
286 | #endif |