Regulator: Add TPS65023 regulator driver
Anuj Aggarwal [Thu, 20 Aug 2009 19:09:31 +0000 (00:09 +0530)]
Adding support for TI TPS65023 regulator driver

Signed-off-by: Anuj Aggarwal <anuj.aggarwal@ti.com>
Acked-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>

drivers/regulator/tps65023-regulator.c [new file with mode: 0644]

diff --git a/drivers/regulator/tps65023-regulator.c b/drivers/regulator/tps65023-regulator.c
new file mode 100644 (file)
index 0000000..1e54f46
--- /dev/null
@@ -0,0 +1,631 @@
+/*
+ * tps65023-regulator.c
+ *
+ * Supports TPS65023 Regulator
+ *
+ * Copyright (C) 2009 Texas Instrument Incorporated - http://www.ti.com/
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
+ * published by the Free Software Foundation version 2.
+ *
+ * This program is distributed "as is" WITHOUT ANY WARRANTY of any kind,
+ * whether express or implied; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * General Public License for more details.
+ */
+
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/init.h>
+#include <linux/err.h>
+#include <linux/platform_device.h>
+#include <linux/regulator/driver.h>
+#include <linux/regulator/machine.h>
+#include <linux/i2c.h>
+#include <linux/delay.h>
+
+/* Register definitions */
+#define        TPS65023_REG_VERSION            0
+#define        TPS65023_REG_PGOODZ             1
+#define        TPS65023_REG_MASK               2
+#define        TPS65023_REG_REG_CTRL           3
+#define        TPS65023_REG_CON_CTRL           4
+#define        TPS65023_REG_CON_CTRL2          5
+#define        TPS65023_REG_DEF_CORE           6
+#define        TPS65023_REG_DEFSLEW            7
+#define        TPS65023_REG_LDO_CTRL           8
+
+/* PGOODZ bitfields */
+#define        TPS65023_PGOODZ_PWRFAILZ        BIT(7)
+#define        TPS65023_PGOODZ_LOWBATTZ        BIT(6)
+#define        TPS65023_PGOODZ_VDCDC1          BIT(5)
+#define        TPS65023_PGOODZ_VDCDC2          BIT(4)
+#define        TPS65023_PGOODZ_VDCDC3          BIT(3)
+#define        TPS65023_PGOODZ_LDO2            BIT(2)
+#define        TPS65023_PGOODZ_LDO1            BIT(1)
+
+/* MASK bitfields */
+#define        TPS65023_MASK_PWRFAILZ          BIT(7)
+#define        TPS65023_MASK_LOWBATTZ          BIT(6)
+#define        TPS65023_MASK_VDCDC1            BIT(5)
+#define        TPS65023_MASK_VDCDC2            BIT(4)
+#define        TPS65023_MASK_VDCDC3            BIT(3)
+#define        TPS65023_MASK_LDO2              BIT(2)
+#define        TPS65023_MASK_LDO1              BIT(1)
+
+/* REG_CTRL bitfields */
+#define TPS65023_REG_CTRL_VDCDC1_EN    BIT(5)
+#define TPS65023_REG_CTRL_VDCDC2_EN    BIT(4)
+#define TPS65023_REG_CTRL_VDCDC3_EN    BIT(3)
+#define TPS65023_REG_CTRL_LDO2_EN      BIT(2)
+#define TPS65023_REG_CTRL_LDO1_EN      BIT(1)
+
+/* LDO_CTRL bitfields */
+#define TPS65023_LDO_CTRL_LDOx_SHIFT(ldo_id)   ((ldo_id)*4)
+#define TPS65023_LDO_CTRL_LDOx_MASK(ldo_id)    (0xF0 >> ((ldo_id)*4))
+
+/* Number of step-down converters available */
+#define TPS65023_NUM_DCDC              3
+/* Number of LDO voltage regulators  available */
+#define TPS65023_NUM_LDO               2
+/* Number of total regulators available */
+#define TPS65023_NUM_REGULATOR (TPS65023_NUM_DCDC + TPS65023_NUM_LDO)
+
+/* DCDCs */
+#define TPS65023_DCDC_1                        0
+#define TPS65023_DCDC_2                        1
+#define TPS65023_DCDC_3                        2
+/* LDOs */
+#define TPS65023_LDO_1                 3
+#define TPS65023_LDO_2                 4
+
+#define TPS65023_MAX_REG_ID            TPS65023_LDO_2
+
+/* Supported voltage values for regulators */
+static const u16 VDCDC1_VSEL_table[] = {
+       800, 825, 850, 875,
+       900, 925, 950, 975,
+       1000, 1025, 1050, 1075,
+       1100, 1125, 1150, 1175,
+       1200, 1225, 1250, 1275,
+       1300, 1325, 1350, 1375,
+       1400, 1425, 1450, 1475,
+       1500, 1525, 1550, 1600,
+};
+
+static const u16 LDO1_VSEL_table[] = {
+       1000, 1100, 1300, 1800,
+       2200, 2600, 2800, 3150,
+};
+
+static const u16 LDO2_VSEL_table[] = {
+       1050, 1200, 1300, 1800,
+       2500, 2800, 3000, 3300,
+};
+
+static unsigned int num_voltages[] = {ARRAY_SIZE(VDCDC1_VSEL_table),
+                               0, 0, ARRAY_SIZE(LDO1_VSEL_table),
+                               ARRAY_SIZE(LDO2_VSEL_table)};
+
+/* Regulator specific details */
+struct tps_info {
+       const char *name;
+       unsigned min_uV;
+       unsigned max_uV;
+       bool fixed;
+       u8 table_len;
+       const u16 *table;
+};
+
+/* PMIC details */
+struct tps_pmic {
+       struct regulator_desc desc[TPS65023_NUM_REGULATOR];
+       struct i2c_client *client;
+       struct regulator_dev *rdev[TPS65023_NUM_REGULATOR];
+       const struct tps_info *info[TPS65023_NUM_REGULATOR];
+       struct mutex io_lock;
+};
+
+static inline int tps_65023_read(struct tps_pmic *tps, u8 reg)
+{
+       return i2c_smbus_read_byte_data(tps->client, reg);
+}
+
+static inline int tps_65023_write(struct tps_pmic *tps, u8 reg, u8 val)
+{
+       return i2c_smbus_write_byte_data(tps->client, reg, val);
+}
+
+static int tps_65023_set_bits(struct tps_pmic *tps, u8 reg, u8 mask)
+{
+       int err, data;
+
+       mutex_lock(&tps->io_lock);
+
+       data = tps_65023_read(tps, reg);
+       if (data < 0) {
+               dev_err(&tps->client->dev, "Read from reg 0x%x failed\n", reg);
+               err = data;
+               goto out;
+       }
+
+       data |= mask;
+       err = tps_65023_write(tps, reg, data);
+       if (err)
+               dev_err(&tps->client->dev, "Write for reg 0x%x failed\n", reg);
+
+out:
+       mutex_unlock(&tps->io_lock);
+       return err;
+}
+
+static int tps_65023_clear_bits(struct tps_pmic *tps, u8 reg, u8 mask)
+{
+       int err, data;
+
+       mutex_lock(&tps->io_lock);
+
+       data = tps_65023_read(tps, reg);
+       if (data < 0) {
+               dev_err(&tps->client->dev, "Read from reg 0x%x failed\n", reg);
+               err = data;
+               goto out;
+       }
+
+       data &= ~mask;
+
+       err = tps_65023_write(tps, reg, data);
+       if (err)
+               dev_err(&tps->client->dev, "Write for reg 0x%x failed\n", reg);
+
+out:
+       mutex_unlock(&tps->io_lock);
+       return err;
+
+}
+
+static int tps_65023_reg_read(struct tps_pmic *tps, u8 reg)
+{
+       int data;
+
+       mutex_lock(&tps->io_lock);
+
+       data = tps_65023_read(tps, reg);
+       if (data < 0)
+               dev_err(&tps->client->dev, "Read from reg 0x%x failed\n", reg);
+
+       mutex_unlock(&tps->io_lock);
+       return data;
+}
+
+static int tps_65023_reg_write(struct tps_pmic *tps, u8 reg, u8 val)
+{
+       int err;
+
+       mutex_lock(&tps->io_lock);
+
+       err = tps_65023_write(tps, reg, val);
+       if (err < 0)
+               dev_err(&tps->client->dev, "Write for reg 0x%x failed\n", reg);
+
+       mutex_unlock(&tps->io_lock);
+       return err;
+}
+
+static int tps65023_dcdc_is_enabled(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int data, dcdc = rdev_get_id(dev);
+       u8 shift;
+
+       if (dcdc < TPS65023_DCDC_1 || dcdc > TPS65023_DCDC_3)
+               return -EINVAL;
+
+       shift = TPS65023_NUM_REGULATOR - dcdc;
+       data = tps_65023_reg_read(tps, TPS65023_REG_REG_CTRL);
+
+       if (data < 0)
+               return data;
+       else
+               return (data & 1<<shift) ? 1 : 0;
+}
+
+static int tps65023_ldo_is_enabled(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int data, ldo = rdev_get_id(dev);
+       u8 shift;
+
+       if (ldo < TPS65023_LDO_1 || ldo > TPS65023_LDO_2)
+               return -EINVAL;
+
+       shift = (ldo == TPS65023_LDO_1 ? 1 : 2);
+       data = tps_65023_reg_read(tps, TPS65023_REG_REG_CTRL);
+
+       if (data < 0)
+               return data;
+       else
+               return (data & 1<<shift) ? 1 : 0;
+}
+
+static int tps65023_dcdc_enable(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int dcdc = rdev_get_id(dev);
+       u8 shift;
+
+       if (dcdc < TPS65023_DCDC_1 || dcdc > TPS65023_DCDC_3)
+               return -EINVAL;
+
+       shift = TPS65023_NUM_REGULATOR - dcdc;
+       return tps_65023_set_bits(tps, TPS65023_REG_REG_CTRL, 1 << shift);
+}
+
+static int tps65023_dcdc_disable(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int dcdc = rdev_get_id(dev);
+       u8 shift;
+
+       if (dcdc < TPS65023_DCDC_1 || dcdc > TPS65023_DCDC_3)
+               return -EINVAL;
+
+       shift = TPS65023_NUM_REGULATOR - dcdc;
+       return tps_65023_clear_bits(tps, TPS65023_REG_REG_CTRL, 1 << shift);
+}
+
+static int tps65023_ldo_enable(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int ldo = rdev_get_id(dev);
+       u8 shift;
+
+       if (ldo < TPS65023_LDO_1 || ldo > TPS65023_LDO_2)
+               return -EINVAL;
+
+       shift = (ldo == TPS65023_LDO_1 ? 1 : 2);
+       return tps_65023_set_bits(tps, TPS65023_REG_REG_CTRL, 1 << shift);
+}
+
+static int tps65023_ldo_disable(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int ldo = rdev_get_id(dev);
+       u8 shift;
+
+       if (ldo < TPS65023_LDO_1 || ldo > TPS65023_LDO_2)
+               return -EINVAL;
+
+       shift = (ldo == TPS65023_LDO_1 ? 1 : 2);
+       return tps_65023_clear_bits(tps, TPS65023_REG_REG_CTRL, 1 << shift);
+}
+
+static int tps65023_dcdc_get_voltage(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int data, dcdc = rdev_get_id(dev);
+
+       if (dcdc < TPS65023_DCDC_1 || dcdc > TPS65023_DCDC_3)
+               return -EINVAL;
+
+       if (dcdc == TPS65023_DCDC_1) {
+               data = tps_65023_reg_read(tps, TPS65023_REG_DEF_CORE);
+               if (data < 0)
+                       return data;
+               data &= (tps->info[dcdc]->table_len - 1);
+               return tps->info[dcdc]->table[data] * 1000;
+       } else
+               return tps->info[dcdc]->min_uV;
+}
+
+static int tps65023_dcdc_set_voltage(struct regulator_dev *dev,
+                               int min_uV, int max_uV)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int dcdc = rdev_get_id(dev);
+       int vsel;
+
+       if (dcdc != TPS65023_DCDC_1)
+               return -EINVAL;
+
+       if (min_uV < tps->info[dcdc]->min_uV
+                       || min_uV > tps->info[dcdc]->max_uV)
+               return -EINVAL;
+       if (max_uV < tps->info[dcdc]->min_uV
+                       || max_uV > tps->info[dcdc]->max_uV)
+               return -EINVAL;
+
+       for (vsel = 0; vsel < tps->info[dcdc]->table_len; vsel++) {
+               int mV = tps->info[dcdc]->table[vsel];
+               int uV = mV * 1000;
+
+               /* Break at the first in-range value */
+               if (min_uV <= uV && uV <= max_uV)
+                       break;
+       }
+
+       /* write to the register in case we found a match */
+       if (vsel == tps->info[dcdc]->table_len)
+               return -EINVAL;
+       else
+               return tps_65023_reg_write(tps, TPS65023_REG_DEF_CORE, vsel);
+}
+
+static int tps65023_ldo_get_voltage(struct regulator_dev *dev)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int data, ldo = rdev_get_id(dev);
+
+       if (ldo < TPS65023_LDO_1 || ldo > TPS65023_LDO_2)
+               return -EINVAL;
+
+       data = tps_65023_reg_read(tps, TPS65023_REG_LDO_CTRL);
+       if (data < 0)
+               return data;
+
+       data >>= (TPS65023_LDO_CTRL_LDOx_SHIFT(ldo - TPS65023_LDO_1));
+       data &= (tps->info[ldo]->table_len - 1);
+       return tps->info[ldo]->table[data] * 1000;
+}
+
+static int tps65023_ldo_set_voltage(struct regulator_dev *dev,
+                               int min_uV, int max_uV)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int data, vsel, ldo = rdev_get_id(dev);
+
+       if (ldo < TPS65023_LDO_1 || ldo > TPS65023_LDO_2)
+               return -EINVAL;
+
+       if (min_uV < tps->info[ldo]->min_uV || min_uV > tps->info[ldo]->max_uV)
+               return -EINVAL;
+       if (max_uV < tps->info[ldo]->min_uV || max_uV > tps->info[ldo]->max_uV)
+               return -EINVAL;
+
+       for (vsel = 0; vsel < tps->info[ldo]->table_len; vsel++) {
+               int mV = tps->info[ldo]->table[vsel];
+               int uV = mV * 1000;
+
+               /* Break at the first in-range value */
+               if (min_uV <= uV && uV <= max_uV)
+                       break;
+       }
+
+       if (vsel == tps->info[ldo]->table_len)
+               return -EINVAL;
+
+       data = tps_65023_reg_read(tps, TPS65023_REG_LDO_CTRL);
+       if (data < 0)
+               return data;
+
+       data &= TPS65023_LDO_CTRL_LDOx_MASK(ldo - TPS65023_LDO_1);
+       data |= (vsel << (TPS65023_LDO_CTRL_LDOx_SHIFT(ldo - TPS65023_LDO_1)));
+       return tps_65023_reg_write(tps, TPS65023_REG_LDO_CTRL, data);
+}
+
+static int tps65023_dcdc_list_voltage(struct regulator_dev *dev,
+                                       unsigned selector)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int dcdc = rdev_get_id(dev);
+
+       if (dcdc < TPS65023_DCDC_1 || dcdc > TPS65023_DCDC_3)
+               return -EINVAL;
+
+       if (dcdc == TPS65023_DCDC_1) {
+               if (selector >= tps->info[dcdc]->table_len)
+                       return -EINVAL;
+               else
+                       return tps->info[dcdc]->table[selector] * 1000;
+       } else
+               return tps->info[dcdc]->min_uV;
+}
+
+static int tps65023_ldo_list_voltage(struct regulator_dev *dev,
+                                       unsigned selector)
+{
+       struct tps_pmic *tps = rdev_get_drvdata(dev);
+       int ldo = rdev_get_id(dev);
+
+       if (ldo < TPS65023_LDO_1 || ldo > TPS65023_LDO_2)
+               return -EINVAL;
+
+       if (selector >= tps->info[ldo]->table_len)
+               return -EINVAL;
+       else
+               return tps->info[ldo]->table[selector] * 1000;
+}
+
+/* Operations permitted on VDCDCx */
+static struct regulator_ops tps65023_dcdc_ops = {
+       .is_enabled = tps65023_dcdc_is_enabled,
+       .enable = tps65023_dcdc_enable,
+       .disable = tps65023_dcdc_disable,
+       .get_voltage = tps65023_dcdc_get_voltage,
+       .set_voltage = tps65023_dcdc_set_voltage,
+       .list_voltage = tps65023_dcdc_list_voltage,
+};
+
+/* Operations permitted on LDOx */
+static struct regulator_ops tps65023_ldo_ops = {
+       .is_enabled = tps65023_ldo_is_enabled,
+       .enable = tps65023_ldo_enable,
+       .disable = tps65023_ldo_disable,
+       .get_voltage = tps65023_ldo_get_voltage,
+       .set_voltage = tps65023_ldo_set_voltage,
+       .list_voltage = tps65023_ldo_list_voltage,
+};
+
+static
+int tps_65023_probe(struct i2c_client *client, const struct i2c_device_id *id)
+{
+       static int desc_id;
+       const struct tps_info *info = (void *)id->driver_data;
+       struct regulator_init_data *init_data;
+       struct regulator_dev *rdev;
+       struct tps_pmic *tps;
+       int i;
+
+       if (!i2c_check_functionality(client->adapter, I2C_FUNC_SMBUS_BYTE_DATA))
+               return -EIO;
+
+       /**
+        * init_data points to array of regulator_init structures
+        * coming from the board-evm file.
+        */
+       init_data = client->dev.platform_data;
+
+       if (!init_data)
+               return -EIO;
+
+       tps = kzalloc(sizeof(*tps), GFP_KERNEL);
+       if (!tps)
+               return -ENOMEM;
+
+       mutex_init(&tps->io_lock);
+
+       /* common for all regulators */
+       tps->client = client;
+
+       for (i = 0; i < TPS65023_NUM_REGULATOR; i++, info++, init_data++) {
+               /* Store regulator specific information */
+               tps->info[i] = info;
+
+               tps->desc[i].name = info->name;
+               tps->desc[i].id = desc_id++;
+               tps->desc[i].n_voltages = num_voltages[i];
+               tps->desc[i].ops = (i > TPS65023_DCDC_3 ?
+                                       &tps65023_ldo_ops : &tps65023_dcdc_ops);
+               tps->desc[i].type = REGULATOR_VOLTAGE;
+               tps->desc[i].owner = THIS_MODULE;
+
+               /* Register the regulators */
+               rdev = regulator_register(&tps->desc[i], &client->dev,
+                                                               init_data, tps);
+               if (IS_ERR(rdev)) {
+                       dev_err(&client->dev, "failed to register %s\n",
+                               id->name);
+
+                       /* Unregister */
+                       while (i)
+                               regulator_unregister(tps->rdev[--i]);
+
+                       tps->client = NULL;
+
+                       /* clear the client data in i2c */
+                       i2c_set_clientdata(client, NULL);
+                       kfree(tps);
+                       return PTR_ERR(rdev);
+               }
+
+               /* Save regulator for cleanup */
+               tps->rdev[i] = rdev;
+       }
+
+       i2c_set_clientdata(client, tps);
+
+       return 0;
+}
+
+/**
+ * tps_65023_remove - TPS65023 driver i2c remove handler
+ * @client: i2c driver client device structure
+ *
+ * Unregister TPS driver as an i2c client device driver
+ */
+static int __devexit tps_65023_remove(struct i2c_client *client)
+{
+       struct tps_pmic *tps = i2c_get_clientdata(client);
+       int i;
+
+       for (i = 0; i < TPS65023_NUM_REGULATOR; i++)
+               regulator_unregister(tps->rdev[i]);
+
+       tps->client = NULL;
+
+       /* clear the client data in i2c */
+       i2c_set_clientdata(client, NULL);
+       kfree(tps);
+
+       return 0;
+}
+
+static const struct tps_info tps65023_regs[] = {
+       {
+               .name = "VDCDC1",
+               .min_uV =  800000,
+               .max_uV = 1600000,
+               .table_len = ARRAY_SIZE(VDCDC1_VSEL_table),
+               .table = VDCDC1_VSEL_table,
+       },
+       {
+               .name = "VDCDC2",
+               .min_uV =  3300000,
+               .max_uV = 3300000,
+               .fixed = 1,
+       },
+       {
+               .name = "VDCDC3",
+               .min_uV =  1800000,
+               .max_uV = 1800000,
+               .fixed = 1,
+       },
+       {
+               .name = "LDO1",
+               .min_uV = 1000000,
+               .max_uV = 3150000,
+               .table_len = ARRAY_SIZE(LDO1_VSEL_table),
+               .table = LDO1_VSEL_table,
+       },
+       {
+               .name = "LDO2",
+               .min_uV = 1050000,
+               .max_uV = 3300000,
+               .table_len = ARRAY_SIZE(LDO2_VSEL_table),
+               .table = LDO2_VSEL_table,
+       },
+};
+
+static const struct i2c_device_id tps_65023_id = {
+       .name = "tps65023",
+       .driver_data = (unsigned long) &tps65023_regs[0],
+};
+
+MODULE_DEVICE_TABLE(i2c, tps_65023_id);
+
+static struct i2c_driver tps_65023_i2c_driver = {
+       .driver = {
+               .name = "tps65023",
+               .owner = THIS_MODULE,
+       },
+       .probe = tps_65023_probe,
+       .remove = __devexit_p(tps_65023_remove),
+       .id_table = &tps_65023_id,
+};
+
+/**
+ * tps_65023_init
+ *
+ * Module init function
+ */
+static int __init tps_65023_init(void)
+{
+       return i2c_add_driver(&tps_65023_i2c_driver);
+}
+subsys_initcall(tps_65023_init);
+
+/**
+ * tps_65023_cleanup
+ *
+ * Module exit function
+ */
+static void __exit tps_65023_cleanup(void)
+{
+       i2c_del_driver(&tps_65023_i2c_driver);
+}
+module_exit(tps_65023_cleanup);
+
+MODULE_AUTHOR("Texas Instruments");
+MODULE_DESCRIPTION("TPS65023 voltage regulator driver");
+MODULE_LICENSE("GPLv2");