2 * max77686.c - Regulator driver for the Maxim 77686
4 * Copyright (C) 2012 Samsung Electronics
5 * Chiwoong Byun <woong.byun@smasung.com>
6 * Jonghwa Lee <jonghwa3.lee@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
22 * This driver is based on max8997.c
25 #include <linux/kernel.h>
26 #include <linux/bug.h>
27 #include <linux/err.h>
28 #include <linux/gpio.h>
29 #include <linux/slab.h>
30 #include <linux/platform_device.h>
31 #include <linux/regulator/driver.h>
32 #include <linux/regulator/machine.h>
33 #include <linux/regulator/of_regulator.h>
34 #include <linux/mfd/max77686.h>
35 #include <linux/mfd/max77686-private.h>
37 #define MAX77686_LDO_MINUV 800000
38 #define MAX77686_LDO_UVSTEP 50000
39 #define MAX77686_LDO_LOW_MINUV 800000
40 #define MAX77686_LDO_LOW_UVSTEP 25000
41 #define MAX77686_BUCK_MINUV 750000
42 #define MAX77686_BUCK_UVSTEP 50000
43 #define MAX77686_RAMP_DELAY 100000 /* uV/us */
44 #define MAX77686_DVS_RAMP_DELAY 27500 /* uV/us */
45 #define MAX77686_DVS_MINUV 600000
46 #define MAX77686_DVS_UVSTEP 12500
49 * Values used for configuring LDOs and bucks.
50 * Forcing low power mode: LDO1, 3-5, 9, 13, 17-26
52 #define MAX77686_LDO_LOWPOWER 0x1
54 * On/off controlled by PWRREQ:
55 * - LDO2, 6-8, 10-12, 14-16
58 #define MAX77686_OFF_PWRREQ 0x1
59 /* Low power mode controlled by PWRREQ: All LDOs */
60 #define MAX77686_LDO_LOWPOWER_PWRREQ 0x2
61 /* Forcing low power mode: buck[234] */
62 #define MAX77686_BUCK_LOWPOWER 0x2
63 #define MAX77686_NORMAL 0x3
65 #define MAX77686_OPMODE_SHIFT 6
66 #define MAX77686_OPMODE_BUCK234_SHIFT 4
67 #define MAX77686_OPMODE_MASK 0x3
69 #define MAX77686_VSEL_MASK 0x3F
70 #define MAX77686_DVS_VSEL_MASK 0xFF
72 #define MAX77686_RAMP_RATE_MASK 0xC0
74 #define MAX77686_REGULATORS MAX77686_REG_MAX
75 #define MAX77686_LDOS 26
77 enum max77686_ramp_rate {
81 RAMP_RATE_NO_CTRL, /* 100mV/us */
84 struct max77686_data {
85 unsigned int opmode[MAX77686_REGULATORS];
88 static unsigned int max77686_get_opmode_shift(int id)
92 case MAX77686_BUCK5 ... MAX77686_BUCK9:
94 case MAX77686_BUCK2 ... MAX77686_BUCK4:
95 return MAX77686_OPMODE_BUCK234_SHIFT;
98 return MAX77686_OPMODE_SHIFT;
102 /* Some BUCKs and LDOs supports Normal[ON/OFF] mode during suspend */
103 static int max77686_set_suspend_disable(struct regulator_dev *rdev)
105 unsigned int val, shift;
106 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
107 int ret, id = rdev_get_id(rdev);
109 shift = max77686_get_opmode_shift(id);
110 val = MAX77686_OFF_PWRREQ;
112 ret = regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
113 rdev->desc->enable_mask, val << shift);
117 max77686->opmode[id] = val;
121 /* Some LDOs supports [LPM/Normal]ON mode during suspend state */
122 static int max77686_set_suspend_mode(struct regulator_dev *rdev,
125 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
127 int ret, id = rdev_get_id(rdev);
129 /* BUCK[5-9] doesn't support this feature */
130 if (id >= MAX77686_BUCK5)
134 case REGULATOR_MODE_IDLE: /* ON in LP Mode */
135 val = MAX77686_LDO_LOWPOWER_PWRREQ;
137 case REGULATOR_MODE_NORMAL: /* ON in Normal Mode */
138 val = MAX77686_NORMAL;
141 pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
142 rdev->desc->name, mode);
146 ret = regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
147 rdev->desc->enable_mask,
148 val << MAX77686_OPMODE_SHIFT);
152 max77686->opmode[id] = val;
156 /* Some LDOs supports LPM-ON/OFF/Normal-ON mode during suspend state */
157 static int max77686_ldo_set_suspend_mode(struct regulator_dev *rdev,
161 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
165 case REGULATOR_MODE_STANDBY: /* switch off */
166 val = MAX77686_OFF_PWRREQ;
168 case REGULATOR_MODE_IDLE: /* ON in LP Mode */
169 val = MAX77686_LDO_LOWPOWER_PWRREQ;
171 case REGULATOR_MODE_NORMAL: /* ON in Normal Mode */
172 val = MAX77686_NORMAL;
175 pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
176 rdev->desc->name, mode);
180 ret = regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
181 rdev->desc->enable_mask,
182 val << MAX77686_OPMODE_SHIFT);
186 max77686->opmode[rdev_get_id(rdev)] = val;
190 static int max77686_enable(struct regulator_dev *rdev)
192 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
194 int id = rdev_get_id(rdev);
196 shift = max77686_get_opmode_shift(id);
198 if (max77686->opmode[id] == MAX77686_OFF_PWRREQ)
199 max77686->opmode[id] = MAX77686_NORMAL;
201 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
202 rdev->desc->enable_mask,
203 max77686->opmode[id] << shift);
206 static int max77686_set_ramp_delay(struct regulator_dev *rdev, int ramp_delay)
208 unsigned int ramp_value = RAMP_RATE_NO_CTRL;
210 switch (ramp_delay) {
212 ramp_value = RAMP_RATE_13P75MV;
214 case 13751 ... 27500:
215 ramp_value = RAMP_RATE_27P5MV;
217 case 27501 ... 55000:
218 ramp_value = RAMP_RATE_55MV;
220 case 55001 ... 100000:
223 pr_warn("%s: ramp_delay: %d not supported, setting 100000\n",
224 rdev->desc->name, ramp_delay);
227 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
228 MAX77686_RAMP_RATE_MASK, ramp_value << 6);
231 static struct regulator_ops max77686_ops = {
232 .list_voltage = regulator_list_voltage_linear,
233 .map_voltage = regulator_map_voltage_linear,
234 .is_enabled = regulator_is_enabled_regmap,
235 .enable = max77686_enable,
236 .disable = regulator_disable_regmap,
237 .get_voltage_sel = regulator_get_voltage_sel_regmap,
238 .set_voltage_sel = regulator_set_voltage_sel_regmap,
239 .set_voltage_time_sel = regulator_set_voltage_time_sel,
240 .set_suspend_mode = max77686_set_suspend_mode,
243 static struct regulator_ops max77686_ldo_ops = {
244 .list_voltage = regulator_list_voltage_linear,
245 .map_voltage = regulator_map_voltage_linear,
246 .is_enabled = regulator_is_enabled_regmap,
247 .enable = max77686_enable,
248 .disable = regulator_disable_regmap,
249 .get_voltage_sel = regulator_get_voltage_sel_regmap,
250 .set_voltage_sel = regulator_set_voltage_sel_regmap,
251 .set_voltage_time_sel = regulator_set_voltage_time_sel,
252 .set_suspend_mode = max77686_ldo_set_suspend_mode,
253 .set_suspend_disable = max77686_set_suspend_disable,
256 static struct regulator_ops max77686_buck1_ops = {
257 .list_voltage = regulator_list_voltage_linear,
258 .map_voltage = regulator_map_voltage_linear,
259 .is_enabled = regulator_is_enabled_regmap,
260 .enable = max77686_enable,
261 .disable = regulator_disable_regmap,
262 .get_voltage_sel = regulator_get_voltage_sel_regmap,
263 .set_voltage_sel = regulator_set_voltage_sel_regmap,
264 .set_voltage_time_sel = regulator_set_voltage_time_sel,
265 .set_suspend_disable = max77686_set_suspend_disable,
268 static struct regulator_ops max77686_buck_dvs_ops = {
269 .list_voltage = regulator_list_voltage_linear,
270 .map_voltage = regulator_map_voltage_linear,
271 .is_enabled = regulator_is_enabled_regmap,
272 .enable = max77686_enable,
273 .disable = regulator_disable_regmap,
274 .get_voltage_sel = regulator_get_voltage_sel_regmap,
275 .set_voltage_sel = regulator_set_voltage_sel_regmap,
276 .set_voltage_time_sel = regulator_set_voltage_time_sel,
277 .set_ramp_delay = max77686_set_ramp_delay,
278 .set_suspend_disable = max77686_set_suspend_disable,
281 #define regulator_desc_ldo(num) { \
283 .id = MAX77686_LDO##num, \
284 .ops = &max77686_ops, \
285 .type = REGULATOR_VOLTAGE, \
286 .owner = THIS_MODULE, \
287 .min_uV = MAX77686_LDO_MINUV, \
288 .uV_step = MAX77686_LDO_UVSTEP, \
289 .ramp_delay = MAX77686_RAMP_DELAY, \
290 .n_voltages = MAX77686_VSEL_MASK + 1, \
291 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
292 .vsel_mask = MAX77686_VSEL_MASK, \
293 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
294 .enable_mask = MAX77686_OPMODE_MASK \
295 << MAX77686_OPMODE_SHIFT, \
297 #define regulator_desc_lpm_ldo(num) { \
299 .id = MAX77686_LDO##num, \
300 .ops = &max77686_ldo_ops, \
301 .type = REGULATOR_VOLTAGE, \
302 .owner = THIS_MODULE, \
303 .min_uV = MAX77686_LDO_MINUV, \
304 .uV_step = MAX77686_LDO_UVSTEP, \
305 .ramp_delay = MAX77686_RAMP_DELAY, \
306 .n_voltages = MAX77686_VSEL_MASK + 1, \
307 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
308 .vsel_mask = MAX77686_VSEL_MASK, \
309 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
310 .enable_mask = MAX77686_OPMODE_MASK \
311 << MAX77686_OPMODE_SHIFT, \
313 #define regulator_desc_ldo_low(num) { \
315 .id = MAX77686_LDO##num, \
316 .ops = &max77686_ldo_ops, \
317 .type = REGULATOR_VOLTAGE, \
318 .owner = THIS_MODULE, \
319 .min_uV = MAX77686_LDO_LOW_MINUV, \
320 .uV_step = MAX77686_LDO_LOW_UVSTEP, \
321 .ramp_delay = MAX77686_RAMP_DELAY, \
322 .n_voltages = MAX77686_VSEL_MASK + 1, \
323 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
324 .vsel_mask = MAX77686_VSEL_MASK, \
325 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
326 .enable_mask = MAX77686_OPMODE_MASK \
327 << MAX77686_OPMODE_SHIFT, \
329 #define regulator_desc_ldo1_low(num) { \
331 .id = MAX77686_LDO##num, \
332 .ops = &max77686_ops, \
333 .type = REGULATOR_VOLTAGE, \
334 .owner = THIS_MODULE, \
335 .min_uV = MAX77686_LDO_LOW_MINUV, \
336 .uV_step = MAX77686_LDO_LOW_UVSTEP, \
337 .ramp_delay = MAX77686_RAMP_DELAY, \
338 .n_voltages = MAX77686_VSEL_MASK + 1, \
339 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
340 .vsel_mask = MAX77686_VSEL_MASK, \
341 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
342 .enable_mask = MAX77686_OPMODE_MASK \
343 << MAX77686_OPMODE_SHIFT, \
345 #define regulator_desc_buck(num) { \
346 .name = "BUCK"#num, \
347 .id = MAX77686_BUCK##num, \
348 .ops = &max77686_ops, \
349 .type = REGULATOR_VOLTAGE, \
350 .owner = THIS_MODULE, \
351 .min_uV = MAX77686_BUCK_MINUV, \
352 .uV_step = MAX77686_BUCK_UVSTEP, \
353 .ramp_delay = MAX77686_RAMP_DELAY, \
354 .n_voltages = MAX77686_VSEL_MASK + 1, \
355 .vsel_reg = MAX77686_REG_BUCK5OUT + (num - 5) * 2, \
356 .vsel_mask = MAX77686_VSEL_MASK, \
357 .enable_reg = MAX77686_REG_BUCK5CTRL + (num - 5) * 2, \
358 .enable_mask = MAX77686_OPMODE_MASK, \
360 #define regulator_desc_buck1(num) { \
361 .name = "BUCK"#num, \
362 .id = MAX77686_BUCK##num, \
363 .ops = &max77686_buck1_ops, \
364 .type = REGULATOR_VOLTAGE, \
365 .owner = THIS_MODULE, \
366 .min_uV = MAX77686_BUCK_MINUV, \
367 .uV_step = MAX77686_BUCK_UVSTEP, \
368 .ramp_delay = MAX77686_RAMP_DELAY, \
369 .n_voltages = MAX77686_VSEL_MASK + 1, \
370 .vsel_reg = MAX77686_REG_BUCK1OUT, \
371 .vsel_mask = MAX77686_VSEL_MASK, \
372 .enable_reg = MAX77686_REG_BUCK1CTRL, \
373 .enable_mask = MAX77686_OPMODE_MASK, \
375 #define regulator_desc_buck_dvs(num) { \
376 .name = "BUCK"#num, \
377 .id = MAX77686_BUCK##num, \
378 .ops = &max77686_buck_dvs_ops, \
379 .type = REGULATOR_VOLTAGE, \
380 .owner = THIS_MODULE, \
381 .min_uV = MAX77686_DVS_MINUV, \
382 .uV_step = MAX77686_DVS_UVSTEP, \
383 .ramp_delay = MAX77686_DVS_RAMP_DELAY, \
384 .n_voltages = MAX77686_DVS_VSEL_MASK + 1, \
385 .vsel_reg = MAX77686_REG_BUCK2DVS1 + (num - 2) * 10, \
386 .vsel_mask = MAX77686_DVS_VSEL_MASK, \
387 .enable_reg = MAX77686_REG_BUCK2CTRL1 + (num - 2) * 10, \
388 .enable_mask = MAX77686_OPMODE_MASK \
389 << MAX77686_OPMODE_BUCK234_SHIFT, \
392 static const struct regulator_desc regulators[] = {
393 regulator_desc_ldo1_low(1),
394 regulator_desc_ldo_low(2),
395 regulator_desc_ldo(3),
396 regulator_desc_ldo(4),
397 regulator_desc_ldo(5),
398 regulator_desc_ldo_low(6),
399 regulator_desc_ldo_low(7),
400 regulator_desc_ldo_low(8),
401 regulator_desc_ldo(9),
402 regulator_desc_lpm_ldo(10),
403 regulator_desc_lpm_ldo(11),
404 regulator_desc_lpm_ldo(12),
405 regulator_desc_ldo(13),
406 regulator_desc_lpm_ldo(14),
407 regulator_desc_ldo_low(15),
408 regulator_desc_lpm_ldo(16),
409 regulator_desc_ldo(17),
410 regulator_desc_ldo(18),
411 regulator_desc_ldo(19),
412 regulator_desc_ldo(20),
413 regulator_desc_ldo(21),
414 regulator_desc_ldo(22),
415 regulator_desc_ldo(23),
416 regulator_desc_ldo(24),
417 regulator_desc_ldo(25),
418 regulator_desc_ldo(26),
419 regulator_desc_buck1(1),
420 regulator_desc_buck_dvs(2),
421 regulator_desc_buck_dvs(3),
422 regulator_desc_buck_dvs(4),
423 regulator_desc_buck(5),
424 regulator_desc_buck(6),
425 regulator_desc_buck(7),
426 regulator_desc_buck(8),
427 regulator_desc_buck(9),
431 static int max77686_pmic_dt_parse_pdata(struct platform_device *pdev,
432 struct max77686_platform_data *pdata)
434 struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
435 struct device_node *pmic_np, *regulators_np;
436 struct max77686_regulator_data *rdata;
437 struct of_regulator_match rmatch;
440 pmic_np = iodev->dev->of_node;
441 regulators_np = of_get_child_by_name(pmic_np, "voltage-regulators");
442 if (!regulators_np) {
443 dev_err(&pdev->dev, "could not find regulators sub-node\n");
447 pdata->num_regulators = ARRAY_SIZE(regulators);
448 rdata = devm_kzalloc(&pdev->dev, sizeof(*rdata) *
449 pdata->num_regulators, GFP_KERNEL);
451 of_node_put(regulators_np);
455 for (i = 0; i < pdata->num_regulators; i++) {
456 rmatch.name = regulators[i].name;
457 rmatch.init_data = NULL;
458 rmatch.of_node = NULL;
459 of_regulator_match(&pdev->dev, regulators_np, &rmatch, 1);
460 rdata[i].initdata = rmatch.init_data;
461 rdata[i].of_node = rmatch.of_node;
464 pdata->regulators = rdata;
465 of_node_put(regulators_np);
470 static int max77686_pmic_dt_parse_pdata(struct platform_device *pdev,
471 struct max77686_platform_data *pdata)
475 #endif /* CONFIG_OF */
477 static int max77686_pmic_probe(struct platform_device *pdev)
479 struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
480 struct max77686_platform_data *pdata = dev_get_platdata(iodev->dev);
481 struct max77686_data *max77686;
483 struct regulator_config config = { };
485 dev_dbg(&pdev->dev, "%s\n", __func__);
488 dev_err(&pdev->dev, "no platform data found for regulator\n");
492 if (iodev->dev->of_node) {
493 ret = max77686_pmic_dt_parse_pdata(pdev, pdata);
498 if (pdata->num_regulators != MAX77686_REGULATORS) {
500 "Invalid initial data for regulator's initialiation\n");
504 max77686 = devm_kzalloc(&pdev->dev, sizeof(struct max77686_data),
509 config.dev = &pdev->dev;
510 config.regmap = iodev->regmap;
511 config.driver_data = max77686;
512 platform_set_drvdata(pdev, max77686);
514 for (i = 0; i < MAX77686_REGULATORS; i++) {
515 struct regulator_dev *rdev;
517 config.init_data = pdata->regulators[i].initdata;
518 config.of_node = pdata->regulators[i].of_node;
520 max77686->opmode[i] = regulators[i].enable_mask >>
521 max77686_get_opmode_shift(i);
522 rdev = devm_regulator_register(&pdev->dev,
523 ®ulators[i], &config);
526 "regulator init failed for %d\n", i);
527 return PTR_ERR(rdev);
534 static const struct platform_device_id max77686_pmic_id[] = {
535 {"max77686-pmic", 0},
538 MODULE_DEVICE_TABLE(platform, max77686_pmic_id);
540 static struct platform_driver max77686_pmic_driver = {
542 .name = "max77686-pmic",
543 .owner = THIS_MODULE,
545 .probe = max77686_pmic_probe,
546 .id_table = max77686_pmic_id,
549 static int __init max77686_pmic_init(void)
551 return platform_driver_register(&max77686_pmic_driver);
553 subsys_initcall(max77686_pmic_init);
555 static void __exit max77686_pmic_cleanup(void)
557 platform_driver_unregister(&max77686_pmic_driver);
559 module_exit(max77686_pmic_cleanup);
561 MODULE_DESCRIPTION("MAXIM 77686 Regulator Driver");
562 MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
563 MODULE_LICENSE("GPL");