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 static struct snd_soc_codec *wm8776_codec;
35 struct snd_soc_codec_device soc_codec_dev_wm8776;
37 /* codec private data */
39 struct snd_soc_codec codec;
40 u16 reg_cache[WM8776_CACHEREGNUM];
44 #ifdef CONFIG_SPI_MASTER
45 static int wm8776_spi_write(struct spi_device *spi, const char *data, int len);
48 static const u16 wm8776_reg[WM8776_CACHEREGNUM] = {
49 0x79, 0x79, 0x79, 0xff, 0xff, /* 4 */
50 0xff, 0x00, 0x90, 0x00, 0x00, /* 9 */
51 0x22, 0x22, 0x22, 0x08, 0xcf, /* 14 */
52 0xcf, 0x7b, 0x00, 0x32, 0x00, /* 19 */
56 static int wm8776_reset(struct snd_soc_codec *codec)
58 return snd_soc_write(codec, WM8776_RESET, 0);
61 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
62 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
63 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
65 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
66 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
68 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
70 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
72 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
74 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
76 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
77 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
78 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
81 static const struct snd_kcontrol_new inmix_controls[] = {
82 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
83 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
84 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
85 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
86 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
89 static const struct snd_kcontrol_new outmix_controls[] = {
90 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
91 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
92 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
95 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
96 SND_SOC_DAPM_INPUT("AUX"),
98 SND_SOC_DAPM_INPUT("AIN1"),
99 SND_SOC_DAPM_INPUT("AIN2"),
100 SND_SOC_DAPM_INPUT("AIN3"),
101 SND_SOC_DAPM_INPUT("AIN4"),
102 SND_SOC_DAPM_INPUT("AIN5"),
104 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
105 inmix_controls, ARRAY_SIZE(inmix_controls)),
107 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
108 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
110 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
111 outmix_controls, ARRAY_SIZE(outmix_controls)),
113 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
115 SND_SOC_DAPM_OUTPUT("VOUT"),
117 SND_SOC_DAPM_OUTPUT("HPOUTL"),
118 SND_SOC_DAPM_OUTPUT("HPOUTR"),
121 static const struct snd_soc_dapm_route routes[] = {
122 { "Input Mixer", "AIN1 Switch", "AIN1" },
123 { "Input Mixer", "AIN2 Switch", "AIN2" },
124 { "Input Mixer", "AIN3 Switch", "AIN3" },
125 { "Input Mixer", "AIN4 Switch", "AIN4" },
126 { "Input Mixer", "AIN5 Switch", "AIN5" },
128 { "ADC", NULL, "Input Mixer" },
130 { "Output Mixer", "DAC Switch", "DAC" },
131 { "Output Mixer", "AUX Switch", "AUX" },
132 { "Output Mixer", "Bypass Switch", "Input Mixer" },
134 { "VOUT", NULL, "Output Mixer" },
136 { "Headphone PGA", NULL, "Output Mixer" },
138 { "HPOUTL", NULL, "Headphone PGA" },
139 { "HPOUTR", NULL, "Headphone PGA" },
142 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
144 struct snd_soc_codec *codec = dai->codec;
145 int reg, iface, master;
149 reg = WM8776_DACIFCTRL;
153 reg = WM8776_ADCIFCTRL;
162 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
163 case SND_SOC_DAIFMT_CBM_CFM:
165 case SND_SOC_DAIFMT_CBS_CFS:
172 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
173 case SND_SOC_DAIFMT_I2S:
176 case SND_SOC_DAIFMT_RIGHT_J:
178 case SND_SOC_DAIFMT_LEFT_J:
181 /* FIXME: CHECK A/B */
182 case SND_SOC_DAIFMT_DSP_A:
185 case SND_SOC_DAIFMT_DSP_B:
192 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
193 case SND_SOC_DAIFMT_NB_NF:
195 case SND_SOC_DAIFMT_IB_IF:
198 case SND_SOC_DAIFMT_IB_NF:
201 case SND_SOC_DAIFMT_NB_IF:
208 /* Finally, write out the values */
209 snd_soc_update_bits(codec, reg, 0xf, iface);
210 snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
215 static int mclk_ratios[] = {
224 static int wm8776_hw_params(struct snd_pcm_substream *substream,
225 struct snd_pcm_hw_params *params,
226 struct snd_soc_dai *dai)
228 struct snd_soc_codec *codec = dai->codec;
229 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
230 int iface_reg, iface;
231 int ratio_shift, master;
238 iface_reg = WM8776_DACIFCTRL;
243 iface_reg = WM8776_ADCIFCTRL;
252 /* Set word length */
253 switch (params_format(params)) {
254 case SNDRV_PCM_FORMAT_S16_LE:
256 case SNDRV_PCM_FORMAT_S20_3LE:
259 case SNDRV_PCM_FORMAT_S24_LE:
262 case SNDRV_PCM_FORMAT_S32_LE:
267 /* Only need to set MCLK/LRCLK ratio if we're master */
268 if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
269 for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
270 if (wm8776->sysclk[dai->id] / params_rate(params)
275 if (i == ARRAY_SIZE(mclk_ratios)) {
277 "Unable to configure MCLK ratio %d/%d\n",
278 wm8776->sysclk[dai->id], params_rate(params));
282 dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
284 snd_soc_update_bits(codec, WM8776_MSTRCTRL,
285 0x7 << ratio_shift, i << ratio_shift);
287 dev_dbg(codec->dev, "DAI in slave mode\n");
290 snd_soc_update_bits(codec, iface_reg, 0x30, iface);
295 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
297 struct snd_soc_codec *codec = dai->codec;
299 return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
302 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
303 int clk_id, unsigned int freq, int dir)
305 struct snd_soc_codec *codec = dai->codec;
306 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
308 BUG_ON(dai->id >= ARRAY_SIZE(wm8776->sysclk));
310 wm8776->sysclk[dai->id] = freq;
315 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
316 enum snd_soc_bias_level level)
319 case SND_SOC_BIAS_ON:
321 case SND_SOC_BIAS_PREPARE:
323 case SND_SOC_BIAS_STANDBY:
324 if (codec->bias_level == SND_SOC_BIAS_OFF) {
325 /* Disable the global powerdown; DAPM does the rest */
326 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
330 case SND_SOC_BIAS_OFF:
331 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
335 codec->bias_level = level;
339 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
340 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
341 SNDRV_PCM_RATE_96000)
344 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
345 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
347 static struct snd_soc_dai_ops wm8776_dac_ops = {
348 .digital_mute = wm8776_mute,
349 .hw_params = wm8776_hw_params,
350 .set_fmt = wm8776_set_fmt,
351 .set_sysclk = wm8776_set_sysclk,
354 static struct snd_soc_dai_ops wm8776_adc_ops = {
355 .hw_params = wm8776_hw_params,
356 .set_fmt = wm8776_set_fmt,
357 .set_sysclk = wm8776_set_sysclk,
360 struct snd_soc_dai wm8776_dai[] = {
362 .name = "WM8776 Playback",
363 .id = WM8776_DAI_DAC,
365 .stream_name = "Playback",
368 .rates = WM8776_RATES,
369 .formats = WM8776_FORMATS,
371 .ops = &wm8776_dac_ops,
374 .name = "WM8776 Capture",
375 .id = WM8776_DAI_ADC,
377 .stream_name = "Capture",
380 .rates = WM8776_RATES,
381 .formats = WM8776_FORMATS,
383 .ops = &wm8776_adc_ops,
386 EXPORT_SYMBOL_GPL(wm8776_dai);
389 static int wm8776_suspend(struct platform_device *pdev, pm_message_t state)
391 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
392 struct snd_soc_codec *codec = socdev->card->codec;
394 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
399 static int wm8776_resume(struct platform_device *pdev)
401 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
402 struct snd_soc_codec *codec = socdev->card->codec;
405 u16 *cache = codec->reg_cache;
407 /* Sync reg_cache with the hardware */
408 for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
409 if (cache[i] == wm8776_reg[i])
411 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
412 data[1] = cache[i] & 0x00ff;
413 codec->hw_write(codec->control_data, data, 2);
416 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
421 #define wm8776_suspend NULL
422 #define wm8776_resume NULL
425 static int wm8776_probe(struct platform_device *pdev)
427 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
428 struct snd_soc_codec *codec;
431 if (wm8776_codec == NULL) {
432 dev_err(&pdev->dev, "Codec device not registered\n");
436 socdev->card->codec = wm8776_codec;
437 codec = wm8776_codec;
440 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
442 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
446 snd_soc_add_controls(codec, wm8776_snd_controls,
447 ARRAY_SIZE(wm8776_snd_controls));
448 snd_soc_dapm_new_controls(codec, wm8776_dapm_widgets,
449 ARRAY_SIZE(wm8776_dapm_widgets));
450 snd_soc_dapm_add_routes(codec, routes, ARRAY_SIZE(routes));
458 /* power down chip */
459 static int wm8776_remove(struct platform_device *pdev)
461 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
463 snd_soc_free_pcms(socdev);
464 snd_soc_dapm_free(socdev);
469 struct snd_soc_codec_device soc_codec_dev_wm8776 = {
470 .probe = wm8776_probe,
471 .remove = wm8776_remove,
472 .suspend = wm8776_suspend,
473 .resume = wm8776_resume,
475 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8776);
477 static int wm8776_register(struct wm8776_priv *wm8776,
478 enum snd_soc_control_type control)
481 struct snd_soc_codec *codec = &wm8776->codec;
484 dev_err(codec->dev, "Another WM8776 is registered\n");
489 mutex_init(&codec->mutex);
490 INIT_LIST_HEAD(&codec->dapm_widgets);
491 INIT_LIST_HEAD(&codec->dapm_paths);
493 snd_soc_codec_set_drvdata(codec, wm8776);
494 codec->name = "WM8776";
495 codec->owner = THIS_MODULE;
496 codec->bias_level = SND_SOC_BIAS_OFF;
497 codec->set_bias_level = wm8776_set_bias_level;
498 codec->dai = wm8776_dai;
499 codec->num_dai = ARRAY_SIZE(wm8776_dai);
500 codec->reg_cache_size = WM8776_CACHEREGNUM;
501 codec->reg_cache = &wm8776->reg_cache;
503 memcpy(codec->reg_cache, wm8776_reg, sizeof(wm8776_reg));
505 ret = snd_soc_codec_set_cache_io(codec, 7, 9, control);
507 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
511 for (i = 0; i < ARRAY_SIZE(wm8776_dai); i++)
512 wm8776_dai[i].dev = codec->dev;
514 ret = wm8776_reset(codec);
516 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
520 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
522 /* Latch the update bits; right channel only since we always
524 snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
525 snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
527 wm8776_codec = codec;
529 ret = snd_soc_register_codec(codec);
531 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
535 ret = snd_soc_register_dais(wm8776_dai, ARRAY_SIZE(wm8776_dai));
537 dev_err(codec->dev, "Failed to register DAIs: %d\n", ret);
544 snd_soc_unregister_codec(codec);
550 static void wm8776_unregister(struct wm8776_priv *wm8776)
552 wm8776_set_bias_level(&wm8776->codec, SND_SOC_BIAS_OFF);
553 snd_soc_unregister_dais(wm8776_dai, ARRAY_SIZE(wm8776_dai));
554 snd_soc_unregister_codec(&wm8776->codec);
559 #if defined(CONFIG_SPI_MASTER)
560 static int wm8776_spi_write(struct spi_device *spi, const char *data, int len)
562 struct spi_transfer t;
563 struct spi_message m;
572 spi_message_init(&m);
573 memset(&t, 0, (sizeof t));
578 spi_message_add_tail(&t, &m);
584 static int __devinit wm8776_spi_probe(struct spi_device *spi)
586 struct snd_soc_codec *codec;
587 struct wm8776_priv *wm8776;
589 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
593 codec = &wm8776->codec;
594 codec->control_data = spi;
595 codec->hw_write = (hw_write_t)wm8776_spi_write;
596 codec->dev = &spi->dev;
598 dev_set_drvdata(&spi->dev, wm8776);
600 return wm8776_register(wm8776, SND_SOC_SPI);
603 static int __devexit wm8776_spi_remove(struct spi_device *spi)
605 struct wm8776_priv *wm8776 = dev_get_drvdata(&spi->dev);
607 wm8776_unregister(wm8776);
612 static struct spi_driver wm8776_spi_driver = {
615 .bus = &spi_bus_type,
616 .owner = THIS_MODULE,
618 .probe = wm8776_spi_probe,
619 .remove = __devexit_p(wm8776_spi_remove),
621 #endif /* CONFIG_SPI_MASTER */
623 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
624 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
625 const struct i2c_device_id *id)
627 struct wm8776_priv *wm8776;
628 struct snd_soc_codec *codec;
630 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
634 codec = &wm8776->codec;
635 codec->hw_write = (hw_write_t)i2c_master_send;
637 i2c_set_clientdata(i2c, wm8776);
638 codec->control_data = i2c;
640 codec->dev = &i2c->dev;
642 return wm8776_register(wm8776, SND_SOC_I2C);
645 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
647 struct wm8776_priv *wm8776 = i2c_get_clientdata(client);
648 wm8776_unregister(wm8776);
652 static const struct i2c_device_id wm8776_i2c_id[] = {
656 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
658 static struct i2c_driver wm8776_i2c_driver = {
661 .owner = THIS_MODULE,
663 .probe = wm8776_i2c_probe,
664 .remove = __devexit_p(wm8776_i2c_remove),
665 .id_table = wm8776_i2c_id,
669 static int __init wm8776_modinit(void)
672 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
673 ret = i2c_add_driver(&wm8776_i2c_driver);
675 printk(KERN_ERR "Failed to register WM8776 I2C driver: %d\n",
679 #if defined(CONFIG_SPI_MASTER)
680 ret = spi_register_driver(&wm8776_spi_driver);
682 printk(KERN_ERR "Failed to register WM8776 SPI driver: %d\n",
688 module_init(wm8776_modinit);
690 static void __exit wm8776_exit(void)
692 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
693 i2c_del_driver(&wm8776_i2c_driver);
695 #if defined(CONFIG_SPI_MASTER)
696 spi_unregister_driver(&wm8776_spi_driver);
699 module_exit(wm8776_exit);
701 MODULE_DESCRIPTION("ASoC WM8776 driver");
702 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
703 MODULE_LICENSE("GPL");