drivers/regulator/max1586.c

   1 /*
   2  * max1586.c  --  Voltage and current regulation for the Maxim 1586
   3  *
   4  * Copyright (C) 2008 Robert Jarzmik
   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  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20 #include <linux/module.h>
  21 #include <linux/err.h>
  22 #include <linux/i2c.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/regulator/driver.h>
  25 #include <linux/slab.h>
  26 #include <linux/regulator/max1586.h>
  27
  28 #define MAX1586_V3_MAX_VSEL 31
  29 #define MAX1586_V6_MAX_VSEL 3
  30
  31 #define MAX1586_V3_MIN_UV   700000
  32 #define MAX1586_V3_MAX_UV  1475000
  33
  34 #define MAX1586_V6_MIN_UV        0
  35 #define MAX1586_V6_MAX_UV  3000000
  36
  37 #define I2C_V3_SELECT (0 << 5)
  38 #define I2C_V6_SELECT (1 << 5)
  39
  40 struct max1586_data {
  41         struct i2c_client *client;
  42
  43         /* min/max V3 voltage */
  44         unsigned int min_uV;
  45         unsigned int max_uV;
  46
  47         struct regulator_dev *rdev[0];
  48 };
  49
  50 /*
  51  * V6 voltage
  52  * On I2C bus, sending a "x" byte to the max1586 means :
  53  *   set V6 to either 0V, 1.8V, 2.5V, 3V depending on (x & 0x3)
  54  * As regulator framework doesn't accept voltages to be 0V, we use 1uV.
  55  */
  56 static int v6_voltages_uv[] = { 1, 1800000, 2500000, 3000000 };
  57
  58 /*
  59  * V3 voltage
  60  * On I2C bus, sending a "x" byte to the max1586 means :
  61  *   set V3 to 0.700V + (x & 0x1f) * 0.025V
  62  * This voltage can be increased by external resistors
  63  * R24 and R25=100kOhm as described in the data sheet.
  64  * The gain is approximately: 1 + R24/R25 + R24/185.5kOhm
  65  */
  66 static int max1586_v3_set(struct regulator_dev *rdev, int min_uV, int max_uV,
  67                           unsigned *selector)
  68 {
  69         struct max1586_data *max1586 = rdev_get_drvdata(rdev);
  70         struct i2c_client *client = max1586->client;
  71         unsigned range_uV = max1586->max_uV - max1586->min_uV;
  72         u8 v3_prog;
  73
  74         if (min_uV > max1586->max_uV || max_uV < max1586->min_uV)
  75                 return -EINVAL;
  76         if (min_uV < max1586->min_uV)
  77                 min_uV = max1586->min_uV;
  78
  79         *selector = DIV_ROUND_UP((min_uV - max1586->min_uV) *
  80                                  MAX1586_V3_MAX_VSEL, range_uV);
  81         if (regulator_list_voltage_linear(rdev, *selector) > max_uV)
  82                 return -EINVAL;
  83
  84         dev_dbg(&client->dev, "changing voltage v3 to %dmv\n",
  85                 regulator_list_voltage_linear(rdev, *selector) / 1000);
  86
  87         v3_prog = I2C_V3_SELECT | (u8) *selector;
  88         return i2c_smbus_write_byte(client, v3_prog);
  89 }
  90
  91 static int max1586_v6_set_voltage_sel(struct regulator_dev *rdev,
  92                                       unsigned int selector)
  93 {
  94         struct i2c_client *client = rdev_get_drvdata(rdev);
  95         u8 v6_prog;
  96
  97         dev_dbg(&client->dev, "changing voltage v6 to %dmv\n",
  98                 rdev->desc->volt_table[selector] / 1000);
  99
 100         v6_prog = I2C_V6_SELECT | (u8) selector;
 101         return i2c_smbus_write_byte(client, v6_prog);
 102 }
 103
 104 /*
 105  * The Maxim 1586 controls V3 and V6 voltages, but offers no way of reading back
 106  * the set up value.
 107  */
 108 static struct regulator_ops max1586_v3_ops = {
 109         .set_voltage = max1586_v3_set,
 110         .list_voltage = regulator_list_voltage_linear,
 111 };
 112
 113 static struct regulator_ops max1586_v6_ops = {
 114         .set_voltage_sel = max1586_v6_set_voltage_sel,
 115         .list_voltage = regulator_list_voltage_table,
 116 };
 117
 118 static struct regulator_desc max1586_reg[] = {
 119         {
 120                 .name = "Output_V3",
 121                 .id = MAX1586_V3,
 122                 .ops = &max1586_v3_ops,
 123                 .type = REGULATOR_VOLTAGE,
 124                 .n_voltages = MAX1586_V3_MAX_VSEL + 1,
 125                 .owner = THIS_MODULE,
 126         },
 127         {
 128                 .name = "Output_V6",
 129                 .id = MAX1586_V6,
 130                 .ops = &max1586_v6_ops,
 131                 .type = REGULATOR_VOLTAGE,
 132                 .n_voltages = MAX1586_V6_MAX_VSEL + 1,
 133                 .volt_table = v6_voltages_uv,
 134                 .owner = THIS_MODULE,
 135         },
 136 };
 137
 138 static int __devinit max1586_pmic_probe(struct i2c_client *client,
 139                                         const struct i2c_device_id *i2c_id)
 140 {
 141         struct regulator_dev **rdev;
 142         struct max1586_platform_data *pdata = client->dev.platform_data;
 143         struct regulator_config config = { };
 144         struct max1586_data *max1586;
 145         int i, id, ret = -ENOMEM;
 146
 147         max1586 = devm_kzalloc(&client->dev, sizeof(struct max1586_data) +
 148                         sizeof(struct regulator_dev *) * (MAX1586_V6 + 1),
 149                         GFP_KERNEL);
 150         if (!max1586)
 151                 return -ENOMEM;
 152
 153         max1586->client = client;
 154
 155         if (!pdata->v3_gain)
 156                 return -EINVAL;
 157
 158         max1586->min_uV = MAX1586_V3_MIN_UV / 1000 * pdata->v3_gain / 1000;
 159         max1586->max_uV = MAX1586_V3_MAX_UV / 1000 * pdata->v3_gain / 1000;
 160
 161         rdev = max1586->rdev;
 162         for (i = 0; i < pdata->num_subdevs && i <= MAX1586_V6; i++) {
 163                 id = pdata->subdevs[i].id;
 164                 if (!pdata->subdevs[i].platform_data)
 165                         continue;
 166                 if (id < MAX1586_V3 || id > MAX1586_V6) {
 167                         dev_err(&client->dev, "invalid regulator id %d\n", id);
 168                         goto err;
 169                 }
 170
 171                 if (id == MAX1586_V3) {
 172                         max1586_reg[id].min_uV = max1586->min_uV;
 173                         max1586_reg[id].uV_step =
 174                                         (max1586->max_uV - max1586->min_uV) /
 175                                         MAX1586_V3_MAX_VSEL;
 176                 }
 177
 178                 config.dev = &client->dev;
 179                 config.init_data = pdata->subdevs[i].platform_data;
 180                 config.driver_data = max1586;
 181
 182                 rdev[i] = regulator_register(&max1586_reg[id], &config);
 183                 if (IS_ERR(rdev[i])) {
 184                         ret = PTR_ERR(rdev[i]);
 185                         dev_err(&client->dev, "failed to register %s\n",
 186                                 max1586_reg[id].name);
 187                         goto err;
 188                 }
 189         }
 190
 191         i2c_set_clientdata(client, max1586);
 192         dev_info(&client->dev, "Maxim 1586 regulator driver loaded\n");
 193         return 0;
 194
 195 err:
 196         while (--i >= 0)
 197                 regulator_unregister(rdev[i]);
 198         return ret;
 199 }
 200
 201 static int __devexit max1586_pmic_remove(struct i2c_client *client)
 202 {
 203         struct max1586_data *max1586 = i2c_get_clientdata(client);
 204         int i;
 205
 206         for (i = 0; i <= MAX1586_V6; i++)
 207                 if (max1586->rdev[i])
 208                         regulator_unregister(max1586->rdev[i]);
 209         return 0;
 210 }
 211
 212 static const struct i2c_device_id max1586_id[] = {
 213         { "max1586", 0 },
 214         { }
 215 };
 216 MODULE_DEVICE_TABLE(i2c, max1586_id);
 217
 218 static struct i2c_driver max1586_pmic_driver = {
 219         .probe = max1586_pmic_probe,
 220         .remove = __devexit_p(max1586_pmic_remove),
 221         .driver         = {
 222                 .name   = "max1586",
 223                 .owner  = THIS_MODULE,
 224         },
 225         .id_table       = max1586_id,
 226 };
 227
 228 static int __init max1586_pmic_init(void)
 229 {
 230         return i2c_add_driver(&max1586_pmic_driver);
 231 }
 232 subsys_initcall(max1586_pmic_init);
 233
 234 static void __exit max1586_pmic_exit(void)
 235 {
 236         i2c_del_driver(&max1586_pmic_driver);
 237 }
 238 module_exit(max1586_pmic_exit);
 239
 240 /* Module information */
 241 MODULE_DESCRIPTION("MAXIM 1586 voltage regulator driver");
 242 MODULE_AUTHOR("Robert Jarzmik");
 243 MODULE_LICENSE("GPL");