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
106struct bcm590xx_board {
107 struct regulator_init_data *bcm590xx_pmu_init_data[BCM590XX_NUM_REGS];
108};
109
110/* LDO group A: supported voltages in microvolts */
111static 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 */
117static const unsigned int ldo_c_table[] = {
118 3100000, 1800000, 2500000, 2700000, 2800000,
119 2900000, 3000000, 3300000,
120};
121
122static const unsigned int ldo_vbus[] = {
123 5000000,
124};
125
126/* DCDC group CSR: supported voltages in microvolts */
127static 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 */
134static 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 */
142static 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
148struct 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
172static 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
202struct bcm590xx_reg {
203 struct regulator_desc *desc;
204 struct bcm590xx *mfd;
205};
206
207static 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
217static 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_VSR:
246 reg = BCM590XX_VSRPMCTRL1;
247 break;
248 case BCM590XX_REG_VBUS:
249 reg = BCM590XX_OTG_CTRL;
250 break;
251 }
252
253
254 return reg;
255}
256
257static const struct regulator_ops bcm590xx_ops_ldo = {
258 .is_enabled = regulator_is_enabled_regmap,
259 .enable = regulator_enable_regmap,
260 .disable = regulator_disable_regmap,
261 .get_voltage_sel = regulator_get_voltage_sel_regmap,
262 .set_voltage_sel = regulator_set_voltage_sel_regmap,
263 .list_voltage = regulator_list_voltage_table,
264 .map_voltage = regulator_map_voltage_iterate,
265};
266
267static const struct regulator_ops bcm590xx_ops_dcdc = {
268 .is_enabled = regulator_is_enabled_regmap,
269 .enable = regulator_enable_regmap,
270 .disable = regulator_disable_regmap,
271 .get_voltage_sel = regulator_get_voltage_sel_regmap,
272 .set_voltage_sel = regulator_set_voltage_sel_regmap,
273 .list_voltage = regulator_list_voltage_linear_range,
274 .map_voltage = regulator_map_voltage_linear_range,
275};
276
277static const struct regulator_ops bcm590xx_ops_vbus = {
278 .is_enabled = regulator_is_enabled_regmap,
279 .enable = regulator_enable_regmap,
280 .disable = regulator_disable_regmap,
281};
282
283#define BCM590XX_MATCH(_name, _id) \
284 { \
285 .name = #_name, \
286 .driver_data = (void *)&bcm590xx_regs[BCM590XX_REG_##_id], \
287 }
288
289static struct of_regulator_match bcm590xx_matches[] = {
290 BCM590XX_MATCH(rfldo, RFLDO),
291 BCM590XX_MATCH(camldo1, CAMLDO1),
292 BCM590XX_MATCH(camldo2, CAMLDO2),
293 BCM590XX_MATCH(simldo1, SIMLDO1),
294 BCM590XX_MATCH(simldo2, SIMLDO2),
295 BCM590XX_MATCH(sdldo, SDLDO),
296 BCM590XX_MATCH(sdxldo, SDXLDO),
297 BCM590XX_MATCH(mmcldo1, MMCLDO1),
298 BCM590XX_MATCH(mmcldo2, MMCLDO2),
299 BCM590XX_MATCH(audldo, AUDLDO),
300 BCM590XX_MATCH(micldo, MICLDO),
301 BCM590XX_MATCH(usbldo, USBLDO),
302 BCM590XX_MATCH(vibldo, VIBLDO),
303 BCM590XX_MATCH(csr, CSR),
304 BCM590XX_MATCH(iosr1, IOSR1),
305 BCM590XX_MATCH(iosr2, IOSR2),
306 BCM590XX_MATCH(msr, MSR),
307 BCM590XX_MATCH(sdsr1, SDSR1),
308 BCM590XX_MATCH(sdsr2, SDSR2),
309 BCM590XX_MATCH(vsr, VSR),
310 BCM590XX_MATCH(gpldo1, GPLDO1),
311 BCM590XX_MATCH(gpldo2, GPLDO2),
312 BCM590XX_MATCH(gpldo3, GPLDO3),
313 BCM590XX_MATCH(gpldo4, GPLDO4),
314 BCM590XX_MATCH(gpldo5, GPLDO5),
315 BCM590XX_MATCH(gpldo6, GPLDO6),
316 BCM590XX_MATCH(vbus, VBUS),
317};
318
319static struct bcm590xx_board *bcm590xx_parse_dt_reg_data(
320 struct platform_device *pdev,
321 struct of_regulator_match **bcm590xx_reg_matches)
322{
323 struct bcm590xx_board *data;
324 struct device_node *np = pdev->dev.parent->of_node;
325 struct device_node *regulators;
326 struct of_regulator_match *matches = bcm590xx_matches;
327 int count = ARRAY_SIZE(bcm590xx_matches);
328 int idx = 0;
329 int ret;
330
331 if (!np) {
332 dev_err(&pdev->dev, "of node not found\n");
333 return NULL;
334 }
335
336 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
337 if (!data)
338 return NULL;
339
340 np = of_node_get(np);
341 regulators = of_get_child_by_name(np, "regulators");
342 if (!regulators) {
343 dev_warn(&pdev->dev, "regulator node not found\n");
344 return NULL;
345 }
346
347 ret = of_regulator_match(&pdev->dev, regulators, matches, count);
348 of_node_put(regulators);
349 if (ret < 0) {
350 dev_err(&pdev->dev, "Error parsing regulator init data: %d\n",
351 ret);
352 return NULL;
353 }
354
355 *bcm590xx_reg_matches = matches;
356
357 for (idx = 0; idx < count; idx++) {
358 if (!matches[idx].init_data || !matches[idx].of_node)
359 continue;
360
361 data->bcm590xx_pmu_init_data[idx] = matches[idx].init_data;
362 }
363
364 return data;
365}
366
367static int bcm590xx_probe(struct platform_device *pdev)
368{
369 struct bcm590xx *bcm590xx = dev_get_drvdata(pdev->dev.parent);
370 struct bcm590xx_board *pmu_data = NULL;
371 struct bcm590xx_reg *pmu;
372 struct regulator_config config = { };
373 struct bcm590xx_info *info;
374 struct regulator_init_data *reg_data;
375 struct regulator_dev *rdev;
376 struct of_regulator_match *bcm590xx_reg_matches = NULL;
377 int i;
378
379 pmu_data = bcm590xx_parse_dt_reg_data(pdev,
380 &bcm590xx_reg_matches);
381
382 pmu = devm_kzalloc(&pdev->dev, sizeof(*pmu), GFP_KERNEL);
383 if (!pmu)
384 return -ENOMEM;
385
386 pmu->mfd = bcm590xx;
387
388 platform_set_drvdata(pdev, pmu);
389
390 pmu->desc = devm_kcalloc(&pdev->dev,
391 BCM590XX_NUM_REGS,
392 sizeof(struct regulator_desc),
393 GFP_KERNEL);
394 if (!pmu->desc)
395 return -ENOMEM;
396
397 info = bcm590xx_regs;
398
399 for (i = 0; i < BCM590XX_NUM_REGS; i++, info++) {
400 if (pmu_data)
401 reg_data = pmu_data->bcm590xx_pmu_init_data[i];
402 else
403 reg_data = NULL;
404
405 /* Register the regulators */
406 pmu->desc[i].name = info->name;
407 pmu->desc[i].supply_name = info->vin_name;
408 pmu->desc[i].id = i;
409 pmu->desc[i].volt_table = info->volt_table;
410 pmu->desc[i].n_voltages = info->n_voltages;
411 pmu->desc[i].linear_ranges = info->linear_ranges;
412 pmu->desc[i].n_linear_ranges = info->n_linear_ranges;
413
414 if ((BCM590XX_REG_IS_LDO(i)) || (BCM590XX_REG_IS_GPLDO(i))) {
415 pmu->desc[i].ops = &bcm590xx_ops_ldo;
416 pmu->desc[i].vsel_mask = BCM590XX_LDO_VSEL_MASK;
417 } else if (BCM590XX_REG_IS_VBUS(i))
418 pmu->desc[i].ops = &bcm590xx_ops_vbus;
419 else {
420 pmu->desc[i].ops = &bcm590xx_ops_dcdc;
421 pmu->desc[i].vsel_mask = BCM590XX_SR_VSEL_MASK;
422 }
423
424 if (BCM590XX_REG_IS_VBUS(i))
425 pmu->desc[i].enable_mask = BCM590XX_VBUS_ENABLE;
426 else {
427 pmu->desc[i].vsel_reg = bcm590xx_get_vsel_register(i);
428 pmu->desc[i].enable_is_inverted = true;
429 pmu->desc[i].enable_mask = BCM590XX_REG_ENABLE;
430 }
431 pmu->desc[i].enable_reg = bcm590xx_get_enable_register(i);
432 pmu->desc[i].type = REGULATOR_VOLTAGE;
433 pmu->desc[i].owner = THIS_MODULE;
434
435 config.dev = bcm590xx->dev;
436 config.init_data = reg_data;
437 config.driver_data = pmu;
438 if (BCM590XX_REG_IS_GPLDO(i) || BCM590XX_REG_IS_VBUS(i))
439 config.regmap = bcm590xx->regmap_sec;
440 else
441 config.regmap = bcm590xx->regmap_pri;
442
443 if (bcm590xx_reg_matches)
444 config.of_node = bcm590xx_reg_matches[i].of_node;
445
446 rdev = devm_regulator_register(&pdev->dev, &pmu->desc[i],
447 &config);
448 if (IS_ERR(rdev)) {
449 dev_err(bcm590xx->dev,
450 "failed to register %s regulator\n",
451 pdev->name);
452 return PTR_ERR(rdev);
453 }
454 }
455
456 return 0;
457}
458
459static struct platform_driver bcm590xx_regulator_driver = {
460 .driver = {
461 .name = "bcm590xx-vregs",
462 },
463 .probe = bcm590xx_probe,
464};
465module_platform_driver(bcm590xx_regulator_driver);
466
467MODULE_AUTHOR("Matt Porter <mporter@linaro.org>");
468MODULE_DESCRIPTION("BCM590xx voltage regulator driver");
469MODULE_LICENSE("GPL v2");
470MODULE_ALIAS("platform:bcm590xx-vregs");
471