drivers/regulator/tps6586x-regulator.c

   1 /*
   2  * Regulator driver for TI TPS6586x
   3  *
   4  * Copyright (C) 2010 Compulab Ltd.
   5  * Author: Mike Rapoport <mike@compulab.co.il>
   6  *
   7  * Based on da903x
   8  * Copyright (C) 2006-2008 Marvell International Ltd.
   9  * Copyright (C) 2008 Compulab Ltd.
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  */
  15
  16 #define DEBUG
  17 #include <linux/kernel.h>
  18 #include <linux/init.h>
  19 #include <linux/err.h>
  20 #include <linux/slab.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/regulator/driver.h>
  23 #include <linux/regulator/machine.h>
  24 #include <linux/mfd/tps6586x.h>
  25
  26 /* supply control and voltage setting  */
  27 #define TPS6586X_SUPPLYENA      0x10
  28 #define TPS6586X_SUPPLYENB      0x11
  29 #define TPS6586X_SUPPLYENC      0x12
  30 #define TPS6586X_SUPPLYEND      0x13
  31 #define TPS6586X_SUPPLYENE      0x14
  32 #define TPS6586X_VCC1           0x20
  33 #define TPS6586X_VCC2           0x21
  34 #define TPS6586X_SM1V1          0x23
  35 #define TPS6586X_SM1V2          0x24
  36 #define TPS6586X_SM1SL          0x25
  37 #define TPS6586X_SM0V1          0x26
  38 #define TPS6586X_SM0V2          0x27
  39 #define TPS6586X_SM0SL          0x28
  40 #define TPS6586X_LDO2AV1        0x29
  41 #define TPS6586X_LDO2AV2        0x2A
  42 #define TPS6586X_LDO2BV1        0x2F
  43 #define TPS6586X_LDO2BV2        0x30
  44 #define TPS6586X_LDO4V1         0x32
  45 #define TPS6586X_LDO4V2         0x33
  46
  47 /* converter settings  */
  48 #define TPS6586X_SUPPLYV1       0x41
  49 #define TPS6586X_SUPPLYV2       0x42
  50 #define TPS6586X_SUPPLYV3       0x43
  51 #define TPS6586X_SUPPLYV4       0x44
  52 #define TPS6586X_SUPPLYV5       0x45
  53 #define TPS6586X_SUPPLYV6       0x46
  54 #define TPS6586X_SMODE1         0x47
  55 #define TPS6586X_SMODE2         0x48
  56
  57 struct tps6586x_regulator {
  58         struct regulator_desc desc;
  59
  60         int volt_reg;
  61         int volt_shift;
  62         int volt_nbits;
  63         int enable_bit[2];
  64         int enable_reg[2];
  65
  66         int *voltages;
  67
  68         /* for DVM regulators */
  69         int go_reg;
  70         int go_bit;
  71 };
  72
  73 static inline struct device *to_tps6586x_dev(struct regulator_dev *rdev)
  74 {
  75         return rdev_get_dev(rdev)->parent->parent;
  76 }
  77
  78 static int tps6586x_ldo_list_voltage(struct regulator_dev *rdev,
  79                                      unsigned selector)
  80 {
  81         struct tps6586x_regulator *info = rdev_get_drvdata(rdev);
  82
  83         return info->voltages[selector] * 1000;
  84 }
  85
  86
  87 static int __tps6586x_ldo_set_voltage(struct device *parent,
  88                                       struct tps6586x_regulator *ri,
  89                                       int min_uV, int max_uV)
  90 {
  91         int val, uV;
  92         uint8_t mask;
  93
  94         for (val = 0; val < ri->desc.n_voltages; val++) {
  95                 uV = ri->voltages[val] * 1000;
  96
  97                 /* LDO0 has minimal voltage 1.2 rather than 1.25 */
  98                 if (ri->desc.id == TPS6586X_ID_LDO_0 && val == 0)
  99                         uV -= 50 * 1000;
 100
 101                 /* use the first in-range value */
 102                 if (min_uV <= uV && uV <= max_uV) {
 103
 104                         val <<= ri->volt_shift;
 105                         mask = ((1 << ri->volt_nbits) - 1) << ri->volt_shift;
 106
 107                         return tps6586x_update(parent, ri->volt_reg, val, mask);
 108                 }
 109         }
 110
 111         return -EINVAL;
 112 }
 113
 114 static int tps6586x_ldo_set_voltage(struct regulator_dev *rdev,
 115                                     int min_uV, int max_uV)
 116 {
 117         struct tps6586x_regulator *ri = rdev_get_drvdata(rdev);
 118         struct device *parent = to_tps6586x_dev(rdev);
 119
 120         return __tps6586x_ldo_set_voltage(parent, ri, min_uV, max_uV);
 121 }
 122
 123 static int tps6586x_ldo_get_voltage(struct regulator_dev *rdev)
 124 {
 125         struct tps6586x_regulator *ri = rdev_get_drvdata(rdev);
 126         struct device *parent = to_tps6586x_dev(rdev);
 127         uint8_t val, mask;
 128         int ret;
 129
 130         ret = tps6586x_read(parent, ri->volt_reg, &val);
 131         if (ret)
 132                 return ret;
 133
 134         mask = ((1 << ri->volt_nbits) - 1) << ri->volt_shift;
 135         val = (val & mask) >> ri->volt_shift;
 136
 137         if (val > ri->desc.n_voltages)
 138                 BUG();
 139
 140         return ri->voltages[val] * 1000;
 141 }
 142
 143 static int tps6586x_dvm_set_voltage(struct regulator_dev *rdev,
 144                                     int min_uV, int max_uV)
 145 {
 146         struct tps6586x_regulator *ri = rdev_get_drvdata(rdev);
 147         struct device *parent = to_tps6586x_dev(rdev);
 148         int ret;
 149
 150         ret = __tps6586x_ldo_set_voltage(parent, ri, min_uV, max_uV);
 151         if (ret)
 152                 return ret;
 153
 154         return tps6586x_set_bits(parent, ri->go_reg, ri->go_bit);
 155 }
 156
 157 static int tps6586x_regulator_enable(struct regulator_dev *rdev)
 158 {
 159         struct tps6586x_regulator *ri = rdev_get_drvdata(rdev);
 160         struct device *parent = to_tps6586x_dev(rdev);
 161
 162         return tps6586x_set_bits(parent, ri->enable_reg[0],
 163                                  1 << ri->enable_bit[0]);
 164 }
 165
 166 static int tps6586x_regulator_disable(struct regulator_dev *rdev)
 167 {
 168         struct tps6586x_regulator *ri = rdev_get_drvdata(rdev);
 169         struct device *parent = to_tps6586x_dev(rdev);
 170
 171         return tps6586x_clr_bits(parent, ri->enable_reg[0],
 172                                  1 << ri->enable_bit[0]);
 173 }
 174
 175 static int tps6586x_regulator_is_enabled(struct regulator_dev *rdev)
 176 {
 177         struct tps6586x_regulator *ri = rdev_get_drvdata(rdev);
 178         struct device *parent = to_tps6586x_dev(rdev);
 179         uint8_t reg_val;
 180         int ret;
 181
 182         ret = tps6586x_read(parent, ri->enable_reg[0], &reg_val);
 183         if (ret)
 184                 return ret;
 185
 186         return !!(reg_val & (1 << ri->enable_bit[0]));
 187 }
 188
 189 static struct regulator_ops tps6586x_regulator_ldo_ops = {
 190         .list_voltage = tps6586x_ldo_list_voltage,
 191         .get_voltage = tps6586x_ldo_get_voltage,
 192         .set_voltage = tps6586x_ldo_set_voltage,
 193
 194         .is_enabled = tps6586x_regulator_is_enabled,
 195         .enable = tps6586x_regulator_enable,
 196         .disable = tps6586x_regulator_disable,
 197 };
 198
 199 static struct regulator_ops tps6586x_regulator_dvm_ops = {
 200         .list_voltage = tps6586x_ldo_list_voltage,
 201         .get_voltage = tps6586x_ldo_get_voltage,
 202         .set_voltage = tps6586x_dvm_set_voltage,
 203
 204         .is_enabled = tps6586x_regulator_is_enabled,
 205         .enable = tps6586x_regulator_enable,
 206         .disable = tps6586x_regulator_disable,
 207 };
 208
 209 static int tps6586x_ldo_voltages[] = {
 210         1250, 1500, 1800, 2500, 2700, 2850, 3100, 3300,
 211 };
 212
 213 static int tps6586x_ldo4_voltages[] = {
 214         1700, 1725, 1750, 1775, 1800, 1825, 1850, 1875,
 215         1900, 1925, 1950, 1975, 2000, 2025, 2050, 2075,
 216         2100, 2125, 2150, 2175, 2200, 2225, 2250, 2275,
 217         2300, 2325, 2350, 2375, 2400, 2425, 2450, 2475,
 218 };
 219
 220 static int tps6586x_sm2_voltages[] = {
 221         3000, 3050, 3100, 3150, 3200, 3250, 3300, 3350,
 222         3400, 3450, 3500, 3550, 3600, 3650, 3700, 3750,
 223         3800, 3850, 3900, 3950, 4000, 4050, 4100, 4150,
 224         4200, 4250, 4300, 4350, 4400, 4450, 4500, 4550,
 225 };
 226
 227 static int tps6586x_dvm_voltages[] = {
 228          725,  750,  775,  800,  825,  850,  875,  900,
 229          925,  950,  975, 1000, 1025, 1050, 1075, 1100,
 230         1125, 1150, 1175, 1200, 1225, 1250, 1275, 1300,
 231         1325, 1350, 1375, 1400, 1425, 1450, 1475, 1500,
 232 };
 233
 234 #define TPS6586X_REGULATOR(_id, vdata, _ops, vreg, shift, nbits,        \
 235                            ereg0, ebit0, ereg1, ebit1, goreg, gobit)    \
 236 {                                                                       \
 237         .desc   = {                                                     \
 238                 .name   = "REG-" #_id,                                  \
 239                 .ops    = &tps6586x_regulator_##_ops,                   \
 240                 .type   = REGULATOR_VOLTAGE,                            \
 241                 .id     = TPS6586X_ID_##_id,                            \
 242                 .n_voltages = ARRAY_SIZE(tps6586x_##vdata##_voltages),  \
 243                 .owner  = THIS_MODULE,                                  \
 244         },                                                              \
 245         .volt_reg       = TPS6586X_##vreg,                              \
 246         .volt_shift     = (shift),                                      \
 247         .volt_nbits     = (nbits),                                      \
 248         .enable_reg[0]  = TPS6586X_SUPPLY##ereg0,                       \
 249         .enable_bit[0]  = (ebit0),                                      \
 250         .enable_reg[1]  = TPS6586X_SUPPLY##ereg1,                       \
 251         .enable_bit[1]  = (ebit1),                                      \
 252         .voltages       = tps6586x_##vdata##_voltages,                  \
 253 }
 254
 255 #define TPS6586X_LDO(_id, vdata, vreg, shift, nbits,                    \
 256                      ereg0, ebit0, ereg1, ebit1)                        \
 257         TPS6586X_REGULATOR(_id, vdata, ldo_ops, vreg, shift, nbits,     \
 258                            ereg0, ebit0, ereg1, ebit1, 0, 0)
 259
 260 #define TPS6586X_DVM(_id, vdata, vreg, shift, nbits,                    \
 261                      ereg0, ebit0, ereg1, ebit1, goreg, gobit)          \
 262         TPS6586X_REGULATOR(_id, vdata, dvm_ops, vreg, shift, nbits,     \
 263                            ereg0, ebit0, ereg1, ebit1, goreg, gobit)
 264
 265 static struct tps6586x_regulator tps6586x_regulator[] = {
 266         TPS6586X_LDO(LDO_0, ldo, SUPPLYV1, 5, 3, ENC, 0, END, 0),
 267         TPS6586X_LDO(LDO_3, ldo, SUPPLYV4, 0, 3, ENC, 2, END, 2),
 268         TPS6586X_LDO(LDO_5, ldo, SUPPLYV6, 0, 3, ENE, 6, ENE, 6),
 269         TPS6586X_LDO(LDO_6, ldo, SUPPLYV3, 0, 3, ENC, 4, END, 4),
 270         TPS6586X_LDO(LDO_7, ldo, SUPPLYV3, 3, 3, ENC, 5, END, 5),
 271         TPS6586X_LDO(LDO_8, ldo, SUPPLYV1, 5, 3, ENC, 6, END, 6),
 272         TPS6586X_LDO(LDO_9, ldo, SUPPLYV6, 3, 3, ENE, 7, ENE, 7),
 273         TPS6586X_LDO(LDO_RTC, ldo, SUPPLYV4, 3, 3, ENE, 7, ENE, 7),
 274         TPS6586X_LDO(LDO_1, dvm, SUPPLYV1, 0, 5, ENC, 1, END, 1),
 275         TPS6586X_LDO(SM_2, sm2, SUPPLYV2, 0, 5, ENC, 1, END, 1),
 276
 277         TPS6586X_DVM(LDO_2, dvm, LDO2BV1, 0, 5, ENA, 3, ENB, 3, VCC2, 6),
 278         TPS6586X_DVM(LDO_4, ldo4, LDO4V1, 0, 5, ENC, 3, END, 3, VCC1, 6),
 279         TPS6586X_DVM(SM_0, dvm, SM0V1, 0, 5, ENA, 1, ENB, 1, VCC1, 2),
 280         TPS6586X_DVM(SM_1, dvm, SM1V1, 0, 5, ENA, 0, ENB, 0, VCC1, 0),
 281 };
 282
 283 /*
 284  * TPS6586X has 2 enable bits that are OR'ed to determine the actual
 285  * regulator state. Clearing one of this bits allows switching
 286  * regulator on and of with single register write.
 287  */
 288 static inline int tps6586x_regulator_preinit(struct device *parent,
 289                                              struct tps6586x_regulator *ri)
 290 {
 291         uint8_t val1, val2;
 292         int ret;
 293
 294         ret = tps6586x_read(parent, ri->enable_reg[0], &val1);
 295         if (ret)
 296                 return ret;
 297
 298         ret = tps6586x_read(parent, ri->enable_reg[1], &val2);
 299         if (ret)
 300                 return ret;
 301
 302         if (!(val2 & ri->enable_bit[1]))
 303                 return 0;
 304
 305         /*
 306          * The regulator is on, but it's enabled with the bit we don't
 307          * want to use, so we switch the enable bits
 308          */
 309         if (!(val1 & ri->enable_bit[0])) {
 310                 ret = tps6586x_set_bits(parent, ri->enable_reg[0],
 311                                         1 << ri->enable_bit[0]);
 312                 if (ret)
 313                         return ret;
 314         }
 315
 316         return tps6586x_clr_bits(parent, ri->enable_reg[1],
 317                                  1 << ri->enable_bit[1]);
 318 }
 319
 320 static inline struct tps6586x_regulator *find_regulator_info(int id)
 321 {
 322         struct tps6586x_regulator *ri;
 323         int i;
 324
 325         for (i = 0; i < ARRAY_SIZE(tps6586x_regulator); i++) {
 326                 ri = &tps6586x_regulator[i];
 327                 if (ri->desc.id == id)
 328                         return ri;
 329         }
 330         return NULL;
 331 }
 332
 333 static int __devinit tps6586x_regulator_probe(struct platform_device *pdev)
 334 {
 335         struct tps6586x_regulator *ri = NULL;
 336         struct regulator_dev *rdev;
 337         int id = pdev->id;
 338         int err;
 339
 340         dev_dbg(&pdev->dev, "Probing reulator %d\n", id);
 341
 342         ri = find_regulator_info(id);
 343         if (ri == NULL) {
 344                 dev_err(&pdev->dev, "invalid regulator ID specified\n");
 345                 return -EINVAL;
 346         }
 347
 348         err = tps6586x_regulator_preinit(pdev->dev.parent, ri);
 349         if (err)
 350                 return err;
 351
 352         rdev = regulator_register(&ri->desc, &pdev->dev,
 353                                   pdev->dev.platform_data, ri);
 354         if (IS_ERR(rdev)) {
 355                 dev_err(&pdev->dev, "failed to register regulator %s\n",
 356                                 ri->desc.name);
 357                 return PTR_ERR(rdev);
 358         }
 359
 360         platform_set_drvdata(pdev, rdev);
 361
 362         return 0;
 363 }
 364
 365 static int __devexit tps6586x_regulator_remove(struct platform_device *pdev)
 366 {
 367         struct regulator_dev *rdev = platform_get_drvdata(pdev);
 368
 369         regulator_unregister(rdev);
 370         return 0;
 371 }
 372
 373 static struct platform_driver tps6586x_regulator_driver = {
 374         .driver = {
 375                 .name   = "tps6586x-regulator",
 376                 .owner  = THIS_MODULE,
 377         },
 378         .probe          = tps6586x_regulator_probe,
 379         .remove         = __devexit_p(tps6586x_regulator_remove),
 380 };
 381
 382 static int __init tps6586x_regulator_init(void)
 383 {
 384         return platform_driver_register(&tps6586x_regulator_driver);
 385 }
 386 subsys_initcall(tps6586x_regulator_init);
 387
 388 static void __exit tps6586x_regulator_exit(void)
 389 {
 390         platform_driver_unregister(&tps6586x_regulator_driver);
 391 }
 392 module_exit(tps6586x_regulator_exit);
 393
 394 MODULE_LICENSE("GPL");
 395 MODULE_AUTHOR("Mike Rapoport <mike@compulab.co.il>");
 396 MODULE_DESCRIPTION("Regulator Driver for TI TPS6586X PMIC");
 397 MODULE_ALIAS("platform:tps6586x-regulator");