1 /*
2  * pv88060-regulator.c - Regulator device driver for PV88060
3  * Copyright (C) 2015  Powerventure Semiconductor Ltd.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  */
15 
16 #include <linux/err.h>
17 #include <linux/i2c.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/slab.h>
21 #include <linux/regulator/driver.h>
22 #include <linux/regulator/machine.h>
23 #include <linux/regmap.h>
24 #include <linux/irq.h>
25 #include <linux/interrupt.h>
26 #include <linux/regulator/of_regulator.h>
27 #include "pv88060-regulator.h"
28 
29 #define PV88060_MAX_REGULATORS	14
30 
31 /* PV88060 REGULATOR IDs */
32 enum {
33 	/* BUCKs */
34 	PV88060_ID_BUCK1,
35 
36 	/* LDOs */
37 	PV88060_ID_LDO1,
38 	PV88060_ID_LDO2,
39 	PV88060_ID_LDO3,
40 	PV88060_ID_LDO4,
41 	PV88060_ID_LDO5,
42 	PV88060_ID_LDO6,
43 	PV88060_ID_LDO7,
44 
45 	/* SWTs */
46 	PV88060_ID_SW1,
47 	PV88060_ID_SW2,
48 	PV88060_ID_SW3,
49 	PV88060_ID_SW4,
50 	PV88060_ID_SW5,
51 	PV88060_ID_SW6,
52 };
53 
54 struct pv88060_regulator {
55 	struct regulator_desc desc;
56 	/* Current limiting */
57 	unsigned	n_current_limits;
58 	const int	*current_limits;
59 	unsigned int limit_mask;
60 	unsigned int conf;		/* buck configuration register */
61 };
62 
63 struct pv88060 {
64 	struct device *dev;
65 	struct regmap *regmap;
66 	struct regulator_dev *rdev[PV88060_MAX_REGULATORS];
67 };
68 
69 static const struct regmap_config pv88060_regmap_config = {
70 	.reg_bits = 8,
71 	.val_bits = 8,
72 };
73 
74 /* Current limits array (in uA) for BUCK1
75  * Entry indexes corresponds to register values.
76  */
77 
78 static const int pv88060_buck1_limits[] = {
79 	1496000, 2393000, 3291000, 4189000
80 };
81 
82 static unsigned int pv88060_buck_get_mode(struct regulator_dev *rdev)
83 {
84 	struct pv88060_regulator *info = rdev_get_drvdata(rdev);
85 	unsigned int data;
86 	int ret, mode = 0;
87 
88 	ret = regmap_read(rdev->regmap, info->conf, &data);
89 	if (ret < 0)
90 		return ret;
91 
92 	switch (data & PV88060_BUCK_MODE_MASK) {
93 	case PV88060_BUCK_MODE_SYNC:
94 		mode = REGULATOR_MODE_FAST;
95 		break;
96 	case PV88060_BUCK_MODE_AUTO:
97 		mode = REGULATOR_MODE_NORMAL;
98 		break;
99 	case PV88060_BUCK_MODE_SLEEP:
100 		mode = REGULATOR_MODE_STANDBY;
101 		break;
102 	}
103 
104 	return mode;
105 }
106 
107 static int pv88060_buck_set_mode(struct regulator_dev *rdev,
108 					unsigned int mode)
109 {
110 	struct pv88060_regulator *info = rdev_get_drvdata(rdev);
111 	int val = 0;
112 
113 	switch (mode) {
114 	case REGULATOR_MODE_FAST:
115 		val = PV88060_BUCK_MODE_SYNC;
116 		break;
117 	case REGULATOR_MODE_NORMAL:
118 		val = PV88060_BUCK_MODE_AUTO;
119 		break;
120 	case REGULATOR_MODE_STANDBY:
121 		val = PV88060_BUCK_MODE_SLEEP;
122 		break;
123 	default:
124 		return -EINVAL;
125 	}
126 
127 	return regmap_update_bits(rdev->regmap, info->conf,
128 					PV88060_BUCK_MODE_MASK, val);
129 }
130 
131 static int pv88060_set_current_limit(struct regulator_dev *rdev, int min,
132 				    int max)
133 {
134 	struct pv88060_regulator *info = rdev_get_drvdata(rdev);
135 	int i;
136 
137 	/* search for closest to maximum */
138 	for (i = info->n_current_limits; i >= 0; i--) {
139 		if (min <= info->current_limits[i]
140 			&& max >= info->current_limits[i]) {
141 			return regmap_update_bits(rdev->regmap,
142 				info->conf,
143 				info->limit_mask,
144 				i << PV88060_BUCK_ILIM_SHIFT);
145 		}
146 	}
147 
148 	return -EINVAL;
149 }
150 
151 static int pv88060_get_current_limit(struct regulator_dev *rdev)
152 {
153 	struct pv88060_regulator *info = rdev_get_drvdata(rdev);
154 	unsigned int data;
155 	int ret;
156 
157 	ret = regmap_read(rdev->regmap, info->conf, &data);
158 	if (ret < 0)
159 		return ret;
160 
161 	data = (data & info->limit_mask) >> PV88060_BUCK_ILIM_SHIFT;
162 	return info->current_limits[data];
163 }
164 
165 static const struct regulator_ops pv88060_buck_ops = {
166 	.get_mode = pv88060_buck_get_mode,
167 	.set_mode = pv88060_buck_set_mode,
168 	.enable = regulator_enable_regmap,
169 	.disable = regulator_disable_regmap,
170 	.is_enabled = regulator_is_enabled_regmap,
171 	.set_voltage_sel = regulator_set_voltage_sel_regmap,
172 	.get_voltage_sel = regulator_get_voltage_sel_regmap,
173 	.list_voltage = regulator_list_voltage_linear,
174 	.set_current_limit = pv88060_set_current_limit,
175 	.get_current_limit = pv88060_get_current_limit,
176 };
177 
178 static const struct regulator_ops pv88060_ldo_ops = {
179 	.enable = regulator_enable_regmap,
180 	.disable = regulator_disable_regmap,
181 	.is_enabled = regulator_is_enabled_regmap,
182 	.set_voltage_sel = regulator_set_voltage_sel_regmap,
183 	.get_voltage_sel = regulator_get_voltage_sel_regmap,
184 	.list_voltage = regulator_list_voltage_linear,
185 };
186 
187 #define PV88060_BUCK(chip, regl_name, min, step, max, limits_array) \
188 {\
189 	.desc	=	{\
190 		.id = chip##_ID_##regl_name,\
191 		.name = __stringify(chip##_##regl_name),\
192 		.of_match = of_match_ptr(#regl_name),\
193 		.regulators_node = of_match_ptr("regulators"),\
194 		.type = REGULATOR_VOLTAGE,\
195 		.owner = THIS_MODULE,\
196 		.ops = &pv88060_buck_ops,\
197 		.min_uV = min,\
198 		.uV_step = step,\
199 		.n_voltages = ((max) - (min))/(step) + 1,\
200 		.enable_reg = PV88060_REG_##regl_name##_CONF0,\
201 		.enable_mask = PV88060_BUCK_EN, \
202 		.vsel_reg = PV88060_REG_##regl_name##_CONF0,\
203 		.vsel_mask = PV88060_VBUCK_MASK,\
204 	},\
205 	.current_limits = limits_array,\
206 	.n_current_limits = ARRAY_SIZE(limits_array),\
207 	.limit_mask = PV88060_BUCK_ILIM_MASK, \
208 	.conf = PV88060_REG_##regl_name##_CONF1,\
209 }
210 
211 #define PV88060_LDO(chip, regl_name, min, step, max) \
212 {\
213 	.desc	=	{\
214 		.id = chip##_ID_##regl_name,\
215 		.name = __stringify(chip##_##regl_name),\
216 		.of_match = of_match_ptr(#regl_name),\
217 		.regulators_node = of_match_ptr("regulators"),\
218 		.type = REGULATOR_VOLTAGE,\
219 		.owner = THIS_MODULE,\
220 		.ops = &pv88060_ldo_ops,\
221 		.min_uV = min, \
222 		.uV_step = step, \
223 		.n_voltages = (step) ? ((max - min) / step + 1) : 1, \
224 		.enable_reg = PV88060_REG_##regl_name##_CONF, \
225 		.enable_mask = PV88060_LDO_EN, \
226 		.vsel_reg = PV88060_REG_##regl_name##_CONF, \
227 		.vsel_mask = PV88060_VLDO_MASK, \
228 	},\
229 }
230 
231 #define PV88060_SW(chip, regl_name, max) \
232 {\
233 	.desc	=	{\
234 		.id = chip##_ID_##regl_name,\
235 		.name = __stringify(chip##_##regl_name),\
236 		.of_match = of_match_ptr(#regl_name),\
237 		.regulators_node = of_match_ptr("regulators"),\
238 		.type = REGULATOR_VOLTAGE,\
239 		.owner = THIS_MODULE,\
240 		.ops = &pv88060_ldo_ops,\
241 		.min_uV = max,\
242 		.uV_step = 0,\
243 		.n_voltages = 1,\
244 		.enable_reg = PV88060_REG_##regl_name##_CONF,\
245 		.enable_mask = PV88060_SW_EN,\
246 	},\
247 }
248 
249 static const struct pv88060_regulator pv88060_regulator_info[] = {
250 	PV88060_BUCK(PV88060, BUCK1, 2800000, 12500, 4387500,
251 		pv88060_buck1_limits),
252 	PV88060_LDO(PV88060, LDO1, 1200000, 50000, 3350000),
253 	PV88060_LDO(PV88060, LDO2, 1200000, 50000, 3350000),
254 	PV88060_LDO(PV88060, LDO3, 1200000, 50000, 3350000),
255 	PV88060_LDO(PV88060, LDO4, 1200000, 50000, 3350000),
256 	PV88060_LDO(PV88060, LDO5, 1200000, 50000, 3350000),
257 	PV88060_LDO(PV88060, LDO6, 1200000, 50000, 3350000),
258 	PV88060_LDO(PV88060, LDO7, 1200000, 50000, 3350000),
259 	PV88060_SW(PV88060, SW1, 5000000),
260 	PV88060_SW(PV88060, SW2, 5000000),
261 	PV88060_SW(PV88060, SW3, 5000000),
262 	PV88060_SW(PV88060, SW4, 5000000),
263 	PV88060_SW(PV88060, SW5, 5000000),
264 	PV88060_SW(PV88060, SW6, 5000000),
265 };
266 
267 static irqreturn_t pv88060_irq_handler(int irq, void *data)
268 {
269 	struct pv88060 *chip = data;
270 	int i, reg_val, err, ret = IRQ_NONE;
271 
272 	err = regmap_read(chip->regmap, PV88060_REG_EVENT_A, &reg_val);
273 	if (err < 0)
274 		goto error_i2c;
275 
276 	if (reg_val & PV88060_E_VDD_FLT) {
277 		for (i = 0; i < PV88060_MAX_REGULATORS; i++) {
278 			if (chip->rdev[i] != NULL) {
279 				regulator_notifier_call_chain(chip->rdev[i],
280 					REGULATOR_EVENT_UNDER_VOLTAGE,
281 					NULL);
282 			}
283 		}
284 
285 		err = regmap_write(chip->regmap, PV88060_REG_EVENT_A,
286 			PV88060_E_VDD_FLT);
287 		if (err < 0)
288 			goto error_i2c;
289 
290 		ret = IRQ_HANDLED;
291 	}
292 
293 	if (reg_val & PV88060_E_OVER_TEMP) {
294 		for (i = 0; i < PV88060_MAX_REGULATORS; i++) {
295 			if (chip->rdev[i] != NULL) {
296 				regulator_notifier_call_chain(chip->rdev[i],
297 					REGULATOR_EVENT_OVER_TEMP,
298 					NULL);
299 			}
300 		}
301 
302 		err = regmap_write(chip->regmap, PV88060_REG_EVENT_A,
303 			PV88060_E_OVER_TEMP);
304 		if (err < 0)
305 			goto error_i2c;
306 
307 		ret = IRQ_HANDLED;
308 	}
309 
310 	return ret;
311 
312 error_i2c:
313 	dev_err(chip->dev, "I2C error : %d\n", err);
314 	return IRQ_NONE;
315 }
316 
317 /*
318  * I2C driver interface functions
319  */
320 static int pv88060_i2c_probe(struct i2c_client *i2c,
321 		const struct i2c_device_id *id)
322 {
323 	struct regulator_init_data *init_data = dev_get_platdata(&i2c->dev);
324 	struct pv88060 *chip;
325 	struct regulator_config config = { };
326 	int error, i, ret = 0;
327 
328 	chip = devm_kzalloc(&i2c->dev, sizeof(struct pv88060), GFP_KERNEL);
329 	if (!chip)
330 		return -ENOMEM;
331 
332 	chip->dev = &i2c->dev;
333 	chip->regmap = devm_regmap_init_i2c(i2c, &pv88060_regmap_config);
334 	if (IS_ERR(chip->regmap)) {
335 		error = PTR_ERR(chip->regmap);
336 		dev_err(chip->dev, "Failed to allocate register map: %d\n",
337 			error);
338 		return error;
339 	}
340 
341 	i2c_set_clientdata(i2c, chip);
342 
343 	if (i2c->irq != 0) {
344 		ret = regmap_write(chip->regmap, PV88060_REG_MASK_A, 0xFF);
345 		if (ret < 0) {
346 			dev_err(chip->dev,
347 				"Failed to mask A reg: %d\n", ret);
348 			return ret;
349 		}
350 
351 		ret = regmap_write(chip->regmap, PV88060_REG_MASK_B, 0xFF);
352 		if (ret < 0) {
353 			dev_err(chip->dev,
354 				"Failed to mask B reg: %d\n", ret);
355 			return ret;
356 		}
357 
358 		ret = regmap_write(chip->regmap, PV88060_REG_MASK_C, 0xFF);
359 		if (ret < 0) {
360 			dev_err(chip->dev,
361 				"Failed to mask C reg: %d\n", ret);
362 			return ret;
363 		}
364 
365 		ret = devm_request_threaded_irq(&i2c->dev, i2c->irq, NULL,
366 					pv88060_irq_handler,
367 					IRQF_TRIGGER_LOW|IRQF_ONESHOT,
368 					"pv88060", chip);
369 		if (ret != 0) {
370 			dev_err(chip->dev, "Failed to request IRQ: %d\n",
371 				i2c->irq);
372 			return ret;
373 		}
374 
375 		ret = regmap_update_bits(chip->regmap, PV88060_REG_MASK_A,
376 			PV88060_M_VDD_FLT | PV88060_M_OVER_TEMP, 0);
377 		if (ret < 0) {
378 			dev_err(chip->dev,
379 				"Failed to update mask reg: %d\n", ret);
380 			return ret;
381 		}
382 
383 	} else {
384 		dev_warn(chip->dev, "No IRQ configured\n");
385 	}
386 
387 	config.dev = chip->dev;
388 	config.regmap = chip->regmap;
389 
390 	for (i = 0; i < PV88060_MAX_REGULATORS; i++) {
391 		if (init_data)
392 			config.init_data = &init_data[i];
393 
394 		config.driver_data = (void *)&pv88060_regulator_info[i];
395 		chip->rdev[i] = devm_regulator_register(chip->dev,
396 			&pv88060_regulator_info[i].desc, &config);
397 		if (IS_ERR(chip->rdev[i])) {
398 			dev_err(chip->dev,
399 				"Failed to register PV88060 regulator\n");
400 			return PTR_ERR(chip->rdev[i]);
401 		}
402 	}
403 
404 	return 0;
405 }
406 
407 static const struct i2c_device_id pv88060_i2c_id[] = {
408 	{"pv88060", 0},
409 	{},
410 };
411 MODULE_DEVICE_TABLE(i2c, pv88060_i2c_id);
412 
413 #ifdef CONFIG_OF
414 static const struct of_device_id pv88060_dt_ids[] = {
415 	{ .compatible = "pvs,pv88060", .data = &pv88060_i2c_id[0] },
416 	{},
417 };
418 MODULE_DEVICE_TABLE(of, pv88060_dt_ids);
419 #endif
420 
421 static struct i2c_driver pv88060_regulator_driver = {
422 	.driver = {
423 		.name = "pv88060",
424 		.of_match_table = of_match_ptr(pv88060_dt_ids),
425 	},
426 	.probe = pv88060_i2c_probe,
427 	.id_table = pv88060_i2c_id,
428 };
429 
430 module_i2c_driver(pv88060_regulator_driver);
431 
432 MODULE_AUTHOR("James Ban <James.Ban.opensource@diasemi.com>");
433 MODULE_DESCRIPTION("Regulator device driver for Powerventure PV88060");
434 MODULE_LICENSE("GPL");
435