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",
211 static int ab3100_disable_regulator(struct regulator_dev
*reg
)
213 struct ab3100_regulator
*abreg
= reg
->reg_data
;
218 * LDO D is a special regulator. When it is disabled, the entire
219 * system is shut down. So this is handled specially.
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
);
230 * All other regulators are handled here
232 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
235 dev_err(®
->dev
, "unable to get register 0x%x\n",
239 regval
&= ~AB3100_REG_ON_MASK
;
240 return abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
244 static int ab3100_is_enabled_regulator(struct regulator_dev
*reg
)
246 struct ab3100_regulator
*abreg
= reg
->reg_data
;
250 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
253 dev_err(®
->dev
, "unable to get register 0x%x\n",
258 return regval
& AB3100_REG_ON_MASK
;
261 static int ab3100_list_voltage_regulator(struct regulator_dev
*reg
,
264 struct ab3100_regulator
*abreg
= reg
->reg_data
;
266 if (selector
>= abreg
->voltages_len
)
268 return abreg
->typ_voltages
[selector
];
271 static int ab3100_get_voltage_regulator(struct regulator_dev
*reg
)
273 struct ab3100_regulator
*abreg
= reg
->reg_data
;
277 /* Return the voltage for fixed regulators immediately */
278 if (abreg
->fixed_voltage
)
279 return abreg
->fixed_voltage
;
282 * For variable types, read out setting and index into
283 * supplied voltage list.
285 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
286 abreg
->regreg
, ®val
);
289 "failed to get regulator value in register %02x\n",
294 /* The 3 highest bits index voltages */
298 if (regval
>= abreg
->voltages_len
) {
300 "regulator register %02x contains an illegal voltage setting\n",
305 return abreg
->typ_voltages
[regval
];
308 static int ab3100_get_best_voltage_index(struct regulator_dev
*reg
,
309 int min_uV
, int max_uV
)
311 struct ab3100_regulator
*abreg
= reg
->reg_data
;
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.
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
];
334 dev_warn(®
->dev
, "requested %d<=x<=%d uV, out of range!\n",
341 static int ab3100_set_voltage_regulator(struct regulator_dev
*reg
,
342 int min_uV
, int max_uV
,
345 struct ab3100_regulator
*abreg
= reg
->reg_data
;
350 bestindex
= ab3100_get_best_voltage_index(reg
, min_uV
, max_uV
);
354 *selector
= bestindex
;
356 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
357 abreg
->regreg
, ®val
);
360 "failed to get regulator register %02x\n",
365 /* The highest three bits control the variable regulators */
367 regval
|= (bestindex
<< 5);
369 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
370 abreg
->regreg
, regval
);
372 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
378 static int ab3100_set_suspend_voltage_regulator(struct regulator_dev
*reg
,
381 struct ab3100_regulator
*abreg
= reg
->reg_data
;
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
;
394 /* LDO E and BUCK have special suspend voltages you can set */
395 bestindex
= ab3100_get_best_voltage_index(reg
, uV
, uV
);
397 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
401 "failed to get regulator register %02x\n",
406 /* The highest three bits control the variable regulators */
408 regval
|= (bestindex
<< 5);
410 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
413 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
420 * The external regulator can just define a fixed voltage.
422 static int ab3100_get_voltage_regulator_external(struct regulator_dev
*reg
)
424 struct ab3100_regulator
*abreg
= reg
->reg_data
;
426 return abreg
->plfdata
->external_voltage
;
429 static int ab3100_enable_time_regulator(struct regulator_dev
*reg
)
431 struct ab3100_regulator
*abreg
= reg
->reg_data
;
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 */
454 static 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
,
462 static 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
,
472 static 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
,
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.
489 static 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
,
496 static struct regulator_desc
497 ab3100_regulator_desc
[AB3100_NUM_REGULATORS
] = {
501 .ops
= ®ulator_ops_fixed
,
502 .type
= REGULATOR_VOLTAGE
,
503 .owner
= THIS_MODULE
,
508 .ops
= ®ulator_ops_fixed
,
509 .type
= REGULATOR_VOLTAGE
,
510 .owner
= THIS_MODULE
,
515 .ops
= ®ulator_ops_fixed
,
516 .type
= REGULATOR_VOLTAGE
,
517 .owner
= THIS_MODULE
,
522 .ops
= ®ulator_ops_variable_sleepable
,
523 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
524 .type
= REGULATOR_VOLTAGE
,
525 .owner
= THIS_MODULE
,
530 .ops
= ®ulator_ops_variable
,
531 .n_voltages
= ARRAY_SIZE(ldo_f_typ_voltages
),
532 .type
= REGULATOR_VOLTAGE
,
533 .owner
= THIS_MODULE
,
538 .ops
= ®ulator_ops_variable
,
539 .n_voltages
= ARRAY_SIZE(ldo_g_typ_voltages
),
540 .type
= REGULATOR_VOLTAGE
,
541 .owner
= THIS_MODULE
,
546 .ops
= ®ulator_ops_variable
,
547 .n_voltages
= ARRAY_SIZE(ldo_h_typ_voltages
),
548 .type
= REGULATOR_VOLTAGE
,
549 .owner
= THIS_MODULE
,
554 .ops
= ®ulator_ops_variable
,
555 .n_voltages
= ARRAY_SIZE(ldo_k_typ_voltages
),
556 .type
= REGULATOR_VOLTAGE
,
557 .owner
= THIS_MODULE
,
561 .id
= AB3100_LDO_EXT
,
562 .ops
= ®ulator_ops_external
,
563 .type
= REGULATOR_VOLTAGE
,
564 .owner
= THIS_MODULE
,
569 .ops
= ®ulator_ops_variable_sleepable
,
570 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
571 .type
= REGULATOR_VOLTAGE
,
572 .owner
= THIS_MODULE
,
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.
582 static int __devinit
ab3100_regulators_probe(struct platform_device
*pdev
)
584 struct ab3100_platform_data
*plfdata
= pdev
->dev
.platform_data
;
589 /* Check chip state */
590 err
= abx500_get_register_interruptible(&pdev
->dev
, 0,
591 AB3100_LDO_D
, &data
);
593 dev_err(&pdev
->dev
, "could not read initial status of LDO_D\n");
597 dev_notice(&pdev
->dev
,
598 "chip is already in active mode (Warm start)\n");
600 dev_notice(&pdev
->dev
,
601 "chip is in inactive mode (Cold start)\n");
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
]);
609 dev_err(&pdev
->dev
, "regulator initialization failed with error %d\n",
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
;
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.
627 reg
->dev
= &pdev
->dev
;
628 reg
->plfdata
= plfdata
;
631 * Register the regulator, pass around
632 * the ab3100_regulator struct
634 rdev
= regulator_register(&ab3100_regulator_desc
[i
],
636 &plfdata
->reg_constraints
[i
],
642 "%s: failed to register regulator %s err %d\n",
643 __func__
, ab3100_regulator_desc
[i
].name
,
645 /* remove the already registered regulators */
647 regulator_unregister(ab3100_regulators
[i
].rdev
);
651 /* Then set a pointer back to the registered regulator */
658 static int __devexit
ab3100_regulators_remove(struct platform_device
*pdev
)
662 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
663 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
665 regulator_unregister(reg
->rdev
);
670 static struct platform_driver ab3100_regulators_driver
= {
672 .name
= "ab3100-regulators",
673 .owner
= THIS_MODULE
,
675 .probe
= ab3100_regulators_probe
,
676 .remove
= __devexit_p(ab3100_regulators_remove
),
679 static __init
int ab3100_regulators_init(void)
681 return platform_driver_register(&ab3100_regulators_driver
);
684 static __exit
void ab3100_regulators_exit(void)
686 platform_driver_unregister(&ab3100_regulators_driver
);
689 subsys_initcall(ab3100_regulators_init
);
690 module_exit(ab3100_regulators_exit
);
692 MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
693 MODULE_DESCRIPTION("AB3100 Regulator driver");
694 MODULE_LICENSE("GPL");
695 MODULE_ALIAS("platform:ab3100-regulators");