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 rdev->constraints = constraints;
697 /* do we need to apply the constraint voltage */
698 if (rdev->constraints->apply_uV &&
699 rdev->constraints->min_uV == rdev->constraints->max_uV &&
701 ret = ops->set_voltage(rdev,
702 rdev->constraints->min_uV, rdev->constraints->max_uV);
704 printk(KERN_ERR "%s: failed to apply %duV constraint to %s\n",
706 rdev->constraints->min_uV, name);
707 rdev->constraints = NULL;
712 /* are we enabled at boot time by firmware / bootloader */
713 if (rdev->constraints->boot_on)
716 /* do we need to setup our suspend state */
717 if (constraints->initial_state) {
718 ret = suspend_prepare(rdev, constraints->initial_state);
720 printk(KERN_ERR "%s: failed to set suspend state for %s\n",
722 rdev->constraints = NULL;
727 if (constraints->initial_mode) {
728 if (!ops->set_mode) {
729 printk(KERN_ERR "%s: no set_mode operation for %s\n",
735 ret = ops->set_mode(rdev, constraints->initial_mode);
738 "%s: failed to set initial mode for %s: %d\n",
739 __func__, name, ret);
744 /* if always_on is set then turn the regulator on if it's not
746 if (constraints->always_on && ops->enable &&
747 ((ops->is_enabled && !ops->is_enabled(rdev)) ||
748 (!ops->is_enabled && !constraints->boot_on))) {
749 ret = ops->enable(rdev);
751 printk(KERN_ERR "%s: failed to enable %s\n",
753 rdev->constraints = NULL;
758 print_constraints(rdev);
764 * set_supply - set regulator supply regulator
765 * @rdev: regulator name
766 * @supply_rdev: supply regulator name
768 * Called by platform initialisation code to set the supply regulator for this
769 * regulator. This ensures that a regulators supply will also be enabled by the
770 * core if it's child is enabled.
772 static int set_supply(struct regulator_dev *rdev,
773 struct regulator_dev *supply_rdev)
777 err = sysfs_create_link(&rdev->dev.kobj, &supply_rdev->dev.kobj,
781 "%s: could not add device link %s err %d\n",
782 __func__, supply_rdev->dev.kobj.name, err);
785 rdev->supply = supply_rdev;
786 list_add(&rdev->slist, &supply_rdev->supply_list);
792 * set_consumer_device_supply: Bind a regulator to a symbolic supply
793 * @rdev: regulator source
794 * @consumer_dev: device the supply applies to
795 * @supply: symbolic name for supply
797 * Allows platform initialisation code to map physical regulator
798 * sources to symbolic names for supplies for use by devices. Devices
799 * should use these symbolic names to request regulators, avoiding the
800 * need to provide board-specific regulator names as platform data.
802 static int set_consumer_device_supply(struct regulator_dev *rdev,
803 struct device *consumer_dev, const char *supply)
805 struct regulator_map *node;
810 list_for_each_entry(node, ®ulator_map_list, list) {
811 if (consumer_dev != node->dev)
813 if (strcmp(node->supply, supply) != 0)
816 dev_dbg(consumer_dev, "%s/%s is '%s' supply; fail %s/%s\n",
817 dev_name(&node->regulator->dev),
818 node->regulator->desc->name,
820 dev_name(&rdev->dev), rdev->desc->name);
824 node = kmalloc(sizeof(struct regulator_map), GFP_KERNEL);
828 node->regulator = rdev;
829 node->dev = consumer_dev;
830 node->supply = supply;
832 list_add(&node->list, ®ulator_map_list);
836 static void unset_consumer_device_supply(struct regulator_dev *rdev,
837 struct device *consumer_dev)
839 struct regulator_map *node, *n;
841 list_for_each_entry_safe(node, n, ®ulator_map_list, list) {
842 if (rdev == node->regulator &&
843 consumer_dev == node->dev) {
844 list_del(&node->list);
851 static void unset_regulator_supplies(struct regulator_dev *rdev)
853 struct regulator_map *node, *n;
855 list_for_each_entry_safe(node, n, ®ulator_map_list, list) {
856 if (rdev == node->regulator) {
857 list_del(&node->list);
864 #define REG_STR_SIZE 32
866 static struct regulator *create_regulator(struct regulator_dev *rdev,
868 const char *supply_name)
870 struct regulator *regulator;
871 char buf[REG_STR_SIZE];
874 regulator = kzalloc(sizeof(*regulator), GFP_KERNEL);
875 if (regulator == NULL)
878 mutex_lock(&rdev->mutex);
879 regulator->rdev = rdev;
880 list_add(®ulator->list, &rdev->consumer_list);
883 /* create a 'requested_microamps_name' sysfs entry */
884 size = scnprintf(buf, REG_STR_SIZE, "microamps_requested_%s",
886 if (size >= REG_STR_SIZE)
889 regulator->dev = dev;
890 regulator->dev_attr.attr.name = kstrdup(buf, GFP_KERNEL);
891 if (regulator->dev_attr.attr.name == NULL)
894 regulator->dev_attr.attr.owner = THIS_MODULE;
895 regulator->dev_attr.attr.mode = 0444;
896 regulator->dev_attr.show = device_requested_uA_show;
897 err = device_create_file(dev, ®ulator->dev_attr);
899 printk(KERN_WARNING "%s: could not add regulator_dev"
900 " load sysfs\n", __func__);
904 /* also add a link to the device sysfs entry */
905 size = scnprintf(buf, REG_STR_SIZE, "%s-%s",
906 dev->kobj.name, supply_name);
907 if (size >= REG_STR_SIZE)
910 regulator->supply_name = kstrdup(buf, GFP_KERNEL);
911 if (regulator->supply_name == NULL)
914 err = sysfs_create_link(&rdev->dev.kobj, &dev->kobj,
918 "%s: could not add device link %s err %d\n",
919 __func__, dev->kobj.name, err);
920 device_remove_file(dev, ®ulator->dev_attr);
924 mutex_unlock(&rdev->mutex);
927 kfree(regulator->supply_name);
929 device_remove_file(regulator->dev, ®ulator->dev_attr);
931 kfree(regulator->dev_attr.attr.name);
933 list_del(®ulator->list);
935 mutex_unlock(&rdev->mutex);
940 * regulator_get - lookup and obtain a reference to a regulator.
941 * @dev: device for regulator "consumer"
942 * @id: Supply name or regulator ID.
944 * Returns a struct regulator corresponding to the regulator producer,
945 * or IS_ERR() condition containing errno.
947 * Use of supply names configured via regulator_set_device_supply() is
948 * strongly encouraged. It is recommended that the supply name used
949 * should match the name used for the supply and/or the relevant
950 * device pins in the datasheet.
952 struct regulator *regulator_get(struct device *dev, const char *id)
954 struct regulator_dev *rdev;
955 struct regulator_map *map;
956 struct regulator *regulator = ERR_PTR(-ENODEV);
959 printk(KERN_ERR "regulator: get() with no identifier\n");
963 mutex_lock(®ulator_list_mutex);
965 list_for_each_entry(map, ®ulator_map_list, list) {
966 if (dev == map->dev &&
967 strcmp(map->supply, id) == 0) {
968 rdev = map->regulator;
972 printk(KERN_ERR "regulator: Unable to get requested regulator: %s\n",
974 mutex_unlock(®ulator_list_mutex);
978 if (!try_module_get(rdev->owner))
981 regulator = create_regulator(rdev, dev, id);
982 if (regulator == NULL) {
983 regulator = ERR_PTR(-ENOMEM);
984 module_put(rdev->owner);
988 mutex_unlock(®ulator_list_mutex);
991 EXPORT_SYMBOL_GPL(regulator_get);
994 * regulator_put - "free" the regulator source
995 * @regulator: regulator source
997 * Note: drivers must ensure that all regulator_enable calls made on this
998 * regulator source are balanced by regulator_disable calls prior to calling
1001 void regulator_put(struct regulator *regulator)
1003 struct regulator_dev *rdev;
1005 if (regulator == NULL || IS_ERR(regulator))
1008 mutex_lock(®ulator_list_mutex);
1009 rdev = regulator->rdev;
1011 if (WARN(regulator->enabled, "Releasing supply %s while enabled\n",
1012 regulator->supply_name))
1013 _regulator_disable(rdev);
1015 /* remove any sysfs entries */
1016 if (regulator->dev) {
1017 sysfs_remove_link(&rdev->dev.kobj, regulator->supply_name);
1018 kfree(regulator->supply_name);
1019 device_remove_file(regulator->dev, ®ulator->dev_attr);
1020 kfree(regulator->dev_attr.attr.name);
1022 list_del(®ulator->list);
1025 module_put(rdev->owner);
1026 mutex_unlock(®ulator_list_mutex);
1028 EXPORT_SYMBOL_GPL(regulator_put);
1030 /* locks held by regulator_enable() */
1031 static int _regulator_enable(struct regulator_dev *rdev)
1035 if (!rdev->constraints) {
1036 printk(KERN_ERR "%s: %s has no constraints\n",
1037 __func__, rdev->desc->name);
1041 /* do we need to enable the supply regulator first */
1043 ret = _regulator_enable(rdev->supply);
1045 printk(KERN_ERR "%s: failed to enable %s: %d\n",
1046 __func__, rdev->desc->name, ret);
1051 /* check voltage and requested load before enabling */
1052 if (rdev->desc->ops->enable) {
1054 if (rdev->constraints &&
1055 (rdev->constraints->valid_ops_mask &
1056 REGULATOR_CHANGE_DRMS))
1057 drms_uA_update(rdev);
1059 ret = rdev->desc->ops->enable(rdev);
1061 printk(KERN_ERR "%s: failed to enable %s: %d\n",
1062 __func__, rdev->desc->name, ret);
1073 * regulator_enable - enable regulator output
1074 * @regulator: regulator source
1076 * Request that the regulator be enabled with the regulator output at
1077 * the predefined voltage or current value. Calls to regulator_enable()
1078 * must be balanced with calls to regulator_disable().
1080 * NOTE: the output value can be set by other drivers, boot loader or may be
1081 * hardwired in the regulator.
1083 int regulator_enable(struct regulator *regulator)
1085 struct regulator_dev *rdev = regulator->rdev;
1088 mutex_lock(&rdev->mutex);
1089 if (regulator->enabled == 0)
1090 ret = _regulator_enable(rdev);
1091 else if (regulator->enabled < 0)
1094 regulator->enabled++;
1095 mutex_unlock(&rdev->mutex);
1098 EXPORT_SYMBOL_GPL(regulator_enable);
1100 /* locks held by regulator_disable() */
1101 static int _regulator_disable(struct regulator_dev *rdev)
1105 /* are we the last user and permitted to disable ? */
1106 if (rdev->use_count == 1 && !rdev->constraints->always_on) {
1108 /* we are last user */
1109 if (rdev->desc->ops->disable) {
1110 ret = rdev->desc->ops->disable(rdev);
1112 printk(KERN_ERR "%s: failed to disable %s\n",
1113 __func__, rdev->desc->name);
1118 /* decrease our supplies ref count and disable if required */
1120 _regulator_disable(rdev->supply);
1122 rdev->use_count = 0;
1123 } else if (rdev->use_count > 1) {
1125 if (rdev->constraints &&
1126 (rdev->constraints->valid_ops_mask &
1127 REGULATOR_CHANGE_DRMS))
1128 drms_uA_update(rdev);
1136 * regulator_disable - disable regulator output
1137 * @regulator: regulator source
1139 * Disable the regulator output voltage or current. Calls to
1140 * regulator_enable() must be balanced with calls to
1141 * regulator_disable().
1143 * NOTE: this will only disable the regulator output if no other consumer
1144 * devices have it enabled, the regulator device supports disabling and
1145 * machine constraints permit this operation.
1147 int regulator_disable(struct regulator *regulator)
1149 struct regulator_dev *rdev = regulator->rdev;
1152 mutex_lock(&rdev->mutex);
1153 if (regulator->enabled == 1) {
1154 ret = _regulator_disable(rdev);
1156 regulator->uA_load = 0;
1157 } else if (WARN(regulator->enabled <= 0,
1158 "unbalanced disables for supply %s\n",
1159 regulator->supply_name))
1162 regulator->enabled--;
1163 mutex_unlock(&rdev->mutex);
1166 EXPORT_SYMBOL_GPL(regulator_disable);
1168 /* locks held by regulator_force_disable() */
1169 static int _regulator_force_disable(struct regulator_dev *rdev)
1174 if (rdev->desc->ops->disable) {
1175 /* ah well, who wants to live forever... */
1176 ret = rdev->desc->ops->disable(rdev);
1178 printk(KERN_ERR "%s: failed to force disable %s\n",
1179 __func__, rdev->desc->name);
1182 /* notify other consumers that power has been forced off */
1183 _notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE,
1187 /* decrease our supplies ref count and disable if required */
1189 _regulator_disable(rdev->supply);
1191 rdev->use_count = 0;
1196 * regulator_force_disable - force disable regulator output
1197 * @regulator: regulator source
1199 * Forcibly disable the regulator output voltage or current.
1200 * NOTE: this *will* disable the regulator output even if other consumer
1201 * devices have it enabled. This should be used for situations when device
1202 * damage will likely occur if the regulator is not disabled (e.g. over temp).
1204 int regulator_force_disable(struct regulator *regulator)
1208 mutex_lock(®ulator->rdev->mutex);
1209 regulator->enabled = 0;
1210 regulator->uA_load = 0;
1211 ret = _regulator_force_disable(regulator->rdev);
1212 mutex_unlock(®ulator->rdev->mutex);
1215 EXPORT_SYMBOL_GPL(regulator_force_disable);
1217 static int _regulator_is_enabled(struct regulator_dev *rdev)
1221 mutex_lock(&rdev->mutex);
1224 if (!rdev->desc->ops->is_enabled) {
1229 ret = rdev->desc->ops->is_enabled(rdev);
1231 mutex_unlock(&rdev->mutex);
1236 * regulator_is_enabled - is the regulator output enabled
1237 * @regulator: regulator source
1239 * Returns positive if the regulator driver backing the source/client
1240 * has requested that the device be enabled, zero if it hasn't, else a
1241 * negative errno code.
1243 * Note that the device backing this regulator handle can have multiple
1244 * users, so it might be enabled even if regulator_enable() was never
1245 * called for this particular source.
1247 int regulator_is_enabled(struct regulator *regulator)
1249 return _regulator_is_enabled(regulator->rdev);
1251 EXPORT_SYMBOL_GPL(regulator_is_enabled);
1254 * regulator_set_voltage - set regulator output voltage
1255 * @regulator: regulator source
1256 * @min_uV: Minimum required voltage in uV
1257 * @max_uV: Maximum acceptable voltage in uV
1259 * Sets a voltage regulator to the desired output voltage. This can be set
1260 * during any regulator state. IOW, regulator can be disabled or enabled.
1262 * If the regulator is enabled then the voltage will change to the new value
1263 * immediately otherwise if the regulator is disabled the regulator will
1264 * output at the new voltage when enabled.
1266 * NOTE: If the regulator is shared between several devices then the lowest
1267 * request voltage that meets the system constraints will be used.
1268 * Regulator system constraints must be set for this regulator before
1269 * calling this function otherwise this call will fail.
1271 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
1273 struct regulator_dev *rdev = regulator->rdev;
1276 mutex_lock(&rdev->mutex);
1279 if (!rdev->desc->ops->set_voltage) {
1284 /* constraints check */
1285 ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
1288 regulator->min_uV = min_uV;
1289 regulator->max_uV = max_uV;
1290 ret = rdev->desc->ops->set_voltage(rdev, min_uV, max_uV);
1293 _notifier_call_chain(rdev, REGULATOR_EVENT_VOLTAGE_CHANGE, NULL);
1294 mutex_unlock(&rdev->mutex);
1297 EXPORT_SYMBOL_GPL(regulator_set_voltage);
1299 static int _regulator_get_voltage(struct regulator_dev *rdev)
1302 if (rdev->desc->ops->get_voltage)
1303 return rdev->desc->ops->get_voltage(rdev);
1309 * regulator_get_voltage - get regulator output voltage
1310 * @regulator: regulator source
1312 * This returns the current regulator voltage in uV.
1314 * NOTE: If the regulator is disabled it will return the voltage value. This
1315 * function should not be used to determine regulator state.
1317 int regulator_get_voltage(struct regulator *regulator)
1321 mutex_lock(®ulator->rdev->mutex);
1323 ret = _regulator_get_voltage(regulator->rdev);
1325 mutex_unlock(®ulator->rdev->mutex);
1329 EXPORT_SYMBOL_GPL(regulator_get_voltage);
1332 * regulator_set_current_limit - set regulator output current limit
1333 * @regulator: regulator source
1334 * @min_uA: Minimuum supported current in uA
1335 * @max_uA: Maximum supported current in uA
1337 * Sets current sink to the desired output current. This can be set during
1338 * any regulator state. IOW, regulator can be disabled or enabled.
1340 * If the regulator is enabled then the current will change to the new value
1341 * immediately otherwise if the regulator is disabled the regulator will
1342 * output at the new current when enabled.
1344 * NOTE: Regulator system constraints must be set for this regulator before
1345 * calling this function otherwise this call will fail.
1347 int regulator_set_current_limit(struct regulator *regulator,
1348 int min_uA, int max_uA)
1350 struct regulator_dev *rdev = regulator->rdev;
1353 mutex_lock(&rdev->mutex);
1356 if (!rdev->desc->ops->set_current_limit) {
1361 /* constraints check */
1362 ret = regulator_check_current_limit(rdev, &min_uA, &max_uA);
1366 ret = rdev->desc->ops->set_current_limit(rdev, min_uA, max_uA);
1368 mutex_unlock(&rdev->mutex);
1371 EXPORT_SYMBOL_GPL(regulator_set_current_limit);
1373 static int _regulator_get_current_limit(struct regulator_dev *rdev)
1377 mutex_lock(&rdev->mutex);
1380 if (!rdev->desc->ops->get_current_limit) {
1385 ret = rdev->desc->ops->get_current_limit(rdev);
1387 mutex_unlock(&rdev->mutex);
1392 * regulator_get_current_limit - get regulator output current
1393 * @regulator: regulator source
1395 * This returns the current supplied by the specified current sink in uA.
1397 * NOTE: If the regulator is disabled it will return the current value. This
1398 * function should not be used to determine regulator state.
1400 int regulator_get_current_limit(struct regulator *regulator)
1402 return _regulator_get_current_limit(regulator->rdev);
1404 EXPORT_SYMBOL_GPL(regulator_get_current_limit);
1407 * regulator_set_mode - set regulator operating mode
1408 * @regulator: regulator source
1409 * @mode: operating mode - one of the REGULATOR_MODE constants
1411 * Set regulator operating mode to increase regulator efficiency or improve
1412 * regulation performance.
1414 * NOTE: Regulator system constraints must be set for this regulator before
1415 * calling this function otherwise this call will fail.
1417 int regulator_set_mode(struct regulator *regulator, unsigned int mode)
1419 struct regulator_dev *rdev = regulator->rdev;
1422 mutex_lock(&rdev->mutex);
1425 if (!rdev->desc->ops->set_mode) {
1430 /* constraints check */
1431 ret = regulator_check_mode(rdev, mode);
1435 ret = rdev->desc->ops->set_mode(rdev, mode);
1437 mutex_unlock(&rdev->mutex);
1440 EXPORT_SYMBOL_GPL(regulator_set_mode);
1442 static unsigned int _regulator_get_mode(struct regulator_dev *rdev)
1446 mutex_lock(&rdev->mutex);
1449 if (!rdev->desc->ops->get_mode) {
1454 ret = rdev->desc->ops->get_mode(rdev);
1456 mutex_unlock(&rdev->mutex);
1461 * regulator_get_mode - get regulator operating mode
1462 * @regulator: regulator source
1464 * Get the current regulator operating mode.
1466 unsigned int regulator_get_mode(struct regulator *regulator)
1468 return _regulator_get_mode(regulator->rdev);
1470 EXPORT_SYMBOL_GPL(regulator_get_mode);
1473 * regulator_set_optimum_mode - set regulator optimum operating mode
1474 * @regulator: regulator source
1475 * @uA_load: load current
1477 * Notifies the regulator core of a new device load. This is then used by
1478 * DRMS (if enabled by constraints) to set the most efficient regulator
1479 * operating mode for the new regulator loading.
1481 * Consumer devices notify their supply regulator of the maximum power
1482 * they will require (can be taken from device datasheet in the power
1483 * consumption tables) when they change operational status and hence power
1484 * state. Examples of operational state changes that can affect power
1485 * consumption are :-
1487 * o Device is opened / closed.
1488 * o Device I/O is about to begin or has just finished.
1489 * o Device is idling in between work.
1491 * This information is also exported via sysfs to userspace.
1493 * DRMS will sum the total requested load on the regulator and change
1494 * to the most efficient operating mode if platform constraints allow.
1496 * Returns the new regulator mode or error.
1498 int regulator_set_optimum_mode(struct regulator *regulator, int uA_load)
1500 struct regulator_dev *rdev = regulator->rdev;
1501 struct regulator *consumer;
1502 int ret, output_uV, input_uV, total_uA_load = 0;
1505 mutex_lock(&rdev->mutex);
1507 regulator->uA_load = uA_load;
1508 ret = regulator_check_drms(rdev);
1514 if (!rdev->desc->ops->get_optimum_mode)
1517 /* get output voltage */
1518 output_uV = rdev->desc->ops->get_voltage(rdev);
1519 if (output_uV <= 0) {
1520 printk(KERN_ERR "%s: invalid output voltage found for %s\n",
1521 __func__, rdev->desc->name);
1525 /* get input voltage */
1526 if (rdev->supply && rdev->supply->desc->ops->get_voltage)
1527 input_uV = rdev->supply->desc->ops->get_voltage(rdev->supply);
1529 input_uV = rdev->constraints->input_uV;
1530 if (input_uV <= 0) {
1531 printk(KERN_ERR "%s: invalid input voltage found for %s\n",
1532 __func__, rdev->desc->name);
1536 /* calc total requested load for this regulator */
1537 list_for_each_entry(consumer, &rdev->consumer_list, list)
1538 total_uA_load += consumer->uA_load;
1540 mode = rdev->desc->ops->get_optimum_mode(rdev,
1541 input_uV, output_uV,
1543 ret = regulator_check_mode(rdev, mode);
1545 printk(KERN_ERR "%s: failed to get optimum mode for %s @"
1546 " %d uA %d -> %d uV\n", __func__, rdev->desc->name,
1547 total_uA_load, input_uV, output_uV);
1551 ret = rdev->desc->ops->set_mode(rdev, mode);
1553 printk(KERN_ERR "%s: failed to set optimum mode %x for %s\n",
1554 __func__, mode, rdev->desc->name);
1559 mutex_unlock(&rdev->mutex);
1562 EXPORT_SYMBOL_GPL(regulator_set_optimum_mode);
1565 * regulator_register_notifier - register regulator event notifier
1566 * @regulator: regulator source
1567 * @nb: notifier block
1569 * Register notifier block to receive regulator events.
1571 int regulator_register_notifier(struct regulator *regulator,
1572 struct notifier_block *nb)
1574 return blocking_notifier_chain_register(®ulator->rdev->notifier,
1577 EXPORT_SYMBOL_GPL(regulator_register_notifier);
1580 * regulator_unregister_notifier - unregister regulator event notifier
1581 * @regulator: regulator source
1582 * @nb: notifier block
1584 * Unregister regulator event notifier block.
1586 int regulator_unregister_notifier(struct regulator *regulator,
1587 struct notifier_block *nb)
1589 return blocking_notifier_chain_unregister(®ulator->rdev->notifier,
1592 EXPORT_SYMBOL_GPL(regulator_unregister_notifier);
1594 /* notify regulator consumers and downstream regulator consumers.
1595 * Note mutex must be held by caller.
1597 static void _notifier_call_chain(struct regulator_dev *rdev,
1598 unsigned long event, void *data)
1600 struct regulator_dev *_rdev;
1602 /* call rdev chain first */
1603 blocking_notifier_call_chain(&rdev->notifier, event, NULL);
1605 /* now notify regulator we supply */
1606 list_for_each_entry(_rdev, &rdev->supply_list, slist) {
1607 mutex_lock(&_rdev->mutex);
1608 _notifier_call_chain(_rdev, event, data);
1609 mutex_unlock(&_rdev->mutex);
1614 * regulator_bulk_get - get multiple regulator consumers
1616 * @dev: Device to supply
1617 * @num_consumers: Number of consumers to register
1618 * @consumers: Configuration of consumers; clients are stored here.
1620 * @return 0 on success, an errno on failure.
1622 * This helper function allows drivers to get several regulator
1623 * consumers in one operation. If any of the regulators cannot be
1624 * acquired then any regulators that were allocated will be freed
1625 * before returning to the caller.
1627 int regulator_bulk_get(struct device *dev, int num_consumers,
1628 struct regulator_bulk_data *consumers)
1633 for (i = 0; i < num_consumers; i++)
1634 consumers[i].consumer = NULL;
1636 for (i = 0; i < num_consumers; i++) {
1637 consumers[i].consumer = regulator_get(dev,
1638 consumers[i].supply);
1639 if (IS_ERR(consumers[i].consumer)) {
1640 dev_err(dev, "Failed to get supply '%s'\n",
1641 consumers[i].supply);
1642 ret = PTR_ERR(consumers[i].consumer);
1643 consumers[i].consumer = NULL;
1651 for (i = 0; i < num_consumers && consumers[i].consumer; i++)
1652 regulator_put(consumers[i].consumer);
1656 EXPORT_SYMBOL_GPL(regulator_bulk_get);
1659 * regulator_bulk_enable - enable multiple regulator consumers
1661 * @num_consumers: Number of consumers
1662 * @consumers: Consumer data; clients are stored here.
1663 * @return 0 on success, an errno on failure
1665 * This convenience API allows consumers to enable multiple regulator
1666 * clients in a single API call. If any consumers cannot be enabled
1667 * then any others that were enabled will be disabled again prior to
1670 int regulator_bulk_enable(int num_consumers,
1671 struct regulator_bulk_data *consumers)
1676 for (i = 0; i < num_consumers; i++) {
1677 ret = regulator_enable(consumers[i].consumer);
1685 printk(KERN_ERR "Failed to enable %s\n", consumers[i].supply);
1686 for (i = 0; i < num_consumers; i++)
1687 regulator_disable(consumers[i].consumer);
1691 EXPORT_SYMBOL_GPL(regulator_bulk_enable);
1694 * regulator_bulk_disable - disable multiple regulator consumers
1696 * @num_consumers: Number of consumers
1697 * @consumers: Consumer data; clients are stored here.
1698 * @return 0 on success, an errno on failure
1700 * This convenience API allows consumers to disable multiple regulator
1701 * clients in a single API call. If any consumers cannot be enabled
1702 * then any others that were disabled will be disabled again prior to
1705 int regulator_bulk_disable(int num_consumers,
1706 struct regulator_bulk_data *consumers)
1711 for (i = 0; i < num_consumers; i++) {
1712 ret = regulator_disable(consumers[i].consumer);
1720 printk(KERN_ERR "Failed to disable %s\n", consumers[i].supply);
1721 for (i = 0; i < num_consumers; i++)
1722 regulator_enable(consumers[i].consumer);
1726 EXPORT_SYMBOL_GPL(regulator_bulk_disable);
1729 * regulator_bulk_free - free multiple regulator consumers
1731 * @num_consumers: Number of consumers
1732 * @consumers: Consumer data; clients are stored here.
1734 * This convenience API allows consumers to free multiple regulator
1735 * clients in a single API call.
1737 void regulator_bulk_free(int num_consumers,
1738 struct regulator_bulk_data *consumers)
1742 for (i = 0; i < num_consumers; i++) {
1743 regulator_put(consumers[i].consumer);
1744 consumers[i].consumer = NULL;
1747 EXPORT_SYMBOL_GPL(regulator_bulk_free);
1750 * regulator_notifier_call_chain - call regulator event notifier
1751 * @rdev: regulator source
1752 * @event: notifier block
1753 * @data: callback-specific data.
1755 * Called by regulator drivers to notify clients a regulator event has
1756 * occurred. We also notify regulator clients downstream.
1757 * Note lock must be held by caller.
1759 int regulator_notifier_call_chain(struct regulator_dev *rdev,
1760 unsigned long event, void *data)
1762 _notifier_call_chain(rdev, event, data);
1766 EXPORT_SYMBOL_GPL(regulator_notifier_call_chain);
1769 * To avoid cluttering sysfs (and memory) with useless state, only
1770 * create attributes that can be meaningfully displayed.
1772 static int add_regulator_attributes(struct regulator_dev *rdev)
1774 struct device *dev = &rdev->dev;
1775 struct regulator_ops *ops = rdev->desc->ops;
1778 /* some attributes need specific methods to be displayed */
1779 if (ops->get_voltage) {
1780 status = device_create_file(dev, &dev_attr_microvolts);
1784 if (ops->get_current_limit) {
1785 status = device_create_file(dev, &dev_attr_microamps);
1789 if (ops->get_mode) {
1790 status = device_create_file(dev, &dev_attr_opmode);
1794 if (ops->is_enabled) {
1795 status = device_create_file(dev, &dev_attr_state);
1799 if (ops->get_status) {
1800 status = device_create_file(dev, &dev_attr_status);
1805 /* some attributes are type-specific */
1806 if (rdev->desc->type == REGULATOR_CURRENT) {
1807 status = device_create_file(dev, &dev_attr_requested_microamps);
1812 /* all the other attributes exist to support constraints;
1813 * don't show them if there are no constraints, or if the
1814 * relevant supporting methods are missing.
1816 if (!rdev->constraints)
1819 /* constraints need specific supporting methods */
1820 if (ops->set_voltage) {
1821 status = device_create_file(dev, &dev_attr_min_microvolts);
1824 status = device_create_file(dev, &dev_attr_max_microvolts);
1828 if (ops->set_current_limit) {
1829 status = device_create_file(dev, &dev_attr_min_microamps);
1832 status = device_create_file(dev, &dev_attr_max_microamps);
1837 /* suspend mode constraints need multiple supporting methods */
1838 if (!(ops->set_suspend_enable && ops->set_suspend_disable))
1841 status = device_create_file(dev, &dev_attr_suspend_standby_state);
1844 status = device_create_file(dev, &dev_attr_suspend_mem_state);
1847 status = device_create_file(dev, &dev_attr_suspend_disk_state);
1851 if (ops->set_suspend_voltage) {
1852 status = device_create_file(dev,
1853 &dev_attr_suspend_standby_microvolts);
1856 status = device_create_file(dev,
1857 &dev_attr_suspend_mem_microvolts);
1860 status = device_create_file(dev,
1861 &dev_attr_suspend_disk_microvolts);
1866 if (ops->set_suspend_mode) {
1867 status = device_create_file(dev,
1868 &dev_attr_suspend_standby_mode);
1871 status = device_create_file(dev,
1872 &dev_attr_suspend_mem_mode);
1875 status = device_create_file(dev,
1876 &dev_attr_suspend_disk_mode);
1885 * regulator_register - register regulator
1886 * @regulator_desc: regulator to register
1887 * @dev: struct device for the regulator
1888 * @init_data: platform provided init data, passed through by driver
1889 * @driver_data: private regulator data
1891 * Called by regulator drivers to register a regulator.
1892 * Returns 0 on success.
1894 struct regulator_dev *regulator_register(struct regulator_desc *regulator_desc,
1895 struct device *dev, struct regulator_init_data *init_data,
1898 static atomic_t regulator_no = ATOMIC_INIT(0);
1899 struct regulator_dev *rdev;
1902 if (regulator_desc == NULL)
1903 return ERR_PTR(-EINVAL);
1905 if (regulator_desc->name == NULL || regulator_desc->ops == NULL)
1906 return ERR_PTR(-EINVAL);
1908 if (!regulator_desc->type == REGULATOR_VOLTAGE &&
1909 !regulator_desc->type == REGULATOR_CURRENT)
1910 return ERR_PTR(-EINVAL);
1913 return ERR_PTR(-EINVAL);
1915 rdev = kzalloc(sizeof(struct regulator_dev), GFP_KERNEL);
1917 return ERR_PTR(-ENOMEM);
1919 mutex_lock(®ulator_list_mutex);
1921 mutex_init(&rdev->mutex);
1922 rdev->reg_data = driver_data;
1923 rdev->owner = regulator_desc->owner;
1924 rdev->desc = regulator_desc;
1925 INIT_LIST_HEAD(&rdev->consumer_list);
1926 INIT_LIST_HEAD(&rdev->supply_list);
1927 INIT_LIST_HEAD(&rdev->list);
1928 INIT_LIST_HEAD(&rdev->slist);
1929 BLOCKING_INIT_NOTIFIER_HEAD(&rdev->notifier);
1931 /* preform any regulator specific init */
1932 if (init_data->regulator_init) {
1933 ret = init_data->regulator_init(rdev->reg_data);
1938 /* register with sysfs */
1939 rdev->dev.class = ®ulator_class;
1940 rdev->dev.parent = dev;
1941 dev_set_name(&rdev->dev, "regulator.%d",
1942 atomic_inc_return(®ulator_no) - 1);
1943 ret = device_register(&rdev->dev);
1947 dev_set_drvdata(&rdev->dev, rdev);
1949 /* set regulator constraints */
1950 ret = set_machine_constraints(rdev, &init_data->constraints);
1954 /* add attributes supported by this regulator */
1955 ret = add_regulator_attributes(rdev);
1959 /* set supply regulator if it exists */
1960 if (init_data->supply_regulator_dev) {
1961 ret = set_supply(rdev,
1962 dev_get_drvdata(init_data->supply_regulator_dev));
1967 /* add consumers devices */
1968 for (i = 0; i < init_data->num_consumer_supplies; i++) {
1969 ret = set_consumer_device_supply(rdev,
1970 init_data->consumer_supplies[i].dev,
1971 init_data->consumer_supplies[i].supply);
1973 for (--i; i >= 0; i--)
1974 unset_consumer_device_supply(rdev,
1975 init_data->consumer_supplies[i].dev);
1980 list_add(&rdev->list, ®ulator_list);
1982 mutex_unlock(®ulator_list_mutex);
1986 device_unregister(&rdev->dev);
1989 rdev = ERR_PTR(ret);
1992 EXPORT_SYMBOL_GPL(regulator_register);
1995 * regulator_unregister - unregister regulator
1996 * @rdev: regulator to unregister
1998 * Called by regulator drivers to unregister a regulator.
2000 void regulator_unregister(struct regulator_dev *rdev)
2005 mutex_lock(®ulator_list_mutex);
2006 unset_regulator_supplies(rdev);
2007 list_del(&rdev->list);
2009 sysfs_remove_link(&rdev->dev.kobj, "supply");
2010 device_unregister(&rdev->dev);
2011 mutex_unlock(®ulator_list_mutex);
2013 EXPORT_SYMBOL_GPL(regulator_unregister);
2016 * regulator_suspend_prepare - prepare regulators for system wide suspend
2017 * @state: system suspend state
2019 * Configure each regulator with it's suspend operating parameters for state.
2020 * This will usually be called by machine suspend code prior to supending.
2022 int regulator_suspend_prepare(suspend_state_t state)
2024 struct regulator_dev *rdev;
2027 /* ON is handled by regulator active state */
2028 if (state == PM_SUSPEND_ON)
2031 mutex_lock(®ulator_list_mutex);
2032 list_for_each_entry(rdev, ®ulator_list, list) {
2034 mutex_lock(&rdev->mutex);
2035 ret = suspend_prepare(rdev, state);
2036 mutex_unlock(&rdev->mutex);
2039 printk(KERN_ERR "%s: failed to prepare %s\n",
2040 __func__, rdev->desc->name);
2045 mutex_unlock(®ulator_list_mutex);
2048 EXPORT_SYMBOL_GPL(regulator_suspend_prepare);
2051 * rdev_get_drvdata - get rdev regulator driver data
2054 * Get rdev regulator driver private data. This call can be used in the
2055 * regulator driver context.
2057 void *rdev_get_drvdata(struct regulator_dev *rdev)
2059 return rdev->reg_data;
2061 EXPORT_SYMBOL_GPL(rdev_get_drvdata);
2064 * regulator_get_drvdata - get regulator driver data
2065 * @regulator: regulator
2067 * Get regulator driver private data. This call can be used in the consumer
2068 * driver context when non API regulator specific functions need to be called.
2070 void *regulator_get_drvdata(struct regulator *regulator)
2072 return regulator->rdev->reg_data;
2074 EXPORT_SYMBOL_GPL(regulator_get_drvdata);
2077 * regulator_set_drvdata - set regulator driver data
2078 * @regulator: regulator
2081 void regulator_set_drvdata(struct regulator *regulator, void *data)
2083 regulator->rdev->reg_data = data;
2085 EXPORT_SYMBOL_GPL(regulator_set_drvdata);
2088 * regulator_get_id - get regulator ID
2091 int rdev_get_id(struct regulator_dev *rdev)
2093 return rdev->desc->id;
2095 EXPORT_SYMBOL_GPL(rdev_get_id);
2097 struct device *rdev_get_dev(struct regulator_dev *rdev)
2101 EXPORT_SYMBOL_GPL(rdev_get_dev);
2103 void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data)
2105 return reg_init_data->driver_data;
2107 EXPORT_SYMBOL_GPL(regulator_get_init_drvdata);
2109 static int __init regulator_init(void)
2111 printk(KERN_INFO "regulator: core version %s\n", REGULATOR_VERSION);
2112 return class_register(®ulator_class);
2115 /* init early to allow our consumers to complete system booting */
2116 core_initcall(regulator_init);