2 * wm8731.c -- WM8731 ALSA SoC Audio driver
4 * Copyright 2005 Openedhand Ltd.
6 * Author: Richard Purdie <richard@openedhand.com>
8 * Based on wm8753.c by Liam Girdwood
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
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>
32 static struct snd_soc_codec *wm8731_codec;
33 struct snd_soc_codec_device soc_codec_dev_wm8731;
35 /* codec private data */
37 struct snd_soc_codec codec;
38 u16 reg_cache[WM8731_CACHEREGNUM];
42 #ifdef CONFIG_SPI_MASTER
43 static int wm8731_spi_write(struct spi_device *spi, const char *data, int len);
47 * wm8731 register cache
48 * We can't read the WM8731 register space when we are
49 * using 2 wire for device control, so we cache them instead.
50 * There is no point in caching the reset register
52 static const u16 wm8731_reg[WM8731_CACHEREGNUM] = {
53 0x0097, 0x0097, 0x0079, 0x0079,
54 0x000a, 0x0008, 0x009f, 0x000a,
59 * read wm8731 register cache
61 static inline unsigned int wm8731_read_reg_cache(struct snd_soc_codec *codec,
64 u16 *cache = codec->reg_cache;
65 if (reg == WM8731_RESET)
67 if (reg >= WM8731_CACHEREGNUM)
73 * write wm8731 register cache
75 static inline void wm8731_write_reg_cache(struct snd_soc_codec *codec,
76 u16 reg, unsigned int value)
78 u16 *cache = codec->reg_cache;
79 if (reg >= WM8731_CACHEREGNUM)
85 * write to the WM8731 register space
87 static int wm8731_write(struct snd_soc_codec *codec, unsigned int reg,
93 * D15..D9 WM8731 register offset
94 * D8...D0 register data
96 data[0] = (reg << 1) | ((value >> 8) & 0x0001);
97 data[1] = value & 0x00ff;
99 wm8731_write_reg_cache(codec, reg, value);
100 if (codec->hw_write(codec->control_data, data, 2) == 2)
106 #define wm8731_reset(c) wm8731_write(c, WM8731_RESET, 0)
108 static const char *wm8731_input_select[] = {"Line In", "Mic"};
109 static const char *wm8731_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
111 static const struct soc_enum wm8731_enum[] = {
112 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select),
113 SOC_ENUM_SINGLE(WM8731_APDIGI, 1, 4, wm8731_deemph),
116 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
118 SOC_DOUBLE_R("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
120 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
123 SOC_DOUBLE_R("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0),
124 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
126 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA, 0, 1, 0),
127 SOC_SINGLE("Capture Mic Switch", WM8731_APANA, 1, 1, 1),
129 SOC_SINGLE("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1),
131 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
132 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
134 SOC_ENUM("Playback De-emphasis", wm8731_enum[1]),
138 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
139 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
140 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
141 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
145 static const struct snd_kcontrol_new wm8731_input_mux_controls =
146 SOC_DAPM_ENUM("Input Select", wm8731_enum[0]);
148 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
149 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
150 &wm8731_output_mixer_controls[0],
151 ARRAY_SIZE(wm8731_output_mixer_controls)),
152 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
153 SND_SOC_DAPM_OUTPUT("LOUT"),
154 SND_SOC_DAPM_OUTPUT("LHPOUT"),
155 SND_SOC_DAPM_OUTPUT("ROUT"),
156 SND_SOC_DAPM_OUTPUT("RHPOUT"),
157 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
158 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
159 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
160 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
161 SND_SOC_DAPM_INPUT("MICIN"),
162 SND_SOC_DAPM_INPUT("RLINEIN"),
163 SND_SOC_DAPM_INPUT("LLINEIN"),
166 static const struct snd_soc_dapm_route intercon[] = {
168 {"Output Mixer", "Line Bypass Switch", "Line Input"},
169 {"Output Mixer", "HiFi Playback Switch", "DAC"},
170 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
173 {"RHPOUT", NULL, "Output Mixer"},
174 {"ROUT", NULL, "Output Mixer"},
175 {"LHPOUT", NULL, "Output Mixer"},
176 {"LOUT", NULL, "Output Mixer"},
179 {"Input Mux", "Line In", "Line Input"},
180 {"Input Mux", "Mic", "Mic Bias"},
181 {"ADC", NULL, "Input Mux"},
184 {"Line Input", NULL, "LLINEIN"},
185 {"Line Input", NULL, "RLINEIN"},
186 {"Mic Bias", NULL, "MICIN"},
189 static int wm8731_add_widgets(struct snd_soc_codec *codec)
191 snd_soc_dapm_new_controls(codec, wm8731_dapm_widgets,
192 ARRAY_SIZE(wm8731_dapm_widgets));
194 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
196 snd_soc_dapm_new_widgets(codec);
209 /* codec mclk clock divider coefficients */
210 static const struct _coeff_div coeff_div[] = {
212 {12288000, 48000, 256, 0x0, 0x0, 0x0},
213 {18432000, 48000, 384, 0x0, 0x1, 0x0},
214 {12000000, 48000, 250, 0x0, 0x0, 0x1},
217 {12288000, 32000, 384, 0x6, 0x0, 0x0},
218 {18432000, 32000, 576, 0x6, 0x1, 0x0},
219 {12000000, 32000, 375, 0x6, 0x0, 0x1},
222 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
223 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
224 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
225 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
226 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
229 {12288000, 96000, 128, 0x7, 0x0, 0x0},
230 {18432000, 96000, 192, 0x7, 0x1, 0x0},
231 {12000000, 96000, 125, 0x7, 0x0, 0x1},
234 {11289600, 44100, 256, 0x8, 0x0, 0x0},
235 {16934400, 44100, 384, 0x8, 0x1, 0x0},
236 {12000000, 44100, 272, 0x8, 0x1, 0x1},
239 {11289600, 88200, 128, 0xf, 0x0, 0x0},
240 {16934400, 88200, 192, 0xf, 0x1, 0x0},
241 {12000000, 88200, 136, 0xf, 0x1, 0x1},
244 static inline int get_coeff(int mclk, int rate)
248 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
249 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
255 static int wm8731_hw_params(struct snd_pcm_substream *substream,
256 struct snd_pcm_hw_params *params,
257 struct snd_soc_dai *dai)
259 struct snd_soc_pcm_runtime *rtd = substream->private_data;
260 struct snd_soc_device *socdev = rtd->socdev;
261 struct snd_soc_codec *codec = socdev->card->codec;
262 struct wm8731_priv *wm8731 = codec->private_data;
263 u16 iface = wm8731_read_reg_cache(codec, WM8731_IFACE) & 0xfff3;
264 int i = get_coeff(wm8731->sysclk, params_rate(params));
265 u16 srate = (coeff_div[i].sr << 2) |
266 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
268 wm8731_write(codec, WM8731_SRATE, srate);
271 switch (params_format(params)) {
272 case SNDRV_PCM_FORMAT_S16_LE:
274 case SNDRV_PCM_FORMAT_S20_3LE:
277 case SNDRV_PCM_FORMAT_S24_LE:
282 wm8731_write(codec, WM8731_IFACE, iface);
286 static int wm8731_pcm_prepare(struct snd_pcm_substream *substream,
287 struct snd_soc_dai *dai)
289 struct snd_soc_pcm_runtime *rtd = substream->private_data;
290 struct snd_soc_device *socdev = rtd->socdev;
291 struct snd_soc_codec *codec = socdev->card->codec;
294 wm8731_write(codec, WM8731_ACTIVE, 0x0001);
299 static void wm8731_shutdown(struct snd_pcm_substream *substream,
300 struct snd_soc_dai *dai)
302 struct snd_soc_pcm_runtime *rtd = substream->private_data;
303 struct snd_soc_device *socdev = rtd->socdev;
304 struct snd_soc_codec *codec = socdev->card->codec;
307 if (!codec->active) {
309 wm8731_write(codec, WM8731_ACTIVE, 0x0);
313 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
315 struct snd_soc_codec *codec = dai->codec;
316 u16 mute_reg = wm8731_read_reg_cache(codec, WM8731_APDIGI) & 0xfff7;
319 wm8731_write(codec, WM8731_APDIGI, mute_reg | 0x8);
321 wm8731_write(codec, WM8731_APDIGI, mute_reg);
325 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
326 int clk_id, unsigned int freq, int dir)
328 struct snd_soc_codec *codec = codec_dai->codec;
329 struct wm8731_priv *wm8731 = codec->private_data;
337 wm8731->sysclk = freq;
344 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
347 struct snd_soc_codec *codec = codec_dai->codec;
350 /* set master/slave audio interface */
351 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
352 case SND_SOC_DAIFMT_CBM_CFM:
355 case SND_SOC_DAIFMT_CBS_CFS:
361 /* interface format */
362 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
363 case SND_SOC_DAIFMT_I2S:
366 case SND_SOC_DAIFMT_RIGHT_J:
368 case SND_SOC_DAIFMT_LEFT_J:
371 case SND_SOC_DAIFMT_DSP_A:
374 case SND_SOC_DAIFMT_DSP_B:
381 /* clock inversion */
382 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
383 case SND_SOC_DAIFMT_NB_NF:
385 case SND_SOC_DAIFMT_IB_IF:
388 case SND_SOC_DAIFMT_IB_NF:
391 case SND_SOC_DAIFMT_NB_IF:
399 wm8731_write(codec, WM8731_IFACE, iface);
403 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
404 enum snd_soc_bias_level level)
409 case SND_SOC_BIAS_ON:
411 case SND_SOC_BIAS_PREPARE:
413 case SND_SOC_BIAS_STANDBY:
414 /* Clear PWROFF, gate CLKOUT, everything else as-is */
415 reg = wm8731_read_reg_cache(codec, WM8731_PWR) & 0xff7f;
416 wm8731_write(codec, WM8731_PWR, reg | 0x0040);
418 case SND_SOC_BIAS_OFF:
419 wm8731_write(codec, WM8731_ACTIVE, 0x0);
420 wm8731_write(codec, WM8731_PWR, 0xffff);
423 codec->bias_level = level;
427 #define WM8731_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
428 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
429 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
430 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
431 SNDRV_PCM_RATE_96000)
433 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
434 SNDRV_PCM_FMTBIT_S24_LE)
436 static struct snd_soc_dai_ops wm8731_dai_ops = {
437 .prepare = wm8731_pcm_prepare,
438 .hw_params = wm8731_hw_params,
439 .shutdown = wm8731_shutdown,
440 .digital_mute = wm8731_mute,
441 .set_sysclk = wm8731_set_dai_sysclk,
442 .set_fmt = wm8731_set_dai_fmt,
445 struct snd_soc_dai wm8731_dai = {
448 .stream_name = "Playback",
451 .rates = WM8731_RATES,
452 .formats = WM8731_FORMATS,},
454 .stream_name = "Capture",
457 .rates = WM8731_RATES,
458 .formats = WM8731_FORMATS,},
459 .ops = &wm8731_dai_ops,
461 EXPORT_SYMBOL_GPL(wm8731_dai);
463 static int wm8731_suspend(struct platform_device *pdev, pm_message_t state)
465 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
466 struct snd_soc_codec *codec = socdev->card->codec;
468 wm8731_write(codec, WM8731_ACTIVE, 0x0);
469 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
473 static int wm8731_resume(struct platform_device *pdev)
475 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
476 struct snd_soc_codec *codec = socdev->card->codec;
479 u16 *cache = codec->reg_cache;
481 /* Sync reg_cache with the hardware */
482 for (i = 0; i < ARRAY_SIZE(wm8731_reg); i++) {
483 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
484 data[1] = cache[i] & 0x00ff;
485 codec->hw_write(codec->control_data, data, 2);
487 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
488 wm8731_set_bias_level(codec, codec->suspend_bias_level);
492 static int wm8731_probe(struct platform_device *pdev)
494 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
495 struct snd_soc_codec *codec;
498 if (wm8731_codec == NULL) {
499 dev_err(&pdev->dev, "Codec device not registered\n");
503 socdev->card->codec = wm8731_codec;
504 codec = wm8731_codec;
507 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
509 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
513 snd_soc_add_controls(codec, wm8731_snd_controls,
514 ARRAY_SIZE(wm8731_snd_controls));
515 wm8731_add_widgets(codec);
516 ret = snd_soc_init_card(socdev);
518 dev_err(codec->dev, "failed to register card: %d\n", ret);
525 snd_soc_free_pcms(socdev);
526 snd_soc_dapm_free(socdev);
531 /* power down chip */
532 static int wm8731_remove(struct platform_device *pdev)
534 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
536 snd_soc_free_pcms(socdev);
537 snd_soc_dapm_free(socdev);
542 struct snd_soc_codec_device soc_codec_dev_wm8731 = {
543 .probe = wm8731_probe,
544 .remove = wm8731_remove,
545 .suspend = wm8731_suspend,
546 .resume = wm8731_resume,
548 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731);
550 static int wm8731_register(struct wm8731_priv *wm8731)
553 struct snd_soc_codec *codec = &wm8731->codec;
557 dev_err(codec->dev, "Another WM8731 is registered\n");
561 mutex_init(&codec->mutex);
562 INIT_LIST_HEAD(&codec->dapm_widgets);
563 INIT_LIST_HEAD(&codec->dapm_paths);
565 codec->private_data = wm8731;
566 codec->name = "WM8731";
567 codec->owner = THIS_MODULE;
568 codec->read = wm8731_read_reg_cache;
569 codec->write = wm8731_write;
570 codec->bias_level = SND_SOC_BIAS_OFF;
571 codec->set_bias_level = wm8731_set_bias_level;
572 codec->dai = &wm8731_dai;
574 codec->reg_cache_size = WM8731_CACHEREGNUM;
575 codec->reg_cache = &wm8731->reg_cache;
577 memcpy(codec->reg_cache, wm8731_reg, sizeof(wm8731_reg));
579 ret = wm8731_reset(codec);
581 dev_err(codec->dev, "Failed to issue reset\n");
585 wm8731_dai.dev = codec->dev;
587 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
589 /* Latch the update bits */
590 reg = wm8731_read_reg_cache(codec, WM8731_LOUT1V);
591 wm8731_write(codec, WM8731_LOUT1V, reg & ~0x0100);
592 reg = wm8731_read_reg_cache(codec, WM8731_ROUT1V);
593 wm8731_write(codec, WM8731_ROUT1V, reg & ~0x0100);
594 reg = wm8731_read_reg_cache(codec, WM8731_LINVOL);
595 wm8731_write(codec, WM8731_LINVOL, reg & ~0x0100);
596 reg = wm8731_read_reg_cache(codec, WM8731_RINVOL);
597 wm8731_write(codec, WM8731_RINVOL, reg & ~0x0100);
599 /* Disable bypass path by default */
600 reg = wm8731_read_reg_cache(codec, WM8731_APANA);
601 wm8731_write(codec, WM8731_APANA, reg & ~0x4);
603 wm8731_codec = codec;
605 ret = snd_soc_register_codec(codec);
607 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
611 ret = snd_soc_register_dai(&wm8731_dai);
613 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
614 snd_soc_unregister_codec(codec);
621 static void wm8731_unregister(struct wm8731_priv *wm8731)
623 wm8731_set_bias_level(&wm8731->codec, SND_SOC_BIAS_OFF);
624 snd_soc_unregister_dai(&wm8731_dai);
625 snd_soc_unregister_codec(&wm8731->codec);
630 #if defined(CONFIG_SPI_MASTER)
631 static int wm8731_spi_write(struct spi_device *spi, const char *data, int len)
633 struct spi_transfer t;
634 struct spi_message m;
643 spi_message_init(&m);
644 memset(&t, 0, (sizeof t));
649 spi_message_add_tail(&t, &m);
655 static int __devinit wm8731_spi_probe(struct spi_device *spi)
657 struct snd_soc_codec *codec;
658 struct wm8731_priv *wm8731;
660 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
664 codec = &wm8731->codec;
665 codec->control_data = spi;
666 codec->hw_write = (hw_write_t)wm8731_spi_write;
667 codec->dev = &spi->dev;
669 spi->dev.driver_data = wm8731;
671 return wm8731_register(wm8731);
674 static int __devexit wm8731_spi_remove(struct spi_device *spi)
676 struct wm8731_priv *wm8731 = spi->dev.driver_data;
678 wm8731_unregister(wm8731);
683 static struct spi_driver wm8731_spi_driver = {
686 .bus = &spi_bus_type,
687 .owner = THIS_MODULE,
689 .probe = wm8731_spi_probe,
690 .remove = __devexit_p(wm8731_spi_remove),
692 #endif /* CONFIG_SPI_MASTER */
694 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
695 static __devinit int wm8731_i2c_probe(struct i2c_client *i2c,
696 const struct i2c_device_id *id)
698 struct wm8731_priv *wm8731;
699 struct snd_soc_codec *codec;
701 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
705 codec = &wm8731->codec;
706 codec->hw_write = (hw_write_t)i2c_master_send;
708 i2c_set_clientdata(i2c, wm8731);
709 codec->control_data = i2c;
711 codec->dev = &i2c->dev;
713 return wm8731_register(wm8731);
716 static __devexit int wm8731_i2c_remove(struct i2c_client *client)
718 struct wm8731_priv *wm8731 = i2c_get_clientdata(client);
719 wm8731_unregister(wm8731);
723 static const struct i2c_device_id wm8731_i2c_id[] = {
727 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
729 static struct i2c_driver wm8731_i2c_driver = {
731 .name = "WM8731 I2C Codec",
732 .owner = THIS_MODULE,
734 .probe = wm8731_i2c_probe,
735 .remove = __devexit_p(wm8731_i2c_remove),
736 .id_table = wm8731_i2c_id,
740 static int __init wm8731_modinit(void)
743 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
744 ret = i2c_add_driver(&wm8731_i2c_driver);
746 printk(KERN_ERR "Failed to register WM8731 I2C driver: %d\n",
750 #if defined(CONFIG_SPI_MASTER)
751 ret = spi_register_driver(&wm8731_spi_driver);
753 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
759 module_init(wm8731_modinit);
761 static void __exit wm8731_exit(void)
763 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
764 i2c_del_driver(&wm8731_i2c_driver);
766 #if defined(CONFIG_SPI_MASTER)
767 spi_unregister_driver(&wm8731_spi_driver);
770 module_exit(wm8731_exit);
772 MODULE_DESCRIPTION("ASoC WM8731 driver");
773 MODULE_AUTHOR("Richard Purdie");
774 MODULE_LICENSE("GPL");