2 * max8997.c - Regulator driver for the Maxim 8997/8966
4 * Copyright (C) 2011 Samsung Electronics
5 * MyungJoo Ham <myungjoo.ham@smasung.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 * This driver is based on max8998.c
24 #include <linux/bug.h>
25 #include <linux/err.h>
26 #include <linux/gpio.h>
27 #include <linux/of_gpio.h>
28 #include <linux/slab.h>
29 #include <linux/module.h>
30 #include <linux/platform_device.h>
31 #include <linux/regulator/driver.h>
32 #include <linux/regulator/machine.h>
33 #include <linux/mfd/max8997.h>
34 #include <linux/mfd/max8997-private.h>
35 #include <linux/regulator/of_regulator.h>
39 struct max8997_dev *iodev;
41 struct regulator_dev **rdev;
42 int ramp_delay; /* in mV/us */
51 int buck125_gpioindex;
52 bool ignore_gpiodvs_side_effect;
54 u8 saved_states[MAX8997_REG_MAX];
57 static const unsigned int safeoutvolt[] = {
64 static inline void max8997_set_gpio(struct max8997_data *max8997)
66 int set3 = (max8997->buck125_gpioindex) & 0x1;
67 int set2 = ((max8997->buck125_gpioindex) >> 1) & 0x1;
68 int set1 = ((max8997->buck125_gpioindex) >> 2) & 0x1;
70 gpio_set_value(max8997->buck125_gpios[0], set1);
71 gpio_set_value(max8997->buck125_gpios[1], set2);
72 gpio_set_value(max8997->buck125_gpios[2], set3);
75 struct voltage_map_desc {
81 /* Voltage maps in mV */
82 static const struct voltage_map_desc ldo_voltage_map_desc = {
83 .min = 800, .max = 3950, .step = 50,
84 }; /* LDO1 ~ 18, 21 all */
86 static const struct voltage_map_desc buck1245_voltage_map_desc = {
87 .min = 650, .max = 2225, .step = 25,
88 }; /* Buck1, 2, 4, 5 */
90 static const struct voltage_map_desc buck37_voltage_map_desc = {
91 .min = 750, .max = 3900, .step = 50,
94 /* current map in mA */
95 static const struct voltage_map_desc charger_current_map_desc = {
96 .min = 200, .max = 950, .step = 50,
99 static const struct voltage_map_desc topoff_current_map_desc = {
100 .min = 50, .max = 200, .step = 10,
103 static const struct voltage_map_desc *reg_voltage_map[] = {
104 [MAX8997_LDO1] = &ldo_voltage_map_desc,
105 [MAX8997_LDO2] = &ldo_voltage_map_desc,
106 [MAX8997_LDO3] = &ldo_voltage_map_desc,
107 [MAX8997_LDO4] = &ldo_voltage_map_desc,
108 [MAX8997_LDO5] = &ldo_voltage_map_desc,
109 [MAX8997_LDO6] = &ldo_voltage_map_desc,
110 [MAX8997_LDO7] = &ldo_voltage_map_desc,
111 [MAX8997_LDO8] = &ldo_voltage_map_desc,
112 [MAX8997_LDO9] = &ldo_voltage_map_desc,
113 [MAX8997_LDO10] = &ldo_voltage_map_desc,
114 [MAX8997_LDO11] = &ldo_voltage_map_desc,
115 [MAX8997_LDO12] = &ldo_voltage_map_desc,
116 [MAX8997_LDO13] = &ldo_voltage_map_desc,
117 [MAX8997_LDO14] = &ldo_voltage_map_desc,
118 [MAX8997_LDO15] = &ldo_voltage_map_desc,
119 [MAX8997_LDO16] = &ldo_voltage_map_desc,
120 [MAX8997_LDO17] = &ldo_voltage_map_desc,
121 [MAX8997_LDO18] = &ldo_voltage_map_desc,
122 [MAX8997_LDO21] = &ldo_voltage_map_desc,
123 [MAX8997_BUCK1] = &buck1245_voltage_map_desc,
124 [MAX8997_BUCK2] = &buck1245_voltage_map_desc,
125 [MAX8997_BUCK3] = &buck37_voltage_map_desc,
126 [MAX8997_BUCK4] = &buck1245_voltage_map_desc,
127 [MAX8997_BUCK5] = &buck1245_voltage_map_desc,
128 [MAX8997_BUCK6] = NULL,
129 [MAX8997_BUCK7] = &buck37_voltage_map_desc,
130 [MAX8997_EN32KHZ_AP] = NULL,
131 [MAX8997_EN32KHZ_CP] = NULL,
132 [MAX8997_ENVICHG] = NULL,
133 [MAX8997_ESAFEOUT1] = NULL,
134 [MAX8997_ESAFEOUT2] = NULL,
135 [MAX8997_CHARGER_CV] = NULL,
136 [MAX8997_CHARGER] = &charger_current_map_desc,
137 [MAX8997_CHARGER_TOPOFF] = &topoff_current_map_desc,
140 static int max8997_list_voltage_charger_cv(struct regulator_dev *rdev,
141 unsigned int selector)
143 int rid = rdev_get_id(rdev);
145 if (rid != MAX8997_CHARGER_CV)
152 return 4000000 + 20000 * (selector - 0x01);
162 static int max8997_list_voltage(struct regulator_dev *rdev,
163 unsigned int selector)
165 const struct voltage_map_desc *desc;
166 int rid = rdev_get_id(rdev);
169 if (rid >= ARRAY_SIZE(reg_voltage_map) ||
173 desc = reg_voltage_map[rid];
177 val = desc->min + desc->step * selector;
184 static int max8997_get_enable_register(struct regulator_dev *rdev,
185 int *reg, int *mask, int *pattern)
187 int rid = rdev_get_id(rdev);
190 case MAX8997_LDO1 ... MAX8997_LDO21:
191 *reg = MAX8997_REG_LDO1CTRL + (rid - MAX8997_LDO1);
196 *reg = MAX8997_REG_BUCK1CTRL;
201 *reg = MAX8997_REG_BUCK2CTRL;
206 *reg = MAX8997_REG_BUCK3CTRL;
211 *reg = MAX8997_REG_BUCK4CTRL;
216 *reg = MAX8997_REG_BUCK5CTRL;
221 *reg = MAX8997_REG_BUCK6CTRL;
226 *reg = MAX8997_REG_BUCK7CTRL;
230 case MAX8997_EN32KHZ_AP ... MAX8997_EN32KHZ_CP:
231 *reg = MAX8997_REG_MAINCON1;
232 *mask = 0x01 << (rid - MAX8997_EN32KHZ_AP);
233 *pattern = 0x01 << (rid - MAX8997_EN32KHZ_AP);
235 case MAX8997_ENVICHG:
236 *reg = MAX8997_REG_MBCCTRL1;
240 case MAX8997_ESAFEOUT1 ... MAX8997_ESAFEOUT2:
241 *reg = MAX8997_REG_SAFEOUTCTRL;
242 *mask = 0x40 << (rid - MAX8997_ESAFEOUT1);
243 *pattern = 0x40 << (rid - MAX8997_ESAFEOUT1);
245 case MAX8997_CHARGER:
246 *reg = MAX8997_REG_MBCCTRL2;
251 /* Not controllable or not exists */
258 static int max8997_reg_is_enabled(struct regulator_dev *rdev)
260 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
261 struct i2c_client *i2c = max8997->iodev->i2c;
262 int ret, reg, mask, pattern;
265 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
269 ret = max8997_read_reg(i2c, reg, &val);
273 return (val & mask) == pattern;
276 static int max8997_reg_enable(struct regulator_dev *rdev)
278 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
279 struct i2c_client *i2c = max8997->iodev->i2c;
280 int ret, reg, mask, pattern;
282 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
286 return max8997_update_reg(i2c, reg, pattern, mask);
289 static int max8997_reg_disable(struct regulator_dev *rdev)
291 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
292 struct i2c_client *i2c = max8997->iodev->i2c;
293 int ret, reg, mask, pattern;
295 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
299 return max8997_update_reg(i2c, reg, ~pattern, mask);
302 static int max8997_get_voltage_register(struct regulator_dev *rdev,
303 int *_reg, int *_shift, int *_mask)
305 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
306 int rid = rdev_get_id(rdev);
307 int reg, shift = 0, mask = 0x3f;
310 case MAX8997_LDO1 ... MAX8997_LDO21:
311 reg = MAX8997_REG_LDO1CTRL + (rid - MAX8997_LDO1);
314 reg = MAX8997_REG_BUCK1DVS1;
315 if (max8997->buck1_gpiodvs)
316 reg += max8997->buck125_gpioindex;
319 reg = MAX8997_REG_BUCK2DVS1;
320 if (max8997->buck2_gpiodvs)
321 reg += max8997->buck125_gpioindex;
324 reg = MAX8997_REG_BUCK3DVS;
327 reg = MAX8997_REG_BUCK4DVS;
330 reg = MAX8997_REG_BUCK5DVS1;
331 if (max8997->buck5_gpiodvs)
332 reg += max8997->buck125_gpioindex;
335 reg = MAX8997_REG_BUCK7DVS;
337 case MAX8997_ESAFEOUT1 ... MAX8997_ESAFEOUT2:
338 reg = MAX8997_REG_SAFEOUTCTRL;
339 shift = (rid == MAX8997_ESAFEOUT2) ? 2 : 0;
342 case MAX8997_CHARGER_CV:
343 reg = MAX8997_REG_MBCCTRL3;
347 case MAX8997_CHARGER:
348 reg = MAX8997_REG_MBCCTRL4;
352 case MAX8997_CHARGER_TOPOFF:
353 reg = MAX8997_REG_MBCCTRL5;
368 static int max8997_get_voltage_sel(struct regulator_dev *rdev)
370 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
371 struct i2c_client *i2c = max8997->iodev->i2c;
372 int reg, shift, mask, ret;
375 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
379 ret = max8997_read_reg(i2c, reg, &val);
389 static inline int max8997_get_voltage_proper_val(
390 const struct voltage_map_desc *desc,
391 int min_vol, int max_vol)
398 if (max_vol < desc->min || min_vol > desc->max)
401 if (min_vol < desc->min)
404 i = DIV_ROUND_UP(min_vol - desc->min, desc->step);
406 if (desc->min + desc->step * i > max_vol)
412 static int max8997_set_voltage_charger_cv(struct regulator_dev *rdev,
413 int min_uV, int max_uV, unsigned *selector)
415 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
416 struct i2c_client *i2c = max8997->iodev->i2c;
417 int rid = rdev_get_id(rdev);
419 int reg, shift = 0, mask, ret = 0;
422 if (rid != MAX8997_CHARGER_CV)
425 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
429 if (max_uV < 4000000 || min_uV > 4350000)
432 if (min_uV <= 4000000) {
433 if (max_uV >= 4000000)
437 } else if (min_uV <= 4200000 && max_uV >= 4200000)
440 lb = (min_uV - 4000001) / 20000 + 2;
441 ub = (max_uV - 4000000) / 20000 + 1;
458 ret = max8997_update_reg(i2c, reg, val << shift, mask);
464 * For LDO1 ~ LDO21, BUCK1~5, BUCK7, CHARGER, CHARGER_TOPOFF
465 * BUCK1, 2, and 5 are available if they are not controlled by gpio
467 static int max8997_set_voltage_ldobuck(struct regulator_dev *rdev,
468 int min_uV, int max_uV, unsigned *selector)
470 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
471 struct i2c_client *i2c = max8997->iodev->i2c;
472 int min_vol = min_uV / 1000, max_vol = max_uV / 1000;
473 const struct voltage_map_desc *desc;
474 int rid = rdev_get_id(rdev);
475 int i, reg, shift, mask, ret;
478 case MAX8997_LDO1 ... MAX8997_LDO21:
480 case MAX8997_BUCK1 ... MAX8997_BUCK5:
486 case MAX8997_CHARGER:
488 case MAX8997_CHARGER_TOPOFF:
494 desc = reg_voltage_map[rid];
496 i = max8997_get_voltage_proper_val(desc, min_vol, max_vol);
500 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
504 ret = max8997_update_reg(i2c, reg, i << shift, mask << shift);
510 static int max8997_set_voltage_buck_time_sel(struct regulator_dev *rdev,
511 unsigned int old_selector,
512 unsigned int new_selector)
514 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
515 int rid = rdev_get_id(rdev);
516 const struct voltage_map_desc *desc = reg_voltage_map[rid];
518 /* Delay is required only if the voltage is increasing */
519 if (old_selector >= new_selector)
522 /* No need to delay if gpio_dvs_mode */
525 if (max8997->buck1_gpiodvs)
529 if (max8997->buck2_gpiodvs)
533 if (max8997->buck5_gpiodvs)
543 return DIV_ROUND_UP(desc->step * (new_selector - old_selector),
544 max8997->ramp_delay);
551 * Assess the damage on the voltage setting of BUCK1,2,5 by the change.
553 * When GPIO-DVS mode is used for multiple bucks, changing the voltage value
554 * of one of the bucks may affect that of another buck, which is the side
555 * effect of the change (set_voltage). This function examines the GPIO-DVS
556 * configurations and checks whether such side-effect exists.
558 static int max8997_assess_side_effect(struct regulator_dev *rdev,
559 u8 new_val, int *best)
561 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
562 int rid = rdev_get_id(rdev);
564 bool buckx_gpiodvs[3];
566 int min_side_effect = INT_MAX;
585 buckx_val[0] = max8997->buck1_vol;
586 buckx_val[1] = max8997->buck2_vol;
587 buckx_val[2] = max8997->buck5_vol;
588 buckx_gpiodvs[0] = max8997->buck1_gpiodvs;
589 buckx_gpiodvs[1] = max8997->buck2_gpiodvs;
590 buckx_gpiodvs[2] = max8997->buck5_gpiodvs;
592 for (i = 0; i < 8; i++) {
595 if (new_val != (buckx_val[rid])[i]) {
601 for (others = 0; others < 3; others++) {
606 if (buckx_gpiodvs[others] == false)
607 continue; /* Not affected */
608 diff = (buckx_val[others])[i] -
609 (buckx_val[others])[max8997->buck125_gpioindex];
611 side_effect[i] += diff;
613 side_effect[i] -= diff;
615 if (side_effect[i] == 0) {
617 return 0; /* NO SIDE EFFECT! Use This! */
619 if (side_effect[i] < min_side_effect) {
620 min_side_effect = side_effect[i];
628 return side_effect[*best];
632 * For Buck 1 ~ 5 and 7. If it is not controlled by GPIO, this calls
633 * max8997_set_voltage_ldobuck to do the job.
635 static int max8997_set_voltage_buck(struct regulator_dev *rdev,
636 int min_uV, int max_uV, unsigned *selector)
638 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
639 int rid = rdev_get_id(rdev);
640 const struct voltage_map_desc *desc;
641 int new_val, new_idx, damage, tmp_val, tmp_idx, tmp_dmg;
642 bool gpio_dvs_mode = false;
643 int min_vol = min_uV / 1000, max_vol = max_uV / 1000;
645 if (rid < MAX8997_BUCK1 || rid > MAX8997_BUCK7)
650 if (max8997->buck1_gpiodvs)
651 gpio_dvs_mode = true;
654 if (max8997->buck2_gpiodvs)
655 gpio_dvs_mode = true;
658 if (max8997->buck5_gpiodvs)
659 gpio_dvs_mode = true;
664 return max8997_set_voltage_ldobuck(rdev, min_uV, max_uV,
667 desc = reg_voltage_map[rid];
668 new_val = max8997_get_voltage_proper_val(desc, min_vol, max_vol);
676 damage = max8997_assess_side_effect(rdev, new_val, &new_idx);
680 if (tmp_dmg > damage) {
687 } while (desc->min + desc->step * new_val <= desc->max);
692 if (max8997->ignore_gpiodvs_side_effect == false)
695 dev_warn(&rdev->dev, "MAX8997 GPIO-DVS Side Effect Warning: GPIO SET:"
696 " %d -> %d\n", max8997->buck125_gpioindex, tmp_idx);
699 if (new_idx < 0 || new_val < 0)
702 max8997->buck125_gpioindex = new_idx;
703 max8997_set_gpio(max8997);
709 /* For SAFEOUT1 and SAFEOUT2 */
710 static int max8997_set_voltage_safeout_sel(struct regulator_dev *rdev,
713 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
714 struct i2c_client *i2c = max8997->iodev->i2c;
715 int rid = rdev_get_id(rdev);
716 int reg, shift = 0, mask, ret;
718 if (rid != MAX8997_ESAFEOUT1 && rid != MAX8997_ESAFEOUT2)
721 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
725 return max8997_update_reg(i2c, reg, selector << shift, mask << shift);
728 static int max8997_reg_disable_suspend(struct regulator_dev *rdev)
730 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
731 struct i2c_client *i2c = max8997->iodev->i2c;
732 int ret, reg, mask, pattern;
733 int rid = rdev_get_id(rdev);
735 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
739 max8997_read_reg(i2c, reg, &max8997->saved_states[rid]);
741 if (rid == MAX8997_LDO1 ||
742 rid == MAX8997_LDO10 ||
743 rid == MAX8997_LDO21) {
744 dev_dbg(&rdev->dev, "Conditional Power-Off for %s\n",
746 return max8997_update_reg(i2c, reg, 0x40, mask);
749 dev_dbg(&rdev->dev, "Full Power-Off for %s (%xh -> %xh)\n",
750 rdev->desc->name, max8997->saved_states[rid] & mask,
752 return max8997_update_reg(i2c, reg, ~pattern, mask);
755 static struct regulator_ops max8997_ldo_ops = {
756 .list_voltage = max8997_list_voltage,
757 .is_enabled = max8997_reg_is_enabled,
758 .enable = max8997_reg_enable,
759 .disable = max8997_reg_disable,
760 .get_voltage_sel = max8997_get_voltage_sel,
761 .set_voltage = max8997_set_voltage_ldobuck,
762 .set_suspend_disable = max8997_reg_disable_suspend,
765 static struct regulator_ops max8997_buck_ops = {
766 .list_voltage = max8997_list_voltage,
767 .is_enabled = max8997_reg_is_enabled,
768 .enable = max8997_reg_enable,
769 .disable = max8997_reg_disable,
770 .get_voltage_sel = max8997_get_voltage_sel,
771 .set_voltage = max8997_set_voltage_buck,
772 .set_voltage_time_sel = max8997_set_voltage_buck_time_sel,
773 .set_suspend_disable = max8997_reg_disable_suspend,
776 static struct regulator_ops max8997_fixedvolt_ops = {
777 .list_voltage = max8997_list_voltage,
778 .is_enabled = max8997_reg_is_enabled,
779 .enable = max8997_reg_enable,
780 .disable = max8997_reg_disable,
781 .set_suspend_disable = max8997_reg_disable_suspend,
784 static struct regulator_ops max8997_safeout_ops = {
785 .list_voltage = regulator_list_voltage_table,
786 .is_enabled = max8997_reg_is_enabled,
787 .enable = max8997_reg_enable,
788 .disable = max8997_reg_disable,
789 .get_voltage_sel = max8997_get_voltage_sel,
790 .set_voltage_sel = max8997_set_voltage_safeout_sel,
791 .set_suspend_disable = max8997_reg_disable_suspend,
794 static struct regulator_ops max8997_fixedstate_ops = {
795 .list_voltage = max8997_list_voltage_charger_cv,
796 .get_voltage_sel = max8997_get_voltage_sel,
797 .set_voltage = max8997_set_voltage_charger_cv,
800 static int max8997_set_current_limit(struct regulator_dev *rdev,
801 int min_uA, int max_uA)
804 int rid = rdev_get_id(rdev);
806 if (rid != MAX8997_CHARGER && rid != MAX8997_CHARGER_TOPOFF)
809 /* Reuse max8997_set_voltage_ldobuck to set current_limit. */
810 return max8997_set_voltage_ldobuck(rdev, min_uA, max_uA, &dummy);
813 static int max8997_get_current_limit(struct regulator_dev *rdev)
815 int sel, rid = rdev_get_id(rdev);
817 if (rid != MAX8997_CHARGER && rid != MAX8997_CHARGER_TOPOFF)
820 sel = max8997_get_voltage_sel(rdev);
824 /* Reuse max8997_list_voltage to get current_limit. */
825 return max8997_list_voltage(rdev, sel);
828 static struct regulator_ops max8997_charger_ops = {
829 .is_enabled = max8997_reg_is_enabled,
830 .enable = max8997_reg_enable,
831 .disable = max8997_reg_disable,
832 .get_current_limit = max8997_get_current_limit,
833 .set_current_limit = max8997_set_current_limit,
836 static struct regulator_ops max8997_charger_fixedstate_ops = {
837 .get_current_limit = max8997_get_current_limit,
838 .set_current_limit = max8997_set_current_limit,
841 #define MAX8997_VOLTAGE_REGULATOR(_name, _ops) {\
843 .id = MAX8997_##_name, \
845 .type = REGULATOR_VOLTAGE, \
846 .owner = THIS_MODULE, \
849 #define MAX8997_CURRENT_REGULATOR(_name, _ops) {\
851 .id = MAX8997_##_name, \
853 .type = REGULATOR_CURRENT, \
854 .owner = THIS_MODULE, \
857 static struct regulator_desc regulators[] = {
858 MAX8997_VOLTAGE_REGULATOR(LDO1, max8997_ldo_ops),
859 MAX8997_VOLTAGE_REGULATOR(LDO2, max8997_ldo_ops),
860 MAX8997_VOLTAGE_REGULATOR(LDO3, max8997_ldo_ops),
861 MAX8997_VOLTAGE_REGULATOR(LDO4, max8997_ldo_ops),
862 MAX8997_VOLTAGE_REGULATOR(LDO5, max8997_ldo_ops),
863 MAX8997_VOLTAGE_REGULATOR(LDO6, max8997_ldo_ops),
864 MAX8997_VOLTAGE_REGULATOR(LDO7, max8997_ldo_ops),
865 MAX8997_VOLTAGE_REGULATOR(LDO8, max8997_ldo_ops),
866 MAX8997_VOLTAGE_REGULATOR(LDO9, max8997_ldo_ops),
867 MAX8997_VOLTAGE_REGULATOR(LDO10, max8997_ldo_ops),
868 MAX8997_VOLTAGE_REGULATOR(LDO11, max8997_ldo_ops),
869 MAX8997_VOLTAGE_REGULATOR(LDO12, max8997_ldo_ops),
870 MAX8997_VOLTAGE_REGULATOR(LDO13, max8997_ldo_ops),
871 MAX8997_VOLTAGE_REGULATOR(LDO14, max8997_ldo_ops),
872 MAX8997_VOLTAGE_REGULATOR(LDO15, max8997_ldo_ops),
873 MAX8997_VOLTAGE_REGULATOR(LDO16, max8997_ldo_ops),
874 MAX8997_VOLTAGE_REGULATOR(LDO17, max8997_ldo_ops),
875 MAX8997_VOLTAGE_REGULATOR(LDO18, max8997_ldo_ops),
876 MAX8997_VOLTAGE_REGULATOR(LDO21, max8997_ldo_ops),
877 MAX8997_VOLTAGE_REGULATOR(BUCK1, max8997_buck_ops),
878 MAX8997_VOLTAGE_REGULATOR(BUCK2, max8997_buck_ops),
879 MAX8997_VOLTAGE_REGULATOR(BUCK3, max8997_buck_ops),
880 MAX8997_VOLTAGE_REGULATOR(BUCK4, max8997_buck_ops),
881 MAX8997_VOLTAGE_REGULATOR(BUCK5, max8997_buck_ops),
882 MAX8997_VOLTAGE_REGULATOR(BUCK6, max8997_fixedvolt_ops),
883 MAX8997_VOLTAGE_REGULATOR(BUCK7, max8997_buck_ops),
884 MAX8997_VOLTAGE_REGULATOR(EN32KHZ_AP, max8997_fixedvolt_ops),
885 MAX8997_VOLTAGE_REGULATOR(EN32KHZ_CP, max8997_fixedvolt_ops),
886 MAX8997_VOLTAGE_REGULATOR(ENVICHG, max8997_fixedvolt_ops),
887 MAX8997_VOLTAGE_REGULATOR(ESAFEOUT1, max8997_safeout_ops),
888 MAX8997_VOLTAGE_REGULATOR(ESAFEOUT2, max8997_safeout_ops),
889 MAX8997_VOLTAGE_REGULATOR(CHARGER_CV, max8997_fixedstate_ops),
890 MAX8997_CURRENT_REGULATOR(CHARGER, max8997_charger_ops),
891 MAX8997_CURRENT_REGULATOR(CHARGER_TOPOFF,
892 max8997_charger_fixedstate_ops),
896 static int max8997_pmic_dt_parse_dvs_gpio(struct max8997_dev *iodev,
897 struct max8997_platform_data *pdata,
898 struct device_node *pmic_np)
902 for (i = 0; i < 3; i++) {
903 gpio = of_get_named_gpio(pmic_np,
904 "max8997,pmic-buck125-dvs-gpios", i);
905 if (!gpio_is_valid(gpio)) {
906 dev_err(iodev->dev, "invalid gpio[%d]: %d\n", i, gpio);
909 pdata->buck125_gpios[i] = gpio;
914 static int max8997_pmic_dt_parse_pdata(struct max8997_dev *iodev,
915 struct max8997_platform_data *pdata)
917 struct device_node *pmic_np, *regulators_np, *reg_np;
918 struct max8997_regulator_data *rdata;
919 unsigned int i, dvs_voltage_nr = 1, ret;
921 pmic_np = iodev->dev->of_node;
923 dev_err(iodev->dev, "could not find pmic sub-node\n");
927 regulators_np = of_find_node_by_name(pmic_np, "regulators");
928 if (!regulators_np) {
929 dev_err(iodev->dev, "could not find regulators sub-node\n");
933 /* count the number of regulators to be supported in pmic */
934 pdata->num_regulators = 0;
935 for_each_child_of_node(regulators_np, reg_np)
936 pdata->num_regulators++;
938 rdata = devm_kzalloc(iodev->dev, sizeof(*rdata) *
939 pdata->num_regulators, GFP_KERNEL);
941 dev_err(iodev->dev, "could not allocate memory for "
946 pdata->regulators = rdata;
947 for_each_child_of_node(regulators_np, reg_np) {
948 for (i = 0; i < ARRAY_SIZE(regulators); i++)
949 if (!of_node_cmp(reg_np->name, regulators[i].name))
952 if (i == ARRAY_SIZE(regulators)) {
953 dev_warn(iodev->dev, "don't know how to configure "
954 "regulator %s\n", reg_np->name);
959 rdata->initdata = of_get_regulator_init_data(
961 rdata->reg_node = reg_np;
965 if (of_get_property(pmic_np, "max8997,pmic-buck1-uses-gpio-dvs", NULL))
966 pdata->buck1_gpiodvs = true;
968 if (of_get_property(pmic_np, "max8997,pmic-buck2-uses-gpio-dvs", NULL))
969 pdata->buck2_gpiodvs = true;
971 if (of_get_property(pmic_np, "max8997,pmic-buck5-uses-gpio-dvs", NULL))
972 pdata->buck5_gpiodvs = true;
974 if (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
975 pdata->buck5_gpiodvs) {
976 ret = max8997_pmic_dt_parse_dvs_gpio(iodev, pdata, pmic_np);
980 if (of_property_read_u32(pmic_np,
981 "max8997,pmic-buck125-default-dvs-idx",
982 &pdata->buck125_default_idx)) {
983 pdata->buck125_default_idx = 0;
985 if (pdata->buck125_default_idx >= 8) {
986 pdata->buck125_default_idx = 0;
987 dev_info(iodev->dev, "invalid value for "
988 "default dvs index, using 0 instead\n");
992 if (of_get_property(pmic_np,
993 "max8997,pmic-ignore-gpiodvs-side-effect", NULL))
994 pdata->ignore_gpiodvs_side_effect = true;
999 if (of_property_read_u32_array(pmic_np,
1000 "max8997,pmic-buck1-dvs-voltage",
1001 pdata->buck1_voltage, dvs_voltage_nr)) {
1002 dev_err(iodev->dev, "buck1 voltages not specified\n");
1006 if (of_property_read_u32_array(pmic_np,
1007 "max8997,pmic-buck2-dvs-voltage",
1008 pdata->buck2_voltage, dvs_voltage_nr)) {
1009 dev_err(iodev->dev, "buck2 voltages not specified\n");
1013 if (of_property_read_u32_array(pmic_np,
1014 "max8997,pmic-buck5-dvs-voltage",
1015 pdata->buck5_voltage, dvs_voltage_nr)) {
1016 dev_err(iodev->dev, "buck5 voltages not specified\n");
1023 static int max8997_pmic_dt_parse_pdata(struct max8997_dev *iodev,
1024 struct max8997_platform_data *pdata)
1028 #endif /* CONFIG_OF */
1030 static int max8997_pmic_probe(struct platform_device *pdev)
1032 struct max8997_dev *iodev = dev_get_drvdata(pdev->dev.parent);
1033 struct max8997_platform_data *pdata = iodev->pdata;
1034 struct regulator_config config = { };
1035 struct regulator_dev **rdev;
1036 struct max8997_data *max8997;
1037 struct i2c_client *i2c;
1038 int i, ret, size, nr_dvs;
1039 u8 max_buck1 = 0, max_buck2 = 0, max_buck5 = 0;
1041 if (IS_ERR_OR_NULL(pdata)) {
1042 dev_err(pdev->dev.parent, "No platform init data supplied.\n");
1046 if (iodev->dev->of_node) {
1047 ret = max8997_pmic_dt_parse_pdata(iodev, pdata);
1052 max8997 = devm_kzalloc(&pdev->dev, sizeof(struct max8997_data),
1057 size = sizeof(struct regulator_dev *) * pdata->num_regulators;
1058 max8997->rdev = devm_kzalloc(&pdev->dev, size, GFP_KERNEL);
1062 rdev = max8997->rdev;
1063 max8997->dev = &pdev->dev;
1064 max8997->iodev = iodev;
1065 max8997->num_regulators = pdata->num_regulators;
1066 platform_set_drvdata(pdev, max8997);
1067 i2c = max8997->iodev->i2c;
1069 max8997->buck125_gpioindex = pdata->buck125_default_idx;
1070 max8997->buck1_gpiodvs = pdata->buck1_gpiodvs;
1071 max8997->buck2_gpiodvs = pdata->buck2_gpiodvs;
1072 max8997->buck5_gpiodvs = pdata->buck5_gpiodvs;
1073 memcpy(max8997->buck125_gpios, pdata->buck125_gpios, sizeof(int) * 3);
1074 max8997->ignore_gpiodvs_side_effect = pdata->ignore_gpiodvs_side_effect;
1076 nr_dvs = (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
1077 pdata->buck5_gpiodvs) ? 8 : 1;
1079 for (i = 0; i < nr_dvs; i++) {
1080 max8997->buck1_vol[i] = ret =
1081 max8997_get_voltage_proper_val(
1082 &buck1245_voltage_map_desc,
1083 pdata->buck1_voltage[i] / 1000,
1084 pdata->buck1_voltage[i] / 1000 +
1085 buck1245_voltage_map_desc.step);
1089 max8997->buck2_vol[i] = ret =
1090 max8997_get_voltage_proper_val(
1091 &buck1245_voltage_map_desc,
1092 pdata->buck2_voltage[i] / 1000,
1093 pdata->buck2_voltage[i] / 1000 +
1094 buck1245_voltage_map_desc.step);
1098 max8997->buck5_vol[i] = ret =
1099 max8997_get_voltage_proper_val(
1100 &buck1245_voltage_map_desc,
1101 pdata->buck5_voltage[i] / 1000,
1102 pdata->buck5_voltage[i] / 1000 +
1103 buck1245_voltage_map_desc.step);
1107 if (max_buck1 < max8997->buck1_vol[i])
1108 max_buck1 = max8997->buck1_vol[i];
1109 if (max_buck2 < max8997->buck2_vol[i])
1110 max_buck2 = max8997->buck2_vol[i];
1111 if (max_buck5 < max8997->buck5_vol[i])
1112 max_buck5 = max8997->buck5_vol[i];
1115 /* For the safety, set max voltage before setting up */
1116 for (i = 0; i < 8; i++) {
1117 max8997_update_reg(i2c, MAX8997_REG_BUCK1DVS1 + i,
1119 max8997_update_reg(i2c, MAX8997_REG_BUCK2DVS1 + i,
1121 max8997_update_reg(i2c, MAX8997_REG_BUCK5DVS1 + i,
1125 /* Initialize all the DVS related BUCK registers */
1126 for (i = 0; i < nr_dvs; i++) {
1127 max8997_update_reg(i2c, MAX8997_REG_BUCK1DVS1 + i,
1128 max8997->buck1_vol[i],
1130 max8997_update_reg(i2c, MAX8997_REG_BUCK2DVS1 + i,
1131 max8997->buck2_vol[i],
1133 max8997_update_reg(i2c, MAX8997_REG_BUCK5DVS1 + i,
1134 max8997->buck5_vol[i],
1139 * If buck 1, 2, and 5 do not care DVS GPIO settings, ignore them.
1140 * If at least one of them cares, set gpios.
1142 if (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
1143 pdata->buck5_gpiodvs) {
1145 if (!gpio_is_valid(pdata->buck125_gpios[0]) ||
1146 !gpio_is_valid(pdata->buck125_gpios[1]) ||
1147 !gpio_is_valid(pdata->buck125_gpios[2])) {
1148 dev_err(&pdev->dev, "GPIO NOT VALID\n");
1153 ret = devm_gpio_request(&pdev->dev, pdata->buck125_gpios[0],
1158 ret = devm_gpio_request(&pdev->dev, pdata->buck125_gpios[1],
1163 ret = devm_gpio_request(&pdev->dev, pdata->buck125_gpios[2],
1168 gpio_direction_output(pdata->buck125_gpios[0],
1169 (max8997->buck125_gpioindex >> 2)
1171 gpio_direction_output(pdata->buck125_gpios[1],
1172 (max8997->buck125_gpioindex >> 1)
1174 gpio_direction_output(pdata->buck125_gpios[2],
1175 (max8997->buck125_gpioindex >> 0)
1179 /* DVS-GPIO disabled */
1180 max8997_update_reg(i2c, MAX8997_REG_BUCK1CTRL, (pdata->buck1_gpiodvs) ?
1181 (1 << 1) : (0 << 1), 1 << 1);
1182 max8997_update_reg(i2c, MAX8997_REG_BUCK2CTRL, (pdata->buck2_gpiodvs) ?
1183 (1 << 1) : (0 << 1), 1 << 1);
1184 max8997_update_reg(i2c, MAX8997_REG_BUCK5CTRL, (pdata->buck5_gpiodvs) ?
1185 (1 << 1) : (0 << 1), 1 << 1);
1188 max8997->ramp_delay = 10; /* set 10mV/us, which is the default */
1189 max8997_write_reg(i2c, MAX8997_REG_BUCKRAMP, (0xf << 4) | 0x9);
1191 for (i = 0; i < pdata->num_regulators; i++) {
1192 const struct voltage_map_desc *desc;
1193 int id = pdata->regulators[i].id;
1195 desc = reg_voltage_map[id];
1197 regulators[id].n_voltages =
1198 (desc->max - desc->min) / desc->step + 1;
1199 } else if (id == MAX8997_ESAFEOUT1 || id == MAX8997_ESAFEOUT2) {
1200 regulators[id].volt_table = safeoutvolt;
1201 regulators[id].n_voltages = ARRAY_SIZE(safeoutvolt);
1202 } else if (id == MAX8997_CHARGER_CV) {
1203 regulators[id].n_voltages = 16;
1206 config.dev = max8997->dev;
1207 config.init_data = pdata->regulators[i].initdata;
1208 config.driver_data = max8997;
1209 config.of_node = pdata->regulators[i].reg_node;
1211 rdev[i] = regulator_register(®ulators[id], &config);
1212 if (IS_ERR(rdev[i])) {
1213 ret = PTR_ERR(rdev[i]);
1214 dev_err(max8997->dev, "regulator init failed for %d\n",
1224 regulator_unregister(rdev[i]);
1229 static int max8997_pmic_remove(struct platform_device *pdev)
1231 struct max8997_data *max8997 = platform_get_drvdata(pdev);
1232 struct regulator_dev **rdev = max8997->rdev;
1235 for (i = 0; i < max8997->num_regulators; i++)
1236 regulator_unregister(rdev[i]);
1240 static const struct platform_device_id max8997_pmic_id[] = {
1241 { "max8997-pmic", 0},
1244 MODULE_DEVICE_TABLE(platform, max8997_pmic_id);
1246 static struct platform_driver max8997_pmic_driver = {
1248 .name = "max8997-pmic",
1249 .owner = THIS_MODULE,
1251 .probe = max8997_pmic_probe,
1252 .remove = max8997_pmic_remove,
1253 .id_table = max8997_pmic_id,
1256 static int __init max8997_pmic_init(void)
1258 return platform_driver_register(&max8997_pmic_driver);
1260 subsys_initcall(max8997_pmic_init);
1262 static void __exit max8997_pmic_cleanup(void)
1264 platform_driver_unregister(&max8997_pmic_driver);
1266 module_exit(max8997_pmic_cleanup);
1268 MODULE_DESCRIPTION("MAXIM 8997/8966 Regulator Driver");
1269 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1270 MODULE_LICENSE("GPL");