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/platform_device.h>
17 #include <linux/regulator/driver.h>
18 #include <linux/mfd/ab3100.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
48 struct ab3100_regulator
{
49 struct regulator_dev
*rdev
;
51 struct ab3100_platform_data
*plfdata
;
55 /* The order in which registers are initialized */
56 static const u8 ab3100_reg_init_order
[AB3100_NUM_REGULATORS
+2] = {
71 /* Preset (hardware defined) voltages for these regulators */
72 #define LDO_A_VOLTAGE 2750000
73 #define LDO_C_VOLTAGE 2650000
74 #define LDO_D_VOLTAGE 2650000
76 static const unsigned int ldo_e_buck_typ_voltages
[] = {
86 static const unsigned int ldo_f_typ_voltages
[] = {
97 static const unsigned int ldo_g_typ_voltages
[] = {
104 static const unsigned int ldo_h_typ_voltages
[] = {
111 static const unsigned int ldo_k_typ_voltages
[] = {
117 /* The regulator devices */
118 static struct ab3100_regulator
119 ab3100_regulators
[AB3100_NUM_REGULATORS
] = {
121 .regreg
= AB3100_LDO_A
,
124 .regreg
= AB3100_LDO_C
,
127 .regreg
= AB3100_LDO_D
,
130 .regreg
= AB3100_LDO_E
,
133 .regreg
= AB3100_LDO_F
,
136 .regreg
= AB3100_LDO_G
,
139 .regreg
= AB3100_LDO_H
,
142 .regreg
= AB3100_LDO_K
,
145 .regreg
= AB3100_LDO_EXT
,
146 /* No voltages for the external regulator */
149 .regreg
= AB3100_BUCK
,
154 * General functions for enable, disable and is_enabled used for
155 * LDO: A,C,E,F,G,H,K,EXT and BUCK
157 static int ab3100_enable_regulator(struct regulator_dev
*reg
)
159 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
163 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
166 dev_warn(®
->dev
, "failed to get regid %d value\n",
171 /* The regulator is already on, no reason to go further */
172 if (regval
& AB3100_REG_ON_MASK
)
175 regval
|= AB3100_REG_ON_MASK
;
177 err
= abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
180 dev_warn(®
->dev
, "failed to set regid %d value\n",
188 static int ab3100_disable_regulator(struct regulator_dev
*reg
)
190 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
195 * LDO D is a special regulator. When it is disabled, the entire
196 * system is shut down. So this is handled specially.
198 pr_info("Called ab3100_disable_regulator\n");
199 if (abreg
->regreg
== AB3100_LDO_D
) {
200 dev_info(®
->dev
, "disabling LDO D - shut down system\n");
201 /* Setting LDO D to 0x00 cuts the power to the SoC */
202 return abx500_set_register_interruptible(abreg
->dev
, 0,
203 AB3100_LDO_D
, 0x00U
);
207 * All other regulators are handled here
209 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
212 dev_err(®
->dev
, "unable to get register 0x%x\n",
216 regval
&= ~AB3100_REG_ON_MASK
;
217 return abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
221 static int ab3100_is_enabled_regulator(struct regulator_dev
*reg
)
223 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
227 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
230 dev_err(®
->dev
, "unable to get register 0x%x\n",
235 return regval
& AB3100_REG_ON_MASK
;
238 static int ab3100_get_voltage_regulator(struct regulator_dev
*reg
)
240 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
245 * For variable types, read out setting and index into
246 * supplied voltage list.
248 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
249 abreg
->regreg
, ®val
);
252 "failed to get regulator value in register %02x\n",
257 /* The 3 highest bits index voltages */
261 if (regval
>= reg
->desc
->n_voltages
) {
263 "regulator register %02x contains an illegal voltage setting\n",
268 return reg
->desc
->volt_table
[regval
];
271 static int ab3100_set_voltage_regulator_sel(struct regulator_dev
*reg
,
274 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
278 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
279 abreg
->regreg
, ®val
);
282 "failed to get regulator register %02x\n",
287 /* The highest three bits control the variable regulators */
289 regval
|= (selector
<< 5);
291 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
292 abreg
->regreg
, regval
);
294 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
300 static int ab3100_set_suspend_voltage_regulator(struct regulator_dev
*reg
,
303 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
309 if (abreg
->regreg
== AB3100_LDO_E
)
310 targetreg
= AB3100_LDO_E_SLEEP
;
311 else if (abreg
->regreg
== AB3100_BUCK
)
312 targetreg
= AB3100_BUCK_SLEEP
;
316 /* LDO E and BUCK have special suspend voltages you can set */
317 bestindex
= regulator_map_voltage_iterate(reg
, uV
, uV
);
319 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
323 "failed to get regulator register %02x\n",
328 /* The highest three bits control the variable regulators */
330 regval
|= (bestindex
<< 5);
332 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
335 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
342 * The external regulator can just define a fixed voltage.
344 static int ab3100_get_voltage_regulator_external(struct regulator_dev
*reg
)
346 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
348 return abreg
->plfdata
->external_voltage
;
351 static struct regulator_ops regulator_ops_fixed
= {
352 .list_voltage
= regulator_list_voltage_linear
,
353 .enable
= ab3100_enable_regulator
,
354 .disable
= ab3100_disable_regulator
,
355 .is_enabled
= ab3100_is_enabled_regulator
,
358 static struct regulator_ops regulator_ops_variable
= {
359 .enable
= ab3100_enable_regulator
,
360 .disable
= ab3100_disable_regulator
,
361 .is_enabled
= ab3100_is_enabled_regulator
,
362 .get_voltage
= ab3100_get_voltage_regulator
,
363 .set_voltage_sel
= ab3100_set_voltage_regulator_sel
,
364 .list_voltage
= regulator_list_voltage_table
,
367 static struct regulator_ops regulator_ops_variable_sleepable
= {
368 .enable
= ab3100_enable_regulator
,
369 .disable
= ab3100_disable_regulator
,
370 .is_enabled
= ab3100_is_enabled_regulator
,
371 .get_voltage
= ab3100_get_voltage_regulator
,
372 .set_voltage_sel
= ab3100_set_voltage_regulator_sel
,
373 .set_suspend_voltage
= ab3100_set_suspend_voltage_regulator
,
374 .list_voltage
= regulator_list_voltage_table
,
378 * LDO EXT is an external regulator so it is really
379 * not possible to set any voltage locally here, AB3100
380 * is an on/off switch plain an simple. The external
381 * voltage is defined in the board set-up if any.
383 static struct regulator_ops regulator_ops_external
= {
384 .enable
= ab3100_enable_regulator
,
385 .disable
= ab3100_disable_regulator
,
386 .is_enabled
= ab3100_is_enabled_regulator
,
387 .get_voltage
= ab3100_get_voltage_regulator_external
,
390 static struct regulator_desc
391 ab3100_regulator_desc
[AB3100_NUM_REGULATORS
] = {
395 .ops
= ®ulator_ops_fixed
,
397 .type
= REGULATOR_VOLTAGE
,
398 .owner
= THIS_MODULE
,
399 .min_uV
= LDO_A_VOLTAGE
,
405 .ops
= ®ulator_ops_fixed
,
407 .type
= REGULATOR_VOLTAGE
,
408 .owner
= THIS_MODULE
,
409 .min_uV
= LDO_C_VOLTAGE
,
415 .ops
= ®ulator_ops_fixed
,
417 .type
= REGULATOR_VOLTAGE
,
418 .owner
= THIS_MODULE
,
419 .min_uV
= LDO_D_VOLTAGE
,
425 .ops
= ®ulator_ops_variable_sleepable
,
426 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
427 .volt_table
= ldo_e_buck_typ_voltages
,
428 .type
= REGULATOR_VOLTAGE
,
429 .owner
= THIS_MODULE
,
435 .ops
= ®ulator_ops_variable
,
436 .n_voltages
= ARRAY_SIZE(ldo_f_typ_voltages
),
437 .volt_table
= ldo_f_typ_voltages
,
438 .type
= REGULATOR_VOLTAGE
,
439 .owner
= THIS_MODULE
,
445 .ops
= ®ulator_ops_variable
,
446 .n_voltages
= ARRAY_SIZE(ldo_g_typ_voltages
),
447 .volt_table
= ldo_g_typ_voltages
,
448 .type
= REGULATOR_VOLTAGE
,
449 .owner
= THIS_MODULE
,
455 .ops
= ®ulator_ops_variable
,
456 .n_voltages
= ARRAY_SIZE(ldo_h_typ_voltages
),
457 .volt_table
= ldo_h_typ_voltages
,
458 .type
= REGULATOR_VOLTAGE
,
459 .owner
= THIS_MODULE
,
465 .ops
= ®ulator_ops_variable
,
466 .n_voltages
= ARRAY_SIZE(ldo_k_typ_voltages
),
467 .volt_table
= ldo_k_typ_voltages
,
468 .type
= REGULATOR_VOLTAGE
,
469 .owner
= THIS_MODULE
,
474 .id
= AB3100_LDO_EXT
,
475 .ops
= ®ulator_ops_external
,
476 .type
= REGULATOR_VOLTAGE
,
477 .owner
= THIS_MODULE
,
482 .ops
= ®ulator_ops_variable_sleepable
,
483 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
484 .volt_table
= ldo_e_buck_typ_voltages
,
485 .type
= REGULATOR_VOLTAGE
,
486 .owner
= THIS_MODULE
,
492 * NOTE: the following functions are regulators pluralis - it is the
493 * binding to the AB3100 core driver and the parent platform device
494 * for all the different regulators.
497 static int ab3100_regulators_probe(struct platform_device
*pdev
)
499 struct ab3100_platform_data
*plfdata
= pdev
->dev
.platform_data
;
500 struct regulator_config config
= { };
505 /* Check chip state */
506 err
= abx500_get_register_interruptible(&pdev
->dev
, 0,
507 AB3100_LDO_D
, &data
);
509 dev_err(&pdev
->dev
, "could not read initial status of LDO_D\n");
513 dev_notice(&pdev
->dev
,
514 "chip is already in active mode (Warm start)\n");
516 dev_notice(&pdev
->dev
,
517 "chip is in inactive mode (Cold start)\n");
519 /* Set up regulators */
520 for (i
= 0; i
< ARRAY_SIZE(ab3100_reg_init_order
); i
++) {
521 err
= abx500_set_register_interruptible(&pdev
->dev
, 0,
522 ab3100_reg_init_order
[i
],
523 plfdata
->reg_initvals
[i
]);
525 dev_err(&pdev
->dev
, "regulator initialization failed with error %d\n",
531 /* Register the regulators */
532 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
533 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
534 struct regulator_dev
*rdev
;
537 * Initialize per-regulator struct.
538 * Inherit platform data, this comes down from the
539 * i2c boarddata, from the machine. So if you want to
540 * see what it looks like for a certain machine, go
541 * into the machine I2C setup.
543 reg
->dev
= &pdev
->dev
;
544 reg
->plfdata
= plfdata
;
546 config
.dev
= &pdev
->dev
;
547 config
.driver_data
= reg
;
548 config
.init_data
= &plfdata
->reg_constraints
[i
];
551 * Register the regulator, pass around
552 * the ab3100_regulator struct
554 rdev
= regulator_register(&ab3100_regulator_desc
[i
], &config
);
558 "%s: failed to register regulator %s err %d\n",
559 __func__
, ab3100_regulator_desc
[i
].name
,
561 /* remove the already registered regulators */
563 regulator_unregister(ab3100_regulators
[i
].rdev
);
567 /* Then set a pointer back to the registered regulator */
574 static int ab3100_regulators_remove(struct platform_device
*pdev
)
578 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
579 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
581 regulator_unregister(reg
->rdev
);
586 static struct platform_driver ab3100_regulators_driver
= {
588 .name
= "ab3100-regulators",
589 .owner
= THIS_MODULE
,
591 .probe
= ab3100_regulators_probe
,
592 .remove
= ab3100_regulators_remove
,
595 static __init
int ab3100_regulators_init(void)
597 return platform_driver_register(&ab3100_regulators_driver
);
600 static __exit
void ab3100_regulators_exit(void)
602 platform_driver_unregister(&ab3100_regulators_driver
);
605 subsys_initcall(ab3100_regulators_init
);
606 module_exit(ab3100_regulators_exit
);
608 MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
609 MODULE_DESCRIPTION("AB3100 Regulator driver");
610 MODULE_LICENSE("GPL");
611 MODULE_ALIAS("platform:ab3100-regulators");