2 * twl-regulator.c -- support regulators in twl4030/twl6030 family chips
4 * Copyright (C) 2008 David Brownell
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/err.h>
15 #include <linux/delay.h>
16 #include <linux/platform_device.h>
17 #include <linux/regulator/driver.h>
18 #include <linux/regulator/machine.h>
19 #include <linux/i2c/twl.h>
23 * The TWL4030/TW5030/TPS659x0/TWL6030 family chips include power management, a
24 * USB OTG transceiver, an RTC, ADC, PWM, and lots more. Some versions
25 * include an audio codec, battery charger, and more voltage regulators.
26 * These chips are often used in OMAP-based systems.
28 * This driver implements software-based resource control for various
29 * voltage regulators. This is usually augmented with state machine
34 /* start of regulator's PM_RECEIVER control register bank */
37 /* twl resource ID, for resource control state machine */
40 /* voltage in mV = table[VSEL]; table_len must be a power-of-two */
44 /* regulator specific turn-on delay */
47 /* State REMAP default configuration */
50 /* chip constraints on regulator behavior */
54 /* used by regulator core */
55 struct regulator_desc desc
;
59 /* LDO control registers ... offset is from the base of its register bank.
60 * The first three registers of all power resource banks help hardware to
61 * manage the various resource groups.
63 /* Common offset in TWL4030/6030 */
65 /* TWL4030 register offsets */
68 #define VREG_DEDICATED 3 /* LDO control */
69 /* TWL6030 register offsets */
72 #define VREG_VOLTAGE 3
73 /* TWL6030 Misc register offsets */
76 #define VREG_BC_PROC 3
77 #define VREG_BC_CLK_RST 4
80 twlreg_read(struct twlreg_info
*info
, unsigned slave_subgp
, unsigned offset
)
85 status
= twl_i2c_read_u8(slave_subgp
,
86 &value
, info
->base
+ offset
);
87 return (status
< 0) ? status
: value
;
91 twlreg_write(struct twlreg_info
*info
, unsigned slave_subgp
, unsigned offset
,
94 return twl_i2c_write_u8(slave_subgp
,
95 value
, info
->base
+ offset
);
98 /*----------------------------------------------------------------------*/
100 /* generic power resource operations, which work on all regulators */
102 static int twlreg_grp(struct regulator_dev
*rdev
)
104 return twlreg_read(rdev_get_drvdata(rdev
), TWL_MODULE_PM_RECEIVER
,
109 * Enable/disable regulators by joining/leaving the P1 (processor) group.
110 * We assume nobody else is updating the DEV_GRP registers.
112 /* definition for 4030 family */
113 #define P3_GRP_4030 BIT(7) /* "peripherals" */
114 #define P2_GRP_4030 BIT(6) /* secondary processor, modem, etc */
115 #define P1_GRP_4030 BIT(5) /* CPU/Linux */
116 /* definition for 6030 family */
117 #define P3_GRP_6030 BIT(2) /* secondary processor, modem, etc */
118 #define P2_GRP_6030 BIT(1) /* "peripherals" */
119 #define P1_GRP_6030 BIT(0) /* CPU/Linux */
121 static int twlreg_is_enabled(struct regulator_dev
*rdev
)
123 int state
= twlreg_grp(rdev
);
128 if (twl_class_is_4030())
129 state
&= P1_GRP_4030
;
131 state
&= P1_GRP_6030
;
135 static int twlreg_enable(struct regulator_dev
*rdev
)
137 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
141 grp
= twlreg_read(info
, TWL_MODULE_PM_RECEIVER
, VREG_GRP
);
145 if (twl_class_is_4030())
150 ret
= twlreg_write(info
, TWL_MODULE_PM_RECEIVER
, VREG_GRP
, grp
);
157 static int twlreg_disable(struct regulator_dev
*rdev
)
159 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
162 grp
= twlreg_read(info
, TWL_MODULE_PM_RECEIVER
, VREG_GRP
);
166 if (twl_class_is_4030())
167 grp
&= ~(P1_GRP_4030
| P2_GRP_4030
| P3_GRP_4030
);
169 grp
&= ~(P1_GRP_6030
| P2_GRP_6030
| P3_GRP_6030
);
171 return twlreg_write(info
, TWL_MODULE_PM_RECEIVER
, VREG_GRP
, grp
);
174 static int twlreg_get_status(struct regulator_dev
*rdev
)
176 int state
= twlreg_grp(rdev
);
178 if (twl_class_is_6030())
179 return 0; /* FIXME return for 6030 regulator */
185 /* assume state != WARM_RESET; we'd not be running... */
187 return REGULATOR_STATUS_OFF
;
188 return (state
& BIT(3))
189 ? REGULATOR_STATUS_NORMAL
190 : REGULATOR_STATUS_STANDBY
;
193 static int twlreg_set_mode(struct regulator_dev
*rdev
, unsigned mode
)
195 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
199 if (twl_class_is_6030())
200 return 0; /* FIXME return for 6030 regulator */
202 /* We can only set the mode through state machine commands... */
204 case REGULATOR_MODE_NORMAL
:
205 message
= MSG_SINGULAR(DEV_GRP_P1
, info
->id
, RES_STATE_ACTIVE
);
207 case REGULATOR_MODE_STANDBY
:
208 message
= MSG_SINGULAR(DEV_GRP_P1
, info
->id
, RES_STATE_SLEEP
);
214 /* Ensure the resource is associated with some group */
215 status
= twlreg_grp(rdev
);
218 if (!(status
& (P3_GRP_4030
| P2_GRP_4030
| P1_GRP_4030
)))
221 status
= twl_i2c_write_u8(TWL_MODULE_PM_MASTER
,
222 message
>> 8, TWL4030_PM_MASTER_PB_WORD_MSB
);
226 return twl_i2c_write_u8(TWL_MODULE_PM_MASTER
,
227 message
& 0xff, TWL4030_PM_MASTER_PB_WORD_LSB
);
230 /*----------------------------------------------------------------------*/
233 * Support for adjustable-voltage LDOs uses a four bit (or less) voltage
234 * select field in its control register. We use tables indexed by VSEL
235 * to record voltages in milliVolts. (Accuracy is about three percent.)
237 * Note that VSEL values for VAUX2 changed in twl5030 and newer silicon;
238 * currently handled by listing two slightly different VAUX2 regulators,
239 * only one of which will be configured.
241 * VSEL values documented as "TI cannot support these values" are flagged
242 * in these tables as UNSUP() values; we normally won't assign them.
244 * VAUX3 at 3V is incorrectly listed in some TI manuals as unsupported.
245 * TI are revising the twl5030/tps659x0 specs to support that 3.0V setting.
247 #ifdef CONFIG_TWL4030_ALLOW_UNSUPPORTED
248 #define UNSUP_MASK 0x0000
250 #define UNSUP_MASK 0x8000
253 #define UNSUP(x) (UNSUP_MASK | (x))
254 #define IS_UNSUP(x) (UNSUP_MASK & (x))
255 #define LDO_MV(x) (~UNSUP_MASK & (x))
258 static const u16 VAUX1_VSEL_table
[] = {
259 UNSUP(1500), UNSUP(1800), 2500, 2800,
260 3000, 3000, 3000, 3000,
262 static const u16 VAUX2_4030_VSEL_table
[] = {
263 UNSUP(1000), UNSUP(1000), UNSUP(1200), 1300,
264 1500, 1800, UNSUP(1850), 2500,
265 UNSUP(2600), 2800, UNSUP(2850), UNSUP(3000),
266 UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
268 static const u16 VAUX2_VSEL_table
[] = {
269 1700, 1700, 1900, 1300,
270 1500, 1800, 2000, 2500,
271 2100, 2800, 2200, 2300,
272 2400, 2400, 2400, 2400,
274 static const u16 VAUX3_VSEL_table
[] = {
275 1500, 1800, 2500, 2800,
276 3000, 3000, 3000, 3000,
278 static const u16 VAUX4_VSEL_table
[] = {
279 700, 1000, 1200, UNSUP(1300),
280 1500, 1800, UNSUP(1850), 2500,
281 UNSUP(2600), 2800, UNSUP(2850), UNSUP(3000),
282 UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
284 static const u16 VMMC1_VSEL_table
[] = {
285 1850, 2850, 3000, 3150,
287 static const u16 VMMC2_VSEL_table
[] = {
288 UNSUP(1000), UNSUP(1000), UNSUP(1200), UNSUP(1300),
289 UNSUP(1500), UNSUP(1800), 1850, UNSUP(2500),
290 2600, 2800, 2850, 3000,
291 3150, 3150, 3150, 3150,
293 static const u16 VPLL1_VSEL_table
[] = {
294 1000, 1200, 1300, 1800,
295 UNSUP(2800), UNSUP(3000), UNSUP(3000), UNSUP(3000),
297 static const u16 VPLL2_VSEL_table
[] = {
298 700, 1000, 1200, 1300,
299 UNSUP(1500), 1800, UNSUP(1850), UNSUP(2500),
300 UNSUP(2600), UNSUP(2800), UNSUP(2850), UNSUP(3000),
301 UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
303 static const u16 VSIM_VSEL_table
[] = {
304 UNSUP(1000), UNSUP(1200), UNSUP(1300), 1800,
305 2800, 3000, 3000, 3000,
307 static const u16 VDAC_VSEL_table
[] = {
308 1200, 1300, 1800, 1800,
310 static const u16 VDD1_VSEL_table
[] = {
313 static const u16 VDD2_VSEL_table
[] = {
316 static const u16 VIO_VSEL_table
[] = {
319 static const u16 VINTANA2_VSEL_table
[] = {
323 static int twl4030ldo_list_voltage(struct regulator_dev
*rdev
, unsigned index
)
325 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
326 int mV
= info
->table
[index
];
328 return IS_UNSUP(mV
) ? 0 : (LDO_MV(mV
) * 1000);
332 twl4030ldo_set_voltage(struct regulator_dev
*rdev
, int min_uV
, int max_uV
,
335 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
338 for (vsel
= 0; vsel
< info
->table_len
; vsel
++) {
339 int mV
= info
->table
[vsel
];
344 uV
= LDO_MV(mV
) * 1000;
346 /* REVISIT for VAUX2, first match may not be best/lowest */
348 /* use the first in-range value */
349 if (min_uV
<= uV
&& uV
<= max_uV
) {
351 return twlreg_write(info
, TWL_MODULE_PM_RECEIVER
,
359 static int twl4030ldo_get_voltage(struct regulator_dev
*rdev
)
361 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
362 int vsel
= twlreg_read(info
, TWL_MODULE_PM_RECEIVER
,
368 vsel
&= info
->table_len
- 1;
369 return LDO_MV(info
->table
[vsel
]) * 1000;
372 static struct regulator_ops twl4030ldo_ops
= {
373 .list_voltage
= twl4030ldo_list_voltage
,
375 .set_voltage
= twl4030ldo_set_voltage
,
376 .get_voltage
= twl4030ldo_get_voltage
,
378 .enable
= twlreg_enable
,
379 .disable
= twlreg_disable
,
380 .is_enabled
= twlreg_is_enabled
,
382 .set_mode
= twlreg_set_mode
,
384 .get_status
= twlreg_get_status
,
387 static int twl6030ldo_list_voltage(struct regulator_dev
*rdev
, unsigned index
)
389 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
391 return ((info
->min_mV
+ (index
* 100)) * 1000);
395 twl6030ldo_set_voltage(struct regulator_dev
*rdev
, int min_uV
, int max_uV
,
398 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
401 if ((min_uV
/1000 < info
->min_mV
) || (max_uV
/1000 > info
->max_mV
))
405 * Use the below formula to calculate vsel
406 * mV = 1000mv + 100mv * (vsel - 1)
408 vsel
= (min_uV
/1000 - 1000)/100 + 1;
410 return twlreg_write(info
, TWL_MODULE_PM_RECEIVER
, VREG_VOLTAGE
, vsel
);
414 static int twl6030ldo_get_voltage(struct regulator_dev
*rdev
)
416 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
417 int vsel
= twlreg_read(info
, TWL_MODULE_PM_RECEIVER
,
424 * Use the below formula to calculate vsel
425 * mV = 1000mv + 100mv * (vsel - 1)
427 return (1000 + (100 * (vsel
- 1))) * 1000;
430 static struct regulator_ops twl6030ldo_ops
= {
431 .list_voltage
= twl6030ldo_list_voltage
,
433 .set_voltage
= twl6030ldo_set_voltage
,
434 .get_voltage
= twl6030ldo_get_voltage
,
436 .enable
= twlreg_enable
,
437 .disable
= twlreg_disable
,
438 .is_enabled
= twlreg_is_enabled
,
440 .set_mode
= twlreg_set_mode
,
442 .get_status
= twlreg_get_status
,
445 /*----------------------------------------------------------------------*/
448 * Fixed voltage LDOs don't have a VSEL field to update.
450 static int twlfixed_list_voltage(struct regulator_dev
*rdev
, unsigned index
)
452 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
454 return info
->min_mV
* 1000;
457 static int twlfixed_get_voltage(struct regulator_dev
*rdev
)
459 struct twlreg_info
*info
= rdev_get_drvdata(rdev
);
461 return info
->min_mV
* 1000;
464 static struct regulator_ops twlfixed_ops
= {
465 .list_voltage
= twlfixed_list_voltage
,
467 .get_voltage
= twlfixed_get_voltage
,
469 .enable
= twlreg_enable
,
470 .disable
= twlreg_disable
,
471 .is_enabled
= twlreg_is_enabled
,
473 .set_mode
= twlreg_set_mode
,
475 .get_status
= twlreg_get_status
,
478 static struct regulator_ops twl6030_fixed_resource
= {
479 .enable
= twlreg_enable
,
480 .disable
= twlreg_disable
,
481 .is_enabled
= twlreg_is_enabled
,
482 .get_status
= twlreg_get_status
,
485 /*----------------------------------------------------------------------*/
487 #define TWL4030_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
489 TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
491 #define TWL6030_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
493 TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
496 #define TWL4030_ADJUSTABLE_LDO(label, offset, num, turnon_delay, remap_conf) { \
499 .table_len = ARRAY_SIZE(label##_VSEL_table), \
500 .table = label##_VSEL_table, \
501 .delay = turnon_delay, \
502 .remap = remap_conf, \
505 .id = TWL4030_REG_##label, \
506 .n_voltages = ARRAY_SIZE(label##_VSEL_table), \
507 .ops = &twl4030ldo_ops, \
508 .type = REGULATOR_VOLTAGE, \
509 .owner = THIS_MODULE, \
513 #define TWL6030_ADJUSTABLE_LDO(label, offset, min_mVolts, max_mVolts, num, \
517 .min_mV = min_mVolts, \
518 .max_mV = max_mVolts, \
519 .remap = remap_conf, \
522 .id = TWL6030_REG_##label, \
523 .n_voltages = (max_mVolts - min_mVolts)/100, \
524 .ops = &twl6030ldo_ops, \
525 .type = REGULATOR_VOLTAGE, \
526 .owner = THIS_MODULE, \
531 #define TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, remap_conf, \
536 .delay = turnon_delay, \
537 .remap = remap_conf, \
540 .id = family##_REG_##label, \
542 .ops = &twlfixed_ops, \
543 .type = REGULATOR_VOLTAGE, \
544 .owner = THIS_MODULE, \
548 #define TWL6030_FIXED_RESOURCE(label, offset, num, turnon_delay, remap_conf) { \
551 .delay = turnon_delay, \
552 .remap = remap_conf, \
555 .id = TWL6030_REG_##label, \
556 .ops = &twl6030_fixed_resource, \
557 .type = REGULATOR_VOLTAGE, \
558 .owner = THIS_MODULE, \
563 * We list regulators here if systems need some level of
564 * software control over them after boot.
566 static struct twlreg_info twl_regs
[] = {
567 TWL4030_ADJUSTABLE_LDO(VAUX1
, 0x17, 1, 100, 0x08),
568 TWL4030_ADJUSTABLE_LDO(VAUX2_4030
, 0x1b, 2, 100, 0x08),
569 TWL4030_ADJUSTABLE_LDO(VAUX2
, 0x1b, 2, 100, 0x08),
570 TWL4030_ADJUSTABLE_LDO(VAUX3
, 0x1f, 3, 100, 0x08),
571 TWL4030_ADJUSTABLE_LDO(VAUX4
, 0x23, 4, 100, 0x08),
572 TWL4030_ADJUSTABLE_LDO(VMMC1
, 0x27, 5, 100, 0x08),
573 TWL4030_ADJUSTABLE_LDO(VMMC2
, 0x2b, 6, 100, 0x08),
574 TWL4030_ADJUSTABLE_LDO(VPLL1
, 0x2f, 7, 100, 0x00),
575 TWL4030_ADJUSTABLE_LDO(VPLL2
, 0x33, 8, 100, 0x08),
576 TWL4030_ADJUSTABLE_LDO(VSIM
, 0x37, 9, 100, 0x00),
577 TWL4030_ADJUSTABLE_LDO(VDAC
, 0x3b, 10, 100, 0x08),
578 TWL4030_FIXED_LDO(VINTANA1
, 0x3f, 1500, 11, 100, 0x08),
579 TWL4030_ADJUSTABLE_LDO(VINTANA2
, 0x43, 12, 100, 0x08),
580 TWL4030_FIXED_LDO(VINTDIG
, 0x47, 1500, 13, 100, 0x08),
581 TWL4030_ADJUSTABLE_LDO(VIO
, 0x4b, 14, 1000, 0x08),
582 TWL4030_ADJUSTABLE_LDO(VDD1
, 0x55, 15, 1000, 0x08),
583 TWL4030_ADJUSTABLE_LDO(VDD2
, 0x63, 16, 1000, 0x08),
584 TWL4030_FIXED_LDO(VUSB1V5
, 0x71, 1500, 17, 100, 0x08),
585 TWL4030_FIXED_LDO(VUSB1V8
, 0x74, 1800, 18, 100, 0x08),
586 TWL4030_FIXED_LDO(VUSB3V1
, 0x77, 3100, 19, 150, 0x08),
587 /* VUSBCP is managed *only* by the USB subchip */
589 /* 6030 REG with base as PMC Slave Misc : 0x0030 */
590 /* Turnon-delay and remap configuration values for 6030 are not
591 verified since the specification is not public */
592 TWL6030_ADJUSTABLE_LDO(VAUX1_6030
, 0x54, 1000, 3300, 1, 0x21),
593 TWL6030_ADJUSTABLE_LDO(VAUX2_6030
, 0x58, 1000, 3300, 2, 0x21),
594 TWL6030_ADJUSTABLE_LDO(VAUX3_6030
, 0x5c, 1000, 3300, 3, 0x21),
595 TWL6030_ADJUSTABLE_LDO(VMMC
, 0x68, 1000, 3300, 4, 0x21),
596 TWL6030_ADJUSTABLE_LDO(VPP
, 0x6c, 1000, 3300, 5, 0x21),
597 TWL6030_ADJUSTABLE_LDO(VUSIM
, 0x74, 1000, 3300, 7, 0x21),
598 TWL6030_FIXED_LDO(VANA
, 0x50, 2100, 15, 0, 0x21),
599 TWL6030_FIXED_LDO(VCXIO
, 0x60, 1800, 16, 0, 0x21),
600 TWL6030_FIXED_LDO(VDAC
, 0x64, 1800, 17, 0, 0x21),
601 TWL6030_FIXED_LDO(VUSB
, 0x70, 3300, 18, 0, 0x21),
602 TWL6030_FIXED_RESOURCE(CLK32KG
, 0x8C, 48, 0, 0x21),
605 static int __devinit
twlreg_probe(struct platform_device
*pdev
)
608 struct twlreg_info
*info
;
609 struct regulator_init_data
*initdata
;
610 struct regulation_constraints
*c
;
611 struct regulator_dev
*rdev
;
613 for (i
= 0, info
= NULL
; i
< ARRAY_SIZE(twl_regs
); i
++) {
614 if (twl_regs
[i
].desc
.id
!= pdev
->id
)
622 initdata
= pdev
->dev
.platform_data
;
626 /* Constrain board-specific capabilities according to what
627 * this driver and the chip itself can actually do.
629 c
= &initdata
->constraints
;
630 c
->valid_modes_mask
&= REGULATOR_MODE_NORMAL
| REGULATOR_MODE_STANDBY
;
631 c
->valid_ops_mask
&= REGULATOR_CHANGE_VOLTAGE
632 | REGULATOR_CHANGE_MODE
633 | REGULATOR_CHANGE_STATUS
;
635 case TWL4030_REG_VIO
:
636 case TWL4030_REG_VDD1
:
637 case TWL4030_REG_VDD2
:
638 case TWL4030_REG_VPLL1
:
639 case TWL4030_REG_VINTANA1
:
640 case TWL4030_REG_VINTANA2
:
641 case TWL4030_REG_VINTDIG
:
648 rdev
= regulator_register(&info
->desc
, &pdev
->dev
, initdata
, info
);
650 dev_err(&pdev
->dev
, "can't register %s, %ld\n",
651 info
->desc
.name
, PTR_ERR(rdev
));
652 return PTR_ERR(rdev
);
654 platform_set_drvdata(pdev
, rdev
);
656 twlreg_write(info
, TWL_MODULE_PM_RECEIVER
, VREG_REMAP
,
659 /* NOTE: many regulators support short-circuit IRQs (presentable
660 * as REGULATOR_OVER_CURRENT notifications?) configured via:
662 * - SC_DETECT1 (vintana2, vmmc1/2, vaux1/2/3/4)
663 * - SC_DETECT2 (vusb, vdac, vio, vdd1/2, vpll2)
670 static int __devexit
twlreg_remove(struct platform_device
*pdev
)
672 regulator_unregister(platform_get_drvdata(pdev
));
676 MODULE_ALIAS("platform:twl_reg");
678 static struct platform_driver twlreg_driver
= {
679 .probe
= twlreg_probe
,
680 .remove
= __devexit_p(twlreg_remove
),
681 /* NOTE: short name, to work around driver model truncation of
682 * "twl_regulator.12" (and friends) to "twl_regulator.1".
684 .driver
.name
= "twl_reg",
685 .driver
.owner
= THIS_MODULE
,
688 static int __init
twlreg_init(void)
690 return platform_driver_register(&twlreg_driver
);
692 subsys_initcall(twlreg_init
);
694 static void __exit
twlreg_exit(void)
696 platform_driver_unregister(&twlreg_driver
);
698 module_exit(twlreg_exit
)
700 MODULE_DESCRIPTION("TWL regulator driver");
701 MODULE_LICENSE("GPL");