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