[deliverable/linux.git] / drivers / regulator / max1586.c

/*
 * max1586.c  --  Voltage and current regulation for the Maxim 1586
 *
 * Copyright (C) 2008 Robert Jarzmik
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#include <linux/module.h>
#include <linux/err.h>
#include <linux/i2c.h>
#include <linux/platform_device.h>
#include <linux/regulator/driver.h>
#include <linux/slab.h>
#include <linux/regulator/max1586.h>

#define MAX1586_V3_MAX_VSEL 31
#define MAX1586_V6_MAX_VSEL 3

#define MAX1586_V3_MIN_UV   700000
#define MAX1586_V3_MAX_UV  1475000

#define MAX1586_V6_MIN_UV        0
#define MAX1586_V6_MAX_UV  3000000

#define I2C_V3_SELECT (0 << 5)
#define I2C_V6_SELECT (1 << 5)

struct max1586_data {
	struct i2c_client *client;

	/* min/max V3 voltage */
	unsigned int min_uV;
	unsigned int max_uV;

	struct regulator_dev *rdev[0];
};

/*
 * V6 voltage
 * On I2C bus, sending a "x" byte to the max1586 means :
 *   set V6 to either 0V, 1.8V, 2.5V, 3V depending on (x & 0x3)
 * As regulator framework doesn't accept voltages to be 0V, we use 1uV.
 */
static int v6_voltages_uv[] = { 1, 1800000, 2500000, 3000000 };

/*
 * V3 voltage
 * On I2C bus, sending a "x" byte to the max1586 means :
 *   set V3 to 0.700V + (x & 0x1f) * 0.025V
 * This voltage can be increased by external resistors
 * R24 and R25=100kOhm as described in the data sheet.
 * The gain is approximately: 1 + R24/R25 + R24/185.5kOhm
 */
static int max1586_v3_calc_voltage(struct max1586_data *max1586,
	unsigned selector)
{
	unsigned range_uV = max1586->max_uV - max1586->min_uV;

	return max1586->min_uV + (selector * range_uV / MAX1586_V3_MAX_VSEL);
}

static int max1586_v3_set(struct regulator_dev *rdev, int min_uV, int max_uV,
			  unsigned *selector)
{
	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
	struct i2c_client *client = max1586->client;
	unsigned range_uV = max1586->max_uV - max1586->min_uV;
	u8 v3_prog;

	if (min_uV > max1586->max_uV || max_uV < max1586->min_uV)
		return -EINVAL;
	if (min_uV < max1586->min_uV)
		min_uV = max1586->min_uV;

	*selector = DIV_ROUND_UP((min_uV - max1586->min_uV) *
				 MAX1586_V3_MAX_VSEL, range_uV);
	if (max1586_v3_calc_voltage(max1586, *selector) > max_uV)
		return -EINVAL;

	dev_dbg(&client->dev, "changing voltage v3 to %dmv\n",
		max1586_v3_calc_voltage(max1586, *selector) / 1000);

	v3_prog = I2C_V3_SELECT | (u8) *selector;
	return i2c_smbus_write_byte(client, v3_prog);
}

static int max1586_v3_list(struct regulator_dev *rdev, unsigned selector)
{
	struct max1586_data *max1586 = rdev_get_drvdata(rdev);

	if (selector > MAX1586_V3_MAX_VSEL)
		return -EINVAL;
	return max1586_v3_calc_voltage(max1586, selector);
}

static int max1586_v6_set_voltage_sel(struct regulator_dev *rdev,
				      unsigned int selector)
{
	struct i2c_client *client = rdev_get_drvdata(rdev);
	u8 v6_prog;

	dev_dbg(&client->dev, "changing voltage v6 to %dmv\n",
		rdev->desc->volt_table[selector] / 1000);

	v6_prog = I2C_V6_SELECT | (u8) selector;
	return i2c_smbus_write_byte(client, v6_prog);
}

/*
 * The Maxim 1586 controls V3 and V6 voltages, but offers no way of reading back
 * the set up value.
 */
