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/platform_device.h>
16 #include <linux/regulator/driver.h>
17 #include <linux/regulator/machine.h>
18 #include <linux/i2c/twl.h>
22 * The TWL4030/TW5030/TPS659x0/TWL6030 family chips include power management, a
23 * USB OTG transceiver, an RTC, ADC, PWM, and lots more. Some versions
24 * include an audio codec, battery charger, and more voltage regulators.
25 * These chips are often used in OMAP-based systems.
27 * This driver implements software-based resource control for various
28 * voltage regulators. This is usually augmented with state machine
33 /* start of regulator's PM_RECEIVER control register bank */
36 /* twl resource ID, for resource control state machine */
39 /* voltage in mV = table[VSEL]; table_len must be a power-of-two */
43 /* regulator specific turn-on delay */
46 /* State REMAP default configuration */
49 /* chip constraints on regulator behavior */
52 /* used by regulator core */
53 struct regulator_desc desc;
57 /* LDO control registers ... offset is from the base of its register bank.
58 * The first three registers of all power resource banks help hardware to
59 * manage the various resource groups.
61 /* Common offset in TWL4030/6030 */
63 /* TWL4030 register offsets */
66 #define VREG_DEDICATED 3 /* LDO control */
67 /* TWL6030 register offsets */
70 #define VREG_VOLTAGE 3
71 /* TWL6030 Misc register offsets */
74 #define VREG_BC_PROC 3
75 #define VREG_BC_CLK_RST 4
78 twlreg_read(struct twlreg_info *info, unsigned slave_subgp, unsigned offset)
83 status = twl_i2c_read_u8(slave_subgp,
84 &value, info->base + offset);
85 return (status < 0) ? status : value;
89 twlreg_write(struct twlreg_info *info, unsigned slave_subgp, unsigned offset,
92 return twl_i2c_write_u8(slave_subgp,
93 value, info->base + offset);
96 /*----------------------------------------------------------------------*/
98 /* generic power resource operations, which work on all regulators */
100 static int twlreg_grp(struct regulator_dev *rdev)
102 return twlreg_read(rdev_get_drvdata(rdev), TWL_MODULE_PM_RECEIVER,
107 * Enable/disable regulators by joining/leaving the P1 (processor) group.
108 * We assume nobody else is updating the DEV_GRP registers.
110 /* definition for 4030 family */
111 #define P3_GRP_4030 BIT(7) /* "peripherals" */
112 #define P2_GRP_4030 BIT(6) /* secondary processor, modem, etc */
113 #define P1_GRP_4030 BIT(5) /* CPU/Linux */
114 /* definition for 6030 family */
115 #define P3_GRP_6030 BIT(2) /* secondary processor, modem, etc */
116 #define P2_GRP_6030 BIT(1) /* "peripherals" */
117 #define P1_GRP_6030 BIT(0) /* CPU/Linux */
119 static int twlreg_is_enabled(struct regulator_dev *rdev)
121 int state = twlreg_grp(rdev);
126 if (twl_class_is_4030())
127 state &= P1_GRP_4030;
129 state &= P1_GRP_6030;
133 static int twlreg_enable(struct regulator_dev *rdev)
135 struct twlreg_info *info = rdev_get_drvdata(rdev);
138 grp = twlreg_read(info, TWL_MODULE_PM_RECEIVER, VREG_GRP);
142 if (twl_class_is_4030())
147 return twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_GRP, grp);
150 static int twlreg_disable(struct regulator_dev *rdev)
152 struct twlreg_info *info = rdev_get_drvdata(rdev);
155 grp = twlreg_read(info, TWL_MODULE_PM_RECEIVER, VREG_GRP);
159 if (twl_class_is_4030())
164 return twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_GRP, grp);
167 static int twlreg_get_status(struct regulator_dev *rdev)
169 int state = twlreg_grp(rdev);
171 if (twl_class_is_6030())
172 return 0; /* FIXME return for 6030 regulator */
178 /* assume state != WARM_RESET; we'd not be running... */
180 return REGULATOR_STATUS_OFF;
181 return (state & BIT(3))
182 ? REGULATOR_STATUS_NORMAL
183 : REGULATOR_STATUS_STANDBY;
186 static int twlreg_set_mode(struct regulator_dev *rdev, unsigned mode)
188 struct twlreg_info *info = rdev_get_drvdata(rdev);
192 if (twl_class_is_6030())
193 return 0; /* FIXME return for 6030 regulator */
195 /* We can only set the mode through state machine commands... */
197 case REGULATOR_MODE_NORMAL:
198 message = MSG_SINGULAR(DEV_GRP_P1, info->id, RES_STATE_ACTIVE);
200 case REGULATOR_MODE_STANDBY:
201 message = MSG_SINGULAR(DEV_GRP_P1, info->id, RES_STATE_SLEEP);
207 /* Ensure the resource is associated with some group */
208 status = twlreg_grp(rdev);
211 if (!(status & (P3_GRP_4030 | P2_GRP_4030 | P1_GRP_4030)))
214 status = twl_i2c_write_u8(TWL_MODULE_PM_MASTER,
215 message >> 8, 0x15 /* PB_WORD_MSB */ );
219 return twl_i2c_write_u8(TWL_MODULE_PM_MASTER,
220 message, 0x16 /* PB_WORD_LSB */ );
223 /*----------------------------------------------------------------------*/
226 * Support for adjustable-voltage LDOs uses a four bit (or less) voltage
227 * select field in its control register. We use tables indexed by VSEL
228 * to record voltages in milliVolts. (Accuracy is about three percent.)
230 * Note that VSEL values for VAUX2 changed in twl5030 and newer silicon;
231 * currently handled by listing two slightly different VAUX2 regulators,
232 * only one of which will be configured.
234 * VSEL values documented as "TI cannot support these values" are flagged
235 * in these tables as UNSUP() values; we normally won't assign them.
237 * VAUX3 at 3V is incorrectly listed in some TI manuals as unsupported.
238 * TI are revising the twl5030/tps659x0 specs to support that 3.0V setting.
240 #ifdef CONFIG_TWL4030_ALLOW_UNSUPPORTED
241 #define UNSUP_MASK 0x0000
243 #define UNSUP_MASK 0x8000
246 #define UNSUP(x) (UNSUP_MASK | (x))
247 #define IS_UNSUP(x) (UNSUP_MASK & (x))
248 #define LDO_MV(x) (~UNSUP_MASK & (x))
251 static const u16 VAUX1_VSEL_table[] = {
252 UNSUP(1500), UNSUP(1800), 2500, 2800,
253 3000, 3000, 3000, 3000,
255 static const u16 VAUX2_4030_VSEL_table[] = {
256 UNSUP(1000), UNSUP(1000), UNSUP(1200), 1300,
257 1500, 1800, UNSUP(1850), 2500,
258 UNSUP(2600), 2800, UNSUP(2850), UNSUP(3000),
259 UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
261 static const u16 VAUX2_VSEL_table[] = {
262 1700, 1700, 1900, 1300,
263 1500, 1800, 2000, 2500,
264 2100, 2800, 2200, 2300,
265 2400, 2400, 2400, 2400,
267 static const u16 VAUX3_VSEL_table[] = {
268 1500, 1800, 2500, 2800,
269 3000, 3000, 3000, 3000,
271 static const u16 VAUX4_VSEL_table[] = {
272 700, 1000, 1200, UNSUP(1300),
273 1500, 1800, UNSUP(1850), 2500,
274 UNSUP(2600), 2800, UNSUP(2850), UNSUP(3000),
275 UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
277 static const u16 VMMC1_VSEL_table[] = {
278 1850, 2850, 3000, 3150,
280 static const u16 VMMC2_VSEL_table[] = {
281 UNSUP(1000), UNSUP(1000), UNSUP(1200), UNSUP(1300),
282 UNSUP(1500), UNSUP(1800), 1850, UNSUP(2500),
283 2600, 2800, 2850, 3000,
284 3150, 3150, 3150, 3150,
286 static const u16 VPLL1_VSEL_table[] = {
287 1000, 1200, 1300, 1800,
288 UNSUP(2800), UNSUP(3000), UNSUP(3000), UNSUP(3000),
290 static const u16 VPLL2_VSEL_table[] = {
291 700, 1000, 1200, 1300,
292 UNSUP(1500), 1800, UNSUP(1850), UNSUP(2500),
293 UNSUP(2600), UNSUP(2800), UNSUP(2850), UNSUP(3000),
294 UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
296 static const u16 VSIM_VSEL_table[] = {
297 UNSUP(1000), UNSUP(1200), UNSUP(1300), 1800,
298 2800, 3000, 3000, 3000,
300 static const u16 VDAC_VSEL_table[] = {
301 1200, 1300, 1800, 1800,
303 static const u16 VDD1_VSEL_table[] = {
306 static const u16 VDD2_VSEL_table[] = {
309 static const u16 VIO_VSEL_table[] = {
312 static const u16 VINTANA2_VSEL_table[] = {
315 static const u16 VAUX1_6030_VSEL_table[] = {
316 1000, 1300, 1800, 2500,
317 2800, 2900, 3000, 3000,
319 static const u16 VAUX2_6030_VSEL_table[] = {
320 1200, 1800, 2500, 2750,
321 2800, 2800, 2800, 2800,
323 static const u16 VAUX3_6030_VSEL_table[] = {
324 1000, 1200, 1300, 1800,
325 2500, 2800, 3000, 3000,
327 static const u16 VMMC_VSEL_table[] = {
328 1200, 1800, 2800, 2900,
329 3000, 3000, 3000, 3000,
331 static const u16 VPP_VSEL_table[] = {
332 1800, 1900, 2000, 2100,
333 2200, 2300, 2400, 2500,
335 static const u16 VUSIM_VSEL_table[] = {
336 1200, 1800, 2500, 2900,
339 static int twlldo_list_voltage(struct regulator_dev *rdev, unsigned index)
341 struct twlreg_info *info = rdev_get_drvdata(rdev);
342 int mV = info->table[index];
344 return IS_UNSUP(mV) ? 0 : (LDO_MV(mV) * 1000);
348 twlldo_set_voltage(struct regulator_dev *rdev, int min_uV, int max_uV)
350 struct twlreg_info *info = rdev_get_drvdata(rdev);
353 for (vsel = 0; vsel < info->table_len; vsel++) {
354 int mV = info->table[vsel];
359 uV = LDO_MV(mV) * 1000;
361 /* REVISIT for VAUX2, first match may not be best/lowest */
363 /* use the first in-range value */
364 if (min_uV <= uV && uV <= max_uV)
365 return twlreg_write(info, TWL_MODULE_PM_RECEIVER,
372 static int twlldo_get_voltage(struct regulator_dev *rdev)
374 struct twlreg_info *info = rdev_get_drvdata(rdev);
375 int vsel = twlreg_read(info, TWL_MODULE_PM_RECEIVER,
381 vsel &= info->table_len - 1;
382 return LDO_MV(info->table[vsel]) * 1000;
385 static struct regulator_ops twlldo_ops = {
386 .list_voltage = twlldo_list_voltage,
388 .set_voltage = twlldo_set_voltage,
389 .get_voltage = twlldo_get_voltage,
391 .enable = twlreg_enable,
392 .disable = twlreg_disable,
393 .is_enabled = twlreg_is_enabled,
395 .set_mode = twlreg_set_mode,
397 .get_status = twlreg_get_status,
400 /*----------------------------------------------------------------------*/
403 * Fixed voltage LDOs don't have a VSEL field to update.
405 static int twlfixed_list_voltage(struct regulator_dev *rdev, unsigned index)
407 struct twlreg_info *info = rdev_get_drvdata(rdev);
409 return info->min_mV * 1000;
412 static int twlfixed_get_voltage(struct regulator_dev *rdev)
414 struct twlreg_info *info = rdev_get_drvdata(rdev);
416 return info->min_mV * 1000;
419 static struct regulator_ops twlfixed_ops = {
420 .list_voltage = twlfixed_list_voltage,
422 .get_voltage = twlfixed_get_voltage,
424 .enable = twlreg_enable,
425 .disable = twlreg_disable,
426 .is_enabled = twlreg_is_enabled,
428 .set_mode = twlreg_set_mode,
430 .get_status = twlreg_get_status,
433 /*----------------------------------------------------------------------*/
435 #define TWL4030_ADJUSTABLE_LDO(label, offset, num, turnon_delay, remap_conf) \
436 TWL_ADJUSTABLE_LDO(label, offset, num, turnon_delay, \
438 #define TWL4030_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
440 TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
442 #define TWL6030_ADJUSTABLE_LDO(label, offset, num, turnon_delay, \
444 TWL_ADJUSTABLE_LDO(label, offset, num, turnon_delay, \
446 #define TWL6030_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
448 TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, \
451 #define TWL_ADJUSTABLE_LDO(label, offset, num, turnon_delay, remap_conf, \
455 .table_len = ARRAY_SIZE(label##_VSEL_table), \
456 .table = label##_VSEL_table, \
457 .delay = turnon_delay, \
458 .remap = remap_conf, \
461 .id = family##_REG_##label, \
462 .n_voltages = ARRAY_SIZE(label##_VSEL_table), \
463 .ops = &twlldo_ops, \
464 .type = REGULATOR_VOLTAGE, \
465 .owner = THIS_MODULE, \
469 #define TWL_FIXED_LDO(label, offset, mVolts, num, turnon_delay, remap_conf, \
474 .delay = turnon_delay, \
475 .remap = remap_conf, \
478 .id = family##_REG_##label, \
480 .ops = &twlfixed_ops, \
481 .type = REGULATOR_VOLTAGE, \
482 .owner = THIS_MODULE, \
487 * We list regulators here if systems need some level of
488 * software control over them after boot.
490 static struct twlreg_info twl_regs[] = {
491 TWL4030_ADJUSTABLE_LDO(VAUX1, 0x17, 1, 100, 0x08),
492 TWL4030_ADJUSTABLE_LDO(VAUX2_4030, 0x1b, 2, 100, 0x08),
493 TWL4030_ADJUSTABLE_LDO(VAUX2, 0x1b, 2, 100, 0x08),
494 TWL4030_ADJUSTABLE_LDO(VAUX3, 0x1f, 3, 100, 0x08),
495 TWL4030_ADJUSTABLE_LDO(VAUX4, 0x23, 4, 100, 0x08),
496 TWL4030_ADJUSTABLE_LDO(VMMC1, 0x27, 5, 100, 0x08),
497 TWL4030_ADJUSTABLE_LDO(VMMC2, 0x2b, 6, 100, 0x08),
498 TWL4030_ADJUSTABLE_LDO(VPLL1, 0x2f, 7, 100, 0x00),
499 TWL4030_ADJUSTABLE_LDO(VPLL2, 0x33, 8, 100, 0x08),
500 TWL4030_ADJUSTABLE_LDO(VSIM, 0x37, 9, 100, 0x00),
501 TWL4030_ADJUSTABLE_LDO(VDAC, 0x3b, 10, 100, 0x08),
502 TWL4030_FIXED_LDO(VINTANA1, 0x3f, 1500, 11, 100, 0x08),
503 TWL4030_ADJUSTABLE_LDO(VINTANA2, 0x43, 12, 100, 0x08),
504 TWL4030_FIXED_LDO(VINTDIG, 0x47, 1500, 13, 100, 0x08),
505 TWL4030_ADJUSTABLE_LDO(VIO, 0x4b, 14, 1000, 0x08),
506 TWL4030_ADJUSTABLE_LDO(VDD1, 0x55, 15, 1000, 0x08),
507 TWL4030_ADJUSTABLE_LDO(VDD2, 0x63, 16, 1000, 0x08),
508 TWL4030_FIXED_LDO(VUSB1V5, 0x71, 1500, 17, 100, 0x08),
509 TWL4030_FIXED_LDO(VUSB1V8, 0x74, 1800, 18, 100, 0x08),
510 TWL4030_FIXED_LDO(VUSB3V1, 0x77, 3100, 19, 150, 0x08),
511 /* VUSBCP is managed *only* by the USB subchip */
513 /* 6030 REG with base as PMC Slave Misc : 0x0030 */
514 /* Turnon-delay and remap configuration values for 6030 are not
515 verified since the specification is not public */
516 TWL6030_ADJUSTABLE_LDO(VAUX1_6030, 0x54, 1, 0, 0x08),
517 TWL6030_ADJUSTABLE_LDO(VAUX2_6030, 0x58, 2, 0, 0x08),
518 TWL6030_ADJUSTABLE_LDO(VAUX3_6030, 0x5c, 3, 0, 0x08),
519 TWL6030_ADJUSTABLE_LDO(VMMC, 0x68, 4, 0, 0x08),
520 TWL6030_ADJUSTABLE_LDO(VPP, 0x6c, 5, 0, 0x08),
521 TWL6030_ADJUSTABLE_LDO(VUSIM, 0x74, 7, 0, 0x08),
522 TWL6030_FIXED_LDO(VANA, 0x50, 2100, 15, 0, 0x08),
523 TWL6030_FIXED_LDO(VCXIO, 0x60, 1800, 16, 0, 0x08),
524 TWL6030_FIXED_LDO(VDAC, 0x64, 1800, 17, 0, 0x08),
525 TWL6030_FIXED_LDO(VUSB, 0x70, 3300, 18, 0, 0x08)
528 static int twlreg_probe(struct platform_device *pdev)
531 struct twlreg_info *info;
532 struct regulator_init_data *initdata;
533 struct regulation_constraints *c;
534 struct regulator_dev *rdev;
536 for (i = 0, info = NULL; i < ARRAY_SIZE(twl_regs); i++) {
537 if (twl_regs[i].desc.id != pdev->id)
545 initdata = pdev->dev.platform_data;
549 /* Constrain board-specific capabilities according to what
550 * this driver and the chip itself can actually do.
552 c = &initdata->constraints;
553 c->valid_modes_mask &= REGULATOR_MODE_NORMAL | REGULATOR_MODE_STANDBY;
554 c->valid_ops_mask &= REGULATOR_CHANGE_VOLTAGE
555 | REGULATOR_CHANGE_MODE
556 | REGULATOR_CHANGE_STATUS;
558 case TWL4030_REG_VIO:
559 case TWL4030_REG_VDD1:
560 case TWL4030_REG_VDD2:
561 case TWL4030_REG_VPLL1:
562 case TWL4030_REG_VINTANA1:
563 case TWL4030_REG_VINTANA2:
564 case TWL4030_REG_VINTDIG:
571 rdev = regulator_register(&info->desc, &pdev->dev, initdata, info);
573 dev_err(&pdev->dev, "can't register %s, %ld\n",
574 info->desc.name, PTR_ERR(rdev));
575 return PTR_ERR(rdev);
577 platform_set_drvdata(pdev, rdev);
579 twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_REMAP,
582 /* NOTE: many regulators support short-circuit IRQs (presentable
583 * as REGULATOR_OVER_CURRENT notifications?) configured via:
585 * - SC_DETECT1 (vintana2, vmmc1/2, vaux1/2/3/4)
586 * - SC_DETECT2 (vusb, vdac, vio, vdd1/2, vpll2)
593 static int __devexit twlreg_remove(struct platform_device *pdev)
595 regulator_unregister(platform_get_drvdata(pdev));
599 MODULE_ALIAS("platform:twl_reg");
601 static struct platform_driver twlreg_driver = {
602 .probe = twlreg_probe,
603 .remove = __devexit_p(twlreg_remove),
604 /* NOTE: short name, to work around driver model truncation of
605 * "twl_regulator.12" (and friends) to "twl_regulator.1".
607 .driver.name = "twl_reg",
608 .driver.owner = THIS_MODULE,
611 static int __init twlreg_init(void)
613 return platform_driver_register(&twlreg_driver);
615 subsys_initcall(twlreg_init);
617 static void __exit twlreg_exit(void)
619 platform_driver_unregister(&twlreg_driver);
621 module_exit(twlreg_exit)
623 MODULE_DESCRIPTION("TWL regulator driver");
624 MODULE_LICENSE("GPL");