xref: /linux/drivers/regulator/arizona-micsupp.c (revision 2aa680df68062e4e0c356ec2aa7100c13654907b)
1 // SPDX-License-Identifier: GPL-2.0+
2 //
3 // arizona-micsupp.c  --  Microphone supply for Arizona devices
4 //
5 // Copyright 2012 Wolfson Microelectronics PLC.
6 //
7 // Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 
9 #include <linux/module.h>
10 #include <linux/moduleparam.h>
11 #include <linux/init.h>
12 #include <linux/bitops.h>
13 #include <linux/err.h>
14 #include <linux/of.h>
15 #include <linux/platform_device.h>
16 #include <linux/regulator/driver.h>
17 #include <linux/regulator/machine.h>
18 #include <linux/regulator/of_regulator.h>
19 #include <linux/slab.h>
20 #include <linux/workqueue.h>
21 #include <sound/soc.h>
22 
23 #include <linux/mfd/arizona/core.h>
24 #include <linux/mfd/arizona/pdata.h>
25 #include <linux/mfd/arizona/registers.h>
26 
27 #include <linux/mfd/madera/core.h>
28 #include <linux/mfd/madera/pdata.h>
29 #include <linux/mfd/madera/registers.h>
30 
31 #include <linux/regulator/arizona-micsupp.h>
32 
33 struct arizona_micsupp {
34 	struct regulator_dev *regulator;
35 	struct regmap *regmap;
36 	struct snd_soc_dapm_context **dapm;
37 	const struct regulator_desc *desc;
38 	struct device *dev;
39 
40 	struct regulator_consumer_supply supply;
41 	struct regulator_init_data init_data;
42 
43 	struct work_struct check_cp_work;
44 };
45 
46 static void arizona_micsupp_check_cp(struct work_struct *work)
47 {
48 	struct arizona_micsupp *micsupp =
49 		container_of(work, struct arizona_micsupp, check_cp_work);
50 	struct snd_soc_dapm_context *dapm = *micsupp->dapm;
51 	const struct regulator_desc *desc = micsupp->desc;
52 	unsigned int val;
53 	int ret;
54 
55 	ret = regmap_read(micsupp->regmap, desc->enable_reg, &val);
56 	if (ret != 0) {
57 		dev_err(micsupp->dev,
58 			"Failed to read CP state: %d\n", ret);
59 		return;
60 	}
61 
62 	if (dapm) {
63 		if ((val & (desc->enable_mask | desc->bypass_mask)) ==
64 		    desc->enable_mask)
65 			snd_soc_dapm_force_enable_pin(dapm, "MICSUPP");
66 		else
67 			snd_soc_dapm_disable_pin(dapm, "MICSUPP");
68 
69 		snd_soc_dapm_sync(dapm);
70 	}
71 }
72 
73 static int arizona_micsupp_enable(struct regulator_dev *rdev)
74 {
75 	struct arizona_micsupp *micsupp = rdev_get_drvdata(rdev);
76 	int ret;
77 
78 	ret = regulator_enable_regmap(rdev);
79 
80 	if (ret == 0)
81 		schedule_work(&micsupp->check_cp_work);
82 
83 	return ret;
84 }
85 
86 static int arizona_micsupp_disable(struct regulator_dev *rdev)
87 {
88 	struct arizona_micsupp *micsupp = rdev_get_drvdata(rdev);
89 	int ret;
90 
91 	ret = regulator_disable_regmap(rdev);
92 	if (ret == 0)
93 		schedule_work(&micsupp->check_cp_work);
94 
95 	return ret;
96 }
97 
98 static int arizona_micsupp_set_bypass(struct regulator_dev *rdev, bool ena)
99 {
100 	struct arizona_micsupp *micsupp = rdev_get_drvdata(rdev);
101 	int ret;
102 
103 	ret = regulator_set_bypass_regmap(rdev, ena);
104 	if (ret == 0)
105 		schedule_work(&micsupp->check_cp_work);
106 
107 	return ret;
108 }
109 
110 static const struct regulator_ops arizona_micsupp_ops = {
111 	.enable = arizona_micsupp_enable,
112 	.disable = arizona_micsupp_disable,
113 	.is_enabled = regulator_is_enabled_regmap,
114 
115 	.list_voltage = regulator_list_voltage_linear_range,
116 	.map_voltage = regulator_map_voltage_linear_range,
117 
118 	.get_voltage_sel = regulator_get_voltage_sel_regmap,
119 	.set_voltage_sel = regulator_set_voltage_sel_regmap,
120 
121 	.get_bypass = regulator_get_bypass_regmap,
122 	.set_bypass = arizona_micsupp_set_bypass,
123 };
124 
125 static const struct linear_range arizona_micsupp_ranges[] = {
126 	REGULATOR_LINEAR_RANGE(1700000, 0,    0x1e, 50000),
127 	REGULATOR_LINEAR_RANGE(3300000, 0x1f, 0x1f, 0),
128 };
129 
130 static const struct regulator_desc arizona_micsupp = {
131 	.name = "MICVDD",
132 	.supply_name = "CPVDD",
133 	.type = REGULATOR_VOLTAGE,
134 	.n_voltages = 32,
135 	.ops = &arizona_micsupp_ops,
136 
137 	.vsel_reg = ARIZONA_LDO2_CONTROL_1,
138 	.vsel_mask = ARIZONA_LDO2_VSEL_MASK,
139 	.enable_reg = ARIZONA_MIC_CHARGE_PUMP_1,
140 	.enable_mask = ARIZONA_CPMIC_ENA,
141 	.bypass_reg = ARIZONA_MIC_CHARGE_PUMP_1,
142 	.bypass_mask = ARIZONA_CPMIC_BYPASS,
143 
144 	.linear_ranges = arizona_micsupp_ranges,
145 	.n_linear_ranges = ARRAY_SIZE(arizona_micsupp_ranges),
146 
147 	.enable_time = 3000,
148 
149 	.owner = THIS_MODULE,
150 };
151 
152 static const struct linear_range arizona_micsupp_ext_ranges[] = {
153 	REGULATOR_LINEAR_RANGE(900000,  0,    0x14, 25000),
154 	REGULATOR_LINEAR_RANGE(1500000, 0x15, 0x27, 100000),
155 };
156 
157 static const struct regulator_desc arizona_micsupp_ext = {
158 	.name = "MICVDD",
159 	.supply_name = "CPVDD",
160 	.type = REGULATOR_VOLTAGE,
161 	.n_voltages = 40,
162 	.ops = &arizona_micsupp_ops,
163 
164 	.vsel_reg = ARIZONA_LDO2_CONTROL_1,
165 	.vsel_mask = ARIZONA_LDO2_VSEL_MASK,
166 	.enable_reg = ARIZONA_MIC_CHARGE_PUMP_1,
167 	.enable_mask = ARIZONA_CPMIC_ENA,
168 	.bypass_reg = ARIZONA_MIC_CHARGE_PUMP_1,
169 	.bypass_mask = ARIZONA_CPMIC_BYPASS,
170 
171 	.linear_ranges = arizona_micsupp_ext_ranges,
172 	.n_linear_ranges = ARRAY_SIZE(arizona_micsupp_ext_ranges),
173 
174 	.enable_time = 3000,
175 
176 	.owner = THIS_MODULE,
177 };
178 
179 static const struct regulator_init_data arizona_micsupp_default = {
180 	.constraints = {
181 		.valid_ops_mask = REGULATOR_CHANGE_STATUS |
182 				REGULATOR_CHANGE_VOLTAGE |
183 				REGULATOR_CHANGE_BYPASS,
184 		.min_uV = 1700000,
185 		.max_uV = 3300000,
186 	},
187 
188 	.num_consumer_supplies = 1,
189 };
190 
191 static const struct regulator_init_data arizona_micsupp_ext_default = {
192 	.constraints = {
193 		.valid_ops_mask = REGULATOR_CHANGE_STATUS |
194 				REGULATOR_CHANGE_VOLTAGE |
195 				REGULATOR_CHANGE_BYPASS,
196 		.min_uV = 900000,
197 		.max_uV = 3300000,
198 	},
199 
200 	.num_consumer_supplies = 1,
201 };
202 
203 static const struct regulator_desc madera_micsupp = {
204 	.name = "MICVDD",
205 	.supply_name = "CPVDD1",
206 	.type = REGULATOR_VOLTAGE,
207 	.n_voltages = 40,
208 	.ops = &arizona_micsupp_ops,
209 	.vsel_reg = MADERA_LDO2_CONTROL_1,
210 	.vsel_mask = MADERA_LDO2_VSEL_MASK,
211 	.enable_reg = MADERA_MIC_CHARGE_PUMP_1,
212 	.enable_mask = MADERA_CPMIC_ENA,
213 	.bypass_reg = MADERA_MIC_CHARGE_PUMP_1,
214 	.bypass_mask = MADERA_CPMIC_BYPASS,
215 
216 	.linear_ranges = arizona_micsupp_ext_ranges,
217 	.n_linear_ranges = ARRAY_SIZE(arizona_micsupp_ext_ranges),
218 
219 	.enable_time = 3000,
220 
221 	.owner = THIS_MODULE,
222 };
223 
224 static int arizona_micsupp_of_get_pdata(struct arizona_micsupp_pdata *pdata,
225 					struct regulator_config *config,
226 					const struct regulator_desc *desc)
227 {
228 	struct arizona_micsupp *micsupp = config->driver_data;
229 	struct device_node *np;
230 	struct regulator_init_data *init_data;
231 
232 	np = of_get_child_by_name(config->dev->of_node, "micvdd");
233 
234 	if (np) {
235 		config->of_node = np;
236 
237 		init_data = of_get_regulator_init_data(config->dev, np, desc);
238 
239 		if (init_data) {
240 			init_data->consumer_supplies = &micsupp->supply;
241 			init_data->num_consumer_supplies = 1;
242 
243 			pdata->init_data = init_data;
244 		}
245 	}
246 
247 	return 0;
248 }
249 
250 static int arizona_micsupp_common_init(struct platform_device *pdev,
251 				       struct arizona_micsupp *micsupp,
252 				       const struct regulator_desc *desc,
253 				       struct arizona_micsupp_pdata *pdata)
254 {
255 	struct regulator_config config = { };
256 	int ret;
257 
258 	INIT_WORK(&micsupp->check_cp_work, arizona_micsupp_check_cp);
259 
260 	micsupp->init_data.consumer_supplies = &micsupp->supply;
261 	micsupp->supply.dev_name = dev_name(micsupp->dev);
262 	micsupp->desc = desc;
263 
264 	config.dev = micsupp->dev;
265 	config.driver_data = micsupp;
266 	config.regmap = micsupp->regmap;
267 
268 	if (IS_ENABLED(CONFIG_OF)) {
269 		if (!dev_get_platdata(micsupp->dev)) {
270 			ret = arizona_micsupp_of_get_pdata(pdata, &config,
271 							   desc);
272 			if (ret < 0)
273 				return ret;
274 		}
275 	}
276 
277 	if (pdata->init_data)
278 		config.init_data = pdata->init_data;
279 	else
280 		config.init_data = &micsupp->init_data;
281 
282 	/* Default to regulated mode */
283 	regmap_update_bits(micsupp->regmap, desc->enable_reg, desc->bypass_mask, 0);
284 
285 	micsupp->regulator = devm_regulator_register(&pdev->dev,
286 						     desc,
287 						     &config);
288 
289 	of_node_put(config.of_node);
290 
291 	if (IS_ERR(micsupp->regulator)) {
292 		ret = PTR_ERR(micsupp->regulator);
293 		dev_err(micsupp->dev, "Failed to register mic supply: %d\n",
294 			ret);
295 		return ret;
296 	}
297 
298 	platform_set_drvdata(pdev, micsupp);
299 
300 	return 0;
301 }
302 
303 static int arizona_micsupp_probe(struct platform_device *pdev)
304 {
305 	struct arizona *arizona = dev_get_drvdata(pdev->dev.parent);
306 	const struct regulator_desc *desc;
307 	struct arizona_micsupp *micsupp;
308 
309 	micsupp = devm_kzalloc(&pdev->dev, sizeof(*micsupp), GFP_KERNEL);
310 	if (!micsupp)
311 		return -ENOMEM;
312 
313 	micsupp->regmap = arizona->regmap;
314 	micsupp->dapm = &arizona->dapm;
315 	micsupp->dev = arizona->dev;
316 
317 	micsupp->supply.supply = "MICVDD";
318 
319 	/*
320 	 * Since the chip usually supplies itself we provide some
321 	 * default init_data for it.  This will be overridden with
322 	 * platform data if provided.
323 	 */
324 	switch (arizona->type) {
325 	case WM5110:
326 	case WM8280:
327 		desc = &arizona_micsupp_ext;
328 		micsupp->init_data = arizona_micsupp_ext_default;
329 		break;
330 	default:
331 		desc = &arizona_micsupp;
332 		micsupp->init_data = arizona_micsupp_default;
333 		break;
334 	}
335 
336 	return arizona_micsupp_common_init(pdev, micsupp, desc,
337 					   &arizona->pdata.micvdd);
338 }
339 
340 static int madera_micsupp_probe(struct platform_device *pdev)
341 {
342 	struct madera *madera = dev_get_drvdata(pdev->dev.parent);
343 	struct arizona_micsupp *micsupp;
344 
345 	micsupp = devm_kzalloc(&pdev->dev, sizeof(*micsupp), GFP_KERNEL);
346 	if (!micsupp)
347 		return -ENOMEM;
348 
349 	micsupp->regmap = madera->regmap;
350 	micsupp->dapm = &madera->dapm;
351 	micsupp->dev = madera->dev;
352 	micsupp->init_data = arizona_micsupp_ext_default;
353 
354 	micsupp->supply.supply = "MICVDD";
355 
356 	return arizona_micsupp_common_init(pdev, micsupp, &madera_micsupp,
357 					   &madera->pdata.micvdd);
358 }
359 
360 static struct platform_driver arizona_micsupp_driver = {
361 	.probe = arizona_micsupp_probe,
362 	.driver		= {
363 		.name	= "arizona-micsupp",
364 		.probe_type = PROBE_FORCE_SYNCHRONOUS,
365 	},
366 };
367 
368 static struct platform_driver madera_micsupp_driver = {
369 	.probe = madera_micsupp_probe,
370 	.driver		= {
371 		.name	= "madera-micsupp",
372 		.probe_type = PROBE_FORCE_SYNCHRONOUS,
373 	},
374 };
375 
376 static struct platform_driver * const arizona_micsupp_drivers[] = {
377 	&arizona_micsupp_driver,
378 	&madera_micsupp_driver,
379 };
380 
381 static int __init arizona_micsupp_init(void)
382 {
383 	return platform_register_drivers(arizona_micsupp_drivers,
384 					 ARRAY_SIZE(arizona_micsupp_drivers));
385 }
386 module_init(arizona_micsupp_init);
387 
388 static void __exit arizona_micsupp_exit(void)
389 {
390 	platform_unregister_drivers(arizona_micsupp_drivers,
391 				    ARRAY_SIZE(arizona_micsupp_drivers));
392 }
393 module_exit(arizona_micsupp_exit);
394 
395 /* Module information */
396 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
397 MODULE_DESCRIPTION("Arizona microphone supply driver");
398 MODULE_LICENSE("GPL");
399 MODULE_ALIAS("platform:arizona-micsupp");
400 MODULE_ALIAS("platform:madera-micsupp");
401