static struct regulator_ops max1586_v3_ops = {
	.set_voltage = max1586_v3_set,
	.list_voltage = max1586_v3_list,
};

static struct regulator_ops max1586_v6_ops = {
	.set_voltage_sel = max1586_v6_set_voltage_sel,
	.list_voltage = regulator_list_voltage_table,
};

static const struct regulator_desc max1586_reg[] = {
	{
		.name = "Output_V3",
		.id = MAX1586_V3,
		.ops = &max1586_v3_ops,
		.type = REGULATOR_VOLTAGE,
		.n_voltages = MAX1586_V3_MAX_VSEL + 1,
		.owner = THIS_MODULE,
	},
	{
		.name = "Output_V6",
		.id = MAX1586_V6,
		.ops = &max1586_v6_ops,
		.type = REGULATOR_VOLTAGE,
		.n_voltages = MAX1586_V6_MAX_VSEL + 1,
		.volt_table = v6_voltages_uv,
		.owner = THIS_MODULE,
	},
};

static int __devinit max1586_pmic_probe(struct i2c_client *client,
					const struct i2c_device_id *i2c_id)
{
	struct regulator_dev **rdev;
	struct max1586_platform_data *pdata = client->dev.platform_data;
	struct regulator_config config = { };
	struct max1586_data *max1586;
	int i, id, ret = -ENOMEM;

	max1586 = devm_kzalloc(&client->dev, sizeof(struct max1586_data) +
			sizeof(struct regulator_dev *) * (MAX1586_V6 + 1),
			GFP_KERNEL);
	if (!max1586)
		return -ENOMEM;

	max1586->client = client;

	if (!pdata->v3_gain)
		return -EINVAL;

	max1586->min_uV = MAX1586_V3_MIN_UV / 1000 * pdata->v3_gain / 1000;
	max1586->max_uV = MAX1586_V3_MAX_UV / 1000 * pdata->v3_gain / 1000;

	rdev = max1586->rdev;
	for (i = 0; i < pdata->num_subdevs && i <= MAX1586_V6; i++) {
		id = pdata->subdevs[i].id;
		if (!pdata->subdevs[i].platform_data)
			continue;
		if (id < MAX1586_V3 || id > MAX1586_V6) {
			dev_err(&client->dev, "invalid regulator id %d\n", id);
			goto err;
		}

		config.dev = &client->dev;
		config.init_data = pdata->subdevs[i].platform_data;
		config.driver_data = max1586;

		rdev[i] = regulator_register(&max1586_reg[id], &config);
		if (IS_ERR(rdev[i])) {
			ret = PTR_ERR(rdev[i]);
			dev_err(&client->dev, "failed to register %s\n",
				max1586_reg[id].name);
			goto err;
		}
	}

	i2c_set_clientdata(client, max1586);
	dev_info(&client->dev, "Maxim 1586 regulator driver loaded\n");
	return 0;

err:
	while (--i >= 0)
		regulator_unregister(rdev[i]);
	return ret;
}

static int __devexit max1586_pmic_remove(struct i2c_client *client)
{
	struct max1586_data *max1586 = i2c_get_clientdata(client);
	int i;

	for (i = 0; i <= MAX1586_V6; i++)
		if (max1586->rdev[i])
			regulator_unregister(max1586->rdev[i]);
	return 0;
}

static const struct i2c_device_id max1586_id[] = {
	{ "max1586", 0 },
	{ }
};
MODULE_DEVICE_TABLE(i2c, max1586_id);

static struct i2c_driver max1586_pmic_driver = {
	.probe = max1586_pmic_probe,
	.remove = __devexit_p(max1586_pmic_remove),
	.driver		= {
		.name	= "max1586",
		.owner	= THIS_MODULE,
	},
	.id_table	= max1586_id,
};

static int __init max1586_pmic_init(void)
{
	return i2c_add_driver(&max1586_pmic_driver);
}
subsys_initcall(max1586_pmic_init);

