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