xref: /openbmc/linux/sound/soc/codecs/wm8711.c (revision 63dc02bd)
1 /*
2  * wm8711.c  --  WM8711 ALSA SoC Audio driver
3  *
4  * Copyright 2006 Wolfson Microelectronics
5  *
6  * Author: Mike Arthur <Mike.Arthur@wolfsonmicro.com>
7  *
8  * Based on wm8731.c by Richard Purdie
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  */
14 
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
19 #include <linux/pm.h>
20 #include <linux/i2c.h>
21 #include <linux/spi/spi.h>
22 #include <linux/slab.h>
23 #include <linux/of_device.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
27 #include <sound/soc.h>
28 #include <sound/tlv.h>
29 #include <sound/initval.h>
30 
31 #include "wm8711.h"
32 
33 /* codec private data */
34 struct wm8711_priv {
35 	enum snd_soc_control_type bus_type;
36 	unsigned int sysclk;
37 };
38 
39 /*
40  * wm8711 register cache
41  * We can't read the WM8711 register space when we are
42  * using 2 wire for device control, so we cache them instead.
43  * There is no point in caching the reset register
44  */
45 static const u16 wm8711_reg[WM8711_CACHEREGNUM] = {
46 	0x0079, 0x0079, 0x000a, 0x0008,
47 	0x009f, 0x000a, 0x0000, 0x0000
48 };
49 
50 #define wm8711_reset(c)	snd_soc_write(c, WM8711_RESET, 0)
51 
52 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
53 
54 static const struct snd_kcontrol_new wm8711_snd_controls[] = {
55 
56 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8711_LOUT1V, WM8711_ROUT1V,
57 		 0, 127, 0, out_tlv),
58 SOC_DOUBLE_R("Master Playback ZC Switch", WM8711_LOUT1V, WM8711_ROUT1V,
59 	7, 1, 0),
60 
61 };
62 
63 /* Output Mixer */
64 static const struct snd_kcontrol_new wm8711_output_mixer_controls[] = {
65 SOC_DAPM_SINGLE("Line Bypass Switch", WM8711_APANA, 3, 1, 0),
66 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8711_APANA, 4, 1, 0),
67 };
68 
69 static const struct snd_soc_dapm_widget wm8711_dapm_widgets[] = {
70 SND_SOC_DAPM_MIXER("Output Mixer", WM8711_PWR, 4, 1,
71 	&wm8711_output_mixer_controls[0],
72 	ARRAY_SIZE(wm8711_output_mixer_controls)),
73 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8711_PWR, 3, 1),
74 SND_SOC_DAPM_OUTPUT("LOUT"),
75 SND_SOC_DAPM_OUTPUT("LHPOUT"),
76 SND_SOC_DAPM_OUTPUT("ROUT"),
77 SND_SOC_DAPM_OUTPUT("RHPOUT"),
78 };
79 
80 static const struct snd_soc_dapm_route wm8711_intercon[] = {
81 	/* output mixer */
82 	{"Output Mixer", "Line Bypass Switch", "Line Input"},
83 	{"Output Mixer", "HiFi Playback Switch", "DAC"},
84 
85 	/* outputs */
86 	{"RHPOUT", NULL, "Output Mixer"},
87 	{"ROUT", NULL, "Output Mixer"},
88 	{"LHPOUT", NULL, "Output Mixer"},
89 	{"LOUT", NULL, "Output Mixer"},
90 };
91 
92 struct _coeff_div {
93 	u32 mclk;
94 	u32 rate;
95 	u16 fs;
96 	u8 sr:4;
97 	u8 bosr:1;
98 	u8 usb:1;
99 };
100 
101 /* codec mclk clock divider coefficients */
102 static const struct _coeff_div coeff_div[] = {
103 	/* 48k */
104 	{12288000, 48000, 256, 0x0, 0x0, 0x0},
105 	{18432000, 48000, 384, 0x0, 0x1, 0x0},
106 	{12000000, 48000, 250, 0x0, 0x0, 0x1},
107 
108 	/* 32k */
109 	{12288000, 32000, 384, 0x6, 0x0, 0x0},
110 	{18432000, 32000, 576, 0x6, 0x1, 0x0},
111 	{12000000, 32000, 375, 0x6, 0x0, 0x1},
112 
113 	/* 8k */
114 	{12288000, 8000, 1536, 0x3, 0x0, 0x0},
115 	{18432000, 8000, 2304, 0x3, 0x1, 0x0},
116 	{11289600, 8000, 1408, 0xb, 0x0, 0x0},
117 	{16934400, 8000, 2112, 0xb, 0x1, 0x0},
118 	{12000000, 8000, 1500, 0x3, 0x0, 0x1},
119 
120 	/* 96k */
121 	{12288000, 96000, 128, 0x7, 0x0, 0x0},
122 	{18432000, 96000, 192, 0x7, 0x1, 0x0},
123 	{12000000, 96000, 125, 0x7, 0x0, 0x1},
124 
125 	/* 44.1k */
126 	{11289600, 44100, 256, 0x8, 0x0, 0x0},
127 	{16934400, 44100, 384, 0x8, 0x1, 0x0},
128 	{12000000, 44100, 272, 0x8, 0x1, 0x1},
129 
130 	/* 88.2k */
131 	{11289600, 88200, 128, 0xf, 0x0, 0x0},
132 	{16934400, 88200, 192, 0xf, 0x1, 0x0},
133 	{12000000, 88200, 136, 0xf, 0x1, 0x1},
134 };
135 
136 static inline int get_coeff(int mclk, int rate)
137 {
138 	int i;
139 
140 	for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
141 		if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
142 			return i;
143 	}
144 	return 0;
145 }
146 
147 static int wm8711_hw_params(struct snd_pcm_substream *substream,
148 	struct snd_pcm_hw_params *params,
149 	struct snd_soc_dai *dai)
150 {
151 	struct snd_soc_codec *codec = dai->codec;
152 	struct wm8711_priv *wm8711 =  snd_soc_codec_get_drvdata(codec);
153 	u16 iface = snd_soc_read(codec, WM8711_IFACE) & 0xfff3;
154 	int i = get_coeff(wm8711->sysclk, params_rate(params));
155 	u16 srate = (coeff_div[i].sr << 2) |
156 		(coeff_div[i].bosr << 1) | coeff_div[i].usb;
157 
158 	snd_soc_write(codec, WM8711_SRATE, srate);
159 
160 	/* bit size */
161 	switch (params_format(params)) {
162 	case SNDRV_PCM_FORMAT_S16_LE:
163 		break;
164 	case SNDRV_PCM_FORMAT_S20_3LE:
165 		iface |= 0x0004;
166 		break;
167 	case SNDRV_PCM_FORMAT_S24_LE:
168 		iface |= 0x0008;
169 		break;
170 	}
171 
172 	snd_soc_write(codec, WM8711_IFACE, iface);
173 	return 0;
174 }
175 
176 static int wm8711_pcm_prepare(struct snd_pcm_substream *substream,
177 			      struct snd_soc_dai *dai)
178 {
179 	struct snd_soc_codec *codec = dai->codec;
180 
181 	/* set active */
182 	snd_soc_write(codec, WM8711_ACTIVE, 0x0001);
183 
184 	return 0;
185 }
186 
187 static void wm8711_shutdown(struct snd_pcm_substream *substream,
188 			    struct snd_soc_dai *dai)
189 {
190 	struct snd_soc_codec *codec = dai->codec;
191 
192 	/* deactivate */
193 	if (!codec->active) {
194 		udelay(50);
195 		snd_soc_write(codec, WM8711_ACTIVE, 0x0);
196 	}
197 }
198 
199 static int wm8711_mute(struct snd_soc_dai *dai, int mute)
200 {
201 	struct snd_soc_codec *codec = dai->codec;
202 	u16 mute_reg = snd_soc_read(codec, WM8711_APDIGI) & 0xfff7;
203 
204 	if (mute)
205 		snd_soc_write(codec, WM8711_APDIGI, mute_reg | 0x8);
206 	else
207 		snd_soc_write(codec, WM8711_APDIGI, mute_reg);
208 
209 	return 0;
210 }
211 
212 static int wm8711_set_dai_sysclk(struct snd_soc_dai *codec_dai,
213 		int clk_id, unsigned int freq, int dir)
214 {
215 	struct snd_soc_codec *codec = codec_dai->codec;
216 	struct wm8711_priv *wm8711 =  snd_soc_codec_get_drvdata(codec);
217 
218 	switch (freq) {
219 	case 11289600:
220 	case 12000000:
221 	case 12288000:
222 	case 16934400:
223 	case 18432000:
224 		wm8711->sysclk = freq;
225 		return 0;
226 	}
227 	return -EINVAL;
228 }
229 
230 static int wm8711_set_dai_fmt(struct snd_soc_dai *codec_dai,
231 		unsigned int fmt)
232 {
233 	struct snd_soc_codec *codec = codec_dai->codec;
234 	u16 iface = snd_soc_read(codec, WM8711_IFACE) & 0x000c;
235 
236 	/* set master/slave audio interface */
237 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
238 	case SND_SOC_DAIFMT_CBM_CFM:
239 		iface |= 0x0040;
240 		break;
241 	case SND_SOC_DAIFMT_CBS_CFS:
242 		break;
243 	default:
244 		return -EINVAL;
245 	}
246 
247 	/* interface format */
248 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
249 	case SND_SOC_DAIFMT_I2S:
250 		iface |= 0x0002;
251 		break;
252 	case SND_SOC_DAIFMT_RIGHT_J:
253 		break;
254 	case SND_SOC_DAIFMT_LEFT_J:
255 		iface |= 0x0001;
256 		break;
257 	case SND_SOC_DAIFMT_DSP_A:
258 		iface |= 0x0003;
259 		break;
260 	case SND_SOC_DAIFMT_DSP_B:
261 		iface |= 0x0013;
262 		break;
263 	default:
264 		return -EINVAL;
265 	}
266 
267 	/* clock inversion */
268 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
269 	case SND_SOC_DAIFMT_NB_NF:
270 		break;
271 	case SND_SOC_DAIFMT_IB_IF:
272 		iface |= 0x0090;
273 		break;
274 	case SND_SOC_DAIFMT_IB_NF:
275 		iface |= 0x0080;
276 		break;
277 	case SND_SOC_DAIFMT_NB_IF:
278 		iface |= 0x0010;
279 		break;
280 	default:
281 		return -EINVAL;
282 	}
283 
284 	/* set iface */
285 	snd_soc_write(codec, WM8711_IFACE, iface);
286 	return 0;
287 }
288 
289 static int wm8711_set_bias_level(struct snd_soc_codec *codec,
290 	enum snd_soc_bias_level level)
291 {
292 	u16 reg = snd_soc_read(codec, WM8711_PWR) & 0xff7f;
293 
294 	switch (level) {
295 	case SND_SOC_BIAS_ON:
296 		snd_soc_write(codec, WM8711_PWR, reg);
297 		break;
298 	case SND_SOC_BIAS_PREPARE:
299 		break;
300 	case SND_SOC_BIAS_STANDBY:
301 		if (codec->dapm.bias_level == SND_SOC_BIAS_OFF)
302 			snd_soc_cache_sync(codec);
303 
304 		snd_soc_write(codec, WM8711_PWR, reg | 0x0040);
305 		break;
306 	case SND_SOC_BIAS_OFF:
307 		snd_soc_write(codec, WM8711_ACTIVE, 0x0);
308 		snd_soc_write(codec, WM8711_PWR, 0xffff);
309 		break;
310 	}
311 	codec->dapm.bias_level = level;
312 	return 0;
313 }
314 
315 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000
316 
317 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
318 	SNDRV_PCM_FMTBIT_S24_LE)
319 
320 static const struct snd_soc_dai_ops wm8711_ops = {
321 	.prepare = wm8711_pcm_prepare,
322 	.hw_params = wm8711_hw_params,
323 	.shutdown = wm8711_shutdown,
324 	.digital_mute = wm8711_mute,
325 	.set_sysclk = wm8711_set_dai_sysclk,
326 	.set_fmt = wm8711_set_dai_fmt,
327 };
328 
329 static struct snd_soc_dai_driver wm8711_dai = {
330 	.name = "wm8711-hifi",
331 	.playback = {
332 		.stream_name = "Playback",
333 		.channels_min = 1,
334 		.channels_max = 2,
335 		.rates = WM8711_RATES,
336 		.formats = WM8711_FORMATS,
337 	},
338 	.ops = &wm8711_ops,
339 };
340 
341 static int wm8711_suspend(struct snd_soc_codec *codec)
342 {
343 	snd_soc_write(codec, WM8711_ACTIVE, 0x0);
344 	wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF);
345 	return 0;
346 }
347 
348 static int wm8711_resume(struct snd_soc_codec *codec)
349 {
350 	wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
351 	return 0;
352 }
353 
354 static int wm8711_probe(struct snd_soc_codec *codec)
355 {
356 	struct wm8711_priv *wm8711 = snd_soc_codec_get_drvdata(codec);
357 	int ret;
358 
359 	ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8711->bus_type);
360 	if (ret < 0) {
361 		dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
362 		return ret;
363 	}
364 
365 	ret = wm8711_reset(codec);
366 	if (ret < 0) {
367 		dev_err(codec->dev, "Failed to issue reset\n");
368 		return ret;
369 	}
370 
371 	wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
372 
373 	/* Latch the update bits */
374 	snd_soc_update_bits(codec, WM8711_LOUT1V, 0x0100, 0x0100);
375 	snd_soc_update_bits(codec, WM8711_ROUT1V, 0x0100, 0x0100);
376 
377 	return ret;
378 
379 }
380 
381 /* power down chip */
382 static int wm8711_remove(struct snd_soc_codec *codec)
383 {
384 	wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF);
385 	return 0;
386 }
387 
388 static struct snd_soc_codec_driver soc_codec_dev_wm8711 = {
389 	.probe =	wm8711_probe,
390 	.remove =	wm8711_remove,
391 	.suspend =	wm8711_suspend,
392 	.resume =	wm8711_resume,
393 	.set_bias_level = wm8711_set_bias_level,
394 	.reg_cache_size = ARRAY_SIZE(wm8711_reg),
395 	.reg_word_size = sizeof(u16),
396 	.reg_cache_default = wm8711_reg,
397 	.controls = wm8711_snd_controls,
398 	.num_controls = ARRAY_SIZE(wm8711_snd_controls),
399 	.dapm_widgets = wm8711_dapm_widgets,
400 	.num_dapm_widgets = ARRAY_SIZE(wm8711_dapm_widgets),
401 	.dapm_routes = wm8711_intercon,
402 	.num_dapm_routes = ARRAY_SIZE(wm8711_intercon),
403 };
404 
405 static const struct of_device_id wm8711_of_match[] = {
406 	{ .compatible = "wlf,wm8711", },
407 	{ }
408 };
409 MODULE_DEVICE_TABLE(of, wm8711_of_match);
410 
411 #if defined(CONFIG_SPI_MASTER)
412 static int __devinit wm8711_spi_probe(struct spi_device *spi)
413 {
414 	struct wm8711_priv *wm8711;
415 	int ret;
416 
417 	wm8711 = kzalloc(sizeof(struct wm8711_priv), GFP_KERNEL);
418 	if (wm8711 == NULL)
419 		return -ENOMEM;
420 
421 	spi_set_drvdata(spi, wm8711);
422 	wm8711->bus_type = SND_SOC_SPI;
423 
424 	ret = snd_soc_register_codec(&spi->dev,
425 			&soc_codec_dev_wm8711, &wm8711_dai, 1);
426 	if (ret < 0)
427 		kfree(wm8711);
428 	return ret;
429 }
430 
431 static int __devexit wm8711_spi_remove(struct spi_device *spi)
432 {
433 	snd_soc_unregister_codec(&spi->dev);
434 	kfree(spi_get_drvdata(spi));
435 	return 0;
436 }
437 
438 static struct spi_driver wm8711_spi_driver = {
439 	.driver = {
440 		.name	= "wm8711",
441 		.owner	= THIS_MODULE,
442 		.of_match_table = wm8711_of_match,
443 	},
444 	.probe		= wm8711_spi_probe,
445 	.remove		= __devexit_p(wm8711_spi_remove),
446 };
447 #endif /* CONFIG_SPI_MASTER */
448 
449 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
450 static __devinit int wm8711_i2c_probe(struct i2c_client *client,
451 				      const struct i2c_device_id *id)
452 {
453 	struct wm8711_priv *wm8711;
454 	int ret;
455 
456 	wm8711 = kzalloc(sizeof(struct wm8711_priv), GFP_KERNEL);
457 	if (wm8711 == NULL)
458 		return -ENOMEM;
459 
460 	i2c_set_clientdata(client, wm8711);
461 	wm8711->bus_type = SND_SOC_I2C;
462 
463 	ret =  snd_soc_register_codec(&client->dev,
464 			&soc_codec_dev_wm8711, &wm8711_dai, 1);
465 	if (ret < 0)
466 		kfree(wm8711);
467 	return ret;
468 }
469 
470 static __devexit int wm8711_i2c_remove(struct i2c_client *client)
471 {
472 	snd_soc_unregister_codec(&client->dev);
473 	kfree(i2c_get_clientdata(client));
474 	return 0;
475 }
476 
477 static const struct i2c_device_id wm8711_i2c_id[] = {
478 	{ "wm8711", 0 },
479 	{ }
480 };
481 MODULE_DEVICE_TABLE(i2c, wm8711_i2c_id);
482 
483 static struct i2c_driver wm8711_i2c_driver = {
484 	.driver = {
485 		.name = "wm8711",
486 		.owner = THIS_MODULE,
487 		.of_match_table = wm8711_of_match,
488 	},
489 	.probe =    wm8711_i2c_probe,
490 	.remove =   __devexit_p(wm8711_i2c_remove),
491 	.id_table = wm8711_i2c_id,
492 };
493 #endif
494 
495 static int __init wm8711_modinit(void)
496 {
497 	int ret;
498 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
499 	ret = i2c_add_driver(&wm8711_i2c_driver);
500 	if (ret != 0) {
501 		printk(KERN_ERR "Failed to register WM8711 I2C driver: %d\n",
502 		       ret);
503 	}
504 #endif
505 #if defined(CONFIG_SPI_MASTER)
506 	ret = spi_register_driver(&wm8711_spi_driver);
507 	if (ret != 0) {
508 		printk(KERN_ERR "Failed to register WM8711 SPI driver: %d\n",
509 		       ret);
510 	}
511 #endif
512 	return 0;
513 }
514 module_init(wm8711_modinit);
515 
516 static void __exit wm8711_exit(void)
517 {
518 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
519 	i2c_del_driver(&wm8711_i2c_driver);
520 #endif
521 #if defined(CONFIG_SPI_MASTER)
522 	spi_unregister_driver(&wm8711_spi_driver);
523 #endif
524 }
525 module_exit(wm8711_exit);
526 
527 MODULE_DESCRIPTION("ASoC WM8711 driver");
528 MODULE_AUTHOR("Mike Arthur");
529 MODULE_LICENSE("GPL");
530