core.c revision 070260f07c7daec311f2466eb9d1df475d5a46f8
1/*
2 * core.c  --  Voltage/Current Regulator framework.
3 *
4 * Copyright 2007, 2008 Wolfson Microelectronics PLC.
5 * Copyright 2008 SlimLogic Ltd.
6 *
7 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
8 *
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.
13 *
14 */
15
16#include <linux/kernel.h>
17#include <linux/init.h>
18#include <linux/debugfs.h>
19#include <linux/device.h>
20#include <linux/slab.h>
21#include <linux/async.h>
22#include <linux/err.h>
23#include <linux/mutex.h>
24#include <linux/suspend.h>
25#include <linux/delay.h>
26#include <linux/gpio.h>
27#include <linux/of.h>
28#include <linux/regmap.h>
29#include <linux/regulator/of_regulator.h>
30#include <linux/regulator/consumer.h>
31#include <linux/regulator/driver.h>
32#include <linux/regulator/machine.h>
33#include <linux/module.h>
34
35#define CREATE_TRACE_POINTS
36#include <trace/events/regulator.h>
37
38#include "dummy.h"
39
40#define rdev_crit(rdev, fmt, ...)					\
41	pr_crit("%s: " fmt, rdev_get_name(rdev), ##__VA_ARGS__)
42#define rdev_err(rdev, fmt, ...)					\
43	pr_err("%s: " fmt, rdev_get_name(rdev), ##__VA_ARGS__)
44#define rdev_warn(rdev, fmt, ...)					\
45	pr_warn("%s: " fmt, rdev_get_name(rdev), ##__VA_ARGS__)
46#define rdev_info(rdev, fmt, ...)					\
47	pr_info("%s: " fmt, rdev_get_name(rdev), ##__VA_ARGS__)
48#define rdev_dbg(rdev, fmt, ...)					\
49	pr_debug("%s: " fmt, rdev_get_name(rdev), ##__VA_ARGS__)
50
51static DEFINE_MUTEX(regulator_list_mutex);
52static LIST_HEAD(regulator_list);
53static LIST_HEAD(regulator_map_list);
54static LIST_HEAD(regulator_ena_gpio_list);
55static bool has_full_constraints;
56static bool board_wants_dummy_regulator;
57
58static struct dentry *debugfs_root;
59
60/*
61 * struct regulator_map
62 *
63 * Used to provide symbolic supply names to devices.
64 */
65struct regulator_map {
66	struct list_head list;
67	const char *dev_name;   /* The dev_name() for the consumer */
68	const char *supply;
69	struct regulator_dev *regulator;
70};
71
72/*
73 * struct regulator_enable_gpio
74 *
75 * Management for shared enable GPIO pin
76 */
77struct regulator_enable_gpio {
78	struct list_head list;
79	int gpio;
80	u32 enable_count;	/* a number of enabled shared GPIO */
81	u32 request_count;	/* a number of requested shared GPIO */
82	unsigned int ena_gpio_invert:1;
83};
84
85/*
86 * struct regulator
87 *
88 * One for each consumer device.
89 */
90struct regulator {
91	struct device *dev;
92	struct list_head list;
93	unsigned int always_on:1;
94	unsigned int bypass:1;
95	int uA_load;
96	int min_uV;
97	int max_uV;
98	char *supply_name;
99	struct device_attribute dev_attr;
100	struct regulator_dev *rdev;
101	struct dentry *debugfs;
102};
103
104static int _regulator_is_enabled(struct regulator_dev *rdev);
105static int _regulator_disable(struct regulator_dev *rdev);
106static int _regulator_get_voltage(struct regulator_dev *rdev);
107static int _regulator_get_current_limit(struct regulator_dev *rdev);
108static unsigned int _regulator_get_mode(struct regulator_dev *rdev);
109static void _notifier_call_chain(struct regulator_dev *rdev,
110				  unsigned long event, void *data);
111static int _regulator_do_set_voltage(struct regulator_dev *rdev,
112				     int min_uV, int max_uV);
113static struct regulator *create_regulator(struct regulator_dev *rdev,
114					  struct device *dev,
115					  const char *supply_name);
116
117static const char *rdev_get_name(struct regulator_dev *rdev)
118{
119	if (rdev->constraints && rdev->constraints->name)
120		return rdev->constraints->name;
121	else if (rdev->desc->name)
122		return rdev->desc->name;
123	else
124		return "";
125}
126
127/**
128 * of_get_regulator - get a regulator device node based on supply name
129 * @dev: Device pointer for the consumer (of regulator) device
130 * @supply: regulator supply name
131 *
132 * Extract the regulator device node corresponding to the supply name.
133 * returns the device node corresponding to the regulator if found, else
134 * returns NULL.
135 */
136static struct device_node *of_get_regulator(struct device *dev, const char *supply)
137{
138	struct device_node *regnode = NULL;
139	char prop_name[32]; /* 32 is max size of property name */
140
141	dev_dbg(dev, "Looking up %s-supply from device tree\n", supply);
142
143	snprintf(prop_name, 32, "%s-supply", supply);
144	regnode = of_parse_phandle(dev->of_node, prop_name, 0);
145
146	if (!regnode) {
147		dev_dbg(dev, "Looking up %s property in node %s failed",
148				prop_name, dev->of_node->full_name);
149		return NULL;
150	}
151	return regnode;
152}
153
154static int _regulator_can_change_status(struct regulator_dev *rdev)
155{
156	if (!rdev->constraints)
157		return 0;
158
159	if (rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_STATUS)
160		return 1;
161	else
162		return 0;
163}
164
165/* Platform voltage constraint check */
166static int regulator_check_voltage(struct regulator_dev *rdev,
167				   int *min_uV, int *max_uV)
168{
169	BUG_ON(*min_uV > *max_uV);
170
171	if (!rdev->constraints) {
172		rdev_err(rdev, "no constraints\n");
173		return -ENODEV;
174	}
175	if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_VOLTAGE)) {
176		rdev_err(rdev, "operation not allowed\n");
177		return -EPERM;
178	}
179
180	if (*max_uV > rdev->constraints->max_uV)
181		*max_uV = rdev->constraints->max_uV;
182	if (*min_uV < rdev->constraints->min_uV)
183		*min_uV = rdev->constraints->min_uV;
184
185	if (*min_uV > *max_uV) {
186		rdev_err(rdev, "unsupportable voltage range: %d-%duV\n",
187			 *min_uV, *max_uV);
188		return -EINVAL;
189	}
190
191	return 0;
192}
193
194/* Make sure we select a voltage that suits the needs of all
195 * regulator consumers
196 */
197static int regulator_check_consumers(struct regulator_dev *rdev,
198				     int *min_uV, int *max_uV)
199{
200	struct regulator *regulator;
201
202	list_for_each_entry(regulator, &rdev->consumer_list, list) {
203		/*
204		 * Assume consumers that didn't say anything are OK
205		 * with anything in the constraint range.
206		 */
207		if (!regulator->min_uV && !regulator->max_uV)
208			continue;
209
210		if (*max_uV > regulator->max_uV)
211			*max_uV = regulator->max_uV;
212		if (*min_uV < regulator->min_uV)
213			*min_uV = regulator->min_uV;
214	}
215
216	if (*min_uV > *max_uV) {
217		rdev_err(rdev, "Restricting voltage, %u-%uuV\n",
218			*min_uV, *max_uV);
219		return -EINVAL;
220	}
221
222	return 0;
223}
224
225/* current constraint check */
226static int regulator_check_current_limit(struct regulator_dev *rdev,
227					int *min_uA, int *max_uA)
228{
229	BUG_ON(*min_uA > *max_uA);
230
231	if (!rdev->constraints) {
232		rdev_err(rdev, "no constraints\n");
233		return -ENODEV;
234	}
235	if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_CURRENT)) {
236		rdev_err(rdev, "operation not allowed\n");
237		return -EPERM;
238	}
239
240	if (*max_uA > rdev->constraints->max_uA)
241		*max_uA = rdev->constraints->max_uA;
242	if (*min_uA < rdev->constraints->min_uA)
243		*min_uA = rdev->constraints->min_uA;
244
245	if (*min_uA > *max_uA) {
246		rdev_err(rdev, "unsupportable current range: %d-%duA\n",
247			 *min_uA, *max_uA);
248		return -EINVAL;
249	}
250
251	return 0;
252}
253
254/* operating mode constraint check */
255static int regulator_mode_constrain(struct regulator_dev *rdev, int *mode)
256{
257	switch (*mode) {
258	case REGULATOR_MODE_FAST:
259	case REGULATOR_MODE_NORMAL:
260	case REGULATOR_MODE_IDLE:
261	case REGULATOR_MODE_STANDBY:
262		break;
263	default:
264		rdev_err(rdev, "invalid mode %x specified\n", *mode);
265		return -EINVAL;
266	}
267
268	if (!rdev->constraints) {
269		rdev_err(rdev, "no constraints\n");
270		return -ENODEV;
271	}
272	if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_MODE)) {
273		rdev_err(rdev, "operation not allowed\n");
274		return -EPERM;
275	}
276
277	/* The modes are bitmasks, the most power hungry modes having
278	 * the lowest values. If the requested mode isn't supported
279	 * try higher modes. */
280	while (*mode) {
281		if (rdev->constraints->valid_modes_mask & *mode)
282			return 0;
283		*mode /= 2;
284	}
285
286	return -EINVAL;
287}
288
289/* dynamic regulator mode switching constraint check */
290static int regulator_check_drms(struct regulator_dev *rdev)
291{
292	if (!rdev->constraints) {
293		rdev_err(rdev, "no constraints\n");
294		return -ENODEV;
295	}
296	if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_DRMS)) {
297		rdev_err(rdev, "operation not allowed\n");
298		return -EPERM;
299	}
300	return 0;
301}
302
303static ssize_t regulator_uV_show(struct device *dev,
304				struct device_attribute *attr, char *buf)
305{
306	struct regulator_dev *rdev = dev_get_drvdata(dev);
307	ssize_t ret;
308
309	mutex_lock(&rdev->mutex);
310	ret = sprintf(buf, "%d\n", _regulator_get_voltage(rdev));
311	mutex_unlock(&rdev->mutex);
312
313	return ret;
314}
315static DEVICE_ATTR(microvolts, 0444, regulator_uV_show, NULL);
316
317static ssize_t regulator_uA_show(struct device *dev,
318				struct device_attribute *attr, char *buf)
319{
320	struct regulator_dev *rdev = dev_get_drvdata(dev);
321
322	return sprintf(buf, "%d\n", _regulator_get_current_limit(rdev));
323}
324static DEVICE_ATTR(microamps, 0444, regulator_uA_show, NULL);
325
326static ssize_t regulator_name_show(struct device *dev,
327			     struct device_attribute *attr, char *buf)
328{
329	struct regulator_dev *rdev = dev_get_drvdata(dev);
330
331	return sprintf(buf, "%s\n", rdev_get_name(rdev));
332}
333
334static ssize_t regulator_print_opmode(char *buf, int mode)
335{
336	switch (mode) {
337	case REGULATOR_MODE_FAST:
338		return sprintf(buf, "fast\n");
339	case REGULATOR_MODE_NORMAL:
340		return sprintf(buf, "normal\n");
341	case REGULATOR_MODE_IDLE:
342		return sprintf(buf, "idle\n");
343	case REGULATOR_MODE_STANDBY:
344		return sprintf(buf, "standby\n");
345	}
346	return sprintf(buf, "unknown\n");
347}
348
349static ssize_t regulator_opmode_show(struct device *dev,
350				    struct device_attribute *attr, char *buf)
351{
352	struct regulator_dev *rdev = dev_get_drvdata(dev);
353
354	return regulator_print_opmode(buf, _regulator_get_mode(rdev));
355}
356static DEVICE_ATTR(opmode, 0444, regulator_opmode_show, NULL);
357
358static ssize_t regulator_print_state(char *buf, int state)
359{
360	if (state > 0)
361		return sprintf(buf, "enabled\n");
362	else if (state == 0)
363		return sprintf(buf, "disabled\n");
364	else
365		return sprintf(buf, "unknown\n");
366}
367
368static ssize_t regulator_state_show(struct device *dev,
369				   struct device_attribute *attr, char *buf)
370{
371	struct regulator_dev *rdev = dev_get_drvdata(dev);
372	ssize_t ret;
373
374	mutex_lock(&rdev->mutex);
375	ret = regulator_print_state(buf, _regulator_is_enabled(rdev));
376	mutex_unlock(&rdev->mutex);
377
378	return ret;
379}
380static DEVICE_ATTR(state, 0444, regulator_state_show, NULL);
381
382static ssize_t regulator_status_show(struct device *dev,
383				   struct device_attribute *attr, char *buf)
384{
385	struct regulator_dev *rdev = dev_get_drvdata(dev);
386	int status;
387	char *label;
388
389	status = rdev->desc->ops->get_status(rdev);
390	if (status < 0)
391		return status;
392
393	switch (status) {
394	case REGULATOR_STATUS_OFF:
395		label = "off";
396		break;
397	case REGULATOR_STATUS_ON:
398		label = "on";
399		break;
400	case REGULATOR_STATUS_ERROR:
401		label = "error";
402		break;
403	case REGULATOR_STATUS_FAST:
404		label = "fast";
405		break;
406	case REGULATOR_STATUS_NORMAL:
407		label = "normal";
408		break;
409	case REGULATOR_STATUS_IDLE:
410		label = "idle";
411		break;
412	case REGULATOR_STATUS_STANDBY:
413		label = "standby";
414		break;
415	case REGULATOR_STATUS_BYPASS:
416		label = "bypass";
417		break;
418	case REGULATOR_STATUS_UNDEFINED:
419		label = "undefined";
420		break;
421	default:
422		return -ERANGE;
423	}
424
425	return sprintf(buf, "%s\n", label);
426}
427static DEVICE_ATTR(status, 0444, regulator_status_show, NULL);
428
429static ssize_t regulator_min_uA_show(struct device *dev,
430				    struct device_attribute *attr, char *buf)
431{
432	struct regulator_dev *rdev = dev_get_drvdata(dev);
433
434	if (!rdev->constraints)
435		return sprintf(buf, "constraint not defined\n");
436
437	return sprintf(buf, "%d\n", rdev->constraints->min_uA);
438}
439static DEVICE_ATTR(min_microamps, 0444, regulator_min_uA_show, NULL);
440
441static ssize_t regulator_max_uA_show(struct device *dev,
442				    struct device_attribute *attr, char *buf)
443{
444	struct regulator_dev *rdev = dev_get_drvdata(dev);
445
446	if (!rdev->constraints)
447		return sprintf(buf, "constraint not defined\n");
448
449	return sprintf(buf, "%d\n", rdev->constraints->max_uA);
450}
451static DEVICE_ATTR(max_microamps, 0444, regulator_max_uA_show, NULL);
452
453static ssize_t regulator_min_uV_show(struct device *dev,
454				    struct device_attribute *attr, char *buf)
455{
456	struct regulator_dev *rdev = dev_get_drvdata(dev);
457
458	if (!rdev->constraints)
459		return sprintf(buf, "constraint not defined\n");
460
461	return sprintf(buf, "%d\n", rdev->constraints->min_uV);
462}
463static DEVICE_ATTR(min_microvolts, 0444, regulator_min_uV_show, NULL);
464
465static ssize_t regulator_max_uV_show(struct device *dev,
466				    struct device_attribute *attr, char *buf)
467{
468	struct regulator_dev *rdev = dev_get_drvdata(dev);
469
470	if (!rdev->constraints)
471		return sprintf(buf, "constraint not defined\n");
472
473	return sprintf(buf, "%d\n", rdev->constraints->max_uV);
474}
475static DEVICE_ATTR(max_microvolts, 0444, regulator_max_uV_show, NULL);
476
477static ssize_t regulator_total_uA_show(struct device *dev,
478				      struct device_attribute *attr, char *buf)
479{
480	struct regulator_dev *rdev = dev_get_drvdata(dev);
481	struct regulator *regulator;
482	int uA = 0;
483
484	mutex_lock(&rdev->mutex);
485	list_for_each_entry(regulator, &rdev->consumer_list, list)
486		uA += regulator->uA_load;
487	mutex_unlock(&rdev->mutex);
488	return sprintf(buf, "%d\n", uA);
489}
490static DEVICE_ATTR(requested_microamps, 0444, regulator_total_uA_show, NULL);
491
492static ssize_t regulator_num_users_show(struct device *dev,
493				      struct device_attribute *attr, char *buf)
494{
495	struct regulator_dev *rdev = dev_get_drvdata(dev);
496	return sprintf(buf, "%d\n", rdev->use_count);
497}
498
499static ssize_t regulator_type_show(struct device *dev,
500				  struct device_attribute *attr, char *buf)
501{
502	struct regulator_dev *rdev = dev_get_drvdata(dev);
503
504	switch (rdev->desc->type) {
505	case REGULATOR_VOLTAGE:
506		return sprintf(buf, "voltage\n");
507	case REGULATOR_CURRENT:
508		return sprintf(buf, "current\n");
509	}
510	return sprintf(buf, "unknown\n");
511}
512
513static ssize_t regulator_suspend_mem_uV_show(struct device *dev,
514				struct device_attribute *attr, char *buf)
515{
516	struct regulator_dev *rdev = dev_get_drvdata(dev);
517
518	return sprintf(buf, "%d\n", rdev->constraints->state_mem.uV);
519}
520static DEVICE_ATTR(suspend_mem_microvolts, 0444,
521		regulator_suspend_mem_uV_show, NULL);
522
523static ssize_t regulator_suspend_disk_uV_show(struct device *dev,
524				struct device_attribute *attr, char *buf)
525{
526	struct regulator_dev *rdev = dev_get_drvdata(dev);
527
528	return sprintf(buf, "%d\n", rdev->constraints->state_disk.uV);
529}
530static DEVICE_ATTR(suspend_disk_microvolts, 0444,
531		regulator_suspend_disk_uV_show, NULL);
532
533static ssize_t regulator_suspend_standby_uV_show(struct device *dev,
534				struct device_attribute *attr, char *buf)
535{
536	struct regulator_dev *rdev = dev_get_drvdata(dev);
537
538	return sprintf(buf, "%d\n", rdev->constraints->state_standby.uV);
539}
540static DEVICE_ATTR(suspend_standby_microvolts, 0444,
541		regulator_suspend_standby_uV_show, NULL);
542
543static ssize_t regulator_suspend_mem_mode_show(struct device *dev,
544				struct device_attribute *attr, char *buf)
545{
546	struct regulator_dev *rdev = dev_get_drvdata(dev);
547
548	return regulator_print_opmode(buf,
549		rdev->constraints->state_mem.mode);
550}
551static DEVICE_ATTR(suspend_mem_mode, 0444,
552		regulator_suspend_mem_mode_show, NULL);
553
554static ssize_t regulator_suspend_disk_mode_show(struct device *dev,
555				struct device_attribute *attr, char *buf)
556{
557	struct regulator_dev *rdev = dev_get_drvdata(dev);
558
559	return regulator_print_opmode(buf,
560		rdev->constraints->state_disk.mode);
561}
562static DEVICE_ATTR(suspend_disk_mode, 0444,
563		regulator_suspend_disk_mode_show, NULL);
564
565static ssize_t regulator_suspend_standby_mode_show(struct device *dev,
566				struct device_attribute *attr, char *buf)
567{
568	struct regulator_dev *rdev = dev_get_drvdata(dev);
569
570	return regulator_print_opmode(buf,
571		rdev->constraints->state_standby.mode);
572}
573static DEVICE_ATTR(suspend_standby_mode, 0444,
574		regulator_suspend_standby_mode_show, NULL);
575
576static ssize_t regulator_suspend_mem_state_show(struct device *dev,
577				   struct device_attribute *attr, char *buf)
578{
579	struct regulator_dev *rdev = dev_get_drvdata(dev);
580
581	return regulator_print_state(buf,
582			rdev->constraints->state_mem.enabled);
583}
584static DEVICE_ATTR(suspend_mem_state, 0444,
585		regulator_suspend_mem_state_show, NULL);
586
587static ssize_t regulator_suspend_disk_state_show(struct device *dev,
588				   struct device_attribute *attr, char *buf)
589{
590	struct regulator_dev *rdev = dev_get_drvdata(dev);
591
592	return regulator_print_state(buf,
593			rdev->constraints->state_disk.enabled);
594}
595static DEVICE_ATTR(suspend_disk_state, 0444,
596		regulator_suspend_disk_state_show, NULL);
597
598static ssize_t regulator_suspend_standby_state_show(struct device *dev,
599				   struct device_attribute *attr, char *buf)
600{
601	struct regulator_dev *rdev = dev_get_drvdata(dev);
602
603	return regulator_print_state(buf,
604			rdev->constraints->state_standby.enabled);
605}
606static DEVICE_ATTR(suspend_standby_state, 0444,
607		regulator_suspend_standby_state_show, NULL);
608
609static ssize_t regulator_bypass_show(struct device *dev,
610				     struct device_attribute *attr, char *buf)
611{
612	struct regulator_dev *rdev = dev_get_drvdata(dev);
613	const char *report;
614	bool bypass;
615	int ret;
616
617	ret = rdev->desc->ops->get_bypass(rdev, &bypass);
618
619	if (ret != 0)
620		report = "unknown";
621	else if (bypass)
622		report = "enabled";
623	else
624		report = "disabled";
625
626	return sprintf(buf, "%s\n", report);
627}
628static DEVICE_ATTR(bypass, 0444,
629		   regulator_bypass_show, NULL);
630
631/*
632 * These are the only attributes are present for all regulators.
633 * Other attributes are a function of regulator functionality.
634 */
635static struct device_attribute regulator_dev_attrs[] = {
636	__ATTR(name, 0444, regulator_name_show, NULL),
637	__ATTR(num_users, 0444, regulator_num_users_show, NULL),
638	__ATTR(type, 0444, regulator_type_show, NULL),
639	__ATTR_NULL,
640};
641
642static void regulator_dev_release(struct device *dev)
643{
644	struct regulator_dev *rdev = dev_get_drvdata(dev);
645	kfree(rdev);
646}
647
648static struct class regulator_class = {
649	.name = "regulator",
650	.dev_release = regulator_dev_release,
651	.dev_attrs = regulator_dev_attrs,
652};
653
654/* Calculate the new optimum regulator operating mode based on the new total
655 * consumer load. All locks held by caller */
656static void drms_uA_update(struct regulator_dev *rdev)
657{
658	struct regulator *sibling;
659	int current_uA = 0, output_uV, input_uV, err;
660	unsigned int mode;
661
662	err = regulator_check_drms(rdev);
663	if (err < 0 || !rdev->desc->ops->get_optimum_mode ||
664	    (!rdev->desc->ops->get_voltage &&
665	     !rdev->desc->ops->get_voltage_sel) ||
666	    !rdev->desc->ops->set_mode)
667		return;
668
669	/* get output voltage */
670	output_uV = _regulator_get_voltage(rdev);
671	if (output_uV <= 0)
672		return;
673
674	/* get input voltage */
675	input_uV = 0;
676	if (rdev->supply)
677		input_uV = regulator_get_voltage(rdev->supply);
678	if (input_uV <= 0)
679		input_uV = rdev->constraints->input_uV;
680	if (input_uV <= 0)
681		return;
682
683	/* calc total requested load */
684	list_for_each_entry(sibling, &rdev->consumer_list, list)
685		current_uA += sibling->uA_load;
686
687	/* now get the optimum mode for our new total regulator load */
688	mode = rdev->desc->ops->get_optimum_mode(rdev, input_uV,
689						  output_uV, current_uA);
690
691	/* check the new mode is allowed */
692	err = regulator_mode_constrain(rdev, &mode);
693	if (err == 0)
694		rdev->desc->ops->set_mode(rdev, mode);
695}
696
697static int suspend_set_state(struct regulator_dev *rdev,
698	struct regulator_state *rstate)
699{
700	int ret = 0;
701
702	/* If we have no suspend mode configration don't set anything;
703	 * only warn if the driver implements set_suspend_voltage or
704	 * set_suspend_mode callback.
705	 */
706	if (!rstate->enabled && !rstate->disabled) {
707		if (rdev->desc->ops->set_suspend_voltage ||
708		    rdev->desc->ops->set_suspend_mode)
709			rdev_warn(rdev, "No configuration\n");
710		return 0;
711	}
712
713	if (rstate->enabled && rstate->disabled) {
714		rdev_err(rdev, "invalid configuration\n");
715		return -EINVAL;
716	}
717
718	if (rstate->enabled && rdev->desc->ops->set_suspend_enable)
719		ret = rdev->desc->ops->set_suspend_enable(rdev);
720	else if (rstate->disabled && rdev->desc->ops->set_suspend_disable)
721		ret = rdev->desc->ops->set_suspend_disable(rdev);
722	else /* OK if set_suspend_enable or set_suspend_disable is NULL */
723		ret = 0;
724
725	if (ret < 0) {
726		rdev_err(rdev, "failed to enabled/disable\n");
727		return ret;
728	}
729
730	if (rdev->desc->ops->set_suspend_voltage && rstate->uV > 0) {
731		ret = rdev->desc->ops->set_suspend_voltage(rdev, rstate->uV);
732		if (ret < 0) {
733			rdev_err(rdev, "failed to set voltage\n");
734			return ret;
735		}
736	}
737
738	if (rdev->desc->ops->set_suspend_mode && rstate->mode > 0) {
739		ret = rdev->desc->ops->set_suspend_mode(rdev, rstate->mode);
740		if (ret < 0) {
741			rdev_err(rdev, "failed to set mode\n");
742			return ret;
743		}
744	}
745	return ret;
746}
747
748/* locks held by caller */
749static int suspend_prepare(struct regulator_dev *rdev, suspend_state_t state)
750{
751	if (!rdev->constraints)
752		return -EINVAL;
753
754	switch (state) {
755	case PM_SUSPEND_STANDBY:
756		return suspend_set_state(rdev,
757			&rdev->constraints->state_standby);
758	case PM_SUSPEND_MEM:
759		return suspend_set_state(rdev,
760			&rdev->constraints->state_mem);
761	case PM_SUSPEND_MAX:
762		return suspend_set_state(rdev,
763			&rdev->constraints->state_disk);
764	default:
765		return -EINVAL;
766	}
767}
768
769static void print_constraints(struct regulator_dev *rdev)
770{
771	struct regulation_constraints *constraints = rdev->constraints;
772	char buf[80] = "";
773	int count = 0;
774	int ret;
775
776	if (constraints->min_uV && constraints->max_uV) {
777		if (constraints->min_uV == constraints->max_uV)
778			count += sprintf(buf + count, "%d mV ",
779					 constraints->min_uV / 1000);
780		else
781			count += sprintf(buf + count, "%d <--> %d mV ",
782					 constraints->min_uV / 1000,
783					 constraints->max_uV / 1000);
784	}
785
786	if (!constraints->min_uV ||
787	    constraints->min_uV != constraints->max_uV) {
788		ret = _regulator_get_voltage(rdev);
789		if (ret > 0)
790			count += sprintf(buf + count, "at %d mV ", ret / 1000);
791	}
792
793	if (constraints->uV_offset)
794		count += sprintf(buf, "%dmV offset ",
795				 constraints->uV_offset / 1000);
796
797	if (constraints->min_uA && constraints->max_uA) {
798		if (constraints->min_uA == constraints->max_uA)
799			count += sprintf(buf + count, "%d mA ",
800					 constraints->min_uA / 1000);
801		else
802			count += sprintf(buf + count, "%d <--> %d mA ",
803					 constraints->min_uA / 1000,
804					 constraints->max_uA / 1000);
805	}
806
807	if (!constraints->min_uA ||
808	    constraints->min_uA != constraints->max_uA) {
809		ret = _regulator_get_current_limit(rdev);
810		if (ret > 0)
811			count += sprintf(buf + count, "at %d mA ", ret / 1000);
812	}
813
814	if (constraints->valid_modes_mask & REGULATOR_MODE_FAST)
815		count += sprintf(buf + count, "fast ");
816	if (constraints->valid_modes_mask & REGULATOR_MODE_NORMAL)
817		count += sprintf(buf + count, "normal ");
818	if (constraints->valid_modes_mask & REGULATOR_MODE_IDLE)
819		count += sprintf(buf + count, "idle ");
820	if (constraints->valid_modes_mask & REGULATOR_MODE_STANDBY)
821		count += sprintf(buf + count, "standby");
822
823	if (!count)
824		sprintf(buf, "no parameters");
825
826	rdev_info(rdev, "%s\n", buf);
827
828	if ((constraints->min_uV != constraints->max_uV) &&
829	    !(constraints->valid_ops_mask & REGULATOR_CHANGE_VOLTAGE))
830		rdev_warn(rdev,
831			  "Voltage range but no REGULATOR_CHANGE_VOLTAGE\n");
832}
833
834static int machine_constraints_voltage(struct regulator_dev *rdev,
835	struct regulation_constraints *constraints)
836{
837	struct regulator_ops *ops = rdev->desc->ops;
838	int ret;
839
840	/* do we need to apply the constraint voltage */
841	if (rdev->constraints->apply_uV &&
842	    rdev->constraints->min_uV == rdev->constraints->max_uV) {
843		ret = _regulator_do_set_voltage(rdev,
844						rdev->constraints->min_uV,
845						rdev->constraints->max_uV);
846		if (ret < 0) {
847			rdev_err(rdev, "failed to apply %duV constraint\n",
848				 rdev->constraints->min_uV);
849			return ret;
850		}
851	}
852
853	/* constrain machine-level voltage specs to fit
854	 * the actual range supported by this regulator.
855	 */
856	if (ops->list_voltage && rdev->desc->n_voltages) {
857		int	count = rdev->desc->n_voltages;
858		int	i;
859		int	min_uV = INT_MAX;
860		int	max_uV = INT_MIN;
861		int	cmin = constraints->min_uV;
862		int	cmax = constraints->max_uV;
863
864		/* it's safe to autoconfigure fixed-voltage supplies
865		   and the constraints are used by list_voltage. */
866		if (count == 1 && !cmin) {
867			cmin = 1;
868			cmax = INT_MAX;
869			constraints->min_uV = cmin;
870			constraints->max_uV = cmax;
871		}
872
873		/* voltage constraints are optional */
874		if ((cmin == 0) && (cmax == 0))
875			return 0;
876
877		/* else require explicit machine-level constraints */
878		if (cmin <= 0 || cmax <= 0 || cmax < cmin) {
879			rdev_err(rdev, "invalid voltage constraints\n");
880			return -EINVAL;
881		}
882
883		/* initial: [cmin..cmax] valid, [min_uV..max_uV] not */
884		for (i = 0; i < count; i++) {
885			int	value;
886
887			value = ops->list_voltage(rdev, i);
888			if (value <= 0)
889				continue;
890
891			/* maybe adjust [min_uV..max_uV] */
892			if (value >= cmin && value < min_uV)
893				min_uV = value;
894			if (value <= cmax && value > max_uV)
895				max_uV = value;
896		}
897
898		/* final: [min_uV..max_uV] valid iff constraints valid */
899		if (max_uV < min_uV) {
900			rdev_err(rdev,
901				 "unsupportable voltage constraints %u-%uuV\n",
902				 min_uV, max_uV);
903			return -EINVAL;
904		}
905
906		/* use regulator's subset of machine constraints */
907		if (constraints->min_uV < min_uV) {
908			rdev_dbg(rdev, "override min_uV, %d -> %d\n",
909				 constraints->min_uV, min_uV);
910			constraints->min_uV = min_uV;
911		}
912		if (constraints->max_uV > max_uV) {
913			rdev_dbg(rdev, "override max_uV, %d -> %d\n",
914				 constraints->max_uV, max_uV);
915			constraints->max_uV = max_uV;
916		}
917	}
918
919	return 0;
920}
921
922/**
923 * set_machine_constraints - sets regulator constraints
924 * @rdev: regulator source
925 * @constraints: constraints to apply
926 *
927 * Allows platform initialisation code to define and constrain
928 * regulator circuits e.g. valid voltage/current ranges, etc.  NOTE:
929 * Constraints *must* be set by platform code in order for some
930 * regulator operations to proceed i.e. set_voltage, set_current_limit,
931 * set_mode.
932 */
933static int set_machine_constraints(struct regulator_dev *rdev,
934	const struct regulation_constraints *constraints)
935{
936	int ret = 0;
937	struct regulator_ops *ops = rdev->desc->ops;
938
939	if (constraints)
940		rdev->constraints = kmemdup(constraints, sizeof(*constraints),
941					    GFP_KERNEL);
942	else
943		rdev->constraints = kzalloc(sizeof(*constraints),
944					    GFP_KERNEL);
945	if (!rdev->constraints)
946		return -ENOMEM;
947
948	ret = machine_constraints_voltage(rdev, rdev->constraints);
949	if (ret != 0)
950		goto out;
951
952	/* do we need to setup our suspend state */
953	if (rdev->constraints->initial_state) {
954		ret = suspend_prepare(rdev, rdev->constraints->initial_state);
955		if (ret < 0) {
956			rdev_err(rdev, "failed to set suspend state\n");
957			goto out;
958		}
959	}
960
961	if (rdev->constraints->initial_mode) {
962		if (!ops->set_mode) {
963			rdev_err(rdev, "no set_mode operation\n");
964			ret = -EINVAL;
965			goto out;
966		}
967
968		ret = ops->set_mode(rdev, rdev->constraints->initial_mode);
969		if (ret < 0) {
970			rdev_err(rdev, "failed to set initial mode: %d\n", ret);
971			goto out;
972		}
973	}
974
975	/* If the constraints say the regulator should be on at this point
976	 * and we have control then make sure it is enabled.
977	 */
978	if ((rdev->constraints->always_on || rdev->constraints->boot_on) &&
979	    ops->enable) {
980		ret = ops->enable(rdev);
981		if (ret < 0) {
982			rdev_err(rdev, "failed to enable\n");
983			goto out;
984		}
985	}
986
987	if (rdev->constraints->ramp_delay && ops->set_ramp_delay) {
988		ret = ops->set_ramp_delay(rdev, rdev->constraints->ramp_delay);
989		if (ret < 0) {
990			rdev_err(rdev, "failed to set ramp_delay\n");
991			goto out;
992		}
993	}
994
995	print_constraints(rdev);
996	return 0;
997out:
998	kfree(rdev->constraints);
999	rdev->constraints = NULL;
1000	return ret;
1001}
1002
1003/**
1004 * set_supply - set regulator supply regulator
1005 * @rdev: regulator name
1006 * @supply_rdev: supply regulator name
1007 *
1008 * Called by platform initialisation code to set the supply regulator for this
1009 * regulator. This ensures that a regulators supply will also be enabled by the
1010 * core if it's child is enabled.
1011 */
1012static int set_supply(struct regulator_dev *rdev,
1013		      struct regulator_dev *supply_rdev)
1014{
1015	int err;
1016
1017	rdev_info(rdev, "supplied by %s\n", rdev_get_name(supply_rdev));
1018
1019	rdev->supply = create_regulator(supply_rdev, &rdev->dev, "SUPPLY");
1020	if (rdev->supply == NULL) {
1021		err = -ENOMEM;
1022		return err;
1023	}
1024	supply_rdev->open_count++;
1025
1026	return 0;
1027}
1028
1029/**
1030 * set_consumer_device_supply - Bind a regulator to a symbolic supply
1031 * @rdev:         regulator source
1032 * @consumer_dev_name: dev_name() string for device supply applies to
1033 * @supply:       symbolic name for supply
1034 *
1035 * Allows platform initialisation code to map physical regulator
1036 * sources to symbolic names for supplies for use by devices.  Devices
1037 * should use these symbolic names to request regulators, avoiding the
1038 * need to provide board-specific regulator names as platform data.
1039 */
1040static int set_consumer_device_supply(struct regulator_dev *rdev,
1041				      const char *consumer_dev_name,
1042				      const char *supply)
1043{
1044	struct regulator_map *node;
1045	int has_dev;
1046
1047	if (supply == NULL)
1048		return -EINVAL;
1049
1050	if (consumer_dev_name != NULL)
1051		has_dev = 1;
1052	else
1053		has_dev = 0;
1054
1055	list_for_each_entry(node, &regulator_map_list, list) {
1056		if (node->dev_name && consumer_dev_name) {
1057			if (strcmp(node->dev_name, consumer_dev_name) != 0)
1058				continue;
1059		} else if (node->dev_name || consumer_dev_name) {
1060			continue;
1061		}
1062
1063		if (strcmp(node->supply, supply) != 0)
1064			continue;
1065
1066		pr_debug("%s: %s/%s is '%s' supply; fail %s/%s\n",
1067			 consumer_dev_name,
1068			 dev_name(&node->regulator->dev),
1069			 node->regulator->desc->name,
1070			 supply,
1071			 dev_name(&rdev->dev), rdev_get_name(rdev));
1072		return -EBUSY;
1073	}
1074
1075	node = kzalloc(sizeof(struct regulator_map), GFP_KERNEL);
1076	if (node == NULL)
1077		return -ENOMEM;
1078
1079	node->regulator = rdev;
1080	node->supply = supply;
1081
1082	if (has_dev) {
1083		node->dev_name = kstrdup(consumer_dev_name, GFP_KERNEL);
1084		if (node->dev_name == NULL) {
1085			kfree(node);
1086			return -ENOMEM;
1087		}
1088	}
1089
1090	list_add(&node->list, &regulator_map_list);
1091	return 0;
1092}
1093
1094static void unset_regulator_supplies(struct regulator_dev *rdev)
1095{
1096	struct regulator_map *node, *n;
1097
1098	list_for_each_entry_safe(node, n, &regulator_map_list, list) {
1099		if (rdev == node->regulator) {
1100			list_del(&node->list);
1101			kfree(node->dev_name);
1102			kfree(node);
1103		}
1104	}
1105}
1106
1107#define REG_STR_SIZE	64
1108
1109static struct regulator *create_regulator(struct regulator_dev *rdev,
1110					  struct device *dev,
1111					  const char *supply_name)
1112{
1113	struct regulator *regulator;
1114	char buf[REG_STR_SIZE];
1115	int err, size;
1116
1117	regulator = kzalloc(sizeof(*regulator), GFP_KERNEL);
1118	if (regulator == NULL)
1119		return NULL;
1120
1121	mutex_lock(&rdev->mutex);
1122	regulator->rdev = rdev;
1123	list_add(&regulator->list, &rdev->consumer_list);
1124
1125	if (dev) {
1126		regulator->dev = dev;
1127
1128		/* Add a link to the device sysfs entry */
1129		size = scnprintf(buf, REG_STR_SIZE, "%s-%s",
1130				 dev->kobj.name, supply_name);
1131		if (size >= REG_STR_SIZE)
1132			goto overflow_err;
1133
1134		regulator->supply_name = kstrdup(buf, GFP_KERNEL);
1135		if (regulator->supply_name == NULL)
1136			goto overflow_err;
1137
1138		err = sysfs_create_link(&rdev->dev.kobj, &dev->kobj,
1139					buf);
1140		if (err) {
1141			rdev_warn(rdev, "could not add device link %s err %d\n",
1142				  dev->kobj.name, err);
1143			/* non-fatal */
1144		}
1145	} else {
1146		regulator->supply_name = kstrdup(supply_name, GFP_KERNEL);
1147		if (regulator->supply_name == NULL)
1148			goto overflow_err;
1149	}
1150
1151	regulator->debugfs = debugfs_create_dir(regulator->supply_name,
1152						rdev->debugfs);
1153	if (!regulator->debugfs) {
1154		rdev_warn(rdev, "Failed to create debugfs directory\n");
1155	} else {
1156		debugfs_create_u32("uA_load", 0444, regulator->debugfs,
1157				   &regulator->uA_load);
1158		debugfs_create_u32("min_uV", 0444, regulator->debugfs,
1159				   &regulator->min_uV);
1160		debugfs_create_u32("max_uV", 0444, regulator->debugfs,
1161				   &regulator->max_uV);
1162	}
1163
1164	/*
1165	 * Check now if the regulator is an always on regulator - if
1166	 * it is then we don't need to do nearly so much work for
1167	 * enable/disable calls.
1168	 */
1169	if (!_regulator_can_change_status(rdev) &&
1170	    _regulator_is_enabled(rdev))
1171		regulator->always_on = true;
1172
1173	mutex_unlock(&rdev->mutex);
1174	return regulator;
1175overflow_err:
1176	list_del(&regulator->list);
1177	kfree(regulator);
1178	mutex_unlock(&rdev->mutex);
1179	return NULL;
1180}
1181
1182static int _regulator_get_enable_time(struct regulator_dev *rdev)
1183{
1184	if (!rdev->desc->ops->enable_time)
1185		return rdev->desc->enable_time;
1186	return rdev->desc->ops->enable_time(rdev);
1187}
1188
1189static struct regulator_dev *regulator_dev_lookup(struct device *dev,
1190						  const char *supply,
1191						  int *ret)
1192{
1193	struct regulator_dev *r;
1194	struct device_node *node;
1195	struct regulator_map *map;
1196	const char *devname = NULL;
1197
1198	/* first do a dt based lookup */
1199	if (dev && dev->of_node) {
1200		node = of_get_regulator(dev, supply);
1201		if (node) {
1202			list_for_each_entry(r, &regulator_list, list)
1203				if (r->dev.parent &&
1204					node == r->dev.of_node)
1205					return r;
1206		} else {
1207			/*
1208			 * If we couldn't even get the node then it's
1209			 * not just that the device didn't register
1210			 * yet, there's no node and we'll never
1211			 * succeed.
1212			 */
1213			*ret = -ENODEV;
1214		}
1215	}
1216
1217	/* if not found, try doing it non-dt way */
1218	if (dev)
1219		devname = dev_name(dev);
1220
1221	list_for_each_entry(r, &regulator_list, list)
1222		if (strcmp(rdev_get_name(r), supply) == 0)
1223			return r;
1224
1225	list_for_each_entry(map, &regulator_map_list, list) {
1226		/* If the mapping has a device set up it must match */
1227		if (map->dev_name &&
1228		    (!devname || strcmp(map->dev_name, devname)))
1229			continue;
1230
1231		if (strcmp(map->supply, supply) == 0)
1232			return map->regulator;
1233	}
1234
1235
1236	return NULL;
1237}
1238
1239/* Internal regulator request function */
1240static struct regulator *_regulator_get(struct device *dev, const char *id,
1241					int exclusive)
1242{
1243	struct regulator_dev *rdev;
1244	struct regulator *regulator = ERR_PTR(-EPROBE_DEFER);
1245	const char *devname = NULL;
1246	int ret = 0;
1247
1248	if (id == NULL) {
1249		pr_err("get() with no identifier\n");
1250		return regulator;
1251	}
1252
1253	if (dev)
1254		devname = dev_name(dev);
1255
1256	mutex_lock(&regulator_list_mutex);
1257
1258	rdev = regulator_dev_lookup(dev, id, &ret);
1259	if (rdev)
1260		goto found;
1261
1262	/*
1263	 * If we have return value from dev_lookup fail, we do not expect to
1264	 * succeed, so, quit with appropriate error value
1265	 */
1266	if (ret) {
1267		regulator = ERR_PTR(ret);
1268		goto out;
1269	}
1270
1271	if (board_wants_dummy_regulator) {
1272		rdev = dummy_regulator_rdev;
1273		goto found;
1274	}
1275
1276#ifdef CONFIG_REGULATOR_DUMMY
1277	if (!devname)
1278		devname = "deviceless";
1279
1280	/* If the board didn't flag that it was fully constrained then
1281	 * substitute in a dummy regulator so consumers can continue.
1282	 */
1283	if (!has_full_constraints) {
1284		pr_warn("%s supply %s not found, using dummy regulator\n",
1285			devname, id);
1286		rdev = dummy_regulator_rdev;
1287		goto found;
1288	}
1289#endif
1290
1291	mutex_unlock(&regulator_list_mutex);
1292	return regulator;
1293
1294found:
1295	if (rdev->exclusive) {
1296		regulator = ERR_PTR(-EPERM);
1297		goto out;
1298	}
1299
1300	if (exclusive && rdev->open_count) {
1301		regulator = ERR_PTR(-EBUSY);
1302		goto out;
1303	}
1304
1305	if (!try_module_get(rdev->owner))
1306		goto out;
1307
1308	regulator = create_regulator(rdev, dev, id);
1309	if (regulator == NULL) {
1310		regulator = ERR_PTR(-ENOMEM);
1311		module_put(rdev->owner);
1312		goto out;
1313	}
1314
1315	rdev->open_count++;
1316	if (exclusive) {
1317		rdev->exclusive = 1;
1318
1319		ret = _regulator_is_enabled(rdev);
1320		if (ret > 0)
1321			rdev->use_count = 1;
1322		else
1323			rdev->use_count = 0;
1324	}
1325
1326out:
1327	mutex_unlock(&regulator_list_mutex);
1328
1329	return regulator;
1330}
1331
1332/**
1333 * regulator_get - lookup and obtain a reference to a regulator.
1334 * @dev: device for regulator "consumer"
1335 * @id: Supply name or regulator ID.
1336 *
1337 * Returns a struct regulator corresponding to the regulator producer,
1338 * or IS_ERR() condition containing errno.
1339 *
1340 * Use of supply names configured via regulator_set_device_supply() is
1341 * strongly encouraged.  It is recommended that the supply name used
1342 * should match the name used for the supply and/or the relevant
1343 * device pins in the datasheet.
1344 */
1345struct regulator *regulator_get(struct device *dev, const char *id)
1346{
1347	return _regulator_get(dev, id, 0);
1348}
1349EXPORT_SYMBOL_GPL(regulator_get);
1350
1351static void devm_regulator_release(struct device *dev, void *res)
1352{
1353	regulator_put(*(struct regulator **)res);
1354}
1355
1356/**
1357 * devm_regulator_get - Resource managed regulator_get()
1358 * @dev: device for regulator "consumer"
1359 * @id: Supply name or regulator ID.
1360 *
1361 * Managed regulator_get(). Regulators returned from this function are
1362 * automatically regulator_put() on driver detach. See regulator_get() for more
1363 * information.
1364 */
1365struct regulator *devm_regulator_get(struct device *dev, const char *id)
1366{
1367	struct regulator **ptr, *regulator;
1368
1369	ptr = devres_alloc(devm_regulator_release, sizeof(*ptr), GFP_KERNEL);
1370	if (!ptr)
1371		return ERR_PTR(-ENOMEM);
1372
1373	regulator = regulator_get(dev, id);
1374	if (!IS_ERR(regulator)) {
1375		*ptr = regulator;
1376		devres_add(dev, ptr);
1377	} else {
1378		devres_free(ptr);
1379	}
1380
1381	return regulator;
1382}
1383EXPORT_SYMBOL_GPL(devm_regulator_get);
1384
1385/**
1386 * regulator_get_exclusive - obtain exclusive access to a regulator.
1387 * @dev: device for regulator "consumer"
1388 * @id: Supply name or regulator ID.
1389 *
1390 * Returns a struct regulator corresponding to the regulator producer,
1391 * or IS_ERR() condition containing errno.  Other consumers will be
1392 * unable to obtain this reference is held and the use count for the
1393 * regulator will be initialised to reflect the current state of the
1394 * regulator.
1395 *
1396 * This is intended for use by consumers which cannot tolerate shared
1397 * use of the regulator such as those which need to force the
1398 * regulator off for correct operation of the hardware they are
1399 * controlling.
1400 *
1401 * Use of supply names configured via regulator_set_device_supply() is
1402 * strongly encouraged.  It is recommended that the supply name used
1403 * should match the name used for the supply and/or the relevant
1404 * device pins in the datasheet.
1405 */
1406struct regulator *regulator_get_exclusive(struct device *dev, const char *id)
1407{
1408	return _regulator_get(dev, id, 1);
1409}
1410EXPORT_SYMBOL_GPL(regulator_get_exclusive);
1411
1412/* Locks held by regulator_put() */
1413static void _regulator_put(struct regulator *regulator)
1414{
1415	struct regulator_dev *rdev;
1416
1417	if (regulator == NULL || IS_ERR(regulator))
1418		return;
1419
1420	rdev = regulator->rdev;
1421
1422	debugfs_remove_recursive(regulator->debugfs);
1423
1424	/* remove any sysfs entries */
1425	if (regulator->dev)
1426		sysfs_remove_link(&rdev->dev.kobj, regulator->supply_name);
1427	kfree(regulator->supply_name);
1428	list_del(&regulator->list);
1429	kfree(regulator);
1430
1431	rdev->open_count--;
1432	rdev->exclusive = 0;
1433
1434	module_put(rdev->owner);
1435}
1436
1437/**
1438 * regulator_put - "free" the regulator source
1439 * @regulator: regulator source
1440 *
1441 * Note: drivers must ensure that all regulator_enable calls made on this
1442 * regulator source are balanced by regulator_disable calls prior to calling
1443 * this function.
1444 */
1445void regulator_put(struct regulator *regulator)
1446{
1447	mutex_lock(&regulator_list_mutex);
1448	_regulator_put(regulator);
1449	mutex_unlock(&regulator_list_mutex);
1450}
1451EXPORT_SYMBOL_GPL(regulator_put);
1452
1453static int devm_regulator_match(struct device *dev, void *res, void *data)
1454{
1455	struct regulator **r = res;
1456	if (!r || !*r) {
1457		WARN_ON(!r || !*r);
1458		return 0;
1459	}
1460	return *r == data;
1461}
1462
1463/**
1464 * devm_regulator_put - Resource managed regulator_put()
1465 * @regulator: regulator to free
1466 *
1467 * Deallocate a regulator allocated with devm_regulator_get(). Normally
1468 * this function will not need to be called and the resource management
1469 * code will ensure that the resource is freed.
1470 */
1471void devm_regulator_put(struct regulator *regulator)
1472{
1473	int rc;
1474
1475	rc = devres_release(regulator->dev, devm_regulator_release,
1476			    devm_regulator_match, regulator);
1477	if (rc != 0)
1478		WARN_ON(rc);
1479}
1480EXPORT_SYMBOL_GPL(devm_regulator_put);
1481
1482/* Manage enable GPIO list. Same GPIO pin can be shared among regulators */
1483static int regulator_ena_gpio_request(struct regulator_dev *rdev,
1484				const struct regulator_config *config)
1485{
1486	struct regulator_enable_gpio *pin;
1487	int ret;
1488
1489	list_for_each_entry(pin, &regulator_ena_gpio_list, list) {
1490		if (pin->gpio == config->ena_gpio) {
1491			rdev_dbg(rdev, "GPIO %d is already used\n",
1492				config->ena_gpio);
1493			goto update_ena_gpio_to_rdev;
1494		}
1495	}
1496
1497	ret = gpio_request_one(config->ena_gpio,
1498				GPIOF_DIR_OUT | config->ena_gpio_flags,
1499				rdev_get_name(rdev));
1500	if (ret)
1501		return ret;
1502
1503	pin = kzalloc(sizeof(struct regulator_enable_gpio), GFP_KERNEL);
1504	if (pin == NULL) {
1505		gpio_free(config->ena_gpio);
1506		return -ENOMEM;
1507	}
1508
1509	pin->gpio = config->ena_gpio;
1510	pin->ena_gpio_invert = config->ena_gpio_invert;
1511	list_add(&pin->list, &regulator_ena_gpio_list);
1512
1513update_ena_gpio_to_rdev:
1514	pin->request_count++;
1515	rdev->ena_pin = pin;
1516	return 0;
1517}
1518
1519static void regulator_ena_gpio_free(struct regulator_dev *rdev)
1520{
1521	struct regulator_enable_gpio *pin, *n;
1522
1523	if (!rdev->ena_pin)
1524		return;
1525
1526	/* Free the GPIO only in case of no use */
1527	list_for_each_entry_safe(pin, n, &regulator_ena_gpio_list, list) {
1528		if (pin->gpio == rdev->ena_pin->gpio) {
1529			if (pin->request_count <= 1) {
1530				pin->request_count = 0;
1531				gpio_free(pin->gpio);
1532				list_del(&pin->list);
1533				kfree(pin);
1534			} else {
1535				pin->request_count--;
1536			}
1537		}
1538	}
1539}
1540
1541/**
1542 * regulator_ena_gpio_ctrl - balance enable_count of each GPIO and actual GPIO pin control
1543 * @rdev: regulator_dev structure
1544 * @enable: enable GPIO at initial use?
1545 *
1546 * GPIO is enabled in case of initial use. (enable_count is 0)
1547 * GPIO is disabled when it is not shared any more. (enable_count <= 1)
1548 */
1549static int regulator_ena_gpio_ctrl(struct regulator_dev *rdev, bool enable)
1550{
1551	struct regulator_enable_gpio *pin = rdev->ena_pin;
1552
1553	if (!pin)
1554		return -EINVAL;
1555
1556	if (enable) {
1557		/* Enable GPIO at initial use */
1558		if (pin->enable_count == 0)
1559			gpio_set_value_cansleep(pin->gpio,
1560						!pin->ena_gpio_invert);
1561
1562		pin->enable_count++;
1563	} else {
1564		if (pin->enable_count > 1) {
1565			pin->enable_count--;
1566			return 0;
1567		}
1568
1569		/* Disable GPIO if not used */
1570		if (pin->enable_count <= 1) {
1571			gpio_set_value_cansleep(pin->gpio,
1572						pin->ena_gpio_invert);
1573			pin->enable_count = 0;
1574		}
1575	}
1576
1577	return 0;
1578}
1579
1580static int _regulator_do_enable(struct regulator_dev *rdev)
1581{
1582	int ret, delay;
1583
1584	/* Query before enabling in case configuration dependent.  */
1585	ret = _regulator_get_enable_time(rdev);
1586	if (ret >= 0) {
1587		delay = ret;
1588	} else {
1589		rdev_warn(rdev, "enable_time() failed: %d\n", ret);
1590		delay = 0;
1591	}
1592
1593	trace_regulator_enable(rdev_get_name(rdev));
1594
1595	if (rdev->ena_pin) {
1596		ret = regulator_ena_gpio_ctrl(rdev, true);
1597		if (ret < 0)
1598			return ret;
1599		rdev->ena_gpio_state = 1;
1600	} else if (rdev->desc->ops->enable) {
1601		ret = rdev->desc->ops->enable(rdev);
1602		if (ret < 0)
1603			return ret;
1604	} else {
1605		return -EINVAL;
1606	}
1607
1608	/* Allow the regulator to ramp; it would be useful to extend
1609	 * this for bulk operations so that the regulators can ramp
1610	 * together.  */
1611	trace_regulator_enable_delay(rdev_get_name(rdev));
1612
1613	if (delay >= 1000) {
1614		mdelay(delay / 1000);
1615		udelay(delay % 1000);
1616	} else if (delay) {
1617		udelay(delay);
1618	}
1619
1620	trace_regulator_enable_complete(rdev_get_name(rdev));
1621
1622	return 0;
1623}
1624
1625/* locks held by regulator_enable() */
1626static int _regulator_enable(struct regulator_dev *rdev)
1627{
1628	int ret;
1629
1630	/* check voltage and requested load before enabling */
1631	if (rdev->constraints &&
1632	    (rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_DRMS))
1633		drms_uA_update(rdev);
1634
1635	if (rdev->use_count == 0) {
1636		/* The regulator may on if it's not switchable or left on */
1637		ret = _regulator_is_enabled(rdev);
1638		if (ret == -EINVAL || ret == 0) {
1639			if (!_regulator_can_change_status(rdev))
1640				return -EPERM;
1641
1642			ret = _regulator_do_enable(rdev);
1643			if (ret < 0)
1644				return ret;
1645
1646		} else if (ret < 0) {
1647			rdev_err(rdev, "is_enabled() failed: %d\n", ret);
1648			return ret;
1649		}
1650		/* Fallthrough on positive return values - already enabled */
1651	}
1652
1653	rdev->use_count++;
1654
1655	return 0;
1656}
1657
1658/**
1659 * regulator_enable - enable regulator output
1660 * @regulator: regulator source
1661 *
1662 * Request that the regulator be enabled with the regulator output at
1663 * the predefined voltage or current value.  Calls to regulator_enable()
1664 * must be balanced with calls to regulator_disable().
1665 *
1666 * NOTE: the output value can be set by other drivers, boot loader or may be
1667 * hardwired in the regulator.
1668 */
1669int regulator_enable(struct regulator *regulator)
1670{
1671	struct regulator_dev *rdev = regulator->rdev;
1672	int ret = 0;
1673
1674	if (regulator->always_on)
1675		return 0;
1676
1677	if (rdev->supply) {
1678		ret = regulator_enable(rdev->supply);
1679		if (ret != 0)
1680			return ret;
1681	}
1682
1683	mutex_lock(&rdev->mutex);
1684	ret = _regulator_enable(rdev);
1685	mutex_unlock(&rdev->mutex);
1686
1687	if (ret != 0 && rdev->supply)
1688		regulator_disable(rdev->supply);
1689
1690	return ret;
1691}
1692EXPORT_SYMBOL_GPL(regulator_enable);
1693
1694static int _regulator_do_disable(struct regulator_dev *rdev)
1695{
1696	int ret;
1697
1698	trace_regulator_disable(rdev_get_name(rdev));
1699
1700	if (rdev->ena_pin) {
1701		ret = regulator_ena_gpio_ctrl(rdev, false);
1702		if (ret < 0)
1703			return ret;
1704		rdev->ena_gpio_state = 0;
1705
1706	} else if (rdev->desc->ops->disable) {
1707		ret = rdev->desc->ops->disable(rdev);
1708		if (ret != 0)
1709			return ret;
1710	}
1711
1712	trace_regulator_disable_complete(rdev_get_name(rdev));
1713
1714	_notifier_call_chain(rdev, REGULATOR_EVENT_DISABLE,
1715			     NULL);
1716	return 0;
1717}
1718
1719/* locks held by regulator_disable() */
1720static int _regulator_disable(struct regulator_dev *rdev)
1721{
1722	int ret = 0;
1723
1724	if (WARN(rdev->use_count <= 0,
1725		 "unbalanced disables for %s\n", rdev_get_name(rdev)))
1726		return -EIO;
1727
1728	/* are we the last user and permitted to disable ? */
1729	if (rdev->use_count == 1 &&
1730	    (rdev->constraints && !rdev->constraints->always_on)) {
1731
1732		/* we are last user */
1733		if (_regulator_can_change_status(rdev)) {
1734			ret = _regulator_do_disable(rdev);
1735			if (ret < 0) {
1736				rdev_err(rdev, "failed to disable\n");
1737				return ret;
1738			}
1739		}
1740
1741		rdev->use_count = 0;
1742	} else if (rdev->use_count > 1) {
1743
1744		if (rdev->constraints &&
1745			(rdev->constraints->valid_ops_mask &
1746			REGULATOR_CHANGE_DRMS))
1747			drms_uA_update(rdev);
1748
1749		rdev->use_count--;
1750	}
1751
1752	return ret;
1753}
1754
1755/**
1756 * regulator_disable - disable regulator output
1757 * @regulator: regulator source
1758 *
1759 * Disable the regulator output voltage or current.  Calls to
1760 * regulator_enable() must be balanced with calls to
1761 * regulator_disable().
1762 *
1763 * NOTE: this will only disable the regulator output if no other consumer
1764 * devices have it enabled, the regulator device supports disabling and
1765 * machine constraints permit this operation.
1766 */
1767int regulator_disable(struct regulator *regulator)
1768{
1769	struct regulator_dev *rdev = regulator->rdev;
1770	int ret = 0;
1771
1772	if (regulator->always_on)
1773		return 0;
1774
1775	mutex_lock(&rdev->mutex);
1776	ret = _regulator_disable(rdev);
1777	mutex_unlock(&rdev->mutex);
1778
1779	if (ret == 0 && rdev->supply)
1780		regulator_disable(rdev->supply);
1781
1782	return ret;
1783}
1784EXPORT_SYMBOL_GPL(regulator_disable);
1785
1786/* locks held by regulator_force_disable() */
1787static int _regulator_force_disable(struct regulator_dev *rdev)
1788{
1789	int ret = 0;
1790
1791	/* force disable */
1792	if (rdev->desc->ops->disable) {
1793		/* ah well, who wants to live forever... */
1794		ret = rdev->desc->ops->disable(rdev);
1795		if (ret < 0) {
1796			rdev_err(rdev, "failed to force disable\n");
1797			return ret;
1798		}
1799		/* notify other consumers that power has been forced off */
1800		_notifier_call_chain(rdev, REGULATOR_EVENT_FORCE_DISABLE |
1801			REGULATOR_EVENT_DISABLE, NULL);
1802	}
1803
1804	return ret;
1805}
1806
1807/**
1808 * regulator_force_disable - force disable regulator output
1809 * @regulator: regulator source
1810 *
1811 * Forcibly disable the regulator output voltage or current.
1812 * NOTE: this *will* disable the regulator output even if other consumer
1813 * devices have it enabled. This should be used for situations when device
1814 * damage will likely occur if the regulator is not disabled (e.g. over temp).
1815 */
1816int regulator_force_disable(struct regulator *regulator)
1817{
1818	struct regulator_dev *rdev = regulator->rdev;
1819	int ret;
1820
1821	mutex_lock(&rdev->mutex);
1822	regulator->uA_load = 0;
1823	ret = _regulator_force_disable(regulator->rdev);
1824	mutex_unlock(&rdev->mutex);
1825
1826	if (rdev->supply)
1827		while (rdev->open_count--)
1828			regulator_disable(rdev->supply);
1829
1830	return ret;
1831}
1832EXPORT_SYMBOL_GPL(regulator_force_disable);
1833
1834static void regulator_disable_work(struct work_struct *work)
1835{
1836	struct regulator_dev *rdev = container_of(work, struct regulator_dev,
1837						  disable_work.work);
1838	int count, i, ret;
1839
1840	mutex_lock(&rdev->mutex);
1841
1842	BUG_ON(!rdev->deferred_disables);
1843
1844	count = rdev->deferred_disables;
1845	rdev->deferred_disables = 0;
1846
1847	for (i = 0; i < count; i++) {
1848		ret = _regulator_disable(rdev);
1849		if (ret != 0)
1850			rdev_err(rdev, "Deferred disable failed: %d\n", ret);
1851	}
1852
1853	mutex_unlock(&rdev->mutex);
1854
1855	if (rdev->supply) {
1856		for (i = 0; i < count; i++) {
1857			ret = regulator_disable(rdev->supply);
1858			if (ret != 0) {
1859				rdev_err(rdev,
1860					 "Supply disable failed: %d\n", ret);
1861			}
1862		}
1863	}
1864}
1865
1866/**
1867 * regulator_disable_deferred - disable regulator output with delay
1868 * @regulator: regulator source
1869 * @ms: miliseconds until the regulator is disabled
1870 *
1871 * Execute regulator_disable() on the regulator after a delay.  This
1872 * is intended for use with devices that require some time to quiesce.
1873 *
1874 * NOTE: this will only disable the regulator output if no other consumer
1875 * devices have it enabled, the regulator device supports disabling and
1876 * machine constraints permit this operation.
1877 */
1878int regulator_disable_deferred(struct regulator *regulator, int ms)
1879{
1880	struct regulator_dev *rdev = regulator->rdev;
1881	int ret;
1882
1883	if (regulator->always_on)
1884		return 0;
1885
1886	if (!ms)
1887		return regulator_disable(regulator);
1888
1889	mutex_lock(&rdev->mutex);
1890	rdev->deferred_disables++;
1891	mutex_unlock(&rdev->mutex);
1892
1893	ret = queue_delayed_work(system_power_efficient_wq,
1894				 &rdev->disable_work,
1895				 msecs_to_jiffies(ms));
1896	if (ret < 0)
1897		return ret;
1898	else
1899		return 0;
1900}
1901EXPORT_SYMBOL_GPL(regulator_disable_deferred);
1902
1903/**
1904 * regulator_is_enabled_regmap - standard is_enabled() for regmap users
1905 *
1906 * @rdev: regulator to operate on
1907 *
1908 * Regulators that use regmap for their register I/O can set the
1909 * enable_reg and enable_mask fields in their descriptor and then use
1910 * this as their is_enabled operation, saving some code.
1911 */
1912int regulator_is_enabled_regmap(struct regulator_dev *rdev)
1913{
1914	unsigned int val;
1915	int ret;
1916
1917	ret = regmap_read(rdev->regmap, rdev->desc->enable_reg, &val);
1918	if (ret != 0)
1919		return ret;
1920
1921	if (rdev->desc->enable_is_inverted)
1922		return (val & rdev->desc->enable_mask) == 0;
1923	else
1924		return (val & rdev->desc->enable_mask) != 0;
1925}
1926EXPORT_SYMBOL_GPL(regulator_is_enabled_regmap);
1927
1928/**
1929 * regulator_enable_regmap - standard enable() for regmap users
1930 *
1931 * @rdev: regulator to operate on
1932 *
1933 * Regulators that use regmap for their register I/O can set the
1934 * enable_reg and enable_mask fields in their descriptor and then use
1935 * this as their enable() operation, saving some code.
1936 */
1937int regulator_enable_regmap(struct regulator_dev *rdev)
1938{
1939	unsigned int val;
1940
1941	if (rdev->desc->enable_is_inverted)
1942		val = 0;
1943	else
1944		val = rdev->desc->enable_mask;
1945
1946	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
1947				  rdev->desc->enable_mask, val);
1948}
1949EXPORT_SYMBOL_GPL(regulator_enable_regmap);
1950
1951/**
1952 * regulator_disable_regmap - standard disable() for regmap users
1953 *
1954 * @rdev: regulator to operate on
1955 *
1956 * Regulators that use regmap for their register I/O can set the
1957 * enable_reg and enable_mask fields in their descriptor and then use
1958 * this as their disable() operation, saving some code.
1959 */
1960int regulator_disable_regmap(struct regulator_dev *rdev)
1961{
1962	unsigned int val;
1963
1964	if (rdev->desc->enable_is_inverted)
1965		val = rdev->desc->enable_mask;
1966	else
1967		val = 0;
1968
1969	return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
1970				  rdev->desc->enable_mask, val);
1971}
1972EXPORT_SYMBOL_GPL(regulator_disable_regmap);
1973
1974static int _regulator_is_enabled(struct regulator_dev *rdev)
1975{
1976	/* A GPIO control always takes precedence */
1977	if (rdev->ena_pin)
1978		return rdev->ena_gpio_state;
1979
1980	/* If we don't know then assume that the regulator is always on */
1981	if (!rdev->desc->ops->is_enabled)
1982		return 1;
1983
1984	return rdev->desc->ops->is_enabled(rdev);
1985}
1986
1987/**
1988 * regulator_is_enabled - is the regulator output enabled
1989 * @regulator: regulator source
1990 *
1991 * Returns positive if the regulator driver backing the source/client
1992 * has requested that the device be enabled, zero if it hasn't, else a
1993 * negative errno code.
1994 *
1995 * Note that the device backing this regulator handle can have multiple
1996 * users, so it might be enabled even if regulator_enable() was never
1997 * called for this particular source.
1998 */
1999int regulator_is_enabled(struct regulator *regulator)
2000{
2001	int ret;
2002
2003	if (regulator->always_on)
2004		return 1;
2005
2006	mutex_lock(&regulator->rdev->mutex);
2007	ret = _regulator_is_enabled(regulator->rdev);
2008	mutex_unlock(&regulator->rdev->mutex);
2009
2010	return ret;
2011}
2012EXPORT_SYMBOL_GPL(regulator_is_enabled);
2013
2014/**
2015 * regulator_can_change_voltage - check if regulator can change voltage
2016 * @regulator: regulator source
2017 *
2018 * Returns positive if the regulator driver backing the source/client
2019 * can change its voltage, false otherwise. Usefull for detecting fixed
2020 * or dummy regulators and disabling voltage change logic in the client
2021 * driver.
2022 */
2023int regulator_can_change_voltage(struct regulator *regulator)
2024{
2025	struct regulator_dev	*rdev = regulator->rdev;
2026
2027	if (rdev->constraints &&
2028	    (rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_VOLTAGE)) {
2029		if (rdev->desc->n_voltages - rdev->desc->linear_min_sel > 1)
2030			return 1;
2031
2032		if (rdev->desc->continuous_voltage_range &&
2033		    rdev->constraints->min_uV && rdev->constraints->max_uV &&
2034		    rdev->constraints->min_uV != rdev->constraints->max_uV)
2035			return 1;
2036	}
2037
2038	return 0;
2039}
2040EXPORT_SYMBOL_GPL(regulator_can_change_voltage);
2041
2042/**
2043 * regulator_count_voltages - count regulator_list_voltage() selectors
2044 * @regulator: regulator source
2045 *
2046 * Returns number of selectors, or negative errno.  Selectors are
2047 * numbered starting at zero, and typically correspond to bitfields
2048 * in hardware registers.
2049 */
2050int regulator_count_voltages(struct regulator *regulator)
2051{
2052	struct regulator_dev	*rdev = regulator->rdev;
2053
2054	return rdev->desc->n_voltages ? : -EINVAL;
2055}
2056EXPORT_SYMBOL_GPL(regulator_count_voltages);
2057
2058/**
2059 * regulator_list_voltage_linear - List voltages with simple calculation
2060 *
2061 * @rdev: Regulator device
2062 * @selector: Selector to convert into a voltage
2063 *
2064 * Regulators with a simple linear mapping between voltages and
2065 * selectors can set min_uV and uV_step in the regulator descriptor
2066 * and then use this function as their list_voltage() operation,
2067 */
2068int regulator_list_voltage_linear(struct regulator_dev *rdev,
2069				  unsigned int selector)
2070{
2071	if (selector >= rdev->desc->n_voltages)
2072		return -EINVAL;
2073	if (selector < rdev->desc->linear_min_sel)
2074		return 0;
2075
2076	selector -= rdev->desc->linear_min_sel;
2077
2078	return rdev->desc->min_uV + (rdev->desc->uV_step * selector);
2079}
2080EXPORT_SYMBOL_GPL(regulator_list_voltage_linear);
2081
2082/**
2083 * regulator_list_voltage_table - List voltages with table based mapping
2084 *
2085 * @rdev: Regulator device
2086 * @selector: Selector to convert into a voltage
2087 *
2088 * Regulators with table based mapping between voltages and
2089 * selectors can set volt_table in the regulator descriptor
2090 * and then use this function as their list_voltage() operation.
2091 */
2092int regulator_list_voltage_table(struct regulator_dev *rdev,
2093				 unsigned int selector)
2094{
2095	if (!rdev->desc->volt_table) {
2096		BUG_ON(!rdev->desc->volt_table);
2097		return -EINVAL;
2098	}
2099
2100	if (selector >= rdev->desc->n_voltages)
2101		return -EINVAL;
2102
2103	return rdev->desc->volt_table[selector];
2104}
2105EXPORT_SYMBOL_GPL(regulator_list_voltage_table);
2106
2107/**
2108 * regulator_list_voltage - enumerate supported voltages
2109 * @regulator: regulator source
2110 * @selector: identify voltage to list
2111 * Context: can sleep
2112 *
2113 * Returns a voltage that can be passed to @regulator_set_voltage(),
2114 * zero if this selector code can't be used on this system, or a
2115 * negative errno.
2116 */
2117int regulator_list_voltage(struct regulator *regulator, unsigned selector)
2118{
2119	struct regulator_dev	*rdev = regulator->rdev;
2120	struct regulator_ops	*ops = rdev->desc->ops;
2121	int			ret;
2122
2123	if (!ops->list_voltage || selector >= rdev->desc->n_voltages)
2124		return -EINVAL;
2125
2126	mutex_lock(&rdev->mutex);
2127	ret = ops->list_voltage(rdev, selector);
2128	mutex_unlock(&rdev->mutex);
2129
2130	if (ret > 0) {
2131		if (ret < rdev->constraints->min_uV)
2132			ret = 0;
2133		else if (ret > rdev->constraints->max_uV)
2134			ret = 0;
2135	}
2136
2137	return ret;
2138}
2139EXPORT_SYMBOL_GPL(regulator_list_voltage);
2140
2141/**
2142 * regulator_get_linear_step - return the voltage step size between VSEL values
2143 * @regulator: regulator source
2144 *
2145 * Returns the voltage step size between VSEL values for linear
2146 * regulators, or return 0 if the regulator isn't a linear regulator.
2147 */
2148unsigned int regulator_get_linear_step(struct regulator *regulator)
2149{
2150	struct regulator_dev *rdev = regulator->rdev;
2151
2152	return rdev->desc->uV_step;
2153}
2154EXPORT_SYMBOL_GPL(regulator_get_linear_step);
2155
2156/**
2157 * regulator_is_supported_voltage - check if a voltage range can be supported
2158 *
2159 * @regulator: Regulator to check.
2160 * @min_uV: Minimum required voltage in uV.
2161 * @max_uV: Maximum required voltage in uV.
2162 *
2163 * Returns a boolean or a negative error code.
2164 */
2165int regulator_is_supported_voltage(struct regulator *regulator,
2166				   int min_uV, int max_uV)
2167{
2168	struct regulator_dev *rdev = regulator->rdev;
2169	int i, voltages, ret;
2170
2171	/* If we can't change voltage check the current voltage */
2172	if (!(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_VOLTAGE)) {
2173		ret = regulator_get_voltage(regulator);
2174		if (ret >= 0)
2175			return (min_uV <= ret && ret <= max_uV);
2176		else
2177			return ret;
2178	}
2179
2180	/* Any voltage within constrains range is fine? */
2181	if (rdev->desc->continuous_voltage_range)
2182		return min_uV >= rdev->constraints->min_uV &&
2183				max_uV <= rdev->constraints->max_uV;
2184
2185	ret = regulator_count_voltages(regulator);
2186	if (ret < 0)
2187		return ret;
2188	voltages = ret;
2189
2190	for (i = 0; i < voltages; i++) {
2191		ret = regulator_list_voltage(regulator, i);
2192
2193		if (ret >= min_uV && ret <= max_uV)
2194			return 1;
2195	}
2196
2197	return 0;
2198}
2199EXPORT_SYMBOL_GPL(regulator_is_supported_voltage);
2200
2201/**
2202 * regulator_get_voltage_sel_regmap - standard get_voltage_sel for regmap users
2203 *
2204 * @rdev: regulator to operate on
2205 *
2206 * Regulators that use regmap for their register I/O can set the
2207 * vsel_reg and vsel_mask fields in their descriptor and then use this
2208 * as their get_voltage_vsel operation, saving some code.
2209 */
2210int regulator_get_voltage_sel_regmap(struct regulator_dev *rdev)
2211{
2212	unsigned int val;
2213	int ret;
2214
2215	ret = regmap_read(rdev->regmap, rdev->desc->vsel_reg, &val);
2216	if (ret != 0)
2217		return ret;
2218
2219	val &= rdev->desc->vsel_mask;
2220	val >>= ffs(rdev->desc->vsel_mask) - 1;
2221
2222	return val;
2223}
2224EXPORT_SYMBOL_GPL(regulator_get_voltage_sel_regmap);
2225
2226/**
2227 * regulator_set_voltage_sel_regmap - standard set_voltage_sel for regmap users
2228 *
2229 * @rdev: regulator to operate on
2230 * @sel: Selector to set
2231 *
2232 * Regulators that use regmap for their register I/O can set the
2233 * vsel_reg and vsel_mask fields in their descriptor and then use this
2234 * as their set_voltage_vsel operation, saving some code.
2235 */
2236int regulator_set_voltage_sel_regmap(struct regulator_dev *rdev, unsigned sel)
2237{
2238	int ret;
2239
2240	sel <<= ffs(rdev->desc->vsel_mask) - 1;
2241
2242	ret = regmap_update_bits(rdev->regmap, rdev->desc->vsel_reg,
2243				  rdev->desc->vsel_mask, sel);
2244	if (ret)
2245		return ret;
2246
2247	if (rdev->desc->apply_bit)
2248		ret = regmap_update_bits(rdev->regmap, rdev->desc->apply_reg,
2249					 rdev->desc->apply_bit,
2250					 rdev->desc->apply_bit);
2251	return ret;
2252}
2253EXPORT_SYMBOL_GPL(regulator_set_voltage_sel_regmap);
2254
2255/**
2256 * regulator_map_voltage_iterate - map_voltage() based on list_voltage()
2257 *
2258 * @rdev: Regulator to operate on
2259 * @min_uV: Lower bound for voltage
2260 * @max_uV: Upper bound for voltage
2261 *
2262 * Drivers implementing set_voltage_sel() and list_voltage() can use
2263 * this as their map_voltage() operation.  It will find a suitable
2264 * voltage by calling list_voltage() until it gets something in bounds
2265 * for the requested voltages.
2266 */
2267int regulator_map_voltage_iterate(struct regulator_dev *rdev,
2268				  int min_uV, int max_uV)
2269{
2270	int best_val = INT_MAX;
2271	int selector = 0;
2272	int i, ret;
2273
2274	/* Find the smallest voltage that falls within the specified
2275	 * range.
2276	 */
2277	for (i = 0; i < rdev->desc->n_voltages; i++) {
2278		ret = rdev->desc->ops->list_voltage(rdev, i);
2279		if (ret < 0)
2280			continue;
2281
2282		if (ret < best_val && ret >= min_uV && ret <= max_uV) {
2283			best_val = ret;
2284			selector = i;
2285		}
2286	}
2287
2288	if (best_val != INT_MAX)
2289		return selector;
2290	else
2291		return -EINVAL;
2292}
2293EXPORT_SYMBOL_GPL(regulator_map_voltage_iterate);
2294
2295/**
2296 * regulator_map_voltage_ascend - map_voltage() for ascendant voltage list
2297 *
2298 * @rdev: Regulator to operate on
2299 * @min_uV: Lower bound for voltage
2300 * @max_uV: Upper bound for voltage
2301 *
2302 * Drivers that have ascendant voltage list can use this as their
2303 * map_voltage() operation.
2304 */
2305int regulator_map_voltage_ascend(struct regulator_dev *rdev,
2306				 int min_uV, int max_uV)
2307{
2308	int i, ret;
2309
2310	for (i = 0; i < rdev->desc->n_voltages; i++) {
2311		ret = rdev->desc->ops->list_voltage(rdev, i);
2312		if (ret < 0)
2313			continue;
2314
2315		if (ret > max_uV)
2316			break;
2317
2318		if (ret >= min_uV && ret <= max_uV)
2319			return i;
2320	}
2321
2322	return -EINVAL;
2323}
2324EXPORT_SYMBOL_GPL(regulator_map_voltage_ascend);
2325
2326/**
2327 * regulator_map_voltage_linear - map_voltage() for simple linear mappings
2328 *
2329 * @rdev: Regulator to operate on
2330 * @min_uV: Lower bound for voltage
2331 * @max_uV: Upper bound for voltage
2332 *
2333 * Drivers providing min_uV and uV_step in their regulator_desc can
2334 * use this as their map_voltage() operation.
2335 */
2336int regulator_map_voltage_linear(struct regulator_dev *rdev,
2337				 int min_uV, int max_uV)
2338{
2339	int ret, voltage;
2340
2341	/* Allow uV_step to be 0 for fixed voltage */
2342	if (rdev->desc->n_voltages == 1 && rdev->desc->uV_step == 0) {
2343		if (min_uV <= rdev->desc->min_uV && rdev->desc->min_uV <= max_uV)
2344			return 0;
2345		else
2346			return -EINVAL;
2347	}
2348
2349	if (!rdev->desc->uV_step) {
2350		BUG_ON(!rdev->desc->uV_step);
2351		return -EINVAL;
2352	}
2353
2354	if (min_uV < rdev->desc->min_uV)
2355		min_uV = rdev->desc->min_uV;
2356
2357	ret = DIV_ROUND_UP(min_uV - rdev->desc->min_uV, rdev->desc->uV_step);
2358	if (ret < 0)
2359		return ret;
2360
2361	ret += rdev->desc->linear_min_sel;
2362
2363	/* Map back into a voltage to verify we're still in bounds */
2364	voltage = rdev->desc->ops->list_voltage(rdev, ret);
2365	if (voltage < min_uV || voltage > max_uV)
2366		return -EINVAL;
2367
2368	return ret;
2369}
2370EXPORT_SYMBOL_GPL(regulator_map_voltage_linear);
2371
2372static int _regulator_do_set_voltage(struct regulator_dev *rdev,
2373				     int min_uV, int max_uV)
2374{
2375	int ret;
2376	int delay = 0;
2377	int best_val = 0;
2378	unsigned int selector;
2379	int old_selector = -1;
2380
2381	trace_regulator_set_voltage(rdev_get_name(rdev), min_uV, max_uV);
2382
2383	min_uV += rdev->constraints->uV_offset;
2384	max_uV += rdev->constraints->uV_offset;
2385
2386	/*
2387	 * If we can't obtain the old selector there is not enough
2388	 * info to call set_voltage_time_sel().
2389	 */
2390	if (_regulator_is_enabled(rdev) &&
2391	    rdev->desc->ops->set_voltage_time_sel &&
2392	    rdev->desc->ops->get_voltage_sel) {
2393		old_selector = rdev->desc->ops->get_voltage_sel(rdev);
2394		if (old_selector < 0)
2395			return old_selector;
2396	}
2397
2398	if (rdev->desc->ops->set_voltage) {
2399		ret = rdev->desc->ops->set_voltage(rdev, min_uV, max_uV,
2400						   &selector);
2401
2402		if (ret >= 0) {
2403			if (rdev->desc->ops->list_voltage)
2404				best_val = rdev->desc->ops->list_voltage(rdev,
2405									 selector);
2406			else
2407				best_val = _regulator_get_voltage(rdev);
2408		}
2409
2410	} else if (rdev->desc->ops->set_voltage_sel) {
2411		if (rdev->desc->ops->map_voltage) {
2412			ret = rdev->desc->ops->map_voltage(rdev, min_uV,
2413							   max_uV);
2414		} else {
2415			if (rdev->desc->ops->list_voltage ==
2416			    regulator_list_voltage_linear)
2417				ret = regulator_map_voltage_linear(rdev,
2418								min_uV, max_uV);
2419			else
2420				ret = regulator_map_voltage_iterate(rdev,
2421								min_uV, max_uV);
2422		}
2423
2424		if (ret >= 0) {
2425			best_val = rdev->desc->ops->list_voltage(rdev, ret);
2426			if (min_uV <= best_val && max_uV >= best_val) {
2427				selector = ret;
2428				if (old_selector == selector)
2429					ret = 0;
2430				else
2431					ret = rdev->desc->ops->set_voltage_sel(
2432								rdev, ret);
2433			} else {
2434				ret = -EINVAL;
2435			}
2436		}
2437	} else {
2438		ret = -EINVAL;
2439	}
2440
2441	/* Call set_voltage_time_sel if successfully obtained old_selector */
2442	if (ret == 0 && _regulator_is_enabled(rdev) && old_selector >= 0 &&
2443	    old_selector != selector && rdev->desc->ops->set_voltage_time_sel) {
2444
2445		delay = rdev->desc->ops->set_voltage_time_sel(rdev,
2446						old_selector, selector);
2447		if (delay < 0) {
2448			rdev_warn(rdev, "set_voltage_time_sel() failed: %d\n",
2449				  delay);
2450			delay = 0;
2451		}
2452
2453		/* Insert any necessary delays */
2454		if (delay >= 1000) {
2455			mdelay(delay / 1000);
2456			udelay(delay % 1000);
2457		} else if (delay) {
2458			udelay(delay);
2459		}
2460	}
2461
2462	if (ret == 0 && best_val >= 0) {
2463		unsigned long data = best_val;
2464
2465		_notifier_call_chain(rdev, REGULATOR_EVENT_VOLTAGE_CHANGE,
2466				     (void *)data);
2467	}
2468
2469	trace_regulator_set_voltage_complete(rdev_get_name(rdev), best_val);
2470
2471	return ret;
2472}
2473
2474/**
2475 * regulator_set_voltage - set regulator output voltage
2476 * @regulator: regulator source
2477 * @min_uV: Minimum required voltage in uV
2478 * @max_uV: Maximum acceptable voltage in uV
2479 *
2480 * Sets a voltage regulator to the desired output voltage. This can be set
2481 * during any regulator state. IOW, regulator can be disabled or enabled.
2482 *
2483 * If the regulator is enabled then the voltage will change to the new value
2484 * immediately otherwise if the regulator is disabled the regulator will
2485 * output at the new voltage when enabled.
2486 *
2487 * NOTE: If the regulator is shared between several devices then the lowest
2488 * request voltage that meets the system constraints will be used.
2489 * Regulator system constraints must be set for this regulator before
2490 * calling this function otherwise this call will fail.
2491 */
2492int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
2493{
2494	struct regulator_dev *rdev = regulator->rdev;
2495	int ret = 0;
2496	int old_min_uV, old_max_uV;
2497
2498	mutex_lock(&rdev->mutex);
2499
2500	/* If we're setting the same range as last time the change
2501	 * should be a noop (some cpufreq implementations use the same
2502	 * voltage for multiple frequencies, for example).
2503	 */
2504	if (regulator->min_uV == min_uV && regulator->max_uV == max_uV)
2505		goto out;
2506
2507	/* sanity check */
2508	if (!rdev->desc->ops->set_voltage &&
2509	    !rdev->desc->ops->set_voltage_sel) {
2510		ret = -EINVAL;
2511		goto out;
2512	}
2513
2514	/* constraints check */
2515	ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
2516	if (ret < 0)
2517		goto out;
2518
2519	/* restore original values in case of error */
2520	old_min_uV = regulator->min_uV;
2521	old_max_uV = regulator->max_uV;
2522	regulator->min_uV = min_uV;
2523	regulator->max_uV = max_uV;
2524
2525	ret = regulator_check_consumers(rdev, &min_uV, &max_uV);
2526	if (ret < 0)
2527		goto out2;
2528
2529	ret = _regulator_do_set_voltage(rdev, min_uV, max_uV);
2530	if (ret < 0)
2531		goto out2;
2532
2533out:
2534	mutex_unlock(&rdev->mutex);
2535	return ret;
2536out2:
2537	regulator->min_uV = old_min_uV;
2538	regulator->max_uV = old_max_uV;
2539	mutex_unlock(&rdev->mutex);
2540	return ret;
2541}
2542EXPORT_SYMBOL_GPL(regulator_set_voltage);
2543
2544/**
2545 * regulator_set_voltage_time - get raise/fall time
2546 * @regulator: regulator source
2547 * @old_uV: starting voltage in microvolts
2548 * @new_uV: target voltage in microvolts
2549 *
2550 * Provided with the starting and ending voltage, this function attempts to
2551 * calculate the time in microseconds required to rise or fall to this new
2552 * voltage.
2553 */
2554int regulator_set_voltage_time(struct regulator *regulator,
2555			       int old_uV, int new_uV)
2556{
2557	struct regulator_dev	*rdev = regulator->rdev;
2558	struct regulator_ops	*ops = rdev->desc->ops;
2559	int old_sel = -1;
2560	int new_sel = -1;
2561	int voltage;
2562	int i;
2563
2564	/* Currently requires operations to do this */
2565	if (!ops->list_voltage || !ops->set_voltage_time_sel
2566	    || !rdev->desc->n_voltages)
2567		return -EINVAL;
2568
2569	for (i = 0; i < rdev->desc->n_voltages; i++) {
2570		/* We only look for exact voltage matches here */
2571		voltage = regulator_list_voltage(regulator, i);
2572		if (voltage < 0)
2573			return -EINVAL;
2574		if (voltage == 0)
2575			continue;
2576		if (voltage == old_uV)
2577			old_sel = i;
2578		if (voltage == new_uV)
2579			new_sel = i;
2580	}
2581
2582	if (old_sel < 0 || new_sel < 0)
2583		return -EINVAL;
2584
2585	return ops->set_voltage_time_sel(rdev, old_sel, new_sel);
2586}
2587EXPORT_SYMBOL_GPL(regulator_set_voltage_time);
2588
2589/**
2590 * regulator_set_voltage_time_sel - get raise/fall time
2591 * @rdev: regulator source device
2592 * @old_selector: selector for starting voltage
2593 * @new_selector: selector for target voltage
2594 *
2595 * Provided with the starting and target voltage selectors, this function
2596 * returns time in microseconds required to rise or fall to this new voltage
2597 *
2598 * Drivers providing ramp_delay in regulation_constraints can use this as their
2599 * set_voltage_time_sel() operation.
2600 */
2601int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
2602				   unsigned int old_selector,
2603				   unsigned int new_selector)
2604{
2605	unsigned int ramp_delay = 0;
2606	int old_volt, new_volt;
2607
2608	if (rdev->constraints->ramp_delay)
2609		ramp_delay = rdev->constraints->ramp_delay;
2610	else if (rdev->desc->ramp_delay)
2611		ramp_delay = rdev->desc->ramp_delay;
2612
2613	if (ramp_delay == 0) {
2614		rdev_warn(rdev, "ramp_delay not set\n");
2615		return 0;
2616	}
2617
2618	/* sanity check */
2619	if (!rdev->desc->ops->list_voltage)
2620		return -EINVAL;
2621
2622	old_volt = rdev->desc->ops->list_voltage(rdev, old_selector);
2623	new_volt = rdev->desc->ops->list_voltage(rdev, new_selector);
2624
2625	return DIV_ROUND_UP(abs(new_volt - old_volt), ramp_delay);
2626}
2627EXPORT_SYMBOL_GPL(regulator_set_voltage_time_sel);
2628
2629/**
2630 * regulator_sync_voltage - re-apply last regulator output voltage
2631 * @regulator: regulator source
2632 *
2633 * Re-apply the last configured voltage.  This is intended to be used
2634 * where some external control source the consumer is cooperating with
2635 * has caused the configured voltage to change.
2636 */
2637int regulator_sync_voltage(struct regulator *regulator)
2638{
2639	struct regulator_dev *rdev = regulator->rdev;
2640	int ret, min_uV, max_uV;
2641
2642	mutex_lock(&rdev->mutex);
2643
2644	if (!rdev->desc->ops->set_voltage &&
2645	    !rdev->desc->ops->set_voltage_sel) {
2646		ret = -EINVAL;
2647		goto out;
2648	}
2649
2650	/* This is only going to work if we've had a voltage configured. */
2651	if (!regulator->min_uV && !regulator->max_uV) {
2652		ret = -EINVAL;
2653		goto out;
2654	}
2655
2656	min_uV = regulator->min_uV;
2657	max_uV = regulator->max_uV;
2658
2659	/* This should be a paranoia check... */
2660	ret = regulator_check_voltage(rdev, &min_uV, &max_uV);
2661	if (ret < 0)
2662		goto out;
2663
2664	ret = regulator_check_consumers(rdev, &min_uV, &max_uV);
2665	if (ret < 0)
2666		goto out;
2667
2668	ret = _regulator_do_set_voltage(rdev, min_uV, max_uV);
2669
2670out:
2671	mutex_unlock(&rdev->mutex);
2672	return ret;
2673}
2674EXPORT_SYMBOL_GPL(regulator_sync_voltage);
2675
2676static int _regulator_get_voltage(struct regulator_dev *rdev)
2677{
2678	int sel, ret;
2679
2680	if (rdev->desc->ops->get_voltage_sel) {
2681		sel = rdev->desc->ops->get_voltage_sel(rdev);
2682		if (sel < 0)
2683			return sel;
2684		ret = rdev->desc->ops->list_voltage(rdev, sel);
2685	} else if (rdev->desc->ops->get_voltage) {
2686		ret = rdev->desc->ops->get_voltage(rdev);
2687	} else if (rdev->desc->ops->list_voltage) {
2688		ret = rdev->desc->ops->list_voltage(rdev, 0);
2689	} else {
2690		return -EINVAL;
2691	}
2692
2693	if (ret < 0)
2694		return ret;
2695	return ret - rdev->constraints->uV_offset;
2696}
2697
2698/**
2699 * regulator_get_voltage - get regulator output voltage
2700 * @regulator: regulator source
2701 *
2702 * This returns the current regulator voltage in uV.
2703 *
2704 * NOTE: If the regulator is disabled it will return the voltage value. This
2705 * function should not be used to determine regulator state.
2706 */
2707int regulator_get_voltage(struct regulator *regulator)
2708{
2709	int ret;
2710
2711	mutex_lock(&regulator->rdev->mutex);
2712
2713	ret = _regulator_get_voltage(regulator->rdev);
2714
2715	mutex_unlock(&regulator->rdev->mutex);
2716
2717	return ret;
2718}
2719EXPORT_SYMBOL_GPL(regulator_get_voltage);
2720
2721/**
2722 * regulator_set_current_limit - set regulator output current limit
2723 * @regulator: regulator source
2724 * @min_uA: Minimum supported current in uA
2725 * @max_uA: Maximum supported current in uA
2726 *
2727 * Sets current sink to the desired output current. This can be set during
2728 * any regulator state. IOW, regulator can be disabled or enabled.
2729 *
2730 * If the regulator is enabled then the current will change to the new value
2731 * immediately otherwise if the regulator is disabled the regulator will
2732 * output at the new current when enabled.
2733 *
2734 * NOTE: Regulator system constraints must be set for this regulator before
2735 * calling this function otherwise this call will fail.
2736 */
2737int regulator_set_current_limit(struct regulator *regulator,
2738			       int min_uA, int max_uA)
2739{
2740	struct regulator_dev *rdev = regulator->rdev;
2741	int ret;
2742
2743	mutex_lock(&rdev->mutex);
2744
2745	/* sanity check */
2746	if (!rdev->desc->ops->set_current_limit) {
2747		ret = -EINVAL;
2748		goto out;
2749	}
2750
2751	/* constraints check */
2752	ret = regulator_check_current_limit(rdev, &min_uA, &max_uA);
2753	if (ret < 0)
2754		goto out;
2755
2756	ret = rdev->desc->ops->set_current_limit(rdev, min_uA, max_uA);
2757out:
2758	mutex_unlock(&rdev->mutex);
2759	return ret;
2760}
2761EXPORT_SYMBOL_GPL(regulator_set_current_limit);
2762
2763static int _regulator_get_current_limit(struct regulator_dev *rdev)
2764{
2765	int ret;
2766
2767	mutex_lock(&rdev->mutex);
2768
2769	/* sanity check */
2770	if (!rdev->desc->ops->get_current_limit) {
2771		ret = -EINVAL;
2772		goto out;
2773	}
2774
2775	ret = rdev->desc->ops->get_current_limit(rdev);
2776out:
2777	mutex_unlock(&rdev->mutex);
2778	return ret;
2779}
2780
2781/**
2782 * regulator_get_current_limit - get regulator output current
2783 * @regulator: regulator source
2784 *
2785 * This returns the current supplied by the specified current sink in uA.
2786 *
2787 * NOTE: If the regulator is disabled it will return the current value. This
2788 * function should not be used to determine regulator state.
2789 */
2790int regulator_get_current_limit(struct regulator *regulator)
2791{
2792	return _regulator_get_current_limit(regulator->rdev);
2793}
2794EXPORT_SYMBOL_GPL(regulator_get_current_limit);
2795
2796/**
2797 * regulator_set_mode - set regulator operating mode
2798 * @regulator: regulator source
2799 * @mode: operating mode - one of the REGULATOR_MODE constants
2800 *
2801 * Set regulator operating mode to increase regulator efficiency or improve
2802 * regulation performance.
2803 *
2804 * NOTE: Regulator system constraints must be set for this regulator before
2805 * calling this function otherwise this call will fail.
2806 */
2807int regulator_set_mode(struct regulator *regulator, unsigned int mode)
2808{
2809	struct regulator_dev *rdev = regulator->rdev;
2810	int ret;
2811	int regulator_curr_mode;
2812
2813	mutex_lock(&rdev->mutex);
2814
2815	/* sanity check */
2816	if (!rdev->desc->ops->set_mode) {
2817		ret = -EINVAL;
2818		goto out;
2819	}
2820
2821	/* return if the same mode is requested */
2822	if (rdev->desc->ops->get_mode) {
2823		regulator_curr_mode = rdev->desc->ops->get_mode(rdev);
2824		if (regulator_curr_mode == mode) {
2825			ret = 0;
2826			goto out;
2827		}
2828	}
2829
2830	/* constraints check */
2831	ret = regulator_mode_constrain(rdev, &mode);
2832	if (ret < 0)
2833		goto out;
2834
2835	ret = rdev->desc->ops->set_mode(rdev, mode);
2836out:
2837	mutex_unlock(&rdev->mutex);
2838	return ret;
2839}
2840EXPORT_SYMBOL_GPL(regulator_set_mode);
2841
2842static unsigned int _regulator_get_mode(struct regulator_dev *rdev)
2843{
2844	int ret;
2845
2846	mutex_lock(&rdev->mutex);
2847
2848	/* sanity check */
2849	if (!rdev->desc->ops->get_mode) {
2850		ret = -EINVAL;
2851		goto out;
2852	}
2853
2854	ret = rdev->desc->ops->get_mode(rdev);
2855out:
2856	mutex_unlock(&rdev->mutex);
2857	return ret;
2858}
2859
2860/**
2861 * regulator_get_mode - get regulator operating mode
2862 * @regulator: regulator source
2863 *
2864 * Get the current regulator operating mode.
2865 */
2866unsigned int regulator_get_mode(struct regulator *regulator)
2867{
2868	return _regulator_get_mode(regulator->rdev);
2869}
2870EXPORT_SYMBOL_GPL(regulator_get_mode);
2871
2872/**
2873 * regulator_set_optimum_mode - set regulator optimum operating mode
2874 * @regulator: regulator source
2875 * @uA_load: load current
2876 *
2877 * Notifies the regulator core of a new device load. This is then used by
2878 * DRMS (if enabled by constraints) to set the most efficient regulator
2879 * operating mode for the new regulator loading.
2880 *
2881 * Consumer devices notify their supply regulator of the maximum power
2882 * they will require (can be taken from device datasheet in the power
2883 * consumption tables) when they change operational status and hence power
2884 * state. Examples of operational state changes that can affect power
2885 * consumption are :-
2886 *
2887 *    o Device is opened / closed.
2888 *    o Device I/O is about to begin or has just finished.
2889 *    o Device is idling in between work.
2890 *
2891 * This information is also exported via sysfs to userspace.
2892 *
2893 * DRMS will sum the total requested load on the regulator and change
2894 * to the most efficient operating mode if platform constraints allow.
2895 *
2896 * Returns the new regulator mode or error.
2897 */
2898int regulator_set_optimum_mode(struct regulator *regulator, int uA_load)
2899{
2900	struct regulator_dev *rdev = regulator->rdev;
2901	struct regulator *consumer;
2902	int ret, output_uV, input_uV = 0, total_uA_load = 0;
2903	unsigned int mode;
2904
2905	if (rdev->supply)
2906		input_uV = regulator_get_voltage(rdev->supply);
2907
2908	mutex_lock(&rdev->mutex);
2909
2910	/*
2911	 * first check to see if we can set modes at all, otherwise just
2912	 * tell the consumer everything is OK.
2913	 */
2914	regulator->uA_load = uA_load;
2915	ret = regulator_check_drms(rdev);
2916	if (ret < 0) {
2917		ret = 0;
2918		goto out;
2919	}
2920
2921	if (!rdev->desc->ops->get_optimum_mode)
2922		goto out;
2923
2924	/*
2925	 * we can actually do this so any errors are indicators of
2926	 * potential real failure.
2927	 */
2928	ret = -EINVAL;
2929
2930	if (!rdev->desc->ops->set_mode)
2931		goto out;
2932
2933	/* get output voltage */
2934	output_uV = _regulator_get_voltage(rdev);
2935	if (output_uV <= 0) {
2936		rdev_err(rdev, "invalid output voltage found\n");
2937		goto out;
2938	}
2939
2940	/* No supply? Use constraint voltage */
2941	if (input_uV <= 0)
2942		input_uV = rdev->constraints->input_uV;
2943	if (input_uV <= 0) {
2944		rdev_err(rdev, "invalid input voltage found\n");
2945		goto out;
2946	}
2947
2948	/* calc total requested load for this regulator */
2949	list_for_each_entry(consumer, &rdev->consumer_list, list)
2950		total_uA_load += consumer->uA_load;
2951
2952	mode = rdev->desc->ops->get_optimum_mode(rdev,
2953						 input_uV, output_uV,
2954						 total_uA_load);
2955	ret = regulator_mode_constrain(rdev, &mode);
2956	if (ret < 0) {
2957		rdev_err(rdev, "failed to get optimum mode @ %d uA %d -> %d uV\n",
2958			 total_uA_load, input_uV, output_uV);
2959		goto out;
2960	}
2961
2962	ret = rdev->desc->ops->set_mode(rdev, mode);
2963	if (ret < 0) {
2964		rdev_err(rdev, "failed to set optimum mode %x\n", mode);
2965		goto out;
2966	}
2967	ret = mode;
2968out:
2969	mutex_unlock(&rdev->mutex);
2970	return ret;
2971}
2972EXPORT_SYMBOL_GPL(regulator_set_optimum_mode);
2973
2974/**
2975 * regulator_set_bypass_regmap - Default set_bypass() using regmap
2976 *
2977 * @rdev: device to operate on.
2978 * @enable: state to set.
2979 */
2980int regulator_set_bypass_regmap(struct regulator_dev *rdev, bool enable)
2981{
2982	unsigned int val;
2983
2984	if (enable)
2985		val = rdev->desc->bypass_mask;
2986	else
2987		val = 0;
2988
2989	return regmap_update_bits(rdev->regmap, rdev->desc->bypass_reg,
2990				  rdev->desc->bypass_mask, val);
2991}
2992EXPORT_SYMBOL_GPL(regulator_set_bypass_regmap);
2993
2994/**
2995 * regulator_get_bypass_regmap - Default get_bypass() using regmap
2996 *
2997 * @rdev: device to operate on.
2998 * @enable: current state.
2999 */
3000int regulator_get_bypass_regmap(struct regulator_dev *rdev, bool *enable)
3001{
3002	unsigned int val;
3003	int ret;
3004
3005	ret = regmap_read(rdev->regmap, rdev->desc->bypass_reg, &val);
3006	if (ret != 0)
3007		return ret;
3008
3009	*enable = val & rdev->desc->bypass_mask;
3010
3011	return 0;
3012}
3013EXPORT_SYMBOL_GPL(regulator_get_bypass_regmap);
3014
3015/**
3016 * regulator_allow_bypass - allow the regulator to go into bypass mode
3017 *
3018 * @regulator: Regulator to configure
3019 * @enable: enable or disable bypass mode
3020 *
3021 * Allow the regulator to go into bypass mode if all other consumers
3022 * for the regulator also enable bypass mode and the machine
3023 * constraints allow this.  Bypass mode means that the regulator is
3024 * simply passing the input directly to the output with no regulation.
3025 */
3026int regulator_allow_bypass(struct regulator *regulator, bool enable)
3027{
3028	struct regulator_dev *rdev = regulator->rdev;
3029	int ret = 0;
3030
3031	if (!rdev->desc->ops->set_bypass)
3032		return 0;
3033
3034	if (rdev->constraints &&
3035	    !(rdev->constraints->valid_ops_mask & REGULATOR_CHANGE_BYPASS))
3036		return 0;
3037
3038	mutex_lock(&rdev->mutex);
3039
3040	if (enable && !regulator->bypass) {
3041		rdev->bypass_count++;
3042
3043		if (rdev->bypass_count == rdev->open_count) {
3044			ret = rdev->desc->ops->set_bypass(rdev, enable);
3045			if (ret != 0)
3046				rdev->bypass_count--;
3047		}
3048
3049	} else if (!enable && regulator->bypass) {
3050		rdev->bypass_count--;
3051
3052		if (rdev->bypass_count != rdev->open_count) {
3053			ret = rdev->desc->ops->set_bypass(rdev, enable);
3054			if (ret != 0)
3055				rdev->bypass_count++;
3056		}
3057	}
3058
3059	if (ret == 0)
3060		regulator->bypass = enable;
3061
3062	mutex_unlock(&rdev->mutex);
3063
3064	return ret;
3065}
3066EXPORT_SYMBOL_GPL(regulator_allow_bypass);
3067
3068/**
3069 * regulator_register_notifier - register regulator event notifier
3070 * @regulator: regulator source
3071 * @nb: notifier block
3072 *
3073 * Register notifier block to receive regulator events.
3074 */
3075int regulator_register_notifier(struct regulator *regulator,
3076			      struct notifier_block *nb)
3077{
3078	return blocking_notifier_chain_register(&regulator->rdev->notifier,
3079						nb);
3080}
3081EXPORT_SYMBOL_GPL(regulator_register_notifier);
3082
3083/**
3084 * regulator_unregister_notifier - unregister regulator event notifier
3085 * @regulator: regulator source
3086 * @nb: notifier block
3087 *
3088 * Unregister regulator event notifier block.
3089 */
3090int regulator_unregister_notifier(struct regulator *regulator,
3091				struct notifier_block *nb)
3092{
3093	return blocking_notifier_chain_unregister(&regulator->rdev->notifier,
3094						  nb);
3095}
3096EXPORT_SYMBOL_GPL(regulator_unregister_notifier);
3097
3098/* notify regulator consumers and downstream regulator consumers.
3099 * Note mutex must be held by caller.
3100 */
3101static void _notifier_call_chain(struct regulator_dev *rdev,
3102				  unsigned long event, void *data)
3103{
3104	/* call rdev chain first */
3105	blocking_notifier_call_chain(&rdev->notifier, event, data);
3106}
3107
3108/**
3109 * regulator_bulk_get - get multiple regulator consumers
3110 *
3111 * @dev:           Device to supply
3112 * @num_consumers: Number of consumers to register
3113 * @consumers:     Configuration of consumers; clients are stored here.
3114 *
3115 * @return 0 on success, an errno on failure.
3116 *
3117 * This helper function allows drivers to get several regulator
3118 * consumers in one operation.  If any of the regulators cannot be
3119 * acquired then any regulators that were allocated will be freed
3120 * before returning to the caller.
3121 */
3122int regulator_bulk_get(struct device *dev, int num_consumers,
3123		       struct regulator_bulk_data *consumers)
3124{
3125	int i;
3126	int ret;
3127
3128	for (i = 0; i < num_consumers; i++)
3129		consumers[i].consumer = NULL;
3130
3131	for (i = 0; i < num_consumers; i++) {
3132		consumers[i].consumer = regulator_get(dev,
3133						      consumers[i].supply);
3134		if (IS_ERR(consumers[i].consumer)) {
3135			ret = PTR_ERR(consumers[i].consumer);
3136			dev_err(dev, "Failed to get supply '%s': %d\n",
3137				consumers[i].supply, ret);
3138			consumers[i].consumer = NULL;
3139			goto err;
3140		}
3141	}
3142
3143	return 0;
3144
3145err:
3146	while (--i >= 0)
3147		regulator_put(consumers[i].consumer);
3148
3149	return ret;
3150}
3151EXPORT_SYMBOL_GPL(regulator_bulk_get);
3152
3153/**
3154 * devm_regulator_bulk_get - managed get multiple regulator consumers
3155 *
3156 * @dev:           Device to supply
3157 * @num_consumers: Number of consumers to register
3158 * @consumers:     Configuration of consumers; clients are stored here.
3159 *
3160 * @return 0 on success, an errno on failure.
3161 *
3162 * This helper function allows drivers to get several regulator
3163 * consumers in one operation with management, the regulators will
3164 * automatically be freed when the device is unbound.  If any of the
3165 * regulators cannot be acquired then any regulators that were
3166 * allocated will be freed before returning to the caller.
3167 */
3168int devm_regulator_bulk_get(struct device *dev, int num_consumers,
3169			    struct regulator_bulk_data *consumers)
3170{
3171	int i;
3172	int ret;
3173
3174	for (i = 0; i < num_consumers; i++)
3175		consumers[i].consumer = NULL;
3176
3177	for (i = 0; i < num_consumers; i++) {
3178		consumers[i].consumer = devm_regulator_get(dev,
3179							   consumers[i].supply);
3180		if (IS_ERR(consumers[i].consumer)) {
3181			ret = PTR_ERR(consumers[i].consumer);
3182			dev_err(dev, "Failed to get supply '%s': %d\n",
3183				consumers[i].supply, ret);
3184			consumers[i].consumer = NULL;
3185			goto err;
3186		}
3187	}
3188
3189	return 0;
3190
3191err:
3192	for (i = 0; i < num_consumers && consumers[i].consumer; i++)
3193		devm_regulator_put(consumers[i].consumer);
3194
3195	return ret;
3196}
3197EXPORT_SYMBOL_GPL(devm_regulator_bulk_get);
3198
3199static void regulator_bulk_enable_async(void *data, async_cookie_t cookie)
3200{
3201	struct regulator_bulk_data *bulk = data;
3202
3203	bulk->ret = regulator_enable(bulk->consumer);
3204}
3205
3206/**
3207 * regulator_bulk_enable - enable multiple regulator consumers
3208 *
3209 * @num_consumers: Number of consumers
3210 * @consumers:     Consumer data; clients are stored here.
3211 * @return         0 on success, an errno on failure
3212 *
3213 * This convenience API allows consumers to enable multiple regulator
3214 * clients in a single API call.  If any consumers cannot be enabled
3215 * then any others that were enabled will be disabled again prior to
3216 * return.
3217 */
3218int regulator_bulk_enable(int num_consumers,
3219			  struct regulator_bulk_data *consumers)
3220{
3221	ASYNC_DOMAIN_EXCLUSIVE(async_domain);
3222	int i;
3223	int ret = 0;
3224
3225	for (i = 0; i < num_consumers; i++) {
3226		if (consumers[i].consumer->always_on)
3227			consumers[i].ret = 0;
3228		else
3229			async_schedule_domain(regulator_bulk_enable_async,
3230					      &consumers[i], &async_domain);
3231	}
3232
3233	async_synchronize_full_domain(&async_domain);
3234
3235	/* If any consumer failed we need to unwind any that succeeded */
3236	for (i = 0; i < num_consumers; i++) {
3237		if (consumers[i].ret != 0) {
3238			ret = consumers[i].ret;
3239			goto err;
3240		}
3241	}
3242
3243	return 0;
3244
3245err:
3246	for (i = 0; i < num_consumers; i++) {
3247		if (consumers[i].ret < 0)
3248			pr_err("Failed to enable %s: %d\n", consumers[i].supply,
3249			       consumers[i].ret);
3250		else
3251			regulator_disable(consumers[i].consumer);
3252	}
3253
3254	return ret;
3255}
3256EXPORT_SYMBOL_GPL(regulator_bulk_enable);
3257
3258/**
3259 * regulator_bulk_disable - disable multiple regulator consumers
3260 *
3261 * @num_consumers: Number of consumers
3262 * @consumers:     Consumer data; clients are stored here.
3263 * @return         0 on success, an errno on failure
3264 *
3265 * This convenience API allows consumers to disable multiple regulator
3266 * clients in a single API call.  If any consumers cannot be disabled
3267 * then any others that were disabled will be enabled again prior to
3268 * return.
3269 */
3270int regulator_bulk_disable(int num_consumers,
3271			   struct regulator_bulk_data *consumers)
3272{
3273	int i;
3274	int ret, r;
3275
3276	for (i = num_consumers - 1; i >= 0; --i) {
3277		ret = regulator_disable(consumers[i].consumer);
3278		if (ret != 0)
3279			goto err;
3280	}
3281
3282	return 0;
3283
3284err:
3285	pr_err("Failed to disable %s: %d\n", consumers[i].supply, ret);
3286	for (++i; i < num_consumers; ++i) {
3287		r = regulator_enable(consumers[i].consumer);
3288		if (r != 0)
3289			pr_err("Failed to reename %s: %d\n",
3290			       consumers[i].supply, r);
3291	}
3292
3293	return ret;
3294}
3295EXPORT_SYMBOL_GPL(regulator_bulk_disable);
3296
3297/**
3298 * regulator_bulk_force_disable - force disable multiple regulator consumers
3299 *
3300 * @num_consumers: Number of consumers
3301 * @consumers:     Consumer data; clients are stored here.
3302 * @return         0 on success, an errno on failure
3303 *
3304 * This convenience API allows consumers to forcibly disable multiple regulator
3305 * clients in a single API call.
3306 * NOTE: This should be used for situations when device damage will
3307 * likely occur if the regulators are not disabled (e.g. over temp).
3308 * Although regulator_force_disable function call for some consumers can
3309 * return error numbers, the function is called for all consumers.
3310 */
3311int regulator_bulk_force_disable(int num_consumers,
3312			   struct regulator_bulk_data *consumers)
3313{
3314	int i;
3315	int ret;
3316
3317	for (i = 0; i < num_consumers; i++)
3318		consumers[i].ret =
3319			    regulator_force_disable(consumers[i].consumer);
3320
3321	for (i = 0; i < num_consumers; i++) {
3322		if (consumers[i].ret != 0) {
3323			ret = consumers[i].ret;
3324			goto out;
3325		}
3326	}
3327
3328	return 0;
3329out:
3330	return ret;
3331}
3332EXPORT_SYMBOL_GPL(regulator_bulk_force_disable);
3333
3334/**
3335 * regulator_bulk_free - free multiple regulator consumers
3336 *
3337 * @num_consumers: Number of consumers
3338 * @consumers:     Consumer data; clients are stored here.
3339 *
3340 * This convenience API allows consumers to free multiple regulator
3341 * clients in a single API call.
3342 */
3343void regulator_bulk_free(int num_consumers,
3344			 struct regulator_bulk_data *consumers)
3345{
3346	int i;
3347
3348	for (i = 0; i < num_consumers; i++) {
3349		regulator_put(consumers[i].consumer);
3350		consumers[i].consumer = NULL;
3351	}
3352}
3353EXPORT_SYMBOL_GPL(regulator_bulk_free);
3354
3355/**
3356 * regulator_notifier_call_chain - call regulator event notifier
3357 * @rdev: regulator source
3358 * @event: notifier block
3359 * @data: callback-specific data.
3360 *
3361 * Called by regulator drivers to notify clients a regulator event has
3362 * occurred. We also notify regulator clients downstream.
3363 * Note lock must be held by caller.
3364 */
3365int regulator_notifier_call_chain(struct regulator_dev *rdev,
3366				  unsigned long event, void *data)
3367{
3368	_notifier_call_chain(rdev, event, data);
3369	return NOTIFY_DONE;
3370
3371}
3372EXPORT_SYMBOL_GPL(regulator_notifier_call_chain);
3373
3374/**
3375 * regulator_mode_to_status - convert a regulator mode into a status
3376 *
3377 * @mode: Mode to convert
3378 *
3379 * Convert a regulator mode into a status.
3380 */
3381int regulator_mode_to_status(unsigned int mode)
3382{
3383	switch (mode) {
3384	case REGULATOR_MODE_FAST:
3385		return REGULATOR_STATUS_FAST;
3386	case REGULATOR_MODE_NORMAL:
3387		return REGULATOR_STATUS_NORMAL;
3388	case REGULATOR_MODE_IDLE:
3389		return REGULATOR_STATUS_IDLE;
3390	case REGULATOR_MODE_STANDBY:
3391		return REGULATOR_STATUS_STANDBY;
3392	default:
3393		return REGULATOR_STATUS_UNDEFINED;
3394	}
3395}
3396EXPORT_SYMBOL_GPL(regulator_mode_to_status);
3397
3398/*
3399 * To avoid cluttering sysfs (and memory) with useless state, only
3400 * create attributes that can be meaningfully displayed.
3401 */
3402static int add_regulator_attributes(struct regulator_dev *rdev)
3403{
3404	struct device		*dev = &rdev->dev;
3405	struct regulator_ops	*ops = rdev->desc->ops;
3406	int			status = 0;
3407
3408	/* some attributes need specific methods to be displayed */
3409	if ((ops->get_voltage && ops->get_voltage(rdev) >= 0) ||
3410	    (ops->get_voltage_sel && ops->get_voltage_sel(rdev) >= 0) ||
3411	    (ops->list_voltage && ops->list_voltage(rdev, 0) >= 0)) {
3412		status = device_create_file(dev, &dev_attr_microvolts);
3413		if (status < 0)
3414			return status;
3415	}
3416	if (ops->get_current_limit) {
3417		status = device_create_file(dev, &dev_attr_microamps);
3418		if (status < 0)
3419			return status;
3420	}
3421	if (ops->get_mode) {
3422		status = device_create_file(dev, &dev_attr_opmode);
3423		if (status < 0)
3424			return status;
3425	}
3426	if (rdev->ena_pin || ops->is_enabled) {
3427		status = device_create_file(dev, &dev_attr_state);
3428		if (status < 0)
3429			return status;
3430	}
3431	if (ops->get_status) {
3432		status = device_create_file(dev, &dev_attr_status);
3433		if (status < 0)
3434			return status;
3435	}
3436	if (ops->get_bypass) {
3437		status = device_create_file(dev, &dev_attr_bypass);
3438		if (status < 0)
3439			return status;
3440	}
3441
3442	/* some attributes are type-specific */
3443	if (rdev->desc->type == REGULATOR_CURRENT) {
3444		status = device_create_file(dev, &dev_attr_requested_microamps);
3445		if (status < 0)
3446			return status;
3447	}
3448
3449	/* all the other attributes exist to support constraints;
3450	 * don't show them if there are no constraints, or if the
3451	 * relevant supporting methods are missing.
3452	 */
3453	if (!rdev->constraints)
3454		return status;
3455
3456	/* constraints need specific supporting methods */
3457	if (ops->set_voltage || ops->set_voltage_sel) {
3458		status = device_create_file(dev, &dev_attr_min_microvolts);
3459		if (status < 0)
3460			return status;
3461		status = device_create_file(dev, &dev_attr_max_microvolts);
3462		if (status < 0)
3463			return status;
3464	}
3465	if (ops->set_current_limit) {
3466		status = device_create_file(dev, &dev_attr_min_microamps);
3467		if (status < 0)
3468			return status;
3469		status = device_create_file(dev, &dev_attr_max_microamps);
3470		if (status < 0)
3471			return status;
3472	}
3473
3474	status = device_create_file(dev, &dev_attr_suspend_standby_state);
3475	if (status < 0)
3476		return status;
3477	status = device_create_file(dev, &dev_attr_suspend_mem_state);
3478	if (status < 0)
3479		return status;
3480	status = device_create_file(dev, &dev_attr_suspend_disk_state);
3481	if (status < 0)
3482		return status;
3483
3484	if (ops->set_suspend_voltage) {
3485		status = device_create_file(dev,
3486				&dev_attr_suspend_standby_microvolts);
3487		if (status < 0)
3488			return status;
3489		status = device_create_file(dev,
3490				&dev_attr_suspend_mem_microvolts);
3491		if (status < 0)
3492			return status;
3493		status = device_create_file(dev,
3494				&dev_attr_suspend_disk_microvolts);
3495		if (status < 0)
3496			return status;
3497	}
3498
3499	if (ops->set_suspend_mode) {
3500		status = device_create_file(dev,
3501				&dev_attr_suspend_standby_mode);
3502		if (status < 0)
3503			return status;
3504		status = device_create_file(dev,
3505				&dev_attr_suspend_mem_mode);
3506		if (status < 0)
3507			return status;
3508		status = device_create_file(dev,
3509				&dev_attr_suspend_disk_mode);
3510		if (status < 0)
3511			return status;
3512	}
3513
3514	return status;
3515}
3516
3517static void rdev_init_debugfs(struct regulator_dev *rdev)
3518{
3519	rdev->debugfs = debugfs_create_dir(rdev_get_name(rdev), debugfs_root);
3520	if (!rdev->debugfs) {
3521		rdev_warn(rdev, "Failed to create debugfs directory\n");
3522		return;
3523	}
3524
3525	debugfs_create_u32("use_count", 0444, rdev->debugfs,
3526			   &rdev->use_count);
3527	debugfs_create_u32("open_count", 0444, rdev->debugfs,
3528			   &rdev->open_count);
3529	debugfs_create_u32("bypass_count", 0444, rdev->debugfs,
3530			   &rdev->bypass_count);
3531}
3532
3533/**
3534 * regulator_register - register regulator
3535 * @regulator_desc: regulator to register
3536 * @config: runtime configuration for regulator
3537 *
3538 * Called by regulator drivers to register a regulator.
3539 * Returns a valid pointer to struct regulator_dev on success
3540 * or an ERR_PTR() on error.
3541 */
3542struct regulator_dev *
3543regulator_register(const struct regulator_desc *regulator_desc,
3544		   const struct regulator_config *config)
3545{
3546	const struct regulation_constraints *constraints = NULL;
3547	const struct regulator_init_data *init_data;
3548	static atomic_t regulator_no = ATOMIC_INIT(0);
3549	struct regulator_dev *rdev;
3550	struct device *dev;
3551	int ret, i;
3552	const char *supply = NULL;
3553
3554	if (regulator_desc == NULL || config == NULL)
3555		return ERR_PTR(-EINVAL);
3556
3557	dev = config->dev;
3558	WARN_ON(!dev);
3559
3560	if (regulator_desc->name == NULL || regulator_desc->ops == NULL)
3561		return ERR_PTR(-EINVAL);
3562
3563	if (regulator_desc->type != REGULATOR_VOLTAGE &&
3564	    regulator_desc->type != REGULATOR_CURRENT)
3565		return ERR_PTR(-EINVAL);
3566
3567	/* Only one of each should be implemented */
3568	WARN_ON(regulator_desc->ops->get_voltage &&
3569		regulator_desc->ops->get_voltage_sel);
3570	WARN_ON(regulator_desc->ops->set_voltage &&
3571		regulator_desc->ops->set_voltage_sel);
3572
3573	/* If we're using selectors we must implement list_voltage. */
3574	if (regulator_desc->ops->get_voltage_sel &&
3575	    !regulator_desc->ops->list_voltage) {
3576		return ERR_PTR(-EINVAL);
3577	}
3578	if (regulator_desc->ops->set_voltage_sel &&
3579	    !regulator_desc->ops->list_voltage) {
3580		return ERR_PTR(-EINVAL);
3581	}
3582
3583	init_data = config->init_data;
3584
3585	rdev = kzalloc(sizeof(struct regulator_dev), GFP_KERNEL);
3586	if (rdev == NULL)
3587		return ERR_PTR(-ENOMEM);
3588
3589	mutex_lock(&regulator_list_mutex);
3590
3591	mutex_init(&rdev->mutex);
3592	rdev->reg_data = config->driver_data;
3593	rdev->owner = regulator_desc->owner;
3594	rdev->desc = regulator_desc;
3595	if (config->regmap)
3596		rdev->regmap = config->regmap;
3597	else if (dev_get_regmap(dev, NULL))
3598		rdev->regmap = dev_get_regmap(dev, NULL);
3599	else if (dev->parent)
3600		rdev->regmap = dev_get_regmap(dev->parent, NULL);
3601	INIT_LIST_HEAD(&rdev->consumer_list);
3602	INIT_LIST_HEAD(&rdev->list);
3603	BLOCKING_INIT_NOTIFIER_HEAD(&rdev->notifier);
3604	INIT_DELAYED_WORK(&rdev->disable_work, regulator_disable_work);
3605
3606	/* preform any regulator specific init */
3607	if (init_data && init_data->regulator_init) {
3608		ret = init_data->regulator_init(rdev->reg_data);
3609		if (ret < 0)
3610			goto clean;
3611	}
3612
3613	/* register with sysfs */
3614	rdev->dev.class = &regulator_class;
3615	rdev->dev.of_node = config->of_node;
3616	rdev->dev.parent = dev;
3617	dev_set_name(&rdev->dev, "regulator.%d",
3618		     atomic_inc_return(&regulator_no) - 1);
3619	ret = device_register(&rdev->dev);
3620	if (ret != 0) {
3621		put_device(&rdev->dev);
3622		goto clean;
3623	}
3624
3625	dev_set_drvdata(&rdev->dev, rdev);
3626
3627	if (config->ena_gpio && gpio_is_valid(config->ena_gpio)) {
3628		ret = regulator_ena_gpio_request(rdev, config);
3629		if (ret != 0) {
3630			rdev_err(rdev, "Failed to request enable GPIO%d: %d\n",
3631				 config->ena_gpio, ret);
3632			goto wash;
3633		}
3634
3635		if (config->ena_gpio_flags & GPIOF_OUT_INIT_HIGH)
3636			rdev->ena_gpio_state = 1;
3637
3638		if (config->ena_gpio_invert)
3639			rdev->ena_gpio_state = !rdev->ena_gpio_state;
3640	}
3641
3642	/* set regulator constraints */
3643	if (init_data)
3644		constraints = &init_data->constraints;
3645
3646	ret = set_machine_constraints(rdev, constraints);
3647	if (ret < 0)
3648		goto scrub;
3649
3650	/* add attributes supported by this regulator */
3651	ret = add_regulator_attributes(rdev);
3652	if (ret < 0)
3653		goto scrub;
3654
3655	if (init_data && init_data->supply_regulator)
3656		supply = init_data->supply_regulator;
3657	else if (regulator_desc->supply_name)
3658		supply = regulator_desc->supply_name;
3659
3660	if (supply) {
3661		struct regulator_dev *r;
3662
3663		r = regulator_dev_lookup(dev, supply, &ret);
3664
3665		if (ret == -ENODEV) {
3666			/*
3667			 * No supply was specified for this regulator and
3668			 * there will never be one.
3669			 */
3670			ret = 0;
3671			goto add_dev;
3672		} else if (!r) {
3673			dev_err(dev, "Failed to find supply %s\n", supply);
3674			ret = -EPROBE_DEFER;
3675			goto scrub;
3676		}
3677
3678		ret = set_supply(rdev, r);
3679		if (ret < 0)
3680			goto scrub;
3681
3682		/* Enable supply if rail is enabled */
3683		if (_regulator_is_enabled(rdev)) {
3684			ret = regulator_enable(rdev->supply);
3685			if (ret < 0)
3686				goto scrub;
3687		}
3688	}
3689
3690add_dev:
3691	/* add consumers devices */
3692	if (init_data) {
3693		for (i = 0; i < init_data->num_consumer_supplies; i++) {
3694			ret = set_consumer_device_supply(rdev,
3695				init_data->consumer_supplies[i].dev_name,
3696				init_data->consumer_supplies[i].supply);
3697			if (ret < 0) {
3698				dev_err(dev, "Failed to set supply %s\n",
3699					init_data->consumer_supplies[i].supply);
3700				goto unset_supplies;
3701			}
3702		}
3703	}
3704
3705	list_add(&rdev->list, &regulator_list);
3706
3707	rdev_init_debugfs(rdev);
3708out:
3709	mutex_unlock(&regulator_list_mutex);
3710	return rdev;
3711
3712unset_supplies:
3713	unset_regulator_supplies(rdev);
3714
3715scrub:
3716	if (rdev->supply)
3717		_regulator_put(rdev->supply);
3718	regulator_ena_gpio_free(rdev);
3719	kfree(rdev->constraints);
3720wash:
3721	device_unregister(&rdev->dev);
3722	/* device core frees rdev */
3723	rdev = ERR_PTR(ret);
3724	goto out;
3725
3726clean:
3727	kfree(rdev);
3728	rdev = ERR_PTR(ret);
3729	goto out;
3730}
3731EXPORT_SYMBOL_GPL(regulator_register);
3732
3733/**
3734 * regulator_unregister - unregister regulator
3735 * @rdev: regulator to unregister
3736 *
3737 * Called by regulator drivers to unregister a regulator.
3738 */
3739void regulator_unregister(struct regulator_dev *rdev)
3740{
3741	if (rdev == NULL)
3742		return;
3743
3744	if (rdev->supply) {
3745		while (rdev->use_count--)
3746			regulator_disable(rdev->supply);
3747		regulator_put(rdev->supply);
3748	}
3749	mutex_lock(&regulator_list_mutex);
3750	debugfs_remove_recursive(rdev->debugfs);
3751	flush_work(&rdev->disable_work.work);
3752	WARN_ON(rdev->open_count);
3753	unset_regulator_supplies(rdev);
3754	list_del(&rdev->list);
3755	kfree(rdev->constraints);
3756	regulator_ena_gpio_free(rdev);
3757	device_unregister(&rdev->dev);
3758	mutex_unlock(&regulator_list_mutex);
3759}
3760EXPORT_SYMBOL_GPL(regulator_unregister);
3761
3762/**
3763 * regulator_suspend_prepare - prepare regulators for system wide suspend
3764 * @state: system suspend state
3765 *
3766 * Configure each regulator with it's suspend operating parameters for state.
3767 * This will usually be called by machine suspend code prior to supending.
3768 */
3769int regulator_suspend_prepare(suspend_state_t state)
3770{
3771	struct regulator_dev *rdev;
3772	int ret = 0;
3773
3774	/* ON is handled by regulator active state */
3775	if (state == PM_SUSPEND_ON)
3776		return -EINVAL;
3777
3778	mutex_lock(&regulator_list_mutex);
3779	list_for_each_entry(rdev, &regulator_list, list) {
3780
3781		mutex_lock(&rdev->mutex);
3782		ret = suspend_prepare(rdev, state);
3783		mutex_unlock(&rdev->mutex);
3784
3785		if (ret < 0) {
3786			rdev_err(rdev, "failed to prepare\n");
3787			goto out;
3788		}
3789	}
3790out:
3791	mutex_unlock(&regulator_list_mutex);
3792	return ret;
3793}
3794EXPORT_SYMBOL_GPL(regulator_suspend_prepare);
3795
3796/**
3797 * regulator_suspend_finish - resume regulators from system wide suspend
3798 *
3799 * Turn on regulators that might be turned off by regulator_suspend_prepare
3800 * and that should be turned on according to the regulators properties.
3801 */
3802int regulator_suspend_finish(void)
3803{
3804	struct regulator_dev *rdev;
3805	int ret = 0, error;
3806
3807	mutex_lock(&regulator_list_mutex);
3808	list_for_each_entry(rdev, &regulator_list, list) {
3809		struct regulator_ops *ops = rdev->desc->ops;
3810
3811		mutex_lock(&rdev->mutex);
3812		if ((rdev->use_count > 0  || rdev->constraints->always_on) &&
3813				ops->enable) {
3814			error = ops->enable(rdev);
3815			if (error)
3816				ret = error;
3817		} else {
3818			if (!has_full_constraints)
3819				goto unlock;
3820			if (!ops->disable)
3821				goto unlock;
3822			if (!_regulator_is_enabled(rdev))
3823				goto unlock;
3824
3825			error = ops->disable(rdev);
3826			if (error)
3827				ret = error;
3828		}
3829unlock:
3830		mutex_unlock(&rdev->mutex);
3831	}
3832	mutex_unlock(&regulator_list_mutex);
3833	return ret;
3834}
3835EXPORT_SYMBOL_GPL(regulator_suspend_finish);
3836
3837/**
3838 * regulator_has_full_constraints - the system has fully specified constraints
3839 *
3840 * Calling this function will cause the regulator API to disable all
3841 * regulators which have a zero use count and don't have an always_on
3842 * constraint in a late_initcall.
3843 *
3844 * The intention is that this will become the default behaviour in a
3845 * future kernel release so users are encouraged to use this facility
3846 * now.
3847 */
3848void regulator_has_full_constraints(void)
3849{
3850	has_full_constraints = 1;
3851}
3852EXPORT_SYMBOL_GPL(regulator_has_full_constraints);
3853
3854/**
3855 * regulator_use_dummy_regulator - Provide a dummy regulator when none is found
3856 *
3857 * Calling this function will cause the regulator API to provide a
3858 * dummy regulator to consumers if no physical regulator is found,
3859 * allowing most consumers to proceed as though a regulator were
3860 * configured.  This allows systems such as those with software
3861 * controllable regulators for the CPU core only to be brought up more
3862 * readily.
3863 */
3864void regulator_use_dummy_regulator(void)
3865{
3866	board_wants_dummy_regulator = true;
3867}
3868EXPORT_SYMBOL_GPL(regulator_use_dummy_regulator);
3869
3870/**
3871 * rdev_get_drvdata - get rdev regulator driver data
3872 * @rdev: regulator
3873 *
3874 * Get rdev regulator driver private data. This call can be used in the
3875 * regulator driver context.
3876 */
3877void *rdev_get_drvdata(struct regulator_dev *rdev)
3878{
3879	return rdev->reg_data;
3880}
3881EXPORT_SYMBOL_GPL(rdev_get_drvdata);
3882
3883/**
3884 * regulator_get_drvdata - get regulator driver data
3885 * @regulator: regulator
3886 *
3887 * Get regulator driver private data. This call can be used in the consumer
3888 * driver context when non API regulator specific functions need to be called.
3889 */
3890void *regulator_get_drvdata(struct regulator *regulator)
3891{
3892	return regulator->rdev->reg_data;
3893}
3894EXPORT_SYMBOL_GPL(regulator_get_drvdata);
3895
3896/**
3897 * regulator_set_drvdata - set regulator driver data
3898 * @regulator: regulator
3899 * @data: data
3900 */
3901void regulator_set_drvdata(struct regulator *regulator, void *data)
3902{
3903	regulator->rdev->reg_data = data;
3904}
3905EXPORT_SYMBOL_GPL(regulator_set_drvdata);
3906
3907/**
3908 * regulator_get_id - get regulator ID
3909 * @rdev: regulator
3910 */
3911int rdev_get_id(struct regulator_dev *rdev)
3912{
3913	return rdev->desc->id;
3914}
3915EXPORT_SYMBOL_GPL(rdev_get_id);
3916
3917struct device *rdev_get_dev(struct regulator_dev *rdev)
3918{
3919	return &rdev->dev;
3920}
3921EXPORT_SYMBOL_GPL(rdev_get_dev);
3922
3923void *regulator_get_init_drvdata(struct regulator_init_data *reg_init_data)
3924{
3925	return reg_init_data->driver_data;
3926}
3927EXPORT_SYMBOL_GPL(regulator_get_init_drvdata);
3928
3929#ifdef CONFIG_DEBUG_FS
3930static ssize_t supply_map_read_file(struct file *file, char __user *user_buf,
3931				    size_t count, loff_t *ppos)
3932{
3933	char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
3934	ssize_t len, ret = 0;
3935	struct regulator_map *map;
3936
3937	if (!buf)
3938		return -ENOMEM;
3939
3940	list_for_each_entry(map, &regulator_map_list, list) {
3941		len = snprintf(buf + ret, PAGE_SIZE - ret,
3942			       "%s -> %s.%s\n",
3943			       rdev_get_name(map->regulator), map->dev_name,
3944			       map->supply);
3945		if (len >= 0)
3946			ret += len;
3947		if (ret > PAGE_SIZE) {
3948			ret = PAGE_SIZE;
3949			break;
3950		}
3951	}
3952
3953	ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
3954
3955	kfree(buf);
3956
3957	return ret;
3958}
3959#endif
3960
3961static const struct file_operations supply_map_fops = {
3962#ifdef CONFIG_DEBUG_FS
3963	.read = supply_map_read_file,
3964	.llseek = default_llseek,
3965#endif
3966};
3967
3968static int __init regulator_init(void)
3969{
3970	int ret;
3971
3972	ret = class_register(&regulator_class);
3973
3974	debugfs_root = debugfs_create_dir("regulator", NULL);
3975	if (!debugfs_root)
3976		pr_warn("regulator: Failed to create debugfs directory\n");
3977
3978	debugfs_create_file("supply_map", 0444, debugfs_root, NULL,
3979			    &supply_map_fops);
3980
3981	regulator_dummy_init();
3982
3983	return ret;
3984}
3985
3986/* init early to allow our consumers to complete system booting */
3987core_initcall(regulator_init);
3988
3989static int __init regulator_init_complete(void)
3990{
3991	struct regulator_dev *rdev;
3992	struct regulator_ops *ops;
3993	struct regulation_constraints *c;
3994	int enabled, ret;
3995
3996	/*
3997	 * Since DT doesn't provide an idiomatic mechanism for
3998	 * enabling full constraints and since it's much more natural
3999	 * with DT to provide them just assume that a DT enabled
4000	 * system has full constraints.
4001	 */
4002	if (of_have_populated_dt())
4003		has_full_constraints = true;
4004
4005	mutex_lock(&regulator_list_mutex);
4006
4007	/* If we have a full configuration then disable any regulators
4008	 * which are not in use or always_on.  This will become the
4009	 * default behaviour in the future.
4010	 */
4011	list_for_each_entry(rdev, &regulator_list, list) {
4012		ops = rdev->desc->ops;
4013		c = rdev->constraints;
4014
4015		if (!ops->disable || (c && c->always_on))
4016			continue;
4017
4018		mutex_lock(&rdev->mutex);
4019
4020		if (rdev->use_count)
4021			goto unlock;
4022
4023		/* If we can't read the status assume it's on. */
4024		if (ops->is_enabled)
4025			enabled = ops->is_enabled(rdev);
4026		else
4027			enabled = 1;
4028
4029		if (!enabled)
4030			goto unlock;
4031
4032		if (has_full_constraints) {
4033			/* We log since this may kill the system if it
4034			 * goes wrong. */
4035			rdev_info(rdev, "disabling\n");
4036			ret = ops->disable(rdev);
4037			if (ret != 0) {
4038				rdev_err(rdev, "couldn't disable: %d\n", ret);
4039			}
4040		} else {
4041			/* The intention is that in future we will
4042			 * assume that full constraints are provided
4043			 * so warn even if we aren't going to do
4044			 * anything here.
4045			 */
4046			rdev_warn(rdev, "incomplete constraints, leaving on\n");
4047		}
4048
4049unlock:
4050		mutex_unlock(&rdev->mutex);
4051	}
4052
4053	mutex_unlock(&regulator_list_mutex);
4054
4055	return 0;
4056}
4057late_initcall(regulator_init_complete);
4058