]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blob - drivers/regulator/max77686-regulator.c
net: stmmac: dwmac-intel-plat: fix error return code in intel_eth_plat_probe()
[mirror_ubuntu-hirsute-kernel.git] / drivers / regulator / max77686-regulator.c
1 // SPDX-License-Identifier: GPL-2.0+
2 //
3 // max77686.c - Regulator driver for the Maxim 77686
4 //
5 // Copyright (C) 2012 Samsung Electronics
6 // Chiwoong Byun <woong.byun@samsung.com>
7 // Jonghwa Lee <jonghwa3.lee@samsung.com>
8 //
9 // This driver is based on max8997.c
10
11 #include <linux/kernel.h>
12 #include <linux/bug.h>
13 #include <linux/err.h>
14 #include <linux/gpio/consumer.h>
15 #include <linux/slab.h>
16 #include <linux/platform_device.h>
17 #include <linux/regulator/driver.h>
18 #include <linux/regulator/machine.h>
19 #include <linux/regulator/of_regulator.h>
20 #include <linux/mfd/max77686.h>
21 #include <linux/mfd/max77686-private.h>
22
23 #define MAX77686_LDO_MINUV 800000
24 #define MAX77686_LDO_UVSTEP 50000
25 #define MAX77686_LDO_LOW_MINUV 800000
26 #define MAX77686_LDO_LOW_UVSTEP 25000
27 #define MAX77686_BUCK_MINUV 750000
28 #define MAX77686_BUCK_UVSTEP 50000
29 #define MAX77686_BUCK_ENABLE_TIME 40 /* us */
30 #define MAX77686_DVS_ENABLE_TIME 22 /* us */
31 #define MAX77686_RAMP_DELAY 100000 /* uV/us */
32 #define MAX77686_DVS_RAMP_DELAY 27500 /* uV/us */
33 #define MAX77686_DVS_MINUV 600000
34 #define MAX77686_DVS_UVSTEP 12500
35
36 /*
37 * Value for configuring buck[89] and LDO{20,21,22} as GPIO control.
38 * It is the same as 'off' for other regulators.
39 */
40 #define MAX77686_GPIO_CONTROL 0x0
41 /*
42 * Values used for configuring LDOs and bucks.
43 * Forcing low power mode: LDO1, 3-5, 9, 13, 17-26
44 */
45 #define MAX77686_LDO_LOWPOWER 0x1
46 /*
47 * On/off controlled by PWRREQ:
48 * - LDO2, 6-8, 10-12, 14-16
49 * - buck[1234]
50 */
51 #define MAX77686_OFF_PWRREQ 0x1
52 /* Low power mode controlled by PWRREQ: All LDOs */
53 #define MAX77686_LDO_LOWPOWER_PWRREQ 0x2
54 /* Forcing low power mode: buck[234] */
55 #define MAX77686_BUCK_LOWPOWER 0x2
56 #define MAX77686_NORMAL 0x3
57
58 #define MAX77686_OPMODE_SHIFT 6
59 #define MAX77686_OPMODE_BUCK234_SHIFT 4
60 #define MAX77686_OPMODE_MASK 0x3
61
62 #define MAX77686_VSEL_MASK 0x3F
63 #define MAX77686_DVS_VSEL_MASK 0xFF
64
65 #define MAX77686_RAMP_RATE_MASK 0xC0
66
67 #define MAX77686_REGULATORS MAX77686_REG_MAX
68 #define MAX77686_LDOS 26
69
70 enum max77686_ramp_rate {
71 RAMP_RATE_13P75MV,
72 RAMP_RATE_27P5MV,
73 RAMP_RATE_55MV,
74 RAMP_RATE_NO_CTRL, /* 100mV/us */
75 };
76
77 struct max77686_data {
78 struct device *dev;
79 DECLARE_BITMAP(gpio_enabled, MAX77686_REGULATORS);
80
81 /* Array indexed by regulator id */
82 unsigned int opmode[MAX77686_REGULATORS];
83 };
84
85 static unsigned int max77686_get_opmode_shift(int id)
86 {
87 switch (id) {
88 case MAX77686_BUCK1:
89 case MAX77686_BUCK5 ... MAX77686_BUCK9:
90 return 0;
91 case MAX77686_BUCK2 ... MAX77686_BUCK4:
92 return MAX77686_OPMODE_BUCK234_SHIFT;
93 default:
94 /* all LDOs */
95 return MAX77686_OPMODE_SHIFT;
96 }
97 }
98
99 /*
100 * When regulator is configured for GPIO control then it
101 * replaces "normal" mode. Any change from low power mode to normal
102 * should actually change to GPIO control.
103 * Map normal mode to proper value for such regulators.
104 */
105 static unsigned int max77686_map_normal_mode(struct max77686_data *max77686,
106 int id)
107 {
108 switch (id) {
109 case MAX77686_BUCK8:
110 case MAX77686_BUCK9:
111 case MAX77686_LDO20 ... MAX77686_LDO22:
112 if (test_bit(id, max77686->gpio_enabled))
113 return MAX77686_GPIO_CONTROL;
114 }
115
116 return MAX77686_NORMAL;
117 }
118
119 /* Some BUCKs and LDOs supports Normal[ON/OFF] mode during suspend */
120 static int max77686_set_suspend_disable(struct regulator_dev *rdev)
121 {
122 unsigned int val, shift;
123 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
124 int ret, id = rdev_get_id(rdev);
125
126 shift = max77686_get_opmode_shift(id);
127 val = MAX77686_OFF_PWRREQ;
128
129 ret = regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
130 rdev->desc->enable_mask, val << shift);
131 if (ret)
132 return ret;
133
134 max77686->opmode[id] = val;
135 return 0;
136 }
137
138 /* Some LDOs supports [LPM/Normal]ON mode during suspend state */
139 static int max77686_set_suspend_mode(struct regulator_dev *rdev,
140 unsigned int mode)
141 {
142 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
143 unsigned int val;
144 int ret, id = rdev_get_id(rdev);
145
146 /* BUCK[5-9] doesn't support this feature */
147 if (id >= MAX77686_BUCK5)
148 return 0;
149
150 switch (mode) {
151 case REGULATOR_MODE_IDLE: /* ON in LP Mode */
152 val = MAX77686_LDO_LOWPOWER_PWRREQ;
153 break;
154 case REGULATOR_MODE_NORMAL: /* ON in Normal Mode */
155 val = max77686_map_normal_mode(max77686, id);
156 break;
157 default:
158 pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
159 rdev->desc->name, mode);
160 return -EINVAL;
161 }
162
163 ret = regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
164 rdev->desc->enable_mask,
165 val << MAX77686_OPMODE_SHIFT);
166 if (ret)
167 return ret;
168
169 max77686->opmode[id] = val;
170 return 0;
171 }
172
173 /* Some LDOs supports LPM-ON/OFF/Normal-ON mode during suspend state */
174 static int max77686_ldo_set_suspend_mode(struct regulator_dev *rdev,
175 unsigned int mode)
176 {
177 unsigned int val;
178 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
179 int ret, id = rdev_get_id(rdev);
180
181 switch (mode) {
182 case REGULATOR_MODE_STANDBY: /* switch off */
183 val = MAX77686_OFF_PWRREQ;
184 break;
185 case REGULATOR_MODE_IDLE: /* ON in LP Mode */
186 val = MAX77686_LDO_LOWPOWER_PWRREQ;
187 break;
188 case REGULATOR_MODE_NORMAL: /* ON in Normal Mode */
189 val = max77686_map_normal_mode(max77686, id);
190 break;
191 default:
192 pr_warn("%s: regulator_suspend_mode : 0x%x not supported\n",
193 rdev->desc->name, mode);
194 return -EINVAL;
195 }
196
197 ret = regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
198 rdev->desc->enable_mask,
199 val << MAX77686_OPMODE_SHIFT);
200 if (ret)
201 return ret;
202
203 max77686->opmode[id] = val;
204 return 0;
205 }
206
207 static int max77686_enable(struct regulator_dev *rdev)
208 {
209 struct max77686_data *max77686 = rdev_get_drvdata(rdev);
210 unsigned int shift;
211 int id = rdev_get_id(rdev);
212
213 shift = max77686_get_opmode_shift(id);
214
215 if (max77686->opmode[id] == MAX77686_OFF_PWRREQ)
216 max77686->opmode[id] = max77686_map_normal_mode(max77686, id);
217
218 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
219 rdev->desc->enable_mask,
220 max77686->opmode[id] << shift);
221 }
222
223 static int max77686_set_ramp_delay(struct regulator_dev *rdev, int ramp_delay)
224 {
225 unsigned int ramp_value = RAMP_RATE_NO_CTRL;
226
227 switch (ramp_delay) {
228 case 1 ... 13750:
229 ramp_value = RAMP_RATE_13P75MV;
230 break;
231 case 13751 ... 27500:
232 ramp_value = RAMP_RATE_27P5MV;
233 break;
234 case 27501 ... 55000:
235 ramp_value = RAMP_RATE_55MV;
236 break;
237 case 55001 ... 100000:
238 break;
239 default:
240 pr_warn("%s: ramp_delay: %d not supported, setting 100000\n",
241 rdev->desc->name, ramp_delay);
242 }
243
244 return regmap_update_bits(rdev->regmap, rdev->desc->enable_reg,
245 MAX77686_RAMP_RATE_MASK, ramp_value << 6);
246 }
247
248 static int max77686_of_parse_cb(struct device_node *np,
249 const struct regulator_desc *desc,
250 struct regulator_config *config)
251 {
252 struct max77686_data *max77686 = config->driver_data;
253 int ret;
254
255 switch (desc->id) {
256 case MAX77686_BUCK8:
257 case MAX77686_BUCK9:
258 case MAX77686_LDO20 ... MAX77686_LDO22:
259 config->ena_gpiod = fwnode_gpiod_get_index(
260 of_fwnode_handle(np),
261 "maxim,ena",
262 0,
263 GPIOD_OUT_HIGH | GPIOD_FLAGS_BIT_NONEXCLUSIVE,
264 "max77686-regulator");
265 if (IS_ERR(config->ena_gpiod))
266 config->ena_gpiod = NULL;
267 break;
268 default:
269 return 0;
270 }
271
272 if (config->ena_gpiod) {
273 set_bit(desc->id, max77686->gpio_enabled);
274
275 ret = regmap_update_bits(config->regmap, desc->enable_reg,
276 desc->enable_mask,
277 MAX77686_GPIO_CONTROL);
278 if (ret) {
279 gpiod_put(config->ena_gpiod);
280 config->ena_gpiod = NULL;
281 }
282 }
283
284 return 0;
285 }
286
287 static const struct regulator_ops max77686_ops = {
288 .list_voltage = regulator_list_voltage_linear,
289 .map_voltage = regulator_map_voltage_linear,
290 .is_enabled = regulator_is_enabled_regmap,
291 .enable = max77686_enable,
292 .disable = regulator_disable_regmap,
293 .get_voltage_sel = regulator_get_voltage_sel_regmap,
294 .set_voltage_sel = regulator_set_voltage_sel_regmap,
295 .set_voltage_time_sel = regulator_set_voltage_time_sel,
296 .set_suspend_mode = max77686_set_suspend_mode,
297 };
298
299 static const struct regulator_ops max77686_ldo_ops = {
300 .list_voltage = regulator_list_voltage_linear,
301 .map_voltage = regulator_map_voltage_linear,
302 .is_enabled = regulator_is_enabled_regmap,
303 .enable = max77686_enable,
304 .disable = regulator_disable_regmap,
305 .get_voltage_sel = regulator_get_voltage_sel_regmap,
306 .set_voltage_sel = regulator_set_voltage_sel_regmap,
307 .set_voltage_time_sel = regulator_set_voltage_time_sel,
308 .set_suspend_mode = max77686_ldo_set_suspend_mode,
309 .set_suspend_disable = max77686_set_suspend_disable,
310 };
311
312 static const struct regulator_ops max77686_buck1_ops = {
313 .list_voltage = regulator_list_voltage_linear,
314 .map_voltage = regulator_map_voltage_linear,
315 .is_enabled = regulator_is_enabled_regmap,
316 .enable = max77686_enable,
317 .disable = regulator_disable_regmap,
318 .get_voltage_sel = regulator_get_voltage_sel_regmap,
319 .set_voltage_sel = regulator_set_voltage_sel_regmap,
320 .set_voltage_time_sel = regulator_set_voltage_time_sel,
321 .set_suspend_disable = max77686_set_suspend_disable,
322 };
323
324 static const struct regulator_ops max77686_buck_dvs_ops = {
325 .list_voltage = regulator_list_voltage_linear,
326 .map_voltage = regulator_map_voltage_linear,
327 .is_enabled = regulator_is_enabled_regmap,
328 .enable = max77686_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 = max77686_set_ramp_delay,
334 .set_suspend_disable = max77686_set_suspend_disable,
335 };
336
337 #define regulator_desc_ldo(num) { \
338 .name = "LDO"#num, \
339 .of_match = of_match_ptr("LDO"#num), \
340 .regulators_node = of_match_ptr("voltage-regulators"), \
341 .of_parse_cb = max77686_of_parse_cb, \
342 .id = MAX77686_LDO##num, \
343 .ops = &max77686_ops, \
344 .type = REGULATOR_VOLTAGE, \
345 .owner = THIS_MODULE, \
346 .min_uV = MAX77686_LDO_MINUV, \
347 .uV_step = MAX77686_LDO_UVSTEP, \
348 .ramp_delay = MAX77686_RAMP_DELAY, \
349 .n_voltages = MAX77686_VSEL_MASK + 1, \
350 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
351 .vsel_mask = MAX77686_VSEL_MASK, \
352 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
353 .enable_mask = MAX77686_OPMODE_MASK \
354 << MAX77686_OPMODE_SHIFT, \
355 }
356 #define regulator_desc_lpm_ldo(num) { \
357 .name = "LDO"#num, \
358 .of_match = of_match_ptr("LDO"#num), \
359 .regulators_node = of_match_ptr("voltage-regulators"), \
360 .id = MAX77686_LDO##num, \
361 .ops = &max77686_ldo_ops, \
362 .type = REGULATOR_VOLTAGE, \
363 .owner = THIS_MODULE, \
364 .min_uV = MAX77686_LDO_MINUV, \
365 .uV_step = MAX77686_LDO_UVSTEP, \
366 .ramp_delay = MAX77686_RAMP_DELAY, \
367 .n_voltages = MAX77686_VSEL_MASK + 1, \
368 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
369 .vsel_mask = MAX77686_VSEL_MASK, \
370 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
371 .enable_mask = MAX77686_OPMODE_MASK \
372 << MAX77686_OPMODE_SHIFT, \
373 }
374 #define regulator_desc_ldo_low(num) { \
375 .name = "LDO"#num, \
376 .of_match = of_match_ptr("LDO"#num), \
377 .regulators_node = of_match_ptr("voltage-regulators"), \
378 .id = MAX77686_LDO##num, \
379 .ops = &max77686_ldo_ops, \
380 .type = REGULATOR_VOLTAGE, \
381 .owner = THIS_MODULE, \
382 .min_uV = MAX77686_LDO_LOW_MINUV, \
383 .uV_step = MAX77686_LDO_LOW_UVSTEP, \
384 .ramp_delay = MAX77686_RAMP_DELAY, \
385 .n_voltages = MAX77686_VSEL_MASK + 1, \
386 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
387 .vsel_mask = MAX77686_VSEL_MASK, \
388 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
389 .enable_mask = MAX77686_OPMODE_MASK \
390 << MAX77686_OPMODE_SHIFT, \
391 }
392 #define regulator_desc_ldo1_low(num) { \
393 .name = "LDO"#num, \
394 .of_match = of_match_ptr("LDO"#num), \
395 .regulators_node = of_match_ptr("voltage-regulators"), \
396 .id = MAX77686_LDO##num, \
397 .ops = &max77686_ops, \
398 .type = REGULATOR_VOLTAGE, \
399 .owner = THIS_MODULE, \
400 .min_uV = MAX77686_LDO_LOW_MINUV, \
401 .uV_step = MAX77686_LDO_LOW_UVSTEP, \
402 .ramp_delay = MAX77686_RAMP_DELAY, \
403 .n_voltages = MAX77686_VSEL_MASK + 1, \
404 .vsel_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
405 .vsel_mask = MAX77686_VSEL_MASK, \
406 .enable_reg = MAX77686_REG_LDO1CTRL1 + num - 1, \
407 .enable_mask = MAX77686_OPMODE_MASK \
408 << MAX77686_OPMODE_SHIFT, \
409 }
410 #define regulator_desc_buck(num) { \
411 .name = "BUCK"#num, \
412 .of_match = of_match_ptr("BUCK"#num), \
413 .regulators_node = of_match_ptr("voltage-regulators"), \
414 .of_parse_cb = max77686_of_parse_cb, \
415 .id = MAX77686_BUCK##num, \
416 .ops = &max77686_ops, \
417 .type = REGULATOR_VOLTAGE, \
418 .owner = THIS_MODULE, \
419 .min_uV = MAX77686_BUCK_MINUV, \
420 .uV_step = MAX77686_BUCK_UVSTEP, \
421 .ramp_delay = MAX77686_RAMP_DELAY, \
422 .enable_time = MAX77686_BUCK_ENABLE_TIME, \
423 .n_voltages = MAX77686_VSEL_MASK + 1, \
424 .vsel_reg = MAX77686_REG_BUCK5OUT + (num - 5) * 2, \
425 .vsel_mask = MAX77686_VSEL_MASK, \
426 .enable_reg = MAX77686_REG_BUCK5CTRL + (num - 5) * 2, \
427 .enable_mask = MAX77686_OPMODE_MASK, \
428 }
429 #define regulator_desc_buck1(num) { \
430 .name = "BUCK"#num, \
431 .of_match = of_match_ptr("BUCK"#num), \
432 .regulators_node = of_match_ptr("voltage-regulators"), \
433 .id = MAX77686_BUCK##num, \
434 .ops = &max77686_buck1_ops, \
435 .type = REGULATOR_VOLTAGE, \
436 .owner = THIS_MODULE, \
437 .min_uV = MAX77686_BUCK_MINUV, \
438 .uV_step = MAX77686_BUCK_UVSTEP, \
439 .ramp_delay = MAX77686_RAMP_DELAY, \
440 .enable_time = MAX77686_BUCK_ENABLE_TIME, \
441 .n_voltages = MAX77686_VSEL_MASK + 1, \
442 .vsel_reg = MAX77686_REG_BUCK1OUT, \
443 .vsel_mask = MAX77686_VSEL_MASK, \
444 .enable_reg = MAX77686_REG_BUCK1CTRL, \
445 .enable_mask = MAX77686_OPMODE_MASK, \
446 }
447 #define regulator_desc_buck_dvs(num) { \
448 .name = "BUCK"#num, \
449 .of_match = of_match_ptr("BUCK"#num), \
450 .regulators_node = of_match_ptr("voltage-regulators"), \
451 .id = MAX77686_BUCK##num, \
452 .ops = &max77686_buck_dvs_ops, \
453 .type = REGULATOR_VOLTAGE, \
454 .owner = THIS_MODULE, \
455 .min_uV = MAX77686_DVS_MINUV, \
456 .uV_step = MAX77686_DVS_UVSTEP, \
457 .ramp_delay = MAX77686_DVS_RAMP_DELAY, \
458 .enable_time = MAX77686_DVS_ENABLE_TIME, \
459 .n_voltages = MAX77686_DVS_VSEL_MASK + 1, \
460 .vsel_reg = MAX77686_REG_BUCK2DVS1 + (num - 2) * 10, \
461 .vsel_mask = MAX77686_DVS_VSEL_MASK, \
462 .enable_reg = MAX77686_REG_BUCK2CTRL1 + (num - 2) * 10, \
463 .enable_mask = MAX77686_OPMODE_MASK \
464 << MAX77686_OPMODE_BUCK234_SHIFT, \
465 }
466
467 static const struct regulator_desc regulators[] = {
468 regulator_desc_ldo1_low(1),
469 regulator_desc_ldo_low(2),
470 regulator_desc_ldo(3),
471 regulator_desc_ldo(4),
472 regulator_desc_ldo(5),
473 regulator_desc_ldo_low(6),
474 regulator_desc_ldo_low(7),
475 regulator_desc_ldo_low(8),
476 regulator_desc_ldo(9),
477 regulator_desc_lpm_ldo(10),
478 regulator_desc_lpm_ldo(11),
479 regulator_desc_lpm_ldo(12),
480 regulator_desc_ldo(13),
481 regulator_desc_lpm_ldo(14),
482 regulator_desc_ldo_low(15),
483 regulator_desc_lpm_ldo(16),
484 regulator_desc_ldo(17),
485 regulator_desc_ldo(18),
486 regulator_desc_ldo(19),
487 regulator_desc_ldo(20),
488 regulator_desc_ldo(21),
489 regulator_desc_ldo(22),
490 regulator_desc_ldo(23),
491 regulator_desc_ldo(24),
492 regulator_desc_ldo(25),
493 regulator_desc_ldo(26),
494 regulator_desc_buck1(1),
495 regulator_desc_buck_dvs(2),
496 regulator_desc_buck_dvs(3),
497 regulator_desc_buck_dvs(4),
498 regulator_desc_buck(5),
499 regulator_desc_buck(6),
500 regulator_desc_buck(7),
501 regulator_desc_buck(8),
502 regulator_desc_buck(9),
503 };
504
505 static int max77686_pmic_probe(struct platform_device *pdev)
506 {
507 struct max77686_dev *iodev = dev_get_drvdata(pdev->dev.parent);
508 struct max77686_data *max77686;
509 int i;
510 struct regulator_config config = { };
511
512 dev_dbg(&pdev->dev, "%s\n", __func__);
513
514 max77686 = devm_kzalloc(&pdev->dev, sizeof(struct max77686_data),
515 GFP_KERNEL);
516 if (!max77686)
517 return -ENOMEM;
518
519 max77686->dev = &pdev->dev;
520 config.dev = iodev->dev;
521 config.regmap = iodev->regmap;
522 config.driver_data = max77686;
523 platform_set_drvdata(pdev, max77686);
524
525 for (i = 0; i < MAX77686_REGULATORS; i++) {
526 struct regulator_dev *rdev;
527 int id = regulators[i].id;
528
529 max77686->opmode[id] = MAX77686_NORMAL;
530 rdev = devm_regulator_register(&pdev->dev,
531 &regulators[i], &config);
532 if (IS_ERR(rdev)) {
533 int ret = PTR_ERR(rdev);
534 dev_err(&pdev->dev,
535 "regulator init failed for %d: %d\n", i, ret);
536 return ret;
537 }
538 }
539
540 return 0;
541 }
542
543 static const struct platform_device_id max77686_pmic_id[] = {
544 {"max77686-pmic", 0},
545 { },
546 };
547 MODULE_DEVICE_TABLE(platform, max77686_pmic_id);
548
549 static struct platform_driver max77686_pmic_driver = {
550 .driver = {
551 .name = "max77686-pmic",
552 },
553 .probe = max77686_pmic_probe,
554 .id_table = max77686_pmic_id,
555 };
556
557 module_platform_driver(max77686_pmic_driver);
558
559 MODULE_DESCRIPTION("MAXIM 77686 Regulator Driver");
560 MODULE_AUTHOR("Chiwoong Byun <woong.byun@samsung.com>");
561 MODULE_LICENSE("GPL");