static void __exit max1586_pmic_exit(void)
{
	i2c_del_driver(&max1586_pmic_driver);
}
module_exit(max1586_pmic_exit);

/* Module information */
MODULE_DESCRIPTION("MAXIM 1586 voltage regulator driver");
MODULE_AUTHOR("Robert Jarzmik");
MODULE_LICENSE("GPL");
Commit	Line	Data
55f4fa4e RJ	1	/*
	2	* max1586.c -- Voltage and current regulation for the Maxim 1586
	3	*
	4	* Copyright (C) 2008 Robert Jarzmik
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
	19	*/
	20	#include <linux/module.h>
	21	#include <linux/err.h>
	22	#include <linux/i2c.h>
	23	#include <linux/platform_device.h>
	24	#include <linux/regulator/driver.h>
5a0e3ad6	25	#include <linux/slab.h>
55f4fa4e RJ	26	#include <linux/regulator/max1586.h>
	27
	28	#define MAX1586_V3_MAX_VSEL 31
	29	#define MAX1586_V6_MAX_VSEL 3
	30
	31	#define MAX1586_V3_MIN_UV 700000
	32	#define MAX1586_V3_MAX_UV 1475000
55f4fa4e RJ	33
	34	#define MAX1586_V6_MIN_UV 0
	35	#define MAX1586_V6_MAX_UV 3000000
	36
	37	#define I2C_V3_SELECT (0 << 5)
	38	#define I2C_V6_SELECT (1 << 5)
	39
b110a8fb PZ	40	struct max1586_data {
	41	struct i2c_client *client;
	42
	43	/* min/max V3 voltage */
c8f1e502 PZ	44	unsigned int min_uV;
c8f1e502 PZ	45	unsigned int max_uV;
b110a8fb PZ	46
	47	struct regulator_dev *rdev[0];
	48	};
	49
96d25221 AL	50	/*
	51	* V6 voltage
	52	* On I2C bus, sending a "x" byte to the max1586 means :
	53	* set V6 to either 0V, 1.8V, 2.5V, 3V depending on (x & 0x3)
	54	* As regulator framework doesn't accept voltages to be 0V, we use 1uV.
	55	*/
	56	static int v6_voltages_uv[] = { 1, 1800000, 2500000, 3000000 };
	57
