1 /* NXP PCF50633 PMIC Driver
2  *
3  * (C) 2006-2008 by Openmoko, Inc.
4  * Author: Balaji Rao <balajirrao@openmoko.org>
5  * All rights reserved.
6  *
7  * Broken down from monstrous PCF50633 driver mainly by
8  * Harald Welte and Andy Green and Werner Almesberger
9  *
10  *  This program is free software; you can redistribute  it and/or modify it
11  *  under  the terms of  the GNU General  Public License as published by the
12  *  Free Software Foundation;  either version 2 of the  License, or (at your
13  *  option) any later version.
14  *
15  */
16 
17 #include <linux/kernel.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/device.h>
21 #include <linux/err.h>
22 #include <linux/platform_device.h>
23 
24 #include <linux/mfd/pcf50633/core.h>
25 #include <linux/mfd/pcf50633/pmic.h>
26 
27 #define PCF50633_REGULATOR(_name, _id, _n) 		\
28 	{					\
29 		.name = _name, 			\
30 		.id = _id,			\
31 		.ops = &pcf50633_regulator_ops,	\
32 		.n_voltages = _n, \
33 		.type = REGULATOR_VOLTAGE, 	\
34 		.owner = THIS_MODULE, 		\
35 	}
36 
37 static const u8 pcf50633_regulator_registers[PCF50633_NUM_REGULATORS] = {
38 	[PCF50633_REGULATOR_AUTO]	= PCF50633_REG_AUTOOUT,
39 	[PCF50633_REGULATOR_DOWN1]	= PCF50633_REG_DOWN1OUT,
40 	[PCF50633_REGULATOR_DOWN2]	= PCF50633_REG_DOWN2OUT,
41 	[PCF50633_REGULATOR_MEMLDO]	= PCF50633_REG_MEMLDOOUT,
42 	[PCF50633_REGULATOR_LDO1]	= PCF50633_REG_LDO1OUT,
43 	[PCF50633_REGULATOR_LDO2]	= PCF50633_REG_LDO2OUT,
44 	[PCF50633_REGULATOR_LDO3]	= PCF50633_REG_LDO3OUT,
45 	[PCF50633_REGULATOR_LDO4]	= PCF50633_REG_LDO4OUT,
46 	[PCF50633_REGULATOR_LDO5]	= PCF50633_REG_LDO5OUT,
47 	[PCF50633_REGULATOR_LDO6]	= PCF50633_REG_LDO6OUT,
48 	[PCF50633_REGULATOR_HCLDO]	= PCF50633_REG_HCLDOOUT,
49 };
50 
51 /* Bits from voltage value */
52 static u8 auto_voltage_bits(unsigned int millivolts)
53 {
54 	if (millivolts < 1800)
55 		return 0;
56 	if (millivolts > 3800)
57 		return 0xff;
58 
59 	millivolts -= 625;
60 
61 	return millivolts / 25;
62 }
63 
64 static u8 down_voltage_bits(unsigned int millivolts)
65 {
66 	if (millivolts < 625)
67 		return 0;
68 	else if (millivolts > 3000)
69 		return 0xff;
70 
71 	millivolts -= 625;
72 
73 	return millivolts / 25;
74 }
75 
76 static u8 ldo_voltage_bits(unsigned int millivolts)
77 {
78 	if (millivolts < 900)
79 		return 0;
80 	else if (millivolts > 3600)
81 		return 0x1f;
82 
83 	millivolts -= 900;
84 	return millivolts / 100;
85 }
86 
87 /* Obtain voltage value from bits */
88 static unsigned int auto_voltage_value(u8 bits)
89 {
90 	if (bits < 0x2f)
91 		return 0;
92 
93 	return 625 + (bits * 25);
94 }
95 
96 
97 static unsigned int down_voltage_value(u8 bits)
98 {
99 	return 625 + (bits * 25);
100 }
101 
102 
103 static unsigned int ldo_voltage_value(u8 bits)
104 {
105 	bits &= 0x1f;
106 
107 	return 900 + (bits * 100);
108 }
109 
110 static int pcf50633_regulator_set_voltage(struct regulator_dev *rdev,
111 						int min_uV, int max_uV)
112 {
113 	struct pcf50633 *pcf;
114 	int regulator_id, millivolts;
115 	u8 volt_bits, regnr;
116 
117 	pcf = rdev_get_drvdata(rdev);
118 
119 	regulator_id = rdev_get_id(rdev);
120 	if (regulator_id >= PCF50633_NUM_REGULATORS)
121 		return -EINVAL;
122 
123 	millivolts = min_uV / 1000;
124 
125 	regnr = pcf50633_regulator_registers[regulator_id];
126 
127 	switch (regulator_id) {
128 	case PCF50633_REGULATOR_AUTO:
129 		volt_bits = auto_voltage_bits(millivolts);
130 		break;
131 	case PCF50633_REGULATOR_DOWN1:
132 		volt_bits = down_voltage_bits(millivolts);
133 		break;
134 	case PCF50633_REGULATOR_DOWN2:
135 		volt_bits = down_voltage_bits(millivolts);
136 		break;
137 	case PCF50633_REGULATOR_LDO1:
138 	case PCF50633_REGULATOR_LDO2:
139 	case PCF50633_REGULATOR_LDO3:
140 	case PCF50633_REGULATOR_LDO4:
141 	case PCF50633_REGULATOR_LDO5:
142 	case PCF50633_REGULATOR_LDO6:
143 	case PCF50633_REGULATOR_HCLDO:
144 		volt_bits = ldo_voltage_bits(millivolts);
145 		break;
146 	default:
147 		return -EINVAL;
148 	}
149 
150 	return pcf50633_reg_write(pcf, regnr, volt_bits);
151 }
152 
153 static int pcf50633_regulator_voltage_value(enum pcf50633_regulator_id id,
154 						u8 bits)
155 {
156 	int millivolts;
157 
158 	switch (id) {
159 	case PCF50633_REGULATOR_AUTO:
160 		millivolts = auto_voltage_value(bits);
161 		break;
162 	case PCF50633_REGULATOR_DOWN1:
163 		millivolts = down_voltage_value(bits);
164 		break;
165 	case PCF50633_REGULATOR_DOWN2:
166 		millivolts = down_voltage_value(bits);
167 		break;
168 	case PCF50633_REGULATOR_LDO1:
169 	case PCF50633_REGULATOR_LDO2:
170 	case PCF50633_REGULATOR_LDO3:
171 	case PCF50633_REGULATOR_LDO4:
172 	case PCF50633_REGULATOR_LDO5:
173 	case PCF50633_REGULATOR_LDO6:
174 	case PCF50633_REGULATOR_HCLDO:
175 		millivolts = ldo_voltage_value(bits);
176 		break;
177 	default:
178 		return -EINVAL;
179 	}
180 
181 	return millivolts * 1000;
182 }
183 
184 static int pcf50633_regulator_get_voltage(struct regulator_dev *rdev)
185 {
186 	struct pcf50633 *pcf;
187 	int regulator_id;
188 	u8 volt_bits, regnr;
189 
190 	pcf = rdev_get_drvdata(rdev);
191 
192 	regulator_id = rdev_get_id(rdev);
193 	if (regulator_id >= PCF50633_NUM_REGULATORS)
194 		return -EINVAL;
195 
196 	regnr = pcf50633_regulator_registers[regulator_id];
197 
198 	volt_bits = pcf50633_reg_read(pcf, regnr);
199 
200 	return pcf50633_regulator_voltage_value(regulator_id, volt_bits);
201 }
202 
203 static int pcf50633_regulator_list_voltage(struct regulator_dev *rdev,
204 						unsigned int index)
205 {
206 	struct pcf50633 *pcf;
207 	int regulator_id;
208 
209 	pcf = rdev_get_drvdata(rdev);
210 
211 	regulator_id = rdev_get_id(rdev);
212 
213 	switch (regulator_id) {
214 	case PCF50633_REGULATOR_AUTO:
215 		index += 0x2f;
216 		break;
217 	case PCF50633_REGULATOR_HCLDO:
218 		index += 0x01;
219 		break;
220 	default:
221 		break;
222 	}
223 
224 	return pcf50633_regulator_voltage_value(regulator_id, index);
225 }
226 
227 static int pcf50633_regulator_enable(struct regulator_dev *rdev)
228 {
229 	struct pcf50633 *pcf = rdev_get_drvdata(rdev);
230 	int regulator_id;
231 	u8 regnr;
232 
233 	regulator_id = rdev_get_id(rdev);
234 	if (regulator_id >= PCF50633_NUM_REGULATORS)
235 		return -EINVAL;
236 
237 	/* The *ENA register is always one after the *OUT register */
238 	regnr = pcf50633_regulator_registers[regulator_id] + 1;
239 
240 	return pcf50633_reg_set_bit_mask(pcf, regnr, PCF50633_REGULATOR_ON,
241 						       PCF50633_REGULATOR_ON);
242 }
243 
244 static int pcf50633_regulator_disable(struct regulator_dev *rdev)
245 {
246 	struct pcf50633 *pcf = rdev_get_drvdata(rdev);
247 	int regulator_id;
248 	u8 regnr;
249 
250 	regulator_id = rdev_get_id(rdev);
251 	if (regulator_id >= PCF50633_NUM_REGULATORS)
252 		return -EINVAL;
253 
254 	/* the *ENA register is always one after the *OUT register */
255 	regnr = pcf50633_regulator_registers[regulator_id] + 1;
256 
257 	return pcf50633_reg_set_bit_mask(pcf, regnr,
258 					PCF50633_REGULATOR_ON, 0);
259 }
260 
261 static int pcf50633_regulator_is_enabled(struct regulator_dev *rdev)
262 {
263 	struct pcf50633 *pcf = rdev_get_drvdata(rdev);
264 	int regulator_id = rdev_get_id(rdev);
265 	u8 regnr;
266 
267 	regulator_id = rdev_get_id(rdev);
268 	if (regulator_id >= PCF50633_NUM_REGULATORS)
269 		return -EINVAL;
270 
271 	/* the *ENA register is always one after the *OUT register */
272 	regnr = pcf50633_regulator_registers[regulator_id] + 1;
273 
274 	return pcf50633_reg_read(pcf, regnr) & PCF50633_REGULATOR_ON;
275 }
276 
277 static struct regulator_ops pcf50633_regulator_ops = {
278 	.set_voltage = pcf50633_regulator_set_voltage,
279 	.get_voltage = pcf50633_regulator_get_voltage,
280 	.list_voltage = pcf50633_regulator_list_voltage,
281 	.enable = pcf50633_regulator_enable,
282 	.disable = pcf50633_regulator_disable,
283 	.is_enabled = pcf50633_regulator_is_enabled,
284 };
285 
286 static struct regulator_desc regulators[] = {
287 	[PCF50633_REGULATOR_AUTO] =
288 		PCF50633_REGULATOR("auto", PCF50633_REGULATOR_AUTO, 80),
289 	[PCF50633_REGULATOR_DOWN1] =
290 		PCF50633_REGULATOR("down1", PCF50633_REGULATOR_DOWN1, 95),
291 	[PCF50633_REGULATOR_DOWN2] =
292 		PCF50633_REGULATOR("down2", PCF50633_REGULATOR_DOWN2, 95),
293 	[PCF50633_REGULATOR_LDO1] =
294 		PCF50633_REGULATOR("ldo1", PCF50633_REGULATOR_LDO1, 27),
295 	[PCF50633_REGULATOR_LDO2] =
296 		PCF50633_REGULATOR("ldo2", PCF50633_REGULATOR_LDO2, 27),
297 	[PCF50633_REGULATOR_LDO3] =
298 		PCF50633_REGULATOR("ldo3", PCF50633_REGULATOR_LDO3, 27),
299 	[PCF50633_REGULATOR_LDO4] =
300 		PCF50633_REGULATOR("ldo4", PCF50633_REGULATOR_LDO4, 27),
301 	[PCF50633_REGULATOR_LDO5] =
302 		PCF50633_REGULATOR("ldo5", PCF50633_REGULATOR_LDO5, 27),
303 	[PCF50633_REGULATOR_LDO6] =
304 		PCF50633_REGULATOR("ldo6", PCF50633_REGULATOR_LDO6, 27),
305 	[PCF50633_REGULATOR_HCLDO] =
306 		PCF50633_REGULATOR("hcldo", PCF50633_REGULATOR_HCLDO, 26),
307 	[PCF50633_REGULATOR_MEMLDO] =
308 		PCF50633_REGULATOR("memldo", PCF50633_REGULATOR_MEMLDO, 0),
309 };
310 
311 static int __devinit pcf50633_regulator_probe(struct platform_device *pdev)
312 {
313 	struct regulator_dev *rdev;
314 	struct pcf50633 *pcf;
315 
316 	/* Already set by core driver */
317 	pcf = dev_to_pcf50633(pdev->dev.parent);
318 
319 	rdev = regulator_register(&regulators[pdev->id], &pdev->dev,
320 				  pdev->dev.platform_data, pcf);
321 	if (IS_ERR(rdev))
322 		return PTR_ERR(rdev);
323 
324 	platform_set_drvdata(pdev, rdev);
325 
326 	if (pcf->pdata->regulator_registered)
327 		pcf->pdata->regulator_registered(pcf, pdev->id);
328 
329 	return 0;
330 }
331 
332 static int __devexit pcf50633_regulator_remove(struct platform_device *pdev)
333 {
334 	struct regulator_dev *rdev = platform_get_drvdata(pdev);
335 
336 	platform_set_drvdata(pdev, NULL);
337 	regulator_unregister(rdev);
338 
339 	return 0;
340 }
341 
342 static struct platform_driver pcf50633_regulator_driver = {
343 	.driver = {
344 		.name = "pcf50633-regltr",
345 	},
346 	.probe = pcf50633_regulator_probe,
347 	.remove = __devexit_p(pcf50633_regulator_remove),
348 };
349 
350 static int __init pcf50633_regulator_init(void)
351 {
352 	return platform_driver_register(&pcf50633_regulator_driver);
353 }
354 subsys_initcall(pcf50633_regulator_init);
355 
356 static void __exit pcf50633_regulator_exit(void)
357 {
358 	platform_driver_unregister(&pcf50633_regulator_driver);
359 }
360 module_exit(pcf50633_regulator_exit);
361 
362 MODULE_AUTHOR("Balaji Rao <balajirrao@openmoko.org>");
363 MODULE_DESCRIPTION("PCF50633 regulator driver");
364 MODULE_LICENSE("GPL");
365 MODULE_ALIAS("platform:pcf50633-regulator");
366