blob: f215195de9175b0d543fac0e8c854aaa175d644e [file] [log] [blame]
Robert Jarzmik55f4fa42009-04-23 20:10:43 +02001/*
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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020026#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
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020033
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
Philipp Zabelb110a8f2009-05-28 07:15:16 +020040struct max1586_data {
41 struct i2c_client *client;
42
43 /* min/max V3 voltage */
Philipp Zabelc8f1e502009-05-28 21:00:03 +020044 unsigned int min_uV;
45 unsigned int max_uV;
Philipp Zabelb110a8f2009-05-28 07:15:16 +020046
47 struct regulator_dev *rdev[0];
48};
49
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020050/*
Axel Lin96d25222012-06-04 12:56:58 +080051 * 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 */
56static int v6_voltages_uv[] = { 1, 1800000, 2500000, 3000000 };
57
58/*
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020059 * V3 voltage
60 * On I2C bus, sending a "x" byte to the max1586 means :
61 * set V3 to 0.700V + (x & 0x1f) * 0.025V
Philipp Zabelb110a8f2009-05-28 07:15:16 +020062 * 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
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020065 */
Philipp Zabelb110a8f2009-05-28 07:15:16 +020066static int max1586_v3_calc_voltage(struct max1586_data *max1586,
67 unsigned selector)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020068{
Philipp Zabelb110a8f2009-05-28 07:15:16 +020069 unsigned range_uV = max1586->max_uV - max1586->min_uV;
70
71 return max1586->min_uV + (selector * range_uV / MAX1586_V3_MAX_VSEL);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020072}
73
Mark Brown3a93f2a2010-11-10 14:38:29 +000074static int max1586_v3_set(struct regulator_dev *rdev, int min_uV, int max_uV,
75 unsigned *selector)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020076{
Philipp Zabelb110a8f2009-05-28 07:15:16 +020077 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;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020080 u8 v3_prog;
81
Philipp Zabelb110a8f2009-05-28 07:15:16 +020082 if (min_uV > max1586->max_uV || max_uV < max1586->min_uV)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020083 return -EINVAL;
Philipp Zabelb110a8f2009-05-28 07:15:16 +020084 if (min_uV < max1586->min_uV)
85 min_uV = max1586->min_uV;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020086
Axel Lin7d530d32012-03-02 16:22:01 +080087 *selector = DIV_ROUND_UP((min_uV - max1586->min_uV) *
88 MAX1586_V3_MAX_VSEL, range_uV);
Mark Brown3a93f2a2010-11-10 14:38:29 +000089 if (max1586_v3_calc_voltage(max1586, *selector) > max_uV)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020090 return -EINVAL;
91
92 dev_dbg(&client->dev, "changing voltage v3 to %dmv\n",
Mark Brown3a93f2a2010-11-10 14:38:29 +000093 max1586_v3_calc_voltage(max1586, *selector) / 1000);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020094
Mark Brown3a93f2a2010-11-10 14:38:29 +000095 v3_prog = I2C_V3_SELECT | (u8) *selector;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +020096 return i2c_smbus_write_byte(client, v3_prog);
97}
98
99static int max1586_v3_list(struct regulator_dev *rdev, unsigned selector)
100{
Philipp Zabelb110a8f2009-05-28 07:15:16 +0200101 struct max1586_data *max1586 = rdev_get_drvdata(rdev);
102
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200103 if (selector > MAX1586_V3_MAX_VSEL)
104 return -EINVAL;
Philipp Zabelb110a8f2009-05-28 07:15:16 +0200105 return max1586_v3_calc_voltage(max1586, selector);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200106}
107
Mark Brown3a93f2a2010-11-10 14:38:29 +0000108static int max1586_v6_set(struct regulator_dev *rdev, int min_uV, int max_uV,
109 unsigned int *selector)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200110{
111 struct i2c_client *client = rdev_get_drvdata(rdev);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200112 u8 v6_prog;
113
114 if (min_uV < MAX1586_V6_MIN_UV || min_uV > MAX1586_V6_MAX_UV)
115 return -EINVAL;
116 if (max_uV < MAX1586_V6_MIN_UV || max_uV > MAX1586_V6_MAX_UV)
117 return -EINVAL;
118
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200119 if (min_uV < 1800000)
Mark Brown3a93f2a2010-11-10 14:38:29 +0000120 *selector = 0;
Axel Lin3e352f92010-08-18 11:37:21 +0800121 else if (min_uV < 2500000)
Mark Brown3a93f2a2010-11-10 14:38:29 +0000122 *selector = 1;
Axel Lin3e352f92010-08-18 11:37:21 +0800123 else if (min_uV < 3000000)
Mark Brown3a93f2a2010-11-10 14:38:29 +0000124 *selector = 2;
Axel Lin3e352f92010-08-18 11:37:21 +0800125 else if (min_uV >= 3000000)
Mark Brown3a93f2a2010-11-10 14:38:29 +0000126 *selector = 3;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200127
Axel Lin96d25222012-06-04 12:56:58 +0800128 if (rdev->desc->volt_table[*selector] > max_uV)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200129 return -EINVAL;
130
131 dev_dbg(&client->dev, "changing voltage v6 to %dmv\n",
Axel Lin96d25222012-06-04 12:56:58 +0800132 rdev->desc->volt_table[*selector] / 1000);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200133
Mark Brown3a93f2a2010-11-10 14:38:29 +0000134 v6_prog = I2C_V6_SELECT | (u8) *selector;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200135 return i2c_smbus_write_byte(client, v6_prog);
136}
137
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200138/*
139 * The Maxim 1586 controls V3 and V6 voltages, but offers no way of reading back
140 * the set up value.
141 */
142static struct regulator_ops max1586_v3_ops = {
143 .set_voltage = max1586_v3_set,
144 .list_voltage = max1586_v3_list,
145};
146
147static struct regulator_ops max1586_v6_ops = {
148 .set_voltage = max1586_v6_set,
Axel Lin96d25222012-06-04 12:56:58 +0800149 .list_voltage = regulator_list_voltage_table,
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200150};
151
Axel Lin0373bcf2012-04-06 08:24:27 +0800152static const struct regulator_desc max1586_reg[] = {
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200153 {
154 .name = "Output_V3",
155 .id = MAX1586_V3,
156 .ops = &max1586_v3_ops,
157 .type = REGULATOR_VOLTAGE,
158 .n_voltages = MAX1586_V3_MAX_VSEL + 1,
159 .owner = THIS_MODULE,
160 },
161 {
162 .name = "Output_V6",
163 .id = MAX1586_V6,
164 .ops = &max1586_v6_ops,
165 .type = REGULATOR_VOLTAGE,
166 .n_voltages = MAX1586_V6_MAX_VSEL + 1,
Axel Lin96d25222012-06-04 12:56:58 +0800167 .volt_table = v6_voltages_uv,
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200168 .owner = THIS_MODULE,
169 },
170};
171
Dmitry Torokhovbd88c9b2010-02-23 23:38:23 -0800172static int __devinit max1586_pmic_probe(struct i2c_client *client,
173 const struct i2c_device_id *i2c_id)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200174{
175 struct regulator_dev **rdev;
176 struct max1586_platform_data *pdata = client->dev.platform_data;
Mark Brownc1727082012-04-04 00:50:22 +0100177 struct regulator_config config = { };
Philipp Zabelb110a8f2009-05-28 07:15:16 +0200178 struct max1586_data *max1586;
179 int i, id, ret = -ENOMEM;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200180
Axel Linb7bd05b2012-04-11 23:06:47 +0800181 max1586 = devm_kzalloc(&client->dev, sizeof(struct max1586_data) +
Philipp Zabelb110a8f2009-05-28 07:15:16 +0200182 sizeof(struct regulator_dev *) * (MAX1586_V6 + 1),
183 GFP_KERNEL);
184 if (!max1586)
Axel Linb7bd05b2012-04-11 23:06:47 +0800185 return -ENOMEM;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200186
Philipp Zabelb110a8f2009-05-28 07:15:16 +0200187 max1586->client = client;
188
Axel Linb7bd05b2012-04-11 23:06:47 +0800189 if (!pdata->v3_gain)
190 return -EINVAL;
191
Philipp Zabelc8f1e502009-05-28 21:00:03 +0200192 max1586->min_uV = MAX1586_V3_MIN_UV / 1000 * pdata->v3_gain / 1000;
193 max1586->max_uV = MAX1586_V3_MAX_UV / 1000 * pdata->v3_gain / 1000;
Philipp Zabelb110a8f2009-05-28 07:15:16 +0200194
195 rdev = max1586->rdev;
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200196 for (i = 0; i < pdata->num_subdevs && i <= MAX1586_V6; i++) {
197 id = pdata->subdevs[i].id;
198 if (!pdata->subdevs[i].platform_data)
199 continue;
200 if (id < MAX1586_V3 || id > MAX1586_V6) {
201 dev_err(&client->dev, "invalid regulator id %d\n", id);
202 goto err;
203 }
Mark Brownc1727082012-04-04 00:50:22 +0100204
205 config.dev = &client->dev;
206 config.init_data = pdata->subdevs[i].platform_data;
207 config.driver_data = max1586;
208
209 rdev[i] = regulator_register(&max1586_reg[id], &config);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200210 if (IS_ERR(rdev[i])) {
211 ret = PTR_ERR(rdev[i]);
212 dev_err(&client->dev, "failed to register %s\n",
213 max1586_reg[id].name);
214 goto err;
215 }
216 }
217
Axel Lin7c4c25e2010-08-06 13:33:15 +0800218 i2c_set_clientdata(client, max1586);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200219 dev_info(&client->dev, "Maxim 1586 regulator driver loaded\n");
220 return 0;
221
222err:
223 while (--i >= 0)
224 regulator_unregister(rdev[i]);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200225 return ret;
226}
227
Dmitry Torokhovbd88c9b2010-02-23 23:38:23 -0800228static int __devexit max1586_pmic_remove(struct i2c_client *client)
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200229{
Axel Lin7c4c25e2010-08-06 13:33:15 +0800230 struct max1586_data *max1586 = i2c_get_clientdata(client);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200231 int i;
232
233 for (i = 0; i <= MAX1586_V6; i++)
Axel Lin7c4c25e2010-08-06 13:33:15 +0800234 if (max1586->rdev[i])
235 regulator_unregister(max1586->rdev[i]);
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200236 return 0;
237}
238
239static const struct i2c_device_id max1586_id[] = {
240 { "max1586", 0 },
241 { }
242};
243MODULE_DEVICE_TABLE(i2c, max1586_id);
244
245static struct i2c_driver max1586_pmic_driver = {
246 .probe = max1586_pmic_probe,
Dmitry Torokhovbd88c9b2010-02-23 23:38:23 -0800247 .remove = __devexit_p(max1586_pmic_remove),
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200248 .driver = {
249 .name = "max1586",
Dmitry Torokhovbd88c9b2010-02-23 23:38:23 -0800250 .owner = THIS_MODULE,
Robert Jarzmik55f4fa42009-04-23 20:10:43 +0200251 },
252 .id_table = max1586_id,
253};
254
255static int __init max1586_pmic_init(void)
256{
257 return i2c_add_driver(&max1586_pmic_driver);
258}
259subsys_initcall(max1586_pmic_init);
260
261static void __exit max1586_pmic_exit(void)
262{
263 i2c_del_driver(&max1586_pmic_driver);
264}
265module_exit(max1586_pmic_exit);
266
267/* Module information */
268MODULE_DESCRIPTION("MAXIM 1586 voltage regulator driver");
269MODULE_AUTHOR("Robert Jarzmik");
270MODULE_LICENSE("GPL");