2 * wm8776.c -- WM8776 ALSA SoC Audio driver
4 * Copyright 2009 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
12 * TODO: Input ALC/limiter support
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/platform_device.h>
22 #include <linux/spi/spi.h>
23 #include <linux/slab.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/soc-dapm.h>
29 #include <sound/initval.h>
30 #include <sound/tlv.h>
34 /* codec private data */
36 enum snd_soc_control_type control_type;
38 u16 reg_cache[WM8776_CACHEREGNUM];
42 static const u16 wm8776_reg[WM8776_CACHEREGNUM] = {
43 0x79, 0x79, 0x79, 0xff, 0xff, /* 4 */
44 0xff, 0x00, 0x90, 0x00, 0x00, /* 9 */
45 0x22, 0x22, 0x22, 0x08, 0xcf, /* 14 */
46 0xcf, 0x7b, 0x00, 0x32, 0x00, /* 19 */
50 static int wm8776_reset(struct snd_soc_codec *codec)
52 return snd_soc_write(codec, WM8776_RESET, 0);
55 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
56 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
57 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
59 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
60 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
62 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
64 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
66 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
68 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
70 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
71 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
72 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
75 static const struct snd_kcontrol_new inmix_controls[] = {
76 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
77 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
78 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
79 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
80 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
83 static const struct snd_kcontrol_new outmix_controls[] = {
84 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
85 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
86 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
89 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
90 SND_SOC_DAPM_INPUT("AUX"),
92 SND_SOC_DAPM_INPUT("AIN1"),
93 SND_SOC_DAPM_INPUT("AIN2"),
94 SND_SOC_DAPM_INPUT("AIN3"),
95 SND_SOC_DAPM_INPUT("AIN4"),
96 SND_SOC_DAPM_INPUT("AIN5"),
98 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
99 inmix_controls, ARRAY_SIZE(inmix_controls)),
101 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
102 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
104 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
105 outmix_controls, ARRAY_SIZE(outmix_controls)),
107 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
109 SND_SOC_DAPM_OUTPUT("VOUT"),
111 SND_SOC_DAPM_OUTPUT("HPOUTL"),
112 SND_SOC_DAPM_OUTPUT("HPOUTR"),
115 static const struct snd_soc_dapm_route routes[] = {
116 { "Input Mixer", "AIN1 Switch", "AIN1" },
117 { "Input Mixer", "AIN2 Switch", "AIN2" },
118 { "Input Mixer", "AIN3 Switch", "AIN3" },
119 { "Input Mixer", "AIN4 Switch", "AIN4" },
120 { "Input Mixer", "AIN5 Switch", "AIN5" },
122 { "ADC", NULL, "Input Mixer" },
124 { "Output Mixer", "DAC Switch", "DAC" },
125 { "Output Mixer", "AUX Switch", "AUX" },
126 { "Output Mixer", "Bypass Switch", "Input Mixer" },
128 { "VOUT", NULL, "Output Mixer" },
130 { "Headphone PGA", NULL, "Output Mixer" },
132 { "HPOUTL", NULL, "Headphone PGA" },
133 { "HPOUTR", NULL, "Headphone PGA" },
136 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
138 struct snd_soc_codec *codec = dai->codec;
139 int reg, iface, master;
141 switch (dai->driver->id) {
143 reg = WM8776_DACIFCTRL;
147 reg = WM8776_ADCIFCTRL;
156 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
157 case SND_SOC_DAIFMT_CBM_CFM:
159 case SND_SOC_DAIFMT_CBS_CFS:
166 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
167 case SND_SOC_DAIFMT_I2S:
170 case SND_SOC_DAIFMT_RIGHT_J:
172 case SND_SOC_DAIFMT_LEFT_J:
175 /* FIXME: CHECK A/B */
176 case SND_SOC_DAIFMT_DSP_A:
179 case SND_SOC_DAIFMT_DSP_B:
186 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
187 case SND_SOC_DAIFMT_NB_NF:
189 case SND_SOC_DAIFMT_IB_IF:
192 case SND_SOC_DAIFMT_IB_NF:
195 case SND_SOC_DAIFMT_NB_IF:
202 /* Finally, write out the values */
203 snd_soc_update_bits(codec, reg, 0xf, iface);
204 snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
209 static int mclk_ratios[] = {
218 static int wm8776_hw_params(struct snd_pcm_substream *substream,
219 struct snd_pcm_hw_params *params,
220 struct snd_soc_dai *dai)
222 struct snd_soc_codec *codec = dai->codec;
223 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
224 int iface_reg, iface;
225 int ratio_shift, master;
230 switch (dai->driver->id) {
232 iface_reg = WM8776_DACIFCTRL;
237 iface_reg = WM8776_ADCIFCTRL;
246 /* Set word length */
247 switch (params_format(params)) {
248 case SNDRV_PCM_FORMAT_S16_LE:
250 case SNDRV_PCM_FORMAT_S20_3LE:
253 case SNDRV_PCM_FORMAT_S24_LE:
256 case SNDRV_PCM_FORMAT_S32_LE:
261 /* Only need to set MCLK/LRCLK ratio if we're master */
262 if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
263 for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
264 if (wm8776->sysclk[dai->driver->id] / params_rate(params)
269 if (i == ARRAY_SIZE(mclk_ratios)) {
271 "Unable to configure MCLK ratio %d/%d\n",
272 wm8776->sysclk[dai->driver->id], params_rate(params));
276 dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
278 snd_soc_update_bits(codec, WM8776_MSTRCTRL,
279 0x7 << ratio_shift, i << ratio_shift);
281 dev_dbg(codec->dev, "DAI in slave mode\n");
284 snd_soc_update_bits(codec, iface_reg, 0x30, iface);
289 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
291 struct snd_soc_codec *codec = dai->codec;
293 return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
296 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
297 int clk_id, unsigned int freq, int dir)
299 struct snd_soc_codec *codec = dai->codec;
300 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
302 BUG_ON(dai->driver->id >= ARRAY_SIZE(wm8776->sysclk));
304 wm8776->sysclk[dai->driver->id] = freq;
309 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
310 enum snd_soc_bias_level level)
313 case SND_SOC_BIAS_ON:
315 case SND_SOC_BIAS_PREPARE:
317 case SND_SOC_BIAS_STANDBY:
318 if (codec->bias_level == SND_SOC_BIAS_OFF) {
319 /* Disable the global powerdown; DAPM does the rest */
320 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
324 case SND_SOC_BIAS_OFF:
325 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
329 codec->bias_level = level;
333 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
334 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
335 SNDRV_PCM_RATE_96000)
338 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
339 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
341 static struct snd_soc_dai_ops wm8776_dac_ops = {
342 .digital_mute = wm8776_mute,
343 .hw_params = wm8776_hw_params,
344 .set_fmt = wm8776_set_fmt,
345 .set_sysclk = wm8776_set_sysclk,
348 static struct snd_soc_dai_ops wm8776_adc_ops = {
349 .hw_params = wm8776_hw_params,
350 .set_fmt = wm8776_set_fmt,
351 .set_sysclk = wm8776_set_sysclk,
354 static struct snd_soc_dai_driver wm8776_dai[] = {
356 .name = "wm8776-hifi-playback",
357 .id = WM8776_DAI_DAC,
359 .stream_name = "Playback",
362 .rates = WM8776_RATES,
363 .formats = WM8776_FORMATS,
365 .ops = &wm8776_dac_ops,
368 .name = "wm8776-hifi-capture",
369 .id = WM8776_DAI_ADC,
371 .stream_name = "Capture",
374 .rates = WM8776_RATES,
375 .formats = WM8776_FORMATS,
377 .ops = &wm8776_adc_ops,
382 static int wm8776_suspend(struct snd_soc_codec *codec, pm_message_t state)
384 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
389 static int wm8776_resume(struct snd_soc_codec *codec)
393 u16 *cache = codec->reg_cache;
395 /* Sync reg_cache with the hardware */
396 for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
397 if (cache[i] == wm8776_reg[i])
399 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
400 data[1] = cache[i] & 0x00ff;
401 codec->hw_write(codec->control_data, data, 2);
404 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
409 #define wm8776_suspend NULL
410 #define wm8776_resume NULL
413 static int wm8776_probe(struct snd_soc_codec *codec)
415 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
418 codec->control_data = wm8776->control_data;
419 ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8776->control_type);
421 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
425 ret = wm8776_reset(codec);
427 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
431 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
433 /* Latch the update bits; right channel only since we always
435 snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
436 snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
438 snd_soc_add_controls(codec, wm8776_snd_controls,
439 ARRAY_SIZE(wm8776_snd_controls));
440 snd_soc_dapm_new_controls(codec, wm8776_dapm_widgets,
441 ARRAY_SIZE(wm8776_dapm_widgets));
442 snd_soc_dapm_add_routes(codec, routes, ARRAY_SIZE(routes));
447 /* power down chip */
448 static int wm8776_remove(struct snd_soc_codec *codec)
450 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
454 static struct snd_soc_codec_driver soc_codec_dev_wm8776 = {
455 .probe = wm8776_probe,
456 .remove = wm8776_remove,
457 .suspend = wm8776_suspend,
458 .resume = wm8776_resume,
459 .set_bias_level = wm8776_set_bias_level,
460 .reg_cache_size = sizeof(wm8776_reg),
461 .reg_word_size = sizeof(u16),
462 .reg_cache_default = wm8776_reg,
465 #if defined(CONFIG_SPI_MASTER)
466 static int __devinit wm8776_spi_probe(struct spi_device *spi)
468 struct wm8776_priv *wm8776;
471 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
475 wm8776->control_data = spi;
476 wm8776->control_type = SND_SOC_SPI;
477 spi_set_drvdata(spi, wm8776);
479 ret = snd_soc_register_codec(&spi->dev,
480 &soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
486 static int __devexit wm8776_spi_remove(struct spi_device *spi)
488 snd_soc_unregister_codec(&spi->dev);
489 kfree(spi_get_drvdata(spi));
493 static struct spi_driver wm8776_spi_driver = {
495 .name = "wm8776-codec",
496 .bus = &spi_bus_type,
497 .owner = THIS_MODULE,
499 .probe = wm8776_spi_probe,
500 .remove = __devexit_p(wm8776_spi_remove),
502 #endif /* CONFIG_SPI_MASTER */
504 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
505 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
506 const struct i2c_device_id *id)
508 struct wm8776_priv *wm8776;
511 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
515 i2c_set_clientdata(i2c, wm8776);
516 wm8776->control_data = i2c;
517 wm8776->control_type = SND_SOC_I2C;
519 ret = snd_soc_register_codec(&i2c->dev,
520 &soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
526 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
528 snd_soc_unregister_codec(&client->dev);
529 kfree(i2c_get_clientdata(client));
533 static const struct i2c_device_id wm8776_i2c_id[] = {
537 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
539 static struct i2c_driver wm8776_i2c_driver = {
541 .name = "wm8776-codec",
542 .owner = THIS_MODULE,
544 .probe = wm8776_i2c_probe,
545 .remove = __devexit_p(wm8776_i2c_remove),
546 .id_table = wm8776_i2c_id,
550 static int __init wm8776_modinit(void)
553 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
554 ret = i2c_add_driver(&wm8776_i2c_driver);
556 printk(KERN_ERR "Failed to register wm8776 I2C driver: %d\n",
560 #if defined(CONFIG_SPI_MASTER)
561 ret = spi_register_driver(&wm8776_spi_driver);
563 printk(KERN_ERR "Failed to register wm8776 SPI driver: %d\n",
569 module_init(wm8776_modinit);
571 static void __exit wm8776_exit(void)
573 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
574 i2c_del_driver(&wm8776_i2c_driver);
576 #if defined(CONFIG_SPI_MASTER)
577 spi_unregister_driver(&wm8776_spi_driver);
580 module_exit(wm8776_exit);
582 MODULE_DESCRIPTION("ASoC WM8776 driver");
583 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
584 MODULE_LICENSE("GPL");