drivers/regulator/fan53555.c

   1 /*
   2  * FAN53555 Fairchild Digitally Programmable TinyBuck Regulator Driver.
   3  *
   4  * Supported Part Numbers:
   5  * FAN53555UC00X/01X/03X/04X/05X
   6  *
   7  * Copyright (c) 2012 Marvell Technology Ltd.
   8  * Yunfan Zhang <yfzhang@marvell.com>
   9  *
  10  * This package is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  */
  15 #include <linux/module.h>
  16 #include <linux/param.h>
  17 #include <linux/err.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/regulator/driver.h>
  20 #include <linux/regulator/machine.h>
  21 #include <linux/regulator/of_regulator.h>
  22 #include <linux/of_device.h>
  23 #include <linux/i2c.h>
  24 #include <linux/slab.h>
  25 #include <linux/regmap.h>
  26 #include <linux/regulator/fan53555.h>
  27 #include <linux/gpio.h>
  28 #include <linux/of_gpio.h>
  29
  30 /* Voltage setting */
  31 #define FAN53555_VSEL0          0x00
  32 #define FAN53555_VSEL1          0x01
  33 /* Control register */
  34 #define FAN53555_CONTROL        0x02
  35 /* IC Type */
  36 #define FAN53555_ID1            0x03
  37 /* IC mask version */
  38 #define FAN53555_ID2            0x04
  39 /* Monitor register */
  40 #define FAN53555_MONITOR        0x05
  41
  42 /* VSEL bit definitions */
  43 #define VSEL_BUCK_EN    (1 << 7)
  44 #define VSEL_MODE               (1 << 6)
  45 #define VSEL_NSEL_MASK  0x3F
  46 /* Chip ID and Verison */
  47 #define DIE_ID          0x0F    /* ID1 */
  48 #define DIE_REV         0x0F    /* ID2 */
  49 /* Control bit definitions */
  50 #define CTL_OUTPUT_DISCHG       (1 << 7)
  51 #define CTL_SLEW_MASK           (0x7 << 4)
  52 #define CTL_SLEW_SHIFT          4
  53 #define CTL_RESET                       (1 << 2)
  54
  55 #define FAN53555_NVOLTAGES      64      /* Numbers of voltages */
  56
  57 enum fan53555_vendor {
  58         FAN53555_VENDOR_FAIRCHILD = 0,
  59         FAN53555_VENDOR_SILERGY,
  60 };
  61
  62 /* IC Type */
  63 enum {
  64         FAN53555_CHIP_ID_00 = 0,
  65         FAN53555_CHIP_ID_01,
  66         FAN53555_CHIP_ID_02,
  67         FAN53555_CHIP_ID_03,
  68         FAN53555_CHIP_ID_04,
  69         FAN53555_CHIP_ID_05,
  70 };
  71
  72 enum {
  73         SILERGY_SYR82X = 8,
  74 };
  75
  76 struct fan53555_device_info {
  77         enum fan53555_vendor vendor;
  78         struct regmap *regmap;
  79         struct device *dev;
  80         struct regulator_desc desc;
  81         struct regulator_dev *rdev;
  82         struct regulator_init_data *regulator;
  83         /* IC Type and Rev */
  84         int chip_id;
  85         int chip_rev;
  86         /* Voltage setting register */
  87         unsigned int vol_reg;
  88         unsigned int sleep_reg;
  89         /* Voltage range and step(linear) */
  90         unsigned int vsel_min;
  91         unsigned int vsel_step;
  92         /* Voltage slew rate limiting */
  93         unsigned int slew_rate;
  94         /* Sleep voltage cache */
  95         unsigned int sleep_vol_cache;
  96         struct gpio_desc *vsel_gpio;
  97         unsigned int sleep_vsel_id;
  98 };
  99
 100 static unsigned int fan53555_map_mode(unsigned int mode)
 101 {
 102         return mode == REGULATOR_MODE_FAST ?
 103                 REGULATOR_MODE_FAST : REGULATOR_MODE_NORMAL;
 104 }
 105
 106 static int fan53555_set_suspend_voltage(struct regulator_dev *rdev, int uV)
 107 {
 108         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 109         int ret;
 110
 111         if (di->sleep_vol_cache == uV)
 112                 return 0;
 113         ret = regulator_map_voltage_linear(rdev, uV, uV);
 114         if (ret < 0)
 115                 return ret;
 116         ret = regmap_update_bits(di->regmap, di->sleep_reg,
 117                                         VSEL_NSEL_MASK, ret);
 118         if (ret < 0)
 119                 return ret;
 120         /* Cache the sleep voltage setting.
 121          * Might not be the real voltage which is rounded */
 122         di->sleep_vol_cache = uV;
 123
 124         return 0;
 125 }
 126
 127 static int fan53555_set_suspend_enable(struct regulator_dev *rdev)
 128 {
 129         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 130
 131         return regmap_update_bits(di->regmap, di->sleep_reg,
 132                                   VSEL_BUCK_EN, VSEL_BUCK_EN);
 133 }
 134
 135 static int fan53555_set_suspend_disable(struct regulator_dev *rdev)
 136 {
 137         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 138
 139         return regmap_update_bits(di->regmap, di->sleep_reg,
 140                                   VSEL_BUCK_EN, 0);
 141 }
 142
 143 static int fan53555_set_enable(struct regulator_dev *rdev)
 144 {
 145         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 146
 147         if (di->vsel_gpio) {
 148                 gpiod_set_raw_value(di->vsel_gpio, !di->sleep_vsel_id);
 149                 return 0;
 150         }
 151
 152         return regmap_update_bits(di->regmap, di->vol_reg,
 153                                   VSEL_BUCK_EN, VSEL_BUCK_EN);
 154 }
 155
 156 static int fan53555_set_disable(struct regulator_dev *rdev)
 157 {
 158         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 159
 160         if (di->vsel_gpio) {
 161                 gpiod_set_raw_value(di->vsel_gpio, di->sleep_vsel_id);
 162                 return 0;
 163         }
 164
 165         return regmap_update_bits(di->regmap, di->vol_reg,
 166                                   VSEL_BUCK_EN, 0);
 167 }
 168
 169 static int fan53555_is_enabled(struct regulator_dev *rdev)
 170 {
 171         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 172         unsigned int val;
 173         int ret = 0;
 174
 175         if (di->vsel_gpio) {
 176                 if (di->sleep_vsel_id)
 177                         return !gpiod_get_raw_value(di->vsel_gpio);
 178                 else
 179                         return gpiod_get_raw_value(di->vsel_gpio);
 180         }
 181
 182         ret = regmap_read(di->regmap, di->vol_reg, &val);
 183         if (ret < 0)
 184                 return ret;
 185         if (val & VSEL_BUCK_EN)
 186                 return 1;
 187         else
 188                 return 0;
 189 }
 190
 191 static int fan53555_set_mode(struct regulator_dev *rdev, unsigned int mode)
 192 {
 193         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 194
 195         switch (mode) {
 196         case REGULATOR_MODE_FAST:
 197                 regmap_update_bits(di->regmap, di->vol_reg,
 198                                 VSEL_MODE, VSEL_MODE);
 199                 break;
 200         case REGULATOR_MODE_NORMAL:
 201                 regmap_update_bits(di->regmap, di->vol_reg, VSEL_MODE, 0);
 202                 break;
 203         default:
 204                 return -EINVAL;
 205         }
 206         return 0;
 207 }
 208
 209 static unsigned int fan53555_get_mode(struct regulator_dev *rdev)
 210 {
 211         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 212         unsigned int val;
 213         int ret = 0;
 214
 215         ret = regmap_read(di->regmap, di->vol_reg, &val);
 216         if (ret < 0)
 217                 return ret;
 218         if (val & VSEL_MODE)
 219                 return REGULATOR_MODE_FAST;
 220         else
 221                 return REGULATOR_MODE_NORMAL;
 222 }
 223
 224 static const int slew_rates[] = {
 225         64000,
 226         32000,
 227         16000,
 228          8000,
 229          4000,
 230          2000,
 231          1000,
 232           500,
 233 };
 234
 235 static int fan53555_set_ramp(struct regulator_dev *rdev, int ramp)
 236 {
 237         struct fan53555_device_info *di = rdev_get_drvdata(rdev);
 238         int regval = -1, i;
 239
 240         for (i = 0; i < ARRAY_SIZE(slew_rates); i++) {
 241                 if (ramp <= slew_rates[i])
 242                         regval = i;
 243                 else
 244                         break;
 245         }
 246
 247         if (regval < 0) {
 248                 dev_err(di->dev, "unsupported ramp value %d\n", ramp);
 249                 return -EINVAL;
 250         }
 251
 252         return regmap_update_bits(di->regmap, FAN53555_CONTROL,
 253                                   CTL_SLEW_MASK, regval << CTL_SLEW_SHIFT);
 254 }
 255
 256 static struct regulator_ops fan53555_regulator_ops = {
 257         .set_voltage_sel = regulator_set_voltage_sel_regmap,
 258         .get_voltage_sel = regulator_get_voltage_sel_regmap,
 259         .set_voltage_time_sel = regulator_set_voltage_time_sel,
 260         .map_voltage = regulator_map_voltage_linear,
 261         .list_voltage = regulator_list_voltage_linear,
 262         .set_suspend_voltage = fan53555_set_suspend_voltage,
 263         .enable = fan53555_set_enable,
 264         .disable = fan53555_set_disable,
 265         .is_enabled = fan53555_is_enabled,
 266         .set_mode = fan53555_set_mode,
 267         .get_mode = fan53555_get_mode,
 268         .set_ramp_delay = fan53555_set_ramp,
 269         .set_suspend_enable = fan53555_set_suspend_enable,
 270         .set_suspend_disable = fan53555_set_suspend_disable,
 271 };
 272
 273 static int fan53555_voltages_setup_fairchild(struct fan53555_device_info *di)
 274 {
 275         /* Init voltage range and step */
 276         switch (di->chip_id) {
 277         case FAN53555_CHIP_ID_00:
 278         case FAN53555_CHIP_ID_01:
 279         case FAN53555_CHIP_ID_03:
 280         case FAN53555_CHIP_ID_05:
 281                 di->vsel_min = 600000;
 282                 di->vsel_step = 10000;
 283                 break;
 284         case FAN53555_CHIP_ID_04:
 285                 di->vsel_min = 603000;
 286                 di->vsel_step = 12826;
 287                 break;
 288         default:
 289                 dev_err(di->dev,
 290                         "Chip ID %d not supported!\n", di->chip_id);
 291                 return -EINVAL;
 292         }
 293
 294         return 0;
 295 }
 296
 297 static int fan53555_voltages_setup_silergy(struct fan53555_device_info *di)
 298 {
 299         /* Init voltage range and step */
 300         switch (di->chip_id) {
 301         case SILERGY_SYR82X:
 302                 di->vsel_min = 712500;
 303                 di->vsel_step = 12500;
 304                 break;
 305         default:
 306                 dev_err(di->dev,
 307                         "Chip ID %d not supported!\n", di->chip_id);
 308                 return -EINVAL;
 309         }
 310
 311         return 0;
 312 }
 313
 314 /* For 00,01,03,05 options:
 315  * VOUT = 0.60V + NSELx * 10mV, from 0.60 to 1.23V.
 316  * For 04 option:
 317  * VOUT = 0.603V + NSELx * 12.826mV, from 0.603 to 1.411V.
 318  * */
 319 static int fan53555_device_setup(struct fan53555_device_info *di,
 320                                 struct fan53555_platform_data *pdata)
 321 {
 322         int ret = 0;
 323
 324         /* Setup voltage control register */
 325         switch (pdata->sleep_vsel_id) {
 326         case FAN53555_VSEL_ID_0:
 327                 di->sleep_reg = FAN53555_VSEL0;
 328                 di->vol_reg = FAN53555_VSEL1;
 329                 break;
 330         case FAN53555_VSEL_ID_1:
 331                 di->sleep_reg = FAN53555_VSEL1;
 332                 di->vol_reg = FAN53555_VSEL0;
 333                 break;
 334         default:
 335                 dev_err(di->dev, "Invalid VSEL ID!\n");
 336                 return -EINVAL;
 337         }
 338
 339         switch (di->vendor) {
 340         case FAN53555_VENDOR_FAIRCHILD:
 341                 ret = fan53555_voltages_setup_fairchild(di);
 342                 break;
 343         case FAN53555_VENDOR_SILERGY:
 344                 ret = fan53555_voltages_setup_silergy(di);
 345                 break;
 346         default:
 347                 dev_err(di->dev, "vendor %d not supported!\n", di->vendor);
 348                 return -EINVAL;
 349         }
 350
 351         return ret;
 352 }
 353
 354 static int fan53555_regulator_register(struct fan53555_device_info *di,
 355                         struct regulator_config *config)
 356 {
 357         struct regulator_desc *rdesc = &di->desc;
 358
 359         rdesc->name = "fan53555-reg";
 360         rdesc->supply_name = "vin";
 361         rdesc->ops = &fan53555_regulator_ops;
 362         rdesc->type = REGULATOR_VOLTAGE;
 363         rdesc->n_voltages = FAN53555_NVOLTAGES;
 364         rdesc->enable_reg = di->vol_reg;
 365         rdesc->enable_mask = VSEL_BUCK_EN;
 366         rdesc->min_uV = di->vsel_min;
 367         rdesc->uV_step = di->vsel_step;
 368         rdesc->vsel_reg = di->vol_reg;
 369         rdesc->vsel_mask = VSEL_NSEL_MASK;
 370         rdesc->owner = THIS_MODULE;
 371         rdesc->enable_time = 400;
 372
 373         di->rdev = devm_regulator_register(di->dev, &di->desc, config);
 374         return PTR_ERR_OR_ZERO(di->rdev);
 375 }
 376
 377 static const struct regmap_config fan53555_regmap_config = {
 378         .reg_bits = 8,
 379         .val_bits = 8,
 380 };
 381
 382 static struct fan53555_platform_data *fan53555_parse_dt(struct device *dev,
 383                                               struct device_node *np,
 384                                               const struct regulator_desc *desc)
 385 {
 386         struct fan53555_platform_data *pdata;
 387         int ret, flag;
 388         u32 tmp;
 389
 390         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
 391         if (!pdata)
 392                 return NULL;
 393
 394         pdata->regulator = of_get_regulator_init_data(dev, np, desc);
 395         pdata->regulator->constraints.initial_state = PM_SUSPEND_MEM;
 396
 397         ret = of_property_read_u32(np, "fcs,suspend-voltage-selector",
 398                                    &tmp);
 399         if (!ret)
 400                 pdata->sleep_vsel_id = tmp;
 401
 402         if (pdata->sleep_vsel_id)
 403                 flag = GPIOD_OUT_LOW;
 404         else
 405                 flag = GPIOD_OUT_HIGH;
 406
 407         pdata->vsel_gpio =
 408                 devm_gpiod_get_index_optional(dev, "vsel", 0,
 409                                               flag);
 410         if (IS_ERR(pdata->vsel_gpio)) {
 411                 ret = PTR_ERR(pdata->vsel_gpio);
 412                 dev_err(dev, "failed to get vesl gpio (%d)\n", ret);
 413         }
 414
 415         return pdata;
 416 }
 417
 418 static const struct of_device_id fan53555_dt_ids[] = {
 419         {
 420                 .compatible = "fcs,fan53555",
 421                 .data = (void *)FAN53555_VENDOR_FAIRCHILD
 422         }, {
 423                 .compatible = "silergy,syr827",
 424                 .data = (void *)FAN53555_VENDOR_SILERGY,
 425         }, {
 426                 .compatible = "silergy,syr828",
 427                 .data = (void *)FAN53555_VENDOR_SILERGY,
 428         },
 429         { }
 430 };
 431 MODULE_DEVICE_TABLE(of, fan53555_dt_ids);
 432
 433 static int fan53555_regulator_probe(struct i2c_client *client,
 434                                 const struct i2c_device_id *id)
 435 {
 436         struct device_node *np = client->dev.of_node;
 437         struct fan53555_device_info *di;
 438         struct fan53555_platform_data *pdata;
 439         struct regulator_config config = { };
 440         unsigned int val;
 441         int ret;
 442
 443         di = devm_kzalloc(&client->dev, sizeof(struct fan53555_device_info),
 444                                         GFP_KERNEL);
 445         if (!di)
 446                 return -ENOMEM;
 447
 448         di->desc.of_map_mode = fan53555_map_mode;
 449
 450         pdata = dev_get_platdata(&client->dev);
 451         if (!pdata)
 452                 pdata = fan53555_parse_dt(&client->dev, np, &di->desc);
 453
 454         if (!pdata || !pdata->regulator) {
 455                 dev_err(&client->dev, "Platform data not found!\n");
 456                 return -ENODEV;
 457         }
 458
 459         di->vsel_gpio = pdata->vsel_gpio;
 460         di->sleep_vsel_id = pdata->sleep_vsel_id;
 461
 462         di->regulator = pdata->regulator;
 463         if (client->dev.of_node) {
 464                 const struct of_device_id *match;
 465
 466                 match = of_match_device(of_match_ptr(fan53555_dt_ids),
 467                                         &client->dev);
 468                 if (!match)
 469                         return -ENODEV;
 470
 471                 di->vendor = (unsigned long) match->data;
 472         } else {
 473                 /* if no ramp constraint set, get the pdata ramp_delay */
 474                 if (!di->regulator->constraints.ramp_delay) {
 475                         int slew_idx = (pdata->slew_rate & 0x7)
 476                                                 ? pdata->slew_rate : 0;
 477
 478                         di->regulator->constraints.ramp_delay
 479                                                 = slew_rates[slew_idx];
 480                 }
 481
 482                 di->vendor = id->driver_data;
 483         }
 484
 485         di->regmap = devm_regmap_init_i2c(client, &fan53555_regmap_config);
 486         if (IS_ERR(di->regmap)) {
 487                 dev_err(&client->dev, "Failed to allocate regmap!\n");
 488                 return PTR_ERR(di->regmap);
 489         }
 490         di->dev = &client->dev;
 491         i2c_set_clientdata(client, di);
 492         /* Get chip ID */
 493         ret = regmap_read(di->regmap, FAN53555_ID1, &val);
 494         if (ret < 0) {
 495                 dev_err(&client->dev, "Failed to get chip ID!\n");
 496                 return ret;
 497         }
 498         di->chip_id = val & DIE_ID;
 499         /* Get chip revision */
 500         ret = regmap_read(di->regmap, FAN53555_ID2, &val);
 501         if (ret < 0) {
 502                 dev_err(&client->dev, "Failed to get chip Rev!\n");
 503                 return ret;
 504         }
 505         di->chip_rev = val & DIE_REV;
 506         dev_info(&client->dev, "FAN53555 Option[%d] Rev[%d] Detected!\n",
 507                                 di->chip_id, di->chip_rev);
 508         /* Device init */
 509         ret = fan53555_device_setup(di, pdata);
 510         if (ret < 0) {
 511                 dev_err(&client->dev, "Failed to setup device!\n");
 512                 return ret;
 513         }
 514         /* Register regulator */
 515         config.dev = di->dev;
 516         config.init_data = di->regulator;
 517         config.regmap = di->regmap;
 518         config.driver_data = di;
 519         config.of_node = np;
 520
 521         ret = fan53555_regulator_register(di, &config);
 522         if (ret < 0)
 523                 dev_err(&client->dev, "Failed to register regulator!\n");
 524         return ret;
 525
 526 }
 527
 528 static const struct i2c_device_id fan53555_id[] = {
 529         {
 530                 .name = "fan53555",
 531                 .driver_data = FAN53555_VENDOR_FAIRCHILD
 532         }, {
 533                 .name = "syr82x",
 534                 .driver_data = FAN53555_VENDOR_SILERGY
 535         },
 536         { },
 537 };
 538 MODULE_DEVICE_TABLE(i2c, fan53555_id);
 539
 540 static struct i2c_driver fan53555_regulator_driver = {
 541         .driver = {
 542                 .name = "fan53555-regulator",
 543                 .of_match_table = of_match_ptr(fan53555_dt_ids),
 544         },
 545         .probe = fan53555_regulator_probe,
 546         .id_table = fan53555_id,
 547 };
 548
 549 module_i2c_driver(fan53555_regulator_driver);
 550
 551 MODULE_AUTHOR("Yunfan Zhang <yfzhang@marvell.com>");
 552 MODULE_DESCRIPTION("FAN53555 regulator driver");
 553 MODULE_LICENSE("GPL v2");