[mirror_ubuntu-jammy-kernel.git] / drivers / regulator / virtual.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * reg-virtual-consumer.c
 *
 * Copyright 2008 Wolfson Microelectronics PLC.
 *
 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
 */

#include <linux/err.h>
#include <linux/mutex.h>
#include <linux/platform_device.h>
#include <linux/regulator/consumer.h>
#include <linux/slab.h>
#include <linux/module.h>

struct virtual_consumer_data {
	struct mutex lock;
	struct regulator *regulator;
	bool enabled;
	int min_uV;
	int max_uV;
	int min_uA;
	int max_uA;
	unsigned int mode;
};

static void update_voltage_constraints(struct device *dev,
				       struct virtual_consumer_data *data)
{
	int ret;

	if (data->min_uV && data->max_uV
	    && data->min_uV <= data->max_uV) {
		dev_dbg(dev, "Requesting %d-%duV\n",
			data->min_uV, data->max_uV);
		ret = regulator_set_voltage(data->regulator,
					data->min_uV, data->max_uV);
		if (ret != 0) {
			dev_err(dev,
				"regulator_set_voltage() failed: %d\n", ret);
			return;
		}
	}

	if (data->min_uV && data->max_uV && !data->enabled) {
		dev_dbg(dev, "Enabling regulator\n");
		ret = regulator_enable(data->regulator);
		if (ret == 0)
			data->enabled = true;
		else
			dev_err(dev, "regulator_enable() failed: %d\n",
				ret);
	}

	if (!(data->min_uV && data->max_uV) && data->enabled) {
		dev_dbg(dev, "Disabling regulator\n");
		ret = regulator_disable(data->regulator);
		if (ret == 0)
			data->enabled = false;
		else
			dev_err(dev, "regulator_disable() failed: %d\n",
				ret);
	}
}

static void update_current_limit_constraints(struct device *dev,
					  struct virtual_consumer_data *data)
{
	int ret;

	if (data->max_uA
	    && data->min_uA <= data->max_uA) {
		dev_dbg(dev, "Requesting %d-%duA\n",
			data->min_uA, data->max_uA);
		ret = regulator_set_current_limit(data->regulator,
					data->min_uA, data->max_uA);
		if (ret != 0) {
			dev_err(dev,
				"regulator_set_current_limit() failed: %d\n",
				ret);
			return;
		}
	}

	if (data->max_uA && !data->enabled) {
		dev_dbg(dev, "Enabling regulator\n");
		ret = regulator_enable(data->regulator);
		if (ret == 0)
			data->enabled = true;
		else
			dev_err(dev, "regulator_enable() failed: %d\n",
				ret);
	}

	if (!(data->min_uA && data->max_uA) && data->enabled) {
		dev_dbg(dev, "Disabling regulator\n");
		ret = regulator_disable(data->regulator);
		if (ret == 0)
			data->enabled = false;
		else
			dev_err(dev, "regulator_disable() failed: %d\n",
				ret);
	}
}

static ssize_t show_min_uV(struct device *dev,
			   struct device_attribute *attr, char *buf)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	return sprintf(buf, "%d\n", data->min_uV);
}

static ssize_t set_min_uV(struct device *dev, struct device_attribute *attr,
			  const char *buf, size_t count)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	long val;

	if (kstrtol(buf, 10, &val) != 0)
		return count;

	mutex_lock(&data->lock);

	data->min_uV = val;
	update_voltage_constraints(dev, data);

	mutex_unlock(&data->lock);

	return count;
}

static ssize_t show_max_uV(struct device *dev,
			   struct device_attribute *attr, char *buf)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	return sprintf(buf, "%d\n", data->max_uV);
}

static ssize_t set_max_uV(struct device *dev, struct device_attribute *attr,
			  const char *buf, size_t count)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	long val;

	if (kstrtol(buf, 10, &val) != 0)
		return count;

	mutex_lock(&data->lock);

	data->max_uV = val;
	update_voltage_constraints(dev, data);

	mutex_unlock(&data->lock);

	return count;
}

static ssize_t show_min_uA(struct device *dev,
			   struct device_attribute *attr, char *buf)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	return sprintf(buf, "%d\n", data->min_uA);
}

static ssize_t set_min_uA(struct device *dev, struct device_attribute *attr,
			  const char *buf, size_t count)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	long val;

	if (kstrtol(buf, 10, &val) != 0)
		return count;

	mutex_lock(&data->lock);

	data->min_uA = val;
	update_current_limit_constraints(dev, data);

	mutex_unlock(&data->lock);

	return count;
}

