Commit | Line | Data |
---|---|---|
27f37e4b WS |
1 | /* |
2 | * max8660.c -- Voltage regulation for the Maxim 8660/8661 | |
3 | * | |
4 | * based on max1586.c and wm8400-regulator.c | |
5 | * | |
6 | * Copyright (C) 2009 Wolfram Sang, Pengutronix e.K. | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify it | |
9 | * under the terms of the GNU General Public License as published by the Free | |
10 | * Software Foundation; version 2 of the License. | |
11 | * | |
12 | * This program is distributed in the hope that it will be useful, but WITHOUT | |
13 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
14 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for | |
15 | * more details. | |
16 | * | |
17 | * You should have received a copy of the GNU General Public License along with | |
18 | * this program; if not, write to the Free Software Foundation, Inc., 59 Temple | |
19 | * Place, Suite 330, Boston, MA 02111-1307 USA | |
20 | * | |
21 | * Some info: | |
22 | * | |
23 | * Datasheet: http://datasheets.maxim-ic.com/en/ds/MAX8660-MAX8661.pdf | |
24 | * | |
25 | * This chip is a bit nasty because it is a write-only device. Thus, the driver | |
26 | * uses shadow registers to keep track of its values. The main problem appears | |
27 | * to be the initialization: When Linux boots up, we cannot know if the chip is | |
28 | * in the default state or not, so we would have to pass such information in | |
29 | * platform_data. As this adds a bit of complexity to the driver, this is left | |
30 | * out for now until it is really needed. | |
31 | * | |
32 | * [A|S|M]DTV1 registers are currently not used, but [A|S|M]DTV2. | |
33 | * | |
34 | * If the driver is feature complete, it might be worth to check if one set of | |
35 | * functions for V3-V7 is sufficient. For maximum flexibility during | |
36 | * development, they are separated for now. | |
37 | * | |
38 | */ | |
39 | ||
40 | #include <linux/module.h> | |
41 | #include <linux/err.h> | |
42 | #include <linux/i2c.h> | |
43 | #include <linux/platform_device.h> | |
44 | #include <linux/regulator/driver.h> | |
5a0e3ad6 | 45 | #include <linux/slab.h> |
27f37e4b WS |
46 | #include <linux/regulator/max8660.h> |
47 | ||
48 | #define MAX8660_DCDC_MIN_UV 725000 | |
49 | #define MAX8660_DCDC_MAX_UV 1800000 | |
50 | #define MAX8660_DCDC_STEP 25000 | |
51 | #define MAX8660_DCDC_MAX_SEL 0x2b | |
52 | ||
53 | #define MAX8660_LDO5_MIN_UV 1700000 | |
54 | #define MAX8660_LDO5_MAX_UV 2000000 | |
55 | #define MAX8660_LDO5_STEP 25000 | |
56 | #define MAX8660_LDO5_MAX_SEL 0x0c | |
57 | ||
58 | #define MAX8660_LDO67_MIN_UV 1800000 | |
59 | #define MAX8660_LDO67_MAX_UV 3300000 | |
60 | #define MAX8660_LDO67_STEP 100000 | |
61 | #define MAX8660_LDO67_MAX_SEL 0x0f | |
62 | ||
63 | enum { | |
64 | MAX8660_OVER1, | |
65 | MAX8660_OVER2, | |
66 | MAX8660_VCC1, | |
67 | MAX8660_ADTV1, | |
68 | MAX8660_ADTV2, | |
69 | MAX8660_SDTV1, | |
70 | MAX8660_SDTV2, | |
71 | MAX8660_MDTV1, | |
72 | MAX8660_MDTV2, | |
73 | MAX8660_L12VCR, | |
74 | MAX8660_FPWM, | |
75 | MAX8660_N_REGS, /* not a real register */ | |
76 | }; | |
77 | ||
78 | struct max8660 { | |
79 | struct i2c_client *client; | |
80 | u8 shadow_regs[MAX8660_N_REGS]; /* as chip is write only */ | |
81 | struct regulator_dev *rdev[]; | |
82 | }; | |
83 | ||
84 | static int max8660_write(struct max8660 *max8660, u8 reg, u8 mask, u8 val) | |
85 | { | |
86 | static const u8 max8660_addresses[MAX8660_N_REGS] = | |
87 | { 0x10, 0x12, 0x20, 0x23, 0x24, 0x29, 0x2a, 0x32, 0x33, 0x39, 0x80 }; | |
88 | ||
89 | int ret; | |
90 | u8 reg_val = (max8660->shadow_regs[reg] & mask) | val; | |
91 | dev_vdbg(&max8660->client->dev, "Writing reg %02x with %02x\n", | |
92 | max8660_addresses[reg], reg_val); | |
93 | ||
94 | ret = i2c_smbus_write_byte_data(max8660->client, | |
95 | max8660_addresses[reg], reg_val); | |
96 | if (ret == 0) | |
97 | max8660->shadow_regs[reg] = reg_val; | |
98 | ||
99 | return ret; | |
100 | } | |
101 | ||
102 | ||
103 | /* | |
104 | * DCDC functions | |
105 | */ | |
106 | ||
107 | static int max8660_dcdc_is_enabled(struct regulator_dev *rdev) | |
108 | { | |
109 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
110 | u8 val = max8660->shadow_regs[MAX8660_OVER1]; | |
111 | u8 mask = (rdev_get_id(rdev) == MAX8660_V3) ? 1 : 4; | |
112 | return !!(val & mask); | |
113 | } | |
114 | ||
115 | static int max8660_dcdc_enable(struct regulator_dev *rdev) | |
116 | { | |
117 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
118 | u8 bit = (rdev_get_id(rdev) == MAX8660_V3) ? 1 : 4; | |
119 | return max8660_write(max8660, MAX8660_OVER1, 0xff, bit); | |
120 | } | |
121 | ||
122 | static int max8660_dcdc_disable(struct regulator_dev *rdev) | |
123 | { | |
124 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
125 | u8 mask = (rdev_get_id(rdev) == MAX8660_V3) ? ~1 : ~4; | |
126 | return max8660_write(max8660, MAX8660_OVER1, mask, 0); | |
127 | } | |
128 | ||
9392c4f0 | 129 | static int max8660_dcdc_get_voltage_sel(struct regulator_dev *rdev) |
27f37e4b WS |
130 | { |
131 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
9392c4f0 | 132 | |
27f37e4b WS |
133 | u8 reg = (rdev_get_id(rdev) == MAX8660_V3) ? MAX8660_ADTV2 : MAX8660_SDTV2; |
134 | u8 selector = max8660->shadow_regs[reg]; | |
9392c4f0 | 135 | return selector; |
27f37e4b WS |
136 | } |
137 | ||
5eb3394f AL |
138 | static int max8660_dcdc_set_voltage_sel(struct regulator_dev *rdev, |
139 | unsigned int selector) | |
27f37e4b WS |
140 | { |
141 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
5eb3394f | 142 | u8 reg, bits; |
27f37e4b WS |
143 | int ret; |
144 | ||
27f37e4b WS |
145 | reg = (rdev_get_id(rdev) == MAX8660_V3) ? MAX8660_ADTV2 : MAX8660_SDTV2; |
146 | ret = max8660_write(max8660, reg, 0, selector); | |
147 | if (ret) | |
148 | return ret; | |
149 | ||
150 | /* Select target voltage register and activate regulation */ | |
151 | bits = (rdev_get_id(rdev) == MAX8660_V3) ? 0x03 : 0x30; | |
152 | return max8660_write(max8660, MAX8660_VCC1, 0xff, bits); | |
153 | } | |
154 | ||
155 | static struct regulator_ops max8660_dcdc_ops = { | |
156 | .is_enabled = max8660_dcdc_is_enabled, | |
134d34a8 | 157 | .list_voltage = regulator_list_voltage_linear, |
5eb3394f AL |
158 | .map_voltage = regulator_map_voltage_linear, |
159 | .set_voltage_sel = max8660_dcdc_set_voltage_sel, | |
9392c4f0 | 160 | .get_voltage_sel = max8660_dcdc_get_voltage_sel, |
27f37e4b WS |
161 | }; |
162 | ||
163 | ||
164 | /* | |
165 | * LDO5 functions | |
166 | */ | |
167 | ||
9392c4f0 | 168 | static int max8660_ldo5_get_voltage_sel(struct regulator_dev *rdev) |
27f37e4b WS |
169 | { |
170 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
27f37e4b | 171 | |
9392c4f0 AL |
172 | u8 selector = max8660->shadow_regs[MAX8660_MDTV2]; |
173 | return selector; | |
27f37e4b WS |
174 | } |
175 | ||
5eb3394f AL |
176 | static int max8660_ldo5_set_voltage_sel(struct regulator_dev *rdev, |
177 | unsigned int selector) | |
27f37e4b WS |
178 | { |
179 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
27f37e4b WS |
180 | int ret; |
181 | ||
27f37e4b WS |
182 | ret = max8660_write(max8660, MAX8660_MDTV2, 0, selector); |
183 | if (ret) | |
184 | return ret; | |
185 | ||
186 | /* Select target voltage register and activate regulation */ | |
187 | return max8660_write(max8660, MAX8660_VCC1, 0xff, 0xc0); | |
188 | } | |
189 | ||
190 | static struct regulator_ops max8660_ldo5_ops = { | |
134d34a8 | 191 | .list_voltage = regulator_list_voltage_linear, |
5eb3394f AL |
192 | .map_voltage = regulator_map_voltage_linear, |
193 | .set_voltage_sel = max8660_ldo5_set_voltage_sel, | |
9392c4f0 | 194 | .get_voltage_sel = max8660_ldo5_get_voltage_sel, |
27f37e4b WS |
195 | }; |
196 | ||
197 | ||
198 | /* | |
199 | * LDO67 functions | |
200 | */ | |
201 | ||
202 | static int max8660_ldo67_is_enabled(struct regulator_dev *rdev) | |
203 | { | |
204 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
205 | u8 val = max8660->shadow_regs[MAX8660_OVER2]; | |
206 | u8 mask = (rdev_get_id(rdev) == MAX8660_V6) ? 2 : 4; | |
207 | return !!(val & mask); | |
208 | } | |
209 | ||
210 | static int max8660_ldo67_enable(struct regulator_dev *rdev) | |
211 | { | |
212 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
213 | u8 bit = (rdev_get_id(rdev) == MAX8660_V6) ? 2 : 4; | |
214 | return max8660_write(max8660, MAX8660_OVER2, 0xff, bit); | |
215 | } | |
216 | ||
217 | static int max8660_ldo67_disable(struct regulator_dev *rdev) | |
218 | { | |
219 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
220 | u8 mask = (rdev_get_id(rdev) == MAX8660_V6) ? ~2 : ~4; | |
221 | return max8660_write(max8660, MAX8660_OVER2, mask, 0); | |
222 | } | |
223 | ||
9392c4f0 | 224 | static int max8660_ldo67_get_voltage_sel(struct regulator_dev *rdev) |
27f37e4b WS |
225 | { |
226 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
9392c4f0 | 227 | |
27f37e4b WS |
228 | u8 shift = (rdev_get_id(rdev) == MAX8660_V6) ? 0 : 4; |
229 | u8 selector = (max8660->shadow_regs[MAX8660_L12VCR] >> shift) & 0xf; | |
9392c4f0 | 230 | return selector; |
27f37e4b WS |
231 | } |
232 | ||
5eb3394f AL |
233 | static int max8660_ldo67_set_voltage_sel(struct regulator_dev *rdev, |
234 | unsigned int selector) | |
27f37e4b WS |
235 | { |
236 | struct max8660 *max8660 = rdev_get_drvdata(rdev); | |
3a93f2a9 | 237 | |
27f37e4b WS |
238 | if (rdev_get_id(rdev) == MAX8660_V6) |
239 | return max8660_write(max8660, MAX8660_L12VCR, 0xf0, selector); | |
240 | else | |
5eb3394f AL |
241 | return max8660_write(max8660, MAX8660_L12VCR, 0x0f, |
242 | selector << 4); | |
27f37e4b WS |
243 | } |
244 | ||
245 | static struct regulator_ops max8660_ldo67_ops = { | |
246 | .is_enabled = max8660_ldo67_is_enabled, | |
247 | .enable = max8660_ldo67_enable, | |
248 | .disable = max8660_ldo67_disable, | |
134d34a8 | 249 | .list_voltage = regulator_list_voltage_linear, |
5eb3394f | 250 | .map_voltage = regulator_map_voltage_linear, |
9392c4f0 | 251 | .get_voltage_sel = max8660_ldo67_get_voltage_sel, |
5eb3394f | 252 | .set_voltage_sel = max8660_ldo67_set_voltage_sel, |
27f37e4b WS |
253 | }; |
254 | ||
621adb30 | 255 | static const struct regulator_desc max8660_reg[] = { |
27f37e4b WS |
256 | { |
257 | .name = "V3(DCDC)", | |
258 | .id = MAX8660_V3, | |
259 | .ops = &max8660_dcdc_ops, | |
260 | .type = REGULATOR_VOLTAGE, | |
261 | .n_voltages = MAX8660_DCDC_MAX_SEL + 1, | |
262 | .owner = THIS_MODULE, | |
134d34a8 AL |
263 | .min_uV = MAX8660_DCDC_MIN_UV, |
264 | .uV_step = MAX8660_DCDC_STEP, | |
27f37e4b WS |
265 | }, |
266 | { | |
267 | .name = "V4(DCDC)", | |
268 | .id = MAX8660_V4, | |
269 | .ops = &max8660_dcdc_ops, | |
270 | .type = REGULATOR_VOLTAGE, | |
271 | .n_voltages = MAX8660_DCDC_MAX_SEL + 1, | |
272 | .owner = THIS_MODULE, | |
134d34a8 AL |
273 | .min_uV = MAX8660_DCDC_MIN_UV, |
274 | .uV_step = MAX8660_DCDC_STEP, | |
27f37e4b WS |
275 | }, |
276 | { | |
277 | .name = "V5(LDO)", | |
278 | .id = MAX8660_V5, | |
279 | .ops = &max8660_ldo5_ops, | |
280 | .type = REGULATOR_VOLTAGE, | |
281 | .n_voltages = MAX8660_LDO5_MAX_SEL + 1, | |
282 | .owner = THIS_MODULE, | |
134d34a8 AL |
283 | .min_uV = MAX8660_LDO5_MIN_UV, |
284 | .uV_step = MAX8660_LDO5_STEP, | |
27f37e4b WS |
285 | }, |
286 | { | |
287 | .name = "V6(LDO)", | |
288 | .id = MAX8660_V6, | |
289 | .ops = &max8660_ldo67_ops, | |
290 | .type = REGULATOR_VOLTAGE, | |
291 | .n_voltages = MAX8660_LDO67_MAX_SEL + 1, | |
292 | .owner = THIS_MODULE, | |
134d34a8 AL |
293 | .min_uV = MAX8660_LDO67_MIN_UV, |
294 | .uV_step = MAX8660_LDO67_STEP, | |
27f37e4b WS |
295 | }, |
296 | { | |
297 | .name = "V7(LDO)", | |
298 | .id = MAX8660_V7, | |
299 | .ops = &max8660_ldo67_ops, | |
300 | .type = REGULATOR_VOLTAGE, | |
301 | .n_voltages = MAX8660_LDO67_MAX_SEL + 1, | |
302 | .owner = THIS_MODULE, | |
134d34a8 AL |
303 | .min_uV = MAX8660_LDO67_MIN_UV, |
304 | .uV_step = MAX8660_LDO67_STEP, | |
27f37e4b WS |
305 | }, |
306 | }; | |
307 | ||
4a678f03 DM |
308 | enum { |
309 | MAX8660 = 0, | |
310 | MAX8661 = 1, | |
311 | }; | |
312 | ||
a5023574 | 313 | static int max8660_probe(struct i2c_client *client, |
308f100f | 314 | const struct i2c_device_id *i2c_id) |
27f37e4b WS |
315 | { |
316 | struct regulator_dev **rdev; | |
de492e8d DM |
317 | struct device *dev = &client->dev; |
318 | struct max8660_platform_data *pdata = dev_get_platdata(dev); | |
c172708d | 319 | struct regulator_config config = { }; |
27f37e4b WS |
320 | struct max8660 *max8660; |
321 | int boot_on, i, id, ret = -EINVAL; | |
4a678f03 | 322 | unsigned int type; |
27f37e4b WS |
323 | |
324 | if (pdata->num_subdevs > MAX8660_V_END) { | |
de492e8d | 325 | dev_err(dev, "Too many regulators found!\n"); |
4d26f7d5 | 326 | return -EINVAL; |
27f37e4b WS |
327 | } |
328 | ||
de492e8d | 329 | max8660 = devm_kzalloc(dev, sizeof(struct max8660) + |
27f37e4b WS |
330 | sizeof(struct regulator_dev *) * MAX8660_V_END, |
331 | GFP_KERNEL); | |
4d26f7d5 AL |
332 | if (!max8660) |
333 | return -ENOMEM; | |
27f37e4b WS |
334 | |
335 | max8660->client = client; | |
336 | rdev = max8660->rdev; | |
4a678f03 | 337 | type = i2c_id->driver_data; |
27f37e4b WS |
338 | |
339 | if (pdata->en34_is_high) { | |
340 | /* Simulate always on */ | |
341 | max8660->shadow_regs[MAX8660_OVER1] = 5; | |
342 | } else { | |
343 | /* Otherwise devices can be toggled via software */ | |
344 | max8660_dcdc_ops.enable = max8660_dcdc_enable; | |
345 | max8660_dcdc_ops.disable = max8660_dcdc_disable; | |
346 | } | |
347 | ||
348 | /* | |
349 | * First, set up shadow registers to prevent glitches. As some | |
350 | * registers are shared between regulators, everything must be properly | |
351 | * set up for all regulators in advance. | |
352 | */ | |
353 | max8660->shadow_regs[MAX8660_ADTV1] = | |
354 | max8660->shadow_regs[MAX8660_ADTV2] = | |
355 | max8660->shadow_regs[MAX8660_SDTV1] = | |
356 | max8660->shadow_regs[MAX8660_SDTV2] = 0x1b; | |
357 | max8660->shadow_regs[MAX8660_MDTV1] = | |
358 | max8660->shadow_regs[MAX8660_MDTV2] = 0x04; | |
359 | ||
360 | for (i = 0; i < pdata->num_subdevs; i++) { | |
361 | ||
362 | if (!pdata->subdevs[i].platform_data) | |
4d26f7d5 | 363 | goto err_out; |
27f37e4b WS |
364 | |
365 | boot_on = pdata->subdevs[i].platform_data->constraints.boot_on; | |
366 | ||
367 | switch (pdata->subdevs[i].id) { | |
368 | case MAX8660_V3: | |
369 | if (boot_on) | |
370 | max8660->shadow_regs[MAX8660_OVER1] |= 1; | |
371 | break; | |
372 | ||
373 | case MAX8660_V4: | |
374 | if (boot_on) | |
375 | max8660->shadow_regs[MAX8660_OVER1] |= 4; | |
376 | break; | |
377 | ||
378 | case MAX8660_V5: | |
379 | break; | |
380 | ||
381 | case MAX8660_V6: | |
382 | if (boot_on) | |
383 | max8660->shadow_regs[MAX8660_OVER2] |= 2; | |
384 | break; | |
385 | ||
386 | case MAX8660_V7: | |
4a678f03 | 387 | if (type == MAX8661) { |
de492e8d | 388 | dev_err(dev, "Regulator not on this chip!\n"); |
4d26f7d5 | 389 | goto err_out; |
27f37e4b WS |
390 | } |
391 | ||
392 | if (boot_on) | |
393 | max8660->shadow_regs[MAX8660_OVER2] |= 4; | |
394 | break; | |
395 | ||
396 | default: | |
de492e8d | 397 | dev_err(dev, "invalid regulator %s\n", |
27f37e4b | 398 | pdata->subdevs[i].name); |
4d26f7d5 | 399 | goto err_out; |
27f37e4b WS |
400 | } |
401 | } | |
402 | ||
403 | /* Finally register devices */ | |
404 | for (i = 0; i < pdata->num_subdevs; i++) { | |
405 | ||
406 | id = pdata->subdevs[i].id; | |
407 | ||
de492e8d | 408 | config.dev = dev; |
c172708d MB |
409 | config.init_data = pdata->subdevs[i].platform_data; |
410 | config.driver_data = max8660; | |
411 | ||
412 | rdev[i] = regulator_register(&max8660_reg[id], &config); | |
27f37e4b WS |
413 | if (IS_ERR(rdev[i])) { |
414 | ret = PTR_ERR(rdev[i]); | |
de492e8d | 415 | dev_err(dev, "failed to register %s\n", |
27f37e4b WS |
416 | max8660_reg[id].name); |
417 | goto err_unregister; | |
418 | } | |
419 | } | |
420 | ||
53a4befa | 421 | i2c_set_clientdata(client, max8660); |
27f37e4b WS |
422 | return 0; |
423 | ||
424 | err_unregister: | |
425 | while (--i >= 0) | |
426 | regulator_unregister(rdev[i]); | |
4d26f7d5 | 427 | err_out: |
27f37e4b WS |
428 | return ret; |
429 | } | |
430 | ||
8dc995f5 | 431 | static int max8660_remove(struct i2c_client *client) |
27f37e4b | 432 | { |
53a4befa | 433 | struct max8660 *max8660 = i2c_get_clientdata(client); |
27f37e4b WS |
434 | int i; |
435 | ||
436 | for (i = 0; i < MAX8660_V_END; i++) | |
020501f1 | 437 | regulator_unregister(max8660->rdev[i]); |
27f37e4b WS |
438 | return 0; |
439 | } | |
440 | ||
441 | static const struct i2c_device_id max8660_id[] = { | |
4a678f03 DM |
442 | { .name = "max8660", .driver_data = MAX8660 }, |
443 | { .name = "max8661", .driver_data = MAX8661 }, | |
27f37e4b WS |
444 | { } |
445 | }; | |
446 | MODULE_DEVICE_TABLE(i2c, max8660_id); | |
447 | ||
448 | static struct i2c_driver max8660_driver = { | |
449 | .probe = max8660_probe, | |
5eb9f2b9 | 450 | .remove = max8660_remove, |
27f37e4b WS |
451 | .driver = { |
452 | .name = "max8660", | |
308f100f | 453 | .owner = THIS_MODULE, |
27f37e4b WS |
454 | }, |
455 | .id_table = max8660_id, | |
456 | }; | |
457 | ||
458 | static int __init max8660_init(void) | |
459 | { | |
460 | return i2c_add_driver(&max8660_driver); | |
461 | } | |
462 | subsys_initcall(max8660_init); | |
463 | ||
464 | static void __exit max8660_exit(void) | |
465 | { | |
466 | i2c_del_driver(&max8660_driver); | |
467 | } | |
468 | module_exit(max8660_exit); | |
469 | ||
470 | /* Module information */ | |
471 | MODULE_DESCRIPTION("MAXIM 8660/8661 voltage regulator driver"); | |
472 | MODULE_AUTHOR("Wolfram Sang"); | |
473 | MODULE_LICENSE("GPL v2"); |