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 int id = rdev_get_id(rdev);
111 int shift = max77802_get_opmode_shift(id);
113 max77802->opmode[id] = val;
114 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
115 rdev->desc->enable_mask, val << shift);
119 * Some LDOs support Low Power Mode while the system is running.
123 static int max77802_set_mode(struct regulator_dev *rdev, unsigned int mode)
125 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
126 int id = rdev_get_id(rdev);
128 int shift = max77802_get_opmode_shift(id);
131 case REGULATOR_MODE_STANDBY:
132 val = MAX77802_OPMODE_LP; /* ON in Low Power Mode */
134 case REGULATOR_MODE_NORMAL:
135 val = MAX77802_OPMODE_NORMAL; /* ON in Normal Mode */
138 dev_warn(&rdev->dev, "%s: regulator mode: 0x%x not supported\n",
139 rdev->desc->name, mode);
143 max77802->opmode[id] = val;
144 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
145 rdev->desc->enable_mask, val << shift);
148 static unsigned max77802_get_mode(struct regulator_dev *rdev)
150 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
151 int id = rdev_get_id(rdev);
153 return max77802_map_mode(max77802->opmode[id]);
157 * max77802_set_suspend_mode - set regulator opmode when the system is suspended
158 * @rdev: regulator to change mode
159 * @mode: operating mode to be set
161 * Will set the operating mode for the regulators during system suspend.
162 * This function is valid for the three different enable control logics:
164 * Enable Control Logic1 by PWRREQ (BUCK 2-4 and LDOs 2, 4-19, 22-35)
165 * Enable Control Logic2 by PWRREQ (LDOs 1, 20, 21)
166 * Enable Control Logic3 by PWRREQ (LDO 3)
168 * If setting the regulator mode fails, the function only warns but does
169 * not return an error code to avoid the regulator core to stop setting
170 * the operating mode for the remaining regulators.
172 static int max77802_set_suspend_mode(struct regulator_dev *rdev,
175 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
176 int id = rdev_get_id(rdev);
178 int shift = max77802_get_opmode_shift(id);
181 * If the regulator has been disabled for suspend
182 * then is invalid to try setting a suspend mode.
184 if (max77802->opmode[id] == MAX77802_OFF_PWRREQ) {
185 dev_warn(&rdev->dev, "%s: is disabled, mode: 0x%x not set\n",
186 rdev->desc->name, mode);
191 case REGULATOR_MODE_STANDBY:
193 * If the regulator opmode is normal then enable
194 * ON in Low Power Mode by PWRREQ. If the mode is
195 * already Low Power then no action is required.
197 if (max77802->opmode[id] == MAX77802_OPMODE_NORMAL)
198 val = MAX77802_LP_PWRREQ;
202 case REGULATOR_MODE_NORMAL:
204 * If the regulator operating mode is Low Power then
205 * normal is not a valid opmode in suspend. If the
206 * mode is already normal then no action is required.
208 if (max77802->opmode[id] == MAX77802_OPMODE_LP)
209 dev_warn(&rdev->dev, "%s: in Low Power: 0x%x invalid\n",
210 rdev->desc->name, mode);
213 dev_warn(&rdev->dev, "%s: regulator mode: 0x%x not supported\n",
214 rdev->desc->name, mode);
218 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
219 rdev->desc->enable_mask, val << shift);
222 static int max77802_enable(struct regulator_dev *rdev)
224 struct max77802_regulator_prv *max77802 = rdev_get_drvdata(rdev);
225 int id = rdev_get_id(rdev);
226 int shift = max77802_get_opmode_shift(id);
228 if (max77802->opmode[id] == MAX77802_OFF_PWRREQ)
229 max77802->opmode[id] = MAX77802_OPMODE_NORMAL;
231 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
232 rdev->desc->enable_mask,
233 max77802->opmode[id] << shift);
236 static int max77802_find_ramp_value(struct regulator_dev *rdev,
237 const unsigned int limits[], int size,
238 unsigned int ramp_delay)
242 for (i = 0; i < size; i++) {
243 if (ramp_delay <= limits[i])
247 /* Use maximum value for no ramp control */
248 dev_warn(&rdev->dev, "%s: ramp_delay: %d not supported, setting 100000\n",
249 rdev->desc->name, ramp_delay);
253 /* Used for BUCKs 2-4 */
254 static int max77802_set_ramp_delay_2bit(struct regulator_dev *rdev,
257 int id = rdev_get_id(rdev);
258 unsigned int ramp_value;
260 if (id > MAX77802_BUCK4) {
262 "%s: regulator: ramp delay not supported\n",
266 ramp_value = max77802_find_ramp_value(rdev, ramp_table_77802_2bit,
267 ARRAY_SIZE(ramp_table_77802_2bit), ramp_delay);
269 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
270 MAX77802_RAMP_RATE_MASK_2BIT,
271 ramp_value << MAX77802_RAMP_RATE_SHIFT_2BIT);
275 static int max77802_set_ramp_delay_4bit(struct regulator_dev *rdev,
278 unsigned int ramp_value;
280 ramp_value = max77802_find_ramp_value(rdev, ramp_table_77802_4bit,
281 ARRAY_SIZE(ramp_table_77802_4bit), ramp_delay);
283 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
284 MAX77802_RAMP_RATE_MASK_4BIT,
285 ramp_value << MAX77802_RAMP_RATE_SHIFT_4BIT);
289 * LDOs 2, 4-19, 22-35
291 static struct regulator_ops max77802_ldo_ops_logic1 = {
292 .list_voltage = regulator_list_voltage_linear,
293 .map_voltage = regulator_map_voltage_linear,
294 .is_enabled = regulator_is_enabled_regmap,
295 .enable = max77802_enable,
296 .disable = regulator_disable_regmap,
297 .get_voltage_sel = regulator_get_voltage_sel_regmap,
298 .set_voltage_sel = regulator_set_voltage_sel_regmap,
299 .set_voltage_time_sel = regulator_set_voltage_time_sel,
300 .set_suspend_disable = max77802_set_suspend_disable,
301 .set_suspend_mode = max77802_set_suspend_mode,
307 static struct regulator_ops max77802_ldo_ops_logic2 = {
308 .list_voltage = regulator_list_voltage_linear,
309 .map_voltage = regulator_map_voltage_linear,
310 .is_enabled = regulator_is_enabled_regmap,
311 .enable = max77802_enable,
312 .disable = regulator_disable_regmap,
313 .get_voltage_sel = regulator_get_voltage_sel_regmap,
314 .set_voltage_sel = regulator_set_voltage_sel_regmap,
315 .set_voltage_time_sel = regulator_set_voltage_time_sel,
316 .set_mode = max77802_set_mode,
317 .get_mode = max77802_get_mode,
318 .set_suspend_mode = max77802_set_suspend_mode,
322 static struct regulator_ops max77802_buck_16_dvs_ops = {
323 .list_voltage = regulator_list_voltage_linear,
324 .map_voltage = regulator_map_voltage_linear,
325 .is_enabled = regulator_is_enabled_regmap,
326 .enable = max77802_enable,
327 .disable = regulator_disable_regmap,
328 .get_voltage_sel = regulator_get_voltage_sel_regmap,
329 .set_voltage_sel = regulator_set_voltage_sel_regmap,
330 .set_voltage_time_sel = regulator_set_voltage_time_sel,
331 .set_ramp_delay = max77802_set_ramp_delay_4bit,
332 .set_suspend_disable = max77802_set_suspend_disable,
336 static struct regulator_ops max77802_buck_234_ops = {
337 .list_voltage = regulator_list_voltage_linear,
338 .map_voltage = regulator_map_voltage_linear,
339 .is_enabled = regulator_is_enabled_regmap,
340 .enable = max77802_enable,
341 .disable = regulator_disable_regmap,
342 .get_voltage_sel = regulator_get_voltage_sel_regmap,
343 .set_voltage_sel = regulator_set_voltage_sel_regmap,
344 .set_voltage_time_sel = regulator_set_voltage_time_sel,
345 .set_ramp_delay = max77802_set_ramp_delay_2bit,
346 .set_suspend_disable = max77802_set_suspend_disable,
347 .set_suspend_mode = max77802_set_suspend_mode,
351 static struct regulator_ops max77802_buck_dvs_ops = {
352 .list_voltage = regulator_list_voltage_linear,
353 .map_voltage = regulator_map_voltage_linear,
354 .is_enabled = regulator_is_enabled_regmap,
355 .enable = max77802_enable,
356 .disable = regulator_disable_regmap,
357 .get_voltage_sel = regulator_get_voltage_sel_regmap,
358 .set_voltage_sel = regulator_set_voltage_sel_regmap,
359 .set_voltage_time_sel = regulator_set_voltage_time_sel,
360 .set_ramp_delay = max77802_set_ramp_delay_2bit,
361 .set_suspend_disable = max77802_set_suspend_disable,
364 /* LDOs 3-7, 9-14, 18-26, 28, 29, 32-34 */
365 #define regulator_77802_desc_p_ldo(num, supply, log) { \
367 .of_match = of_match_ptr("LDO"#num), \
368 .regulators_node = of_match_ptr("regulators"), \
369 .id = MAX77802_LDO##num, \
370 .supply_name = "inl"#supply, \
371 .ops = &max77802_ldo_ops_logic##log, \
372 .type = REGULATOR_VOLTAGE, \
373 .owner = THIS_MODULE, \
376 .ramp_delay = MAX77802_RAMP_DELAY, \
377 .n_voltages = 1 << 6, \
378 .vsel_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
379 .vsel_mask = MAX77802_VSEL_MASK, \
380 .enable_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
381 .enable_mask = MAX77802_OPMODE_MASK << MAX77802_OPMODE_SHIFT_LDO, \
382 .of_map_mode = max77802_map_mode, \
385 /* LDOs 1, 2, 8, 15, 17, 27, 30, 35 */
386 #define regulator_77802_desc_n_ldo(num, supply, log) { \
388 .of_match = of_match_ptr("LDO"#num), \
389 .regulators_node = of_match_ptr("regulators"), \
390 .id = MAX77802_LDO##num, \
391 .supply_name = "inl"#supply, \
392 .ops = &max77802_ldo_ops_logic##log, \
393 .type = REGULATOR_VOLTAGE, \
394 .owner = THIS_MODULE, \
397 .ramp_delay = MAX77802_RAMP_DELAY, \
398 .n_voltages = 1 << 6, \
399 .vsel_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
400 .vsel_mask = MAX77802_VSEL_MASK, \
401 .enable_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
402 .enable_mask = MAX77802_OPMODE_MASK << MAX77802_OPMODE_SHIFT_LDO, \
403 .of_map_mode = max77802_map_mode, \
407 #define regulator_77802_desc_16_buck(num) { \
408 .name = "BUCK"#num, \
409 .of_match = of_match_ptr("BUCK"#num), \
410 .regulators_node = of_match_ptr("regulators"), \
411 .id = MAX77802_BUCK##num, \
412 .supply_name = "inb"#num, \
413 .ops = &max77802_buck_16_dvs_ops, \
414 .type = REGULATOR_VOLTAGE, \
415 .owner = THIS_MODULE, \
418 .ramp_delay = MAX77802_RAMP_DELAY, \
419 .n_voltages = 1 << 8, \
420 .vsel_reg = MAX77802_REG_BUCK ## num ## DVS1, \
421 .vsel_mask = MAX77802_DVS_VSEL_MASK, \
422 .enable_reg = MAX77802_REG_BUCK ## num ## CTRL, \
423 .enable_mask = MAX77802_OPMODE_MASK, \
424 .of_map_mode = max77802_map_mode, \
428 #define regulator_77802_desc_234_buck(num) { \
429 .name = "BUCK"#num, \
430 .of_match = of_match_ptr("BUCK"#num), \
431 .regulators_node = of_match_ptr("regulators"), \
432 .id = MAX77802_BUCK##num, \
433 .supply_name = "inb"#num, \
434 .ops = &max77802_buck_234_ops, \
435 .type = REGULATOR_VOLTAGE, \
436 .owner = THIS_MODULE, \
439 .ramp_delay = MAX77802_RAMP_DELAY, \
440 .n_voltages = 0x91, \
441 .vsel_reg = MAX77802_REG_BUCK ## num ## DVS1, \
442 .vsel_mask = MAX77802_DVS_VSEL_MASK, \
443 .enable_reg = MAX77802_REG_BUCK ## num ## CTRL1, \
444 .enable_mask = MAX77802_OPMODE_MASK << \
445 MAX77802_OPMODE_BUCK234_SHIFT, \
446 .of_map_mode = max77802_map_mode, \
450 #define regulator_77802_desc_buck5(num) { \
451 .name = "BUCK"#num, \
452 .of_match = of_match_ptr("BUCK"#num), \
453 .regulators_node = of_match_ptr("regulators"), \
454 .id = MAX77802_BUCK##num, \
455 .supply_name = "inb"#num, \
456 .ops = &max77802_buck_dvs_ops, \
457 .type = REGULATOR_VOLTAGE, \
458 .owner = THIS_MODULE, \
461 .ramp_delay = MAX77802_RAMP_DELAY, \
462 .n_voltages = 1 << 6, \
463 .vsel_reg = MAX77802_REG_BUCK5OUT, \
464 .vsel_mask = MAX77802_VSEL_MASK, \
465 .enable_reg = MAX77802_REG_BUCK5CTRL, \
466 .enable_mask = MAX77802_OPMODE_MASK, \
467 .of_map_mode = max77802_map_mode, \
471 #define regulator_77802_desc_buck7_10(num) { \
472 .name = "BUCK"#num, \
473 .of_match = of_match_ptr("BUCK"#num), \
474 .regulators_node = of_match_ptr("regulators"), \
475 .id = MAX77802_BUCK##num, \
476 .supply_name = "inb"#num, \
477 .ops = &max77802_buck_dvs_ops, \
478 .type = REGULATOR_VOLTAGE, \
479 .owner = THIS_MODULE, \
482 .ramp_delay = MAX77802_RAMP_DELAY, \
483 .n_voltages = 1 << 6, \
484 .vsel_reg = MAX77802_REG_BUCK7OUT + (num - 7) * 3, \
485 .vsel_mask = MAX77802_VSEL_MASK, \
486 .enable_reg = MAX77802_REG_BUCK7CTRL + (num - 7) * 3, \
487 .enable_mask = MAX77802_OPMODE_MASK, \
488 .of_map_mode = max77802_map_mode, \
491 static const struct regulator_desc regulators[] = {
492 regulator_77802_desc_16_buck(1),
493 regulator_77802_desc_234_buck(2),
494 regulator_77802_desc_234_buck(3),
495 regulator_77802_desc_234_buck(4),
496 regulator_77802_desc_buck5(5),
497 regulator_77802_desc_16_buck(6),
498 regulator_77802_desc_buck7_10(7),
499 regulator_77802_desc_buck7_10(8),
500 regulator_77802_desc_buck7_10(9),
501 regulator_77802_desc_buck7_10(10),
502 regulator_77802_desc_n_ldo(1, 10, 2),
503 regulator_77802_desc_n_ldo(2, 10, 1),
504 regulator_77802_desc_p_ldo(3, 3, 2),
505 regulator_77802_desc_p_ldo(4, 6, 1),
506 regulator_77802_desc_p_ldo(5, 3, 1),
507 regulator_77802_desc_p_ldo(6, 3, 1),
508 regulator_77802_desc_p_ldo(7, 3, 1),
509 regulator_77802_desc_n_ldo(8, 1, 1),
510 regulator_77802_desc_p_ldo(9, 5, 1),
511 regulator_77802_desc_p_ldo(10, 4, 1),
512 regulator_77802_desc_p_ldo(11, 4, 1),
513 regulator_77802_desc_p_ldo(12, 9, 1),
514 regulator_77802_desc_p_ldo(13, 4, 1),
515 regulator_77802_desc_p_ldo(14, 4, 1),
516 regulator_77802_desc_n_ldo(15, 1, 1),
517 regulator_77802_desc_n_ldo(17, 2, 1),
518 regulator_77802_desc_p_ldo(18, 7, 1),
519 regulator_77802_desc_p_ldo(19, 5, 1),
520 regulator_77802_desc_p_ldo(20, 7, 2),
521 regulator_77802_desc_p_ldo(21, 6, 2),
522 regulator_77802_desc_p_ldo(23, 9, 1),
523 regulator_77802_desc_p_ldo(24, 6, 1),
524 regulator_77802_desc_p_ldo(25, 9, 1),
525 regulator_77802_desc_p_ldo(26, 9, 1),
526 regulator_77802_desc_n_ldo(27, 2, 1),
527 regulator_77802_desc_p_ldo(28, 7, 1),
528 regulator_77802_desc_p_ldo(29, 7, 1),
529 regulator_77802_desc_n_ldo(30, 2, 1),
530 regulator_77802_desc_p_ldo(32, 9, 1),
531 regulator_77802_desc_p_ldo(33, 6, 1),
532 regulator_77802_desc_p_ldo(34, 9, 1),
533 regulator_77802_desc_n_ldo(35, 2, 1),
536 static int max77802_pmic_probe(struct platform_device *pdev)
538 struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
539 struct max77802_regulator_prv *max77802;
541 struct regulator_config config = { };
543 max77802 = devm_kzalloc(&pdev->dev,
544 sizeof(struct max77802_regulator_prv),
549 config.dev = iodev->dev;
550 config.regmap = iodev->regmap;
551 config.driver_data = max77802;
552 platform_set_drvdata(pdev, max77802);
554 for (i = 0; i < MAX77802_REG_MAX; i++) {
555 struct regulator_dev *rdev;
556 int id = regulators[i].id;
557 int shift = max77802_get_opmode_shift(id);
560 ret = regmap_read(iodev->regmap, regulators[i].enable_reg, &val);
563 "cannot read current mode for %d\n", i);
564 val = MAX77802_OPMODE_NORMAL;
566 val = val >> shift & MAX77802_OPMODE_MASK;
570 * If the regulator is disabled and the system warm rebooted,
571 * the hardware reports OFF as the regulator operating mode.
572 * Default to operating mode NORMAL in that case.
574 if (val == MAX77802_STATUS_OFF)
575 max77802->opmode[id] = MAX77802_OPMODE_NORMAL;
577 max77802->opmode[id] = val;
579 rdev = devm_regulator_register(&pdev->dev,
580 ®ulators[i], &config);
584 "regulator init failed for %d: %d\n", i, ret);
592 static const struct platform_device_id max77802_pmic_id[] = {
593 {"max77802-pmic", 0},
596 MODULE_DEVICE_TABLE(platform, max77802_pmic_id);
598 static struct platform_driver max77802_pmic_driver = {
600 .name = "max77802-pmic",
602 .probe = max77802_pmic_probe,
603 .id_table = max77802_pmic_id,
606 module_platform_driver(max77802_pmic_driver);
608 MODULE_DESCRIPTION("MAXIM 77802 Regulator Driver");
609 MODULE_AUTHOR("Simon Glass <sjg@chromium.org>");
610 MODULE_LICENSE("GPL");