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>
29 #include <sound/tlv.h>
33 static struct snd_soc_codec *wm8731_codec;
34 struct snd_soc_codec_device soc_codec_dev_wm8731;
36 /* codec private data */
38 struct snd_soc_codec codec;
39 u16 reg_cache[WM8731_CACHEREGNUM];
43 #ifdef CONFIG_SPI_MASTER
44 static int wm8731_spi_write(struct spi_device *spi, const char *data, int len);
48 * wm8731 register cache
49 * We can't read the WM8731 register space when we are
50 * using 2 wire for device control, so we cache them instead.
51 * There is no point in caching the reset register
53 static const u16 wm8731_reg[WM8731_CACHEREGNUM] = {
54 0x0097, 0x0097, 0x0079, 0x0079,
55 0x000a, 0x0008, 0x009f, 0x000a,
59 #define wm8731_reset(c) snd_soc_write(c, WM8731_RESET, 0)
61 static const char *wm8731_input_select[] = {"Line In", "Mic"};
62 static const char *wm8731_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
64 static const struct soc_enum wm8731_enum[] = {
65 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select),
66 SOC_ENUM_SINGLE(WM8731_APDIGI, 1, 4, wm8731_deemph),
69 static const DECLARE_TLV_DB_SCALE(in_tlv, -3450, 150, 0);
70 static const DECLARE_TLV_DB_SCALE(sidetone_tlv, -1500, 300, 0);
71 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
73 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
75 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
77 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
80 SOC_DOUBLE_R_TLV("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0,
82 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
84 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA, 0, 1, 0),
85 SOC_SINGLE("Mic Capture Switch", WM8731_APANA, 1, 1, 1),
87 SOC_SINGLE_TLV("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1,
90 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
91 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
93 SOC_ENUM("Playback De-emphasis", wm8731_enum[1]),
97 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
98 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
99 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
100 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
104 static const struct snd_kcontrol_new wm8731_input_mux_controls =
105 SOC_DAPM_ENUM("Input Select", wm8731_enum[0]);
107 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
108 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
109 &wm8731_output_mixer_controls[0],
110 ARRAY_SIZE(wm8731_output_mixer_controls)),
111 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
112 SND_SOC_DAPM_OUTPUT("LOUT"),
113 SND_SOC_DAPM_OUTPUT("LHPOUT"),
114 SND_SOC_DAPM_OUTPUT("ROUT"),
115 SND_SOC_DAPM_OUTPUT("RHPOUT"),
116 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
117 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
118 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
119 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
120 SND_SOC_DAPM_INPUT("MICIN"),
121 SND_SOC_DAPM_INPUT("RLINEIN"),
122 SND_SOC_DAPM_INPUT("LLINEIN"),
125 static const struct snd_soc_dapm_route intercon[] = {
127 {"Output Mixer", "Line Bypass Switch", "Line Input"},
128 {"Output Mixer", "HiFi Playback Switch", "DAC"},
129 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
132 {"RHPOUT", NULL, "Output Mixer"},
133 {"ROUT", NULL, "Output Mixer"},
134 {"LHPOUT", NULL, "Output Mixer"},
135 {"LOUT", NULL, "Output Mixer"},
138 {"Input Mux", "Line In", "Line Input"},
139 {"Input Mux", "Mic", "Mic Bias"},
140 {"ADC", NULL, "Input Mux"},
143 {"Line Input", NULL, "LLINEIN"},
144 {"Line Input", NULL, "RLINEIN"},
145 {"Mic Bias", NULL, "MICIN"},
148 static int wm8731_add_widgets(struct snd_soc_codec *codec)
150 snd_soc_dapm_new_controls(codec, wm8731_dapm_widgets,
151 ARRAY_SIZE(wm8731_dapm_widgets));
153 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
155 snd_soc_dapm_new_widgets(codec);
168 /* codec mclk clock divider coefficients */
169 static const struct _coeff_div coeff_div[] = {
171 {12288000, 48000, 256, 0x0, 0x0, 0x0},
172 {18432000, 48000, 384, 0x0, 0x1, 0x0},
173 {12000000, 48000, 250, 0x0, 0x0, 0x1},
176 {12288000, 32000, 384, 0x6, 0x0, 0x0},
177 {18432000, 32000, 576, 0x6, 0x1, 0x0},
178 {12000000, 32000, 375, 0x6, 0x0, 0x1},
181 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
182 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
183 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
184 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
185 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
188 {12288000, 96000, 128, 0x7, 0x0, 0x0},
189 {18432000, 96000, 192, 0x7, 0x1, 0x0},
190 {12000000, 96000, 125, 0x7, 0x0, 0x1},
193 {11289600, 44100, 256, 0x8, 0x0, 0x0},
194 {16934400, 44100, 384, 0x8, 0x1, 0x0},
195 {12000000, 44100, 272, 0x8, 0x1, 0x1},
198 {11289600, 88200, 128, 0xf, 0x0, 0x0},
199 {16934400, 88200, 192, 0xf, 0x1, 0x0},
200 {12000000, 88200, 136, 0xf, 0x1, 0x1},
203 static inline int get_coeff(int mclk, int rate)
207 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
208 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
214 static int wm8731_hw_params(struct snd_pcm_substream *substream,
215 struct snd_pcm_hw_params *params,
216 struct snd_soc_dai *dai)
218 struct snd_soc_pcm_runtime *rtd = substream->private_data;
219 struct snd_soc_device *socdev = rtd->socdev;
220 struct snd_soc_codec *codec = socdev->card->codec;
221 struct wm8731_priv *wm8731 = codec->private_data;
222 u16 iface = snd_soc_read(codec, WM8731_IFACE) & 0xfff3;
223 int i = get_coeff(wm8731->sysclk, params_rate(params));
224 u16 srate = (coeff_div[i].sr << 2) |
225 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
227 snd_soc_write(codec, WM8731_SRATE, srate);
230 switch (params_format(params)) {
231 case SNDRV_PCM_FORMAT_S16_LE:
233 case SNDRV_PCM_FORMAT_S20_3LE:
236 case SNDRV_PCM_FORMAT_S24_LE:
241 snd_soc_write(codec, WM8731_IFACE, iface);
245 static int wm8731_pcm_prepare(struct snd_pcm_substream *substream,
246 struct snd_soc_dai *dai)
248 struct snd_soc_pcm_runtime *rtd = substream->private_data;
249 struct snd_soc_device *socdev = rtd->socdev;
250 struct snd_soc_codec *codec = socdev->card->codec;
253 snd_soc_write(codec, WM8731_ACTIVE, 0x0001);
258 static void wm8731_shutdown(struct snd_pcm_substream *substream,
259 struct snd_soc_dai *dai)
261 struct snd_soc_pcm_runtime *rtd = substream->private_data;
262 struct snd_soc_device *socdev = rtd->socdev;
263 struct snd_soc_codec *codec = socdev->card->codec;
266 if (!codec->active) {
268 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
272 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
274 struct snd_soc_codec *codec = dai->codec;
275 u16 mute_reg = snd_soc_read(codec, WM8731_APDIGI) & 0xfff7;
278 snd_soc_write(codec, WM8731_APDIGI, mute_reg | 0x8);
280 snd_soc_write(codec, WM8731_APDIGI, mute_reg);
284 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
285 int clk_id, unsigned int freq, int dir)
287 struct snd_soc_codec *codec = codec_dai->codec;
288 struct wm8731_priv *wm8731 = codec->private_data;
296 wm8731->sysclk = freq;
303 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
306 struct snd_soc_codec *codec = codec_dai->codec;
309 /* set master/slave audio interface */
310 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
311 case SND_SOC_DAIFMT_CBM_CFM:
314 case SND_SOC_DAIFMT_CBS_CFS:
320 /* interface format */
321 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
322 case SND_SOC_DAIFMT_I2S:
325 case SND_SOC_DAIFMT_RIGHT_J:
327 case SND_SOC_DAIFMT_LEFT_J:
330 case SND_SOC_DAIFMT_DSP_A:
333 case SND_SOC_DAIFMT_DSP_B:
340 /* clock inversion */
341 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
342 case SND_SOC_DAIFMT_NB_NF:
344 case SND_SOC_DAIFMT_IB_IF:
347 case SND_SOC_DAIFMT_IB_NF:
350 case SND_SOC_DAIFMT_NB_IF:
358 snd_soc_write(codec, WM8731_IFACE, iface);
362 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
363 enum snd_soc_bias_level level)
368 case SND_SOC_BIAS_ON:
370 case SND_SOC_BIAS_PREPARE:
372 case SND_SOC_BIAS_STANDBY:
373 /* Clear PWROFF, gate CLKOUT, everything else as-is */
374 reg = snd_soc_read(codec, WM8731_PWR) & 0xff7f;
375 snd_soc_write(codec, WM8731_PWR, reg | 0x0040);
377 case SND_SOC_BIAS_OFF:
378 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
379 snd_soc_write(codec, WM8731_PWR, 0xffff);
382 codec->bias_level = level;
386 #define WM8731_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
387 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
388 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
389 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
390 SNDRV_PCM_RATE_96000)
392 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
393 SNDRV_PCM_FMTBIT_S24_LE)
395 static struct snd_soc_dai_ops wm8731_dai_ops = {
396 .prepare = wm8731_pcm_prepare,
397 .hw_params = wm8731_hw_params,
398 .shutdown = wm8731_shutdown,
399 .digital_mute = wm8731_mute,
400 .set_sysclk = wm8731_set_dai_sysclk,
401 .set_fmt = wm8731_set_dai_fmt,
404 struct snd_soc_dai wm8731_dai = {
407 .stream_name = "Playback",
410 .rates = WM8731_RATES,
411 .formats = WM8731_FORMATS,},
413 .stream_name = "Capture",
416 .rates = WM8731_RATES,
417 .formats = WM8731_FORMATS,},
418 .ops = &wm8731_dai_ops,
419 .symmetric_rates = 1,
421 EXPORT_SYMBOL_GPL(wm8731_dai);
424 static int wm8731_suspend(struct platform_device *pdev, pm_message_t state)
426 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
427 struct snd_soc_codec *codec = socdev->card->codec;
429 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
430 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
434 static int wm8731_resume(struct platform_device *pdev)
436 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
437 struct snd_soc_codec *codec = socdev->card->codec;
440 u16 *cache = codec->reg_cache;
442 /* Sync reg_cache with the hardware */
443 for (i = 0; i < ARRAY_SIZE(wm8731_reg); i++) {
444 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
445 data[1] = cache[i] & 0x00ff;
446 codec->hw_write(codec->control_data, data, 2);
448 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
449 wm8731_set_bias_level(codec, codec->suspend_bias_level);
453 #define wm8731_suspend NULL
454 #define wm8731_resume NULL
457 static int wm8731_probe(struct platform_device *pdev)
459 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
460 struct snd_soc_codec *codec;
463 if (wm8731_codec == NULL) {
464 dev_err(&pdev->dev, "Codec device not registered\n");
468 socdev->card->codec = wm8731_codec;
469 codec = wm8731_codec;
472 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
474 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
478 snd_soc_add_controls(codec, wm8731_snd_controls,
479 ARRAY_SIZE(wm8731_snd_controls));
480 wm8731_add_widgets(codec);
481 ret = snd_soc_init_card(socdev);
483 dev_err(codec->dev, "failed to register card: %d\n", ret);
490 snd_soc_free_pcms(socdev);
491 snd_soc_dapm_free(socdev);
496 /* power down chip */
497 static int wm8731_remove(struct platform_device *pdev)
499 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
501 snd_soc_free_pcms(socdev);
502 snd_soc_dapm_free(socdev);
507 struct snd_soc_codec_device soc_codec_dev_wm8731 = {
508 .probe = wm8731_probe,
509 .remove = wm8731_remove,
510 .suspend = wm8731_suspend,
511 .resume = wm8731_resume,
513 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731);
515 static int wm8731_register(struct wm8731_priv *wm8731,
516 enum snd_soc_control_type control)
519 struct snd_soc_codec *codec = &wm8731->codec;
522 dev_err(codec->dev, "Another WM8731 is registered\n");
527 mutex_init(&codec->mutex);
528 INIT_LIST_HEAD(&codec->dapm_widgets);
529 INIT_LIST_HEAD(&codec->dapm_paths);
531 codec->private_data = wm8731;
532 codec->name = "WM8731";
533 codec->owner = THIS_MODULE;
534 codec->bias_level = SND_SOC_BIAS_OFF;
535 codec->set_bias_level = wm8731_set_bias_level;
536 codec->dai = &wm8731_dai;
538 codec->reg_cache_size = WM8731_CACHEREGNUM;
539 codec->reg_cache = &wm8731->reg_cache;
541 memcpy(codec->reg_cache, wm8731_reg, sizeof(wm8731_reg));
543 ret = snd_soc_codec_set_cache_io(codec, 7, 9, control);
545 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
549 ret = wm8731_reset(codec);
551 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
555 wm8731_dai.dev = codec->dev;
557 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
559 /* Latch the update bits */
560 snd_soc_update_bits(codec, WM8731_LOUT1V, 0x100, 0);
561 snd_soc_update_bits(codec, WM8731_ROUT1V, 0x100, 0);
562 snd_soc_update_bits(codec, WM8731_LINVOL, 0x100, 0);
563 snd_soc_update_bits(codec, WM8731_RINVOL, 0x100, 0);
565 /* Disable bypass path by default */
566 snd_soc_update_bits(codec, WM8731_APANA, 0x4, 0);
568 wm8731_codec = codec;
570 ret = snd_soc_register_codec(codec);
572 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
576 ret = snd_soc_register_dai(&wm8731_dai);
578 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
579 snd_soc_unregister_codec(codec);
586 snd_soc_unregister_codec(codec);
592 static void wm8731_unregister(struct wm8731_priv *wm8731)
594 wm8731_set_bias_level(&wm8731->codec, SND_SOC_BIAS_OFF);
595 snd_soc_unregister_dai(&wm8731_dai);
596 snd_soc_unregister_codec(&wm8731->codec);
601 #if defined(CONFIG_SPI_MASTER)
602 static int __devinit wm8731_spi_probe(struct spi_device *spi)
604 struct snd_soc_codec *codec;
605 struct wm8731_priv *wm8731;
607 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
611 codec = &wm8731->codec;
612 codec->control_data = spi;
613 codec->dev = &spi->dev;
615 dev_set_drvdata(&spi->dev, wm8731);
617 return wm8731_register(wm8731, SND_SOC_SPI);
620 static int __devexit wm8731_spi_remove(struct spi_device *spi)
622 struct wm8731_priv *wm8731 = dev_get_drvdata(&spi->dev);
624 wm8731_unregister(wm8731);
630 static int wm8731_spi_suspend(struct spi_device *spi, pm_message_t msg)
632 return snd_soc_suspend_device(&spi->dev);
635 static int wm8731_spi_resume(struct spi_device *spi)
637 return snd_soc_resume_device(&spi->dev);
640 #define wm8731_spi_suspend NULL
641 #define wm8731_spi_resume NULL
644 static struct spi_driver wm8731_spi_driver = {
647 .bus = &spi_bus_type,
648 .owner = THIS_MODULE,
650 .probe = wm8731_spi_probe,
651 .suspend = wm8731_spi_suspend,
652 .resume = wm8731_spi_resume,
653 .remove = __devexit_p(wm8731_spi_remove),
655 #endif /* CONFIG_SPI_MASTER */
657 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
658 static __devinit int wm8731_i2c_probe(struct i2c_client *i2c,
659 const struct i2c_device_id *id)
661 struct wm8731_priv *wm8731;
662 struct snd_soc_codec *codec;
664 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
668 codec = &wm8731->codec;
670 i2c_set_clientdata(i2c, wm8731);
671 codec->control_data = i2c;
673 codec->dev = &i2c->dev;
675 return wm8731_register(wm8731, SND_SOC_I2C);
678 static __devexit int wm8731_i2c_remove(struct i2c_client *client)
680 struct wm8731_priv *wm8731 = i2c_get_clientdata(client);
681 wm8731_unregister(wm8731);
686 static int wm8731_i2c_suspend(struct i2c_client *i2c, pm_message_t msg)
688 return snd_soc_suspend_device(&i2c->dev);
691 static int wm8731_i2c_resume(struct i2c_client *i2c)
693 return snd_soc_resume_device(&i2c->dev);
696 #define wm8731_i2c_suspend NULL
697 #define wm8731_i2c_resume NULL
700 static const struct i2c_device_id wm8731_i2c_id[] = {
704 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
706 static struct i2c_driver wm8731_i2c_driver = {
708 .name = "WM8731 I2C Codec",
709 .owner = THIS_MODULE,
711 .probe = wm8731_i2c_probe,
712 .remove = __devexit_p(wm8731_i2c_remove),
713 .suspend = wm8731_i2c_suspend,
714 .resume = wm8731_i2c_resume,
715 .id_table = wm8731_i2c_id,
719 static int __init wm8731_modinit(void)
722 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
723 ret = i2c_add_driver(&wm8731_i2c_driver);
725 printk(KERN_ERR "Failed to register WM8731 I2C driver: %d\n",
729 #if defined(CONFIG_SPI_MASTER)
730 ret = spi_register_driver(&wm8731_spi_driver);
732 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
738 module_init(wm8731_modinit);
740 static void __exit wm8731_exit(void)
742 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
743 i2c_del_driver(&wm8731_i2c_driver);
745 #if defined(CONFIG_SPI_MASTER)
746 spi_unregister_driver(&wm8731_spi_driver);
749 module_exit(wm8731_exit);
751 MODULE_DESCRIPTION("ASoC WM8731 driver");
752 MODULE_AUTHOR("Richard Purdie");
753 MODULE_LICENSE("GPL");