Loading...
1/*
2 * drivers/regulator/ab3100.c
3 *
4 * Copyright (C) 2008-2009 ST-Ericsson AB
5 * License terms: GNU General Public License (GPL) version 2
6 * Low-level control of the AB3100 IC Low Dropout (LDO)
7 * regulators, external regulator and buck converter
8 * Author: Mattias Wallin <mattias.wallin@stericsson.com>
9 * Author: Linus Walleij <linus.walleij@stericsson.com>
10 */
11
12#include <linux/module.h>
13#include <linux/kernel.h>
14#include <linux/init.h>
15#include <linux/err.h>
16#include <linux/delay.h>
17#include <linux/platform_device.h>
18#include <linux/regulator/driver.h>
19#include <linux/mfd/abx500.h>
20
21/* LDO registers and some handy masking definitions for AB3100 */
22#define AB3100_LDO_A 0x40
23#define AB3100_LDO_C 0x41
24#define AB3100_LDO_D 0x42
25#define AB3100_LDO_E 0x43
26#define AB3100_LDO_E_SLEEP 0x44
27#define AB3100_LDO_F 0x45
28#define AB3100_LDO_G 0x46
29#define AB3100_LDO_H 0x47
30#define AB3100_LDO_H_SLEEP_MODE 0
31#define AB3100_LDO_H_SLEEP_EN 2
32#define AB3100_LDO_ON 4
33#define AB3100_LDO_H_VSEL_AC 5
34#define AB3100_LDO_K 0x48
35#define AB3100_LDO_EXT 0x49
36#define AB3100_BUCK 0x4A
37#define AB3100_BUCK_SLEEP 0x4B
38#define AB3100_REG_ON_MASK 0x10
39
40/**
41 * struct ab3100_regulator
42 * A struct passed around the individual regulator functions
43 * @platform_device: platform device holding this regulator
44 * @dev: handle to the device
45 * @plfdata: AB3100 platform data passed in at probe time
46 * @regreg: regulator register number in the AB3100
47 * @fixed_voltage: a fixed voltage for this regulator, if this
48 * 0 the voltages array is used instead.
49 * @typ_voltages: an array of available typical voltages for
50 * this regulator
51 * @voltages_len: length of the array of available voltages
52 */
53struct ab3100_regulator {
54 struct regulator_dev *rdev;
55 struct device *dev;
56 struct ab3100_platform_data *plfdata;
57 u8 regreg;
58 int fixed_voltage;
59 int const *typ_voltages;
60 u8 voltages_len;
61};
62
63/* The order in which registers are initialized */
64static const u8 ab3100_reg_init_order[AB3100_NUM_REGULATORS+2] = {
65 AB3100_LDO_A,
66 AB3100_LDO_C,
67 AB3100_LDO_E,
68 AB3100_LDO_E_SLEEP,
69 AB3100_LDO_F,
70 AB3100_LDO_G,
71 AB3100_LDO_H,
72 AB3100_LDO_K,
73 AB3100_LDO_EXT,
74 AB3100_BUCK,
75 AB3100_BUCK_SLEEP,
76 AB3100_LDO_D,
77};
78
79/* Preset (hardware defined) voltages for these regulators */
80#define LDO_A_VOLTAGE 2750000
81#define LDO_C_VOLTAGE 2650000
82#define LDO_D_VOLTAGE 2650000
83
84static const int ldo_e_buck_typ_voltages[] = {
85 1800000,
86 1400000,
87 1300000,
88 1200000,
89 1100000,
90 1050000,
91 900000,
92};
93
94static const int ldo_f_typ_voltages[] = {
95 1800000,
96 1400000,
97 1300000,
98 1200000,
99 1100000,
100 1050000,
101 2500000,
102 2650000,
103};
104
105static const int ldo_g_typ_voltages[] = {
106 2850000,
107 2750000,
108 1800000,
109 1500000,
110};
111
112static const int ldo_h_typ_voltages[] = {
113 2750000,
114 1800000,
115 1500000,
116 1200000,
117};
118
119static const int ldo_k_typ_voltages[] = {
120 2750000,
121 1800000,
122};
123
124
125/* The regulator devices */
126static struct ab3100_regulator
127ab3100_regulators[AB3100_NUM_REGULATORS] = {
128 {
129 .regreg = AB3100_LDO_A,
130 .fixed_voltage = LDO_A_VOLTAGE,
131 },
132 {
133 .regreg = AB3100_LDO_C,
134 .fixed_voltage = LDO_C_VOLTAGE,
135 },
136 {
137 .regreg = AB3100_LDO_D,
138 .fixed_voltage = LDO_D_VOLTAGE,
139 },
140 {
141 .regreg = AB3100_LDO_E,
142 .typ_voltages = ldo_e_buck_typ_voltages,
143 .voltages_len = ARRAY_SIZE(ldo_e_buck_typ_voltages),
144 },
145 {
146 .regreg = AB3100_LDO_F,
147 .typ_voltages = ldo_f_typ_voltages,
148 .voltages_len = ARRAY_SIZE(ldo_f_typ_voltages),
149 },
150 {
151 .regreg = AB3100_LDO_G,
152 .typ_voltages = ldo_g_typ_voltages,
153 .voltages_len = ARRAY_SIZE(ldo_g_typ_voltages),
154 },
155 {
156 .regreg = AB3100_LDO_H,
157 .typ_voltages = ldo_h_typ_voltages,
158 .voltages_len = ARRAY_SIZE(ldo_h_typ_voltages),
159 },
160 {
161 .regreg = AB3100_LDO_K,
162 .typ_voltages = ldo_k_typ_voltages,
163 .voltages_len = ARRAY_SIZE(ldo_k_typ_voltages),
164 },
165 {
166 .regreg = AB3100_LDO_EXT,
167 /* No voltages for the external regulator */
168 },
169 {
170 .regreg = AB3100_BUCK,
171 .typ_voltages = ldo_e_buck_typ_voltages,
172 .voltages_len = ARRAY_SIZE(ldo_e_buck_typ_voltages),
173 },
174};
175
176/*
177 * General functions for enable, disable and is_enabled used for
178 * LDO: A,C,E,F,G,H,K,EXT and BUCK
179 */
180static int ab3100_enable_regulator(struct regulator_dev *reg)
181{
182 struct ab3100_regulator *abreg = reg->reg_data;
183 int err;
184 u8 regval;
185
186 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
187 ®val);
188 if (err) {
189 dev_warn(®->dev, "failed to get regid %d value\n",
190 abreg->regreg);
191 return err;
192 }
193
194 /* The regulator is already on, no reason to go further */
195 if (regval & AB3100_REG_ON_MASK)
196 return 0;
197
198 regval |= AB3100_REG_ON_MASK;
199
200 err = abx500_set_register_interruptible(abreg->dev, 0, abreg->regreg,
201 regval);
202 if (err) {
203 dev_warn(®->dev, "failed to set regid %d value\n",
204 abreg->regreg);
205 return err;
206 }
207
208 return 0;
209}
210
211static int ab3100_disable_regulator(struct regulator_dev *reg)
212{
213 struct ab3100_regulator *abreg = reg->reg_data;
214 int err;
215 u8 regval;
216
217 /*
218 * LDO D is a special regulator. When it is disabled, the entire
219 * system is shut down. So this is handled specially.
220 */
221 pr_info("Called ab3100_disable_regulator\n");
222 if (abreg->regreg == AB3100_LDO_D) {
223 dev_info(®->dev, "disabling LDO D - shut down system\n");
224 /* Setting LDO D to 0x00 cuts the power to the SoC */
225 return abx500_set_register_interruptible(abreg->dev, 0,
226 AB3100_LDO_D, 0x00U);
227 }
228
229 /*
230 * All other regulators are handled here
231 */
232 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
233 ®val);
234 if (err) {
235 dev_err(®->dev, "unable to get register 0x%x\n",
236 abreg->regreg);
237 return err;
238 }
239 regval &= ~AB3100_REG_ON_MASK;
240 return abx500_set_register_interruptible(abreg->dev, 0, abreg->regreg,
241 regval);
242}
243
244static int ab3100_is_enabled_regulator(struct regulator_dev *reg)
245{
246 struct ab3100_regulator *abreg = reg->reg_data;
247 u8 regval;
248 int err;
249
250 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
251 ®val);
252 if (err) {
253 dev_err(®->dev, "unable to get register 0x%x\n",
254 abreg->regreg);
255 return err;
256 }
257
258 return regval & AB3100_REG_ON_MASK;
259}
260
261static int ab3100_list_voltage_regulator(struct regulator_dev *reg,
262 unsigned selector)
263{
264 struct ab3100_regulator *abreg = reg->reg_data;
265
266 if (selector >= abreg->voltages_len)
267 return -EINVAL;
268 return abreg->typ_voltages[selector];
269}
270
271static int ab3100_get_voltage_regulator(struct regulator_dev *reg)
272{
273 struct ab3100_regulator *abreg = reg->reg_data;
274 u8 regval;
275 int err;
276
277 /* Return the voltage for fixed regulators immediately */
278 if (abreg->fixed_voltage)
279 return abreg->fixed_voltage;
280
281 /*
282 * For variable types, read out setting and index into
283 * supplied voltage list.
284 */
285 err = abx500_get_register_interruptible(abreg->dev, 0,
286 abreg->regreg, ®val);
287 if (err) {
288 dev_warn(®->dev,
289 "failed to get regulator value in register %02x\n",
290 abreg->regreg);
291 return err;
292 }
293
294 /* The 3 highest bits index voltages */
295 regval &= 0xE0;
296 regval >>= 5;
297
298 if (regval >= abreg->voltages_len) {
299 dev_err(®->dev,
300 "regulator register %02x contains an illegal voltage setting\n",
301 abreg->regreg);
302 return -EINVAL;
303 }
304
305 return abreg->typ_voltages[regval];
306}
307
308static int ab3100_get_best_voltage_index(struct regulator_dev *reg,
309 int min_uV, int max_uV)
310{
311 struct ab3100_regulator *abreg = reg->reg_data;
312 int i;
313 int bestmatch;
314 int bestindex;
315
316 /*
317 * Locate the minimum voltage fitting the criteria on
318 * this regulator. The switchable voltages are not
319 * in strict falling order so we need to check them
320 * all for the best match.
321 */
322 bestmatch = INT_MAX;
323 bestindex = -1;
324 for (i = 0; i < abreg->voltages_len; i++) {
325 if (abreg->typ_voltages[i] <= max_uV &&
326 abreg->typ_voltages[i] >= min_uV &&
327 abreg->typ_voltages[i] < bestmatch) {
328 bestmatch = abreg->typ_voltages[i];
329 bestindex = i;
330 }
331 }
332
333 if (bestindex < 0) {
334 dev_warn(®->dev, "requested %d<=x<=%d uV, out of range!\n",
335 min_uV, max_uV);
336 return -EINVAL;
337 }
338 return bestindex;
339}
340
341static int ab3100_set_voltage_regulator(struct regulator_dev *reg,
342 int min_uV, int max_uV,
343 unsigned *selector)
344{
345 struct ab3100_regulator *abreg = reg->reg_data;
346 u8 regval;
347 int err;
348 int bestindex;
349
350 bestindex = ab3100_get_best_voltage_index(reg, min_uV, max_uV);
351 if (bestindex < 0)
352 return bestindex;
353
354 *selector = bestindex;
355
356 err = abx500_get_register_interruptible(abreg->dev, 0,
357 abreg->regreg, ®val);
358 if (err) {
359 dev_warn(®->dev,
360 "failed to get regulator register %02x\n",
361 abreg->regreg);
362 return err;
363 }
364
365 /* The highest three bits control the variable regulators */
366 regval &= ~0xE0;
367 regval |= (bestindex << 5);
368
369 err = abx500_set_register_interruptible(abreg->dev, 0,
370 abreg->regreg, regval);
371 if (err)
372 dev_warn(®->dev, "failed to set regulator register %02x\n",
373 abreg->regreg);
374
375 return err;
376}
377
378static int ab3100_set_suspend_voltage_regulator(struct regulator_dev *reg,
379 int uV)
380{
381 struct ab3100_regulator *abreg = reg->reg_data;
382 u8 regval;
383 int err;
384 int bestindex;
385 u8 targetreg;
386
387 if (abreg->regreg == AB3100_LDO_E)
388 targetreg = AB3100_LDO_E_SLEEP;
389 else if (abreg->regreg == AB3100_BUCK)
390 targetreg = AB3100_BUCK_SLEEP;
391 else
392 return -EINVAL;
393
394 /* LDO E and BUCK have special suspend voltages you can set */
395 bestindex = ab3100_get_best_voltage_index(reg, uV, uV);
396
397 err = abx500_get_register_interruptible(abreg->dev, 0,
398 targetreg, ®val);
399 if (err) {
400 dev_warn(®->dev,
401 "failed to get regulator register %02x\n",
402 targetreg);
403 return err;
404 }
405
406 /* The highest three bits control the variable regulators */
407 regval &= ~0xE0;
408 regval |= (bestindex << 5);
409
410 err = abx500_set_register_interruptible(abreg->dev, 0,
411 targetreg, regval);
412 if (err)
413 dev_warn(®->dev, "failed to set regulator register %02x\n",
414 abreg->regreg);
415
416 return err;
417}
418
419/*
420 * The external regulator can just define a fixed voltage.
421 */
422static int ab3100_get_voltage_regulator_external(struct regulator_dev *reg)
423{
424 struct ab3100_regulator *abreg = reg->reg_data;
425
426 return abreg->plfdata->external_voltage;
427}
428
429static int ab3100_enable_time_regulator(struct regulator_dev *reg)
430{
431 struct ab3100_regulator *abreg = reg->reg_data;
432
433 /* Per-regulator power on delay from spec */
434 switch (abreg->regreg) {
435 case AB3100_LDO_A: /* Fallthrough */
436 case AB3100_LDO_C: /* Fallthrough */
437 case AB3100_LDO_D: /* Fallthrough */
438 case AB3100_LDO_E: /* Fallthrough */
439 case AB3100_LDO_H: /* Fallthrough */
440 case AB3100_LDO_K:
441 return 200;
442 case AB3100_LDO_F:
443 return 600;
444 case AB3100_LDO_G:
445 return 400;
446 case AB3100_BUCK:
447 return 1000;
448 default:
449 break;
450 }
451 return 0;
452}
453
454static struct regulator_ops regulator_ops_fixed = {
455 .enable = ab3100_enable_regulator,
456 .disable = ab3100_disable_regulator,
457 .is_enabled = ab3100_is_enabled_regulator,
458 .get_voltage = ab3100_get_voltage_regulator,
459 .enable_time = ab3100_enable_time_regulator,
460};
461
462static struct regulator_ops regulator_ops_variable = {
463 .enable = ab3100_enable_regulator,
464 .disable = ab3100_disable_regulator,
465 .is_enabled = ab3100_is_enabled_regulator,
466 .get_voltage = ab3100_get_voltage_regulator,
467 .set_voltage = ab3100_set_voltage_regulator,
468 .list_voltage = ab3100_list_voltage_regulator,
469 .enable_time = ab3100_enable_time_regulator,
470};
471
472static struct regulator_ops regulator_ops_variable_sleepable = {
473 .enable = ab3100_enable_regulator,
474 .disable = ab3100_disable_regulator,
475 .is_enabled = ab3100_is_enabled_regulator,
476 .get_voltage = ab3100_get_voltage_regulator,
477 .set_voltage = ab3100_set_voltage_regulator,
478 .set_suspend_voltage = ab3100_set_suspend_voltage_regulator,
479 .list_voltage = ab3100_list_voltage_regulator,
480 .enable_time = ab3100_enable_time_regulator,
481};
482
483/*
484 * LDO EXT is an external regulator so it is really
485 * not possible to set any voltage locally here, AB3100
486 * is an on/off switch plain an simple. The external
487 * voltage is defined in the board set-up if any.
488 */
489static struct regulator_ops regulator_ops_external = {
490 .enable = ab3100_enable_regulator,
491 .disable = ab3100_disable_regulator,
492 .is_enabled = ab3100_is_enabled_regulator,
493 .get_voltage = ab3100_get_voltage_regulator_external,
494};
495
496static struct regulator_desc
497ab3100_regulator_desc[AB3100_NUM_REGULATORS] = {
498 {
499 .name = "LDO_A",
500 .id = AB3100_LDO_A,
501 .ops = ®ulator_ops_fixed,
502 .type = REGULATOR_VOLTAGE,
503 .owner = THIS_MODULE,
504 },
505 {
506 .name = "LDO_C",
507 .id = AB3100_LDO_C,
508 .ops = ®ulator_ops_fixed,
509 .type = REGULATOR_VOLTAGE,
510 .owner = THIS_MODULE,
511 },
512 {
513 .name = "LDO_D",
514 .id = AB3100_LDO_D,
515 .ops = ®ulator_ops_fixed,
516 .type = REGULATOR_VOLTAGE,
517 .owner = THIS_MODULE,
518 },
519 {
520 .name = "LDO_E",
521 .id = AB3100_LDO_E,
522 .ops = ®ulator_ops_variable_sleepable,
523 .n_voltages = ARRAY_SIZE(ldo_e_buck_typ_voltages),
524 .type = REGULATOR_VOLTAGE,
525 .owner = THIS_MODULE,
526 },
527 {
528 .name = "LDO_F",
529 .id = AB3100_LDO_F,
530 .ops = ®ulator_ops_variable,
531 .n_voltages = ARRAY_SIZE(ldo_f_typ_voltages),
532 .type = REGULATOR_VOLTAGE,
533 .owner = THIS_MODULE,
534 },
535 {
536 .name = "LDO_G",
537 .id = AB3100_LDO_G,
538 .ops = ®ulator_ops_variable,
539 .n_voltages = ARRAY_SIZE(ldo_g_typ_voltages),
540 .type = REGULATOR_VOLTAGE,
541 .owner = THIS_MODULE,
542 },
543 {
544 .name = "LDO_H",
545 .id = AB3100_LDO_H,
546 .ops = ®ulator_ops_variable,
547 .n_voltages = ARRAY_SIZE(ldo_h_typ_voltages),
548 .type = REGULATOR_VOLTAGE,
549 .owner = THIS_MODULE,
550 },
551 {
552 .name = "LDO_K",
553 .id = AB3100_LDO_K,
554 .ops = ®ulator_ops_variable,
555 .n_voltages = ARRAY_SIZE(ldo_k_typ_voltages),
556 .type = REGULATOR_VOLTAGE,
557 .owner = THIS_MODULE,
558 },
559 {
560 .name = "LDO_EXT",
561 .id = AB3100_LDO_EXT,
562 .ops = ®ulator_ops_external,
563 .type = REGULATOR_VOLTAGE,
564 .owner = THIS_MODULE,
565 },
566 {
567 .name = "BUCK",
568 .id = AB3100_BUCK,
569 .ops = ®ulator_ops_variable_sleepable,
570 .n_voltages = ARRAY_SIZE(ldo_e_buck_typ_voltages),
571 .type = REGULATOR_VOLTAGE,
572 .owner = THIS_MODULE,
573 },
574};
575
576/*
577 * NOTE: the following functions are regulators pluralis - it is the
578 * binding to the AB3100 core driver and the parent platform device
579 * for all the different regulators.
580 */
581
582static int __devinit ab3100_regulators_probe(struct platform_device *pdev)
583{
584 struct ab3100_platform_data *plfdata = pdev->dev.platform_data;
585 int err = 0;
586 u8 data;
587 int i;
588
589 /* Check chip state */
590 err = abx500_get_register_interruptible(&pdev->dev, 0,
591 AB3100_LDO_D, &data);
592 if (err) {
593 dev_err(&pdev->dev, "could not read initial status of LDO_D\n");
594 return err;
595 }
596 if (data & 0x10)
597 dev_notice(&pdev->dev,
598 "chip is already in active mode (Warm start)\n");
599 else
600 dev_notice(&pdev->dev,
601 "chip is in inactive mode (Cold start)\n");
602
603 /* Set up regulators */
604 for (i = 0; i < ARRAY_SIZE(ab3100_reg_init_order); i++) {
605 err = abx500_set_register_interruptible(&pdev->dev, 0,
606 ab3100_reg_init_order[i],
607 plfdata->reg_initvals[i]);
608 if (err) {
609 dev_err(&pdev->dev, "regulator initialization failed with error %d\n",
610 err);
611 return err;
612 }
613 }
614
615 /* Register the regulators */
616 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
617 struct ab3100_regulator *reg = &ab3100_regulators[i];
618 struct regulator_dev *rdev;
619
620 /*
621 * Initialize per-regulator struct.
622 * Inherit platform data, this comes down from the
623 * i2c boarddata, from the machine. So if you want to
624 * see what it looks like for a certain machine, go
625 * into the machine I2C setup.
626 */
627 reg->dev = &pdev->dev;
628 reg->plfdata = plfdata;
629
630 /*
631 * Register the regulator, pass around
632 * the ab3100_regulator struct
633 */
634 rdev = regulator_register(&ab3100_regulator_desc[i],
635 &pdev->dev,
636 &plfdata->reg_constraints[i],
637 reg);
638
639 if (IS_ERR(rdev)) {
640 err = PTR_ERR(rdev);
641 dev_err(&pdev->dev,
642 "%s: failed to register regulator %s err %d\n",
643 __func__, ab3100_regulator_desc[i].name,
644 err);
645 /* remove the already registered regulators */
646 while (--i >= 0)
647 regulator_unregister(ab3100_regulators[i].rdev);
648 return err;
649 }
650
651 /* Then set a pointer back to the registered regulator */
652 reg->rdev = rdev;
653 }
654
655 return 0;
656}
657
658static int __devexit ab3100_regulators_remove(struct platform_device *pdev)
659{
660 int i;
661
662 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
663 struct ab3100_regulator *reg = &ab3100_regulators[i];
664
665 regulator_unregister(reg->rdev);
666 }
667 return 0;
668}
669
670static struct platform_driver ab3100_regulators_driver = {
671 .driver = {
672 .name = "ab3100-regulators",
673 .owner = THIS_MODULE,
674 },
675 .probe = ab3100_regulators_probe,
676 .remove = __devexit_p(ab3100_regulators_remove),
677};
678
679static __init int ab3100_regulators_init(void)
680{
681 return platform_driver_register(&ab3100_regulators_driver);
682}
683
684static __exit void ab3100_regulators_exit(void)
685{
686 platform_driver_unregister(&ab3100_regulators_driver);
687}
688
689subsys_initcall(ab3100_regulators_init);
690module_exit(ab3100_regulators_exit);
691
692MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
693MODULE_DESCRIPTION("AB3100 Regulator driver");
694MODULE_LICENSE("GPL");
695MODULE_ALIAS("platform:ab3100-regulators");
1/*
2 * drivers/regulator/ab3100.c
3 *
4 * Copyright (C) 2008-2009 ST-Ericsson AB
5 * License terms: GNU General Public License (GPL) version 2
6 * Low-level control of the AB3100 IC Low Dropout (LDO)
7 * regulators, external regulator and buck converter
8 * Author: Mattias Wallin <mattias.wallin@stericsson.com>
9 * Author: Linus Walleij <linus.walleij@stericsson.com>
10 */
11
12#include <linux/module.h>
13#include <linux/kernel.h>
14#include <linux/init.h>
15#include <linux/err.h>
16#include <linux/platform_device.h>
17#include <linux/regulator/driver.h>
18#include <linux/mfd/ab3100.h>
19#include <linux/mfd/abx500.h>
20#include <linux/of.h>
21#include <linux/regulator/of_regulator.h>
22
23/* LDO registers and some handy masking definitions for AB3100 */
24#define AB3100_LDO_A 0x40
25#define AB3100_LDO_C 0x41
26#define AB3100_LDO_D 0x42
27#define AB3100_LDO_E 0x43
28#define AB3100_LDO_E_SLEEP 0x44
29#define AB3100_LDO_F 0x45
30#define AB3100_LDO_G 0x46
31#define AB3100_LDO_H 0x47
32#define AB3100_LDO_H_SLEEP_MODE 0
33#define AB3100_LDO_H_SLEEP_EN 2
34#define AB3100_LDO_ON 4
35#define AB3100_LDO_H_VSEL_AC 5
36#define AB3100_LDO_K 0x48
37#define AB3100_LDO_EXT 0x49
38#define AB3100_BUCK 0x4A
39#define AB3100_BUCK_SLEEP 0x4B
40#define AB3100_REG_ON_MASK 0x10
41
42/**
43 * struct ab3100_regulator
44 * A struct passed around the individual regulator functions
45 * @platform_device: platform device holding this regulator
46 * @dev: handle to the device
47 * @plfdata: AB3100 platform data passed in at probe time
48 * @regreg: regulator register number in the AB3100
49 */
50struct ab3100_regulator {
51 struct regulator_dev *rdev;
52 struct device *dev;
53 struct ab3100_platform_data *plfdata;
54 u8 regreg;
55};
56
57/* The order in which registers are initialized */
58static const u8 ab3100_reg_init_order[AB3100_NUM_REGULATORS+2] = {
59 AB3100_LDO_A,
60 AB3100_LDO_C,
61 AB3100_LDO_E,
62 AB3100_LDO_E_SLEEP,
63 AB3100_LDO_F,
64 AB3100_LDO_G,
65 AB3100_LDO_H,
66 AB3100_LDO_K,
67 AB3100_LDO_EXT,
68 AB3100_BUCK,
69 AB3100_BUCK_SLEEP,
70 AB3100_LDO_D,
71};
72
73/* Preset (hardware defined) voltages for these regulators */
74#define LDO_A_VOLTAGE 2750000
75#define LDO_C_VOLTAGE 2650000
76#define LDO_D_VOLTAGE 2650000
77
78static const unsigned int ldo_e_buck_typ_voltages[] = {
79 1800000,
80 1400000,
81 1300000,
82 1200000,
83 1100000,
84 1050000,
85 900000,
86};
87
88static const unsigned int ldo_f_typ_voltages[] = {
89 1800000,
90 1400000,
91 1300000,
92 1200000,
93 1100000,
94 1050000,
95 2500000,
96 2650000,
97};
98
99static const unsigned int ldo_g_typ_voltages[] = {
100 2850000,
101 2750000,
102 1800000,
103 1500000,
104};
105
106static const unsigned int ldo_h_typ_voltages[] = {
107 2750000,
108 1800000,
109 1500000,
110 1200000,
111};
112
113static const unsigned int ldo_k_typ_voltages[] = {
114 2750000,
115 1800000,
116};
117
118
119/* The regulator devices */
120static struct ab3100_regulator
121ab3100_regulators[AB3100_NUM_REGULATORS] = {
122 {
123 .regreg = AB3100_LDO_A,
124 },
125 {
126 .regreg = AB3100_LDO_C,
127 },
128 {
129 .regreg = AB3100_LDO_D,
130 },
131 {
132 .regreg = AB3100_LDO_E,
133 },
134 {
135 .regreg = AB3100_LDO_F,
136 },
137 {
138 .regreg = AB3100_LDO_G,
139 },
140 {
141 .regreg = AB3100_LDO_H,
142 },
143 {
144 .regreg = AB3100_LDO_K,
145 },
146 {
147 .regreg = AB3100_LDO_EXT,
148 /* No voltages for the external regulator */
149 },
150 {
151 .regreg = AB3100_BUCK,
152 },
153};
154
155/*
156 * General functions for enable, disable and is_enabled used for
157 * LDO: A,C,E,F,G,H,K,EXT and BUCK
158 */
159static int ab3100_enable_regulator(struct regulator_dev *reg)
160{
161 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
162 int err;
163 u8 regval;
164
165 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
166 ®val);
167 if (err) {
168 dev_warn(®->dev, "failed to get regid %d value\n",
169 abreg->regreg);
170 return err;
171 }
172
173 /* The regulator is already on, no reason to go further */
174 if (regval & AB3100_REG_ON_MASK)
175 return 0;
176
177 regval |= AB3100_REG_ON_MASK;
178
179 err = abx500_set_register_interruptible(abreg->dev, 0, abreg->regreg,
180 regval);
181 if (err) {
182 dev_warn(®->dev, "failed to set regid %d value\n",
183 abreg->regreg);
184 return err;
185 }
186
187 return 0;
188}
189
190static int ab3100_disable_regulator(struct regulator_dev *reg)
191{
192 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
193 int err;
194 u8 regval;
195
196 /*
197 * LDO D is a special regulator. When it is disabled, the entire
198 * system is shut down. So this is handled specially.
199 */
200 pr_info("Called ab3100_disable_regulator\n");
201 if (abreg->regreg == AB3100_LDO_D) {
202 dev_info(®->dev, "disabling LDO D - shut down system\n");
203 /* Setting LDO D to 0x00 cuts the power to the SoC */
204 return abx500_set_register_interruptible(abreg->dev, 0,
205 AB3100_LDO_D, 0x00U);
206 }
207
208 /*
209 * All other regulators are handled here
210 */
211 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
212 ®val);
213 if (err) {
214 dev_err(®->dev, "unable to get register 0x%x\n",
215 abreg->regreg);
216 return err;
217 }
218 regval &= ~AB3100_REG_ON_MASK;
219 return abx500_set_register_interruptible(abreg->dev, 0, abreg->regreg,
220 regval);
221}
222
223static int ab3100_is_enabled_regulator(struct regulator_dev *reg)
224{
225 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
226 u8 regval;
227 int err;
228
229 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
230 ®val);
231 if (err) {
232 dev_err(®->dev, "unable to get register 0x%x\n",
233 abreg->regreg);
234 return err;
235 }
236
237 return regval & AB3100_REG_ON_MASK;
238}
239
240static int ab3100_get_voltage_regulator(struct regulator_dev *reg)
241{
242 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
243 u8 regval;
244 int err;
245
246 /*
247 * For variable types, read out setting and index into
248 * supplied voltage list.
249 */
250 err = abx500_get_register_interruptible(abreg->dev, 0,
251 abreg->regreg, ®val);
252 if (err) {
253 dev_warn(®->dev,
254 "failed to get regulator value in register %02x\n",
255 abreg->regreg);
256 return err;
257 }
258
259 /* The 3 highest bits index voltages */
260 regval &= 0xE0;
261 regval >>= 5;
262
263 if (regval >= reg->desc->n_voltages) {
264 dev_err(®->dev,
265 "regulator register %02x contains an illegal voltage setting\n",
266 abreg->regreg);
267 return -EINVAL;
268 }
269
270 return reg->desc->volt_table[regval];
271}
272
273static int ab3100_set_voltage_regulator_sel(struct regulator_dev *reg,
274 unsigned selector)
275{
276 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
277 u8 regval;
278 int err;
279
280 err = abx500_get_register_interruptible(abreg->dev, 0,
281 abreg->regreg, ®val);
282 if (err) {
283 dev_warn(®->dev,
284 "failed to get regulator register %02x\n",
285 abreg->regreg);
286 return err;
287 }
288
289 /* The highest three bits control the variable regulators */
290 regval &= ~0xE0;
291 regval |= (selector << 5);
292
293 err = abx500_set_register_interruptible(abreg->dev, 0,
294 abreg->regreg, regval);
295 if (err)
296 dev_warn(®->dev, "failed to set regulator register %02x\n",
297 abreg->regreg);
298
299 return err;
300}
301
302static int ab3100_set_suspend_voltage_regulator(struct regulator_dev *reg,
303 int uV)
304{
305 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
306 u8 regval;
307 int err;
308 int bestindex;
309 u8 targetreg;
310
311 if (abreg->regreg == AB3100_LDO_E)
312 targetreg = AB3100_LDO_E_SLEEP;
313 else if (abreg->regreg == AB3100_BUCK)
314 targetreg = AB3100_BUCK_SLEEP;
315 else
316 return -EINVAL;
317
318 /* LDO E and BUCK have special suspend voltages you can set */
319 bestindex = regulator_map_voltage_iterate(reg, uV, uV);
320
321 err = abx500_get_register_interruptible(abreg->dev, 0,
322 targetreg, ®val);
323 if (err) {
324 dev_warn(®->dev,
325 "failed to get regulator register %02x\n",
326 targetreg);
327 return err;
328 }
329
330 /* The highest three bits control the variable regulators */
331 regval &= ~0xE0;
332 regval |= (bestindex << 5);
333
334 err = abx500_set_register_interruptible(abreg->dev, 0,
335 targetreg, regval);
336 if (err)
337 dev_warn(®->dev, "failed to set regulator register %02x\n",
338 abreg->regreg);
339
340 return err;
341}
342
343/*
344 * The external regulator can just define a fixed voltage.
345 */
346static int ab3100_get_voltage_regulator_external(struct regulator_dev *reg)
347{
348 struct ab3100_regulator *abreg = rdev_get_drvdata(reg);
349
350 if (abreg->plfdata)
351 return abreg->plfdata->external_voltage;
352 else
353 /* TODO: encode external voltage into device tree */
354 return 0;
355}
356
357static struct regulator_ops regulator_ops_fixed = {
358 .list_voltage = regulator_list_voltage_linear,
359 .enable = ab3100_enable_regulator,
360 .disable = ab3100_disable_regulator,
361 .is_enabled = ab3100_is_enabled_regulator,
362};
363
364static struct regulator_ops regulator_ops_variable = {
365 .enable = ab3100_enable_regulator,
366 .disable = ab3100_disable_regulator,
367 .is_enabled = ab3100_is_enabled_regulator,
368 .get_voltage = ab3100_get_voltage_regulator,
369 .set_voltage_sel = ab3100_set_voltage_regulator_sel,
370 .list_voltage = regulator_list_voltage_table,
371};
372
373static struct regulator_ops regulator_ops_variable_sleepable = {
374 .enable = ab3100_enable_regulator,
375 .disable = ab3100_disable_regulator,
376 .is_enabled = ab3100_is_enabled_regulator,
377 .get_voltage = ab3100_get_voltage_regulator,
378 .set_voltage_sel = ab3100_set_voltage_regulator_sel,
379 .set_suspend_voltage = ab3100_set_suspend_voltage_regulator,
380 .list_voltage = regulator_list_voltage_table,
381};
382
383/*
384 * LDO EXT is an external regulator so it is really
385 * not possible to set any voltage locally here, AB3100
386 * is an on/off switch plain an simple. The external
387 * voltage is defined in the board set-up if any.
388 */
389static struct regulator_ops regulator_ops_external = {
390 .enable = ab3100_enable_regulator,
391 .disable = ab3100_disable_regulator,
392 .is_enabled = ab3100_is_enabled_regulator,
393 .get_voltage = ab3100_get_voltage_regulator_external,
394};
395
396static struct regulator_desc
397ab3100_regulator_desc[AB3100_NUM_REGULATORS] = {
398 {
399 .name = "LDO_A",
400 .id = AB3100_LDO_A,
401 .ops = ®ulator_ops_fixed,
402 .n_voltages = 1,
403 .type = REGULATOR_VOLTAGE,
404 .owner = THIS_MODULE,
405 .min_uV = LDO_A_VOLTAGE,
406 .enable_time = 200,
407 },
408 {
409 .name = "LDO_C",
410 .id = AB3100_LDO_C,
411 .ops = ®ulator_ops_fixed,
412 .n_voltages = 1,
413 .type = REGULATOR_VOLTAGE,
414 .owner = THIS_MODULE,
415 .min_uV = LDO_C_VOLTAGE,
416 .enable_time = 200,
417 },
418 {
419 .name = "LDO_D",
420 .id = AB3100_LDO_D,
421 .ops = ®ulator_ops_fixed,
422 .n_voltages = 1,
423 .type = REGULATOR_VOLTAGE,
424 .owner = THIS_MODULE,
425 .min_uV = LDO_D_VOLTAGE,
426 .enable_time = 200,
427 },
428 {
429 .name = "LDO_E",
430 .id = AB3100_LDO_E,
431 .ops = ®ulator_ops_variable_sleepable,
432 .n_voltages = ARRAY_SIZE(ldo_e_buck_typ_voltages),
433 .volt_table = ldo_e_buck_typ_voltages,
434 .type = REGULATOR_VOLTAGE,
435 .owner = THIS_MODULE,
436 .enable_time = 200,
437 },
438 {
439 .name = "LDO_F",
440 .id = AB3100_LDO_F,
441 .ops = ®ulator_ops_variable,
442 .n_voltages = ARRAY_SIZE(ldo_f_typ_voltages),
443 .volt_table = ldo_f_typ_voltages,
444 .type = REGULATOR_VOLTAGE,
445 .owner = THIS_MODULE,
446 .enable_time = 600,
447 },
448 {
449 .name = "LDO_G",
450 .id = AB3100_LDO_G,
451 .ops = ®ulator_ops_variable,
452 .n_voltages = ARRAY_SIZE(ldo_g_typ_voltages),
453 .volt_table = ldo_g_typ_voltages,
454 .type = REGULATOR_VOLTAGE,
455 .owner = THIS_MODULE,
456 .enable_time = 400,
457 },
458 {
459 .name = "LDO_H",
460 .id = AB3100_LDO_H,
461 .ops = ®ulator_ops_variable,
462 .n_voltages = ARRAY_SIZE(ldo_h_typ_voltages),
463 .volt_table = ldo_h_typ_voltages,
464 .type = REGULATOR_VOLTAGE,
465 .owner = THIS_MODULE,
466 .enable_time = 200,
467 },
468 {
469 .name = "LDO_K",
470 .id = AB3100_LDO_K,
471 .ops = ®ulator_ops_variable,
472 .n_voltages = ARRAY_SIZE(ldo_k_typ_voltages),
473 .volt_table = ldo_k_typ_voltages,
474 .type = REGULATOR_VOLTAGE,
475 .owner = THIS_MODULE,
476 .enable_time = 200,
477 },
478 {
479 .name = "LDO_EXT",
480 .id = AB3100_LDO_EXT,
481 .ops = ®ulator_ops_external,
482 .type = REGULATOR_VOLTAGE,
483 .owner = THIS_MODULE,
484 },
485 {
486 .name = "BUCK",
487 .id = AB3100_BUCK,
488 .ops = ®ulator_ops_variable_sleepable,
489 .n_voltages = ARRAY_SIZE(ldo_e_buck_typ_voltages),
490 .volt_table = ldo_e_buck_typ_voltages,
491 .type = REGULATOR_VOLTAGE,
492 .owner = THIS_MODULE,
493 .enable_time = 1000,
494 },
495};
496
497static int ab3100_regulator_register(struct platform_device *pdev,
498 struct ab3100_platform_data *plfdata,
499 struct regulator_init_data *init_data,
500 struct device_node *np,
501 unsigned long id)
502{
503 struct regulator_desc *desc;
504 struct ab3100_regulator *reg;
505 struct regulator_dev *rdev;
506 struct regulator_config config = { };
507 int err, i;
508
509 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
510 desc = &ab3100_regulator_desc[i];
511 if (desc->id == id)
512 break;
513 }
514 if (desc->id != id)
515 return -ENODEV;
516
517 /* Same index used for this array */
518 reg = &ab3100_regulators[i];
519
520 /*
521 * Initialize per-regulator struct.
522 * Inherit platform data, this comes down from the
523 * i2c boarddata, from the machine. So if you want to
524 * see what it looks like for a certain machine, go
525 * into the machine I2C setup.
526 */
527 reg->dev = &pdev->dev;
528 if (plfdata) {
529 reg->plfdata = plfdata;
530 config.init_data = &plfdata->reg_constraints[i];
531 } else if (np) {
532 config.of_node = np;
533 config.init_data = init_data;
534 }
535 config.dev = &pdev->dev;
536 config.driver_data = reg;
537
538 rdev = devm_regulator_register(&pdev->dev, desc, &config);
539 if (IS_ERR(rdev)) {
540 err = PTR_ERR(rdev);
541 dev_err(&pdev->dev,
542 "%s: failed to register regulator %s err %d\n",
543 __func__, desc->name,
544 err);
545 return err;
546 }
547
548 /* Then set a pointer back to the registered regulator */
549 reg->rdev = rdev;
550 return 0;
551}
552
553static struct of_regulator_match ab3100_regulator_matches[] = {
554 { .name = "ab3100_ldo_a", .driver_data = (void *) AB3100_LDO_A, },
555 { .name = "ab3100_ldo_c", .driver_data = (void *) AB3100_LDO_C, },
556 { .name = "ab3100_ldo_d", .driver_data = (void *) AB3100_LDO_D, },
557 { .name = "ab3100_ldo_e", .driver_data = (void *) AB3100_LDO_E, },
558 { .name = "ab3100_ldo_f", .driver_data = (void *) AB3100_LDO_F },
559 { .name = "ab3100_ldo_g", .driver_data = (void *) AB3100_LDO_G },
560 { .name = "ab3100_ldo_h", .driver_data = (void *) AB3100_LDO_H },
561 { .name = "ab3100_ldo_k", .driver_data = (void *) AB3100_LDO_K },
562 { .name = "ab3100_ext", .driver_data = (void *) AB3100_LDO_EXT },
563 { .name = "ab3100_buck", .driver_data = (void *) AB3100_BUCK },
564};
565
566/*
567 * Initial settings of ab3100 registers.
568 * Common for below LDO regulator settings are that
569 * bit 7-5 controls voltage. Bit 4 turns regulator ON(1) or OFF(0).
570 * Bit 3-2 controls sleep enable and bit 1-0 controls sleep mode.
571 */
572/* LDO_A 0x16: 2.75V, ON, SLEEP_A, SLEEP OFF GND */
573#define LDO_A_SETTING 0x16
574/* LDO_C 0x10: 2.65V, ON, SLEEP_A or B, SLEEP full power */
575#define LDO_C_SETTING 0x10
576/* LDO_D 0x10: 2.65V, ON, sleep mode not used */
577#define LDO_D_SETTING 0x10
578/* LDO_E 0x10: 1.8V, ON, SLEEP_A or B, SLEEP full power */
579#define LDO_E_SETTING 0x10
580/* LDO_E SLEEP 0x00: 1.8V, not used, SLEEP_A or B, not used */
581#define LDO_E_SLEEP_SETTING 0x00
582/* LDO_F 0xD0: 2.5V, ON, SLEEP_A or B, SLEEP full power */
583#define LDO_F_SETTING 0xD0
584/* LDO_G 0x00: 2.85V, OFF, SLEEP_A or B, SLEEP full power */
585#define LDO_G_SETTING 0x00
586/* LDO_H 0x18: 2.75V, ON, SLEEP_B, SLEEP full power */
587#define LDO_H_SETTING 0x18
588/* LDO_K 0x00: 2.75V, OFF, SLEEP_A or B, SLEEP full power */
589#define LDO_K_SETTING 0x00
590/* LDO_EXT 0x00: Voltage not set, OFF, not used, not used */
591#define LDO_EXT_SETTING 0x00
592/* BUCK 0x7D: 1.2V, ON, SLEEP_A and B, SLEEP low power */
593#define BUCK_SETTING 0x7D
594/* BUCK SLEEP 0xAC: 1.05V, Not used, SLEEP_A and B, Not used */
595#define BUCK_SLEEP_SETTING 0xAC
596
597static const u8 ab3100_reg_initvals[] = {
598 LDO_A_SETTING,
599 LDO_C_SETTING,
600 LDO_E_SETTING,
601 LDO_E_SLEEP_SETTING,
602 LDO_F_SETTING,
603 LDO_G_SETTING,
604 LDO_H_SETTING,
605 LDO_K_SETTING,
606 LDO_EXT_SETTING,
607 BUCK_SETTING,
608 BUCK_SLEEP_SETTING,
609 LDO_D_SETTING,
610};
611
612static int ab3100_regulators_remove(struct platform_device *pdev)
613{
614 int i;
615
616 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
617 struct ab3100_regulator *reg = &ab3100_regulators[i];
618
619 reg->rdev = NULL;
620 }
621 return 0;
622}
623
624static int
625ab3100_regulator_of_probe(struct platform_device *pdev, struct device_node *np)
626{
627 int err, i;
628
629 /*
630 * Set up the regulator registers, as was previously done with
631 * platform data.
632 */
633 /* Set up regulators */
634 for (i = 0; i < ARRAY_SIZE(ab3100_reg_init_order); i++) {
635 err = abx500_set_register_interruptible(&pdev->dev, 0,
636 ab3100_reg_init_order[i],
637 ab3100_reg_initvals[i]);
638 if (err) {
639 dev_err(&pdev->dev, "regulator initialization failed with error %d\n",
640 err);
641 return err;
642 }
643 }
644
645 for (i = 0; i < ARRAY_SIZE(ab3100_regulator_matches); i++) {
646 err = ab3100_regulator_register(
647 pdev, NULL, ab3100_regulator_matches[i].init_data,
648 ab3100_regulator_matches[i].of_node,
649 (unsigned long)ab3100_regulator_matches[i].driver_data);
650 if (err) {
651 ab3100_regulators_remove(pdev);
652 return err;
653 }
654 }
655
656 return 0;
657}
658
659
660static int ab3100_regulators_probe(struct platform_device *pdev)
661{
662 struct ab3100_platform_data *plfdata = dev_get_platdata(&pdev->dev);
663 struct device_node *np = pdev->dev.of_node;
664 int err = 0;
665 u8 data;
666 int i;
667
668 /* Check chip state */
669 err = abx500_get_register_interruptible(&pdev->dev, 0,
670 AB3100_LDO_D, &data);
671 if (err) {
672 dev_err(&pdev->dev, "could not read initial status of LDO_D\n");
673 return err;
674 }
675 if (data & 0x10)
676 dev_notice(&pdev->dev,
677 "chip is already in active mode (Warm start)\n");
678 else
679 dev_notice(&pdev->dev,
680 "chip is in inactive mode (Cold start)\n");
681
682 if (np) {
683 err = of_regulator_match(&pdev->dev, np,
684 ab3100_regulator_matches,
685 ARRAY_SIZE(ab3100_regulator_matches));
686 if (err < 0) {
687 dev_err(&pdev->dev,
688 "Error parsing regulator init data: %d\n", err);
689 return err;
690 }
691 return ab3100_regulator_of_probe(pdev, np);
692 }
693
694 /* Set up regulators */
695 for (i = 0; i < ARRAY_SIZE(ab3100_reg_init_order); i++) {
696 err = abx500_set_register_interruptible(&pdev->dev, 0,
697 ab3100_reg_init_order[i],
698 plfdata->reg_initvals[i]);
699 if (err) {
700 dev_err(&pdev->dev, "regulator initialization failed with error %d\n",
701 err);
702 return err;
703 }
704 }
705
706 /* Register the regulators */
707 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
708 struct regulator_desc *desc = &ab3100_regulator_desc[i];
709
710 err = ab3100_regulator_register(pdev, plfdata, NULL, NULL,
711 desc->id);
712 if (err) {
713 ab3100_regulators_remove(pdev);
714 return err;
715 }
716 }
717
718 return 0;
719}
720
721static struct platform_driver ab3100_regulators_driver = {
722 .driver = {
723 .name = "ab3100-regulators",
724 },
725 .probe = ab3100_regulators_probe,
726 .remove = ab3100_regulators_remove,
727};
728
729static __init int ab3100_regulators_init(void)
730{
731 return platform_driver_register(&ab3100_regulators_driver);
732}
733
734static __exit void ab3100_regulators_exit(void)
735{
736 platform_driver_unregister(&ab3100_regulators_driver);
737}
738
739subsys_initcall(ab3100_regulators_init);
740module_exit(ab3100_regulators_exit);
741
742MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
743MODULE_DESCRIPTION("AB3100 Regulator driver");
744MODULE_LICENSE("GPL");
745MODULE_ALIAS("platform:ab3100-regulators");