xref: /openbmc/linux/sound/soc/codecs/wm8776.c (revision d1dc698a)
1 /*
2  * wm8776.c  --  WM8776 ALSA SoC Audio driver
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
9  * it under the terms of the GNU General Public License version 2 as
10  * published by the Free Software Foundation.
11  *
12  * TODO: Input ALC/limiter support
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/of_device.h>
22 #include <linux/platform_device.h>
23 #include <linux/spi/spi.h>
24 #include <linux/slab.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/soc.h>
29 #include <sound/initval.h>
30 #include <sound/tlv.h>
31 
32 #include "wm8776.h"
33 
34 /* codec private data */
35 struct wm8776_priv {
36 	enum snd_soc_control_type control_type;
37 	int sysclk[2];
38 };
39 
40 static const u16 wm8776_reg[WM8776_CACHEREGNUM] = {
41 	0x79, 0x79, 0x79, 0xff, 0xff,  /* 4 */
42 	0xff, 0x00, 0x90, 0x00, 0x00,  /* 9 */
43 	0x22, 0x22, 0x22, 0x08, 0xcf,  /* 14 */
44 	0xcf, 0x7b, 0x00, 0x32, 0x00,  /* 19 */
45 	0xa6, 0x01, 0x01
46 };
47 
48 static int wm8776_reset(struct snd_soc_codec *codec)
49 {
50 	return snd_soc_write(codec, WM8776_RESET, 0);
51 }
52 
53 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
54 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
55 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
56 
57 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
58 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
59 		 0, 127, 0, hp_tlv),
60 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
61 		 0, 255, 0, dac_tlv),
62 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
63 
64 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
65 
66 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
67 		 0, 255, 0, adc_tlv),
68 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
69 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
70 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
71 };
72 
73 static const struct snd_kcontrol_new inmix_controls[] = {
74 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
75 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
76 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
77 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
78 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
79 };
80 
81 static const struct snd_kcontrol_new outmix_controls[] = {
82 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
83 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
84 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
85 };
86 
87 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
88 SND_SOC_DAPM_INPUT("AUX"),
89 
90 SND_SOC_DAPM_INPUT("AIN1"),
91 SND_SOC_DAPM_INPUT("AIN2"),
92 SND_SOC_DAPM_INPUT("AIN3"),
93 SND_SOC_DAPM_INPUT("AIN4"),
94 SND_SOC_DAPM_INPUT("AIN5"),
95 
96 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
97 		   inmix_controls, ARRAY_SIZE(inmix_controls)),
98 
99 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
100 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
101 
102 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
103 		   outmix_controls, ARRAY_SIZE(outmix_controls)),
104 
105 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
106 
107 SND_SOC_DAPM_OUTPUT("VOUT"),
108 
109 SND_SOC_DAPM_OUTPUT("HPOUTL"),
110 SND_SOC_DAPM_OUTPUT("HPOUTR"),
111 };
112 
113 static const struct snd_soc_dapm_route routes[] = {
114 	{ "Input Mixer", "AIN1 Switch", "AIN1" },
115 	{ "Input Mixer", "AIN2 Switch", "AIN2" },
116 	{ "Input Mixer", "AIN3 Switch", "AIN3" },
117 	{ "Input Mixer", "AIN4 Switch", "AIN4" },
118 	{ "Input Mixer", "AIN5 Switch", "AIN5" },
119 
120 	{ "ADC", NULL, "Input Mixer" },
121 
122 	{ "Output Mixer", "DAC Switch", "DAC" },
123 	{ "Output Mixer", "AUX Switch", "AUX" },
124 	{ "Output Mixer", "Bypass Switch", "Input Mixer" },
125 
126 	{ "VOUT", NULL, "Output Mixer" },
127 
128 	{ "Headphone PGA", NULL, "Output Mixer" },
129 
130 	{ "HPOUTL", NULL, "Headphone PGA" },
131 	{ "HPOUTR", NULL, "Headphone PGA" },
132 };
133 
134 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
135 {
136 	struct snd_soc_codec *codec = dai->codec;
137 	int reg, iface, master;
138 
139 	switch (dai->driver->id) {
140 	case WM8776_DAI_DAC:
141 		reg = WM8776_DACIFCTRL;
142 		master = 0x80;
143 		break;
144 	case WM8776_DAI_ADC:
145 		reg = WM8776_ADCIFCTRL;
146 		master = 0x100;
147 		break;
148 	default:
149 		return -EINVAL;
150 	}
151 
152 	iface = 0;
153 
154 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
155 	case SND_SOC_DAIFMT_CBM_CFM:
156 		break;
157 	case SND_SOC_DAIFMT_CBS_CFS:
158 		master = 0;
159 		break;
160 	default:
161 		return -EINVAL;
162 	}
163 
164 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
165 	case SND_SOC_DAIFMT_I2S:
166 		iface |= 0x0002;
167 		break;
168 	case SND_SOC_DAIFMT_RIGHT_J:
169 		break;
170 	case SND_SOC_DAIFMT_LEFT_J:
171 		iface |= 0x0001;
172 		break;
173 	default:
174 		return -EINVAL;
175 	}
176 
177 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
178 	case SND_SOC_DAIFMT_NB_NF:
179 		break;
180 	case SND_SOC_DAIFMT_IB_IF:
181 		iface |= 0x00c;
182 		break;
183 	case SND_SOC_DAIFMT_IB_NF:
184 		iface |= 0x008;
185 		break;
186 	case SND_SOC_DAIFMT_NB_IF:
187 		iface |= 0x004;
188 		break;
189 	default:
190 		return -EINVAL;
191 	}
192 
193 	/* Finally, write out the values */
194 	snd_soc_update_bits(codec, reg, 0xf, iface);
195 	snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
196 
197 	return 0;
198 }
199 
200 static int mclk_ratios[] = {
201 	128,
202 	192,
203 	256,
204 	384,
205 	512,
206 	768,
207 };
208 
209 static int wm8776_hw_params(struct snd_pcm_substream *substream,
210 			    struct snd_pcm_hw_params *params,
211 			    struct snd_soc_dai *dai)
212 {
213 	struct snd_soc_codec *codec = dai->codec;
214 	struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
215 	int iface_reg, iface;
216 	int ratio_shift, master;
217 	int i;
218 
219 	switch (dai->driver->id) {
220 	case WM8776_DAI_DAC:
221 		iface_reg = WM8776_DACIFCTRL;
222 		master = 0x80;
223 		ratio_shift = 4;
224 		break;
225 	case WM8776_DAI_ADC:
226 		iface_reg = WM8776_ADCIFCTRL;
227 		master = 0x100;
228 		ratio_shift = 0;
229 		break;
230 	default:
231 		return -EINVAL;
232 	}
233 
234 	/* Set word length */
235 	switch (snd_pcm_format_width(params_format(params))) {
236 	case 16:
237 		iface = 0;
238 	case 20:
239 		iface = 0x10;
240 		break;
241 	case 24:
242 		iface = 0x20;
243 		break;
244 	case 32:
245 		iface = 0x30;
246 		break;
247 	default:
248 		dev_err(codec->dev, "Unsupported sample size: %i\n",
249 			snd_pcm_format_width(params_format(params)));
250 		return -EINVAL;
251 	}
252 
253 	/* Only need to set MCLK/LRCLK ratio if we're master */
254 	if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
255 		for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
256 			if (wm8776->sysclk[dai->driver->id] / params_rate(params)
257 			    == mclk_ratios[i])
258 				break;
259 		}
260 
261 		if (i == ARRAY_SIZE(mclk_ratios)) {
262 			dev_err(codec->dev,
263 				"Unable to configure MCLK ratio %d/%d\n",
264 				wm8776->sysclk[dai->driver->id], params_rate(params));
265 			return -EINVAL;
266 		}
267 
268 		dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
269 
270 		snd_soc_update_bits(codec, WM8776_MSTRCTRL,
271 				    0x7 << ratio_shift, i << ratio_shift);
272 	} else {
273 		dev_dbg(codec->dev, "DAI in slave mode\n");
274 	}
275 
276 	snd_soc_update_bits(codec, iface_reg, 0x30, iface);
277 
278 	return 0;
279 }
280 
281 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
282 {
283 	struct snd_soc_codec *codec = dai->codec;
284 
285 	return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
286 }
287 
288 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
289 			     int clk_id, unsigned int freq, int dir)
290 {
291 	struct snd_soc_codec *codec = dai->codec;
292 	struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
293 
294 	BUG_ON(dai->driver->id >= ARRAY_SIZE(wm8776->sysclk));
295 
296 	wm8776->sysclk[dai->driver->id] = freq;
297 
298 	return 0;
299 }
300 
301 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
302 				 enum snd_soc_bias_level level)
303 {
304 	switch (level) {
305 	case SND_SOC_BIAS_ON:
306 		break;
307 	case SND_SOC_BIAS_PREPARE:
308 		break;
309 	case SND_SOC_BIAS_STANDBY:
310 		if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
311 			/* Disable the global powerdown; DAPM does the rest */
312 			snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
313 		}
314 
315 		break;
316 	case SND_SOC_BIAS_OFF:
317 		snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
318 		break;
319 	}
320 
321 	codec->dapm.bias_level = level;
322 	return 0;
323 }
324 
325 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
326 		      SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
327 		      SNDRV_PCM_RATE_96000)
328 
329 
330 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
331 			SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
332 
333 static struct snd_soc_dai_ops wm8776_dac_ops = {
334 	.digital_mute	= wm8776_mute,
335 	.hw_params      = wm8776_hw_params,
336 	.set_fmt        = wm8776_set_fmt,
337 	.set_sysclk     = wm8776_set_sysclk,
338 };
339 
340 static struct snd_soc_dai_ops wm8776_adc_ops = {
341 	.hw_params      = wm8776_hw_params,
342 	.set_fmt        = wm8776_set_fmt,
343 	.set_sysclk     = wm8776_set_sysclk,
344 };
345 
346 static struct snd_soc_dai_driver wm8776_dai[] = {
347 	{
348 		.name = "wm8776-hifi-playback",
349 		.id	= WM8776_DAI_DAC,
350 		.playback = {
351 			.stream_name = "Playback",
352 			.channels_min = 2,
353 			.channels_max = 2,
354 			.rates = WM8776_RATES,
355 			.formats = WM8776_FORMATS,
356 		},
357 		.ops = &wm8776_dac_ops,
358 	},
359 	{
360 		.name = "wm8776-hifi-capture",
361 		.id	= WM8776_DAI_ADC,
362 		.capture = {
363 			.stream_name = "Capture",
364 			.channels_min = 2,
365 			.channels_max = 2,
366 			.rates = WM8776_RATES,
367 			.formats = WM8776_FORMATS,
368 		},
369 		.ops = &wm8776_adc_ops,
370 	},
371 };
372 
373 #ifdef CONFIG_PM
374 static int wm8776_suspend(struct snd_soc_codec *codec, pm_message_t state)
375 {
376 	wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
377 
378 	return 0;
379 }
380 
381 static int wm8776_resume(struct snd_soc_codec *codec)
382 {
383 	int i;
384 	u8 data[2];
385 	u16 *cache = codec->reg_cache;
386 
387 	/* Sync reg_cache with the hardware */
388 	for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
389 		if (cache[i] == wm8776_reg[i])
390 			continue;
391 		data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
392 		data[1] = cache[i] & 0x00ff;
393 		codec->hw_write(codec->control_data, data, 2);
394 	}
395 
396 	wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
397 
398 	return 0;
399 }
400 #else
401 #define wm8776_suspend NULL
402 #define wm8776_resume NULL
403 #endif
404 
405 static int wm8776_probe(struct snd_soc_codec *codec)
406 {
407 	struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
408 	struct snd_soc_dapm_context *dapm = &codec->dapm;
409 	int ret = 0;
410 
411 	ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8776->control_type);
412 	if (ret < 0) {
413 		dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
414 		return ret;
415 	}
416 
417 	ret = wm8776_reset(codec);
418 	if (ret < 0) {
419 		dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
420 		return ret;
421 	}
422 
423 	wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
424 
425 	/* Latch the update bits; right channel only since we always
426 	 * update both. */
427 	snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
428 	snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
429 
430 	snd_soc_add_controls(codec, wm8776_snd_controls,
431 			     ARRAY_SIZE(wm8776_snd_controls));
432 	snd_soc_dapm_new_controls(dapm, wm8776_dapm_widgets,
433 				  ARRAY_SIZE(wm8776_dapm_widgets));
434 	snd_soc_dapm_add_routes(dapm, routes, ARRAY_SIZE(routes));
435 
436 	return ret;
437 }
438 
439 /* power down chip */
440 static int wm8776_remove(struct snd_soc_codec *codec)
441 {
442 	wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
443 	return 0;
444 }
445 
446 static struct snd_soc_codec_driver soc_codec_dev_wm8776 = {
447 	.probe = 	wm8776_probe,
448 	.remove = 	wm8776_remove,
449 	.suspend = 	wm8776_suspend,
450 	.resume =	wm8776_resume,
451 	.set_bias_level = wm8776_set_bias_level,
452 	.reg_cache_size = ARRAY_SIZE(wm8776_reg),
453 	.reg_word_size = sizeof(u16),
454 	.reg_cache_default = wm8776_reg,
455 };
456 
457 static const struct of_device_id wm8776_of_match[] = {
458 	{ .compatible = "wlf,wm8776", },
459 	{ }
460 };
461 MODULE_DEVICE_TABLE(of, wm8776_of_match);
462 
463 #if defined(CONFIG_SPI_MASTER)
464 static int __devinit wm8776_spi_probe(struct spi_device *spi)
465 {
466 	struct wm8776_priv *wm8776;
467 	int ret;
468 
469 	wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
470 	if (wm8776 == NULL)
471 		return -ENOMEM;
472 
473 	wm8776->control_type = SND_SOC_SPI;
474 	spi_set_drvdata(spi, wm8776);
475 
476 	ret = snd_soc_register_codec(&spi->dev,
477 			&soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
478 	if (ret < 0)
479 		kfree(wm8776);
480 	return ret;
481 }
482 
483 static int __devexit wm8776_spi_remove(struct spi_device *spi)
484 {
485 	snd_soc_unregister_codec(&spi->dev);
486 	kfree(spi_get_drvdata(spi));
487 	return 0;
488 }
489 
490 static struct spi_driver wm8776_spi_driver = {
491 	.driver = {
492 		.name	= "wm8776",
493 		.owner	= THIS_MODULE,
494 		.of_match_table = wm8776_of_match,
495 	},
496 	.probe		= wm8776_spi_probe,
497 	.remove		= __devexit_p(wm8776_spi_remove),
498 };
499 #endif /* CONFIG_SPI_MASTER */
500 
501 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
502 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
503 				      const struct i2c_device_id *id)
504 {
505 	struct wm8776_priv *wm8776;
506 	int ret;
507 
508 	wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
509 	if (wm8776 == NULL)
510 		return -ENOMEM;
511 
512 	i2c_set_clientdata(i2c, wm8776);
513 	wm8776->control_type = SND_SOC_I2C;
514 
515 	ret =  snd_soc_register_codec(&i2c->dev,
516 			&soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
517 	if (ret < 0)
518 		kfree(wm8776);
519 	return ret;
520 }
521 
522 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
523 {
524 	snd_soc_unregister_codec(&client->dev);
525 	kfree(i2c_get_clientdata(client));
526 	return 0;
527 }
528 
529 static const struct i2c_device_id wm8776_i2c_id[] = {
530 	{ "wm8776", 0 },
531 	{ }
532 };
533 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
534 
535 static struct i2c_driver wm8776_i2c_driver = {
536 	.driver = {
537 		.name = "wm8776",
538 		.owner = THIS_MODULE,
539 		.of_match_table = wm8776_of_match,
540 	},
541 	.probe =    wm8776_i2c_probe,
542 	.remove =   __devexit_p(wm8776_i2c_remove),
543 	.id_table = wm8776_i2c_id,
544 };
545 #endif
546 
547 static int __init wm8776_modinit(void)
548 {
549 	int ret = 0;
550 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
551 	ret = i2c_add_driver(&wm8776_i2c_driver);
552 	if (ret != 0) {
553 		printk(KERN_ERR "Failed to register wm8776 I2C driver: %d\n",
554 		       ret);
555 	}
556 #endif
557 #if defined(CONFIG_SPI_MASTER)
558 	ret = spi_register_driver(&wm8776_spi_driver);
559 	if (ret != 0) {
560 		printk(KERN_ERR "Failed to register wm8776 SPI driver: %d\n",
561 		       ret);
562 	}
563 #endif
564 	return ret;
565 }
566 module_init(wm8776_modinit);
567 
568 static void __exit wm8776_exit(void)
569 {
570 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
571 	i2c_del_driver(&wm8776_i2c_driver);
572 #endif
573 #if defined(CONFIG_SPI_MASTER)
574 	spi_unregister_driver(&wm8776_spi_driver);
575 #endif
576 }
577 module_exit(wm8776_exit);
578 
579 MODULE_DESCRIPTION("ASoC WM8776 driver");
580 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
581 MODULE_LICENSE("GPL");
582