1 /*
2  * AS3711 PMIC regulator driver, using DCDC Step Down and LDO supplies
3  *
4  * Copyright (C) 2012 Renesas Electronics Corporation
5  * Author: Guennadi Liakhovetski, <g.liakhovetski@gmx.de>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the version 2 of the GNU General Public License as
9  * published by the Free Software Foundation
10  */
11 
12 #include <linux/err.h>
13 #include <linux/init.h>
14 #include <linux/mfd/as3711.h>
15 #include <linux/module.h>
16 #include <linux/of.h>
17 #include <linux/platform_device.h>
18 #include <linux/regmap.h>
19 #include <linux/regulator/driver.h>
20 #include <linux/regulator/of_regulator.h>
21 #include <linux/slab.h>
22 
23 struct as3711_regulator_info {
24 	struct regulator_desc	desc;
25 	unsigned int		max_uV;
26 };
27 
28 struct as3711_regulator {
29 	struct as3711_regulator_info *reg_info;
30 	struct regulator_dev *rdev;
31 };
32 
33 /*
34  * The regulator API supports 4 modes of operataion: FAST, NORMAL, IDLE and
35  * STANDBY. We map them in the following way to AS3711 SD1-4 DCDC modes:
36  * FAST:	sdX_fast=1
37  * NORMAL:	low_noise=1
38  * IDLE:	low_noise=0
39  */
40 
41 static int as3711_set_mode_sd(struct regulator_dev *rdev, unsigned int mode)
42 {
43 	unsigned int fast_bit = rdev->desc->enable_mask,
44 		low_noise_bit = fast_bit << 4;
45 	u8 val;
46 
47 	switch (mode) {
48 	case REGULATOR_MODE_FAST:
49 		val = fast_bit | low_noise_bit;
50 		break;
51 	case REGULATOR_MODE_NORMAL:
52 		val = low_noise_bit;
53 		break;
54 	case REGULATOR_MODE_IDLE:
55 		val = 0;
56 		break;
57 	default:
58 		return -EINVAL;
59 	}
60 
61 	return regmap_update_bits(rdev->regmap, AS3711_SD_CONTROL_1,
62 				  low_noise_bit | fast_bit, val);
63 }
64 
65 static unsigned int as3711_get_mode_sd(struct regulator_dev *rdev)
66 {
67 	unsigned int fast_bit = rdev->desc->enable_mask,
68 		low_noise_bit = fast_bit << 4, mask = fast_bit | low_noise_bit;
69 	unsigned int val;
70 	int ret = regmap_read(rdev->regmap, AS3711_SD_CONTROL_1, &val);
71 
72 	if (ret < 0)
73 		return ret;
74 
75 	if ((val & mask) == mask)
76 		return REGULATOR_MODE_FAST;
77 
78 	if ((val & mask) == low_noise_bit)
79 		return REGULATOR_MODE_NORMAL;
80 
81 	if (!(val & mask))
82 		return REGULATOR_MODE_IDLE;
83 
84 	return -EINVAL;
85 }
86 
87 static struct regulator_ops as3711_sd_ops = {
88 	.is_enabled		= regulator_is_enabled_regmap,
89 	.enable			= regulator_enable_regmap,
90 	.disable		= regulator_disable_regmap,
91 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
92 	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
93 	.list_voltage		= regulator_list_voltage_linear_range,
94 	.map_voltage		= regulator_map_voltage_linear_range,
95 	.get_mode		= as3711_get_mode_sd,
96 	.set_mode		= as3711_set_mode_sd,
97 };
98 
99 static struct regulator_ops as3711_aldo_ops = {
100 	.is_enabled		= regulator_is_enabled_regmap,
101 	.enable			= regulator_enable_regmap,
102 	.disable		= regulator_disable_regmap,
103 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
104 	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
105 	.list_voltage		= regulator_list_voltage_linear_range,
106 	.map_voltage		= regulator_map_voltage_linear_range,
107 };
108 
109 static struct regulator_ops as3711_dldo_ops = {
110 	.is_enabled		= regulator_is_enabled_regmap,
111 	.enable			= regulator_enable_regmap,
112 	.disable		= regulator_disable_regmap,
113 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
114 	.set_voltage_sel	= regulator_set_voltage_sel_regmap,
115 	.list_voltage		= regulator_list_voltage_linear_range,
116 	.map_voltage		= regulator_map_voltage_linear_range,
117 };
118 
119 static const struct regulator_linear_range as3711_sd_ranges[] = {
120 	{ .min_uV = 612500, .max_uV = 1400000,
121 	  .min_sel = 0x1, .max_sel = 0x40, .uV_step = 12500 },
122 	{ .min_uV = 1425000, .max_uV = 2600000,
123 	  .min_sel = 0x41, .max_sel = 0x70, .uV_step = 25000 },
124 	{ .min_uV = 2650000, .max_uV = 3350000,
125 	  .min_sel = 0x71, .max_sel = 0x7f, .uV_step = 50000 },
126 };
127 
128 static const struct regulator_linear_range as3711_aldo_ranges[] = {
129 	{ .min_uV = 1200000, .max_uV = 1950000,
130 	  .min_sel = 0, .max_sel = 0xf, .uV_step = 50000 },
131 	{ .min_uV = 1800000, .max_uV = 3300000,
132 	  .min_sel = 0x10, .max_sel = 0x1f, .uV_step = 100000 },
133 };
134 
135 static const struct regulator_linear_range as3711_dldo_ranges[] = {
136 	{ .min_uV = 900000, .max_uV = 1700000,
137 	  .min_sel = 0, .max_sel = 0x10, .uV_step = 50000 },
138 	{ .min_uV = 1750000, .max_uV = 3300000,
139 	  .min_sel = 0x20, .max_sel = 0x3f, .uV_step = 50000 },
140 };
141 
142 #define AS3711_REG(_id, _en_reg, _en_bit, _vmask, _vshift, _min_uV, _max_uV, _sfx)	\
143 	[AS3711_REGULATOR_ ## _id] = {							\
144 	.desc = {									\
145 		.name = "as3711-regulator-" # _id,					\
146 		.id = AS3711_REGULATOR_ ## _id,						\
147 		.n_voltages = (_vmask + 1),						\
148 		.ops = &as3711_ ## _sfx ## _ops,					\
149 		.type = REGULATOR_VOLTAGE,						\
150 		.owner = THIS_MODULE,							\
151 		.vsel_reg = AS3711_ ## _id ## _VOLTAGE,					\
152 		.vsel_mask = _vmask << _vshift,						\
153 		.enable_reg = AS3711_ ## _en_reg,					\
154 		.enable_mask = BIT(_en_bit),						\
155 		.min_uV	= _min_uV,							\
156 		.linear_ranges = as3711_ ## _sfx ## _ranges,				\
157 		.n_linear_ranges = ARRAY_SIZE(as3711_ ## _sfx ## _ranges),		\
158 	},										\
159 	.max_uV = _max_uV,								\
160 }
161 
162 static struct as3711_regulator_info as3711_reg_info[] = {
163 	AS3711_REG(SD_1, SD_CONTROL, 0, 0x7f, 0, 612500, 3350000, sd),
164 	AS3711_REG(SD_2, SD_CONTROL, 1, 0x7f, 0, 612500, 3350000, sd),
165 	AS3711_REG(SD_3, SD_CONTROL, 2, 0x7f, 0, 612500, 3350000, sd),
166 	AS3711_REG(SD_4, SD_CONTROL, 3, 0x7f, 0, 612500, 3350000, sd),
167 	AS3711_REG(LDO_1, LDO_1_VOLTAGE, 7, 0x1f, 0, 1200000, 3300000, aldo),
168 	AS3711_REG(LDO_2, LDO_2_VOLTAGE, 7, 0x1f, 0, 1200000, 3300000, aldo),
169 	AS3711_REG(LDO_3, LDO_3_VOLTAGE, 7, 0x3f, 0, 900000, 3300000, dldo),
170 	AS3711_REG(LDO_4, LDO_4_VOLTAGE, 7, 0x3f, 0, 900000, 3300000, dldo),
171 	AS3711_REG(LDO_5, LDO_5_VOLTAGE, 7, 0x3f, 0, 900000, 3300000, dldo),
172 	AS3711_REG(LDO_6, LDO_6_VOLTAGE, 7, 0x3f, 0, 900000, 3300000, dldo),
173 	AS3711_REG(LDO_7, LDO_7_VOLTAGE, 7, 0x3f, 0, 900000, 3300000, dldo),
174 	AS3711_REG(LDO_8, LDO_8_VOLTAGE, 7, 0x3f, 0, 900000, 3300000, dldo),
175 	/* StepUp output voltage depends on supplying regulator */
176 };
177 
178 #define AS3711_REGULATOR_NUM ARRAY_SIZE(as3711_reg_info)
179 
180 static struct of_regulator_match
181 as3711_regulator_matches[AS3711_REGULATOR_NUM] = {
182 	[AS3711_REGULATOR_SD_1] = { .name = "sd1" },
183 	[AS3711_REGULATOR_SD_2] = { .name = "sd2" },
184 	[AS3711_REGULATOR_SD_3] = { .name = "sd3" },
185 	[AS3711_REGULATOR_SD_4] = { .name = "sd4" },
186 	[AS3711_REGULATOR_LDO_1] = { .name = "ldo1" },
187 	[AS3711_REGULATOR_LDO_2] = { .name = "ldo2" },
188 	[AS3711_REGULATOR_LDO_3] = { .name = "ldo3" },
189 	[AS3711_REGULATOR_LDO_4] = { .name = "ldo4" },
190 	[AS3711_REGULATOR_LDO_5] = { .name = "ldo5" },
191 	[AS3711_REGULATOR_LDO_6] = { .name = "ldo6" },
192 	[AS3711_REGULATOR_LDO_7] = { .name = "ldo7" },
193 	[AS3711_REGULATOR_LDO_8] = { .name = "ldo8" },
194 };
195 
196 static int as3711_regulator_parse_dt(struct device *dev,
197 				struct device_node **of_node, const int count)
198 {
199 	struct as3711_regulator_pdata *pdata = dev_get_platdata(dev);
200 	struct device_node *regulators =
201 		of_find_node_by_name(dev->parent->of_node, "regulators");
202 	struct of_regulator_match *match;
203 	int ret, i;
204 
205 	if (!regulators) {
206 		dev_err(dev, "regulator node not found\n");
207 		return -ENODEV;
208 	}
209 
210 	ret = of_regulator_match(dev->parent, regulators,
211 				 as3711_regulator_matches, count);
212 	of_node_put(regulators);
213 	if (ret < 0) {
214 		dev_err(dev, "Error parsing regulator init data: %d\n", ret);
215 		return ret;
216 	}
217 
218 	for (i = 0, match = as3711_regulator_matches; i < count; i++, match++)
219 		if (match->of_node) {
220 			pdata->init_data[i] = match->init_data;
221 			of_node[i] = match->of_node;
222 		}
223 
224 	return 0;
225 }
226 
227 static int as3711_regulator_probe(struct platform_device *pdev)
228 {
229 	struct as3711_regulator_pdata *pdata = dev_get_platdata(&pdev->dev);
230 	struct as3711 *as3711 = dev_get_drvdata(pdev->dev.parent);
231 	struct regulator_init_data *reg_data;
232 	struct regulator_config config = {.dev = &pdev->dev,};
233 	struct as3711_regulator *reg = NULL;
234 	struct as3711_regulator *regs;
235 	struct device_node *of_node[AS3711_REGULATOR_NUM] = {};
236 	struct regulator_dev *rdev;
237 	struct as3711_regulator_info *ri;
238 	int ret;
239 	int id;
240 
241 	if (!pdata) {
242 		dev_err(&pdev->dev, "No platform data...\n");
243 		return -ENODEV;
244 	}
245 
246 	if (pdev->dev.parent->of_node) {
247 		ret = as3711_regulator_parse_dt(&pdev->dev, of_node, AS3711_REGULATOR_NUM);
248 		if (ret < 0) {
249 			dev_err(&pdev->dev, "DT parsing failed: %d\n", ret);
250 			return ret;
251 		}
252 	}
253 
254 	regs = devm_kzalloc(&pdev->dev, AS3711_REGULATOR_NUM *
255 			sizeof(struct as3711_regulator), GFP_KERNEL);
256 	if (!regs) {
257 		dev_err(&pdev->dev, "Memory allocation failed exiting..\n");
258 		return -ENOMEM;
259 	}
260 
261 	for (id = 0, ri = as3711_reg_info; id < AS3711_REGULATOR_NUM; ++id, ri++) {
262 		reg_data = pdata->init_data[id];
263 
264 		/* No need to register if there is no regulator data */
265 		if (!reg_data)
266 			continue;
267 
268 		reg = &regs[id];
269 		reg->reg_info = ri;
270 
271 		config.init_data = reg_data;
272 		config.driver_data = reg;
273 		config.regmap = as3711->regmap;
274 		config.of_node = of_node[id];
275 
276 		rdev = regulator_register(&ri->desc, &config);
277 		if (IS_ERR(rdev)) {
278 			dev_err(&pdev->dev, "Failed to register regulator %s\n",
279 				ri->desc.name);
280 			ret = PTR_ERR(rdev);
281 			goto eregreg;
282 		}
283 		reg->rdev = rdev;
284 	}
285 	platform_set_drvdata(pdev, regs);
286 	return 0;
287 
288 eregreg:
289 	while (--id >= 0)
290 		regulator_unregister(regs[id].rdev);
291 
292 	return ret;
293 }
294 
295 static int as3711_regulator_remove(struct platform_device *pdev)
296 {
297 	struct as3711_regulator *regs = platform_get_drvdata(pdev);
298 	int id;
299 
300 	for (id = 0; id < AS3711_REGULATOR_NUM; ++id)
301 		regulator_unregister(regs[id].rdev);
302 	return 0;
303 }
304 
305 static struct platform_driver as3711_regulator_driver = {
306 	.driver	= {
307 		.name	= "as3711-regulator",
308 		.owner	= THIS_MODULE,
309 	},
310 	.probe		= as3711_regulator_probe,
311 	.remove		= as3711_regulator_remove,
312 };
313 
314 static int __init as3711_regulator_init(void)
315 {
316 	return platform_driver_register(&as3711_regulator_driver);
317 }
318 subsys_initcall(as3711_regulator_init);
319 
320 static void __exit as3711_regulator_exit(void)
321 {
322 	platform_driver_unregister(&as3711_regulator_driver);
323 }
324 module_exit(as3711_regulator_exit);
325 
326 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
327 MODULE_DESCRIPTION("AS3711 regulator driver");
328 MODULE_ALIAS("platform:as3711-regulator");
329 MODULE_LICENSE("GPL v2");
330