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