xref: /linux/drivers/regulator/rc5t583-regulator.c (revision 95e301ba83612e616bea0151868b7160111227f3)
1 /*
2  * Regulator driver for RICOH RC5T583 power management chip.
3  *
4  * Copyright (c) 2011-2012, NVIDIA CORPORATION.  All rights reserved.
5  * Author: Laxman dewangan <ldewangan@nvidia.com>
6  *
7  * based on code
8  *      Copyright (C) 2011 RICOH COMPANY,LTD
9  *
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms and conditions of the GNU General Public License,
13  * version 2, as published by the Free Software Foundation.
14  *
15  * This program is distributed in the hope it will be useful, but WITHOUT
16  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
18  * more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
22  *
23  */
24 
25 #include <linux/module.h>
26 #include <linux/delay.h>
27 #include <linux/init.h>
28 #include <linux/slab.h>
29 #include <linux/err.h>
30 #include <linux/platform_device.h>
31 #include <linux/regulator/driver.h>
32 #include <linux/regulator/machine.h>
33 #include <linux/gpio.h>
34 #include <linux/mfd/rc5t583.h>
35 
36 struct rc5t583_regulator_info {
37 	int			deepsleep_id;
38 
39 	/* Regulator register address.*/
40 	uint8_t			reg_en_reg;
41 	uint8_t			en_bit;
42 	uint8_t			reg_disc_reg;
43 	uint8_t			disc_bit;
44 	uint8_t			vout_reg;
45 	uint8_t			vout_mask;
46 	uint8_t			deepsleep_reg;
47 
48 	/* Chip constraints on regulator behavior */
49 	int			min_uV;
50 	int			max_uV;
51 	int			step_uV;
52 
53 	/* Regulator specific turn-on delay  and voltage settling time*/
54 	int			enable_uv_per_us;
55 	int			change_uv_per_us;
56 
57 	/* Used by regulator core */
58 	struct regulator_desc	desc;
59 };
60 
61 struct rc5t583_regulator {
62 	struct rc5t583_regulator_info *reg_info;
63 
64 	/* Devices */
65 	struct device		*dev;
66 	struct rc5t583		*mfd;
67 	struct regulator_dev	*rdev;
68 };
69 
70 static int rc5t583_reg_is_enabled(struct regulator_dev *rdev)
71 {
72 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
73 	struct rc5t583_regulator_info *ri = reg->reg_info;
74 	uint8_t control;
75 	int ret;
76 
77 	ret = rc5t583_read(reg->mfd->dev, ri->reg_en_reg, &control);
78 	if (ret < 0) {
79 		dev_err(&rdev->dev,
80 			"Error in reading the control register 0x%02x\n",
81 			ri->reg_en_reg);
82 		return ret;
83 	}
84 	return !!(control & BIT(ri->en_bit));
85 }
86 
87 static int rc5t583_reg_enable(struct regulator_dev *rdev)
88 {
89 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
90 	struct rc5t583_regulator_info *ri = reg->reg_info;
91 	int ret;
92 
93 	ret = rc5t583_set_bits(reg->mfd->dev, ri->reg_en_reg,
94 				(1 << ri->en_bit));
95 	if (ret < 0) {
96 		dev_err(&rdev->dev,
97 			"Error in setting bit of STATE register 0x%02x\n",
98 			ri->reg_en_reg);
99 		return ret;
100 	}
101 	return ret;
102 }
103 
104 static int rc5t583_reg_disable(struct regulator_dev *rdev)
105 {
106 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
107 	struct rc5t583_regulator_info *ri = reg->reg_info;
108 	int ret;
109 
110 	ret = rc5t583_clear_bits(reg->mfd->dev, ri->reg_en_reg,
111 				(1 << ri->en_bit));
112 	if (ret < 0)
113 		dev_err(&rdev->dev,
114 			"Error in clearing bit of STATE register 0x%02x\n",
115 			ri->reg_en_reg);
116 
117 	return ret;
118 }
119 
120 static int rc5t583_list_voltage(struct regulator_dev *rdev, unsigned selector)
121 {
122 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
123 	struct rc5t583_regulator_info *ri = reg->reg_info;
124 	return ri->min_uV + (ri->step_uV * selector);
125 }
126 
127 static int rc5t583_set_voltage_sel(struct regulator_dev *rdev,
128 		unsigned int selector)
129 {
130 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
131 	struct rc5t583_regulator_info *ri = reg->reg_info;
132 	int ret;
133 	if (selector >= rdev->desc->n_voltages) {
134 		dev_err(&rdev->dev, "Invalid selector 0x%02x\n", selector);
135 		return -EINVAL;
136 	}
137 
138 	ret = rc5t583_update(reg->mfd->dev, ri->vout_reg,
139 				selector, ri->vout_mask);
140 	if (ret < 0)
141 		dev_err(&rdev->dev,
142 		    "Error in update voltage register 0x%02x\n", ri->vout_reg);
143 	return ret;
144 }
145 
146 static int rc5t583_get_voltage_sel(struct regulator_dev *rdev)
147 {
148 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
149 	struct rc5t583_regulator_info *ri = reg->reg_info;
150 	uint8_t vsel;
151 	int ret;
152 	ret = rc5t583_read(reg->mfd->dev, ri->vout_reg, &vsel);
153 	if (ret < 0) {
154 		dev_err(&rdev->dev,
155 		    "Error in reading voltage register 0x%02x\n", ri->vout_reg);
156 		return ret;
157 	}
158 	return vsel & ri->vout_mask;
159 }
160 
161 static int rc5t583_regulator_enable_time(struct regulator_dev *rdev)
162 {
163 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
164 	int vsel = rc5t583_get_voltage_sel(rdev);
165 	int curr_uV = rc5t583_list_voltage(rdev, vsel);
166 	return DIV_ROUND_UP(curr_uV, reg->reg_info->enable_uv_per_us);
167 }
168 
169 static int rc5t583_set_voltage_time_sel(struct regulator_dev *rdev,
170 		unsigned int old_selector, unsigned int new_selector)
171 {
172 	struct rc5t583_regulator *reg = rdev_get_drvdata(rdev);
173 	int old_uV, new_uV;
174 	old_uV = rc5t583_list_voltage(rdev, old_selector);
175 
176 	if (old_uV < 0)
177 		return old_uV;
178 
179 	new_uV = rc5t583_list_voltage(rdev, new_selector);
180 	if (new_uV < 0)
181 		return new_uV;
182 
183 	return DIV_ROUND_UP(abs(old_uV - new_uV),
184 				reg->reg_info->change_uv_per_us);
185 }
186 
187 
188 static struct regulator_ops rc5t583_ops = {
189 	.is_enabled		= rc5t583_reg_is_enabled,
190 	.enable			= rc5t583_reg_enable,
191 	.disable		= rc5t583_reg_disable,
192 	.enable_time		= rc5t583_regulator_enable_time,
193 	.get_voltage_sel	= rc5t583_get_voltage_sel,
194 	.set_voltage_sel	= rc5t583_set_voltage_sel,
195 	.list_voltage		= rc5t583_list_voltage,
196 	.set_voltage_time_sel	= rc5t583_set_voltage_time_sel,
197 };
198 
199 #define RC5T583_REG(_id, _en_reg, _en_bit, _disc_reg, _disc_bit, \
200 		_vout_mask, _min_mv, _max_mv, _step_uV, _enable_mv) \
201 {								\
202 	.reg_en_reg	= RC5T583_REG_##_en_reg,		\
203 	.en_bit		= _en_bit,				\
204 	.reg_disc_reg	= RC5T583_REG_##_disc_reg,		\
205 	.disc_bit	= _disc_bit,				\
206 	.vout_reg	= RC5T583_REG_##_id##DAC,		\
207 	.vout_mask	= _vout_mask,				\
208 	.deepsleep_reg	= RC5T583_REG_##_id##DAC_DS,		\
209 	.min_uV		= _min_mv * 1000,			\
210 	.max_uV		= _max_mv * 1000,			\
211 	.step_uV	= _step_uV,				\
212 	.enable_uv_per_us = _enable_mv * 1000,			\
213 	.change_uv_per_us = 40 * 1000,				\
214 	.deepsleep_id	= RC5T583_DS_##_id,			\
215 	.desc = {						\
216 		.name = "rc5t583-regulator-"#_id,		\
217 		.id = RC5T583_REGULATOR_##_id,			\
218 		.n_voltages = (_max_mv - _min_mv) * 1000 / _step_uV + 1, \
219 		.ops = &rc5t583_ops,				\
220 		.type = REGULATOR_VOLTAGE,			\
221 		.owner = THIS_MODULE,				\
222 	},							\
223 }
224 
225 static struct rc5t583_regulator_info rc5t583_reg_info[RC5T583_REGULATOR_MAX] = {
226 	RC5T583_REG(DC0, DC0CTL, 0, DC0CTL, 1, 0x7F, 700, 1500, 12500, 4),
227 	RC5T583_REG(DC1, DC1CTL, 0, DC1CTL, 1, 0x7F, 700, 1500, 12500, 14),
228 	RC5T583_REG(DC2, DC2CTL, 0, DC2CTL, 1, 0x7F, 900, 2400, 12500, 14),
229 	RC5T583_REG(DC3, DC3CTL, 0, DC3CTL, 1, 0x7F, 900, 2400, 12500, 14),
230 	RC5T583_REG(LDO0, LDOEN2, 0, LDODIS2, 0, 0x7F, 900, 3400, 25000, 160),
231 	RC5T583_REG(LDO1, LDOEN2, 1, LDODIS2, 1, 0x7F, 900, 3400, 25000, 160),
232 	RC5T583_REG(LDO2, LDOEN2, 2, LDODIS2, 2, 0x7F, 900, 3400, 25000, 160),
233 	RC5T583_REG(LDO3, LDOEN2, 3, LDODIS2, 3, 0x7F, 900, 3400, 25000, 160),
234 	RC5T583_REG(LDO4, LDOEN2, 4, LDODIS2, 4, 0x3F, 750, 1500, 12500, 133),
235 	RC5T583_REG(LDO5, LDOEN2, 5, LDODIS2, 5, 0x7F, 900, 3400, 25000, 267),
236 	RC5T583_REG(LDO6, LDOEN2, 6, LDODIS2, 6, 0x7F, 900, 3400, 25000, 133),
237 	RC5T583_REG(LDO7, LDOEN2, 7, LDODIS2, 7, 0x7F, 900, 3400, 25000, 233),
238 	RC5T583_REG(LDO8, LDOEN1, 0, LDODIS1, 0, 0x7F, 900, 3400, 25000, 233),
239 	RC5T583_REG(LDO9, LDOEN1, 1, LDODIS1, 1, 0x7F, 900, 3400, 25000, 133),
240 };
241 
242 static int __devinit rc5t583_regulator_probe(struct platform_device *pdev)
243 {
244 	struct rc5t583 *rc5t583 = dev_get_drvdata(pdev->dev.parent);
245 	struct rc5t583_platform_data *pdata = dev_get_platdata(rc5t583->dev);
246 	struct regulator_init_data *reg_data;
247 	struct rc5t583_regulator *reg = NULL;
248 	struct rc5t583_regulator *regs;
249 	struct regulator_dev *rdev;
250 	struct rc5t583_regulator_info *ri;
251 	int ret;
252 	int id;
253 
254 	if (!pdata) {
255 		dev_err(&pdev->dev, "No platform data, exiting...\n");
256 		return -ENODEV;
257 	}
258 
259 	regs = devm_kzalloc(&pdev->dev, RC5T583_REGULATOR_MAX *
260 			sizeof(struct rc5t583_regulator), GFP_KERNEL);
261 	if (!regs) {
262 		dev_err(&pdev->dev, "Memory allocation failed exiting..\n");
263 		return -ENOMEM;
264 	}
265 
266 
267 	for (id = 0; id < RC5T583_REGULATOR_MAX; ++id) {
268 		reg_data = pdata->reg_init_data[id];
269 
270 		/* No need to register if there is no regulator data */
271 		if (!reg_data)
272 			continue;
273 
274 		reg = &regs[id];
275 		ri = &rc5t583_reg_info[id];
276 		reg->reg_info = ri;
277 		reg->mfd = rc5t583;
278 		reg->dev = &pdev->dev;
279 
280 		if (ri->deepsleep_id == RC5T583_DS_NONE)
281 			goto skip_ext_pwr_config;
282 
283 		ret = rc5t583_ext_power_req_config(rc5t583->dev,
284 				ri->deepsleep_id,
285 				pdata->regulator_ext_pwr_control[id],
286 				pdata->regulator_deepsleep_slot[id]);
287 		/*
288 		 * Configuring external control is not a major issue,
289 		 * just give warning.
290 		 */
291 		if (ret < 0)
292 			dev_warn(&pdev->dev,
293 				"Failed to configure ext control %d\n", id);
294 
295 skip_ext_pwr_config:
296 		rdev = regulator_register(&ri->desc, &pdev->dev,
297 					reg_data, reg, NULL);
298 		if (IS_ERR(rdev)) {
299 			dev_err(&pdev->dev, "Failed to register regulator %s\n",
300 						ri->desc.name);
301 			ret = PTR_ERR(rdev);
302 			goto clean_exit;
303 		}
304 		reg->rdev = rdev;
305 	}
306 	platform_set_drvdata(pdev, regs);
307 	return 0;
308 
309 clean_exit:
310 	while (--id >= 0)
311 		regulator_unregister(regs[id].rdev);
312 
313 	return ret;
314 }
315 
316 static int __devexit rc5t583_regulator_remove(struct platform_device *pdev)
317 {
318 	struct rc5t583_regulator *regs = platform_get_drvdata(pdev);
319 	int id;
320 
321 	for (id = 0; id < RC5T583_REGULATOR_MAX; ++id)
322 		regulator_unregister(regs[id].rdev);
323 	return 0;
324 }
325 
326 static struct platform_driver rc5t583_regulator_driver = {
327 	.driver	= {
328 		.name	= "rc5t583-regulator",
329 		.owner	= THIS_MODULE,
330 	},
331 	.probe		= rc5t583_regulator_probe,
332 	.remove		= __devexit_p(rc5t583_regulator_remove),
333 };
334 
335 static int __init rc5t583_regulator_init(void)
336 {
337 	return platform_driver_register(&rc5t583_regulator_driver);
338 }
339 subsys_initcall(rc5t583_regulator_init);
340 
341 static void __exit rc5t583_regulator_exit(void)
342 {
343 	platform_driver_unregister(&rc5t583_regulator_driver);
344 }
345 module_exit(rc5t583_regulator_exit);
346 
347 MODULE_AUTHOR("Laxman Dewangan <ldewangan@nvidia.com>");
348 MODULE_DESCRIPTION("RC5T583 regulator driver");
349 MODULE_ALIAS("platform:rc5t583-regulator");
350 MODULE_LICENSE("GPL V2");
351