drivers/regulator/max8997.c

   1 /*
   2  * max8997.c - Regulator driver for the Maxim 8997/8966
   3  *
   4  * Copyright (C) 2011 Samsung Electronics
   5  * MyungJoo Ham <myungjoo.ham@smasung.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  * This driver is based on max8998.c
  22  */
  23
  24 #include <linux/bug.h>
  25 #include <linux/delay.h>
  26 #include <linux/err.h>
  27 #include <linux/gpio.h>
  28 #include <linux/slab.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/regulator/driver.h>
  31 #include <linux/regulator/machine.h>
  32 #include <linux/mfd/max8997.h>
  33 #include <linux/mfd/max8997-private.h>
  34
  35 struct max8997_data {
  36         struct device *dev;
  37         struct max8997_dev *iodev;
  38         int num_regulators;
  39         struct regulator_dev **rdev;
  40         int ramp_delay; /* in mV/us */
  41
  42         bool buck1_gpiodvs;
  43         bool buck2_gpiodvs;
  44         bool buck5_gpiodvs;
  45         u8 buck1_vol[8];
  46         u8 buck2_vol[8];
  47         u8 buck5_vol[8];
  48         int buck125_gpios[3];
  49         int buck125_gpioindex;
  50         bool ignore_gpiodvs_side_effect;
  51
  52         u8 saved_states[MAX8997_REG_MAX];
  53 };
  54
  55 static inline void max8997_set_gpio(struct max8997_data *max8997)
  56 {
  57         int set3 = (max8997->buck125_gpioindex) & 0x1;
  58         int set2 = ((max8997->buck125_gpioindex) >> 1) & 0x1;
  59         int set1 = ((max8997->buck125_gpioindex) >> 2) & 0x1;
  60
  61         gpio_set_value(max8997->buck125_gpios[0], set1);
  62         gpio_set_value(max8997->buck125_gpios[1], set2);
  63         gpio_set_value(max8997->buck125_gpios[2], set3);
  64 }
  65
  66 struct voltage_map_desc {
  67         int min;
  68         int max;
  69         int step;
  70         unsigned int n_bits;
  71 };
  72
  73 /* Voltage maps in mV */
  74 static const struct voltage_map_desc ldo_voltage_map_desc = {
  75         .min = 800,     .max = 3950,    .step = 50,     .n_bits = 6,
  76 }; /* LDO1 ~ 18, 21 all */
  77
  78 static const struct voltage_map_desc buck1245_voltage_map_desc = {
  79         .min = 650,     .max = 2225,    .step = 25,     .n_bits = 6,
  80 }; /* Buck1, 2, 4, 5 */
  81
  82 static const struct voltage_map_desc buck37_voltage_map_desc = {
  83         .min = 750,     .max = 3900,    .step = 50,     .n_bits = 6,
  84 }; /* Buck3, 7 */
  85
  86 /* current map in mA */
  87 static const struct voltage_map_desc charger_current_map_desc = {
  88         .min = 200,     .max = 950,     .step = 50,     .n_bits = 4,
  89 };
  90
  91 static const struct voltage_map_desc topoff_current_map_desc = {
  92         .min = 50,      .max = 200,     .step = 10,     .n_bits = 4,
  93 };
  94
  95 static const struct voltage_map_desc *reg_voltage_map[] = {
  96         [MAX8997_LDO1] = &ldo_voltage_map_desc,
  97         [MAX8997_LDO2] = &ldo_voltage_map_desc,
  98         [MAX8997_LDO3] = &ldo_voltage_map_desc,
  99         [MAX8997_LDO4] = &ldo_voltage_map_desc,
 100         [MAX8997_LDO5] = &ldo_voltage_map_desc,
 101         [MAX8997_LDO6] = &ldo_voltage_map_desc,
 102         [MAX8997_LDO7] = &ldo_voltage_map_desc,
 103         [MAX8997_LDO8] = &ldo_voltage_map_desc,
 104         [MAX8997_LDO9] = &ldo_voltage_map_desc,
 105         [MAX8997_LDO10] = &ldo_voltage_map_desc,
 106         [MAX8997_LDO11] = &ldo_voltage_map_desc,
 107         [MAX8997_LDO12] = &ldo_voltage_map_desc,
 108         [MAX8997_LDO13] = &ldo_voltage_map_desc,
 109         [MAX8997_LDO14] = &ldo_voltage_map_desc,
 110         [MAX8997_LDO15] = &ldo_voltage_map_desc,
 111         [MAX8997_LDO16] = &ldo_voltage_map_desc,
 112         [MAX8997_LDO17] = &ldo_voltage_map_desc,
 113         [MAX8997_LDO18] = &ldo_voltage_map_desc,
 114         [MAX8997_LDO21] = &ldo_voltage_map_desc,
 115         [MAX8997_BUCK1] = &buck1245_voltage_map_desc,
 116         [MAX8997_BUCK2] = &buck1245_voltage_map_desc,
 117         [MAX8997_BUCK3] = &buck37_voltage_map_desc,
 118         [MAX8997_BUCK4] = &buck1245_voltage_map_desc,
 119         [MAX8997_BUCK5] = &buck1245_voltage_map_desc,
 120         [MAX8997_BUCK6] = NULL,
 121         [MAX8997_BUCK7] = &buck37_voltage_map_desc,
 122         [MAX8997_EN32KHZ_AP] = NULL,
 123         [MAX8997_EN32KHZ_CP] = NULL,
 124         [MAX8997_ENVICHG] = NULL,
 125         [MAX8997_ESAFEOUT1] = NULL,
 126         [MAX8997_ESAFEOUT2] = NULL,
 127         [MAX8997_CHARGER_CV] = NULL,
 128         [MAX8997_CHARGER] = &charger_current_map_desc,
 129         [MAX8997_CHARGER_TOPOFF] = &topoff_current_map_desc,
 130 };
 131
 132 static inline int max8997_get_rid(struct regulator_dev *rdev)
 133 {
 134         return rdev_get_id(rdev);
 135 }
 136
 137 static int max8997_list_voltage_safeout(struct regulator_dev *rdev,
 138                 unsigned int selector)
 139 {
 140         int rid = max8997_get_rid(rdev);
 141
 142         if (rid == MAX8997_ESAFEOUT1 || rid == MAX8997_ESAFEOUT2) {
 143                 switch (selector) {
 144                 case 0:
 145                         return 4850000;
 146                 case 1:
 147                         return 4900000;
 148                 case 2:
 149                         return 4950000;
 150                 case 3:
 151                         return 3300000;
 152                 default:
 153                         return -EINVAL;
 154                 }
 155         }
 156
 157         return -EINVAL;
 158 }
 159
 160 static int max8997_list_voltage_charger_cv(struct regulator_dev *rdev,
 161                 unsigned int selector)
 162 {
 163         int rid = max8997_get_rid(rdev);
 164
 165         if (rid != MAX8997_CHARGER_CV)
 166                 goto err;
 167
 168         switch (selector) {
 169         case 0x00:
 170                 return 4200000;
 171         case 0x01 ... 0x0E:
 172                 return 4000000 + 20000 * (selector - 0x01);
 173         case 0x0F:
 174                 return 4350000;
 175         default:
 176                 return -EINVAL;
 177         }
 178 err:
 179         return -EINVAL;
 180 }
 181
 182 static int max8997_list_voltage(struct regulator_dev *rdev,
 183                 unsigned int selector)
 184 {
 185         const struct voltage_map_desc *desc;
 186         int rid = max8997_get_rid(rdev);
 187         int val;
 188
 189         if (rid >= ARRAY_SIZE(reg_voltage_map) ||
 190                         rid < 0)
 191                 return -EINVAL;
 192
 193         desc = reg_voltage_map[rid];
 194         if (desc == NULL)
 195                 return -EINVAL;
 196
 197         val = desc->min + desc->step * selector;
 198         if (val > desc->max)
 199                 return -EINVAL;
 200
 201         return val * 1000;
 202 }
 203
 204 static int max8997_get_enable_register(struct regulator_dev *rdev,
 205                 int *reg, int *mask, int *pattern)
 206 {
 207         int rid = max8997_get_rid(rdev);
 208
 209         switch (rid) {
 210         case MAX8997_LDO1 ... MAX8997_LDO21:
 211                 *reg = MAX8997_REG_LDO1CTRL + (rid - MAX8997_LDO1);
 212                 *mask = 0xC0;
 213                 *pattern = 0xC0;
 214                 break;
 215         case MAX8997_BUCK1:
 216                 *reg = MAX8997_REG_BUCK1CTRL;
 217                 *mask = 0x01;
 218                 *pattern = 0x01;
 219                 break;
 220         case MAX8997_BUCK2:
 221                 *reg = MAX8997_REG_BUCK2CTRL;
 222                 *mask = 0x01;
 223                 *pattern = 0x01;
 224                 break;
 225         case MAX8997_BUCK3:
 226                 *reg = MAX8997_REG_BUCK3CTRL;
 227                 *mask = 0x01;
 228                 *pattern = 0x01;
 229                 break;
 230         case MAX8997_BUCK4:
 231                 *reg = MAX8997_REG_BUCK4CTRL;
 232                 *mask = 0x01;
 233                 *pattern = 0x01;
 234                 break;
 235         case MAX8997_BUCK5:
 236                 *reg = MAX8997_REG_BUCK5CTRL;
 237                 *mask = 0x01;
 238                 *pattern = 0x01;
 239                 break;
 240         case MAX8997_BUCK6:
 241                 *reg = MAX8997_REG_BUCK6CTRL;
 242                 *mask = 0x01;
 243                 *pattern = 0x01;
 244                 break;
 245         case MAX8997_BUCK7:
 246                 *reg = MAX8997_REG_BUCK7CTRL;
 247                 *mask = 0x01;
 248                 *pattern = 0x01;
 249                 break;
 250         case MAX8997_EN32KHZ_AP ... MAX8997_EN32KHZ_CP:
 251                 *reg = MAX8997_REG_MAINCON1;
 252                 *mask = 0x01 << (rid - MAX8997_EN32KHZ_AP);
 253                 *pattern = 0x01 << (rid - MAX8997_EN32KHZ_AP);
 254                 break;
 255         case MAX8997_ENVICHG:
 256                 *reg = MAX8997_REG_MBCCTRL1;
 257                 *mask = 0x80;
 258                 *pattern = 0x80;
 259                 break;
 260         case MAX8997_ESAFEOUT1 ... MAX8997_ESAFEOUT2:
 261                 *reg = MAX8997_REG_SAFEOUTCTRL;
 262                 *mask = 0x40 << (rid - MAX8997_ESAFEOUT1);
 263                 *pattern = 0x40 << (rid - MAX8997_ESAFEOUT1);
 264                 break;
 265         case MAX8997_CHARGER:
 266                 *reg = MAX8997_REG_MBCCTRL2;
 267                 *mask = 0x40;
 268                 *pattern = 0x40;
 269                 break;
 270         default:
 271                 /* Not controllable or not exists */
 272                 return -EINVAL;
 273         }
 274
 275         return 0;
 276 }
 277
 278 static int max8997_reg_is_enabled(struct regulator_dev *rdev)
 279 {
 280         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 281         struct i2c_client *i2c = max8997->iodev->i2c;
 282         int ret, reg, mask, pattern;
 283         u8 val;
 284
 285         ret = max8997_get_enable_register(rdev, &reg, &mask, &pattern);
 286         if (ret == -EINVAL)
 287                 return 1; /* "not controllable" */
 288         else if (ret)
 289                 return ret;
 290
 291         ret = max8997_read_reg(i2c, reg, &val);
 292         if (ret)
 293                 return ret;
 294
 295         return (val & mask) == pattern;
 296 }
 297
 298 static int max8997_reg_enable(struct regulator_dev *rdev)
 299 {
 300         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 301         struct i2c_client *i2c = max8997->iodev->i2c;
 302         int ret, reg, mask, pattern;
 303
 304         ret = max8997_get_enable_register(rdev, &reg, &mask, &pattern);
 305         if (ret)
 306                 return ret;
 307
 308         return max8997_update_reg(i2c, reg, pattern, mask);
 309 }
 310
 311 static int max8997_reg_disable(struct regulator_dev *rdev)
 312 {
 313         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 314         struct i2c_client *i2c = max8997->iodev->i2c;
 315         int ret, reg, mask, pattern;
 316
 317         ret = max8997_get_enable_register(rdev, &reg, &mask, &pattern);
 318         if (ret)
 319                 return ret;
 320
 321         return max8997_update_reg(i2c, reg, ~pattern, mask);
 322 }
 323
 324 static int max8997_get_voltage_register(struct regulator_dev *rdev,
 325                 int *_reg, int *_shift, int *_mask)
 326 {
 327         int rid = max8997_get_rid(rdev);
 328         int reg, shift = 0, mask = 0x3f;
 329
 330         switch (rid) {
 331         case MAX8997_LDO1 ... MAX8997_LDO21:
 332                 reg = MAX8997_REG_LDO1CTRL + (rid - MAX8997_LDO1);
 333                 break;
 334         case MAX8997_BUCK1:
 335                 reg = MAX8997_REG_BUCK1DVS1;
 336                 break;
 337         case MAX8997_BUCK2:
 338                 reg = MAX8997_REG_BUCK2DVS1;
 339                 break;
 340         case MAX8997_BUCK3:
 341                 reg = MAX8997_REG_BUCK3DVS;
 342                 break;
 343         case MAX8997_BUCK4:
 344                 reg = MAX8997_REG_BUCK4DVS;
 345                 break;
 346         case MAX8997_BUCK5:
 347                 reg = MAX8997_REG_BUCK5DVS1;
 348                 break;
 349         case MAX8997_BUCK7:
 350                 reg = MAX8997_REG_BUCK7DVS;
 351                 break;
 352         case MAX8997_ESAFEOUT1 ...  MAX8997_ESAFEOUT2:
 353                 reg = MAX8997_REG_SAFEOUTCTRL;
 354                 shift = (rid == MAX8997_ESAFEOUT2) ? 2 : 0;
 355                 mask = 0x3;
 356                 break;
 357         case MAX8997_CHARGER_CV:
 358                 reg = MAX8997_REG_MBCCTRL3;
 359                 shift = 0;
 360                 mask = 0xf;
 361                 break;
 362         case MAX8997_CHARGER:
 363                 reg = MAX8997_REG_MBCCTRL4;
 364                 shift = 0;
 365                 mask = 0xf;
 366                 break;
 367         case MAX8997_CHARGER_TOPOFF:
 368                 reg = MAX8997_REG_MBCCTRL5;
 369                 shift = 0;
 370                 mask = 0xf;
 371                 break;
 372         default:
 373                 return -EINVAL;
 374         }
 375
 376         *_reg = reg;
 377         *_shift = shift;
 378         *_mask = mask;
 379
 380         return 0;
 381 }
 382
 383 static int max8997_get_voltage(struct regulator_dev *rdev)
 384 {
 385         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 386         struct i2c_client *i2c = max8997->iodev->i2c;
 387         int reg, shift, mask, ret;
 388         int rid = max8997_get_rid(rdev);
 389         u8 val;
 390
 391         ret = max8997_get_voltage_register(rdev, &reg, &shift, &mask);
 392         if (ret)
 393                 return ret;
 394
 395         if ((rid == MAX8997_BUCK1 && max8997->buck1_gpiodvs) ||
 396                         (rid == MAX8997_BUCK2 && max8997->buck2_gpiodvs) ||
 397                         (rid == MAX8997_BUCK5 && max8997->buck5_gpiodvs))
 398                 reg += max8997->buck125_gpioindex;
 399
 400         ret = max8997_read_reg(i2c, reg, &val);
 401         if (ret)
 402                 return ret;
 403
 404         val >>= shift;
 405         val &= mask;
 406
 407         if (rdev->desc && rdev->desc->ops && rdev->desc->ops->list_voltage)
 408                 return rdev->desc->ops->list_voltage(rdev, val);
 409
 410         /*
 411          * max8997_list_voltage returns value for any rdev with voltage_map,
 412          * which works for "CHARGER" and "CHARGER TOPOFF" that do not have
 413          * list_voltage ops (they are current regulators).
 414          */
 415         return max8997_list_voltage(rdev, val);
 416 }
 417
 418 static inline int max8997_get_voltage_proper_val(
 419                 const struct voltage_map_desc *desc,
 420                 int min_vol, int max_vol)
 421 {
 422         int i = 0;
 423
 424         if (desc == NULL)
 425                 return -EINVAL;
 426
 427         if (max_vol < desc->min || min_vol > desc->max)
 428                 return -EINVAL;
 429
 430         while (desc->min + desc->step * i < min_vol &&
 431                         desc->min + desc->step * i < desc->max)
 432                 i++;
 433
 434         if (desc->min + desc->step * i > max_vol)
 435                 return -EINVAL;
 436
 437         if (i >= (1 << desc->n_bits))
 438                 return -EINVAL;
 439
 440         return i;
 441 }
 442
 443 static int max8997_set_voltage_charger_cv(struct regulator_dev *rdev,
 444                 int min_uV, int max_uV, unsigned *selector)
 445 {
 446         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 447         struct i2c_client *i2c = max8997->iodev->i2c;
 448         int rid = max8997_get_rid(rdev);
 449         int lb, ub;
 450         int reg, shift = 0, mask, ret = 0;
 451         u8 val = 0x0;
 452
 453         if (rid != MAX8997_CHARGER_CV)
 454                 return -EINVAL;
 455
 456         ret = max8997_get_voltage_register(rdev, &reg, &shift, &mask);
 457         if (ret)
 458                 return ret;
 459
 460         if (max_uV < 4000000 || min_uV > 4350000)
 461                 return -EINVAL;
 462
 463         if (min_uV <= 4000000) {
 464                 if (max_uV >= 4000000)
 465                         return -EINVAL;
 466                 else
 467                         val = 0x1;
 468         } else if (min_uV <= 4200000 && max_uV >= 4200000)
 469                 val = 0x0;
 470         else {
 471                 lb = (min_uV - 4000001) / 20000 + 2;
 472                 ub = (max_uV - 4000000) / 20000 + 1;
 473
 474                 if (lb > ub)
 475                         return -EINVAL;
 476
 477                 if (lb < 0xf)
 478                         val = lb;
 479                 else {
 480                         if (ub >= 0xf)
 481                                 val = 0xf;
 482                         else
 483                                 return -EINVAL;
 484                 }
 485         }
 486
 487         *selector = val;
 488
 489         ret = max8997_update_reg(i2c, reg, val << shift, mask);
 490
 491         return ret;
 492 }
 493
 494 /*
 495  * For LDO1 ~ LDO21, BUCK1~5, BUCK7, CHARGER, CHARGER_TOPOFF
 496  * BUCK1, 2, and 5 are available if they are not controlled by gpio
 497  */
 498 static int max8997_set_voltage_ldobuck(struct regulator_dev *rdev,
 499                 int min_uV, int max_uV, unsigned *selector)
 500 {
 501         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 502         struct i2c_client *i2c = max8997->iodev->i2c;
 503         int min_vol = min_uV / 1000, max_vol = max_uV / 1000;
 504         const struct voltage_map_desc *desc;
 505         int rid = max8997_get_rid(rdev);
 506         int reg, shift = 0, mask, ret;
 507         int i;
 508         u8 org;
 509
 510         switch (rid) {
 511         case MAX8997_LDO1 ... MAX8997_LDO21:
 512                 break;
 513         case MAX8997_BUCK1 ... MAX8997_BUCK5:
 514                 break;
 515         case MAX8997_BUCK6:
 516                 return -EINVAL;
 517         case MAX8997_BUCK7:
 518                 break;
 519         case MAX8997_CHARGER:
 520                 break;
 521         case MAX8997_CHARGER_TOPOFF:
 522                 break;
 523         default:
 524                 return -EINVAL;
 525         }
 526
 527         desc = reg_voltage_map[rid];
 528
 529         i = max8997_get_voltage_proper_val(desc, min_vol, max_vol);
 530         if (i < 0)
 531                 return i;
 532
 533         ret = max8997_get_voltage_register(rdev, &reg, &shift, &mask);
 534         if (ret)
 535                 return ret;
 536
 537         max8997_read_reg(i2c, reg, &org);
 538         org = (org & mask) >> shift;
 539
 540         ret = max8997_update_reg(i2c, reg, i << shift, mask << shift);
 541         *selector = i;
 542
 543         if (rid == MAX8997_BUCK1 || rid == MAX8997_BUCK2 ||
 544                         rid == MAX8997_BUCK4 || rid == MAX8997_BUCK5) {
 545                 /* If the voltage is increasing */
 546                 if (org < i)
 547                         udelay(desc->step * (i - org) / max8997->ramp_delay);
 548         }
 549
 550         return ret;
 551 }
 552
 553 /*
 554  * Assess the damage on the voltage setting of BUCK1,2,5 by the change.
 555  *
 556  * When GPIO-DVS mode is used for multiple bucks, changing the voltage value
 557  * of one of the bucks may affect that of another buck, which is the side
 558  * effect of the change (set_voltage). This function examines the GPIO-DVS
 559  * configurations and checks whether such side-effect exists.
 560  */
 561 static int max8997_assess_side_effect(struct regulator_dev *rdev,
 562                 u8 new_val, int *best)
 563 {
 564         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 565         int rid = max8997_get_rid(rdev);
 566         u8 *buckx_val[3];
 567         bool buckx_gpiodvs[3];
 568         int side_effect[8];
 569         int min_side_effect = INT_MAX;
 570         int i;
 571
 572         *best = -1;
 573
 574         switch (rid) {
 575         case MAX8997_BUCK1:
 576                 rid = 0;
 577                 break;
 578         case MAX8997_BUCK2:
 579                 rid = 1;
 580                 break;
 581         case MAX8997_BUCK5:
 582                 rid = 2;
 583                 break;
 584         default:
 585                 return -EINVAL;
 586         }
 587
 588         buckx_val[0] = max8997->buck1_vol;
 589         buckx_val[1] = max8997->buck2_vol;
 590         buckx_val[2] = max8997->buck5_vol;
 591         buckx_gpiodvs[0] = max8997->buck1_gpiodvs;
 592         buckx_gpiodvs[1] = max8997->buck2_gpiodvs;
 593         buckx_gpiodvs[2] = max8997->buck5_gpiodvs;
 594
 595         for (i = 0; i < 8; i++) {
 596                 int others;
 597
 598                 if (new_val != (buckx_val[rid])[i]) {
 599                         side_effect[i] = -1;
 600                         continue;
 601                 }
 602
 603                 side_effect[i] = 0;
 604                 for (others = 0; others < 3; others++) {
 605                         int diff;
 606
 607                         if (others == rid)
 608                                 continue;
 609                         if (buckx_gpiodvs[others] == false)
 610                                 continue; /* Not affected */
 611                         diff = (buckx_val[others])[i] -
 612                                 (buckx_val[others])[max8997->buck125_gpioindex];
 613                         if (diff > 0)
 614                                 side_effect[i] += diff;
 615                         else if (diff < 0)
 616                                 side_effect[i] -= diff;
 617                 }
 618                 if (side_effect[i] == 0) {
 619                         *best = i;
 620                         return 0; /* NO SIDE EFFECT! Use This! */
 621                 }
 622                 if (side_effect[i] < min_side_effect) {
 623                         min_side_effect = side_effect[i];
 624                         *best = i;
 625                 }
 626         }
 627
 628         if (*best == -1)
 629                 return -EINVAL;
 630
 631         return side_effect[*best];
 632 }
 633
 634 /*
 635  * For Buck 1 ~ 5 and 7. If it is not controlled by GPIO, this calls
 636  * max8997_set_voltage_ldobuck to do the job.
 637  */
 638 static int max8997_set_voltage_buck(struct regulator_dev *rdev,
 639                 int min_uV, int max_uV, unsigned *selector)
 640 {
 641         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 642         int rid = max8997_get_rid(rdev);
 643         const struct voltage_map_desc *desc;
 644         int new_val, new_idx, damage, tmp_val, tmp_idx, tmp_dmg;
 645         bool gpio_dvs_mode = false;
 646         int min_vol = min_uV / 1000, max_vol = max_uV / 1000;
 647
 648         if (rid < MAX8997_BUCK1 || rid > MAX8997_BUCK7)
 649                 return -EINVAL;
 650
 651         switch (rid) {
 652         case MAX8997_BUCK1:
 653                 if (max8997->buck1_gpiodvs)
 654                         gpio_dvs_mode = true;
 655                 break;
 656         case MAX8997_BUCK2:
 657                 if (max8997->buck2_gpiodvs)
 658                         gpio_dvs_mode = true;
 659                 break;
 660         case MAX8997_BUCK5:
 661                 if (max8997->buck5_gpiodvs)
 662                         gpio_dvs_mode = true;
 663                 break;
 664         }
 665
 666         if (!gpio_dvs_mode)
 667                 return max8997_set_voltage_ldobuck(rdev, min_uV, max_uV,
 668                                                 selector);
 669
 670         desc = reg_voltage_map[rid];
 671         new_val = max8997_get_voltage_proper_val(desc, min_vol, max_vol);
 672         if (new_val < 0)
 673                 return new_val;
 674
 675         tmp_dmg = INT_MAX;
 676         tmp_idx = -1;
 677         tmp_val = -1;
 678         do {
 679                 damage = max8997_assess_side_effect(rdev, new_val, &new_idx);
 680                 if (damage == 0)
 681                         goto out;
 682
 683                 if (tmp_dmg > damage) {
 684                         tmp_idx = new_idx;
 685                         tmp_val = new_val;
 686                         tmp_dmg = damage;
 687                 }
 688
 689                 new_val++;
 690         } while (desc->min + desc->step + new_val <= desc->max);
 691
 692         new_idx = tmp_idx;
 693         new_val = tmp_val;
 694
 695         if (max8997->ignore_gpiodvs_side_effect == false)
 696                 return -EINVAL;
 697
 698         dev_warn(&rdev->dev, "MAX8997 GPIO-DVS Side Effect Warning: GPIO SET:"
 699                         " %d -> %d\n", max8997->buck125_gpioindex, tmp_idx);
 700
 701 out:
 702         if (new_idx < 0 || new_val < 0)
 703                 return -EINVAL;
 704
 705         max8997->buck125_gpioindex = new_idx;
 706         max8997_set_gpio(max8997);
 707         *selector = new_val;
 708
 709         return 0;
 710 }
 711
 712 static const int safeoutvolt[] = {
 713         3300000,
 714         4850000,
 715         4900000,
 716         4950000,
 717 };
 718
 719 /* For SAFEOUT1 and SAFEOUT2 */
 720 static int max8997_set_voltage_safeout(struct regulator_dev *rdev,
 721                 int min_uV, int max_uV, unsigned *selector)
 722 {
 723         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 724         struct i2c_client *i2c = max8997->iodev->i2c;
 725         int rid = max8997_get_rid(rdev);
 726         int reg, shift = 0, mask, ret;
 727         int i = 0;
 728         u8 val;
 729
 730         if (rid != MAX8997_ESAFEOUT1 && rid != MAX8997_ESAFEOUT2)
 731                 return -EINVAL;
 732
 733         for (i = 0; i < ARRAY_SIZE(safeoutvolt); i++) {
 734                 if (min_uV <= safeoutvolt[i] &&
 735                                 max_uV >= safeoutvolt[i])
 736                         break;
 737         }
 738
 739         if (i >= ARRAY_SIZE(safeoutvolt))
 740                 return -EINVAL;
 741
 742         if (i == 0)
 743                 val = 0x3;
 744         else
 745                 val = i - 1;
 746
 747         ret = max8997_get_voltage_register(rdev, &reg, &shift, &mask);
 748         if (ret)
 749                 return ret;
 750
 751         ret = max8997_update_reg(i2c, reg, val << shift, mask << shift);
 752         *selector = val;
 753
 754         return ret;
 755 }
 756
 757 static int max8997_reg_enable_suspend(struct regulator_dev *rdev)
 758 {
 759         return 0;
 760 }
 761
 762 static int max8997_reg_disable_suspend(struct regulator_dev *rdev)
 763 {
 764         struct max8997_data *max8997 = rdev_get_drvdata(rdev);
 765         struct i2c_client *i2c = max8997->iodev->i2c;
 766         int ret, reg, mask, pattern;
 767         int rid = max8997_get_rid(rdev);
 768
 769         ret = max8997_get_enable_register(rdev, &reg, &mask, &pattern);
 770         if (ret)
 771                 return ret;
 772
 773         max8997_read_reg(i2c, reg, &max8997->saved_states[rid]);
 774
 775         if (rid == MAX8997_LDO1 ||
 776                         rid == MAX8997_LDO10 ||
 777                         rid == MAX8997_LDO21) {
 778                 dev_dbg(&rdev->dev, "Conditional Power-Off for %s\n",
 779                                 rdev->desc->name);
 780                 return max8997_update_reg(i2c, reg, 0x40, mask);
 781         }
 782
 783         dev_dbg(&rdev->dev, "Full Power-Off for %s (%xh -> %xh)\n",
 784                         rdev->desc->name, max8997->saved_states[rid] & mask,
 785                         (~pattern) & mask);
 786         return max8997_update_reg(i2c, reg, ~pattern, mask);
 787 }
 788
 789 static struct regulator_ops max8997_ldo_ops = {
 790         .list_voltage           = max8997_list_voltage,
 791         .is_enabled             = max8997_reg_is_enabled,
 792         .enable                 = max8997_reg_enable,
 793         .disable                = max8997_reg_disable,
 794         .get_voltage            = max8997_get_voltage,
 795         .set_voltage            = max8997_set_voltage_ldobuck,
 796         .set_suspend_enable     = max8997_reg_enable_suspend,
 797         .set_suspend_disable    = max8997_reg_disable_suspend,
 798 };
 799
 800 static struct regulator_ops max8997_buck_ops = {
 801         .list_voltage           = max8997_list_voltage,
 802         .is_enabled             = max8997_reg_is_enabled,
 803         .enable                 = max8997_reg_enable,
 804         .disable                = max8997_reg_disable,
 805         .get_voltage            = max8997_get_voltage,
 806         .set_voltage            = max8997_set_voltage_buck,
 807         .set_suspend_enable     = max8997_reg_enable_suspend,
 808         .set_suspend_disable    = max8997_reg_disable_suspend,
 809 };
 810
 811 static struct regulator_ops max8997_fixedvolt_ops = {
 812         .list_voltage           = max8997_list_voltage,
 813         .is_enabled             = max8997_reg_is_enabled,
 814         .enable                 = max8997_reg_enable,
 815         .disable                = max8997_reg_disable,
 816         .set_suspend_enable     = max8997_reg_enable_suspend,
 817         .set_suspend_disable    = max8997_reg_disable_suspend,
 818 };
 819
 820 static struct regulator_ops max8997_safeout_ops = {
 821         .list_voltage           = max8997_list_voltage_safeout,
 822         .is_enabled             = max8997_reg_is_enabled,
 823         .enable                 = max8997_reg_enable,
 824         .disable                = max8997_reg_disable,
 825         .get_voltage            = max8997_get_voltage,
 826         .set_voltage            = max8997_set_voltage_safeout,
 827         .set_suspend_enable     = max8997_reg_enable_suspend,
 828         .set_suspend_disable    = max8997_reg_disable_suspend,
 829 };
 830
 831 static struct regulator_ops max8997_fixedstate_ops = {
 832         .list_voltage           = max8997_list_voltage_charger_cv,
 833         .get_voltage            = max8997_get_voltage,
 834         .set_voltage            = max8997_set_voltage_charger_cv,
 835 };
 836
 837 static int max8997_set_voltage_ldobuck_wrap(struct regulator_dev *rdev,
 838                 int min_uV, int max_uV)
 839 {
 840         unsigned dummy;
 841
 842         return max8997_set_voltage_ldobuck(rdev, min_uV, max_uV, &dummy);
 843 }
 844
 845
 846 static struct regulator_ops max8997_charger_ops = {
 847         .is_enabled             = max8997_reg_is_enabled,
 848         .enable                 = max8997_reg_enable,
 849         .disable                = max8997_reg_disable,
 850         .get_current_limit      = max8997_get_voltage,
 851         .set_current_limit      = max8997_set_voltage_ldobuck_wrap,
 852 };
 853
 854 static struct regulator_ops max8997_charger_fixedstate_ops = {
 855         .is_enabled             = max8997_reg_is_enabled,
 856         .get_current_limit      = max8997_get_voltage,
 857         .set_current_limit      = max8997_set_voltage_ldobuck_wrap,
 858 };
 859
 860 #define regulator_desc_ldo(num)         {       \
 861         .name           = "LDO"#num,            \
 862         .id             = MAX8997_LDO##num,     \
 863         .ops            = &max8997_ldo_ops,     \
 864         .type           = REGULATOR_VOLTAGE,    \
 865         .owner          = THIS_MODULE,          \
 866 }
 867 #define regulator_desc_buck(num)                {       \
 868         .name           = "BUCK"#num,           \
 869         .id             = MAX8997_BUCK##num,    \
 870         .ops            = &max8997_buck_ops,    \
 871         .type           = REGULATOR_VOLTAGE,    \
 872         .owner          = THIS_MODULE,          \
 873 }
 874
 875 static struct regulator_desc regulators[] = {
 876         regulator_desc_ldo(1),
 877         regulator_desc_ldo(2),
 878         regulator_desc_ldo(3),
 879         regulator_desc_ldo(4),
 880         regulator_desc_ldo(5),
 881         regulator_desc_ldo(6),
 882         regulator_desc_ldo(7),
 883         regulator_desc_ldo(8),
 884         regulator_desc_ldo(9),
 885         regulator_desc_ldo(10),
 886         regulator_desc_ldo(11),
 887         regulator_desc_ldo(12),
 888         regulator_desc_ldo(13),
 889         regulator_desc_ldo(14),
 890         regulator_desc_ldo(15),
 891         regulator_desc_ldo(16),
 892         regulator_desc_ldo(17),
 893         regulator_desc_ldo(18),
 894         regulator_desc_ldo(21),
 895         regulator_desc_buck(1),
 896         regulator_desc_buck(2),
 897         regulator_desc_buck(3),
 898         regulator_desc_buck(4),
 899         regulator_desc_buck(5),
 900         {
 901                 .name   = "BUCK6",
 902                 .id     = MAX8997_BUCK6,
 903                 .ops    = &max8997_fixedvolt_ops,
 904                 .type   = REGULATOR_VOLTAGE,
 905                 .owner  = THIS_MODULE,
 906         },
 907         regulator_desc_buck(7),
 908         {
 909                 .name   = "EN32KHz AP",
 910                 .id     = MAX8997_EN32KHZ_AP,
 911                 .ops    = &max8997_fixedvolt_ops,
 912                 .type   = REGULATOR_VOLTAGE,
 913                 .owner  = THIS_MODULE,
 914         }, {
 915                 .name   = "EN32KHz CP",
 916                 .id     = MAX8997_EN32KHZ_CP,
 917                 .ops    = &max8997_fixedvolt_ops,
 918                 .type   = REGULATOR_VOLTAGE,
 919                 .owner  = THIS_MODULE,
 920         }, {
 921                 .name   = "ENVICHG",
 922                 .id     = MAX8997_ENVICHG,
 923                 .ops    = &max8997_fixedvolt_ops,
 924                 .type   = REGULATOR_VOLTAGE,
 925                 .owner  = THIS_MODULE,
 926         }, {
 927                 .name   = "ESAFEOUT1",
 928                 .id     = MAX8997_ESAFEOUT1,
 929                 .ops    = &max8997_safeout_ops,
 930                 .type   = REGULATOR_VOLTAGE,
 931                 .owner   = THIS_MODULE,
 932         }, {
 933                 .name   = "ESAFEOUT2",
 934                 .id     = MAX8997_ESAFEOUT2,
 935                 .ops    = &max8997_safeout_ops,
 936                 .type   = REGULATOR_VOLTAGE,
 937                 .owner   = THIS_MODULE,
 938         }, {
 939                 .name   = "CHARGER CV",
 940                 .id     = MAX8997_CHARGER_CV,
 941                 .ops    = &max8997_fixedstate_ops,
 942                 .type   = REGULATOR_VOLTAGE,
 943                 .owner   = THIS_MODULE,
 944         }, {
 945                 .name   = "CHARGER",
 946                 .id     = MAX8997_CHARGER,
 947                 .ops    = &max8997_charger_ops,
 948                 .type   = REGULATOR_CURRENT,
 949                 .owner   = THIS_MODULE,
 950         }, {
 951                 .name   = "CHARGER TOPOFF",
 952                 .id     = MAX8997_CHARGER_TOPOFF,
 953                 .ops    = &max8997_charger_fixedstate_ops,
 954                 .type   = REGULATOR_CURRENT,
 955                 .owner   = THIS_MODULE,
 956         },
 957 };
 958
 959 static __devinit int max8997_pmic_probe(struct platform_device *pdev)
 960 {
 961         struct max8997_dev *iodev = dev_get_drvdata(pdev->dev.parent);
 962         struct max8997_platform_data *pdata = dev_get_platdata(iodev->dev);
 963         struct regulator_dev **rdev;
 964         struct max8997_data *max8997;
 965         struct i2c_client *i2c;
 966         int i, ret, size;
 967         u8 max_buck1 = 0, max_buck2 = 0, max_buck5 = 0;
 968
 969         if (!pdata) {
 970                 dev_err(pdev->dev.parent, "No platform init data supplied.\n");
 971                 return -ENODEV;
 972         }
 973
 974         max8997 = kzalloc(sizeof(struct max8997_data), GFP_KERNEL);
 975         if (!max8997)
 976                 return -ENOMEM;
 977
 978         size = sizeof(struct regulator_dev *) * pdata->num_regulators;
 979         max8997->rdev = kzalloc(size, GFP_KERNEL);
 980         if (!max8997->rdev) {
 981                 kfree(max8997);
 982                 return -ENOMEM;
 983         }
 984
 985         rdev = max8997->rdev;
 986         max8997->dev = &pdev->dev;
 987         max8997->iodev = iodev;
 988         max8997->num_regulators = pdata->num_regulators;
 989         platform_set_drvdata(pdev, max8997);
 990         i2c = max8997->iodev->i2c;
 991
 992         max8997->buck125_gpioindex = pdata->buck125_default_idx;
 993         max8997->buck1_gpiodvs = pdata->buck1_gpiodvs;
 994         max8997->buck2_gpiodvs = pdata->buck2_gpiodvs;
 995         max8997->buck5_gpiodvs = pdata->buck5_gpiodvs;
 996         memcpy(max8997->buck125_gpios, pdata->buck125_gpios, sizeof(int) * 3);
 997         max8997->ignore_gpiodvs_side_effect = pdata->ignore_gpiodvs_side_effect;
 998
 999         for (i = 0; i < 8; i++) {
1000                 max8997->buck1_vol[i] = ret =
1001                         max8997_get_voltage_proper_val(
1002                                         &buck1245_voltage_map_desc,
1003                                         pdata->buck1_voltage[i] / 1000,
1004                                         pdata->buck1_voltage[i] / 1000 +
1005                                         buck1245_voltage_map_desc.step);
1006                 if (ret < 0)
1007                         goto err_alloc;
1008
1009                 max8997->buck2_vol[i] = ret =
1010                         max8997_get_voltage_proper_val(
1011                                         &buck1245_voltage_map_desc,
1012                                         pdata->buck2_voltage[i] / 1000,
1013                                         pdata->buck2_voltage[i] / 1000 +
1014                                         buck1245_voltage_map_desc.step);
1015                 if (ret < 0)
1016                         goto err_alloc;
1017
1018                 max8997->buck5_vol[i] = ret =
1019                         max8997_get_voltage_proper_val(
1020                                         &buck1245_voltage_map_desc,
1021                                         pdata->buck5_voltage[i] / 1000,
1022                                         pdata->buck5_voltage[i] / 1000 +
1023                                         buck1245_voltage_map_desc.step);
1024                 if (ret < 0)
1025                         goto err_alloc;
1026
1027                 if (max_buck1 < max8997->buck1_vol[i])
1028                         max_buck1 = max8997->buck1_vol[i];
1029                 if (max_buck2 < max8997->buck2_vol[i])
1030                         max_buck2 = max8997->buck2_vol[i];
1031                 if (max_buck5 < max8997->buck5_vol[i])
1032                         max_buck5 = max8997->buck5_vol[i];
1033         }
1034
1035         /* For the safety, set max voltage before setting up */
1036         for (i = 0; i < 8; i++) {
1037                 max8997_update_reg(i2c, MAX8997_REG_BUCK1DVS1 + i,
1038                                 max_buck1, 0x3f);
1039                 max8997_update_reg(i2c, MAX8997_REG_BUCK2DVS1 + i,
1040                                 max_buck2, 0x3f);
1041                 max8997_update_reg(i2c, MAX8997_REG_BUCK5DVS1 + i,
1042                                 max_buck5, 0x3f);
1043         }
1044
1045         /*
1046          * If buck 1, 2, and 5 do not care DVS GPIO settings, ignore them.
1047          * If at least one of them cares, set gpios.
1048          */
1049         if (pdata->buck1_gpiodvs || pdata->buck2_gpiodvs ||
1050                         pdata->buck5_gpiodvs) {
1051                 bool gpio1set = false, gpio2set = false;
1052
1053                 if (!gpio_is_valid(pdata->buck125_gpios[0]) ||
1054                                 !gpio_is_valid(pdata->buck125_gpios[1]) ||
1055                                 !gpio_is_valid(pdata->buck125_gpios[2])) {
1056                         dev_err(&pdev->dev, "GPIO NOT VALID\n");
1057                         ret = -EINVAL;
1058                         goto err_alloc;
1059                 }
1060
1061                 ret = gpio_request(pdata->buck125_gpios[0],
1062                                 "MAX8997 SET1");
1063                 if (ret == -EBUSY)
1064                         dev_warn(&pdev->dev, "Duplicated gpio request"
1065                                         " on SET1\n");
1066                 else if (ret)
1067                         goto err_alloc;
1068                 else
1069                         gpio1set = true;
1070
1071                 ret = gpio_request(pdata->buck125_gpios[1],
1072                                 "MAX8997 SET2");
1073                 if (ret == -EBUSY)
1074                         dev_warn(&pdev->dev, "Duplicated gpio request"
1075                                         " on SET2\n");
1076                 else if (ret) {
1077                         if (gpio1set)
1078                                 gpio_free(pdata->buck125_gpios[0]);
1079                         goto err_alloc;
1080                 } else
1081                         gpio2set = true;
1082
1083                 ret = gpio_request(pdata->buck125_gpios[2],
1084                                 "MAX8997 SET3");
1085                 if (ret == -EBUSY)
1086                         dev_warn(&pdev->dev, "Duplicated gpio request"
1087                                         " on SET3\n");
1088                 else if (ret) {
1089                         if (gpio1set)
1090                                 gpio_free(pdata->buck125_gpios[0]);
1091                         if (gpio2set)
1092                                 gpio_free(pdata->buck125_gpios[1]);
1093                         goto err_alloc;
1094                 }
1095
1096                 gpio_direction_output(pdata->buck125_gpios[0],
1097                                 (max8997->buck125_gpioindex >> 2)
1098                                 & 0x1); /* SET1 */
1099                 gpio_direction_output(pdata->buck125_gpios[1],
1100                                 (max8997->buck125_gpioindex >> 1)
1101                                 & 0x1); /* SET2 */
1102                 gpio_direction_output(pdata->buck125_gpios[2],
1103                                 (max8997->buck125_gpioindex >> 0)
1104                                 & 0x1); /* SET3 */
1105                 ret = 0;
1106         }
1107
1108         /* DVS-GPIO disabled */
1109         max8997_update_reg(i2c, MAX8997_REG_BUCK1CTRL, (pdata->buck1_gpiodvs) ?
1110                         (1 << 1) : (0 << 1), 1 << 1);
1111         max8997_update_reg(i2c, MAX8997_REG_BUCK2CTRL, (pdata->buck2_gpiodvs) ?
1112                         (1 << 1) : (0 << 1), 1 << 1);
1113         max8997_update_reg(i2c, MAX8997_REG_BUCK5CTRL, (pdata->buck5_gpiodvs) ?
1114                         (1 << 1) : (0 << 1), 1 << 1);
1115
1116         /* Initialize all the DVS related BUCK registers */
1117         for (i = 0; i < 8; i++) {
1118                 max8997_update_reg(i2c, MAX8997_REG_BUCK1DVS1 + i,
1119                                 max8997->buck1_vol[i],
1120                                 0x3f);
1121                 max8997_update_reg(i2c, MAX8997_REG_BUCK2DVS1 + i,
1122                                 max8997->buck2_vol[i],
1123                                 0x3f);
1124                 max8997_update_reg(i2c, MAX8997_REG_BUCK5DVS1 + i,
1125                                 max8997->buck5_vol[i],
1126                                 0x3f);
1127         }
1128
1129         /* Misc Settings */
1130         max8997->ramp_delay = 10; /* set 10mV/us, which is the default */
1131         max8997_write_reg(i2c, MAX8997_REG_BUCKRAMP, (0xf << 4) | 0x9);
1132
1133         for (i = 0; i < pdata->num_regulators; i++) {
1134                 const struct voltage_map_desc *desc;
1135                 int id = pdata->regulators[i].id;
1136
1137                 desc = reg_voltage_map[id];
1138                 if (desc)
1139                         regulators[id].n_voltages =
1140                                 (desc->max - desc->min) / desc->step + 1;
1141                 else if (id == MAX8997_ESAFEOUT1 || id == MAX8997_ESAFEOUT2)
1142                         regulators[id].n_voltages = 4;
1143                 else if (id == MAX8997_CHARGER_CV)
1144                         regulators[id].n_voltages = 16;
1145
1146                 rdev[i] = regulator_register(&regulators[id], max8997->dev,
1147                                 pdata->regulators[i].initdata, max8997);
1148                 if (IS_ERR(rdev[i])) {
1149                         ret = PTR_ERR(rdev[i]);
1150                         dev_err(max8997->dev, "regulator init failed for %d\n",
1151                                         id);
1152                         rdev[i] = NULL;
1153                         goto err;
1154                 }
1155         }
1156
1157         return 0;
1158 err:
1159         for (i = 0; i < max8997->num_regulators; i++)
1160                 if (rdev[i])
1161                         regulator_unregister(rdev[i]);
1162 err_alloc:
1163         kfree(max8997->rdev);
1164         kfree(max8997);
1165
1166         return ret;
1167 }
1168
1169 static int __devexit max8997_pmic_remove(struct platform_device *pdev)
1170 {
1171         struct max8997_data *max8997 = platform_get_drvdata(pdev);
1172         struct regulator_dev **rdev = max8997->rdev;
1173         int i;
1174
1175         for (i = 0; i < max8997->num_regulators; i++)
1176                 if (rdev[i])
1177                         regulator_unregister(rdev[i]);
1178
1179         kfree(max8997->rdev);
1180         kfree(max8997);
1181
1182         return 0;
1183 }
1184
1185 static const struct platform_device_id max8997_pmic_id[] = {
1186         { "max8997-pmic", 0},
1187         { },
1188 };
1189 MODULE_DEVICE_TABLE(platform, max8997_pmic_id);
1190
1191 static struct platform_driver max8997_pmic_driver = {
1192         .driver = {
1193                 .name = "max8997-pmic",
1194                 .owner = THIS_MODULE,
1195         },
1196         .probe = max8997_pmic_probe,
1197         .remove = __devexit_p(max8997_pmic_remove),
1198         .id_table = max8997_pmic_id,
1199 };
1200
1201 static int __init max8997_pmic_init(void)
1202 {
1203         return platform_driver_register(&max8997_pmic_driver);
1204 }
1205 subsys_initcall(max8997_pmic_init);
1206
1207 static void __exit max8997_pmic_cleanup(void)
1208 {
1209         platform_driver_unregister(&max8997_pmic_driver);
1210 }
1211 module_exit(max8997_pmic_cleanup);
1212
1213 MODULE_DESCRIPTION("MAXIM 8997/8966 Regulator Driver");
1214 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1215 MODULE_LICENSE("GPL");