1 /*
2  * Broadcom BCM590xx regulator driver
3  *
4  * Copyright 2014 Linaro Limited
5  * Author: Matt Porter <mporter@linaro.org>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under  the terms of the GNU General  Public License as published by the
9  * Free Software Foundation;  either version 2 of the License, or (at your
10  * option) any later version.
11  */
12 
13 #include <linux/err.h>
14 #include <linux/init.h>
15 #include <linux/kernel.h>
16 #include <linux/mfd/bcm590xx.h>
17 #include <linux/module.h>
18 #include <linux/of.h>
19 #include <linux/platform_device.h>
20 #include <linux/regulator/driver.h>
21 #include <linux/regulator/machine.h>
22 #include <linux/regulator/of_regulator.h>
23 #include <linux/slab.h>
24 
25 /* I2C slave 0 registers */
26 #define BCM590XX_RFLDOPMCTRL1	0x60
27 #define BCM590XX_IOSR1PMCTRL1	0x7a
28 #define BCM590XX_IOSR2PMCTRL1	0x7c
29 #define BCM590XX_CSRPMCTRL1	0x7e
30 #define BCM590XX_SDSR1PMCTRL1	0x82
31 #define BCM590XX_SDSR2PMCTRL1	0x86
32 #define BCM590XX_MSRPMCTRL1	0x8a
33 #define BCM590XX_VSRPMCTRL1	0x8e
34 #define BCM590XX_RFLDOCTRL	0x96
35 #define BCM590XX_CSRVOUT1	0xc0
36 
37 /* I2C slave 1 registers */
38 #define BCM590XX_GPLDO5PMCTRL1	0x16
39 #define BCM590XX_GPLDO6PMCTRL1	0x18
40 #define BCM590XX_GPLDO1CTRL	0x1a
41 #define BCM590XX_GPLDO2CTRL	0x1b
42 #define BCM590XX_GPLDO3CTRL	0x1c
43 #define BCM590XX_GPLDO4CTRL	0x1d
44 #define BCM590XX_GPLDO5CTRL	0x1e
45 #define BCM590XX_GPLDO6CTRL	0x1f
46 #define BCM590XX_OTG_CTRL	0x40
47 #define BCM590XX_GPLDO1PMCTRL1	0x57
48 #define BCM590XX_GPLDO2PMCTRL1	0x59
49 #define BCM590XX_GPLDO3PMCTRL1	0x5b
50 #define BCM590XX_GPLDO4PMCTRL1	0x5d
51 
52 #define BCM590XX_REG_ENABLE	BIT(7)
53 #define BCM590XX_VBUS_ENABLE	BIT(2)
54 #define BCM590XX_LDO_VSEL_MASK	GENMASK(5, 3)
55 #define BCM590XX_SR_VSEL_MASK	GENMASK(5, 0)
56 
57 /*
58  * RFLDO to VSR regulators are
59  * accessed via I2C slave 0
60  */
61 
62 /* LDO regulator IDs */
63 #define BCM590XX_REG_RFLDO	0
64 #define BCM590XX_REG_CAMLDO1	1
65 #define BCM590XX_REG_CAMLDO2	2
66 #define BCM590XX_REG_SIMLDO1	3
67 #define BCM590XX_REG_SIMLDO2	4
68 #define BCM590XX_REG_SDLDO	5
69 #define BCM590XX_REG_SDXLDO	6
70 #define BCM590XX_REG_MMCLDO1	7
71 #define BCM590XX_REG_MMCLDO2	8
72 #define BCM590XX_REG_AUDLDO	9
73 #define BCM590XX_REG_MICLDO	10
74 #define BCM590XX_REG_USBLDO	11
75 #define BCM590XX_REG_VIBLDO	12
76 
77 /* DCDC regulator IDs */
78 #define BCM590XX_REG_CSR	13
79 #define BCM590XX_REG_IOSR1	14
80 #define BCM590XX_REG_IOSR2	15
81 #define BCM590XX_REG_MSR	16
82 #define BCM590XX_REG_SDSR1	17
83 #define BCM590XX_REG_SDSR2	18
84 #define BCM590XX_REG_VSR	19
85 
86 /*
87  * GPLDO1 to VBUS regulators are
88  * accessed via I2C slave 1
89  */
90 
91 #define BCM590XX_REG_GPLDO1	20
92 #define BCM590XX_REG_GPLDO2	21
93 #define BCM590XX_REG_GPLDO3	22
94 #define BCM590XX_REG_GPLDO4	23
95 #define BCM590XX_REG_GPLDO5	24
96 #define BCM590XX_REG_GPLDO6	25
97 #define BCM590XX_REG_VBUS	26
98 
99 #define BCM590XX_NUM_REGS	27
100 
101 #define BCM590XX_REG_IS_LDO(n)	(n < BCM590XX_REG_CSR)
102 #define BCM590XX_REG_IS_GPLDO(n) \
103 	((n > BCM590XX_REG_VSR) && (n < BCM590XX_REG_VBUS))
104 #define BCM590XX_REG_IS_VBUS(n)	(n == BCM590XX_REG_VBUS)
105 
106 struct bcm590xx_board {
107 	struct regulator_init_data *bcm590xx_pmu_init_data[BCM590XX_NUM_REGS];
108 };
109 
110 /* LDO group A: supported voltages in microvolts */
111 static const unsigned int ldo_a_table[] = {
112 	1200000, 1800000, 2500000, 2700000, 2800000,
113 	2900000, 3000000, 3300000,
114 };
115 
116 /* LDO group C: supported voltages in microvolts */
117 static const unsigned int ldo_c_table[] = {
118 	3100000, 1800000, 2500000, 2700000, 2800000,
119 	2900000, 3000000, 3300000,
120 };
121 
122 static const unsigned int ldo_vbus[] = {
123 	5000000,
124 };
125 
126 /* DCDC group CSR: supported voltages in microvolts */
127 static const struct regulator_linear_range dcdc_csr_ranges[] = {
128 	REGULATOR_LINEAR_RANGE(860000, 2, 50, 10000),
129 	REGULATOR_LINEAR_RANGE(1360000, 51, 55, 20000),
130 	REGULATOR_LINEAR_RANGE(900000, 56, 63, 0),
131 };
132 
133 /* DCDC group IOSR1: supported voltages in microvolts */
134 static const struct regulator_linear_range dcdc_iosr1_ranges[] = {
135 	REGULATOR_LINEAR_RANGE(860000, 2, 51, 10000),
136 	REGULATOR_LINEAR_RANGE(1500000, 52, 52, 0),
137 	REGULATOR_LINEAR_RANGE(1800000, 53, 53, 0),
138 	REGULATOR_LINEAR_RANGE(900000, 54, 63, 0),
139 };
140 
141 /* DCDC group SDSR1: supported voltages in microvolts */
142 static const struct regulator_linear_range dcdc_sdsr1_ranges[] = {
143 	REGULATOR_LINEAR_RANGE(860000, 2, 50, 10000),
144 	REGULATOR_LINEAR_RANGE(1340000, 51, 51, 0),
145 	REGULATOR_LINEAR_RANGE(900000, 52, 63, 0),
146 };
147 
148 struct bcm590xx_info {
149 	const char *name;
150 	const char *vin_name;
151 	u8 n_voltages;
152 	const unsigned int *volt_table;
153 	u8 n_linear_ranges;
154 	const struct regulator_linear_range *linear_ranges;
155 };
156 
157 #define BCM590XX_REG_TABLE(_name, _table) \
158 	{ \
159 		.name = #_name, \
160 		.n_voltages = ARRAY_SIZE(_table), \
161 		.volt_table = _table, \
162 	}
163 
164 #define BCM590XX_REG_RANGES(_name, _ranges) \
165 	{ \
166 		.name = #_name, \
167 		.n_voltages = 64, \
168 		.n_linear_ranges = ARRAY_SIZE(_ranges), \
169 		.linear_ranges = _ranges, \
170 	}
171 
172 static struct bcm590xx_info bcm590xx_regs[] = {
173 	BCM590XX_REG_TABLE(rfldo, ldo_a_table),
174 	BCM590XX_REG_TABLE(camldo1, ldo_c_table),
175 	BCM590XX_REG_TABLE(camldo2, ldo_c_table),
176 	BCM590XX_REG_TABLE(simldo1, ldo_a_table),
177 	BCM590XX_REG_TABLE(simldo2, ldo_a_table),
178 	BCM590XX_REG_TABLE(sdldo, ldo_c_table),
179 	BCM590XX_REG_TABLE(sdxldo, ldo_a_table),
180 	BCM590XX_REG_TABLE(mmcldo1, ldo_a_table),
181 	BCM590XX_REG_TABLE(mmcldo2, ldo_a_table),
182 	BCM590XX_REG_TABLE(audldo, ldo_a_table),
183 	BCM590XX_REG_TABLE(micldo, ldo_a_table),
184 	BCM590XX_REG_TABLE(usbldo, ldo_a_table),
185 	BCM590XX_REG_TABLE(vibldo, ldo_c_table),
186 	BCM590XX_REG_RANGES(csr, dcdc_csr_ranges),
187 	BCM590XX_REG_RANGES(iosr1, dcdc_iosr1_ranges),
188 	BCM590XX_REG_RANGES(iosr2, dcdc_iosr1_ranges),
189 	BCM590XX_REG_RANGES(msr, dcdc_iosr1_ranges),
190 	BCM590XX_REG_RANGES(sdsr1, dcdc_sdsr1_ranges),
191 	BCM590XX_REG_RANGES(sdsr2, dcdc_iosr1_ranges),
192 	BCM590XX_REG_RANGES(vsr, dcdc_iosr1_ranges),
193 	BCM590XX_REG_TABLE(gpldo1, ldo_a_table),
194 	BCM590XX_REG_TABLE(gpldo2, ldo_a_table),
195 	BCM590XX_REG_TABLE(gpldo3, ldo_a_table),
196 	BCM590XX_REG_TABLE(gpldo4, ldo_a_table),
197 	BCM590XX_REG_TABLE(gpldo5, ldo_a_table),
198 	BCM590XX_REG_TABLE(gpldo6, ldo_a_table),
199 	BCM590XX_REG_TABLE(vbus, ldo_vbus),
200 };
201 
202 struct bcm590xx_reg {
203 	struct regulator_desc *desc;
204 	struct bcm590xx *mfd;
205 };
206 
207 static int bcm590xx_get_vsel_register(int id)
208 {
209 	if (BCM590XX_REG_IS_LDO(id))
210 		return BCM590XX_RFLDOCTRL + id;
211 	else if (BCM590XX_REG_IS_GPLDO(id))
212 		return BCM590XX_GPLDO1CTRL + id;
213 	else
214 		return BCM590XX_CSRVOUT1 + (id - BCM590XX_REG_CSR) * 3;
215 }
216 
217 static int bcm590xx_get_enable_register(int id)
218 {
219 	int reg = 0;
220 
221 	if (BCM590XX_REG_IS_LDO(id))
222 		reg = BCM590XX_RFLDOPMCTRL1 + id * 2;
223 	else if (BCM590XX_REG_IS_GPLDO(id))
224 		reg = BCM590XX_GPLDO1PMCTRL1 + id * 2;
225 	else
226 		switch (id) {
227 		case BCM590XX_REG_CSR:
228 			reg = BCM590XX_CSRPMCTRL1;
229 			break;
230 		case BCM590XX_REG_IOSR1:
231 			reg = BCM590XX_IOSR1PMCTRL1;
232 			break;
233 		case BCM590XX_REG_IOSR2:
234 			reg = BCM590XX_IOSR2PMCTRL1;
235 			break;
236 		case BCM590XX_REG_MSR:
237 			reg = BCM590XX_MSRPMCTRL1;
238 			break;
239 		case BCM590XX_REG_SDSR1:
240 			reg = BCM590XX_SDSR1PMCTRL1;
241 			break;
242 		case BCM590XX_REG_SDSR2:
243 			reg = BCM590XX_SDSR2PMCTRL1;
244 			break;
245 		case BCM590XX_REG_VBUS:
246 			reg = BCM590XX_OTG_CTRL;
247 		}
248 
249 
250 	return reg;
251 }
252 
253 static const struct regulator_ops bcm590xx_ops_ldo = {
254 	.is_enabled		= regulator_is_enabled_regmap,
255 	.enable			= regulator_enable_regmap,
256 	.disable		= regulator_disable_regmap,
257 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
258 	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
259 	.list_voltage		= regulator_list_voltage_table,
260 	.map_voltage		= regulator_map_voltage_iterate,
261 };
262 
263 static const struct regulator_ops bcm590xx_ops_dcdc = {
264 	.is_enabled		= regulator_is_enabled_regmap,
265 	.enable			= regulator_enable_regmap,
266 	.disable		= regulator_disable_regmap,
267 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
268 	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
269 	.list_voltage		= regulator_list_voltage_linear_range,
270 	.map_voltage		= regulator_map_voltage_linear_range,
271 };
272 
273 static const struct regulator_ops bcm590xx_ops_vbus = {
274 	.is_enabled		= regulator_is_enabled_regmap,
275 	.enable			= regulator_enable_regmap,
276 	.disable		= regulator_disable_regmap,
277 };
278 
279 #define BCM590XX_MATCH(_name, _id) \
280 	{ \
281 		.name = #_name, \
282 		.driver_data = (void *)&bcm590xx_regs[BCM590XX_REG_##_id], \
283 	}
284 
285 static struct of_regulator_match bcm590xx_matches[] = {
286 	BCM590XX_MATCH(rfldo, RFLDO),
287 	BCM590XX_MATCH(camldo1, CAMLDO1),
288 	BCM590XX_MATCH(camldo2, CAMLDO2),
289 	BCM590XX_MATCH(simldo1, SIMLDO1),
290 	BCM590XX_MATCH(simldo2, SIMLDO2),
291 	BCM590XX_MATCH(sdldo, SDLDO),
292 	BCM590XX_MATCH(sdxldo, SDXLDO),
293 	BCM590XX_MATCH(mmcldo1, MMCLDO1),
294 	BCM590XX_MATCH(mmcldo2, MMCLDO2),
295 	BCM590XX_MATCH(audldo, AUDLDO),
296 	BCM590XX_MATCH(micldo, MICLDO),
297 	BCM590XX_MATCH(usbldo, USBLDO),
298 	BCM590XX_MATCH(vibldo, VIBLDO),
299 	BCM590XX_MATCH(csr, CSR),
300 	BCM590XX_MATCH(iosr1, IOSR1),
301 	BCM590XX_MATCH(iosr2, IOSR2),
302 	BCM590XX_MATCH(msr, MSR),
303 	BCM590XX_MATCH(sdsr1, SDSR1),
304 	BCM590XX_MATCH(sdsr2, SDSR2),
305 	BCM590XX_MATCH(vsr, VSR),
306 	BCM590XX_MATCH(gpldo1, GPLDO1),
307 	BCM590XX_MATCH(gpldo2, GPLDO2),
308 	BCM590XX_MATCH(gpldo3, GPLDO3),
309 	BCM590XX_MATCH(gpldo4, GPLDO4),
310 	BCM590XX_MATCH(gpldo5, GPLDO5),
311 	BCM590XX_MATCH(gpldo6, GPLDO6),
312 	BCM590XX_MATCH(vbus, VBUS),
313 };
314 
315 static struct bcm590xx_board *bcm590xx_parse_dt_reg_data(
316 		struct platform_device *pdev,
317 		struct of_regulator_match **bcm590xx_reg_matches)
318 {
319 	struct bcm590xx_board *data;
320 	struct device_node *np = pdev->dev.parent->of_node;
321 	struct device_node *regulators;
322 	struct of_regulator_match *matches = bcm590xx_matches;
323 	int count = ARRAY_SIZE(bcm590xx_matches);
324 	int idx = 0;
325 	int ret;
326 
327 	if (!np) {
328 		dev_err(&pdev->dev, "of node not found\n");
329 		return NULL;
330 	}
331 
332 	data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
333 	if (!data)
334 		return NULL;
335 
336 	np = of_node_get(np);
337 	regulators = of_get_child_by_name(np, "regulators");
338 	if (!regulators) {
339 		dev_warn(&pdev->dev, "regulator node not found\n");
340 		return NULL;
341 	}
342 
343 	ret = of_regulator_match(&pdev->dev, regulators, matches, count);
344 	of_node_put(regulators);
345 	if (ret < 0) {
346 		dev_err(&pdev->dev, "Error parsing regulator init data: %d\n",
347 			ret);
348 		return NULL;
349 	}
350 
351 	*bcm590xx_reg_matches = matches;
352 
353 	for (idx = 0; idx < count; idx++) {
354 		if (!matches[idx].init_data || !matches[idx].of_node)
355 			continue;
356 
357 		data->bcm590xx_pmu_init_data[idx] = matches[idx].init_data;
358 	}
359 
360 	return data;
361 }
362 
363 static int bcm590xx_probe(struct platform_device *pdev)
364 {
365 	struct bcm590xx *bcm590xx = dev_get_drvdata(pdev->dev.parent);
366 	struct bcm590xx_board *pmu_data = NULL;
367 	struct bcm590xx_reg *pmu;
368 	struct regulator_config config = { };
369 	struct bcm590xx_info *info;
370 	struct regulator_init_data *reg_data;
371 	struct regulator_dev *rdev;
372 	struct of_regulator_match *bcm590xx_reg_matches = NULL;
373 	int i;
374 
375 	pmu_data = bcm590xx_parse_dt_reg_data(pdev,
376 					      &bcm590xx_reg_matches);
377 
378 	pmu = devm_kzalloc(&pdev->dev, sizeof(*pmu), GFP_KERNEL);
379 	if (!pmu)
380 		return -ENOMEM;
381 
382 	pmu->mfd = bcm590xx;
383 
384 	platform_set_drvdata(pdev, pmu);
385 
386 	pmu->desc = devm_kcalloc(&pdev->dev,
387 				 BCM590XX_NUM_REGS,
388 				 sizeof(struct regulator_desc),
389 				 GFP_KERNEL);
390 	if (!pmu->desc)
391 		return -ENOMEM;
392 
393 	info = bcm590xx_regs;
394 
395 	for (i = 0; i < BCM590XX_NUM_REGS; i++, info++) {
396 		if (pmu_data)
397 			reg_data = pmu_data->bcm590xx_pmu_init_data[i];
398 		else
399 			reg_data = NULL;
400 
401 		/* Register the regulators */
402 		pmu->desc[i].name = info->name;
403 		pmu->desc[i].supply_name = info->vin_name;
404 		pmu->desc[i].id = i;
405 		pmu->desc[i].volt_table = info->volt_table;
406 		pmu->desc[i].n_voltages = info->n_voltages;
407 		pmu->desc[i].linear_ranges = info->linear_ranges;
408 		pmu->desc[i].n_linear_ranges = info->n_linear_ranges;
409 
410 		if ((BCM590XX_REG_IS_LDO(i)) || (BCM590XX_REG_IS_GPLDO(i))) {
411 			pmu->desc[i].ops = &bcm590xx_ops_ldo;
412 			pmu->desc[i].vsel_mask = BCM590XX_LDO_VSEL_MASK;
413 		} else if (BCM590XX_REG_IS_VBUS(i))
414 			pmu->desc[i].ops = &bcm590xx_ops_vbus;
415 		else {
416 			pmu->desc[i].ops = &bcm590xx_ops_dcdc;
417 			pmu->desc[i].vsel_mask = BCM590XX_SR_VSEL_MASK;
418 		}
419 
420 		if (BCM590XX_REG_IS_VBUS(i))
421 			pmu->desc[i].enable_mask = BCM590XX_VBUS_ENABLE;
422 		else {
423 			pmu->desc[i].vsel_reg = bcm590xx_get_vsel_register(i);
424 			pmu->desc[i].enable_is_inverted = true;
425 			pmu->desc[i].enable_mask = BCM590XX_REG_ENABLE;
426 		}
427 		pmu->desc[i].enable_reg = bcm590xx_get_enable_register(i);
428 		pmu->desc[i].type = REGULATOR_VOLTAGE;
429 		pmu->desc[i].owner = THIS_MODULE;
430 
431 		config.dev = bcm590xx->dev;
432 		config.init_data = reg_data;
433 		config.driver_data = pmu;
434 		if (BCM590XX_REG_IS_GPLDO(i) || BCM590XX_REG_IS_VBUS(i))
435 			config.regmap = bcm590xx->regmap_sec;
436 		else
437 			config.regmap = bcm590xx->regmap_pri;
438 
439 		if (bcm590xx_reg_matches)
440 			config.of_node = bcm590xx_reg_matches[i].of_node;
441 
442 		rdev = devm_regulator_register(&pdev->dev, &pmu->desc[i],
443 					       &config);
444 		if (IS_ERR(rdev)) {
445 			dev_err(bcm590xx->dev,
446 				"failed to register %s regulator\n",
447 				pdev->name);
448 			return PTR_ERR(rdev);
449 		}
450 	}
451 
452 	return 0;
453 }
454 
455 static struct platform_driver bcm590xx_regulator_driver = {
456 	.driver = {
457 		.name = "bcm590xx-vregs",
458 	},
459 	.probe = bcm590xx_probe,
460 };
461 module_platform_driver(bcm590xx_regulator_driver);
462 
463 MODULE_AUTHOR("Matt Porter <mporter@linaro.org>");
464 MODULE_DESCRIPTION("BCM590xx voltage regulator driver");
465 MODULE_LICENSE("GPL v2");
466 MODULE_ALIAS("platform:bcm590xx-vregs");
467