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, 0x15 /* PB_WORD_MSB */ );
226 return twl_i2c_write_u8(TWL_MODULE_PM_MASTER,
227 message, 0x16 /* 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)
334 struct twlreg_info *info = rdev_get_drvdata(rdev);
337 for (vsel = 0; vsel < info->table_len; vsel++) {
338 int mV = info->table[vsel];
343 uV = LDO_MV(mV) * 1000;
345 /* REVISIT for VAUX2, first match may not be best/lowest */
347 /* use the first in-range value */
348 if (min_uV <= uV && uV <= max_uV)
349 return twlreg_write(info, TWL_MODULE_PM_RECEIVER,
356 static int twl4030ldo_get_voltage(struct regulator_dev *rdev)
358 struct twlreg_info *info = rdev_get_drvdata(rdev);
359 int vsel = twlreg_read(info, TWL_MODULE_PM_RECEIVER,
365 vsel &= info->table_len - 1;
366 return LDO_MV(info->table[vsel]) * 1000;
369 static struct regulator_ops twl4030ldo_ops = {
370 .list_voltage = twl4030ldo_list_voltage,
372 .set_voltage = twl4030ldo_set_voltage,
373 .get_voltage = twl4030ldo_get_voltage,
375 .enable = twlreg_enable,
376 .disable = twlreg_disable,
377 .is_enabled = twlreg_is_enabled,
379 .set_mode = twlreg_set_mode,
381 .get_status = twlreg_get_status,
384 static int twl6030ldo_list_voltage(struct regulator_dev *rdev, unsigned index)
386 struct twlreg_info *info = rdev_get_drvdata(rdev);
388 return ((info->min_mV + (index * 100)) * 1000);
392 twl6030ldo_set_voltage(struct regulator_dev *rdev, int min_uV, int max_uV)
394 struct twlreg_info *info = rdev_get_drvdata(rdev);
397 if ((min_uV/1000 < info->min_mV) || (max_uV/1000 > info->max_mV))
401 * Use the below formula to calculate vsel
402 * mV = 1000mv + 100mv * (vsel - 1)
404 vsel = (min_uV/1000 - 1000)/100 + 1;
405 return twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_VOLTAGE, vsel);
409 static int twl6030ldo_get_voltage(struct regulator_dev *rdev)
411 struct twlreg_info *info = rdev_get_drvdata(rdev);
412 int vsel = twlreg_read(info, TWL_MODULE_PM_RECEIVER,
419 * Use the below formula to calculate vsel
420 * mV = 1000mv + 100mv * (vsel - 1)
422 return (1000 + (100 * (vsel - 1))) * 1000;
425 static struct regulator_ops twl6030ldo_ops = {
426 .list_voltage = twl6030ldo_list_voltage,
428 .set_voltage = twl6030ldo_set_voltage,
429 .get_voltage = twl6030ldo_get_voltage,
431 .enable = twlreg_enable,
432 .disable = twlreg_disable,
433 .is_enabled = twlreg_is_enabled,
435 .set_mode = twlreg_set_mode,
437 .get_status = twlreg_get_status,
440 /*----------------------------------------------------------------------*/
443 * Fixed voltage LDOs don't have a VSEL field to update.
445 static int twlfixed_list_voltage(struct regulator_dev *rdev, unsigned index)
447 struct twlreg_info *info = rdev_get_drvdata(rdev);
449 return info->min_mV * 1000;
452 static int twlfixed_get_voltage(struct regulator_dev *rdev)
454 struct twlreg_info *info = rdev_get_drvdata(rdev);
456 return info->min_mV * 1000;
459 static struct regulator_ops twlfixed_ops = {
460 .list_voltage = twlfixed_list_voltage,
462 .get_voltage = twlfixed_get_voltage,
464 .enable = twlreg_enable,
465 .disable = twlreg_disable,
466 .is_enabled = twlreg_is_enabled,
468 .set_mode = twlreg_set_mode,
470 .get_status = twlreg_get_status,
473 /*----------------------------------------------------------------------*/
475 #define TWL4030_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
477 TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
479 #define TWL6030_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
481 TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
484 #define TWL4030_ADJUSTABLE_LDO(label, offset, num, turnon_delay, remap_conf) { \
487 .table_len = ARRAY_SIZE(label##_VSEL_table), \
488 .table = label##_VSEL_table, \
489 .delay = turnon_delay, \
490 .remap = remap_conf, \
493 .id = TWL4030_REG_##label, \
494 .n_voltages = ARRAY_SIZE(label##_VSEL_table), \
495 .ops = &twl4030ldo_ops, \
496 .type = REGULATOR_VOLTAGE, \
497 .owner = THIS_MODULE, \
501 #define TWL6030_ADJUSTABLE_LDO(label, offset, min_mVolts, max_mVolts, num, \
505 .min_mV = min_mVolts, \
506 .max_mV = max_mVolts, \
507 .remap = remap_conf, \
510 .id = TWL6030_REG_##label, \
511 .n_voltages = (max_mVolts - min_mVolts)/100, \
512 .ops = &twl6030ldo_ops, \
513 .type = REGULATOR_VOLTAGE, \
514 .owner = THIS_MODULE, \
519 #define TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, remap_conf, \
524 .delay = turnon_delay, \
525 .remap = remap_conf, \
528 .id = family##_REG_##label, \
530 .ops = &twlfixed_ops, \
531 .type = REGULATOR_VOLTAGE, \
532 .owner = THIS_MODULE, \
537 * We list regulators here if systems need some level of
538 * software control over them after boot.
540 static struct twlreg_info twl_regs[] = {
541 TWL4030_ADJUSTABLE_LDO(VAUX1, 0x17, 1, 100, 0x08),
542 TWL4030_ADJUSTABLE_LDO(VAUX2_4030, 0x1b, 2, 100, 0x08),
543 TWL4030_ADJUSTABLE_LDO(VAUX2, 0x1b, 2, 100, 0x08),
544 TWL4030_ADJUSTABLE_LDO(VAUX3, 0x1f, 3, 100, 0x08),
545 TWL4030_ADJUSTABLE_LDO(VAUX4, 0x23, 4, 100, 0x08),
546 TWL4030_ADJUSTABLE_LDO(VMMC1, 0x27, 5, 100, 0x08),
547 TWL4030_ADJUSTABLE_LDO(VMMC2, 0x2b, 6, 100, 0x08),
548 TWL4030_ADJUSTABLE_LDO(VPLL1, 0x2f, 7, 100, 0x00),
549 TWL4030_ADJUSTABLE_LDO(VPLL2, 0x33, 8, 100, 0x08),
550 TWL4030_ADJUSTABLE_LDO(VSIM, 0x37, 9, 100, 0x00),
551 TWL4030_ADJUSTABLE_LDO(VDAC, 0x3b, 10, 100, 0x08),
552 TWL4030_FIXED_LDO(VINTANA1, 0x3f, 1500, 11, 100, 0x08),
553 TWL4030_ADJUSTABLE_LDO(VINTANA2, 0x43, 12, 100, 0x08),
554 TWL4030_FIXED_LDO(VINTDIG, 0x47, 1500, 13, 100, 0x08),
555 TWL4030_ADJUSTABLE_LDO(VIO, 0x4b, 14, 1000, 0x08),
556 TWL4030_ADJUSTABLE_LDO(VDD1, 0x55, 15, 1000, 0x08),
557 TWL4030_ADJUSTABLE_LDO(VDD2, 0x63, 16, 1000, 0x08),
558 TWL4030_FIXED_LDO(VUSB1V5, 0x71, 1500, 17, 100, 0x08),
559 TWL4030_FIXED_LDO(VUSB1V8, 0x74, 1800, 18, 100, 0x08),
560 TWL4030_FIXED_LDO(VUSB3V1, 0x77, 3100, 19, 150, 0x08),
561 /* VUSBCP is managed *only* by the USB subchip */
563 /* 6030 REG with base as PMC Slave Misc : 0x0030 */
564 /* Turnon-delay and remap configuration values for 6030 are not
565 verified since the specification is not public */
566 TWL6030_ADJUSTABLE_LDO(VAUX1_6030, 0x54, 1000, 3300, 1, 0x21),
567 TWL6030_ADJUSTABLE_LDO(VAUX2_6030, 0x58, 1000, 3300, 2, 0x21),
568 TWL6030_ADJUSTABLE_LDO(VAUX3_6030, 0x5c, 1000, 3300, 3, 0x21),
569 TWL6030_ADJUSTABLE_LDO(VMMC, 0x68, 1000, 3300, 4, 0x21),
570 TWL6030_ADJUSTABLE_LDO(VPP, 0x6c, 1000, 3300, 5, 0x21),
571 TWL6030_ADJUSTABLE_LDO(VUSIM, 0x74, 1000, 3300, 7, 0x21),
572 TWL6030_FIXED_LDO(VANA, 0x50, 2100, 15, 0, 0x21),
573 TWL6030_FIXED_LDO(VCXIO, 0x60, 1800, 16, 0, 0x21),
574 TWL6030_FIXED_LDO(VDAC, 0x64, 1800, 17, 0, 0x21),
575 TWL6030_FIXED_LDO(VUSB, 0x70, 3300, 18, 0, 0x21)
578 static int __devinit twlreg_probe(struct platform_device *pdev)
581 struct twlreg_info *info;
582 struct regulator_init_data *initdata;
583 struct regulation_constraints *c;
584 struct regulator_dev *rdev;
586 for (i = 0, info = NULL; i < ARRAY_SIZE(twl_regs); i++) {
587 if (twl_regs[i].desc.id != pdev->id)
595 initdata = pdev->dev.platform_data;
599 /* Constrain board-specific capabilities according to what
600 * this driver and the chip itself can actually do.
602 c = &initdata->constraints;
603 c->valid_modes_mask &= REGULATOR_MODE_NORMAL | REGULATOR_MODE_STANDBY;
604 c->valid_ops_mask &= REGULATOR_CHANGE_VOLTAGE
605 | REGULATOR_CHANGE_MODE
606 | REGULATOR_CHANGE_STATUS;
608 case TWL4030_REG_VIO:
609 case TWL4030_REG_VDD1:
610 case TWL4030_REG_VDD2:
611 case TWL4030_REG_VPLL1:
612 case TWL4030_REG_VINTANA1:
613 case TWL4030_REG_VINTANA2:
614 case TWL4030_REG_VINTDIG:
621 rdev = regulator_register(&info->desc, &pdev->dev, initdata, info);
623 dev_err(&pdev->dev, "can't register %s, %ld\n",
624 info->desc.name, PTR_ERR(rdev));
625 return PTR_ERR(rdev);
627 platform_set_drvdata(pdev, rdev);
629 twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_REMAP,
632 /* NOTE: many regulators support short-circuit IRQs (presentable
633 * as REGULATOR_OVER_CURRENT notifications?) configured via:
635 * - SC_DETECT1 (vintana2, vmmc1/2, vaux1/2/3/4)
636 * - SC_DETECT2 (vusb, vdac, vio, vdd1/2, vpll2)
643 static int __devexit twlreg_remove(struct platform_device *pdev)
645 regulator_unregister(platform_get_drvdata(pdev));
649 MODULE_ALIAS("platform:twl_reg");
651 static struct platform_driver twlreg_driver = {
652 .probe = twlreg_probe,
653 .remove = __devexit_p(twlreg_remove),
654 /* NOTE: short name, to work around driver model truncation of
655 * "twl_regulator.12" (and friends) to "twl_regulator.1".
657 .driver.name = "twl_reg",
658 .driver.owner = THIS_MODULE,
661 static int __init twlreg_init(void)
663 return platform_driver_register(&twlreg_driver);
665 subsys_initcall(twlreg_init);
667 static void __exit twlreg_exit(void)
669 platform_driver_unregister(&twlreg_driver);
671 module_exit(twlreg_exit)
673 MODULE_DESCRIPTION("TWL regulator driver");
674 MODULE_LICENSE("GPL");