2 * drivers/regulator/ab3100.c
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>
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>
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
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
51 * @voltages_len: length of the array of available voltages
53 struct ab3100_regulator {
54 struct regulator_dev *rdev;
56 struct ab3100_platform_data *plfdata;
59 int const *typ_voltages;
63 /* The order in which registers are initialized */
64 static const u8 ab3100_reg_init_order[AB3100_NUM_REGULATORS+2] = {
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
84 static const int ldo_e_buck_typ_voltages[] = {
94 static const int ldo_f_typ_voltages[] = {
105 static const int ldo_g_typ_voltages[] = {
112 static const int ldo_h_typ_voltages[] = {
119 static const int ldo_k_typ_voltages[] = {
125 /* The regulator devices */
126 static struct ab3100_regulator
127 ab3100_regulators[AB3100_NUM_REGULATORS] = {
129 .regreg = AB3100_LDO_A,
130 .fixed_voltage = LDO_A_VOLTAGE,
133 .regreg = AB3100_LDO_C,
134 .fixed_voltage = LDO_C_VOLTAGE,
137 .regreg = AB3100_LDO_D,
138 .fixed_voltage = LDO_D_VOLTAGE,
141 .regreg = AB3100_LDO_E,
142 .typ_voltages = ldo_e_buck_typ_voltages,
143 .voltages_len = ARRAY_SIZE(ldo_e_buck_typ_voltages),
146 .regreg = AB3100_LDO_F,
147 .typ_voltages = ldo_f_typ_voltages,
148 .voltages_len = ARRAY_SIZE(ldo_f_typ_voltages),
151 .regreg = AB3100_LDO_G,
152 .typ_voltages = ldo_g_typ_voltages,
153 .voltages_len = ARRAY_SIZE(ldo_g_typ_voltages),
156 .regreg = AB3100_LDO_H,
157 .typ_voltages = ldo_h_typ_voltages,
158 .voltages_len = ARRAY_SIZE(ldo_h_typ_voltages),
161 .regreg = AB3100_LDO_K,
162 .typ_voltages = ldo_k_typ_voltages,
163 .voltages_len = ARRAY_SIZE(ldo_k_typ_voltages),
166 .regreg = AB3100_LDO_EXT,
167 /* No voltages for the external regulator */
170 .regreg = AB3100_BUCK,
171 .typ_voltages = ldo_e_buck_typ_voltages,
172 .voltages_len = ARRAY_SIZE(ldo_e_buck_typ_voltages),
177 * General functions for enable, disable and is_enabled used for
178 * LDO: A,C,E,F,G,H,K,EXT and BUCK
180 static int ab3100_enable_regulator(struct regulator_dev *reg)
182 struct ab3100_regulator *abreg = reg->reg_data;
186 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
189 dev_warn(®->dev, "failed to get regid %d value\n",
194 /* The regulator is already on, no reason to go further */
195 if (regval & AB3100_REG_ON_MASK)
198 regval |= AB3100_REG_ON_MASK;
200 err = abx500_set_register_interruptible(abreg->dev, 0, abreg->regreg,
203 dev_warn(®->dev, "failed to set regid %d value\n",
208 /* Per-regulator power on delay from spec */
209 switch (abreg->regreg) {
210 case AB3100_LDO_A: /* Fallthrough */
211 case AB3100_LDO_C: /* Fallthrough */
212 case AB3100_LDO_D: /* Fallthrough */
213 case AB3100_LDO_E: /* Fallthrough */
214 case AB3100_LDO_H: /* Fallthrough */
234 static int ab3100_disable_regulator(struct regulator_dev *reg)
236 struct ab3100_regulator *abreg = reg->reg_data;
241 * LDO D is a special regulator. When it is disabled, the entire
242 * system is shut down. So this is handled specially.
244 pr_info("Called ab3100_disable_regulator\n");
245 if (abreg->regreg == AB3100_LDO_D) {
246 dev_info(®->dev, "disabling LDO D - shut down system\n");
247 /* Setting LDO D to 0x00 cuts the power to the SoC */
248 return abx500_set_register_interruptible(abreg->dev, 0,
249 AB3100_LDO_D, 0x00U);
253 * All other regulators are handled here
255 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
258 dev_err(®->dev, "unable to get register 0x%x\n",
262 regval &= ~AB3100_REG_ON_MASK;
263 return abx500_set_register_interruptible(abreg->dev, 0, abreg->regreg,
267 static int ab3100_is_enabled_regulator(struct regulator_dev *reg)
269 struct ab3100_regulator *abreg = reg->reg_data;
273 err = abx500_get_register_interruptible(abreg->dev, 0, abreg->regreg,
276 dev_err(®->dev, "unable to get register 0x%x\n",
281 return regval & AB3100_REG_ON_MASK;
284 static int ab3100_list_voltage_regulator(struct regulator_dev *reg,
287 struct ab3100_regulator *abreg = reg->reg_data;
289 if (selector >= abreg->voltages_len)
291 return abreg->typ_voltages[selector];
294 static int ab3100_get_voltage_regulator(struct regulator_dev *reg)
296 struct ab3100_regulator *abreg = reg->reg_data;
300 /* Return the voltage for fixed regulators immediately */
301 if (abreg->fixed_voltage)
302 return abreg->fixed_voltage;
305 * For variable types, read out setting and index into
306 * supplied voltage list.
308 err = abx500_get_register_interruptible(abreg->dev, 0,
309 abreg->regreg, ®val);
312 "failed to get regulator value in register %02x\n",
317 /* The 3 highest bits index voltages */
321 if (regval >= abreg->voltages_len) {
323 "regulator register %02x contains an illegal voltage setting\n",
328 return abreg->typ_voltages[regval];
331 static int ab3100_get_best_voltage_index(struct regulator_dev *reg,
332 int min_uV, int max_uV)
334 struct ab3100_regulator *abreg = reg->reg_data;
340 * Locate the minimum voltage fitting the criteria on
341 * this regulator. The switchable voltages are not
342 * in strict falling order so we need to check them
343 * all for the best match.
347 for (i = 0; i < abreg->voltages_len; i++) {
348 if (abreg->typ_voltages[i] <= max_uV &&
349 abreg->typ_voltages[i] >= min_uV &&
350 abreg->typ_voltages[i] < bestmatch) {
351 bestmatch = abreg->typ_voltages[i];
357 dev_warn(®->dev, "requested %d<=x<=%d uV, out of range!\n",
364 static int ab3100_set_voltage_regulator(struct regulator_dev *reg,
365 int min_uV, int max_uV)
367 struct ab3100_regulator *abreg = reg->reg_data;
372 bestindex = ab3100_get_best_voltage_index(reg, min_uV, max_uV);
376 err = abx500_get_register_interruptible(abreg->dev, 0,
377 abreg->regreg, ®val);
380 "failed to get regulator register %02x\n",
385 /* The highest three bits control the variable regulators */
387 regval |= (bestindex << 5);
389 err = abx500_set_register_interruptible(abreg->dev, 0,
390 abreg->regreg, regval);
392 dev_warn(®->dev, "failed to set regulator register %02x\n",
398 static int ab3100_set_suspend_voltage_regulator(struct regulator_dev *reg,
401 struct ab3100_regulator *abreg = reg->reg_data;
407 if (abreg->regreg == AB3100_LDO_E)
408 targetreg = AB3100_LDO_E_SLEEP;
409 else if (abreg->regreg == AB3100_BUCK)
410 targetreg = AB3100_BUCK_SLEEP;
414 /* LDO E and BUCK have special suspend voltages you can set */
415 bestindex = ab3100_get_best_voltage_index(reg, uV, uV);
417 err = abx500_get_register_interruptible(abreg->dev, 0,
421 "failed to get regulator register %02x\n",
426 /* The highest three bits control the variable regulators */
428 regval |= (bestindex << 5);
430 err = abx500_set_register_interruptible(abreg->dev, 0,
433 dev_warn(®->dev, "failed to set regulator register %02x\n",
440 * The external regulator can just define a fixed voltage.
442 static int ab3100_get_voltage_regulator_external(struct regulator_dev *reg)
444 struct ab3100_regulator *abreg = reg->reg_data;
446 return abreg->plfdata->external_voltage;
449 static struct regulator_ops regulator_ops_fixed = {
450 .enable = ab3100_enable_regulator,
451 .disable = ab3100_disable_regulator,
452 .is_enabled = ab3100_is_enabled_regulator,
453 .get_voltage = ab3100_get_voltage_regulator,
456 static struct regulator_ops regulator_ops_variable = {
457 .enable = ab3100_enable_regulator,
458 .disable = ab3100_disable_regulator,
459 .is_enabled = ab3100_is_enabled_regulator,
460 .get_voltage = ab3100_get_voltage_regulator,
461 .set_voltage = ab3100_set_voltage_regulator,
462 .list_voltage = ab3100_list_voltage_regulator,
465 static struct regulator_ops regulator_ops_variable_sleepable = {
466 .enable = ab3100_enable_regulator,
467 .disable = ab3100_disable_regulator,
468 .is_enabled = ab3100_is_enabled_regulator,
469 .get_voltage = ab3100_get_voltage_regulator,
470 .set_voltage = ab3100_set_voltage_regulator,
471 .set_suspend_voltage = ab3100_set_suspend_voltage_regulator,
472 .list_voltage = ab3100_list_voltage_regulator,
476 * LDO EXT is an external regulator so it is really
477 * not possible to set any voltage locally here, AB3100
478 * is an on/off switch plain an simple. The external
479 * voltage is defined in the board set-up if any.
481 static struct regulator_ops regulator_ops_external = {
482 .enable = ab3100_enable_regulator,
483 .disable = ab3100_disable_regulator,
484 .is_enabled = ab3100_is_enabled_regulator,
485 .get_voltage = ab3100_get_voltage_regulator_external,
488 static struct regulator_desc
489 ab3100_regulator_desc[AB3100_NUM_REGULATORS] = {
493 .ops = ®ulator_ops_fixed,
494 .type = REGULATOR_VOLTAGE,
495 .owner = THIS_MODULE,
500 .ops = ®ulator_ops_fixed,
501 .type = REGULATOR_VOLTAGE,
502 .owner = THIS_MODULE,
507 .ops = ®ulator_ops_fixed,
508 .type = REGULATOR_VOLTAGE,
509 .owner = THIS_MODULE,
514 .ops = ®ulator_ops_variable_sleepable,
515 .n_voltages = ARRAY_SIZE(ldo_e_buck_typ_voltages),
516 .type = REGULATOR_VOLTAGE,
517 .owner = THIS_MODULE,
522 .ops = ®ulator_ops_variable,
523 .n_voltages = ARRAY_SIZE(ldo_f_typ_voltages),
524 .type = REGULATOR_VOLTAGE,
525 .owner = THIS_MODULE,
530 .ops = ®ulator_ops_variable,
531 .n_voltages = ARRAY_SIZE(ldo_g_typ_voltages),
532 .type = REGULATOR_VOLTAGE,
533 .owner = THIS_MODULE,
538 .ops = ®ulator_ops_variable,
539 .n_voltages = ARRAY_SIZE(ldo_h_typ_voltages),
540 .type = REGULATOR_VOLTAGE,
541 .owner = THIS_MODULE,
546 .ops = ®ulator_ops_variable,
547 .n_voltages = ARRAY_SIZE(ldo_k_typ_voltages),
548 .type = REGULATOR_VOLTAGE,
549 .owner = THIS_MODULE,
553 .id = AB3100_LDO_EXT,
554 .ops = ®ulator_ops_external,
555 .type = REGULATOR_VOLTAGE,
556 .owner = THIS_MODULE,
561 .ops = ®ulator_ops_variable_sleepable,
562 .n_voltages = ARRAY_SIZE(ldo_e_buck_typ_voltages),
563 .type = REGULATOR_VOLTAGE,
564 .owner = THIS_MODULE,
569 * NOTE: the following functions are regulators pluralis - it is the
570 * binding to the AB3100 core driver and the parent platform device
571 * for all the different regulators.
574 static int __devinit ab3100_regulators_probe(struct platform_device *pdev)
576 struct ab3100_platform_data *plfdata = pdev->dev.platform_data;
581 /* Check chip state */
582 err = abx500_get_register_interruptible(&pdev->dev, 0,
583 AB3100_LDO_D, &data);
585 dev_err(&pdev->dev, "could not read initial status of LDO_D\n");
589 dev_notice(&pdev->dev,
590 "chip is already in active mode (Warm start)\n");
592 dev_notice(&pdev->dev,
593 "chip is in inactive mode (Cold start)\n");
595 /* Set up regulators */
596 for (i = 0; i < ARRAY_SIZE(ab3100_reg_init_order); i++) {
597 err = abx500_set_register_interruptible(&pdev->dev, 0,
598 ab3100_reg_init_order[i],
599 plfdata->reg_initvals[i]);
601 dev_err(&pdev->dev, "regulator initialization failed with error %d\n",
607 /* Register the regulators */
608 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
609 struct ab3100_regulator *reg = &ab3100_regulators[i];
610 struct regulator_dev *rdev;
613 * Initialize per-regulator struct.
614 * Inherit platform data, this comes down from the
615 * i2c boarddata, from the machine. So if you want to
616 * see what it looks like for a certain machine, go
617 * into the machine I2C setup.
619 reg->dev = &pdev->dev;
620 reg->plfdata = plfdata;
623 * Register the regulator, pass around
624 * the ab3100_regulator struct
626 rdev = regulator_register(&ab3100_regulator_desc[i],
628 &plfdata->reg_constraints[i],
634 "%s: failed to register regulator %s err %d\n",
635 __func__, ab3100_regulator_desc[i].name,
637 /* remove the already registered regulators */
639 regulator_unregister(ab3100_regulators[i].rdev);
643 /* Then set a pointer back to the registered regulator */
650 static int __devexit ab3100_regulators_remove(struct platform_device *pdev)
654 for (i = 0; i < AB3100_NUM_REGULATORS; i++) {
655 struct ab3100_regulator *reg = &ab3100_regulators[i];
657 regulator_unregister(reg->rdev);
662 static struct platform_driver ab3100_regulators_driver = {
664 .name = "ab3100-regulators",
665 .owner = THIS_MODULE,
667 .probe = ab3100_regulators_probe,
668 .remove = __devexit_p(ab3100_regulators_remove),
671 static __init int ab3100_regulators_init(void)
673 return platform_driver_register(&ab3100_regulators_driver);
676 static __exit void ab3100_regulators_exit(void)
678 platform_driver_unregister(&ab3100_regulators_driver);
681 subsys_initcall(ab3100_regulators_init);
682 module_exit(ab3100_regulators_exit);
684 MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
685 MODULE_DESCRIPTION("AB3100 Regulator driver");
686 MODULE_LICENSE("GPL");
687 MODULE_ALIAS("platform:ab3100-regulators");