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