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