1 /*
2  * tps65217-regulator.c
3  *
4  * Regulator driver for TPS65217 PMIC
5  *
6  * Copyright (C) 2011 Texas Instruments Incorporated - http://www.ti.com/
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation version 2.
11  *
12  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
13  * kind, whether express or implied; without even the implied warranty
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  */
17 
18 #include <linux/kernel.h>
19 #include <linux/module.h>
20 #include <linux/device.h>
21 #include <linux/init.h>
22 #include <linux/err.h>
23 #include <linux/platform_device.h>
24 
25 #include <linux/regulator/of_regulator.h>
26 #include <linux/regulator/driver.h>
27 #include <linux/regulator/machine.h>
28 #include <linux/mfd/tps65217.h>
29 
30 #define TPS65217_REGULATOR(_name, _id, _ops, _n, _vr, _vm, _em, _t, _lr, _nlr) \
31 	{						\
32 		.name		= _name,		\
33 		.id		= _id,			\
34 		.ops		= &_ops,		\
35 		.n_voltages	= _n,			\
36 		.type		= REGULATOR_VOLTAGE,	\
37 		.owner		= THIS_MODULE,		\
38 		.vsel_reg	= _vr,			\
39 		.vsel_mask	= _vm,			\
40 		.enable_reg	= TPS65217_REG_ENABLE,	\
41 		.enable_mask	= _em,			\
42 		.volt_table	= _t,			\
43 		.linear_ranges	= _lr,			\
44 		.n_linear_ranges = _nlr,		\
45 	}						\
46 
47 static const unsigned int LDO1_VSEL_table[] = {
48 	1000000, 1100000, 1200000, 1250000,
49 	1300000, 1350000, 1400000, 1500000,
50 	1600000, 1800000, 2500000, 2750000,
51 	2800000, 3000000, 3100000, 3300000,
52 };
53 
54 static const struct regulator_linear_range tps65217_uv1_ranges[] = {
55 	{ .min_uV = 900000, .max_uV = 1500000, .min_sel =  0, .max_sel = 24,
56 	  .uV_step = 25000 },
57 	{ .min_uV = 1550000, .max_uV = 1800000, .min_sel = 25, .max_sel = 30,
58 	  .uV_step = 50000 },
59 	{ .min_uV = 1850000, .max_uV = 2900000, .min_sel = 31, .max_sel = 52,
60 	  .uV_step = 50000 },
61 	{ .min_uV = 3000000, .max_uV = 3200000, .min_sel = 53, .max_sel = 55,
62 	  .uV_step = 100000 },
63 	{ .min_uV = 3300000, .max_uV = 3300000, .min_sel = 56, .max_sel = 62,
64 	  .uV_step = 0 },
65 };
66 
67 static const struct regulator_linear_range tps65217_uv2_ranges[] = {
68 	{ .min_uV = 1500000, .max_uV = 1900000, .min_sel =  0, .max_sel = 8,
69 	  .uV_step = 50000 },
70 	{ .min_uV = 2000000, .max_uV = 2400000, .min_sel = 9, .max_sel = 13,
71 	  .uV_step = 100000 },
72 	{ .min_uV = 2450000, .max_uV = 3300000, .min_sel = 14, .max_sel = 31,
73 	  .uV_step = 50000 },
74 };
75 
76 static int tps65217_pmic_enable(struct regulator_dev *dev)
77 {
78 	struct tps65217 *tps = rdev_get_drvdata(dev);
79 	unsigned int rid = rdev_get_id(dev);
80 
81 	if (rid < TPS65217_DCDC_1 || rid > TPS65217_LDO_4)
82 		return -EINVAL;
83 
84 	/* Enable the regulator and password protection is level 1 */
85 	return tps65217_set_bits(tps, TPS65217_REG_ENABLE,
86 				 dev->desc->enable_mask, dev->desc->enable_mask,
87 				 TPS65217_PROTECT_L1);
88 }
89 
90 static int tps65217_pmic_disable(struct regulator_dev *dev)
91 {
92 	struct tps65217 *tps = rdev_get_drvdata(dev);
93 	unsigned int rid = rdev_get_id(dev);
94 
95 	if (rid < TPS65217_DCDC_1 || rid > TPS65217_LDO_4)
96 		return -EINVAL;
97 
98 	/* Disable the regulator and password protection is level 1 */
99 	return tps65217_clear_bits(tps, TPS65217_REG_ENABLE,
100 				   dev->desc->enable_mask, TPS65217_PROTECT_L1);
101 }
102 
103 static int tps65217_pmic_set_voltage_sel(struct regulator_dev *dev,
104 					 unsigned selector)
105 {
106 	int ret;
107 	struct tps65217 *tps = rdev_get_drvdata(dev);
108 	unsigned int rid = rdev_get_id(dev);
109 
110 	/* Set the voltage based on vsel value and write protect level is 2 */
111 	ret = tps65217_set_bits(tps, dev->desc->vsel_reg, dev->desc->vsel_mask,
112 				selector, TPS65217_PROTECT_L2);
113 
114 	/* Set GO bit for DCDCx to initiate voltage transistion */
115 	switch (rid) {
116 	case TPS65217_DCDC_1 ... TPS65217_DCDC_3:
117 		ret = tps65217_set_bits(tps, TPS65217_REG_DEFSLEW,
118 				       TPS65217_DEFSLEW_GO, TPS65217_DEFSLEW_GO,
119 				       TPS65217_PROTECT_L2);
120 		break;
121 	}
122 
123 	return ret;
124 }
125 
126 /* Operations permitted on DCDCx, LDO2, LDO3 and LDO4 */
127 static struct regulator_ops tps65217_pmic_ops = {
128 	.is_enabled		= regulator_is_enabled_regmap,
129 	.enable			= tps65217_pmic_enable,
130 	.disable		= tps65217_pmic_disable,
131 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
132 	.set_voltage_sel	= tps65217_pmic_set_voltage_sel,
133 	.list_voltage		= regulator_list_voltage_linear_range,
134 	.map_voltage		= regulator_map_voltage_linear_range,
135 };
136 
137 /* Operations permitted on LDO1 */
138 static struct regulator_ops tps65217_pmic_ldo1_ops = {
139 	.is_enabled		= regulator_is_enabled_regmap,
140 	.enable			= tps65217_pmic_enable,
141 	.disable		= tps65217_pmic_disable,
142 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
143 	.set_voltage_sel	= tps65217_pmic_set_voltage_sel,
144 	.list_voltage		= regulator_list_voltage_table,
145 };
146 
147 static const struct regulator_desc regulators[] = {
148 	TPS65217_REGULATOR("DCDC1", TPS65217_DCDC_1, tps65217_pmic_ops, 64,
149 			   TPS65217_REG_DEFDCDC1, TPS65217_DEFDCDCX_DCDC_MASK,
150 			   TPS65217_ENABLE_DC1_EN, NULL, tps65217_uv1_ranges,
151 			   2),	/* DCDC1 voltage range: 900000 ~ 1800000 */
152 	TPS65217_REGULATOR("DCDC2", TPS65217_DCDC_2, tps65217_pmic_ops, 64,
153 			   TPS65217_REG_DEFDCDC2, TPS65217_DEFDCDCX_DCDC_MASK,
154 			   TPS65217_ENABLE_DC2_EN, NULL, tps65217_uv1_ranges,
155 			   ARRAY_SIZE(tps65217_uv1_ranges)),
156 	TPS65217_REGULATOR("DCDC3", TPS65217_DCDC_3, tps65217_pmic_ops, 64,
157 			   TPS65217_REG_DEFDCDC3, TPS65217_DEFDCDCX_DCDC_MASK,
158 			   TPS65217_ENABLE_DC3_EN, NULL, tps65217_uv1_ranges,
159 			   1),	/* DCDC3 voltage range: 900000 ~ 1500000 */
160 	TPS65217_REGULATOR("LDO1", TPS65217_LDO_1, tps65217_pmic_ldo1_ops, 16,
161 			   TPS65217_REG_DEFLDO1, TPS65217_DEFLDO1_LDO1_MASK,
162 			   TPS65217_ENABLE_LDO1_EN, LDO1_VSEL_table, NULL, 0),
163 	TPS65217_REGULATOR("LDO2", TPS65217_LDO_2, tps65217_pmic_ops, 64,
164 			   TPS65217_REG_DEFLDO2, TPS65217_DEFLDO2_LDO2_MASK,
165 			   TPS65217_ENABLE_LDO2_EN, NULL, tps65217_uv1_ranges,
166 			   ARRAY_SIZE(tps65217_uv1_ranges)),
167 	TPS65217_REGULATOR("LDO3", TPS65217_LDO_3, tps65217_pmic_ops, 32,
168 			   TPS65217_REG_DEFLS1, TPS65217_DEFLDO3_LDO3_MASK,
169 			   TPS65217_ENABLE_LS1_EN | TPS65217_DEFLDO3_LDO3_EN,
170 			   NULL, tps65217_uv2_ranges,
171 			   ARRAY_SIZE(tps65217_uv2_ranges)),
172 	TPS65217_REGULATOR("LDO4", TPS65217_LDO_4, tps65217_pmic_ops, 32,
173 			   TPS65217_REG_DEFLS2, TPS65217_DEFLDO4_LDO4_MASK,
174 			   TPS65217_ENABLE_LS2_EN | TPS65217_DEFLDO4_LDO4_EN,
175 			   NULL, tps65217_uv2_ranges,
176 			   ARRAY_SIZE(tps65217_uv2_ranges)),
177 };
178 
179 #ifdef CONFIG_OF
180 static struct of_regulator_match reg_matches[] = {
181 	{ .name = "dcdc1", .driver_data = (void *)TPS65217_DCDC_1 },
182 	{ .name = "dcdc2", .driver_data = (void *)TPS65217_DCDC_2 },
183 	{ .name = "dcdc3", .driver_data = (void *)TPS65217_DCDC_3 },
184 	{ .name = "ldo1", .driver_data = (void *)TPS65217_LDO_1 },
185 	{ .name = "ldo2", .driver_data = (void *)TPS65217_LDO_2 },
186 	{ .name = "ldo3", .driver_data = (void *)TPS65217_LDO_3 },
187 	{ .name = "ldo4", .driver_data = (void *)TPS65217_LDO_4 },
188 };
189 
190 static struct tps65217_board *tps65217_parse_dt(struct platform_device *pdev)
191 {
192 	struct tps65217 *tps = dev_get_drvdata(pdev->dev.parent);
193 	struct device_node *node = tps->dev->of_node;
194 	struct tps65217_board *pdata;
195 	struct device_node *regs;
196 	int i, count;
197 
198 	regs = of_find_node_by_name(node, "regulators");
199 	if (!regs)
200 		return NULL;
201 
202 	count = of_regulator_match(&pdev->dev, regs, reg_matches,
203 				   TPS65217_NUM_REGULATOR);
204 	of_node_put(regs);
205 	if ((count < 0) || (count > TPS65217_NUM_REGULATOR))
206 		return NULL;
207 
208 	pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
209 	if (!pdata)
210 		return NULL;
211 
212 	for (i = 0; i < count; i++) {
213 		if (!reg_matches[i].init_data || !reg_matches[i].of_node)
214 			continue;
215 
216 		pdata->tps65217_init_data[i] = reg_matches[i].init_data;
217 		pdata->of_node[i] = reg_matches[i].of_node;
218 	}
219 
220 	return pdata;
221 }
222 #else
223 static struct tps65217_board *tps65217_parse_dt(struct platform_device *pdev)
224 {
225 	return NULL;
226 }
227 #endif
228 
229 static int tps65217_regulator_probe(struct platform_device *pdev)
230 {
231 	struct tps65217 *tps = dev_get_drvdata(pdev->dev.parent);
232 	struct tps65217_board *pdata = dev_get_platdata(tps->dev);
233 	struct regulator_init_data *reg_data;
234 	struct regulator_dev *rdev;
235 	struct regulator_config config = { };
236 	int i, ret;
237 
238 	if (tps->dev->of_node)
239 		pdata = tps65217_parse_dt(pdev);
240 
241 	if (!pdata) {
242 		dev_err(&pdev->dev, "Platform data not found\n");
243 		return -EINVAL;
244 	}
245 
246 	if (tps65217_chip_id(tps) != TPS65217) {
247 		dev_err(&pdev->dev, "Invalid tps chip version\n");
248 		return -ENODEV;
249 	}
250 
251 	platform_set_drvdata(pdev, tps);
252 
253 	for (i = 0; i < TPS65217_NUM_REGULATOR; i++) {
254 
255 		reg_data = pdata->tps65217_init_data[i];
256 
257 		/*
258 		 * Regulator API handles empty constraints but not NULL
259 		 * constraints
260 		 */
261 		if (!reg_data)
262 			continue;
263 
264 		/* Register the regulators */
265 		config.dev = tps->dev;
266 		config.init_data = reg_data;
267 		config.driver_data = tps;
268 		config.regmap = tps->regmap;
269 		if (tps->dev->of_node)
270 			config.of_node = pdata->of_node[i];
271 
272 		rdev = regulator_register(&regulators[i], &config);
273 		if (IS_ERR(rdev)) {
274 			dev_err(tps->dev, "failed to register %s regulator\n",
275 				pdev->name);
276 			ret = PTR_ERR(rdev);
277 			goto err_unregister_regulator;
278 		}
279 
280 		/* Save regulator for cleanup */
281 		tps->rdev[i] = rdev;
282 	}
283 	return 0;
284 
285 err_unregister_regulator:
286 	while (--i >= 0)
287 		regulator_unregister(tps->rdev[i]);
288 
289 	return ret;
290 }
291 
292 static int tps65217_regulator_remove(struct platform_device *pdev)
293 {
294 	struct tps65217 *tps = platform_get_drvdata(pdev);
295 	unsigned int i;
296 
297 	for (i = 0; i < TPS65217_NUM_REGULATOR; i++)
298 		regulator_unregister(tps->rdev[i]);
299 
300 	return 0;
301 }
302 
303 static struct platform_driver tps65217_regulator_driver = {
304 	.driver = {
305 		.name = "tps65217-pmic",
306 	},
307 	.probe = tps65217_regulator_probe,
308 	.remove = tps65217_regulator_remove,
309 };
310 
311 static int __init tps65217_regulator_init(void)
312 {
313 	return platform_driver_register(&tps65217_regulator_driver);
314 }
315 subsys_initcall(tps65217_regulator_init);
316 
317 static void __exit tps65217_regulator_exit(void)
318 {
319 	platform_driver_unregister(&tps65217_regulator_driver);
320 }
321 module_exit(tps65217_regulator_exit);
322 
323 MODULE_AUTHOR("AnilKumar Ch <anilkumar@ti.com>");
324 MODULE_DESCRIPTION("TPS65217 voltage regulator driver");
325 MODULE_ALIAS("platform:tps65217-pmic");
326 MODULE_LICENSE("GPL v2");
327