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