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>
20 #include <linux/mfd/core.h>
22 /* LDO registers and some handy masking definitions for AB3100 */
23 #define AB3100_LDO_A 0x40
24 #define AB3100_LDO_C 0x41
25 #define AB3100_LDO_D 0x42
26 #define AB3100_LDO_E 0x43
27 #define AB3100_LDO_E_SLEEP 0x44
28 #define AB3100_LDO_F 0x45
29 #define AB3100_LDO_G 0x46
30 #define AB3100_LDO_H 0x47
31 #define AB3100_LDO_H_SLEEP_MODE 0
32 #define AB3100_LDO_H_SLEEP_EN 2
33 #define AB3100_LDO_ON 4
34 #define AB3100_LDO_H_VSEL_AC 5
35 #define AB3100_LDO_K 0x48
36 #define AB3100_LDO_EXT 0x49
37 #define AB3100_BUCK 0x4A
38 #define AB3100_BUCK_SLEEP 0x4B
39 #define AB3100_REG_ON_MASK 0x10
42 * struct ab3100_regulator
43 * A struct passed around the individual regulator functions
44 * @platform_device: platform device holding this regulator
45 * @dev: handle to the device
46 * @plfdata: AB3100 platform data passed in at probe time
47 * @regreg: regulator register number in the AB3100
48 * @fixed_voltage: a fixed voltage for this regulator, if this
49 * 0 the voltages array is used instead.
50 * @typ_voltages: an array of available typical voltages for
52 * @voltages_len: length of the array of available voltages
54 struct ab3100_regulator
{
55 struct regulator_dev
*rdev
;
57 struct ab3100_platform_data
*plfdata
;
60 int const *typ_voltages
;
64 /* The order in which registers are initialized */
65 static const u8 ab3100_reg_init_order
[AB3100_NUM_REGULATORS
+2] = {
80 /* Preset (hardware defined) voltages for these regulators */
81 #define LDO_A_VOLTAGE 2750000
82 #define LDO_C_VOLTAGE 2650000
83 #define LDO_D_VOLTAGE 2650000
85 static const int ldo_e_buck_typ_voltages
[] = {
95 static const int ldo_f_typ_voltages
[] = {
106 static const int ldo_g_typ_voltages
[] = {
113 static const int ldo_h_typ_voltages
[] = {
120 static const int ldo_k_typ_voltages
[] = {
126 /* The regulator devices */
127 static struct ab3100_regulator
128 ab3100_regulators
[AB3100_NUM_REGULATORS
] = {
130 .regreg
= AB3100_LDO_A
,
131 .fixed_voltage
= LDO_A_VOLTAGE
,
134 .regreg
= AB3100_LDO_C
,
135 .fixed_voltage
= LDO_C_VOLTAGE
,
138 .regreg
= AB3100_LDO_D
,
139 .fixed_voltage
= LDO_D_VOLTAGE
,
142 .regreg
= AB3100_LDO_E
,
143 .typ_voltages
= ldo_e_buck_typ_voltages
,
144 .voltages_len
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
147 .regreg
= AB3100_LDO_F
,
148 .typ_voltages
= ldo_f_typ_voltages
,
149 .voltages_len
= ARRAY_SIZE(ldo_f_typ_voltages
),
152 .regreg
= AB3100_LDO_G
,
153 .typ_voltages
= ldo_g_typ_voltages
,
154 .voltages_len
= ARRAY_SIZE(ldo_g_typ_voltages
),
157 .regreg
= AB3100_LDO_H
,
158 .typ_voltages
= ldo_h_typ_voltages
,
159 .voltages_len
= ARRAY_SIZE(ldo_h_typ_voltages
),
162 .regreg
= AB3100_LDO_K
,
163 .typ_voltages
= ldo_k_typ_voltages
,
164 .voltages_len
= ARRAY_SIZE(ldo_k_typ_voltages
),
167 .regreg
= AB3100_LDO_EXT
,
168 /* No voltages for the external regulator */
171 .regreg
= AB3100_BUCK
,
172 .typ_voltages
= ldo_e_buck_typ_voltages
,
173 .voltages_len
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
178 * General functions for enable, disable and is_enabled used for
179 * LDO: A,C,E,F,G,H,K,EXT and BUCK
181 static int ab3100_enable_regulator(struct regulator_dev
*reg
)
183 struct ab3100_regulator
*abreg
= reg
->reg_data
;
187 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
190 dev_warn(®
->dev
, "failed to get regid %d value\n",
195 /* The regulator is already on, no reason to go further */
196 if (regval
& AB3100_REG_ON_MASK
)
199 regval
|= AB3100_REG_ON_MASK
;
201 err
= abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
204 dev_warn(®
->dev
, "failed to set regid %d value\n",
212 static int ab3100_disable_regulator(struct regulator_dev
*reg
)
214 struct ab3100_regulator
*abreg
= reg
->reg_data
;
219 * LDO D is a special regulator. When it is disabled, the entire
220 * system is shut down. So this is handled specially.
222 pr_info("Called ab3100_disable_regulator\n");
223 if (abreg
->regreg
== AB3100_LDO_D
) {
224 dev_info(®
->dev
, "disabling LDO D - shut down system\n");
225 /* Setting LDO D to 0x00 cuts the power to the SoC */
226 return abx500_set_register_interruptible(abreg
->dev
, 0,
227 AB3100_LDO_D
, 0x00U
);
231 * All other regulators are handled here
233 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
236 dev_err(®
->dev
, "unable to get register 0x%x\n",
240 regval
&= ~AB3100_REG_ON_MASK
;
241 return abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
245 static int ab3100_is_enabled_regulator(struct regulator_dev
*reg
)
247 struct ab3100_regulator
*abreg
= reg
->reg_data
;
251 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
254 dev_err(®
->dev
, "unable to get register 0x%x\n",
259 return regval
& AB3100_REG_ON_MASK
;
262 static int ab3100_list_voltage_regulator(struct regulator_dev
*reg
,
265 struct ab3100_regulator
*abreg
= reg
->reg_data
;
267 if (selector
>= abreg
->voltages_len
)
269 return abreg
->typ_voltages
[selector
];
272 static int ab3100_get_voltage_regulator(struct regulator_dev
*reg
)
274 struct ab3100_regulator
*abreg
= reg
->reg_data
;
278 /* Return the voltage for fixed regulators immediately */
279 if (abreg
->fixed_voltage
)
280 return abreg
->fixed_voltage
;
283 * For variable types, read out setting and index into
284 * supplied voltage list.
286 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
287 abreg
->regreg
, ®val
);
290 "failed to get regulator value in register %02x\n",
295 /* The 3 highest bits index voltages */
299 if (regval
>= abreg
->voltages_len
) {
301 "regulator register %02x contains an illegal voltage setting\n",
306 return abreg
->typ_voltages
[regval
];
309 static int ab3100_get_best_voltage_index(struct regulator_dev
*reg
,
310 int min_uV
, int max_uV
)
312 struct ab3100_regulator
*abreg
= reg
->reg_data
;
318 * Locate the minimum voltage fitting the criteria on
319 * this regulator. The switchable voltages are not
320 * in strict falling order so we need to check them
321 * all for the best match.
325 for (i
= 0; i
< abreg
->voltages_len
; i
++) {
326 if (abreg
->typ_voltages
[i
] <= max_uV
&&
327 abreg
->typ_voltages
[i
] >= min_uV
&&
328 abreg
->typ_voltages
[i
] < bestmatch
) {
329 bestmatch
= abreg
->typ_voltages
[i
];
335 dev_warn(®
->dev
, "requested %d<=x<=%d uV, out of range!\n",
342 static int ab3100_set_voltage_regulator(struct regulator_dev
*reg
,
343 int min_uV
, int max_uV
,
346 struct ab3100_regulator
*abreg
= reg
->reg_data
;
351 bestindex
= ab3100_get_best_voltage_index(reg
, min_uV
, max_uV
);
355 *selector
= bestindex
;
357 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
358 abreg
->regreg
, ®val
);
361 "failed to get regulator register %02x\n",
366 /* The highest three bits control the variable regulators */
368 regval
|= (bestindex
<< 5);
370 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
371 abreg
->regreg
, regval
);
373 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
379 static int ab3100_set_suspend_voltage_regulator(struct regulator_dev
*reg
,
382 struct ab3100_regulator
*abreg
= reg
->reg_data
;
388 if (abreg
->regreg
== AB3100_LDO_E
)
389 targetreg
= AB3100_LDO_E_SLEEP
;
390 else if (abreg
->regreg
== AB3100_BUCK
)
391 targetreg
= AB3100_BUCK_SLEEP
;
395 /* LDO E and BUCK have special suspend voltages you can set */
396 bestindex
= ab3100_get_best_voltage_index(reg
, uV
, uV
);
398 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
402 "failed to get regulator register %02x\n",
407 /* The highest three bits control the variable regulators */
409 regval
|= (bestindex
<< 5);
411 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
414 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
421 * The external regulator can just define a fixed voltage.
423 static int ab3100_get_voltage_regulator_external(struct regulator_dev
*reg
)
425 struct ab3100_regulator
*abreg
= reg
->reg_data
;
427 return abreg
->plfdata
->external_voltage
;
430 static int ab3100_enable_time_regulator(struct regulator_dev
*reg
)
432 struct ab3100_regulator
*abreg
= reg
->reg_data
;
434 /* Per-regulator power on delay from spec */
435 switch (abreg
->regreg
) {
436 case AB3100_LDO_A
: /* Fallthrough */
437 case AB3100_LDO_C
: /* Fallthrough */
438 case AB3100_LDO_D
: /* Fallthrough */
439 case AB3100_LDO_E
: /* Fallthrough */
440 case AB3100_LDO_H
: /* Fallthrough */
455 static struct regulator_ops regulator_ops_fixed
= {
456 .enable
= ab3100_enable_regulator
,
457 .disable
= ab3100_disable_regulator
,
458 .is_enabled
= ab3100_is_enabled_regulator
,
459 .get_voltage
= ab3100_get_voltage_regulator
,
460 .enable_time
= ab3100_enable_time_regulator
,
463 static struct regulator_ops regulator_ops_variable
= {
464 .enable
= ab3100_enable_regulator
,
465 .disable
= ab3100_disable_regulator
,
466 .is_enabled
= ab3100_is_enabled_regulator
,
467 .get_voltage
= ab3100_get_voltage_regulator
,
468 .set_voltage
= ab3100_set_voltage_regulator
,
469 .list_voltage
= ab3100_list_voltage_regulator
,
470 .enable_time
= ab3100_enable_time_regulator
,
473 static struct regulator_ops regulator_ops_variable_sleepable
= {
474 .enable
= ab3100_enable_regulator
,
475 .disable
= ab3100_disable_regulator
,
476 .is_enabled
= ab3100_is_enabled_regulator
,
477 .get_voltage
= ab3100_get_voltage_regulator
,
478 .set_voltage
= ab3100_set_voltage_regulator
,
479 .set_suspend_voltage
= ab3100_set_suspend_voltage_regulator
,
480 .list_voltage
= ab3100_list_voltage_regulator
,
481 .enable_time
= ab3100_enable_time_regulator
,
485 * LDO EXT is an external regulator so it is really
486 * not possible to set any voltage locally here, AB3100
487 * is an on/off switch plain an simple. The external
488 * voltage is defined in the board set-up if any.
490 static struct regulator_ops regulator_ops_external
= {
491 .enable
= ab3100_enable_regulator
,
492 .disable
= ab3100_disable_regulator
,
493 .is_enabled
= ab3100_is_enabled_regulator
,
494 .get_voltage
= ab3100_get_voltage_regulator_external
,
497 static struct regulator_desc
498 ab3100_regulator_desc
[AB3100_NUM_REGULATORS
] = {
502 .ops
= ®ulator_ops_fixed
,
503 .type
= REGULATOR_VOLTAGE
,
504 .owner
= THIS_MODULE
,
509 .ops
= ®ulator_ops_fixed
,
510 .type
= REGULATOR_VOLTAGE
,
511 .owner
= THIS_MODULE
,
516 .ops
= ®ulator_ops_fixed
,
517 .type
= REGULATOR_VOLTAGE
,
518 .owner
= THIS_MODULE
,
523 .ops
= ®ulator_ops_variable_sleepable
,
524 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
525 .type
= REGULATOR_VOLTAGE
,
526 .owner
= THIS_MODULE
,
531 .ops
= ®ulator_ops_variable
,
532 .n_voltages
= ARRAY_SIZE(ldo_f_typ_voltages
),
533 .type
= REGULATOR_VOLTAGE
,
534 .owner
= THIS_MODULE
,
539 .ops
= ®ulator_ops_variable
,
540 .n_voltages
= ARRAY_SIZE(ldo_g_typ_voltages
),
541 .type
= REGULATOR_VOLTAGE
,
542 .owner
= THIS_MODULE
,
547 .ops
= ®ulator_ops_variable
,
548 .n_voltages
= ARRAY_SIZE(ldo_h_typ_voltages
),
549 .type
= REGULATOR_VOLTAGE
,
550 .owner
= THIS_MODULE
,
555 .ops
= ®ulator_ops_variable
,
556 .n_voltages
= ARRAY_SIZE(ldo_k_typ_voltages
),
557 .type
= REGULATOR_VOLTAGE
,
558 .owner
= THIS_MODULE
,
562 .id
= AB3100_LDO_EXT
,
563 .ops
= ®ulator_ops_external
,
564 .type
= REGULATOR_VOLTAGE
,
565 .owner
= THIS_MODULE
,
570 .ops
= ®ulator_ops_variable_sleepable
,
571 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
572 .type
= REGULATOR_VOLTAGE
,
573 .owner
= THIS_MODULE
,
578 * NOTE: the following functions are regulators pluralis - it is the
579 * binding to the AB3100 core driver and the parent platform device
580 * for all the different regulators.
583 static int __devinit
ab3100_regulators_probe(struct platform_device
*pdev
)
585 struct ab3100_platform_data
*plfdata
= mfd_get_data(pdev
);
590 /* Check chip state */
591 err
= abx500_get_register_interruptible(&pdev
->dev
, 0,
592 AB3100_LDO_D
, &data
);
594 dev_err(&pdev
->dev
, "could not read initial status of LDO_D\n");
598 dev_notice(&pdev
->dev
,
599 "chip is already in active mode (Warm start)\n");
601 dev_notice(&pdev
->dev
,
602 "chip is in inactive mode (Cold start)\n");
604 /* Set up regulators */
605 for (i
= 0; i
< ARRAY_SIZE(ab3100_reg_init_order
); i
++) {
606 err
= abx500_set_register_interruptible(&pdev
->dev
, 0,
607 ab3100_reg_init_order
[i
],
608 plfdata
->reg_initvals
[i
]);
610 dev_err(&pdev
->dev
, "regulator initialization failed with error %d\n",
616 /* Register the regulators */
617 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
618 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
619 struct regulator_dev
*rdev
;
622 * Initialize per-regulator struct.
623 * Inherit platform data, this comes down from the
624 * i2c boarddata, from the machine. So if you want to
625 * see what it looks like for a certain machine, go
626 * into the machine I2C setup.
628 reg
->dev
= &pdev
->dev
;
629 reg
->plfdata
= plfdata
;
632 * Register the regulator, pass around
633 * the ab3100_regulator struct
635 rdev
= regulator_register(&ab3100_regulator_desc
[i
],
637 &plfdata
->reg_constraints
[i
],
643 "%s: failed to register regulator %s err %d\n",
644 __func__
, ab3100_regulator_desc
[i
].name
,
646 /* remove the already registered regulators */
648 regulator_unregister(ab3100_regulators
[i
].rdev
);
652 /* Then set a pointer back to the registered regulator */
659 static int __devexit
ab3100_regulators_remove(struct platform_device
*pdev
)
663 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
664 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
666 regulator_unregister(reg
->rdev
);
671 static struct platform_driver ab3100_regulators_driver
= {
673 .name
= "ab3100-regulators",
674 .owner
= THIS_MODULE
,
676 .probe
= ab3100_regulators_probe
,
677 .remove
= __devexit_p(ab3100_regulators_remove
),
680 static __init
int ab3100_regulators_init(void)
682 return platform_driver_register(&ab3100_regulators_driver
);
685 static __exit
void ab3100_regulators_exit(void)
687 platform_driver_unregister(&ab3100_regulators_driver
);
690 subsys_initcall(ab3100_regulators_init
);
691 module_exit(ab3100_regulators_exit
);
693 MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
694 MODULE_DESCRIPTION("AB3100 Regulator driver");
695 MODULE_LICENSE("GPL");
696 MODULE_ALIAS("platform:ab3100-regulators");