55f4fa4e RJ	58	/*
	59	* V3 voltage
	60	* On I2C bus, sending a "x" byte to the max1586 means :
	61	* set V3 to 0.700V + (x & 0x1f) * 0.025V
b110a8fb PZ	62	* This voltage can be increased by external resistors
	63	* R24 and R25=100kOhm as described in the data sheet.
	64	* The gain is approximately: 1 + R24/R25 + R24/185.5kOhm
55f4fa4e	65	*/
b110a8fb PZ	66	static int max1586_v3_calc_voltage(struct max1586_data *max1586,
b110a8fb PZ	67	unsigned selector)
55f4fa4e	68	{
b110a8fb PZ	69	unsigned range_uV = max1586->max_uV - max1586->min_uV;
	70
	71	return max1586->min_uV + (selector * range_uV / MAX1586_V3_MAX_VSEL);
55f4fa4e RJ	72	}
55f4fa4e RJ	73
3a93f2a9 MB	74	static int max1586_v3_set(struct regulator_dev *rdev, int min_uV, int max_uV,
3a93f2a9 MB	75	unsigned *selector)
55f4fa4e	76	{
b110a8fb PZ	77	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
	78	struct i2c_client *client = max1586->client;
	79	unsigned range_uV = max1586->max_uV - max1586->min_uV;
55f4fa4e RJ	80	u8 v3_prog;
55f4fa4e RJ	81
b110a8fb	82	if (min_uV > max1586->max_uV \|\| max_uV < max1586->min_uV)
55f4fa4e	83	return -EINVAL;
b110a8fb PZ	84	if (min_uV < max1586->min_uV)
b110a8fb PZ	85	min_uV = max1586->min_uV;
55f4fa4e	86
7d530d32 AL	87	selector = DIV_ROUND_UP((min_uV - max1586->min_uV)
7d530d32 AL	88	MAX1586_V3_MAX_VSEL, range_uV);
3a93f2a9	89	if (max1586_v3_calc_voltage(max1586, *selector) > max_uV)
55f4fa4e RJ	90	return -EINVAL;
	91
	92	dev_dbg(&client->dev, "changing voltage v3 to %dmv\n",
3a93f2a9	93	max1586_v3_calc_voltage(max1586, *selector) / 1000);
55f4fa4e	94
3a93f2a9	95	v3_prog = I2C_V3_SELECT \| (u8) *selector;
55f4fa4e RJ	96	return i2c_smbus_write_byte(client, v3_prog);
	97	}
	98
	99	static int max1586_v3_list(struct regulator_dev *rdev, unsigned selector)
	100	{
b110a8fb PZ	101	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
b110a8fb PZ	102
55f4fa4e RJ	103	if (selector > MAX1586_V3_MAX_VSEL)
55f4fa4e RJ	104	return -EINVAL;
b110a8fb	105	return max1586_v3_calc_voltage(max1586, selector);
55f4fa4e RJ	106	}
55f4fa4e RJ	107
0d032731 AL	108	static int max1586_v6_set_voltage_sel(struct regulator_dev *rdev,
0d032731 AL	109	unsigned int selector)
55f4fa4e RJ	110	{
55f4fa4e RJ	111	struct i2c_client *client = rdev_get_drvdata(rdev);
55f4fa4e RJ	112	u8 v6_prog;
55f4fa4e RJ	113
55f4fa4e	114	dev_dbg(&client->dev, "changing voltage v6 to %dmv\n",
0d032731	115	rdev->desc->volt_table[selector] / 1000);
55f4fa4e	116
0d032731	117	v6_prog = I2C_V6_SELECT \| (u8) selector;
55f4fa4e RJ	118	return i2c_smbus_write_byte(client, v6_prog);
	119	}
	120
55f4fa4e RJ	121	/*
	122	* The Maxim 1586 controls V3 and V6 voltages, but offers no way of reading back
	123	* the set up value.
	124	*/
	125	static struct regulator_ops max1586_v3_ops = {
	126	.set_voltage = max1586_v3_set,
	127	.list_voltage = max1586_v3_list,
	128	};
	129
	130	static struct regulator_ops max1586_v6_ops = {
0d032731	131	.set_voltage_sel = max1586_v6_set_voltage_sel,
96d25221	132	.list_voltage = regulator_list_voltage_table,
55f4fa4e RJ	133	};
55f4fa4e RJ	134
0373bcff	135	static const struct regulator_desc max1586_reg[] = {
55f4fa4e RJ	136	{
	137	.name = "Output_V3",
	138	.id = MAX1586_V3,
	139	.ops = &max1586_v3_ops,
	140	.type = REGULATOR_VOLTAGE,
	141	.n_voltages = MAX1586_V3_MAX_VSEL + 1,
	142	.owner = THIS_MODULE,
	143	},
	144	{
	145	.name = "Output_V6",
	146	.id = MAX1586_V6,
	147	.ops = &max1586_v6_ops,
	148	.type = REGULATOR_VOLTAGE,
	149	.n_voltages = MAX1586_V6_MAX_VSEL + 1,
96d25221	150	.volt_table = v6_voltages_uv,
55f4fa4e RJ	151	.owner = THIS_MODULE,
	152	},
	153	};
	154
