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, _of_match, _ops, _n, _vr, _vm, _em, \
31 			   _t, _lr, _nlr,  _sr, _sm)	\
32 	{						\
33 		.name		= _name,		\
34 		.id		= _id,			\
35 		.of_match       = of_match_ptr(_of_match),    \
36 		.regulators_node= of_match_ptr("regulators"), \
37 		.ops		= &_ops,		\
38 		.n_voltages	= _n,			\
39 		.type		= REGULATOR_VOLTAGE,	\
40 		.owner		= THIS_MODULE,		\
41 		.vsel_reg	= _vr,			\
42 		.vsel_mask	= _vm,			\
43 		.enable_reg	= TPS65217_REG_ENABLE,	\
44 		.enable_mask	= _em,			\
45 		.volt_table	= _t,			\
46 		.linear_ranges	= _lr,			\
47 		.n_linear_ranges = _nlr,		\
48 		.bypass_reg	= _sr,			\
49 		.bypass_mask	= _sm,			\
50 	}						\
51 
52 static const unsigned int LDO1_VSEL_table[] = {
53 	1000000, 1100000, 1200000, 1250000,
54 	1300000, 1350000, 1400000, 1500000,
55 	1600000, 1800000, 2500000, 2750000,
56 	2800000, 3000000, 3100000, 3300000,
57 };
58 
59 static const struct regulator_linear_range tps65217_uv1_ranges[] = {
60 	REGULATOR_LINEAR_RANGE(900000, 0, 24, 25000),
61 	REGULATOR_LINEAR_RANGE(1550000, 25, 30, 50000),
62 	REGULATOR_LINEAR_RANGE(1850000, 31, 52, 50000),
63 	REGULATOR_LINEAR_RANGE(3000000, 53, 55, 100000),
64 	REGULATOR_LINEAR_RANGE(3300000, 56, 62, 0),
65 };
66 
67 static const struct regulator_linear_range tps65217_uv2_ranges[] = {
68 	REGULATOR_LINEAR_RANGE(1500000, 0, 8, 50000),
69 	REGULATOR_LINEAR_RANGE(2000000, 9, 13, 100000),
70 	REGULATOR_LINEAR_RANGE(2450000, 14, 31, 50000),
71 };
72 
73 static int tps65217_pmic_enable(struct regulator_dev *dev)
74 {
75 	struct tps65217 *tps = rdev_get_drvdata(dev);
76 	int rid = rdev_get_id(dev);
77 
78 	if (rid < TPS65217_DCDC_1 || rid > TPS65217_LDO_4)
79 		return -EINVAL;
80 
81 	/* Enable the regulator and password protection is level 1 */
82 	return tps65217_set_bits(tps, TPS65217_REG_ENABLE,
83 				 dev->desc->enable_mask, dev->desc->enable_mask,
84 				 TPS65217_PROTECT_L1);
85 }
86 
87 static int tps65217_pmic_disable(struct regulator_dev *dev)
88 {
89 	struct tps65217 *tps = rdev_get_drvdata(dev);
90 	int rid = rdev_get_id(dev);
91 
92 	if (rid < TPS65217_DCDC_1 || rid > TPS65217_LDO_4)
93 		return -EINVAL;
94 
95 	/* Disable the regulator and password protection is level 1 */
96 	return tps65217_clear_bits(tps, TPS65217_REG_ENABLE,
97 				   dev->desc->enable_mask, TPS65217_PROTECT_L1);
98 }
99 
100 static int tps65217_pmic_set_voltage_sel(struct regulator_dev *dev,
101 					 unsigned selector)
102 {
103 	int ret;
104 	struct tps65217 *tps = rdev_get_drvdata(dev);
105 	unsigned int rid = rdev_get_id(dev);
106 
107 	/* Set the voltage based on vsel value and write protect level is 2 */
108 	ret = tps65217_set_bits(tps, dev->desc->vsel_reg, dev->desc->vsel_mask,
109 				selector, TPS65217_PROTECT_L2);
110 
111 	/* Set GO bit for DCDCx to initiate voltage transistion */
112 	switch (rid) {
113 	case TPS65217_DCDC_1 ... TPS65217_DCDC_3:
114 		ret = tps65217_set_bits(tps, TPS65217_REG_DEFSLEW,
115 				       TPS65217_DEFSLEW_GO, TPS65217_DEFSLEW_GO,
116 				       TPS65217_PROTECT_L2);
117 		break;
118 	}
119 
120 	return ret;
121 }
122 
123 static int tps65217_pmic_set_suspend_enable(struct regulator_dev *dev)
124 {
125 	struct tps65217 *tps = rdev_get_drvdata(dev);
126 	unsigned int rid = rdev_get_id(dev);
127 
128 	if (rid < TPS65217_DCDC_1 || rid > TPS65217_LDO_4)
129 		return -EINVAL;
130 
131 	return tps65217_clear_bits(tps, dev->desc->bypass_reg,
132 				   dev->desc->bypass_mask,
133 				   TPS65217_PROTECT_L1);
134 }
135 
136 static int tps65217_pmic_set_suspend_disable(struct regulator_dev *dev)
137 {
138 	struct tps65217 *tps = rdev_get_drvdata(dev);
139 	unsigned int rid = rdev_get_id(dev);
140 
141 	if (rid < TPS65217_DCDC_1 || rid > TPS65217_LDO_4)
142 		return -EINVAL;
143 
144 	if (!tps->strobes[rid])
145 		return -EINVAL;
146 
147 	return tps65217_set_bits(tps, dev->desc->bypass_reg,
148 				 dev->desc->bypass_mask,
149 				 tps->strobes[rid], TPS65217_PROTECT_L1);
150 }
151 
152 /* Operations permitted on DCDCx, LDO2, LDO3 and LDO4 */
153 static struct regulator_ops tps65217_pmic_ops = {
154 	.is_enabled		= regulator_is_enabled_regmap,
155 	.enable			= tps65217_pmic_enable,
156 	.disable		= tps65217_pmic_disable,
157 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
158 	.set_voltage_sel	= tps65217_pmic_set_voltage_sel,
159 	.list_voltage		= regulator_list_voltage_linear_range,
160 	.map_voltage		= regulator_map_voltage_linear_range,
161 	.set_suspend_enable	= tps65217_pmic_set_suspend_enable,
162 	.set_suspend_disable	= tps65217_pmic_set_suspend_disable,
163 };
164 
165 /* Operations permitted on LDO1 */
166 static struct regulator_ops tps65217_pmic_ldo1_ops = {
167 	.is_enabled		= regulator_is_enabled_regmap,
168 	.enable			= tps65217_pmic_enable,
169 	.disable		= tps65217_pmic_disable,
170 	.get_voltage_sel	= regulator_get_voltage_sel_regmap,
171 	.set_voltage_sel	= tps65217_pmic_set_voltage_sel,
172 	.list_voltage		= regulator_list_voltage_table,
173 	.map_voltage		= regulator_map_voltage_ascend,
174 	.set_suspend_enable	= tps65217_pmic_set_suspend_enable,
175 	.set_suspend_disable	= tps65217_pmic_set_suspend_disable,
176 };
177 
178 static const struct regulator_desc regulators[] = {
179 	TPS65217_REGULATOR("DCDC1", TPS65217_DCDC_1, "dcdc1",
180 			   tps65217_pmic_ops, 64, TPS65217_REG_DEFDCDC1,
181 			   TPS65217_DEFDCDCX_DCDC_MASK, TPS65217_ENABLE_DC1_EN,
182 			   NULL, tps65217_uv1_ranges,
183 			   ARRAY_SIZE(tps65217_uv1_ranges), TPS65217_REG_SEQ1,
184 			   TPS65217_SEQ1_DC1_SEQ_MASK),
185 	TPS65217_REGULATOR("DCDC2", TPS65217_DCDC_2, "dcdc2",
186 			   tps65217_pmic_ops, 64, TPS65217_REG_DEFDCDC2,
187 			   TPS65217_DEFDCDCX_DCDC_MASK, TPS65217_ENABLE_DC2_EN,
188 			   NULL, tps65217_uv1_ranges,
189 			   ARRAY_SIZE(tps65217_uv1_ranges), TPS65217_REG_SEQ1,
190 			   TPS65217_SEQ1_DC2_SEQ_MASK),
191 	TPS65217_REGULATOR("DCDC3", TPS65217_DCDC_3, "dcdc3",
192 			   tps65217_pmic_ops, 64, TPS65217_REG_DEFDCDC3,
193 			   TPS65217_DEFDCDCX_DCDC_MASK, TPS65217_ENABLE_DC3_EN,
194 			   NULL, tps65217_uv1_ranges,
195 			   ARRAY_SIZE(tps65217_uv1_ranges), TPS65217_REG_SEQ2,
196 			   TPS65217_SEQ2_DC3_SEQ_MASK),
197 	TPS65217_REGULATOR("LDO1", TPS65217_LDO_1, "ldo1",
198 			   tps65217_pmic_ldo1_ops, 16, TPS65217_REG_DEFLDO1,
199 			   TPS65217_DEFLDO1_LDO1_MASK, TPS65217_ENABLE_LDO1_EN,
200 			   LDO1_VSEL_table, NULL, 0, TPS65217_REG_SEQ2,
201 			   TPS65217_SEQ2_LDO1_SEQ_MASK),
202 	TPS65217_REGULATOR("LDO2", TPS65217_LDO_2, "ldo2", tps65217_pmic_ops,
203 			   64, TPS65217_REG_DEFLDO2,
204 			   TPS65217_DEFLDO2_LDO2_MASK, TPS65217_ENABLE_LDO2_EN,
205 			   NULL, tps65217_uv1_ranges,
206 			   ARRAY_SIZE(tps65217_uv1_ranges), TPS65217_REG_SEQ3,
207 			   TPS65217_SEQ3_LDO2_SEQ_MASK),
208 	TPS65217_REGULATOR("LDO3", TPS65217_LDO_3, "ldo3", tps65217_pmic_ops,
209 			   32, TPS65217_REG_DEFLS1, TPS65217_DEFLDO3_LDO3_MASK,
210 			   TPS65217_ENABLE_LS1_EN | TPS65217_DEFLDO3_LDO3_EN,
211 			   NULL, tps65217_uv2_ranges,
212 			   ARRAY_SIZE(tps65217_uv2_ranges), TPS65217_REG_SEQ3,
213 			   TPS65217_SEQ3_LDO3_SEQ_MASK),
214 	TPS65217_REGULATOR("LDO4", TPS65217_LDO_4, "ldo4", tps65217_pmic_ops,
215 			   32, TPS65217_REG_DEFLS2, TPS65217_DEFLDO4_LDO4_MASK,
216 			   TPS65217_ENABLE_LS2_EN | TPS65217_DEFLDO4_LDO4_EN,
217 			   NULL, tps65217_uv2_ranges,
218 			   ARRAY_SIZE(tps65217_uv2_ranges), TPS65217_REG_SEQ4,
219 			   TPS65217_SEQ4_LDO4_SEQ_MASK),
220 };
221 
222 static int tps65217_regulator_probe(struct platform_device *pdev)
223 {
224 	struct tps65217 *tps = dev_get_drvdata(pdev->dev.parent);
225 	struct tps65217_board *pdata = dev_get_platdata(tps->dev);
226 	struct regulator_dev *rdev;
227 	struct regulator_config config = { };
228 	int i, ret;
229 	unsigned int val;
230 
231 	/* Allocate memory for strobes */
232 	tps->strobes = devm_kcalloc(&pdev->dev,
233 				    TPS65217_NUM_REGULATOR, sizeof(u8),
234 				    GFP_KERNEL);
235 	if (!tps->strobes)
236 		return -ENOMEM;
237 
238 	platform_set_drvdata(pdev, tps);
239 
240 	for (i = 0; i < TPS65217_NUM_REGULATOR; i++) {
241 		/* Register the regulators */
242 		config.dev = tps->dev;
243 		if (pdata)
244 			config.init_data = pdata->tps65217_init_data[i];
245 		config.driver_data = tps;
246 		config.regmap = tps->regmap;
247 
248 		rdev = devm_regulator_register(&pdev->dev, &regulators[i],
249 					       &config);
250 		if (IS_ERR(rdev)) {
251 			dev_err(tps->dev, "failed to register %s regulator\n",
252 				pdev->name);
253 			return PTR_ERR(rdev);
254 		}
255 
256 		/* Store default strobe info */
257 		ret = tps65217_reg_read(tps, regulators[i].bypass_reg, &val);
258 		tps->strobes[i] = val & regulators[i].bypass_mask;
259 	}
260 
261 	return 0;
262 }
263 
264 static struct platform_driver tps65217_regulator_driver = {
265 	.driver = {
266 		.name = "tps65217-pmic",
267 	},
268 	.probe = tps65217_regulator_probe,
269 };
270 
271 static int __init tps65217_regulator_init(void)
272 {
273 	return platform_driver_register(&tps65217_regulator_driver);
274 }
275 subsys_initcall(tps65217_regulator_init);
276 
277 static void __exit tps65217_regulator_exit(void)
278 {
279 	platform_driver_unregister(&tps65217_regulator_driver);
280 }
281 module_exit(tps65217_regulator_exit);
282 
283 MODULE_AUTHOR("AnilKumar Ch <anilkumar@ti.com>");
284 MODULE_DESCRIPTION("TPS65217 voltage regulator driver");
285 MODULE_ALIAS("platform:tps65217-pmic");
286 MODULE_LICENSE("GPL v2");
287