static ssize_t show_max_uA(struct device *dev,
			   struct device_attribute *attr, char *buf)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	return sprintf(buf, "%d\n", data->max_uA);
}

static ssize_t set_max_uA(struct device *dev, struct device_attribute *attr,
			  const char *buf, size_t count)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	long val;

	if (kstrtol(buf, 10, &val) != 0)
		return count;

	mutex_lock(&data->lock);

	data->max_uA = val;
	update_current_limit_constraints(dev, data);

	mutex_unlock(&data->lock);

	return count;
}

static ssize_t show_mode(struct device *dev,
			 struct device_attribute *attr, char *buf)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);

	switch (data->mode) {
	case REGULATOR_MODE_FAST:
		return sprintf(buf, "fast\n");
	case REGULATOR_MODE_NORMAL:
		return sprintf(buf, "normal\n");
	case REGULATOR_MODE_IDLE:
		return sprintf(buf, "idle\n");
	case REGULATOR_MODE_STANDBY:
		return sprintf(buf, "standby\n");
	default:
		return sprintf(buf, "unknown\n");
	}
}

static ssize_t set_mode(struct device *dev, struct device_attribute *attr,
			const char *buf, size_t count)
{
	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	unsigned int mode;
	int ret;

	/*
	 * sysfs_streq() doesn't need the \n's, but we add them so the strings
	 * will be shared with show_mode(), above.
	 */
	if (sysfs_streq(buf, "fast\n"))
		mode = REGULATOR_MODE_FAST;
	else if (sysfs_streq(buf, "normal\n"))
		mode = REGULATOR_MODE_NORMAL;
	else if (sysfs_streq(buf, "idle\n"))
		mode = REGULATOR_MODE_IDLE;
	else if (sysfs_streq(buf, "standby\n"))
		mode = REGULATOR_MODE_STANDBY;
	else {
		dev_err(dev, "Configuring invalid mode\n");
		return count;
	}

	mutex_lock(&data->lock);
	ret = regulator_set_mode(data->regulator, mode);
	if (ret == 0)
		data->mode = mode;
	else
		dev_err(dev, "Failed to configure mode: %d\n", ret);
	mutex_unlock(&data->lock);

	return count;
}

static DEVICE_ATTR(min_microvolts, 0664, show_min_uV, set_min_uV);
static DEVICE_ATTR(max_microvolts, 0664, show_max_uV, set_max_uV);
static DEVICE_ATTR(min_microamps, 0664, show_min_uA, set_min_uA);
static DEVICE_ATTR(max_microamps, 0664, show_max_uA, set_max_uA);
static DEVICE_ATTR(mode, 0664, show_mode, set_mode);

static struct attribute *regulator_virtual_attributes[] = {
	&dev_attr_min_microvolts.attr,
	&dev_attr_max_microvolts.attr,
	&dev_attr_min_microamps.attr,
	&dev_attr_max_microamps.attr,
	&dev_attr_mode.attr,
	NULL
};

static const struct attribute_group regulator_virtual_attr_group = {
	.attrs	= regulator_virtual_attributes,
};

static int regulator_virtual_probe(struct platform_device *pdev)
{
	char *reg_id = dev_get_platdata(&pdev->dev);
	struct virtual_consumer_data *drvdata;
	int ret;

	drvdata = devm_kzalloc(&pdev->dev, sizeof(struct virtual_consumer_data),
			       GFP_KERNEL);
	if (drvdata == NULL)
		return -ENOMEM;

	mutex_init(&drvdata->lock);

	drvdata->regulator = devm_regulator_get(&pdev->dev, reg_id);
	if (IS_ERR(drvdata->regulator)) {
		ret = PTR_ERR(drvdata->regulator);
		dev_err(&pdev->dev, "Failed to obtain supply '%s': %d\n",
			reg_id, ret);
		return ret;
	}

	ret = sysfs_create_group(&pdev->dev.kobj,
				 &regulator_virtual_attr_group);
	if (ret != 0) {
		dev_err(&pdev->dev,
			"Failed to create attribute group: %d\n", ret);
		return ret;
	}

	drvdata->mode = regulator_get_mode(drvdata->regulator);

	platform_set_drvdata(pdev, drvdata);

	return 0;
}

static int regulator_virtual_remove(struct platform_device *pdev)
{
	struct virtual_consumer_data *drvdata = platform_get_drvdata(pdev);

	sysfs_remove_group(&pdev->dev.kobj, &regulator_virtual_attr_group);

	if (drvdata->enabled)
		regulator_disable(drvdata->regulator);

	return 0;
}

