1 // SPDX-License-Identifier: GPL-2.0
3 // FAN53555 Fairchild Digitally Programmable TinyBuck Regulator Driver.
5 // Supported Part Numbers:
6 // FAN53555UC00X/01X/03X/04X/05X
8 // Copyright (c) 2012 Marvell Technology Ltd.
9 // Yunfan Zhang <yfzhang@marvell.com>
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>
25 #define FAN53555_VSEL0 0x00
26 #define FAN53555_VSEL1 0x01
28 #define TCS4525_VSEL0 0x11
29 #define TCS4525_VSEL1 0x10
30 #define TCS4525_TIME 0x13
31 #define TCS4525_COMMAND 0x14
33 /* Control register */
34 #define FAN53555_CONTROL 0x02
36 #define FAN53555_ID1 0x03
38 #define FAN53555_ID2 0x04
39 /* Monitor register */
40 #define FAN53555_MONITOR 0x05
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)
56 #define FAN53555_NVOLTAGES 64 /* Numbers of voltages */
57 #define FAN53526_NVOLTAGES 128
59 #define TCS_VSEL_NSEL_MASK 0x7f
60 #define TCS_VSEL0_MODE (1 << 7)
61 #define TCS_VSEL1_MODE (1 << 6)
63 #define TCS_SLEW_SHIFT 3
64 #define TCS_SLEW_MASK (0x3 < 3)
66 enum fan53555_vendor {
67 FAN53526_VENDOR_FAIRCHILD = 0,
68 FAN53555_VENDOR_FAIRCHILD,
69 FAN53555_VENDOR_SILERGY,
74 FAN53526_CHIP_ID_01 = 1,
78 FAN53526_CHIP_REV_08 = 8,
83 FAN53555_CHIP_ID_00 = 0,
89 FAN53555_CHIP_ID_08 = 8,
92 /* IC mask revision */
94 FAN53555_CHIP_REV_00 = 0x3,
95 FAN53555_CHIP_REV_13 = 0xf,
103 struct fan53555_device_info {
104 enum fan53555_vendor vendor;
106 struct regulator_desc desc;
107 struct regulator_init_data *regulator;
108 /* IC Type and Rev */
111 /* Voltage setting register */
112 unsigned int vol_reg;
113 unsigned int sleep_reg;
114 /* Voltage range and step(linear) */
115 unsigned int vsel_min;
116 unsigned int vsel_step;
117 unsigned int vsel_count;
119 unsigned int mode_reg;
120 unsigned int mode_mask;
121 /* Sleep voltage cache */
122 unsigned int sleep_vol_cache;
124 unsigned int slew_reg;
125 unsigned int slew_mask;
126 unsigned int slew_shift;
127 unsigned int slew_rate;
130 static int fan53555_set_suspend_voltage(struct regulator_dev *rdev, int uV)
132 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
135 if (di->sleep_vol_cache == uV)
137 ret = regulator_map_voltage_linear(rdev, uV, uV);
140 ret = regmap_update_bits(rdev->regmap, di->sleep_reg,
141 di->desc.vsel_mask, ret);
144 /* Cache the sleep voltage setting.
145 * Might not be the real voltage which is rounded */
146 di->sleep_vol_cache = uV;
151 static int fan53555_set_suspend_enable(struct regulator_dev *rdev)
153 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
155 return regmap_update_bits(rdev->regmap, di->sleep_reg,
156 VSEL_BUCK_EN, VSEL_BUCK_EN);
159 static int fan53555_set_suspend_disable(struct regulator_dev *rdev)
161 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
163 return regmap_update_bits(rdev->regmap, di->sleep_reg,
167 static int fan53555_set_mode(struct regulator_dev *rdev, unsigned int mode)
169 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
172 case REGULATOR_MODE_FAST:
173 regmap_update_bits(rdev->regmap, di->mode_reg,
174 di->mode_mask, di->mode_mask);
176 case REGULATOR_MODE_NORMAL:
177 regmap_update_bits(rdev->regmap, di->vol_reg, di->mode_mask, 0);
185 static unsigned int fan53555_get_mode(struct regulator_dev *rdev)
187 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
191 ret = regmap_read(rdev->regmap, di->mode_reg, &val);
194 if (val & di->mode_mask)
195 return REGULATOR_MODE_FAST;
197 return REGULATOR_MODE_NORMAL;
200 static const int slew_rates[] = {
211 static const int tcs_slew_rates[] = {
218 static int fan53555_set_ramp(struct regulator_dev *rdev, int ramp)
220 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
222 const int *slew_rate_t;
225 switch (di->vendor) {
226 case FAN53526_VENDOR_FAIRCHILD:
227 case FAN53555_VENDOR_FAIRCHILD:
228 case FAN53555_VENDOR_SILERGY:
229 slew_rate_t = slew_rates;
230 slew_rate_n = ARRAY_SIZE(slew_rates);
232 case FAN53555_VENDOR_TCS:
233 slew_rate_t = tcs_slew_rates;
234 slew_rate_n = ARRAY_SIZE(tcs_slew_rates);
240 for (i = 0; i < slew_rate_n; i++) {
241 if (ramp <= slew_rate_t[i])
248 dev_err(di->dev, "unsupported ramp value %d\n", ramp);
252 return regmap_update_bits(rdev->regmap, di->slew_reg,
253 di->slew_mask, regval << di->slew_shift);
256 static const struct regulator_ops fan53555_regulator_ops = {
257 .set_voltage_sel = regulator_set_voltage_sel_regmap,
258 .get_voltage_sel = regulator_get_voltage_sel_regmap,
259 .set_voltage_time_sel = regulator_set_voltage_time_sel,
260 .map_voltage = regulator_map_voltage_linear,
261 .list_voltage = regulator_list_voltage_linear,
262 .set_suspend_voltage = fan53555_set_suspend_voltage,
263 .enable = regulator_enable_regmap,
264 .disable = regulator_disable_regmap,
265 .is_enabled = regulator_is_enabled_regmap,
266 .set_mode = fan53555_set_mode,
267 .get_mode = fan53555_get_mode,
268 .set_ramp_delay = fan53555_set_ramp,
269 .set_suspend_enable = fan53555_set_suspend_enable,
270 .set_suspend_disable = fan53555_set_suspend_disable,
273 static int fan53526_voltages_setup_fairchild(struct fan53555_device_info *di)
275 /* Init voltage range and step */
276 switch (di->chip_id) {
277 case FAN53526_CHIP_ID_01:
278 switch (di->chip_rev) {
279 case FAN53526_CHIP_REV_08:
280 di->vsel_min = 600000;
281 di->vsel_step = 6250;
285 "Chip ID %d with rev %d not supported!\n",
286 di->chip_id, di->chip_rev);
292 "Chip ID %d not supported!\n", di->chip_id);
296 di->vsel_count = FAN53526_NVOLTAGES;
301 static int fan53555_voltages_setup_fairchild(struct fan53555_device_info *di)
303 /* Init voltage range and step */
304 switch (di->chip_id) {
305 case FAN53555_CHIP_ID_00:
306 switch (di->chip_rev) {
307 case FAN53555_CHIP_REV_00:
308 di->vsel_min = 600000;
309 di->vsel_step = 10000;
311 case FAN53555_CHIP_REV_13:
312 di->vsel_min = 800000;
313 di->vsel_step = 10000;
317 "Chip ID %d with rev %d not supported!\n",
318 di->chip_id, di->chip_rev);
322 case FAN53555_CHIP_ID_01:
323 case FAN53555_CHIP_ID_03:
324 case FAN53555_CHIP_ID_05:
325 case FAN53555_CHIP_ID_08:
326 di->vsel_min = 600000;
327 di->vsel_step = 10000;
329 case FAN53555_CHIP_ID_04:
330 di->vsel_min = 603000;
331 di->vsel_step = 12826;
335 "Chip ID %d not supported!\n", di->chip_id);
338 di->slew_reg = FAN53555_CONTROL;
339 di->slew_mask = CTL_SLEW_MASK;
340 di->slew_shift = CTL_SLEW_SHIFT;
341 di->vsel_count = FAN53555_NVOLTAGES;
346 static int fan53555_voltages_setup_silergy(struct fan53555_device_info *di)
348 /* Init voltage range and step */
349 switch (di->chip_id) {
352 di->vsel_min = 712500;
353 di->vsel_step = 12500;
357 "Chip ID %d not supported!\n", di->chip_id);
360 di->slew_reg = FAN53555_CONTROL;
361 di->slew_reg = FAN53555_CONTROL;
362 di->slew_mask = CTL_SLEW_MASK;
363 di->slew_shift = CTL_SLEW_SHIFT;
364 di->vsel_count = FAN53555_NVOLTAGES;
369 static int fan53555_voltages_setup_tcs(struct fan53555_device_info *di)
371 di->slew_reg = TCS4525_TIME;
372 di->slew_mask = TCS_SLEW_MASK;
373 di->slew_shift = TCS_SLEW_MASK;
375 /* Init voltage range and step */
376 di->vsel_min = 600000;
377 di->vsel_step = 6250;
378 di->vsel_count = FAN53526_NVOLTAGES;
383 /* For 00,01,03,05 options:
384 * VOUT = 0.60V + NSELx * 10mV, from 0.60 to 1.23V.
386 * VOUT = 0.603V + NSELx * 12.826mV, from 0.603 to 1.411V.
388 static int fan53555_device_setup(struct fan53555_device_info *di,
389 struct fan53555_platform_data *pdata)
393 /* Setup voltage control register */
394 switch (di->vendor) {
395 case FAN53526_VENDOR_FAIRCHILD:
396 case FAN53555_VENDOR_FAIRCHILD:
397 case FAN53555_VENDOR_SILERGY:
398 switch (pdata->sleep_vsel_id) {
399 case FAN53555_VSEL_ID_0:
400 di->sleep_reg = FAN53555_VSEL0;
401 di->vol_reg = FAN53555_VSEL1;
403 case FAN53555_VSEL_ID_1:
404 di->sleep_reg = FAN53555_VSEL1;
405 di->vol_reg = FAN53555_VSEL0;
408 dev_err(di->dev, "Invalid VSEL ID!\n");
412 case FAN53555_VENDOR_TCS:
413 switch (pdata->sleep_vsel_id) {
414 case FAN53555_VSEL_ID_0:
415 di->sleep_reg = TCS4525_VSEL0;
416 di->vol_reg = TCS4525_VSEL1;
418 case FAN53555_VSEL_ID_1:
419 di->sleep_reg = TCS4525_VSEL1;
420 di->vol_reg = TCS4525_VSEL0;
423 dev_err(di->dev, "Invalid VSEL ID!\n");
428 dev_err(di->dev, "vendor %d not supported!\n", di->vendor);
432 /* Setup mode control register */
433 switch (di->vendor) {
434 case FAN53526_VENDOR_FAIRCHILD:
435 di->mode_reg = FAN53555_CONTROL;
437 switch (pdata->sleep_vsel_id) {
438 case FAN53555_VSEL_ID_0:
439 di->mode_mask = CTL_MODE_VSEL1_MODE;
441 case FAN53555_VSEL_ID_1:
442 di->mode_mask = CTL_MODE_VSEL0_MODE;
446 case FAN53555_VENDOR_FAIRCHILD:
447 case FAN53555_VENDOR_SILERGY:
448 di->mode_reg = di->vol_reg;
449 di->mode_mask = VSEL_MODE;
451 case FAN53555_VENDOR_TCS:
452 di->mode_reg = TCS4525_COMMAND;
454 switch (pdata->sleep_vsel_id) {
455 case FAN53555_VSEL_ID_0:
456 di->mode_mask = TCS_VSEL1_MODE;
458 case FAN53555_VSEL_ID_1:
459 di->mode_mask = TCS_VSEL0_MODE;
464 dev_err(di->dev, "vendor %d not supported!\n", di->vendor);
468 /* Setup voltage range */
469 switch (di->vendor) {
470 case FAN53526_VENDOR_FAIRCHILD:
471 ret = fan53526_voltages_setup_fairchild(di);
473 case FAN53555_VENDOR_FAIRCHILD:
474 ret = fan53555_voltages_setup_fairchild(di);
476 case FAN53555_VENDOR_SILERGY:
477 ret = fan53555_voltages_setup_silergy(di);
479 case FAN53555_VENDOR_TCS:
480 ret = fan53555_voltages_setup_tcs(di);
483 dev_err(di->dev, "vendor %d not supported!\n", di->vendor);
490 static int fan53555_regulator_register(struct fan53555_device_info *di,
491 struct regulator_config *config)
493 struct regulator_desc *rdesc = &di->desc;
494 struct regulator_dev *rdev;
496 rdesc->name = "fan53555-reg";
497 rdesc->supply_name = "vin";
498 rdesc->ops = &fan53555_regulator_ops;
499 rdesc->type = REGULATOR_VOLTAGE;
500 rdesc->n_voltages = di->vsel_count;
501 rdesc->enable_reg = di->vol_reg;
502 rdesc->enable_mask = VSEL_BUCK_EN;
503 rdesc->min_uV = di->vsel_min;
504 rdesc->uV_step = di->vsel_step;
505 rdesc->vsel_reg = di->vol_reg;
506 rdesc->vsel_mask = di->vsel_count - 1;
507 rdesc->owner = THIS_MODULE;
509 rdev = devm_regulator_register(di->dev, &di->desc, config);
510 return PTR_ERR_OR_ZERO(rdev);
513 static const struct regmap_config fan53555_regmap_config = {
518 static struct fan53555_platform_data *fan53555_parse_dt(struct device *dev,
519 struct device_node *np,
520 const struct regulator_desc *desc)
522 struct fan53555_platform_data *pdata;
526 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
530 pdata->regulator = of_get_regulator_init_data(dev, np, desc);
532 ret = of_property_read_u32(np, "fcs,suspend-voltage-selector",
535 pdata->sleep_vsel_id = tmp;
540 static const struct of_device_id __maybe_unused fan53555_dt_ids[] = {
542 .compatible = "fcs,fan53526",
543 .data = (void *)FAN53526_VENDOR_FAIRCHILD,
545 .compatible = "fcs,fan53555",
546 .data = (void *)FAN53555_VENDOR_FAIRCHILD
548 .compatible = "silergy,syr827",
549 .data = (void *)FAN53555_VENDOR_SILERGY,
551 .compatible = "silergy,syr828",
552 .data = (void *)FAN53555_VENDOR_SILERGY,
554 .compatible = "tcs,tcs4525",
555 .data = (void *)FAN53555_VENDOR_TCS
559 MODULE_DEVICE_TABLE(of, fan53555_dt_ids);
561 static int fan53555_regulator_probe(struct i2c_client *client,
562 const struct i2c_device_id *id)
564 struct device_node *np = client->dev.of_node;
565 struct fan53555_device_info *di;
566 struct fan53555_platform_data *pdata;
567 struct regulator_config config = { };
568 struct regmap *regmap;
572 di = devm_kzalloc(&client->dev, sizeof(struct fan53555_device_info),
577 pdata = dev_get_platdata(&client->dev);
579 pdata = fan53555_parse_dt(&client->dev, np, &di->desc);
581 if (!pdata || !pdata->regulator) {
582 dev_err(&client->dev, "Platform data not found!\n");
586 di->regulator = pdata->regulator;
587 if (client->dev.of_node) {
589 (unsigned long)of_device_get_match_data(&client->dev);
591 /* if no ramp constraint set, get the pdata ramp_delay */
592 if (!di->regulator->constraints.ramp_delay) {
593 if (pdata->slew_rate >= ARRAY_SIZE(slew_rates)) {
594 dev_err(&client->dev, "Invalid slew_rate\n");
598 di->regulator->constraints.ramp_delay
599 = slew_rates[pdata->slew_rate];
602 di->vendor = id->driver_data;
605 regmap = devm_regmap_init_i2c(client, &fan53555_regmap_config);
606 if (IS_ERR(regmap)) {
607 dev_err(&client->dev, "Failed to allocate regmap!\n");
608 return PTR_ERR(regmap);
610 di->dev = &client->dev;
611 i2c_set_clientdata(client, di);
613 ret = regmap_read(regmap, FAN53555_ID1, &val);
615 dev_err(&client->dev, "Failed to get chip ID!\n");
618 di->chip_id = val & DIE_ID;
619 /* Get chip revision */
620 ret = regmap_read(regmap, FAN53555_ID2, &val);
622 dev_err(&client->dev, "Failed to get chip Rev!\n");
625 di->chip_rev = val & DIE_REV;
626 dev_info(&client->dev, "FAN53555 Option[%d] Rev[%d] Detected!\n",
627 di->chip_id, di->chip_rev);
629 ret = fan53555_device_setup(di, pdata);
631 dev_err(&client->dev, "Failed to setup device!\n");
634 /* Register regulator */
635 config.dev = di->dev;
636 config.init_data = di->regulator;
637 config.regmap = regmap;
638 config.driver_data = di;
641 ret = fan53555_regulator_register(di, &config);
643 dev_err(&client->dev, "Failed to register regulator!\n");
648 static const struct i2c_device_id fan53555_id[] = {
651 .driver_data = FAN53526_VENDOR_FAIRCHILD
654 .driver_data = FAN53555_VENDOR_FAIRCHILD
657 .driver_data = FAN53555_VENDOR_SILERGY
660 .driver_data = FAN53555_VENDOR_SILERGY
663 .driver_data = FAN53555_VENDOR_TCS
667 MODULE_DEVICE_TABLE(i2c, fan53555_id);
669 static struct i2c_driver fan53555_regulator_driver = {
671 .name = "fan53555-regulator",
672 .of_match_table = of_match_ptr(fan53555_dt_ids),
674 .probe = fan53555_regulator_probe,
675 .id_table = fan53555_id,
678 module_i2c_driver(fan53555_regulator_driver);
680 MODULE_AUTHOR("Yunfan Zhang <yfzhang@marvell.com>");
681 MODULE_DESCRIPTION("FAN53555 regulator driver");
682 MODULE_LICENSE("GPL v2");