3  * consumer.h -- SoC Regulator consumer support.
9  * Regulator Consumer Interface.
11  * A Power Management Regulator framework for SoC based devices.
15  *   o Regulator status.
19  *   Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
23  *   e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
25  *   idling. Regulator r has > 90% efficiency in NORMAL mode at loads > 100mA
26  *   but this drops rapidly to 60% when below 100mA. Regulator r has > 90%
27  *   efficiency in IDLE mode at loads < 10mA. Thus regulator r will operate
43  * Regulator operating modes.
47  * best (and most efficient) regulator mode for a desired load.
50  * will probably not match the naming convention of your regulator data sheet
56  *  FAST       Regulator can handle fast changes in it's load.
60  *  NORMAL     Normal regulator power supply mode. Most drivers will
63  *  IDLE       Regulator runs in a more efficient mode for light
69  *  STANDBY    Regulator runs in the most efficient mode for very
88  * Regulator notifier events.
90  * UNDER_VOLTAGE  Regulator output is under voltage.
91  * OVER_CURRENT   Regulator output current is too high.
92  * REGULATION_OUT Regulator output is out of regulation.
93  * FAIL           Regulator output has failed.
94  * OVER_TEMP      Regulator over temp.
95  * FORCE_DISABLE  Regulator forcibly shut down by software.
96  * VOLTAGE_CHANGE Regulator voltage changed.
98  * DISABLE        Regulator was disabled.
99  * PRE_VOLTAGE_CHANGE   Regulator is about to have voltage changed.
101  * ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason.
103  * PRE_DISABLE    Regulator is about to be disabled
104  * ABORT_DISABLE  Regulator disable failed for some reason
134  * Regulator errors that can be queried using regulator_get_error_flags
136  * UNDER_VOLTAGE  Regulator output is under voltage.
137  * OVER_CURRENT   Regulator output current is too high.
138  * REGULATION_OUT Regulator output is out of regulation.
139  * FAIL           Regulator output has failed.
140  * OVER_TEMP      Regulator over temp.
169 struct regulator;
172  * struct regulator_bulk_data - Data used for bulk regulator operations.
175  *            using the bulk regulator APIs.
176  * @consumer: The regulator consumer for the supply.  This will be managed
179  * The regulator APIs provide a series of regulator_bulk_() API calls as
185 	struct regulator *consumer;
193 /* regulator get and put */
194 struct regulator *__must_check regulator_get(struct device *dev,
196 struct regulator *__must_check devm_regulator_get(struct device *dev,
198 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
200 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
202 struct regulator *__must_check regulator_get_optional(struct device *dev,
204 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
206 void regulator_put(struct regulator *regulator);
207 void devm_regulator_put(struct regulator *regulator);
232 /* regulator output control and status */
233 int __must_check regulator_enable(struct regulator *regulator);
234 int regulator_disable(struct regulator *regulator);
235 int regulator_force_disable(struct regulator *regulator);
236 int regulator_is_enabled(struct regulator *regulator);
237 int regulator_disable_deferred(struct regulator *regulator, int ms);
252 int regulator_count_voltages(struct regulator *regulator);
253 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
254 int regulator_is_supported_voltage(struct regulator *regulator,
256 unsigned int regulator_get_linear_step(struct regulator *regulator);
257 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
258 int regulator_set_voltage_time(struct regulator *regulator,
260 int regulator_get_voltage(struct regulator *regulator);
261 int regulator_sync_voltage(struct regulator *regulator);
262 int regulator_set_current_limit(struct regulator *regulator,
264 int regulator_get_current_limit(struct regulator *regulator);
266 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
267 unsigned int regulator_get_mode(struct regulator *regulator);
268 int regulator_get_error_flags(struct regulator *regulator,
270 int regulator_set_load(struct regulator *regulator, int load_uA);
272 int regulator_allow_bypass(struct regulator *regulator, bool allow);
274 struct regmap *regulator_get_regmap(struct regulator *regulator);
275 int regulator_get_hardware_vsel_register(struct regulator *regulator,
278 int regulator_list_hardware_vsel(struct regulator *regulator,
281 /* regulator notifier block */
282 int regulator_register_notifier(struct regulator *regulator,
284 int devm_regulator_register_notifier(struct regulator *regulator,
286 int regulator_unregister_notifier(struct regulator *regulator,
288 void devm_regulator_unregister_notifier(struct regulator *regulator,
291 /* regulator suspend */
296 int regulator_set_suspend_voltage(struct regulator *regulator, int min_uV,
300 void *regulator_get_drvdata(struct regulator *regulator);
301 void regulator_set_drvdata(struct regulator *regulator, void *data);
309 bool regulator_is_equal(struct regulator *reg1, struct regulator *reg2);
317 static inline struct regulator *__must_check regulator_get(struct device *dev,  in regulator_get()
320 	/* Nothing except the stubbed out regulator API should be  in regulator_get()
323 	 * skipping all regulator API calls, but they don't have to.  in regulator_get()
331 static inline struct regulator *__must_check
337 static inline struct regulator *__must_check
343 static inline struct regulator *__must_check
349 static inline struct regulator *__must_check
356 static inline struct regulator *__must_check
362 static inline void regulator_put(struct regulator *regulator)  in regulator_put()  argument
366 static inline void devm_regulator_put(struct regulator *regulator)  in devm_regulator_put()  argument
415 static inline int regulator_enable(struct regulator *regulator)  in regulator_enable()  argument
420 static inline int regulator_disable(struct regulator *regulator)  in regulator_disable()  argument
425 static inline int regulator_force_disable(struct regulator *regulator)  in regulator_force_disable()  argument
430 static inline int regulator_disable_deferred(struct regulator *regulator,  in regulator_disable_deferred()  argument
436 static inline int regulator_is_enabled(struct regulator *regulator)  in regulator_is_enabled()  argument
477 static inline int regulator_set_voltage(struct regulator *regulator,  in regulator_set_voltage()  argument
483 static inline int regulator_set_voltage_time(struct regulator *regulator,  in regulator_set_voltage_time()  argument
489 static inline int regulator_get_voltage(struct regulator *regulator)  in regulator_get_voltage()  argument
494 static inline int regulator_sync_voltage(struct regulator *regulator)  in regulator_sync_voltage()  argument
499 static inline int regulator_is_supported_voltage(struct regulator *regulator,  in regulator_is_supported_voltage()  argument
505 static inline unsigned int regulator_get_linear_step(struct regulator *regulator)  in regulator_get_linear_step()  argument
510 static inline int regulator_set_current_limit(struct regulator *regulator,  in regulator_set_current_limit()  argument
516 static inline int regulator_get_current_limit(struct regulator *regulator)  in regulator_get_current_limit()  argument
521 static inline int regulator_set_mode(struct regulator *regulator,  in regulator_set_mode()  argument
527 static inline unsigned int regulator_get_mode(struct regulator *regulator)  in regulator_get_mode()  argument
532 static inline int regulator_get_error_flags(struct regulator *regulator,  in regulator_get_error_flags()  argument
538 static inline int regulator_set_load(struct regulator *regulator, int load_uA)  in regulator_set_load()  argument
543 static inline int regulator_allow_bypass(struct regulator *regulator,  in regulator_allow_bypass()  argument
549 static inline struct regmap *regulator_get_regmap(struct regulator *regulator)  in regulator_get_regmap()  argument
554 static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,  in regulator_get_hardware_vsel_register()  argument
561 static inline int regulator_list_hardware_vsel(struct regulator *regulator,  in regulator_list_hardware_vsel()  argument
567 static inline int regulator_register_notifier(struct regulator *regulator,  in regulator_register_notifier()  argument
573 static inline int devm_regulator_register_notifier(struct regulator *regulator,  in devm_regulator_register_notifier()  argument
579 static inline int regulator_unregister_notifier(struct regulator *regulator,  in regulator_unregister_notifier()  argument
585 static inline int devm_regulator_unregister_notifier(struct regulator *regulator,  in devm_regulator_unregister_notifier()  argument
603 static inline int regulator_set_suspend_voltage(struct regulator *regulator,  in regulator_set_suspend_voltage()  argument
610 static inline void *regulator_get_drvdata(struct regulator *regulator)  in regulator_get_drvdata()  argument
615 static inline void regulator_set_drvdata(struct regulator *regulator,  in regulator_set_drvdata()  argument
620 static inline int regulator_count_voltages(struct regulator *regulator)  in regulator_count_voltages()  argument
625 static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)  in regulator_list_voltage()  argument
638 regulator_is_equal(struct regulator *reg1, struct regulator *reg2)  in regulator_is_equal()
644 static inline int regulator_set_voltage_triplet(struct regulator *regulator,  in regulator_set_voltage_triplet()  argument
648 	if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)  in regulator_set_voltage_triplet()
651 	return regulator_set_voltage(regulator, min_uV, max_uV);  in regulator_set_voltage_triplet()
654 static inline int regulator_set_voltage_tol(struct regulator *regulator,  in regulator_set_voltage_tol()  argument
657 	if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)  in regulator_set_voltage_tol()
660 		return regulator_set_voltage(regulator,  in regulator_set_voltage_tol()
664 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,  in regulator_is_supported_voltage_tol()  argument
667 	return regulator_is_supported_voltage(regulator,  in regulator_is_supported_voltage_tol()