1/*
2 * Regulators driver for Marvell 88PM800
3 *
4 * Copyright (C) 2012 Marvell International Ltd.
5 * Joseph(Yossi) Hanin <yhanin@marvell.com>
6 * Yi Zhang <yizhang@marvell.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 */
12#include <linux/module.h>
13#include <linux/moduleparam.h>
14#include <linux/init.h>
15#include <linux/err.h>
16#include <linux/regmap.h>
17#include <linux/regulator/driver.h>
18#include <linux/regulator/machine.h>
19#include <linux/mfd/88pm80x.h>
20#include <linux/delay.h>
21#include <linux/io.h>
22#include <linux/of.h>
23#include <linux/regulator/of_regulator.h>
24
25/* LDO1 with DVC[0..3] */
26#define PM800_LDO1_VOUT		(0x08) /* VOUT1 */
27#define PM800_LDO1_VOUT_2	(0x09)
28#define PM800_LDO1_VOUT_3	(0x0A)
29#define PM800_LDO2_VOUT		(0x0B)
30#define PM800_LDO3_VOUT		(0x0C)
31#define PM800_LDO4_VOUT		(0x0D)
32#define PM800_LDO5_VOUT		(0x0E)
33#define PM800_LDO6_VOUT		(0x0F)
34#define PM800_LDO7_VOUT		(0x10)
35#define PM800_LDO8_VOUT		(0x11)
36#define PM800_LDO9_VOUT		(0x12)
37#define PM800_LDO10_VOUT	(0x13)
38#define PM800_LDO11_VOUT	(0x14)
39#define PM800_LDO12_VOUT	(0x15)
40#define PM800_LDO13_VOUT	(0x16)
41#define PM800_LDO14_VOUT	(0x17)
42#define PM800_LDO15_VOUT	(0x18)
43#define PM800_LDO16_VOUT	(0x19)
44#define PM800_LDO17_VOUT	(0x1A)
45#define PM800_LDO18_VOUT	(0x1B)
46#define PM800_LDO19_VOUT	(0x1C)
47
48/* BUCK1 with DVC[0..3] */
49#define PM800_BUCK1		(0x3C)
50#define PM800_BUCK1_1		(0x3D)
51#define PM800_BUCK1_2		(0x3E)
52#define PM800_BUCK1_3		(0x3F)
53#define PM800_BUCK2		(0x40)
54#define PM800_BUCK3		(0x41)
55#define PM800_BUCK4		(0x42)
56#define PM800_BUCK4_1		(0x43)
57#define PM800_BUCK4_2		(0x44)
58#define PM800_BUCK4_3		(0x45)
59#define PM800_BUCK5		(0x46)
60
61#define PM800_BUCK_ENA		(0x50)
62#define PM800_LDO_ENA1_1	(0x51)
63#define PM800_LDO_ENA1_2	(0x52)
64#define PM800_LDO_ENA1_3	(0x53)
65
66#define PM800_LDO_ENA2_1	(0x56)
67#define PM800_LDO_ENA2_2	(0x57)
68#define PM800_LDO_ENA2_3	(0x58)
69
70#define PM800_BUCK1_MISC1	(0x78)
71#define PM800_BUCK3_MISC1	(0x7E)
72#define PM800_BUCK4_MISC1	(0x81)
73#define PM800_BUCK5_MISC1	(0x84)
74
75struct pm800_regulator_info {
76	struct regulator_desc desc;
77	int max_ua;
78};
79
80struct pm800_regulators {
81	struct regulator_dev *regulators[PM800_ID_RG_MAX];
82	struct pm80x_chip *chip;
83	struct regmap *map;
84};
85
86/*
87 * vreg - the buck regs string.
88 * ereg - the string for the enable register.
89 * ebit - the bit number in the enable register.
90 * amax - the current
91 * Buck has 2 kinds of voltage steps. It is easy to find voltage by ranges,
92 * not the constant voltage table.
93 * n_volt - Number of available selectors
94 */
95#define PM800_BUCK(vreg, ereg, ebit, amax, volt_ranges, n_volt)		\
96{									\
97	.desc	= {							\
98		.name	= #vreg,					\
99		.ops	= &pm800_volt_range_ops,			\
100		.type	= REGULATOR_VOLTAGE,				\
101		.id	= PM800_ID_##vreg,				\
102		.owner	= THIS_MODULE,					\
103		.n_voltages		= n_volt,			\
104		.linear_ranges		= volt_ranges,			\
105		.n_linear_ranges	= ARRAY_SIZE(volt_ranges),	\
106		.vsel_reg		= PM800_##vreg,			\
107		.vsel_mask		= 0x7f,				\
108		.enable_reg		= PM800_##ereg,			\
109		.enable_mask		= 1 << (ebit),			\
110	},								\
111	.max_ua		= (amax),					\
112}
113
114/*
115 * vreg - the LDO regs string
116 * ereg -  the string for the enable register.
117 * ebit - the bit number in the enable register.
118 * amax - the current
119 * volt_table - the LDO voltage table
120 * For all the LDOes, there are too many ranges. Using volt_table will be
121 * simpler and faster.
122 */
123#define PM800_LDO(vreg, ereg, ebit, amax, ldo_volt_table)		\
124{									\
125	.desc	= {							\
126		.name	= #vreg,					\
127		.ops	= &pm800_volt_table_ops,			\
128		.type	= REGULATOR_VOLTAGE,				\
129		.id	= PM800_ID_##vreg,				\
130		.owner	= THIS_MODULE,					\
131		.n_voltages = ARRAY_SIZE(ldo_volt_table),		\
132		.vsel_reg	= PM800_##vreg##_VOUT,			\
133		.vsel_mask	= 0x1f,					\
134		.enable_reg	= PM800_##ereg,				\
135		.enable_mask	= 1 << (ebit),				\
136		.volt_table	= ldo_volt_table,			\
137	},								\
138	.max_ua		= (amax),					\
139}
140
141/* Ranges are sorted in ascending order. */
142static const struct regulator_linear_range buck1_volt_range[] = {
143	REGULATOR_LINEAR_RANGE(600000, 0, 0x4f, 12500),
144	REGULATOR_LINEAR_RANGE(1600000, 0x50, 0x54, 50000),
145};
146
147/* BUCK 2~5 have same ranges. */
148static const struct regulator_linear_range buck2_5_volt_range[] = {
149	REGULATOR_LINEAR_RANGE(600000, 0, 0x4f, 12500),
150	REGULATOR_LINEAR_RANGE(1600000, 0x50, 0x72, 50000),
151};
152
153static const unsigned int ldo1_volt_table[] = {
154	600000,  650000,  700000,  750000,  800000,  850000,  900000,  950000,
155	1000000, 1050000, 1100000, 1150000, 1200000, 1300000, 1400000, 1500000,
156};
157
158static const unsigned int ldo2_volt_table[] = {
159	1700000, 1800000, 1900000, 2000000, 2100000, 2500000, 2700000, 2800000,
160};
161
162/* LDO 3~17 have same voltage table. */
163static const unsigned int ldo3_17_volt_table[] = {
164	1200000, 1250000, 1700000, 1800000, 1850000, 1900000, 2500000, 2600000,
165	2700000, 2750000, 2800000, 2850000, 2900000, 3000000, 3100000, 3300000,
166};
167
168/* LDO 18~19 have same voltage table. */
169static const unsigned int ldo18_19_volt_table[] = {
170	1700000, 1800000, 1900000, 2500000, 2800000, 2900000, 3100000, 3300000,
171};
172
173static int pm800_get_current_limit(struct regulator_dev *rdev)
174{
175	struct pm800_regulator_info *info = rdev_get_drvdata(rdev);
176
177	return info->max_ua;
178}
179
180static struct regulator_ops pm800_volt_range_ops = {
181	.list_voltage = regulator_list_voltage_linear_range,
182	.map_voltage = regulator_map_voltage_linear_range,
183	.set_voltage_sel = regulator_set_voltage_sel_regmap,
184	.get_voltage_sel = regulator_get_voltage_sel_regmap,
185	.enable = regulator_enable_regmap,
186	.disable = regulator_disable_regmap,
187	.is_enabled = regulator_is_enabled_regmap,
188	.get_current_limit = pm800_get_current_limit,
189};
190
191static struct regulator_ops pm800_volt_table_ops = {
192	.list_voltage = regulator_list_voltage_table,
193	.map_voltage = regulator_map_voltage_iterate,
194	.set_voltage_sel = regulator_set_voltage_sel_regmap,
195	.get_voltage_sel = regulator_get_voltage_sel_regmap,
196	.enable = regulator_enable_regmap,
197	.disable = regulator_disable_regmap,
198	.is_enabled = regulator_is_enabled_regmap,
199	.get_current_limit = pm800_get_current_limit,
200};
201
202/* The array is indexed by id(PM800_ID_XXX) */
203static struct pm800_regulator_info pm800_regulator_info[] = {
204	PM800_BUCK(BUCK1, BUCK_ENA, 0, 3000000, buck1_volt_range, 0x55),
205	PM800_BUCK(BUCK2, BUCK_ENA, 1, 1200000, buck2_5_volt_range, 0x73),
206	PM800_BUCK(BUCK3, BUCK_ENA, 2, 1200000, buck2_5_volt_range, 0x73),
207	PM800_BUCK(BUCK4, BUCK_ENA, 3, 1200000, buck2_5_volt_range, 0x73),
208	PM800_BUCK(BUCK5, BUCK_ENA, 4, 1200000, buck2_5_volt_range, 0x73),
209
210	PM800_LDO(LDO1, LDO_ENA1_1, 0, 200000, ldo1_volt_table),
211	PM800_LDO(LDO2, LDO_ENA1_1, 1, 10000, ldo2_volt_table),
212	PM800_LDO(LDO3, LDO_ENA1_1, 2, 300000, ldo3_17_volt_table),
213	PM800_LDO(LDO4, LDO_ENA1_1, 3, 300000, ldo3_17_volt_table),
214	PM800_LDO(LDO5, LDO_ENA1_1, 4, 300000, ldo3_17_volt_table),
215	PM800_LDO(LDO6, LDO_ENA1_1, 5, 300000, ldo3_17_volt_table),
216	PM800_LDO(LDO7, LDO_ENA1_1, 6, 300000, ldo3_17_volt_table),
217	PM800_LDO(LDO8, LDO_ENA1_1, 7, 300000, ldo3_17_volt_table),
218	PM800_LDO(LDO9, LDO_ENA1_2, 0, 300000, ldo3_17_volt_table),
219	PM800_LDO(LDO10, LDO_ENA1_2, 1, 300000, ldo3_17_volt_table),
220	PM800_LDO(LDO11, LDO_ENA1_2, 2, 300000, ldo3_17_volt_table),
221	PM800_LDO(LDO12, LDO_ENA1_2, 3, 300000, ldo3_17_volt_table),
222	PM800_LDO(LDO13, LDO_ENA1_2, 4, 300000, ldo3_17_volt_table),
223	PM800_LDO(LDO14, LDO_ENA1_2, 5, 300000, ldo3_17_volt_table),
224	PM800_LDO(LDO15, LDO_ENA1_2, 6, 300000, ldo3_17_volt_table),
225	PM800_LDO(LDO16, LDO_ENA1_2, 7, 300000, ldo3_17_volt_table),
226	PM800_LDO(LDO17, LDO_ENA1_3, 0, 300000, ldo3_17_volt_table),
227	PM800_LDO(LDO18, LDO_ENA1_3, 1, 200000, ldo18_19_volt_table),
228	PM800_LDO(LDO19, LDO_ENA1_3, 2, 200000, ldo18_19_volt_table),
229};
230
231#define PM800_REGULATOR_OF_MATCH(_name, _id)				\
232	[PM800_ID_##_id] = {						\
233		.name = #_name,						\
234		.driver_data = &pm800_regulator_info[PM800_ID_##_id],	\
235	}
236
237static struct of_regulator_match pm800_regulator_matches[] = {
238	PM800_REGULATOR_OF_MATCH(buck1, BUCK1),
239	PM800_REGULATOR_OF_MATCH(buck2, BUCK2),
240	PM800_REGULATOR_OF_MATCH(buck3, BUCK3),
241	PM800_REGULATOR_OF_MATCH(buck4, BUCK4),
242	PM800_REGULATOR_OF_MATCH(buck5, BUCK5),
243	PM800_REGULATOR_OF_MATCH(ldo1, LDO1),
244	PM800_REGULATOR_OF_MATCH(ldo2, LDO2),
245	PM800_REGULATOR_OF_MATCH(ldo3, LDO3),
246	PM800_REGULATOR_OF_MATCH(ldo4, LDO4),
247	PM800_REGULATOR_OF_MATCH(ldo5, LDO5),
248	PM800_REGULATOR_OF_MATCH(ldo6, LDO6),
249	PM800_REGULATOR_OF_MATCH(ldo7, LDO7),
250	PM800_REGULATOR_OF_MATCH(ldo8, LDO8),
251	PM800_REGULATOR_OF_MATCH(ldo9, LDO9),
252	PM800_REGULATOR_OF_MATCH(ldo10, LDO10),
253	PM800_REGULATOR_OF_MATCH(ldo11, LDO11),
254	PM800_REGULATOR_OF_MATCH(ldo12, LDO12),
255	PM800_REGULATOR_OF_MATCH(ldo13, LDO13),
256	PM800_REGULATOR_OF_MATCH(ldo14, LDO14),
257	PM800_REGULATOR_OF_MATCH(ldo15, LDO15),
258	PM800_REGULATOR_OF_MATCH(ldo16, LDO16),
259	PM800_REGULATOR_OF_MATCH(ldo17, LDO17),
260	PM800_REGULATOR_OF_MATCH(ldo18, LDO18),
261	PM800_REGULATOR_OF_MATCH(ldo19, LDO19),
262};
263
264static int pm800_regulator_dt_init(struct platform_device *pdev)
265{
266	struct device_node *np = pdev->dev.of_node;
267	int ret;
268
269	ret = of_regulator_match(&pdev->dev, np,
270				 pm800_regulator_matches,
271				 ARRAY_SIZE(pm800_regulator_matches));
272	if (ret < 0)
273		return ret;
274
275	return 0;
276}
277
278static int pm800_regulator_probe(struct platform_device *pdev)
279{
280	struct pm80x_chip *chip = dev_get_drvdata(pdev->dev.parent);
281	struct pm80x_platform_data *pdata = dev_get_platdata(pdev->dev.parent);
282	struct pm800_regulators *pm800_data;
283	struct pm800_regulator_info *info;
284	struct regulator_config config = { };
285	struct regulator_init_data *init_data;
286	int i, ret;
287
288	if (!pdata || pdata->num_regulators == 0) {
289		if (IS_ENABLED(CONFIG_OF)) {
290			ret = pm800_regulator_dt_init(pdev);
291			if (ret)
292				return ret;
293		} else {
294			return -ENODEV;
295		}
296	} else if (pdata->num_regulators) {
297		unsigned int count = 0;
298
299		/* Check whether num_regulator is valid. */
300		for (i = 0; i < ARRAY_SIZE(pdata->regulators); i++) {
301			if (pdata->regulators[i])
302				count++;
303		}
304		if (count != pdata->num_regulators)
305			return -EINVAL;
306	} else {
307		return -EINVAL;
308	}
309
310	pm800_data = devm_kzalloc(&pdev->dev, sizeof(*pm800_data),
311					GFP_KERNEL);
312	if (!pm800_data)
313		return -ENOMEM;
314
315	pm800_data->map = chip->subchip->regmap_power;
316	pm800_data->chip = chip;
317
318	platform_set_drvdata(pdev, pm800_data);
319
320	for (i = 0; i < PM800_ID_RG_MAX; i++) {
321		if (!pdata || pdata->num_regulators == 0)
322			init_data = pm800_regulator_matches[i].init_data;
323		else
324			init_data = pdata->regulators[i];
325		if (!init_data)
326			continue;
327		info = pm800_regulator_matches[i].driver_data;
328		config.dev = &pdev->dev;
329		config.init_data = init_data;
330		config.driver_data = info;
331		config.regmap = pm800_data->map;
332		config.of_node = pm800_regulator_matches[i].of_node;
333
334		pm800_data->regulators[i] =
335				regulator_register(&info->desc, &config);
336		if (IS_ERR(pm800_data->regulators[i])) {
337			ret = PTR_ERR(pm800_data->regulators[i]);
338			dev_err(&pdev->dev, "Failed to register %s\n",
339				info->desc.name);
340
341			while (--i >= 0)
342				regulator_unregister(pm800_data->regulators[i]);
343
344			return ret;
345		}
346	}
347
348	return 0;
349}
350
351static int pm800_regulator_remove(struct platform_device *pdev)
352{
353	struct pm800_regulators *pm800_data = platform_get_drvdata(pdev);
354	int i;
355
356	for (i = 0; i < PM800_ID_RG_MAX; i++)
357		regulator_unregister(pm800_data->regulators[i]);
358
359	return 0;
360}
361
362static struct platform_driver pm800_regulator_driver = {
363	.driver		= {
364		.name	= "88pm80x-regulator",
365		.owner	= THIS_MODULE,
366	},
367	.probe		= pm800_regulator_probe,
368	.remove		= pm800_regulator_remove,
369};
370
371module_platform_driver(pm800_regulator_driver);
372
373MODULE_LICENSE("GPL");
374MODULE_AUTHOR("Joseph(Yossi) Hanin <yhanin@marvell.com>");
375MODULE_DESCRIPTION("Regulator Driver for Marvell 88PM800 PMIC");
376MODULE_ALIAS("platform:88pm800-regulator");
377