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/abx500.h>
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
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
47 struct ab3100_regulator
{
48 struct regulator_dev
*rdev
;
50 struct ab3100_platform_data
*plfdata
;
54 /* The order in which registers are initialized */
55 static const u8 ab3100_reg_init_order
[AB3100_NUM_REGULATORS
+2] = {
70 /* Preset (hardware defined) voltages for these regulators */
71 #define LDO_A_VOLTAGE 2750000
72 #define LDO_C_VOLTAGE 2650000
73 #define LDO_D_VOLTAGE 2650000
75 static const unsigned int ldo_e_buck_typ_voltages
[] = {
85 static const unsigned int ldo_f_typ_voltages
[] = {
96 static const unsigned int ldo_g_typ_voltages
[] = {
103 static const unsigned int ldo_h_typ_voltages
[] = {
110 static const unsigned int ldo_k_typ_voltages
[] = {
116 /* The regulator devices */
117 static struct ab3100_regulator
118 ab3100_regulators
[AB3100_NUM_REGULATORS
] = {
120 .regreg
= AB3100_LDO_A
,
123 .regreg
= AB3100_LDO_C
,
126 .regreg
= AB3100_LDO_D
,
129 .regreg
= AB3100_LDO_E
,
132 .regreg
= AB3100_LDO_F
,
135 .regreg
= AB3100_LDO_G
,
138 .regreg
= AB3100_LDO_H
,
141 .regreg
= AB3100_LDO_K
,
144 .regreg
= AB3100_LDO_EXT
,
145 /* No voltages for the external regulator */
148 .regreg
= AB3100_BUCK
,
153 * General functions for enable, disable and is_enabled used for
154 * LDO: A,C,E,F,G,H,K,EXT and BUCK
156 static int ab3100_enable_regulator(struct regulator_dev
*reg
)
158 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
162 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
165 dev_warn(®
->dev
, "failed to get regid %d value\n",
170 /* The regulator is already on, no reason to go further */
171 if (regval
& AB3100_REG_ON_MASK
)
174 regval
|= AB3100_REG_ON_MASK
;
176 err
= abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
179 dev_warn(®
->dev
, "failed to set regid %d value\n",
187 static int ab3100_disable_regulator(struct regulator_dev
*reg
)
189 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
194 * LDO D is a special regulator. When it is disabled, the entire
195 * system is shut down. So this is handled specially.
197 pr_info("Called ab3100_disable_regulator\n");
198 if (abreg
->regreg
== AB3100_LDO_D
) {
199 dev_info(®
->dev
, "disabling LDO D - shut down system\n");
200 /* Setting LDO D to 0x00 cuts the power to the SoC */
201 return abx500_set_register_interruptible(abreg
->dev
, 0,
202 AB3100_LDO_D
, 0x00U
);
206 * All other regulators are handled here
208 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
211 dev_err(®
->dev
, "unable to get register 0x%x\n",
215 regval
&= ~AB3100_REG_ON_MASK
;
216 return abx500_set_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
220 static int ab3100_is_enabled_regulator(struct regulator_dev
*reg
)
222 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
226 err
= abx500_get_register_interruptible(abreg
->dev
, 0, abreg
->regreg
,
229 dev_err(®
->dev
, "unable to get register 0x%x\n",
234 return regval
& AB3100_REG_ON_MASK
;
237 static int ab3100_get_voltage_regulator(struct regulator_dev
*reg
)
239 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
244 * For variable types, read out setting and index into
245 * supplied voltage list.
247 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
248 abreg
->regreg
, ®val
);
251 "failed to get regulator value in register %02x\n",
256 /* The 3 highest bits index voltages */
260 if (regval
>= reg
->desc
->n_voltages
) {
262 "regulator register %02x contains an illegal voltage setting\n",
267 return reg
->desc
->volt_table
[regval
];
270 static int ab3100_set_voltage_regulator_sel(struct regulator_dev
*reg
,
273 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
277 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
278 abreg
->regreg
, ®val
);
281 "failed to get regulator register %02x\n",
286 /* The highest three bits control the variable regulators */
288 regval
|= (selector
<< 5);
290 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
291 abreg
->regreg
, regval
);
293 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
299 static int ab3100_set_suspend_voltage_regulator(struct regulator_dev
*reg
,
302 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
308 if (abreg
->regreg
== AB3100_LDO_E
)
309 targetreg
= AB3100_LDO_E_SLEEP
;
310 else if (abreg
->regreg
== AB3100_BUCK
)
311 targetreg
= AB3100_BUCK_SLEEP
;
315 /* LDO E and BUCK have special suspend voltages you can set */
316 bestindex
= regulator_map_voltage_iterate(reg
, uV
, uV
);
318 err
= abx500_get_register_interruptible(abreg
->dev
, 0,
322 "failed to get regulator register %02x\n",
327 /* The highest three bits control the variable regulators */
329 regval
|= (bestindex
<< 5);
331 err
= abx500_set_register_interruptible(abreg
->dev
, 0,
334 dev_warn(®
->dev
, "failed to set regulator register %02x\n",
341 * The external regulator can just define a fixed voltage.
343 static int ab3100_get_voltage_regulator_external(struct regulator_dev
*reg
)
345 struct ab3100_regulator
*abreg
= rdev_get_drvdata(reg
);
347 return abreg
->plfdata
->external_voltage
;
350 static int ab3100_get_fixed_voltage_regulator(struct regulator_dev
*reg
)
352 return reg
->desc
->min_uV
;
355 static struct regulator_ops regulator_ops_fixed
= {
356 .list_voltage
= regulator_list_voltage_linear
,
357 .enable
= ab3100_enable_regulator
,
358 .disable
= ab3100_disable_regulator
,
359 .is_enabled
= ab3100_is_enabled_regulator
,
360 .get_voltage
= ab3100_get_fixed_voltage_regulator
,
363 static struct regulator_ops regulator_ops_variable
= {
364 .enable
= ab3100_enable_regulator
,
365 .disable
= ab3100_disable_regulator
,
366 .is_enabled
= ab3100_is_enabled_regulator
,
367 .get_voltage
= ab3100_get_voltage_regulator
,
368 .set_voltage_sel
= ab3100_set_voltage_regulator_sel
,
369 .list_voltage
= regulator_list_voltage_table
,
372 static struct regulator_ops regulator_ops_variable_sleepable
= {
373 .enable
= ab3100_enable_regulator
,
374 .disable
= ab3100_disable_regulator
,
375 .is_enabled
= ab3100_is_enabled_regulator
,
376 .get_voltage
= ab3100_get_voltage_regulator
,
377 .set_voltage_sel
= ab3100_set_voltage_regulator_sel
,
378 .set_suspend_voltage
= ab3100_set_suspend_voltage_regulator
,
379 .list_voltage
= regulator_list_voltage_table
,
383 * LDO EXT is an external regulator so it is really
384 * not possible to set any voltage locally here, AB3100
385 * is an on/off switch plain an simple. The external
386 * voltage is defined in the board set-up if any.
388 static struct regulator_ops regulator_ops_external
= {
389 .enable
= ab3100_enable_regulator
,
390 .disable
= ab3100_disable_regulator
,
391 .is_enabled
= ab3100_is_enabled_regulator
,
392 .get_voltage
= ab3100_get_voltage_regulator_external
,
395 static struct regulator_desc
396 ab3100_regulator_desc
[AB3100_NUM_REGULATORS
] = {
400 .ops
= ®ulator_ops_fixed
,
402 .type
= REGULATOR_VOLTAGE
,
403 .owner
= THIS_MODULE
,
404 .min_uV
= LDO_A_VOLTAGE
,
410 .ops
= ®ulator_ops_fixed
,
412 .type
= REGULATOR_VOLTAGE
,
413 .owner
= THIS_MODULE
,
414 .min_uV
= LDO_C_VOLTAGE
,
420 .ops
= ®ulator_ops_fixed
,
422 .type
= REGULATOR_VOLTAGE
,
423 .owner
= THIS_MODULE
,
424 .min_uV
= LDO_D_VOLTAGE
,
430 .ops
= ®ulator_ops_variable_sleepable
,
431 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
432 .volt_table
= ldo_e_buck_typ_voltages
,
433 .type
= REGULATOR_VOLTAGE
,
434 .owner
= THIS_MODULE
,
440 .ops
= ®ulator_ops_variable
,
441 .n_voltages
= ARRAY_SIZE(ldo_f_typ_voltages
),
442 .volt_table
= ldo_f_typ_voltages
,
443 .type
= REGULATOR_VOLTAGE
,
444 .owner
= THIS_MODULE
,
450 .ops
= ®ulator_ops_variable
,
451 .n_voltages
= ARRAY_SIZE(ldo_g_typ_voltages
),
452 .volt_table
= ldo_g_typ_voltages
,
453 .type
= REGULATOR_VOLTAGE
,
454 .owner
= THIS_MODULE
,
460 .ops
= ®ulator_ops_variable
,
461 .n_voltages
= ARRAY_SIZE(ldo_h_typ_voltages
),
462 .volt_table
= ldo_h_typ_voltages
,
463 .type
= REGULATOR_VOLTAGE
,
464 .owner
= THIS_MODULE
,
470 .ops
= ®ulator_ops_variable
,
471 .n_voltages
= ARRAY_SIZE(ldo_k_typ_voltages
),
472 .volt_table
= ldo_k_typ_voltages
,
473 .type
= REGULATOR_VOLTAGE
,
474 .owner
= THIS_MODULE
,
479 .id
= AB3100_LDO_EXT
,
480 .ops
= ®ulator_ops_external
,
481 .type
= REGULATOR_VOLTAGE
,
482 .owner
= THIS_MODULE
,
487 .ops
= ®ulator_ops_variable_sleepable
,
488 .n_voltages
= ARRAY_SIZE(ldo_e_buck_typ_voltages
),
489 .type
= REGULATOR_VOLTAGE
,
490 .owner
= THIS_MODULE
,
496 * NOTE: the following functions are regulators pluralis - it is the
497 * binding to the AB3100 core driver and the parent platform device
498 * for all the different regulators.
501 static int __devinit
ab3100_regulators_probe(struct platform_device
*pdev
)
503 struct ab3100_platform_data
*plfdata
= pdev
->dev
.platform_data
;
504 struct regulator_config config
= { };
509 /* Check chip state */
510 err
= abx500_get_register_interruptible(&pdev
->dev
, 0,
511 AB3100_LDO_D
, &data
);
513 dev_err(&pdev
->dev
, "could not read initial status of LDO_D\n");
517 dev_notice(&pdev
->dev
,
518 "chip is already in active mode (Warm start)\n");
520 dev_notice(&pdev
->dev
,
521 "chip is in inactive mode (Cold start)\n");
523 /* Set up regulators */
524 for (i
= 0; i
< ARRAY_SIZE(ab3100_reg_init_order
); i
++) {
525 err
= abx500_set_register_interruptible(&pdev
->dev
, 0,
526 ab3100_reg_init_order
[i
],
527 plfdata
->reg_initvals
[i
]);
529 dev_err(&pdev
->dev
, "regulator initialization failed with error %d\n",
535 /* Register the regulators */
536 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
537 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
538 struct regulator_dev
*rdev
;
541 * Initialize per-regulator struct.
542 * Inherit platform data, this comes down from the
543 * i2c boarddata, from the machine. So if you want to
544 * see what it looks like for a certain machine, go
545 * into the machine I2C setup.
547 reg
->dev
= &pdev
->dev
;
548 reg
->plfdata
= plfdata
;
550 config
.dev
= &pdev
->dev
;
551 config
.driver_data
= reg
;
552 config
.init_data
= &plfdata
->reg_constraints
[i
];
555 * Register the regulator, pass around
556 * the ab3100_regulator struct
558 rdev
= regulator_register(&ab3100_regulator_desc
[i
], &config
);
562 "%s: failed to register regulator %s err %d\n",
563 __func__
, ab3100_regulator_desc
[i
].name
,
565 /* remove the already registered regulators */
567 regulator_unregister(ab3100_regulators
[i
].rdev
);
571 /* Then set a pointer back to the registered regulator */
578 static int __devexit
ab3100_regulators_remove(struct platform_device
*pdev
)
582 for (i
= 0; i
< AB3100_NUM_REGULATORS
; i
++) {
583 struct ab3100_regulator
*reg
= &ab3100_regulators
[i
];
585 regulator_unregister(reg
->rdev
);
590 static struct platform_driver ab3100_regulators_driver
= {
592 .name
= "ab3100-regulators",
593 .owner
= THIS_MODULE
,
595 .probe
= ab3100_regulators_probe
,
596 .remove
= __devexit_p(ab3100_regulators_remove
),
599 static __init
int ab3100_regulators_init(void)
601 return platform_driver_register(&ab3100_regulators_driver
);
604 static __exit
void ab3100_regulators_exit(void)
606 platform_driver_unregister(&ab3100_regulators_driver
);
609 subsys_initcall(ab3100_regulators_init
);
610 module_exit(ab3100_regulators_exit
);
612 MODULE_AUTHOR("Mattias Wallin <mattias.wallin@stericsson.com>");
613 MODULE_DESCRIPTION("AB3100 Regulator driver");
614 MODULE_LICENSE("GPL");
615 MODULE_ALIAS("platform:ab3100-regulators");