static struct platform_driver regulator_virtual_consumer_driver = {
	.probe		= regulator_virtual_probe,
	.remove		= regulator_virtual_remove,
	.driver		= {
		.name		= "reg-virt-consumer",
	},
};

module_platform_driver(regulator_virtual_consumer_driver);

MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
MODULE_DESCRIPTION("Virtual regulator consumer");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:reg-virt-consumer");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
c080909e MB	2	/*
	3	* reg-virtual-consumer.c
	4	*
	5	* Copyright 2008 Wolfson Microelectronics PLC.
	6	*
	7	* Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
c080909e MB	8	*/
	9
	10	#include <linux/err.h>
	11	#include <linux/mutex.h>
	12	#include <linux/platform_device.h>
	13	#include <linux/regulator/consumer.h>
5a0e3ad6	14	#include <linux/slab.h>
65602c32	15	#include <linux/module.h>
c080909e MB	16
	17	struct virtual_consumer_data {
	18	struct mutex lock;
	19	struct regulator *regulator;
4cf95663	20	bool enabled;
c080909e MB	21	int min_uV;
	22	int max_uV;
	23	int min_uA;
	24	int max_uA;
	25	unsigned int mode;
	26	};
	27
a07ac217 MB	28	static void update_voltage_constraints(struct device *dev,
a07ac217 MB	29	struct virtual_consumer_data *data)
c080909e MB	30	{
	31	int ret;
	32
	33	if (data->min_uV && data->max_uV
	34	&& data->min_uV <= data->max_uV) {
a5d2abce MB	35	dev_dbg(dev, "Requesting %d-%duV\n",
a5d2abce MB	36	data->min_uV, data->max_uV);
c080909e	37	ret = regulator_set_voltage(data->regulator,
a07ac217	38	data->min_uV, data->max_uV);
c080909e	39	if (ret != 0) {
a07ac217 MB	40	dev_err(dev,
a07ac217 MB	41	"regulator_set_voltage() failed: %d\n", ret);
c080909e MB	42	return;
	43	}
	44	}
	45
	46	if (data->min_uV && data->max_uV && !data->enabled) {
a5d2abce	47	dev_dbg(dev, "Enabling regulator\n");
c080909e MB	48	ret = regulator_enable(data->regulator);
c080909e MB	49	if (ret == 0)
4cf95663	50	data->enabled = true;
c080909e	51	else
a07ac217	52	dev_err(dev, "regulator_enable() failed: %d\n",
c080909e MB	53	ret);
	54	}
	55
	56	if (!(data->min_uV && data->max_uV) && data->enabled) {
a5d2abce	57	dev_dbg(dev, "Disabling regulator\n");
c080909e MB	58	ret = regulator_disable(data->regulator);
c080909e MB	59	if (ret == 0)
4cf95663	60	data->enabled = false;
c080909e	61	else
a07ac217	62	dev_err(dev, "regulator_disable() failed: %d\n",
c080909e MB	63	ret);
	64	}
	65	}
	66
