2 * max8997.c - Regulator driver for the Maxim 8997/8966
4 * Copyright (C) 2011 Samsung Electronics
5 * MyungJoo Ham <myungjoo.ham@samsung.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 int ramp_delay; /* in mV/us */
50 int buck125_gpioindex;
51 bool ignore_gpiodvs_side_effect;
53 u8 saved_states[MAX8997_REG_MAX];
56 static const unsigned int safeoutvolt[] = {
63 static inline void max8997_set_gpio(struct max8997_data *max8997)
65 int set3 = (max8997->buck125_gpioindex) & 0x1;
66 int set2 = ((max8997->buck125_gpioindex) >> 1) & 0x1;
67 int set1 = ((max8997->buck125_gpioindex) >> 2) & 0x1;
69 gpio_set_value(max8997->buck125_gpios[0], set1);
70 gpio_set_value(max8997->buck125_gpios[1], set2);
71 gpio_set_value(max8997->buck125_gpios[2], set3);
74 struct voltage_map_desc {
80 /* Voltage maps in uV */
81 static const struct voltage_map_desc ldo_voltage_map_desc = {
82 .min = 800000, .max = 3950000, .step = 50000,
83 }; /* LDO1 ~ 18, 21 all */
85 static const struct voltage_map_desc buck1245_voltage_map_desc = {
86 .min = 650000, .max = 2225000, .step = 25000,
87 }; /* Buck1, 2, 4, 5 */
89 static const struct voltage_map_desc buck37_voltage_map_desc = {
90 .min = 750000, .max = 3900000, .step = 50000,
93 /* current map in uA */
94 static const struct voltage_map_desc charger_current_map_desc = {
95 .min = 200000, .max = 950000, .step = 50000,
98 static const struct voltage_map_desc topoff_current_map_desc = {
99 .min = 50000, .max = 200000, .step = 10000,
102 static const struct voltage_map_desc *reg_voltage_map[] = {
103 [MAX8997_LDO1] = &ldo_voltage_map_desc,
104 [MAX8997_LDO2] = &ldo_voltage_map_desc,
105 [MAX8997_LDO3] = &ldo_voltage_map_desc,
106 [MAX8997_LDO4] = &ldo_voltage_map_desc,
107 [MAX8997_LDO5] = &ldo_voltage_map_desc,
108 [MAX8997_LDO6] = &ldo_voltage_map_desc,
109 [MAX8997_LDO7] = &ldo_voltage_map_desc,
110 [MAX8997_LDO8] = &ldo_voltage_map_desc,
111 [MAX8997_LDO9] = &ldo_voltage_map_desc,
112 [MAX8997_LDO10] = &ldo_voltage_map_desc,
113 [MAX8997_LDO11] = &ldo_voltage_map_desc,
114 [MAX8997_LDO12] = &ldo_voltage_map_desc,
115 [MAX8997_LDO13] = &ldo_voltage_map_desc,
116 [MAX8997_LDO14] = &ldo_voltage_map_desc,
117 [MAX8997_LDO15] = &ldo_voltage_map_desc,
118 [MAX8997_LDO16] = &ldo_voltage_map_desc,
119 [MAX8997_LDO17] = &ldo_voltage_map_desc,
120 [MAX8997_LDO18] = &ldo_voltage_map_desc,
121 [MAX8997_LDO21] = &ldo_voltage_map_desc,
122 [MAX8997_BUCK1] = &buck1245_voltage_map_desc,
123 [MAX8997_BUCK2] = &buck1245_voltage_map_desc,
124 [MAX8997_BUCK3] = &buck37_voltage_map_desc,
125 [MAX8997_BUCK4] = &buck1245_voltage_map_desc,
126 [MAX8997_BUCK5] = &buck1245_voltage_map_desc,
127 [MAX8997_BUCK6] = NULL,
128 [MAX8997_BUCK7] = &buck37_voltage_map_desc,
129 [MAX8997_EN32KHZ_AP] = NULL,
130 [MAX8997_EN32KHZ_CP] = NULL,
131 [MAX8997_ENVICHG] = NULL,
132 [MAX8997_ESAFEOUT1] = NULL,
133 [MAX8997_ESAFEOUT2] = NULL,
134 [MAX8997_CHARGER_CV] = NULL,
135 [MAX8997_CHARGER] = &charger_current_map_desc,
136 [MAX8997_CHARGER_TOPOFF] = &topoff_current_map_desc,
139 static int max8997_list_voltage_charger_cv(struct regulator_dev *rdev,
140 unsigned int selector)
142 int rid = rdev_get_id(rdev);
144 if (rid != MAX8997_CHARGER_CV)
151 return 4000000 + 20000 * (selector - 0x01);
161 static int max8997_list_voltage(struct regulator_dev *rdev,
162 unsigned int selector)
164 const struct voltage_map_desc *desc;
165 int rid = rdev_get_id(rdev);
168 if (rid < 0 || rid >= ARRAY_SIZE(reg_voltage_map))
171 desc = reg_voltage_map[rid];
175 val = desc->min + desc->step * selector;
182 static int max8997_get_enable_register(struct regulator_dev *rdev,
183 int *reg, int *mask, int *pattern)
185 int rid = rdev_get_id(rdev);
188 case MAX8997_LDO1 ... MAX8997_LDO21:
189 *reg = MAX8997_REG_LDO1CTRL + (rid - MAX8997_LDO1);
194 *reg = MAX8997_REG_BUCK1CTRL;
199 *reg = MAX8997_REG_BUCK2CTRL;
204 *reg = MAX8997_REG_BUCK3CTRL;
209 *reg = MAX8997_REG_BUCK4CTRL;
214 *reg = MAX8997_REG_BUCK5CTRL;
219 *reg = MAX8997_REG_BUCK6CTRL;
224 *reg = MAX8997_REG_BUCK7CTRL;
228 case MAX8997_EN32KHZ_AP ... MAX8997_EN32KHZ_CP:
229 *reg = MAX8997_REG_MAINCON1;
230 *mask = 0x01 << (rid - MAX8997_EN32KHZ_AP);
231 *pattern = 0x01 << (rid - MAX8997_EN32KHZ_AP);
233 case MAX8997_ENVICHG:
234 *reg = MAX8997_REG_MBCCTRL1;
238 case MAX8997_ESAFEOUT1 ... MAX8997_ESAFEOUT2:
239 *reg = MAX8997_REG_SAFEOUTCTRL;
240 *mask = 0x40 << (rid - MAX8997_ESAFEOUT1);
241 *pattern = 0x40 << (rid - MAX8997_ESAFEOUT1);
243 case MAX8997_CHARGER:
244 *reg = MAX8997_REG_MBCCTRL2;
249 /* Not controllable or not exists */
256 static int max8997_reg_is_enabled(struct regulator_dev *rdev)
258 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
259 struct i2c_client *i2c = max8997->iodev->i2c;
260 int ret, reg, mask, pattern;
263 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
267 ret = max8997_read_reg(i2c, reg, &val);
271 return (val & mask) == pattern;
274 static int max8997_reg_enable(struct regulator_dev *rdev)
276 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
277 struct i2c_client *i2c = max8997->iodev->i2c;
278 int ret, reg, mask, pattern;
280 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
284 return max8997_update_reg(i2c, reg, pattern, mask);
287 static int max8997_reg_disable(struct regulator_dev *rdev)
289 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
290 struct i2c_client *i2c = max8997->iodev->i2c;
291 int ret, reg, mask, pattern;
293 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
297 return max8997_update_reg(i2c, reg, ~pattern, mask);
300 static int max8997_get_voltage_register(struct regulator_dev *rdev,
301 int *_reg, int *_shift, int *_mask)
303 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
304 int rid = rdev_get_id(rdev);
305 int reg, shift = 0, mask = 0x3f;
308 case MAX8997_LDO1 ... MAX8997_LDO21:
309 reg = MAX8997_REG_LDO1CTRL + (rid - MAX8997_LDO1);
312 reg = MAX8997_REG_BUCK1DVS1;
313 if (max8997->buck1_gpiodvs)
314 reg += max8997->buck125_gpioindex;
317 reg = MAX8997_REG_BUCK2DVS1;
318 if (max8997->buck2_gpiodvs)
319 reg += max8997->buck125_gpioindex;
322 reg = MAX8997_REG_BUCK3DVS;
325 reg = MAX8997_REG_BUCK4DVS;
328 reg = MAX8997_REG_BUCK5DVS1;
329 if (max8997->buck5_gpiodvs)
330 reg += max8997->buck125_gpioindex;
333 reg = MAX8997_REG_BUCK7DVS;
335 case MAX8997_ESAFEOUT1 ... MAX8997_ESAFEOUT2:
336 reg = MAX8997_REG_SAFEOUTCTRL;
337 shift = (rid == MAX8997_ESAFEOUT2) ? 2 : 0;
340 case MAX8997_CHARGER_CV:
341 reg = MAX8997_REG_MBCCTRL3;
345 case MAX8997_CHARGER:
346 reg = MAX8997_REG_MBCCTRL4;
350 case MAX8997_CHARGER_TOPOFF:
351 reg = MAX8997_REG_MBCCTRL5;
366 static int max8997_get_voltage_sel(struct regulator_dev *rdev)
368 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
369 struct i2c_client *i2c = max8997->iodev->i2c;
370 int reg, shift, mask, ret;
373 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
377 ret = max8997_read_reg(i2c, reg, &val);
387 static inline int max8997_get_voltage_proper_val(
388 const struct voltage_map_desc *desc,
389 int min_vol, int max_vol)
396 if (max_vol < desc->min || min_vol > desc->max)
399 if (min_vol < desc->min)
402 i = DIV_ROUND_UP(min_vol - desc->min, desc->step);
404 if (desc->min + desc->step * i > max_vol)
410 static int max8997_set_voltage_charger_cv(struct regulator_dev *rdev,
411 int min_uV, int max_uV, unsigned *selector)
413 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
414 struct i2c_client *i2c = max8997->iodev->i2c;
415 int rid = rdev_get_id(rdev);
417 int reg, shift = 0, mask, ret = 0;
420 if (rid != MAX8997_CHARGER_CV)
423 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
427 if (max_uV < 4000000 || min_uV > 4350000)
430 if (min_uV <= 4000000)
432 else if (min_uV <= 4200000 && max_uV >= 4200000)
435 lb = (min_uV - 4000001) / 20000 + 2;
436 ub = (max_uV - 4000000) / 20000 + 1;
453 ret = max8997_update_reg(i2c, reg, val << shift, mask);
459 * For LDO1 ~ LDO21, BUCK1~5, BUCK7, CHARGER, CHARGER_TOPOFF
460 * BUCK1, 2, and 5 are available if they are not controlled by gpio
462 static int max8997_set_voltage_ldobuck(struct regulator_dev *rdev,
463 int min_uV, int max_uV, unsigned *selector)
465 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
466 struct i2c_client *i2c = max8997->iodev->i2c;
467 const struct voltage_map_desc *desc;
468 int rid = rdev_get_id(rdev);
469 int i, reg, shift, mask, ret;
472 case MAX8997_LDO1 ... MAX8997_LDO21:
474 case MAX8997_BUCK1 ... MAX8997_BUCK5:
480 case MAX8997_CHARGER:
482 case MAX8997_CHARGER_TOPOFF:
488 desc = reg_voltage_map[rid];
490 i = max8997_get_voltage_proper_val(desc, min_uV, max_uV);
494 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
498 ret = max8997_update_reg(i2c, reg, i << shift, mask << shift);
504 static int max8997_set_voltage_buck_time_sel(struct regulator_dev *rdev,
505 unsigned int old_selector,
506 unsigned int new_selector)
508 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
509 int rid = rdev_get_id(rdev);
510 const struct voltage_map_desc *desc = reg_voltage_map[rid];
512 /* Delay is required only if the voltage is increasing */
513 if (old_selector >= new_selector)
516 /* No need to delay if gpio_dvs_mode */
519 if (max8997->buck1_gpiodvs)
523 if (max8997->buck2_gpiodvs)
527 if (max8997->buck5_gpiodvs)
537 return DIV_ROUND_UP(desc->step * (new_selector - old_selector),
538 max8997->ramp_delay * 1000);
545 * Assess the damage on the voltage setting of BUCK1,2,5 by the change.
547 * When GPIO-DVS mode is used for multiple bucks, changing the voltage value
548 * of one of the bucks may affect that of another buck, which is the side
549 * effect of the change (set_voltage). This function examines the GPIO-DVS
550 * configurations and checks whether such side-effect exists.
552 static int max8997_assess_side_effect(struct regulator_dev *rdev,
553 u8 new_val, int *best)
555 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
556 int rid = rdev_get_id(rdev);
558 bool buckx_gpiodvs[3];
560 int min_side_effect = INT_MAX;
579 buckx_val[0] = max8997->buck1_vol;
580 buckx_val[1] = max8997->buck2_vol;
581 buckx_val[2] = max8997->buck5_vol;
582 buckx_gpiodvs[0] = max8997->buck1_gpiodvs;
583 buckx_gpiodvs[1] = max8997->buck2_gpiodvs;
584 buckx_gpiodvs[2] = max8997->buck5_gpiodvs;
586 for (i = 0; i < 8; i++) {
589 if (new_val != (buckx_val[rid])[i]) {
595 for (others = 0; others < 3; others++) {
600 if (buckx_gpiodvs[others] == false)
601 continue; /* Not affected */
602 diff = (buckx_val[others])[i] -
603 (buckx_val[others])[max8997->buck125_gpioindex];
605 side_effect[i] += diff;
607 side_effect[i] -= diff;
609 if (side_effect[i] == 0) {
611 return 0; /* NO SIDE EFFECT! Use This! */
613 if (side_effect[i] < min_side_effect) {
614 min_side_effect = side_effect[i];
622 return side_effect[*best];
626 * For Buck 1 ~ 5 and 7. If it is not controlled by GPIO, this calls
627 * max8997_set_voltage_ldobuck to do the job.
629 static int max8997_set_voltage_buck(struct regulator_dev *rdev,
630 int min_uV, int max_uV, unsigned *selector)
632 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
633 int rid = rdev_get_id(rdev);
634 const struct voltage_map_desc *desc;
635 int new_val, new_idx, damage, tmp_val, tmp_idx, tmp_dmg;
636 bool gpio_dvs_mode = false;
638 if (rid < MAX8997_BUCK1 || rid > MAX8997_BUCK7)
643 if (max8997->buck1_gpiodvs)
644 gpio_dvs_mode = true;
647 if (max8997->buck2_gpiodvs)
648 gpio_dvs_mode = true;
651 if (max8997->buck5_gpiodvs)
652 gpio_dvs_mode = true;
657 return max8997_set_voltage_ldobuck(rdev, min_uV, max_uV,
660 desc = reg_voltage_map[rid];
661 new_val = max8997_get_voltage_proper_val(desc, min_uV, max_uV);
669 damage = max8997_assess_side_effect(rdev, new_val, &new_idx);
673 if (tmp_dmg > damage) {
680 } while (desc->min + desc->step * new_val <= desc->max);
685 if (max8997->ignore_gpiodvs_side_effect == false)
689 "MAX8997 GPIO-DVS Side Effect Warning: GPIO SET: %d -> %d\n",
690 max8997->buck125_gpioindex, tmp_idx);
693 if (new_idx < 0 || new_val < 0)
696 max8997->buck125_gpioindex = new_idx;
697 max8997_set_gpio(max8997);
703 /* For SAFEOUT1 and SAFEOUT2 */
704 static int max8997_set_voltage_safeout_sel(struct regulator_dev *rdev,
707 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
708 struct i2c_client *i2c = max8997->iodev->i2c;
709 int rid = rdev_get_id(rdev);
710 int reg, shift = 0, mask, ret;
712 if (rid != MAX8997_ESAFEOUT1 && rid != MAX8997_ESAFEOUT2)
715 ret = max8997_get_voltage_register(rdev, ®, &shift, &mask);
719 return max8997_update_reg(i2c, reg, selector << shift, mask << shift);
722 static int max8997_reg_disable_suspend(struct regulator_dev *rdev)
724 struct max8997_data *max8997 = rdev_get_drvdata(rdev);
725 struct i2c_client *i2c = max8997->iodev->i2c;
726 int ret, reg, mask, pattern;
727 int rid = rdev_get_id(rdev);
729 ret = max8997_get_enable_register(rdev, ®, &mask, &pattern);
733 max8997_read_reg(i2c, reg, &max8997->saved_states[rid]);
735 if (rid == MAX8997_LDO1 ||
736 rid == MAX8997_LDO10 ||
737 rid == MAX8997_LDO21) {
738 dev_dbg(&rdev->dev, "Conditional Power-Off for %s\n",
740 return max8997_update_reg(i2c, reg, 0x40, mask);
743 dev_dbg(&rdev->dev, "Full Power-Off for %s (%xh -> %xh)\n",
744 rdev->desc->name, max8997->saved_states[rid] & mask,
746 return max8997_update_reg(i2c, reg, ~pattern, mask);
749 static struct regulator_ops max8997_ldo_ops = {
750 .list_voltage = max8997_list_voltage,
751 .is_enabled = max8997_reg_is_enabled,
752 .enable = max8997_reg_enable,
753 .disable = max8997_reg_disable,
754 .get_voltage_sel = max8997_get_voltage_sel,
755 .set_voltage = max8997_set_voltage_ldobuck,
756 .set_suspend_disable = max8997_reg_disable_suspend,
759 static struct regulator_ops max8997_buck_ops = {
760 .list_voltage = max8997_list_voltage,
761 .is_enabled = max8997_reg_is_enabled,
762 .enable = max8997_reg_enable,
763 .disable = max8997_reg_disable,
764 .get_voltage_sel = max8997_get_voltage_sel,
765 .set_voltage = max8997_set_voltage_buck,
766 .set_voltage_time_sel = max8997_set_voltage_buck_time_sel,
767 .set_suspend_disable = max8997_reg_disable_suspend,
770 static struct regulator_ops max8997_fixedvolt_ops = {
771 .list_voltage = max8997_list_voltage,
772 .is_enabled = max8997_reg_is_enabled,
773 .enable = max8997_reg_enable,
774 .disable = max8997_reg_disable,
775 .set_suspend_disable = max8997_reg_disable_suspend,
778 static struct regulator_ops max8997_safeout_ops = {
779 .list_voltage = regulator_list_voltage_table,
780 .is_enabled = max8997_reg_is_enabled,
781 .enable = max8997_reg_enable,
782 .disable = max8997_reg_disable,
783 .get_voltage_sel = max8997_get_voltage_sel,
784 .set_voltage_sel = max8997_set_voltage_safeout_sel,
785 .set_suspend_disable = max8997_reg_disable_suspend,
788 static struct regulator_ops max8997_fixedstate_ops = {
789 .list_voltage = max8997_list_voltage_charger_cv,
790 .get_voltage_sel = max8997_get_voltage_sel,
791 .set_voltage = max8997_set_voltage_charger_cv,
794 static int max8997_set_current_limit(struct regulator_dev *rdev,
795 int min_uA, int max_uA)
798 int rid = rdev_get_id(rdev);
800 if (rid != MAX8997_CHARGER && rid != MAX8997_CHARGER_TOPOFF)
803 /* Reuse max8997_set_voltage_ldobuck to set current_limit. */
804 return max8997_set_voltage_ldobuck(rdev, min_uA, max_uA, &dummy);
807 static int max8997_get_current_limit(struct regulator_dev *rdev)
809 int sel, rid = rdev_get_id(rdev);
811 if (rid != MAX8997_CHARGER && rid != MAX8997_CHARGER_TOPOFF)
814 sel = max8997_get_voltage_sel(rdev);
818 /* Reuse max8997_list_voltage to get current_limit. */
819 return max8997_list_voltage(rdev, sel);
822 static struct regulator_ops max8997_charger_ops = {
823 .is_enabled = max8997_reg_is_enabled,
824 .enable = max8997_reg_enable,
825 .disable = max8997_reg_disable,
826 .get_current_limit = max8997_get_current_limit,
827 .set_current_limit = max8997_set_current_limit,
830 static struct regulator_ops max8997_charger_fixedstate_ops = {
831 .get_current_limit = max8997_get_current_limit,
832 .set_current_limit = max8997_set_current_limit,
835 #define MAX8997_VOLTAGE_REGULATOR(_name, _ops) {\
837 .id = MAX8997_##_name, \
839 .type = REGULATOR_VOLTAGE, \
840 .owner = THIS_MODULE, \
843 #define MAX8997_CURRENT_REGULATOR(_name, _ops) {\
845 .id = MAX8997_##_name, \
847 .type = REGULATOR_CURRENT, \
848 .owner = THIS_MODULE, \
851 static struct regulator_desc regulators[] = {
852 MAX8997_VOLTAGE_REGULATOR(LDO1, max8997_ldo_ops),
853 MAX8997_VOLTAGE_REGULATOR(LDO2, max8997_ldo_ops),
854 MAX8997_VOLTAGE_REGULATOR(LDO3, max8997_ldo_ops),
855 MAX8997_VOLTAGE_REGULATOR(LDO4, max8997_ldo_ops),
856 MAX8997_VOLTAGE_REGULATOR(LDO5, max8997_ldo_ops),
857 MAX8997_VOLTAGE_REGULATOR(LDO6, max8997_ldo_ops),
858 MAX8997_VOLTAGE_REGULATOR(LDO7, max8997_ldo_ops),
859 MAX8997_VOLTAGE_REGULATOR(LDO8, max8997_ldo_ops),
860 MAX8997_VOLTAGE_REGULATOR(LDO9, max8997_ldo_ops),
861 MAX8997_VOLTAGE_REGULATOR(LDO10, max8997_ldo_ops),
862 MAX8997_VOLTAGE_REGULATOR(LDO11, max8997_ldo_ops),
863 MAX8997_VOLTAGE_REGULATOR(LDO12, max8997_ldo_ops),
864 MAX8997_VOLTAGE_REGULATOR(LDO13, max8997_ldo_ops),
865 MAX8997_VOLTAGE_REGULATOR(LDO14, max8997_ldo_ops),
866 MAX8997_VOLTAGE_REGULATOR(LDO15, max8997_ldo_ops),
867 MAX8997_VOLTAGE_REGULATOR(LDO16, max8997_ldo_ops),
868 MAX8997_VOLTAGE_REGULATOR(LDO17, max8997_ldo_ops),
869 MAX8997_VOLTAGE_REGULATOR(LDO18, max8997_ldo_ops),
870 MAX8997_VOLTAGE_REGULATOR(LDO21, max8997_ldo_ops),
871 MAX8997_VOLTAGE_REGULATOR(BUCK1, max8997_buck_ops),
872 MAX8997_VOLTAGE_REGULATOR(BUCK2, max8997_buck_ops),
873 MAX8997_VOLTAGE_REGULATOR(BUCK3, max8997_buck_ops),
874 MAX8997_VOLTAGE_REGULATOR(BUCK4, max8997_buck_ops),
875 MAX8997_VOLTAGE_REGULATOR(BUCK5, max8997_buck_ops),
876 MAX8997_VOLTAGE_REGULATOR(BUCK6, max8997_fixedvolt_ops),
877 MAX8997_VOLTAGE_REGULATOR(BUCK7, max8997_buck_ops),
878 MAX8997_VOLTAGE_REGULATOR(EN32KHZ_AP, max8997_fixedvolt_ops),
879 MAX8997_VOLTAGE_REGULATOR(EN32KHZ_CP, max8997_fixedvolt_ops),
880 MAX8997_VOLTAGE_REGULATOR(ENVICHG, max8997_fixedvolt_ops),
881 MAX8997_VOLTAGE_REGULATOR(ESAFEOUT1, max8997_safeout_ops),
882 MAX8997_VOLTAGE_REGULATOR(ESAFEOUT2, max8997_safeout_ops),
883 MAX8997_VOLTAGE_REGULATOR(CHARGER_CV, max8997_fixedstate_ops),
884 MAX8997_CURRENT_REGULATOR(CHARGER, max8997_charger_ops),
885 MAX8997_CURRENT_REGULATOR(CHARGER_TOPOFF,
886 max8997_charger_fixedstate_ops),
890 static int max8997_pmic_dt_parse_dvs_gpio(struct platform_device *pdev,
891 struct max8997_platform_data *pdata,
892 struct device_node *pmic_np)
896 for (i = 0; i < 3; i++) {
897 gpio = of_get_named_gpio(pmic_np,
898 "max8997,pmic-buck125-dvs-gpios", i);
899 if (!gpio_is_valid(gpio)) {
900 dev_err(&pdev->dev, "invalid gpio[%d]: %d\n", i, gpio);
903 pdata->buck125_gpios[i] = gpio;
908 static int max8997_pmic_dt_parse_pdata(struct platform_device *pdev,
909 struct max8997_platform_data *pdata)
911 struct max8997_dev *iodev = dev_get_drvdata(pdev->dev.parent);
912 struct device_node *pmic_np, *regulators_np, *reg_np;
913 struct max8997_regulator_data *rdata;
914 unsigned int i, dvs_voltage_nr = 1, ret;
916 pmic_np = iodev->dev->of_node;
918 dev_err(&pdev->dev, "could not find pmic sub-node\n");
922 regulators_np = of_get_child_by_name(pmic_np, "regulators");
923 if (!regulators_np) {
924 dev_err(&pdev->dev, "could not find regulators sub-node\n");
928 /* count the number of regulators to be supported in pmic */
929 pdata->num_regulators = of_get_child_count(regulators_np);
931 rdata = devm_kcalloc(&pdev->dev,
932 pdata->num_regulators, sizeof(*rdata),
935 of_node_put(regulators_np);
939 pdata->regulators = rdata;
940 for_each_child_of_node(regulators_np, reg_np) {
941 for (i = 0; i < ARRAY_SIZE(regulators); i++)
942 if (!of_node_cmp(reg_np->name, regulators[i].name))
945 if (i == ARRAY_SIZE(regulators)) {
946 dev_warn(&pdev->dev, "don't know how to configure regulator %s\n",
952 rdata->initdata = of_get_regulator_init_data(&pdev->dev,
955 rdata->reg_node = reg_np;
958 of_node_put(regulators_np);
960 if (of_get_property(pmic_np, "max8997,pmic-buck1-uses-gpio-dvs", NULL))
961 pdata->buck1_gpiodvs = true;
963 if (of_get_property(pmic_np, "max8997,pmic-buck2-uses-gpio-dvs", NULL))
964 pdata->buck2_gpiodvs = true;
966 if (of_get_property(pmic_np, "max8997,pmic-buck5-uses-gpio-dvs", NULL))
967 pdata->buck5_gpiodvs = true;
969 if (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
970 pdata->buck5_gpiodvs) {
971 ret = max8997_pmic_dt_parse_dvs_gpio(pdev, pdata, pmic_np);
975 if (of_property_read_u32(pmic_np,
976 "max8997,pmic-buck125-default-dvs-idx",
977 &pdata->buck125_default_idx)) {
978 pdata->buck125_default_idx = 0;
980 if (pdata->buck125_default_idx >= 8) {
981 pdata->buck125_default_idx = 0;
982 dev_info(&pdev->dev, "invalid value for default dvs index, using 0 instead\n");
986 if (of_get_property(pmic_np,
987 "max8997,pmic-ignore-gpiodvs-side-effect", NULL))
988 pdata->ignore_gpiodvs_side_effect = true;
993 if (of_property_read_u32_array(pmic_np,
994 "max8997,pmic-buck1-dvs-voltage",
995 pdata->buck1_voltage, dvs_voltage_nr)) {
996 dev_err(&pdev->dev, "buck1 voltages not specified\n");
1000 if (of_property_read_u32_array(pmic_np,
1001 "max8997,pmic-buck2-dvs-voltage",
1002 pdata->buck2_voltage, dvs_voltage_nr)) {
1003 dev_err(&pdev->dev, "buck2 voltages not specified\n");
1007 if (of_property_read_u32_array(pmic_np,
1008 "max8997,pmic-buck5-dvs-voltage",
1009 pdata->buck5_voltage, dvs_voltage_nr)) {
1010 dev_err(&pdev->dev, "buck5 voltages not specified\n");
1017 static int max8997_pmic_dt_parse_pdata(struct platform_device *pdev,
1018 struct max8997_platform_data *pdata)
1022 #endif /* CONFIG_OF */
1024 static int max8997_pmic_probe(struct platform_device *pdev)
1026 struct max8997_dev *iodev = dev_get_drvdata(pdev->dev.parent);
1027 struct max8997_platform_data *pdata = iodev->pdata;
1028 struct regulator_config config = { };
1029 struct regulator_dev *rdev;
1030 struct max8997_data *max8997;
1031 struct i2c_client *i2c;
1033 u8 max_buck1 = 0, max_buck2 = 0, max_buck5 = 0;
1036 dev_err(&pdev->dev, "No platform init data supplied.\n");
1040 if (iodev->dev->of_node) {
1041 ret = max8997_pmic_dt_parse_pdata(pdev, pdata);
1046 max8997 = devm_kzalloc(&pdev->dev, sizeof(struct max8997_data),
1051 max8997->dev = &pdev->dev;
1052 max8997->iodev = iodev;
1053 max8997->num_regulators = pdata->num_regulators;
1054 platform_set_drvdata(pdev, max8997);
1055 i2c = max8997->iodev->i2c;
1057 max8997->buck125_gpioindex = pdata->buck125_default_idx;
1058 max8997->buck1_gpiodvs = pdata->buck1_gpiodvs;
1059 max8997->buck2_gpiodvs = pdata->buck2_gpiodvs;
1060 max8997->buck5_gpiodvs = pdata->buck5_gpiodvs;
1061 memcpy(max8997->buck125_gpios, pdata->buck125_gpios, sizeof(int) * 3);
1062 max8997->ignore_gpiodvs_side_effect = pdata->ignore_gpiodvs_side_effect;
1064 nr_dvs = (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
1065 pdata->buck5_gpiodvs) ? 8 : 1;
1067 for (i = 0; i < nr_dvs; i++) {
1068 max8997->buck1_vol[i] = ret =
1069 max8997_get_voltage_proper_val(
1070 &buck1245_voltage_map_desc,
1071 pdata->buck1_voltage[i],
1072 pdata->buck1_voltage[i] +
1073 buck1245_voltage_map_desc.step);
1077 max8997->buck2_vol[i] = ret =
1078 max8997_get_voltage_proper_val(
1079 &buck1245_voltage_map_desc,
1080 pdata->buck2_voltage[i],
1081 pdata->buck2_voltage[i] +
1082 buck1245_voltage_map_desc.step);
1086 max8997->buck5_vol[i] = ret =
1087 max8997_get_voltage_proper_val(
1088 &buck1245_voltage_map_desc,
1089 pdata->buck5_voltage[i],
1090 pdata->buck5_voltage[i] +
1091 buck1245_voltage_map_desc.step);
1095 if (max_buck1 < max8997->buck1_vol[i])
1096 max_buck1 = max8997->buck1_vol[i];
1097 if (max_buck2 < max8997->buck2_vol[i])
1098 max_buck2 = max8997->buck2_vol[i];
1099 if (max_buck5 < max8997->buck5_vol[i])
1100 max_buck5 = max8997->buck5_vol[i];
1103 /* For the safety, set max voltage before setting up */
1104 for (i = 0; i < 8; i++) {
1105 max8997_update_reg(i2c, MAX8997_REG_BUCK1DVS1 + i,
1107 max8997_update_reg(i2c, MAX8997_REG_BUCK2DVS1 + i,
1109 max8997_update_reg(i2c, MAX8997_REG_BUCK5DVS1 + i,
1113 /* Initialize all the DVS related BUCK registers */
1114 for (i = 0; i < nr_dvs; i++) {
1115 max8997_update_reg(i2c, MAX8997_REG_BUCK1DVS1 + i,
1116 max8997->buck1_vol[i],
1118 max8997_update_reg(i2c, MAX8997_REG_BUCK2DVS1 + i,
1119 max8997->buck2_vol[i],
1121 max8997_update_reg(i2c, MAX8997_REG_BUCK5DVS1 + i,
1122 max8997->buck5_vol[i],
1127 * If buck 1, 2, and 5 do not care DVS GPIO settings, ignore them.
1128 * If at least one of them cares, set gpios.
1130 if (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
1131 pdata->buck5_gpiodvs) {
1133 if (!gpio_is_valid(pdata->buck125_gpios[0]) ||
1134 !gpio_is_valid(pdata->buck125_gpios[1]) ||
1135 !gpio_is_valid(pdata->buck125_gpios[2])) {
1136 dev_err(&pdev->dev, "GPIO NOT VALID\n");
1140 ret = devm_gpio_request(&pdev->dev, pdata->buck125_gpios[0],
1145 ret = devm_gpio_request(&pdev->dev, pdata->buck125_gpios[1],
1150 ret = devm_gpio_request(&pdev->dev, pdata->buck125_gpios[2],
1155 gpio_direction_output(pdata->buck125_gpios[0],
1156 (max8997->buck125_gpioindex >> 2)
1158 gpio_direction_output(pdata->buck125_gpios[1],
1159 (max8997->buck125_gpioindex >> 1)
1161 gpio_direction_output(pdata->buck125_gpios[2],
1162 (max8997->buck125_gpioindex >> 0)
1166 /* DVS-GPIO disabled */
1167 max8997_update_reg(i2c, MAX8997_REG_BUCK1CTRL, (pdata->buck1_gpiodvs) ?
1168 (1 << 1) : (0 << 1), 1 << 1);
1169 max8997_update_reg(i2c, MAX8997_REG_BUCK2CTRL, (pdata->buck2_gpiodvs) ?
1170 (1 << 1) : (0 << 1), 1 << 1);
1171 max8997_update_reg(i2c, MAX8997_REG_BUCK5CTRL, (pdata->buck5_gpiodvs) ?
1172 (1 << 1) : (0 << 1), 1 << 1);
1175 max8997->ramp_delay = 10; /* set 10mV/us, which is the default */
1176 max8997_write_reg(i2c, MAX8997_REG_BUCKRAMP, (0xf << 4) | 0x9);
1178 for (i = 0; i < pdata->num_regulators; i++) {
1179 const struct voltage_map_desc *desc;
1180 int id = pdata->regulators[i].id;
1182 desc = reg_voltage_map[id];
1184 regulators[id].n_voltages =
1185 (desc->max - desc->min) / desc->step + 1;
1186 } else if (id == MAX8997_ESAFEOUT1 || id == MAX8997_ESAFEOUT2) {
1187 regulators[id].volt_table = safeoutvolt;
1188 regulators[id].n_voltages = ARRAY_SIZE(safeoutvolt);
1189 } else if (id == MAX8997_CHARGER_CV) {
1190 regulators[id].n_voltages = 16;
1193 config.dev = max8997->dev;
1194 config.init_data = pdata->regulators[i].initdata;
1195 config.driver_data = max8997;
1196 config.of_node = pdata->regulators[i].reg_node;
1198 rdev = devm_regulator_register(&pdev->dev, ®ulators[id],
1201 dev_err(max8997->dev, "regulator init failed for %d\n",
1203 return PTR_ERR(rdev);
1210 static const struct platform_device_id max8997_pmic_id[] = {
1211 { "max8997-pmic", 0},
1214 MODULE_DEVICE_TABLE(platform, max8997_pmic_id);
1216 static struct platform_driver max8997_pmic_driver = {
1218 .name = "max8997-pmic",
1220 .probe = max8997_pmic_probe,
1221 .id_table = max8997_pmic_id,
1224 static int __init max8997_pmic_init(void)
1226 return platform_driver_register(&max8997_pmic_driver);
1228 subsys_initcall(max8997_pmic_init);
1230 static void __exit max8997_pmic_cleanup(void)
1232 platform_driver_unregister(&max8997_pmic_driver);
1234 module_exit(max8997_pmic_cleanup);
1236 MODULE_DESCRIPTION("MAXIM 8997/8966 Regulator Driver");
1237 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1238 MODULE_LICENSE("GPL");