drivers/regulator/tps65023-regulator.c

   1 /*
   2  * tps65023-regulator.c
   3  *
   4  * Supports TPS65023 Regulator
   5  *
   6  * Copyright (C) 2009 Texas Instrument Incorporated - http://www.ti.com/
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation version 2.
  11  *
  12  * This program is distributed "as is" WITHOUT ANY WARRANTY of any kind,
  13  * whether express or implied; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  */
  17
  18 #include <linux/kernel.h>
  19 #include <linux/module.h>
  20 #include <linux/init.h>
  21 #include <linux/err.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/regulator/driver.h>
  24 #include <linux/regulator/machine.h>
  25 #include <linux/i2c.h>
  26 #include <linux/slab.h>
  27 #include <linux/regmap.h>
  28
  29 /* Register definitions */
  30 #define TPS65023_REG_VERSION            0
  31 #define TPS65023_REG_PGOODZ             1
  32 #define TPS65023_REG_MASK               2
  33 #define TPS65023_REG_REG_CTRL           3
  34 #define TPS65023_REG_CON_CTRL           4
  35 #define TPS65023_REG_CON_CTRL2          5
  36 #define TPS65023_REG_DEF_CORE           6
  37 #define TPS65023_REG_DEFSLEW            7
  38 #define TPS65023_REG_LDO_CTRL           8
  39
  40 /* PGOODZ bitfields */
  41 #define TPS65023_PGOODZ_PWRFAILZ        BIT(7)
  42 #define TPS65023_PGOODZ_LOWBATTZ        BIT(6)
  43 #define TPS65023_PGOODZ_VDCDC1          BIT(5)
  44 #define TPS65023_PGOODZ_VDCDC2          BIT(4)
  45 #define TPS65023_PGOODZ_VDCDC3          BIT(3)
  46 #define TPS65023_PGOODZ_LDO2            BIT(2)
  47 #define TPS65023_PGOODZ_LDO1            BIT(1)
  48
  49 /* MASK bitfields */
  50 #define TPS65023_MASK_PWRFAILZ          BIT(7)
  51 #define TPS65023_MASK_LOWBATTZ          BIT(6)
  52 #define TPS65023_MASK_VDCDC1            BIT(5)
  53 #define TPS65023_MASK_VDCDC2            BIT(4)
  54 #define TPS65023_MASK_VDCDC3            BIT(3)
  55 #define TPS65023_MASK_LDO2              BIT(2)
  56 #define TPS65023_MASK_LDO1              BIT(1)
  57
  58 /* REG_CTRL bitfields */
  59 #define TPS65023_REG_CTRL_VDCDC1_EN     BIT(5)
  60 #define TPS65023_REG_CTRL_VDCDC2_EN     BIT(4)
  61 #define TPS65023_REG_CTRL_VDCDC3_EN     BIT(3)
  62 #define TPS65023_REG_CTRL_LDO2_EN       BIT(2)
  63 #define TPS65023_REG_CTRL_LDO1_EN       BIT(1)
  64
  65 /* REG_CTRL2 bitfields */
  66 #define TPS65023_REG_CTRL2_GO           BIT(7)
  67 #define TPS65023_REG_CTRL2_CORE_ADJ     BIT(6)
  68 #define TPS65023_REG_CTRL2_DCDC2        BIT(2)
  69 #define TPS65023_REG_CTRL2_DCDC1        BIT(1)
  70 #define TPS65023_REG_CTRL2_DCDC3        BIT(0)
  71
  72 /* Number of step-down converters available */
  73 #define TPS65023_NUM_DCDC               3
  74 /* Number of LDO voltage regulators  available */
  75 #define TPS65023_NUM_LDO                2
  76 /* Number of total regulators available */
  77 #define TPS65023_NUM_REGULATOR  (TPS65023_NUM_DCDC + TPS65023_NUM_LDO)
  78
  79 /* DCDCs */
  80 #define TPS65023_DCDC_1                 0
  81 #define TPS65023_DCDC_2                 1
  82 #define TPS65023_DCDC_3                 2
  83 /* LDOs */
  84 #define TPS65023_LDO_1                  3
  85 #define TPS65023_LDO_2                  4
  86
  87 #define TPS65023_MAX_REG_ID             TPS65023_LDO_2
  88
  89 /* Supported voltage values for regulators */
  90 static const unsigned int VCORE_VSEL_table[] = {
  91         800000, 825000, 850000, 875000,
  92         900000, 925000, 950000, 975000,
  93         1000000, 1025000, 1050000, 1075000,
  94         1100000, 1125000, 1150000, 1175000,
  95         1200000, 1225000, 1250000, 1275000,
  96         1300000, 1325000, 1350000, 1375000,
  97         1400000, 1425000, 1450000, 1475000,
  98         1500000, 1525000, 1550000, 1600000,
  99 };
 100
 101 static const unsigned int DCDC_FIXED_3300000_VSEL_table[] = {
 102         3300000,
 103 };
 104
 105 static const unsigned int DCDC_FIXED_1800000_VSEL_table[] = {
 106         1800000,
 107 };
 108
 109 /* Supported voltage values for LDO regulators for tps65020 */
 110 static const unsigned int TPS65020_LDO_VSEL_table[] = {
 111         1000000, 1050000, 1100000, 1300000,
 112         1800000, 2500000, 3000000, 3300000,
 113 };
 114
 115 /* Supported voltage values for LDO regulators
 116  * for tps65021 and tps65023 */
 117 static const unsigned int TPS65023_LDO1_VSEL_table[] = {
 118         1000000, 1100000, 1300000, 1800000,
 119         2200000, 2600000, 2800000, 3150000,
 120 };
 121
 122 static const unsigned int TPS65023_LDO2_VSEL_table[] = {
 123         1050000, 1200000, 1300000, 1800000,
 124         2500000, 2800000, 3000000, 3300000,
 125 };
 126
 127 /* Regulator specific details */
 128 struct tps_info {
 129         const char *name;
 130         u8 table_len;
 131         const unsigned int *table;
 132 };
 133
 134 /* PMIC details */
 135 struct tps_pmic {
 136         struct regulator_desc desc[TPS65023_NUM_REGULATOR];
 137         struct regulator_dev *rdev[TPS65023_NUM_REGULATOR];
 138         const struct tps_info *info[TPS65023_NUM_REGULATOR];
 139         struct regmap *regmap;
 140         u8 core_regulator;
 141 };
 142
 143 /* Struct passed as driver data */
 144 struct tps_driver_data {
 145         const struct tps_info *info;
 146         u8 core_regulator;
 147 };
 148
 149 static int tps65023_dcdc_get_voltage_sel(struct regulator_dev *dev)
 150 {
 151         struct tps_pmic *tps = rdev_get_drvdata(dev);
 152         int ret;
 153         int data, dcdc = rdev_get_id(dev);
 154
 155         if (dcdc < TPS65023_DCDC_1 || dcdc > TPS65023_DCDC_3)
 156                 return -EINVAL;
 157
 158         if (dcdc == tps->core_regulator) {
 159                 ret = regmap_read(tps->regmap, TPS65023_REG_DEF_CORE, &data);
 160                 if (ret != 0)
 161                         return ret;
 162                 data &= (tps->info[dcdc]->table_len - 1);
 163                 return data;
 164         } else
 165                 return 0;
 166 }
 167
 168 static int tps65023_dcdc_set_voltage_sel(struct regulator_dev *dev,
 169                                          unsigned selector)
 170 {
 171         struct tps_pmic *tps = rdev_get_drvdata(dev);
 172         int dcdc = rdev_get_id(dev);
 173         int ret;
 174
 175         if (dcdc != tps->core_regulator)
 176                 return -EINVAL;
 177
 178         ret = regmap_write(tps->regmap, TPS65023_REG_DEF_CORE, selector);
 179         if (ret)
 180                 goto out;
 181
 182         /* Tell the chip that we have changed the value in DEFCORE
 183          * and its time to update the core voltage
 184          */
 185         ret = regmap_update_bits(tps->regmap, TPS65023_REG_CON_CTRL2,
 186                                  TPS65023_REG_CTRL2_GO, TPS65023_REG_CTRL2_GO);
 187
 188 out:
 189         return ret;
 190 }
 191
 192 /* Operations permitted on VDCDCx */
 193 static struct regulator_ops tps65023_dcdc_ops = {
 194         .is_enabled = regulator_is_enabled_regmap,
 195         .enable = regulator_enable_regmap,
 196         .disable = regulator_disable_regmap,
 197         .get_voltage_sel = tps65023_dcdc_get_voltage_sel,
 198         .set_voltage_sel = tps65023_dcdc_set_voltage_sel,
 199         .list_voltage = regulator_list_voltage_table,
 200         .map_voltage = regulator_map_voltage_ascend,
 201 };
 202
 203 /* Operations permitted on LDOx */
 204 static struct regulator_ops tps65023_ldo_ops = {
 205         .is_enabled = regulator_is_enabled_regmap,
 206         .enable = regulator_enable_regmap,
 207         .disable = regulator_disable_regmap,
 208         .get_voltage_sel = regulator_get_voltage_sel_regmap,
 209         .set_voltage_sel = regulator_set_voltage_sel_regmap,
 210         .list_voltage = regulator_list_voltage_table,
 211         .map_voltage = regulator_map_voltage_ascend,
 212 };
 213
 214 static struct regmap_config tps65023_regmap_config = {
 215         .reg_bits = 8,
 216         .val_bits = 8,
 217 };
 218
 219 static int tps_65023_probe(struct i2c_client *client,
 220                                      const struct i2c_device_id *id)
 221 {
 222         const struct tps_driver_data *drv_data = (void *)id->driver_data;
 223         const struct tps_info *info = drv_data->info;
 224         struct regulator_config config = { };
 225         struct regulator_init_data *init_data;
 226         struct regulator_dev *rdev;
 227         struct tps_pmic *tps;
 228         int i;
 229         int error;
 230
 231         if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
 232                 return -EIO;
 233
 234         /**
 235          * init_data points to array of regulator_init structures
 236          * coming from the board-evm file.
 237          */
 238         init_data = client->dev.platform_data;
 239         if (!init_data)
 240                 return -EIO;
 241
 242         tps = devm_kzalloc(&client->dev, sizeof(*tps), GFP_KERNEL);
 243         if (!tps)
 244                 return -ENOMEM;
 245
 246         tps->regmap = devm_regmap_init_i2c(client, &tps65023_regmap_config);
 247         if (IS_ERR(tps->regmap)) {
 248                 error = PTR_ERR(tps->regmap);
 249                 dev_err(&client->dev, "Failed to allocate register map: %d\n",
 250                         error);
 251                 return error;
 252         }
 253
 254         /* common for all regulators */
 255         tps->core_regulator = drv_data->core_regulator;
 256
 257         for (i = 0; i < TPS65023_NUM_REGULATOR; i++, info++, init_data++) {
 258                 /* Store regulator specific information */
 259                 tps->info[i] = info;
 260
 261                 tps->desc[i].name = info->name;
 262                 tps->desc[i].id = i;
 263                 tps->desc[i].n_voltages = info->table_len;
 264                 tps->desc[i].volt_table = info->table;
 265                 tps->desc[i].ops = (i > TPS65023_DCDC_3 ?
 266                                         &tps65023_ldo_ops : &tps65023_dcdc_ops);
 267                 tps->desc[i].type = REGULATOR_VOLTAGE;
 268                 tps->desc[i].owner = THIS_MODULE;
 269
 270                 tps->desc[i].enable_reg = TPS65023_REG_REG_CTRL;
 271                 switch (i) {
 272                 case TPS65023_LDO_1:
 273                         tps->desc[i].vsel_reg = TPS65023_REG_LDO_CTRL;
 274                         tps->desc[i].vsel_mask = 0x07;
 275                         tps->desc[i].enable_mask = 1 << 1;
 276                         break;
 277                 case TPS65023_LDO_2:
 278                         tps->desc[i].vsel_reg = TPS65023_REG_LDO_CTRL;
 279                         tps->desc[i].vsel_mask = 0x70;
 280                         tps->desc[i].enable_mask = 1 << 2;
 281                         break;
 282                 default: /* DCDCx */
 283                         tps->desc[i].enable_mask =
 284                                         1 << (TPS65023_NUM_REGULATOR - i);
 285                 }
 286
 287                 config.dev = &client->dev;
 288                 config.init_data = init_data;
 289                 config.driver_data = tps;
 290                 config.regmap = tps->regmap;
 291
 292                 /* Register the regulators */
 293                 rdev = regulator_register(&tps->desc[i], &config);
 294                 if (IS_ERR(rdev)) {
 295                         dev_err(&client->dev, "failed to register %s\n",
 296                                 id->name);
 297                         error = PTR_ERR(rdev);
 298                         goto fail;
 299                 }
 300
 301                 /* Save regulator for cleanup */
 302                 tps->rdev[i] = rdev;
 303         }
 304
 305         i2c_set_clientdata(client, tps);
 306
 307         /* Enable setting output voltage by I2C */
 308         regmap_update_bits(tps->regmap, TPS65023_REG_CON_CTRL2,
 309                         TPS65023_REG_CTRL2_CORE_ADJ, TPS65023_REG_CTRL2_CORE_ADJ);
 310
 311         return 0;
 312
 313  fail:
 314         while (--i >= 0)
 315                 regulator_unregister(tps->rdev[i]);
 316         return error;
 317 }
 318
 319 static int tps_65023_remove(struct i2c_client *client)
 320 {
 321         struct tps_pmic *tps = i2c_get_clientdata(client);
 322         int i;
 323
 324         for (i = 0; i < TPS65023_NUM_REGULATOR; i++)
 325                 regulator_unregister(tps->rdev[i]);
 326         return 0;
 327 }
 328
 329 static const struct tps_info tps65020_regs[] = {
 330         {
 331                 .name = "VDCDC1",
 332                 .table_len = ARRAY_SIZE(DCDC_FIXED_3300000_VSEL_table),
 333                 .table = DCDC_FIXED_3300000_VSEL_table,
 334         },
 335         {
 336                 .name = "VDCDC2",
 337                 .table_len = ARRAY_SIZE(DCDC_FIXED_1800000_VSEL_table),
 338                 .table = DCDC_FIXED_1800000_VSEL_table,
 339         },
 340         {
 341                 .name = "VDCDC3",
 342                 .table_len = ARRAY_SIZE(VCORE_VSEL_table),
 343                 .table = VCORE_VSEL_table,
 344         },
 345         {
 346                 .name = "LDO1",
 347                 .table_len = ARRAY_SIZE(TPS65020_LDO_VSEL_table),
 348                 .table = TPS65020_LDO_VSEL_table,
 349         },
 350         {
 351                 .name = "LDO2",
 352                 .table_len = ARRAY_SIZE(TPS65020_LDO_VSEL_table),
 353                 .table = TPS65020_LDO_VSEL_table,
 354         },
 355 };
 356
 357 static const struct tps_info tps65021_regs[] = {
 358         {
 359                 .name = "VDCDC1",
 360                 .table_len = ARRAY_SIZE(DCDC_FIXED_3300000_VSEL_table),
 361                 .table = DCDC_FIXED_3300000_VSEL_table,
 362         },
 363         {
 364                 .name = "VDCDC2",
 365                 .table_len = ARRAY_SIZE(DCDC_FIXED_1800000_VSEL_table),
 366                 .table = DCDC_FIXED_1800000_VSEL_table,
 367         },
 368         {
 369                 .name = "VDCDC3",
 370                 .table_len = ARRAY_SIZE(VCORE_VSEL_table),
 371                 .table = VCORE_VSEL_table,
 372         },
 373         {
 374                 .name = "LDO1",
 375                 .table_len = ARRAY_SIZE(TPS65023_LDO1_VSEL_table),
 376                 .table = TPS65023_LDO1_VSEL_table,
 377         },
 378         {
 379                 .name = "LDO2",
 380                 .table_len = ARRAY_SIZE(TPS65023_LDO2_VSEL_table),
 381                 .table = TPS65023_LDO2_VSEL_table,
 382         },
 383 };
 384
 385 static const struct tps_info tps65023_regs[] = {
 386         {
 387                 .name = "VDCDC1",
 388                 .table_len = ARRAY_SIZE(VCORE_VSEL_table),
 389                 .table = VCORE_VSEL_table,
 390         },
 391         {
 392                 .name = "VDCDC2",
 393                 .table_len = ARRAY_SIZE(DCDC_FIXED_3300000_VSEL_table),
 394                 .table = DCDC_FIXED_3300000_VSEL_table,
 395         },
 396         {
 397                 .name = "VDCDC3",
 398                 .table_len = ARRAY_SIZE(DCDC_FIXED_1800000_VSEL_table),
 399                 .table = DCDC_FIXED_1800000_VSEL_table,
 400         },
 401         {
 402                 .name = "LDO1",
 403                 .table_len = ARRAY_SIZE(TPS65023_LDO1_VSEL_table),
 404                 .table = TPS65023_LDO1_VSEL_table,
 405         },
 406         {
 407                 .name = "LDO2",
 408                 .table_len = ARRAY_SIZE(TPS65023_LDO2_VSEL_table),
 409                 .table = TPS65023_LDO2_VSEL_table,
 410         },
 411 };
 412
 413 static struct tps_driver_data tps65020_drv_data = {
 414         .info = tps65020_regs,
 415         .core_regulator = TPS65023_DCDC_3,
 416 };
 417
 418 static struct tps_driver_data tps65021_drv_data = {
 419         .info = tps65021_regs,
 420         .core_regulator = TPS65023_DCDC_3,
 421 };
 422
 423 static struct tps_driver_data tps65023_drv_data = {
 424         .info = tps65023_regs,
 425         .core_regulator = TPS65023_DCDC_1,
 426 };
 427
 428 static const struct i2c_device_id tps_65023_id[] = {
 429         {.name = "tps65023",
 430         .driver_data = (unsigned long) &tps65023_drv_data},
 431         {.name = "tps65021",
 432         .driver_data = (unsigned long) &tps65021_drv_data,},
 433         {.name = "tps65020",
 434         .driver_data = (unsigned long) &tps65020_drv_data},
 435         { },
 436 };
 437
 438 MODULE_DEVICE_TABLE(i2c, tps_65023_id);
 439
 440 static struct i2c_driver tps_65023_i2c_driver = {
 441         .driver = {
 442                 .name = "tps65023",
 443                 .owner = THIS_MODULE,
 444         },
 445         .probe = tps_65023_probe,
 446         .remove = tps_65023_remove,
 447         .id_table = tps_65023_id,
 448 };
 449
 450 static int __init tps_65023_init(void)
 451 {
 452         return i2c_add_driver(&tps_65023_i2c_driver);
 453 }
 454 subsys_initcall(tps_65023_init);
 455
 456 static void __exit tps_65023_cleanup(void)
 457 {
 458         i2c_del_driver(&tps_65023_i2c_driver);
 459 }
 460 module_exit(tps_65023_cleanup);
 461
 462 MODULE_AUTHOR("Texas Instruments");
 463 MODULE_DESCRIPTION("TPS65023 voltage regulator driver");
 464 MODULE_LICENSE("GPL v2");