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 <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc.h>
27 #include <sound/soc-dapm.h>
28 #include <sound/initval.h>
29 #include <sound/tlv.h>
33 static struct snd_soc_codec *wm8776_codec;
34 struct snd_soc_codec_device soc_codec_dev_wm8776;
36 /* codec private data */
38 struct snd_soc_codec codec;
39 u16 reg_cache[WM8776_CACHEREGNUM];
43 #ifdef CONFIG_SPI_MASTER
44 static int wm8776_spi_write(struct spi_device *spi, const char *data, int len);
47 static const u16 wm8776_reg[WM8776_CACHEREGNUM] = {
48 0x79, 0x79, 0x79, 0xff, 0xff, /* 4 */
49 0xff, 0x00, 0x90, 0x00, 0x00, /* 9 */
50 0x22, 0x22, 0x22, 0x08, 0xcf, /* 14 */
51 0xcf, 0x7b, 0x00, 0x32, 0x00, /* 19 */
55 static int wm8776_reset(struct snd_soc_codec *codec)
57 return snd_soc_write(codec, WM8776_RESET, 0);
60 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
61 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
62 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
64 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
65 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
67 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
69 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
71 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
73 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
75 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
76 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
77 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
80 static const struct snd_kcontrol_new inmix_controls[] = {
81 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
82 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
83 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
84 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
85 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
88 static const struct snd_kcontrol_new outmix_controls[] = {
89 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
90 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
91 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
94 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
95 SND_SOC_DAPM_INPUT("AUX"),
97 SND_SOC_DAPM_INPUT("AIN1"),
98 SND_SOC_DAPM_INPUT("AIN2"),
99 SND_SOC_DAPM_INPUT("AIN3"),
100 SND_SOC_DAPM_INPUT("AIN4"),
101 SND_SOC_DAPM_INPUT("AIN5"),
103 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
104 inmix_controls, ARRAY_SIZE(inmix_controls)),
106 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
107 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
109 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
110 outmix_controls, ARRAY_SIZE(outmix_controls)),
112 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
114 SND_SOC_DAPM_OUTPUT("VOUT"),
116 SND_SOC_DAPM_OUTPUT("HPOUTL"),
117 SND_SOC_DAPM_OUTPUT("HPOUTR"),
120 static const struct snd_soc_dapm_route routes[] = {
121 { "Input Mixer", "AIN1 Switch", "AIN1" },
122 { "Input Mixer", "AIN2 Switch", "AIN2" },
123 { "Input Mixer", "AIN3 Switch", "AIN3" },
124 { "Input Mixer", "AIN4 Switch", "AIN4" },
125 { "Input Mixer", "AIN5 Switch", "AIN5" },
127 { "ADC", NULL, "Input Mixer" },
129 { "Output Mixer", "DAC Switch", "DAC" },
130 { "Output Mixer", "AUX Switch", "AUX" },
131 { "Output Mixer", "Bypass Switch", "Input Mixer" },
133 { "VOUT", NULL, "Output Mixer" },
135 { "Headphone PGA", NULL, "Output Mixer" },
137 { "HPOUTL", NULL, "Headphone PGA" },
138 { "HPOUTR", NULL, "Headphone PGA" },
141 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
143 struct snd_soc_codec *codec = dai->codec;
144 int reg, iface, master;
148 reg = WM8776_DACIFCTRL;
152 reg = WM8776_ADCIFCTRL;
161 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
162 case SND_SOC_DAIFMT_CBM_CFM:
164 case SND_SOC_DAIFMT_CBS_CFS:
171 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
172 case SND_SOC_DAIFMT_I2S:
175 case SND_SOC_DAIFMT_RIGHT_J:
177 case SND_SOC_DAIFMT_LEFT_J:
184 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
185 case SND_SOC_DAIFMT_NB_NF:
187 case SND_SOC_DAIFMT_IB_IF:
190 case SND_SOC_DAIFMT_IB_NF:
193 case SND_SOC_DAIFMT_NB_IF:
200 /* Finally, write out the values */
201 snd_soc_update_bits(codec, reg, 0xf, iface);
202 snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
207 static int mclk_ratios[] = {
216 static int wm8776_hw_params(struct snd_pcm_substream *substream,
217 struct snd_pcm_hw_params *params,
218 struct snd_soc_dai *dai)
220 struct snd_soc_codec *codec = dai->codec;
221 struct wm8776_priv *wm8776 = codec->private_data;
222 int iface_reg, iface;
223 int ratio_shift, master;
230 iface_reg = WM8776_DACIFCTRL;
235 iface_reg = WM8776_ADCIFCTRL;
244 /* Set word length */
245 switch (params_format(params)) {
246 case SNDRV_PCM_FORMAT_S16_LE:
248 case SNDRV_PCM_FORMAT_S20_3LE:
251 case SNDRV_PCM_FORMAT_S24_LE:
254 case SNDRV_PCM_FORMAT_S32_LE:
259 /* Only need to set MCLK/LRCLK ratio if we're master */
260 if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
261 for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
262 if (wm8776->sysclk[dai->id] / params_rate(params)
267 if (i == ARRAY_SIZE(mclk_ratios)) {
269 "Unable to configure MCLK ratio %d/%d\n",
270 wm8776->sysclk[dai->id], params_rate(params));
274 dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
276 snd_soc_update_bits(codec, WM8776_MSTRCTRL,
277 0x7 << ratio_shift, i << ratio_shift);
279 dev_dbg(codec->dev, "DAI in slave mode\n");
282 snd_soc_update_bits(codec, iface_reg, 0x30, iface);
287 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
289 struct snd_soc_codec *codec = dai->codec;
291 return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
294 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
295 int clk_id, unsigned int freq, int dir)
297 struct snd_soc_codec *codec = dai->codec;
298 struct wm8776_priv *wm8776 = codec->private_data;
300 BUG_ON(dai->id >= ARRAY_SIZE(wm8776->sysclk));
302 wm8776->sysclk[dai->id] = freq;
307 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
308 enum snd_soc_bias_level level)
311 case SND_SOC_BIAS_ON:
313 case SND_SOC_BIAS_PREPARE:
315 case SND_SOC_BIAS_STANDBY:
316 if (codec->bias_level == SND_SOC_BIAS_OFF) {
317 /* Disable the global powerdown; DAPM does the rest */
318 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
322 case SND_SOC_BIAS_OFF:
323 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
327 codec->bias_level = level;
331 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
332 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
333 SNDRV_PCM_RATE_96000)
336 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
337 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
339 static struct snd_soc_dai_ops wm8776_dac_ops = {
340 .digital_mute = wm8776_mute,
341 .hw_params = wm8776_hw_params,
342 .set_fmt = wm8776_set_fmt,
343 .set_sysclk = wm8776_set_sysclk,
346 static struct snd_soc_dai_ops wm8776_adc_ops = {
347 .hw_params = wm8776_hw_params,
348 .set_fmt = wm8776_set_fmt,
349 .set_sysclk = wm8776_set_sysclk,
352 struct snd_soc_dai wm8776_dai[] = {
354 .name = "WM8776 Playback",
355 .id = WM8776_DAI_DAC,
357 .stream_name = "Playback",
360 .rates = WM8776_RATES,
361 .formats = WM8776_FORMATS,
363 .ops = &wm8776_dac_ops,
366 .name = "WM8776 Capture",
367 .id = WM8776_DAI_ADC,
369 .stream_name = "Capture",
372 .rates = WM8776_RATES,
373 .formats = WM8776_FORMATS,
375 .ops = &wm8776_adc_ops,
378 EXPORT_SYMBOL_GPL(wm8776_dai);
381 static int wm8776_suspend(struct platform_device *pdev, pm_message_t state)
383 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
384 struct snd_soc_codec *codec = socdev->card->codec;
386 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
391 static int wm8776_resume(struct platform_device *pdev)
393 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
394 struct snd_soc_codec *codec = socdev->card->codec;
397 u16 *cache = codec->reg_cache;
399 /* Sync reg_cache with the hardware */
400 for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
401 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
402 data[1] = cache[i] & 0x00ff;
403 codec->hw_write(codec->control_data, data, 2);
406 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
411 #define wm8776_suspend NULL
412 #define wm8776_resume NULL
415 static int wm8776_probe(struct platform_device *pdev)
417 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
418 struct snd_soc_codec *codec;
421 if (wm8776_codec == NULL) {
422 dev_err(&pdev->dev, "Codec device not registered\n");
426 socdev->card->codec = wm8776_codec;
427 codec = wm8776_codec;
430 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
432 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
436 snd_soc_add_controls(codec, wm8776_snd_controls,
437 ARRAY_SIZE(wm8776_snd_controls));
438 snd_soc_dapm_new_controls(codec, wm8776_dapm_widgets,
439 ARRAY_SIZE(wm8776_dapm_widgets));
440 snd_soc_dapm_add_routes(codec, routes, ARRAY_SIZE(routes));
442 ret = snd_soc_init_card(socdev);
444 dev_err(codec->dev, "failed to register card: %d\n", ret);
451 snd_soc_free_pcms(socdev);
452 snd_soc_dapm_free(socdev);
457 /* power down chip */
458 static int wm8776_remove(struct platform_device *pdev)
460 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
462 snd_soc_free_pcms(socdev);
463 snd_soc_dapm_free(socdev);
468 struct snd_soc_codec_device soc_codec_dev_wm8776 = {
469 .probe = wm8776_probe,
470 .remove = wm8776_remove,
471 .suspend = wm8776_suspend,
472 .resume = wm8776_resume,
474 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8776);
476 static int wm8776_register(struct wm8776_priv *wm8776,
477 enum snd_soc_control_type control)
480 struct snd_soc_codec *codec = &wm8776->codec;
483 dev_err(codec->dev, "Another WM8776 is registered\n");
488 mutex_init(&codec->mutex);
489 INIT_LIST_HEAD(&codec->dapm_widgets);
490 INIT_LIST_HEAD(&codec->dapm_paths);
492 codec->private_data = wm8776;
493 codec->name = "WM8776";
494 codec->owner = THIS_MODULE;
495 codec->bias_level = SND_SOC_BIAS_OFF;
496 codec->set_bias_level = wm8776_set_bias_level;
497 codec->dai = wm8776_dai;
498 codec->num_dai = ARRAY_SIZE(wm8776_dai);
499 codec->reg_cache_size = WM8776_CACHEREGNUM;
500 codec->reg_cache = &wm8776->reg_cache;
502 memcpy(codec->reg_cache, wm8776_reg, sizeof(wm8776_reg));
504 ret = snd_soc_codec_set_cache_io(codec, 7, 9, control);
506 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
510 for (i = 0; i < ARRAY_SIZE(wm8776_dai); i++)
511 wm8776_dai[i].dev = codec->dev;
513 ret = wm8776_reset(codec);
515 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
519 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
521 /* Latch the update bits; right channel only since we always
523 snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
524 snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
526 wm8776_codec = codec;
528 ret = snd_soc_register_codec(codec);
530 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
534 ret = snd_soc_register_dais(wm8776_dai, ARRAY_SIZE(wm8776_dai));
536 dev_err(codec->dev, "Failed to register DAIs: %d\n", ret);
543 snd_soc_unregister_codec(codec);
549 static void wm8776_unregister(struct wm8776_priv *wm8776)
551 wm8776_set_bias_level(&wm8776->codec, SND_SOC_BIAS_OFF);
552 snd_soc_unregister_dais(wm8776_dai, ARRAY_SIZE(wm8776_dai));
553 snd_soc_unregister_codec(&wm8776->codec);
558 #if defined(CONFIG_SPI_MASTER)
559 static int wm8776_spi_write(struct spi_device *spi, const char *data, int len)
561 struct spi_transfer t;
562 struct spi_message m;
571 spi_message_init(&m);
572 memset(&t, 0, (sizeof t));
577 spi_message_add_tail(&t, &m);
583 static int __devinit wm8776_spi_probe(struct spi_device *spi)
585 struct snd_soc_codec *codec;
586 struct wm8776_priv *wm8776;
588 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
592 codec = &wm8776->codec;
593 codec->control_data = spi;
594 codec->hw_write = (hw_write_t)wm8776_spi_write;
595 codec->dev = &spi->dev;
597 dev_set_drvdata(&spi->dev, wm8776);
599 return wm8776_register(wm8776, SND_SOC_SPI);
602 static int __devexit wm8776_spi_remove(struct spi_device *spi)
604 struct wm8776_priv *wm8776 = dev_get_drvdata(&spi->dev);
606 wm8776_unregister(wm8776);
612 static int wm8776_spi_suspend(struct spi_device *spi, pm_message_t msg)
614 return snd_soc_suspend_device(&spi->dev);
617 static int wm8776_spi_resume(struct spi_device *spi)
619 return snd_soc_resume_device(&spi->dev);
622 #define wm8776_spi_suspend NULL
623 #define wm8776_spi_resume NULL
626 static struct spi_driver wm8776_spi_driver = {
629 .bus = &spi_bus_type,
630 .owner = THIS_MODULE,
632 .probe = wm8776_spi_probe,
633 .suspend = wm8776_spi_suspend,
634 .resume = wm8776_spi_resume,
635 .remove = __devexit_p(wm8776_spi_remove),
637 #endif /* CONFIG_SPI_MASTER */
639 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
640 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
641 const struct i2c_device_id *id)
643 struct wm8776_priv *wm8776;
644 struct snd_soc_codec *codec;
646 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
650 codec = &wm8776->codec;
651 codec->hw_write = (hw_write_t)i2c_master_send;
653 i2c_set_clientdata(i2c, wm8776);
654 codec->control_data = i2c;
656 codec->dev = &i2c->dev;
658 return wm8776_register(wm8776, SND_SOC_I2C);
661 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
663 struct wm8776_priv *wm8776 = i2c_get_clientdata(client);
664 wm8776_unregister(wm8776);
669 static int wm8776_i2c_suspend(struct i2c_client *i2c, pm_message_t msg)
671 return snd_soc_suspend_device(&i2c->dev);
674 static int wm8776_i2c_resume(struct i2c_client *i2c)
676 return snd_soc_resume_device(&i2c->dev);
679 #define wm8776_i2c_suspend NULL
680 #define wm8776_i2c_resume NULL
683 static const struct i2c_device_id wm8776_i2c_id[] = {
687 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
689 static struct i2c_driver wm8776_i2c_driver = {
692 .owner = THIS_MODULE,
694 .probe = wm8776_i2c_probe,
695 .remove = __devexit_p(wm8776_i2c_remove),
696 .suspend = wm8776_i2c_suspend,
697 .resume = wm8776_i2c_resume,
698 .id_table = wm8776_i2c_id,
702 static int __init wm8776_modinit(void)
705 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
706 ret = i2c_add_driver(&wm8776_i2c_driver);
708 printk(KERN_ERR "Failed to register WM8776 I2C driver: %d\n",
712 #if defined(CONFIG_SPI_MASTER)
713 ret = spi_register_driver(&wm8776_spi_driver);
715 printk(KERN_ERR "Failed to register WM8776 SPI driver: %d\n",
721 module_init(wm8776_modinit);
723 static void __exit wm8776_exit(void)
725 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
726 i2c_del_driver(&wm8776_i2c_driver);
728 #if defined(CONFIG_SPI_MASTER)
729 spi_unregister_driver(&wm8776_spi_driver);
732 module_exit(wm8776_exit);
734 MODULE_DESCRIPTION("ASoC WM8776 driver");
735 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
736 MODULE_LICENSE("GPL");