[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;

	unsigned int v3_curr_sel;
	unsigned int v6_curr_sel;
};

/*
 * 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 const unsigned 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_get_voltage_sel(struct regulator_dev *rdev)
{
	struct max1586_data *max1586 = rdev_get_drvdata(rdev);

	return max1586->v3_curr_sel;
}

static int max1586_v3_set_voltage_sel(struct regulator_dev *rdev,
				      unsigned selector)
{
	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
	struct i2c_client *client = max1586->client;
	int ret;
	u8 v3_prog;

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

	v3_prog = I2C_V3_SELECT | (u8) selector;
	ret = i2c_smbus_write_byte(client, v3_prog);
	if (ret)
		return ret;

	max1586->v3_curr_sel = selector;

	return 0;
}

static int max1586_v6_get_voltage_sel(struct regulator_dev *rdev)
{
	struct max1586_data *max1586 = rdev_get_drvdata(rdev);

	return max1586->v6_curr_sel;
}

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

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

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

	max1586->v6_curr_sel = selector;

	return 0;
}

/*
 * 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 = {
	.get_voltage_sel = max1586_v3_get_voltage_sel,
	.set_voltage_sel = max1586_v3_set_voltage_sel,
	.list_voltage = regulator_list_voltage_linear,
	.map_voltage = regulator_map_voltage_linear,
};

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

static 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 max1586_pmic_probe(struct i2c_client *client,
					const struct i2c_device_id *i2c_id)
{
	struct max1586_platform_data *pdata = dev_get_platdata(&client->dev);
	struct regulator_config config = { };
	struct max1586_data *max1586;
	int i, id;

	max1586 = devm_kzalloc(&client->dev, sizeof(struct max1586_data),
			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;

	/* Set curr_sel to default voltage on power-up */
	max1586->v3_curr_sel = 24; /* 1.3V */
	max1586->v6_curr_sel = 0;

	for (i = 0; i < pdata->num_subdevs && i <= MAX1586_V6; i++) {
		struct regulator_dev *rdev;

		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);
			return -EINVAL;
		}

		if (id == MAX1586_V3) {
			max1586_reg[id].min_uV = max1586->min_uV;
			max1586_reg[id].uV_step =
					(max1586->max_uV - max1586->min_uV) /
					MAX1586_V3_MAX_VSEL;
		}

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

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

	i2c_set_clientdata(client, max1586);
	dev_info(&client->dev, "Maxim 1586 regulator driver loaded\n");
	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,
	.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	46
4efd9dfe AL	47	unsigned int v3_curr_sel;
4efd9dfe AL	48	unsigned int v6_curr_sel;
b110a8fb PZ	49	};
b110a8fb PZ	50
96d25221 AL	51	/*
	52	* V6 voltage
	53	* On I2C bus, sending a "x" byte to the max1586 means :
	54	* set V6 to either 0V, 1.8V, 2.5V, 3V depending on (x & 0x3)
	55	* As regulator framework doesn't accept voltages to be 0V, we use 1uV.
	56	*/
d67c42cc	57	static const unsigned int v6_voltages_uv[] = { 1, 1800000, 2500000, 3000000 };
96d25221	58
55f4fa4e RJ	59	/*
	60	* V3 voltage
	61	* On I2C bus, sending a "x" byte to the max1586 means :
	62	* set V3 to 0.700V + (x & 0x1f) * 0.025V
b110a8fb PZ	63	* This voltage can be increased by external resistors
	64	* R24 and R25=100kOhm as described in the data sheet.
	65	* The gain is approximately: 1 + R24/R25 + R24/185.5kOhm
55f4fa4e	66	*/
4efd9dfe AL	67	static int max1586_v3_get_voltage_sel(struct regulator_dev *rdev)
	68	{
	69	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
	70
	71	return max1586->v3_curr_sel;
	72	}
	73
