drivers/regulator/twl-regulator.c

   1 /*
   2  * twl-regulator.c -- support regulators in twl4030/twl6030 family chips
   3  *
   4  * Copyright (C) 2008 David Brownell
   5  *
   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.
  10  */
  11
  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>
  19
  20
  21 /*
  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.
  26  *
  27  * This driver implements software-based resource control for various
  28  * voltage regulators.  This is usually augmented with state machine
  29  * based control.
  30  */
  31
  32 struct twlreg_info {
  33         /* start of regulator's PM_RECEIVER control register bank */
  34         u8                      base;
  35
  36         /* twl resource ID, for resource control state machine */
  37         u8                      id;
  38
  39         /* voltage in mV = table[VSEL]; table_len must be a power-of-two */
  40         u8                      table_len;
  41         const u16               *table;
  42
  43         /* chip constraints on regulator behavior */
  44         u16                     min_mV;
  45
  46         /* used by regulator core */
  47         struct regulator_desc   desc;
  48 };
  49
  50
  51 /* LDO control registers ... offset is from the base of its register bank.
  52  * The first three registers of all power resource banks help hardware to
  53  * manage the various resource groups.
  54  */
  55 /* Common offset in TWL4030/6030 */
  56 #define VREG_GRP                0
  57 /* TWL4030 register offsets */
  58 #define VREG_TYPE               1
  59 #define VREG_REMAP              2
  60 #define VREG_DEDICATED          3       /* LDO control */
  61 /* TWL6030 register offsets */
  62 #define VREG_TRANS              1
  63 #define VREG_STATE              2
  64 #define VREG_VOLTAGE            3
  65 /* TWL6030 Misc register offsets */
  66 #define VREG_BC_ALL             1
  67 #define VREG_BC_REF             2
  68 #define VREG_BC_PROC            3
  69 #define VREG_BC_CLK_RST         4
  70
  71 static inline int
  72 twlreg_read(struct twlreg_info *info, unsigned slave_subgp, unsigned offset)
  73 {
  74         u8 value;
  75         int status;
  76
  77         status = twl_i2c_read_u8(slave_subgp,
  78                         &value, info->base + offset);
  79         return (status < 0) ? status : value;
  80 }
  81
  82 static inline int
  83 twlreg_write(struct twlreg_info *info, unsigned slave_subgp, unsigned offset,
  84                                                  u8 value)
  85 {
  86         return twl_i2c_write_u8(slave_subgp,
  87                         value, info->base + offset);
  88 }
  89
  90 /*----------------------------------------------------------------------*/
  91
  92 /* generic power resource operations, which work on all regulators */
  93
  94 static int twlreg_grp(struct regulator_dev *rdev)
  95 {
  96         return twlreg_read(rdev_get_drvdata(rdev), TWL_MODULE_PM_RECEIVER,
  97                                                                  VREG_GRP);
  98 }
  99
 100 /*
 101  * Enable/disable regulators by joining/leaving the P1 (processor) group.
 102  * We assume nobody else is updating the DEV_GRP registers.
 103  */
 104 /* definition for 4030 family */
 105 #define P3_GRP_4030     BIT(7)          /* "peripherals" */
 106 #define P2_GRP_4030     BIT(6)          /* secondary processor, modem, etc */
 107 #define P1_GRP_4030     BIT(5)          /* CPU/Linux */
 108 /* definition for 6030 family */
 109 #define P3_GRP_6030     BIT(2)          /* secondary processor, modem, etc */
 110 #define P2_GRP_6030     BIT(1)          /* "peripherals" */
 111 #define P1_GRP_6030     BIT(0)          /* CPU/Linux */
 112
 113 static int twlreg_is_enabled(struct regulator_dev *rdev)
 114 {
 115         int     state = twlreg_grp(rdev);
 116
 117         if (state < 0)
 118                 return state;
 119
 120         if (twl_class_is_4030())
 121                 state &= P1_GRP_4030;
 122         else
 123                 state &= P1_GRP_6030;
 124         return state;
 125 }
 126
 127 static int twlreg_enable(struct regulator_dev *rdev)
 128 {
 129         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 130         int                     grp;
 131
 132         grp = twlreg_read(info, TWL_MODULE_PM_RECEIVER, VREG_GRP);
 133         if (grp < 0)
 134                 return grp;
 135
 136         if (twl_class_is_4030())
 137                 grp |= P1_GRP_4030;
 138         else
 139                 grp |= P1_GRP_6030;
 140
 141         return twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_GRP, grp);
 142 }
 143
 144 static int twlreg_disable(struct regulator_dev *rdev)
 145 {
 146         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 147         int                     grp;
 148
 149         grp = twlreg_read(info, TWL_MODULE_PM_RECEIVER, VREG_GRP);
 150         if (grp < 0)
 151                 return grp;
 152
 153         if (twl_class_is_4030())
 154                 grp &= ~P1_GRP_4030;
 155         else
 156                 grp &= ~P1_GRP_6030;
 157
 158         return twlreg_write(info, TWL_MODULE_PM_RECEIVER, VREG_GRP, grp);
 159 }
 160
 161 static int twlreg_get_status(struct regulator_dev *rdev)
 162 {
 163         int     state = twlreg_grp(rdev);
 164
 165         if (twl_class_is_6030())
 166                 return 0; /* FIXME return for 6030 regulator */
 167
 168         if (state < 0)
 169                 return state;
 170         state &= 0x0f;
 171
 172         /* assume state != WARM_RESET; we'd not be running...  */
 173         if (!state)
 174                 return REGULATOR_STATUS_OFF;
 175         return (state & BIT(3))
 176                 ? REGULATOR_STATUS_NORMAL
 177                 : REGULATOR_STATUS_STANDBY;
 178 }
 179
 180 static int twlreg_set_mode(struct regulator_dev *rdev, unsigned mode)
 181 {
 182         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 183         unsigned                message;
 184         int                     status;
 185
 186         if (twl_class_is_6030())
 187                 return 0; /* FIXME return for 6030 regulator */
 188
 189         /* We can only set the mode through state machine commands... */
 190         switch (mode) {
 191         case REGULATOR_MODE_NORMAL:
 192                 message = MSG_SINGULAR(DEV_GRP_P1, info->id, RES_STATE_ACTIVE);
 193                 break;
 194         case REGULATOR_MODE_STANDBY:
 195                 message = MSG_SINGULAR(DEV_GRP_P1, info->id, RES_STATE_SLEEP);
 196                 break;
 197         default:
 198                 return -EINVAL;
 199         }
 200
 201         /* Ensure the resource is associated with some group */
 202         status = twlreg_grp(rdev);
 203         if (status < 0)
 204                 return status;
 205         if (!(status & (P3_GRP_4030 | P2_GRP_4030 | P1_GRP_4030)))
 206                 return -EACCES;
 207
 208         status = twl_i2c_write_u8(TWL_MODULE_PM_MASTER,
 209                         message >> 8, 0x15 /* PB_WORD_MSB */ );
 210         if (status >= 0)
 211                 return status;
 212
 213         return twl_i2c_write_u8(TWL_MODULE_PM_MASTER,
 214                         message, 0x16 /* PB_WORD_LSB */ );
 215 }
 216
 217 /*----------------------------------------------------------------------*/
 218
 219 /*
 220  * Support for adjustable-voltage LDOs uses a four bit (or less) voltage
 221  * select field in its control register.   We use tables indexed by VSEL
 222  * to record voltages in milliVolts.  (Accuracy is about three percent.)
 223  *
 224  * Note that VSEL values for VAUX2 changed in twl5030 and newer silicon;
 225  * currently handled by listing two slightly different VAUX2 regulators,
 226  * only one of which will be configured.
 227  *
 228  * VSEL values documented as "TI cannot support these values" are flagged
 229  * in these tables as UNSUP() values; we normally won't assign them.
 230  *
 231  * VAUX3 at 3V is incorrectly listed in some TI manuals as unsupported.
 232  * TI are revising the twl5030/tps659x0 specs to support that 3.0V setting.
 233  */
 234 #ifdef CONFIG_TWL4030_ALLOW_UNSUPPORTED
 235 #define UNSUP_MASK      0x0000
 236 #else
 237 #define UNSUP_MASK      0x8000
 238 #endif
 239
 240 #define UNSUP(x)        (UNSUP_MASK | (x))
 241 #define IS_UNSUP(x)     (UNSUP_MASK & (x))
 242 #define LDO_MV(x)       (~UNSUP_MASK & (x))
 243
 244
 245 static const u16 VAUX1_VSEL_table[] = {
 246         UNSUP(1500), UNSUP(1800), 2500, 2800,
 247         3000, 3000, 3000, 3000,
 248 };
 249 static const u16 VAUX2_4030_VSEL_table[] = {
 250         UNSUP(1000), UNSUP(1000), UNSUP(1200), 1300,
 251         1500, 1800, UNSUP(1850), 2500,
 252         UNSUP(2600), 2800, UNSUP(2850), UNSUP(3000),
 253         UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
 254 };
 255 static const u16 VAUX2_VSEL_table[] = {
 256         1700, 1700, 1900, 1300,
 257         1500, 1800, 2000, 2500,
 258         2100, 2800, 2200, 2300,
 259         2400, 2400, 2400, 2400,
 260 };
 261 static const u16 VAUX3_VSEL_table[] = {
 262         1500, 1800, 2500, 2800,
 263         3000, 3000, 3000, 3000,
 264 };
 265 static const u16 VAUX4_VSEL_table[] = {
 266         700, 1000, 1200, UNSUP(1300),
 267         1500, 1800, UNSUP(1850), 2500,
 268         UNSUP(2600), 2800, UNSUP(2850), UNSUP(3000),
 269         UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
 270 };
 271 static const u16 VMMC1_VSEL_table[] = {
 272         1850, 2850, 3000, 3150,
 273 };
 274 static const u16 VMMC2_VSEL_table[] = {
 275         UNSUP(1000), UNSUP(1000), UNSUP(1200), UNSUP(1300),
 276         UNSUP(1500), UNSUP(1800), 1850, UNSUP(2500),
 277         2600, 2800, 2850, 3000,
 278         3150, 3150, 3150, 3150,
 279 };
 280 static const u16 VPLL1_VSEL_table[] = {
 281         1000, 1200, 1300, 1800,
 282         UNSUP(2800), UNSUP(3000), UNSUP(3000), UNSUP(3000),
 283 };
 284 static const u16 VPLL2_VSEL_table[] = {
 285         700, 1000, 1200, 1300,
 286         UNSUP(1500), 1800, UNSUP(1850), UNSUP(2500),
 287         UNSUP(2600), UNSUP(2800), UNSUP(2850), UNSUP(3000),
 288         UNSUP(3150), UNSUP(3150), UNSUP(3150), UNSUP(3150),
 289 };
 290 static const u16 VSIM_VSEL_table[] = {
 291         UNSUP(1000), UNSUP(1200), UNSUP(1300), 1800,
 292         2800, 3000, 3000, 3000,
 293 };
 294 static const u16 VDAC_VSEL_table[] = {
 295         1200, 1300, 1800, 1800,
 296 };
 297 static const u16 VAUX1_6030_VSEL_table[] = {
 298         1000, 1300, 1800, 2500,
 299         2800, 2900, 3000, 3000,
 300 };
 301 static const u16 VAUX2_6030_VSEL_table[] = {
 302         1200, 1800, 2500, 2750,
 303         2800, 2800, 2800, 2800,
 304 };
 305 static const u16 VAUX3_6030_VSEL_table[] = {
 306         1000, 1200, 1300, 1800,
 307         2500, 2800, 3000, 3000,
 308 };
 309 static const u16 VMMC_VSEL_table[] = {
 310         1200, 1800, 2800, 2900,
 311         3000, 3000, 3000, 3000,
 312 };
 313 static const u16 VPP_VSEL_table[] = {
 314         1800, 1900, 2000, 2100,
 315         2200, 2300, 2400, 2500,
 316 };
 317 static const u16 VUSIM_VSEL_table[] = {
 318         1200, 1800, 2500, 2900,
 319 };
 320
 321 static int twlldo_list_voltage(struct regulator_dev *rdev, unsigned index)
 322 {
 323         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 324         int                     mV = info->table[index];
 325
 326         return IS_UNSUP(mV) ? 0 : (LDO_MV(mV) * 1000);
 327 }
 328
 329 static int
 330 twlldo_set_voltage(struct regulator_dev *rdev, int min_uV, int max_uV)
 331 {
 332         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 333         int                     vsel;
 334
 335         for (vsel = 0; vsel < info->table_len; vsel++) {
 336                 int mV = info->table[vsel];
 337                 int uV;
 338
 339                 if (IS_UNSUP(mV))
 340                         continue;
 341                 uV = LDO_MV(mV) * 1000;
 342
 343                 /* REVISIT for VAUX2, first match may not be best/lowest */
 344
 345                 /* use the first in-range value */
 346                 if (min_uV <= uV && uV <= max_uV)
 347                         return twlreg_write(info, TWL_MODULE_PM_RECEIVER,
 348                                                         VREG_VOLTAGE, vsel);
 349         }
 350
 351         return -EDOM;
 352 }
 353
 354 static int twlldo_get_voltage(struct regulator_dev *rdev)
 355 {
 356         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 357         int             vsel = twlreg_read(info, TWL_MODULE_PM_RECEIVER,
 358                                                                 VREG_VOLTAGE);
 359
 360         if (vsel < 0)
 361                 return vsel;
 362
 363         vsel &= info->table_len - 1;
 364         return LDO_MV(info->table[vsel]) * 1000;
 365 }
 366
 367 static struct regulator_ops twlldo_ops = {
 368         .list_voltage   = twlldo_list_voltage,
 369
 370         .set_voltage    = twlldo_set_voltage,
 371         .get_voltage    = twlldo_get_voltage,
 372
 373         .enable         = twlreg_enable,
 374         .disable        = twlreg_disable,
 375         .is_enabled     = twlreg_is_enabled,
 376
 377         .set_mode       = twlreg_set_mode,
 378
 379         .get_status     = twlreg_get_status,
 380 };
 381
 382 /*----------------------------------------------------------------------*/
 383
 384 /*
 385  * Fixed voltage LDOs don't have a VSEL field to update.
 386  */
 387 static int twlfixed_list_voltage(struct regulator_dev *rdev, unsigned index)
 388 {
 389         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 390
 391         return info->min_mV * 1000;
 392 }
 393
 394 static int twlfixed_get_voltage(struct regulator_dev *rdev)
 395 {
 396         struct twlreg_info      *info = rdev_get_drvdata(rdev);
 397
 398         return info->min_mV * 1000;
 399 }
 400
 401 static struct regulator_ops twlfixed_ops = {
 402         .list_voltage   = twlfixed_list_voltage,
 403
 404         .get_voltage    = twlfixed_get_voltage,
 405
 406         .enable         = twlreg_enable,
 407         .disable        = twlreg_disable,
 408         .is_enabled     = twlreg_is_enabled,
 409
 410         .set_mode       = twlreg_set_mode,
 411
 412         .get_status     = twlreg_get_status,
 413 };
 414
 415 /*----------------------------------------------------------------------*/
 416
 417 #define TWL4030_ADJUSTABLE_LDO(label, offset, num) \
 418                 TWL_ADJUSTABLE_LDO(label, offset, num, TWL4030)
 419 #define TWL4030_FIXED_LDO(label, offset, mVolts, num) \
 420                 TWL_FIXED_LDO(label, offset, mVolts, num, TWL4030)
 421 #define TWL6030_ADJUSTABLE_LDO(label, offset, num) \
 422                 TWL_ADJUSTABLE_LDO(label, offset, num, TWL6030)
 423 #define TWL6030_FIXED_LDO(label, offset, mVolts, num) \
 424                 TWL_FIXED_LDO(label, offset, mVolts, num, TWL6030)
 425
 426 #define TWL_ADJUSTABLE_LDO(label, offset, num, family) { \
 427         .base = offset, \
 428         .id = num, \
 429         .table_len = ARRAY_SIZE(label##_VSEL_table), \
 430         .table = label##_VSEL_table, \
 431         .desc = { \
 432                 .name = #label, \
 433                 .id = family##_REG_##label, \
 434                 .n_voltages = ARRAY_SIZE(label##_VSEL_table), \
 435                 .ops = &twlldo_ops, \
 436                 .type = REGULATOR_VOLTAGE, \
 437                 .owner = THIS_MODULE, \
 438                 }, \
 439         }
 440
 441 #define TWL_FIXED_LDO(label, offset, mVolts, num, family) { \
 442         .base = offset, \
 443         .id = num, \
 444         .min_mV = mVolts, \
 445         .desc = { \
 446                 .name = #label, \
 447                 .id = family##_REG_##label, \
 448                 .n_voltages = 1, \
 449                 .ops = &twlfixed_ops, \
 450                 .type = REGULATOR_VOLTAGE, \
 451                 .owner = THIS_MODULE, \
 452                 }, \
 453         }
 454
 455 /*
 456  * We list regulators here if systems need some level of
 457  * software control over them after boot.
 458  */
 459 static struct twlreg_info twl_regs[] = {
 460         TWL4030_ADJUSTABLE_LDO(VAUX1, 0x17, 1),
 461         TWL4030_ADJUSTABLE_LDO(VAUX2_4030, 0x1b, 2),
 462         TWL4030_ADJUSTABLE_LDO(VAUX2, 0x1b, 2),
 463         TWL4030_ADJUSTABLE_LDO(VAUX3, 0x1f, 3),
 464         TWL4030_ADJUSTABLE_LDO(VAUX4, 0x23, 4),
 465         TWL4030_ADJUSTABLE_LDO(VMMC1, 0x27, 5),
 466         TWL4030_ADJUSTABLE_LDO(VMMC2, 0x2b, 6),
 467         /*
 468         TWL4030_ADJUSTABLE_LDO(VPLL1, 0x2f, 7),
 469         */
 470         TWL4030_ADJUSTABLE_LDO(VPLL2, 0x33, 8),
 471         TWL4030_ADJUSTABLE_LDO(VSIM, 0x37, 9),
 472         TWL4030_ADJUSTABLE_LDO(VDAC, 0x3b, 10),
 473         /*
 474         TWL4030_ADJUSTABLE_LDO(VINTANA1, 0x3f, 11),
 475         TWL4030_ADJUSTABLE_LDO(VINTANA2, 0x43, 12),
 476         TWL4030_ADJUSTABLE_LDO(VINTDIG, 0x47, 13),
 477         TWL4030_SMPS(VIO, 0x4b, 14),
 478         TWL4030_SMPS(VDD1, 0x55, 15),
 479         TWL4030_SMPS(VDD2, 0x63, 16),
 480          */
 481         TWL4030_FIXED_LDO(VUSB1V5, 0x71, 1500, 17),
 482         TWL4030_FIXED_LDO(VUSB1V8, 0x74, 1800, 18),
 483         TWL4030_FIXED_LDO(VUSB3V1, 0x77, 3100, 19),
 484         /* VUSBCP is managed *only* by the USB subchip */
 485
 486         /* 6030 REG with base as PMC Slave Misc : 0x0030 */
 487         TWL6030_ADJUSTABLE_LDO(VAUX1_6030, 0x54, 1),
 488         TWL6030_ADJUSTABLE_LDO(VAUX2_6030, 0x58, 2),
 489         TWL6030_ADJUSTABLE_LDO(VAUX3_6030, 0x5c, 3),
 490         TWL6030_ADJUSTABLE_LDO(VMMC, 0x68, 4),
 491         TWL6030_ADJUSTABLE_LDO(VPP, 0x6c, 5),
 492         TWL6030_ADJUSTABLE_LDO(VUSIM, 0x74, 7),
 493         TWL6030_FIXED_LDO(VANA, 0x50, 2100, 15),
 494         TWL6030_FIXED_LDO(VCXIO, 0x60, 1800, 16),
 495         TWL6030_FIXED_LDO(VDAC, 0x64, 1800, 17),
 496         TWL6030_FIXED_LDO(VUSB, 0x70, 3300, 18)
 497 };
 498
 499 static int twlreg_probe(struct platform_device *pdev)
 500 {
 501         int                             i;
 502         struct twlreg_info              *info;
 503         struct regulator_init_data      *initdata;
 504         struct regulation_constraints   *c;
 505         struct regulator_dev            *rdev;
 506
 507         for (i = 0, info = NULL; i < ARRAY_SIZE(twl_regs); i++) {
 508                 if (twl_regs[i].desc.id != pdev->id)
 509                         continue;
 510                 info = twl_regs + i;
 511                 break;
 512         }
 513         if (!info)
 514                 return -ENODEV;
 515
 516         initdata = pdev->dev.platform_data;
 517         if (!initdata)
 518                 return -EINVAL;
 519
 520         /* Constrain board-specific capabilities according to what
 521          * this driver and the chip itself can actually do.
 522          */
 523         c = &initdata->constraints;
 524         c->valid_modes_mask &= REGULATOR_MODE_NORMAL | REGULATOR_MODE_STANDBY;
 525         c->valid_ops_mask &= REGULATOR_CHANGE_VOLTAGE
 526                                 | REGULATOR_CHANGE_MODE
 527                                 | REGULATOR_CHANGE_STATUS;
 528
 529         rdev = regulator_register(&info->desc, &pdev->dev, initdata, info);
 530         if (IS_ERR(rdev)) {
 531                 dev_err(&pdev->dev, "can't register %s, %ld\n",
 532                                 info->desc.name, PTR_ERR(rdev));
 533                 return PTR_ERR(rdev);
 534         }
 535         platform_set_drvdata(pdev, rdev);
 536
 537         /* NOTE:  many regulators support short-circuit IRQs (presentable
 538          * as REGULATOR_OVER_CURRENT notifications?) configured via:
 539          *  - SC_CONFIG
 540          *  - SC_DETECT1 (vintana2, vmmc1/2, vaux1/2/3/4)
 541          *  - SC_DETECT2 (vusb, vdac, vio, vdd1/2, vpll2)
 542          *  - IT_CONFIG
 543          */
 544
 545         return 0;
 546 }
 547
 548 static int __devexit twlreg_remove(struct platform_device *pdev)
 549 {
 550         regulator_unregister(platform_get_drvdata(pdev));
 551         return 0;
 552 }
 553
 554 MODULE_ALIAS("platform:twl_reg");
 555
 556 static struct platform_driver twlreg_driver = {
 557         .probe          = twlreg_probe,
 558         .remove         = __devexit_p(twlreg_remove),
 559         /* NOTE: short name, to work around driver model truncation of
 560          * "twl_regulator.12" (and friends) to "twl_regulator.1".
 561          */
 562         .driver.name    = "twl_reg",
 563         .driver.owner   = THIS_MODULE,
 564 };
 565
 566 static int __init twlreg_init(void)
 567 {
 568         return platform_driver_register(&twlreg_driver);
 569 }
 570 subsys_initcall(twlreg_init);
 571
 572 static void __exit twlreg_exit(void)
 573 {
 574         platform_driver_unregister(&twlreg_driver);
 575 }
 576 module_exit(twlreg_exit)
 577
 578 MODULE_DESCRIPTION("TWL regulator driver");
 579 MODULE_LICENSE("GPL");