bd88c9b2 DT	155	static int __devinit max1586_pmic_probe(struct i2c_client *client,
bd88c9b2 DT	156	const struct i2c_device_id *i2c_id)
55f4fa4e RJ	157	{
	158	struct regulator_dev **rdev;
	159	struct max1586_platform_data *pdata = client->dev.platform_data;
c172708d	160	struct regulator_config config = { };
b110a8fb PZ	161	struct max1586_data *max1586;
	162	int i, id, ret = -ENOMEM;
	163
b7bd05b8	164	max1586 = devm_kzalloc(&client->dev, sizeof(struct max1586_data) +
b110a8fb PZ	165	sizeof(struct regulator_dev ) (MAX1586_V6 + 1),
	166	GFP_KERNEL);
	167	if (!max1586)
b7bd05b8	168	return -ENOMEM;
55f4fa4e	169
b110a8fb	170	max1586->client = client;
55f4fa4e	171
b7bd05b8 AL	172	if (!pdata->v3_gain)
	173	return -EINVAL;
	174
c8f1e502 PZ	175	max1586->min_uV = MAX1586_V3_MIN_UV / 1000 * pdata->v3_gain / 1000;
c8f1e502 PZ	176	max1586->max_uV = MAX1586_V3_MAX_UV / 1000 * pdata->v3_gain / 1000;
b110a8fb PZ	177
b110a8fb PZ	178	rdev = max1586->rdev;
55f4fa4e RJ	179	for (i = 0; i < pdata->num_subdevs && i <= MAX1586_V6; i++) {
	180	id = pdata->subdevs[i].id;
	181	if (!pdata->subdevs[i].platform_data)
	182	continue;
	183	if (id < MAX1586_V3 \|\| id > MAX1586_V6) {
	184	dev_err(&client->dev, "invalid regulator id %d\n", id);
	185	goto err;
	186	}
c172708d MB	187
	188	config.dev = &client->dev;
	189	config.init_data = pdata->subdevs[i].platform_data;
	190	config.driver_data = max1586;
	191
	192	rdev[i] = regulator_register(&max1586_reg[id], &config);
55f4fa4e RJ	193	if (IS_ERR(rdev[i])) {
	194	ret = PTR_ERR(rdev[i]);
	195	dev_err(&client->dev, "failed to register %s\n",
	196	max1586_reg[id].name);
	197	goto err;
	198	}
	199	}
	200
7c4c25e4	201	i2c_set_clientdata(client, max1586);
55f4fa4e RJ	202	dev_info(&client->dev, "Maxim 1586 regulator driver loaded\n");
	203	return 0;
	204
	205	err:
	206	while (--i >= 0)
	207	regulator_unregister(rdev[i]);
55f4fa4e RJ	208	return ret;
	209	}
	210
bd88c9b2	211	static int __devexit max1586_pmic_remove(struct i2c_client *client)
55f4fa4e	212	{
7c4c25e4	213	struct max1586_data *max1586 = i2c_get_clientdata(client);
55f4fa4e RJ	214	int i;
	215
	216	for (i = 0; i <= MAX1586_V6; i++)
7c4c25e4 AL	217	if (max1586->rdev[i])
7c4c25e4 AL	218	regulator_unregister(max1586->rdev[i]);
55f4fa4e RJ	219	return 0;
	220	}
	221
	222	static const struct i2c_device_id max1586_id[] = {
	223	{ "max1586", 0 },
	224	{ }
	225	};
	226	MODULE_DEVICE_TABLE(i2c, max1586_id);
	227
	228	static struct i2c_driver max1586_pmic_driver = {
	229	.probe = max1586_pmic_probe,
bd88c9b2	230	.remove = __devexit_p(max1586_pmic_remove),
55f4fa4e RJ	231	.driver = {
55f4fa4e RJ	232	.name = "max1586",
bd88c9b2	233	.owner = THIS_MODULE,
55f4fa4e RJ	234	},
	235	.id_table = max1586_id,
	236	};
	237
	238	static int __init max1586_pmic_init(void)
	239	{
	240	return i2c_add_driver(&max1586_pmic_driver);
	241	}
	242	subsys_initcall(max1586_pmic_init);
	243
	244	static void __exit max1586_pmic_exit(void)
	245	{
	246	i2c_del_driver(&max1586_pmic_driver);
	247	}
	248	module_exit(max1586_pmic_exit);
	249
	250	/* Module information */
	251	MODULE_DESCRIPTION("MAXIM 1586 voltage regulator driver");
	252	MODULE_AUTHOR("Robert Jarzmik");
	253	MODULE_LICENSE("GPL");