9b558950 AL	74	static int max1586_v3_set_voltage_sel(struct regulator_dev *rdev,
9b558950 AL	75	unsigned selector)
55f4fa4e	76	{
b110a8fb PZ	77	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
b110a8fb PZ	78	struct i2c_client *client = max1586->client;
4efd9dfe	79	int ret;
55f4fa4e RJ	80	u8 v3_prog;
55f4fa4e RJ	81
55f4fa4e	82	dev_dbg(&client->dev, "changing voltage v3 to %dmv\n",
9b558950	83	regulator_list_voltage_linear(rdev, selector) / 1000);
55f4fa4e	84
9b558950	85	v3_prog = I2C_V3_SELECT \| (u8) selector;
4efd9dfe AL	86	ret = i2c_smbus_write_byte(client, v3_prog);
	87	if (ret)
	88	return ret;
	89
	90	max1586->v3_curr_sel = selector;
	91
	92	return 0;
	93	}
	94
	95	static int max1586_v6_get_voltage_sel(struct regulator_dev *rdev)
	96	{
	97	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
	98
	99	return max1586->v6_curr_sel;
55f4fa4e RJ	100	}
55f4fa4e RJ	101
0d032731 AL	102	static int max1586_v6_set_voltage_sel(struct regulator_dev *rdev,
0d032731 AL	103	unsigned int selector)
55f4fa4e	104	{
4efd9dfe AL	105	struct max1586_data *max1586 = rdev_get_drvdata(rdev);
4efd9dfe AL	106	struct i2c_client *client = max1586->client;
55f4fa4e	107	u8 v6_prog;
4efd9dfe	108	int ret;
55f4fa4e	109
55f4fa4e	110	dev_dbg(&client->dev, "changing voltage v6 to %dmv\n",
0d032731	111	rdev->desc->volt_table[selector] / 1000);
55f4fa4e	112
0d032731	113	v6_prog = I2C_V6_SELECT \| (u8) selector;
4efd9dfe AL	114	ret = i2c_smbus_write_byte(client, v6_prog);
	115	if (ret)
	116	return ret;
	117
	118	max1586->v6_curr_sel = selector;
	119
	120	return 0;
55f4fa4e RJ	121	}
55f4fa4e RJ	122
55f4fa4e RJ	123	/*
	124	* The Maxim 1586 controls V3 and V6 voltages, but offers no way of reading back
	125	* the set up value.
	126	*/
	127	static struct regulator_ops max1586_v3_ops = {
4efd9dfe	128	.get_voltage_sel = max1586_v3_get_voltage_sel,
9b558950	129	.set_voltage_sel = max1586_v3_set_voltage_sel,
93f5de5c	130	.list_voltage = regulator_list_voltage_linear,
9b558950	131	.map_voltage = regulator_map_voltage_linear,
55f4fa4e RJ	132	};
	133
	134	static struct regulator_ops max1586_v6_ops = {
4efd9dfe	135	.get_voltage_sel = max1586_v6_get_voltage_sel,
0d032731	136	.set_voltage_sel = max1586_v6_set_voltage_sel,
96d25221	137	.list_voltage = regulator_list_voltage_table,
55f4fa4e RJ	138	};
55f4fa4e RJ	139
93f5de5c	140	static struct regulator_desc max1586_reg[] = {
55f4fa4e RJ	141	{
	142	.name = "Output_V3",
	143	.id = MAX1586_V3,
	144	.ops = &max1586_v3_ops,
	145	.type = REGULATOR_VOLTAGE,
	146	.n_voltages = MAX1586_V3_MAX_VSEL + 1,
	147	.owner = THIS_MODULE,
	148	},
	149	{
	150	.name = "Output_V6",
	151	.id = MAX1586_V6,
	152	.ops = &max1586_v6_ops,
	153	.type = REGULATOR_VOLTAGE,
	154	.n_voltages = MAX1586_V6_MAX_VSEL + 1,
96d25221	155	.volt_table = v6_voltages_uv,
55f4fa4e RJ	156	.owner = THIS_MODULE,
	157	},
	158	};
	159
