2 * max77802.c - Regulator driver for the Maxim 77802
4 * Copyright (C) 2013-2014 Google, Inc
5 * Simon Glass <sjg@chromium.org>
7 * Copyright (C) 2012 Samsung Electronics
8 * Chiwoong Byun <woong.byun@samsung.com>
9 * Jonghwa Lee <jonghwa3.lee@samsung.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * This driver is based on max8997.c
24 #include <linux/kernel.h>
25 #include <linux/bug.h>
26 #include <linux/err.h>
27 #include <linux/gpio.h>
28 #include <linux/slab.h>
29 #include <linux/gpio/consumer.h>
30 #include <linux/module.h>
31 #include <linux/platform_device.h>
32 #include <linux/regulator/driver.h>
33 #include <linux/regulator/machine.h>
34 #include <linux/regulator/of_regulator.h>
35 #include <linux/mfd/max77686.h>
36 #include <linux/mfd/max77686-private.h>
37 #include <dt-bindings/regulator/maxim,max77802.h>
39 /* Default ramp delay in case it is not manually set */
40 #define MAX77802_RAMP_DELAY 100000 /* uV/us */
42 #define MAX77802_OPMODE_SHIFT_LDO 6
43 #define MAX77802_OPMODE_BUCK234_SHIFT 4
44 #define MAX77802_OPMODE_MASK 0x3
46 #define MAX77802_VSEL_MASK 0x3F
47 #define MAX77802_DVS_VSEL_MASK 0xFF
49 #define MAX77802_RAMP_RATE_MASK_2BIT 0xC0
50 #define MAX77802_RAMP_RATE_SHIFT_2BIT 6
51 #define MAX77802_RAMP_RATE_MASK_4BIT 0xF0
52 #define MAX77802_RAMP_RATE_SHIFT_4BIT 4
54 #define MAX77802_STATUS_OFF 0x0
55 #define MAX77802_OFF_PWRREQ 0x1
56 #define MAX77802_LP_PWRREQ 0x2
58 /* MAX77802 has two register formats: 2-bit and 4-bit */
59 static const unsigned int ramp_table_77802_2bit[] = {
66 static unsigned int ramp_table_77802_4bit[] = {
67 1000, 2000, 3030, 4000,
68 5000, 5880, 7140, 8330,
69 9090, 10000, 11110, 12500,
70 16670, 25000, 50000, 100000,
73 struct max77802_regulator_prv {
74 /* Array indexed by regulator id */
75 unsigned int opmode[MAX77802_REG_MAX];
78 static inline unsigned int max77802_map_mode(unsigned int mode)
80 return mode == MAX77802_OPMODE_NORMAL ?
81 REGULATOR_MODE_NORMAL : REGULATOR_MODE_STANDBY;
84 static int max77802_get_opmode_shift(int id)
86 if (id == MAX77802_BUCK1 || (id >= MAX77802_BUCK5 &&
87 id <= MAX77802_BUCK10))
90 if (id >= MAX77802_BUCK2 && id <= MAX77802_BUCK4)
91 return MAX77802_OPMODE_BUCK234_SHIFT;
93 if (id >= MAX77802_LDO1 && id <= MAX77802_LDO35)
94 return MAX77802_OPMODE_SHIFT_LDO;
100 * max77802_set_suspend_disable - Disable the regulator during system suspend
101 * @rdev: regulator to mark as disabled
103 * All regulators expect LDO 1, 3, 20 and 21 support OFF by PWRREQ.
104 * Configure the regulator so the PMIC will turn it OFF during system suspend.
106 static int max77802_set_suspend_disable(struct regulator_dev *rdev)
108 unsigned int val = MAX77802_OFF_PWRREQ;
109 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
110 unsigned int id = rdev_get_id(rdev);
111 int shift = max77802_get_opmode_shift(id);
113 if (WARN_ON_ONCE(id >= ARRAY_SIZE(max77802->opmode)))
115 max77802->opmode[id] = val;
116 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
117 rdev->desc->enable_mask, val << shift);
121 * Some LDOs support Low Power Mode while the system is running.
125 static int max77802_set_mode(struct regulator_dev *rdev, unsigned int mode)
127 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
128 unsigned int id = rdev_get_id(rdev);
130 int shift = max77802_get_opmode_shift(id);
133 case REGULATOR_MODE_STANDBY:
134 val = MAX77802_OPMODE_LP; /* ON in Low Power Mode */
136 case REGULATOR_MODE_NORMAL:
137 val = MAX77802_OPMODE_NORMAL; /* ON in Normal Mode */
140 dev_warn(&rdev->dev, "%s: regulator mode: 0x%x not supported\n",
141 rdev->desc->name, mode);
145 if (WARN_ON_ONCE(id >= ARRAY_SIZE(max77802->opmode)))
148 max77802->opmode[id] = val;
149 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
150 rdev->desc->enable_mask, val << shift);
153 static unsigned max77802_get_mode(struct regulator_dev *rdev)
155 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
156 unsigned int id = rdev_get_id(rdev);
158 if (WARN_ON_ONCE(id >= ARRAY_SIZE(max77802->opmode)))
160 return max77802_map_mode(max77802->opmode[id]);
164 * max77802_set_suspend_mode - set regulator opmode when the system is suspended
165 * @rdev: regulator to change mode
166 * @mode: operating mode to be set
168 * Will set the operating mode for the regulators during system suspend.
169 * This function is valid for the three different enable control logics:
171 * Enable Control Logic1 by PWRREQ (BUCK 2-4 and LDOs 2, 4-19, 22-35)
172 * Enable Control Logic2 by PWRREQ (LDOs 1, 20, 21)
173 * Enable Control Logic3 by PWRREQ (LDO 3)
175 * If setting the regulator mode fails, the function only warns but does
176 * not return an error code to avoid the regulator core to stop setting
177 * the operating mode for the remaining regulators.
179 static int max77802_set_suspend_mode(struct regulator_dev *rdev,
182 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
183 unsigned int id = rdev_get_id(rdev);
185 int shift = max77802_get_opmode_shift(id);
187 if (WARN_ON_ONCE(id >= ARRAY_SIZE(max77802->opmode)))
191 * If the regulator has been disabled for suspend
192 * then is invalid to try setting a suspend mode.
194 if (max77802->opmode[id] == MAX77802_OFF_PWRREQ) {
195 dev_warn(&rdev->dev, "%s: is disabled, mode: 0x%x not set\n",
196 rdev->desc->name, mode);
201 case REGULATOR_MODE_STANDBY:
203 * If the regulator opmode is normal then enable
204 * ON in Low Power Mode by PWRREQ. If the mode is
205 * already Low Power then no action is required.
207 if (max77802->opmode[id] == MAX77802_OPMODE_NORMAL)
208 val = MAX77802_LP_PWRREQ;
212 case REGULATOR_MODE_NORMAL:
214 * If the regulator operating mode is Low Power then
215 * normal is not a valid opmode in suspend. If the
216 * mode is already normal then no action is required.
218 if (max77802->opmode[id] == MAX77802_OPMODE_LP)
219 dev_warn(&rdev->dev, "%s: in Low Power: 0x%x invalid\n",
220 rdev->desc->name, mode);
223 dev_warn(&rdev->dev, "%s: regulator mode: 0x%x not supported\n",
224 rdev->desc->name, mode);
228 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
229 rdev->desc->enable_mask, val << shift);
232 static int max77802_enable(struct regulator_dev *rdev)
234 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
235 unsigned int id = rdev_get_id(rdev);
236 int shift = max77802_get_opmode_shift(id);
238 if (WARN_ON_ONCE(id >= ARRAY_SIZE(max77802->opmode)))
240 if (max77802->opmode[id] == MAX77802_OFF_PWRREQ)
241 max77802->opmode[id] = MAX77802_OPMODE_NORMAL;
243 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
244 rdev->desc->enable_mask,
245 max77802->opmode[id] << shift);
248 static int max77802_find_ramp_value(struct regulator_dev *rdev,
249 const unsigned int limits[], int size,
250 unsigned int ramp_delay)
254 for (i = 0; i < size; i++) {
255 if (ramp_delay <= limits[i])
259 /* Use maximum value for no ramp control */
260 dev_warn(&rdev->dev, "%s: ramp_delay: %d not supported, setting 100000\n",
261 rdev->desc->name, ramp_delay);
265 /* Used for BUCKs 2-4 */
266 static int max77802_set_ramp_delay_2bit(struct regulator_dev *rdev,
269 int id = rdev_get_id(rdev);
270 unsigned int ramp_value;
272 if (id > MAX77802_BUCK4) {
274 "%s: regulator: ramp delay not supported\n",
278 ramp_value = max77802_find_ramp_value(rdev, ramp_table_77802_2bit,
279 ARRAY_SIZE(ramp_table_77802_2bit), ramp_delay);
281 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
282 MAX77802_RAMP_RATE_MASK_2BIT,
283 ramp_value << MAX77802_RAMP_RATE_SHIFT_2BIT);
287 static int max77802_set_ramp_delay_4bit(struct regulator_dev *rdev,
290 unsigned int ramp_value;
292 ramp_value = max77802_find_ramp_value(rdev, ramp_table_77802_4bit,
293 ARRAY_SIZE(ramp_table_77802_4bit), ramp_delay);
295 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
296 MAX77802_RAMP_RATE_MASK_4BIT,
297 ramp_value << MAX77802_RAMP_RATE_SHIFT_4BIT);
301 * LDOs 2, 4-19, 22-35
303 static const struct regulator_ops max77802_ldo_ops_logic1 = {
304 .list_voltage = regulator_list_voltage_linear,
305 .map_voltage = regulator_map_voltage_linear,
306 .is_enabled = regulator_is_enabled_regmap,
307 .enable = max77802_enable,
308 .disable = regulator_disable_regmap,
309 .get_voltage_sel = regulator_get_voltage_sel_regmap,
310 .set_voltage_sel = regulator_set_voltage_sel_regmap,
311 .set_voltage_time_sel = regulator_set_voltage_time_sel,
312 .set_suspend_disable = max77802_set_suspend_disable,
313 .set_suspend_mode = max77802_set_suspend_mode,
319 static const struct regulator_ops max77802_ldo_ops_logic2 = {
320 .list_voltage = regulator_list_voltage_linear,
321 .map_voltage = regulator_map_voltage_linear,
322 .is_enabled = regulator_is_enabled_regmap,
323 .enable = max77802_enable,
324 .disable = regulator_disable_regmap,
325 .get_voltage_sel = regulator_get_voltage_sel_regmap,
326 .set_voltage_sel = regulator_set_voltage_sel_regmap,
327 .set_voltage_time_sel = regulator_set_voltage_time_sel,
328 .set_mode = max77802_set_mode,
329 .get_mode = max77802_get_mode,
330 .set_suspend_mode = max77802_set_suspend_mode,
334 static const struct regulator_ops max77802_buck_16_dvs_ops = {
335 .list_voltage = regulator_list_voltage_linear,
336 .map_voltage = regulator_map_voltage_linear,
337 .is_enabled = regulator_is_enabled_regmap,
338 .enable = max77802_enable,
339 .disable = regulator_disable_regmap,
340 .get_voltage_sel = regulator_get_voltage_sel_regmap,
341 .set_voltage_sel = regulator_set_voltage_sel_regmap,
342 .set_voltage_time_sel = regulator_set_voltage_time_sel,
343 .set_ramp_delay = max77802_set_ramp_delay_4bit,
344 .set_suspend_disable = max77802_set_suspend_disable,
348 static const struct regulator_ops max77802_buck_234_ops = {
349 .list_voltage = regulator_list_voltage_linear,
350 .map_voltage = regulator_map_voltage_linear,
351 .is_enabled = regulator_is_enabled_regmap,
352 .enable = max77802_enable,
353 .disable = regulator_disable_regmap,
354 .get_voltage_sel = regulator_get_voltage_sel_regmap,
355 .set_voltage_sel = regulator_set_voltage_sel_regmap,
356 .set_voltage_time_sel = regulator_set_voltage_time_sel,
357 .set_ramp_delay = max77802_set_ramp_delay_2bit,
358 .set_suspend_disable = max77802_set_suspend_disable,
359 .set_suspend_mode = max77802_set_suspend_mode,
363 static const struct regulator_ops max77802_buck_dvs_ops = {
364 .list_voltage = regulator_list_voltage_linear,
365 .map_voltage = regulator_map_voltage_linear,
366 .is_enabled = regulator_is_enabled_regmap,
367 .enable = max77802_enable,
368 .disable = regulator_disable_regmap,
369 .get_voltage_sel = regulator_get_voltage_sel_regmap,
370 .set_voltage_sel = regulator_set_voltage_sel_regmap,
371 .set_voltage_time_sel = regulator_set_voltage_time_sel,
372 .set_ramp_delay = max77802_set_ramp_delay_2bit,
373 .set_suspend_disable = max77802_set_suspend_disable,
376 /* LDOs 3-7, 9-14, 18-26, 28, 29, 32-34 */
377 #define regulator_77802_desc_p_ldo(num, supply, log) { \
379 .of_match = of_match_ptr("LDO"#num), \
380 .regulators_node = of_match_ptr("regulators"), \
381 .id = MAX77802_LDO##num, \
382 .supply_name = "inl"#supply, \
383 .ops = &max77802_ldo_ops_logic##log, \
384 .type = REGULATOR_VOLTAGE, \
385 .owner = THIS_MODULE, \
388 .ramp_delay = MAX77802_RAMP_DELAY, \
389 .n_voltages = 1 << 6, \
390 .vsel_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
391 .vsel_mask = MAX77802_VSEL_MASK, \
392 .enable_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
393 .enable_mask = MAX77802_OPMODE_MASK << MAX77802_OPMODE_SHIFT_LDO, \
394 .of_map_mode = max77802_map_mode, \
397 /* LDOs 1, 2, 8, 15, 17, 27, 30, 35 */
398 #define regulator_77802_desc_n_ldo(num, supply, log) { \
400 .of_match = of_match_ptr("LDO"#num), \
401 .regulators_node = of_match_ptr("regulators"), \
402 .id = MAX77802_LDO##num, \
403 .supply_name = "inl"#supply, \
404 .ops = &max77802_ldo_ops_logic##log, \
405 .type = REGULATOR_VOLTAGE, \
406 .owner = THIS_MODULE, \
409 .ramp_delay = MAX77802_RAMP_DELAY, \
410 .n_voltages = 1 << 6, \
411 .vsel_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
412 .vsel_mask = MAX77802_VSEL_MASK, \
413 .enable_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
414 .enable_mask = MAX77802_OPMODE_MASK << MAX77802_OPMODE_SHIFT_LDO, \
415 .of_map_mode = max77802_map_mode, \
419 #define regulator_77802_desc_16_buck(num) { \
420 .name = "BUCK"#num, \
421 .of_match = of_match_ptr("BUCK"#num), \
422 .regulators_node = of_match_ptr("regulators"), \
423 .id = MAX77802_BUCK##num, \
424 .supply_name = "inb"#num, \
425 .ops = &max77802_buck_16_dvs_ops, \
426 .type = REGULATOR_VOLTAGE, \
427 .owner = THIS_MODULE, \
430 .ramp_delay = MAX77802_RAMP_DELAY, \
431 .n_voltages = 1 << 8, \
432 .vsel_reg = MAX77802_REG_BUCK ## num ## DVS1, \
433 .vsel_mask = MAX77802_DVS_VSEL_MASK, \
434 .enable_reg = MAX77802_REG_BUCK ## num ## CTRL, \
435 .enable_mask = MAX77802_OPMODE_MASK, \
436 .of_map_mode = max77802_map_mode, \
440 #define regulator_77802_desc_234_buck(num) { \
441 .name = "BUCK"#num, \
442 .of_match = of_match_ptr("BUCK"#num), \
443 .regulators_node = of_match_ptr("regulators"), \
444 .id = MAX77802_BUCK##num, \
445 .supply_name = "inb"#num, \
446 .ops = &max77802_buck_234_ops, \
447 .type = REGULATOR_VOLTAGE, \
448 .owner = THIS_MODULE, \
451 .ramp_delay = MAX77802_RAMP_DELAY, \
452 .n_voltages = 0x91, \
453 .vsel_reg = MAX77802_REG_BUCK ## num ## DVS1, \
454 .vsel_mask = MAX77802_DVS_VSEL_MASK, \
455 .enable_reg = MAX77802_REG_BUCK ## num ## CTRL1, \
456 .enable_mask = MAX77802_OPMODE_MASK << \
457 MAX77802_OPMODE_BUCK234_SHIFT, \
458 .of_map_mode = max77802_map_mode, \
462 #define regulator_77802_desc_buck5(num) { \
463 .name = "BUCK"#num, \
464 .of_match = of_match_ptr("BUCK"#num), \
465 .regulators_node = of_match_ptr("regulators"), \
466 .id = MAX77802_BUCK##num, \
467 .supply_name = "inb"#num, \
468 .ops = &max77802_buck_dvs_ops, \
469 .type = REGULATOR_VOLTAGE, \
470 .owner = THIS_MODULE, \
473 .ramp_delay = MAX77802_RAMP_DELAY, \
474 .n_voltages = 1 << 6, \
475 .vsel_reg = MAX77802_REG_BUCK5OUT, \
476 .vsel_mask = MAX77802_VSEL_MASK, \
477 .enable_reg = MAX77802_REG_BUCK5CTRL, \
478 .enable_mask = MAX77802_OPMODE_MASK, \
479 .of_map_mode = max77802_map_mode, \
483 #define regulator_77802_desc_buck7_10(num) { \
484 .name = "BUCK"#num, \
485 .of_match = of_match_ptr("BUCK"#num), \
486 .regulators_node = of_match_ptr("regulators"), \
487 .id = MAX77802_BUCK##num, \
488 .supply_name = "inb"#num, \
489 .ops = &max77802_buck_dvs_ops, \
490 .type = REGULATOR_VOLTAGE, \
491 .owner = THIS_MODULE, \
494 .ramp_delay = MAX77802_RAMP_DELAY, \
495 .n_voltages = 1 << 6, \
496 .vsel_reg = MAX77802_REG_BUCK7OUT + (num - 7) * 3, \
497 .vsel_mask = MAX77802_VSEL_MASK, \
498 .enable_reg = MAX77802_REG_BUCK7CTRL + (num - 7) * 3, \
499 .enable_mask = MAX77802_OPMODE_MASK, \
500 .of_map_mode = max77802_map_mode, \
503 static const struct regulator_desc regulators[] = {
504 regulator_77802_desc_16_buck(1),
505 regulator_77802_desc_234_buck(2),
506 regulator_77802_desc_234_buck(3),
507 regulator_77802_desc_234_buck(4),
508 regulator_77802_desc_buck5(5),
509 regulator_77802_desc_16_buck(6),
510 regulator_77802_desc_buck7_10(7),
511 regulator_77802_desc_buck7_10(8),
512 regulator_77802_desc_buck7_10(9),
513 regulator_77802_desc_buck7_10(10),
514 regulator_77802_desc_n_ldo(1, 10, 2),
515 regulator_77802_desc_n_ldo(2, 10, 1),
516 regulator_77802_desc_p_ldo(3, 3, 2),
517 regulator_77802_desc_p_ldo(4, 6, 1),
518 regulator_77802_desc_p_ldo(5, 3, 1),
519 regulator_77802_desc_p_ldo(6, 3, 1),
520 regulator_77802_desc_p_ldo(7, 3, 1),
521 regulator_77802_desc_n_ldo(8, 1, 1),
522 regulator_77802_desc_p_ldo(9, 5, 1),
523 regulator_77802_desc_p_ldo(10, 4, 1),
524 regulator_77802_desc_p_ldo(11, 4, 1),
525 regulator_77802_desc_p_ldo(12, 9, 1),
526 regulator_77802_desc_p_ldo(13, 4, 1),
527 regulator_77802_desc_p_ldo(14, 4, 1),
528 regulator_77802_desc_n_ldo(15, 1, 1),
529 regulator_77802_desc_n_ldo(17, 2, 1),
530 regulator_77802_desc_p_ldo(18, 7, 1),
531 regulator_77802_desc_p_ldo(19, 5, 1),
532 regulator_77802_desc_p_ldo(20, 7, 2),
533 regulator_77802_desc_p_ldo(21, 6, 2),
534 regulator_77802_desc_p_ldo(23, 9, 1),
535 regulator_77802_desc_p_ldo(24, 6, 1),
536 regulator_77802_desc_p_ldo(25, 9, 1),
537 regulator_77802_desc_p_ldo(26, 9, 1),
538 regulator_77802_desc_n_ldo(27, 2, 1),
539 regulator_77802_desc_p_ldo(28, 7, 1),
540 regulator_77802_desc_p_ldo(29, 7, 1),
541 regulator_77802_desc_n_ldo(30, 2, 1),
542 regulator_77802_desc_p_ldo(32, 9, 1),
543 regulator_77802_desc_p_ldo(33, 6, 1),
544 regulator_77802_desc_p_ldo(34, 9, 1),
545 regulator_77802_desc_n_ldo(35, 2, 1),
548 static int max77802_pmic_probe(struct platform_device *pdev)
550 struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
551 struct max77802_regulator_prv *max77802;
553 struct regulator_config config = { };
555 max77802 = devm_kzalloc(&pdev->dev,
556 sizeof(struct max77802_regulator_prv),
561 config.dev = iodev->dev;
562 config.regmap = iodev->regmap;
563 config.driver_data = max77802;
564 platform_set_drvdata(pdev, max77802);
566 for (i = 0; i < MAX77802_REG_MAX; i++) {
567 struct regulator_dev *rdev;
568 unsigned int id = regulators[i].id;
569 int shift = max77802_get_opmode_shift(id);
572 ret = regmap_read(iodev->regmap, regulators[i].enable_reg, &val);
575 "cannot read current mode for %d\n", i);
576 val = MAX77802_OPMODE_NORMAL;
578 val = val >> shift & MAX77802_OPMODE_MASK;
582 * If the regulator is disabled and the system warm rebooted,
583 * the hardware reports OFF as the regulator operating mode.
584 * Default to operating mode NORMAL in that case.
586 if (id < ARRAY_SIZE(max77802->opmode)) {
587 if (val == MAX77802_STATUS_OFF)
588 max77802->opmode[id] = MAX77802_OPMODE_NORMAL;
590 max77802->opmode[id] = val;
593 rdev = devm_regulator_register(&pdev->dev,
594 ®ulators[i], &config);
598 "regulator init failed for %d: %d\n", i, ret);
606 static const struct platform_device_id max77802_pmic_id[] = {
607 {"max77802-pmic", 0},
610 MODULE_DEVICE_TABLE(platform, max77802_pmic_id);
612 static struct platform_driver max77802_pmic_driver = {
614 .name = "max77802-pmic",
616 .probe = max77802_pmic_probe,
617 .id_table = max77802_pmic_id,
620 module_platform_driver(max77802_pmic_driver);
622 MODULE_DESCRIPTION("MAXIM 77802 Regulator Driver");
623 MODULE_AUTHOR("Simon Glass <sjg@chromium.org>");
624 MODULE_LICENSE("GPL");