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>
37 struct notifier_block;
41 * Regulator operating modes.
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.
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.
51 * In order of power efficiency (least efficient at top).
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.
58 * NORMAL Normal regulator power supply mode. Most drivers will
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.
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
73 * NOTE: Most regulators will only support a subset of these modes. Some
74 * will only just support NORMAL.
76 * These modes can be OR'ed together to make up a mask of valid register modes.
79 #define REGULATOR_MODE_INVALID 0x0
80 #define REGULATOR_MODE_FAST 0x1
81 #define REGULATOR_MODE_NORMAL 0x2
82 #define REGULATOR_MODE_IDLE 0x4
83 #define REGULATOR_MODE_STANDBY 0x8
86 * Regulator notifier events.
88 * UNDER_VOLTAGE Regulator output is under voltage.
89 * OVER_CURRENT Regulator output current is too high.
90 * REGULATION_OUT Regulator output is out of regulation.
91 * FAIL Regulator output has failed.
92 * OVER_TEMP Regulator over temp.
93 * FORCE_DISABLE Regulator forcibly shut down by software.
94 * VOLTAGE_CHANGE Regulator voltage changed.
95 * Data passed is old voltage cast to (void *).
96 * DISABLE Regulator was disabled.
97 * PRE_VOLTAGE_CHANGE Regulator is about to have voltage changed.
98 * Data passed is "struct pre_voltage_change_data"
99 * ABORT_VOLTAGE_CHANGE Regulator voltage change failed for some reason.
100 * Data passed is old voltage cast to (void *).
101 * PRE_DISABLE Regulator is about to be disabled
102 * ABORT_DISABLE Regulator disable failed for some reason
104 * NOTE: These events can be OR'ed together when passed into handler.
107 #define REGULATOR_EVENT_UNDER_VOLTAGE 0x01
108 #define REGULATOR_EVENT_OVER_CURRENT 0x02
109 #define REGULATOR_EVENT_REGULATION_OUT 0x04
110 #define REGULATOR_EVENT_FAIL 0x08
111 #define REGULATOR_EVENT_OVER_TEMP 0x10
112 #define REGULATOR_EVENT_FORCE_DISABLE 0x20
113 #define REGULATOR_EVENT_VOLTAGE_CHANGE 0x40
114 #define REGULATOR_EVENT_DISABLE 0x80
115 #define REGULATOR_EVENT_PRE_VOLTAGE_CHANGE 0x100
116 #define REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE 0x200
117 #define REGULATOR_EVENT_PRE_DISABLE 0x400
118 #define REGULATOR_EVENT_ABORT_DISABLE 0x800
119 #define REGULATOR_EVENT_ENABLE 0x1000
122 * Regulator errors that can be queried using regulator_get_error_flags
124 * UNDER_VOLTAGE Regulator output is under voltage.
125 * OVER_CURRENT Regulator output current is too high.
126 * REGULATION_OUT Regulator output is out of regulation.
127 * FAIL Regulator output has failed.
128 * OVER_TEMP Regulator over temp.
130 * NOTE: These errors can be OR'ed together.
133 #define REGULATOR_ERROR_UNDER_VOLTAGE BIT(1)
134 #define REGULATOR_ERROR_OVER_CURRENT BIT(2)
135 #define REGULATOR_ERROR_REGULATION_OUT BIT(3)
136 #define REGULATOR_ERROR_FAIL BIT(4)
137 #define REGULATOR_ERROR_OVER_TEMP BIT(5)
141 * struct pre_voltage_change_data - Data sent with PRE_VOLTAGE_CHANGE event
143 * @old_uV: Current voltage before change.
144 * @min_uV: Min voltage we'll change to.
145 * @max_uV: Max voltage we'll change to.
147 struct pre_voltage_change_data {
148 unsigned long old_uV;
149 unsigned long min_uV;
150 unsigned long max_uV;
156 * struct regulator_bulk_data - Data used for bulk regulator operations.
158 * @supply: The name of the supply. Initialised by the user before
159 * using the bulk regulator APIs.
160 * @consumer: The regulator consumer for the supply. This will be managed
163 * The regulator APIs provide a series of regulator_bulk_() API calls as
164 * a convenience to consumers which require multiple supplies. This
165 * structure is used to manage data for these calls.
167 struct regulator_bulk_data {
169 struct regulator *consumer;
171 /* private: Internal use */
175 #if defined(CONFIG_REGULATOR)
177 /* regulator get and put */
178 struct regulator *__must_check regulator_get(struct device *dev,
180 struct regulator *__must_check devm_regulator_get(struct device *dev,
182 struct regulator *__must_check regulator_get_exclusive(struct device *dev,
184 struct regulator *__must_check devm_regulator_get_exclusive(struct device *dev,
186 struct regulator *__must_check regulator_get_optional(struct device *dev,
188 struct regulator *__must_check devm_regulator_get_optional(struct device *dev,
190 void regulator_put(struct regulator *regulator);
191 void devm_regulator_put(struct regulator *regulator);
193 int regulator_register_supply_alias(struct device *dev, const char *id,
194 struct device *alias_dev,
195 const char *alias_id);
196 void regulator_unregister_supply_alias(struct device *dev, const char *id);
198 int 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 regulator_bulk_unregister_supply_alias(struct device *dev,
204 const char * const *id, int num_id);
206 int devm_regulator_register_supply_alias(struct device *dev, const char *id,
207 struct device *alias_dev,
208 const char *alias_id);
209 void devm_regulator_unregister_supply_alias(struct device *dev,
212 int devm_regulator_bulk_register_supply_alias(struct device *dev,
213 const char *const *id,
214 struct device *alias_dev,
215 const char *const *alias_id,
217 void devm_regulator_bulk_unregister_supply_alias(struct device *dev,
218 const char *const *id,
221 /* regulator output control and status */
222 int __must_check regulator_enable(struct regulator *regulator);
223 int regulator_disable(struct regulator *regulator);
224 int regulator_force_disable(struct regulator *regulator);
225 int regulator_is_enabled(struct regulator *regulator);
226 int regulator_disable_deferred(struct regulator *regulator, int ms);
228 int __must_check regulator_bulk_get(struct device *dev, int num_consumers,
229 struct regulator_bulk_data *consumers);
230 int __must_check devm_regulator_bulk_get(struct device *dev, int num_consumers,
231 struct regulator_bulk_data *consumers);
232 int __must_check regulator_bulk_enable(int num_consumers,
233 struct regulator_bulk_data *consumers);
234 int regulator_bulk_disable(int num_consumers,
235 struct regulator_bulk_data *consumers);
236 int regulator_bulk_force_disable(int num_consumers,
237 struct regulator_bulk_data *consumers);
238 void regulator_bulk_free(int num_consumers,
239 struct regulator_bulk_data *consumers);
241 int regulator_count_voltages(struct regulator *regulator);
242 int regulator_list_voltage(struct regulator *regulator, unsigned selector);
243 int regulator_is_supported_voltage(struct regulator *regulator,
244 int min_uV, int max_uV);
245 unsigned int regulator_get_linear_step(struct regulator *regulator);
246 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV);
247 int regulator_set_voltage_time(struct regulator *regulator,
248 int old_uV, int new_uV);
249 int regulator_get_voltage(struct regulator *regulator);
250 int regulator_sync_voltage(struct regulator *regulator);
251 int regulator_set_current_limit(struct regulator *regulator,
252 int min_uA, int max_uA);
253 int regulator_get_current_limit(struct regulator *regulator);
255 int regulator_set_mode(struct regulator *regulator, unsigned int mode);
256 unsigned int regulator_get_mode(struct regulator *regulator);
257 int regulator_get_error_flags(struct regulator *regulator,
258 unsigned int *flags);
259 int regulator_set_load(struct regulator *regulator, int load_uA);
261 int regulator_allow_bypass(struct regulator *regulator, bool allow);
263 struct regmap *regulator_get_regmap(struct regulator *regulator);
264 int regulator_get_hardware_vsel_register(struct regulator *regulator,
266 unsigned *vsel_mask);
267 int regulator_list_hardware_vsel(struct regulator *regulator,
270 /* regulator notifier block */
271 int regulator_register_notifier(struct regulator *regulator,
272 struct notifier_block *nb);
273 int devm_regulator_register_notifier(struct regulator *regulator,
274 struct notifier_block *nb);
275 int regulator_unregister_notifier(struct regulator *regulator,
276 struct notifier_block *nb);
277 void devm_regulator_unregister_notifier(struct regulator *regulator,
278 struct notifier_block *nb);
280 /* driver data - core doesn't touch */
281 void *regulator_get_drvdata(struct regulator *regulator);
282 void regulator_set_drvdata(struct regulator *regulator, void *data);
286 void regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
287 const char *const *supply_names,
288 unsigned int num_supplies);
293 * Make sure client drivers will still build on systems with no software
294 * controllable voltage or current regulators.
296 static inline struct regulator *__must_check regulator_get(struct device *dev,
299 /* Nothing except the stubbed out regulator API should be
300 * looking at the value except to check if it is an error
301 * value. Drivers are free to handle NULL specifically by
302 * skipping all regulator API calls, but they don't have to.
303 * Drivers which don't, should make sure they properly handle
304 * corner cases of the API, such as regulator_get_voltage()
310 static inline struct regulator *__must_check
311 devm_regulator_get(struct device *dev, const char *id)
316 static inline struct regulator *__must_check
317 regulator_get_exclusive(struct device *dev, const char *id)
319 return ERR_PTR(-ENODEV);
322 static inline struct regulator *__must_check
323 regulator_get_optional(struct device *dev, const char *id)
325 return ERR_PTR(-ENODEV);
329 static inline struct regulator *__must_check
330 devm_regulator_get_optional(struct device *dev, const char *id)
332 return ERR_PTR(-ENODEV);
335 static inline void regulator_put(struct regulator *regulator)
339 static inline void devm_regulator_put(struct regulator *regulator)
343 static inline int regulator_register_supply_alias(struct device *dev,
345 struct device *alias_dev,
346 const char *alias_id)
351 static inline void regulator_unregister_supply_alias(struct device *dev,
356 static inline int regulator_bulk_register_supply_alias(struct device *dev,
357 const char *const *id,
358 struct device *alias_dev,
359 const char * const *alias_id,
365 static inline void regulator_bulk_unregister_supply_alias(struct device *dev,
366 const char * const *id,
371 static inline int devm_regulator_register_supply_alias(struct device *dev,
373 struct device *alias_dev,
374 const char *alias_id)
379 static inline void devm_regulator_unregister_supply_alias(struct device *dev,
384 static inline int devm_regulator_bulk_register_supply_alias(struct device *dev,
385 const char *const *id,
386 struct device *alias_dev,
387 const char *const *alias_id,
393 static inline void devm_regulator_bulk_unregister_supply_alias(
394 struct device *dev, const char *const *id, int num_id)
398 static inline int regulator_enable(struct regulator *regulator)
403 static inline int regulator_disable(struct regulator *regulator)
408 static inline int regulator_force_disable(struct regulator *regulator)
413 static inline int regulator_disable_deferred(struct regulator *regulator,
419 static inline int regulator_is_enabled(struct regulator *regulator)
424 static inline int regulator_bulk_get(struct device *dev,
426 struct regulator_bulk_data *consumers)
431 static inline int devm_regulator_bulk_get(struct device *dev, int num_consumers,
432 struct regulator_bulk_data *consumers)
437 static inline int regulator_bulk_enable(int num_consumers,
438 struct regulator_bulk_data *consumers)
443 static inline int regulator_bulk_disable(int num_consumers,
444 struct regulator_bulk_data *consumers)
449 static inline int regulator_bulk_force_disable(int num_consumers,
450 struct regulator_bulk_data *consumers)
455 static inline void regulator_bulk_free(int num_consumers,
456 struct regulator_bulk_data *consumers)
460 static inline int regulator_set_voltage(struct regulator *regulator,
461 int min_uV, int max_uV)
466 static inline int regulator_set_voltage_time(struct regulator *regulator,
467 int old_uV, int new_uV)
472 static inline int regulator_get_voltage(struct regulator *regulator)
477 static inline int regulator_is_supported_voltage(struct regulator *regulator,
478 int min_uV, int max_uV)
483 static inline unsigned int regulator_get_linear_step(struct regulator *regulator)
488 static inline int regulator_set_current_limit(struct regulator *regulator,
489 int min_uA, int max_uA)
494 static inline int regulator_get_current_limit(struct regulator *regulator)
499 static inline int regulator_set_mode(struct regulator *regulator,
505 static inline unsigned int regulator_get_mode(struct regulator *regulator)
507 return REGULATOR_MODE_NORMAL;
510 static inline int regulator_get_error_flags(struct regulator *regulator,
516 static inline int regulator_set_load(struct regulator *regulator, int load_uA)
521 static inline int regulator_allow_bypass(struct regulator *regulator,
527 static inline struct regmap *regulator_get_regmap(struct regulator *regulator)
529 return ERR_PTR(-EOPNOTSUPP);
532 static inline int regulator_get_hardware_vsel_register(struct regulator *regulator,
539 static inline int regulator_list_hardware_vsel(struct regulator *regulator,
545 static inline int regulator_register_notifier(struct regulator *regulator,
546 struct notifier_block *nb)
551 static inline int devm_regulator_register_notifier(struct regulator *regulator,
552 struct notifier_block *nb)
557 static inline int regulator_unregister_notifier(struct regulator *regulator,
558 struct notifier_block *nb)
563 static inline int devm_regulator_unregister_notifier(struct regulator *regulator,
564 struct notifier_block *nb)
569 static inline void *regulator_get_drvdata(struct regulator *regulator)
574 static inline void regulator_set_drvdata(struct regulator *regulator,
579 static inline int regulator_count_voltages(struct regulator *regulator)
584 static inline int regulator_list_voltage(struct regulator *regulator, unsigned selector)
590 regulator_bulk_set_supply_names(struct regulator_bulk_data *consumers,
591 const char *const *supply_names,
592 unsigned int num_supplies)
598 static inline int regulator_set_voltage_triplet(struct regulator *regulator,
599 int min_uV, int target_uV,
602 if (regulator_set_voltage(regulator, target_uV, max_uV) == 0)
605 return regulator_set_voltage(regulator, min_uV, max_uV);
608 static inline int regulator_set_voltage_tol(struct regulator *regulator,
609 int new_uV, int tol_uV)
611 if (regulator_set_voltage(regulator, new_uV, new_uV + tol_uV) == 0)
614 return regulator_set_voltage(regulator,
615 new_uV - tol_uV, new_uV + tol_uV);
618 static inline int regulator_is_supported_voltage_tol(struct regulator *regulator,
619 int target_uV, int tol_uV)
621 return regulator_is_supported_voltage(regulator,