a07ac217 MB	67	static void update_current_limit_constraints(struct device *dev,
a07ac217 MB	68	struct virtual_consumer_data *data)
c080909e MB	69	{
	70	int ret;
	71
	72	if (data->max_uA
	73	&& data->min_uA <= data->max_uA) {
a5d2abce MB	74	dev_dbg(dev, "Requesting %d-%duA\n",
a5d2abce MB	75	data->min_uA, data->max_uA);
c080909e MB	76	ret = regulator_set_current_limit(data->regulator,
	77	data->min_uA, data->max_uA);
	78	if (ret != 0) {
a07ac217 MB	79	dev_err(dev,
	80	"regulator_set_current_limit() failed: %d\n",
	81	ret);
c080909e MB	82	return;
	83	}
	84	}
	85
	86	if (data->max_uA && !data->enabled) {
a5d2abce	87	dev_dbg(dev, "Enabling regulator\n");
c080909e MB	88	ret = regulator_enable(data->regulator);
c080909e MB	89	if (ret == 0)
4cf95663	90	data->enabled = true;
c080909e	91	else
a07ac217	92	dev_err(dev, "regulator_enable() failed: %d\n",
c080909e MB	93	ret);
	94	}
	95
	96	if (!(data->min_uA && data->max_uA) && data->enabled) {
a5d2abce	97	dev_dbg(dev, "Disabling regulator\n");
c080909e MB	98	ret = regulator_disable(data->regulator);
c080909e MB	99	if (ret == 0)
4cf95663	100	data->enabled = false;
c080909e	101	else
a07ac217	102	dev_err(dev, "regulator_disable() failed: %d\n",
c080909e MB	103	ret);
	104	}
	105	}
	106
	107	static ssize_t show_min_uV(struct device *dev,
	108	struct device_attribute attr, char buf)
	109	{
	110	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	111	return sprintf(buf, "%d\n", data->min_uV);
	112	}
	113
	114	static ssize_t set_min_uV(struct device dev, struct device_attribute attr,
	115	const char *buf, size_t count)
	116	{
	117	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	118	long val;
	119
85960e7b	120	if (kstrtol(buf, 10, &val) != 0)
c080909e MB	121	return count;
	122
	123	mutex_lock(&data->lock);
	124
	125	data->min_uV = val;
a07ac217	126	update_voltage_constraints(dev, data);
c080909e MB	127
	128	mutex_unlock(&data->lock);
	129
	130	return count;
	131	}
	132
	133	static ssize_t show_max_uV(struct device *dev,
	134	struct device_attribute attr, char buf)
	135	{
	136	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	137	return sprintf(buf, "%d\n", data->max_uV);
	138	}
	139
	140	static ssize_t set_max_uV(struct device dev, struct device_attribute attr,
	141	const char *buf, size_t count)
	142	{
	143	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	144	long val;
	145
85960e7b	146	if (kstrtol(buf, 10, &val) != 0)
c080909e MB	147	return count;
	148
	149	mutex_lock(&data->lock);
	150
	151	data->max_uV = val;
a07ac217	152	update_voltage_constraints(dev, data);
c080909e MB	153
	154	mutex_unlock(&data->lock);
	155
	156	return count;
	157	}
	158
	159	static ssize_t show_min_uA(struct device *dev,
	160	struct device_attribute attr, char buf)
	161	{
	162	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	163	return sprintf(buf, "%d\n", data->min_uA);
	164	}
	165
	166	static ssize_t set_min_uA(struct device dev, struct device_attribute attr,
	167	const char *buf, size_t count)
	168	{
	169	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	170	long val;
	171
85960e7b	172	if (kstrtol(buf, 10, &val) != 0)
c080909e MB	173	return count;
	174
	175	mutex_lock(&data->lock);
	176
	177	data->min_uA = val;
a07ac217	178	update_current_limit_constraints(dev, data);
c080909e MB	179
	180	mutex_unlock(&data->lock);
	181
	182	return count;
	183	}
	184
	185	static ssize_t show_max_uA(struct device *dev,
	186	struct device_attribute attr, char buf)
	187	{
	188	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	189	return sprintf(buf, "%d\n", data->max_uA);
	190	}
	191
	192	static ssize_t set_max_uA(struct device dev, struct device_attribute attr,
	193	const char *buf, size_t count)
	194	{
	195	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	196	long val;
	197
85960e7b	198	if (kstrtol(buf, 10, &val) != 0)
c080909e MB	199	return count;
	200
	201	mutex_lock(&data->lock);
	202
	203	data->max_uA = val;
a07ac217	204	update_current_limit_constraints(dev, data);
c080909e MB	205
	206	mutex_unlock(&data->lock);
	207
	208	return count;
	209	}
	210
	211	static ssize_t show_mode(struct device *dev,
	212	struct device_attribute attr, char buf)
	213	{
	214	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	215
	216	switch (data->mode) {
	217	case REGULATOR_MODE_FAST:
	218	return sprintf(buf, "fast\n");
	219	case REGULATOR_MODE_NORMAL:
	220	return sprintf(buf, "normal\n");
	221	case REGULATOR_MODE_IDLE:
	222	return sprintf(buf, "idle\n");
	223	case REGULATOR_MODE_STANDBY:
	224	return sprintf(buf, "standby\n");
	225	default:
	226	return sprintf(buf, "unknown\n");
	227	}
	228	}
	229
	230	static ssize_t set_mode(struct device dev, struct device_attribute attr,
	231	const char *buf, size_t count)
	232	{
	233	struct virtual_consumer_data *data = dev_get_drvdata(dev);
	234	unsigned int mode;
	235	int ret;
	236
9485397a AM	237	/*
	238	* sysfs_streq() doesn't need the \n's, but we add them so the strings
	239	* will be shared with show_mode(), above.
	240	*/
aa61d558	241	if (sysfs_streq(buf, "fast\n"))
c080909e	242	mode = REGULATOR_MODE_FAST;
aa61d558	243	else if (sysfs_streq(buf, "normal\n"))
c080909e	244	mode = REGULATOR_MODE_NORMAL;
aa61d558	245	else if (sysfs_streq(buf, "idle\n"))
c080909e	246	mode = REGULATOR_MODE_IDLE;
aa61d558	247	else if (sysfs_streq(buf, "standby\n"))
c080909e MB	248	mode = REGULATOR_MODE_STANDBY;
	249	else {
	250	dev_err(dev, "Configuring invalid mode\n");
	251	return count;
	252	}
	253
	254	mutex_lock(&data->lock);
	255	ret = regulator_set_mode(data->regulator, mode);
	256	if (ret == 0)
	257	data->mode = mode;
	258	else
	259	dev_err(dev, "Failed to configure mode: %d\n", ret);
	260	mutex_unlock(&data->lock);
	261
	262	return count;
	263	}
	264
