wm8994-core.c revision c3f1386171a100d27d9fb978f474a6a330888af5 
1/*
2 * wm8994-core.c  --  Device access for Wolfson WM8994
3 *
4 * Copyright 2009 Wolfson Microelectronics PLC.
5 *
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7 *
8 *  This program is free software; you can redistribute  it and/or modify it
9 *  under  the terms of  the GNU General  Public License as published by the
10 *  Free Software Foundation;  either version 2 of the  License, or (at your
11 *  option) any later version.
12 *
13 */
14
15#include <linux/kernel.h>
16#include <linux/module.h>
17#include <linux/slab.h>
18#include <linux/i2c.h>
19#include <linux/err.h>
20#include <linux/delay.h>
21#include <linux/mfd/core.h>
22#include <linux/pm_runtime.h>
23#include <linux/regmap.h>
24#include <linux/regulator/consumer.h>
25#include <linux/regulator/machine.h>
26
27#include <linux/mfd/wm8994/core.h>
28#include <linux/mfd/wm8994/pdata.h>
29#include <linux/mfd/wm8994/registers.h>
30
31#include "wm8994.h"
32
33/**
34 * wm8994_reg_read: Read a single WM8994 register.
35 *
36 * @wm8994: Device to read from.
37 * @reg: Register to read.
38 */
39int wm8994_reg_read(struct wm8994 *wm8994, unsigned short reg)
40{
41	unsigned int val;
42	int ret;
43
44	ret = regmap_read(wm8994->regmap, reg, &val);
45
46	if (ret < 0)
47		return ret;
48	else
49		return val;
50}
51EXPORT_SYMBOL_GPL(wm8994_reg_read);
52
53/**
54 * wm8994_bulk_read: Read multiple WM8994 registers
55 *
56 * @wm8994: Device to read from
57 * @reg: First register
58 * @count: Number of registers
59 * @buf: Buffer to fill.  The data will be returned big endian.
60 */
61int wm8994_bulk_read(struct wm8994 *wm8994, unsigned short reg,
62		     int count, u16 *buf)
63{
64	return regmap_bulk_read(wm8994->regmap, reg, buf, count);
65}
66
67/**
68 * wm8994_reg_write: Write a single WM8994 register.
69 *
70 * @wm8994: Device to write to.
71 * @reg: Register to write to.
72 * @val: Value to write.
73 */
74int wm8994_reg_write(struct wm8994 *wm8994, unsigned short reg,
75		     unsigned short val)
76{
77	return regmap_write(wm8994->regmap, reg, val);
78}
79EXPORT_SYMBOL_GPL(wm8994_reg_write);
80
81/**
82 * wm8994_bulk_write: Write multiple WM8994 registers
83 *
84 * @wm8994: Device to write to
85 * @reg: First register
86 * @count: Number of registers
87 * @buf: Buffer to write from.  Data must be big-endian formatted.
88 */
89int wm8994_bulk_write(struct wm8994 *wm8994, unsigned short reg,
90		      int count, const u16 *buf)
91{
92	return regmap_raw_write(wm8994->regmap, reg, buf, count * sizeof(u16));
93}
94EXPORT_SYMBOL_GPL(wm8994_bulk_write);
95
96/**
97 * wm8994_set_bits: Set the value of a bitfield in a WM8994 register
98 *
99 * @wm8994: Device to write to.
100 * @reg: Register to write to.
101 * @mask: Mask of bits to set.
102 * @val: Value to set (unshifted)
103 */
104int wm8994_set_bits(struct wm8994 *wm8994, unsigned short reg,
105		    unsigned short mask, unsigned short val)
106{
107	return regmap_update_bits(wm8994->regmap, reg, mask, val);
108}
109EXPORT_SYMBOL_GPL(wm8994_set_bits);
110
111static struct mfd_cell wm8994_regulator_devs[] = {
112	{
113		.name = "wm8994-ldo",
114		.id = 1,
115		.pm_runtime_no_callbacks = true,
116	},
117	{
118		.name = "wm8994-ldo",
119		.id = 2,
120		.pm_runtime_no_callbacks = true,
121	},
122};
123
124static struct resource wm8994_codec_resources[] = {
125	{
126		.start = WM8994_IRQ_TEMP_SHUT,
127		.end   = WM8994_IRQ_TEMP_WARN,
128		.flags = IORESOURCE_IRQ,
129	},
130};
131
132static struct resource wm8994_gpio_resources[] = {
133	{
134		.start = WM8994_IRQ_GPIO(1),
135		.end   = WM8994_IRQ_GPIO(11),
136		.flags = IORESOURCE_IRQ,
137	},
138};
139
140static struct mfd_cell wm8994_devs[] = {
141	{
142		.name = "wm8994-codec",
143		.num_resources = ARRAY_SIZE(wm8994_codec_resources),
144		.resources = wm8994_codec_resources,
145	},
146
147	{
148		.name = "wm8994-gpio",
149		.num_resources = ARRAY_SIZE(wm8994_gpio_resources),
150		.resources = wm8994_gpio_resources,
151		.pm_runtime_no_callbacks = true,
152	},
153};
154
155/*
156 * Supplies for the main bulk of CODEC; the LDO supplies are ignored
157 * and should be handled via the standard regulator API supply
158 * management.
159 */
160static const char *wm1811_main_supplies[] = {
161	"DBVDD1",
162	"DBVDD2",
163	"DBVDD3",
164	"DCVDD",
165	"AVDD1",
166	"AVDD2",
167	"CPVDD",
168	"SPKVDD1",
169	"SPKVDD2",
170};
171
172static const char *wm8994_main_supplies[] = {
173	"DBVDD",
174	"DCVDD",
175	"AVDD1",
176	"AVDD2",
177	"CPVDD",
178	"SPKVDD1",
179	"SPKVDD2",
180};
181
182static const char *wm8958_main_supplies[] = {
183	"DBVDD1",
184	"DBVDD2",
185	"DBVDD3",
186	"DCVDD",
187	"AVDD1",
188	"AVDD2",
189	"CPVDD",
190	"SPKVDD1",
191	"SPKVDD2",
192};
193
194#ifdef CONFIG_PM
195static int wm8994_suspend(struct device *dev)
196{
197	struct wm8994 *wm8994 = dev_get_drvdata(dev);
198	int ret;
199
200	/* Don't actually go through with the suspend if the CODEC is
201	 * still active (eg, for audio passthrough from CP. */
202	ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_1);
203	if (ret < 0) {
204		dev_err(dev, "Failed to read power status: %d\n", ret);
205	} else if (ret & WM8994_VMID_SEL_MASK) {
206		dev_dbg(dev, "CODEC still active, ignoring suspend\n");
207		return 0;
208	}
209
210	ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_4);
211	if (ret < 0) {
212		dev_err(dev, "Failed to read power status: %d\n", ret);
213	} else if (ret & (WM8994_AIF2ADCL_ENA | WM8994_AIF2ADCR_ENA |
214			  WM8994_AIF1ADC2L_ENA | WM8994_AIF1ADC2R_ENA |
215			  WM8994_AIF1ADC1L_ENA | WM8994_AIF1ADC1R_ENA)) {
216		dev_dbg(dev, "CODEC still active, ignoring suspend\n");
217		return 0;
218	}
219
220	ret = wm8994_reg_read(wm8994, WM8994_POWER_MANAGEMENT_5);
221	if (ret < 0) {
222		dev_err(dev, "Failed to read power status: %d\n", ret);
223	} else if (ret & (WM8994_AIF2DACL_ENA | WM8994_AIF2DACR_ENA |
224			  WM8994_AIF1DAC2L_ENA | WM8994_AIF1DAC2R_ENA |
225			  WM8994_AIF1DAC1L_ENA | WM8994_AIF1DAC1R_ENA)) {
226		dev_dbg(dev, "CODEC still active, ignoring suspend\n");
227		return 0;
228	}
229
230	switch (wm8994->type) {
231	case WM8958:
232		ret = wm8994_reg_read(wm8994, WM8958_MIC_DETECT_1);
233		if (ret < 0) {
234			dev_err(dev, "Failed to read power status: %d\n", ret);
235		} else if (ret & WM8958_MICD_ENA) {
236			dev_dbg(dev, "CODEC still active, ignoring suspend\n");
237			return 0;
238		}
239		break;
240	default:
241		break;
242	}
243
244	/* Disable LDO pulldowns while the device is suspended if we
245	 * don't know that something will be driving them. */
246	if (!wm8994->ldo_ena_always_driven)
247		wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
248				WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
249				WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD);
250
251	/* Explicitly put the device into reset in case regulators
252	 * don't get disabled in order to ensure consistent restart.
253	 */
254	wm8994_reg_write(wm8994, WM8994_SOFTWARE_RESET,
255			 wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET));
256
257	regcache_mark_dirty(wm8994->regmap);
258
259	wm8994->suspended = true;
260
261	ret = regulator_bulk_disable(wm8994->num_supplies,
262				     wm8994->supplies);
263	if (ret != 0) {
264		dev_err(dev, "Failed to disable supplies: %d\n", ret);
265		return ret;
266	}
267
268	return 0;
269}
270
271static int wm8994_resume(struct device *dev)
272{
273	struct wm8994 *wm8994 = dev_get_drvdata(dev);
274	int ret;
275
276	/* We may have lied to the PM core about suspending */
277	if (!wm8994->suspended)
278		return 0;
279
280	ret = regulator_bulk_enable(wm8994->num_supplies,
281				    wm8994->supplies);
282	if (ret != 0) {
283		dev_err(dev, "Failed to enable supplies: %d\n", ret);
284		return ret;
285	}
286
287	ret = regcache_sync(wm8994->regmap);
288	if (ret != 0) {
289		dev_err(dev, "Failed to restore register map: %d\n", ret);
290		goto err_enable;
291	}
292
293	/* Disable LDO pulldowns while the device is active */
294	wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
295			WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD,
296			0);
297
298	wm8994->suspended = false;
299
300	return 0;
301
302err_enable:
303	regulator_bulk_disable(wm8994->num_supplies, wm8994->supplies);
304
305	return ret;
306}
307#endif
308
309#ifdef CONFIG_REGULATOR
310static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
311{
312	struct wm8994_ldo_pdata *ldo_pdata;
313
314	if (!pdata)
315		return 0;
316
317	ldo_pdata = &pdata->ldo[ldo];
318
319	if (!ldo_pdata->init_data)
320		return 0;
321
322	return ldo_pdata->init_data->num_consumer_supplies != 0;
323}
324#else
325static int wm8994_ldo_in_use(struct wm8994_pdata *pdata, int ldo)
326{
327	return 0;
328}
329#endif
330
331/*
332 * Instantiate the generic non-control parts of the device.
333 */
334static int wm8994_device_init(struct wm8994 *wm8994, int irq)
335{
336	struct wm8994_pdata *pdata = wm8994->dev->platform_data;
337	const char *devname;
338	int ret, i;
339	int pulls = 0;
340
341	dev_set_drvdata(wm8994->dev, wm8994);
342
343	/* Add the on-chip regulators first for bootstrapping */
344	ret = mfd_add_devices(wm8994->dev, -1,
345			      wm8994_regulator_devs,
346			      ARRAY_SIZE(wm8994_regulator_devs),
347			      NULL, 0);
348	if (ret != 0) {
349		dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
350		goto err_regmap;
351	}
352
353	switch (wm8994->type) {
354	case WM1811:
355		wm8994->num_supplies = ARRAY_SIZE(wm1811_main_supplies);
356		break;
357	case WM8994:
358		wm8994->num_supplies = ARRAY_SIZE(wm8994_main_supplies);
359		break;
360	case WM8958:
361		wm8994->num_supplies = ARRAY_SIZE(wm8958_main_supplies);
362		break;
363	default:
364		BUG();
365		goto err_regmap;
366	}
367
368	wm8994->supplies = devm_kzalloc(wm8994->dev,
369					sizeof(struct regulator_bulk_data) *
370					wm8994->num_supplies, GFP_KERNEL);
371	if (!wm8994->supplies) {
372		ret = -ENOMEM;
373		goto err_regmap;
374	}
375
376	switch (wm8994->type) {
377	case WM1811:
378		for (i = 0; i < ARRAY_SIZE(wm1811_main_supplies); i++)
379			wm8994->supplies[i].supply = wm1811_main_supplies[i];
380		break;
381	case WM8994:
382		for (i = 0; i < ARRAY_SIZE(wm8994_main_supplies); i++)
383			wm8994->supplies[i].supply = wm8994_main_supplies[i];
384		break;
385	case WM8958:
386		for (i = 0; i < ARRAY_SIZE(wm8958_main_supplies); i++)
387			wm8994->supplies[i].supply = wm8958_main_supplies[i];
388		break;
389	default:
390		BUG();
391		goto err_regmap;
392	}
393
394	ret = regulator_bulk_get(wm8994->dev, wm8994->num_supplies,
395				 wm8994->supplies);
396	if (ret != 0) {
397		dev_err(wm8994->dev, "Failed to get supplies: %d\n", ret);
398		goto err_regmap;
399	}
400
401	ret = regulator_bulk_enable(wm8994->num_supplies,
402				    wm8994->supplies);
403	if (ret != 0) {
404		dev_err(wm8994->dev, "Failed to enable supplies: %d\n", ret);
405		goto err_get;
406	}
407
408	ret = wm8994_reg_read(wm8994, WM8994_SOFTWARE_RESET);
409	if (ret < 0) {
410		dev_err(wm8994->dev, "Failed to read ID register\n");
411		goto err_enable;
412	}
413	switch (ret) {
414	case 0x1811:
415		devname = "WM1811";
416		if (wm8994->type != WM1811)
417			dev_warn(wm8994->dev, "Device registered as type %d\n",
418				 wm8994->type);
419		wm8994->type = WM1811;
420		break;
421	case 0x8994:
422		devname = "WM8994";
423		if (wm8994->type != WM8994)
424			dev_warn(wm8994->dev, "Device registered as type %d\n",
425				 wm8994->type);
426		wm8994->type = WM8994;
427		break;
428	case 0x8958:
429		devname = "WM8958";
430		if (wm8994->type != WM8958)
431			dev_warn(wm8994->dev, "Device registered as type %d\n",
432				 wm8994->type);
433		wm8994->type = WM8958;
434		break;
435	default:
436		dev_err(wm8994->dev, "Device is not a WM8994, ID is %x\n",
437			ret);
438		ret = -EINVAL;
439		goto err_enable;
440	}
441
442	ret = wm8994_reg_read(wm8994, WM8994_CHIP_REVISION);
443	if (ret < 0) {
444		dev_err(wm8994->dev, "Failed to read revision register: %d\n",
445			ret);
446		goto err_enable;
447	}
448
449	switch (wm8994->type) {
450	case WM8994:
451		switch (ret) {
452		case 0:
453		case 1:
454			dev_warn(wm8994->dev,
455				 "revision %c not fully supported\n",
456				 'A' + ret);
457			break;
458		default:
459			break;
460		}
461		break;
462	default:
463		break;
464	}
465
466	dev_info(wm8994->dev, "%s revision %c\n", devname, 'A' + ret);
467
468	if (pdata) {
469		wm8994->irq_base = pdata->irq_base;
470		wm8994->gpio_base = pdata->gpio_base;
471
472		/* GPIO configuration is only applied if it's non-zero */
473		for (i = 0; i < ARRAY_SIZE(pdata->gpio_defaults); i++) {
474			if (pdata->gpio_defaults[i]) {
475				wm8994_set_bits(wm8994, WM8994_GPIO_1 + i,
476						0xffff,
477						pdata->gpio_defaults[i]);
478			}
479		}
480
481		wm8994->ldo_ena_always_driven = pdata->ldo_ena_always_driven;
482
483		if (pdata->spkmode_pu)
484			pulls |= WM8994_SPKMODE_PU;
485	}
486
487	/* Disable unneeded pulls */
488	wm8994_set_bits(wm8994, WM8994_PULL_CONTROL_2,
489			WM8994_LDO1ENA_PD | WM8994_LDO2ENA_PD |
490			WM8994_SPKMODE_PU | WM8994_CSNADDR_PD,
491			pulls);
492
493	/* In some system designs where the regulators are not in use,
494	 * we can achieve a small reduction in leakage currents by
495	 * floating LDO outputs.  This bit makes no difference if the
496	 * LDOs are enabled, it only affects cases where the LDOs were
497	 * in operation and are then disabled.
498	 */
499	for (i = 0; i < WM8994_NUM_LDO_REGS; i++) {
500		if (wm8994_ldo_in_use(pdata, i))
501			wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
502					WM8994_LDO1_DISCH, WM8994_LDO1_DISCH);
503		else
504			wm8994_set_bits(wm8994, WM8994_LDO_1 + i,
505					WM8994_LDO1_DISCH, 0);
506	}
507
508	wm8994_irq_init(wm8994);
509
510	ret = mfd_add_devices(wm8994->dev, -1,
511			      wm8994_devs, ARRAY_SIZE(wm8994_devs),
512			      NULL, 0);
513	if (ret != 0) {
514		dev_err(wm8994->dev, "Failed to add children: %d\n", ret);
515		goto err_irq;
516	}
517
518	pm_runtime_enable(wm8994->dev);
519	pm_runtime_resume(wm8994->dev);
520
521	return 0;
522
523err_irq:
524	wm8994_irq_exit(wm8994);
525err_enable:
526	regulator_bulk_disable(wm8994->num_supplies,
527			       wm8994->supplies);
528err_get:
529	regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
530err_regmap:
531	regmap_exit(wm8994->regmap);
532	mfd_remove_devices(wm8994->dev);
533	return ret;
534}
535
536static void wm8994_device_exit(struct wm8994 *wm8994)
537{
538	pm_runtime_disable(wm8994->dev);
539	mfd_remove_devices(wm8994->dev);
540	wm8994_irq_exit(wm8994);
541	regulator_bulk_disable(wm8994->num_supplies,
542			       wm8994->supplies);
543	regulator_bulk_free(wm8994->num_supplies, wm8994->supplies);
544	regmap_exit(wm8994->regmap);
545}
546
547static const struct of_device_id wm8994_of_match[] = {
548	{ .compatible = "wlf,wm1811", },
549	{ .compatible = "wlf,wm8994", },
550	{ .compatible = "wlf,wm8958", },
551	{ }
552};
553MODULE_DEVICE_TABLE(of, wm8994_of_match);
554
555static int wm8994_i2c_probe(struct i2c_client *i2c,
556			    const struct i2c_device_id *id)
557{
558	struct wm8994 *wm8994;
559	struct regmap_config *regmap_config;
560	int ret;
561
562	wm8994 = devm_kzalloc(&i2c->dev, sizeof(struct wm8994), GFP_KERNEL);
563	if (wm8994 == NULL)
564		return -ENOMEM;
565
566	i2c_set_clientdata(i2c, wm8994);
567	wm8994->dev = &i2c->dev;
568	wm8994->irq = i2c->irq;
569	wm8994->type = id->driver_data;
570
571	switch (wm8994->type) {
572	case WM1811:
573		regmap_config = &wm1811_regmap_config;
574		break;
575	case WM8994:
576		regmap_config = &wm8994_regmap_config;
577		break;
578	case WM8958:
579		regmap_config = &wm8958_regmap_config;
580		break;
581	default:
582		dev_err(wm8994->dev, "Unknown device type %d\n", wm8994->type);
583		return -EINVAL;
584	}
585
586	wm8994->regmap = regmap_init_i2c(i2c, regmap_config);
587	if (IS_ERR(wm8994->regmap)) {
588		ret = PTR_ERR(wm8994->regmap);
589		dev_err(wm8994->dev, "Failed to allocate register map: %d\n",
590			ret);
591		return ret;
592	}
593
594	return wm8994_device_init(wm8994, i2c->irq);
595}
596
597static int wm8994_i2c_remove(struct i2c_client *i2c)
598{
599	struct wm8994 *wm8994 = i2c_get_clientdata(i2c);
600
601	wm8994_device_exit(wm8994);
602
603	return 0;
604}
605
606static const struct i2c_device_id wm8994_i2c_id[] = {
607	{ "wm1811", WM1811 },
608	{ "wm8994", WM8994 },
609	{ "wm8958", WM8958 },
610	{ }
611};
612MODULE_DEVICE_TABLE(i2c, wm8994_i2c_id);
613
614static UNIVERSAL_DEV_PM_OPS(wm8994_pm_ops, wm8994_suspend, wm8994_resume,
615			    NULL);
616
617static struct i2c_driver wm8994_i2c_driver = {
618	.driver = {
619		.name = "wm8994",
620		.owner = THIS_MODULE,
621		.pm = &wm8994_pm_ops,
622		.of_match_table = wm8994_of_match,
623	},
624	.probe = wm8994_i2c_probe,
625	.remove = wm8994_i2c_remove,
626	.id_table = wm8994_i2c_id,
627};
628
629static int __init wm8994_i2c_init(void)
630{
631	int ret;
632
633	ret = i2c_add_driver(&wm8994_i2c_driver);
634	if (ret != 0)
635		pr_err("Failed to register wm8994 I2C driver: %d\n", ret);
636
637	return ret;
638}
639module_init(wm8994_i2c_init);
640
641static void __exit wm8994_i2c_exit(void)
642{
643	i2c_del_driver(&wm8994_i2c_driver);
644}
645module_exit(wm8994_i2c_exit);
646
647MODULE_DESCRIPTION("Core support for the WM8994 audio CODEC");
648MODULE_LICENSE("GPL");
649MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
650