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 */
56 * read wm8776 register cache
58 static inline unsigned int wm8776_read_reg_cache(struct snd_soc_codec *codec,
61 u16 *cache = codec->reg_cache;
62 if (reg >= WM8776_CACHEREGNUM)
68 * write wm8776 register cache
70 static inline void wm8776_write_reg_cache(struct snd_soc_codec *codec,
71 u16 reg, unsigned int value)
73 u16 *cache = codec->reg_cache;
74 if (reg >= WM8776_CACHEREGNUM)
80 * write to the WM8776 register space
82 static int wm8776_write(struct snd_soc_codec *codec, unsigned int reg,
87 data[0] = (reg << 1) | ((value >> 8) & 0x0001);
88 data[1] = value & 0x00ff;
90 wm8776_write_reg_cache(codec, reg, value);
91 if (codec->hw_write(codec->control_data, data, 2) == 2)
97 static int wm8776_reset(struct snd_soc_codec *codec)
99 return wm8776_write(codec, WM8776_RESET, 0);
102 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
103 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
104 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
106 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
107 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
109 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
111 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
113 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
115 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
117 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
118 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
119 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
122 static const struct snd_kcontrol_new inmix_controls[] = {
123 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
124 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
125 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
126 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
127 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
130 static const struct snd_kcontrol_new outmix_controls[] = {
131 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
132 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
133 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
136 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
137 SND_SOC_DAPM_INPUT("AUX"),
138 SND_SOC_DAPM_INPUT("AUX"),
140 SND_SOC_DAPM_INPUT("AIN1"),
141 SND_SOC_DAPM_INPUT("AIN2"),
142 SND_SOC_DAPM_INPUT("AIN3"),
143 SND_SOC_DAPM_INPUT("AIN4"),
144 SND_SOC_DAPM_INPUT("AIN5"),
146 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
147 inmix_controls, ARRAY_SIZE(inmix_controls)),
149 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
150 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
152 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
153 outmix_controls, ARRAY_SIZE(outmix_controls)),
155 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
157 SND_SOC_DAPM_OUTPUT("VOUT"),
159 SND_SOC_DAPM_OUTPUT("HPOUTL"),
160 SND_SOC_DAPM_OUTPUT("HPOUTR"),
163 static const struct snd_soc_dapm_route routes[] = {
164 { "Input Mixer", "AIN1 Switch", "AIN1" },
165 { "Input Mixer", "AIN2 Switch", "AIN2" },
166 { "Input Mixer", "AIN3 Switch", "AIN3" },
167 { "Input Mixer", "AIN4 Switch", "AIN4" },
168 { "Input Mixer", "AIN5 Switch", "AIN5" },
170 { "ADC", NULL, "Input Mixer" },
172 { "Output Mixer", "DAC Switch", "DAC" },
173 { "Output Mixer", "AUX Switch", "AUX" },
174 { "Output Mixer", "Bypass Switch", "Input Mixer" },
176 { "VOUT", NULL, "Output Mixer" },
178 { "Headphone PGA", NULL, "Output Mixer" },
180 { "HPOUTL", NULL, "Headphone PGA" },
181 { "HPOUTR", NULL, "Headphone PGA" },
184 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
186 struct snd_soc_codec *codec = dai->codec;
187 int reg, iface, master;
191 reg = WM8776_DACIFCTRL;
195 reg = WM8776_ADCIFCTRL;
204 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
205 case SND_SOC_DAIFMT_CBM_CFM:
207 case SND_SOC_DAIFMT_CBS_CFS:
214 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
215 case SND_SOC_DAIFMT_I2S:
218 case SND_SOC_DAIFMT_RIGHT_J:
220 case SND_SOC_DAIFMT_LEFT_J:
223 /* FIXME: CHECK A/B */
224 case SND_SOC_DAIFMT_DSP_A:
227 case SND_SOC_DAIFMT_DSP_B:
234 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
235 case SND_SOC_DAIFMT_NB_NF:
237 case SND_SOC_DAIFMT_IB_IF:
240 case SND_SOC_DAIFMT_IB_NF:
243 case SND_SOC_DAIFMT_NB_IF:
250 /* Finally, write out the values */
251 snd_soc_update_bits(codec, reg, 0xf, iface);
252 snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
257 static int mclk_ratios[] = {
266 static int wm8776_hw_params(struct snd_pcm_substream *substream,
267 struct snd_pcm_hw_params *params,
268 struct snd_soc_dai *dai)
270 struct snd_soc_codec *codec = dai->codec;
271 struct wm8776_priv *wm8776 = codec->private_data;
272 int iface_reg, iface;
273 int ratio_shift, master;
280 iface_reg = WM8776_DACIFCTRL;
285 iface_reg = WM8776_ADCIFCTRL;
294 /* Set word length */
295 switch (params_format(params)) {
296 case SNDRV_PCM_FORMAT_S16_LE:
298 case SNDRV_PCM_FORMAT_S20_3LE:
301 case SNDRV_PCM_FORMAT_S24_LE:
304 case SNDRV_PCM_FORMAT_S32_LE:
309 /* Only need to set MCLK/LRCLK ratio if we're master */
310 if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
311 for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
312 if (wm8776->sysclk[dai->id] / params_rate(params)
317 if (i == ARRAY_SIZE(mclk_ratios)) {
319 "Unable to configure MCLK ratio %d/%d\n",
320 wm8776->sysclk[dai->id], params_rate(params));
324 dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
326 snd_soc_update_bits(codec, WM8776_MSTRCTRL,
327 0x7 << ratio_shift, i << ratio_shift);
329 dev_dbg(codec->dev, "DAI in slave mode\n");
332 snd_soc_update_bits(codec, iface_reg, 0x30, iface);
337 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
339 struct snd_soc_codec *codec = dai->codec;
341 return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
344 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
345 int clk_id, unsigned int freq, int dir)
347 struct snd_soc_codec *codec = dai->codec;
348 struct wm8776_priv *wm8776 = codec->private_data;
350 BUG_ON(dai->id >= ARRAY_SIZE(wm8776->sysclk));
352 wm8776->sysclk[dai->id] = freq;
357 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
358 enum snd_soc_bias_level level)
361 case SND_SOC_BIAS_ON:
363 case SND_SOC_BIAS_PREPARE:
365 case SND_SOC_BIAS_STANDBY:
366 if (codec->bias_level == SND_SOC_BIAS_OFF) {
367 /* Disable the global powerdown; DAPM does the rest */
368 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
372 case SND_SOC_BIAS_OFF:
373 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
377 codec->bias_level = level;
381 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
382 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
383 SNDRV_PCM_RATE_96000)
386 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
387 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
389 static struct snd_soc_dai_ops wm8776_dac_ops = {
390 .digital_mute = wm8776_mute,
391 .hw_params = wm8776_hw_params,
392 .set_fmt = wm8776_set_fmt,
393 .set_sysclk = wm8776_set_sysclk,
396 static struct snd_soc_dai_ops wm8776_adc_ops = {
397 .hw_params = wm8776_hw_params,
398 .set_fmt = wm8776_set_fmt,
399 .set_sysclk = wm8776_set_sysclk,
402 struct snd_soc_dai wm8776_dai[] = {
404 .name = "WM8776 Playback",
405 .id = WM8776_DAI_DAC,
407 .stream_name = "Playback",
410 .rates = WM8776_RATES,
411 .formats = WM8776_FORMATS,
413 .ops = &wm8776_dac_ops,
416 .name = "WM8776 Capture",
417 .id = WM8776_DAI_ADC,
419 .stream_name = "Capture",
422 .rates = WM8776_RATES,
423 .formats = WM8776_FORMATS,
425 .ops = &wm8776_adc_ops,
428 EXPORT_SYMBOL_GPL(wm8776_dai);
431 static int wm8776_suspend(struct platform_device *pdev, pm_message_t state)
433 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
434 struct snd_soc_codec *codec = socdev->card->codec;
436 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
441 static int wm8776_resume(struct platform_device *pdev)
443 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
444 struct snd_soc_codec *codec = socdev->card->codec;
447 u16 *cache = codec->reg_cache;
449 /* Sync reg_cache with the hardware */
450 for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
451 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
452 data[1] = cache[i] & 0x00ff;
453 codec->hw_write(codec->control_data, data, 2);
456 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
461 #define wm8776_suspend NULL
462 #define wm8776_resume NULL
465 static int wm8776_probe(struct platform_device *pdev)
467 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
468 struct snd_soc_codec *codec;
471 if (wm8776_codec == NULL) {
472 dev_err(&pdev->dev, "Codec device not registered\n");
476 socdev->card->codec = wm8776_codec;
477 codec = wm8776_codec;
480 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
482 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
486 snd_soc_add_controls(codec, wm8776_snd_controls,
487 ARRAY_SIZE(wm8776_snd_controls));
488 snd_soc_dapm_new_controls(codec, wm8776_dapm_widgets,
489 ARRAY_SIZE(wm8776_dapm_widgets));
490 snd_soc_dapm_add_routes(codec, routes, ARRAY_SIZE(routes));
492 ret = snd_soc_init_card(socdev);
494 dev_err(codec->dev, "failed to register card: %d\n", ret);
501 snd_soc_free_pcms(socdev);
502 snd_soc_dapm_free(socdev);
507 /* power down chip */
508 static int wm8776_remove(struct platform_device *pdev)
510 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
512 snd_soc_free_pcms(socdev);
513 snd_soc_dapm_free(socdev);
518 struct snd_soc_codec_device soc_codec_dev_wm8776 = {
519 .probe = wm8776_probe,
520 .remove = wm8776_remove,
521 .suspend = wm8776_suspend,
522 .resume = wm8776_resume,
524 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8776);
526 static int wm8776_register(struct wm8776_priv *wm8776)
529 struct snd_soc_codec *codec = &wm8776->codec;
532 dev_err(codec->dev, "Another WM8776 is registered\n");
537 mutex_init(&codec->mutex);
538 INIT_LIST_HEAD(&codec->dapm_widgets);
539 INIT_LIST_HEAD(&codec->dapm_paths);
541 codec->private_data = wm8776;
542 codec->name = "WM8776";
543 codec->owner = THIS_MODULE;
544 codec->read = wm8776_read_reg_cache;
545 codec->write = wm8776_write;
546 codec->bias_level = SND_SOC_BIAS_OFF;
547 codec->set_bias_level = wm8776_set_bias_level;
548 codec->dai = wm8776_dai;
549 codec->num_dai = ARRAY_SIZE(wm8776_dai);
550 codec->reg_cache_size = WM8776_CACHEREGNUM;
551 codec->reg_cache = &wm8776->reg_cache;
553 memcpy(codec->reg_cache, wm8776_reg, sizeof(wm8776_reg));
555 for (i = 0; i < ARRAY_SIZE(wm8776_dai); i++)
556 wm8776_dai[i].dev = codec->dev;
558 ret = wm8776_reset(codec);
560 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
564 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
566 /* Latch the update bits; right channel only since we always
568 snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
569 snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
571 wm8776_codec = codec;
573 ret = snd_soc_register_codec(codec);
575 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
579 ret = snd_soc_register_dais(wm8776_dai, ARRAY_SIZE(wm8776_dai));
581 dev_err(codec->dev, "Failed to register DAIs: %d\n", ret);
588 snd_soc_unregister_codec(codec);
594 static void wm8776_unregister(struct wm8776_priv *wm8776)
596 wm8776_set_bias_level(&wm8776->codec, SND_SOC_BIAS_OFF);
597 snd_soc_unregister_dais(wm8776_dai, ARRAY_SIZE(wm8776_dai));
598 snd_soc_unregister_codec(&wm8776->codec);
603 #if defined(CONFIG_SPI_MASTER)
604 static int wm8776_spi_write(struct spi_device *spi, const char *data, int len)
606 struct spi_transfer t;
607 struct spi_message m;
616 spi_message_init(&m);
617 memset(&t, 0, (sizeof t));
622 spi_message_add_tail(&t, &m);
628 static int __devinit wm8776_spi_probe(struct spi_device *spi)
630 struct snd_soc_codec *codec;
631 struct wm8776_priv *wm8776;
633 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
637 codec = &wm8776->codec;
638 codec->control_data = spi;
639 codec->hw_write = (hw_write_t)wm8776_spi_write;
640 codec->dev = &spi->dev;
642 dev_set_drvdata(&spi->dev, wm8776);
644 return wm8776_register(wm8776);
647 static int __devexit wm8776_spi_remove(struct spi_device *spi)
649 struct wm8776_priv *wm8776 = dev_get_drvdata(&spi->dev);
651 wm8776_unregister(wm8776);
657 static int wm8776_spi_suspend(struct spi_device *spi, pm_message_t msg)
659 return snd_soc_suspend_device(&spi->dev);
662 static int wm8776_spi_resume(struct spi_device *spi)
664 return snd_soc_resume_device(&spi->dev);
667 #define wm8776_spi_suspend NULL
668 #define wm8776_spi_resume NULL
671 static struct spi_driver wm8776_spi_driver = {
674 .bus = &spi_bus_type,
675 .owner = THIS_MODULE,
677 .probe = wm8776_spi_probe,
678 .suspend = wm8776_spi_suspend,
679 .resume = wm8776_spi_resume,
680 .remove = __devexit_p(wm8776_spi_remove),
682 #endif /* CONFIG_SPI_MASTER */
684 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
685 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
686 const struct i2c_device_id *id)
688 struct wm8776_priv *wm8776;
689 struct snd_soc_codec *codec;
691 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
695 codec = &wm8776->codec;
696 codec->hw_write = (hw_write_t)i2c_master_send;
698 i2c_set_clientdata(i2c, wm8776);
699 codec->control_data = i2c;
701 codec->dev = &i2c->dev;
703 return wm8776_register(wm8776);
706 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
708 struct wm8776_priv *wm8776 = i2c_get_clientdata(client);
709 wm8776_unregister(wm8776);
714 static int wm8776_i2c_suspend(struct i2c_client *i2c, pm_message_t msg)
716 return snd_soc_suspend_device(&i2c->dev);
719 static int wm8776_i2c_resume(struct i2c_client *i2c)
721 return snd_soc_resume_device(&i2c->dev);
724 #define wm8776_i2c_suspend NULL
725 #define wm8776_i2c_resume NULL
728 static const struct i2c_device_id wm8776_i2c_id[] = {
732 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
734 static struct i2c_driver wm8776_i2c_driver = {
737 .owner = THIS_MODULE,
739 .probe = wm8776_i2c_probe,
740 .remove = __devexit_p(wm8776_i2c_remove),
741 .suspend = wm8776_i2c_suspend,
742 .resume = wm8776_i2c_resume,
743 .id_table = wm8776_i2c_id,
747 static int __init wm8776_modinit(void)
750 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
751 ret = i2c_add_driver(&wm8776_i2c_driver);
753 printk(KERN_ERR "Failed to register WM8776 I2C driver: %d\n",
757 #if defined(CONFIG_SPI_MASTER)
758 ret = spi_register_driver(&wm8776_spi_driver);
760 printk(KERN_ERR "Failed to register WM8776 SPI driver: %d\n",
766 module_init(wm8776_modinit);
768 static void __exit wm8776_exit(void)
770 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
771 i2c_del_driver(&wm8776_i2c_driver);
773 #if defined(CONFIG_SPI_MASTER)
774 spi_unregister_driver(&wm8776_spi_driver);
777 module_exit(wm8776_exit);
779 MODULE_DESCRIPTION("ASoC WM8776 driver");
780 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
781 MODULE_LICENSE("GPL");