71e06af2 RR	265	static DEVICE_ATTR(min_microvolts, 0664, show_min_uV, set_min_uV);
	266	static DEVICE_ATTR(max_microvolts, 0664, show_max_uV, set_max_uV);
	267	static DEVICE_ATTR(min_microamps, 0664, show_min_uA, set_min_uA);
	268	static DEVICE_ATTR(max_microamps, 0664, show_max_uA, set_max_uA);
	269	static DEVICE_ATTR(mode, 0664, show_mode, set_mode);
c080909e	270
4cf95663 DT	271	static struct attribute *regulator_virtual_attributes[] = {
	272	&dev_attr_min_microvolts.attr,
	273	&dev_attr_max_microvolts.attr,
	274	&dev_attr_min_microamps.attr,
	275	&dev_attr_max_microamps.attr,
	276	&dev_attr_mode.attr,
	277	NULL
c080909e MB	278	};
c080909e MB	279
4cf95663 DT	280	static const struct attribute_group regulator_virtual_attr_group = {
	281	.attrs = regulator_virtual_attributes,
	282	};
	283
a5023574	284	static int regulator_virtual_probe(struct platform_device *pdev)
c080909e	285	{
dff91d0b	286	char *reg_id = dev_get_platdata(&pdev->dev);
c080909e	287	struct virtual_consumer_data *drvdata;
4cf95663	288	int ret;
c080909e	289
a81edbde AL	290	drvdata = devm_kzalloc(&pdev->dev, sizeof(struct virtual_consumer_data),
a81edbde AL	291	GFP_KERNEL);
4cf95663	292	if (drvdata == NULL)
72b86876	293	return -ENOMEM;
c080909e MB	294
	295	mutex_init(&drvdata->lock);
	296
a81edbde	297	drvdata->regulator = devm_regulator_get(&pdev->dev, reg_id);
c080909e MB	298	if (IS_ERR(drvdata->regulator)) {
c080909e MB	299	ret = PTR_ERR(drvdata->regulator);
d61c3d56 MB	300	dev_err(&pdev->dev, "Failed to obtain supply '%s': %d\n",
d61c3d56 MB	301	reg_id, ret);
a81edbde	302	return ret;
c080909e MB	303	}
c080909e MB	304
4cf95663 DT	305	ret = sysfs_create_group(&pdev->dev.kobj,
	306	&regulator_virtual_attr_group);
	307	if (ret != 0) {
	308	dev_err(&pdev->dev,
	309	"Failed to create attribute group: %d\n", ret);
a81edbde	310	return ret;
c080909e MB	311	}
	312
	313	drvdata->mode = regulator_get_mode(drvdata->regulator);
	314
	315	platform_set_drvdata(pdev, drvdata);
	316
	317	return 0;
c080909e MB	318	}
c080909e MB	319
8dc995f5	320	static int regulator_virtual_remove(struct platform_device *pdev)
c080909e MB	321	{
c080909e MB	322	struct virtual_consumer_data *drvdata = platform_get_drvdata(pdev);
c080909e	323
4cf95663 DT	324	sysfs_remove_group(&pdev->dev.kobj, &regulator_virtual_attr_group);
4cf95663 DT	325
c080909e MB	326	if (drvdata->enabled)
c080909e MB	327	regulator_disable(drvdata->regulator);
c080909e MB	328
	329	return 0;
	330	}
	331
	332	static struct platform_driver regulator_virtual_consumer_driver = {
4cf95663	333	.probe = regulator_virtual_probe,
5eb9f2b9	334	.remove = regulator_virtual_remove,
c080909e MB	335	.driver = {
	336	.name = "reg-virt-consumer",
	337	},
	338	};
	339
005d610f	340	module_platform_driver(regulator_virtual_consumer_driver);
c080909e MB	341
	342	MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
	343	MODULE_DESCRIPTION("Virtual regulator consumer");
	344	MODULE_LICENSE("GPL");
38c53c89	345	MODULE_ALIAS("platform:reg-virt-consumer");