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/regulator/consumer.h>
23 #include <linux/spi/spi.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 *wm8731_codec;
35 struct snd_soc_codec_device soc_codec_dev_wm8731;
37 #define WM8731_NUM_SUPPLIES 4
38 static const char *wm8731_supply_names[WM8731_NUM_SUPPLIES] = {
45 /* codec private data */
47 struct snd_soc_codec codec;
48 struct regulator_bulk_data supplies[WM8731_NUM_SUPPLIES];
49 u16 reg_cache[WM8731_CACHEREGNUM];
55 * wm8731 register cache
56 * We can't read the WM8731 register space when we are
57 * using 2 wire for device control, so we cache them instead.
58 * There is no point in caching the reset register
60 static const u16 wm8731_reg[WM8731_CACHEREGNUM] = {
61 0x0097, 0x0097, 0x0079, 0x0079,
62 0x000a, 0x0008, 0x009f, 0x000a,
66 #define wm8731_reset(c) snd_soc_write(c, WM8731_RESET, 0)
68 static const char *wm8731_input_select[] = {"Line In", "Mic"};
69 static const char *wm8731_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
71 static const struct soc_enum wm8731_enum[] = {
72 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select),
73 SOC_ENUM_SINGLE(WM8731_APDIGI, 1, 4, wm8731_deemph),
76 static const DECLARE_TLV_DB_SCALE(in_tlv, -3450, 150, 0);
77 static const DECLARE_TLV_DB_SCALE(sidetone_tlv, -1500, 300, 0);
78 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
80 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
82 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
84 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
87 SOC_DOUBLE_R_TLV("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0,
89 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
91 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA, 0, 1, 0),
92 SOC_SINGLE("Mic Capture Switch", WM8731_APANA, 1, 1, 1),
94 SOC_SINGLE_TLV("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1,
97 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
98 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
100 SOC_ENUM("Playback De-emphasis", wm8731_enum[1]),
104 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
105 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
106 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
107 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
111 static const struct snd_kcontrol_new wm8731_input_mux_controls =
112 SOC_DAPM_ENUM("Input Select", wm8731_enum[0]);
114 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
115 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
116 &wm8731_output_mixer_controls[0],
117 ARRAY_SIZE(wm8731_output_mixer_controls)),
118 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
119 SND_SOC_DAPM_OUTPUT("LOUT"),
120 SND_SOC_DAPM_OUTPUT("LHPOUT"),
121 SND_SOC_DAPM_OUTPUT("ROUT"),
122 SND_SOC_DAPM_OUTPUT("RHPOUT"),
123 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
124 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
125 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
126 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
127 SND_SOC_DAPM_INPUT("MICIN"),
128 SND_SOC_DAPM_INPUT("RLINEIN"),
129 SND_SOC_DAPM_INPUT("LLINEIN"),
132 static const struct snd_soc_dapm_route intercon[] = {
134 {"Output Mixer", "Line Bypass Switch", "Line Input"},
135 {"Output Mixer", "HiFi Playback Switch", "DAC"},
136 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
139 {"RHPOUT", NULL, "Output Mixer"},
140 {"ROUT", NULL, "Output Mixer"},
141 {"LHPOUT", NULL, "Output Mixer"},
142 {"LOUT", NULL, "Output Mixer"},
145 {"Input Mux", "Line In", "Line Input"},
146 {"Input Mux", "Mic", "Mic Bias"},
147 {"ADC", NULL, "Input Mux"},
150 {"Line Input", NULL, "LLINEIN"},
151 {"Line Input", NULL, "RLINEIN"},
152 {"Mic Bias", NULL, "MICIN"},
155 static int wm8731_add_widgets(struct snd_soc_codec *codec)
157 snd_soc_dapm_new_controls(codec, wm8731_dapm_widgets,
158 ARRAY_SIZE(wm8731_dapm_widgets));
160 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
174 /* codec mclk clock divider coefficients */
175 static const struct _coeff_div coeff_div[] = {
177 {12288000, 48000, 256, 0x0, 0x0, 0x0},
178 {18432000, 48000, 384, 0x0, 0x1, 0x0},
179 {12000000, 48000, 250, 0x0, 0x0, 0x1},
182 {12288000, 32000, 384, 0x6, 0x0, 0x0},
183 {18432000, 32000, 576, 0x6, 0x1, 0x0},
184 {12000000, 32000, 375, 0x6, 0x0, 0x1},
187 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
188 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
189 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
190 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
191 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
194 {12288000, 96000, 128, 0x7, 0x0, 0x0},
195 {18432000, 96000, 192, 0x7, 0x1, 0x0},
196 {12000000, 96000, 125, 0x7, 0x0, 0x1},
199 {11289600, 44100, 256, 0x8, 0x0, 0x0},
200 {16934400, 44100, 384, 0x8, 0x1, 0x0},
201 {12000000, 44100, 272, 0x8, 0x1, 0x1},
204 {11289600, 88200, 128, 0xf, 0x0, 0x0},
205 {16934400, 88200, 192, 0xf, 0x1, 0x0},
206 {12000000, 88200, 136, 0xf, 0x1, 0x1},
209 static inline int get_coeff(int mclk, int rate)
213 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
214 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
220 static int wm8731_hw_params(struct snd_pcm_substream *substream,
221 struct snd_pcm_hw_params *params,
222 struct snd_soc_dai *dai)
224 struct snd_soc_pcm_runtime *rtd = substream->private_data;
225 struct snd_soc_device *socdev = rtd->socdev;
226 struct snd_soc_codec *codec = socdev->card->codec;
227 struct wm8731_priv *wm8731 = codec->private_data;
228 u16 iface = snd_soc_read(codec, WM8731_IFACE) & 0xfff3;
229 int i = get_coeff(wm8731->sysclk, params_rate(params));
230 u16 srate = (coeff_div[i].sr << 2) |
231 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
233 snd_soc_write(codec, WM8731_SRATE, srate);
236 switch (params_format(params)) {
237 case SNDRV_PCM_FORMAT_S16_LE:
239 case SNDRV_PCM_FORMAT_S20_3LE:
242 case SNDRV_PCM_FORMAT_S24_LE:
247 snd_soc_write(codec, WM8731_IFACE, iface);
251 static int wm8731_pcm_prepare(struct snd_pcm_substream *substream,
252 struct snd_soc_dai *dai)
254 struct snd_soc_pcm_runtime *rtd = substream->private_data;
255 struct snd_soc_device *socdev = rtd->socdev;
256 struct snd_soc_codec *codec = socdev->card->codec;
259 snd_soc_write(codec, WM8731_ACTIVE, 0x0001);
264 static void wm8731_shutdown(struct snd_pcm_substream *substream,
265 struct snd_soc_dai *dai)
267 struct snd_soc_pcm_runtime *rtd = substream->private_data;
268 struct snd_soc_device *socdev = rtd->socdev;
269 struct snd_soc_codec *codec = socdev->card->codec;
272 if (!codec->active) {
274 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
278 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
280 struct snd_soc_codec *codec = dai->codec;
281 u16 mute_reg = snd_soc_read(codec, WM8731_APDIGI) & 0xfff7;
284 snd_soc_write(codec, WM8731_APDIGI, mute_reg | 0x8);
286 snd_soc_write(codec, WM8731_APDIGI, mute_reg);
290 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
291 int clk_id, unsigned int freq, int dir)
293 struct snd_soc_codec *codec = codec_dai->codec;
294 struct wm8731_priv *wm8731 = codec->private_data;
302 wm8731->sysclk = freq;
309 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
312 struct snd_soc_codec *codec = codec_dai->codec;
315 /* set master/slave audio interface */
316 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
317 case SND_SOC_DAIFMT_CBM_CFM:
320 case SND_SOC_DAIFMT_CBS_CFS:
326 /* interface format */
327 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
328 case SND_SOC_DAIFMT_I2S:
331 case SND_SOC_DAIFMT_RIGHT_J:
333 case SND_SOC_DAIFMT_LEFT_J:
336 case SND_SOC_DAIFMT_DSP_A:
339 case SND_SOC_DAIFMT_DSP_B:
346 /* clock inversion */
347 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
348 case SND_SOC_DAIFMT_NB_NF:
350 case SND_SOC_DAIFMT_IB_IF:
353 case SND_SOC_DAIFMT_IB_NF:
356 case SND_SOC_DAIFMT_NB_IF:
364 snd_soc_write(codec, WM8731_IFACE, iface);
368 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
369 enum snd_soc_bias_level level)
374 case SND_SOC_BIAS_ON:
376 case SND_SOC_BIAS_PREPARE:
378 case SND_SOC_BIAS_STANDBY:
379 /* Clear PWROFF, gate CLKOUT, everything else as-is */
380 reg = snd_soc_read(codec, WM8731_PWR) & 0xff7f;
381 snd_soc_write(codec, WM8731_PWR, reg | 0x0040);
383 case SND_SOC_BIAS_OFF:
384 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
385 snd_soc_write(codec, WM8731_PWR, 0xffff);
388 codec->bias_level = level;
392 #define WM8731_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
393 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
394 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
395 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
396 SNDRV_PCM_RATE_96000)
398 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
399 SNDRV_PCM_FMTBIT_S24_LE)
401 static struct snd_soc_dai_ops wm8731_dai_ops = {
402 .prepare = wm8731_pcm_prepare,
403 .hw_params = wm8731_hw_params,
404 .shutdown = wm8731_shutdown,
405 .digital_mute = wm8731_mute,
406 .set_sysclk = wm8731_set_dai_sysclk,
407 .set_fmt = wm8731_set_dai_fmt,
410 struct snd_soc_dai wm8731_dai = {
413 .stream_name = "Playback",
416 .rates = WM8731_RATES,
417 .formats = WM8731_FORMATS,},
419 .stream_name = "Capture",
422 .rates = WM8731_RATES,
423 .formats = WM8731_FORMATS,},
424 .ops = &wm8731_dai_ops,
425 .symmetric_rates = 1,
427 EXPORT_SYMBOL_GPL(wm8731_dai);
430 static int wm8731_suspend(struct platform_device *pdev, pm_message_t state)
432 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
433 struct snd_soc_codec *codec = socdev->card->codec;
434 struct wm8731_priv *wm8731 = codec->private_data;
436 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
437 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
438 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies),
443 static int wm8731_resume(struct platform_device *pdev)
445 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
446 struct snd_soc_codec *codec = socdev->card->codec;
447 struct wm8731_priv *wm8731 = codec->private_data;
450 u16 *cache = codec->reg_cache;
452 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
457 /* Sync reg_cache with the hardware */
458 for (i = 0; i < ARRAY_SIZE(wm8731_reg); i++) {
459 if (cache[i] == wm8731_reg[i])
462 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
463 data[1] = cache[i] & 0x00ff;
464 codec->hw_write(codec->control_data, data, 2);
466 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
467 wm8731_set_bias_level(codec, codec->suspend_bias_level);
472 #define wm8731_suspend NULL
473 #define wm8731_resume NULL
476 static int wm8731_probe(struct platform_device *pdev)
478 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
479 struct snd_soc_codec *codec;
482 if (wm8731_codec == NULL) {
483 dev_err(&pdev->dev, "Codec device not registered\n");
487 socdev->card->codec = wm8731_codec;
488 codec = wm8731_codec;
491 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
493 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
497 snd_soc_add_controls(codec, wm8731_snd_controls,
498 ARRAY_SIZE(wm8731_snd_controls));
499 wm8731_add_widgets(codec);
507 /* power down chip */
508 static int wm8731_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_wm8731 = {
519 .probe = wm8731_probe,
520 .remove = wm8731_remove,
521 .suspend = wm8731_suspend,
522 .resume = wm8731_resume,
524 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731);
526 static int wm8731_register(struct wm8731_priv *wm8731,
527 enum snd_soc_control_type control)
530 struct snd_soc_codec *codec = &wm8731->codec;
533 dev_err(codec->dev, "Another WM8731 is registered\n");
538 mutex_init(&codec->mutex);
539 INIT_LIST_HEAD(&codec->dapm_widgets);
540 INIT_LIST_HEAD(&codec->dapm_paths);
542 codec->private_data = wm8731;
543 codec->name = "WM8731";
544 codec->owner = THIS_MODULE;
545 codec->bias_level = SND_SOC_BIAS_OFF;
546 codec->set_bias_level = wm8731_set_bias_level;
547 codec->dai = &wm8731_dai;
549 codec->reg_cache_size = WM8731_CACHEREGNUM;
550 codec->reg_cache = &wm8731->reg_cache;
552 memcpy(codec->reg_cache, wm8731_reg, sizeof(wm8731_reg));
554 ret = snd_soc_codec_set_cache_io(codec, 7, 9, control);
556 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
560 for (i = 0; i < ARRAY_SIZE(wm8731->supplies); i++)
561 wm8731->supplies[i].supply = wm8731_supply_names[i];
563 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8731->supplies),
566 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
570 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
573 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
574 goto err_regulator_get;
577 ret = wm8731_reset(codec);
579 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
580 goto err_regulator_enable;
583 wm8731_dai.dev = codec->dev;
585 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
587 /* Latch the update bits */
588 snd_soc_update_bits(codec, WM8731_LOUT1V, 0x100, 0);
589 snd_soc_update_bits(codec, WM8731_ROUT1V, 0x100, 0);
590 snd_soc_update_bits(codec, WM8731_LINVOL, 0x100, 0);
591 snd_soc_update_bits(codec, WM8731_RINVOL, 0x100, 0);
593 /* Disable bypass path by default */
594 snd_soc_update_bits(codec, WM8731_APANA, 0x4, 0);
596 wm8731_codec = codec;
598 ret = snd_soc_register_codec(codec);
600 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
601 goto err_regulator_enable;
604 ret = snd_soc_register_dai(&wm8731_dai);
606 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
607 snd_soc_unregister_codec(codec);
614 snd_soc_unregister_codec(codec);
615 err_regulator_enable:
616 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
618 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
624 static void wm8731_unregister(struct wm8731_priv *wm8731)
626 wm8731_set_bias_level(&wm8731->codec, SND_SOC_BIAS_OFF);
627 snd_soc_unregister_dai(&wm8731_dai);
628 snd_soc_unregister_codec(&wm8731->codec);
629 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
630 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
635 #if defined(CONFIG_SPI_MASTER)
636 static int __devinit wm8731_spi_probe(struct spi_device *spi)
638 struct snd_soc_codec *codec;
639 struct wm8731_priv *wm8731;
641 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
645 codec = &wm8731->codec;
646 codec->control_data = spi;
647 codec->dev = &spi->dev;
649 dev_set_drvdata(&spi->dev, wm8731);
651 return wm8731_register(wm8731, SND_SOC_SPI);
654 static int __devexit wm8731_spi_remove(struct spi_device *spi)
656 struct wm8731_priv *wm8731 = dev_get_drvdata(&spi->dev);
658 wm8731_unregister(wm8731);
663 static struct spi_driver wm8731_spi_driver = {
666 .bus = &spi_bus_type,
667 .owner = THIS_MODULE,
669 .probe = wm8731_spi_probe,
670 .remove = __devexit_p(wm8731_spi_remove),
672 #endif /* CONFIG_SPI_MASTER */
674 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
675 static __devinit int wm8731_i2c_probe(struct i2c_client *i2c,
676 const struct i2c_device_id *id)
678 struct wm8731_priv *wm8731;
679 struct snd_soc_codec *codec;
681 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
685 codec = &wm8731->codec;
687 i2c_set_clientdata(i2c, wm8731);
688 codec->control_data = i2c;
690 codec->dev = &i2c->dev;
692 return wm8731_register(wm8731, SND_SOC_I2C);
695 static __devexit int wm8731_i2c_remove(struct i2c_client *client)
697 struct wm8731_priv *wm8731 = i2c_get_clientdata(client);
698 wm8731_unregister(wm8731);
702 static const struct i2c_device_id wm8731_i2c_id[] = {
706 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
708 static struct i2c_driver wm8731_i2c_driver = {
710 .name = "WM8731 I2C Codec",
711 .owner = THIS_MODULE,
713 .probe = wm8731_i2c_probe,
714 .remove = __devexit_p(wm8731_i2c_remove),
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");