2 * consumer.h -- SoC Regulator consumer support.
4 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
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.
12 * Regulator Consumer Interface.
14 * A Power Management Regulator framework for SoC based devices.
16 * o Voltage and current level control.
17 * o Operating mode control.
19 * o sysfs entries for showing client devices and status
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.
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.
35 #ifndef __LINUX_REGULATOR_CONSUMER_H_
36 #define __LINUX_REGULATOR_CONSUMER_H_
38 #include <linux/err.h>
41 struct notifier_block;
45 * Regulator operating modes.
47 * Regulators can run in a variety of different operating modes depending on
48 * output load. This allows further system power savings by selecting the
49 * best (and most efficient) regulator mode for a desired load.
51 * Most drivers will only care about NORMAL. The modes below are generic and
52 * will probably not match the naming convention of your regulator data sheet
53 * but should match the use cases in the datasheet.
55 * In order of power efficiency (least efficient at top).
58 * FAST Regulator can handle fast changes in it's load.
59 * e.g. useful in CPU voltage & frequency scaling where
60 * load can quickly increase with CPU frequency increases.
62 * NORMAL Normal regulator power supply mode. Most drivers will
65 * IDLE Regulator runs in a more efficient mode for light
66 * loads. Can be used for devices that have a low power
67 * requirement during periods of inactivity. This mode
68 * may be more noisy than NORMAL and may not be able
69 * to handle fast load switching.
71 * STANDBY Regulator runs in the most efficient mode for very
72 * light loads. Can be used by devices when they are
73 * in a sleep/standby state. This mode is likely to be
74 * the most noisy and may not be able to handle fast load
77 * NOTE: Most regulators will only support a subset of these modes. Some
78 * will only just support NORMAL.
80 * These modes can be OR'ed together to make up a mask of valid register modes.
83 #define REGULATOR_MODE_FAST 0x1
84 #define REGULATOR_MODE_NORMAL 0x2
85 #define REGULATOR_MODE_IDLE 0x4
86 #define REGULATOR_MODE_STANDBY 0x8
89 * Regulator notifier events.
91 * UNDER_VOLTAGE Regulator output is under voltage.
92 * OVER_CURRENT Regulator output current is too high.
93 * REGULATION_OUT Regulator output is out of regulation.
94 * FAIL Regulator output has failed.
95 * OVER_TEMP Regulator over temp.
96 * FORCE_DISABLE Regulator forcibly shut down by software.
97 * VOLTAGE_CHANGE Regulator voltage changed.
98 * Data passed is old voltage cast to (void *).
99 * DISABLE Regulator was disabled.
100 * PRE_VOLTAGE_CHANGE Regulator is about to have voltage changed.
101 * Data passed is "struct pre_voltage_change_data"
102 * ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason.
103 * Data passed is old voltage cast to (void *).
104 * PRE_DISABLE Regulator is about to be disabled
105 * ABORT_DISABLE Regulator disable failed for some reason
107 * NOTE: These events can be OR'ed together when passed into handler.
110 #define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
111 #define REGULATOR_EVENT_OVER_CURRENT 0x02
112 #define REGULATOR_EVENT_REGULATION_OUT 0x04
113 #define REGULATOR_EVENT_FAIL 0x08
114 #define REGULATOR_EVENT_OVER_TEMP 0x10
115 #define REGULATOR_EVENT_FORCE_DISABLE 0x20
116 #define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
117 #define REGULATOR_EVENT_DISABLE 0x80
118 #define REGULATOR_EVENT_PRE_VOLTAGE_CHANGE 0x100
119 #define REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE 0x200
120 #define REGULATOR_EVENT_PRE_DISABLE 0x400
121 #define REGULATOR_EVENT_ABORT_DISABLE 0x800
124 * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
126 * @old_uV: Current voltage before change.
127 * @min_uV: Min voltage we'll change to.
128 * @max_uV: Max voltage we'll change to.
130 struct pre_voltage_change_data {
131 unsigned long old_uV;
132 unsigned long min_uV;
133 unsigned long max_uV;
139 * struct regulator_bulk_data - Data used for bulk regulator operations.
141 * @supply: The name of the supply. Initialised by the user before
142 * using the bulk regulator APIs.
143 * @optional: The supply should be considered optional. Initialised by the user
144 * before using the bulk regulator APIs.
145 * @consumer: The regulator consumer for the supply. This will be managed
148 * The regulator APIs provide a series of regulator_bulk_() API calls as
149 * a convenience to consumers which require multiple supplies. This
150 * structure is used to manage data for these calls.
152 struct regulator_bulk_data {
155 struct regulator *consumer;
157 /* private: Internal use */
161 #if defined(CONFIG_REGULATOR)
163 /* regulator get and put */
164 struct regulator *__must_check regulator_get(struct device *dev,
166 struct regulator *__must_check devm_regulator_get(struct device *dev,
168 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
170 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
172 struct regulator *__must_check regulator_get_optional(struct device *dev,
174 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
176 void regulator_put(struct regulator *regulator);
177 void devm_regulator_put(struct regulator *regulator);
179 int regulator_register_supply_alias(struct device *dev, const char *id,
180 struct device *alias_dev,
181 const char *alias_id);
182 void regulator_unregister_supply_alias(struct device *dev, const char *id);
184 int regulator_bulk_register_supply_alias(struct device *dev,
185 const char *const *id,
186 struct device *alias_dev,
187 const char *const *alias_id,
189 void regulator_bulk_unregister_supply_alias(struct device *dev,
190 const char * const *id, int num_id);
192 int devm_regulator_register_supply_alias(struct device *dev, const char *id,
193 struct device *alias_dev,
194 const char *alias_id);
195 void devm_regulator_unregister_supply_alias(struct device *dev,
198 int devm_regulator_bulk_register_supply_alias(struct device *dev,
199 const char *const *id,
200 struct device *alias_dev,
201 const char *const *alias_id,
203 void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
204 const char *const *id,
207 /* regulator output control and status */
208 int __must_check regulator_enable(struct regulator *regulator);
209 int regulator_disable(struct regulator *regulator);
210 int regulator_force_disable(struct regulator *regulator);
211 int regulator_is_enabled(struct regulator *regulator);
212 int regulator_disable_deferred(struct regulator *regulator, int ms);
214 int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
215 struct regulator_bulk_data *consumers);
216 int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
217 struct regulator_bulk_data *consumers);
218 int __must_check regulator_bulk_enable(int num_consumers,
219 struct regulator_bulk_data *consumers);
220 int regulator_bulk_disable(int num_consumers,
221 struct regulator_bulk_data *consumers);
222 int regulator_bulk_force_disable(int num_consumers,
223 struct regulator_bulk_data *consumers);
224 void regulator_bulk_free(int num_consumers,
225 struct regulator_bulk_data *consumers);
227 int regulator_count_voltages(struct regulator *regulator);
228 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
229 int regulator_is_supported_voltage(struct regulator *regulator,
230 int min_uV, int max_uV);
231 unsigned int regulator_get_linear_step(struct regulator *regulator);
232 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
233 int regulator_set_voltage_time(struct regulator *regulator,
234 int old_uV, int new_uV);
235 int regulator_get_voltage(struct regulator *regulator);
236 int regulator_sync_voltage(struct regulator *regulator);
237 int regulator_set_current_limit(struct regulator *regulator,
238 int min_uA, int max_uA);
239 int regulator_get_current_limit(struct regulator *regulator);
241 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
242 unsigned int regulator_get_mode(struct regulator *regulator);
243 int regulator_set_load(struct regulator *regulator, int load_uA);
245 int regulator_allow_bypass(struct regulator *regulator, bool allow);
247 struct regmap *regulator_get_regmap(struct regulator *regulator);
248 int regulator_get_hardware_vsel_register(struct regulator *regulator,
250 unsigned *vsel_mask);
251 int regulator_list_hardware_vsel(struct regulator *regulator,
254 /* regulator notifier block */
255 int regulator_register_notifier(struct regulator *regulator,
256 struct notifier_block *nb);
257 int devm_regulator_register_notifier(struct regulator *regulator,
258 struct notifier_block *nb);
259 int regulator_unregister_notifier(struct regulator *regulator,
260 struct notifier_block *nb);
261 void devm_regulator_unregister_notifier(struct regulator *regulator,
262 struct notifier_block *nb);
264 /* driver data - core doesn't touch */
265 void *regulator_get_drvdata(struct regulator *regulator);
266 void regulator_set_drvdata(struct regulator *regulator, void *data);
271 * Make sure client drivers will still build on systems with no software
272 * controllable voltage or current regulators.
274 static inline struct regulator *__must_check regulator_get(struct device *dev,
277 /* Nothing except the stubbed out regulator API should be
278 * looking at the value except to check if it is an error
279 * value. Drivers are free to handle NULL specifically by
280 * skipping all regulator API calls, but they don't have to.
281 * Drivers which don't, should make sure they properly handle
282 * corner cases of the API, such as regulator_get_voltage()
288 static inline struct regulator *__must_check
289 devm_regulator_get(struct device *dev, const char *id)
294 static inline struct regulator *__must_check
295 regulator_get_exclusive(struct device *dev, const char *id)
297 return ERR_PTR(-ENODEV);
300 static inline struct regulator *__must_check
301 regulator_get_optional(struct device *dev, const char *id)
303 return ERR_PTR(-ENODEV);
307 static inline struct regulator *__must_check
308 devm_regulator_get_optional(struct device *dev, const char *id)
310 return ERR_PTR(-ENODEV);
313 static inline void regulator_put(struct regulator *regulator)
317 static inline void devm_regulator_put(struct regulator *regulator)
321 static inline int regulator_register_supply_alias(struct device *dev,
323 struct device *alias_dev,
324 const char *alias_id)
329 static inline void regulator_unregister_supply_alias(struct device *dev,
334 static inline int regulator_bulk_register_supply_alias(struct device *dev,
335 const char *const *id,
336 struct device *alias_dev,
337 const char * const *alias_id,
343 static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
344 const char * const *id,
349 static inline int devm_regulator_register_supply_alias(struct device *dev,
351 struct device *alias_dev,
352 const char *alias_id)
357 static inline void devm_regulator_unregister_supply_alias(struct device *dev,
362 static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
363 const char *const *id,
364 struct device *alias_dev,
365 const char *const *alias_id,
371 static inline void devm_regulator_bulk_unregister_supply_alias(
372 struct device *dev, const char *const *id, int num_id)
376 static inline int regulator_enable(struct regulator *regulator)
381 static inline int regulator_disable(struct regulator *regulator)
386 static inline int regulator_force_disable(struct regulator *regulator)
391 static inline int regulator_disable_deferred(struct regulator *regulator,
397 static inline int regulator_is_enabled(struct regulator *regulator)
402 static inline int regulator_bulk_get(struct device *dev,
404 struct regulator_bulk_data *consumers)
409 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
410 struct regulator_bulk_data *consumers)
415 static inline int regulator_bulk_enable(int num_consumers,
416 struct regulator_bulk_data *consumers)
421 static inline int regulator_bulk_disable(int num_consumers,
422 struct regulator_bulk_data *consumers)
427 static inline int regulator_bulk_force_disable(int num_consumers,
428 struct regulator_bulk_data *consumers)
433 static inline void regulator_bulk_free(int num_consumers,
434 struct regulator_bulk_data *consumers)
438 static inline int regulator_set_voltage(struct regulator *regulator,
439 int min_uV, int max_uV)
444 static inline int regulator_set_voltage_time(struct regulator *regulator,
445 int old_uV, int new_uV)
450 static inline int regulator_get_voltage(struct regulator *regulator)
455 static inline int regulator_is_supported_voltage(struct regulator *regulator,
456 int min_uV, int max_uV)
461 static inline int regulator_set_current_limit(struct regulator *regulator,
462 int min_uA, int max_uA)
467 static inline int regulator_get_current_limit(struct regulator *regulator)
472 static inline int regulator_set_mode(struct regulator *regulator,
478 static inline unsigned int regulator_get_mode(struct regulator *regulator)
480 return REGULATOR_MODE_NORMAL;
483 static inline int regulator_set_load(struct regulator *regulator, int load_uA)
485 return REGULATOR_MODE_NORMAL;
488 static inline int regulator_allow_bypass(struct regulator *regulator,
494 static inline struct regmap *regulator_get_regmap(struct regulator *regulator)
496 return ERR_PTR(-EOPNOTSUPP);
499 static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
506 static inline int regulator_list_hardware_vsel(struct regulator *regulator,
512 static inline int regulator_register_notifier(struct regulator *regulator,
513 struct notifier_block *nb)
518 static inline int devm_regulator_register_notifier(struct regulator *regulator,
519 struct notifier_block *nb)
524 static inline int regulator_unregister_notifier(struct regulator *regulator,
525 struct notifier_block *nb)
530 static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
531 struct notifier_block *nb)
536 static inline void *regulator_get_drvdata(struct regulator *regulator)
541 static inline void regulator_set_drvdata(struct regulator *regulator,
546 static inline int regulator_count_voltages(struct regulator *regulator)
551 static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
558 static inline int regulator_set_voltage_triplet(struct regulator *regulator,
559 int min_uV, int target_uV,
562 if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
565 return regulator_set_voltage(regulator, min_uV, max_uV);
568 static inline int regulator_set_voltage_tol(struct regulator *regulator,
569 int new_uV, int tol_uV)
571 if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
574 return regulator_set_voltage(regulator,
575 new_uV - tol_uV, new_uV + tol_uV);
578 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
579 int target_uV, int tol_uV)
581 return regulator_is_supported_voltage(regulator,