drivers/regulator/fan53555.c

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