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_current_limit(struct regulator_dev *rdev);
87 static unsigned int _regulator_get_mode(struct regulator_dev *rdev);
88 static int _notifier_call_chain(struct regulator_dev *rdev,
89 unsigned long event, void *data);
90 static int _regulator_do_set_voltage(struct regulator_dev *rdev,
91 int min_uV, int max_uV);
92 static int regulator_balance_voltage(struct regulator_dev *rdev,
93 suspend_state_t state);
94 static struct regulator *create_regulator(struct regulator_dev *rdev,
96 const char *supply_name);
97 static void destroy_regulator(struct regulator *regulator);
98 static void _regulator_put(struct regulator *regulator);
100 const char *rdev_get_name(struct regulator_dev *rdev)
102 if (rdev->constraints && rdev->constraints->name)
103 return rdev->constraints->name;
104 else if (rdev->desc->name)
105 return rdev->desc->name;
109 EXPORT_SYMBOL_GPL(rdev_get_name);
111 static bool have_full_constraints(void)
113 return has_full_constraints || of_have_populated_dt();
116 static bool regulator_ops_is_valid(struct regulator_dev *rdev, int ops)
118 if (!rdev->constraints) {
119 rdev_err(rdev, "no constraints\n");
123 if (rdev->constraints->valid_ops_mask & ops)
130 * regulator_lock_nested - lock a single regulator
131 * @rdev: regulator source
132 * @ww_ctx: w/w mutex acquire context
134 * This function can be called many times by one task on
135 * a single regulator and its mutex will be locked only
136 * once. If a task, which is calling this function is other
137 * than the one, which initially locked the mutex, it will
140 static inline int regulator_lock_nested(struct regulator_dev *rdev,
141 struct ww_acquire_ctx *ww_ctx)
146 mutex_lock(®ulator_nesting_mutex);
148 if (ww_ctx || !ww_mutex_trylock(&rdev->mutex)) {
149 if (rdev->mutex_owner == current)
155 mutex_unlock(®ulator_nesting_mutex);
156 ret = ww_mutex_lock(&rdev->mutex, ww_ctx);
157 mutex_lock(®ulator_nesting_mutex);
163 if (lock && ret != -EDEADLK) {
165 rdev->mutex_owner = current;
168 mutex_unlock(®ulator_nesting_mutex);
174 * regulator_lock - lock a single regulator
175 * @rdev: regulator source
177 * This function can be called many times by one task on
178 * a single regulator and its mutex will be locked only
179 * once. If a task, which is calling this function is other
180 * than the one, which initially locked the mutex, it will
183 static void regulator_lock(struct regulator_dev *rdev)
185 regulator_lock_nested(rdev, NULL);
189 * regulator_unlock - unlock a single regulator
190 * @rdev: regulator_source
192 * This function unlocks the mutex when the
193 * reference counter reaches 0.
195 static void regulator_unlock(struct regulator_dev *rdev)
197 mutex_lock(®ulator_nesting_mutex);
199 if (--rdev->ref_cnt == 0) {
200 rdev->mutex_owner = NULL;
201 ww_mutex_unlock(&rdev->mutex);
204 WARN_ON_ONCE(rdev->ref_cnt < 0);
206 mutex_unlock(®ulator_nesting_mutex);
209 static bool regulator_supply_is_couple(struct regulator_dev *rdev)
211 struct regulator_dev *c_rdev;
214 for (i = 1; i < rdev->coupling_desc.n_coupled; i++) {
215 c_rdev = rdev->coupling_desc.coupled_rdevs[i];
217 if (rdev->supply->rdev == c_rdev)
224 static void regulator_unlock_recursive(struct regulator_dev *rdev,
225 unsigned int n_coupled)
227 struct regulator_dev *c_rdev, *supply_rdev;
228 int i, supply_n_coupled;
230 for (i = n_coupled; i > 0; i--) {
231 c_rdev = rdev->coupling_desc.coupled_rdevs[i - 1];
236 if (c_rdev->supply && !regulator_supply_is_couple(c_rdev)) {
237 supply_rdev = c_rdev->supply->rdev;
238 supply_n_coupled = supply_rdev->coupling_desc.n_coupled;
240 regulator_unlock_recursive(supply_rdev,
244 regulator_unlock(c_rdev);
248 static int regulator_lock_recursive(struct regulator_dev *rdev,
249 struct regulator_dev **new_contended_rdev,
250 struct regulator_dev **old_contended_rdev,
251 struct ww_acquire_ctx *ww_ctx)
253 struct regulator_dev *c_rdev;
256 for (i = 0; i < rdev->coupling_desc.n_coupled; i++) {
257 c_rdev = rdev->coupling_desc.coupled_rdevs[i];
262 if (c_rdev != *old_contended_rdev) {
263 err = regulator_lock_nested(c_rdev, ww_ctx);
265 if (err == -EDEADLK) {
266 *new_contended_rdev = c_rdev;
270 /* shouldn't happen */
271 WARN_ON_ONCE(err != -EALREADY);
274 *old_contended_rdev = NULL;
277 if (c_rdev->supply && !regulator_supply_is_couple(c_rdev)) {
278 err = regulator_lock_recursive(c_rdev->supply->rdev,
283 regulator_unlock(c_rdev);
292 regulator_unlock_recursive(rdev, i);
298 * regulator_unlock_dependent - unlock regulator's suppliers and coupled
300 * @rdev: regulator source
301 * @ww_ctx: w/w mutex acquire context
303 * Unlock all regulators related with rdev by coupling or supplying.
305 static void regulator_unlock_dependent(struct regulator_dev *rdev,
306 struct ww_acquire_ctx *ww_ctx)
308 regulator_unlock_recursive(rdev, rdev->coupling_desc.n_coupled);
309 ww_acquire_fini(ww_ctx);
313 * regulator_lock_dependent - lock regulator's suppliers and coupled regulators
314 * @rdev: regulator source
315 * @ww_ctx: w/w mutex acquire context
317 * This function as a wrapper on regulator_lock_recursive(), which locks
318 * all regulators related with rdev by coupling or supplying.
320 static void regulator_lock_dependent(struct regulator_dev *rdev,
321 struct ww_acquire_ctx *ww_ctx)
323 struct regulator_dev *new_contended_rdev = NULL;
324 struct regulator_dev *old_contended_rdev = NULL;
327 mutex_lock(®ulator_list_mutex);
329 ww_acquire_init(ww_ctx, ®ulator_ww_class);
332 if (new_contended_rdev) {
333 ww_mutex_lock_slow(&new_contended_rdev->mutex, ww_ctx);
334 old_contended_rdev = new_contended_rdev;
335 old_contended_rdev->ref_cnt++;
338 err = regulator_lock_recursive(rdev,
343 if (old_contended_rdev)
344 regulator_unlock(old_contended_rdev);
346 } while (err == -EDEADLK);
348 ww_acquire_done(ww_ctx);
350 mutex_unlock(®ulator_list_mutex);
354 * of_get_child_regulator - get a child regulator device node
355 * based on supply name
356 * @parent: Parent device node
357 * @prop_name: Combination regulator supply name and "-supply"
359 * Traverse all child nodes.
360 * Extract the child regulator device node corresponding to the supply name.
361 * returns the device node corresponding to the regulator if found, else
364 static struct device_node *of_get_child_regulator(struct device_node *parent,
365 const char *prop_name)
367 struct device_node *regnode = NULL;
368 struct device_node *child = NULL;
370 for_each_child_of_node(parent, child) {
371 regnode = of_parse_phandle(child, prop_name, 0);
374 regnode = of_get_child_regulator(child, prop_name);
389 * of_get_regulator - get a regulator device node based on supply name
390 * @dev: Device pointer for the consumer (of regulator) device
391 * @supply: regulator supply name
393 * Extract the regulator device node corresponding to the supply name.
394 * returns the device node corresponding to the regulator if found, else
397 static struct device_node *of_get_regulator(struct device *dev, const char *supply)
399 struct device_node *regnode = NULL;
400 char prop_name[64]; /* 64 is max size of property name */
402 dev_dbg(dev, "Looking up %s-supply from device tree\n", supply);
404 snprintf(prop_name, 64, "%s-supply", supply);
405 regnode = of_parse_phandle(dev->of_node, prop_name, 0);
408 regnode = of_get_child_regulator(dev->of_node, prop_name);
412 dev_dbg(dev, "Looking up %s property in node %pOF failed\n",
413 prop_name, dev->of_node);
419 /* Platform voltage constraint check */
420 int regulator_check_voltage(struct regulator_dev *rdev,
421 int *min_uV, int *max_uV)
423 BUG_ON(*min_uV > *max_uV);
425 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE)) {
426 rdev_err(rdev, "voltage operation not allowed\n");
430 if (*max_uV > rdev->constraints->max_uV)
431 *max_uV = rdev->constraints->max_uV;
432 if (*min_uV < rdev->constraints->min_uV)
433 *min_uV = rdev->constraints->min_uV;
435 if (*min_uV > *max_uV) {
436 rdev_err(rdev, "unsupportable voltage range: %d-%duV\n",
444 /* return 0 if the state is valid */
445 static int regulator_check_states(suspend_state_t state)
447 return (state > PM_SUSPEND_MAX || state == PM_SUSPEND_TO_IDLE);
450 /* Make sure we select a voltage that suits the needs of all
451 * regulator consumers
453 int regulator_check_consumers(struct regulator_dev *rdev,
454 int *min_uV, int *max_uV,
455 suspend_state_t state)
457 struct regulator *regulator;
458 struct regulator_voltage *voltage;
460 list_for_each_entry(regulator, &rdev->consumer_list, list) {
461 voltage = ®ulator->voltage[state];
463 * Assume consumers that didn't say anything are OK
464 * with anything in the constraint range.
466 if (!voltage->min_uV && !voltage->max_uV)
469 if (*max_uV > voltage->max_uV)
470 *max_uV = voltage->max_uV;
471 if (*min_uV < voltage->min_uV)
472 *min_uV = voltage->min_uV;
475 if (*min_uV > *max_uV) {
476 rdev_err(rdev, "Restricting voltage, %u-%uuV\n",
484 /* current constraint check */
485 static int regulator_check_current_limit(struct regulator_dev *rdev,
486 int *min_uA, int *max_uA)
488 BUG_ON(*min_uA > *max_uA);
490 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_CURRENT)) {
491 rdev_err(rdev, "current operation not allowed\n");
495 if (*max_uA > rdev->constraints->max_uA)
496 *max_uA = rdev->constraints->max_uA;
497 if (*min_uA < rdev->constraints->min_uA)
498 *min_uA = rdev->constraints->min_uA;
500 if (*min_uA > *max_uA) {
501 rdev_err(rdev, "unsupportable current range: %d-%duA\n",
509 /* operating mode constraint check */
510 static int regulator_mode_constrain(struct regulator_dev *rdev,
514 case REGULATOR_MODE_FAST:
515 case REGULATOR_MODE_NORMAL:
516 case REGULATOR_MODE_IDLE:
517 case REGULATOR_MODE_STANDBY:
520 rdev_err(rdev, "invalid mode %x specified\n", *mode);
524 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_MODE)) {
525 rdev_err(rdev, "mode operation not allowed\n");
529 /* The modes are bitmasks, the most power hungry modes having
530 * the lowest values. If the requested mode isn't supported
534 if (rdev->constraints->valid_modes_mask & *mode)
542 static inline struct regulator_state *
543 regulator_get_suspend_state(struct regulator_dev *rdev, suspend_state_t state)
545 if (rdev->constraints == NULL)
549 case PM_SUSPEND_STANDBY:
550 return &rdev->constraints->state_standby;
552 return &rdev->constraints->state_mem;
554 return &rdev->constraints->state_disk;
560 static const struct regulator_state *
561 regulator_get_suspend_state_check(struct regulator_dev *rdev, suspend_state_t state)
563 const struct regulator_state *rstate;
565 rstate = regulator_get_suspend_state(rdev, state);
569 /* If we have no suspend mode configuration don't set anything;
570 * only warn if the driver implements set_suspend_voltage or
571 * set_suspend_mode callback.
573 if (rstate->enabled != ENABLE_IN_SUSPEND &&
574 rstate->enabled != DISABLE_IN_SUSPEND) {
575 if (rdev->desc->ops->set_suspend_voltage ||
576 rdev->desc->ops->set_suspend_mode)
577 rdev_warn(rdev, "No configuration\n");
584 static ssize_t microvolts_show(struct device *dev,
585 struct device_attribute *attr, char *buf)
587 struct regulator_dev *rdev = dev_get_drvdata(dev);
590 regulator_lock(rdev);
591 uV = regulator_get_voltage_rdev(rdev);
592 regulator_unlock(rdev);
596 return sprintf(buf, "%d\n", uV);
598 static DEVICE_ATTR_RO(microvolts);
600 static ssize_t microamps_show(struct device *dev,
601 struct device_attribute *attr, char *buf)
603 struct regulator_dev *rdev = dev_get_drvdata(dev);
605 return sprintf(buf, "%d\n", _regulator_get_current_limit(rdev));
607 static DEVICE_ATTR_RO(microamps);
609 static ssize_t name_show(struct device *dev, struct device_attribute *attr,
612 struct regulator_dev *rdev = dev_get_drvdata(dev);
614 return sprintf(buf, "%s\n", rdev_get_name(rdev));
616 static DEVICE_ATTR_RO(name);
618 static const char *regulator_opmode_to_str(int mode)
621 case REGULATOR_MODE_FAST:
623 case REGULATOR_MODE_NORMAL:
625 case REGULATOR_MODE_IDLE:
627 case REGULATOR_MODE_STANDBY:
633 static ssize_t regulator_print_opmode(char *buf, int mode)
635 return sprintf(buf, "%s\n", regulator_opmode_to_str(mode));
638 static ssize_t opmode_show(struct device *dev,
639 struct device_attribute *attr, char *buf)
641 struct regulator_dev *rdev = dev_get_drvdata(dev);
643 return regulator_print_opmode(buf, _regulator_get_mode(rdev));
645 static DEVICE_ATTR_RO(opmode);
647 static ssize_t regulator_print_state(char *buf, int state)
650 return sprintf(buf, "enabled\n");
652 return sprintf(buf, "disabled\n");
654 return sprintf(buf, "unknown\n");
657 static ssize_t state_show(struct device *dev,
658 struct device_attribute *attr, char *buf)
660 struct regulator_dev *rdev = dev_get_drvdata(dev);
663 regulator_lock(rdev);
664 ret = regulator_print_state(buf, _regulator_is_enabled(rdev));
665 regulator_unlock(rdev);
669 static DEVICE_ATTR_RO(state);
671 static ssize_t status_show(struct device *dev,
672 struct device_attribute *attr, char *buf)
674 struct regulator_dev *rdev = dev_get_drvdata(dev);
678 status = rdev->desc->ops->get_status(rdev);
683 case REGULATOR_STATUS_OFF:
686 case REGULATOR_STATUS_ON:
689 case REGULATOR_STATUS_ERROR:
692 case REGULATOR_STATUS_FAST:
695 case REGULATOR_STATUS_NORMAL:
698 case REGULATOR_STATUS_IDLE:
701 case REGULATOR_STATUS_STANDBY:
704 case REGULATOR_STATUS_BYPASS:
707 case REGULATOR_STATUS_UNDEFINED:
714 return sprintf(buf, "%s\n", label);
716 static DEVICE_ATTR_RO(status);
718 static ssize_t min_microamps_show(struct device *dev,
719 struct device_attribute *attr, char *buf)
721 struct regulator_dev *rdev = dev_get_drvdata(dev);
723 if (!rdev->constraints)
724 return sprintf(buf, "constraint not defined\n");
726 return sprintf(buf, "%d\n", rdev->constraints->min_uA);
728 static DEVICE_ATTR_RO(min_microamps);
730 static ssize_t max_microamps_show(struct device *dev,
731 struct device_attribute *attr, char *buf)
733 struct regulator_dev *rdev = dev_get_drvdata(dev);
735 if (!rdev->constraints)
736 return sprintf(buf, "constraint not defined\n");
738 return sprintf(buf, "%d\n", rdev->constraints->max_uA);
740 static DEVICE_ATTR_RO(max_microamps);
742 static ssize_t min_microvolts_show(struct device *dev,
743 struct device_attribute *attr, char *buf)
745 struct regulator_dev *rdev = dev_get_drvdata(dev);
747 if (!rdev->constraints)
748 return sprintf(buf, "constraint not defined\n");
750 return sprintf(buf, "%d\n", rdev->constraints->min_uV);
752 static DEVICE_ATTR_RO(min_microvolts);
754 static ssize_t max_microvolts_show(struct device *dev,
755 struct device_attribute *attr, char *buf)
757 struct regulator_dev *rdev = dev_get_drvdata(dev);
759 if (!rdev->constraints)
760 return sprintf(buf, "constraint not defined\n");
762 return sprintf(buf, "%d\n", rdev->constraints->max_uV);
764 static DEVICE_ATTR_RO(max_microvolts);
766 static ssize_t requested_microamps_show(struct device *dev,
767 struct device_attribute *attr, char *buf)
769 struct regulator_dev *rdev = dev_get_drvdata(dev);
770 struct regulator *regulator;
773 regulator_lock(rdev);
774 list_for_each_entry(regulator, &rdev->consumer_list, list) {
775 if (regulator->enable_count)
776 uA += regulator->uA_load;
778 regulator_unlock(rdev);
779 return sprintf(buf, "%d\n", uA);
781 static DEVICE_ATTR_RO(requested_microamps);
783 static ssize_t num_users_show(struct device *dev, struct device_attribute *attr,
786 struct regulator_dev *rdev = dev_get_drvdata(dev);
787 return sprintf(buf, "%d\n", rdev->use_count);
789 static DEVICE_ATTR_RO(num_users);
791 static ssize_t type_show(struct device *dev, struct device_attribute *attr,
794 struct regulator_dev *rdev = dev_get_drvdata(dev);
796 switch (rdev->desc->type) {
797 case REGULATOR_VOLTAGE:
798 return sprintf(buf, "voltage\n");
799 case REGULATOR_CURRENT:
800 return sprintf(buf, "current\n");
802 return sprintf(buf, "unknown\n");
804 static DEVICE_ATTR_RO(type);
806 static ssize_t suspend_mem_microvolts_show(struct device *dev,
807 struct device_attribute *attr, char *buf)
809 struct regulator_dev *rdev = dev_get_drvdata(dev);
811 return sprintf(buf, "%d\n", rdev->constraints->state_mem.uV);
813 static DEVICE_ATTR_RO(suspend_mem_microvolts);
815 static ssize_t suspend_disk_microvolts_show(struct device *dev,
816 struct device_attribute *attr, char *buf)
818 struct regulator_dev *rdev = dev_get_drvdata(dev);
820 return sprintf(buf, "%d\n", rdev->constraints->state_disk.uV);
822 static DEVICE_ATTR_RO(suspend_disk_microvolts);
824 static ssize_t suspend_standby_microvolts_show(struct device *dev,
825 struct device_attribute *attr, char *buf)
827 struct regulator_dev *rdev = dev_get_drvdata(dev);
829 return sprintf(buf, "%d\n", rdev->constraints->state_standby.uV);
831 static DEVICE_ATTR_RO(suspend_standby_microvolts);
833 static ssize_t suspend_mem_mode_show(struct device *dev,
834 struct device_attribute *attr, char *buf)
836 struct regulator_dev *rdev = dev_get_drvdata(dev);
838 return regulator_print_opmode(buf,
839 rdev->constraints->state_mem.mode);
841 static DEVICE_ATTR_RO(suspend_mem_mode);
843 static ssize_t suspend_disk_mode_show(struct device *dev,
844 struct device_attribute *attr, char *buf)
846 struct regulator_dev *rdev = dev_get_drvdata(dev);
848 return regulator_print_opmode(buf,
849 rdev->constraints->state_disk.mode);
851 static DEVICE_ATTR_RO(suspend_disk_mode);
853 static ssize_t suspend_standby_mode_show(struct device *dev,
854 struct device_attribute *attr, char *buf)
856 struct regulator_dev *rdev = dev_get_drvdata(dev);
858 return regulator_print_opmode(buf,
859 rdev->constraints->state_standby.mode);
861 static DEVICE_ATTR_RO(suspend_standby_mode);
863 static ssize_t suspend_mem_state_show(struct device *dev,
864 struct device_attribute *attr, char *buf)
866 struct regulator_dev *rdev = dev_get_drvdata(dev);
868 return regulator_print_state(buf,
869 rdev->constraints->state_mem.enabled);
871 static DEVICE_ATTR_RO(suspend_mem_state);
873 static ssize_t suspend_disk_state_show(struct device *dev,
874 struct device_attribute *attr, char *buf)
876 struct regulator_dev *rdev = dev_get_drvdata(dev);
878 return regulator_print_state(buf,
879 rdev->constraints->state_disk.enabled);
881 static DEVICE_ATTR_RO(suspend_disk_state);
883 static ssize_t suspend_standby_state_show(struct device *dev,
884 struct device_attribute *attr, char *buf)
886 struct regulator_dev *rdev = dev_get_drvdata(dev);
888 return regulator_print_state(buf,
889 rdev->constraints->state_standby.enabled);
891 static DEVICE_ATTR_RO(suspend_standby_state);
893 static ssize_t bypass_show(struct device *dev,
894 struct device_attribute *attr, char *buf)
896 struct regulator_dev *rdev = dev_get_drvdata(dev);
901 ret = rdev->desc->ops->get_bypass(rdev, &bypass);
910 return sprintf(buf, "%s\n", report);
912 static DEVICE_ATTR_RO(bypass);
914 /* Calculate the new optimum regulator operating mode based on the new total
915 * consumer load. All locks held by caller
917 static int drms_uA_update(struct regulator_dev *rdev)
919 struct regulator *sibling;
920 int current_uA = 0, output_uV, input_uV, err;
924 * first check to see if we can set modes at all, otherwise just
925 * tell the consumer everything is OK.
927 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_DRMS)) {
928 rdev_dbg(rdev, "DRMS operation not allowed\n");
932 if (!rdev->desc->ops->get_optimum_mode &&
933 !rdev->desc->ops->set_load)
936 if (!rdev->desc->ops->set_mode &&
937 !rdev->desc->ops->set_load)
940 /* calc total requested load */
941 list_for_each_entry(sibling, &rdev->consumer_list, list) {
942 if (sibling->enable_count)
943 current_uA += sibling->uA_load;
946 current_uA += rdev->constraints->system_load;
948 if (rdev->desc->ops->set_load) {
949 /* set the optimum mode for our new total regulator load */
950 err = rdev->desc->ops->set_load(rdev, current_uA);
952 rdev_err(rdev, "failed to set load %d: %pe\n",
953 current_uA, ERR_PTR(err));
955 /* get output voltage */
956 output_uV = regulator_get_voltage_rdev(rdev);
957 if (output_uV <= 0) {
958 rdev_err(rdev, "invalid output voltage found\n");
962 /* get input voltage */
965 input_uV = regulator_get_voltage(rdev->supply);
967 input_uV = rdev->constraints->input_uV;
969 rdev_err(rdev, "invalid input voltage found\n");
973 /* now get the optimum mode for our new total regulator load */
974 mode = rdev->desc->ops->get_optimum_mode(rdev, input_uV,
975 output_uV, current_uA);
977 /* check the new mode is allowed */
978 err = regulator_mode_constrain(rdev, &mode);
980 rdev_err(rdev, "failed to get optimum mode @ %d uA %d -> %d uV: %pe\n",
981 current_uA, input_uV, output_uV, ERR_PTR(err));
985 err = rdev->desc->ops->set_mode(rdev, mode);
987 rdev_err(rdev, "failed to set optimum mode %x: %pe\n",
994 static int __suspend_set_state(struct regulator_dev *rdev,
995 const struct regulator_state *rstate)
999 if (rstate->enabled == ENABLE_IN_SUSPEND &&
1000 rdev->desc->ops->set_suspend_enable)
1001 ret = rdev->desc->ops->set_suspend_enable(rdev);
1002 else if (rstate->enabled == DISABLE_IN_SUSPEND &&
1003 rdev->desc->ops->set_suspend_disable)
1004 ret = rdev->desc->ops->set_suspend_disable(rdev);
1005 else /* OK if set_suspend_enable or set_suspend_disable is NULL */
1009 rdev_err(rdev, "failed to enabled/disable: %pe\n", ERR_PTR(ret));
1013 if (rdev->desc->ops->set_suspend_voltage && rstate->uV > 0) {
1014 ret = rdev->desc->ops->set_suspend_voltage(rdev, rstate->uV);
1016 rdev_err(rdev, "failed to set voltage: %pe\n", ERR_PTR(ret));
1021 if (rdev->desc->ops->set_suspend_mode && rstate->mode > 0) {
1022 ret = rdev->desc->ops->set_suspend_mode(rdev, rstate->mode);
1024 rdev_err(rdev, "failed to set mode: %pe\n", ERR_PTR(ret));
1032 static int suspend_set_initial_state(struct regulator_dev *rdev)
1034 const struct regulator_state *rstate;
1036 rstate = regulator_get_suspend_state_check(rdev,
1037 rdev->constraints->initial_state);
1041 return __suspend_set_state(rdev, rstate);
1044 #if defined(DEBUG) || defined(CONFIG_DYNAMIC_DEBUG)
1045 static void print_constraints_debug(struct regulator_dev *rdev)
1047 struct regulation_constraints *constraints = rdev->constraints;
1049 size_t len = sizeof(buf) - 1;
1053 if (constraints->min_uV && constraints->max_uV) {
1054 if (constraints->min_uV == constraints->max_uV)
1055 count += scnprintf(buf + count, len - count, "%d mV ",
1056 constraints->min_uV / 1000);
1058 count += scnprintf(buf + count, len - count,
1060 constraints->min_uV / 1000,
1061 constraints->max_uV / 1000);
1064 if (!constraints->min_uV ||
1065 constraints->min_uV != constraints->max_uV) {
1066 ret = regulator_get_voltage_rdev(rdev);
1068 count += scnprintf(buf + count, len - count,
1069 "at %d mV ", ret / 1000);
1072 if (constraints->uV_offset)
1073 count += scnprintf(buf + count, len - count, "%dmV offset ",
1074 constraints->uV_offset / 1000);
1076 if (constraints->min_uA && constraints->max_uA) {
1077 if (constraints->min_uA == constraints->max_uA)
1078 count += scnprintf(buf + count, len - count, "%d mA ",
1079 constraints->min_uA / 1000);
1081 count += scnprintf(buf + count, len - count,
1083 constraints->min_uA / 1000,
1084 constraints->max_uA / 1000);
1087 if (!constraints->min_uA ||
1088 constraints->min_uA != constraints->max_uA) {
1089 ret = _regulator_get_current_limit(rdev);
1091 count += scnprintf(buf + count, len - count,
1092 "at %d mA ", ret / 1000);
1095 if (constraints->valid_modes_mask & REGULATOR_MODE_FAST)
1096 count += scnprintf(buf + count, len - count, "fast ");
1097 if (constraints->valid_modes_mask & REGULATOR_MODE_NORMAL)
1098 count += scnprintf(buf + count, len - count, "normal ");
1099 if (constraints->valid_modes_mask & REGULATOR_MODE_IDLE)
1100 count += scnprintf(buf + count, len - count, "idle ");
1101 if (constraints->valid_modes_mask & REGULATOR_MODE_STANDBY)
1102 count += scnprintf(buf + count, len - count, "standby ");
1105 count = scnprintf(buf, len, "no parameters");
1109 count += scnprintf(buf + count, len - count, ", %s",
1110 _regulator_is_enabled(rdev) ? "enabled" : "disabled");
1112 rdev_dbg(rdev, "%s\n", buf);
1114 #else /* !DEBUG && !CONFIG_DYNAMIC_DEBUG */
1115 static inline void print_constraints_debug(struct regulator_dev *rdev) {}
1116 #endif /* !DEBUG && !CONFIG_DYNAMIC_DEBUG */
1118 static void print_constraints(struct regulator_dev *rdev)
1120 struct regulation_constraints *constraints = rdev->constraints;
1122 print_constraints_debug(rdev);
1124 if ((constraints->min_uV != constraints->max_uV) &&
1125 !regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE))
1127 "Voltage range but no REGULATOR_CHANGE_VOLTAGE\n");
1130 static int machine_constraints_voltage(struct regulator_dev *rdev,
1131 struct regulation_constraints *constraints)
1133 const struct regulator_ops *ops = rdev->desc->ops;
1136 /* do we need to apply the constraint voltage */
1137 if (rdev->constraints->apply_uV &&
1138 rdev->constraints->min_uV && rdev->constraints->max_uV) {
1139 int target_min, target_max;
1140 int current_uV = regulator_get_voltage_rdev(rdev);
1142 if (current_uV == -ENOTRECOVERABLE) {
1143 /* This regulator can't be read and must be initialized */
1144 rdev_info(rdev, "Setting %d-%duV\n",
1145 rdev->constraints->min_uV,
1146 rdev->constraints->max_uV);
1147 _regulator_do_set_voltage(rdev,
1148 rdev->constraints->min_uV,
1149 rdev->constraints->max_uV);
1150 current_uV = regulator_get_voltage_rdev(rdev);
1153 if (current_uV < 0) {
1155 "failed to get the current voltage: %pe\n",
1156 ERR_PTR(current_uV));
1161 * If we're below the minimum voltage move up to the
1162 * minimum voltage, if we're above the maximum voltage
1163 * then move down to the maximum.
1165 target_min = current_uV;
1166 target_max = current_uV;
1168 if (current_uV < rdev->constraints->min_uV) {
1169 target_min = rdev->constraints->min_uV;
1170 target_max = rdev->constraints->min_uV;
1173 if (current_uV > rdev->constraints->max_uV) {
1174 target_min = rdev->constraints->max_uV;
1175 target_max = rdev->constraints->max_uV;
1178 if (target_min != current_uV || target_max != current_uV) {
1179 rdev_info(rdev, "Bringing %duV into %d-%duV\n",
1180 current_uV, target_min, target_max);
1181 ret = _regulator_do_set_voltage(
1182 rdev, target_min, target_max);
1185 "failed to apply %d-%duV constraint: %pe\n",
1186 target_min, target_max, ERR_PTR(ret));
1192 /* constrain machine-level voltage specs to fit
1193 * the actual range supported by this regulator.
1195 if (ops->list_voltage && rdev->desc->n_voltages) {
1196 int count = rdev->desc->n_voltages;
1198 int min_uV = INT_MAX;
1199 int max_uV = INT_MIN;
1200 int cmin = constraints->min_uV;
1201 int cmax = constraints->max_uV;
1203 /* it's safe to autoconfigure fixed-voltage supplies
1204 * and the constraints are used by list_voltage.
1206 if (count == 1 && !cmin) {
1209 constraints->min_uV = cmin;
1210 constraints->max_uV = cmax;
1213 /* voltage constraints are optional */
1214 if ((cmin == 0) && (cmax == 0))
1217 /* else require explicit machine-level constraints */
1218 if (cmin <= 0 || cmax <= 0 || cmax < cmin) {
1219 rdev_err(rdev, "invalid voltage constraints\n");
1223 /* no need to loop voltages if range is continuous */
1224 if (rdev->desc->continuous_voltage_range)
1227 /* initial: [cmin..cmax] valid, [min_uV..max_uV] not */
1228 for (i = 0; i < count; i++) {
1231 value = ops->list_voltage(rdev, i);
1235 /* maybe adjust [min_uV..max_uV] */
1236 if (value >= cmin && value < min_uV)
1238 if (value <= cmax && value > max_uV)
1242 /* final: [min_uV..max_uV] valid iff constraints valid */
1243 if (max_uV < min_uV) {
1245 "unsupportable voltage constraints %u-%uuV\n",
1250 /* use regulator's subset of machine constraints */
1251 if (constraints->min_uV < min_uV) {
1252 rdev_dbg(rdev, "override min_uV, %d -> %d\n",
1253 constraints->min_uV, min_uV);
1254 constraints->min_uV = min_uV;
1256 if (constraints->max_uV > max_uV) {
1257 rdev_dbg(rdev, "override max_uV, %d -> %d\n",
1258 constraints->max_uV, max_uV);
1259 constraints->max_uV = max_uV;
1266 static int machine_constraints_current(struct regulator_dev *rdev,
1267 struct regulation_constraints *constraints)
1269 const struct regulator_ops *ops = rdev->desc->ops;
1272 if (!constraints->min_uA && !constraints->max_uA)
1275 if (constraints->min_uA > constraints->max_uA) {
1276 rdev_err(rdev, "Invalid current constraints\n");
1280 if (!ops->set_current_limit || !ops->get_current_limit) {
1281 rdev_warn(rdev, "Operation of current configuration missing\n");
1285 /* Set regulator current in constraints range */
1286 ret = ops->set_current_limit(rdev, constraints->min_uA,
1287 constraints->max_uA);
1289 rdev_err(rdev, "Failed to set current constraint, %d\n", ret);
1296 static int _regulator_do_enable(struct regulator_dev *rdev);
1298 static int notif_set_limit(struct regulator_dev *rdev,
1299 int (*set)(struct regulator_dev *, int, int, bool),
1300 int limit, int severity)
1304 if (limit == REGULATOR_NOTIF_LIMIT_DISABLE) {
1311 if (limit == REGULATOR_NOTIF_LIMIT_ENABLE)
1314 return set(rdev, limit, severity, enable);
1317 static int handle_notify_limits(struct regulator_dev *rdev,
1318 int (*set)(struct regulator_dev *, int, int, bool),
1319 struct notification_limit *limits)
1327 ret = notif_set_limit(rdev, set, limits->prot,
1328 REGULATOR_SEVERITY_PROT);
1333 ret = notif_set_limit(rdev, set, limits->err,
1334 REGULATOR_SEVERITY_ERR);
1339 ret = notif_set_limit(rdev, set, limits->warn,
1340 REGULATOR_SEVERITY_WARN);
1345 * set_machine_constraints - sets regulator constraints
1346 * @rdev: regulator source
1348 * Allows platform initialisation code to define and constrain
1349 * regulator circuits e.g. valid voltage/current ranges, etc. NOTE:
1350 * Constraints *must* be set by platform code in order for some
1351 * regulator operations to proceed i.e. set_voltage, set_current_limit,
1354 static int set_machine_constraints(struct regulator_dev *rdev)
1357 const struct regulator_ops *ops = rdev->desc->ops;
1359 ret = machine_constraints_voltage(rdev, rdev->constraints);
1363 ret = machine_constraints_current(rdev, rdev->constraints);
1367 if (rdev->constraints->ilim_uA && ops->set_input_current_limit) {
1368 ret = ops->set_input_current_limit(rdev,
1369 rdev->constraints->ilim_uA);
1371 rdev_err(rdev, "failed to set input limit: %pe\n", ERR_PTR(ret));
1376 /* do we need to setup our suspend state */
1377 if (rdev->constraints->initial_state) {
1378 ret = suspend_set_initial_state(rdev);
1380 rdev_err(rdev, "failed to set suspend state: %pe\n", ERR_PTR(ret));
1385 if (rdev->constraints->initial_mode) {
1386 if (!ops->set_mode) {
1387 rdev_err(rdev, "no set_mode operation\n");
1391 ret = ops->set_mode(rdev, rdev->constraints->initial_mode);
1393 rdev_err(rdev, "failed to set initial mode: %pe\n", ERR_PTR(ret));
1396 } else if (rdev->constraints->system_load) {
1398 * We'll only apply the initial system load if an
1399 * initial mode wasn't specified.
1401 drms_uA_update(rdev);
1404 if ((rdev->constraints->ramp_delay || rdev->constraints->ramp_disable)
1405 && ops->set_ramp_delay) {
1406 ret = ops->set_ramp_delay(rdev, rdev->constraints->ramp_delay);
1408 rdev_err(rdev, "failed to set ramp_delay: %pe\n", ERR_PTR(ret));
1413 if (rdev->constraints->pull_down && ops->set_pull_down) {
1414 ret = ops->set_pull_down(rdev);
1416 rdev_err(rdev, "failed to set pull down: %pe\n", ERR_PTR(ret));
1421 if (rdev->constraints->soft_start && ops->set_soft_start) {
1422 ret = ops->set_soft_start(rdev);
1424 rdev_err(rdev, "failed to set soft start: %pe\n", ERR_PTR(ret));
1430 * Existing logic does not warn if over_current_protection is given as
1431 * a constraint but driver does not support that. I think we should
1432 * warn about this type of issues as it is possible someone changes
1433 * PMIC on board to another type - and the another PMIC's driver does
1434 * not support setting protection. Board composer may happily believe
1435 * the DT limits are respected - especially if the new PMIC HW also
1436 * supports protection but the driver does not. I won't change the logic
1437 * without hearing more experienced opinion on this though.
1439 * If warning is seen as a good idea then we can merge handling the
1440 * over-curret protection and detection and get rid of this special
1443 if (rdev->constraints->over_current_protection
1444 && ops->set_over_current_protection) {
1445 int lim = rdev->constraints->over_curr_limits.prot;
1447 ret = ops->set_over_current_protection(rdev, lim,
1448 REGULATOR_SEVERITY_PROT,
1451 rdev_err(rdev, "failed to set over current protection: %pe\n",
1457 if (rdev->constraints->over_current_detection)
1458 ret = handle_notify_limits(rdev,
1459 ops->set_over_current_protection,
1460 &rdev->constraints->over_curr_limits);
1462 if (ret != -EOPNOTSUPP) {
1463 rdev_err(rdev, "failed to set over current limits: %pe\n",
1468 "IC does not support requested over-current limits\n");
1471 if (rdev->constraints->over_voltage_detection)
1472 ret = handle_notify_limits(rdev,
1473 ops->set_over_voltage_protection,
1474 &rdev->constraints->over_voltage_limits);
1476 if (ret != -EOPNOTSUPP) {
1477 rdev_err(rdev, "failed to set over voltage limits %pe\n",
1482 "IC does not support requested over voltage limits\n");
1485 if (rdev->constraints->under_voltage_detection)
1486 ret = handle_notify_limits(rdev,
1487 ops->set_under_voltage_protection,
1488 &rdev->constraints->under_voltage_limits);
1490 if (ret != -EOPNOTSUPP) {
1491 rdev_err(rdev, "failed to set under voltage limits %pe\n",
1496 "IC does not support requested under voltage limits\n");
1499 if (rdev->constraints->over_temp_detection)
1500 ret = handle_notify_limits(rdev,
1501 ops->set_thermal_protection,
1502 &rdev->constraints->temp_limits);
1504 if (ret != -EOPNOTSUPP) {
1505 rdev_err(rdev, "failed to set temperature limits %pe\n",
1510 "IC does not support requested temperature limits\n");
1513 if (rdev->constraints->active_discharge && ops->set_active_discharge) {
1514 bool ad_state = (rdev->constraints->active_discharge ==
1515 REGULATOR_ACTIVE_DISCHARGE_ENABLE) ? true : false;
1517 ret = ops->set_active_discharge(rdev, ad_state);
1519 rdev_err(rdev, "failed to set active discharge: %pe\n", ERR_PTR(ret));
1524 /* If the constraints say the regulator should be on at this point
1525 * and we have control then make sure it is enabled.
1527 if (rdev->constraints->always_on || rdev->constraints->boot_on) {
1528 /* If we want to enable this regulator, make sure that we know
1529 * the supplying regulator.
1531 if (rdev->supply_name && !rdev->supply)
1532 return -EPROBE_DEFER;
1535 ret = regulator_enable(rdev->supply);
1537 _regulator_put(rdev->supply);
1538 rdev->supply = NULL;
1543 ret = _regulator_do_enable(rdev);
1544 if (ret < 0 && ret != -EINVAL) {
1545 rdev_err(rdev, "failed to enable: %pe\n", ERR_PTR(ret));
1549 if (rdev->constraints->always_on)
1551 } else if (rdev->desc->off_on_delay) {
1552 rdev->last_off = ktime_get();
1555 print_constraints(rdev);
1560 * set_supply - set regulator supply regulator
1561 * @rdev: regulator name
1562 * @supply_rdev: supply regulator name
1564 * Called by platform initialisation code to set the supply regulator for this
1565 * regulator. This ensures that a regulators supply will also be enabled by the
1566 * core if it's child is enabled.
1568 static int set_supply(struct regulator_dev *rdev,
1569 struct regulator_dev *supply_rdev)
1573 rdev_info(rdev, "supplied by %s\n", rdev_get_name(supply_rdev));
1575 if (!try_module_get(supply_rdev->owner))
1578 rdev->supply = create_regulator(supply_rdev, &rdev->dev, "SUPPLY");
1579 if (rdev->supply == NULL) {
1583 supply_rdev->open_count++;
1589 * set_consumer_device_supply - Bind a regulator to a symbolic supply
1590 * @rdev: regulator source
1591 * @consumer_dev_name: dev_name() string for device supply applies to
1592 * @supply: symbolic name for supply
1594 * Allows platform initialisation code to map physical regulator
1595 * sources to symbolic names for supplies for use by devices. Devices
1596 * should use these symbolic names to request regulators, avoiding the
1597 * need to provide board-specific regulator names as platform data.
1599 static int set_consumer_device_supply(struct regulator_dev *rdev,
1600 const char *consumer_dev_name,
1603 struct regulator_map *node, *new_node;
1609 if (consumer_dev_name != NULL)
1614 new_node = kzalloc(sizeof(struct regulator_map), GFP_KERNEL);
1615 if (new_node == NULL)
1618 new_node->regulator = rdev;
1619 new_node->supply = supply;
1622 new_node->dev_name = kstrdup(consumer_dev_name, GFP_KERNEL);
1623 if (new_node->dev_name == NULL) {
1629 mutex_lock(®ulator_list_mutex);
1630 list_for_each_entry(node, ®ulator_map_list, list) {
1631 if (node->dev_name && consumer_dev_name) {
1632 if (strcmp(node->dev_name, consumer_dev_name) != 0)
1634 } else if (node->dev_name || consumer_dev_name) {
1638 if (strcmp(node->supply, supply) != 0)
1641 pr_debug("%s: %s/%s is '%s' supply; fail %s/%s\n",
1643 dev_name(&node->regulator->dev),
1644 node->regulator->desc->name,
1646 dev_name(&rdev->dev), rdev_get_name(rdev));
1650 list_add(&new_node->list, ®ulator_map_list);
1651 mutex_unlock(®ulator_list_mutex);
1656 mutex_unlock(®ulator_list_mutex);
1657 kfree(new_node->dev_name);
1662 static void unset_regulator_supplies(struct regulator_dev *rdev)
1664 struct regulator_map *node, *n;
1666 list_for_each_entry_safe(node, n, ®ulator_map_list, list) {
1667 if (rdev == node->regulator) {
1668 list_del(&node->list);
1669 kfree(node->dev_name);
1675 #ifdef CONFIG_DEBUG_FS
1676 static ssize_t constraint_flags_read_file(struct file *file,
1677 char __user *user_buf,
1678 size_t count, loff_t *ppos)
1680 const struct regulator *regulator = file->private_data;
1681 const struct regulation_constraints *c = regulator->rdev->constraints;
1688 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
1692 ret = snprintf(buf, PAGE_SIZE,
1696 "ramp_disable: %u\n"
1699 "over_current_protection: %u\n",
1706 c->over_current_protection);
1708 ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
1716 static const struct file_operations constraint_flags_fops = {
1717 #ifdef CONFIG_DEBUG_FS
1718 .open = simple_open,
1719 .read = constraint_flags_read_file,
1720 .llseek = default_llseek,
1724 #define REG_STR_SIZE 64
1726 static struct regulator *create_regulator(struct regulator_dev *rdev,
1728 const char *supply_name)
1730 struct regulator *regulator;
1734 char buf[REG_STR_SIZE];
1737 size = snprintf(buf, REG_STR_SIZE, "%s-%s",
1738 dev->kobj.name, supply_name);
1739 if (size >= REG_STR_SIZE)
1742 supply_name = kstrdup(buf, GFP_KERNEL);
1743 if (supply_name == NULL)
1746 supply_name = kstrdup_const(supply_name, GFP_KERNEL);
1747 if (supply_name == NULL)
1751 regulator = kzalloc(sizeof(*regulator), GFP_KERNEL);
1752 if (regulator == NULL) {
1757 regulator->rdev = rdev;
1758 regulator->supply_name = supply_name;
1760 regulator_lock(rdev);
1761 list_add(®ulator->list, &rdev->consumer_list);
1762 regulator_unlock(rdev);
1765 regulator->dev = dev;
1767 /* Add a link to the device sysfs entry */
1768 err = sysfs_create_link_nowarn(&rdev->dev.kobj, &dev->kobj,
1771 rdev_dbg(rdev, "could not add device link %s: %pe\n",
1772 dev->kobj.name, ERR_PTR(err));
1778 regulator->debugfs = debugfs_create_dir(supply_name, rdev->debugfs);
1779 if (!regulator->debugfs) {
1780 rdev_dbg(rdev, "Failed to create debugfs directory\n");
1782 debugfs_create_u32("uA_load", 0444, regulator->debugfs,
1783 ®ulator->uA_load);
1784 debugfs_create_u32("min_uV", 0444, regulator->debugfs,
1785 ®ulator->voltage[PM_SUSPEND_ON].min_uV);
1786 debugfs_create_u32("max_uV", 0444, regulator->debugfs,
1787 ®ulator->voltage[PM_SUSPEND_ON].max_uV);
1788 debugfs_create_file("constraint_flags", 0444,
1789 regulator->debugfs, regulator,
1790 &constraint_flags_fops);
1794 * Check now if the regulator is an always on regulator - if
1795 * it is then we don't need to do nearly so much work for
1796 * enable/disable calls.
1798 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_STATUS) &&
1799 _regulator_is_enabled(rdev))
1800 regulator->always_on = true;
1805 static int _regulator_get_enable_time(struct regulator_dev *rdev)
1807 if (rdev->constraints && rdev->constraints->enable_time)
1808 return rdev->constraints->enable_time;
1809 if (rdev->desc->ops->enable_time)
1810 return rdev->desc->ops->enable_time(rdev);
1811 return rdev->desc->enable_time;
1814 static struct regulator_supply_alias *regulator_find_supply_alias(
1815 struct device *dev, const char *supply)
1817 struct regulator_supply_alias *map;
1819 list_for_each_entry(map, ®ulator_supply_alias_list, list)
1820 if (map->src_dev == dev && strcmp(map->src_supply, supply) == 0)
1826 static void regulator_supply_alias(struct device **dev, const char **supply)
1828 struct regulator_supply_alias *map;
1830 map = regulator_find_supply_alias(*dev, *supply);
1832 dev_dbg(*dev, "Mapping supply %s to %s,%s\n",
1833 *supply, map->alias_supply,
1834 dev_name(map->alias_dev));
1835 *dev = map->alias_dev;
1836 *supply = map->alias_supply;
1840 static int regulator_match(struct device *dev, const void *data)
1842 struct regulator_dev *r = dev_to_rdev(dev);
1844 return strcmp(rdev_get_name(r), data) == 0;
1847 static struct regulator_dev *regulator_lookup_by_name(const char *name)
1851 dev = class_find_device(®ulator_class, NULL, name, regulator_match);
1853 return dev ? dev_to_rdev(dev) : NULL;
1857 * regulator_dev_lookup - lookup a regulator device.
1858 * @dev: device for regulator "consumer".
1859 * @supply: Supply name or regulator ID.
1861 * If successful, returns a struct regulator_dev that corresponds to the name
1862 * @supply and with the embedded struct device refcount incremented by one.
1863 * The refcount must be dropped by calling put_device().
1864 * On failure one of the following ERR-PTR-encoded values is returned:
1865 * -ENODEV if lookup fails permanently, -EPROBE_DEFER if lookup could succeed
1868 static struct regulator_dev *regulator_dev_lookup(struct device *dev,
1871 struct regulator_dev *r = NULL;
1872 struct device_node *node;
1873 struct regulator_map *map;
1874 const char *devname = NULL;
1876 regulator_supply_alias(&dev, &supply);
1878 /* first do a dt based lookup */
1879 if (dev && dev->of_node) {
1880 node = of_get_regulator(dev, supply);
1882 r = of_find_regulator_by_node(node);
1887 * We have a node, but there is no device.
1888 * assume it has not registered yet.
1890 return ERR_PTR(-EPROBE_DEFER);
1894 /* if not found, try doing it non-dt way */
1896 devname = dev_name(dev);
1898 mutex_lock(®ulator_list_mutex);
1899 list_for_each_entry(map, ®ulator_map_list, list) {
1900 /* If the mapping has a device set up it must match */
1901 if (map->dev_name &&
1902 (!devname || strcmp(map->dev_name, devname)))
1905 if (strcmp(map->supply, supply) == 0 &&
1906 get_device(&map->regulator->dev)) {
1911 mutex_unlock(®ulator_list_mutex);
1916 r = regulator_lookup_by_name(supply);
1920 return ERR_PTR(-ENODEV);
1923 static int regulator_resolve_supply(struct regulator_dev *rdev)
1925 struct regulator_dev *r;
1926 struct device *dev = rdev->dev.parent;
1929 /* No supply to resolve? */
1930 if (!rdev->supply_name)
1933 /* Supply already resolved? (fast-path without locking contention) */
1937 r = regulator_dev_lookup(dev, rdev->supply_name);
1941 /* Did the lookup explicitly defer for us? */
1942 if (ret == -EPROBE_DEFER)
1945 if (have_full_constraints()) {
1946 r = dummy_regulator_rdev;
1947 get_device(&r->dev);
1949 dev_err(dev, "Failed to resolve %s-supply for %s\n",
1950 rdev->supply_name, rdev->desc->name);
1951 ret = -EPROBE_DEFER;
1957 dev_err(dev, "Supply for %s (%s) resolved to itself\n",
1958 rdev->desc->name, rdev->supply_name);
1959 if (!have_full_constraints()) {
1963 r = dummy_regulator_rdev;
1964 get_device(&r->dev);
1968 * If the supply's parent device is not the same as the
1969 * regulator's parent device, then ensure the parent device
1970 * is bound before we resolve the supply, in case the parent
1971 * device get probe deferred and unregisters the supply.
1973 if (r->dev.parent && r->dev.parent != rdev->dev.parent) {
1974 if (!device_is_bound(r->dev.parent)) {
1975 put_device(&r->dev);
1976 ret = -EPROBE_DEFER;
1981 /* Recursively resolve the supply of the supply */
1982 ret = regulator_resolve_supply(r);
1984 put_device(&r->dev);
1989 * Recheck rdev->supply with rdev->mutex lock held to avoid a race
1990 * between rdev->supply null check and setting rdev->supply in
1991 * set_supply() from concurrent tasks.
1993 regulator_lock(rdev);
1995 /* Supply just resolved by a concurrent task? */
1997 regulator_unlock(rdev);
1998 put_device(&r->dev);
2002 ret = set_supply(rdev, r);
2004 regulator_unlock(rdev);
2005 put_device(&r->dev);
2009 regulator_unlock(rdev);
2012 * In set_machine_constraints() we may have turned this regulator on
2013 * but we couldn't propagate to the supply if it hadn't been resolved
2016 if (rdev->use_count) {
2017 ret = regulator_enable(rdev->supply);
2019 _regulator_put(rdev->supply);
2020 rdev->supply = NULL;
2029 /* Internal regulator request function */
2030 struct regulator *_regulator_get(struct device *dev, const char *id,
2031 enum regulator_get_type get_type)
2033 struct regulator_dev *rdev;
2034 struct regulator *regulator;
2035 struct device_link *link;
2038 if (get_type >= MAX_GET_TYPE) {
2039 dev_err(dev, "invalid type %d in %s\n", get_type, __func__);
2040 return ERR_PTR(-EINVAL);
2044 pr_err("get() with no identifier\n");
2045 return ERR_PTR(-EINVAL);
2048 rdev = regulator_dev_lookup(dev, id);
2050 ret = PTR_ERR(rdev);
2053 * If regulator_dev_lookup() fails with error other
2054 * than -ENODEV our job here is done, we simply return it.
2057 return ERR_PTR(ret);
2059 if (!have_full_constraints()) {
2061 "incomplete constraints, dummy supplies not allowed\n");
2062 return ERR_PTR(-ENODEV);
2068 * Assume that a regulator is physically present and
2069 * enabled, even if it isn't hooked up, and just
2072 dev_warn(dev, "supply %s not found, using dummy regulator\n", id);
2073 rdev = dummy_regulator_rdev;
2074 get_device(&rdev->dev);
2079 "dummy supplies not allowed for exclusive requests\n");
2083 return ERR_PTR(-ENODEV);
2087 if (rdev->exclusive) {
2088 regulator = ERR_PTR(-EPERM);
2089 put_device(&rdev->dev);
2093 if (get_type == EXCLUSIVE_GET && rdev->open_count) {
2094 regulator = ERR_PTR(-EBUSY);
2095 put_device(&rdev->dev);
2099 mutex_lock(®ulator_list_mutex);
2100 ret = (rdev->coupling_desc.n_resolved != rdev->coupling_desc.n_coupled);
2101 mutex_unlock(®ulator_list_mutex);
2104 regulator = ERR_PTR(-EPROBE_DEFER);
2105 put_device(&rdev->dev);
2109 ret = regulator_resolve_supply(rdev);
2111 regulator = ERR_PTR(ret);
2112 put_device(&rdev->dev);
2116 if (!try_module_get(rdev->owner)) {
2117 regulator = ERR_PTR(-EPROBE_DEFER);
2118 put_device(&rdev->dev);
2122 regulator = create_regulator(rdev, dev, id);
2123 if (regulator == NULL) {
2124 regulator = ERR_PTR(-ENOMEM);
2125 module_put(rdev->owner);
2126 put_device(&rdev->dev);
2131 if (get_type == EXCLUSIVE_GET) {
2132 rdev->exclusive = 1;
2134 ret = _regulator_is_enabled(rdev);
2136 rdev->use_count = 1;
2138 rdev->use_count = 0;
2141 link = device_link_add(dev, &rdev->dev, DL_FLAG_STATELESS);
2142 if (!IS_ERR_OR_NULL(link))
2143 regulator->device_link = true;
2149 * regulator_get - lookup and obtain a reference to a regulator.
2150 * @dev: device for regulator "consumer"
2151 * @id: Supply name or regulator ID.
2153 * Returns a struct regulator corresponding to the regulator producer,
2154 * or IS_ERR() condition containing errno.
2156 * Use of supply names configured via set_consumer_device_supply() is
2157 * strongly encouraged. It is recommended that the supply name used
2158 * should match the name used for the supply and/or the relevant
2159 * device pins in the datasheet.
2161 struct regulator *regulator_get(struct device *dev, const char *id)
2163 return _regulator_get(dev, id, NORMAL_GET);
2165 EXPORT_SYMBOL_GPL(regulator_get);
2168 * regulator_get_exclusive - obtain exclusive access to a regulator.
2169 * @dev: device for regulator "consumer"
2170 * @id: Supply name or regulator ID.
2172 * Returns a struct regulator corresponding to the regulator producer,
2173 * or IS_ERR() condition containing errno. Other consumers will be
2174 * unable to obtain this regulator while this reference is held and the
2175 * use count for the regulator will be initialised to reflect the current
2176 * state of the regulator.
2178 * This is intended for use by consumers which cannot tolerate shared
2179 * use of the regulator such as those which need to force the
2180 * regulator off for correct operation of the hardware they are
2183 * Use of supply names configured via set_consumer_device_supply() is
2184 * strongly encouraged. It is recommended that the supply name used
2185 * should match the name used for the supply and/or the relevant
2186 * device pins in the datasheet.
2188 struct regulator *regulator_get_exclusive(struct device *dev, const char *id)
2190 return _regulator_get(dev, id, EXCLUSIVE_GET);
2192 EXPORT_SYMBOL_GPL(regulator_get_exclusive);
2195 * regulator_get_optional - obtain optional access to a regulator.
2196 * @dev: device for regulator "consumer"
2197 * @id: Supply name or regulator ID.
2199 * Returns a struct regulator corresponding to the regulator producer,
2200 * or IS_ERR() condition containing errno.
2202 * This is intended for use by consumers for devices which can have
2203 * some supplies unconnected in normal use, such as some MMC devices.
2204 * It can allow the regulator core to provide stub supplies for other
2205 * supplies requested using normal regulator_get() calls without
2206 * disrupting the operation of drivers that can handle absent
2209 * Use of supply names configured via set_consumer_device_supply() is
2210 * strongly encouraged. It is recommended that the supply name used
2211 * should match the name used for the supply and/or the relevant
2212 * device pins in the datasheet.
2214 struct regulator *regulator_get_optional(struct device *dev, const char *id)
2216 return _regulator_get(dev, id, OPTIONAL_GET);
2218 EXPORT_SYMBOL_GPL(regulator_get_optional);
2220 static void destroy_regulator(struct regulator *regulator)
2222 struct regulator_dev *rdev = regulator->rdev;
2224 debugfs_remove_recursive(regulator->debugfs);
2226 if (regulator->dev) {
2227 if (regulator->device_link)
2228 device_link_remove(regulator->dev, &rdev->dev);
2230 /* remove any sysfs entries */
2231 sysfs_remove_link(&rdev->dev.kobj, regulator->supply_name);
2234 regulator_lock(rdev);
2235 list_del(®ulator->list);
2238 rdev->exclusive = 0;
2239 regulator_unlock(rdev);
2241 kfree_const(regulator->supply_name);
2245 /* regulator_list_mutex lock held by regulator_put() */
2246 static void _regulator_put(struct regulator *regulator)
2248 struct regulator_dev *rdev;
2250 if (IS_ERR_OR_NULL(regulator))
2253 lockdep_assert_held_once(®ulator_list_mutex);
2255 /* Docs say you must disable before calling regulator_put() */
2256 WARN_ON(regulator->enable_count);
2258 rdev = regulator->rdev;
2260 destroy_regulator(regulator);
2262 module_put(rdev->owner);
2263 put_device(&rdev->dev);
2267 * regulator_put - "free" the regulator source
2268 * @regulator: regulator source
2270 * Note: drivers must ensure that all regulator_enable calls made on this
2271 * regulator source are balanced by regulator_disable calls prior to calling
2274 void regulator_put(struct regulator *regulator)
2276 mutex_lock(®ulator_list_mutex);
2277 _regulator_put(regulator);
2278 mutex_unlock(®ulator_list_mutex);
2280 EXPORT_SYMBOL_GPL(regulator_put);
2283 * regulator_register_supply_alias - Provide device alias for supply lookup
2285 * @dev: device that will be given as the regulator "consumer"
2286 * @id: Supply name or regulator ID
2287 * @alias_dev: device that should be used to lookup the supply
2288 * @alias_id: Supply name or regulator ID that should be used to lookup the
2291 * All lookups for id on dev will instead be conducted for alias_id on
2294 int regulator_register_supply_alias(struct device *dev, const char *id,
2295 struct device *alias_dev,
2296 const char *alias_id)
2298 struct regulator_supply_alias *map;
2300 map = regulator_find_supply_alias(dev, id);
2304 map = kzalloc(sizeof(struct regulator_supply_alias), GFP_KERNEL);
2309 map->src_supply = id;
2310 map->alias_dev = alias_dev;
2311 map->alias_supply = alias_id;
2313 list_add(&map->list, ®ulator_supply_alias_list);
2315 pr_info("Adding alias for supply %s,%s -> %s,%s\n",
2316 id, dev_name(dev), alias_id, dev_name(alias_dev));
2320 EXPORT_SYMBOL_GPL(regulator_register_supply_alias);
2323 * regulator_unregister_supply_alias - Remove device alias
2325 * @dev: device that will be given as the regulator "consumer"
2326 * @id: Supply name or regulator ID
2328 * Remove a lookup alias if one exists for id on dev.
2330 void regulator_unregister_supply_alias(struct device *dev, const char *id)
2332 struct regulator_supply_alias *map;
2334 map = regulator_find_supply_alias(dev, id);
2336 list_del(&map->list);
2340 EXPORT_SYMBOL_GPL(regulator_unregister_supply_alias);
2343 * regulator_bulk_register_supply_alias - register multiple aliases
2345 * @dev: device that will be given as the regulator "consumer"
2346 * @id: List of supply names or regulator IDs
2347 * @alias_dev: device that should be used to lookup the supply
2348 * @alias_id: List of supply names or regulator IDs that should be used to
2350 * @num_id: Number of aliases to register
2352 * @return 0 on success, an errno on failure.
2354 * This helper function allows drivers to register several supply
2355 * aliases in one operation. If any of the aliases cannot be
2356 * registered any aliases that were registered will be removed
2357 * before returning to the caller.
2359 int regulator_bulk_register_supply_alias(struct device *dev,
2360 const char *const *id,
2361 struct device *alias_dev,
2362 const char *const *alias_id,
2368 for (i = 0; i < num_id; ++i) {
2369 ret = regulator_register_supply_alias(dev, id[i], alias_dev,
2379 "Failed to create supply alias %s,%s -> %s,%s\n",
2380 id[i], dev_name(dev), alias_id[i], dev_name(alias_dev));
2383 regulator_unregister_supply_alias(dev, id[i]);
2387 EXPORT_SYMBOL_GPL(regulator_bulk_register_supply_alias);
2390 * regulator_bulk_unregister_supply_alias - unregister multiple aliases
2392 * @dev: device that will be given as the regulator "consumer"
2393 * @id: List of supply names or regulator IDs
2394 * @num_id: Number of aliases to unregister
2396 * This helper function allows drivers to unregister several supply
2397 * aliases in one operation.
2399 void regulator_bulk_unregister_supply_alias(struct device *dev,
2400 const char *const *id,
2405 for (i = 0; i < num_id; ++i)
2406 regulator_unregister_supply_alias(dev, id[i]);
2408 EXPORT_SYMBOL_GPL(regulator_bulk_unregister_supply_alias);
2411 /* Manage enable GPIO list. Same GPIO pin can be shared among regulators */
2412 static int regulator_ena_gpio_request(struct regulator_dev *rdev,
2413 const struct regulator_config *config)
2415 struct regulator_enable_gpio *pin, *new_pin;
2416 struct gpio_desc *gpiod;
2418 gpiod = config->ena_gpiod;
2419 new_pin = kzalloc(sizeof(*new_pin), GFP_KERNEL);
2421 mutex_lock(®ulator_list_mutex);
2423 list_for_each_entry(pin, ®ulator_ena_gpio_list, list) {
2424 if (pin->gpiod == gpiod) {
2425 rdev_dbg(rdev, "GPIO is already used\n");
2426 goto update_ena_gpio_to_rdev;
2430 if (new_pin == NULL) {
2431 mutex_unlock(®ulator_list_mutex);
2439 list_add(&pin->list, ®ulator_ena_gpio_list);
2441 update_ena_gpio_to_rdev:
2442 pin->request_count++;
2443 rdev->ena_pin = pin;
2445 mutex_unlock(®ulator_list_mutex);
2451 static void regulator_ena_gpio_free(struct regulator_dev *rdev)
2453 struct regulator_enable_gpio *pin, *n;
2458 /* Free the GPIO only in case of no use */
2459 list_for_each_entry_safe(pin, n, ®ulator_ena_gpio_list, list) {
2460 if (pin != rdev->ena_pin)
2463 if (--pin->request_count)
2466 gpiod_put(pin->gpiod);
2467 list_del(&pin->list);
2472 rdev->ena_pin = NULL;
2476 * regulator_ena_gpio_ctrl - balance enable_count of each GPIO and actual GPIO pin control
2477 * @rdev: regulator_dev structure
2478 * @enable: enable GPIO at initial use?
2480 * GPIO is enabled in case of initial use. (enable_count is 0)
2481 * GPIO is disabled when it is not shared any more. (enable_count <= 1)
2483 static int regulator_ena_gpio_ctrl(struct regulator_dev *rdev, bool enable)
2485 struct regulator_enable_gpio *pin = rdev->ena_pin;
2491 /* Enable GPIO at initial use */
2492 if (pin->enable_count == 0)
2493 gpiod_set_value_cansleep(pin->gpiod, 1);
2495 pin->enable_count++;
2497 if (pin->enable_count > 1) {
2498 pin->enable_count--;
2502 /* Disable GPIO if not used */
2503 if (pin->enable_count <= 1) {
2504 gpiod_set_value_cansleep(pin->gpiod, 0);
2505 pin->enable_count = 0;
2513 * _regulator_enable_delay - a delay helper function
2514 * @delay: time to delay in microseconds
2516 * Delay for the requested amount of time as per the guidelines in:
2518 * Documentation/timers/timers-howto.rst
2520 * The assumption here is that regulators will never be enabled in
2521 * atomic context and therefore sleeping functions can be used.
2523 static void _regulator_enable_delay(unsigned int delay)
2525 unsigned int ms = delay / 1000;
2526 unsigned int us = delay % 1000;
2530 * For small enough values, handle super-millisecond
2531 * delays in the usleep_range() call below.
2540 * Give the scheduler some room to coalesce with any other
2541 * wakeup sources. For delays shorter than 10 us, don't even
2542 * bother setting up high-resolution timers and just busy-
2546 usleep_range(us, us + 100);
2552 * _regulator_check_status_enabled
2554 * A helper function to check if the regulator status can be interpreted
2555 * as 'regulator is enabled'.
2556 * @rdev: the regulator device to check
2559 * * 1 - if status shows regulator is in enabled state
2560 * * 0 - if not enabled state
2561 * * Error Value - as received from ops->get_status()
2563 static inline int _regulator_check_status_enabled(struct regulator_dev *rdev)
2565 int ret = rdev->desc->ops->get_status(rdev);
2568 rdev_info(rdev, "get_status returned error: %d\n", ret);
2573 case REGULATOR_STATUS_OFF:
2574 case REGULATOR_STATUS_ERROR:
2575 case REGULATOR_STATUS_UNDEFINED:
2582 static int _regulator_do_enable(struct regulator_dev *rdev)
2586 /* Query before enabling in case configuration dependent. */
2587 ret = _regulator_get_enable_time(rdev);
2591 rdev_warn(rdev, "enable_time() failed: %pe\n", ERR_PTR(ret));
2595 trace_regulator_enable(rdev_get_name(rdev));
2597 if (rdev->desc->off_on_delay && rdev->last_off) {
2598 /* if needed, keep a distance of off_on_delay from last time
2599 * this regulator was disabled.
2601 ktime_t end = ktime_add_us(rdev->last_off, rdev->desc->off_on_delay);
2602 s64 remaining = ktime_us_delta(end, ktime_get());
2605 _regulator_enable_delay(remaining);
2608 if (rdev->ena_pin) {
2609 if (!rdev->ena_gpio_state) {
2610 ret = regulator_ena_gpio_ctrl(rdev, true);
2613 rdev->ena_gpio_state = 1;
2615 } else if (rdev->desc->ops->enable) {
2616 ret = rdev->desc->ops->enable(rdev);
2623 /* Allow the regulator to ramp; it would be useful to extend
2624 * this for bulk operations so that the regulators can ramp
2627 trace_regulator_enable_delay(rdev_get_name(rdev));
2629 /* If poll_enabled_time is set, poll upto the delay calculated
2630 * above, delaying poll_enabled_time uS to check if the regulator
2631 * actually got enabled.
2632 * If the regulator isn't enabled after enable_delay has
2633 * expired, return -ETIMEDOUT.
2635 if (rdev->desc->poll_enabled_time) {
2636 unsigned int time_remaining = delay;
2638 while (time_remaining > 0) {
2639 _regulator_enable_delay(rdev->desc->poll_enabled_time);
2641 if (rdev->desc->ops->get_status) {
2642 ret = _regulator_check_status_enabled(rdev);
2647 } else if (rdev->desc->ops->is_enabled(rdev))
2650 time_remaining -= rdev->desc->poll_enabled_time;
2653 if (time_remaining <= 0) {
2654 rdev_err(rdev, "Enabled check timed out\n");
2658 _regulator_enable_delay(delay);
2661 trace_regulator_enable_complete(rdev_get_name(rdev));
2667 * _regulator_handle_consumer_enable - handle that a consumer enabled
2668 * @regulator: regulator source
2670 * Some things on a regulator consumer (like the contribution towards total
2671 * load on the regulator) only have an effect when the consumer wants the
2672 * regulator enabled. Explained in example with two consumers of the same
2674 * consumer A: set_load(100); => total load = 0
2675 * consumer A: regulator_enable(); => total load = 100
2676 * consumer B: set_load(1000); => total load = 100
2677 * consumer B: regulator_enable(); => total load = 1100
2678 * consumer A: regulator_disable(); => total_load = 1000
2680 * This function (together with _regulator_handle_consumer_disable) is
2681 * responsible for keeping track of the refcount for a given regulator consumer
2682 * and applying / unapplying these things.
2684 * Returns 0 upon no error; -error upon error.
2686 static int _regulator_handle_consumer_enable(struct regulator *regulator)
2688 struct regulator_dev *rdev = regulator->rdev;
2690 lockdep_assert_held_once(&rdev->mutex.base);
2692 regulator->enable_count++;
2693 if (regulator->uA_load && regulator->enable_count == 1)
2694 return drms_uA_update(rdev);
2700 * _regulator_handle_consumer_disable - handle that a consumer disabled
2701 * @regulator: regulator source
2703 * The opposite of _regulator_handle_consumer_enable().
2705 * Returns 0 upon no error; -error upon error.
2707 static int _regulator_handle_consumer_disable(struct regulator *regulator)
2709 struct regulator_dev *rdev = regulator->rdev;
2711 lockdep_assert_held_once(&rdev->mutex.base);
2713 if (!regulator->enable_count) {
2714 rdev_err(rdev, "Underflow of regulator enable count\n");
2718 regulator->enable_count--;
2719 if (regulator->uA_load && regulator->enable_count == 0)
2720 return drms_uA_update(rdev);
2725 /* locks held by regulator_enable() */
2726 static int _regulator_enable(struct regulator *regulator)
2728 struct regulator_dev *rdev = regulator->rdev;
2731 lockdep_assert_held_once(&rdev->mutex.base);
2733 if (rdev->use_count == 0 && rdev->supply) {
2734 ret = _regulator_enable(rdev->supply);
2739 /* balance only if there are regulators coupled */
2740 if (rdev->coupling_desc.n_coupled > 1) {
2741 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
2743 goto err_disable_supply;
2746 ret = _regulator_handle_consumer_enable(regulator);
2748 goto err_disable_supply;
2750 if (rdev->use_count == 0) {
2752 * The regulator may already be enabled if it's not switchable
2755 ret = _regulator_is_enabled(rdev);
2756 if (ret == -EINVAL || ret == 0) {
2757 if (!regulator_ops_is_valid(rdev,
2758 REGULATOR_CHANGE_STATUS)) {
2760 goto err_consumer_disable;
2763 ret = _regulator_do_enable(rdev);
2765 goto err_consumer_disable;
2767 _notifier_call_chain(rdev, REGULATOR_EVENT_ENABLE,
2769 } else if (ret < 0) {
2770 rdev_err(rdev, "is_enabled() failed: %pe\n", ERR_PTR(ret));
2771 goto err_consumer_disable;
2773 /* Fallthrough on positive return values - already enabled */
2780 err_consumer_disable:
2781 _regulator_handle_consumer_disable(regulator);
2784 if (rdev->use_count == 0 && rdev->supply)
2785 _regulator_disable(rdev->supply);
2791 * regulator_enable - enable regulator output
2792 * @regulator: regulator source
2794 * Request that the regulator be enabled with the regulator output at
2795 * the predefined voltage or current value. Calls to regulator_enable()
2796 * must be balanced with calls to regulator_disable().
2798 * NOTE: the output value can be set by other drivers, boot loader or may be
2799 * hardwired in the regulator.
2801 int regulator_enable(struct regulator *regulator)
2803 struct regulator_dev *rdev = regulator->rdev;
2804 struct ww_acquire_ctx ww_ctx;
2807 regulator_lock_dependent(rdev, &ww_ctx);
2808 ret = _regulator_enable(regulator);
2809 regulator_unlock_dependent(rdev, &ww_ctx);
2813 EXPORT_SYMBOL_GPL(regulator_enable);
2815 static int _regulator_do_disable(struct regulator_dev *rdev)
2819 trace_regulator_disable(rdev_get_name(rdev));
2821 if (rdev->ena_pin) {
2822 if (rdev->ena_gpio_state) {
2823 ret = regulator_ena_gpio_ctrl(rdev, false);
2826 rdev->ena_gpio_state = 0;
2829 } else if (rdev->desc->ops->disable) {
2830 ret = rdev->desc->ops->disable(rdev);
2835 if (rdev->desc->off_on_delay)
2836 rdev->last_off = ktime_get();
2838 trace_regulator_disable_complete(rdev_get_name(rdev));
2843 /* locks held by regulator_disable() */
2844 static int _regulator_disable(struct regulator *regulator)
2846 struct regulator_dev *rdev = regulator->rdev;
2849 lockdep_assert_held_once(&rdev->mutex.base);
2851 if (WARN(rdev->use_count <= 0,
2852 "unbalanced disables for %s\n", rdev_get_name(rdev)))
2855 /* are we the last user and permitted to disable ? */
2856 if (rdev->use_count == 1 &&
2857 (rdev->constraints && !rdev->constraints->always_on)) {
2859 /* we are last user */
2860 if (regulator_ops_is_valid(rdev, REGULATOR_CHANGE_STATUS)) {
2861 ret = _notifier_call_chain(rdev,
2862 REGULATOR_EVENT_PRE_DISABLE,
2864 if (ret & NOTIFY_STOP_MASK)
2867 ret = _regulator_do_disable(rdev);
2869 rdev_err(rdev, "failed to disable: %pe\n", ERR_PTR(ret));
2870 _notifier_call_chain(rdev,
2871 REGULATOR_EVENT_ABORT_DISABLE,
2875 _notifier_call_chain(rdev, REGULATOR_EVENT_DISABLE,
2879 rdev->use_count = 0;
2880 } else if (rdev->use_count > 1) {
2885 ret = _regulator_handle_consumer_disable(regulator);
2887 if (ret == 0 && rdev->coupling_desc.n_coupled > 1)
2888 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
2890 if (ret == 0 && rdev->use_count == 0 && rdev->supply)
2891 ret = _regulator_disable(rdev->supply);
2897 * regulator_disable - disable regulator output
2898 * @regulator: regulator source
2900 * Disable the regulator output voltage or current. Calls to
2901 * regulator_enable() must be balanced with calls to
2902 * regulator_disable().
2904 * NOTE: this will only disable the regulator output if no other consumer
2905 * devices have it enabled, the regulator device supports disabling and
2906 * machine constraints permit this operation.
2908 int regulator_disable(struct regulator *regulator)
2910 struct regulator_dev *rdev = regulator->rdev;
2911 struct ww_acquire_ctx ww_ctx;
2914 regulator_lock_dependent(rdev, &ww_ctx);
2915 ret = _regulator_disable(regulator);
2916 regulator_unlock_dependent(rdev, &ww_ctx);
2920 EXPORT_SYMBOL_GPL(regulator_disable);
2922 /* locks held by regulator_force_disable() */
2923 static int _regulator_force_disable(struct regulator_dev *rdev)
2927 lockdep_assert_held_once(&rdev->mutex.base);
2929 ret = _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
2930 REGULATOR_EVENT_PRE_DISABLE, NULL);
2931 if (ret & NOTIFY_STOP_MASK)
2934 ret = _regulator_do_disable(rdev);
2936 rdev_err(rdev, "failed to force disable: %pe\n", ERR_PTR(ret));
2937 _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
2938 REGULATOR_EVENT_ABORT_DISABLE, NULL);
2942 _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
2943 REGULATOR_EVENT_DISABLE, NULL);
2949 * regulator_force_disable - force disable regulator output
2950 * @regulator: regulator source
2952 * Forcibly disable the regulator output voltage or current.
2953 * NOTE: this *will* disable the regulator output even if other consumer
2954 * devices have it enabled. This should be used for situations when device
2955 * damage will likely occur if the regulator is not disabled (e.g. over temp).
2957 int regulator_force_disable(struct regulator *regulator)
2959 struct regulator_dev *rdev = regulator->rdev;
2960 struct ww_acquire_ctx ww_ctx;
2963 regulator_lock_dependent(rdev, &ww_ctx);
2965 ret = _regulator_force_disable(regulator->rdev);
2967 if (rdev->coupling_desc.n_coupled > 1)
2968 regulator_balance_voltage(rdev, PM_SUSPEND_ON);
2970 if (regulator->uA_load) {
2971 regulator->uA_load = 0;
2972 ret = drms_uA_update(rdev);
2975 if (rdev->use_count != 0 && rdev->supply)
2976 _regulator_disable(rdev->supply);
2978 regulator_unlock_dependent(rdev, &ww_ctx);
2982 EXPORT_SYMBOL_GPL(regulator_force_disable);
2984 static void regulator_disable_work(struct work_struct *work)
2986 struct regulator_dev *rdev = container_of(work, struct regulator_dev,
2988 struct ww_acquire_ctx ww_ctx;
2990 struct regulator *regulator;
2991 int total_count = 0;
2993 regulator_lock_dependent(rdev, &ww_ctx);
2996 * Workqueue functions queue the new work instance while the previous
2997 * work instance is being processed. Cancel the queued work instance
2998 * as the work instance under processing does the job of the queued
3001 cancel_delayed_work(&rdev->disable_work);
3003 list_for_each_entry(regulator, &rdev->consumer_list, list) {
3004 count = regulator->deferred_disables;
3009 total_count += count;
3010 regulator->deferred_disables = 0;
3012 for (i = 0; i < count; i++) {
3013 ret = _regulator_disable(regulator);
3015 rdev_err(rdev, "Deferred disable failed: %pe\n",
3019 WARN_ON(!total_count);
3021 if (rdev->coupling_desc.n_coupled > 1)
3022 regulator_balance_voltage(rdev, PM_SUSPEND_ON);
3024 regulator_unlock_dependent(rdev, &ww_ctx);
3028 * regulator_disable_deferred - disable regulator output with delay
3029 * @regulator: regulator source
3030 * @ms: milliseconds until the regulator is disabled
3032 * Execute regulator_disable() on the regulator after a delay. This
3033 * is intended for use with devices that require some time to quiesce.
3035 * NOTE: this will only disable the regulator output if no other consumer
3036 * devices have it enabled, the regulator device supports disabling and
3037 * machine constraints permit this operation.
3039 int regulator_disable_deferred(struct regulator *regulator, int ms)
3041 struct regulator_dev *rdev = regulator->rdev;
3044 return regulator_disable(regulator);
3046 regulator_lock(rdev);
3047 regulator->deferred_disables++;
3048 mod_delayed_work(system_power_efficient_wq, &rdev->disable_work,
3049 msecs_to_jiffies(ms));
3050 regulator_unlock(rdev);
3054 EXPORT_SYMBOL_GPL(regulator_disable_deferred);
3056 static int _regulator_is_enabled(struct regulator_dev *rdev)
3058 /* A GPIO control always takes precedence */
3060 return rdev->ena_gpio_state;
3062 /* If we don't know then assume that the regulator is always on */
3063 if (!rdev->desc->ops->is_enabled)
3066 return rdev->desc->ops->is_enabled(rdev);
3069 static int _regulator_list_voltage(struct regulator_dev *rdev,
3070 unsigned selector, int lock)
3072 const struct regulator_ops *ops = rdev->desc->ops;
3075 if (rdev->desc->fixed_uV && rdev->desc->n_voltages == 1 && !selector)
3076 return rdev->desc->fixed_uV;
3078 if (ops->list_voltage) {
3079 if (selector >= rdev->desc->n_voltages)
3081 if (selector < rdev->desc->linear_min_sel)
3084 regulator_lock(rdev);
3085 ret = ops->list_voltage(rdev, selector);
3087 regulator_unlock(rdev);
3088 } else if (rdev->is_switch && rdev->supply) {
3089 ret = _regulator_list_voltage(rdev->supply->rdev,
3096 if (ret < rdev->constraints->min_uV)
3098 else if (ret > rdev->constraints->max_uV)
3106 * regulator_is_enabled - is the regulator output enabled
3107 * @regulator: regulator source
3109 * Returns positive if the regulator driver backing the source/client
3110 * has requested that the device be enabled, zero if it hasn't, else a
3111 * negative errno code.
3113 * Note that the device backing this regulator handle can have multiple
3114 * users, so it might be enabled even if regulator_enable() was never
3115 * called for this particular source.
3117 int regulator_is_enabled(struct regulator *regulator)
3121 if (regulator->always_on)
3124 regulator_lock(regulator->rdev);
3125 ret = _regulator_is_enabled(regulator->rdev);
3126 regulator_unlock(regulator->rdev);
3130 EXPORT_SYMBOL_GPL(regulator_is_enabled);
3133 * regulator_count_voltages - count regulator_list_voltage() selectors
3134 * @regulator: regulator source
3136 * Returns number of selectors, or negative errno. Selectors are
3137 * numbered starting at zero, and typically correspond to bitfields
3138 * in hardware registers.
3140 int regulator_count_voltages(struct regulator *regulator)
3142 struct regulator_dev *rdev = regulator->rdev;
3144 if (rdev->desc->n_voltages)
3145 return rdev->desc->n_voltages;
3147 if (!rdev->is_switch || !rdev->supply)
3150 return regulator_count_voltages(rdev->supply);
3152 EXPORT_SYMBOL_GPL(regulator_count_voltages);
3155 * regulator_list_voltage - enumerate supported voltages
3156 * @regulator: regulator source
3157 * @selector: identify voltage to list
3158 * Context: can sleep
3160 * Returns a voltage that can be passed to @regulator_set_voltage(),
3161 * zero if this selector code can't be used on this system, or a
3164 int regulator_list_voltage(struct regulator *regulator, unsigned selector)
3166 return _regulator_list_voltage(regulator->rdev, selector, 1);
3168 EXPORT_SYMBOL_GPL(regulator_list_voltage);
3171 * regulator_get_regmap - get the regulator's register map
3172 * @regulator: regulator source
3174 * Returns the register map for the given regulator, or an ERR_PTR value
3175 * if the regulator doesn't use regmap.
3177 struct regmap *regulator_get_regmap(struct regulator *regulator)
3179 struct regmap *map = regulator->rdev->regmap;
3181 return map ? map : ERR_PTR(-EOPNOTSUPP);
3185 * regulator_get_hardware_vsel_register - get the HW voltage selector register
3186 * @regulator: regulator source
3187 * @vsel_reg: voltage selector register, output parameter
3188 * @vsel_mask: mask for voltage selector bitfield, output parameter
3190 * Returns the hardware register offset and bitmask used for setting the
3191 * regulator voltage. This might be useful when configuring voltage-scaling
3192 * hardware or firmware that can make I2C requests behind the kernel's back,
3195 * On success, the output parameters @vsel_reg and @vsel_mask are filled in
3196 * and 0 is returned, otherwise a negative errno is returned.
3198 int regulator_get_hardware_vsel_register(struct regulator *regulator,
3200 unsigned *vsel_mask)
3202 struct regulator_dev *rdev = regulator->rdev;
3203 const struct regulator_ops *ops = rdev->desc->ops;
3205 if (ops->set_voltage_sel != regulator_set_voltage_sel_regmap)
3208 *vsel_reg = rdev->desc->vsel_reg;
3209 *vsel_mask = rdev->desc->vsel_mask;
3213 EXPORT_SYMBOL_GPL(regulator_get_hardware_vsel_register);
3216 * regulator_list_hardware_vsel - get the HW-specific register value for a selector
3217 * @regulator: regulator source
3218 * @selector: identify voltage to list
3220 * Converts the selector to a hardware-specific voltage selector that can be
3221 * directly written to the regulator registers. The address of the voltage
3222 * register can be determined by calling @regulator_get_hardware_vsel_register.
3224 * On error a negative errno is returned.
3226 int regulator_list_hardware_vsel(struct regulator *regulator,
3229 struct regulator_dev *rdev = regulator->rdev;
3230 const struct regulator_ops *ops = rdev->desc->ops;
3232 if (selector >= rdev->desc->n_voltages)
3234 if (selector < rdev->desc->linear_min_sel)
3236 if (ops->set_voltage_sel != regulator_set_voltage_sel_regmap)
3241 EXPORT_SYMBOL_GPL(regulator_list_hardware_vsel);
3244 * regulator_get_linear_step - return the voltage step size between VSEL values
3245 * @regulator: regulator source
3247 * Returns the voltage step size between VSEL values for linear
3248 * regulators, or return 0 if the regulator isn't a linear regulator.
3250 unsigned int regulator_get_linear_step(struct regulator *regulator)
3252 struct regulator_dev *rdev = regulator->rdev;
3254 return rdev->desc->uV_step;
3256 EXPORT_SYMBOL_GPL(regulator_get_linear_step);
3259 * regulator_is_supported_voltage - check if a voltage range can be supported
3261 * @regulator: Regulator to check.
3262 * @min_uV: Minimum required voltage in uV.
3263 * @max_uV: Maximum required voltage in uV.
3265 * Returns a boolean.
3267 int regulator_is_supported_voltage(struct regulator *regulator,
3268 int min_uV, int max_uV)
3270 struct regulator_dev *rdev = regulator->rdev;
3271 int i, voltages, ret;
3273 /* If we can't change voltage check the current voltage */
3274 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE)) {
3275 ret = regulator_get_voltage(regulator);
3277 return min_uV <= ret && ret <= max_uV;
3282 /* Any voltage within constrains range is fine? */
3283 if (rdev->desc->continuous_voltage_range)
3284 return min_uV >= rdev->constraints->min_uV &&
3285 max_uV <= rdev->constraints->max_uV;
3287 ret = regulator_count_voltages(regulator);
3292 for (i = 0; i < voltages; i++) {
3293 ret = regulator_list_voltage(regulator, i);
3295 if (ret >= min_uV && ret <= max_uV)
3301 EXPORT_SYMBOL_GPL(regulator_is_supported_voltage);
3303 static int regulator_map_voltage(struct regulator_dev *rdev, int min_uV,
3306 const struct regulator_desc *desc = rdev->desc;
3308 if (desc->ops->map_voltage)
3309 return desc->ops->map_voltage(rdev, min_uV, max_uV);
3311 if (desc->ops->list_voltage == regulator_list_voltage_linear)
3312 return regulator_map_voltage_linear(rdev, min_uV, max_uV);
3314 if (desc->ops->list_voltage == regulator_list_voltage_linear_range)
3315 return regulator_map_voltage_linear_range(rdev, min_uV, max_uV);
3317 if (desc->ops->list_voltage ==
3318 regulator_list_voltage_pickable_linear_range)
3319 return regulator_map_voltage_pickable_linear_range(rdev,
3322 return regulator_map_voltage_iterate(rdev, min_uV, max_uV);
3325 static int _regulator_call_set_voltage(struct regulator_dev *rdev,
3326 int min_uV, int max_uV,
3329 struct pre_voltage_change_data data;
3332 data.old_uV = regulator_get_voltage_rdev(rdev);
3333 data.min_uV = min_uV;
3334 data.max_uV = max_uV;
3335 ret = _notifier_call_chain(rdev, REGULATOR_EVENT_PRE_VOLTAGE_CHANGE,
3337 if (ret & NOTIFY_STOP_MASK)
3340 ret = rdev->desc->ops->set_voltage(rdev, min_uV, max_uV, selector);
3344 _notifier_call_chain(rdev, REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE,
3345 (void *)data.old_uV);
3350 static int _regulator_call_set_voltage_sel(struct regulator_dev *rdev,
3351 int uV, unsigned selector)
3353 struct pre_voltage_change_data data;
3356 data.old_uV = regulator_get_voltage_rdev(rdev);
3359 ret = _notifier_call_chain(rdev, REGULATOR_EVENT_PRE_VOLTAGE_CHANGE,
3361 if (ret & NOTIFY_STOP_MASK)
3364 ret = rdev->desc->ops->set_voltage_sel(rdev, selector);
3368 _notifier_call_chain(rdev, REGULATOR_EVENT_ABORT_VOLTAGE_CHANGE,
3369 (void *)data.old_uV);
3374 static int _regulator_set_voltage_sel_step(struct regulator_dev *rdev,
3375 int uV, int new_selector)
3377 const struct regulator_ops *ops = rdev->desc->ops;
3378 int diff, old_sel, curr_sel, ret;
3380 /* Stepping is only needed if the regulator is enabled. */
3381 if (!_regulator_is_enabled(rdev))
3384 if (!ops->get_voltage_sel)
3387 old_sel = ops->get_voltage_sel(rdev);
3391 diff = new_selector - old_sel;
3393 return 0; /* No change needed. */
3397 for (curr_sel = old_sel + rdev->desc->vsel_step;
3398 curr_sel < new_selector;
3399 curr_sel += rdev->desc->vsel_step) {
3401 * Call the callback directly instead of using
3402 * _regulator_call_set_voltage_sel() as we don't
3403 * want to notify anyone yet. Same in the branch
3406 ret = ops->set_voltage_sel(rdev, curr_sel);
3411 /* Stepping down. */
3412 for (curr_sel = old_sel - rdev->desc->vsel_step;
3413 curr_sel > new_selector;
3414 curr_sel -= rdev->desc->vsel_step) {
3415 ret = ops->set_voltage_sel(rdev, curr_sel);
3422 /* The final selector will trigger the notifiers. */
3423 return _regulator_call_set_voltage_sel(rdev, uV, new_selector);
3427 * At least try to return to the previous voltage if setting a new
3430 (void)ops->set_voltage_sel(rdev, old_sel);
3434 static int _regulator_set_voltage_time(struct regulator_dev *rdev,
3435 int old_uV, int new_uV)
3437 unsigned int ramp_delay = 0;
3439 if (rdev->constraints->ramp_delay)
3440 ramp_delay = rdev->constraints->ramp_delay;
3441 else if (rdev->desc->ramp_delay)
3442 ramp_delay = rdev->desc->ramp_delay;
3443 else if (rdev->constraints->settling_time)
3444 return rdev->constraints->settling_time;
3445 else if (rdev->constraints->settling_time_up &&
3447 return rdev->constraints->settling_time_up;
3448 else if (rdev->constraints->settling_time_down &&
3450 return rdev->constraints->settling_time_down;
3452 if (ramp_delay == 0) {
3453 rdev_dbg(rdev, "ramp_delay not set\n");
3457 return DIV_ROUND_UP(abs(new_uV - old_uV), ramp_delay);
3460 static int _regulator_do_set_voltage(struct regulator_dev *rdev,
3461 int min_uV, int max_uV)
3466 unsigned int selector;
3467 int old_selector = -1;
3468 const struct regulator_ops *ops = rdev->desc->ops;
3469 int old_uV = regulator_get_voltage_rdev(rdev);
3471 trace_regulator_set_voltage(rdev_get_name(rdev), min_uV, max_uV);
3473 min_uV += rdev->constraints->uV_offset;
3474 max_uV += rdev->constraints->uV_offset;
3477 * If we can't obtain the old selector there is not enough
3478 * info to call set_voltage_time_sel().
3480 if (_regulator_is_enabled(rdev) &&
3481 ops->set_voltage_time_sel && ops->get_voltage_sel) {
3482 old_selector = ops->get_voltage_sel(rdev);
3483 if (old_selector < 0)
3484 return old_selector;
3487 if (ops->set_voltage) {
3488 ret = _regulator_call_set_voltage(rdev, min_uV, max_uV,
3492 if (ops->list_voltage)
3493 best_val = ops->list_voltage(rdev,
3496 best_val = regulator_get_voltage_rdev(rdev);
3499 } else if (ops->set_voltage_sel) {
3500 ret = regulator_map_voltage(rdev, min_uV, max_uV);
3502 best_val = ops->list_voltage(rdev, ret);
3503 if (min_uV <= best_val && max_uV >= best_val) {
3505 if (old_selector == selector)
3507 else if (rdev->desc->vsel_step)
3508 ret = _regulator_set_voltage_sel_step(
3509 rdev, best_val, selector);
3511 ret = _regulator_call_set_voltage_sel(
3512 rdev, best_val, selector);
3524 if (ops->set_voltage_time_sel) {
3526 * Call set_voltage_time_sel if successfully obtained
3529 if (old_selector >= 0 && old_selector != selector)
3530 delay = ops->set_voltage_time_sel(rdev, old_selector,
3533 if (old_uV != best_val) {
3534 if (ops->set_voltage_time)
3535 delay = ops->set_voltage_time(rdev, old_uV,
3538 delay = _regulator_set_voltage_time(rdev,
3545 rdev_warn(rdev, "failed to get delay: %pe\n", ERR_PTR(delay));
3549 /* Insert any necessary delays */
3550 if (delay >= 1000) {
3551 mdelay(delay / 1000);
3552 udelay(delay % 1000);
3557 if (best_val >= 0) {
3558 unsigned long data = best_val;
3560 _notifier_call_chain(rdev, REGULATOR_EVENT_VOLTAGE_CHANGE,
3565 trace_regulator_set_voltage_complete(rdev_get_name(rdev), best_val);
3570 static int _regulator_do_set_suspend_voltage(struct regulator_dev *rdev,
3571 int min_uV, int max_uV, suspend_state_t state)
3573 struct regulator_state *rstate;
3576 rstate = regulator_get_suspend_state(rdev, state);
3580 if (min_uV < rstate->min_uV)
3581 min_uV = rstate->min_uV;
3582 if (max_uV > rstate->max_uV)
3583 max_uV = rstate->max_uV;
3585 sel = regulator_map_voltage(rdev, min_uV, max_uV);
3589 uV = rdev->desc->ops->list_voltage(rdev, sel);
3590 if (uV >= min_uV && uV <= max_uV)
3596 static int regulator_set_voltage_unlocked(struct regulator *regulator,
3597 int min_uV, int max_uV,
3598 suspend_state_t state)
3600 struct regulator_dev *rdev = regulator->rdev;
3601 struct regulator_voltage *voltage = ®ulator->voltage[state];
3603 int old_min_uV, old_max_uV;
3606 /* If we're setting the same range as last time the change
3607 * should be a noop (some cpufreq implementations use the same
3608 * voltage for multiple frequencies, for example).
3610 if (voltage->min_uV == min_uV && voltage->max_uV == max_uV)
3613 /* If we're trying to set a range that overlaps the current voltage,
3614 * return successfully even though the regulator does not support
3615 * changing the voltage.
3617 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_VOLTAGE)) {
3618 current_uV = regulator_get_voltage_rdev(rdev);
3619 if (min_uV <= current_uV && current_uV <= max_uV) {
3620 voltage->min_uV = min_uV;
3621 voltage->max_uV = max_uV;
3627 if (!rdev->desc->ops->set_voltage &&
3628 !rdev->desc->ops->set_voltage_sel) {
3633 /* constraints check */
3634 ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
3638 /* restore original values in case of error */
3639 old_min_uV = voltage->min_uV;
3640 old_max_uV = voltage->max_uV;
3641 voltage->min_uV = min_uV;
3642 voltage->max_uV = max_uV;
3644 /* for not coupled regulators this will just set the voltage */
3645 ret = regulator_balance_voltage(rdev, state);
3647 voltage->min_uV = old_min_uV;
3648 voltage->max_uV = old_max_uV;
3655 int regulator_set_voltage_rdev(struct regulator_dev *rdev, int min_uV,
3656 int max_uV, suspend_state_t state)
3658 int best_supply_uV = 0;
3659 int supply_change_uV = 0;
3663 regulator_ops_is_valid(rdev->supply->rdev,
3664 REGULATOR_CHANGE_VOLTAGE) &&
3665 (rdev->desc->min_dropout_uV || !(rdev->desc->ops->get_voltage ||
3666 rdev->desc->ops->get_voltage_sel))) {
3667 int current_supply_uV;
3670 selector = regulator_map_voltage(rdev, min_uV, max_uV);
3676 best_supply_uV = _regulator_list_voltage(rdev, selector, 0);
3677 if (best_supply_uV < 0) {
3678 ret = best_supply_uV;
3682 best_supply_uV += rdev->desc->min_dropout_uV;
3684 current_supply_uV = regulator_get_voltage_rdev(rdev->supply->rdev);
3685 if (current_supply_uV < 0) {
3686 ret = current_supply_uV;
3690 supply_change_uV = best_supply_uV - current_supply_uV;
3693 if (supply_change_uV > 0) {
3694 ret = regulator_set_voltage_unlocked(rdev->supply,
3695 best_supply_uV, INT_MAX, state);
3697 dev_err(&rdev->dev, "Failed to increase supply voltage: %pe\n",
3703 if (state == PM_SUSPEND_ON)
3704 ret = _regulator_do_set_voltage(rdev, min_uV, max_uV);
3706 ret = _regulator_do_set_suspend_voltage(rdev, min_uV,
3711 if (supply_change_uV < 0) {
3712 ret = regulator_set_voltage_unlocked(rdev->supply,
3713 best_supply_uV, INT_MAX, state);
3715 dev_warn(&rdev->dev, "Failed to decrease supply voltage: %pe\n",
3717 /* No need to fail here */
3724 EXPORT_SYMBOL_GPL(regulator_set_voltage_rdev);
3726 static int regulator_limit_voltage_step(struct regulator_dev *rdev,
3727 int *current_uV, int *min_uV)
3729 struct regulation_constraints *constraints = rdev->constraints;
3731 /* Limit voltage change only if necessary */
3732 if (!constraints->max_uV_step || !_regulator_is_enabled(rdev))
3735 if (*current_uV < 0) {
3736 *current_uV = regulator_get_voltage_rdev(rdev);
3738 if (*current_uV < 0)
3742 if (abs(*current_uV - *min_uV) <= constraints->max_uV_step)
3745 /* Clamp target voltage within the given step */
3746 if (*current_uV < *min_uV)
3747 *min_uV = min(*current_uV + constraints->max_uV_step,
3750 *min_uV = max(*current_uV - constraints->max_uV_step,
3756 static int regulator_get_optimal_voltage(struct regulator_dev *rdev,
3758 int *min_uV, int *max_uV,
3759 suspend_state_t state,
3762 struct coupling_desc *c_desc = &rdev->coupling_desc;
3763 struct regulator_dev **c_rdevs = c_desc->coupled_rdevs;
3764 struct regulation_constraints *constraints = rdev->constraints;
3765 int desired_min_uV = 0, desired_max_uV = INT_MAX;
3766 int max_current_uV = 0, min_current_uV = INT_MAX;
3767 int highest_min_uV = 0, target_uV, possible_uV;
3768 int i, ret, max_spread;
3774 * If there are no coupled regulators, simply set the voltage
3775 * demanded by consumers.
3777 if (n_coupled == 1) {
3779 * If consumers don't provide any demands, set voltage
3782 desired_min_uV = constraints->min_uV;
3783 desired_max_uV = constraints->max_uV;
3785 ret = regulator_check_consumers(rdev,
3787 &desired_max_uV, state);
3791 possible_uV = desired_min_uV;
3797 /* Find highest min desired voltage */
3798 for (i = 0; i < n_coupled; i++) {
3800 int tmp_max = INT_MAX;
3802 lockdep_assert_held_once(&c_rdevs[i]->mutex.base);
3804 ret = regulator_check_consumers(c_rdevs[i],
3810 ret = regulator_check_voltage(c_rdevs[i], &tmp_min, &tmp_max);
3814 highest_min_uV = max(highest_min_uV, tmp_min);
3817 desired_min_uV = tmp_min;
3818 desired_max_uV = tmp_max;
3822 max_spread = constraints->max_spread[0];
3825 * Let target_uV be equal to the desired one if possible.
3826 * If not, set it to minimum voltage, allowed by other coupled
3829 target_uV = max(desired_min_uV, highest_min_uV - max_spread);
3832 * Find min and max voltages, which currently aren't violating
3835 for (i = 1; i < n_coupled; i++) {
3838 if (!_regulator_is_enabled(c_rdevs[i]))
3841 tmp_act = regulator_get_voltage_rdev(c_rdevs[i]);
3845 min_current_uV = min(tmp_act, min_current_uV);
3846 max_current_uV = max(tmp_act, max_current_uV);
3849 /* There aren't any other regulators enabled */
3850 if (max_current_uV == 0) {
3851 possible_uV = target_uV;
3854 * Correct target voltage, so as it currently isn't
3855 * violating max_spread
3857 possible_uV = max(target_uV, max_current_uV - max_spread);
3858 possible_uV = min(possible_uV, min_current_uV + max_spread);
3861 if (possible_uV > desired_max_uV)
3864 done = (possible_uV == target_uV);
3865 desired_min_uV = possible_uV;
3868 /* Apply max_uV_step constraint if necessary */
3869 if (state == PM_SUSPEND_ON) {
3870 ret = regulator_limit_voltage_step(rdev, current_uV,
3879 /* Set current_uV if wasn't done earlier in the code and if necessary */
3880 if (n_coupled > 1 && *current_uV == -1) {
3882 if (_regulator_is_enabled(rdev)) {
3883 ret = regulator_get_voltage_rdev(rdev);
3889 *current_uV = desired_min_uV;
3893 *min_uV = desired_min_uV;
3894 *max_uV = desired_max_uV;
3899 int regulator_do_balance_voltage(struct regulator_dev *rdev,
3900 suspend_state_t state, bool skip_coupled)
3902 struct regulator_dev **c_rdevs;
3903 struct regulator_dev *best_rdev;
3904 struct coupling_desc *c_desc = &rdev->coupling_desc;
3905 int i, ret, n_coupled, best_min_uV, best_max_uV, best_c_rdev;
3906 unsigned int delta, best_delta;
3907 unsigned long c_rdev_done = 0;
3908 bool best_c_rdev_done;
3910 c_rdevs = c_desc->coupled_rdevs;
3911 n_coupled = skip_coupled ? 1 : c_desc->n_coupled;
3914 * Find the best possible voltage change on each loop. Leave the loop
3915 * if there isn't any possible change.
3918 best_c_rdev_done = false;
3926 * Find highest difference between optimal voltage
3927 * and current voltage.
3929 for (i = 0; i < n_coupled; i++) {
3931 * optimal_uV is the best voltage that can be set for
3932 * i-th regulator at the moment without violating
3933 * max_spread constraint in order to balance
3934 * the coupled voltages.
3936 int optimal_uV = 0, optimal_max_uV = 0, current_uV = 0;
3938 if (test_bit(i, &c_rdev_done))
3941 ret = regulator_get_optimal_voltage(c_rdevs[i],
3949 delta = abs(optimal_uV - current_uV);
3951 if (delta && best_delta <= delta) {
3952 best_c_rdev_done = ret;
3954 best_rdev = c_rdevs[i];
3955 best_min_uV = optimal_uV;
3956 best_max_uV = optimal_max_uV;
3961 /* Nothing to change, return successfully */
3967 ret = regulator_set_voltage_rdev(best_rdev, best_min_uV,
3968 best_max_uV, state);
3973 if (best_c_rdev_done)
3974 set_bit(best_c_rdev, &c_rdev_done);
3976 } while (n_coupled > 1);
3982 static int regulator_balance_voltage(struct regulator_dev *rdev,
3983 suspend_state_t state)
3985 struct coupling_desc *c_desc = &rdev->coupling_desc;
3986 struct regulator_coupler *coupler = c_desc->coupler;
3987 bool skip_coupled = false;
3990 * If system is in a state other than PM_SUSPEND_ON, don't check
3991 * other coupled regulators.
3993 if (state != PM_SUSPEND_ON)
3994 skip_coupled = true;
3996 if (c_desc->n_resolved < c_desc->n_coupled) {
3997 rdev_err(rdev, "Not all coupled regulators registered\n");
4001 /* Invoke custom balancer for customized couplers */
4002 if (coupler && coupler->balance_voltage)
4003 return coupler->balance_voltage(coupler, rdev, state);
4005 return regulator_do_balance_voltage(rdev, state, skip_coupled);
4009 * regulator_set_voltage - set regulator output voltage
4010 * @regulator: regulator source
4011 * @min_uV: Minimum required voltage in uV
4012 * @max_uV: Maximum acceptable voltage in uV
4014 * Sets a voltage regulator to the desired output voltage. This can be set
4015 * during any regulator state. IOW, regulator can be disabled or enabled.
4017 * If the regulator is enabled then the voltage will change to the new value
4018 * immediately otherwise if the regulator is disabled the regulator will
4019 * output at the new voltage when enabled.
4021 * NOTE: If the regulator is shared between several devices then the lowest
4022 * request voltage that meets the system constraints will be used.
4023 * Regulator system constraints must be set for this regulator before
4024 * calling this function otherwise this call will fail.
4026 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
4028 struct ww_acquire_ctx ww_ctx;
4031 regulator_lock_dependent(regulator->rdev, &ww_ctx);
4033 ret = regulator_set_voltage_unlocked(regulator, min_uV, max_uV,
4036 regulator_unlock_dependent(regulator->rdev, &ww_ctx);
4040 EXPORT_SYMBOL_GPL(regulator_set_voltage);
4042 static inline int regulator_suspend_toggle(struct regulator_dev *rdev,
4043 suspend_state_t state, bool en)
4045 struct regulator_state *rstate;
4047 rstate = regulator_get_suspend_state(rdev, state);
4051 if (!rstate->changeable)
4054 rstate->enabled = (en) ? ENABLE_IN_SUSPEND : DISABLE_IN_SUSPEND;
4059 int regulator_suspend_enable(struct regulator_dev *rdev,
4060 suspend_state_t state)
4062 return regulator_suspend_toggle(rdev, state, true);
4064 EXPORT_SYMBOL_GPL(regulator_suspend_enable);
4066 int regulator_suspend_disable(struct regulator_dev *rdev,
4067 suspend_state_t state)
4069 struct regulator *regulator;
4070 struct regulator_voltage *voltage;
4073 * if any consumer wants this regulator device keeping on in
4074 * suspend states, don't set it as disabled.
4076 list_for_each_entry(regulator, &rdev->consumer_list, list) {
4077 voltage = ®ulator->voltage[state];
4078 if (voltage->min_uV || voltage->max_uV)
4082 return regulator_suspend_toggle(rdev, state, false);
4084 EXPORT_SYMBOL_GPL(regulator_suspend_disable);
4086 static int _regulator_set_suspend_voltage(struct regulator *regulator,
4087 int min_uV, int max_uV,
4088 suspend_state_t state)
4090 struct regulator_dev *rdev = regulator->rdev;
4091 struct regulator_state *rstate;
4093 rstate = regulator_get_suspend_state(rdev, state);
4097 if (rstate->min_uV == rstate->max_uV) {
4098 rdev_err(rdev, "The suspend voltage can't be changed!\n");
4102 return regulator_set_voltage_unlocked(regulator, min_uV, max_uV, state);
4105 int regulator_set_suspend_voltage(struct regulator *regulator, int min_uV,
4106 int max_uV, suspend_state_t state)
4108 struct ww_acquire_ctx ww_ctx;
4111 /* PM_SUSPEND_ON is handled by regulator_set_voltage() */
4112 if (regulator_check_states(state) || state == PM_SUSPEND_ON)
4115 regulator_lock_dependent(regulator->rdev, &ww_ctx);
4117 ret = _regulator_set_suspend_voltage(regulator, min_uV,
4120 regulator_unlock_dependent(regulator->rdev, &ww_ctx);
4124 EXPORT_SYMBOL_GPL(regulator_set_suspend_voltage);
4127 * regulator_set_voltage_time - get raise/fall time
4128 * @regulator: regulator source
4129 * @old_uV: starting voltage in microvolts
4130 * @new_uV: target voltage in microvolts
4132 * Provided with the starting and ending voltage, this function attempts to
4133 * calculate the time in microseconds required to rise or fall to this new
4136 int regulator_set_voltage_time(struct regulator *regulator,
4137 int old_uV, int new_uV)
4139 struct regulator_dev *rdev = regulator->rdev;
4140 const struct regulator_ops *ops = rdev->desc->ops;
4146 if (ops->set_voltage_time)
4147 return ops->set_voltage_time(rdev, old_uV, new_uV);
4148 else if (!ops->set_voltage_time_sel)
4149 return _regulator_set_voltage_time(rdev, old_uV, new_uV);
4151 /* Currently requires operations to do this */
4152 if (!ops->list_voltage || !rdev->desc->n_voltages)
4155 for (i = 0; i < rdev->desc->n_voltages; i++) {
4156 /* We only look for exact voltage matches here */
4157 if (i < rdev->desc->linear_min_sel)
4160 if (old_sel >= 0 && new_sel >= 0)
4163 voltage = regulator_list_voltage(regulator, i);
4168 if (voltage == old_uV)
4170 if (voltage == new_uV)
4174 if (old_sel < 0 || new_sel < 0)
4177 return ops->set_voltage_time_sel(rdev, old_sel, new_sel);
4179 EXPORT_SYMBOL_GPL(regulator_set_voltage_time);
4182 * regulator_set_voltage_time_sel - get raise/fall time
4183 * @rdev: regulator source device
4184 * @old_selector: selector for starting voltage
4185 * @new_selector: selector for target voltage
4187 * Provided with the starting and target voltage selectors, this function
4188 * returns time in microseconds required to rise or fall to this new voltage
4190 * Drivers providing ramp_delay in regulation_constraints can use this as their
4191 * set_voltage_time_sel() operation.
4193 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
4194 unsigned int old_selector,
4195 unsigned int new_selector)
4197 int old_volt, new_volt;
4200 if (!rdev->desc->ops->list_voltage)
4203 old_volt = rdev->desc->ops->list_voltage(rdev, old_selector);
4204 new_volt = rdev->desc->ops->list_voltage(rdev, new_selector);
4206 if (rdev->desc->ops->set_voltage_time)
4207 return rdev->desc->ops->set_voltage_time(rdev, old_volt,
4210 return _regulator_set_voltage_time(rdev, old_volt, new_volt);
4212 EXPORT_SYMBOL_GPL(regulator_set_voltage_time_sel);
4214 int regulator_sync_voltage_rdev(struct regulator_dev *rdev)
4218 regulator_lock(rdev);
4220 if (!rdev->desc->ops->set_voltage &&
4221 !rdev->desc->ops->set_voltage_sel) {
4226 /* balance only, if regulator is coupled */
4227 if (rdev->coupling_desc.n_coupled > 1)
4228 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
4233 regulator_unlock(rdev);
4238 * regulator_sync_voltage - re-apply last regulator output voltage
4239 * @regulator: regulator source
4241 * Re-apply the last configured voltage. This is intended to be used
4242 * where some external control source the consumer is cooperating with
4243 * has caused the configured voltage to change.
4245 int regulator_sync_voltage(struct regulator *regulator)
4247 struct regulator_dev *rdev = regulator->rdev;
4248 struct regulator_voltage *voltage = ®ulator->voltage[PM_SUSPEND_ON];
4249 int ret, min_uV, max_uV;
4251 regulator_lock(rdev);
4253 if (!rdev->desc->ops->set_voltage &&
4254 !rdev->desc->ops->set_voltage_sel) {
4259 /* This is only going to work if we've had a voltage configured. */
4260 if (!voltage->min_uV && !voltage->max_uV) {
4265 min_uV = voltage->min_uV;
4266 max_uV = voltage->max_uV;
4268 /* This should be a paranoia check... */
4269 ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
4273 ret = regulator_check_consumers(rdev, &min_uV, &max_uV, 0);
4277 /* balance only, if regulator is coupled */
4278 if (rdev->coupling_desc.n_coupled > 1)
4279 ret = regulator_balance_voltage(rdev, PM_SUSPEND_ON);
4281 ret = _regulator_do_set_voltage(rdev, min_uV, max_uV);
4284 regulator_unlock(rdev);
4287 EXPORT_SYMBOL_GPL(regulator_sync_voltage);
4289 int regulator_get_voltage_rdev(struct regulator_dev *rdev)
4294 if (rdev->desc->ops->get_bypass) {
4295 ret = rdev->desc->ops->get_bypass(rdev, &bypassed);
4299 /* if bypassed the regulator must have a supply */
4300 if (!rdev->supply) {
4302 "bypassed regulator has no supply!\n");
4303 return -EPROBE_DEFER;
4306 return regulator_get_voltage_rdev(rdev->supply->rdev);
4310 if (rdev->desc->ops->get_voltage_sel) {
4311 sel = rdev->desc->ops->get_voltage_sel(rdev);
4314 ret = rdev->desc->ops->list_voltage(rdev, sel);
4315 } else if (rdev->desc->ops->get_voltage) {
4316 ret = rdev->desc->ops->get_voltage(rdev);
4317 } else if (rdev->desc->ops->list_voltage) {
4318 ret = rdev->desc->ops->list_voltage(rdev, 0);
4319 } else if (rdev->desc->fixed_uV && (rdev->desc->n_voltages == 1)) {
4320 ret = rdev->desc->fixed_uV;
4321 } else if (rdev->supply) {
4322 ret = regulator_get_voltage_rdev(rdev->supply->rdev);
4323 } else if (rdev->supply_name) {
4324 return -EPROBE_DEFER;
4331 return ret - rdev->constraints->uV_offset;
4333 EXPORT_SYMBOL_GPL(regulator_get_voltage_rdev);
4336 * regulator_get_voltage - get regulator output voltage
4337 * @regulator: regulator source
4339 * This returns the current regulator voltage in uV.
4341 * NOTE: If the regulator is disabled it will return the voltage value. This
4342 * function should not be used to determine regulator state.
4344 int regulator_get_voltage(struct regulator *regulator)
4346 struct ww_acquire_ctx ww_ctx;
4349 regulator_lock_dependent(regulator->rdev, &ww_ctx);
4350 ret = regulator_get_voltage_rdev(regulator->rdev);
4351 regulator_unlock_dependent(regulator->rdev, &ww_ctx);
4355 EXPORT_SYMBOL_GPL(regulator_get_voltage);
4358 * regulator_set_current_limit - set regulator output current limit
4359 * @regulator: regulator source
4360 * @min_uA: Minimum supported current in uA
4361 * @max_uA: Maximum supported current in uA
4363 * Sets current sink to the desired output current. This can be set during
4364 * any regulator state. IOW, regulator can be disabled or enabled.
4366 * If the regulator is enabled then the current will change to the new value
4367 * immediately otherwise if the regulator is disabled the regulator will
4368 * output at the new current when enabled.
4370 * NOTE: Regulator system constraints must be set for this regulator before
4371 * calling this function otherwise this call will fail.
4373 int regulator_set_current_limit(struct regulator *regulator,
4374 int min_uA, int max_uA)
4376 struct regulator_dev *rdev = regulator->rdev;
4379 regulator_lock(rdev);
4382 if (!rdev->desc->ops->set_current_limit) {
4387 /* constraints check */
4388 ret = regulator_check_current_limit(rdev, &min_uA, &max_uA);
4392 ret = rdev->desc->ops->set_current_limit(rdev, min_uA, max_uA);
4394 regulator_unlock(rdev);
4397 EXPORT_SYMBOL_GPL(regulator_set_current_limit);
4399 static int _regulator_get_current_limit_unlocked(struct regulator_dev *rdev)
4402 if (!rdev->desc->ops->get_current_limit)
4405 return rdev->desc->ops->get_current_limit(rdev);
4408 static int _regulator_get_current_limit(struct regulator_dev *rdev)
4412 regulator_lock(rdev);
4413 ret = _regulator_get_current_limit_unlocked(rdev);
4414 regulator_unlock(rdev);
4420 * regulator_get_current_limit - get regulator output current
4421 * @regulator: regulator source
4423 * This returns the current supplied by the specified current sink in uA.
4425 * NOTE: If the regulator is disabled it will return the current value. This
4426 * function should not be used to determine regulator state.
4428 int regulator_get_current_limit(struct regulator *regulator)
4430 return _regulator_get_current_limit(regulator->rdev);
4432 EXPORT_SYMBOL_GPL(regulator_get_current_limit);
4435 * regulator_set_mode - set regulator operating mode
4436 * @regulator: regulator source
4437 * @mode: operating mode - one of the REGULATOR_MODE constants
4439 * Set regulator operating mode to increase regulator efficiency or improve
4440 * regulation performance.
4442 * NOTE: Regulator system constraints must be set for this regulator before
4443 * calling this function otherwise this call will fail.
4445 int regulator_set_mode(struct regulator *regulator, unsigned int mode)
4447 struct regulator_dev *rdev = regulator->rdev;
4449 int regulator_curr_mode;
4451 regulator_lock(rdev);
4454 if (!rdev->desc->ops->set_mode) {
4459 /* return if the same mode is requested */
4460 if (rdev->desc->ops->get_mode) {
4461 regulator_curr_mode = rdev->desc->ops->get_mode(rdev);
4462 if (regulator_curr_mode == mode) {
4468 /* constraints check */
4469 ret = regulator_mode_constrain(rdev, &mode);
4473 ret = rdev->desc->ops->set_mode(rdev, mode);
4475 regulator_unlock(rdev);
4478 EXPORT_SYMBOL_GPL(regulator_set_mode);
4480 static unsigned int _regulator_get_mode_unlocked(struct regulator_dev *rdev)
4483 if (!rdev->desc->ops->get_mode)
4486 return rdev->desc->ops->get_mode(rdev);
4489 static unsigned int _regulator_get_mode(struct regulator_dev *rdev)
4493 regulator_lock(rdev);
4494 ret = _regulator_get_mode_unlocked(rdev);
4495 regulator_unlock(rdev);
4501 * regulator_get_mode - get regulator operating mode
4502 * @regulator: regulator source
4504 * Get the current regulator operating mode.
4506 unsigned int regulator_get_mode(struct regulator *regulator)
4508 return _regulator_get_mode(regulator->rdev);
4510 EXPORT_SYMBOL_GPL(regulator_get_mode);
4512 static int rdev_get_cached_err_flags(struct regulator_dev *rdev)
4516 if (rdev->use_cached_err) {
4517 spin_lock(&rdev->err_lock);
4518 ret = rdev->cached_err;
4519 spin_unlock(&rdev->err_lock);
4524 static int _regulator_get_error_flags(struct regulator_dev *rdev,
4525 unsigned int *flags)
4527 int cached_flags, ret = 0;
4529 regulator_lock(rdev);
4531 cached_flags = rdev_get_cached_err_flags(rdev);
4533 if (rdev->desc->ops->get_error_flags)
4534 ret = rdev->desc->ops->get_error_flags(rdev, flags);
4535 else if (!rdev->use_cached_err)
4538 *flags |= cached_flags;
4540 regulator_unlock(rdev);
4546 * regulator_get_error_flags - get regulator error information
4547 * @regulator: regulator source
4548 * @flags: pointer to store error flags
4550 * Get the current regulator error information.
4552 int regulator_get_error_flags(struct regulator *regulator,
4553 unsigned int *flags)
4555 return _regulator_get_error_flags(regulator->rdev, flags);
4557 EXPORT_SYMBOL_GPL(regulator_get_error_flags);
4560 * regulator_set_load - set regulator load
4561 * @regulator: regulator source
4562 * @uA_load: load current
4564 * Notifies the regulator core of a new device load. This is then used by
4565 * DRMS (if enabled by constraints) to set the most efficient regulator
4566 * operating mode for the new regulator loading.
4568 * Consumer devices notify their supply regulator of the maximum power
4569 * they will require (can be taken from device datasheet in the power
4570 * consumption tables) when they change operational status and hence power
4571 * state. Examples of operational state changes that can affect power
4572 * consumption are :-
4574 * o Device is opened / closed.
4575 * o Device I/O is about to begin or has just finished.
4576 * o Device is idling in between work.
4578 * This information is also exported via sysfs to userspace.
4580 * DRMS will sum the total requested load on the regulator and change
4581 * to the most efficient operating mode if platform constraints allow.
4583 * NOTE: when a regulator consumer requests to have a regulator
4584 * disabled then any load that consumer requested no longer counts
4585 * toward the total requested load. If the regulator is re-enabled
4586 * then the previously requested load will start counting again.
4588 * If a regulator is an always-on regulator then an individual consumer's
4589 * load will still be removed if that consumer is fully disabled.
4591 * On error a negative errno is returned.
4593 int regulator_set_load(struct regulator *regulator, int uA_load)
4595 struct regulator_dev *rdev = regulator->rdev;
4599 regulator_lock(rdev);
4600 old_uA_load = regulator->uA_load;
4601 regulator->uA_load = uA_load;
4602 if (regulator->enable_count && old_uA_load != uA_load) {
4603 ret = drms_uA_update(rdev);
4605 regulator->uA_load = old_uA_load;
4607 regulator_unlock(rdev);
4611 EXPORT_SYMBOL_GPL(regulator_set_load);
4614 * regulator_allow_bypass - allow the regulator to go into bypass mode
4616 * @regulator: Regulator to configure
4617 * @enable: enable or disable bypass mode
4619 * Allow the regulator to go into bypass mode if all other consumers
4620 * for the regulator also enable bypass mode and the machine
4621 * constraints allow this. Bypass mode means that the regulator is
4622 * simply passing the input directly to the output with no regulation.
4624 int regulator_allow_bypass(struct regulator *regulator, bool enable)
4626 struct regulator_dev *rdev = regulator->rdev;
4627 const char *name = rdev_get_name(rdev);
4630 if (!rdev->desc->ops->set_bypass)
4633 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_BYPASS))
4636 regulator_lock(rdev);
4638 if (enable && !regulator->bypass) {
4639 rdev->bypass_count++;
4641 if (rdev->bypass_count == rdev->open_count) {
4642 trace_regulator_bypass_enable(name);
4644 ret = rdev->desc->ops->set_bypass(rdev, enable);
4646 rdev->bypass_count--;
4648 trace_regulator_bypass_enable_complete(name);
4651 } else if (!enable && regulator->bypass) {
4652 rdev->bypass_count--;
4654 if (rdev->bypass_count != rdev->open_count) {
4655 trace_regulator_bypass_disable(name);
4657 ret = rdev->desc->ops->set_bypass(rdev, enable);
4659 rdev->bypass_count++;
4661 trace_regulator_bypass_disable_complete(name);
4666 regulator->bypass = enable;
4668 regulator_unlock(rdev);
4672 EXPORT_SYMBOL_GPL(regulator_allow_bypass);
4675 * regulator_register_notifier - register regulator event notifier
4676 * @regulator: regulator source
4677 * @nb: notifier block
4679 * Register notifier block to receive regulator events.
4681 int regulator_register_notifier(struct regulator *regulator,
4682 struct notifier_block *nb)
4684 return blocking_notifier_chain_register(®ulator->rdev->notifier,
4687 EXPORT_SYMBOL_GPL(regulator_register_notifier);
4690 * regulator_unregister_notifier - unregister regulator event notifier
4691 * @regulator: regulator source
4692 * @nb: notifier block
4694 * Unregister regulator event notifier block.
4696 int regulator_unregister_notifier(struct regulator *regulator,
4697 struct notifier_block *nb)
4699 return blocking_notifier_chain_unregister(®ulator->rdev->notifier,
4702 EXPORT_SYMBOL_GPL(regulator_unregister_notifier);
4704 /* notify regulator consumers and downstream regulator consumers.
4705 * Note mutex must be held by caller.
4707 static int _notifier_call_chain(struct regulator_dev *rdev,
4708 unsigned long event, void *data)
4710 /* call rdev chain first */
4711 return blocking_notifier_call_chain(&rdev->notifier, event, data);
4715 * regulator_bulk_get - get multiple regulator consumers
4717 * @dev: Device to supply
4718 * @num_consumers: Number of consumers to register
4719 * @consumers: Configuration of consumers; clients are stored here.
4721 * @return 0 on success, an errno on failure.
4723 * This helper function allows drivers to get several regulator
4724 * consumers in one operation. If any of the regulators cannot be
4725 * acquired then any regulators that were allocated will be freed
4726 * before returning to the caller.
4728 int regulator_bulk_get(struct device *dev, int num_consumers,
4729 struct regulator_bulk_data *consumers)
4734 for (i = 0; i < num_consumers; i++)
4735 consumers[i].consumer = NULL;
4737 for (i = 0; i < num_consumers; i++) {
4738 consumers[i].consumer = regulator_get(dev,
4739 consumers[i].supply);
4740 if (IS_ERR(consumers[i].consumer)) {
4741 ret = PTR_ERR(consumers[i].consumer);
4742 consumers[i].consumer = NULL;
4750 if (ret != -EPROBE_DEFER)
4751 dev_err(dev, "Failed to get supply '%s': %pe\n",
4752 consumers[i].supply, ERR_PTR(ret));
4754 dev_dbg(dev, "Failed to get supply '%s', deferring\n",
4755 consumers[i].supply);
4758 regulator_put(consumers[i].consumer);
4762 EXPORT_SYMBOL_GPL(regulator_bulk_get);
4764 static void regulator_bulk_enable_async(void *data, async_cookie_t cookie)
4766 struct regulator_bulk_data *bulk = data;
4768 bulk->ret = regulator_enable(bulk->consumer);
4772 * regulator_bulk_enable - enable multiple regulator consumers
4774 * @num_consumers: Number of consumers
4775 * @consumers: Consumer data; clients are stored here.
4776 * @return 0 on success, an errno on failure
4778 * This convenience API allows consumers to enable multiple regulator
4779 * clients in a single API call. If any consumers cannot be enabled
4780 * then any others that were enabled will be disabled again prior to
4783 int regulator_bulk_enable(int num_consumers,
4784 struct regulator_bulk_data *consumers)
4786 ASYNC_DOMAIN_EXCLUSIVE(async_domain);
4790 for (i = 0; i < num_consumers; i++) {
4791 async_schedule_domain(regulator_bulk_enable_async,
4792 &consumers[i], &async_domain);
4795 async_synchronize_full_domain(&async_domain);
4797 /* If any consumer failed we need to unwind any that succeeded */
4798 for (i = 0; i < num_consumers; i++) {
4799 if (consumers[i].ret != 0) {
4800 ret = consumers[i].ret;
4808 for (i = 0; i < num_consumers; i++) {
4809 if (consumers[i].ret < 0)
4810 pr_err("Failed to enable %s: %pe\n", consumers[i].supply,
4811 ERR_PTR(consumers[i].ret));
4813 regulator_disable(consumers[i].consumer);
4818 EXPORT_SYMBOL_GPL(regulator_bulk_enable);
4821 * regulator_bulk_disable - disable multiple regulator consumers
4823 * @num_consumers: Number of consumers
4824 * @consumers: Consumer data; clients are stored here.
4825 * @return 0 on success, an errno on failure
4827 * This convenience API allows consumers to disable multiple regulator
4828 * clients in a single API call. If any consumers cannot be disabled
4829 * then any others that were disabled will be enabled again prior to
4832 int regulator_bulk_disable(int num_consumers,
4833 struct regulator_bulk_data *consumers)
4838 for (i = num_consumers - 1; i >= 0; --i) {
4839 ret = regulator_disable(consumers[i].consumer);
4847 pr_err("Failed to disable %s: %pe\n", consumers[i].supply, ERR_PTR(ret));
4848 for (++i; i < num_consumers; ++i) {
4849 r = regulator_enable(consumers[i].consumer);
4851 pr_err("Failed to re-enable %s: %pe\n",
4852 consumers[i].supply, ERR_PTR(r));
4857 EXPORT_SYMBOL_GPL(regulator_bulk_disable);
4860 * regulator_bulk_force_disable - force disable multiple regulator consumers
4862 * @num_consumers: Number of consumers
4863 * @consumers: Consumer data; clients are stored here.
4864 * @return 0 on success, an errno on failure
4866 * This convenience API allows consumers to forcibly disable multiple regulator
4867 * clients in a single API call.
4868 * NOTE: This should be used for situations when device damage will
4869 * likely occur if the regulators are not disabled (e.g. over temp).
4870 * Although regulator_force_disable function call for some consumers can
4871 * return error numbers, the function is called for all consumers.
4873 int regulator_bulk_force_disable(int num_consumers,
4874 struct regulator_bulk_data *consumers)
4879 for (i = 0; i < num_consumers; i++) {
4881 regulator_force_disable(consumers[i].consumer);
4883 /* Store first error for reporting */
4884 if (consumers[i].ret && !ret)
4885 ret = consumers[i].ret;
4890 EXPORT_SYMBOL_GPL(regulator_bulk_force_disable);
4893 * regulator_bulk_free - free multiple regulator consumers
4895 * @num_consumers: Number of consumers
4896 * @consumers: Consumer data; clients are stored here.
4898 * This convenience API allows consumers to free multiple regulator
4899 * clients in a single API call.
4901 void regulator_bulk_free(int num_consumers,
4902 struct regulator_bulk_data *consumers)
4906 for (i = 0; i < num_consumers; i++) {
4907 regulator_put(consumers[i].consumer);
4908 consumers[i].consumer = NULL;
4911 EXPORT_SYMBOL_GPL(regulator_bulk_free);
4914 * regulator_notifier_call_chain - call regulator event notifier
4915 * @rdev: regulator source
4916 * @event: notifier block
4917 * @data: callback-specific data.
4919 * Called by regulator drivers to notify clients a regulator event has
4922 int regulator_notifier_call_chain(struct regulator_dev *rdev,
4923 unsigned long event, void *data)
4925 _notifier_call_chain(rdev, event, data);
4929 EXPORT_SYMBOL_GPL(regulator_notifier_call_chain);
4932 * regulator_mode_to_status - convert a regulator mode into a status
4934 * @mode: Mode to convert
4936 * Convert a regulator mode into a status.
4938 int regulator_mode_to_status(unsigned int mode)
4941 case REGULATOR_MODE_FAST:
4942 return REGULATOR_STATUS_FAST;
4943 case REGULATOR_MODE_NORMAL:
4944 return REGULATOR_STATUS_NORMAL;
4945 case REGULATOR_MODE_IDLE:
4946 return REGULATOR_STATUS_IDLE;
4947 case REGULATOR_MODE_STANDBY:
4948 return REGULATOR_STATUS_STANDBY;
4950 return REGULATOR_STATUS_UNDEFINED;
4953 EXPORT_SYMBOL_GPL(regulator_mode_to_status);
4955 static struct attribute *regulator_dev_attrs[] = {
4956 &dev_attr_name.attr,
4957 &dev_attr_num_users.attr,
4958 &dev_attr_type.attr,
4959 &dev_attr_microvolts.attr,
4960 &dev_attr_microamps.attr,
4961 &dev_attr_opmode.attr,
4962 &dev_attr_state.attr,
4963 &dev_attr_status.attr,
4964 &dev_attr_bypass.attr,
4965 &dev_attr_requested_microamps.attr,
4966 &dev_attr_min_microvolts.attr,
4967 &dev_attr_max_microvolts.attr,
4968 &dev_attr_min_microamps.attr,
4969 &dev_attr_max_microamps.attr,
4970 &dev_attr_suspend_standby_state.attr,
4971 &dev_attr_suspend_mem_state.attr,
4972 &dev_attr_suspend_disk_state.attr,
4973 &dev_attr_suspend_standby_microvolts.attr,
4974 &dev_attr_suspend_mem_microvolts.attr,
4975 &dev_attr_suspend_disk_microvolts.attr,
4976 &dev_attr_suspend_standby_mode.attr,
4977 &dev_attr_suspend_mem_mode.attr,
4978 &dev_attr_suspend_disk_mode.attr,
4983 * To avoid cluttering sysfs (and memory) with useless state, only
4984 * create attributes that can be meaningfully displayed.
4986 static umode_t regulator_attr_is_visible(struct kobject *kobj,
4987 struct attribute *attr, int idx)
4989 struct device *dev = kobj_to_dev(kobj);
4990 struct regulator_dev *rdev = dev_to_rdev(dev);
4991 const struct regulator_ops *ops = rdev->desc->ops;
4992 umode_t mode = attr->mode;
4994 /* these three are always present */
4995 if (attr == &dev_attr_name.attr ||
4996 attr == &dev_attr_num_users.attr ||
4997 attr == &dev_attr_type.attr)
5000 /* some attributes need specific methods to be displayed */
5001 if (attr == &dev_attr_microvolts.attr) {
5002 if ((ops->get_voltage && ops->get_voltage(rdev) >= 0) ||
5003 (ops->get_voltage_sel && ops->get_voltage_sel(rdev) >= 0) ||
5004 (ops->list_voltage && ops->list_voltage(rdev, 0) >= 0) ||
5005 (rdev->desc->fixed_uV && rdev->desc->n_voltages == 1))
5010 if (attr == &dev_attr_microamps.attr)
5011 return ops->get_current_limit ? mode : 0;
5013 if (attr == &dev_attr_opmode.attr)
5014 return ops->get_mode ? mode : 0;
5016 if (attr == &dev_attr_state.attr)
5017 return (rdev->ena_pin || ops->is_enabled) ? mode : 0;
5019 if (attr == &dev_attr_status.attr)
5020 return ops->get_status ? mode : 0;
5022 if (attr == &dev_attr_bypass.attr)
5023 return ops->get_bypass ? mode : 0;
5025 /* constraints need specific supporting methods */
5026 if (attr == &dev_attr_min_microvolts.attr ||
5027 attr == &dev_attr_max_microvolts.attr)
5028 return (ops->set_voltage || ops->set_voltage_sel) ? mode : 0;
5030 if (attr == &dev_attr_min_microamps.attr ||
5031 attr == &dev_attr_max_microamps.attr)
5032 return ops->set_current_limit ? mode : 0;
5034 if (attr == &dev_attr_suspend_standby_state.attr ||
5035 attr == &dev_attr_suspend_mem_state.attr ||
5036 attr == &dev_attr_suspend_disk_state.attr)
5039 if (attr == &dev_attr_suspend_standby_microvolts.attr ||
5040 attr == &dev_attr_suspend_mem_microvolts.attr ||
5041 attr == &dev_attr_suspend_disk_microvolts.attr)
5042 return ops->set_suspend_voltage ? mode : 0;
5044 if (attr == &dev_attr_suspend_standby_mode.attr ||
5045 attr == &dev_attr_suspend_mem_mode.attr ||
5046 attr == &dev_attr_suspend_disk_mode.attr)
5047 return ops->set_suspend_mode ? mode : 0;
5052 static const struct attribute_group regulator_dev_group = {
5053 .attrs = regulator_dev_attrs,
5054 .is_visible = regulator_attr_is_visible,
5057 static const struct attribute_group *regulator_dev_groups[] = {
5058 ®ulator_dev_group,
5062 static void regulator_dev_release(struct device *dev)
5064 struct regulator_dev *rdev = dev_get_drvdata(dev);
5066 kfree(rdev->constraints);
5067 of_node_put(rdev->dev.of_node);
5071 static void rdev_init_debugfs(struct regulator_dev *rdev)
5073 struct device *parent = rdev->dev.parent;
5074 const char *rname = rdev_get_name(rdev);
5075 char name[NAME_MAX];
5077 /* Avoid duplicate debugfs directory names */
5078 if (parent && rname == rdev->desc->name) {
5079 snprintf(name, sizeof(name), "%s-%s", dev_name(parent),
5084 rdev->debugfs = debugfs_create_dir(rname, debugfs_root);
5085 if (!rdev->debugfs) {
5086 rdev_warn(rdev, "Failed to create debugfs directory\n");
5090 debugfs_create_u32("use_count", 0444, rdev->debugfs,
5092 debugfs_create_u32("open_count", 0444, rdev->debugfs,
5094 debugfs_create_u32("bypass_count", 0444, rdev->debugfs,
5095 &rdev->bypass_count);
5098 static int regulator_register_resolve_supply(struct device *dev, void *data)
5100 struct regulator_dev *rdev = dev_to_rdev(dev);
5102 if (regulator_resolve_supply(rdev))
5103 rdev_dbg(rdev, "unable to resolve supply\n");
5108 int regulator_coupler_register(struct regulator_coupler *coupler)
5110 mutex_lock(®ulator_list_mutex);
5111 list_add_tail(&coupler->list, ®ulator_coupler_list);
5112 mutex_unlock(®ulator_list_mutex);
5117 static struct regulator_coupler *
5118 regulator_find_coupler(struct regulator_dev *rdev)
5120 struct regulator_coupler *coupler;
5124 * Note that regulators are appended to the list and the generic
5125 * coupler is registered first, hence it will be attached at last
5128 list_for_each_entry_reverse(coupler, ®ulator_coupler_list, list) {
5129 err = coupler->attach_regulator(coupler, rdev);
5131 if (!coupler->balance_voltage &&
5132 rdev->coupling_desc.n_coupled > 2)
5133 goto err_unsupported;
5139 return ERR_PTR(err);
5147 return ERR_PTR(-EINVAL);
5150 if (coupler->detach_regulator)
5151 coupler->detach_regulator(coupler, rdev);
5154 "Voltage balancing for multiple regulator couples is unimplemented\n");
5156 return ERR_PTR(-EPERM);
5159 static void regulator_resolve_coupling(struct regulator_dev *rdev)
5161 struct regulator_coupler *coupler = rdev->coupling_desc.coupler;
5162 struct coupling_desc *c_desc = &rdev->coupling_desc;
5163 int n_coupled = c_desc->n_coupled;
5164 struct regulator_dev *c_rdev;
5167 for (i = 1; i < n_coupled; i++) {
5168 /* already resolved */
5169 if (c_desc->coupled_rdevs[i])
5172 c_rdev = of_parse_coupled_regulator(rdev, i - 1);
5177 if (c_rdev->coupling_desc.coupler != coupler) {
5178 rdev_err(rdev, "coupler mismatch with %s\n",
5179 rdev_get_name(c_rdev));
5183 c_desc->coupled_rdevs[i] = c_rdev;
5184 c_desc->n_resolved++;
5186 regulator_resolve_coupling(c_rdev);
5190 static void regulator_remove_coupling(struct regulator_dev *rdev)
5192 struct regulator_coupler *coupler = rdev->coupling_desc.coupler;
5193 struct coupling_desc *__c_desc, *c_desc = &rdev->coupling_desc;
5194 struct regulator_dev *__c_rdev, *c_rdev;
5195 unsigned int __n_coupled, n_coupled;
5199 n_coupled = c_desc->n_coupled;
5201 for (i = 1; i < n_coupled; i++) {
5202 c_rdev = c_desc->coupled_rdevs[i];
5207 regulator_lock(c_rdev);
5209 __c_desc = &c_rdev->coupling_desc;
5210 __n_coupled = __c_desc->n_coupled;
5212 for (k = 1; k < __n_coupled; k++) {
5213 __c_rdev = __c_desc->coupled_rdevs[k];
5215 if (__c_rdev == rdev) {
5216 __c_desc->coupled_rdevs[k] = NULL;
5217 __c_desc->n_resolved--;
5222 regulator_unlock(c_rdev);
5224 c_desc->coupled_rdevs[i] = NULL;
5225 c_desc->n_resolved--;
5228 if (coupler && coupler->detach_regulator) {
5229 err = coupler->detach_regulator(coupler, rdev);
5231 rdev_err(rdev, "failed to detach from coupler: %pe\n",
5235 kfree(rdev->coupling_desc.coupled_rdevs);
5236 rdev->coupling_desc.coupled_rdevs = NULL;
5239 static int regulator_init_coupling(struct regulator_dev *rdev)
5241 struct regulator_dev **coupled;
5242 int err, n_phandles;
5244 if (!IS_ENABLED(CONFIG_OF))
5247 n_phandles = of_get_n_coupled(rdev);
5249 coupled = kcalloc(n_phandles + 1, sizeof(*coupled), GFP_KERNEL);
5253 rdev->coupling_desc.coupled_rdevs = coupled;
5256 * Every regulator should always have coupling descriptor filled with
5257 * at least pointer to itself.
5259 rdev->coupling_desc.coupled_rdevs[0] = rdev;
5260 rdev->coupling_desc.n_coupled = n_phandles + 1;
5261 rdev->coupling_desc.n_resolved++;
5263 /* regulator isn't coupled */
5264 if (n_phandles == 0)
5267 if (!of_check_coupling_data(rdev))
5270 mutex_lock(®ulator_list_mutex);
5271 rdev->coupling_desc.coupler = regulator_find_coupler(rdev);
5272 mutex_unlock(®ulator_list_mutex);
5274 if (IS_ERR(rdev->coupling_desc.coupler)) {
5275 err = PTR_ERR(rdev->coupling_desc.coupler);
5276 rdev_err(rdev, "failed to get coupler: %pe\n", ERR_PTR(err));
5283 static int generic_coupler_attach(struct regulator_coupler *coupler,
5284 struct regulator_dev *rdev)
5286 if (rdev->coupling_desc.n_coupled > 2) {
5288 "Voltage balancing for multiple regulator couples is unimplemented\n");
5292 if (!rdev->constraints->always_on) {
5294 "Coupling of a non always-on regulator is unimplemented\n");
5301 static struct regulator_coupler generic_regulator_coupler = {
5302 .attach_regulator = generic_coupler_attach,
5306 * regulator_register - register regulator
5307 * @regulator_desc: regulator to register
5308 * @cfg: runtime configuration for regulator
5310 * Called by regulator drivers to register a regulator.
5311 * Returns a valid pointer to struct regulator_dev on success
5312 * or an ERR_PTR() on error.
5314 struct regulator_dev *
5315 regulator_register(const struct regulator_desc *regulator_desc,
5316 const struct regulator_config *cfg)
5318 const struct regulator_init_data *init_data;
5319 struct regulator_config *config = NULL;
5320 static atomic_t regulator_no = ATOMIC_INIT(-1);
5321 struct regulator_dev *rdev;
5322 bool dangling_cfg_gpiod = false;
5323 bool dangling_of_gpiod = false;
5328 return ERR_PTR(-EINVAL);
5330 dangling_cfg_gpiod = true;
5331 if (regulator_desc == NULL) {
5339 if (regulator_desc->name == NULL || regulator_desc->ops == NULL) {
5344 if (regulator_desc->type != REGULATOR_VOLTAGE &&
5345 regulator_desc->type != REGULATOR_CURRENT) {
5350 /* Only one of each should be implemented */
5351 WARN_ON(regulator_desc->ops->get_voltage &&
5352 regulator_desc->ops->get_voltage_sel);
5353 WARN_ON(regulator_desc->ops->set_voltage &&
5354 regulator_desc->ops->set_voltage_sel);
5356 /* If we're using selectors we must implement list_voltage. */
5357 if (regulator_desc->ops->get_voltage_sel &&
5358 !regulator_desc->ops->list_voltage) {
5362 if (regulator_desc->ops->set_voltage_sel &&
5363 !regulator_desc->ops->list_voltage) {
5368 rdev = kzalloc(sizeof(struct regulator_dev), GFP_KERNEL);
5373 device_initialize(&rdev->dev);
5374 spin_lock_init(&rdev->err_lock);
5377 * Duplicate the config so the driver could override it after
5378 * parsing init data.
5380 config = kmemdup(cfg, sizeof(*cfg), GFP_KERNEL);
5381 if (config == NULL) {
5386 init_data = regulator_of_get_init_data(dev, regulator_desc, config,
5387 &rdev->dev.of_node);
5390 * Sometimes not all resources are probed already so we need to take
5391 * that into account. This happens most the time if the ena_gpiod comes
5392 * from a gpio extender or something else.
5394 if (PTR_ERR(init_data) == -EPROBE_DEFER) {
5395 ret = -EPROBE_DEFER;
5400 * We need to keep track of any GPIO descriptor coming from the
5401 * device tree until we have handled it over to the core. If the
5402 * config that was passed in to this function DOES NOT contain
5403 * a descriptor, and the config after this call DOES contain
5404 * a descriptor, we definitely got one from parsing the device
5407 if (!cfg->ena_gpiod && config->ena_gpiod)
5408 dangling_of_gpiod = true;
5410 init_data = config->init_data;
5411 rdev->dev.of_node = of_node_get(config->of_node);
5414 ww_mutex_init(&rdev->mutex, ®ulator_ww_class);
5415 rdev->reg_data = config->driver_data;
5416 rdev->owner = regulator_desc->owner;
5417 rdev->desc = regulator_desc;
5419 rdev->regmap = config->regmap;
5420 else if (dev_get_regmap(dev, NULL))
5421 rdev->regmap = dev_get_regmap(dev, NULL);
5422 else if (dev->parent)
5423 rdev->regmap = dev_get_regmap(dev->parent, NULL);
5424 INIT_LIST_HEAD(&rdev->consumer_list);
5425 INIT_LIST_HEAD(&rdev->list);
5426 BLOCKING_INIT_NOTIFIER_HEAD(&rdev->notifier);
5427 INIT_DELAYED_WORK(&rdev->disable_work, regulator_disable_work);
5429 /* preform any regulator specific init */
5430 if (init_data && init_data->regulator_init) {
5431 ret = init_data->regulator_init(rdev->reg_data);
5436 if (config->ena_gpiod) {
5437 ret = regulator_ena_gpio_request(rdev, config);
5439 rdev_err(rdev, "Failed to request enable GPIO: %pe\n",
5443 /* The regulator core took over the GPIO descriptor */
5444 dangling_cfg_gpiod = false;
5445 dangling_of_gpiod = false;
5448 /* register with sysfs */
5449 rdev->dev.class = ®ulator_class;
5450 rdev->dev.parent = dev;
5451 dev_set_name(&rdev->dev, "regulator.%lu",
5452 (unsigned long) atomic_inc_return(®ulator_no));
5453 dev_set_drvdata(&rdev->dev, rdev);
5455 /* set regulator constraints */
5457 rdev->constraints = kmemdup(&init_data->constraints,
5458 sizeof(*rdev->constraints),
5461 rdev->constraints = kzalloc(sizeof(*rdev->constraints),
5463 if (!rdev->constraints) {
5468 if (init_data && init_data->supply_regulator)
5469 rdev->supply_name = init_data->supply_regulator;
5470 else if (regulator_desc->supply_name)
5471 rdev->supply_name = regulator_desc->supply_name;
5473 ret = set_machine_constraints(rdev);
5474 if (ret == -EPROBE_DEFER) {
5475 /* Regulator might be in bypass mode and so needs its supply
5476 * to set the constraints
5478 /* FIXME: this currently triggers a chicken-and-egg problem
5479 * when creating -SUPPLY symlink in sysfs to a regulator
5480 * that is just being created
5482 rdev_dbg(rdev, "will resolve supply early: %s\n",
5484 ret = regulator_resolve_supply(rdev);
5486 ret = set_machine_constraints(rdev);
5488 rdev_dbg(rdev, "unable to resolve supply early: %pe\n",
5494 ret = regulator_init_coupling(rdev);
5498 /* add consumers devices */
5500 for (i = 0; i < init_data->num_consumer_supplies; i++) {
5501 ret = set_consumer_device_supply(rdev,
5502 init_data->consumer_supplies[i].dev_name,
5503 init_data->consumer_supplies[i].supply);
5505 dev_err(dev, "Failed to set supply %s\n",
5506 init_data->consumer_supplies[i].supply);
5507 goto unset_supplies;
5512 if (!rdev->desc->ops->get_voltage &&
5513 !rdev->desc->ops->list_voltage &&
5514 !rdev->desc->fixed_uV)
5515 rdev->is_switch = true;
5517 ret = device_add(&rdev->dev);
5519 goto unset_supplies;
5521 rdev_init_debugfs(rdev);
5523 /* try to resolve regulators coupling since a new one was registered */
5524 mutex_lock(®ulator_list_mutex);
5525 regulator_resolve_coupling(rdev);
5526 mutex_unlock(®ulator_list_mutex);
5528 /* try to resolve regulators supply since a new one was registered */
5529 class_for_each_device(®ulator_class, NULL, NULL,
5530 regulator_register_resolve_supply);
5535 mutex_lock(®ulator_list_mutex);
5536 unset_regulator_supplies(rdev);
5537 regulator_remove_coupling(rdev);
5538 mutex_unlock(®ulator_list_mutex);
5540 kfree(rdev->coupling_desc.coupled_rdevs);
5541 mutex_lock(®ulator_list_mutex);
5542 regulator_ena_gpio_free(rdev);
5543 mutex_unlock(®ulator_list_mutex);
5545 if (dangling_of_gpiod)
5546 gpiod_put(config->ena_gpiod);
5548 put_device(&rdev->dev);
5550 if (dangling_cfg_gpiod)
5551 gpiod_put(cfg->ena_gpiod);
5552 return ERR_PTR(ret);
5554 EXPORT_SYMBOL_GPL(regulator_register);
5557 * regulator_unregister - unregister regulator
5558 * @rdev: regulator to unregister
5560 * Called by regulator drivers to unregister a regulator.
5562 void regulator_unregister(struct regulator_dev *rdev)
5568 while (rdev->use_count--)
5569 regulator_disable(rdev->supply);
5570 regulator_put(rdev->supply);
5573 flush_work(&rdev->disable_work.work);
5575 mutex_lock(®ulator_list_mutex);
5577 debugfs_remove_recursive(rdev->debugfs);
5578 WARN_ON(rdev->open_count);
5579 regulator_remove_coupling(rdev);
5580 unset_regulator_supplies(rdev);
5581 list_del(&rdev->list);
5582 regulator_ena_gpio_free(rdev);
5583 device_unregister(&rdev->dev);
5585 mutex_unlock(®ulator_list_mutex);
5587 EXPORT_SYMBOL_GPL(regulator_unregister);
5589 #ifdef CONFIG_SUSPEND
5591 * regulator_suspend - prepare regulators for system wide suspend
5592 * @dev: ``&struct device`` pointer that is passed to _regulator_suspend()
5594 * Configure each regulator with it's suspend operating parameters for state.
5596 static int regulator_suspend(struct device *dev)
5598 struct regulator_dev *rdev = dev_to_rdev(dev);
5599 suspend_state_t state = pm_suspend_target_state;
5601 const struct regulator_state *rstate;
5603 rstate = regulator_get_suspend_state_check(rdev, state);
5607 regulator_lock(rdev);
5608 ret = __suspend_set_state(rdev, rstate);
5609 regulator_unlock(rdev);
5614 static int regulator_resume(struct device *dev)
5616 suspend_state_t state = pm_suspend_target_state;
5617 struct regulator_dev *rdev = dev_to_rdev(dev);
5618 struct regulator_state *rstate;
5621 rstate = regulator_get_suspend_state(rdev, state);
5625 /* Avoid grabbing the lock if we don't need to */
5626 if (!rdev->desc->ops->resume)
5629 regulator_lock(rdev);
5631 if (rstate->enabled == ENABLE_IN_SUSPEND ||
5632 rstate->enabled == DISABLE_IN_SUSPEND)
5633 ret = rdev->desc->ops->resume(rdev);
5635 regulator_unlock(rdev);
5639 #else /* !CONFIG_SUSPEND */
5641 #define regulator_suspend NULL
5642 #define regulator_resume NULL
5644 #endif /* !CONFIG_SUSPEND */
5647 static const struct dev_pm_ops __maybe_unused regulator_pm_ops = {
5648 .suspend = regulator_suspend,
5649 .resume = regulator_resume,
5653 struct class regulator_class = {
5654 .name = "regulator",
5655 .dev_release = regulator_dev_release,
5656 .dev_groups = regulator_dev_groups,
5658 .pm = ®ulator_pm_ops,
5662 * regulator_has_full_constraints - the system has fully specified constraints
5664 * Calling this function will cause the regulator API to disable all
5665 * regulators which have a zero use count and don't have an always_on
5666 * constraint in a late_initcall.
5668 * The intention is that this will become the default behaviour in a
5669 * future kernel release so users are encouraged to use this facility
5672 void regulator_has_full_constraints(void)
5674 has_full_constraints = 1;
5676 EXPORT_SYMBOL_GPL(regulator_has_full_constraints);
5679 * rdev_get_drvdata - get rdev regulator driver data
5682 * Get rdev regulator driver private data. This call can be used in the
5683 * regulator driver context.
5685 void *rdev_get_drvdata(struct regulator_dev *rdev)
5687 return rdev->reg_data;
5689 EXPORT_SYMBOL_GPL(rdev_get_drvdata);
5692 * regulator_get_drvdata - get regulator driver data
5693 * @regulator: regulator
5695 * Get regulator driver private data. This call can be used in the consumer
5696 * driver context when non API regulator specific functions need to be called.
5698 void *regulator_get_drvdata(struct regulator *regulator)
5700 return regulator->rdev->reg_data;
5702 EXPORT_SYMBOL_GPL(regulator_get_drvdata);
5705 * regulator_set_drvdata - set regulator driver data
5706 * @regulator: regulator
5709 void regulator_set_drvdata(struct regulator *regulator, void *data)
5711 regulator->rdev->reg_data = data;
5713 EXPORT_SYMBOL_GPL(regulator_set_drvdata);
5716 * rdev_get_id - get regulator ID
5719 int rdev_get_id(struct regulator_dev *rdev)
5721 return rdev->desc->id;
5723 EXPORT_SYMBOL_GPL(rdev_get_id);
5725 struct device *rdev_get_dev(struct regulator_dev *rdev)
5729 EXPORT_SYMBOL_GPL(rdev_get_dev);
5731 struct regmap *rdev_get_regmap(struct regulator_dev *rdev)
5733 return rdev->regmap;
5735 EXPORT_SYMBOL_GPL(rdev_get_regmap);
5737 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data)
5739 return reg_init_data->driver_data;
5741 EXPORT_SYMBOL_GPL(regulator_get_init_drvdata);
5743 #ifdef CONFIG_DEBUG_FS
5744 static int supply_map_show(struct seq_file *sf, void *data)
5746 struct regulator_map *map;
5748 list_for_each_entry(map, ®ulator_map_list, list) {
5749 seq_printf(sf, "%s -> %s.%s\n",
5750 rdev_get_name(map->regulator), map->dev_name,
5756 DEFINE_SHOW_ATTRIBUTE(supply_map);
5758 struct summary_data {
5760 struct regulator_dev *parent;
5764 static void regulator_summary_show_subtree(struct seq_file *s,
5765 struct regulator_dev *rdev,
5768 static int regulator_summary_show_children(struct device *dev, void *data)
5770 struct regulator_dev *rdev = dev_to_rdev(dev);
5771 struct summary_data *summary_data = data;
5773 if (rdev->supply && rdev->supply->rdev == summary_data->parent)
5774 regulator_summary_show_subtree(summary_data->s, rdev,
5775 summary_data->level + 1);
5780 static void regulator_summary_show_subtree(struct seq_file *s,
5781 struct regulator_dev *rdev,
5784 struct regulation_constraints *c;
5785 struct regulator *consumer;
5786 struct summary_data summary_data;
5787 unsigned int opmode;
5792 opmode = _regulator_get_mode_unlocked(rdev);
5793 seq_printf(s, "%*s%-*s %3d %4d %6d %7s ",
5795 30 - level * 3, rdev_get_name(rdev),
5796 rdev->use_count, rdev->open_count, rdev->bypass_count,
5797 regulator_opmode_to_str(opmode));
5799 seq_printf(s, "%5dmV ", regulator_get_voltage_rdev(rdev) / 1000);
5800 seq_printf(s, "%5dmA ",
5801 _regulator_get_current_limit_unlocked(rdev) / 1000);
5803 c = rdev->constraints;
5805 switch (rdev->desc->type) {
5806 case REGULATOR_VOLTAGE:
5807 seq_printf(s, "%5dmV %5dmV ",
5808 c->min_uV / 1000, c->max_uV / 1000);
5810 case REGULATOR_CURRENT:
5811 seq_printf(s, "%5dmA %5dmA ",
5812 c->min_uA / 1000, c->max_uA / 1000);
5819 list_for_each_entry(consumer, &rdev->consumer_list, list) {
5820 if (consumer->dev && consumer->dev->class == ®ulator_class)
5823 seq_printf(s, "%*s%-*s ",
5824 (level + 1) * 3 + 1, "",
5825 30 - (level + 1) * 3,
5826 consumer->supply_name ? consumer->supply_name :
5827 consumer->dev ? dev_name(consumer->dev) : "deviceless");
5829 switch (rdev->desc->type) {
5830 case REGULATOR_VOLTAGE:
5831 seq_printf(s, "%3d %33dmA%c%5dmV %5dmV",
5832 consumer->enable_count,
5833 consumer->uA_load / 1000,
5834 consumer->uA_load && !consumer->enable_count ?
5836 consumer->voltage[PM_SUSPEND_ON].min_uV / 1000,
5837 consumer->voltage[PM_SUSPEND_ON].max_uV / 1000);
5839 case REGULATOR_CURRENT:
5847 summary_data.level = level;
5848 summary_data.parent = rdev;
5850 class_for_each_device(®ulator_class, NULL, &summary_data,
5851 regulator_summary_show_children);
5854 struct summary_lock_data {
5855 struct ww_acquire_ctx *ww_ctx;
5856 struct regulator_dev **new_contended_rdev;
5857 struct regulator_dev **old_contended_rdev;
5860 static int regulator_summary_lock_one(struct device *dev, void *data)
5862 struct regulator_dev *rdev = dev_to_rdev(dev);
5863 struct summary_lock_data *lock_data = data;
5866 if (rdev != *lock_data->old_contended_rdev) {
5867 ret = regulator_lock_nested(rdev, lock_data->ww_ctx);
5869 if (ret == -EDEADLK)
5870 *lock_data->new_contended_rdev = rdev;
5874 *lock_data->old_contended_rdev = NULL;
5880 static int regulator_summary_unlock_one(struct device *dev, void *data)
5882 struct regulator_dev *rdev = dev_to_rdev(dev);
5883 struct summary_lock_data *lock_data = data;
5886 if (rdev == *lock_data->new_contended_rdev)
5890 regulator_unlock(rdev);
5895 static int regulator_summary_lock_all(struct ww_acquire_ctx *ww_ctx,
5896 struct regulator_dev **new_contended_rdev,
5897 struct regulator_dev **old_contended_rdev)
5899 struct summary_lock_data lock_data;
5902 lock_data.ww_ctx = ww_ctx;
5903 lock_data.new_contended_rdev = new_contended_rdev;
5904 lock_data.old_contended_rdev = old_contended_rdev;
5906 ret = class_for_each_device(®ulator_class, NULL, &lock_data,
5907 regulator_summary_lock_one);
5909 class_for_each_device(®ulator_class, NULL, &lock_data,
5910 regulator_summary_unlock_one);
5915 static void regulator_summary_lock(struct ww_acquire_ctx *ww_ctx)
5917 struct regulator_dev *new_contended_rdev = NULL;
5918 struct regulator_dev *old_contended_rdev = NULL;
5921 mutex_lock(®ulator_list_mutex);
5923 ww_acquire_init(ww_ctx, ®ulator_ww_class);
5926 if (new_contended_rdev) {
5927 ww_mutex_lock_slow(&new_contended_rdev->mutex, ww_ctx);
5928 old_contended_rdev = new_contended_rdev;
5929 old_contended_rdev->ref_cnt++;
5932 err = regulator_summary_lock_all(ww_ctx,
5933 &new_contended_rdev,
5934 &old_contended_rdev);
5936 if (old_contended_rdev)
5937 regulator_unlock(old_contended_rdev);
5939 } while (err == -EDEADLK);
5941 ww_acquire_done(ww_ctx);
5944 static void regulator_summary_unlock(struct ww_acquire_ctx *ww_ctx)
5946 class_for_each_device(®ulator_class, NULL, NULL,
5947 regulator_summary_unlock_one);
5948 ww_acquire_fini(ww_ctx);
5950 mutex_unlock(®ulator_list_mutex);
5953 static int regulator_summary_show_roots(struct device *dev, void *data)
5955 struct regulator_dev *rdev = dev_to_rdev(dev);
5956 struct seq_file *s = data;
5959 regulator_summary_show_subtree(s, rdev, 0);
5964 static int regulator_summary_show(struct seq_file *s, void *data)
5966 struct ww_acquire_ctx ww_ctx;
5968 seq_puts(s, " regulator use open bypass opmode voltage current min max\n");
5969 seq_puts(s, "---------------------------------------------------------------------------------------\n");
5971 regulator_summary_lock(&ww_ctx);
5973 class_for_each_device(®ulator_class, NULL, s,
5974 regulator_summary_show_roots);
5976 regulator_summary_unlock(&ww_ctx);
5980 DEFINE_SHOW_ATTRIBUTE(regulator_summary);
5981 #endif /* CONFIG_DEBUG_FS */
5983 static int __init regulator_init(void)
5987 ret = class_register(®ulator_class);
5989 debugfs_root = debugfs_create_dir("regulator", NULL);
5991 pr_warn("regulator: Failed to create debugfs directory\n");
5993 #ifdef CONFIG_DEBUG_FS
5994 debugfs_create_file("supply_map", 0444, debugfs_root, NULL,
5997 debugfs_create_file("regulator_summary", 0444, debugfs_root,
5998 NULL, ®ulator_summary_fops);
6000 regulator_dummy_init();
6002 regulator_coupler_register(&generic_regulator_coupler);
6007 /* init early to allow our consumers to complete system booting */
6008 core_initcall(regulator_init);
6010 static int regulator_late_cleanup(struct device *dev, void *data)
6012 struct regulator_dev *rdev = dev_to_rdev(dev);
6013 const struct regulator_ops *ops = rdev->desc->ops;
6014 struct regulation_constraints *c = rdev->constraints;
6017 if (c && c->always_on)
6020 if (!regulator_ops_is_valid(rdev, REGULATOR_CHANGE_STATUS))
6023 regulator_lock(rdev);
6025 if (rdev->use_count)
6028 /* If we can't read the status assume it's always on. */
6029 if (ops->is_enabled)
6030 enabled = ops->is_enabled(rdev);
6034 /* But if reading the status failed, assume that it's off. */
6038 if (have_full_constraints()) {
6039 /* We log since this may kill the system if it goes
6042 rdev_info(rdev, "disabling\n");
6043 ret = _regulator_do_disable(rdev);
6045 rdev_err(rdev, "couldn't disable: %pe\n", ERR_PTR(ret));
6047 /* The intention is that in future we will
6048 * assume that full constraints are provided
6049 * so warn even if we aren't going to do
6052 rdev_warn(rdev, "incomplete constraints, leaving on\n");
6056 regulator_unlock(rdev);
6061 static void regulator_init_complete_work_function(struct work_struct *work)
6064 * Regulators may had failed to resolve their input supplies
6065 * when were registered, either because the input supply was
6066 * not registered yet or because its parent device was not
6067 * bound yet. So attempt to resolve the input supplies for
6068 * pending regulators before trying to disable unused ones.
6070 class_for_each_device(®ulator_class, NULL, NULL,
6071 regulator_register_resolve_supply);
6073 /* If we have a full configuration then disable any regulators
6074 * we have permission to change the status for and which are
6075 * not in use or always_on. This is effectively the default
6076 * for DT and ACPI as they have full constraints.
6078 class_for_each_device(®ulator_class, NULL, NULL,
6079 regulator_late_cleanup);
6082 static DECLARE_DELAYED_WORK(regulator_init_complete_work,
6083 regulator_init_complete_work_function);
6085 static int __init regulator_init_complete(void)
6088 * Since DT doesn't provide an idiomatic mechanism for
6089 * enabling full constraints and since it's much more natural
6090 * with DT to provide them just assume that a DT enabled
6091 * system has full constraints.
6093 if (of_have_populated_dt())
6094 has_full_constraints = true;
6097 * We punt completion for an arbitrary amount of time since
6098 * systems like distros will load many drivers from userspace
6099 * so consumers might not always be ready yet, this is
6100 * particularly an issue with laptops where this might bounce
6101 * the display off then on. Ideally we'd get a notification
6102 * from userspace when this happens but we don't so just wait
6103 * a bit and hope we waited long enough. It'd be better if
6104 * we'd only do this on systems that need it, and a kernel
6105 * command line option might be useful.
6107 schedule_delayed_work(®ulator_init_complete_work,
6108 msecs_to_jiffies(30000));
6112 late_initcall_sync(regulator_init_complete);