2 * max8998.c - Voltage regulator driver for the Maxim 8998
4 * Copyright (C) 2009-2010 Samsung Electronics
5 * Kyungmin Park <kyungmin.park@samsung.com>
6 * Marek Szyprowski <m.szyprowski@samsung.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/module.h>
24 #include <linux/init.h>
25 #include <linux/i2c.h>
26 #include <linux/err.h>
27 #include <linux/gpio.h>
28 #include <linux/slab.h>
29 #include <linux/interrupt.h>
30 #include <linux/mutex.h>
31 #include <linux/delay.h>
32 #include <linux/platform_device.h>
33 #include <linux/regulator/driver.h>
34 #include <linux/mfd/max8998.h>
35 #include <linux/mfd/max8998-private.h>
39 struct max8998_dev *iodev;
41 struct regulator_dev **rdev;
44 struct voltage_map_desc {
51 static const struct voltage_map_desc ldo23_voltage_map_desc = {
52 .min = 800, .step = 50, .max = 1300,
54 static const struct voltage_map_desc ldo456711_voltage_map_desc = {
55 .min = 1600, .step = 100, .max = 3600,
57 static const struct voltage_map_desc ldo8_voltage_map_desc = {
58 .min = 3000, .step = 100, .max = 3600,
60 static const struct voltage_map_desc ldo9_voltage_map_desc = {
61 .min = 2800, .step = 100, .max = 3100,
63 static const struct voltage_map_desc ldo10_voltage_map_desc = {
64 .min = 950, .step = 50, .max = 1300,
66 static const struct voltage_map_desc ldo1213_voltage_map_desc = {
67 .min = 800, .step = 100, .max = 3300,
69 static const struct voltage_map_desc ldo1415_voltage_map_desc = {
70 .min = 1200, .step = 100, .max = 3300,
72 static const struct voltage_map_desc ldo1617_voltage_map_desc = {
73 .min = 1600, .step = 100, .max = 3600,
75 static const struct voltage_map_desc buck12_voltage_map_desc = {
76 .min = 750, .step = 25, .max = 1525,
78 static const struct voltage_map_desc buck3_voltage_map_desc = {
79 .min = 1600, .step = 100, .max = 3600,
81 static const struct voltage_map_desc buck4_voltage_map_desc = {
82 .min = 800, .step = 100, .max = 2300,
85 static const struct voltage_map_desc *ldo_voltage_map[] = {
88 &ldo23_voltage_map_desc, /* LDO2 */
89 &ldo23_voltage_map_desc, /* LDO3 */
90 &ldo456711_voltage_map_desc, /* LDO4 */
91 &ldo456711_voltage_map_desc, /* LDO5 */
92 &ldo456711_voltage_map_desc, /* LDO6 */
93 &ldo456711_voltage_map_desc, /* LDO7 */
94 &ldo8_voltage_map_desc, /* LDO8 */
95 &ldo9_voltage_map_desc, /* LDO9 */
96 &ldo10_voltage_map_desc, /* LDO10 */
97 &ldo456711_voltage_map_desc, /* LDO11 */
98 &ldo1213_voltage_map_desc, /* LDO12 */
99 &ldo1213_voltage_map_desc, /* LDO13 */
100 &ldo1415_voltage_map_desc, /* LDO14 */
101 &ldo1415_voltage_map_desc, /* LDO15 */
102 &ldo1617_voltage_map_desc, /* LDO16 */
103 &ldo1617_voltage_map_desc, /* LDO17 */
104 &buck12_voltage_map_desc, /* BUCK1 */
105 &buck12_voltage_map_desc, /* BUCK2 */
106 &buck3_voltage_map_desc, /* BUCK3 */
107 &buck4_voltage_map_desc, /* BUCK4 */
110 static inline int max8998_get_ldo(struct regulator_dev *rdev)
112 return rdev_get_id(rdev);
115 static int max8998_list_voltage(struct regulator_dev *rdev,
116 unsigned int selector)
118 const struct voltage_map_desc *desc;
119 int ldo = max8998_get_ldo(rdev);
122 if (ldo >= ARRAY_SIZE(ldo_voltage_map))
125 desc = ldo_voltage_map[ldo];
129 val = desc->min + desc->step * selector;
136 static int max8998_get_enable_register(struct regulator_dev *rdev,
137 int *reg, int *shift)
139 int ldo = max8998_get_ldo(rdev);
142 case MAX8998_LDO2 ... MAX8998_LDO5:
143 *reg = MAX8998_REG_ONOFF1;
144 *shift = 3 - (ldo - MAX8998_LDO2);
146 case MAX8998_LDO6 ... MAX8998_LDO13:
147 *reg = MAX8998_REG_ONOFF2;
148 *shift = 7 - (ldo - MAX8998_LDO6);
150 case MAX8998_LDO14 ... MAX8998_LDO17:
151 *reg = MAX8998_REG_ONOFF3;
152 *shift = 7 - (ldo - MAX8998_LDO14);
154 case MAX8998_BUCK1 ... MAX8998_BUCK4:
155 *reg = MAX8998_REG_ONOFF1;
156 *shift = 7 - (ldo - MAX8998_BUCK1);
158 case MAX8998_EN32KHZ_AP ... MAX8998_ENVICHG:
159 *reg = MAX8998_REG_ONOFF4;
160 *shift = 7 - (ldo - MAX8998_EN32KHZ_AP);
162 case MAX8998_ESAFEOUT1 ... MAX8998_ESAFEOUT2:
163 *reg = MAX8998_REG_CHGR2;
164 *shift = 7 - (ldo - MAX8998_ESAFEOUT1);
173 static int max8998_ldo_is_enabled(struct regulator_dev *rdev)
175 struct max8998_data *max8998 = rdev_get_drvdata(rdev);
176 struct i2c_client *i2c = max8998->iodev->i2c;
177 int ret, reg, shift = 8;
180 ret = max8998_get_enable_register(rdev, ®, &shift);
184 ret = max8998_read_reg(i2c, reg, &val);
188 return val & (1 << shift);
191 static int max8998_ldo_enable(struct regulator_dev *rdev)
193 struct max8998_data *max8998 = rdev_get_drvdata(rdev);
194 struct i2c_client *i2c = max8998->iodev->i2c;
195 int reg, shift = 8, ret;
197 ret = max8998_get_enable_register(rdev, ®, &shift);
201 return max8998_update_reg(i2c, reg, 1<<shift, 1<<shift);
204 static int max8998_ldo_disable(struct regulator_dev *rdev)
206 struct max8998_data *max8998 = rdev_get_drvdata(rdev);
207 struct i2c_client *i2c = max8998->iodev->i2c;
208 int reg, shift = 8, ret;
210 ret = max8998_get_enable_register(rdev, ®, &shift);
214 return max8998_update_reg(i2c, reg, 0, 1<<shift);
217 static int max8998_get_voltage_register(struct regulator_dev *rdev,
218 int *_reg, int *_shift, int *_mask)
220 int ldo = max8998_get_ldo(rdev);
221 int reg, shift = 0, mask = 0xff;
224 case MAX8998_LDO2 ... MAX8998_LDO3:
225 reg = MAX8998_REG_LDO2_LDO3;
227 if (ldo == MAX8998_LDO2)
232 case MAX8998_LDO4 ... MAX8998_LDO7:
233 reg = MAX8998_REG_LDO4 + (ldo - MAX8998_LDO4);
235 case MAX8998_LDO8 ... MAX8998_LDO9:
236 reg = MAX8998_REG_LDO8_LDO9;
238 if (ldo == MAX8998_LDO8)
243 case MAX8998_LDO10 ... MAX8998_LDO11:
244 reg = MAX8998_REG_LDO10_LDO11;
245 if (ldo == MAX8998_LDO10) {
253 case MAX8998_LDO12 ... MAX8998_LDO17:
254 reg = MAX8998_REG_LDO12 + (ldo - MAX8998_LDO12);
257 reg = MAX8998_REG_BUCK1_DVSARM1;
260 reg = MAX8998_REG_BUCK2_DVSINT1;
263 reg = MAX8998_REG_BUCK3;
266 reg = MAX8998_REG_BUCK4;
279 static int max8998_get_voltage(struct regulator_dev *rdev)
281 struct max8998_data *max8998 = rdev_get_drvdata(rdev);
282 struct i2c_client *i2c = max8998->iodev->i2c;
283 int reg, shift = 0, mask, ret;
286 ret = max8998_get_voltage_register(rdev, ®, &shift, &mask);
290 ret = max8998_read_reg(i2c, reg, &val);
297 return max8998_list_voltage(rdev, val);
300 static int max8998_set_voltage_ldo(struct regulator_dev *rdev,
301 int min_uV, int max_uV)
303 struct max8998_data *max8998 = rdev_get_drvdata(rdev);
304 struct i2c_client *i2c = max8998->iodev->i2c;
305 int min_vol = min_uV / 1000, max_vol = max_uV / 1000;
306 const struct voltage_map_desc *desc;
307 int ldo = max8998_get_ldo(rdev);
308 int reg, shift = 0, mask, ret;
311 if (ldo >= ARRAY_SIZE(ldo_voltage_map))
314 desc = ldo_voltage_map[ldo];
318 if (max_vol < desc->min || min_vol > desc->max)
321 while (desc->min + desc->step*i < min_vol &&
322 desc->min + desc->step*i < desc->max)
325 if (desc->min + desc->step*i > max_vol)
328 ret = max8998_get_voltage_register(rdev, ®, &shift, &mask);
332 ret = max8998_update_reg(i2c, reg, i<<shift, mask<<shift);
337 static int max8998_set_voltage_buck(struct regulator_dev *rdev,
338 int min_uV, int max_uV)
340 struct max8998_data *max8998 = rdev_get_drvdata(rdev);
341 struct i2c_client *i2c = max8998->iodev->i2c;
342 int min_vol = min_uV / 1000, max_vol = max_uV / 1000;
343 int previous_vol = 0;
344 const struct voltage_map_desc *desc;
345 int ldo = max8998_get_ldo(rdev);
346 int reg, shift = 0, mask, ret;
349 bool en_ramp = false;
351 if (ldo >= ARRAY_SIZE(ldo_voltage_map))
354 desc = ldo_voltage_map[ldo];
358 if (max_vol < desc->min || min_vol > desc->max)
361 while (desc->min + desc->step*i < min_vol &&
362 desc->min + desc->step*i < desc->max)
365 if (desc->min + desc->step*i > max_vol)
368 ret = max8998_get_voltage_register(rdev, ®, &shift, &mask);
372 /* wait for RAMP_UP_DELAY if rdev is BUCK1/2 and
374 if (ldo == MAX8998_BUCK1 || ldo == MAX8998_BUCK2) {
375 max8998_read_reg(i2c, MAX8998_REG_ONOFF4, &val);
376 if (val & (1 << 4)) {
378 previous_vol = max8998_get_voltage(rdev);
382 ret = max8998_update_reg(i2c, reg, i<<shift, mask<<shift);
384 if (en_ramp == true) {
385 int difference = desc->min + desc->step*i - previous_vol/1000;
387 udelay(difference / ((val & 0x0f) + 1));
393 static struct regulator_ops max8998_ldo_ops = {
394 .list_voltage = max8998_list_voltage,
395 .is_enabled = max8998_ldo_is_enabled,
396 .enable = max8998_ldo_enable,
397 .disable = max8998_ldo_disable,
398 .get_voltage = max8998_get_voltage,
399 .set_voltage = max8998_set_voltage_ldo,
400 .set_suspend_enable = max8998_ldo_enable,
401 .set_suspend_disable = max8998_ldo_disable,
404 static struct regulator_ops max8998_buck_ops = {
405 .list_voltage = max8998_list_voltage,
406 .is_enabled = max8998_ldo_is_enabled,
407 .enable = max8998_ldo_enable,
408 .disable = max8998_ldo_disable,
409 .get_voltage = max8998_get_voltage,
410 .set_voltage = max8998_set_voltage_buck,
411 .set_suspend_enable = max8998_ldo_enable,
412 .set_suspend_disable = max8998_ldo_disable,
415 static struct regulator_ops max8998_others_ops = {
416 .is_enabled = max8998_ldo_is_enabled,
417 .enable = max8998_ldo_enable,
418 .disable = max8998_ldo_disable,
419 .set_suspend_enable = max8998_ldo_enable,
420 .set_suspend_disable = max8998_ldo_disable,
423 static struct regulator_desc regulators[] = {
427 .ops = &max8998_ldo_ops,
428 .type = REGULATOR_VOLTAGE,
429 .owner = THIS_MODULE,
433 .ops = &max8998_ldo_ops,
434 .type = REGULATOR_VOLTAGE,
435 .owner = THIS_MODULE,
439 .ops = &max8998_ldo_ops,
440 .type = REGULATOR_VOLTAGE,
441 .owner = THIS_MODULE,
445 .ops = &max8998_ldo_ops,
446 .type = REGULATOR_VOLTAGE,
447 .owner = THIS_MODULE,
451 .ops = &max8998_ldo_ops,
452 .type = REGULATOR_VOLTAGE,
453 .owner = THIS_MODULE,
457 .ops = &max8998_ldo_ops,
458 .type = REGULATOR_VOLTAGE,
459 .owner = THIS_MODULE,
463 .ops = &max8998_ldo_ops,
464 .type = REGULATOR_VOLTAGE,
465 .owner = THIS_MODULE,
469 .ops = &max8998_ldo_ops,
470 .type = REGULATOR_VOLTAGE,
471 .owner = THIS_MODULE,
475 .ops = &max8998_ldo_ops,
476 .type = REGULATOR_VOLTAGE,
477 .owner = THIS_MODULE,
481 .ops = &max8998_ldo_ops,
482 .type = REGULATOR_VOLTAGE,
483 .owner = THIS_MODULE,
487 .ops = &max8998_ldo_ops,
488 .type = REGULATOR_VOLTAGE,
489 .owner = THIS_MODULE,
493 .ops = &max8998_ldo_ops,
494 .type = REGULATOR_VOLTAGE,
495 .owner = THIS_MODULE,
499 .ops = &max8998_ldo_ops,
500 .type = REGULATOR_VOLTAGE,
501 .owner = THIS_MODULE,
505 .ops = &max8998_ldo_ops,
506 .type = REGULATOR_VOLTAGE,
507 .owner = THIS_MODULE,
511 .ops = &max8998_ldo_ops,
512 .type = REGULATOR_VOLTAGE,
513 .owner = THIS_MODULE,
517 .ops = &max8998_ldo_ops,
518 .type = REGULATOR_VOLTAGE,
519 .owner = THIS_MODULE,
523 .ops = &max8998_buck_ops,
524 .type = REGULATOR_VOLTAGE,
525 .owner = THIS_MODULE,
529 .ops = &max8998_buck_ops,
530 .type = REGULATOR_VOLTAGE,
531 .owner = THIS_MODULE,
535 .ops = &max8998_buck_ops,
536 .type = REGULATOR_VOLTAGE,
537 .owner = THIS_MODULE,
541 .ops = &max8998_buck_ops,
542 .type = REGULATOR_VOLTAGE,
543 .owner = THIS_MODULE,
545 .name = "EN32KHz AP",
546 .id = MAX8998_EN32KHZ_AP,
547 .ops = &max8998_others_ops,
548 .type = REGULATOR_VOLTAGE,
549 .owner = THIS_MODULE,
551 .name = "EN32KHz CP",
552 .id = MAX8998_EN32KHZ_CP,
553 .ops = &max8998_others_ops,
554 .type = REGULATOR_VOLTAGE,
555 .owner = THIS_MODULE,
558 .id = MAX8998_ENVICHG,
559 .ops = &max8998_others_ops,
560 .type = REGULATOR_VOLTAGE,
561 .owner = THIS_MODULE,
564 .id = MAX8998_ESAFEOUT1,
565 .ops = &max8998_others_ops,
566 .type = REGULATOR_VOLTAGE,
567 .owner = THIS_MODULE,
570 .id = MAX8998_ESAFEOUT2,
571 .ops = &max8998_others_ops,
572 .type = REGULATOR_VOLTAGE,
573 .owner = THIS_MODULE,
577 static __devinit int max8998_pmic_probe(struct platform_device *pdev)
579 struct max8998_dev *iodev = dev_get_drvdata(pdev->dev.parent);
580 struct max8998_platform_data *pdata = dev_get_platdata(iodev->dev);
581 struct regulator_dev **rdev;
582 struct max8998_data *max8998;
586 dev_err(pdev->dev.parent, "No platform init data supplied\n");
590 max8998 = kzalloc(sizeof(struct max8998_data), GFP_KERNEL);
594 size = sizeof(struct regulator_dev *) * pdata->num_regulators;
595 max8998->rdev = kzalloc(size, GFP_KERNEL);
596 if (!max8998->rdev) {
601 rdev = max8998->rdev;
602 max8998->dev = &pdev->dev;
603 max8998->iodev = iodev;
604 max8998->num_regulators = pdata->num_regulators;
605 platform_set_drvdata(pdev, max8998);
607 for (i = 0; i < pdata->num_regulators; i++) {
608 const struct voltage_map_desc *desc;
609 int id = pdata->regulators[i].id;
610 int index = id - MAX8998_LDO2;
612 desc = ldo_voltage_map[id];
613 if (desc && regulators[index].ops != &max8998_others_ops) {
614 int count = (desc->max - desc->min) / desc->step + 1;
615 regulators[index].n_voltages = count;
617 rdev[i] = regulator_register(®ulators[index], max8998->dev,
618 pdata->regulators[i].initdata, max8998);
619 if (IS_ERR(rdev[i])) {
620 ret = PTR_ERR(rdev[i]);
621 dev_err(max8998->dev, "regulator init failed\n");
630 for (i = 0; i < max8998->num_regulators; i++)
632 regulator_unregister(rdev[i]);
634 kfree(max8998->rdev);
640 static int __devexit max8998_pmic_remove(struct platform_device *pdev)
642 struct max8998_data *max8998 = platform_get_drvdata(pdev);
643 struct regulator_dev **rdev = max8998->rdev;
646 for (i = 0; i < max8998->num_regulators; i++)
648 regulator_unregister(rdev[i]);
650 kfree(max8998->rdev);
656 static struct platform_driver max8998_pmic_driver = {
658 .name = "max8998-pmic",
659 .owner = THIS_MODULE,
661 .probe = max8998_pmic_probe,
662 .remove = __devexit_p(max8998_pmic_remove),
665 static int __init max8998_pmic_init(void)
667 return platform_driver_register(&max8998_pmic_driver);
669 subsys_initcall(max8998_pmic_init);
671 static void __exit max8998_pmic_cleanup(void)
673 platform_driver_unregister(&max8998_pmic_driver);
675 module_exit(max8998_pmic_cleanup);
677 MODULE_DESCRIPTION("MAXIM 8998 voltage regulator driver");
678 MODULE_AUTHOR("Kyungmin Park <kyungmin.park@samsung.com>");
679 MODULE_LICENSE("GPL");