1 // SPDX-License-Identifier: GPL-2.0+
3 // max77802.c - Regulator driver for the Maxim 77802
5 // Copyright (C) 2013-2014 Google, Inc
6 // Simon Glass <sjg@chromium.org>
8 // Copyright (C) 2012 Samsung Electronics
9 // Chiwoong Byun <woong.byun@samsung.com>
10 // Jonghwa Lee <jonghwa3.lee@samsung.com>
12 // This driver is based on max8997.c
14 #include <linux/kernel.h>
15 #include <linux/bug.h>
16 #include <linux/err.h>
17 #include <linux/slab.h>
18 #include <linux/module.h>
19 #include <linux/platform_device.h>
20 #include <linux/regulator/driver.h>
21 #include <linux/regulator/machine.h>
22 #include <linux/regulator/of_regulator.h>
23 #include <linux/mfd/max77686.h>
24 #include <linux/mfd/max77686-private.h>
25 #include <dt-bindings/regulator/maxim,max77802.h>
27 /* Default ramp delay in case it is not manually set */
28 #define MAX77802_RAMP_DELAY 100000 /* uV/us */
30 #define MAX77802_OPMODE_SHIFT_LDO 6
31 #define MAX77802_OPMODE_BUCK234_SHIFT 4
32 #define MAX77802_OPMODE_MASK 0x3
34 #define MAX77802_VSEL_MASK 0x3F
35 #define MAX77802_DVS_VSEL_MASK 0xFF
37 #define MAX77802_RAMP_RATE_MASK_2BIT 0xC0
38 #define MAX77802_RAMP_RATE_SHIFT_2BIT 6
39 #define MAX77802_RAMP_RATE_MASK_4BIT 0xF0
40 #define MAX77802_RAMP_RATE_SHIFT_4BIT 4
42 #define MAX77802_STATUS_OFF 0x0
43 #define MAX77802_OFF_PWRREQ 0x1
44 #define MAX77802_LP_PWRREQ 0x2
46 /* MAX77802 has two register formats: 2-bit and 4-bit */
47 static const unsigned int ramp_table_77802_2bit
[] = {
54 static unsigned int ramp_table_77802_4bit
[] = {
55 1000, 2000, 3030, 4000,
56 5000, 5880, 7140, 8330,
57 9090, 10000, 11110, 12500,
58 16670, 25000, 50000, 100000,
61 struct max77802_regulator_prv
{
62 /* Array indexed by regulator id */
63 unsigned int opmode
[MAX77802_REG_MAX
];
66 static inline unsigned int max77802_map_mode(unsigned int mode
)
68 return mode
== MAX77802_OPMODE_NORMAL
?
69 REGULATOR_MODE_NORMAL
: REGULATOR_MODE_STANDBY
;
72 static int max77802_get_opmode_shift(int id
)
74 if (id
== MAX77802_BUCK1
|| (id
>= MAX77802_BUCK5
&&
75 id
<= MAX77802_BUCK10
))
78 if (id
>= MAX77802_BUCK2
&& id
<= MAX77802_BUCK4
)
79 return MAX77802_OPMODE_BUCK234_SHIFT
;
81 if (id
>= MAX77802_LDO1
&& id
<= MAX77802_LDO35
)
82 return MAX77802_OPMODE_SHIFT_LDO
;
88 * max77802_set_suspend_disable - Disable the regulator during system suspend
89 * @rdev: regulator to mark as disabled
91 * All regulators expect LDO 1, 3, 20 and 21 support OFF by PWRREQ.
92 * Configure the regulator so the PMIC will turn it OFF during system suspend.
94 static int max77802_set_suspend_disable(struct regulator_dev
*rdev
)
96 unsigned int val
= MAX77802_OFF_PWRREQ
;
97 struct max77802_regulator_prv
*max77802
= rdev_get_drvdata(rdev
);
98 int id
= rdev_get_id(rdev
);
99 int shift
= max77802_get_opmode_shift(id
);
101 max77802
->opmode
[id
] = val
;
102 return regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
103 rdev
->desc
->enable_mask
, val
<< shift
);
107 * Some LDOs support Low Power Mode while the system is running.
111 static int max77802_set_mode(struct regulator_dev
*rdev
, unsigned int mode
)
113 struct max77802_regulator_prv
*max77802
= rdev_get_drvdata(rdev
);
114 int id
= rdev_get_id(rdev
);
116 int shift
= max77802_get_opmode_shift(id
);
119 case REGULATOR_MODE_STANDBY
:
120 val
= MAX77802_OPMODE_LP
; /* ON in Low Power Mode */
122 case REGULATOR_MODE_NORMAL
:
123 val
= MAX77802_OPMODE_NORMAL
; /* ON in Normal Mode */
126 dev_warn(&rdev
->dev
, "%s: regulator mode: 0x%x not supported\n",
127 rdev
->desc
->name
, mode
);
131 max77802
->opmode
[id
] = val
;
132 return regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
133 rdev
->desc
->enable_mask
, val
<< shift
);
136 static unsigned max77802_get_mode(struct regulator_dev
*rdev
)
138 struct max77802_regulator_prv
*max77802
= rdev_get_drvdata(rdev
);
139 int id
= rdev_get_id(rdev
);
141 return max77802_map_mode(max77802
->opmode
[id
]);
145 * max77802_set_suspend_mode - set regulator opmode when the system is suspended
146 * @rdev: regulator to change mode
147 * @mode: operating mode to be set
149 * Will set the operating mode for the regulators during system suspend.
150 * This function is valid for the three different enable control logics:
152 * Enable Control Logic1 by PWRREQ (BUCK 2-4 and LDOs 2, 4-19, 22-35)
153 * Enable Control Logic2 by PWRREQ (LDOs 1, 20, 21)
154 * Enable Control Logic3 by PWRREQ (LDO 3)
156 * If setting the regulator mode fails, the function only warns but does
157 * not return an error code to avoid the regulator core to stop setting
158 * the operating mode for the remaining regulators.
160 static int max77802_set_suspend_mode(struct regulator_dev
*rdev
,
163 struct max77802_regulator_prv
*max77802
= rdev_get_drvdata(rdev
);
164 int id
= rdev_get_id(rdev
);
166 int shift
= max77802_get_opmode_shift(id
);
169 * If the regulator has been disabled for suspend
170 * then is invalid to try setting a suspend mode.
172 if (max77802
->opmode
[id
] == MAX77802_OFF_PWRREQ
) {
173 dev_warn(&rdev
->dev
, "%s: is disabled, mode: 0x%x not set\n",
174 rdev
->desc
->name
, mode
);
179 case REGULATOR_MODE_STANDBY
:
181 * If the regulator opmode is normal then enable
182 * ON in Low Power Mode by PWRREQ. If the mode is
183 * already Low Power then no action is required.
185 if (max77802
->opmode
[id
] == MAX77802_OPMODE_NORMAL
)
186 val
= MAX77802_LP_PWRREQ
;
190 case REGULATOR_MODE_NORMAL
:
192 * If the regulator operating mode is Low Power then
193 * normal is not a valid opmode in suspend. If the
194 * mode is already normal then no action is required.
196 if (max77802
->opmode
[id
] == MAX77802_OPMODE_LP
)
197 dev_warn(&rdev
->dev
, "%s: in Low Power: 0x%x invalid\n",
198 rdev
->desc
->name
, mode
);
201 dev_warn(&rdev
->dev
, "%s: regulator mode: 0x%x not supported\n",
202 rdev
->desc
->name
, mode
);
206 return regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
207 rdev
->desc
->enable_mask
, val
<< shift
);
210 static int max77802_enable(struct regulator_dev
*rdev
)
212 struct max77802_regulator_prv
*max77802
= rdev_get_drvdata(rdev
);
213 int id
= rdev_get_id(rdev
);
214 int shift
= max77802_get_opmode_shift(id
);
216 if (max77802
->opmode
[id
] == MAX77802_OFF_PWRREQ
)
217 max77802
->opmode
[id
] = MAX77802_OPMODE_NORMAL
;
219 return regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
220 rdev
->desc
->enable_mask
,
221 max77802
->opmode
[id
] << shift
);
224 static int max77802_find_ramp_value(struct regulator_dev
*rdev
,
225 const unsigned int limits
[], int size
,
226 unsigned int ramp_delay
)
230 for (i
= 0; i
< size
; i
++) {
231 if (ramp_delay
<= limits
[i
])
235 /* Use maximum value for no ramp control */
236 dev_warn(&rdev
->dev
, "%s: ramp_delay: %d not supported, setting 100000\n",
237 rdev
->desc
->name
, ramp_delay
);
241 /* Used for BUCKs 2-4 */
242 static int max77802_set_ramp_delay_2bit(struct regulator_dev
*rdev
,
245 int id
= rdev_get_id(rdev
);
246 unsigned int ramp_value
;
248 if (id
> MAX77802_BUCK4
) {
250 "%s: regulator: ramp delay not supported\n",
254 ramp_value
= max77802_find_ramp_value(rdev
, ramp_table_77802_2bit
,
255 ARRAY_SIZE(ramp_table_77802_2bit
), ramp_delay
);
257 return regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
258 MAX77802_RAMP_RATE_MASK_2BIT
,
259 ramp_value
<< MAX77802_RAMP_RATE_SHIFT_2BIT
);
263 static int max77802_set_ramp_delay_4bit(struct regulator_dev
*rdev
,
266 unsigned int ramp_value
;
268 ramp_value
= max77802_find_ramp_value(rdev
, ramp_table_77802_4bit
,
269 ARRAY_SIZE(ramp_table_77802_4bit
), ramp_delay
);
271 return regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
272 MAX77802_RAMP_RATE_MASK_4BIT
,
273 ramp_value
<< MAX77802_RAMP_RATE_SHIFT_4BIT
);
277 * LDOs 2, 4-19, 22-35
279 static const struct regulator_ops max77802_ldo_ops_logic1
= {
280 .list_voltage
= regulator_list_voltage_linear
,
281 .map_voltage
= regulator_map_voltage_linear
,
282 .is_enabled
= regulator_is_enabled_regmap
,
283 .enable
= max77802_enable
,
284 .disable
= regulator_disable_regmap
,
285 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
286 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
287 .set_voltage_time_sel
= regulator_set_voltage_time_sel
,
288 .set_suspend_disable
= max77802_set_suspend_disable
,
289 .set_suspend_mode
= max77802_set_suspend_mode
,
295 static const struct regulator_ops max77802_ldo_ops_logic2
= {
296 .list_voltage
= regulator_list_voltage_linear
,
297 .map_voltage
= regulator_map_voltage_linear
,
298 .is_enabled
= regulator_is_enabled_regmap
,
299 .enable
= max77802_enable
,
300 .disable
= regulator_disable_regmap
,
301 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
302 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
303 .set_voltage_time_sel
= regulator_set_voltage_time_sel
,
304 .set_mode
= max77802_set_mode
,
305 .get_mode
= max77802_get_mode
,
306 .set_suspend_mode
= max77802_set_suspend_mode
,
310 static const struct regulator_ops max77802_buck_16_dvs_ops
= {
311 .list_voltage
= regulator_list_voltage_linear
,
312 .map_voltage
= regulator_map_voltage_linear
,
313 .is_enabled
= regulator_is_enabled_regmap
,
314 .enable
= max77802_enable
,
315 .disable
= regulator_disable_regmap
,
316 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
317 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
318 .set_voltage_time_sel
= regulator_set_voltage_time_sel
,
319 .set_ramp_delay
= max77802_set_ramp_delay_4bit
,
320 .set_suspend_disable
= max77802_set_suspend_disable
,
324 static const struct regulator_ops max77802_buck_234_ops
= {
325 .list_voltage
= regulator_list_voltage_linear
,
326 .map_voltage
= regulator_map_voltage_linear
,
327 .is_enabled
= regulator_is_enabled_regmap
,
328 .enable
= max77802_enable
,
329 .disable
= regulator_disable_regmap
,
330 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
331 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
332 .set_voltage_time_sel
= regulator_set_voltage_time_sel
,
333 .set_ramp_delay
= max77802_set_ramp_delay_2bit
,
334 .set_suspend_disable
= max77802_set_suspend_disable
,
335 .set_suspend_mode
= max77802_set_suspend_mode
,
339 static const struct regulator_ops max77802_buck_dvs_ops
= {
340 .list_voltage
= regulator_list_voltage_linear
,
341 .map_voltage
= regulator_map_voltage_linear
,
342 .is_enabled
= regulator_is_enabled_regmap
,
343 .enable
= max77802_enable
,
344 .disable
= regulator_disable_regmap
,
345 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
346 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
347 .set_voltage_time_sel
= regulator_set_voltage_time_sel
,
348 .set_ramp_delay
= max77802_set_ramp_delay_2bit
,
349 .set_suspend_disable
= max77802_set_suspend_disable
,
352 /* LDOs 3-7, 9-14, 18-26, 28, 29, 32-34 */
353 #define regulator_77802_desc_p_ldo(num, supply, log) { \
355 .of_match = of_match_ptr("LDO"#num), \
356 .regulators_node = of_match_ptr("regulators"), \
357 .id = MAX77802_LDO##num, \
358 .supply_name = "inl"#supply, \
359 .ops = &max77802_ldo_ops_logic##log, \
360 .type = REGULATOR_VOLTAGE, \
361 .owner = THIS_MODULE, \
364 .ramp_delay = MAX77802_RAMP_DELAY, \
365 .n_voltages = 1 << 6, \
366 .vsel_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
367 .vsel_mask = MAX77802_VSEL_MASK, \
368 .enable_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
369 .enable_mask = MAX77802_OPMODE_MASK << MAX77802_OPMODE_SHIFT_LDO, \
370 .of_map_mode = max77802_map_mode, \
373 /* LDOs 1, 2, 8, 15, 17, 27, 30, 35 */
374 #define regulator_77802_desc_n_ldo(num, supply, log) { \
376 .of_match = of_match_ptr("LDO"#num), \
377 .regulators_node = of_match_ptr("regulators"), \
378 .id = MAX77802_LDO##num, \
379 .supply_name = "inl"#supply, \
380 .ops = &max77802_ldo_ops_logic##log, \
381 .type = REGULATOR_VOLTAGE, \
382 .owner = THIS_MODULE, \
385 .ramp_delay = MAX77802_RAMP_DELAY, \
386 .n_voltages = 1 << 6, \
387 .vsel_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
388 .vsel_mask = MAX77802_VSEL_MASK, \
389 .enable_reg = MAX77802_REG_LDO1CTRL1 + num - 1, \
390 .enable_mask = MAX77802_OPMODE_MASK << MAX77802_OPMODE_SHIFT_LDO, \
391 .of_map_mode = max77802_map_mode, \
395 #define regulator_77802_desc_16_buck(num) { \
396 .name = "BUCK"#num, \
397 .of_match = of_match_ptr("BUCK"#num), \
398 .regulators_node = of_match_ptr("regulators"), \
399 .id = MAX77802_BUCK##num, \
400 .supply_name = "inb"#num, \
401 .ops = &max77802_buck_16_dvs_ops, \
402 .type = REGULATOR_VOLTAGE, \
403 .owner = THIS_MODULE, \
406 .ramp_delay = MAX77802_RAMP_DELAY, \
407 .n_voltages = 1 << 8, \
408 .vsel_reg = MAX77802_REG_BUCK ## num ## DVS1, \
409 .vsel_mask = MAX77802_DVS_VSEL_MASK, \
410 .enable_reg = MAX77802_REG_BUCK ## num ## CTRL, \
411 .enable_mask = MAX77802_OPMODE_MASK, \
412 .of_map_mode = max77802_map_mode, \
416 #define regulator_77802_desc_234_buck(num) { \
417 .name = "BUCK"#num, \
418 .of_match = of_match_ptr("BUCK"#num), \
419 .regulators_node = of_match_ptr("regulators"), \
420 .id = MAX77802_BUCK##num, \
421 .supply_name = "inb"#num, \
422 .ops = &max77802_buck_234_ops, \
423 .type = REGULATOR_VOLTAGE, \
424 .owner = THIS_MODULE, \
427 .ramp_delay = MAX77802_RAMP_DELAY, \
428 .n_voltages = 0x91, \
429 .vsel_reg = MAX77802_REG_BUCK ## num ## DVS1, \
430 .vsel_mask = MAX77802_DVS_VSEL_MASK, \
431 .enable_reg = MAX77802_REG_BUCK ## num ## CTRL1, \
432 .enable_mask = MAX77802_OPMODE_MASK << \
433 MAX77802_OPMODE_BUCK234_SHIFT, \
434 .of_map_mode = max77802_map_mode, \
438 #define regulator_77802_desc_buck5(num) { \
439 .name = "BUCK"#num, \
440 .of_match = of_match_ptr("BUCK"#num), \
441 .regulators_node = of_match_ptr("regulators"), \
442 .id = MAX77802_BUCK##num, \
443 .supply_name = "inb"#num, \
444 .ops = &max77802_buck_dvs_ops, \
445 .type = REGULATOR_VOLTAGE, \
446 .owner = THIS_MODULE, \
449 .ramp_delay = MAX77802_RAMP_DELAY, \
450 .n_voltages = 1 << 6, \
451 .vsel_reg = MAX77802_REG_BUCK5OUT, \
452 .vsel_mask = MAX77802_VSEL_MASK, \
453 .enable_reg = MAX77802_REG_BUCK5CTRL, \
454 .enable_mask = MAX77802_OPMODE_MASK, \
455 .of_map_mode = max77802_map_mode, \
459 #define regulator_77802_desc_buck7_10(num) { \
460 .name = "BUCK"#num, \
461 .of_match = of_match_ptr("BUCK"#num), \
462 .regulators_node = of_match_ptr("regulators"), \
463 .id = MAX77802_BUCK##num, \
464 .supply_name = "inb"#num, \
465 .ops = &max77802_buck_dvs_ops, \
466 .type = REGULATOR_VOLTAGE, \
467 .owner = THIS_MODULE, \
470 .ramp_delay = MAX77802_RAMP_DELAY, \
471 .n_voltages = 1 << 6, \
472 .vsel_reg = MAX77802_REG_BUCK7OUT + (num - 7) * 3, \
473 .vsel_mask = MAX77802_VSEL_MASK, \
474 .enable_reg = MAX77802_REG_BUCK7CTRL + (num - 7) * 3, \
475 .enable_mask = MAX77802_OPMODE_MASK, \
476 .of_map_mode = max77802_map_mode, \
479 static const struct regulator_desc regulators
[] = {
480 regulator_77802_desc_16_buck(1),
481 regulator_77802_desc_234_buck(2),
482 regulator_77802_desc_234_buck(3),
483 regulator_77802_desc_234_buck(4),
484 regulator_77802_desc_buck5(5),
485 regulator_77802_desc_16_buck(6),
486 regulator_77802_desc_buck7_10(7),
487 regulator_77802_desc_buck7_10(8),
488 regulator_77802_desc_buck7_10(9),
489 regulator_77802_desc_buck7_10(10),
490 regulator_77802_desc_n_ldo(1, 10, 2),
491 regulator_77802_desc_n_ldo(2, 10, 1),
492 regulator_77802_desc_p_ldo(3, 3, 2),
493 regulator_77802_desc_p_ldo(4, 6, 1),
494 regulator_77802_desc_p_ldo(5, 3, 1),
495 regulator_77802_desc_p_ldo(6, 3, 1),
496 regulator_77802_desc_p_ldo(7, 3, 1),
497 regulator_77802_desc_n_ldo(8, 1, 1),
498 regulator_77802_desc_p_ldo(9, 5, 1),
499 regulator_77802_desc_p_ldo(10, 4, 1),
500 regulator_77802_desc_p_ldo(11, 4, 1),
501 regulator_77802_desc_p_ldo(12, 9, 1),
502 regulator_77802_desc_p_ldo(13, 4, 1),
503 regulator_77802_desc_p_ldo(14, 4, 1),
504 regulator_77802_desc_n_ldo(15, 1, 1),
505 regulator_77802_desc_n_ldo(17, 2, 1),
506 regulator_77802_desc_p_ldo(18, 7, 1),
507 regulator_77802_desc_p_ldo(19, 5, 1),
508 regulator_77802_desc_p_ldo(20, 7, 2),
509 regulator_77802_desc_p_ldo(21, 6, 2),
510 regulator_77802_desc_p_ldo(23, 9, 1),
511 regulator_77802_desc_p_ldo(24, 6, 1),
512 regulator_77802_desc_p_ldo(25, 9, 1),
513 regulator_77802_desc_p_ldo(26, 9, 1),
514 regulator_77802_desc_n_ldo(27, 2, 1),
515 regulator_77802_desc_p_ldo(28, 7, 1),
516 regulator_77802_desc_p_ldo(29, 7, 1),
517 regulator_77802_desc_n_ldo(30, 2, 1),
518 regulator_77802_desc_p_ldo(32, 9, 1),
519 regulator_77802_desc_p_ldo(33, 6, 1),
520 regulator_77802_desc_p_ldo(34, 9, 1),
521 regulator_77802_desc_n_ldo(35, 2, 1),
524 static int max77802_pmic_probe(struct platform_device
*pdev
)
526 struct max77686_dev
*iodev
= dev_get_drvdata(pdev
->dev
.parent
);
527 struct max77802_regulator_prv
*max77802
;
529 struct regulator_config config
= { };
531 max77802
= devm_kzalloc(&pdev
->dev
,
532 sizeof(struct max77802_regulator_prv
),
537 config
.dev
= iodev
->dev
;
538 config
.regmap
= iodev
->regmap
;
539 config
.driver_data
= max77802
;
540 platform_set_drvdata(pdev
, max77802
);
542 for (i
= 0; i
< MAX77802_REG_MAX
; i
++) {
543 struct regulator_dev
*rdev
;
544 int id
= regulators
[i
].id
;
545 int shift
= max77802_get_opmode_shift(id
);
548 ret
= regmap_read(iodev
->regmap
, regulators
[i
].enable_reg
, &val
);
551 "cannot read current mode for %d\n", i
);
552 val
= MAX77802_OPMODE_NORMAL
;
554 val
= val
>> shift
& MAX77802_OPMODE_MASK
;
558 * If the regulator is disabled and the system warm rebooted,
559 * the hardware reports OFF as the regulator operating mode.
560 * Default to operating mode NORMAL in that case.
562 if (val
== MAX77802_STATUS_OFF
)
563 max77802
->opmode
[id
] = MAX77802_OPMODE_NORMAL
;
565 max77802
->opmode
[id
] = val
;
567 rdev
= devm_regulator_register(&pdev
->dev
,
568 ®ulators
[i
], &config
);
572 "regulator init failed for %d: %d\n", i
, ret
);
580 static const struct platform_device_id max77802_pmic_id
[] = {
581 {"max77802-pmic", 0},
584 MODULE_DEVICE_TABLE(platform
, max77802_pmic_id
);
586 static struct platform_driver max77802_pmic_driver
= {
588 .name
= "max77802-pmic",
590 .probe
= max77802_pmic_probe
,
591 .id_table
= max77802_pmic_id
,
594 module_platform_driver(max77802_pmic_driver
);
596 MODULE_DESCRIPTION("MAXIM 77802 Regulator Driver");
597 MODULE_AUTHOR("Simon Glass <sjg@chromium.org>");
598 MODULE_LICENSE("GPL");