2 * core.c -- Voltage/Current Regulator framework.
4 * Copyright 2007, 2008 Wolfson Microelectronics PLC.
5 * Copyright 2008 SlimLogic Ltd.
7 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the
11 * Free Software Foundation; either version 2 of the License, or (at your
12 * option) any later version.
16 #include <linux/kernel.h>
17 #include <linux/init.h>
18 #include <linux/device.h>
19 #include <linux/err.h>
20 #include <linux/mutex.h>
21 #include <linux/suspend.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/regulator/driver.h>
24 #include <linux/regulator/machine.h>
26 #define REGULATOR_VERSION "0.5"
28 static DEFINE_MUTEX(regulator_list_mutex);
29 static LIST_HEAD(regulator_list);
30 static LIST_HEAD(regulator_map_list);
33 * struct regulator_map
35 * Used to provide symbolic supply names to devices.
37 struct regulator_map {
38 struct list_head list;
41 struct regulator_dev *regulator;
47 * One for each consumer device.
51 struct list_head list;
55 int enabled; /* count of client enables */
57 struct device_attribute dev_attr;
58 struct regulator_dev *rdev;
61 static int _regulator_is_enabled(struct regulator_dev *rdev);
62 static int _regulator_disable(struct regulator_dev *rdev);
63 static int _regulator_get_voltage(struct regulator_dev *rdev);
64 static int _regulator_get_current_limit(struct regulator_dev *rdev);
65 static unsigned int _regulator_get_mode(struct regulator_dev *rdev);
66 static void _notifier_call_chain(struct regulator_dev *rdev,
67 unsigned long event, void *data);
69 /* gets the regulator for a given consumer device */
70 static struct regulator *get_device_regulator(struct device *dev)
72 struct regulator *regulator = NULL;
73 struct regulator_dev *rdev;
75 mutex_lock(®ulator_list_mutex);
76 list_for_each_entry(rdev, ®ulator_list, list) {
77 mutex_lock(&rdev->mutex);
78 list_for_each_entry(regulator, &rdev->consumer_list, list) {
79 if (regulator->dev == dev) {
80 mutex_unlock(&rdev->mutex);
81 mutex_unlock(®ulator_list_mutex);
85 mutex_unlock(&rdev->mutex);
87 mutex_unlock(®ulator_list_mutex);
91 /* Platform voltage constraint check */
92 static int regulator_check_voltage(struct regulator_dev *rdev,
93 int *min_uV, int *max_uV)
95 BUG_ON(*min_uV > *max_uV);
97 if (!rdev->constraints) {
98 printk(KERN_ERR "%s: no constraints for %s\n", __func__,
102 if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_VOLTAGE)) {
103 printk(KERN_ERR "%s: operation not allowed for %s\n",
104 __func__, rdev->desc->name);
108 if (*max_uV > rdev->constraints->max_uV)
109 *max_uV = rdev->constraints->max_uV;
110 if (*min_uV < rdev->constraints->min_uV)
111 *min_uV = rdev->constraints->min_uV;
113 if (*min_uV > *max_uV)
119 /* current constraint check */
120 static int regulator_check_current_limit(struct regulator_dev *rdev,
121 int *min_uA, int *max_uA)
123 BUG_ON(*min_uA > *max_uA);
125 if (!rdev->constraints) {
126 printk(KERN_ERR "%s: no constraints for %s\n", __func__,
130 if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_CURRENT)) {
131 printk(KERN_ERR "%s: operation not allowed for %s\n",
132 __func__, rdev->desc->name);
136 if (*max_uA > rdev->constraints->max_uA)
137 *max_uA = rdev->constraints->max_uA;
138 if (*min_uA < rdev->constraints->min_uA)
139 *min_uA = rdev->constraints->min_uA;
141 if (*min_uA > *max_uA)
147 /* operating mode constraint check */
148 static int regulator_check_mode(struct regulator_dev *rdev, int mode)
151 case REGULATOR_MODE_FAST:
152 case REGULATOR_MODE_NORMAL:
153 case REGULATOR_MODE_IDLE:
154 case REGULATOR_MODE_STANDBY:
160 if (!rdev->constraints) {
161 printk(KERN_ERR "%s: no constraints for %s\n", __func__,
165 if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_MODE)) {
166 printk(KERN_ERR "%s: operation not allowed for %s\n",
167 __func__, rdev->desc->name);
170 if (!(rdev->constraints->valid_modes_mask & mode)) {
171 printk(KERN_ERR "%s: invalid mode %x for %s\n",
172 __func__, mode, rdev->desc->name);
178 /* dynamic regulator mode switching constraint check */
179 static int regulator_check_drms(struct regulator_dev *rdev)
181 if (!rdev->constraints) {
182 printk(KERN_ERR "%s: no constraints for %s\n", __func__,
186 if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_DRMS)) {
187 printk(KERN_ERR "%s: operation not allowed for %s\n",
188 __func__, rdev->desc->name);
194 static ssize_t device_requested_uA_show(struct device *dev,
195 struct device_attribute *attr, char *buf)
197 struct regulator *regulator;
199 regulator = get_device_regulator(dev);
200 if (regulator == NULL)
203 return sprintf(buf, "%d\n", regulator->uA_load);
206 static ssize_t regulator_uV_show(struct device *dev,
207 struct device_attribute *attr, char *buf)
209 struct regulator_dev *rdev = dev_get_drvdata(dev);
212 mutex_lock(&rdev->mutex);
213 ret = sprintf(buf, "%d\n", _regulator_get_voltage(rdev));
214 mutex_unlock(&rdev->mutex);
218 static DEVICE_ATTR(microvolts, 0444, regulator_uV_show, NULL);
220 static ssize_t regulator_uA_show(struct device *dev,
221 struct device_attribute *attr, char *buf)
223 struct regulator_dev *rdev = dev_get_drvdata(dev);
225 return sprintf(buf, "%d\n", _regulator_get_current_limit(rdev));
227 static DEVICE_ATTR(microamps, 0444, regulator_uA_show, NULL);
229 static ssize_t regulator_name_show(struct device *dev,
230 struct device_attribute *attr, char *buf)
232 struct regulator_dev *rdev = dev_get_drvdata(dev);
235 if (rdev->constraints->name)
236 name = rdev->constraints->name;
237 else if (rdev->desc->name)
238 name = rdev->desc->name;
242 return sprintf(buf, "%s\n", name);
245 static ssize_t regulator_print_opmode(char *buf, int mode)
248 case REGULATOR_MODE_FAST:
249 return sprintf(buf, "fast\n");
250 case REGULATOR_MODE_NORMAL:
251 return sprintf(buf, "normal\n");
252 case REGULATOR_MODE_IDLE:
253 return sprintf(buf, "idle\n");
254 case REGULATOR_MODE_STANDBY:
255 return sprintf(buf, "standby\n");
257 return sprintf(buf, "unknown\n");
260 static ssize_t regulator_opmode_show(struct device *dev,
261 struct device_attribute *attr, char *buf)
263 struct regulator_dev *rdev = dev_get_drvdata(dev);
265 return regulator_print_opmode(buf, _regulator_get_mode(rdev));
267 static DEVICE_ATTR(opmode, 0444, regulator_opmode_show, NULL);
269 static ssize_t regulator_print_state(char *buf, int state)
272 return sprintf(buf, "enabled\n");
274 return sprintf(buf, "disabled\n");
276 return sprintf(buf, "unknown\n");
279 static ssize_t regulator_state_show(struct device *dev,
280 struct device_attribute *attr, char *buf)
282 struct regulator_dev *rdev = dev_get_drvdata(dev);
284 return regulator_print_state(buf, _regulator_is_enabled(rdev));
286 static DEVICE_ATTR(state, 0444, regulator_state_show, NULL);
288 static ssize_t regulator_status_show(struct device *dev,
289 struct device_attribute *attr, char *buf)
291 struct regulator_dev *rdev = dev_get_drvdata(dev);
295 status = rdev->desc->ops->get_status(rdev);
300 case REGULATOR_STATUS_OFF:
303 case REGULATOR_STATUS_ON:
306 case REGULATOR_STATUS_ERROR:
309 case REGULATOR_STATUS_FAST:
312 case REGULATOR_STATUS_NORMAL:
315 case REGULATOR_STATUS_IDLE:
318 case REGULATOR_STATUS_STANDBY:
325 return sprintf(buf, "%s\n", label);
327 static DEVICE_ATTR(status, 0444, regulator_status_show, NULL);
329 static ssize_t regulator_min_uA_show(struct device *dev,
330 struct device_attribute *attr, char *buf)
332 struct regulator_dev *rdev = dev_get_drvdata(dev);
334 if (!rdev->constraints)
335 return sprintf(buf, "constraint not defined\n");
337 return sprintf(buf, "%d\n", rdev->constraints->min_uA);
339 static DEVICE_ATTR(min_microamps, 0444, regulator_min_uA_show, NULL);
341 static ssize_t regulator_max_uA_show(struct device *dev,
342 struct device_attribute *attr, char *buf)
344 struct regulator_dev *rdev = dev_get_drvdata(dev);
346 if (!rdev->constraints)
347 return sprintf(buf, "constraint not defined\n");
349 return sprintf(buf, "%d\n", rdev->constraints->max_uA);
351 static DEVICE_ATTR(max_microamps, 0444, regulator_max_uA_show, NULL);
353 static ssize_t regulator_min_uV_show(struct device *dev,
354 struct device_attribute *attr, char *buf)
356 struct regulator_dev *rdev = dev_get_drvdata(dev);
358 if (!rdev->constraints)
359 return sprintf(buf, "constraint not defined\n");
361 return sprintf(buf, "%d\n", rdev->constraints->min_uV);
363 static DEVICE_ATTR(min_microvolts, 0444, regulator_min_uV_show, NULL);
365 static ssize_t regulator_max_uV_show(struct device *dev,
366 struct device_attribute *attr, char *buf)
368 struct regulator_dev *rdev = dev_get_drvdata(dev);
370 if (!rdev->constraints)
371 return sprintf(buf, "constraint not defined\n");
373 return sprintf(buf, "%d\n", rdev->constraints->max_uV);
375 static DEVICE_ATTR(max_microvolts, 0444, regulator_max_uV_show, NULL);
377 static ssize_t regulator_total_uA_show(struct device *dev,
378 struct device_attribute *attr, char *buf)
380 struct regulator_dev *rdev = dev_get_drvdata(dev);
381 struct regulator *regulator;
384 mutex_lock(&rdev->mutex);
385 list_for_each_entry(regulator, &rdev->consumer_list, list)
386 uA += regulator->uA_load;
387 mutex_unlock(&rdev->mutex);
388 return sprintf(buf, "%d\n", uA);
390 static DEVICE_ATTR(requested_microamps, 0444, regulator_total_uA_show, NULL);
392 static ssize_t regulator_num_users_show(struct device *dev,
393 struct device_attribute *attr, char *buf)
395 struct regulator_dev *rdev = dev_get_drvdata(dev);
396 return sprintf(buf, "%d\n", rdev->use_count);
399 static ssize_t regulator_type_show(struct device *dev,
400 struct device_attribute *attr, char *buf)
402 struct regulator_dev *rdev = dev_get_drvdata(dev);
404 switch (rdev->desc->type) {
405 case REGULATOR_VOLTAGE:
406 return sprintf(buf, "voltage\n");
407 case REGULATOR_CURRENT:
408 return sprintf(buf, "current\n");
410 return sprintf(buf, "unknown\n");
413 static ssize_t regulator_suspend_mem_uV_show(struct device *dev,
414 struct device_attribute *attr, char *buf)
416 struct regulator_dev *rdev = dev_get_drvdata(dev);
418 return sprintf(buf, "%d\n", rdev->constraints->state_mem.uV);
420 static DEVICE_ATTR(suspend_mem_microvolts, 0444,
421 regulator_suspend_mem_uV_show, NULL);
423 static ssize_t regulator_suspend_disk_uV_show(struct device *dev,
424 struct device_attribute *attr, char *buf)
426 struct regulator_dev *rdev = dev_get_drvdata(dev);
428 return sprintf(buf, "%d\n", rdev->constraints->state_disk.uV);
430 static DEVICE_ATTR(suspend_disk_microvolts, 0444,
431 regulator_suspend_disk_uV_show, NULL);
433 static ssize_t regulator_suspend_standby_uV_show(struct device *dev,
434 struct device_attribute *attr, char *buf)
436 struct regulator_dev *rdev = dev_get_drvdata(dev);
438 return sprintf(buf, "%d\n", rdev->constraints->state_standby.uV);
440 static DEVICE_ATTR(suspend_standby_microvolts, 0444,
441 regulator_suspend_standby_uV_show, NULL);
443 static ssize_t regulator_suspend_mem_mode_show(struct device *dev,
444 struct device_attribute *attr, char *buf)
446 struct regulator_dev *rdev = dev_get_drvdata(dev);
448 return regulator_print_opmode(buf,
449 rdev->constraints->state_mem.mode);
451 static DEVICE_ATTR(suspend_mem_mode, 0444,
452 regulator_suspend_mem_mode_show, NULL);
454 static ssize_t regulator_suspend_disk_mode_show(struct device *dev,
455 struct device_attribute *attr, char *buf)
457 struct regulator_dev *rdev = dev_get_drvdata(dev);
459 return regulator_print_opmode(buf,
460 rdev->constraints->state_disk.mode);
462 static DEVICE_ATTR(suspend_disk_mode, 0444,
463 regulator_suspend_disk_mode_show, NULL);
465 static ssize_t regulator_suspend_standby_mode_show(struct device *dev,
466 struct device_attribute *attr, char *buf)
468 struct regulator_dev *rdev = dev_get_drvdata(dev);
470 return regulator_print_opmode(buf,
471 rdev->constraints->state_standby.mode);
473 static DEVICE_ATTR(suspend_standby_mode, 0444,
474 regulator_suspend_standby_mode_show, NULL);
476 static ssize_t regulator_suspend_mem_state_show(struct device *dev,
477 struct device_attribute *attr, char *buf)
479 struct regulator_dev *rdev = dev_get_drvdata(dev);
481 return regulator_print_state(buf,
482 rdev->constraints->state_mem.enabled);
484 static DEVICE_ATTR(suspend_mem_state, 0444,
485 regulator_suspend_mem_state_show, NULL);
487 static ssize_t regulator_suspend_disk_state_show(struct device *dev,
488 struct device_attribute *attr, char *buf)
490 struct regulator_dev *rdev = dev_get_drvdata(dev);
492 return regulator_print_state(buf,
493 rdev->constraints->state_disk.enabled);
495 static DEVICE_ATTR(suspend_disk_state, 0444,
496 regulator_suspend_disk_state_show, NULL);
498 static ssize_t regulator_suspend_standby_state_show(struct device *dev,
499 struct device_attribute *attr, char *buf)
501 struct regulator_dev *rdev = dev_get_drvdata(dev);
503 return regulator_print_state(buf,
504 rdev->constraints->state_standby.enabled);
506 static DEVICE_ATTR(suspend_standby_state, 0444,
507 regulator_suspend_standby_state_show, NULL);
511 * These are the only attributes are present for all regulators.
512 * Other attributes are a function of regulator functionality.
514 static struct device_attribute regulator_dev_attrs[] = {
515 __ATTR(name, 0444, regulator_name_show, NULL),
516 __ATTR(num_users, 0444, regulator_num_users_show, NULL),
517 __ATTR(type, 0444, regulator_type_show, NULL),
521 static void regulator_dev_release(struct device *dev)
523 struct regulator_dev *rdev = dev_get_drvdata(dev);
527 static struct class regulator_class = {
529 .dev_release = regulator_dev_release,
530 .dev_attrs = regulator_dev_attrs,
533 /* Calculate the new optimum regulator operating mode based on the new total
534 * consumer load. All locks held by caller */
535 static void drms_uA_update(struct regulator_dev *rdev)
537 struct regulator *sibling;
538 int current_uA = 0, output_uV, input_uV, err;
541 err = regulator_check_drms(rdev);
542 if (err < 0 || !rdev->desc->ops->get_optimum_mode ||
543 !rdev->desc->ops->get_voltage || !rdev->desc->ops->set_mode);
546 /* get output voltage */
547 output_uV = rdev->desc->ops->get_voltage(rdev);
551 /* get input voltage */
552 if (rdev->supply && rdev->supply->desc->ops->get_voltage)
553 input_uV = rdev->supply->desc->ops->get_voltage(rdev->supply);
555 input_uV = rdev->constraints->input_uV;
559 /* calc total requested load */
560 list_for_each_entry(sibling, &rdev->consumer_list, list)
561 current_uA += sibling->uA_load;
563 /* now get the optimum mode for our new total regulator load */
564 mode = rdev->desc->ops->get_optimum_mode(rdev, input_uV,
565 output_uV, current_uA);
567 /* check the new mode is allowed */
568 err = regulator_check_mode(rdev, mode);
570 rdev->desc->ops->set_mode(rdev, mode);
573 static int suspend_set_state(struct regulator_dev *rdev,
574 struct regulator_state *rstate)
578 /* enable & disable are mandatory for suspend control */
579 if (!rdev->desc->ops->set_suspend_enable ||
580 !rdev->desc->ops->set_suspend_disable) {
581 printk(KERN_ERR "%s: no way to set suspend state\n",
587 ret = rdev->desc->ops->set_suspend_enable(rdev);
589 ret = rdev->desc->ops->set_suspend_disable(rdev);
591 printk(KERN_ERR "%s: failed to enabled/disable\n", __func__);
595 if (rdev->desc->ops->set_suspend_voltage && rstate->uV > 0) {
596 ret = rdev->desc->ops->set_suspend_voltage(rdev, rstate->uV);
598 printk(KERN_ERR "%s: failed to set voltage\n",
604 if (rdev->desc->ops->set_suspend_mode && rstate->mode > 0) {
605 ret = rdev->desc->ops->set_suspend_mode(rdev, rstate->mode);
607 printk(KERN_ERR "%s: failed to set mode\n", __func__);
614 /* locks held by caller */
615 static int suspend_prepare(struct regulator_dev *rdev, suspend_state_t state)
617 if (!rdev->constraints)
621 case PM_SUSPEND_STANDBY:
622 return suspend_set_state(rdev,
623 &rdev->constraints->state_standby);
625 return suspend_set_state(rdev,
626 &rdev->constraints->state_mem);
628 return suspend_set_state(rdev,
629 &rdev->constraints->state_disk);
635 static void print_constraints(struct regulator_dev *rdev)
637 struct regulation_constraints *constraints = rdev->constraints;
641 if (rdev->desc->type == REGULATOR_VOLTAGE) {
642 if (constraints->min_uV == constraints->max_uV)
643 count = sprintf(buf, "%d mV ",
644 constraints->min_uV / 1000);
646 count = sprintf(buf, "%d <--> %d mV ",
647 constraints->min_uV / 1000,
648 constraints->max_uV / 1000);
650 if (constraints->min_uA == constraints->max_uA)
651 count = sprintf(buf, "%d mA ",
652 constraints->min_uA / 1000);
654 count = sprintf(buf, "%d <--> %d mA ",
655 constraints->min_uA / 1000,
656 constraints->max_uA / 1000);
658 if (constraints->valid_modes_mask & REGULATOR_MODE_FAST)
659 count += sprintf(buf + count, "fast ");
660 if (constraints->valid_modes_mask & REGULATOR_MODE_NORMAL)
661 count += sprintf(buf + count, "normal ");
662 if (constraints->valid_modes_mask & REGULATOR_MODE_IDLE)
663 count += sprintf(buf + count, "idle ");
664 if (constraints->valid_modes_mask & REGULATOR_MODE_STANDBY)
665 count += sprintf(buf + count, "standby");
667 printk(KERN_INFO "regulator: %s: %s\n", rdev->desc->name, buf);
671 * set_machine_constraints - sets regulator constraints
672 * @rdev: regulator source
673 * @constraints: constraints to apply
675 * Allows platform initialisation code to define and constrain
676 * regulator circuits e.g. valid voltage/current ranges, etc. NOTE:
677 * Constraints *must* be set by platform code in order for some
678 * regulator operations to proceed i.e. set_voltage, set_current_limit,
681 static int set_machine_constraints(struct regulator_dev *rdev,
682 struct regulation_constraints *constraints)
686 struct regulator_ops *ops = rdev->desc->ops;
688 if (constraints->name)
689 name = constraints->name;
690 else if (rdev->desc->name)
691 name = rdev->desc->name;
695 /* constrain machine-level voltage specs to fit
696 * the actual range supported by this regulator.
698 if (ops->list_voltage && rdev->desc->n_voltages) {
699 int count = rdev->desc->n_voltages;
701 int min_uV = INT_MAX;
702 int max_uV = INT_MIN;
703 int cmin = constraints->min_uV;
704 int cmax = constraints->max_uV;
706 /* it's safe to autoconfigure fixed-voltage supplies */
707 if (count == 1 && !cmin) {
712 /* voltage constraints are optional */
713 if ((cmin == 0) && (cmax == 0))
716 /* else require explicit machine-level constraints */
717 if (cmin <= 0 || cmax <= 0 || cmax < cmin) {
718 pr_err("%s: %s '%s' voltage constraints\n",
719 __func__, "invalid", name);
724 /* initial: [cmin..cmax] valid, [min_uV..max_uV] not */
725 for (i = 0; i < count; i++) {
728 value = ops->list_voltage(rdev, i);
732 /* maybe adjust [min_uV..max_uV] */
733 if (value >= cmin && value < min_uV)
735 if (value <= cmax && value > max_uV)
739 /* final: [min_uV..max_uV] valid iff constraints valid */
740 if (max_uV < min_uV) {
741 pr_err("%s: %s '%s' voltage constraints\n",
742 __func__, "unsupportable", name);
747 /* use regulator's subset of machine constraints */
748 if (constraints->min_uV < min_uV) {
749 pr_debug("%s: override '%s' %s, %d -> %d\n",
750 __func__, name, "min_uV",
751 constraints->min_uV, min_uV);
752 constraints->min_uV = min_uV;
754 if (constraints->max_uV > max_uV) {
755 pr_debug("%s: override '%s' %s, %d -> %d\n",
756 __func__, name, "max_uV",
757 constraints->max_uV, max_uV);
758 constraints->max_uV = max_uV;
762 rdev->constraints = constraints;
764 /* do we need to apply the constraint voltage */
765 if (rdev->constraints->apply_uV &&
766 rdev->constraints->min_uV == rdev->constraints->max_uV &&
768 ret = ops->set_voltage(rdev,
769 rdev->constraints->min_uV, rdev->constraints->max_uV);
771 printk(KERN_ERR "%s: failed to apply %duV constraint to %s\n",
773 rdev->constraints->min_uV, name);
774 rdev->constraints = NULL;
779 /* are we enabled at boot time by firmware / bootloader */
780 if (rdev->constraints->boot_on)
783 /* do we need to setup our suspend state */
784 if (constraints->initial_state) {
785 ret = suspend_prepare(rdev, constraints->initial_state);
787 printk(KERN_ERR "%s: failed to set suspend state for %s\n",
789 rdev->constraints = NULL;
794 if (constraints->initial_mode) {
795 if (!ops->set_mode) {
796 printk(KERN_ERR "%s: no set_mode operation for %s\n",
802 ret = ops->set_mode(rdev, constraints->initial_mode);
805 "%s: failed to set initial mode for %s: %d\n",
806 __func__, name, ret);
811 /* if always_on is set then turn the regulator on if it's not
813 if (constraints->always_on && ops->enable &&
814 ((ops->is_enabled && !ops->is_enabled(rdev)) ||
815 (!ops->is_enabled && !constraints->boot_on))) {
816 ret = ops->enable(rdev);
818 printk(KERN_ERR "%s: failed to enable %s\n",
820 rdev->constraints = NULL;
825 print_constraints(rdev);
831 * set_supply - set regulator supply regulator
832 * @rdev: regulator name
833 * @supply_rdev: supply regulator name
835 * Called by platform initialisation code to set the supply regulator for this
836 * regulator. This ensures that a regulators supply will also be enabled by the
837 * core if it's child is enabled.
839 static int set_supply(struct regulator_dev *rdev,
840 struct regulator_dev *supply_rdev)
844 err = sysfs_create_link(&rdev->dev.kobj, &supply_rdev->dev.kobj,
848 "%s: could not add device link %s err %d\n",
849 __func__, supply_rdev->dev.kobj.name, err);
852 rdev->supply = supply_rdev;
853 list_add(&rdev->slist, &supply_rdev->supply_list);
859 * set_consumer_device_supply: Bind a regulator to a symbolic supply
860 * @rdev: regulator source
861 * @consumer_dev: device the supply applies to
862 * @supply: symbolic name for supply
864 * Allows platform initialisation code to map physical regulator
865 * sources to symbolic names for supplies for use by devices. Devices
866 * should use these symbolic names to request regulators, avoiding the
867 * need to provide board-specific regulator names as platform data.
869 static int set_consumer_device_supply(struct regulator_dev *rdev,
870 struct device *consumer_dev, const char *supply)
872 struct regulator_map *node;
877 list_for_each_entry(node, ®ulator_map_list, list) {
878 if (consumer_dev != node->dev)
880 if (strcmp(node->supply, supply) != 0)
883 dev_dbg(consumer_dev, "%s/%s is '%s' supply; fail %s/%s\n",
884 dev_name(&node->regulator->dev),
885 node->regulator->desc->name,
887 dev_name(&rdev->dev), rdev->desc->name);
891 node = kmalloc(sizeof(struct regulator_map), GFP_KERNEL);
895 node->regulator = rdev;
896 node->dev = consumer_dev;
897 node->supply = supply;
899 list_add(&node->list, ®ulator_map_list);
903 static void unset_consumer_device_supply(struct regulator_dev *rdev,
904 struct device *consumer_dev)
906 struct regulator_map *node, *n;
908 list_for_each_entry_safe(node, n, ®ulator_map_list, list) {
909 if (rdev == node->regulator &&
910 consumer_dev == node->dev) {
911 list_del(&node->list);
918 static void unset_regulator_supplies(struct regulator_dev *rdev)
920 struct regulator_map *node, *n;
922 list_for_each_entry_safe(node, n, ®ulator_map_list, list) {
923 if (rdev == node->regulator) {
924 list_del(&node->list);
931 #define REG_STR_SIZE 32
933 static struct regulator *create_regulator(struct regulator_dev *rdev,
935 const char *supply_name)
937 struct regulator *regulator;
938 char buf[REG_STR_SIZE];
941 regulator = kzalloc(sizeof(*regulator), GFP_KERNEL);
942 if (regulator == NULL)
945 mutex_lock(&rdev->mutex);
946 regulator->rdev = rdev;
947 list_add(®ulator->list, &rdev->consumer_list);
950 /* create a 'requested_microamps_name' sysfs entry */
951 size = scnprintf(buf, REG_STR_SIZE, "microamps_requested_%s",
953 if (size >= REG_STR_SIZE)
956 regulator->dev = dev;
957 regulator->dev_attr.attr.name = kstrdup(buf, GFP_KERNEL);
958 if (regulator->dev_attr.attr.name == NULL)
961 regulator->dev_attr.attr.owner = THIS_MODULE;
962 regulator->dev_attr.attr.mode = 0444;
963 regulator->dev_attr.show = device_requested_uA_show;
964 err = device_create_file(dev, ®ulator->dev_attr);
966 printk(KERN_WARNING "%s: could not add regulator_dev"
967 " load sysfs\n", __func__);
971 /* also add a link to the device sysfs entry */
972 size = scnprintf(buf, REG_STR_SIZE, "%s-%s",
973 dev->kobj.name, supply_name);
974 if (size >= REG_STR_SIZE)
977 regulator->supply_name = kstrdup(buf, GFP_KERNEL);
978 if (regulator->supply_name == NULL)
981 err = sysfs_create_link(&rdev->dev.kobj, &dev->kobj,
985 "%s: could not add device link %s err %d\n",
986 __func__, dev->kobj.name, err);
987 device_remove_file(dev, ®ulator->dev_attr);
991 mutex_unlock(&rdev->mutex);
994 kfree(regulator->supply_name);
996 device_remove_file(regulator->dev, ®ulator->dev_attr);
998 kfree(regulator->dev_attr.attr.name);
1000 list_del(®ulator->list);
1002 mutex_unlock(&rdev->mutex);
1007 * regulator_get - lookup and obtain a reference to a regulator.
1008 * @dev: device for regulator "consumer"
1009 * @id: Supply name or regulator ID.
1011 * Returns a struct regulator corresponding to the regulator producer,
1012 * or IS_ERR() condition containing errno.
1014 * Use of supply names configured via regulator_set_device_supply() is
1015 * strongly encouraged. It is recommended that the supply name used
1016 * should match the name used for the supply and/or the relevant
1017 * device pins in the datasheet.
1019 struct regulator *regulator_get(struct device *dev, const char *id)
1021 struct regulator_dev *rdev;
1022 struct regulator_map *map;
1023 struct regulator *regulator = ERR_PTR(-ENODEV);
1026 printk(KERN_ERR "regulator: get() with no identifier\n");
1030 mutex_lock(®ulator_list_mutex);
1032 list_for_each_entry(map, ®ulator_map_list, list) {
1033 if (dev == map->dev &&
1034 strcmp(map->supply, id) == 0) {
1035 rdev = map->regulator;
1039 printk(KERN_ERR "regulator: Unable to get requested regulator: %s\n",
1041 mutex_unlock(®ulator_list_mutex);
1045 if (!try_module_get(rdev->owner))
1048 regulator = create_regulator(rdev, dev, id);
1049 if (regulator == NULL) {
1050 regulator = ERR_PTR(-ENOMEM);
1051 module_put(rdev->owner);
1055 mutex_unlock(®ulator_list_mutex);
1058 EXPORT_SYMBOL_GPL(regulator_get);
1061 * regulator_put - "free" the regulator source
1062 * @regulator: regulator source
1064 * Note: drivers must ensure that all regulator_enable calls made on this
1065 * regulator source are balanced by regulator_disable calls prior to calling
1068 void regulator_put(struct regulator *regulator)
1070 struct regulator_dev *rdev;
1072 if (regulator == NULL || IS_ERR(regulator))
1075 mutex_lock(®ulator_list_mutex);
1076 rdev = regulator->rdev;
1078 if (WARN(regulator->enabled, "Releasing supply %s while enabled\n",
1079 regulator->supply_name))
1080 _regulator_disable(rdev);
1082 /* remove any sysfs entries */
1083 if (regulator->dev) {
1084 sysfs_remove_link(&rdev->dev.kobj, regulator->supply_name);
1085 kfree(regulator->supply_name);
1086 device_remove_file(regulator->dev, ®ulator->dev_attr);
1087 kfree(regulator->dev_attr.attr.name);
1089 list_del(®ulator->list);
1092 module_put(rdev->owner);
1093 mutex_unlock(®ulator_list_mutex);
1095 EXPORT_SYMBOL_GPL(regulator_put);
1097 /* locks held by regulator_enable() */
1098 static int _regulator_enable(struct regulator_dev *rdev)
1102 if (!rdev->constraints) {
1103 printk(KERN_ERR "%s: %s has no constraints\n",
1104 __func__, rdev->desc->name);
1108 /* do we need to enable the supply regulator first */
1110 ret = _regulator_enable(rdev->supply);
1112 printk(KERN_ERR "%s: failed to enable %s: %d\n",
1113 __func__, rdev->desc->name, ret);
1118 /* check voltage and requested load before enabling */
1119 if (rdev->desc->ops->enable) {
1121 if (rdev->constraints &&
1122 (rdev->constraints->valid_ops_mask &
1123 REGULATOR_CHANGE_DRMS))
1124 drms_uA_update(rdev);
1126 ret = rdev->desc->ops->enable(rdev);
1128 printk(KERN_ERR "%s: failed to enable %s: %d\n",
1129 __func__, rdev->desc->name, ret);
1140 * regulator_enable - enable regulator output
1141 * @regulator: regulator source
1143 * Request that the regulator be enabled with the regulator output at
1144 * the predefined voltage or current value. Calls to regulator_enable()
1145 * must be balanced with calls to regulator_disable().
1147 * NOTE: the output value can be set by other drivers, boot loader or may be
1148 * hardwired in the regulator.
1150 int regulator_enable(struct regulator *regulator)
1152 struct regulator_dev *rdev = regulator->rdev;
1155 mutex_lock(&rdev->mutex);
1156 if (regulator->enabled == 0)
1157 ret = _regulator_enable(rdev);
1158 else if (regulator->enabled < 0)
1161 regulator->enabled++;
1162 mutex_unlock(&rdev->mutex);
1165 EXPORT_SYMBOL_GPL(regulator_enable);
1167 /* locks held by regulator_disable() */
1168 static int _regulator_disable(struct regulator_dev *rdev)
1172 /* are we the last user and permitted to disable ? */
1173 if (rdev->use_count == 1 && !rdev->constraints->always_on) {
1175 /* we are last user */
1176 if (rdev->desc->ops->disable) {
1177 ret = rdev->desc->ops->disable(rdev);
1179 printk(KERN_ERR "%s: failed to disable %s\n",
1180 __func__, rdev->desc->name);
1185 /* decrease our supplies ref count and disable if required */
1187 _regulator_disable(rdev->supply);
1189 rdev->use_count = 0;
1190 } else if (rdev->use_count > 1) {
1192 if (rdev->constraints &&
1193 (rdev->constraints->valid_ops_mask &
1194 REGULATOR_CHANGE_DRMS))
1195 drms_uA_update(rdev);
1203 * regulator_disable - disable regulator output
1204 * @regulator: regulator source
1206 * Disable the regulator output voltage or current. Calls to
1207 * regulator_enable() must be balanced with calls to
1208 * regulator_disable().
1210 * NOTE: this will only disable the regulator output if no other consumer
1211 * devices have it enabled, the regulator device supports disabling and
1212 * machine constraints permit this operation.
1214 int regulator_disable(struct regulator *regulator)
1216 struct regulator_dev *rdev = regulator->rdev;
1219 mutex_lock(&rdev->mutex);
1220 if (regulator->enabled == 1) {
1221 ret = _regulator_disable(rdev);
1223 regulator->uA_load = 0;
1224 } else if (WARN(regulator->enabled <= 0,
1225 "unbalanced disables for supply %s\n",
1226 regulator->supply_name))
1229 regulator->enabled--;
1230 mutex_unlock(&rdev->mutex);
1233 EXPORT_SYMBOL_GPL(regulator_disable);
1235 /* locks held by regulator_force_disable() */
1236 static int _regulator_force_disable(struct regulator_dev *rdev)
1241 if (rdev->desc->ops->disable) {
1242 /* ah well, who wants to live forever... */
1243 ret = rdev->desc->ops->disable(rdev);
1245 printk(KERN_ERR "%s: failed to force disable %s\n",
1246 __func__, rdev->desc->name);
1249 /* notify other consumers that power has been forced off */
1250 _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE,
1254 /* decrease our supplies ref count and disable if required */
1256 _regulator_disable(rdev->supply);
1258 rdev->use_count = 0;
1263 * regulator_force_disable - force disable regulator output
1264 * @regulator: regulator source
1266 * Forcibly disable the regulator output voltage or current.
1267 * NOTE: this *will* disable the regulator output even if other consumer
1268 * devices have it enabled. This should be used for situations when device
1269 * damage will likely occur if the regulator is not disabled (e.g. over temp).
1271 int regulator_force_disable(struct regulator *regulator)
1275 mutex_lock(®ulator->rdev->mutex);
1276 regulator->enabled = 0;
1277 regulator->uA_load = 0;
1278 ret = _regulator_force_disable(regulator->rdev);
1279 mutex_unlock(®ulator->rdev->mutex);
1282 EXPORT_SYMBOL_GPL(regulator_force_disable);
1284 static int _regulator_is_enabled(struct regulator_dev *rdev)
1288 mutex_lock(&rdev->mutex);
1291 if (!rdev->desc->ops->is_enabled) {
1296 ret = rdev->desc->ops->is_enabled(rdev);
1298 mutex_unlock(&rdev->mutex);
1303 * regulator_is_enabled - is the regulator output enabled
1304 * @regulator: regulator source
1306 * Returns positive if the regulator driver backing the source/client
1307 * has requested that the device be enabled, zero if it hasn't, else a
1308 * negative errno code.
1310 * Note that the device backing this regulator handle can have multiple
1311 * users, so it might be enabled even if regulator_enable() was never
1312 * called for this particular source.
1314 int regulator_is_enabled(struct regulator *regulator)
1316 return _regulator_is_enabled(regulator->rdev);
1318 EXPORT_SYMBOL_GPL(regulator_is_enabled);
1321 * regulator_count_voltages - count regulator_list_voltage() selectors
1322 * @regulator: regulator source
1324 * Returns number of selectors, or negative errno. Selectors are
1325 * numbered starting at zero, and typically correspond to bitfields
1326 * in hardware registers.
1328 int regulator_count_voltages(struct regulator *regulator)
1330 struct regulator_dev *rdev = regulator->rdev;
1332 return rdev->desc->n_voltages ? : -EINVAL;
1334 EXPORT_SYMBOL_GPL(regulator_count_voltages);
1337 * regulator_list_voltage - enumerate supported voltages
1338 * @regulator: regulator source
1339 * @selector: identify voltage to list
1340 * Context: can sleep
1342 * Returns a voltage that can be passed to @regulator_set_voltage(),
1343 * zero if this selector code can't be used on this sytem, or a
1346 int regulator_list_voltage(struct regulator *regulator, unsigned selector)
1348 struct regulator_dev *rdev = regulator->rdev;
1349 struct regulator_ops *ops = rdev->desc->ops;
1352 if (!ops->list_voltage || selector >= rdev->desc->n_voltages)
1355 mutex_lock(&rdev->mutex);
1356 ret = ops->list_voltage(rdev, selector);
1357 mutex_unlock(&rdev->mutex);
1360 if (ret < rdev->constraints->min_uV)
1362 else if (ret > rdev->constraints->max_uV)
1368 EXPORT_SYMBOL_GPL(regulator_list_voltage);
1371 * regulator_set_voltage - set regulator output voltage
1372 * @regulator: regulator source
1373 * @min_uV: Minimum required voltage in uV
1374 * @max_uV: Maximum acceptable voltage in uV
1376 * Sets a voltage regulator to the desired output voltage. This can be set
1377 * during any regulator state. IOW, regulator can be disabled or enabled.
1379 * If the regulator is enabled then the voltage will change to the new value
1380 * immediately otherwise if the regulator is disabled the regulator will
1381 * output at the new voltage when enabled.
1383 * NOTE: If the regulator is shared between several devices then the lowest
1384 * request voltage that meets the system constraints will be used.
1385 * Regulator system constraints must be set for this regulator before
1386 * calling this function otherwise this call will fail.
1388 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
1390 struct regulator_dev *rdev = regulator->rdev;
1393 mutex_lock(&rdev->mutex);
1396 if (!rdev->desc->ops->set_voltage) {
1401 /* constraints check */
1402 ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
1405 regulator->min_uV = min_uV;
1406 regulator->max_uV = max_uV;
1407 ret = rdev->desc->ops->set_voltage(rdev, min_uV, max_uV);
1410 _notifier_call_chain(rdev, REGULATOR_EVENT_VOLTAGE_CHANGE, NULL);
1411 mutex_unlock(&rdev->mutex);
1414 EXPORT_SYMBOL_GPL(regulator_set_voltage);
1416 static int _regulator_get_voltage(struct regulator_dev *rdev)
1419 if (rdev->desc->ops->get_voltage)
1420 return rdev->desc->ops->get_voltage(rdev);
1426 * regulator_get_voltage - get regulator output voltage
1427 * @regulator: regulator source
1429 * This returns the current regulator voltage in uV.
1431 * NOTE: If the regulator is disabled it will return the voltage value. This
1432 * function should not be used to determine regulator state.
1434 int regulator_get_voltage(struct regulator *regulator)
1438 mutex_lock(®ulator->rdev->mutex);
1440 ret = _regulator_get_voltage(regulator->rdev);
1442 mutex_unlock(®ulator->rdev->mutex);
1446 EXPORT_SYMBOL_GPL(regulator_get_voltage);
1449 * regulator_set_current_limit - set regulator output current limit
1450 * @regulator: regulator source
1451 * @min_uA: Minimuum supported current in uA
1452 * @max_uA: Maximum supported current in uA
1454 * Sets current sink to the desired output current. This can be set during
1455 * any regulator state. IOW, regulator can be disabled or enabled.
1457 * If the regulator is enabled then the current will change to the new value
1458 * immediately otherwise if the regulator is disabled the regulator will
1459 * output at the new current when enabled.
1461 * NOTE: Regulator system constraints must be set for this regulator before
1462 * calling this function otherwise this call will fail.
1464 int regulator_set_current_limit(struct regulator *regulator,
1465 int min_uA, int max_uA)
1467 struct regulator_dev *rdev = regulator->rdev;
1470 mutex_lock(&rdev->mutex);
1473 if (!rdev->desc->ops->set_current_limit) {
1478 /* constraints check */
1479 ret = regulator_check_current_limit(rdev, &min_uA, &max_uA);
1483 ret = rdev->desc->ops->set_current_limit(rdev, min_uA, max_uA);
1485 mutex_unlock(&rdev->mutex);
1488 EXPORT_SYMBOL_GPL(regulator_set_current_limit);
1490 static int _regulator_get_current_limit(struct regulator_dev *rdev)
1494 mutex_lock(&rdev->mutex);
1497 if (!rdev->desc->ops->get_current_limit) {
1502 ret = rdev->desc->ops->get_current_limit(rdev);
1504 mutex_unlock(&rdev->mutex);
1509 * regulator_get_current_limit - get regulator output current
1510 * @regulator: regulator source
1512 * This returns the current supplied by the specified current sink in uA.
1514 * NOTE: If the regulator is disabled it will return the current value. This
1515 * function should not be used to determine regulator state.
1517 int regulator_get_current_limit(struct regulator *regulator)
1519 return _regulator_get_current_limit(regulator->rdev);
1521 EXPORT_SYMBOL_GPL(regulator_get_current_limit);
1524 * regulator_set_mode - set regulator operating mode
1525 * @regulator: regulator source
1526 * @mode: operating mode - one of the REGULATOR_MODE constants
1528 * Set regulator operating mode to increase regulator efficiency or improve
1529 * regulation performance.
1531 * NOTE: Regulator system constraints must be set for this regulator before
1532 * calling this function otherwise this call will fail.
1534 int regulator_set_mode(struct regulator *regulator, unsigned int mode)
1536 struct regulator_dev *rdev = regulator->rdev;
1539 mutex_lock(&rdev->mutex);
1542 if (!rdev->desc->ops->set_mode) {
1547 /* constraints check */
1548 ret = regulator_check_mode(rdev, mode);
1552 ret = rdev->desc->ops->set_mode(rdev, mode);
1554 mutex_unlock(&rdev->mutex);
1557 EXPORT_SYMBOL_GPL(regulator_set_mode);
1559 static unsigned int _regulator_get_mode(struct regulator_dev *rdev)
1563 mutex_lock(&rdev->mutex);
1566 if (!rdev->desc->ops->get_mode) {
1571 ret = rdev->desc->ops->get_mode(rdev);
1573 mutex_unlock(&rdev->mutex);
1578 * regulator_get_mode - get regulator operating mode
1579 * @regulator: regulator source
1581 * Get the current regulator operating mode.
1583 unsigned int regulator_get_mode(struct regulator *regulator)
1585 return _regulator_get_mode(regulator->rdev);
1587 EXPORT_SYMBOL_GPL(regulator_get_mode);
1590 * regulator_set_optimum_mode - set regulator optimum operating mode
1591 * @regulator: regulator source
1592 * @uA_load: load current
1594 * Notifies the regulator core of a new device load. This is then used by
1595 * DRMS (if enabled by constraints) to set the most efficient regulator
1596 * operating mode for the new regulator loading.
1598 * Consumer devices notify their supply regulator of the maximum power
1599 * they will require (can be taken from device datasheet in the power
1600 * consumption tables) when they change operational status and hence power
1601 * state. Examples of operational state changes that can affect power
1602 * consumption are :-
1604 * o Device is opened / closed.
1605 * o Device I/O is about to begin or has just finished.
1606 * o Device is idling in between work.
1608 * This information is also exported via sysfs to userspace.
1610 * DRMS will sum the total requested load on the regulator and change
1611 * to the most efficient operating mode if platform constraints allow.
1613 * Returns the new regulator mode or error.
1615 int regulator_set_optimum_mode(struct regulator *regulator, int uA_load)
1617 struct regulator_dev *rdev = regulator->rdev;
1618 struct regulator *consumer;
1619 int ret, output_uV, input_uV, total_uA_load = 0;
1622 mutex_lock(&rdev->mutex);
1624 regulator->uA_load = uA_load;
1625 ret = regulator_check_drms(rdev);
1631 if (!rdev->desc->ops->get_optimum_mode)
1634 /* get output voltage */
1635 output_uV = rdev->desc->ops->get_voltage(rdev);
1636 if (output_uV <= 0) {
1637 printk(KERN_ERR "%s: invalid output voltage found for %s\n",
1638 __func__, rdev->desc->name);
1642 /* get input voltage */
1643 if (rdev->supply && rdev->supply->desc->ops->get_voltage)
1644 input_uV = rdev->supply->desc->ops->get_voltage(rdev->supply);
1646 input_uV = rdev->constraints->input_uV;
1647 if (input_uV <= 0) {
1648 printk(KERN_ERR "%s: invalid input voltage found for %s\n",
1649 __func__, rdev->desc->name);
1653 /* calc total requested load for this regulator */
1654 list_for_each_entry(consumer, &rdev->consumer_list, list)
1655 total_uA_load += consumer->uA_load;
1657 mode = rdev->desc->ops->get_optimum_mode(rdev,
1658 input_uV, output_uV,
1660 ret = regulator_check_mode(rdev, mode);
1662 printk(KERN_ERR "%s: failed to get optimum mode for %s @"
1663 " %d uA %d -> %d uV\n", __func__, rdev->desc->name,
1664 total_uA_load, input_uV, output_uV);
1668 ret = rdev->desc->ops->set_mode(rdev, mode);
1670 printk(KERN_ERR "%s: failed to set optimum mode %x for %s\n",
1671 __func__, mode, rdev->desc->name);
1676 mutex_unlock(&rdev->mutex);
1679 EXPORT_SYMBOL_GPL(regulator_set_optimum_mode);
1682 * regulator_register_notifier - register regulator event notifier
1683 * @regulator: regulator source
1684 * @nb: notifier block
1686 * Register notifier block to receive regulator events.
1688 int regulator_register_notifier(struct regulator *regulator,
1689 struct notifier_block *nb)
1691 return blocking_notifier_chain_register(®ulator->rdev->notifier,
1694 EXPORT_SYMBOL_GPL(regulator_register_notifier);
1697 * regulator_unregister_notifier - unregister regulator event notifier
1698 * @regulator: regulator source
1699 * @nb: notifier block
1701 * Unregister regulator event notifier block.
1703 int regulator_unregister_notifier(struct regulator *regulator,
1704 struct notifier_block *nb)
1706 return blocking_notifier_chain_unregister(®ulator->rdev->notifier,
1709 EXPORT_SYMBOL_GPL(regulator_unregister_notifier);
1711 /* notify regulator consumers and downstream regulator consumers.
1712 * Note mutex must be held by caller.
1714 static void _notifier_call_chain(struct regulator_dev *rdev,
1715 unsigned long event, void *data)
1717 struct regulator_dev *_rdev;
1719 /* call rdev chain first */
1720 blocking_notifier_call_chain(&rdev->notifier, event, NULL);
1722 /* now notify regulator we supply */
1723 list_for_each_entry(_rdev, &rdev->supply_list, slist) {
1724 mutex_lock(&_rdev->mutex);
1725 _notifier_call_chain(_rdev, event, data);
1726 mutex_unlock(&_rdev->mutex);
1731 * regulator_bulk_get - get multiple regulator consumers
1733 * @dev: Device to supply
1734 * @num_consumers: Number of consumers to register
1735 * @consumers: Configuration of consumers; clients are stored here.
1737 * @return 0 on success, an errno on failure.
1739 * This helper function allows drivers to get several regulator
1740 * consumers in one operation. If any of the regulators cannot be
1741 * acquired then any regulators that were allocated will be freed
1742 * before returning to the caller.
1744 int regulator_bulk_get(struct device *dev, int num_consumers,
1745 struct regulator_bulk_data *consumers)
1750 for (i = 0; i < num_consumers; i++)
1751 consumers[i].consumer = NULL;
1753 for (i = 0; i < num_consumers; i++) {
1754 consumers[i].consumer = regulator_get(dev,
1755 consumers[i].supply);
1756 if (IS_ERR(consumers[i].consumer)) {
1757 dev_err(dev, "Failed to get supply '%s'\n",
1758 consumers[i].supply);
1759 ret = PTR_ERR(consumers[i].consumer);
1760 consumers[i].consumer = NULL;
1768 for (i = 0; i < num_consumers && consumers[i].consumer; i++)
1769 regulator_put(consumers[i].consumer);
1773 EXPORT_SYMBOL_GPL(regulator_bulk_get);
1776 * regulator_bulk_enable - enable multiple regulator consumers
1778 * @num_consumers: Number of consumers
1779 * @consumers: Consumer data; clients are stored here.
1780 * @return 0 on success, an errno on failure
1782 * This convenience API allows consumers to enable multiple regulator
1783 * clients in a single API call. If any consumers cannot be enabled
1784 * then any others that were enabled will be disabled again prior to
1787 int regulator_bulk_enable(int num_consumers,
1788 struct regulator_bulk_data *consumers)
1793 for (i = 0; i < num_consumers; i++) {
1794 ret = regulator_enable(consumers[i].consumer);
1802 printk(KERN_ERR "Failed to enable %s\n", consumers[i].supply);
1803 for (i = 0; i < num_consumers; i++)
1804 regulator_disable(consumers[i].consumer);
1808 EXPORT_SYMBOL_GPL(regulator_bulk_enable);
1811 * regulator_bulk_disable - disable multiple regulator consumers
1813 * @num_consumers: Number of consumers
1814 * @consumers: Consumer data; clients are stored here.
1815 * @return 0 on success, an errno on failure
1817 * This convenience API allows consumers to disable multiple regulator
1818 * clients in a single API call. If any consumers cannot be enabled
1819 * then any others that were disabled will be disabled again prior to
1822 int regulator_bulk_disable(int num_consumers,
1823 struct regulator_bulk_data *consumers)
1828 for (i = 0; i < num_consumers; i++) {
1829 ret = regulator_disable(consumers[i].consumer);
1837 printk(KERN_ERR "Failed to disable %s\n", consumers[i].supply);
1838 for (i = 0; i < num_consumers; i++)
1839 regulator_enable(consumers[i].consumer);
1843 EXPORT_SYMBOL_GPL(regulator_bulk_disable);
1846 * regulator_bulk_free - free multiple regulator consumers
1848 * @num_consumers: Number of consumers
1849 * @consumers: Consumer data; clients are stored here.
1851 * This convenience API allows consumers to free multiple regulator
1852 * clients in a single API call.
1854 void regulator_bulk_free(int num_consumers,
1855 struct regulator_bulk_data *consumers)
1859 for (i = 0; i < num_consumers; i++) {
1860 regulator_put(consumers[i].consumer);
1861 consumers[i].consumer = NULL;
1864 EXPORT_SYMBOL_GPL(regulator_bulk_free);
1867 * regulator_notifier_call_chain - call regulator event notifier
1868 * @rdev: regulator source
1869 * @event: notifier block
1870 * @data: callback-specific data.
1872 * Called by regulator drivers to notify clients a regulator event has
1873 * occurred. We also notify regulator clients downstream.
1874 * Note lock must be held by caller.
1876 int regulator_notifier_call_chain(struct regulator_dev *rdev,
1877 unsigned long event, void *data)
1879 _notifier_call_chain(rdev, event, data);
1883 EXPORT_SYMBOL_GPL(regulator_notifier_call_chain);
1886 * To avoid cluttering sysfs (and memory) with useless state, only
1887 * create attributes that can be meaningfully displayed.
1889 static int add_regulator_attributes(struct regulator_dev *rdev)
1891 struct device *dev = &rdev->dev;
1892 struct regulator_ops *ops = rdev->desc->ops;
1895 /* some attributes need specific methods to be displayed */
1896 if (ops->get_voltage) {
1897 status = device_create_file(dev, &dev_attr_microvolts);
1901 if (ops->get_current_limit) {
1902 status = device_create_file(dev, &dev_attr_microamps);
1906 if (ops->get_mode) {
1907 status = device_create_file(dev, &dev_attr_opmode);
1911 if (ops->is_enabled) {
1912 status = device_create_file(dev, &dev_attr_state);
1916 if (ops->get_status) {
1917 status = device_create_file(dev, &dev_attr_status);
1922 /* some attributes are type-specific */
1923 if (rdev->desc->type == REGULATOR_CURRENT) {
1924 status = device_create_file(dev, &dev_attr_requested_microamps);
1929 /* all the other attributes exist to support constraints;
1930 * don't show them if there are no constraints, or if the
1931 * relevant supporting methods are missing.
1933 if (!rdev->constraints)
1936 /* constraints need specific supporting methods */
1937 if (ops->set_voltage) {
1938 status = device_create_file(dev, &dev_attr_min_microvolts);
1941 status = device_create_file(dev, &dev_attr_max_microvolts);
1945 if (ops->set_current_limit) {
1946 status = device_create_file(dev, &dev_attr_min_microamps);
1949 status = device_create_file(dev, &dev_attr_max_microamps);
1954 /* suspend mode constraints need multiple supporting methods */
1955 if (!(ops->set_suspend_enable && ops->set_suspend_disable))
1958 status = device_create_file(dev, &dev_attr_suspend_standby_state);
1961 status = device_create_file(dev, &dev_attr_suspend_mem_state);
1964 status = device_create_file(dev, &dev_attr_suspend_disk_state);
1968 if (ops->set_suspend_voltage) {
1969 status = device_create_file(dev,
1970 &dev_attr_suspend_standby_microvolts);
1973 status = device_create_file(dev,
1974 &dev_attr_suspend_mem_microvolts);
1977 status = device_create_file(dev,
1978 &dev_attr_suspend_disk_microvolts);
1983 if (ops->set_suspend_mode) {
1984 status = device_create_file(dev,
1985 &dev_attr_suspend_standby_mode);
1988 status = device_create_file(dev,
1989 &dev_attr_suspend_mem_mode);
1992 status = device_create_file(dev,
1993 &dev_attr_suspend_disk_mode);
2002 * regulator_register - register regulator
2003 * @regulator_desc: regulator to register
2004 * @dev: struct device for the regulator
2005 * @init_data: platform provided init data, passed through by driver
2006 * @driver_data: private regulator data
2008 * Called by regulator drivers to register a regulator.
2009 * Returns 0 on success.
2011 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
2012 struct device *dev, struct regulator_init_data *init_data,
2015 static atomic_t regulator_no = ATOMIC_INIT(0);
2016 struct regulator_dev *rdev;
2019 if (regulator_desc == NULL)
2020 return ERR_PTR(-EINVAL);
2022 if (regulator_desc->name == NULL || regulator_desc->ops == NULL)
2023 return ERR_PTR(-EINVAL);
2025 if (!regulator_desc->type == REGULATOR_VOLTAGE &&
2026 !regulator_desc->type == REGULATOR_CURRENT)
2027 return ERR_PTR(-EINVAL);
2030 return ERR_PTR(-EINVAL);
2032 rdev = kzalloc(sizeof(struct regulator_dev), GFP_KERNEL);
2034 return ERR_PTR(-ENOMEM);
2036 mutex_lock(®ulator_list_mutex);
2038 mutex_init(&rdev->mutex);
2039 rdev->reg_data = driver_data;
2040 rdev->owner = regulator_desc->owner;
2041 rdev->desc = regulator_desc;
2042 INIT_LIST_HEAD(&rdev->consumer_list);
2043 INIT_LIST_HEAD(&rdev->supply_list);
2044 INIT_LIST_HEAD(&rdev->list);
2045 INIT_LIST_HEAD(&rdev->slist);
2046 BLOCKING_INIT_NOTIFIER_HEAD(&rdev->notifier);
2048 /* preform any regulator specific init */
2049 if (init_data->regulator_init) {
2050 ret = init_data->regulator_init(rdev->reg_data);
2055 /* register with sysfs */
2056 rdev->dev.class = ®ulator_class;
2057 rdev->dev.parent = dev;
2058 dev_set_name(&rdev->dev, "regulator.%d",
2059 atomic_inc_return(®ulator_no) - 1);
2060 ret = device_register(&rdev->dev);
2064 dev_set_drvdata(&rdev->dev, rdev);
2066 /* set regulator constraints */
2067 ret = set_machine_constraints(rdev, &init_data->constraints);
2071 /* add attributes supported by this regulator */
2072 ret = add_regulator_attributes(rdev);
2076 /* set supply regulator if it exists */
2077 if (init_data->supply_regulator_dev) {
2078 ret = set_supply(rdev,
2079 dev_get_drvdata(init_data->supply_regulator_dev));
2084 /* add consumers devices */
2085 for (i = 0; i < init_data->num_consumer_supplies; i++) {
2086 ret = set_consumer_device_supply(rdev,
2087 init_data->consumer_supplies[i].dev,
2088 init_data->consumer_supplies[i].supply);
2090 for (--i; i >= 0; i--)
2091 unset_consumer_device_supply(rdev,
2092 init_data->consumer_supplies[i].dev);
2097 list_add(&rdev->list, ®ulator_list);
2099 mutex_unlock(®ulator_list_mutex);
2103 device_unregister(&rdev->dev);
2106 rdev = ERR_PTR(ret);
2109 EXPORT_SYMBOL_GPL(regulator_register);
2112 * regulator_unregister - unregister regulator
2113 * @rdev: regulator to unregister
2115 * Called by regulator drivers to unregister a regulator.
2117 void regulator_unregister(struct regulator_dev *rdev)
2122 mutex_lock(®ulator_list_mutex);
2123 unset_regulator_supplies(rdev);
2124 list_del(&rdev->list);
2126 sysfs_remove_link(&rdev->dev.kobj, "supply");
2127 device_unregister(&rdev->dev);
2128 mutex_unlock(®ulator_list_mutex);
2130 EXPORT_SYMBOL_GPL(regulator_unregister);
2133 * regulator_suspend_prepare - prepare regulators for system wide suspend
2134 * @state: system suspend state
2136 * Configure each regulator with it's suspend operating parameters for state.
2137 * This will usually be called by machine suspend code prior to supending.
2139 int regulator_suspend_prepare(suspend_state_t state)
2141 struct regulator_dev *rdev;
2144 /* ON is handled by regulator active state */
2145 if (state == PM_SUSPEND_ON)
2148 mutex_lock(®ulator_list_mutex);
2149 list_for_each_entry(rdev, ®ulator_list, list) {
2151 mutex_lock(&rdev->mutex);
2152 ret = suspend_prepare(rdev, state);
2153 mutex_unlock(&rdev->mutex);
2156 printk(KERN_ERR "%s: failed to prepare %s\n",
2157 __func__, rdev->desc->name);
2162 mutex_unlock(®ulator_list_mutex);
2165 EXPORT_SYMBOL_GPL(regulator_suspend_prepare);
2168 * rdev_get_drvdata - get rdev regulator driver data
2171 * Get rdev regulator driver private data. This call can be used in the
2172 * regulator driver context.
2174 void *rdev_get_drvdata(struct regulator_dev *rdev)
2176 return rdev->reg_data;
2178 EXPORT_SYMBOL_GPL(rdev_get_drvdata);
2181 * regulator_get_drvdata - get regulator driver data
2182 * @regulator: regulator
2184 * Get regulator driver private data. This call can be used in the consumer
2185 * driver context when non API regulator specific functions need to be called.
2187 void *regulator_get_drvdata(struct regulator *regulator)
2189 return regulator->rdev->reg_data;
2191 EXPORT_SYMBOL_GPL(regulator_get_drvdata);
2194 * regulator_set_drvdata - set regulator driver data
2195 * @regulator: regulator
2198 void regulator_set_drvdata(struct regulator *regulator, void *data)
2200 regulator->rdev->reg_data = data;
2202 EXPORT_SYMBOL_GPL(regulator_set_drvdata);
2205 * regulator_get_id - get regulator ID
2208 int rdev_get_id(struct regulator_dev *rdev)
2210 return rdev->desc->id;
2212 EXPORT_SYMBOL_GPL(rdev_get_id);
2214 struct device *rdev_get_dev(struct regulator_dev *rdev)
2218 EXPORT_SYMBOL_GPL(rdev_get_dev);
2220 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data)
2222 return reg_init_data->driver_data;
2224 EXPORT_SYMBOL_GPL(regulator_get_init_drvdata);
2226 static int __init regulator_init(void)
2228 printk(KERN_INFO "regulator: core version %s\n", REGULATOR_VERSION);
2229 return class_register(®ulator_class);
2232 /* init early to allow our consumers to complete system booting */
2233 core_initcall(regulator_init);