1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * consumer.h -- SoC Regulator consumer support.
5 * Copyright (C) 2007, 2008 Wolfson Microelectronics PLC.
7 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
9 * Regulator Consumer Interface.
11 * A Power Management Regulator framework for SoC based devices.
13 * o Voltage and current level control.
14 * o Operating mode control.
16 * o sysfs entries for showing client devices and status
18 * EXPERIMENTAL FEATURES:
19 * Dynamic Regulator operating Mode Switching (DRMS) - allows regulators
20 * to use most efficient operating mode depending upon voltage and load and
21 * is transparent to client drivers.
23 * e.g. Devices x,y,z share regulator r. Device x and y draw 20mA each during
24 * IO and 1mA at idle. Device z draws 100mA when under load and 5mA when
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
28 * in normal mode for loads > 10mA and in IDLE mode for load <= 10mA.
31 #ifndef __LINUX_REGULATOR_CONSUMER_H_
32 #define __LINUX_REGULATOR_CONSUMER_H_
34 #include <linux/err.h>
35 #include <linux/suspend.h>
38 struct notifier_block;
43 * Regulator operating modes.
45 * Regulators can run in a variety of different operating modes depending on
46 * output load. This allows further system power savings by selecting the
47 * best (and most efficient) regulator mode for a desired load.
49 * Most drivers will only care about NORMAL. The modes below are generic and
50 * will probably not match the naming convention of your regulator data sheet
51 * but should match the use cases in the datasheet.
53 * In order of power efficiency (least efficient at top).
56 * FAST Regulator can handle fast changes in it's load.
57 * e.g. useful in CPU voltage & frequency scaling where
58 * load can quickly increase with CPU frequency increases.
60 * NORMAL Normal regulator power supply mode. Most drivers will
63 * IDLE Regulator runs in a more efficient mode for light
64 * loads. Can be used for devices that have a low power
65 * requirement during periods of inactivity. This mode
66 * may be more noisy than NORMAL and may not be able
67 * to handle fast load switching.
69 * STANDBY Regulator runs in the most efficient mode for very
70 * light loads. Can be used by devices when they are
71 * in a sleep/standby state. This mode is likely to be
72 * the most noisy and may not be able to handle fast load
75 * NOTE: Most regulators will only support a subset of these modes. Some
76 * will only just support NORMAL.
78 * These modes can be OR'ed together to make up a mask of valid register modes.
81 #define REGULATOR_MODE_INVALID 0x0
82 #define REGULATOR_MODE_FAST 0x1
83 #define REGULATOR_MODE_NORMAL 0x2
84 #define REGULATOR_MODE_IDLE 0x4
85 #define REGULATOR_MODE_STANDBY 0x8
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.
97 * Data passed is old voltage cast to (void *).
98 * DISABLE Regulator was disabled.
99 * PRE_VOLTAGE_CHANGE Regulator is about to have voltage changed.
100 * Data passed is "struct pre_voltage_change_data"
101 * ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason.
102 * Data passed is old voltage cast to (void *).
103 * PRE_DISABLE Regulator is about to be disabled
104 * ABORT_DISABLE Regulator disable failed for some reason
106 * NOTE: These events can be OR'ed together when passed into handler.
109 #define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
110 #define REGULATOR_EVENT_OVER_CURRENT 0x02
111 #define REGULATOR_EVENT_REGULATION_OUT 0x04
112 #define REGULATOR_EVENT_FAIL 0x08
113 #define REGULATOR_EVENT_OVER_TEMP 0x10
114 #define REGULATOR_EVENT_FORCE_DISABLE 0x20
115 #define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
116 #define REGULATOR_EVENT_DISABLE 0x80
117 #define REGULATOR_EVENT_PRE_VOLTAGE_CHANGE 0x100
118 #define REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE 0x200
119 #define REGULATOR_EVENT_PRE_DISABLE 0x400
120 #define REGULATOR_EVENT_ABORT_DISABLE 0x800
121 #define REGULATOR_EVENT_ENABLE 0x1000
124 * Regulator errors that can be queried using regulator_get_error_flags
126 * UNDER_VOLTAGE Regulator output is under voltage.
127 * OVER_CURRENT Regulator output current is too high.
128 * REGULATION_OUT Regulator output is out of regulation.
129 * FAIL Regulator output has failed.
130 * OVER_TEMP Regulator over temp.
132 * NOTE: These errors can be OR'ed together.
135 #define REGULATOR_ERROR_UNDER_VOLTAGE BIT(1)
136 #define REGULATOR_ERROR_OVER_CURRENT BIT(2)
137 #define REGULATOR_ERROR_REGULATION_OUT BIT(3)
138 #define REGULATOR_ERROR_FAIL BIT(4)
139 #define REGULATOR_ERROR_OVER_TEMP BIT(5)
143 * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
145 * @old_uV: Current voltage before change.
146 * @min_uV: Min voltage we'll change to.
147 * @max_uV: Max voltage we'll change to.
149 struct pre_voltage_change_data {
150 unsigned long old_uV;
151 unsigned long min_uV;
152 unsigned long max_uV;
158 * struct regulator_bulk_data - Data used for bulk regulator operations.
160 * @supply: The name of the supply. Initialised by the user before
161 * using the bulk regulator APIs.
162 * @consumer: The regulator consumer for the supply. This will be managed
165 * The regulator APIs provide a series of regulator_bulk_() API calls as
166 * a convenience to consumers which require multiple supplies. This
167 * structure is used to manage data for these calls.
169 struct regulator_bulk_data {
171 struct regulator *consumer;
173 /* private: Internal use */
177 #if defined(CONFIG_REGULATOR)
179 /* regulator get and put */
180 struct regulator *__must_check regulator_get(struct device *dev,
182 struct regulator *__must_check devm_regulator_get(struct device *dev,
184 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
186 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
188 struct regulator *__must_check regulator_get_optional(struct device *dev,
190 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
192 void regulator_put(struct regulator *regulator);
193 void devm_regulator_put(struct regulator *regulator);
195 int regulator_register_supply_alias(struct device *dev, const char *id,
196 struct device *alias_dev,
197 const char *alias_id);
198 void regulator_unregister_supply_alias(struct device *dev, const char *id);
200 int regulator_bulk_register_supply_alias(struct device *dev,
201 const char *const *id,
202 struct device *alias_dev,
203 const char *const *alias_id,
205 void regulator_bulk_unregister_supply_alias(struct device *dev,
206 const char * const *id, int num_id);
208 int devm_regulator_register_supply_alias(struct device *dev, const char *id,
209 struct device *alias_dev,
210 const char *alias_id);
211 void devm_regulator_unregister_supply_alias(struct device *dev,
214 int devm_regulator_bulk_register_supply_alias(struct device *dev,
215 const char *const *id,
216 struct device *alias_dev,
217 const char *const *alias_id,
219 void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
220 const char *const *id,
223 /* regulator output control and status */
224 int __must_check regulator_enable(struct regulator *regulator);
225 int regulator_disable(struct regulator *regulator);
226 int regulator_force_disable(struct regulator *regulator);
227 int regulator_is_enabled(struct regulator *regulator);
228 int regulator_disable_deferred(struct regulator *regulator, int ms);
230 int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
231 struct regulator_bulk_data *consumers);
232 int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
233 struct regulator_bulk_data *consumers);
234 int __must_check regulator_bulk_enable(int num_consumers,
235 struct regulator_bulk_data *consumers);
236 int regulator_bulk_disable(int num_consumers,
237 struct regulator_bulk_data *consumers);
238 int regulator_bulk_force_disable(int num_consumers,
239 struct regulator_bulk_data *consumers);
240 void regulator_bulk_free(int num_consumers,
241 struct regulator_bulk_data *consumers);
243 int regulator_count_voltages(struct regulator *regulator);
244 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
245 int regulator_is_supported_voltage(struct regulator *regulator,
246 int min_uV, int max_uV);
247 unsigned int regulator_get_linear_step(struct regulator *regulator);
248 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
249 int regulator_set_voltage_time(struct regulator *regulator,
250 int old_uV, int new_uV);
251 int regulator_get_voltage(struct regulator *regulator);
252 int regulator_sync_voltage(struct regulator *regulator);
253 int regulator_set_current_limit(struct regulator *regulator,
254 int min_uA, int max_uA);
255 int regulator_get_current_limit(struct regulator *regulator);
257 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
258 unsigned int regulator_get_mode(struct regulator *regulator);
259 int regulator_get_error_flags(struct regulator *regulator,
260 unsigned int *flags);
261 int regulator_set_load(struct regulator *regulator, int load_uA);
263 int regulator_allow_bypass(struct regulator *regulator, bool allow);
265 struct regmap *regulator_get_regmap(struct regulator *regulator);
266 int regulator_get_hardware_vsel_register(struct regulator *regulator,
268 unsigned *vsel_mask);
269 int regulator_list_hardware_vsel(struct regulator *regulator,
272 /* regulator notifier block */
273 int regulator_register_notifier(struct regulator *regulator,
274 struct notifier_block *nb);
275 int devm_regulator_register_notifier(struct regulator *regulator,
276 struct notifier_block *nb);
277 int regulator_unregister_notifier(struct regulator *regulator,
278 struct notifier_block *nb);
279 void devm_regulator_unregister_notifier(struct regulator *regulator,
280 struct notifier_block *nb);
282 /* regulator suspend */
283 int regulator_suspend_enable(struct regulator_dev *rdev,
284 suspend_state_t state);
285 int regulator_suspend_disable(struct regulator_dev *rdev,
286 suspend_state_t state);
287 int regulator_set_suspend_voltage(struct regulator *regulator, int min_uV,
288 int max_uV, suspend_state_t state);
290 /* driver data - core doesn't touch */
291 void *regulator_get_drvdata(struct regulator *regulator);
292 void regulator_set_drvdata(struct regulator *regulator, void *data);
296 void regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
297 const char *const *supply_names,
298 unsigned int num_supplies);
300 bool regulator_is_equal(struct regulator *reg1, struct regulator *reg2);
305 * Make sure client drivers will still build on systems with no software
306 * controllable voltage or current regulators.
308 static inline struct regulator *__must_check regulator_get(struct device *dev,
311 /* Nothing except the stubbed out regulator API should be
312 * looking at the value except to check if it is an error
313 * value. Drivers are free to handle NULL specifically by
314 * skipping all regulator API calls, but they don't have to.
315 * Drivers which don't, should make sure they properly handle
316 * corner cases of the API, such as regulator_get_voltage()
322 static inline struct regulator *__must_check
323 devm_regulator_get(struct device *dev, const char *id)
328 static inline struct regulator *__must_check
329 regulator_get_exclusive(struct device *dev, const char *id)
331 return ERR_PTR(-ENODEV);
334 static inline struct regulator *__must_check
335 devm_regulator_get_exclusive(struct device *dev, const char *id)
337 return ERR_PTR(-ENODEV);
340 static inline struct regulator *__must_check
341 regulator_get_optional(struct device *dev, const char *id)
343 return ERR_PTR(-ENODEV);
347 static inline struct regulator *__must_check
348 devm_regulator_get_optional(struct device *dev, const char *id)
350 return ERR_PTR(-ENODEV);
353 static inline void regulator_put(struct regulator *regulator)
357 static inline void devm_regulator_put(struct regulator *regulator)
361 static inline int regulator_register_supply_alias(struct device *dev,
363 struct device *alias_dev,
364 const char *alias_id)
369 static inline void regulator_unregister_supply_alias(struct device *dev,
374 static inline int regulator_bulk_register_supply_alias(struct device *dev,
375 const char *const *id,
376 struct device *alias_dev,
377 const char * const *alias_id,
383 static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
384 const char * const *id,
389 static inline int devm_regulator_register_supply_alias(struct device *dev,
391 struct device *alias_dev,
392 const char *alias_id)
397 static inline void devm_regulator_unregister_supply_alias(struct device *dev,
402 static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
403 const char *const *id,
404 struct device *alias_dev,
405 const char *const *alias_id,
411 static inline void devm_regulator_bulk_unregister_supply_alias(
412 struct device *dev, const char *const *id, int num_id)
416 static inline int regulator_enable(struct regulator *regulator)
421 static inline int regulator_disable(struct regulator *regulator)
426 static inline int regulator_force_disable(struct regulator *regulator)
431 static inline int regulator_disable_deferred(struct regulator *regulator,
437 static inline int regulator_is_enabled(struct regulator *regulator)
442 static inline int regulator_bulk_get(struct device *dev,
444 struct regulator_bulk_data *consumers)
449 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
450 struct regulator_bulk_data *consumers)
455 static inline int regulator_bulk_enable(int num_consumers,
456 struct regulator_bulk_data *consumers)
461 static inline int regulator_bulk_disable(int num_consumers,
462 struct regulator_bulk_data *consumers)
467 static inline int regulator_bulk_force_disable(int num_consumers,
468 struct regulator_bulk_data *consumers)
473 static inline void regulator_bulk_free(int num_consumers,
474 struct regulator_bulk_data *consumers)
478 static inline int regulator_set_voltage(struct regulator *regulator,
479 int min_uV, int max_uV)
484 static inline int regulator_set_voltage_time(struct regulator *regulator,
485 int old_uV, int new_uV)
490 static inline int regulator_get_voltage(struct regulator *regulator)
495 static inline int regulator_sync_voltage(struct regulator *regulator)
500 static inline int regulator_is_supported_voltage(struct regulator *regulator,
501 int min_uV, int max_uV)
506 static inline unsigned int regulator_get_linear_step(struct regulator *regulator)
511 static inline int regulator_set_current_limit(struct regulator *regulator,
512 int min_uA, int max_uA)
517 static inline int regulator_get_current_limit(struct regulator *regulator)
522 static inline int regulator_set_mode(struct regulator *regulator,
528 static inline unsigned int regulator_get_mode(struct regulator *regulator)
530 return REGULATOR_MODE_NORMAL;
533 static inline int regulator_get_error_flags(struct regulator *regulator,
539 static inline int regulator_set_load(struct regulator *regulator, int load_uA)
544 static inline int regulator_allow_bypass(struct regulator *regulator,
550 static inline struct regmap *regulator_get_regmap(struct regulator *regulator)
552 return ERR_PTR(-EOPNOTSUPP);
555 static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
562 static inline int regulator_list_hardware_vsel(struct regulator *regulator,
568 static inline int regulator_register_notifier(struct regulator *regulator,
569 struct notifier_block *nb)
574 static inline int devm_regulator_register_notifier(struct regulator *regulator,
575 struct notifier_block *nb)
580 static inline int regulator_unregister_notifier(struct regulator *regulator,
581 struct notifier_block *nb)
586 static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
587 struct notifier_block *nb)
592 static inline int regulator_suspend_enable(struct regulator_dev *rdev,
593 suspend_state_t state)
598 static inline int regulator_suspend_disable(struct regulator_dev *rdev,
599 suspend_state_t state)
604 static inline int regulator_set_suspend_voltage(struct regulator *regulator,
605 int min_uV, int max_uV,
606 suspend_state_t state)
611 static inline void *regulator_get_drvdata(struct regulator *regulator)
616 static inline void regulator_set_drvdata(struct regulator *regulator,
621 static inline int regulator_count_voltages(struct regulator *regulator)
626 static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
632 regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
633 const char *const *supply_names,
634 unsigned int num_supplies)
639 regulator_is_equal(struct regulator *reg1, struct regulator *reg2)
645 static inline int regulator_set_voltage_triplet(struct regulator *regulator,
646 int min_uV, int target_uV,
649 if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
652 return regulator_set_voltage(regulator, min_uV, max_uV);
655 static inline int regulator_set_voltage_tol(struct regulator *regulator,
656 int new_uV, int tol_uV)
658 if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
661 return regulator_set_voltage(regulator,
662 new_uV - tol_uV, new_uV + tol_uV);
665 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
666 int target_uV, int tol_uV)
668 return regulator_is_supported_voltage(regulator,