1 // SPDX-License-Identifier: GPL-2.0-or-later
3 // core.c -- Voltage/Current Regulator framework.
5 // Copyright 2007, 2008 Wolfson Microelectronics PLC.
6 // Copyright 2008 SlimLogic Ltd.
8 // Author: Liam Girdwood <lrg@slimlogic.co.uk>
10 #include <linux/kernel.h>
11 #include <linux/init.h>
12 #include <linux/debugfs.h>
13 #include <linux/device.h>
14 #include <linux/slab.h>
15 #include <linux/async.h>
16 #include <linux/err.h>
17 #include <linux/mutex.h>
18 #include <linux/suspend.h>
19 #include <linux/delay.h>
20 #include <linux/gpio/consumer.h>
22 #include <linux/regmap.h>
23 #include <linux/regulator/of_regulator.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/regulator/coupler.h>
26 #include <linux/regulator/driver.h>
27 #include <linux/regulator/machine.h>
28 #include <linux/module.h>
30 #define CREATE_TRACE_POINTS
31 #include <trace/events/regulator.h>
36 static DEFINE_WW_CLASS(regulator_ww_class);
37 static DEFINE_MUTEX(regulator_nesting_mutex);
38 static DEFINE_MUTEX(regulator_list_mutex);
39 static LIST_HEAD(regulator_map_list);
40 static LIST_HEAD(regulator_ena_gpio_list);
41 static LIST_HEAD(regulator_supply_alias_list);
42 static LIST_HEAD(regulator_coupler_list);
43 static bool has_full_constraints;
45 static struct dentry *debugfs_root;
48 * struct regulator_map
50 * Used to provide symbolic supply names to devices.
52 struct regulator_map {
53 struct list_head list;
54 const char *dev_name; /* The dev_name() for the consumer */
56 struct regulator_dev *regulator;
60 * struct regulator_enable_gpio
62 * Management for shared enable GPIO pin
64 struct regulator_enable_gpio {
65 struct list_head list;
66 struct gpio_desc *gpiod;
67 u32 enable_count; /* a number of enabled shared GPIO */
68 u32 request_count; /* a number of requested shared GPIO */
72 * struct regulator_supply_alias
74 * Used to map lookups for a supply onto an alternative device.
76 struct regulator_supply_alias {
77 struct list_head list;
78 struct device *src_dev;
79 const char *src_supply;
80 struct device *alias_dev;
81 const char *alias_supply;
84 static int _regulator_is_enabled(struct regulator_dev *rdev);
85 static int _regulator_disable(struct regulator *regulator);
86 static int _regulator_get_error_flags(struct regulator_dev *rdev, unsigned int *flags);
87 static int _regulator_get_current_limit(struct regulator_dev *rdev);
88 static unsigned int _regulator_get_mode(struct regulator_dev *rdev);
89 static int _notifier_call_chain(struct regulator_dev *rdev,
90 unsigned long event, void *data);
91 static int _regulator_do_set_voltage(struct regulator_dev *rdev,
92 int min_uV, int max_uV);
93 static int regulator_balance_voltage(struct regulator_dev *rdev,
94 suspend_state_t state);
95 static struct regulator *create_regulator(struct regulator_dev *rdev,
97 const char *supply_name);
98 static void destroy_regulator(struct regulator *regulator);
99 static void _regulator_put(struct regulator *regulator);
101 const char *rdev_get_name(struct regulator_dev *rdev)
103 if (rdev->constraints && rdev->constraints->name)
104 return rdev->constraints->name;
105 else if (rdev->desc->name)
106 return rdev->desc->name;
110 EXPORT_SYMBOL_GPL(rdev_get_name);
112 static bool have_full_constraints(void)
114 return has_full_constraints || of_have_populated_dt();
117 static bool regulator_ops_is_valid(struct regulator_dev *rdev, int ops)
119 if (!rdev->constraints) {
120 rdev_err(rdev, "no constraints\n");
124 if (rdev->constraints->valid_ops_mask & ops)
131 * regulator_lock_nested - lock a single regulator
132 * @rdev: regulator source
133 * @ww_ctx: w/w mutex acquire context
135 * This function can be called many times by one task on
136 * a single regulator and its mutex will be locked only
137 * once. If a task, which is calling this function is other
138 * than the one, which initially locked the mutex, it will
141 static inline int regulator_lock_nested(struct regulator_dev *rdev,
142 struct ww_acquire_ctx *ww_ctx)
147 mutex_lock(®ulator_nesting_mutex);
149 if (!ww_mutex_trylock(&rdev->mutex, ww_ctx)) {
150 if (rdev->mutex_owner == current)
156 mutex_unlock(®ulator_nesting_mutex);
157 ret = ww_mutex_lock(&rdev->mutex, ww_ctx);
158 mutex_lock(®ulator_nesting_mutex);
164 if (lock && ret != -EDEADLK) {
166 rdev->mutex_owner = current;
169 mutex_unlock(®ulator_nesting_mutex);
175 * regulator_lock - lock a single regulator
176 * @rdev: regulator source
178 * This function can be called many times by one task on
179 * a single regulator and its mutex will be locked only
180 * once. If a task, which is calling this function is other
181 * than the one, which initially locked the mutex, it will
184 static void regulator_lock(struct regulator_dev *rdev)
186 regulator_lock_nested(rdev, NULL);
190 * regulator_unlock - unlock a single regulator
191 * @rdev: regulator_source
193 * This function unlocks the mutex when the
194 * reference counter reaches 0.
196 static void regulator_unlock(struct regulator_dev *rdev)
198 mutex_lock(®ulator_nesting_mutex);
200 if (--rdev->ref_cnt == 0) {
201 rdev->mutex_owner = NULL;
202 ww_mutex_unlock(&rdev->mutex);
205 WARN_ON_ONCE(rdev->ref_cnt < 0);
207 mutex_unlock(®ulator_nesting_mutex);
210 static bool regulator_supply_is_couple(struct regulator_dev *rdev)
212 struct regulator_dev *c_rdev;
215 for (i = 1; i < rdev->coupling_desc.n_coupled; i++) {
216 c_rdev = rdev->coupling_desc.coupled_rdevs[i];
218 if (rdev->supply->rdev == c_rdev)
225 static void regulator_unlock_recursive(struct regulator_dev *rdev,
226 unsigned int n_coupled)
228 struct regulator_dev *c_rdev, *supply_rdev;
229 int i, supply_n_coupled;
231 for (i = n_coupled; i > 0; i--) {
232 c_rdev = rdev->coupling_desc.coupled_rdevs[i - 1];
237 if (c_rdev->supply && !regulator_supply_is_couple(c_rdev)) {
238 supply_rdev = c_rdev->supply->rdev;
239 supply_n_coupled = supply_rdev->coupling_desc.n_coupled;
241 regulator_unlock_recursive(supply_rdev,
245 regulator_unlock(c_rdev);
249 static int regulator_lock_recursive(struct regulator_dev *rdev,
250 struct regulator_dev **new_contended_rdev,
251 struct regulator_dev **old_contended_rdev,
252 struct ww_acquire_ctx *ww_ctx)
254 struct regulator_dev *c_rdev;
257 for (i = 0; i < rdev->coupling_desc.n_coupled; i++) {
258 c_rdev = rdev->coupling_desc.coupled_rdevs[i];
263 if (c_rdev != *old_contended_rdev) {
264 err = regulator_lock_nested(c_rdev, ww_ctx);
266 if (err == -EDEADLK) {
267 *new_contended_rdev = c_rdev;
271 /* shouldn't happen */
272 WARN_ON_ONCE(err != -EALREADY);
275 *old_contended_rdev = NULL;
278 if (c_rdev->supply && !regulator_supply_is_couple(c_rdev)) {
279 err = regulator_lock_recursive(c_rdev->supply->rdev,
284 regulator_unlock(c_rdev);
293 regulator_unlock_recursive(rdev, i);
299 * regulator_unlock_dependent - unlock regulator's suppliers and coupled
301 * @rdev: regulator source
302 * @ww_ctx: w/w mutex acquire context
304 * Unlock all regulators related with rdev by coupling or supplying.
306 static void regulator_unlock_dependent(struct regulator_dev *rdev,
307 struct ww_acquire_ctx *ww_ctx)
309 regulator_unlock_recursive(rdev, rdev->coupling_desc.n_coupled);
310 ww_acquire_fini(ww_ctx);
314 * regulator_lock_dependent - lock regulator's suppliers and coupled regulators
315 * @rdev: regulator source
316 * @ww_ctx: w/w mutex acquire context
318 * This function as a wrapper on regulator_lock_recursive(), which locks
319 * all regulators related with rdev by coupling or supplying.
321 static void regulator_lock_dependent(struct regulator_dev *rdev,
322 struct ww_acquire_ctx *ww_ctx)
324 struct regulator_dev *new_contended_rdev = NULL;
325 struct regulator_dev *old_contended_rdev = NULL;
328 mutex_lock(®ulator_list_mutex);
330 ww_acquire_init(ww_ctx, ®ulator_ww_class);
333 if (new_contended_rdev) {
334 ww_mutex_lock_slow(&new_contended_rdev->mutex, ww_ctx);
335 old_contended_rdev = new_contended_rdev;
336 old_contended_rdev->ref_cnt++;
339 err = regulator_lock_recursive(rdev,
344 if (old_contended_rdev)
345 regulator_unlock(old_contended_rdev);
347 } while (err == -EDEADLK);
349 ww_acquire_done(ww_ctx);
351 mutex_unlock(®ulator_list_mutex);
355 * of_get_child_regulator - get a child regulator device node
356 * based on supply name
357 * @parent: Parent device node
358 * @prop_name: Combination regulator supply name and "-supply"
360 * Traverse all child nodes.
361 * Extract the child regulator device node corresponding to the supply name.
362 * returns the device node corresponding to the regulator if found, else
365 static struct device_node *of_get_child_regulator(struct device_node *parent,
366 const char *prop_name)
368 struct device_node *regnode = NULL;
369 struct device_node *child = NULL;
371 for_each_child_of_node(parent, child) {
372 regnode = of_parse_phandle(child, prop_name, 0);
375 regnode = of_get_child_regulator(child, prop_name);
390 * of_get_regulator - get a regulator device node based on supply name
391 * @dev: Device pointer for the consumer (of regulator) device
392 * @supply: regulator supply name
394 * Extract the regulator device node corresponding to the supply name.
395 * returns the device node corresponding to the regulator if found, else
398 static struct device_node *of_get_regulator(struct device *dev, const char *supply)
400 struct device_node *regnode = NULL;
401 char prop_name[64]; /* 64 is max size of property name */
403 dev_dbg(dev, "Looking up %s-supply from device tree\n", supply);
405 snprintf(prop_name, 64, "%s-supply", supply);
406 regnode = of_parse_phandle(dev->of_node, prop_name, 0);
409 regnode = of_get_child_regulator(dev->of_node, prop_name);
413 dev_dbg(dev, "Looking up %s property in node %pOF failed\n",
414 prop_name, dev->of_node);
420 /* Platform voltage constraint check */
421 int regulator_check_voltage(struct regulator_dev *rdev,
422 int *min_uV, int *max_uV)
424 BUG_ON(*min_uV > *max_uV);
426 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE)) {
427 rdev_err(rdev, "voltage operation not allowed\n");
431 if (*max_uV > rdev->constraints->max_uV)
432 *max_uV = rdev->constraints->max_uV;
433 if (*min_uV < rdev->constraints->min_uV)
434 *min_uV = rdev->constraints->min_uV;
436 if (*min_uV > *max_uV) {
437 rdev_err(rdev, "unsupportable voltage range: %d-%duV\n",
445 /* return 0 if the state is valid */
446 static int regulator_check_states(suspend_state_t state)
448 return (state > PM_SUSPEND_MAX || state == PM_SUSPEND_TO_IDLE);
451 /* Make sure we select a voltage that suits the needs of all
452 * regulator consumers
454 int regulator_check_consumers(struct regulator_dev *rdev,
455 int *min_uV, int *max_uV,
456 suspend_state_t state)
458 struct regulator *regulator;
459 struct regulator_voltage *voltage;
461 list_for_each_entry(regulator, &rdev->consumer_list, list) {
462 voltage = ®ulator->voltage[state];
464 * Assume consumers that didn't say anything are OK
465 * with anything in the constraint range.
467 if (!voltage->min_uV && !voltage->max_uV)
470 if (*max_uV > voltage->max_uV)
471 *max_uV = voltage->max_uV;
472 if (*min_uV < voltage->min_uV)
473 *min_uV = voltage->min_uV;
476 if (*min_uV > *max_uV) {
477 rdev_err(rdev, "Restricting voltage, %u-%uuV\n",
485 /* current constraint check */
486 static int regulator_check_current_limit(struct regulator_dev *rdev,
487 int *min_uA, int *max_uA)
489 BUG_ON(*min_uA > *max_uA);
491 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_CURRENT)) {
492 rdev_err(rdev, "current operation not allowed\n");
496 if (*max_uA > rdev->constraints->max_uA)
497 *max_uA = rdev->constraints->max_uA;
498 if (*min_uA < rdev->constraints->min_uA)
499 *min_uA = rdev->constraints->min_uA;
501 if (*min_uA > *max_uA) {
502 rdev_err(rdev, "unsupportable current range: %d-%duA\n",
510 /* operating mode constraint check */
511 static int regulator_mode_constrain(struct regulator_dev *rdev,
515 case REGULATOR_MODE_FAST:
516 case REGULATOR_MODE_NORMAL:
517 case REGULATOR_MODE_IDLE:
518 case REGULATOR_MODE_STANDBY:
521 rdev_err(rdev, "invalid mode %x specified\n", *mode);
525 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_MODE)) {
526 rdev_err(rdev, "mode operation not allowed\n");
530 /* The modes are bitmasks, the most power hungry modes having
531 * the lowest values. If the requested mode isn't supported
535 if (rdev->constraints->valid_modes_mask & *mode)
543 static inline struct regulator_state *
544 regulator_get_suspend_state(struct regulator_dev *rdev, suspend_state_t state)
546 if (rdev->constraints == NULL)
550 case PM_SUSPEND_STANDBY:
551 return &rdev->constraints->state_standby;
553 return &rdev->constraints->state_mem;
555 return &rdev->constraints->state_disk;
561 static const struct regulator_state *
562 regulator_get_suspend_state_check(struct regulator_dev *rdev, suspend_state_t state)
564 const struct regulator_state *rstate;
566 rstate = regulator_get_suspend_state(rdev, state);
570 /* If we have no suspend mode configuration don't set anything;
571 * only warn if the driver implements set_suspend_voltage or
572 * set_suspend_mode callback.
574 if (rstate->enabled != ENABLE_IN_SUSPEND &&
575 rstate->enabled != DISABLE_IN_SUSPEND) {
576 if (rdev->desc->ops->set_suspend_voltage ||
577 rdev->desc->ops->set_suspend_mode)
578 rdev_warn(rdev, "No configuration\n");
585 static ssize_t microvolts_show(struct device *dev,
586 struct device_attribute *attr, char *buf)
588 struct regulator_dev *rdev = dev_get_drvdata(dev);
591 regulator_lock(rdev);
592 uV = regulator_get_voltage_rdev(rdev);
593 regulator_unlock(rdev);
597 return sprintf(buf, "%d\n", uV);
599 static DEVICE_ATTR_RO(microvolts);
601 static ssize_t microamps_show(struct device *dev,
602 struct device_attribute *attr, char *buf)
604 struct regulator_dev *rdev = dev_get_drvdata(dev);
606 return sprintf(buf, "%d\n", _regulator_get_current_limit(rdev));
608 static DEVICE_ATTR_RO(microamps);
610 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
613 struct regulator_dev *rdev = dev_get_drvdata(dev);
615 return sprintf(buf, "%s\n", rdev_get_name(rdev));
617 static DEVICE_ATTR_RO(name);
619 static const char *regulator_opmode_to_str(int mode)
622 case REGULATOR_MODE_FAST:
624 case REGULATOR_MODE_NORMAL:
626 case REGULATOR_MODE_IDLE:
628 case REGULATOR_MODE_STANDBY:
634 static ssize_t regulator_print_opmode(char *buf, int mode)
636 return sprintf(buf, "%s\n", regulator_opmode_to_str(mode));
639 static ssize_t opmode_show(struct device *dev,
640 struct device_attribute *attr, char *buf)
642 struct regulator_dev *rdev = dev_get_drvdata(dev);
644 return regulator_print_opmode(buf, _regulator_get_mode(rdev));
646 static DEVICE_ATTR_RO(opmode);
648 static ssize_t regulator_print_state(char *buf, int state)
651 return sprintf(buf, "enabled\n");
653 return sprintf(buf, "disabled\n");
655 return sprintf(buf, "unknown\n");
658 static ssize_t state_show(struct device *dev,
659 struct device_attribute *attr, char *buf)
661 struct regulator_dev *rdev = dev_get_drvdata(dev);
664 regulator_lock(rdev);
665 ret = regulator_print_state(buf, _regulator_is_enabled(rdev));
666 regulator_unlock(rdev);
670 static DEVICE_ATTR_RO(state);
672 static ssize_t status_show(struct device *dev,
673 struct device_attribute *attr, char *buf)
675 struct regulator_dev *rdev = dev_get_drvdata(dev);
679 status = rdev->desc->ops->get_status(rdev);
684 case REGULATOR_STATUS_OFF:
687 case REGULATOR_STATUS_ON:
690 case REGULATOR_STATUS_ERROR:
693 case REGULATOR_STATUS_FAST:
696 case REGULATOR_STATUS_NORMAL:
699 case REGULATOR_STATUS_IDLE:
702 case REGULATOR_STATUS_STANDBY:
705 case REGULATOR_STATUS_BYPASS:
708 case REGULATOR_STATUS_UNDEFINED:
715 return sprintf(buf, "%s\n", label);
717 static DEVICE_ATTR_RO(status);
719 static ssize_t min_microamps_show(struct device *dev,
720 struct device_attribute *attr, char *buf)
722 struct regulator_dev *rdev = dev_get_drvdata(dev);
724 if (!rdev->constraints)
725 return sprintf(buf, "constraint not defined\n");
727 return sprintf(buf, "%d\n", rdev->constraints->min_uA);
729 static DEVICE_ATTR_RO(min_microamps);
731 static ssize_t max_microamps_show(struct device *dev,
732 struct device_attribute *attr, char *buf)
734 struct regulator_dev *rdev = dev_get_drvdata(dev);
736 if (!rdev->constraints)
737 return sprintf(buf, "constraint not defined\n");
739 return sprintf(buf, "%d\n", rdev->constraints->max_uA);
741 static DEVICE_ATTR_RO(max_microamps);
743 static ssize_t min_microvolts_show(struct device *dev,
744 struct device_attribute *attr, char *buf)
746 struct regulator_dev *rdev = dev_get_drvdata(dev);
748 if (!rdev->constraints)
749 return sprintf(buf, "constraint not defined\n");
751 return sprintf(buf, "%d\n", rdev->constraints->min_uV);
753 static DEVICE_ATTR_RO(min_microvolts);
755 static ssize_t max_microvolts_show(struct device *dev,
756 struct device_attribute *attr, char *buf)
758 struct regulator_dev *rdev = dev_get_drvdata(dev);
760 if (!rdev->constraints)
761 return sprintf(buf, "constraint not defined\n");
763 return sprintf(buf, "%d\n", rdev->constraints->max_uV);
765 static DEVICE_ATTR_RO(max_microvolts);
767 static ssize_t requested_microamps_show(struct device *dev,
768 struct device_attribute *attr, char *buf)
770 struct regulator_dev *rdev = dev_get_drvdata(dev);
771 struct regulator *regulator;
774 regulator_lock(rdev);
775 list_for_each_entry(regulator, &rdev->consumer_list, list) {
776 if (regulator->enable_count)
777 uA += regulator->uA_load;
779 regulator_unlock(rdev);
780 return sprintf(buf, "%d\n", uA);
782 static DEVICE_ATTR_RO(requested_microamps);
784 static ssize_t num_users_show(struct device *dev, struct device_attribute *attr,
787 struct regulator_dev *rdev = dev_get_drvdata(dev);
788 return sprintf(buf, "%d\n", rdev->use_count);
790 static DEVICE_ATTR_RO(num_users);
792 static ssize_t type_show(struct device *dev, struct device_attribute *attr,
795 struct regulator_dev *rdev = dev_get_drvdata(dev);
797 switch (rdev->desc->type) {
798 case REGULATOR_VOLTAGE:
799 return sprintf(buf, "voltage\n");
800 case REGULATOR_CURRENT:
801 return sprintf(buf, "current\n");
803 return sprintf(buf, "unknown\n");
805 static DEVICE_ATTR_RO(type);
807 static ssize_t suspend_mem_microvolts_show(struct device *dev,
808 struct device_attribute *attr, char *buf)
810 struct regulator_dev *rdev = dev_get_drvdata(dev);
812 return sprintf(buf, "%d\n", rdev->constraints->state_mem.uV);
814 static DEVICE_ATTR_RO(suspend_mem_microvolts);
816 static ssize_t suspend_disk_microvolts_show(struct device *dev,
817 struct device_attribute *attr, char *buf)
819 struct regulator_dev *rdev = dev_get_drvdata(dev);
821 return sprintf(buf, "%d\n", rdev->constraints->state_disk.uV);
823 static DEVICE_ATTR_RO(suspend_disk_microvolts);
825 static ssize_t suspend_standby_microvolts_show(struct device *dev,
826 struct device_attribute *attr, char *buf)
828 struct regulator_dev *rdev = dev_get_drvdata(dev);
830 return sprintf(buf, "%d\n", rdev->constraints->state_standby.uV);
832 static DEVICE_ATTR_RO(suspend_standby_microvolts);
834 static ssize_t suspend_mem_mode_show(struct device *dev,
835 struct device_attribute *attr, char *buf)
837 struct regulator_dev *rdev = dev_get_drvdata(dev);
839 return regulator_print_opmode(buf,
840 rdev->constraints->state_mem.mode);
842 static DEVICE_ATTR_RO(suspend_mem_mode);
844 static ssize_t suspend_disk_mode_show(struct device *dev,
845 struct device_attribute *attr, char *buf)
847 struct regulator_dev *rdev = dev_get_drvdata(dev);
849 return regulator_print_opmode(buf,
850 rdev->constraints->state_disk.mode);
852 static DEVICE_ATTR_RO(suspend_disk_mode);
854 static ssize_t suspend_standby_mode_show(struct device *dev,
855 struct device_attribute *attr, char *buf)
857 struct regulator_dev *rdev = dev_get_drvdata(dev);
859 return regulator_print_opmode(buf,
860 rdev->constraints->state_standby.mode);
862 static DEVICE_ATTR_RO(suspend_standby_mode);
864 static ssize_t suspend_mem_state_show(struct device *dev,
865 struct device_attribute *attr, char *buf)
867 struct regulator_dev *rdev = dev_get_drvdata(dev);
869 return regulator_print_state(buf,
870 rdev->constraints->state_mem.enabled);
872 static DEVICE_ATTR_RO(suspend_mem_state);
874 static ssize_t suspend_disk_state_show(struct device *dev,
875 struct device_attribute *attr, char *buf)
877 struct regulator_dev *rdev = dev_get_drvdata(dev);
879 return regulator_print_state(buf,
880 rdev->constraints->state_disk.enabled);
882 static DEVICE_ATTR_RO(suspend_disk_state);
884 static ssize_t suspend_standby_state_show(struct device *dev,
885 struct device_attribute *attr, char *buf)
887 struct regulator_dev *rdev = dev_get_drvdata(dev);
889 return regulator_print_state(buf,
890 rdev->constraints->state_standby.enabled);
892 static DEVICE_ATTR_RO(suspend_standby_state);
894 static ssize_t bypass_show(struct device *dev,
895 struct device_attribute *attr, char *buf)
897 struct regulator_dev *rdev = dev_get_drvdata(dev);
902 ret = rdev->desc->ops->get_bypass(rdev, &bypass);
911 return sprintf(buf, "%s\n", report);
913 static DEVICE_ATTR_RO(bypass);
915 #define REGULATOR_ERROR_ATTR(name, bit) \
916 static ssize_t name##_show(struct device *dev, struct device_attribute *attr, \
920 unsigned int flags; \
921 struct regulator_dev *rdev = dev_get_drvdata(dev); \
922 ret = _regulator_get_error_flags(rdev, &flags); \
925 return sysfs_emit(buf, "%d\n", !!(flags & (bit))); \
927 static DEVICE_ATTR_RO(name)
929 REGULATOR_ERROR_ATTR(under_voltage, REGULATOR_ERROR_UNDER_VOLTAGE);
930 REGULATOR_ERROR_ATTR(over_current, REGULATOR_ERROR_OVER_CURRENT);
931 REGULATOR_ERROR_ATTR(regulation_out, REGULATOR_ERROR_REGULATION_OUT);
932 REGULATOR_ERROR_ATTR(fail, REGULATOR_ERROR_FAIL);
933 REGULATOR_ERROR_ATTR(over_temp, REGULATOR_ERROR_OVER_TEMP);
934 REGULATOR_ERROR_ATTR(under_voltage_warn, REGULATOR_ERROR_UNDER_VOLTAGE_WARN);
935 REGULATOR_ERROR_ATTR(over_current_warn, REGULATOR_ERROR_OVER_CURRENT_WARN);
936 REGULATOR_ERROR_ATTR(over_voltage_warn, REGULATOR_ERROR_OVER_VOLTAGE_WARN);
937 REGULATOR_ERROR_ATTR(over_temp_warn, REGULATOR_ERROR_OVER_TEMP_WARN);
939 /* Calculate the new optimum regulator operating mode based on the new total
940 * consumer load. All locks held by caller
942 static int drms_uA_update(struct regulator_dev *rdev)
944 struct regulator *sibling;
945 int current_uA = 0, output_uV, input_uV, err;
949 * first check to see if we can set modes at all, otherwise just
950 * tell the consumer everything is OK.
952 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_DRMS)) {
953 rdev_dbg(rdev, "DRMS operation not allowed\n");
957 if (!rdev->desc->ops->get_optimum_mode &&
958 !rdev->desc->ops->set_load)
961 if (!rdev->desc->ops->set_mode &&
962 !rdev->desc->ops->set_load)
965 /* calc total requested load */
966 list_for_each_entry(sibling, &rdev->consumer_list, list) {
967 if (sibling->enable_count)
968 current_uA += sibling->uA_load;
971 current_uA += rdev->constraints->system_load;
973 if (rdev->desc->ops->set_load) {
974 /* set the optimum mode for our new total regulator load */
975 err = rdev->desc->ops->set_load(rdev, current_uA);
977 rdev_err(rdev, "failed to set load %d: %pe\n",
978 current_uA, ERR_PTR(err));
981 * Unfortunately in some cases the constraints->valid_ops has
982 * REGULATOR_CHANGE_DRMS but there are no valid modes listed.
983 * That's not really legit but we won't consider it a fatal
984 * error here. We'll treat it as if REGULATOR_CHANGE_DRMS
987 if (!rdev->constraints->valid_modes_mask) {
988 rdev_dbg(rdev, "Can change modes; but no valid mode\n");
992 /* get output voltage */
993 output_uV = regulator_get_voltage_rdev(rdev);
996 * Don't return an error; if regulator driver cares about
997 * output_uV then it's up to the driver to validate.
1000 rdev_dbg(rdev, "invalid output voltage found\n");
1002 /* get input voltage */
1005 input_uV = regulator_get_voltage_rdev(rdev->supply->rdev);
1007 input_uV = rdev->constraints->input_uV;
1010 * Don't return an error; if regulator driver cares about
1011 * input_uV then it's up to the driver to validate.
1014 rdev_dbg(rdev, "invalid input voltage found\n");
1016 /* now get the optimum mode for our new total regulator load */
1017 mode = rdev->desc->ops->get_optimum_mode(rdev, input_uV,
1018 output_uV, current_uA);
1020 /* check the new mode is allowed */
1021 err = regulator_mode_constrain(rdev, &mode);
1023 rdev_err(rdev, "failed to get optimum mode @ %d uA %d -> %d uV: %pe\n",
1024 current_uA, input_uV, output_uV, ERR_PTR(err));
1028 err = rdev->desc->ops->set_mode(rdev, mode);
1030 rdev_err(rdev, "failed to set optimum mode %x: %pe\n",
1031 mode, ERR_PTR(err));
1037 static int __suspend_set_state(struct regulator_dev *rdev,
1038 const struct regulator_state *rstate)
1042 if (rstate->enabled == ENABLE_IN_SUSPEND &&
1043 rdev->desc->ops->set_suspend_enable)
1044 ret = rdev->desc->ops->set_suspend_enable(rdev);
1045 else if (rstate->enabled == DISABLE_IN_SUSPEND &&
1046 rdev->desc->ops->set_suspend_disable)
1047 ret = rdev->desc->ops->set_suspend_disable(rdev);
1048 else /* OK if set_suspend_enable or set_suspend_disable is NULL */
1052 rdev_err(rdev, "failed to enabled/disable: %pe\n", ERR_PTR(ret));
1056 if (rdev->desc->ops->set_suspend_voltage && rstate->uV > 0) {
1057 ret = rdev->desc->ops->set_suspend_voltage(rdev, rstate->uV);
1059 rdev_err(rdev, "failed to set voltage: %pe\n", ERR_PTR(ret));
1064 if (rdev->desc->ops->set_suspend_mode && rstate->mode > 0) {
1065 ret = rdev->desc->ops->set_suspend_mode(rdev, rstate->mode);
1067 rdev_err(rdev, "failed to set mode: %pe\n", ERR_PTR(ret));
1075 static int suspend_set_initial_state(struct regulator_dev *rdev)
1077 const struct regulator_state *rstate;
1079 rstate = regulator_get_suspend_state_check(rdev,
1080 rdev->constraints->initial_state);
1084 return __suspend_set_state(rdev, rstate);
1087 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
1088 static void print_constraints_debug(struct regulator_dev *rdev)
1090 struct regulation_constraints *constraints = rdev->constraints;
1092 size_t len = sizeof(buf) - 1;
1096 if (constraints->min_uV && constraints->max_uV) {
1097 if (constraints->min_uV == constraints->max_uV)
1098 count += scnprintf(buf + count, len - count, "%d mV ",
1099 constraints->min_uV / 1000);
1101 count += scnprintf(buf + count, len - count,
1103 constraints->min_uV / 1000,
1104 constraints->max_uV / 1000);
1107 if (!constraints->min_uV ||
1108 constraints->min_uV != constraints->max_uV) {
1109 ret = regulator_get_voltage_rdev(rdev);
1111 count += scnprintf(buf + count, len - count,
1112 "at %d mV ", ret / 1000);
1115 if (constraints->uV_offset)
1116 count += scnprintf(buf + count, len - count, "%dmV offset ",
1117 constraints->uV_offset / 1000);
1119 if (constraints->min_uA && constraints->max_uA) {
1120 if (constraints->min_uA == constraints->max_uA)
1121 count += scnprintf(buf + count, len - count, "%d mA ",
1122 constraints->min_uA / 1000);
1124 count += scnprintf(buf + count, len - count,
1126 constraints->min_uA / 1000,
1127 constraints->max_uA / 1000);
1130 if (!constraints->min_uA ||
1131 constraints->min_uA != constraints->max_uA) {
1132 ret = _regulator_get_current_limit(rdev);
1134 count += scnprintf(buf + count, len - count,
1135 "at %d mA ", ret / 1000);
1138 if (constraints->valid_modes_mask & REGULATOR_MODE_FAST)
1139 count += scnprintf(buf + count, len - count, "fast ");
1140 if (constraints->valid_modes_mask & REGULATOR_MODE_NORMAL)
1141 count += scnprintf(buf + count, len - count, "normal ");
1142 if (constraints->valid_modes_mask & REGULATOR_MODE_IDLE)
1143 count += scnprintf(buf + count, len - count, "idle ");
1144 if (constraints->valid_modes_mask & REGULATOR_MODE_STANDBY)
1145 count += scnprintf(buf + count, len - count, "standby ");
1148 count = scnprintf(buf, len, "no parameters");
1152 count += scnprintf(buf + count, len - count, ", %s",
1153 _regulator_is_enabled(rdev) ? "enabled" : "disabled");
1155 rdev_dbg(rdev, "%s\n", buf);
1157 #else /* !DEBUG && !CONFIG_DYNAMIC_DEBUG */
1158 static inline void print_constraints_debug(struct regulator_dev *rdev) {}
1159 #endif /* !DEBUG && !CONFIG_DYNAMIC_DEBUG */
1161 static void print_constraints(struct regulator_dev *rdev)
1163 struct regulation_constraints *constraints = rdev->constraints;
1165 print_constraints_debug(rdev);
1167 if ((constraints->min_uV != constraints->max_uV) &&
1168 !regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE))
1170 "Voltage range but no REGULATOR_CHANGE_VOLTAGE\n");
1173 static int machine_constraints_voltage(struct regulator_dev *rdev,
1174 struct regulation_constraints *constraints)
1176 const struct regulator_ops *ops = rdev->desc->ops;
1179 /* do we need to apply the constraint voltage */
1180 if (rdev->constraints->apply_uV &&
1181 rdev->constraints->min_uV && rdev->constraints->max_uV) {
1182 int target_min, target_max;
1183 int current_uV = regulator_get_voltage_rdev(rdev);
1185 if (current_uV == -ENOTRECOVERABLE) {
1186 /* This regulator can't be read and must be initialized */
1187 rdev_info(rdev, "Setting %d-%duV\n",
1188 rdev->constraints->min_uV,
1189 rdev->constraints->max_uV);
1190 _regulator_do_set_voltage(rdev,
1191 rdev->constraints->min_uV,
1192 rdev->constraints->max_uV);
1193 current_uV = regulator_get_voltage_rdev(rdev);
1196 if (current_uV < 0) {
1197 if (current_uV != -EPROBE_DEFER)
1199 "failed to get the current voltage: %pe\n",
1200 ERR_PTR(current_uV));
1205 * If we're below the minimum voltage move up to the
1206 * minimum voltage, if we're above the maximum voltage
1207 * then move down to the maximum.
1209 target_min = current_uV;
1210 target_max = current_uV;
1212 if (current_uV < rdev->constraints->min_uV) {
1213 target_min = rdev->constraints->min_uV;
1214 target_max = rdev->constraints->min_uV;
1217 if (current_uV > rdev->constraints->max_uV) {
1218 target_min = rdev->constraints->max_uV;
1219 target_max = rdev->constraints->max_uV;
1222 if (target_min != current_uV || target_max != current_uV) {
1223 rdev_info(rdev, "Bringing %duV into %d-%duV\n",
1224 current_uV, target_min, target_max);
1225 ret = _regulator_do_set_voltage(
1226 rdev, target_min, target_max);
1229 "failed to apply %d-%duV constraint: %pe\n",
1230 target_min, target_max, ERR_PTR(ret));
1236 /* constrain machine-level voltage specs to fit
1237 * the actual range supported by this regulator.
1239 if (ops->list_voltage && rdev->desc->n_voltages) {
1240 int count = rdev->desc->n_voltages;
1242 int min_uV = INT_MAX;
1243 int max_uV = INT_MIN;
1244 int cmin = constraints->min_uV;
1245 int cmax = constraints->max_uV;
1247 /* it's safe to autoconfigure fixed-voltage supplies
1248 * and the constraints are used by list_voltage.
1250 if (count == 1 && !cmin) {
1253 constraints->min_uV = cmin;
1254 constraints->max_uV = cmax;
1257 /* voltage constraints are optional */
1258 if ((cmin == 0) && (cmax == 0))
1261 /* else require explicit machine-level constraints */
1262 if (cmin <= 0 || cmax <= 0 || cmax < cmin) {
1263 rdev_err(rdev, "invalid voltage constraints\n");
1267 /* no need to loop voltages if range is continuous */
1268 if (rdev->desc->continuous_voltage_range)
1271 /* initial: [cmin..cmax] valid, [min_uV..max_uV] not */
1272 for (i = 0; i < count; i++) {
1275 value = ops->list_voltage(rdev, i);
1279 /* maybe adjust [min_uV..max_uV] */
1280 if (value >= cmin && value < min_uV)
1282 if (value <= cmax && value > max_uV)
1286 /* final: [min_uV..max_uV] valid iff constraints valid */
1287 if (max_uV < min_uV) {
1289 "unsupportable voltage constraints %u-%uuV\n",
1294 /* use regulator's subset of machine constraints */
1295 if (constraints->min_uV < min_uV) {
1296 rdev_dbg(rdev, "override min_uV, %d -> %d\n",
1297 constraints->min_uV, min_uV);
1298 constraints->min_uV = min_uV;
1300 if (constraints->max_uV > max_uV) {
1301 rdev_dbg(rdev, "override max_uV, %d -> %d\n",
1302 constraints->max_uV, max_uV);
1303 constraints->max_uV = max_uV;
1310 static int machine_constraints_current(struct regulator_dev *rdev,
1311 struct regulation_constraints *constraints)
1313 const struct regulator_ops *ops = rdev->desc->ops;
1316 if (!constraints->min_uA && !constraints->max_uA)
1319 if (constraints->min_uA > constraints->max_uA) {
1320 rdev_err(rdev, "Invalid current constraints\n");
1324 if (!ops->set_current_limit || !ops->get_current_limit) {
1325 rdev_warn(rdev, "Operation of current configuration missing\n");
1329 /* Set regulator current in constraints range */
1330 ret = ops->set_current_limit(rdev, constraints->min_uA,
1331 constraints->max_uA);
1333 rdev_err(rdev, "Failed to set current constraint, %d\n", ret);
1340 static int _regulator_do_enable(struct regulator_dev *rdev);
1342 static int notif_set_limit(struct regulator_dev *rdev,
1343 int (*set)(struct regulator_dev *, int, int, bool),
1344 int limit, int severity)
1348 if (limit == REGULATOR_NOTIF_LIMIT_DISABLE) {
1355 if (limit == REGULATOR_NOTIF_LIMIT_ENABLE)
1358 return set(rdev, limit, severity, enable);
1361 static int handle_notify_limits(struct regulator_dev *rdev,
1362 int (*set)(struct regulator_dev *, int, int, bool),
1363 struct notification_limit *limits)
1371 ret = notif_set_limit(rdev, set, limits->prot,
1372 REGULATOR_SEVERITY_PROT);
1377 ret = notif_set_limit(rdev, set, limits->err,
1378 REGULATOR_SEVERITY_ERR);
1383 ret = notif_set_limit(rdev, set, limits->warn,
1384 REGULATOR_SEVERITY_WARN);
1389 * set_machine_constraints - sets regulator constraints
1390 * @rdev: regulator source
1392 * Allows platform initialisation code to define and constrain
1393 * regulator circuits e.g. valid voltage/current ranges, etc. NOTE:
1394 * Constraints *must* be set by platform code in order for some
1395 * regulator operations to proceed i.e. set_voltage, set_current_limit,
1398 static int set_machine_constraints(struct regulator_dev *rdev)
1401 const struct regulator_ops *ops = rdev->desc->ops;
1403 ret = machine_constraints_voltage(rdev, rdev->constraints);
1407 ret = machine_constraints_current(rdev, rdev->constraints);
1411 if (rdev->constraints->ilim_uA && ops->set_input_current_limit) {
1412 ret = ops->set_input_current_limit(rdev,
1413 rdev->constraints->ilim_uA);
1415 rdev_err(rdev, "failed to set input limit: %pe\n", ERR_PTR(ret));
1420 /* do we need to setup our suspend state */
1421 if (rdev->constraints->initial_state) {
1422 ret = suspend_set_initial_state(rdev);
1424 rdev_err(rdev, "failed to set suspend state: %pe\n", ERR_PTR(ret));
1429 if (rdev->constraints->initial_mode) {
1430 if (!ops->set_mode) {
1431 rdev_err(rdev, "no set_mode operation\n");
1435 ret = ops->set_mode(rdev, rdev->constraints->initial_mode);
1437 rdev_err(rdev, "failed to set initial mode: %pe\n", ERR_PTR(ret));
1440 } else if (rdev->constraints->system_load) {
1442 * We'll only apply the initial system load if an
1443 * initial mode wasn't specified.
1445 drms_uA_update(rdev);
1448 if ((rdev->constraints->ramp_delay || rdev->constraints->ramp_disable)
1449 && ops->set_ramp_delay) {
1450 ret = ops->set_ramp_delay(rdev, rdev->constraints->ramp_delay);
1452 rdev_err(rdev, "failed to set ramp_delay: %pe\n", ERR_PTR(ret));
1457 if (rdev->constraints->pull_down && ops->set_pull_down) {
1458 ret = ops->set_pull_down(rdev);
1460 rdev_err(rdev, "failed to set pull down: %pe\n", ERR_PTR(ret));
1465 if (rdev->constraints->soft_start && ops->set_soft_start) {
1466 ret = ops->set_soft_start(rdev);
1468 rdev_err(rdev, "failed to set soft start: %pe\n", ERR_PTR(ret));
1474 * Existing logic does not warn if over_current_protection is given as
1475 * a constraint but driver does not support that. I think we should
1476 * warn about this type of issues as it is possible someone changes
1477 * PMIC on board to another type - and the another PMIC's driver does
1478 * not support setting protection. Board composer may happily believe
1479 * the DT limits are respected - especially if the new PMIC HW also
1480 * supports protection but the driver does not. I won't change the logic
1481 * without hearing more experienced opinion on this though.
1483 * If warning is seen as a good idea then we can merge handling the
1484 * over-curret protection and detection and get rid of this special
1487 if (rdev->constraints->over_current_protection
1488 && ops->set_over_current_protection) {
1489 int lim = rdev->constraints->over_curr_limits.prot;
1491 ret = ops->set_over_current_protection(rdev, lim,
1492 REGULATOR_SEVERITY_PROT,
1495 rdev_err(rdev, "failed to set over current protection: %pe\n",
1501 if (rdev->constraints->over_current_detection)
1502 ret = handle_notify_limits(rdev,
1503 ops->set_over_current_protection,
1504 &rdev->constraints->over_curr_limits);
1506 if (ret != -EOPNOTSUPP) {
1507 rdev_err(rdev, "failed to set over current limits: %pe\n",
1512 "IC does not support requested over-current limits\n");
1515 if (rdev->constraints->over_voltage_detection)
1516 ret = handle_notify_limits(rdev,
1517 ops->set_over_voltage_protection,
1518 &rdev->constraints->over_voltage_limits);
1520 if (ret != -EOPNOTSUPP) {
1521 rdev_err(rdev, "failed to set over voltage limits %pe\n",
1526 "IC does not support requested over voltage limits\n");
1529 if (rdev->constraints->under_voltage_detection)
1530 ret = handle_notify_limits(rdev,
1531 ops->set_under_voltage_protection,
1532 &rdev->constraints->under_voltage_limits);
1534 if (ret != -EOPNOTSUPP) {
1535 rdev_err(rdev, "failed to set under voltage limits %pe\n",
1540 "IC does not support requested under voltage limits\n");
1543 if (rdev->constraints->over_temp_detection)
1544 ret = handle_notify_limits(rdev,
1545 ops->set_thermal_protection,
1546 &rdev->constraints->temp_limits);
1548 if (ret != -EOPNOTSUPP) {
1549 rdev_err(rdev, "failed to set temperature limits %pe\n",
1554 "IC does not support requested temperature limits\n");
1557 if (rdev->constraints->active_discharge && ops->set_active_discharge) {
1558 bool ad_state = (rdev->constraints->active_discharge ==
1559 REGULATOR_ACTIVE_DISCHARGE_ENABLE) ? true : false;
1561 ret = ops->set_active_discharge(rdev, ad_state);
1563 rdev_err(rdev, "failed to set active discharge: %pe\n", ERR_PTR(ret));
1569 * If there is no mechanism for controlling the regulator then
1570 * flag it as always_on so we don't end up duplicating checks
1571 * for this so much. Note that we could control the state of
1572 * a supply to control the output on a regulator that has no
1575 if (!rdev->ena_pin && !ops->enable) {
1576 if (rdev->supply_name && !rdev->supply)
1577 return -EPROBE_DEFER;
1580 rdev->constraints->always_on =
1581 rdev->supply->rdev->constraints->always_on;
1583 rdev->constraints->always_on = true;
1586 if (rdev->desc->off_on_delay)
1587 rdev->last_off = ktime_get();
1589 /* If the constraints say the regulator should be on at this point
1590 * and we have control then make sure it is enabled.
1592 if (rdev->constraints->always_on || rdev->constraints->boot_on) {
1593 /* If we want to enable this regulator, make sure that we know
1594 * the supplying regulator.
1596 if (rdev->supply_name && !rdev->supply)
1597 return -EPROBE_DEFER;
1599 /* If supplying regulator has already been enabled,
1600 * it's not intended to have use_count increment
1601 * when rdev is only boot-on.
1604 (rdev->constraints->always_on ||
1605 !regulator_is_enabled(rdev->supply))) {
1606 ret = regulator_enable(rdev->supply);
1608 _regulator_put(rdev->supply);
1609 rdev->supply = NULL;
1614 ret = _regulator_do_enable(rdev);
1615 if (ret < 0 && ret != -EINVAL) {
1616 rdev_err(rdev, "failed to enable: %pe\n", ERR_PTR(ret));
1620 if (rdev->constraints->always_on)
1624 print_constraints(rdev);
1629 * set_supply - set regulator supply regulator
1630 * @rdev: regulator name
1631 * @supply_rdev: supply regulator name
1633 * Called by platform initialisation code to set the supply regulator for this
1634 * regulator. This ensures that a regulators supply will also be enabled by the
1635 * core if it's child is enabled.
1637 static int set_supply(struct regulator_dev *rdev,
1638 struct regulator_dev *supply_rdev)
1642 rdev_dbg(rdev, "supplied by %s\n", rdev_get_name(supply_rdev));
1644 if (!try_module_get(supply_rdev->owner))
1647 rdev->supply = create_regulator(supply_rdev, &rdev->dev, "SUPPLY");
1648 if (rdev->supply == NULL) {
1649 module_put(supply_rdev->owner);
1653 supply_rdev->open_count++;
1659 * set_consumer_device_supply - Bind a regulator to a symbolic supply
1660 * @rdev: regulator source
1661 * @consumer_dev_name: dev_name() string for device supply applies to
1662 * @supply: symbolic name for supply
1664 * Allows platform initialisation code to map physical regulator
1665 * sources to symbolic names for supplies for use by devices. Devices
1666 * should use these symbolic names to request regulators, avoiding the
1667 * need to provide board-specific regulator names as platform data.
1669 static int set_consumer_device_supply(struct regulator_dev *rdev,
1670 const char *consumer_dev_name,
1673 struct regulator_map *node, *new_node;
1679 if (consumer_dev_name != NULL)
1684 new_node = kzalloc(sizeof(struct regulator_map), GFP_KERNEL);
1685 if (new_node == NULL)
1688 new_node->regulator = rdev;
1689 new_node->supply = supply;
1692 new_node->dev_name = kstrdup(consumer_dev_name, GFP_KERNEL);
1693 if (new_node->dev_name == NULL) {
1699 mutex_lock(®ulator_list_mutex);
1700 list_for_each_entry(node, ®ulator_map_list, list) {
1701 if (node->dev_name && consumer_dev_name) {
1702 if (strcmp(node->dev_name, consumer_dev_name) != 0)
1704 } else if (node->dev_name || consumer_dev_name) {
1708 if (strcmp(node->supply, supply) != 0)
1711 pr_debug("%s: %s/%s is '%s' supply; fail %s/%s\n",
1713 dev_name(&node->regulator->dev),
1714 node->regulator->desc->name,
1716 dev_name(&rdev->dev), rdev_get_name(rdev));
1720 list_add(&new_node->list, ®ulator_map_list);
1721 mutex_unlock(®ulator_list_mutex);
1726 mutex_unlock(®ulator_list_mutex);
1727 kfree(new_node->dev_name);
1732 static void unset_regulator_supplies(struct regulator_dev *rdev)
1734 struct regulator_map *node, *n;
1736 list_for_each_entry_safe(node, n, ®ulator_map_list, list) {
1737 if (rdev == node->regulator) {
1738 list_del(&node->list);
1739 kfree(node->dev_name);
1745 #ifdef CONFIG_DEBUG_FS
1746 static ssize_t constraint_flags_read_file(struct file *file,
1747 char __user *user_buf,
1748 size_t count, loff_t *ppos)
1750 const struct regulator *regulator = file->private_data;
1751 const struct regulation_constraints *c = regulator->rdev->constraints;
1758 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
1762 ret = snprintf(buf, PAGE_SIZE,
1766 "ramp_disable: %u\n"
1769 "over_current_protection: %u\n",
1776 c->over_current_protection);
1778 ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
1786 static const struct file_operations constraint_flags_fops = {
1787 #ifdef CONFIG_DEBUG_FS
1788 .open = simple_open,
1789 .read = constraint_flags_read_file,
1790 .llseek = default_llseek,
1794 #define REG_STR_SIZE 64
1796 static struct regulator *create_regulator(struct regulator_dev *rdev,
1798 const char *supply_name)
1800 struct regulator *regulator;
1804 char buf[REG_STR_SIZE];
1807 size = snprintf(buf, REG_STR_SIZE, "%s-%s",
1808 dev->kobj.name, supply_name);
1809 if (size >= REG_STR_SIZE)
1812 supply_name = kstrdup(buf, GFP_KERNEL);
1813 if (supply_name == NULL)
1816 supply_name = kstrdup_const(supply_name, GFP_KERNEL);
1817 if (supply_name == NULL)
1821 regulator = kzalloc(sizeof(*regulator), GFP_KERNEL);
1822 if (regulator == NULL) {
1823 kfree_const(supply_name);
1827 regulator->rdev = rdev;
1828 regulator->supply_name = supply_name;
1830 regulator_lock(rdev);
1831 list_add(®ulator->list, &rdev->consumer_list);
1832 regulator_unlock(rdev);
1835 regulator->dev = dev;
1837 /* Add a link to the device sysfs entry */
1838 err = sysfs_create_link_nowarn(&rdev->dev.kobj, &dev->kobj,
1841 rdev_dbg(rdev, "could not add device link %s: %pe\n",
1842 dev->kobj.name, ERR_PTR(err));
1848 regulator->debugfs = debugfs_create_dir(supply_name, rdev->debugfs);
1849 if (!regulator->debugfs) {
1850 rdev_dbg(rdev, "Failed to create debugfs directory\n");
1852 debugfs_create_u32("uA_load", 0444, regulator->debugfs,
1853 ®ulator->uA_load);
1854 debugfs_create_u32("min_uV", 0444, regulator->debugfs,
1855 ®ulator->voltage[PM_SUSPEND_ON].min_uV);
1856 debugfs_create_u32("max_uV", 0444, regulator->debugfs,
1857 ®ulator->voltage[PM_SUSPEND_ON].max_uV);
1858 debugfs_create_file("constraint_flags", 0444,
1859 regulator->debugfs, regulator,
1860 &constraint_flags_fops);
1864 * Check now if the regulator is an always on regulator - if
1865 * it is then we don't need to do nearly so much work for
1866 * enable/disable calls.
1868 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_STATUS) &&
1869 _regulator_is_enabled(rdev))
1870 regulator->always_on = true;
1875 static int _regulator_get_enable_time(struct regulator_dev *rdev)
1877 if (rdev->constraints && rdev->constraints->enable_time)
1878 return rdev->constraints->enable_time;
1879 if (rdev->desc->ops->enable_time)
1880 return rdev->desc->ops->enable_time(rdev);
1881 return rdev->desc->enable_time;
1884 static struct regulator_supply_alias *regulator_find_supply_alias(
1885 struct device *dev, const char *supply)
1887 struct regulator_supply_alias *map;
1889 list_for_each_entry(map, ®ulator_supply_alias_list, list)
1890 if (map->src_dev == dev && strcmp(map->src_supply, supply) == 0)
1896 static void regulator_supply_alias(struct device **dev, const char **supply)
1898 struct regulator_supply_alias *map;
1900 map = regulator_find_supply_alias(*dev, *supply);
1902 dev_dbg(*dev, "Mapping supply %s to %s,%s\n",
1903 *supply, map->alias_supply,
1904 dev_name(map->alias_dev));
1905 *dev = map->alias_dev;
1906 *supply = map->alias_supply;
1910 static int regulator_match(struct device *dev, const void *data)
1912 struct regulator_dev *r = dev_to_rdev(dev);
1914 return strcmp(rdev_get_name(r), data) == 0;
1917 static struct regulator_dev *regulator_lookup_by_name(const char *name)
1921 dev = class_find_device(®ulator_class, NULL, name, regulator_match);
1923 return dev ? dev_to_rdev(dev) : NULL;
1927 * regulator_dev_lookup - lookup a regulator device.
1928 * @dev: device for regulator "consumer".
1929 * @supply: Supply name or regulator ID.
1931 * If successful, returns a struct regulator_dev that corresponds to the name
1932 * @supply and with the embedded struct device refcount incremented by one.
1933 * The refcount must be dropped by calling put_device().
1934 * On failure one of the following ERR-PTR-encoded values is returned:
1935 * -ENODEV if lookup fails permanently, -EPROBE_DEFER if lookup could succeed
1938 static struct regulator_dev *regulator_dev_lookup(struct device *dev,
1941 struct regulator_dev *r = NULL;
1942 struct device_node *node;
1943 struct regulator_map *map;
1944 const char *devname = NULL;
1946 regulator_supply_alias(&dev, &supply);
1948 /* first do a dt based lookup */
1949 if (dev && dev->of_node) {
1950 node = of_get_regulator(dev, supply);
1952 r = of_find_regulator_by_node(node);
1958 * We have a node, but there is no device.
1959 * assume it has not registered yet.
1961 return ERR_PTR(-EPROBE_DEFER);
1965 /* if not found, try doing it non-dt way */
1967 devname = dev_name(dev);
1969 mutex_lock(®ulator_list_mutex);
1970 list_for_each_entry(map, ®ulator_map_list, list) {
1971 /* If the mapping has a device set up it must match */
1972 if (map->dev_name &&
1973 (!devname || strcmp(map->dev_name, devname)))
1976 if (strcmp(map->supply, supply) == 0 &&
1977 get_device(&map->regulator->dev)) {
1982 mutex_unlock(®ulator_list_mutex);
1987 r = regulator_lookup_by_name(supply);
1991 return ERR_PTR(-ENODEV);
1994 static int regulator_resolve_supply(struct regulator_dev *rdev)
1996 struct regulator_dev *r;
1997 struct device *dev = rdev->dev.parent;
2000 /* No supply to resolve? */
2001 if (!rdev->supply_name)
2004 /* Supply already resolved? (fast-path without locking contention) */
2008 r = regulator_dev_lookup(dev, rdev->supply_name);
2012 /* Did the lookup explicitly defer for us? */
2013 if (ret == -EPROBE_DEFER)
2016 if (have_full_constraints()) {
2017 r = dummy_regulator_rdev;
2018 get_device(&r->dev);
2020 dev_err(dev, "Failed to resolve %s-supply for %s\n",
2021 rdev->supply_name, rdev->desc->name);
2022 ret = -EPROBE_DEFER;
2028 dev_err(dev, "Supply for %s (%s) resolved to itself\n",
2029 rdev->desc->name, rdev->supply_name);
2030 if (!have_full_constraints()) {
2034 r = dummy_regulator_rdev;
2035 get_device(&r->dev);
2039 * If the supply's parent device is not the same as the
2040 * regulator's parent device, then ensure the parent device
2041 * is bound before we resolve the supply, in case the parent
2042 * device get probe deferred and unregisters the supply.
2044 if (r->dev.parent && r->dev.parent != rdev->dev.parent) {
2045 if (!device_is_bound(r->dev.parent)) {
2046 put_device(&r->dev);
2047 ret = -EPROBE_DEFER;
2052 /* Recursively resolve the supply of the supply */
2053 ret = regulator_resolve_supply(r);
2055 put_device(&r->dev);
2060 * Recheck rdev->supply with rdev->mutex lock held to avoid a race
2061 * between rdev->supply null check and setting rdev->supply in
2062 * set_supply() from concurrent tasks.
2064 regulator_lock(rdev);
2066 /* Supply just resolved by a concurrent task? */
2068 regulator_unlock(rdev);
2069 put_device(&r->dev);
2073 ret = set_supply(rdev, r);
2075 regulator_unlock(rdev);
2076 put_device(&r->dev);
2080 regulator_unlock(rdev);
2083 * In set_machine_constraints() we may have turned this regulator on
2084 * but we couldn't propagate to the supply if it hadn't been resolved
2087 if (rdev->use_count) {
2088 ret = regulator_enable(rdev->supply);
2090 _regulator_put(rdev->supply);
2091 rdev->supply = NULL;
2100 /* Internal regulator request function */
2101 struct regulator *_regulator_get(struct device *dev, const char *id,
2102 enum regulator_get_type get_type)
2104 struct regulator_dev *rdev;
2105 struct regulator *regulator;
2106 struct device_link *link;
2109 if (get_type >= MAX_GET_TYPE) {
2110 dev_err(dev, "invalid type %d in %s\n", get_type, __func__);
2111 return ERR_PTR(-EINVAL);
2115 pr_err("get() with no identifier\n");
2116 return ERR_PTR(-EINVAL);
2119 rdev = regulator_dev_lookup(dev, id);
2121 ret = PTR_ERR(rdev);
2124 * If regulator_dev_lookup() fails with error other
2125 * than -ENODEV our job here is done, we simply return it.
2128 return ERR_PTR(ret);
2130 if (!have_full_constraints()) {
2132 "incomplete constraints, dummy supplies not allowed\n");
2133 return ERR_PTR(-ENODEV);
2139 * Assume that a regulator is physically present and
2140 * enabled, even if it isn't hooked up, and just
2143 dev_warn(dev, "supply %s not found, using dummy regulator\n", id);
2144 rdev = dummy_regulator_rdev;
2145 get_device(&rdev->dev);
2150 "dummy supplies not allowed for exclusive requests\n");
2154 return ERR_PTR(-ENODEV);
2158 if (rdev->exclusive) {
2159 regulator = ERR_PTR(-EPERM);
2160 put_device(&rdev->dev);
2164 if (get_type == EXCLUSIVE_GET && rdev->open_count) {
2165 regulator = ERR_PTR(-EBUSY);
2166 put_device(&rdev->dev);
2170 mutex_lock(®ulator_list_mutex);
2171 ret = (rdev->coupling_desc.n_resolved != rdev->coupling_desc.n_coupled);
2172 mutex_unlock(®ulator_list_mutex);
2175 regulator = ERR_PTR(-EPROBE_DEFER);
2176 put_device(&rdev->dev);
2180 ret = regulator_resolve_supply(rdev);
2182 regulator = ERR_PTR(ret);
2183 put_device(&rdev->dev);
2187 if (!try_module_get(rdev->owner)) {
2188 regulator = ERR_PTR(-EPROBE_DEFER);
2189 put_device(&rdev->dev);
2193 regulator = create_regulator(rdev, dev, id);
2194 if (regulator == NULL) {
2195 regulator = ERR_PTR(-ENOMEM);
2196 module_put(rdev->owner);
2197 put_device(&rdev->dev);
2202 if (get_type == EXCLUSIVE_GET) {
2203 rdev->exclusive = 1;
2205 ret = _regulator_is_enabled(rdev);
2207 rdev->use_count = 1;
2208 regulator->enable_count = 1;
2210 rdev->use_count = 0;
2211 regulator->enable_count = 0;
2215 link = device_link_add(dev, &rdev->dev, DL_FLAG_STATELESS);
2216 if (!IS_ERR_OR_NULL(link))
2217 regulator->device_link = true;
2223 * regulator_get - lookup and obtain a reference to a regulator.
2224 * @dev: device for regulator "consumer"
2225 * @id: Supply name or regulator ID.
2227 * Returns a struct regulator corresponding to the regulator producer,
2228 * or IS_ERR() condition containing errno.
2230 * Use of supply names configured via set_consumer_device_supply() is
2231 * strongly encouraged. It is recommended that the supply name used
2232 * should match the name used for the supply and/or the relevant
2233 * device pins in the datasheet.
2235 struct regulator *regulator_get(struct device *dev, const char *id)
2237 return _regulator_get(dev, id, NORMAL_GET);
2239 EXPORT_SYMBOL_GPL(regulator_get);
2242 * regulator_get_exclusive - obtain exclusive access to a regulator.
2243 * @dev: device for regulator "consumer"
2244 * @id: Supply name or regulator ID.
2246 * Returns a struct regulator corresponding to the regulator producer,
2247 * or IS_ERR() condition containing errno. Other consumers will be
2248 * unable to obtain this regulator while this reference is held and the
2249 * use count for the regulator will be initialised to reflect the current
2250 * state of the regulator.
2252 * This is intended for use by consumers which cannot tolerate shared
2253 * use of the regulator such as those which need to force the
2254 * regulator off for correct operation of the hardware they are
2257 * Use of supply names configured via set_consumer_device_supply() is
2258 * strongly encouraged. It is recommended that the supply name used
2259 * should match the name used for the supply and/or the relevant
2260 * device pins in the datasheet.
2262 struct regulator *regulator_get_exclusive(struct device *dev, const char *id)
2264 return _regulator_get(dev, id, EXCLUSIVE_GET);
2266 EXPORT_SYMBOL_GPL(regulator_get_exclusive);
2269 * regulator_get_optional - obtain optional access to a regulator.
2270 * @dev: device for regulator "consumer"
2271 * @id: Supply name or regulator ID.
2273 * Returns a struct regulator corresponding to the regulator producer,
2274 * or IS_ERR() condition containing errno.
2276 * This is intended for use by consumers for devices which can have
2277 * some supplies unconnected in normal use, such as some MMC devices.
2278 * It can allow the regulator core to provide stub supplies for other
2279 * supplies requested using normal regulator_get() calls without
2280 * disrupting the operation of drivers that can handle absent
2283 * Use of supply names configured via set_consumer_device_supply() is
2284 * strongly encouraged. It is recommended that the supply name used
2285 * should match the name used for the supply and/or the relevant
2286 * device pins in the datasheet.
2288 struct regulator *regulator_get_optional(struct device *dev, const char *id)
2290 return _regulator_get(dev, id, OPTIONAL_GET);
2292 EXPORT_SYMBOL_GPL(regulator_get_optional);
2294 static void destroy_regulator(struct regulator *regulator)
2296 struct regulator_dev *rdev = regulator->rdev;
2298 debugfs_remove_recursive(regulator->debugfs);
2300 if (regulator->dev) {
2301 if (regulator->device_link)
2302 device_link_remove(regulator->dev, &rdev->dev);
2304 /* remove any sysfs entries */
2305 sysfs_remove_link(&rdev->dev.kobj, regulator->supply_name);
2308 regulator_lock(rdev);
2309 list_del(®ulator->list);
2312 rdev->exclusive = 0;
2313 regulator_unlock(rdev);
2315 kfree_const(regulator->supply_name);
2319 /* regulator_list_mutex lock held by regulator_put() */
2320 static void _regulator_put(struct regulator *regulator)
2322 struct regulator_dev *rdev;
2324 if (IS_ERR_OR_NULL(regulator))
2327 lockdep_assert_held_once(®ulator_list_mutex);
2329 /* Docs say you must disable before calling regulator_put() */
2330 WARN_ON(regulator->enable_count);
2332 rdev = regulator->rdev;
2334 destroy_regulator(regulator);
2336 module_put(rdev->owner);
2337 put_device(&rdev->dev);
2341 * regulator_put - "free" the regulator source
2342 * @regulator: regulator source
2344 * Note: drivers must ensure that all regulator_enable calls made on this
2345 * regulator source are balanced by regulator_disable calls prior to calling
2348 void regulator_put(struct regulator *regulator)
2350 mutex_lock(®ulator_list_mutex);
2351 _regulator_put(regulator);
2352 mutex_unlock(®ulator_list_mutex);
2354 EXPORT_SYMBOL_GPL(regulator_put);
2357 * regulator_register_supply_alias - Provide device alias for supply lookup
2359 * @dev: device that will be given as the regulator "consumer"
2360 * @id: Supply name or regulator ID
2361 * @alias_dev: device that should be used to lookup the supply
2362 * @alias_id: Supply name or regulator ID that should be used to lookup the
2365 * All lookups for id on dev will instead be conducted for alias_id on
2368 int regulator_register_supply_alias(struct device *dev, const char *id,
2369 struct device *alias_dev,
2370 const char *alias_id)
2372 struct regulator_supply_alias *map;
2374 map = regulator_find_supply_alias(dev, id);
2378 map = kzalloc(sizeof(struct regulator_supply_alias), GFP_KERNEL);
2383 map->src_supply = id;
2384 map->alias_dev = alias_dev;
2385 map->alias_supply = alias_id;
2387 list_add(&map->list, ®ulator_supply_alias_list);
2389 pr_info("Adding alias for supply %s,%s -> %s,%s\n",
2390 id, dev_name(dev), alias_id, dev_name(alias_dev));
2394 EXPORT_SYMBOL_GPL(regulator_register_supply_alias);
2397 * regulator_unregister_supply_alias - Remove device alias
2399 * @dev: device that will be given as the regulator "consumer"
2400 * @id: Supply name or regulator ID
2402 * Remove a lookup alias if one exists for id on dev.
2404 void regulator_unregister_supply_alias(struct device *dev, const char *id)
2406 struct regulator_supply_alias *map;
2408 map = regulator_find_supply_alias(dev, id);
2410 list_del(&map->list);
2414 EXPORT_SYMBOL_GPL(regulator_unregister_supply_alias);
2417 * regulator_bulk_register_supply_alias - register multiple aliases
2419 * @dev: device that will be given as the regulator "consumer"
2420 * @id: List of supply names or regulator IDs
2421 * @alias_dev: device that should be used to lookup the supply
2422 * @alias_id: List of supply names or regulator IDs that should be used to
2424 * @num_id: Number of aliases to register
2426 * @return 0 on success, an errno on failure.
2428 * This helper function allows drivers to register several supply
2429 * aliases in one operation. If any of the aliases cannot be
2430 * registered any aliases that were registered will be removed
2431 * before returning to the caller.
2433 int regulator_bulk_register_supply_alias(struct device *dev,
2434 const char *const *id,
2435 struct device *alias_dev,
2436 const char *const *alias_id,
2442 for (i = 0; i < num_id; ++i) {
2443 ret = regulator_register_supply_alias(dev, id[i], alias_dev,
2453 "Failed to create supply alias %s,%s -> %s,%s\n",
2454 id[i], dev_name(dev), alias_id[i], dev_name(alias_dev));
2457 regulator_unregister_supply_alias(dev, id[i]);
2461 EXPORT_SYMBOL_GPL(regulator_bulk_register_supply_alias);
2464 * regulator_bulk_unregister_supply_alias - unregister multiple aliases
2466 * @dev: device that will be given as the regulator "consumer"
2467 * @id: List of supply names or regulator IDs
2468 * @num_id: Number of aliases to unregister
2470 * This helper function allows drivers to unregister several supply
2471 * aliases in one operation.
2473 void regulator_bulk_unregister_supply_alias(struct device *dev,
2474 const char *const *id,
2479 for (i = 0; i < num_id; ++i)
2480 regulator_unregister_supply_alias(dev, id[i]);
2482 EXPORT_SYMBOL_GPL(regulator_bulk_unregister_supply_alias);
2485 /* Manage enable GPIO list. Same GPIO pin can be shared among regulators */
2486 static int regulator_ena_gpio_request(struct regulator_dev *rdev,
2487 const struct regulator_config *config)
2489 struct regulator_enable_gpio *pin, *new_pin;
2490 struct gpio_desc *gpiod;
2492 gpiod = config->ena_gpiod;
2493 new_pin = kzalloc(sizeof(*new_pin), GFP_KERNEL);
2495 mutex_lock(®ulator_list_mutex);
2497 list_for_each_entry(pin, ®ulator_ena_gpio_list, list) {
2498 if (pin->gpiod == gpiod) {
2499 rdev_dbg(rdev, "GPIO is already used\n");
2500 goto update_ena_gpio_to_rdev;
2504 if (new_pin == NULL) {
2505 mutex_unlock(®ulator_list_mutex);
2513 list_add(&pin->list, ®ulator_ena_gpio_list);
2515 update_ena_gpio_to_rdev:
2516 pin->request_count++;
2517 rdev->ena_pin = pin;
2519 mutex_unlock(®ulator_list_mutex);
2525 static void regulator_ena_gpio_free(struct regulator_dev *rdev)
2527 struct regulator_enable_gpio *pin, *n;
2532 /* Free the GPIO only in case of no use */
2533 list_for_each_entry_safe(pin, n, ®ulator_ena_gpio_list, list) {
2534 if (pin != rdev->ena_pin)
2537 if (--pin->request_count)
2540 gpiod_put(pin->gpiod);
2541 list_del(&pin->list);
2546 rdev->ena_pin = NULL;
2550 * regulator_ena_gpio_ctrl - balance enable_count of each GPIO and actual GPIO pin control
2551 * @rdev: regulator_dev structure
2552 * @enable: enable GPIO at initial use?
2554 * GPIO is enabled in case of initial use. (enable_count is 0)
2555 * GPIO is disabled when it is not shared any more. (enable_count <= 1)
2557 static int regulator_ena_gpio_ctrl(struct regulator_dev *rdev, bool enable)
2559 struct regulator_enable_gpio *pin = rdev->ena_pin;
2565 /* Enable GPIO at initial use */
2566 if (pin->enable_count == 0)
2567 gpiod_set_value_cansleep(pin->gpiod, 1);
2569 pin->enable_count++;
2571 if (pin->enable_count > 1) {
2572 pin->enable_count--;
2576 /* Disable GPIO if not used */
2577 if (pin->enable_count <= 1) {
2578 gpiod_set_value_cansleep(pin->gpiod, 0);
2579 pin->enable_count = 0;
2587 * _regulator_delay_helper - a delay helper function
2588 * @delay: time to delay in microseconds
2590 * Delay for the requested amount of time as per the guidelines in:
2592 * Documentation/timers/timers-howto.rst
2594 * The assumption here is that these regulator operations will never used in
2595 * atomic context and therefore sleeping functions can be used.
2597 static void _regulator_delay_helper(unsigned int delay)
2599 unsigned int ms = delay / 1000;
2600 unsigned int us = delay % 1000;
2604 * For small enough values, handle super-millisecond
2605 * delays in the usleep_range() call below.
2614 * Give the scheduler some room to coalesce with any other
2615 * wakeup sources. For delays shorter than 10 us, don't even
2616 * bother setting up high-resolution timers and just busy-
2620 usleep_range(us, us + 100);
2626 * _regulator_check_status_enabled
2628 * A helper function to check if the regulator status can be interpreted
2629 * as 'regulator is enabled'.
2630 * @rdev: the regulator device to check
2633 * * 1 - if status shows regulator is in enabled state
2634 * * 0 - if not enabled state
2635 * * Error Value - as received from ops->get_status()
2637 static inline int _regulator_check_status_enabled(struct regulator_dev *rdev)
2639 int ret = rdev->desc->ops->get_status(rdev);
2642 rdev_info(rdev, "get_status returned error: %d\n", ret);
2647 case REGULATOR_STATUS_OFF:
2648 case REGULATOR_STATUS_ERROR:
2649 case REGULATOR_STATUS_UNDEFINED:
2656 static int _regulator_do_enable(struct regulator_dev *rdev)
2660 /* Query before enabling in case configuration dependent. */
2661 ret = _regulator_get_enable_time(rdev);
2665 rdev_warn(rdev, "enable_time() failed: %pe\n", ERR_PTR(ret));
2669 trace_regulator_enable(rdev_get_name(rdev));
2671 if (rdev->desc->off_on_delay && rdev->last_off) {
2672 /* if needed, keep a distance of off_on_delay from last time
2673 * this regulator was disabled.
2675 ktime_t end = ktime_add_us(rdev->last_off, rdev->desc->off_on_delay);
2676 s64 remaining = ktime_us_delta(end, ktime_get());
2679 _regulator_delay_helper(remaining);
2682 if (rdev->ena_pin) {
2683 if (!rdev->ena_gpio_state) {
2684 ret = regulator_ena_gpio_ctrl(rdev, true);
2687 rdev->ena_gpio_state = 1;
2689 } else if (rdev->desc->ops->enable) {
2690 ret = rdev->desc->ops->enable(rdev);
2697 /* Allow the regulator to ramp; it would be useful to extend
2698 * this for bulk operations so that the regulators can ramp
2701 trace_regulator_enable_delay(rdev_get_name(rdev));
2703 /* If poll_enabled_time is set, poll upto the delay calculated
2704 * above, delaying poll_enabled_time uS to check if the regulator
2705 * actually got enabled.
2706 * If the regulator isn't enabled after our delay helper has expired,
2707 * return -ETIMEDOUT.
2709 if (rdev->desc->poll_enabled_time) {
2710 int time_remaining = delay;
2712 while (time_remaining > 0) {
2713 _regulator_delay_helper(rdev->desc->poll_enabled_time);
2715 if (rdev->desc->ops->get_status) {
2716 ret = _regulator_check_status_enabled(rdev);
2721 } else if (rdev->desc->ops->is_enabled(rdev))
2724 time_remaining -= rdev->desc->poll_enabled_time;
2727 if (time_remaining <= 0) {
2728 rdev_err(rdev, "Enabled check timed out\n");
2732 _regulator_delay_helper(delay);
2735 trace_regulator_enable_complete(rdev_get_name(rdev));
2741 * _regulator_handle_consumer_enable - handle that a consumer enabled
2742 * @regulator: regulator source
2744 * Some things on a regulator consumer (like the contribution towards total
2745 * load on the regulator) only have an effect when the consumer wants the
2746 * regulator enabled. Explained in example with two consumers of the same
2748 * consumer A: set_load(100); => total load = 0
2749 * consumer A: regulator_enable(); => total load = 100
2750 * consumer B: set_load(1000); => total load = 100
2751 * consumer B: regulator_enable(); => total load = 1100
2752 * consumer A: regulator_disable(); => total_load = 1000
2754 * This function (together with _regulator_handle_consumer_disable) is
2755 * responsible for keeping track of the refcount for a given regulator consumer
2756 * and applying / unapplying these things.
2758 * Returns 0 upon no error; -error upon error.
2760 static int _regulator_handle_consumer_enable(struct regulator *regulator)
2763 struct regulator_dev *rdev = regulator->rdev;
2765 lockdep_assert_held_once(&rdev->mutex.base);
2767 regulator->enable_count++;
2768 if (regulator->uA_load && regulator->enable_count == 1) {
2769 ret = drms_uA_update(rdev);
2771 regulator->enable_count--;
2779 * _regulator_handle_consumer_disable - handle that a consumer disabled
2780 * @regulator: regulator source
2782 * The opposite of _regulator_handle_consumer_enable().
2784 * Returns 0 upon no error; -error upon error.
2786 static int _regulator_handle_consumer_disable(struct regulator *regulator)
2788 struct regulator_dev *rdev = regulator->rdev;
2790 lockdep_assert_held_once(&rdev->mutex.base);
2792 if (!regulator->enable_count) {
2793 rdev_err(rdev, "Underflow of regulator enable count\n");
2797 regulator->enable_count--;
2798 if (regulator->uA_load && regulator->enable_count == 0)
2799 return drms_uA_update(rdev);
2804 /* locks held by regulator_enable() */
2805 static int _regulator_enable(struct regulator *regulator)
2807 struct regulator_dev *rdev = regulator->rdev;
2810 lockdep_assert_held_once(&rdev->mutex.base);
2812 if (rdev->use_count == 0 && rdev->supply) {
2813 ret = _regulator_enable(rdev->supply);
2818 /* balance only if there are regulators coupled */
2819 if (rdev->coupling_desc.n_coupled > 1) {
2820 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
2822 goto err_disable_supply;
2825 ret = _regulator_handle_consumer_enable(regulator);
2827 goto err_disable_supply;
2829 if (rdev->use_count == 0) {
2831 * The regulator may already be enabled if it's not switchable
2834 ret = _regulator_is_enabled(rdev);
2835 if (ret == -EINVAL || ret == 0) {
2836 if (!regulator_ops_is_valid(rdev,
2837 REGULATOR_CHANGE_STATUS)) {
2839 goto err_consumer_disable;
2842 ret = _regulator_do_enable(rdev);
2844 goto err_consumer_disable;
2846 _notifier_call_chain(rdev, REGULATOR_EVENT_ENABLE,
2848 } else if (ret < 0) {
2849 rdev_err(rdev, "is_enabled() failed: %pe\n", ERR_PTR(ret));
2850 goto err_consumer_disable;
2852 /* Fallthrough on positive return values - already enabled */
2859 err_consumer_disable:
2860 _regulator_handle_consumer_disable(regulator);
2863 if (rdev->use_count == 0 && rdev->supply)
2864 _regulator_disable(rdev->supply);
2870 * regulator_enable - enable regulator output
2871 * @regulator: regulator source
2873 * Request that the regulator be enabled with the regulator output at
2874 * the predefined voltage or current value. Calls to regulator_enable()
2875 * must be balanced with calls to regulator_disable().
2877 * NOTE: the output value can be set by other drivers, boot loader or may be
2878 * hardwired in the regulator.
2880 int regulator_enable(struct regulator *regulator)
2882 struct regulator_dev *rdev = regulator->rdev;
2883 struct ww_acquire_ctx ww_ctx;
2886 regulator_lock_dependent(rdev, &ww_ctx);
2887 ret = _regulator_enable(regulator);
2888 regulator_unlock_dependent(rdev, &ww_ctx);
2892 EXPORT_SYMBOL_GPL(regulator_enable);
2894 static int _regulator_do_disable(struct regulator_dev *rdev)
2898 trace_regulator_disable(rdev_get_name(rdev));
2900 if (rdev->ena_pin) {
2901 if (rdev->ena_gpio_state) {
2902 ret = regulator_ena_gpio_ctrl(rdev, false);
2905 rdev->ena_gpio_state = 0;
2908 } else if (rdev->desc->ops->disable) {
2909 ret = rdev->desc->ops->disable(rdev);
2914 if (rdev->desc->off_on_delay)
2915 rdev->last_off = ktime_get();
2917 trace_regulator_disable_complete(rdev_get_name(rdev));
2922 /* locks held by regulator_disable() */
2923 static int _regulator_disable(struct regulator *regulator)
2925 struct regulator_dev *rdev = regulator->rdev;
2928 lockdep_assert_held_once(&rdev->mutex.base);
2930 if (WARN(rdev->use_count <= 0,
2931 "unbalanced disables for %s\n", rdev_get_name(rdev)))
2934 /* are we the last user and permitted to disable ? */
2935 if (rdev->use_count == 1 &&
2936 (rdev->constraints && !rdev->constraints->always_on)) {
2938 /* we are last user */
2939 if (regulator_ops_is_valid(rdev, REGULATOR_CHANGE_STATUS)) {
2940 ret = _notifier_call_chain(rdev,
2941 REGULATOR_EVENT_PRE_DISABLE,
2943 if (ret & NOTIFY_STOP_MASK)
2946 ret = _regulator_do_disable(rdev);
2948 rdev_err(rdev, "failed to disable: %pe\n", ERR_PTR(ret));
2949 _notifier_call_chain(rdev,
2950 REGULATOR_EVENT_ABORT_DISABLE,
2954 _notifier_call_chain(rdev, REGULATOR_EVENT_DISABLE,
2958 rdev->use_count = 0;
2959 } else if (rdev->use_count > 1) {
2964 ret = _regulator_handle_consumer_disable(regulator);
2966 if (ret == 0 && rdev->coupling_desc.n_coupled > 1)
2967 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
2969 if (ret == 0 && rdev->use_count == 0 && rdev->supply)
2970 ret = _regulator_disable(rdev->supply);
2976 * regulator_disable - disable regulator output
2977 * @regulator: regulator source
2979 * Disable the regulator output voltage or current. Calls to
2980 * regulator_enable() must be balanced with calls to
2981 * regulator_disable().
2983 * NOTE: this will only disable the regulator output if no other consumer
2984 * devices have it enabled, the regulator device supports disabling and
2985 * machine constraints permit this operation.
2987 int regulator_disable(struct regulator *regulator)
2989 struct regulator_dev *rdev = regulator->rdev;
2990 struct ww_acquire_ctx ww_ctx;
2993 regulator_lock_dependent(rdev, &ww_ctx);
2994 ret = _regulator_disable(regulator);
2995 regulator_unlock_dependent(rdev, &ww_ctx);
2999 EXPORT_SYMBOL_GPL(regulator_disable);
3001 /* locks held by regulator_force_disable() */
3002 static int _regulator_force_disable(struct regulator_dev *rdev)
3006 lockdep_assert_held_once(&rdev->mutex.base);
3008 ret = _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
3009 REGULATOR_EVENT_PRE_DISABLE, NULL);
3010 if (ret & NOTIFY_STOP_MASK)
3013 ret = _regulator_do_disable(rdev);
3015 rdev_err(rdev, "failed to force disable: %pe\n", ERR_PTR(ret));
3016 _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
3017 REGULATOR_EVENT_ABORT_DISABLE, NULL);
3021 _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
3022 REGULATOR_EVENT_DISABLE, NULL);
3028 * regulator_force_disable - force disable regulator output
3029 * @regulator: regulator source
3031 * Forcibly disable the regulator output voltage or current.
3032 * NOTE: this *will* disable the regulator output even if other consumer
3033 * devices have it enabled. This should be used for situations when device
3034 * damage will likely occur if the regulator is not disabled (e.g. over temp).
3036 int regulator_force_disable(struct regulator *regulator)
3038 struct regulator_dev *rdev = regulator->rdev;
3039 struct ww_acquire_ctx ww_ctx;
3042 regulator_lock_dependent(rdev, &ww_ctx);
3044 ret = _regulator_force_disable(regulator->rdev);
3046 if (rdev->coupling_desc.n_coupled > 1)
3047 regulator_balance_voltage(rdev, PM_SUSPEND_ON);
3049 if (regulator->uA_load) {
3050 regulator->uA_load = 0;
3051 ret = drms_uA_update(rdev);
3054 if (rdev->use_count != 0 && rdev->supply)
3055 _regulator_disable(rdev->supply);
3057 regulator_unlock_dependent(rdev, &ww_ctx);
3061 EXPORT_SYMBOL_GPL(regulator_force_disable);
3063 static void regulator_disable_work(struct work_struct *work)
3065 struct regulator_dev *rdev = container_of(work, struct regulator_dev,
3067 struct ww_acquire_ctx ww_ctx;
3069 struct regulator *regulator;
3070 int total_count = 0;
3072 regulator_lock_dependent(rdev, &ww_ctx);
3075 * Workqueue functions queue the new work instance while the previous
3076 * work instance is being processed. Cancel the queued work instance
3077 * as the work instance under processing does the job of the queued
3080 cancel_delayed_work(&rdev->disable_work);
3082 list_for_each_entry(regulator, &rdev->consumer_list, list) {
3083 count = regulator->deferred_disables;
3088 total_count += count;
3089 regulator->deferred_disables = 0;
3091 for (i = 0; i < count; i++) {
3092 ret = _regulator_disable(regulator);
3094 rdev_err(rdev, "Deferred disable failed: %pe\n",
3098 WARN_ON(!total_count);
3100 if (rdev->coupling_desc.n_coupled > 1)
3101 regulator_balance_voltage(rdev, PM_SUSPEND_ON);
3103 regulator_unlock_dependent(rdev, &ww_ctx);
3107 * regulator_disable_deferred - disable regulator output with delay
3108 * @regulator: regulator source
3109 * @ms: milliseconds until the regulator is disabled
3111 * Execute regulator_disable() on the regulator after a delay. This
3112 * is intended for use with devices that require some time to quiesce.
3114 * NOTE: this will only disable the regulator output if no other consumer
3115 * devices have it enabled, the regulator device supports disabling and
3116 * machine constraints permit this operation.
3118 int regulator_disable_deferred(struct regulator *regulator, int ms)
3120 struct regulator_dev *rdev = regulator->rdev;
3123 return regulator_disable(regulator);
3125 regulator_lock(rdev);
3126 regulator->deferred_disables++;
3127 mod_delayed_work(system_power_efficient_wq, &rdev->disable_work,
3128 msecs_to_jiffies(ms));
3129 regulator_unlock(rdev);
3133 EXPORT_SYMBOL_GPL(regulator_disable_deferred);
3135 static int _regulator_is_enabled(struct regulator_dev *rdev)
3137 /* A GPIO control always takes precedence */
3139 return rdev->ena_gpio_state;
3141 /* If we don't know then assume that the regulator is always on */
3142 if (!rdev->desc->ops->is_enabled)
3145 return rdev->desc->ops->is_enabled(rdev);
3148 static int _regulator_list_voltage(struct regulator_dev *rdev,
3149 unsigned selector, int lock)
3151 const struct regulator_ops *ops = rdev->desc->ops;
3154 if (rdev->desc->fixed_uV && rdev->desc->n_voltages == 1 && !selector)
3155 return rdev->desc->fixed_uV;
3157 if (ops->list_voltage) {
3158 if (selector >= rdev->desc->n_voltages)
3160 if (selector < rdev->desc->linear_min_sel)
3163 regulator_lock(rdev);
3164 ret = ops->list_voltage(rdev, selector);
3166 regulator_unlock(rdev);
3167 } else if (rdev->is_switch && rdev->supply) {
3168 ret = _regulator_list_voltage(rdev->supply->rdev,
3175 if (ret < rdev->constraints->min_uV)
3177 else if (ret > rdev->constraints->max_uV)
3185 * regulator_is_enabled - is the regulator output enabled
3186 * @regulator: regulator source
3188 * Returns positive if the regulator driver backing the source/client
3189 * has requested that the device be enabled, zero if it hasn't, else a
3190 * negative errno code.
3192 * Note that the device backing this regulator handle can have multiple
3193 * users, so it might be enabled even if regulator_enable() was never
3194 * called for this particular source.
3196 int regulator_is_enabled(struct regulator *regulator)
3200 if (regulator->always_on)
3203 regulator_lock(regulator->rdev);
3204 ret = _regulator_is_enabled(regulator->rdev);
3205 regulator_unlock(regulator->rdev);
3209 EXPORT_SYMBOL_GPL(regulator_is_enabled);
3212 * regulator_count_voltages - count regulator_list_voltage() selectors
3213 * @regulator: regulator source
3215 * Returns number of selectors, or negative errno. Selectors are
3216 * numbered starting at zero, and typically correspond to bitfields
3217 * in hardware registers.
3219 int regulator_count_voltages(struct regulator *regulator)
3221 struct regulator_dev *rdev = regulator->rdev;
3223 if (rdev->desc->n_voltages)
3224 return rdev->desc->n_voltages;
3226 if (!rdev->is_switch || !rdev->supply)
3229 return regulator_count_voltages(rdev->supply);
3231 EXPORT_SYMBOL_GPL(regulator_count_voltages);
3234 * regulator_list_voltage - enumerate supported voltages
3235 * @regulator: regulator source
3236 * @selector: identify voltage to list
3237 * Context: can sleep
3239 * Returns a voltage that can be passed to @regulator_set_voltage(),
3240 * zero if this selector code can't be used on this system, or a
3243 int regulator_list_voltage(struct regulator *regulator, unsigned selector)
3245 return _regulator_list_voltage(regulator->rdev, selector, 1);
3247 EXPORT_SYMBOL_GPL(regulator_list_voltage);
3250 * regulator_get_regmap - get the regulator's register map
3251 * @regulator: regulator source
3253 * Returns the register map for the given regulator, or an ERR_PTR value
3254 * if the regulator doesn't use regmap.
3256 struct regmap *regulator_get_regmap(struct regulator *regulator)
3258 struct regmap *map = regulator->rdev->regmap;
3260 return map ? map : ERR_PTR(-EOPNOTSUPP);
3264 * regulator_get_hardware_vsel_register - get the HW voltage selector register
3265 * @regulator: regulator source
3266 * @vsel_reg: voltage selector register, output parameter
3267 * @vsel_mask: mask for voltage selector bitfield, output parameter
3269 * Returns the hardware register offset and bitmask used for setting the
3270 * regulator voltage. This might be useful when configuring voltage-scaling
3271 * hardware or firmware that can make I2C requests behind the kernel's back,
3274 * On success, the output parameters @vsel_reg and @vsel_mask are filled in
3275 * and 0 is returned, otherwise a negative errno is returned.
3277 int regulator_get_hardware_vsel_register(struct regulator *regulator,
3279 unsigned *vsel_mask)
3281 struct regulator_dev *rdev = regulator->rdev;
3282 const struct regulator_ops *ops = rdev->desc->ops;
3284 if (ops->set_voltage_sel != regulator_set_voltage_sel_regmap)
3287 *vsel_reg = rdev->desc->vsel_reg;
3288 *vsel_mask = rdev->desc->vsel_mask;
3292 EXPORT_SYMBOL_GPL(regulator_get_hardware_vsel_register);
3295 * regulator_list_hardware_vsel - get the HW-specific register value for a selector
3296 * @regulator: regulator source
3297 * @selector: identify voltage to list
3299 * Converts the selector to a hardware-specific voltage selector that can be
3300 * directly written to the regulator registers. The address of the voltage
3301 * register can be determined by calling @regulator_get_hardware_vsel_register.
3303 * On error a negative errno is returned.
3305 int regulator_list_hardware_vsel(struct regulator *regulator,
3308 struct regulator_dev *rdev = regulator->rdev;
3309 const struct regulator_ops *ops = rdev->desc->ops;
3311 if (selector >= rdev->desc->n_voltages)
3313 if (selector < rdev->desc->linear_min_sel)
3315 if (ops->set_voltage_sel != regulator_set_voltage_sel_regmap)
3320 EXPORT_SYMBOL_GPL(regulator_list_hardware_vsel);
3323 * regulator_get_linear_step - return the voltage step size between VSEL values
3324 * @regulator: regulator source
3326 * Returns the voltage step size between VSEL values for linear
3327 * regulators, or return 0 if the regulator isn't a linear regulator.
3329 unsigned int regulator_get_linear_step(struct regulator *regulator)
3331 struct regulator_dev *rdev = regulator->rdev;
3333 return rdev->desc->uV_step;
3335 EXPORT_SYMBOL_GPL(regulator_get_linear_step);
3338 * regulator_is_supported_voltage - check if a voltage range can be supported
3340 * @regulator: Regulator to check.
3341 * @min_uV: Minimum required voltage in uV.
3342 * @max_uV: Maximum required voltage in uV.
3344 * Returns a boolean.
3346 int regulator_is_supported_voltage(struct regulator *regulator,
3347 int min_uV, int max_uV)
3349 struct regulator_dev *rdev = regulator->rdev;
3350 int i, voltages, ret;
3352 /* If we can't change voltage check the current voltage */
3353 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE)) {
3354 ret = regulator_get_voltage(regulator);
3356 return min_uV <= ret && ret <= max_uV;
3361 /* Any voltage within constrains range is fine? */
3362 if (rdev->desc->continuous_voltage_range)
3363 return min_uV >= rdev->constraints->min_uV &&
3364 max_uV <= rdev->constraints->max_uV;
3366 ret = regulator_count_voltages(regulator);
3371 for (i = 0; i < voltages; i++) {
3372 ret = regulator_list_voltage(regulator, i);
3374 if (ret >= min_uV && ret <= max_uV)
3380 EXPORT_SYMBOL_GPL(regulator_is_supported_voltage);
3382 static int regulator_map_voltage(struct regulator_dev *rdev, int min_uV,
3385 const struct regulator_desc *desc = rdev->desc;
3387 if (desc->ops->map_voltage)
3388 return desc->ops->map_voltage(rdev, min_uV, max_uV);
3390 if (desc->ops->list_voltage == regulator_list_voltage_linear)
3391 return regulator_map_voltage_linear(rdev, min_uV, max_uV);
3393 if (desc->ops->list_voltage == regulator_list_voltage_linear_range)
3394 return regulator_map_voltage_linear_range(rdev, min_uV, max_uV);
3396 if (desc->ops->list_voltage ==
3397 regulator_list_voltage_pickable_linear_range)
3398 return regulator_map_voltage_pickable_linear_range(rdev,
3401 return regulator_map_voltage_iterate(rdev, min_uV, max_uV);
3404 static int _regulator_call_set_voltage(struct regulator_dev *rdev,
3405 int min_uV, int max_uV,
3408 struct pre_voltage_change_data data;
3411 data.old_uV = regulator_get_voltage_rdev(rdev);
3412 data.min_uV = min_uV;
3413 data.max_uV = max_uV;
3414 ret = _notifier_call_chain(rdev, REGULATOR_EVENT_PRE_VOLTAGE_CHANGE,
3416 if (ret & NOTIFY_STOP_MASK)
3419 ret = rdev->desc->ops->set_voltage(rdev, min_uV, max_uV, selector);
3423 _notifier_call_chain(rdev, REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE,
3424 (void *)data.old_uV);
3429 static int _regulator_call_set_voltage_sel(struct regulator_dev *rdev,
3430 int uV, unsigned selector)
3432 struct pre_voltage_change_data data;
3435 data.old_uV = regulator_get_voltage_rdev(rdev);
3438 ret = _notifier_call_chain(rdev, REGULATOR_EVENT_PRE_VOLTAGE_CHANGE,
3440 if (ret & NOTIFY_STOP_MASK)
3443 ret = rdev->desc->ops->set_voltage_sel(rdev, selector);
3447 _notifier_call_chain(rdev, REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE,
3448 (void *)data.old_uV);
3453 static int _regulator_set_voltage_sel_step(struct regulator_dev *rdev,
3454 int uV, int new_selector)
3456 const struct regulator_ops *ops = rdev->desc->ops;
3457 int diff, old_sel, curr_sel, ret;
3459 /* Stepping is only needed if the regulator is enabled. */
3460 if (!_regulator_is_enabled(rdev))
3463 if (!ops->get_voltage_sel)
3466 old_sel = ops->get_voltage_sel(rdev);
3470 diff = new_selector - old_sel;
3472 return 0; /* No change needed. */
3476 for (curr_sel = old_sel + rdev->desc->vsel_step;
3477 curr_sel < new_selector;
3478 curr_sel += rdev->desc->vsel_step) {
3480 * Call the callback directly instead of using
3481 * _regulator_call_set_voltage_sel() as we don't
3482 * want to notify anyone yet. Same in the branch
3485 ret = ops->set_voltage_sel(rdev, curr_sel);
3490 /* Stepping down. */
3491 for (curr_sel = old_sel - rdev->desc->vsel_step;
3492 curr_sel > new_selector;
3493 curr_sel -= rdev->desc->vsel_step) {
3494 ret = ops->set_voltage_sel(rdev, curr_sel);
3501 /* The final selector will trigger the notifiers. */
3502 return _regulator_call_set_voltage_sel(rdev, uV, new_selector);
3506 * At least try to return to the previous voltage if setting a new
3509 (void)ops->set_voltage_sel(rdev, old_sel);
3513 static int _regulator_set_voltage_time(struct regulator_dev *rdev,
3514 int old_uV, int new_uV)
3516 unsigned int ramp_delay = 0;
3518 if (rdev->constraints->ramp_delay)
3519 ramp_delay = rdev->constraints->ramp_delay;
3520 else if (rdev->desc->ramp_delay)
3521 ramp_delay = rdev->desc->ramp_delay;
3522 else if (rdev->constraints->settling_time)
3523 return rdev->constraints->settling_time;
3524 else if (rdev->constraints->settling_time_up &&
3526 return rdev->constraints->settling_time_up;
3527 else if (rdev->constraints->settling_time_down &&
3529 return rdev->constraints->settling_time_down;
3531 if (ramp_delay == 0)
3534 return DIV_ROUND_UP(abs(new_uV - old_uV), ramp_delay);
3537 static int _regulator_do_set_voltage(struct regulator_dev *rdev,
3538 int min_uV, int max_uV)
3543 unsigned int selector;
3544 int old_selector = -1;
3545 const struct regulator_ops *ops = rdev->desc->ops;
3546 int old_uV = regulator_get_voltage_rdev(rdev);
3548 trace_regulator_set_voltage(rdev_get_name(rdev), min_uV, max_uV);
3550 min_uV += rdev->constraints->uV_offset;
3551 max_uV += rdev->constraints->uV_offset;
3554 * If we can't obtain the old selector there is not enough
3555 * info to call set_voltage_time_sel().
3557 if (_regulator_is_enabled(rdev) &&
3558 ops->set_voltage_time_sel && ops->get_voltage_sel) {
3559 old_selector = ops->get_voltage_sel(rdev);
3560 if (old_selector < 0)
3561 return old_selector;
3564 if (ops->set_voltage) {
3565 ret = _regulator_call_set_voltage(rdev, min_uV, max_uV,
3569 if (ops->list_voltage)
3570 best_val = ops->list_voltage(rdev,
3573 best_val = regulator_get_voltage_rdev(rdev);
3576 } else if (ops->set_voltage_sel) {
3577 ret = regulator_map_voltage(rdev, min_uV, max_uV);
3579 best_val = ops->list_voltage(rdev, ret);
3580 if (min_uV <= best_val && max_uV >= best_val) {
3582 if (old_selector == selector)
3584 else if (rdev->desc->vsel_step)
3585 ret = _regulator_set_voltage_sel_step(
3586 rdev, best_val, selector);
3588 ret = _regulator_call_set_voltage_sel(
3589 rdev, best_val, selector);
3601 if (ops->set_voltage_time_sel) {
3603 * Call set_voltage_time_sel if successfully obtained
3606 if (old_selector >= 0 && old_selector != selector)
3607 delay = ops->set_voltage_time_sel(rdev, old_selector,
3610 if (old_uV != best_val) {
3611 if (ops->set_voltage_time)
3612 delay = ops->set_voltage_time(rdev, old_uV,
3615 delay = _regulator_set_voltage_time(rdev,
3622 rdev_warn(rdev, "failed to get delay: %pe\n", ERR_PTR(delay));
3626 /* Insert any necessary delays */
3627 _regulator_delay_helper(delay);
3629 if (best_val >= 0) {
3630 unsigned long data = best_val;
3632 _notifier_call_chain(rdev, REGULATOR_EVENT_VOLTAGE_CHANGE,
3637 trace_regulator_set_voltage_complete(rdev_get_name(rdev), best_val);
3642 static int _regulator_do_set_suspend_voltage(struct regulator_dev *rdev,
3643 int min_uV, int max_uV, suspend_state_t state)
3645 struct regulator_state *rstate;
3648 rstate = regulator_get_suspend_state(rdev, state);
3652 if (min_uV < rstate->min_uV)
3653 min_uV = rstate->min_uV;
3654 if (max_uV > rstate->max_uV)
3655 max_uV = rstate->max_uV;
3657 sel = regulator_map_voltage(rdev, min_uV, max_uV);
3661 uV = rdev->desc->ops->list_voltage(rdev, sel);
3662 if (uV >= min_uV && uV <= max_uV)
3668 static int regulator_set_voltage_unlocked(struct regulator *regulator,
3669 int min_uV, int max_uV,
3670 suspend_state_t state)
3672 struct regulator_dev *rdev = regulator->rdev;
3673 struct regulator_voltage *voltage = ®ulator->voltage[state];
3675 int old_min_uV, old_max_uV;
3678 /* If we're setting the same range as last time the change
3679 * should be a noop (some cpufreq implementations use the same
3680 * voltage for multiple frequencies, for example).
3682 if (voltage->min_uV == min_uV && voltage->max_uV == max_uV)
3685 /* If we're trying to set a range that overlaps the current voltage,
3686 * return successfully even though the regulator does not support
3687 * changing the voltage.
3689 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE)) {
3690 current_uV = regulator_get_voltage_rdev(rdev);
3691 if (min_uV <= current_uV && current_uV <= max_uV) {
3692 voltage->min_uV = min_uV;
3693 voltage->max_uV = max_uV;
3699 if (!rdev->desc->ops->set_voltage &&
3700 !rdev->desc->ops->set_voltage_sel) {
3705 /* constraints check */
3706 ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
3710 /* restore original values in case of error */
3711 old_min_uV = voltage->min_uV;
3712 old_max_uV = voltage->max_uV;
3713 voltage->min_uV = min_uV;
3714 voltage->max_uV = max_uV;
3716 /* for not coupled regulators this will just set the voltage */
3717 ret = regulator_balance_voltage(rdev, state);
3719 voltage->min_uV = old_min_uV;
3720 voltage->max_uV = old_max_uV;
3727 int regulator_set_voltage_rdev(struct regulator_dev *rdev, int min_uV,
3728 int max_uV, suspend_state_t state)
3730 int best_supply_uV = 0;
3731 int supply_change_uV = 0;
3735 regulator_ops_is_valid(rdev->supply->rdev,
3736 REGULATOR_CHANGE_VOLTAGE) &&
3737 (rdev->desc->min_dropout_uV || !(rdev->desc->ops->get_voltage ||
3738 rdev->desc->ops->get_voltage_sel))) {
3739 int current_supply_uV;
3742 selector = regulator_map_voltage(rdev, min_uV, max_uV);
3748 best_supply_uV = _regulator_list_voltage(rdev, selector, 0);
3749 if (best_supply_uV < 0) {
3750 ret = best_supply_uV;
3754 best_supply_uV += rdev->desc->min_dropout_uV;
3756 current_supply_uV = regulator_get_voltage_rdev(rdev->supply->rdev);
3757 if (current_supply_uV < 0) {
3758 ret = current_supply_uV;
3762 supply_change_uV = best_supply_uV - current_supply_uV;
3765 if (supply_change_uV > 0) {
3766 ret = regulator_set_voltage_unlocked(rdev->supply,
3767 best_supply_uV, INT_MAX, state);
3769 dev_err(&rdev->dev, "Failed to increase supply voltage: %pe\n",
3775 if (state == PM_SUSPEND_ON)
3776 ret = _regulator_do_set_voltage(rdev, min_uV, max_uV);
3778 ret = _regulator_do_set_suspend_voltage(rdev, min_uV,
3783 if (supply_change_uV < 0) {
3784 ret = regulator_set_voltage_unlocked(rdev->supply,
3785 best_supply_uV, INT_MAX, state);
3787 dev_warn(&rdev->dev, "Failed to decrease supply voltage: %pe\n",
3789 /* No need to fail here */
3796 EXPORT_SYMBOL_GPL(regulator_set_voltage_rdev);
3798 static int regulator_limit_voltage_step(struct regulator_dev *rdev,
3799 int *current_uV, int *min_uV)
3801 struct regulation_constraints *constraints = rdev->constraints;
3803 /* Limit voltage change only if necessary */
3804 if (!constraints->max_uV_step || !_regulator_is_enabled(rdev))
3807 if (*current_uV < 0) {
3808 *current_uV = regulator_get_voltage_rdev(rdev);
3810 if (*current_uV < 0)
3814 if (abs(*current_uV - *min_uV) <= constraints->max_uV_step)
3817 /* Clamp target voltage within the given step */
3818 if (*current_uV < *min_uV)
3819 *min_uV = min(*current_uV + constraints->max_uV_step,
3822 *min_uV = max(*current_uV - constraints->max_uV_step,
3828 static int regulator_get_optimal_voltage(struct regulator_dev *rdev,
3830 int *min_uV, int *max_uV,
3831 suspend_state_t state,
3834 struct coupling_desc *c_desc = &rdev->coupling_desc;
3835 struct regulator_dev **c_rdevs = c_desc->coupled_rdevs;
3836 struct regulation_constraints *constraints = rdev->constraints;
3837 int desired_min_uV = 0, desired_max_uV = INT_MAX;
3838 int max_current_uV = 0, min_current_uV = INT_MAX;
3839 int highest_min_uV = 0, target_uV, possible_uV;
3840 int i, ret, max_spread;
3846 * If there are no coupled regulators, simply set the voltage
3847 * demanded by consumers.
3849 if (n_coupled == 1) {
3851 * If consumers don't provide any demands, set voltage
3854 desired_min_uV = constraints->min_uV;
3855 desired_max_uV = constraints->max_uV;
3857 ret = regulator_check_consumers(rdev,
3859 &desired_max_uV, state);
3863 possible_uV = desired_min_uV;
3869 /* Find highest min desired voltage */
3870 for (i = 0; i < n_coupled; i++) {
3872 int tmp_max = INT_MAX;
3874 lockdep_assert_held_once(&c_rdevs[i]->mutex.base);
3876 ret = regulator_check_consumers(c_rdevs[i],
3882 ret = regulator_check_voltage(c_rdevs[i], &tmp_min, &tmp_max);
3886 highest_min_uV = max(highest_min_uV, tmp_min);
3889 desired_min_uV = tmp_min;
3890 desired_max_uV = tmp_max;
3894 max_spread = constraints->max_spread[0];
3897 * Let target_uV be equal to the desired one if possible.
3898 * If not, set it to minimum voltage, allowed by other coupled
3901 target_uV = max(desired_min_uV, highest_min_uV - max_spread);
3904 * Find min and max voltages, which currently aren't violating
3907 for (i = 1; i < n_coupled; i++) {
3910 if (!_regulator_is_enabled(c_rdevs[i]))
3913 tmp_act = regulator_get_voltage_rdev(c_rdevs[i]);
3917 min_current_uV = min(tmp_act, min_current_uV);
3918 max_current_uV = max(tmp_act, max_current_uV);
3921 /* There aren't any other regulators enabled */
3922 if (max_current_uV == 0) {
3923 possible_uV = target_uV;
3926 * Correct target voltage, so as it currently isn't
3927 * violating max_spread
3929 possible_uV = max(target_uV, max_current_uV - max_spread);
3930 possible_uV = min(possible_uV, min_current_uV + max_spread);
3933 if (possible_uV > desired_max_uV)
3936 done = (possible_uV == target_uV);
3937 desired_min_uV = possible_uV;
3940 /* Apply max_uV_step constraint if necessary */
3941 if (state == PM_SUSPEND_ON) {
3942 ret = regulator_limit_voltage_step(rdev, current_uV,
3951 /* Set current_uV if wasn't done earlier in the code and if necessary */
3952 if (n_coupled > 1 && *current_uV == -1) {
3954 if (_regulator_is_enabled(rdev)) {
3955 ret = regulator_get_voltage_rdev(rdev);
3961 *current_uV = desired_min_uV;
3965 *min_uV = desired_min_uV;
3966 *max_uV = desired_max_uV;
3971 int regulator_do_balance_voltage(struct regulator_dev *rdev,
3972 suspend_state_t state, bool skip_coupled)
3974 struct regulator_dev **c_rdevs;
3975 struct regulator_dev *best_rdev;
3976 struct coupling_desc *c_desc = &rdev->coupling_desc;
3977 int i, ret, n_coupled, best_min_uV, best_max_uV, best_c_rdev;
3978 unsigned int delta, best_delta;
3979 unsigned long c_rdev_done = 0;
3980 bool best_c_rdev_done;
3982 c_rdevs = c_desc->coupled_rdevs;
3983 n_coupled = skip_coupled ? 1 : c_desc->n_coupled;
3986 * Find the best possible voltage change on each loop. Leave the loop
3987 * if there isn't any possible change.
3990 best_c_rdev_done = false;
3998 * Find highest difference between optimal voltage
3999 * and current voltage.
4001 for (i = 0; i < n_coupled; i++) {
4003 * optimal_uV is the best voltage that can be set for
4004 * i-th regulator at the moment without violating
4005 * max_spread constraint in order to balance
4006 * the coupled voltages.
4008 int optimal_uV = 0, optimal_max_uV = 0, current_uV = 0;
4010 if (test_bit(i, &c_rdev_done))
4013 ret = regulator_get_optimal_voltage(c_rdevs[i],
4021 delta = abs(optimal_uV - current_uV);
4023 if (delta && best_delta <= delta) {
4024 best_c_rdev_done = ret;
4026 best_rdev = c_rdevs[i];
4027 best_min_uV = optimal_uV;
4028 best_max_uV = optimal_max_uV;
4033 /* Nothing to change, return successfully */
4039 ret = regulator_set_voltage_rdev(best_rdev, best_min_uV,
4040 best_max_uV, state);
4045 if (best_c_rdev_done)
4046 set_bit(best_c_rdev, &c_rdev_done);
4048 } while (n_coupled > 1);
4054 static int regulator_balance_voltage(struct regulator_dev *rdev,
4055 suspend_state_t state)
4057 struct coupling_desc *c_desc = &rdev->coupling_desc;
4058 struct regulator_coupler *coupler = c_desc->coupler;
4059 bool skip_coupled = false;
4062 * If system is in a state other than PM_SUSPEND_ON, don't check
4063 * other coupled regulators.
4065 if (state != PM_SUSPEND_ON)
4066 skip_coupled = true;
4068 if (c_desc->n_resolved < c_desc->n_coupled) {
4069 rdev_err(rdev, "Not all coupled regulators registered\n");
4073 /* Invoke custom balancer for customized couplers */
4074 if (coupler && coupler->balance_voltage)
4075 return coupler->balance_voltage(coupler, rdev, state);
4077 return regulator_do_balance_voltage(rdev, state, skip_coupled);
4081 * regulator_set_voltage - set regulator output voltage
4082 * @regulator: regulator source
4083 * @min_uV: Minimum required voltage in uV
4084 * @max_uV: Maximum acceptable voltage in uV
4086 * Sets a voltage regulator to the desired output voltage. This can be set
4087 * during any regulator state. IOW, regulator can be disabled or enabled.
4089 * If the regulator is enabled then the voltage will change to the new value
4090 * immediately otherwise if the regulator is disabled the regulator will
4091 * output at the new voltage when enabled.
4093 * NOTE: If the regulator is shared between several devices then the lowest
4094 * request voltage that meets the system constraints will be used.
4095 * Regulator system constraints must be set for this regulator before
4096 * calling this function otherwise this call will fail.
4098 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
4100 struct ww_acquire_ctx ww_ctx;
4103 regulator_lock_dependent(regulator->rdev, &ww_ctx);
4105 ret = regulator_set_voltage_unlocked(regulator, min_uV, max_uV,
4108 regulator_unlock_dependent(regulator->rdev, &ww_ctx);
4112 EXPORT_SYMBOL_GPL(regulator_set_voltage);
4114 static inline int regulator_suspend_toggle(struct regulator_dev *rdev,
4115 suspend_state_t state, bool en)
4117 struct regulator_state *rstate;
4119 rstate = regulator_get_suspend_state(rdev, state);
4123 if (!rstate->changeable)
4126 rstate->enabled = (en) ? ENABLE_IN_SUSPEND : DISABLE_IN_SUSPEND;
4131 int regulator_suspend_enable(struct regulator_dev *rdev,
4132 suspend_state_t state)
4134 return regulator_suspend_toggle(rdev, state, true);
4136 EXPORT_SYMBOL_GPL(regulator_suspend_enable);
4138 int regulator_suspend_disable(struct regulator_dev *rdev,
4139 suspend_state_t state)
4141 struct regulator *regulator;
4142 struct regulator_voltage *voltage;
4145 * if any consumer wants this regulator device keeping on in
4146 * suspend states, don't set it as disabled.
4148 list_for_each_entry(regulator, &rdev->consumer_list, list) {
4149 voltage = ®ulator->voltage[state];
4150 if (voltage->min_uV || voltage->max_uV)
4154 return regulator_suspend_toggle(rdev, state, false);
4156 EXPORT_SYMBOL_GPL(regulator_suspend_disable);
4158 static int _regulator_set_suspend_voltage(struct regulator *regulator,
4159 int min_uV, int max_uV,
4160 suspend_state_t state)
4162 struct regulator_dev *rdev = regulator->rdev;
4163 struct regulator_state *rstate;
4165 rstate = regulator_get_suspend_state(rdev, state);
4169 if (rstate->min_uV == rstate->max_uV) {
4170 rdev_err(rdev, "The suspend voltage can't be changed!\n");
4174 return regulator_set_voltage_unlocked(regulator, min_uV, max_uV, state);
4177 int regulator_set_suspend_voltage(struct regulator *regulator, int min_uV,
4178 int max_uV, suspend_state_t state)
4180 struct ww_acquire_ctx ww_ctx;
4183 /* PM_SUSPEND_ON is handled by regulator_set_voltage() */
4184 if (regulator_check_states(state) || state == PM_SUSPEND_ON)
4187 regulator_lock_dependent(regulator->rdev, &ww_ctx);
4189 ret = _regulator_set_suspend_voltage(regulator, min_uV,
4192 regulator_unlock_dependent(regulator->rdev, &ww_ctx);
4196 EXPORT_SYMBOL_GPL(regulator_set_suspend_voltage);
4199 * regulator_set_voltage_time - get raise/fall time
4200 * @regulator: regulator source
4201 * @old_uV: starting voltage in microvolts
4202 * @new_uV: target voltage in microvolts
4204 * Provided with the starting and ending voltage, this function attempts to
4205 * calculate the time in microseconds required to rise or fall to this new
4208 int regulator_set_voltage_time(struct regulator *regulator,
4209 int old_uV, int new_uV)
4211 struct regulator_dev *rdev = regulator->rdev;
4212 const struct regulator_ops *ops = rdev->desc->ops;
4218 if (ops->set_voltage_time)
4219 return ops->set_voltage_time(rdev, old_uV, new_uV);
4220 else if (!ops->set_voltage_time_sel)
4221 return _regulator_set_voltage_time(rdev, old_uV, new_uV);
4223 /* Currently requires operations to do this */
4224 if (!ops->list_voltage || !rdev->desc->n_voltages)
4227 for (i = 0; i < rdev->desc->n_voltages; i++) {
4228 /* We only look for exact voltage matches here */
4229 if (i < rdev->desc->linear_min_sel)
4232 if (old_sel >= 0 && new_sel >= 0)
4235 voltage = regulator_list_voltage(regulator, i);
4240 if (voltage == old_uV)
4242 if (voltage == new_uV)
4246 if (old_sel < 0 || new_sel < 0)
4249 return ops->set_voltage_time_sel(rdev, old_sel, new_sel);
4251 EXPORT_SYMBOL_GPL(regulator_set_voltage_time);
4254 * regulator_set_voltage_time_sel - get raise/fall time
4255 * @rdev: regulator source device
4256 * @old_selector: selector for starting voltage
4257 * @new_selector: selector for target voltage
4259 * Provided with the starting and target voltage selectors, this function
4260 * returns time in microseconds required to rise or fall to this new voltage
4262 * Drivers providing ramp_delay in regulation_constraints can use this as their
4263 * set_voltage_time_sel() operation.
4265 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
4266 unsigned int old_selector,
4267 unsigned int new_selector)
4269 int old_volt, new_volt;
4272 if (!rdev->desc->ops->list_voltage)
4275 old_volt = rdev->desc->ops->list_voltage(rdev, old_selector);
4276 new_volt = rdev->desc->ops->list_voltage(rdev, new_selector);
4278 if (rdev->desc->ops->set_voltage_time)
4279 return rdev->desc->ops->set_voltage_time(rdev, old_volt,
4282 return _regulator_set_voltage_time(rdev, old_volt, new_volt);
4284 EXPORT_SYMBOL_GPL(regulator_set_voltage_time_sel);
4286 int regulator_sync_voltage_rdev(struct regulator_dev *rdev)
4290 regulator_lock(rdev);
4292 if (!rdev->desc->ops->set_voltage &&
4293 !rdev->desc->ops->set_voltage_sel) {
4298 /* balance only, if regulator is coupled */
4299 if (rdev->coupling_desc.n_coupled > 1)
4300 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
4305 regulator_unlock(rdev);
4310 * regulator_sync_voltage - re-apply last regulator output voltage
4311 * @regulator: regulator source
4313 * Re-apply the last configured voltage. This is intended to be used
4314 * where some external control source the consumer is cooperating with
4315 * has caused the configured voltage to change.
4317 int regulator_sync_voltage(struct regulator *regulator)
4319 struct regulator_dev *rdev = regulator->rdev;
4320 struct regulator_voltage *voltage = ®ulator->voltage[PM_SUSPEND_ON];
4321 int ret, min_uV, max_uV;
4323 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE))
4326 regulator_lock(rdev);
4328 if (!rdev->desc->ops->set_voltage &&
4329 !rdev->desc->ops->set_voltage_sel) {
4334 /* This is only going to work if we've had a voltage configured. */
4335 if (!voltage->min_uV && !voltage->max_uV) {
4340 min_uV = voltage->min_uV;
4341 max_uV = voltage->max_uV;
4343 /* This should be a paranoia check... */
4344 ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
4348 ret = regulator_check_consumers(rdev, &min_uV, &max_uV, 0);
4352 /* balance only, if regulator is coupled */
4353 if (rdev->coupling_desc.n_coupled > 1)
4354 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
4356 ret = _regulator_do_set_voltage(rdev, min_uV, max_uV);
4359 regulator_unlock(rdev);
4362 EXPORT_SYMBOL_GPL(regulator_sync_voltage);
4364 int regulator_get_voltage_rdev(struct regulator_dev *rdev)
4369 if (rdev->desc->ops->get_bypass) {
4370 ret = rdev->desc->ops->get_bypass(rdev, &bypassed);
4374 /* if bypassed the regulator must have a supply */
4375 if (!rdev->supply) {
4377 "bypassed regulator has no supply!\n");
4378 return -EPROBE_DEFER;
4381 return regulator_get_voltage_rdev(rdev->supply->rdev);
4385 if (rdev->desc->ops->get_voltage_sel) {
4386 sel = rdev->desc->ops->get_voltage_sel(rdev);
4389 ret = rdev->desc->ops->list_voltage(rdev, sel);
4390 } else if (rdev->desc->ops->get_voltage) {
4391 ret = rdev->desc->ops->get_voltage(rdev);
4392 } else if (rdev->desc->ops->list_voltage) {
4393 ret = rdev->desc->ops->list_voltage(rdev, 0);
4394 } else if (rdev->desc->fixed_uV && (rdev->desc->n_voltages == 1)) {
4395 ret = rdev->desc->fixed_uV;
4396 } else if (rdev->supply) {
4397 ret = regulator_get_voltage_rdev(rdev->supply->rdev);
4398 } else if (rdev->supply_name) {
4399 return -EPROBE_DEFER;
4406 return ret - rdev->constraints->uV_offset;
4408 EXPORT_SYMBOL_GPL(regulator_get_voltage_rdev);
4411 * regulator_get_voltage - get regulator output voltage
4412 * @regulator: regulator source
4414 * This returns the current regulator voltage in uV.
4416 * NOTE: If the regulator is disabled it will return the voltage value. This
4417 * function should not be used to determine regulator state.
4419 int regulator_get_voltage(struct regulator *regulator)
4421 struct ww_acquire_ctx ww_ctx;
4424 regulator_lock_dependent(regulator->rdev, &ww_ctx);
4425 ret = regulator_get_voltage_rdev(regulator->rdev);
4426 regulator_unlock_dependent(regulator->rdev, &ww_ctx);
4430 EXPORT_SYMBOL_GPL(regulator_get_voltage);
4433 * regulator_set_current_limit - set regulator output current limit
4434 * @regulator: regulator source
4435 * @min_uA: Minimum supported current in uA
4436 * @max_uA: Maximum supported current in uA
4438 * Sets current sink to the desired output current. This can be set during
4439 * any regulator state. IOW, regulator can be disabled or enabled.
4441 * If the regulator is enabled then the current will change to the new value
4442 * immediately otherwise if the regulator is disabled the regulator will
4443 * output at the new current when enabled.
4445 * NOTE: Regulator system constraints must be set for this regulator before
4446 * calling this function otherwise this call will fail.
4448 int regulator_set_current_limit(struct regulator *regulator,
4449 int min_uA, int max_uA)
4451 struct regulator_dev *rdev = regulator->rdev;
4454 regulator_lock(rdev);
4457 if (!rdev->desc->ops->set_current_limit) {
4462 /* constraints check */
4463 ret = regulator_check_current_limit(rdev, &min_uA, &max_uA);
4467 ret = rdev->desc->ops->set_current_limit(rdev, min_uA, max_uA);
4469 regulator_unlock(rdev);
4472 EXPORT_SYMBOL_GPL(regulator_set_current_limit);
4474 static int _regulator_get_current_limit_unlocked(struct regulator_dev *rdev)
4477 if (!rdev->desc->ops->get_current_limit)
4480 return rdev->desc->ops->get_current_limit(rdev);
4483 static int _regulator_get_current_limit(struct regulator_dev *rdev)
4487 regulator_lock(rdev);
4488 ret = _regulator_get_current_limit_unlocked(rdev);
4489 regulator_unlock(rdev);
4495 * regulator_get_current_limit - get regulator output current
4496 * @regulator: regulator source
4498 * This returns the current supplied by the specified current sink in uA.
4500 * NOTE: If the regulator is disabled it will return the current value. This
4501 * function should not be used to determine regulator state.
4503 int regulator_get_current_limit(struct regulator *regulator)
4505 return _regulator_get_current_limit(regulator->rdev);
4507 EXPORT_SYMBOL_GPL(regulator_get_current_limit);
4510 * regulator_set_mode - set regulator operating mode
4511 * @regulator: regulator source
4512 * @mode: operating mode - one of the REGULATOR_MODE constants
4514 * Set regulator operating mode to increase regulator efficiency or improve
4515 * regulation performance.
4517 * NOTE: Regulator system constraints must be set for this regulator before
4518 * calling this function otherwise this call will fail.
4520 int regulator_set_mode(struct regulator *regulator, unsigned int mode)
4522 struct regulator_dev *rdev = regulator->rdev;
4524 int regulator_curr_mode;
4526 regulator_lock(rdev);
4529 if (!rdev->desc->ops->set_mode) {
4534 /* return if the same mode is requested */
4535 if (rdev->desc->ops->get_mode) {
4536 regulator_curr_mode = rdev->desc->ops->get_mode(rdev);
4537 if (regulator_curr_mode == mode) {
4543 /* constraints check */
4544 ret = regulator_mode_constrain(rdev, &mode);
4548 ret = rdev->desc->ops->set_mode(rdev, mode);
4550 regulator_unlock(rdev);
4553 EXPORT_SYMBOL_GPL(regulator_set_mode);
4555 static unsigned int _regulator_get_mode_unlocked(struct regulator_dev *rdev)
4558 if (!rdev->desc->ops->get_mode)
4561 return rdev->desc->ops->get_mode(rdev);
4564 static unsigned int _regulator_get_mode(struct regulator_dev *rdev)
4568 regulator_lock(rdev);
4569 ret = _regulator_get_mode_unlocked(rdev);
4570 regulator_unlock(rdev);
4576 * regulator_get_mode - get regulator operating mode
4577 * @regulator: regulator source
4579 * Get the current regulator operating mode.
4581 unsigned int regulator_get_mode(struct regulator *regulator)
4583 return _regulator_get_mode(regulator->rdev);
4585 EXPORT_SYMBOL_GPL(regulator_get_mode);
4587 static int rdev_get_cached_err_flags(struct regulator_dev *rdev)
4591 if (rdev->use_cached_err) {
4592 spin_lock(&rdev->err_lock);
4593 ret = rdev->cached_err;
4594 spin_unlock(&rdev->err_lock);
4599 static int _regulator_get_error_flags(struct regulator_dev *rdev,
4600 unsigned int *flags)
4602 int cached_flags, ret = 0;
4604 regulator_lock(rdev);
4606 cached_flags = rdev_get_cached_err_flags(rdev);
4608 if (rdev->desc->ops->get_error_flags)
4609 ret = rdev->desc->ops->get_error_flags(rdev, flags);
4610 else if (!rdev->use_cached_err)
4613 *flags |= cached_flags;
4615 regulator_unlock(rdev);
4621 * regulator_get_error_flags - get regulator error information
4622 * @regulator: regulator source
4623 * @flags: pointer to store error flags
4625 * Get the current regulator error information.
4627 int regulator_get_error_flags(struct regulator *regulator,
4628 unsigned int *flags)
4630 return _regulator_get_error_flags(regulator->rdev, flags);
4632 EXPORT_SYMBOL_GPL(regulator_get_error_flags);
4635 * regulator_set_load - set regulator load
4636 * @regulator: regulator source
4637 * @uA_load: load current
4639 * Notifies the regulator core of a new device load. This is then used by
4640 * DRMS (if enabled by constraints) to set the most efficient regulator
4641 * operating mode for the new regulator loading.
4643 * Consumer devices notify their supply regulator of the maximum power
4644 * they will require (can be taken from device datasheet in the power
4645 * consumption tables) when they change operational status and hence power
4646 * state. Examples of operational state changes that can affect power
4647 * consumption are :-
4649 * o Device is opened / closed.
4650 * o Device I/O is about to begin or has just finished.
4651 * o Device is idling in between work.
4653 * This information is also exported via sysfs to userspace.
4655 * DRMS will sum the total requested load on the regulator and change
4656 * to the most efficient operating mode if platform constraints allow.
4658 * NOTE: when a regulator consumer requests to have a regulator
4659 * disabled then any load that consumer requested no longer counts
4660 * toward the total requested load. If the regulator is re-enabled
4661 * then the previously requested load will start counting again.
4663 * If a regulator is an always-on regulator then an individual consumer's
4664 * load will still be removed if that consumer is fully disabled.
4666 * On error a negative errno is returned.
4668 int regulator_set_load(struct regulator *regulator, int uA_load)
4670 struct regulator_dev *rdev = regulator->rdev;
4674 regulator_lock(rdev);
4675 old_uA_load = regulator->uA_load;
4676 regulator->uA_load = uA_load;
4677 if (regulator->enable_count && old_uA_load != uA_load) {
4678 ret = drms_uA_update(rdev);
4680 regulator->uA_load = old_uA_load;
4682 regulator_unlock(rdev);
4686 EXPORT_SYMBOL_GPL(regulator_set_load);
4689 * regulator_allow_bypass - allow the regulator to go into bypass mode
4691 * @regulator: Regulator to configure
4692 * @enable: enable or disable bypass mode
4694 * Allow the regulator to go into bypass mode if all other consumers
4695 * for the regulator also enable bypass mode and the machine
4696 * constraints allow this. Bypass mode means that the regulator is
4697 * simply passing the input directly to the output with no regulation.
4699 int regulator_allow_bypass(struct regulator *regulator, bool enable)
4701 struct regulator_dev *rdev = regulator->rdev;
4702 const char *name = rdev_get_name(rdev);
4705 if (!rdev->desc->ops->set_bypass)
4708 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_BYPASS))
4711 regulator_lock(rdev);
4713 if (enable && !regulator->bypass) {
4714 rdev->bypass_count++;
4716 if (rdev->bypass_count == rdev->open_count) {
4717 trace_regulator_bypass_enable(name);
4719 ret = rdev->desc->ops->set_bypass(rdev, enable);
4721 rdev->bypass_count--;
4723 trace_regulator_bypass_enable_complete(name);
4726 } else if (!enable && regulator->bypass) {
4727 rdev->bypass_count--;
4729 if (rdev->bypass_count != rdev->open_count) {
4730 trace_regulator_bypass_disable(name);
4732 ret = rdev->desc->ops->set_bypass(rdev, enable);
4734 rdev->bypass_count++;
4736 trace_regulator_bypass_disable_complete(name);
4741 regulator->bypass = enable;
4743 regulator_unlock(rdev);
4747 EXPORT_SYMBOL_GPL(regulator_allow_bypass);
4750 * regulator_register_notifier - register regulator event notifier
4751 * @regulator: regulator source
4752 * @nb: notifier block
4754 * Register notifier block to receive regulator events.
4756 int regulator_register_notifier(struct regulator *regulator,
4757 struct notifier_block *nb)
4759 return blocking_notifier_chain_register(®ulator->rdev->notifier,
4762 EXPORT_SYMBOL_GPL(regulator_register_notifier);
4765 * regulator_unregister_notifier - unregister regulator event notifier
4766 * @regulator: regulator source
4767 * @nb: notifier block
4769 * Unregister regulator event notifier block.
4771 int regulator_unregister_notifier(struct regulator *regulator,
4772 struct notifier_block *nb)
4774 return blocking_notifier_chain_unregister(®ulator->rdev->notifier,
4777 EXPORT_SYMBOL_GPL(regulator_unregister_notifier);
4779 /* notify regulator consumers and downstream regulator consumers.
4780 * Note mutex must be held by caller.
4782 static int _notifier_call_chain(struct regulator_dev *rdev,
4783 unsigned long event, void *data)
4785 /* call rdev chain first */
4786 return blocking_notifier_call_chain(&rdev->notifier, event, data);
4789 int _regulator_bulk_get(struct device *dev, int num_consumers,
4790 struct regulator_bulk_data *consumers, enum regulator_get_type get_type)
4795 for (i = 0; i < num_consumers; i++)
4796 consumers[i].consumer = NULL;
4798 for (i = 0; i < num_consumers; i++) {
4799 consumers[i].consumer = _regulator_get(dev,
4800 consumers[i].supply, get_type);
4801 if (IS_ERR(consumers[i].consumer)) {
4802 ret = dev_err_probe(dev, PTR_ERR(consumers[i].consumer),
4803 "Failed to get supply '%s'",
4804 consumers[i].supply);
4805 consumers[i].consumer = NULL;
4809 if (consumers[i].init_load_uA > 0) {
4810 ret = regulator_set_load(consumers[i].consumer,
4811 consumers[i].init_load_uA);
4823 regulator_put(consumers[i].consumer);
4829 * regulator_bulk_get - get multiple regulator consumers
4831 * @dev: Device to supply
4832 * @num_consumers: Number of consumers to register
4833 * @consumers: Configuration of consumers; clients are stored here.
4835 * @return 0 on success, an errno on failure.
4837 * This helper function allows drivers to get several regulator
4838 * consumers in one operation. If any of the regulators cannot be
4839 * acquired then any regulators that were allocated will be freed
4840 * before returning to the caller.
4842 int regulator_bulk_get(struct device *dev, int num_consumers,
4843 struct regulator_bulk_data *consumers)
4845 return _regulator_bulk_get(dev, num_consumers, consumers, NORMAL_GET);
4847 EXPORT_SYMBOL_GPL(regulator_bulk_get);
4849 static void regulator_bulk_enable_async(void *data, async_cookie_t cookie)
4851 struct regulator_bulk_data *bulk = data;
4853 bulk->ret = regulator_enable(bulk->consumer);
4857 * regulator_bulk_enable - enable multiple regulator consumers
4859 * @num_consumers: Number of consumers
4860 * @consumers: Consumer data; clients are stored here.
4861 * @return 0 on success, an errno on failure
4863 * This convenience API allows consumers to enable multiple regulator
4864 * clients in a single API call. If any consumers cannot be enabled
4865 * then any others that were enabled will be disabled again prior to
4868 int regulator_bulk_enable(int num_consumers,
4869 struct regulator_bulk_data *consumers)
4871 ASYNC_DOMAIN_EXCLUSIVE(async_domain);
4875 for (i = 0; i < num_consumers; i++) {
4876 async_schedule_domain(regulator_bulk_enable_async,
4877 &consumers[i], &async_domain);
4880 async_synchronize_full_domain(&async_domain);
4882 /* If any consumer failed we need to unwind any that succeeded */
4883 for (i = 0; i < num_consumers; i++) {
4884 if (consumers[i].ret != 0) {
4885 ret = consumers[i].ret;
4893 for (i = 0; i < num_consumers; i++) {
4894 if (consumers[i].ret < 0)
4895 pr_err("Failed to enable %s: %pe\n", consumers[i].supply,
4896 ERR_PTR(consumers[i].ret));
4898 regulator_disable(consumers[i].consumer);
4903 EXPORT_SYMBOL_GPL(regulator_bulk_enable);
4906 * regulator_bulk_disable - disable multiple regulator consumers
4908 * @num_consumers: Number of consumers
4909 * @consumers: Consumer data; clients are stored here.
4910 * @return 0 on success, an errno on failure
4912 * This convenience API allows consumers to disable multiple regulator
4913 * clients in a single API call. If any consumers cannot be disabled
4914 * then any others that were disabled will be enabled again prior to
4917 int regulator_bulk_disable(int num_consumers,
4918 struct regulator_bulk_data *consumers)
4923 for (i = num_consumers - 1; i >= 0; --i) {
4924 ret = regulator_disable(consumers[i].consumer);
4932 pr_err("Failed to disable %s: %pe\n", consumers[i].supply, ERR_PTR(ret));
4933 for (++i; i < num_consumers; ++i) {
4934 r = regulator_enable(consumers[i].consumer);
4936 pr_err("Failed to re-enable %s: %pe\n",
4937 consumers[i].supply, ERR_PTR(r));
4942 EXPORT_SYMBOL_GPL(regulator_bulk_disable);
4945 * regulator_bulk_force_disable - force disable multiple regulator consumers
4947 * @num_consumers: Number of consumers
4948 * @consumers: Consumer data; clients are stored here.
4949 * @return 0 on success, an errno on failure
4951 * This convenience API allows consumers to forcibly disable multiple regulator
4952 * clients in a single API call.
4953 * NOTE: This should be used for situations when device damage will
4954 * likely occur if the regulators are not disabled (e.g. over temp).
4955 * Although regulator_force_disable function call for some consumers can
4956 * return error numbers, the function is called for all consumers.
4958 int regulator_bulk_force_disable(int num_consumers,
4959 struct regulator_bulk_data *consumers)
4964 for (i = 0; i < num_consumers; i++) {
4966 regulator_force_disable(consumers[i].consumer);
4968 /* Store first error for reporting */
4969 if (consumers[i].ret && !ret)
4970 ret = consumers[i].ret;
4975 EXPORT_SYMBOL_GPL(regulator_bulk_force_disable);
4978 * regulator_bulk_free - free multiple regulator consumers
4980 * @num_consumers: Number of consumers
4981 * @consumers: Consumer data; clients are stored here.
4983 * This convenience API allows consumers to free multiple regulator
4984 * clients in a single API call.
4986 void regulator_bulk_free(int num_consumers,
4987 struct regulator_bulk_data *consumers)
4991 for (i = 0; i < num_consumers; i++) {
4992 regulator_put(consumers[i].consumer);
4993 consumers[i].consumer = NULL;
4996 EXPORT_SYMBOL_GPL(regulator_bulk_free);
4999 * regulator_notifier_call_chain - call regulator event notifier
5000 * @rdev: regulator source
5001 * @event: notifier block
5002 * @data: callback-specific data.
5004 * Called by regulator drivers to notify clients a regulator event has
5007 int regulator_notifier_call_chain(struct regulator_dev *rdev,
5008 unsigned long event, void *data)
5010 _notifier_call_chain(rdev, event, data);
5014 EXPORT_SYMBOL_GPL(regulator_notifier_call_chain);
5017 * regulator_mode_to_status - convert a regulator mode into a status
5019 * @mode: Mode to convert
5021 * Convert a regulator mode into a status.
5023 int regulator_mode_to_status(unsigned int mode)
5026 case REGULATOR_MODE_FAST:
5027 return REGULATOR_STATUS_FAST;
5028 case REGULATOR_MODE_NORMAL:
5029 return REGULATOR_STATUS_NORMAL;
5030 case REGULATOR_MODE_IDLE:
5031 return REGULATOR_STATUS_IDLE;
5032 case REGULATOR_MODE_STANDBY:
5033 return REGULATOR_STATUS_STANDBY;
5035 return REGULATOR_STATUS_UNDEFINED;
5038 EXPORT_SYMBOL_GPL(regulator_mode_to_status);
5040 static struct attribute *regulator_dev_attrs[] = {
5041 &dev_attr_name.attr,
5042 &dev_attr_num_users.attr,
5043 &dev_attr_type.attr,
5044 &dev_attr_microvolts.attr,
5045 &dev_attr_microamps.attr,
5046 &dev_attr_opmode.attr,
5047 &dev_attr_state.attr,
5048 &dev_attr_status.attr,
5049 &dev_attr_bypass.attr,
5050 &dev_attr_requested_microamps.attr,
5051 &dev_attr_min_microvolts.attr,
5052 &dev_attr_max_microvolts.attr,
5053 &dev_attr_min_microamps.attr,
5054 &dev_attr_max_microamps.attr,
5055 &dev_attr_under_voltage.attr,
5056 &dev_attr_over_current.attr,
5057 &dev_attr_regulation_out.attr,
5058 &dev_attr_fail.attr,
5059 &dev_attr_over_temp.attr,
5060 &dev_attr_under_voltage_warn.attr,
5061 &dev_attr_over_current_warn.attr,
5062 &dev_attr_over_voltage_warn.attr,
5063 &dev_attr_over_temp_warn.attr,
5064 &dev_attr_suspend_standby_state.attr,
5065 &dev_attr_suspend_mem_state.attr,
5066 &dev_attr_suspend_disk_state.attr,
5067 &dev_attr_suspend_standby_microvolts.attr,
5068 &dev_attr_suspend_mem_microvolts.attr,
5069 &dev_attr_suspend_disk_microvolts.attr,
5070 &dev_attr_suspend_standby_mode.attr,
5071 &dev_attr_suspend_mem_mode.attr,
5072 &dev_attr_suspend_disk_mode.attr,
5077 * To avoid cluttering sysfs (and memory) with useless state, only
5078 * create attributes that can be meaningfully displayed.
5080 static umode_t regulator_attr_is_visible(struct kobject *kobj,
5081 struct attribute *attr, int idx)
5083 struct device *dev = kobj_to_dev(kobj);
5084 struct regulator_dev *rdev = dev_to_rdev(dev);
5085 const struct regulator_ops *ops = rdev->desc->ops;
5086 umode_t mode = attr->mode;
5088 /* these three are always present */
5089 if (attr == &dev_attr_name.attr ||
5090 attr == &dev_attr_num_users.attr ||
5091 attr == &dev_attr_type.attr)
5094 /* some attributes need specific methods to be displayed */
5095 if (attr == &dev_attr_microvolts.attr) {
5096 if ((ops->get_voltage && ops->get_voltage(rdev) >= 0) ||
5097 (ops->get_voltage_sel && ops->get_voltage_sel(rdev) >= 0) ||
5098 (ops->list_voltage && ops->list_voltage(rdev, 0) >= 0) ||
5099 (rdev->desc->fixed_uV && rdev->desc->n_voltages == 1))
5104 if (attr == &dev_attr_microamps.attr)
5105 return ops->get_current_limit ? mode : 0;
5107 if (attr == &dev_attr_opmode.attr)
5108 return ops->get_mode ? mode : 0;
5110 if (attr == &dev_attr_state.attr)
5111 return (rdev->ena_pin || ops->is_enabled) ? mode : 0;
5113 if (attr == &dev_attr_status.attr)
5114 return ops->get_status ? mode : 0;
5116 if (attr == &dev_attr_bypass.attr)
5117 return ops->get_bypass ? mode : 0;
5119 if (attr == &dev_attr_under_voltage.attr ||
5120 attr == &dev_attr_over_current.attr ||
5121 attr == &dev_attr_regulation_out.attr ||
5122 attr == &dev_attr_fail.attr ||
5123 attr == &dev_attr_over_temp.attr ||
5124 attr == &dev_attr_under_voltage_warn.attr ||
5125 attr == &dev_attr_over_current_warn.attr ||
5126 attr == &dev_attr_over_voltage_warn.attr ||
5127 attr == &dev_attr_over_temp_warn.attr)
5128 return ops->get_error_flags ? mode : 0;
5130 /* constraints need specific supporting methods */
5131 if (attr == &dev_attr_min_microvolts.attr ||
5132 attr == &dev_attr_max_microvolts.attr)
5133 return (ops->set_voltage || ops->set_voltage_sel) ? mode : 0;
5135 if (attr == &dev_attr_min_microamps.attr ||
5136 attr == &dev_attr_max_microamps.attr)
5137 return ops->set_current_limit ? mode : 0;
5139 if (attr == &dev_attr_suspend_standby_state.attr ||
5140 attr == &dev_attr_suspend_mem_state.attr ||
5141 attr == &dev_attr_suspend_disk_state.attr)
5144 if (attr == &dev_attr_suspend_standby_microvolts.attr ||
5145 attr == &dev_attr_suspend_mem_microvolts.attr ||
5146 attr == &dev_attr_suspend_disk_microvolts.attr)
5147 return ops->set_suspend_voltage ? mode : 0;
5149 if (attr == &dev_attr_suspend_standby_mode.attr ||
5150 attr == &dev_attr_suspend_mem_mode.attr ||
5151 attr == &dev_attr_suspend_disk_mode.attr)
5152 return ops->set_suspend_mode ? mode : 0;
5157 static const struct attribute_group regulator_dev_group = {
5158 .attrs = regulator_dev_attrs,
5159 .is_visible = regulator_attr_is_visible,
5162 static const struct attribute_group *regulator_dev_groups[] = {
5163 ®ulator_dev_group,
5167 static void regulator_dev_release(struct device *dev)
5169 struct regulator_dev *rdev = dev_get_drvdata(dev);
5171 debugfs_remove_recursive(rdev->debugfs);
5172 kfree(rdev->constraints);
5173 of_node_put(rdev->dev.of_node);
5177 static void rdev_init_debugfs(struct regulator_dev *rdev)
5179 struct device *parent = rdev->dev.parent;
5180 const char *rname = rdev_get_name(rdev);
5181 char name[NAME_MAX];
5183 /* Avoid duplicate debugfs directory names */
5184 if (parent && rname == rdev->desc->name) {
5185 snprintf(name, sizeof(name), "%s-%s", dev_name(parent),
5190 rdev->debugfs = debugfs_create_dir(rname, debugfs_root);
5191 if (!rdev->debugfs) {
5192 rdev_warn(rdev, "Failed to create debugfs directory\n");
5196 debugfs_create_u32("use_count", 0444, rdev->debugfs,
5198 debugfs_create_u32("open_count", 0444, rdev->debugfs,
5200 debugfs_create_u32("bypass_count", 0444, rdev->debugfs,
5201 &rdev->bypass_count);
5204 static int regulator_register_resolve_supply(struct device *dev, void *data)
5206 struct regulator_dev *rdev = dev_to_rdev(dev);
5208 if (regulator_resolve_supply(rdev))
5209 rdev_dbg(rdev, "unable to resolve supply\n");
5214 int regulator_coupler_register(struct regulator_coupler *coupler)
5216 mutex_lock(®ulator_list_mutex);
5217 list_add_tail(&coupler->list, ®ulator_coupler_list);
5218 mutex_unlock(®ulator_list_mutex);
5223 static struct regulator_coupler *
5224 regulator_find_coupler(struct regulator_dev *rdev)
5226 struct regulator_coupler *coupler;
5230 * Note that regulators are appended to the list and the generic
5231 * coupler is registered first, hence it will be attached at last
5234 list_for_each_entry_reverse(coupler, ®ulator_coupler_list, list) {
5235 err = coupler->attach_regulator(coupler, rdev);
5237 if (!coupler->balance_voltage &&
5238 rdev->coupling_desc.n_coupled > 2)
5239 goto err_unsupported;
5245 return ERR_PTR(err);
5253 return ERR_PTR(-EINVAL);
5256 if (coupler->detach_regulator)
5257 coupler->detach_regulator(coupler, rdev);
5260 "Voltage balancing for multiple regulator couples is unimplemented\n");
5262 return ERR_PTR(-EPERM);
5265 static void regulator_resolve_coupling(struct regulator_dev *rdev)
5267 struct regulator_coupler *coupler = rdev->coupling_desc.coupler;
5268 struct coupling_desc *c_desc = &rdev->coupling_desc;
5269 int n_coupled = c_desc->n_coupled;
5270 struct regulator_dev *c_rdev;
5273 for (i = 1; i < n_coupled; i++) {
5274 /* already resolved */
5275 if (c_desc->coupled_rdevs[i])
5278 c_rdev = of_parse_coupled_regulator(rdev, i - 1);
5283 if (c_rdev->coupling_desc.coupler != coupler) {
5284 rdev_err(rdev, "coupler mismatch with %s\n",
5285 rdev_get_name(c_rdev));
5289 c_desc->coupled_rdevs[i] = c_rdev;
5290 c_desc->n_resolved++;
5292 regulator_resolve_coupling(c_rdev);
5296 static void regulator_remove_coupling(struct regulator_dev *rdev)
5298 struct regulator_coupler *coupler = rdev->coupling_desc.coupler;
5299 struct coupling_desc *__c_desc, *c_desc = &rdev->coupling_desc;
5300 struct regulator_dev *__c_rdev, *c_rdev;
5301 unsigned int __n_coupled, n_coupled;
5305 n_coupled = c_desc->n_coupled;
5307 for (i = 1; i < n_coupled; i++) {
5308 c_rdev = c_desc->coupled_rdevs[i];
5313 regulator_lock(c_rdev);
5315 __c_desc = &c_rdev->coupling_desc;
5316 __n_coupled = __c_desc->n_coupled;
5318 for (k = 1; k < __n_coupled; k++) {
5319 __c_rdev = __c_desc->coupled_rdevs[k];
5321 if (__c_rdev == rdev) {
5322 __c_desc->coupled_rdevs[k] = NULL;
5323 __c_desc->n_resolved--;
5328 regulator_unlock(c_rdev);
5330 c_desc->coupled_rdevs[i] = NULL;
5331 c_desc->n_resolved--;
5334 if (coupler && coupler->detach_regulator) {
5335 err = coupler->detach_regulator(coupler, rdev);
5337 rdev_err(rdev, "failed to detach from coupler: %pe\n",
5341 kfree(rdev->coupling_desc.coupled_rdevs);
5342 rdev->coupling_desc.coupled_rdevs = NULL;
5345 static int regulator_init_coupling(struct regulator_dev *rdev)
5347 struct regulator_dev **coupled;
5348 int err, n_phandles;
5350 if (!IS_ENABLED(CONFIG_OF))
5353 n_phandles = of_get_n_coupled(rdev);
5355 coupled = kcalloc(n_phandles + 1, sizeof(*coupled), GFP_KERNEL);
5359 rdev->coupling_desc.coupled_rdevs = coupled;
5362 * Every regulator should always have coupling descriptor filled with
5363 * at least pointer to itself.
5365 rdev->coupling_desc.coupled_rdevs[0] = rdev;
5366 rdev->coupling_desc.n_coupled = n_phandles + 1;
5367 rdev->coupling_desc.n_resolved++;
5369 /* regulator isn't coupled */
5370 if (n_phandles == 0)
5373 if (!of_check_coupling_data(rdev))
5376 mutex_lock(®ulator_list_mutex);
5377 rdev->coupling_desc.coupler = regulator_find_coupler(rdev);
5378 mutex_unlock(®ulator_list_mutex);
5380 if (IS_ERR(rdev->coupling_desc.coupler)) {
5381 err = PTR_ERR(rdev->coupling_desc.coupler);
5382 rdev_err(rdev, "failed to get coupler: %pe\n", ERR_PTR(err));
5389 static int generic_coupler_attach(struct regulator_coupler *coupler,
5390 struct regulator_dev *rdev)
5392 if (rdev->coupling_desc.n_coupled > 2) {
5394 "Voltage balancing for multiple regulator couples is unimplemented\n");
5398 if (!rdev->constraints->always_on) {
5400 "Coupling of a non always-on regulator is unimplemented\n");
5407 static struct regulator_coupler generic_regulator_coupler = {
5408 .attach_regulator = generic_coupler_attach,
5412 * regulator_register - register regulator
5413 * @dev: the device that drive the regulator
5414 * @regulator_desc: regulator to register
5415 * @cfg: runtime configuration for regulator
5417 * Called by regulator drivers to register a regulator.
5418 * Returns a valid pointer to struct regulator_dev on success
5419 * or an ERR_PTR() on error.
5421 struct regulator_dev *
5422 regulator_register(struct device *dev,
5423 const struct regulator_desc *regulator_desc,
5424 const struct regulator_config *cfg)
5426 const struct regulator_init_data *init_data;
5427 struct regulator_config *config = NULL;
5428 static atomic_t regulator_no = ATOMIC_INIT(-1);
5429 struct regulator_dev *rdev;
5430 bool dangling_cfg_gpiod = false;
5431 bool dangling_of_gpiod = false;
5433 bool resolved_early = false;
5436 return ERR_PTR(-EINVAL);
5438 dangling_cfg_gpiod = true;
5439 if (regulator_desc == NULL) {
5444 WARN_ON(!dev || !cfg->dev);
5446 if (regulator_desc->name == NULL || regulator_desc->ops == NULL) {
5451 if (regulator_desc->type != REGULATOR_VOLTAGE &&
5452 regulator_desc->type != REGULATOR_CURRENT) {
5457 /* Only one of each should be implemented */
5458 WARN_ON(regulator_desc->ops->get_voltage &&
5459 regulator_desc->ops->get_voltage_sel);
5460 WARN_ON(regulator_desc->ops->set_voltage &&
5461 regulator_desc->ops->set_voltage_sel);
5463 /* If we're using selectors we must implement list_voltage. */
5464 if (regulator_desc->ops->get_voltage_sel &&
5465 !regulator_desc->ops->list_voltage) {
5469 if (regulator_desc->ops->set_voltage_sel &&
5470 !regulator_desc->ops->list_voltage) {
5475 rdev = kzalloc(sizeof(struct regulator_dev), GFP_KERNEL);
5480 device_initialize(&rdev->dev);
5481 spin_lock_init(&rdev->err_lock);
5484 * Duplicate the config so the driver could override it after
5485 * parsing init data.
5487 config = kmemdup(cfg, sizeof(*cfg), GFP_KERNEL);
5488 if (config == NULL) {
5493 init_data = regulator_of_get_init_data(dev, regulator_desc, config,
5494 &rdev->dev.of_node);
5497 * Sometimes not all resources are probed already so we need to take
5498 * that into account. This happens most the time if the ena_gpiod comes
5499 * from a gpio extender or something else.
5501 if (PTR_ERR(init_data) == -EPROBE_DEFER) {
5502 ret = -EPROBE_DEFER;
5507 * We need to keep track of any GPIO descriptor coming from the
5508 * device tree until we have handled it over to the core. If the
5509 * config that was passed in to this function DOES NOT contain
5510 * a descriptor, and the config after this call DOES contain
5511 * a descriptor, we definitely got one from parsing the device
5514 if (!cfg->ena_gpiod && config->ena_gpiod)
5515 dangling_of_gpiod = true;
5517 init_data = config->init_data;
5518 rdev->dev.of_node = of_node_get(config->of_node);
5521 ww_mutex_init(&rdev->mutex, ®ulator_ww_class);
5522 rdev->reg_data = config->driver_data;
5523 rdev->owner = regulator_desc->owner;
5524 rdev->desc = regulator_desc;
5526 rdev->regmap = config->regmap;
5527 else if (dev_get_regmap(dev, NULL))
5528 rdev->regmap = dev_get_regmap(dev, NULL);
5529 else if (dev->parent)
5530 rdev->regmap = dev_get_regmap(dev->parent, NULL);
5531 INIT_LIST_HEAD(&rdev->consumer_list);
5532 INIT_LIST_HEAD(&rdev->list);
5533 BLOCKING_INIT_NOTIFIER_HEAD(&rdev->notifier);
5534 INIT_DELAYED_WORK(&rdev->disable_work, regulator_disable_work);
5536 if (init_data && init_data->supply_regulator)
5537 rdev->supply_name = init_data->supply_regulator;
5538 else if (regulator_desc->supply_name)
5539 rdev->supply_name = regulator_desc->supply_name;
5541 /* register with sysfs */
5542 rdev->dev.class = ®ulator_class;
5543 rdev->dev.parent = config->dev;
5544 dev_set_name(&rdev->dev, "regulator.%lu",
5545 (unsigned long) atomic_inc_return(®ulator_no));
5546 dev_set_drvdata(&rdev->dev, rdev);
5548 /* set regulator constraints */
5550 rdev->constraints = kmemdup(&init_data->constraints,
5551 sizeof(*rdev->constraints),
5554 rdev->constraints = kzalloc(sizeof(*rdev->constraints),
5556 if (!rdev->constraints) {
5561 if ((rdev->supply_name && !rdev->supply) &&
5562 (rdev->constraints->always_on ||
5563 rdev->constraints->boot_on)) {
5564 ret = regulator_resolve_supply(rdev);
5566 rdev_dbg(rdev, "unable to resolve supply early: %pe\n",
5569 resolved_early = true;
5572 /* perform any regulator specific init */
5573 if (init_data && init_data->regulator_init) {
5574 ret = init_data->regulator_init(rdev->reg_data);
5579 if (config->ena_gpiod) {
5580 ret = regulator_ena_gpio_request(rdev, config);
5582 rdev_err(rdev, "Failed to request enable GPIO: %pe\n",
5586 /* The regulator core took over the GPIO descriptor */
5587 dangling_cfg_gpiod = false;
5588 dangling_of_gpiod = false;
5591 ret = set_machine_constraints(rdev);
5592 if (ret == -EPROBE_DEFER && !resolved_early) {
5593 /* Regulator might be in bypass mode and so needs its supply
5594 * to set the constraints
5596 /* FIXME: this currently triggers a chicken-and-egg problem
5597 * when creating -SUPPLY symlink in sysfs to a regulator
5598 * that is just being created
5600 rdev_dbg(rdev, "will resolve supply early: %s\n",
5602 ret = regulator_resolve_supply(rdev);
5604 ret = set_machine_constraints(rdev);
5606 rdev_dbg(rdev, "unable to resolve supply early: %pe\n",
5612 ret = regulator_init_coupling(rdev);
5616 /* add consumers devices */
5618 for (i = 0; i < init_data->num_consumer_supplies; i++) {
5619 ret = set_consumer_device_supply(rdev,
5620 init_data->consumer_supplies[i].dev_name,
5621 init_data->consumer_supplies[i].supply);
5623 dev_err(dev, "Failed to set supply %s\n",
5624 init_data->consumer_supplies[i].supply);
5625 goto unset_supplies;
5630 if (!rdev->desc->ops->get_voltage &&
5631 !rdev->desc->ops->list_voltage &&
5632 !rdev->desc->fixed_uV)
5633 rdev->is_switch = true;
5635 ret = device_add(&rdev->dev);
5637 goto unset_supplies;
5639 rdev_init_debugfs(rdev);
5641 /* try to resolve regulators coupling since a new one was registered */
5642 mutex_lock(®ulator_list_mutex);
5643 regulator_resolve_coupling(rdev);
5644 mutex_unlock(®ulator_list_mutex);
5646 /* try to resolve regulators supply since a new one was registered */
5647 class_for_each_device(®ulator_class, NULL, NULL,
5648 regulator_register_resolve_supply);
5653 mutex_lock(®ulator_list_mutex);
5654 unset_regulator_supplies(rdev);
5655 regulator_remove_coupling(rdev);
5656 mutex_unlock(®ulator_list_mutex);
5658 regulator_put(rdev->supply);
5659 kfree(rdev->coupling_desc.coupled_rdevs);
5660 mutex_lock(®ulator_list_mutex);
5661 regulator_ena_gpio_free(rdev);
5662 mutex_unlock(®ulator_list_mutex);
5663 put_device(&rdev->dev);
5666 if (dangling_of_gpiod)
5667 gpiod_put(config->ena_gpiod);
5668 if (rdev && rdev->dev.of_node)
5669 of_node_put(rdev->dev.of_node);
5673 if (dangling_cfg_gpiod)
5674 gpiod_put(cfg->ena_gpiod);
5675 return ERR_PTR(ret);
5677 EXPORT_SYMBOL_GPL(regulator_register);
5680 * regulator_unregister - unregister regulator
5681 * @rdev: regulator to unregister
5683 * Called by regulator drivers to unregister a regulator.
5685 void regulator_unregister(struct regulator_dev *rdev)
5691 while (rdev->use_count--)
5692 regulator_disable(rdev->supply);
5693 regulator_put(rdev->supply);
5696 flush_work(&rdev->disable_work.work);
5698 mutex_lock(®ulator_list_mutex);
5700 WARN_ON(rdev->open_count);
5701 regulator_remove_coupling(rdev);
5702 unset_regulator_supplies(rdev);
5703 list_del(&rdev->list);
5704 regulator_ena_gpio_free(rdev);
5705 device_unregister(&rdev->dev);
5707 mutex_unlock(®ulator_list_mutex);
5709 EXPORT_SYMBOL_GPL(regulator_unregister);
5711 #ifdef CONFIG_SUSPEND
5713 * regulator_suspend - prepare regulators for system wide suspend
5714 * @dev: ``&struct device`` pointer that is passed to _regulator_suspend()
5716 * Configure each regulator with it's suspend operating parameters for state.
5718 static int regulator_suspend(struct device *dev)
5720 struct regulator_dev *rdev = dev_to_rdev(dev);
5721 suspend_state_t state = pm_suspend_target_state;
5723 const struct regulator_state *rstate;
5725 rstate = regulator_get_suspend_state_check(rdev, state);
5729 regulator_lock(rdev);
5730 ret = __suspend_set_state(rdev, rstate);
5731 regulator_unlock(rdev);
5736 static int regulator_resume(struct device *dev)
5738 suspend_state_t state = pm_suspend_target_state;
5739 struct regulator_dev *rdev = dev_to_rdev(dev);
5740 struct regulator_state *rstate;
5743 rstate = regulator_get_suspend_state(rdev, state);
5747 /* Avoid grabbing the lock if we don't need to */
5748 if (!rdev->desc->ops->resume)
5751 regulator_lock(rdev);
5753 if (rstate->enabled == ENABLE_IN_SUSPEND ||
5754 rstate->enabled == DISABLE_IN_SUSPEND)
5755 ret = rdev->desc->ops->resume(rdev);
5757 regulator_unlock(rdev);
5761 #else /* !CONFIG_SUSPEND */
5763 #define regulator_suspend NULL
5764 #define regulator_resume NULL
5766 #endif /* !CONFIG_SUSPEND */
5769 static const struct dev_pm_ops __maybe_unused regulator_pm_ops = {
5770 .suspend = regulator_suspend,
5771 .resume = regulator_resume,
5775 struct class regulator_class = {
5776 .name = "regulator",
5777 .dev_release = regulator_dev_release,
5778 .dev_groups = regulator_dev_groups,
5780 .pm = ®ulator_pm_ops,
5784 * regulator_has_full_constraints - the system has fully specified constraints
5786 * Calling this function will cause the regulator API to disable all
5787 * regulators which have a zero use count and don't have an always_on
5788 * constraint in a late_initcall.
5790 * The intention is that this will become the default behaviour in a
5791 * future kernel release so users are encouraged to use this facility
5794 void regulator_has_full_constraints(void)
5796 has_full_constraints = 1;
5798 EXPORT_SYMBOL_GPL(regulator_has_full_constraints);
5801 * rdev_get_drvdata - get rdev regulator driver data
5804 * Get rdev regulator driver private data. This call can be used in the
5805 * regulator driver context.
5807 void *rdev_get_drvdata(struct regulator_dev *rdev)
5809 return rdev->reg_data;
5811 EXPORT_SYMBOL_GPL(rdev_get_drvdata);
5814 * regulator_get_drvdata - get regulator driver data
5815 * @regulator: regulator
5817 * Get regulator driver private data. This call can be used in the consumer
5818 * driver context when non API regulator specific functions need to be called.
5820 void *regulator_get_drvdata(struct regulator *regulator)
5822 return regulator->rdev->reg_data;
5824 EXPORT_SYMBOL_GPL(regulator_get_drvdata);
5827 * regulator_set_drvdata - set regulator driver data
5828 * @regulator: regulator
5831 void regulator_set_drvdata(struct regulator *regulator, void *data)
5833 regulator->rdev->reg_data = data;
5835 EXPORT_SYMBOL_GPL(regulator_set_drvdata);
5838 * rdev_get_id - get regulator ID
5841 int rdev_get_id(struct regulator_dev *rdev)
5843 return rdev->desc->id;
5845 EXPORT_SYMBOL_GPL(rdev_get_id);
5847 struct device *rdev_get_dev(struct regulator_dev *rdev)
5851 EXPORT_SYMBOL_GPL(rdev_get_dev);
5853 struct regmap *rdev_get_regmap(struct regulator_dev *rdev)
5855 return rdev->regmap;
5857 EXPORT_SYMBOL_GPL(rdev_get_regmap);
5859 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data)
5861 return reg_init_data->driver_data;
5863 EXPORT_SYMBOL_GPL(regulator_get_init_drvdata);
5865 #ifdef CONFIG_DEBUG_FS
5866 static int supply_map_show(struct seq_file *sf, void *data)
5868 struct regulator_map *map;
5870 list_for_each_entry(map, ®ulator_map_list, list) {
5871 seq_printf(sf, "%s -> %s.%s\n",
5872 rdev_get_name(map->regulator), map->dev_name,
5878 DEFINE_SHOW_ATTRIBUTE(supply_map);
5880 struct summary_data {
5882 struct regulator_dev *parent;
5886 static void regulator_summary_show_subtree(struct seq_file *s,
5887 struct regulator_dev *rdev,
5890 static int regulator_summary_show_children(struct device *dev, void *data)
5892 struct regulator_dev *rdev = dev_to_rdev(dev);
5893 struct summary_data *summary_data = data;
5895 if (rdev->supply && rdev->supply->rdev == summary_data->parent)
5896 regulator_summary_show_subtree(summary_data->s, rdev,
5897 summary_data->level + 1);
5902 static void regulator_summary_show_subtree(struct seq_file *s,
5903 struct regulator_dev *rdev,
5906 struct regulation_constraints *c;
5907 struct regulator *consumer;
5908 struct summary_data summary_data;
5909 unsigned int opmode;
5914 opmode = _regulator_get_mode_unlocked(rdev);
5915 seq_printf(s, "%*s%-*s %3d %4d %6d %7s ",
5917 30 - level * 3, rdev_get_name(rdev),
5918 rdev->use_count, rdev->open_count, rdev->bypass_count,
5919 regulator_opmode_to_str(opmode));
5921 seq_printf(s, "%5dmV ", regulator_get_voltage_rdev(rdev) / 1000);
5922 seq_printf(s, "%5dmA ",
5923 _regulator_get_current_limit_unlocked(rdev) / 1000);
5925 c = rdev->constraints;
5927 switch (rdev->desc->type) {
5928 case REGULATOR_VOLTAGE:
5929 seq_printf(s, "%5dmV %5dmV ",
5930 c->min_uV / 1000, c->max_uV / 1000);
5932 case REGULATOR_CURRENT:
5933 seq_printf(s, "%5dmA %5dmA ",
5934 c->min_uA / 1000, c->max_uA / 1000);
5941 list_for_each_entry(consumer, &rdev->consumer_list, list) {
5942 if (consumer->dev && consumer->dev->class == ®ulator_class)
5945 seq_printf(s, "%*s%-*s ",
5946 (level + 1) * 3 + 1, "",
5947 30 - (level + 1) * 3,
5948 consumer->supply_name ? consumer->supply_name :
5949 consumer->dev ? dev_name(consumer->dev) : "deviceless");
5951 switch (rdev->desc->type) {
5952 case REGULATOR_VOLTAGE:
5953 seq_printf(s, "%3d %33dmA%c%5dmV %5dmV",
5954 consumer->enable_count,
5955 consumer->uA_load / 1000,
5956 consumer->uA_load && !consumer->enable_count ?
5958 consumer->voltage[PM_SUSPEND_ON].min_uV / 1000,
5959 consumer->voltage[PM_SUSPEND_ON].max_uV / 1000);
5961 case REGULATOR_CURRENT:
5969 summary_data.level = level;
5970 summary_data.parent = rdev;
5972 class_for_each_device(®ulator_class, NULL, &summary_data,
5973 regulator_summary_show_children);
5976 struct summary_lock_data {
5977 struct ww_acquire_ctx *ww_ctx;
5978 struct regulator_dev **new_contended_rdev;
5979 struct regulator_dev **old_contended_rdev;
5982 static int regulator_summary_lock_one(struct device *dev, void *data)
5984 struct regulator_dev *rdev = dev_to_rdev(dev);
5985 struct summary_lock_data *lock_data = data;
5988 if (rdev != *lock_data->old_contended_rdev) {
5989 ret = regulator_lock_nested(rdev, lock_data->ww_ctx);
5991 if (ret == -EDEADLK)
5992 *lock_data->new_contended_rdev = rdev;
5996 *lock_data->old_contended_rdev = NULL;
6002 static int regulator_summary_unlock_one(struct device *dev, void *data)
6004 struct regulator_dev *rdev = dev_to_rdev(dev);
6005 struct summary_lock_data *lock_data = data;
6008 if (rdev == *lock_data->new_contended_rdev)
6012 regulator_unlock(rdev);
6017 static int regulator_summary_lock_all(struct ww_acquire_ctx *ww_ctx,
6018 struct regulator_dev **new_contended_rdev,
6019 struct regulator_dev **old_contended_rdev)
6021 struct summary_lock_data lock_data;
6024 lock_data.ww_ctx = ww_ctx;
6025 lock_data.new_contended_rdev = new_contended_rdev;
6026 lock_data.old_contended_rdev = old_contended_rdev;
6028 ret = class_for_each_device(®ulator_class, NULL, &lock_data,
6029 regulator_summary_lock_one);
6031 class_for_each_device(®ulator_class, NULL, &lock_data,
6032 regulator_summary_unlock_one);
6037 static void regulator_summary_lock(struct ww_acquire_ctx *ww_ctx)
6039 struct regulator_dev *new_contended_rdev = NULL;
6040 struct regulator_dev *old_contended_rdev = NULL;
6043 mutex_lock(®ulator_list_mutex);
6045 ww_acquire_init(ww_ctx, ®ulator_ww_class);
6048 if (new_contended_rdev) {
6049 ww_mutex_lock_slow(&new_contended_rdev->mutex, ww_ctx);
6050 old_contended_rdev = new_contended_rdev;
6051 old_contended_rdev->ref_cnt++;
6054 err = regulator_summary_lock_all(ww_ctx,
6055 &new_contended_rdev,
6056 &old_contended_rdev);
6058 if (old_contended_rdev)
6059 regulator_unlock(old_contended_rdev);
6061 } while (err == -EDEADLK);
6063 ww_acquire_done(ww_ctx);
6066 static void regulator_summary_unlock(struct ww_acquire_ctx *ww_ctx)
6068 class_for_each_device(®ulator_class, NULL, NULL,
6069 regulator_summary_unlock_one);
6070 ww_acquire_fini(ww_ctx);
6072 mutex_unlock(®ulator_list_mutex);
6075 static int regulator_summary_show_roots(struct device *dev, void *data)
6077 struct regulator_dev *rdev = dev_to_rdev(dev);
6078 struct seq_file *s = data;
6081 regulator_summary_show_subtree(s, rdev, 0);
6086 static int regulator_summary_show(struct seq_file *s, void *data)
6088 struct ww_acquire_ctx ww_ctx;
6090 seq_puts(s, " regulator use open bypass opmode voltage current min max\n");
6091 seq_puts(s, "---------------------------------------------------------------------------------------\n");
6093 regulator_summary_lock(&ww_ctx);
6095 class_for_each_device(®ulator_class, NULL, s,
6096 regulator_summary_show_roots);
6098 regulator_summary_unlock(&ww_ctx);
6102 DEFINE_SHOW_ATTRIBUTE(regulator_summary);
6103 #endif /* CONFIG_DEBUG_FS */
6105 static int __init regulator_init(void)
6109 ret = class_register(®ulator_class);
6111 debugfs_root = debugfs_create_dir("regulator", NULL);
6113 pr_warn("regulator: Failed to create debugfs directory\n");
6115 #ifdef CONFIG_DEBUG_FS
6116 debugfs_create_file("supply_map", 0444, debugfs_root, NULL,
6119 debugfs_create_file("regulator_summary", 0444, debugfs_root,
6120 NULL, ®ulator_summary_fops);
6122 regulator_dummy_init();
6124 regulator_coupler_register(&generic_regulator_coupler);
6129 /* init early to allow our consumers to complete system booting */
6130 core_initcall(regulator_init);
6132 static int regulator_late_cleanup(struct device *dev, void *data)
6134 struct regulator_dev *rdev = dev_to_rdev(dev);
6135 struct regulation_constraints *c = rdev->constraints;
6138 if (c && c->always_on)
6141 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_STATUS))
6144 regulator_lock(rdev);
6146 if (rdev->use_count)
6149 /* If reading the status failed, assume that it's off. */
6150 if (_regulator_is_enabled(rdev) <= 0)
6153 if (have_full_constraints()) {
6154 /* We log since this may kill the system if it goes
6157 rdev_info(rdev, "disabling\n");
6158 ret = _regulator_do_disable(rdev);
6160 rdev_err(rdev, "couldn't disable: %pe\n", ERR_PTR(ret));
6162 /* The intention is that in future we will
6163 * assume that full constraints are provided
6164 * so warn even if we aren't going to do
6167 rdev_warn(rdev, "incomplete constraints, leaving on\n");
6171 regulator_unlock(rdev);
6176 static void regulator_init_complete_work_function(struct work_struct *work)
6179 * Regulators may had failed to resolve their input supplies
6180 * when were registered, either because the input supply was
6181 * not registered yet or because its parent device was not
6182 * bound yet. So attempt to resolve the input supplies for
6183 * pending regulators before trying to disable unused ones.
6185 class_for_each_device(®ulator_class, NULL, NULL,
6186 regulator_register_resolve_supply);
6188 /* If we have a full configuration then disable any regulators
6189 * we have permission to change the status for and which are
6190 * not in use or always_on. This is effectively the default
6191 * for DT and ACPI as they have full constraints.
6193 class_for_each_device(®ulator_class, NULL, NULL,
6194 regulator_late_cleanup);
6197 static DECLARE_DELAYED_WORK(regulator_init_complete_work,
6198 regulator_init_complete_work_function);
6200 static int __init regulator_init_complete(void)
6203 * Since DT doesn't provide an idiomatic mechanism for
6204 * enabling full constraints and since it's much more natural
6205 * with DT to provide them just assume that a DT enabled
6206 * system has full constraints.
6208 if (of_have_populated_dt())
6209 has_full_constraints = true;
6212 * We punt completion for an arbitrary amount of time since
6213 * systems like distros will load many drivers from userspace
6214 * so consumers might not always be ready yet, this is
6215 * particularly an issue with laptops where this might bounce
6216 * the display off then on. Ideally we'd get a notification
6217 * from userspace when this happens but we don't so just wait
6218 * a bit and hope we waited long enough. It'd be better if
6219 * we'd only do this on systems that need it, and a kernel
6220 * command line option might be useful.
6222 schedule_delayed_work(®ulator_init_complete_work,
6223 msecs_to_jiffies(30000));
6227 late_initcall_sync(regulator_init_complete);