a5023574	160	static int max1586_pmic_probe(struct i2c_client *client,
bd88c9b2	161	const struct i2c_device_id *i2c_id)
55f4fa4e	162	{
dff91d0b	163	struct max1586_platform_data *pdata = dev_get_platdata(&client->dev);
c172708d	164	struct regulator_config config = { };
b110a8fb	165	struct max1586_data *max1586;
249cc1f2	166	int i, id;
b110a8fb	167
2d45e78a	168	max1586 = devm_kzalloc(&client->dev, sizeof(struct max1586_data),
b110a8fb PZ	169	GFP_KERNEL);
b110a8fb PZ	170	if (!max1586)
b7bd05b8	171	return -ENOMEM;
55f4fa4e	172
b110a8fb	173	max1586->client = client;
55f4fa4e	174
b7bd05b8 AL	175	if (!pdata->v3_gain)
	176	return -EINVAL;
	177
c8f1e502 PZ	178	max1586->min_uV = MAX1586_V3_MIN_UV / 1000 * pdata->v3_gain / 1000;
c8f1e502 PZ	179	max1586->max_uV = MAX1586_V3_MAX_UV / 1000 * pdata->v3_gain / 1000;
b110a8fb	180
4efd9dfe AL	181	/* Set curr_sel to default voltage on power-up */
	182	max1586->v3_curr_sel = 24; /* 1.3V */
	183	max1586->v6_curr_sel = 0;
	184
55f4fa4e	185	for (i = 0; i < pdata->num_subdevs && i <= MAX1586_V6; i++) {
aaa46b4b KK	186	struct regulator_dev *rdev;
aaa46b4b KK	187
55f4fa4e RJ	188	id = pdata->subdevs[i].id;
	189	if (!pdata->subdevs[i].platform_data)
	190	continue;
	191	if (id < MAX1586_V3 \|\| id > MAX1586_V6) {
	192	dev_err(&client->dev, "invalid regulator id %d\n", id);
249cc1f2	193	return -EINVAL;
55f4fa4e	194	}
c172708d	195
93f5de5c AL	196	if (id == MAX1586_V3) {
	197	max1586_reg[id].min_uV = max1586->min_uV;
	198	max1586_reg[id].uV_step =
	199	(max1586->max_uV - max1586->min_uV) /
	200	MAX1586_V3_MAX_VSEL;
	201	}
	202
c172708d MB	203	config.dev = &client->dev;
	204	config.init_data = pdata->subdevs[i].platform_data;
	205	config.driver_data = max1586;
	206
aaa46b4b	207	rdev = devm_regulator_register(&client->dev,
249cc1f2	208	&max1586_reg[id], &config);
aaa46b4b	209	if (IS_ERR(rdev)) {
55f4fa4e RJ	210	dev_err(&client->dev, "failed to register %s\n",
55f4fa4e RJ	211	max1586_reg[id].name);
aaa46b4b	212	return PTR_ERR(rdev);
55f4fa4e RJ	213	}
	214	}
	215
7c4c25e4	216	i2c_set_clientdata(client, max1586);
55f4fa4e RJ	217	dev_info(&client->dev, "Maxim 1586 regulator driver loaded\n");
55f4fa4e RJ	218	return 0;
55f4fa4e RJ	219	}
	220
	221	static const struct i2c_device_id max1586_id[] = {
	222	{ "max1586", 0 },
	223	{ }
	224	};
	225	MODULE_DEVICE_TABLE(i2c, max1586_id);
	226
	227	static struct i2c_driver max1586_pmic_driver = {
	228	.probe = max1586_pmic_probe,
55f4fa4e RJ	229	.driver = {
55f4fa4e RJ	230	.name = "max1586",
bd88c9b2	231	.owner = THIS_MODULE,
55f4fa4e RJ	232	},
	233	.id_table = max1586_id,
	234	};
	235
	236	static int __init max1586_pmic_init(void)
	237	{
	238	return i2c_add_driver(&max1586_pmic_driver);
	239	}
	240	subsys_initcall(max1586_pmic_init);
	241
	242	static void __exit max1586_pmic_exit(void)
	243	{
	244	i2c_del_driver(&max1586_pmic_driver);
	245	}
	246	module_exit(max1586_pmic_exit);
	247
	248	/* Module information */
	249	MODULE_DESCRIPTION("MAXIM 1586 voltage regulator driver");
	250	MODULE_AUTHOR("Robert Jarzmik");
	251	MODULE_LICENSE("GPL");