1 // SPDX-License-Identifier: GPL-2.0
3 // Device driver for regulators in Hi6421 IC
5 // Copyright (c) <2011-2014> HiSilicon Technologies Co., Ltd.
6 // http://www.hisilicon.com
7 // Copyright (c) <2013-2014> Linaro Ltd.
8 // https://www.linaro.org
10 // Author: Guodong Xu <guodong.xu@linaro.org>
12 #include <linux/slab.h>
13 #include <linux/device.h>
14 #include <linux/module.h>
15 #include <linux/err.h>
16 #include <linux/platform_device.h>
18 #include <linux/regmap.h>
19 #include <linux/regulator/driver.h>
20 #include <linux/regulator/machine.h>
21 #include <linux/regulator/of_regulator.h>
22 #include <linux/mfd/hi6421-pmic.h>
25 * struct hi6421_regulator_pdata - Hi6421 regulator data of platform device
26 * @lock: mutex to serialize regulator enable
28 struct hi6421_regulator_pdata
{
33 * struct hi6421_regulator_info - hi6421 regulator information
34 * @desc: regulator description
35 * @mode_mask: ECO mode bitmask of LDOs; for BUCKs, this masks sleep
36 * @eco_microamp: eco mode load upper limit (in uA), valid for LDOs only
38 struct hi6421_regulator_info
{
39 struct regulator_desc desc
;
44 /* HI6421 regulators */
45 enum hi6421_regulator_id
{
74 HI6421_NUM_REGULATORS
,
77 /* LDO 0, 4~7, 9~14, 16~20 have same voltage table. */
78 static const unsigned int ldo_0_voltages
[] = {
79 1500000, 1800000, 2400000, 2500000,
80 2600000, 2700000, 2850000, 3000000,
83 /* LDO 8, 15 have same voltage table. */
84 static const unsigned int ldo_8_voltages
[] = {
85 1500000, 1800000, 2400000, 2600000,
86 2700000, 2850000, 3000000, 3300000,
89 /* Ranges are sorted in ascending order. */
90 static const struct linear_range ldo_audio_volt_range
[] = {
91 REGULATOR_LINEAR_RANGE(2800000, 0, 3, 50000),
92 REGULATOR_LINEAR_RANGE(3000000, 4, 7, 100000),
95 static const unsigned int buck_3_voltages
[] = {
96 950000, 1050000, 1100000, 1117000,
97 1134000, 1150000, 1167000, 1200000,
100 static const unsigned int buck_4_voltages
[] = {
101 1150000, 1200000, 1250000, 1350000,
102 1700000, 1800000, 1900000, 2000000,
105 static const unsigned int buck_5_voltages
[] = {
106 1150000, 1200000, 1250000, 1350000,
107 1600000, 1700000, 1800000, 1900000,
110 static const struct regulator_ops hi6421_ldo_ops
;
111 static const struct regulator_ops hi6421_ldo_linear_ops
;
112 static const struct regulator_ops hi6421_ldo_linear_range_ops
;
113 static const struct regulator_ops hi6421_buck012_ops
;
114 static const struct regulator_ops hi6421_buck345_ops
;
116 #define HI6421_LDO_ENABLE_TIME (350)
118 * _id - LDO id name string
119 * _match - of match name string
120 * v_table - voltage table
121 * vreg - voltage select register
122 * vmask - voltage select mask
123 * ereg - enable register
124 * emask - enable mask
125 * odelay - off/on delay time in uS
126 * ecomask - eco mode mask
127 * ecoamp - eco mode load uppler limit in uA
129 #define HI6421_LDO(_id, _match, v_table, vreg, vmask, ereg, emask, \
130 odelay, ecomask, ecoamp) \
134 .of_match = of_match_ptr(#_match), \
135 .regulators_node = of_match_ptr("regulators"), \
136 .ops = &hi6421_ldo_ops, \
137 .type = REGULATOR_VOLTAGE, \
138 .id = HI6421_##_id, \
139 .owner = THIS_MODULE, \
140 .n_voltages = ARRAY_SIZE(v_table), \
141 .volt_table = v_table, \
142 .vsel_reg = HI6421_REG_TO_BUS_ADDR(vreg), \
143 .vsel_mask = vmask, \
144 .enable_reg = HI6421_REG_TO_BUS_ADDR(ereg), \
145 .enable_mask = emask, \
146 .enable_time = HI6421_LDO_ENABLE_TIME, \
147 .off_on_delay = odelay, \
149 .mode_mask = ecomask, \
150 .eco_microamp = ecoamp, \
153 /* HI6421 LDO1~3 are linear voltage regulators at fixed uV_step
155 * _id - LDO id name string
156 * _match - of match name string
157 * _min_uV - minimum voltage supported in uV
158 * n_volt - number of votages available
159 * vstep - voltage increase in each linear step in uV
160 * vreg - voltage select register
161 * vmask - voltage select mask
162 * ereg - enable register
163 * emask - enable mask
164 * odelay - off/on delay time in uS
165 * ecomask - eco mode mask
166 * ecoamp - eco mode load uppler limit in uA
168 #define HI6421_LDO_LINEAR(_id, _match, _min_uV, n_volt, vstep, vreg, vmask,\
169 ereg, emask, odelay, ecomask, ecoamp) \
173 .of_match = of_match_ptr(#_match), \
174 .regulators_node = of_match_ptr("regulators"), \
175 .ops = &hi6421_ldo_linear_ops, \
176 .type = REGULATOR_VOLTAGE, \
177 .id = HI6421_##_id, \
178 .owner = THIS_MODULE, \
180 .n_voltages = n_volt, \
182 .vsel_reg = HI6421_REG_TO_BUS_ADDR(vreg), \
183 .vsel_mask = vmask, \
184 .enable_reg = HI6421_REG_TO_BUS_ADDR(ereg), \
185 .enable_mask = emask, \
186 .enable_time = HI6421_LDO_ENABLE_TIME, \
187 .off_on_delay = odelay, \
189 .mode_mask = ecomask, \
190 .eco_microamp = ecoamp, \
193 /* HI6421 LDOAUDIO is a linear voltage regulator with two 4-step ranges
195 * _id - LDO id name string
196 * _match - of match name string
197 * n_volt - number of votages available
198 * volt_ranges - array of linear_range
199 * vstep - voltage increase in each linear step in uV
200 * vreg - voltage select register
201 * vmask - voltage select mask
202 * ereg - enable register
203 * emask - enable mask
204 * odelay - off/on delay time in uS
205 * ecomask - eco mode mask
206 * ecoamp - eco mode load uppler limit in uA
208 #define HI6421_LDO_LINEAR_RANGE(_id, _match, n_volt, volt_ranges, vreg, vmask,\
209 ereg, emask, odelay, ecomask, ecoamp) \
213 .of_match = of_match_ptr(#_match), \
214 .regulators_node = of_match_ptr("regulators"), \
215 .ops = &hi6421_ldo_linear_range_ops, \
216 .type = REGULATOR_VOLTAGE, \
217 .id = HI6421_##_id, \
218 .owner = THIS_MODULE, \
219 .n_voltages = n_volt, \
220 .linear_ranges = volt_ranges, \
221 .n_linear_ranges = ARRAY_SIZE(volt_ranges), \
222 .vsel_reg = HI6421_REG_TO_BUS_ADDR(vreg), \
223 .vsel_mask = vmask, \
224 .enable_reg = HI6421_REG_TO_BUS_ADDR(ereg), \
225 .enable_mask = emask, \
226 .enable_time = HI6421_LDO_ENABLE_TIME, \
227 .off_on_delay = odelay, \
229 .mode_mask = ecomask, \
230 .eco_microamp = ecoamp, \
233 /* HI6421 BUCK0/1/2 are linear voltage regulators at fixed uV_step
235 * _id - BUCK0/1/2 id name string
236 * _match - of match name string
237 * vreg - voltage select register
238 * vmask - voltage select mask
239 * ereg - enable register
240 * emask - enable mask
241 * sleepmask - mask of sleep mode
242 * etime - enable time
243 * odelay - off/on delay time in uS
245 #define HI6421_BUCK012(_id, _match, vreg, vmask, ereg, emask, sleepmask,\
250 .of_match = of_match_ptr(#_match), \
251 .regulators_node = of_match_ptr("regulators"), \
252 .ops = &hi6421_buck012_ops, \
253 .type = REGULATOR_VOLTAGE, \
254 .id = HI6421_##_id, \
255 .owner = THIS_MODULE, \
259 .vsel_reg = HI6421_REG_TO_BUS_ADDR(vreg), \
260 .vsel_mask = vmask, \
261 .enable_reg = HI6421_REG_TO_BUS_ADDR(ereg), \
262 .enable_mask = emask, \
263 .enable_time = etime, \
264 .off_on_delay = odelay, \
266 .mode_mask = sleepmask, \
269 /* HI6421 BUCK3/4/5 share similar configurations as LDOs, with exception
270 * that it supports SLEEP mode, so has different .ops.
272 * _id - LDO id name string
273 * _match - of match name string
274 * v_table - voltage table
275 * vreg - voltage select register
276 * vmask - voltage select mask
277 * ereg - enable register
278 * emask - enable mask
279 * odelay - off/on delay time in uS
280 * sleepmask - mask of sleep mode
282 #define HI6421_BUCK345(_id, _match, v_table, vreg, vmask, ereg, emask, \
287 .of_match = of_match_ptr(#_match), \
288 .regulators_node = of_match_ptr("regulators"), \
289 .ops = &hi6421_buck345_ops, \
290 .type = REGULATOR_VOLTAGE, \
291 .id = HI6421_##_id, \
292 .owner = THIS_MODULE, \
293 .n_voltages = ARRAY_SIZE(v_table), \
294 .volt_table = v_table, \
295 .vsel_reg = HI6421_REG_TO_BUS_ADDR(vreg), \
296 .vsel_mask = vmask, \
297 .enable_reg = HI6421_REG_TO_BUS_ADDR(ereg), \
298 .enable_mask = emask, \
299 .enable_time = HI6421_LDO_ENABLE_TIME, \
300 .off_on_delay = odelay, \
302 .mode_mask = sleepmask, \
305 /* HI6421 regulator information */
306 static struct hi6421_regulator_info
307 hi6421_regulator_info
[HI6421_NUM_REGULATORS
] = {
308 HI6421_LDO(LDO0
, hi6421_vout0
, ldo_0_voltages
, 0x20, 0x07, 0x20, 0x10,
310 HI6421_LDO_LINEAR(LDO1
, hi6421_vout1
, 1700000, 4, 100000, 0x21, 0x03,
311 0x21, 0x10, 10000, 0x20, 5000),
312 HI6421_LDO_LINEAR(LDO2
, hi6421_vout2
, 1050000, 8, 50000, 0x22, 0x07,
313 0x22, 0x10, 20000, 0x20, 8000),
314 HI6421_LDO_LINEAR(LDO3
, hi6421_vout3
, 1050000, 8, 50000, 0x23, 0x07,
315 0x23, 0x10, 20000, 0x20, 8000),
316 HI6421_LDO(LDO4
, hi6421_vout4
, ldo_0_voltages
, 0x24, 0x07, 0x24, 0x10,
318 HI6421_LDO(LDO5
, hi6421_vout5
, ldo_0_voltages
, 0x25, 0x07, 0x25, 0x10,
320 HI6421_LDO(LDO6
, hi6421_vout6
, ldo_0_voltages
, 0x26, 0x07, 0x26, 0x10,
322 HI6421_LDO(LDO7
, hi6421_vout7
, ldo_0_voltages
, 0x27, 0x07, 0x27, 0x10,
324 HI6421_LDO(LDO8
, hi6421_vout8
, ldo_8_voltages
, 0x28, 0x07, 0x28, 0x10,
326 HI6421_LDO(LDO9
, hi6421_vout9
, ldo_0_voltages
, 0x29, 0x07, 0x29, 0x10,
328 HI6421_LDO(LDO10
, hi6421_vout10
, ldo_0_voltages
, 0x2a, 0x07, 0x2a, 0x10,
330 HI6421_LDO(LDO11
, hi6421_vout11
, ldo_0_voltages
, 0x2b, 0x07, 0x2b, 0x10,
332 HI6421_LDO(LDO12
, hi6421_vout12
, ldo_0_voltages
, 0x2c, 0x07, 0x2c, 0x10,
334 HI6421_LDO(LDO13
, hi6421_vout13
, ldo_0_voltages
, 0x2d, 0x07, 0x2d, 0x10,
336 HI6421_LDO(LDO14
, hi6421_vout14
, ldo_0_voltages
, 0x2e, 0x07, 0x2e, 0x10,
338 HI6421_LDO(LDO15
, hi6421_vout15
, ldo_8_voltages
, 0x2f, 0x07, 0x2f, 0x10,
340 HI6421_LDO(LDO16
, hi6421_vout16
, ldo_0_voltages
, 0x30, 0x07, 0x30, 0x10,
342 HI6421_LDO(LDO17
, hi6421_vout17
, ldo_0_voltages
, 0x31, 0x07, 0x31, 0x10,
344 HI6421_LDO(LDO18
, hi6421_vout18
, ldo_0_voltages
, 0x32, 0x07, 0x32, 0x10,
346 HI6421_LDO(LDO19
, hi6421_vout19
, ldo_0_voltages
, 0x33, 0x07, 0x33, 0x10,
348 HI6421_LDO(LDO20
, hi6421_vout20
, ldo_0_voltages
, 0x34, 0x07, 0x34, 0x10,
350 HI6421_LDO_LINEAR_RANGE(LDOAUDIO
, hi6421_vout_audio
, 8,
351 ldo_audio_volt_range
, 0x36, 0x70, 0x36, 0x01,
353 HI6421_BUCK012(BUCK0
, hi6421_buck0
, 0x0d, 0x7f, 0x0c, 0x01, 0x10, 400,
355 HI6421_BUCK012(BUCK1
, hi6421_buck1
, 0x0f, 0x7f, 0x0e, 0x01, 0x10, 400,
357 HI6421_BUCK012(BUCK2
, hi6421_buck2
, 0x11, 0x7f, 0x10, 0x01, 0x10, 350,
359 HI6421_BUCK345(BUCK3
, hi6421_buck3
, buck_3_voltages
, 0x13, 0x07, 0x12,
361 HI6421_BUCK345(BUCK4
, hi6421_buck4
, buck_4_voltages
, 0x15, 0x07, 0x14,
363 HI6421_BUCK345(BUCK5
, hi6421_buck5
, buck_5_voltages
, 0x17, 0x07, 0x16,
367 static int hi6421_regulator_enable(struct regulator_dev
*rdev
)
369 struct hi6421_regulator_pdata
*pdata
;
371 pdata
= dev_get_drvdata(rdev
->dev
.parent
);
372 /* hi6421 spec requires regulator enablement must be serialized:
373 * - Because when BUCK, LDO switching from off to on, it will have
374 * a huge instantaneous current; so you can not turn on two or
375 * more LDO or BUCKs simultaneously, or it may burn the chip.
377 mutex_lock(&pdata
->lock
);
379 /* call regulator regmap helper */
380 regulator_enable_regmap(rdev
);
382 mutex_unlock(&pdata
->lock
);
386 static unsigned int hi6421_regulator_ldo_get_mode(struct regulator_dev
*rdev
)
388 struct hi6421_regulator_info
*info
= rdev_get_drvdata(rdev
);
391 regmap_read(rdev
->regmap
, rdev
->desc
->enable_reg
, ®_val
);
392 if (reg_val
& info
->mode_mask
)
393 return REGULATOR_MODE_IDLE
;
395 return REGULATOR_MODE_NORMAL
;
398 static unsigned int hi6421_regulator_buck_get_mode(struct regulator_dev
*rdev
)
400 struct hi6421_regulator_info
*info
= rdev_get_drvdata(rdev
);
403 regmap_read(rdev
->regmap
, rdev
->desc
->enable_reg
, ®_val
);
404 if (reg_val
& info
->mode_mask
)
405 return REGULATOR_MODE_STANDBY
;
407 return REGULATOR_MODE_NORMAL
;
410 static int hi6421_regulator_ldo_set_mode(struct regulator_dev
*rdev
,
413 struct hi6421_regulator_info
*info
= rdev_get_drvdata(rdev
);
417 case REGULATOR_MODE_NORMAL
:
420 case REGULATOR_MODE_IDLE
:
421 new_mode
= info
->mode_mask
;
428 regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
429 info
->mode_mask
, new_mode
);
434 static int hi6421_regulator_buck_set_mode(struct regulator_dev
*rdev
,
437 struct hi6421_regulator_info
*info
= rdev_get_drvdata(rdev
);
441 case REGULATOR_MODE_NORMAL
:
444 case REGULATOR_MODE_STANDBY
:
445 new_mode
= info
->mode_mask
;
452 regmap_update_bits(rdev
->regmap
, rdev
->desc
->enable_reg
,
453 info
->mode_mask
, new_mode
);
459 hi6421_regulator_ldo_get_optimum_mode(struct regulator_dev
*rdev
,
460 int input_uV
, int output_uV
, int load_uA
)
462 struct hi6421_regulator_info
*info
= rdev_get_drvdata(rdev
);
464 if (load_uA
> info
->eco_microamp
)
465 return REGULATOR_MODE_NORMAL
;
467 return REGULATOR_MODE_IDLE
;
470 static const struct regulator_ops hi6421_ldo_ops
= {
471 .is_enabled
= regulator_is_enabled_regmap
,
472 .enable
= hi6421_regulator_enable
,
473 .disable
= regulator_disable_regmap
,
474 .list_voltage
= regulator_list_voltage_table
,
475 .map_voltage
= regulator_map_voltage_ascend
,
476 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
477 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
478 .get_mode
= hi6421_regulator_ldo_get_mode
,
479 .set_mode
= hi6421_regulator_ldo_set_mode
,
480 .get_optimum_mode
= hi6421_regulator_ldo_get_optimum_mode
,
483 static const struct regulator_ops hi6421_ldo_linear_ops
= {
484 .is_enabled
= regulator_is_enabled_regmap
,
485 .enable
= hi6421_regulator_enable
,
486 .disable
= regulator_disable_regmap
,
487 .list_voltage
= regulator_list_voltage_linear
,
488 .map_voltage
= regulator_map_voltage_linear
,
489 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
490 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
491 .get_mode
= hi6421_regulator_ldo_get_mode
,
492 .set_mode
= hi6421_regulator_ldo_set_mode
,
493 .get_optimum_mode
= hi6421_regulator_ldo_get_optimum_mode
,
496 static const struct regulator_ops hi6421_ldo_linear_range_ops
= {
497 .is_enabled
= regulator_is_enabled_regmap
,
498 .enable
= hi6421_regulator_enable
,
499 .disable
= regulator_disable_regmap
,
500 .list_voltage
= regulator_list_voltage_linear_range
,
501 .map_voltage
= regulator_map_voltage_linear_range
,
502 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
503 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
504 .get_mode
= hi6421_regulator_ldo_get_mode
,
505 .set_mode
= hi6421_regulator_ldo_set_mode
,
506 .get_optimum_mode
= hi6421_regulator_ldo_get_optimum_mode
,
509 static const struct regulator_ops hi6421_buck012_ops
= {
510 .is_enabled
= regulator_is_enabled_regmap
,
511 .enable
= hi6421_regulator_enable
,
512 .disable
= regulator_disable_regmap
,
513 .list_voltage
= regulator_list_voltage_linear
,
514 .map_voltage
= regulator_map_voltage_linear
,
515 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
516 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
517 .get_mode
= hi6421_regulator_buck_get_mode
,
518 .set_mode
= hi6421_regulator_buck_set_mode
,
521 static const struct regulator_ops hi6421_buck345_ops
= {
522 .is_enabled
= regulator_is_enabled_regmap
,
523 .enable
= hi6421_regulator_enable
,
524 .disable
= regulator_disable_regmap
,
525 .list_voltage
= regulator_list_voltage_table
,
526 .map_voltage
= regulator_map_voltage_ascend
,
527 .get_voltage_sel
= regulator_get_voltage_sel_regmap
,
528 .set_voltage_sel
= regulator_set_voltage_sel_regmap
,
529 .get_mode
= hi6421_regulator_buck_get_mode
,
530 .set_mode
= hi6421_regulator_buck_set_mode
,
533 static int hi6421_regulator_probe(struct platform_device
*pdev
)
535 struct hi6421_pmic
*pmic
= dev_get_drvdata(pdev
->dev
.parent
);
536 struct hi6421_regulator_pdata
*pdata
;
537 struct hi6421_regulator_info
*info
;
538 struct regulator_config config
= { };
539 struct regulator_dev
*rdev
;
542 pdata
= devm_kzalloc(&pdev
->dev
, sizeof(*pdata
), GFP_KERNEL
);
545 mutex_init(&pdata
->lock
);
546 platform_set_drvdata(pdev
, pdata
);
548 for (i
= 0; i
< ARRAY_SIZE(hi6421_regulator_info
); i
++) {
549 /* assign per-regulator data */
550 info
= &hi6421_regulator_info
[i
];
552 config
.dev
= pdev
->dev
.parent
;
553 config
.driver_data
= info
;
554 config
.regmap
= pmic
->regmap
;
556 rdev
= devm_regulator_register(&pdev
->dev
, &info
->desc
,
559 dev_err(&pdev
->dev
, "failed to register regulator %s\n",
561 return PTR_ERR(rdev
);
568 static const struct platform_device_id hi6421_regulator_table
[] = {
569 { .name
= "hi6421-regulator" },
572 MODULE_DEVICE_TABLE(platform
, hi6421_regulator_table
);
574 static struct platform_driver hi6421_regulator_driver
= {
575 .id_table
= hi6421_regulator_table
,
577 .name
= "hi6421-regulator",
579 .probe
= hi6421_regulator_probe
,
581 module_platform_driver(hi6421_regulator_driver
);
583 MODULE_AUTHOR("Guodong Xu <guodong.xu@linaro.org>");
584 MODULE_DESCRIPTION("Hi6421 regulator driver");
585 MODULE_LICENSE("GPL v2");