drivers/regulator/max8973-regulator.c

   1 /*
   2  * max8973-regulator.c -- Maxim max8973
   3  *
   4  * Regulator driver for MAXIM 8973 DC-DC step-down switching regulator.
   5  *
   6  * Copyright (c) 2012, NVIDIA Corporation.
   7  *
   8  * Author: Laxman Dewangan <ldewangan@nvidia.com>
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License as
  12  * published by the Free Software Foundation version 2.
  13  *
  14  * This program is distributed "as is" WITHOUT ANY WARRANTY of any kind,
  15  * whether express or implied; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  22  * 02111-1307, USA
  23  */
  24
  25 #include <linux/kernel.h>
  26 #include <linux/module.h>
  27 #include <linux/init.h>
  28 #include <linux/err.h>
  29 #include <linux/of.h>
  30 #include <linux/platform_device.h>
  31 #include <linux/regulator/driver.h>
  32 #include <linux/regulator/machine.h>
  33 #include <linux/regulator/max8973-regulator.h>
  34 #include <linux/regulator/of_regulator.h>
  35 #include <linux/gpio.h>
  36 #include <linux/of_gpio.h>
  37 #include <linux/i2c.h>
  38 #include <linux/slab.h>
  39 #include <linux/regmap.h>
  40
  41 /* Register definitions */
  42 #define MAX8973_VOUT                                    0x0
  43 #define MAX8973_VOUT_DVS                                0x1
  44 #define MAX8973_CONTROL1                                0x2
  45 #define MAX8973_CONTROL2                                0x3
  46 #define MAX8973_CHIPID1                                 0x4
  47 #define MAX8973_CHIPID2                                 0x5
  48
  49 #define MAX8973_MAX_VOUT_REG                            2
  50
  51 /* MAX8973_VOUT */
  52 #define MAX8973_VOUT_ENABLE                             BIT(7)
  53 #define MAX8973_VOUT_MASK                               0x7F
  54
  55 /* MAX8973_VOUT_DVS */
  56 #define MAX8973_DVS_VOUT_MASK                           0x7F
  57
  58 /* MAX8973_CONTROL1 */
  59 #define MAX8973_SNS_ENABLE                              BIT(7)
  60 #define MAX8973_FPWM_EN_M                               BIT(6)
  61 #define MAX8973_NFSR_ENABLE                             BIT(5)
  62 #define MAX8973_AD_ENABLE                               BIT(4)
  63 #define MAX8973_BIAS_ENABLE                             BIT(3)
  64 #define MAX8973_FREQSHIFT_9PER                          BIT(2)
  65
  66 #define MAX8973_RAMP_12mV_PER_US                        0x0
  67 #define MAX8973_RAMP_25mV_PER_US                        0x1
  68 #define MAX8973_RAMP_50mV_PER_US                        0x2
  69 #define MAX8973_RAMP_200mV_PER_US                       0x3
  70
  71 /* MAX8973_CONTROL2 */
  72 #define MAX8973_WDTMR_ENABLE                            BIT(6)
  73 #define MAX8973_DISCH_ENBABLE                           BIT(5)
  74 #define MAX8973_FT_ENABLE                               BIT(4)
  75
  76 #define MAX8973_CKKADV_TRIP_DISABLE                     0xC
  77 #define MAX8973_CKKADV_TRIP_75mV_PER_US                 0x0
  78 #define MAX8973_CKKADV_TRIP_150mV_PER_US                0x4
  79 #define MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS        0x8
  80 #define MAX8973_CONTROL_CLKADV_TRIP_MASK                0x00030000
  81
  82 #define MAX8973_INDUCTOR_MIN_30_PER                     0x0
  83 #define MAX8973_INDUCTOR_NOMINAL                        0x1
  84 #define MAX8973_INDUCTOR_PLUS_30_PER                    0x2
  85 #define MAX8973_INDUCTOR_PLUS_60_PER                    0x3
  86 #define MAX8973_CONTROL_INDUCTOR_VALUE_MASK             0x00300000
  87
  88 #define MAX8973_MIN_VOLATGE                             606250
  89 #define MAX8973_MAX_VOLATGE                             1400000
  90 #define MAX8973_VOLATGE_STEP                            6250
  91 #define MAX8973_BUCK_N_VOLTAGE                          0x80
  92
  93 /* Maxim 8973 chip information */
  94 struct max8973_chip {
  95         struct device *dev;
  96         struct regulator_desc desc;
  97         struct regmap *regmap;
  98         bool enable_external_control;
  99         int dvs_gpio;
 100         int lru_index[MAX8973_MAX_VOUT_REG];
 101         int curr_vout_val[MAX8973_MAX_VOUT_REG];
 102         int curr_vout_reg;
 103         int curr_gpio_val;
 104         struct regulator_ops ops;
 105 };
 106
 107 /*
 108  * find_voltage_set_register: Find new voltage configuration register (VOUT).
 109  * The finding of the new VOUT register will be based on the LRU mechanism.
 110  * Each VOUT register will have different voltage configured . This
 111  * Function will look if any of the VOUT register have requested voltage set
 112  * or not.
 113  *     - If it is already there then it will make that register as most
 114  *       recently used and return as found so that caller need not to set
 115  *       the VOUT register but need to set the proper gpios to select this
 116  *       VOUT register.
 117  *     - If requested voltage is not found then it will use the least
 118  *       recently mechanism to get new VOUT register for new configuration
 119  *       and will return not_found so that caller need to set new VOUT
 120  *       register and then gpios (both).
 121  */
 122 static bool find_voltage_set_register(struct max8973_chip *tps,
 123                 int req_vsel, int *vout_reg, int *gpio_val)
 124 {
 125         int i;
 126         bool found = false;
 127         int new_vout_reg = tps->lru_index[MAX8973_MAX_VOUT_REG - 1];
 128         int found_index = MAX8973_MAX_VOUT_REG - 1;
 129
 130         for (i = 0; i < MAX8973_MAX_VOUT_REG; ++i) {
 131                 if (tps->curr_vout_val[tps->lru_index[i]] == req_vsel) {
 132                         new_vout_reg = tps->lru_index[i];
 133                         found_index = i;
 134                         found = true;
 135                         goto update_lru_index;
 136                 }
 137         }
 138
 139 update_lru_index:
 140         for (i = found_index; i > 0; i--)
 141                 tps->lru_index[i] = tps->lru_index[i - 1];
 142
 143         tps->lru_index[0] = new_vout_reg;
 144         *gpio_val = new_vout_reg;
 145         *vout_reg = MAX8973_VOUT + new_vout_reg;
 146         return found;
 147 }
 148
 149 static int max8973_dcdc_get_voltage_sel(struct regulator_dev *rdev)
 150 {
 151         struct max8973_chip *max = rdev_get_drvdata(rdev);
 152         unsigned int data;
 153         int ret;
 154
 155         ret = regmap_read(max->regmap, max->curr_vout_reg, &data);
 156         if (ret < 0) {
 157                 dev_err(max->dev, "register %d read failed, err = %d\n",
 158                         max->curr_vout_reg, ret);
 159                 return ret;
 160         }
 161         return data & MAX8973_VOUT_MASK;
 162 }
 163
 164 static int max8973_dcdc_set_voltage_sel(struct regulator_dev *rdev,
 165              unsigned vsel)
 166 {
 167         struct max8973_chip *max = rdev_get_drvdata(rdev);
 168         int ret;
 169         bool found = false;
 170         int vout_reg = max->curr_vout_reg;
 171         int gpio_val = max->curr_gpio_val;
 172
 173         /*
 174          * If gpios are available to select the VOUT register then least
 175          * recently used register for new configuration.
 176          */
 177         if (gpio_is_valid(max->dvs_gpio))
 178                 found = find_voltage_set_register(max, vsel,
 179                                         &vout_reg, &gpio_val);
 180
 181         if (!found) {
 182                 ret = regmap_update_bits(max->regmap, vout_reg,
 183                                         MAX8973_VOUT_MASK, vsel);
 184                 if (ret < 0) {
 185                         dev_err(max->dev, "register %d update failed, err %d\n",
 186                                  vout_reg, ret);
 187                         return ret;
 188                 }
 189                 max->curr_vout_reg = vout_reg;
 190                 max->curr_vout_val[gpio_val] = vsel;
 191         }
 192
 193         /* Select proper VOUT register vio gpios */
 194         if (gpio_is_valid(max->dvs_gpio)) {
 195                 gpio_set_value_cansleep(max->dvs_gpio, gpio_val & 0x1);
 196                 max->curr_gpio_val = gpio_val;
 197         }
 198         return 0;
 199 }
 200
 201 static int max8973_dcdc_set_mode(struct regulator_dev *rdev, unsigned int mode)
 202 {
 203         struct max8973_chip *max = rdev_get_drvdata(rdev);
 204         int ret;
 205         int pwm;
 206
 207         /* Enable force PWM mode in FAST mode only. */
 208         switch (mode) {
 209         case REGULATOR_MODE_FAST:
 210                 pwm = MAX8973_FPWM_EN_M;
 211                 break;
 212
 213         case REGULATOR_MODE_NORMAL:
 214                 pwm = 0;
 215                 break;
 216
 217         default:
 218                 return -EINVAL;
 219         }
 220
 221         ret = regmap_update_bits(max->regmap, MAX8973_CONTROL1,
 222                                 MAX8973_FPWM_EN_M, pwm);
 223         if (ret < 0)
 224                 dev_err(max->dev, "register %d update failed, err %d\n",
 225                                 MAX8973_CONTROL1, ret);
 226         return ret;
 227 }
 228
 229 static unsigned int max8973_dcdc_get_mode(struct regulator_dev *rdev)
 230 {
 231         struct max8973_chip *max = rdev_get_drvdata(rdev);
 232         unsigned int data;
 233         int ret;
 234
 235         ret = regmap_read(max->regmap, MAX8973_CONTROL1, &data);
 236         if (ret < 0) {
 237                 dev_err(max->dev, "register %d read failed, err %d\n",
 238                                 MAX8973_CONTROL1, ret);
 239                 return ret;
 240         }
 241         return (data & MAX8973_FPWM_EN_M) ?
 242                 REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
 243 }
 244
 245 static const struct regulator_ops max8973_dcdc_ops = {
 246         .get_voltage_sel        = max8973_dcdc_get_voltage_sel,
 247         .set_voltage_sel        = max8973_dcdc_set_voltage_sel,
 248         .list_voltage           = regulator_list_voltage_linear,
 249         .set_mode               = max8973_dcdc_set_mode,
 250         .get_mode               = max8973_dcdc_get_mode,
 251 };
 252
 253 static int max8973_init_dcdc(struct max8973_chip *max,
 254                              struct max8973_regulator_platform_data *pdata)
 255 {
 256         int ret;
 257         uint8_t control1 = 0;
 258         uint8_t control2 = 0;
 259
 260         if (pdata->control_flags & MAX8973_CONTROL_REMOTE_SENSE_ENABLE)
 261                 control1 |= MAX8973_SNS_ENABLE;
 262
 263         if (!(pdata->control_flags & MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE))
 264                 control1 |= MAX8973_NFSR_ENABLE;
 265
 266         if (pdata->control_flags & MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE)
 267                 control1 |= MAX8973_AD_ENABLE;
 268
 269         if (pdata->control_flags & MAX8973_CONTROL_BIAS_ENABLE) {
 270                 control1 |= MAX8973_BIAS_ENABLE;
 271                 max->desc.enable_time = 20;
 272         } else {
 273                 max->desc.enable_time = 240;
 274         }
 275
 276         if (pdata->control_flags & MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE)
 277                 control1 |= MAX8973_FREQSHIFT_9PER;
 278
 279         /* Set ramp delay */
 280         if (pdata->reg_init_data &&
 281                         pdata->reg_init_data->constraints.ramp_delay) {
 282                 if (pdata->reg_init_data->constraints.ramp_delay < 25000)
 283                         control1 |= MAX8973_RAMP_12mV_PER_US;
 284                 else if (pdata->reg_init_data->constraints.ramp_delay < 50000)
 285                         control1 |= MAX8973_RAMP_25mV_PER_US;
 286                 else if (pdata->reg_init_data->constraints.ramp_delay < 200000)
 287                         control1 |= MAX8973_RAMP_50mV_PER_US;
 288                 else
 289                         control1 |= MAX8973_RAMP_200mV_PER_US;
 290         } else {
 291                 control1 |= MAX8973_RAMP_12mV_PER_US;
 292                 max->desc.ramp_delay = 12500;
 293         }
 294
 295         if (!(pdata->control_flags & MAX8973_CONTROL_PULL_DOWN_ENABLE))
 296                 control2 |= MAX8973_DISCH_ENBABLE;
 297
 298         /*  Clock advance trip configuration */
 299         switch (pdata->control_flags & MAX8973_CONTROL_CLKADV_TRIP_MASK) {
 300         case MAX8973_CONTROL_CLKADV_TRIP_DISABLED:
 301                 control2 |= MAX8973_CKKADV_TRIP_DISABLE;
 302                 break;
 303
 304         case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US:
 305                 control2 |= MAX8973_CKKADV_TRIP_75mV_PER_US;
 306                 break;
 307
 308         case MAX8973_CONTROL_CLKADV_TRIP_150mV_PER_US:
 309                 control2 |= MAX8973_CKKADV_TRIP_150mV_PER_US;
 310                 break;
 311
 312         case MAX8973_CONTROL_CLKADV_TRIP_75mV_PER_US_HIST_DIS:
 313                 control2 |= MAX8973_CKKADV_TRIP_75mV_PER_US_HIST_DIS;
 314                 break;
 315         }
 316
 317         /* Configure inductor value */
 318         switch (pdata->control_flags & MAX8973_CONTROL_INDUCTOR_VALUE_MASK) {
 319         case MAX8973_CONTROL_INDUCTOR_VALUE_NOMINAL:
 320                 control2 |= MAX8973_INDUCTOR_NOMINAL;
 321                 break;
 322
 323         case MAX8973_CONTROL_INDUCTOR_VALUE_MINUS_30_PER:
 324                 control2 |= MAX8973_INDUCTOR_MIN_30_PER;
 325                 break;
 326
 327         case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_30_PER:
 328                 control2 |= MAX8973_INDUCTOR_PLUS_30_PER;
 329                 break;
 330
 331         case MAX8973_CONTROL_INDUCTOR_VALUE_PLUS_60_PER:
 332                 control2 |= MAX8973_INDUCTOR_PLUS_60_PER;
 333                 break;
 334         }
 335
 336         ret = regmap_write(max->regmap, MAX8973_CONTROL1, control1);
 337         if (ret < 0) {
 338                 dev_err(max->dev, "register %d write failed, err = %d",
 339                                 MAX8973_CONTROL1, ret);
 340                 return ret;
 341         }
 342
 343         ret = regmap_write(max->regmap, MAX8973_CONTROL2, control2);
 344         if (ret < 0) {
 345                 dev_err(max->dev, "register %d write failed, err = %d",
 346                                 MAX8973_CONTROL2, ret);
 347                 return ret;
 348         }
 349
 350         /* If external control is enabled then disable EN bit */
 351         if (max->enable_external_control) {
 352                 ret = regmap_update_bits(max->regmap, MAX8973_VOUT,
 353                                                 MAX8973_VOUT_ENABLE, 0);
 354                 if (ret < 0)
 355                         dev_err(max->dev, "register %d update failed, err = %d",
 356                                 MAX8973_VOUT, ret);
 357         }
 358         return ret;
 359 }
 360
 361 static const struct regmap_config max8973_regmap_config = {
 362         .reg_bits               = 8,
 363         .val_bits               = 8,
 364         .max_register           = MAX8973_CHIPID2,
 365         .cache_type             = REGCACHE_RBTREE,
 366 };
 367
 368 static struct max8973_regulator_platform_data *max8973_parse_dt(
 369                 struct device *dev)
 370 {
 371         struct max8973_regulator_platform_data *pdata;
 372         struct device_node *np = dev->of_node;
 373         int ret;
 374         u32 pval;
 375
 376         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
 377         if (!pdata)
 378                 return NULL;
 379
 380         pdata->enable_ext_control = of_property_read_bool(np,
 381                                                 "maxim,externally-enable");
 382         pdata->dvs_gpio = of_get_named_gpio(np, "maxim,dvs-gpio", 0);
 383
 384         ret = of_property_read_u32(np, "maxim,dvs-default-state", &pval);
 385         if (!ret)
 386                 pdata->dvs_def_state = pval;
 387
 388         if (of_property_read_bool(np, "maxim,enable-remote-sense"))
 389                 pdata->control_flags  |= MAX8973_CONTROL_REMOTE_SENSE_ENABLE;
 390
 391         if (of_property_read_bool(np, "maxim,enable-falling-slew-rate"))
 392                 pdata->control_flags  |=
 393                                 MAX8973_CONTROL_FALLING_SLEW_RATE_ENABLE;
 394
 395         if (of_property_read_bool(np, "maxim,enable-active-discharge"))
 396                 pdata->control_flags  |=
 397                                 MAX8973_CONTROL_OUTPUT_ACTIVE_DISCH_ENABLE;
 398
 399         if (of_property_read_bool(np, "maxim,enable-frequency-shift"))
 400                 pdata->control_flags  |= MAX8973_CONTROL_FREQ_SHIFT_9PER_ENABLE;
 401
 402         if (of_property_read_bool(np, "maxim,enable-bias-control"))
 403                 pdata->control_flags  |= MAX8973_BIAS_ENABLE;
 404
 405         return pdata;
 406 }
 407
 408 static int max8973_probe(struct i2c_client *client,
 409                          const struct i2c_device_id *id)
 410 {
 411         struct max8973_regulator_platform_data *pdata;
 412         struct regulator_config config = { };
 413         struct regulator_dev *rdev;
 414         struct max8973_chip *max;
 415         bool pdata_from_dt = false;
 416         int ret;
 417
 418         pdata = dev_get_platdata(&client->dev);
 419
 420         if (!pdata && client->dev.of_node) {
 421                 pdata = max8973_parse_dt(&client->dev);
 422                 pdata_from_dt = true;
 423         }
 424
 425         if (!pdata) {
 426                 dev_err(&client->dev, "No Platform data");
 427                 return -EIO;
 428         }
 429
 430         if (pdata->dvs_gpio == -EPROBE_DEFER)
 431                 return -EPROBE_DEFER;
 432
 433         max = devm_kzalloc(&client->dev, sizeof(*max), GFP_KERNEL);
 434         if (!max)
 435                 return -ENOMEM;
 436
 437         max->regmap = devm_regmap_init_i2c(client, &max8973_regmap_config);
 438         if (IS_ERR(max->regmap)) {
 439                 ret = PTR_ERR(max->regmap);
 440                 dev_err(&client->dev, "regmap init failed, err %d\n", ret);
 441                 return ret;
 442         }
 443
 444         i2c_set_clientdata(client, max);
 445         max->ops = max8973_dcdc_ops;
 446         max->dev = &client->dev;
 447         max->desc.name = id->name;
 448         max->desc.id = 0;
 449         max->desc.ops = &max->ops;
 450         max->desc.type = REGULATOR_VOLTAGE;
 451         max->desc.owner = THIS_MODULE;
 452         max->desc.min_uV = MAX8973_MIN_VOLATGE;
 453         max->desc.uV_step = MAX8973_VOLATGE_STEP;
 454         max->desc.n_voltages = MAX8973_BUCK_N_VOLTAGE;
 455
 456         if (!pdata->enable_ext_control) {
 457                 max->desc.enable_reg = MAX8973_VOUT;
 458                 max->desc.enable_mask = MAX8973_VOUT_ENABLE;
 459                 max->ops.enable = regulator_enable_regmap;
 460                 max->ops.disable = regulator_disable_regmap;
 461                 max->ops.is_enabled = regulator_is_enabled_regmap;
 462         }
 463
 464         max->dvs_gpio = (pdata->dvs_gpio) ? pdata->dvs_gpio : -EINVAL;
 465         max->enable_external_control = pdata->enable_ext_control;
 466         max->curr_gpio_val = pdata->dvs_def_state;
 467         max->curr_vout_reg = MAX8973_VOUT + pdata->dvs_def_state;
 468
 469         max->lru_index[0] = max->curr_vout_reg;
 470
 471         if (gpio_is_valid(max->dvs_gpio)) {
 472                 int gpio_flags;
 473                 int i;
 474
 475                 gpio_flags = (pdata->dvs_def_state) ?
 476                                 GPIOF_OUT_INIT_HIGH : GPIOF_OUT_INIT_LOW;
 477                 ret = devm_gpio_request_one(&client->dev, max->dvs_gpio,
 478                                 gpio_flags, "max8973-dvs");
 479                 if (ret) {
 480                         dev_err(&client->dev,
 481                                 "gpio_request for gpio %d failed, err = %d\n",
 482                                 max->dvs_gpio, ret);
 483                         return ret;
 484                 }
 485
 486                 /*
 487                  * Initialize the lru index with vout_reg id
 488                  * The index 0 will be most recently used and
 489                  * set with the max->curr_vout_reg */
 490                 for (i = 0; i < MAX8973_MAX_VOUT_REG; ++i)
 491                         max->lru_index[i] = i;
 492                 max->lru_index[0] = max->curr_vout_reg;
 493                 max->lru_index[max->curr_vout_reg] = 0;
 494         }
 495
 496         if (pdata_from_dt)
 497                 pdata->reg_init_data = of_get_regulator_init_data(&client->dev,
 498                                         client->dev.of_node, &max->desc);
 499
 500         ret = max8973_init_dcdc(max, pdata);
 501         if (ret < 0) {
 502                 dev_err(max->dev, "Max8973 Init failed, err = %d\n", ret);
 503                 return ret;
 504         }
 505
 506         config.dev = &client->dev;
 507         config.init_data = pdata->reg_init_data;
 508         config.driver_data = max;
 509         config.of_node = client->dev.of_node;
 510         config.regmap = max->regmap;
 511
 512         /* Register the regulators */
 513         rdev = devm_regulator_register(&client->dev, &max->desc, &config);
 514         if (IS_ERR(rdev)) {
 515                 ret = PTR_ERR(rdev);
 516                 dev_err(max->dev, "regulator register failed, err %d\n", ret);
 517                 return ret;
 518         }
 519
 520         return 0;
 521 }
 522
 523 static const struct i2c_device_id max8973_id[] = {
 524         {.name = "max8973",},
 525         {},
 526 };
 527
 528 MODULE_DEVICE_TABLE(i2c, max8973_id);
 529
 530 static struct i2c_driver max8973_i2c_driver = {
 531         .driver = {
 532                 .name = "max8973",
 533                 .owner = THIS_MODULE,
 534         },
 535         .probe = max8973_probe,
 536         .id_table = max8973_id,
 537 };
 538
 539 static int __init max8973_init(void)
 540 {
 541         return i2c_add_driver(&max8973_i2c_driver);
 542 }
 543 subsys_initcall(max8973_init);
 544
 545 static void __exit max8973_cleanup(void)
 546 {
 547         i2c_del_driver(&max8973_i2c_driver);
 548 }
 549 module_exit(max8973_cleanup);
 550
 551 MODULE_AUTHOR("Laxman Dewangan <ldewangan@nvidia.com>");
 552 MODULE_DESCRIPTION("MAX8973 voltage regulator driver");
 553 MODULE_LICENSE("GPL v2");