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/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>
26 #define FAN53555_VSEL0 0x00
27 #define FAN53555_VSEL1 0x01
28 /* Control register */
29 #define FAN53555_CONTROL 0x02
31 #define FAN53555_ID1 0x03
33 #define FAN53555_ID2 0x04
34 /* Monitor register */
35 #define FAN53555_MONITOR 0x05
37 /* VSEL bit definitions */
38 #define VSEL_BUCK_EN (1 << 7)
39 #define VSEL_MODE (1 << 6)
40 /* Chip ID and Verison */
41 #define DIE_ID 0x0F /* ID1 */
42 #define DIE_REV 0x0F /* ID2 */
43 /* Control bit definitions */
44 #define CTL_OUTPUT_DISCHG (1 << 7)
45 #define CTL_SLEW_MASK (0x7 << 4)
46 #define CTL_SLEW_SHIFT 4
47 #define CTL_RESET (1 << 2)
48 #define CTL_MODE_VSEL0_MODE BIT(0)
49 #define CTL_MODE_VSEL1_MODE BIT(1)
51 #define FAN53555_NVOLTAGES 64 /* Numbers of voltages */
52 #define FAN53526_NVOLTAGES 128
54 enum fan53555_vendor {
55 FAN53526_VENDOR_FAIRCHILD = 0,
56 FAN53555_VENDOR_FAIRCHILD,
57 FAN53555_VENDOR_SILERGY,
61 FAN53526_CHIP_ID_01 = 1,
65 FAN53526_CHIP_REV_08 = 8,
70 FAN53555_CHIP_ID_00 = 0,
76 FAN53555_CHIP_ID_08 = 8,
79 /* IC mask revision */
81 FAN53555_CHIP_REV_00 = 0x3,
82 FAN53555_CHIP_REV_13 = 0xf,
90 struct fan53555_device_info {
91 enum fan53555_vendor vendor;
93 struct regulator_desc desc;
94 struct regulator_init_data *regulator;
98 /* Voltage setting register */
100 unsigned int sleep_reg;
101 /* Voltage range and step(linear) */
102 unsigned int vsel_min;
103 unsigned int vsel_step;
104 unsigned int vsel_count;
106 unsigned int mode_reg;
107 unsigned int mode_mask;
108 /* Sleep voltage cache */
109 unsigned int sleep_vol_cache;
112 static int fan53555_set_suspend_voltage(struct regulator_dev *rdev, int uV)
114 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
117 if (di->sleep_vol_cache == uV)
119 ret = regulator_map_voltage_linear(rdev, uV, uV);
122 ret = regmap_update_bits(rdev->regmap, di->sleep_reg,
123 di->desc.vsel_mask, ret);
126 /* Cache the sleep voltage setting.
127 * Might not be the real voltage which is rounded */
128 di->sleep_vol_cache = uV;
133 static int fan53555_set_suspend_enable(struct regulator_dev *rdev)
135 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
137 return regmap_update_bits(rdev->regmap, di->sleep_reg,
138 VSEL_BUCK_EN, VSEL_BUCK_EN);
141 static int fan53555_set_suspend_disable(struct regulator_dev *rdev)
143 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
145 return regmap_update_bits(rdev->regmap, di->sleep_reg,
149 static int fan53555_set_mode(struct regulator_dev *rdev, unsigned int mode)
151 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
154 case REGULATOR_MODE_FAST:
155 regmap_update_bits(rdev->regmap, di->mode_reg,
156 di->mode_mask, di->mode_mask);
158 case REGULATOR_MODE_NORMAL:
159 regmap_update_bits(rdev->regmap, di->vol_reg, di->mode_mask, 0);
167 static unsigned int fan53555_get_mode(struct regulator_dev *rdev)
169 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
173 ret = regmap_read(rdev->regmap, di->mode_reg, &val);
176 if (val & di->mode_mask)
177 return REGULATOR_MODE_FAST;
179 return REGULATOR_MODE_NORMAL;
182 static const int slew_rates[] = {
193 static int fan53555_set_ramp(struct regulator_dev *rdev, int ramp)
195 struct fan53555_device_info *di = rdev_get_drvdata(rdev);
198 for (i = 0; i < ARRAY_SIZE(slew_rates); i++) {
199 if (ramp <= slew_rates[i])
206 dev_err(di->dev, "unsupported ramp value %d\n", ramp);
210 return regmap_update_bits(rdev->regmap, FAN53555_CONTROL,
211 CTL_SLEW_MASK, regval << CTL_SLEW_SHIFT);
214 static const struct regulator_ops fan53555_regulator_ops = {
215 .set_voltage_sel = regulator_set_voltage_sel_regmap,
216 .get_voltage_sel = regulator_get_voltage_sel_regmap,
217 .set_voltage_time_sel = regulator_set_voltage_time_sel,
218 .map_voltage = regulator_map_voltage_linear,
219 .list_voltage = regulator_list_voltage_linear,
220 .set_suspend_voltage = fan53555_set_suspend_voltage,
221 .enable = regulator_enable_regmap,
222 .disable = regulator_disable_regmap,
223 .is_enabled = regulator_is_enabled_regmap,
224 .set_mode = fan53555_set_mode,
225 .get_mode = fan53555_get_mode,
226 .set_ramp_delay = fan53555_set_ramp,
227 .set_suspend_enable = fan53555_set_suspend_enable,
228 .set_suspend_disable = fan53555_set_suspend_disable,
231 static int fan53526_voltages_setup_fairchild(struct fan53555_device_info *di)
233 /* Init voltage range and step */
234 switch (di->chip_id) {
235 case FAN53526_CHIP_ID_01:
236 switch (di->chip_rev) {
237 case FAN53526_CHIP_REV_08:
238 di->vsel_min = 600000;
239 di->vsel_step = 6250;
243 "Chip ID %d with rev %d not supported!\n",
244 di->chip_id, di->chip_rev);
250 "Chip ID %d not supported!\n", di->chip_id);
254 di->vsel_count = FAN53526_NVOLTAGES;
259 static int fan53555_voltages_setup_fairchild(struct fan53555_device_info *di)
261 /* Init voltage range and step */
262 switch (di->chip_id) {
263 case FAN53555_CHIP_ID_00:
264 switch (di->chip_rev) {
265 case FAN53555_CHIP_REV_00:
266 di->vsel_min = 600000;
267 di->vsel_step = 10000;
269 case FAN53555_CHIP_REV_13:
270 di->vsel_min = 800000;
271 di->vsel_step = 10000;
275 "Chip ID %d with rev %d not supported!\n",
276 di->chip_id, di->chip_rev);
280 case FAN53555_CHIP_ID_01:
281 case FAN53555_CHIP_ID_03:
282 case FAN53555_CHIP_ID_05:
283 case FAN53555_CHIP_ID_08:
284 di->vsel_min = 600000;
285 di->vsel_step = 10000;
287 case FAN53555_CHIP_ID_04:
288 di->vsel_min = 603000;
289 di->vsel_step = 12826;
293 "Chip ID %d not supported!\n", di->chip_id);
297 di->vsel_count = FAN53555_NVOLTAGES;
302 static int fan53555_voltages_setup_silergy(struct fan53555_device_info *di)
304 /* Init voltage range and step */
305 switch (di->chip_id) {
308 di->vsel_min = 712500;
309 di->vsel_step = 12500;
313 "Chip ID %d not supported!\n", di->chip_id);
317 di->vsel_count = FAN53555_NVOLTAGES;
322 /* For 00,01,03,05 options:
323 * VOUT = 0.60V + NSELx * 10mV, from 0.60 to 1.23V.
325 * VOUT = 0.603V + NSELx * 12.826mV, from 0.603 to 1.411V.
327 static int fan53555_device_setup(struct fan53555_device_info *di,
328 struct fan53555_platform_data *pdata)
332 /* Setup voltage control register */
333 switch (pdata->sleep_vsel_id) {
334 case FAN53555_VSEL_ID_0:
335 di->sleep_reg = FAN53555_VSEL0;
336 di->vol_reg = FAN53555_VSEL1;
338 case FAN53555_VSEL_ID_1:
339 di->sleep_reg = FAN53555_VSEL1;
340 di->vol_reg = FAN53555_VSEL0;
343 dev_err(di->dev, "Invalid VSEL ID!\n");
347 /* Setup mode control register */
348 switch (di->vendor) {
349 case FAN53526_VENDOR_FAIRCHILD:
350 di->mode_reg = FAN53555_CONTROL;
352 switch (pdata->sleep_vsel_id) {
353 case FAN53555_VSEL_ID_0:
354 di->mode_mask = CTL_MODE_VSEL1_MODE;
356 case FAN53555_VSEL_ID_1:
357 di->mode_mask = CTL_MODE_VSEL0_MODE;
361 case FAN53555_VENDOR_FAIRCHILD:
362 case FAN53555_VENDOR_SILERGY:
363 di->mode_reg = di->vol_reg;
364 di->mode_mask = VSEL_MODE;
367 dev_err(di->dev, "vendor %d not supported!\n", di->vendor);
371 /* Setup voltage range */
372 switch (di->vendor) {
373 case FAN53526_VENDOR_FAIRCHILD:
374 ret = fan53526_voltages_setup_fairchild(di);
376 case FAN53555_VENDOR_FAIRCHILD:
377 ret = fan53555_voltages_setup_fairchild(di);
379 case FAN53555_VENDOR_SILERGY:
380 ret = fan53555_voltages_setup_silergy(di);
383 dev_err(di->dev, "vendor %d not supported!\n", di->vendor);
390 static int fan53555_regulator_register(struct fan53555_device_info *di,
391 struct regulator_config *config)
393 struct regulator_desc *rdesc = &di->desc;
394 struct regulator_dev *rdev;
396 rdesc->name = "fan53555-reg";
397 rdesc->supply_name = "vin";
398 rdesc->ops = &fan53555_regulator_ops;
399 rdesc->type = REGULATOR_VOLTAGE;
400 rdesc->n_voltages = di->vsel_count;
401 rdesc->enable_reg = di->vol_reg;
402 rdesc->enable_mask = VSEL_BUCK_EN;
403 rdesc->min_uV = di->vsel_min;
404 rdesc->uV_step = di->vsel_step;
405 rdesc->vsel_reg = di->vol_reg;
406 rdesc->vsel_mask = di->vsel_count - 1;
407 rdesc->owner = THIS_MODULE;
409 rdev = devm_regulator_register(di->dev, &di->desc, config);
410 return PTR_ERR_OR_ZERO(rdev);
413 static const struct regmap_config fan53555_regmap_config = {
418 static struct fan53555_platform_data *fan53555_parse_dt(struct device *dev,
419 struct device_node *np,
420 const struct regulator_desc *desc)
422 struct fan53555_platform_data *pdata;
426 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
430 pdata->regulator = of_get_regulator_init_data(dev, np, desc);
432 ret = of_property_read_u32(np, "fcs,suspend-voltage-selector",
435 pdata->sleep_vsel_id = tmp;
440 static const struct of_device_id __maybe_unused fan53555_dt_ids[] = {
442 .compatible = "fcs,fan53526",
443 .data = (void *)FAN53526_VENDOR_FAIRCHILD,
445 .compatible = "fcs,fan53555",
446 .data = (void *)FAN53555_VENDOR_FAIRCHILD
448 .compatible = "silergy,syr827",
449 .data = (void *)FAN53555_VENDOR_SILERGY,
451 .compatible = "silergy,syr828",
452 .data = (void *)FAN53555_VENDOR_SILERGY,
456 MODULE_DEVICE_TABLE(of, fan53555_dt_ids);
458 static int fan53555_regulator_probe(struct i2c_client *client,
459 const struct i2c_device_id *id)
461 struct device_node *np = client->dev.of_node;
462 struct fan53555_device_info *di;
463 struct fan53555_platform_data *pdata;
464 struct regulator_config config = { };
465 struct regmap *regmap;
469 di = devm_kzalloc(&client->dev, sizeof(struct fan53555_device_info),
474 pdata = dev_get_platdata(&client->dev);
476 pdata = fan53555_parse_dt(&client->dev, np, &di->desc);
478 if (!pdata || !pdata->regulator) {
479 dev_err(&client->dev, "Platform data not found!\n");
483 di->regulator = pdata->regulator;
484 if (client->dev.of_node) {
486 (unsigned long)of_device_get_match_data(&client->dev);
488 /* if no ramp constraint set, get the pdata ramp_delay */
489 if (!di->regulator->constraints.ramp_delay) {
490 if (pdata->slew_rate >= ARRAY_SIZE(slew_rates)) {
491 dev_err(&client->dev, "Invalid slew_rate\n");
495 di->regulator->constraints.ramp_delay
496 = slew_rates[pdata->slew_rate];
499 di->vendor = id->driver_data;
502 regmap = devm_regmap_init_i2c(client, &fan53555_regmap_config);
503 if (IS_ERR(regmap)) {
504 dev_err(&client->dev, "Failed to allocate regmap!\n");
505 return PTR_ERR(regmap);
507 di->dev = &client->dev;
508 i2c_set_clientdata(client, di);
510 ret = regmap_read(regmap, FAN53555_ID1, &val);
512 dev_err(&client->dev, "Failed to get chip ID!\n");
515 di->chip_id = val & DIE_ID;
516 /* Get chip revision */
517 ret = regmap_read(regmap, FAN53555_ID2, &val);
519 dev_err(&client->dev, "Failed to get chip Rev!\n");
522 di->chip_rev = val & DIE_REV;
523 dev_info(&client->dev, "FAN53555 Option[%d] Rev[%d] Detected!\n",
524 di->chip_id, di->chip_rev);
526 ret = fan53555_device_setup(di, pdata);
528 dev_err(&client->dev, "Failed to setup device!\n");
531 /* Register regulator */
532 config.dev = di->dev;
533 config.init_data = di->regulator;
534 config.regmap = regmap;
535 config.driver_data = di;
538 ret = fan53555_regulator_register(di, &config);
540 dev_err(&client->dev, "Failed to register regulator!\n");
545 static const struct i2c_device_id fan53555_id[] = {
548 .driver_data = FAN53526_VENDOR_FAIRCHILD
551 .driver_data = FAN53555_VENDOR_FAIRCHILD
554 .driver_data = FAN53555_VENDOR_SILERGY
557 .driver_data = FAN53555_VENDOR_SILERGY
561 MODULE_DEVICE_TABLE(i2c, fan53555_id);
563 static struct i2c_driver fan53555_regulator_driver = {
565 .name = "fan53555-regulator",
566 .of_match_table = of_match_ptr(fan53555_dt_ids),
568 .probe = fan53555_regulator_probe,
569 .id_table = fan53555_id,
572 module_i2c_driver(fan53555_regulator_driver);
574 MODULE_AUTHOR("Yunfan Zhang <yfzhang@marvell.com>");
575 MODULE_DESCRIPTION("FAN53555 regulator driver");
576 MODULE_LICENSE("GPL v2");