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/slab.h>
22 #include <linux/platform_device.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/spi/spi.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/soc.h>
29 #include <sound/soc-dapm.h>
30 #include <sound/initval.h>
31 #include <sound/tlv.h>
35 static struct snd_soc_codec *wm8731_codec;
36 struct snd_soc_codec_device soc_codec_dev_wm8731;
38 #define WM8731_NUM_SUPPLIES 4
39 static const char *wm8731_supply_names[WM8731_NUM_SUPPLIES] = {
46 /* codec private data */
48 struct snd_soc_codec codec;
49 struct regulator_bulk_data supplies[WM8731_NUM_SUPPLIES];
50 u16 reg_cache[WM8731_CACHEREGNUM];
56 * wm8731 register cache
57 * We can't read the WM8731 register space when we are
58 * using 2 wire for device control, so we cache them instead.
59 * There is no point in caching the reset register
61 static const u16 wm8731_reg[WM8731_CACHEREGNUM] = {
62 0x0097, 0x0097, 0x0079, 0x0079,
63 0x000a, 0x0008, 0x009f, 0x000a,
67 #define wm8731_reset(c) snd_soc_write(c, WM8731_RESET, 0)
69 static const char *wm8731_input_select[] = {"Line In", "Mic"};
70 static const char *wm8731_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
72 static const struct soc_enum wm8731_enum[] = {
73 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select),
74 SOC_ENUM_SINGLE(WM8731_APDIGI, 1, 4, wm8731_deemph),
77 static const DECLARE_TLV_DB_SCALE(in_tlv, -3450, 150, 0);
78 static const DECLARE_TLV_DB_SCALE(sidetone_tlv, -1500, 300, 0);
79 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
81 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
83 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
85 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
88 SOC_DOUBLE_R_TLV("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0,
90 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
92 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA, 0, 1, 0),
93 SOC_SINGLE("Mic Capture Switch", WM8731_APANA, 1, 1, 1),
95 SOC_SINGLE_TLV("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1,
98 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
99 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
101 SOC_ENUM("Playback De-emphasis", wm8731_enum[1]),
105 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
106 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
107 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
108 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
112 static const struct snd_kcontrol_new wm8731_input_mux_controls =
113 SOC_DAPM_ENUM("Input Select", wm8731_enum[0]);
115 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
116 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
117 &wm8731_output_mixer_controls[0],
118 ARRAY_SIZE(wm8731_output_mixer_controls)),
119 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
120 SND_SOC_DAPM_OUTPUT("LOUT"),
121 SND_SOC_DAPM_OUTPUT("LHPOUT"),
122 SND_SOC_DAPM_OUTPUT("ROUT"),
123 SND_SOC_DAPM_OUTPUT("RHPOUT"),
124 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
125 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
126 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
127 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
128 SND_SOC_DAPM_INPUT("MICIN"),
129 SND_SOC_DAPM_INPUT("RLINEIN"),
130 SND_SOC_DAPM_INPUT("LLINEIN"),
133 static const struct snd_soc_dapm_route intercon[] = {
135 {"Output Mixer", "Line Bypass Switch", "Line Input"},
136 {"Output Mixer", "HiFi Playback Switch", "DAC"},
137 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
140 {"RHPOUT", NULL, "Output Mixer"},
141 {"ROUT", NULL, "Output Mixer"},
142 {"LHPOUT", NULL, "Output Mixer"},
143 {"LOUT", NULL, "Output Mixer"},
146 {"Input Mux", "Line In", "Line Input"},
147 {"Input Mux", "Mic", "Mic Bias"},
148 {"ADC", NULL, "Input Mux"},
151 {"Line Input", NULL, "LLINEIN"},
152 {"Line Input", NULL, "RLINEIN"},
153 {"Mic Bias", NULL, "MICIN"},
156 static int wm8731_add_widgets(struct snd_soc_codec *codec)
158 snd_soc_dapm_new_controls(codec, wm8731_dapm_widgets,
159 ARRAY_SIZE(wm8731_dapm_widgets));
161 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
175 /* codec mclk clock divider coefficients */
176 static const struct _coeff_div coeff_div[] = {
178 {12288000, 48000, 256, 0x0, 0x0, 0x0},
179 {18432000, 48000, 384, 0x0, 0x1, 0x0},
180 {12000000, 48000, 250, 0x0, 0x0, 0x1},
183 {12288000, 32000, 384, 0x6, 0x0, 0x0},
184 {18432000, 32000, 576, 0x6, 0x1, 0x0},
185 {12000000, 32000, 375, 0x6, 0x0, 0x1},
188 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
189 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
190 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
191 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
192 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
195 {12288000, 96000, 128, 0x7, 0x0, 0x0},
196 {18432000, 96000, 192, 0x7, 0x1, 0x0},
197 {12000000, 96000, 125, 0x7, 0x0, 0x1},
200 {11289600, 44100, 256, 0x8, 0x0, 0x0},
201 {16934400, 44100, 384, 0x8, 0x1, 0x0},
202 {12000000, 44100, 272, 0x8, 0x1, 0x1},
205 {11289600, 88200, 128, 0xf, 0x0, 0x0},
206 {16934400, 88200, 192, 0xf, 0x1, 0x0},
207 {12000000, 88200, 136, 0xf, 0x1, 0x1},
210 static inline int get_coeff(int mclk, int rate)
214 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
215 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
221 static int wm8731_hw_params(struct snd_pcm_substream *substream,
222 struct snd_pcm_hw_params *params,
223 struct snd_soc_dai *dai)
225 struct snd_soc_pcm_runtime *rtd = substream->private_data;
226 struct snd_soc_device *socdev = rtd->socdev;
227 struct snd_soc_codec *codec = socdev->card->codec;
228 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
229 u16 iface = snd_soc_read(codec, WM8731_IFACE) & 0xfff3;
230 int i = get_coeff(wm8731->sysclk, params_rate(params));
231 u16 srate = (coeff_div[i].sr << 2) |
232 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
234 snd_soc_write(codec, WM8731_SRATE, srate);
237 switch (params_format(params)) {
238 case SNDRV_PCM_FORMAT_S16_LE:
240 case SNDRV_PCM_FORMAT_S20_3LE:
243 case SNDRV_PCM_FORMAT_S24_LE:
248 snd_soc_write(codec, WM8731_IFACE, iface);
252 static int wm8731_pcm_prepare(struct snd_pcm_substream *substream,
253 struct snd_soc_dai *dai)
255 struct snd_soc_pcm_runtime *rtd = substream->private_data;
256 struct snd_soc_device *socdev = rtd->socdev;
257 struct snd_soc_codec *codec = socdev->card->codec;
260 snd_soc_write(codec, WM8731_ACTIVE, 0x0001);
265 static void wm8731_shutdown(struct snd_pcm_substream *substream,
266 struct snd_soc_dai *dai)
268 struct snd_soc_pcm_runtime *rtd = substream->private_data;
269 struct snd_soc_device *socdev = rtd->socdev;
270 struct snd_soc_codec *codec = socdev->card->codec;
273 if (!codec->active) {
275 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
279 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
281 struct snd_soc_codec *codec = dai->codec;
282 u16 mute_reg = snd_soc_read(codec, WM8731_APDIGI) & 0xfff7;
285 snd_soc_write(codec, WM8731_APDIGI, mute_reg | 0x8);
287 snd_soc_write(codec, WM8731_APDIGI, mute_reg);
291 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
292 int clk_id, unsigned int freq, int dir)
294 struct snd_soc_codec *codec = codec_dai->codec;
295 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
303 wm8731->sysclk = freq;
310 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
313 struct snd_soc_codec *codec = codec_dai->codec;
316 /* set master/slave audio interface */
317 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
318 case SND_SOC_DAIFMT_CBM_CFM:
321 case SND_SOC_DAIFMT_CBS_CFS:
327 /* interface format */
328 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
329 case SND_SOC_DAIFMT_I2S:
332 case SND_SOC_DAIFMT_RIGHT_J:
334 case SND_SOC_DAIFMT_LEFT_J:
337 case SND_SOC_DAIFMT_DSP_A:
340 case SND_SOC_DAIFMT_DSP_B:
347 /* clock inversion */
348 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
349 case SND_SOC_DAIFMT_NB_NF:
351 case SND_SOC_DAIFMT_IB_IF:
354 case SND_SOC_DAIFMT_IB_NF:
357 case SND_SOC_DAIFMT_NB_IF:
365 snd_soc_write(codec, WM8731_IFACE, iface);
369 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
370 enum snd_soc_bias_level level)
372 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
375 u16 *cache = codec->reg_cache;
379 case SND_SOC_BIAS_ON:
381 case SND_SOC_BIAS_PREPARE:
383 case SND_SOC_BIAS_STANDBY:
384 if (codec->bias_level == SND_SOC_BIAS_OFF) {
385 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
390 /* Sync reg_cache with the hardware */
391 for (i = 0; i < ARRAY_SIZE(wm8731_reg); i++) {
392 if (cache[i] == wm8731_reg[i])
395 data[0] = (i << 1) | ((cache[i] >> 8)
397 data[1] = cache[i] & 0x00ff;
398 codec->hw_write(codec->control_data, data, 2);
402 /* Clear PWROFF, gate CLKOUT, everything else as-is */
403 reg = snd_soc_read(codec, WM8731_PWR) & 0xff7f;
404 snd_soc_write(codec, WM8731_PWR, reg | 0x0040);
406 case SND_SOC_BIAS_OFF:
407 snd_soc_write(codec, WM8731_ACTIVE, 0x0);
408 snd_soc_write(codec, WM8731_PWR, 0xffff);
409 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies),
413 codec->bias_level = level;
417 #define WM8731_RATES SNDRV_PCM_RATE_8000_96000
419 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
420 SNDRV_PCM_FMTBIT_S24_LE)
422 static struct snd_soc_dai_ops wm8731_dai_ops = {
423 .prepare = wm8731_pcm_prepare,
424 .hw_params = wm8731_hw_params,
425 .shutdown = wm8731_shutdown,
426 .digital_mute = wm8731_mute,
427 .set_sysclk = wm8731_set_dai_sysclk,
428 .set_fmt = wm8731_set_dai_fmt,
431 struct snd_soc_dai wm8731_dai = {
434 .stream_name = "Playback",
437 .rates = WM8731_RATES,
438 .formats = WM8731_FORMATS,},
440 .stream_name = "Capture",
443 .rates = WM8731_RATES,
444 .formats = WM8731_FORMATS,},
445 .ops = &wm8731_dai_ops,
446 .symmetric_rates = 1,
448 EXPORT_SYMBOL_GPL(wm8731_dai);
451 static int wm8731_suspend(struct platform_device *pdev, pm_message_t state)
453 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
454 struct snd_soc_codec *codec = socdev->card->codec;
456 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
461 static int wm8731_resume(struct platform_device *pdev)
463 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
464 struct snd_soc_codec *codec = socdev->card->codec;
466 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
471 #define wm8731_suspend NULL
472 #define wm8731_resume NULL
475 static int wm8731_probe(struct platform_device *pdev)
477 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
478 struct snd_soc_codec *codec;
481 if (wm8731_codec == NULL) {
482 dev_err(&pdev->dev, "Codec device not registered\n");
486 socdev->card->codec = wm8731_codec;
487 codec = wm8731_codec;
490 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
492 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
496 snd_soc_add_controls(codec, wm8731_snd_controls,
497 ARRAY_SIZE(wm8731_snd_controls));
498 wm8731_add_widgets(codec);
506 /* power down chip */
507 static int wm8731_remove(struct platform_device *pdev)
509 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
511 snd_soc_free_pcms(socdev);
512 snd_soc_dapm_free(socdev);
517 struct snd_soc_codec_device soc_codec_dev_wm8731 = {
518 .probe = wm8731_probe,
519 .remove = wm8731_remove,
520 .suspend = wm8731_suspend,
521 .resume = wm8731_resume,
523 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731);
525 static int wm8731_register(struct wm8731_priv *wm8731,
526 enum snd_soc_control_type control)
529 struct snd_soc_codec *codec = &wm8731->codec;
532 dev_err(codec->dev, "Another WM8731 is registered\n");
537 mutex_init(&codec->mutex);
538 INIT_LIST_HEAD(&codec->dapm_widgets);
539 INIT_LIST_HEAD(&codec->dapm_paths);
541 snd_soc_codec_set_drvdata(codec, wm8731);
542 codec->name = "WM8731";
543 codec->owner = THIS_MODULE;
544 codec->bias_level = SND_SOC_BIAS_OFF;
545 codec->set_bias_level = wm8731_set_bias_level;
546 codec->dai = &wm8731_dai;
548 codec->reg_cache_size = WM8731_CACHEREGNUM;
549 codec->reg_cache = &wm8731->reg_cache;
551 memcpy(codec->reg_cache, wm8731_reg, sizeof(wm8731_reg));
553 ret = snd_soc_codec_set_cache_io(codec, 7, 9, control);
555 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
559 for (i = 0; i < ARRAY_SIZE(wm8731->supplies); i++)
560 wm8731->supplies[i].supply = wm8731_supply_names[i];
562 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8731->supplies),
565 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
569 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
572 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
573 goto err_regulator_get;
576 ret = wm8731_reset(codec);
578 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
579 goto err_regulator_enable;
582 wm8731_dai.dev = codec->dev;
584 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
586 /* Latch the update bits */
587 snd_soc_update_bits(codec, WM8731_LOUT1V, 0x100, 0);
588 snd_soc_update_bits(codec, WM8731_ROUT1V, 0x100, 0);
589 snd_soc_update_bits(codec, WM8731_LINVOL, 0x100, 0);
590 snd_soc_update_bits(codec, WM8731_RINVOL, 0x100, 0);
592 /* Disable bypass path by default */
593 snd_soc_update_bits(codec, WM8731_APANA, 0x4, 0);
595 wm8731_codec = codec;
597 ret = snd_soc_register_codec(codec);
599 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
600 goto err_regulator_enable;
603 ret = snd_soc_register_dai(&wm8731_dai);
605 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
606 snd_soc_unregister_codec(codec);
610 /* Regulators will have been enabled by bias management */
611 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
616 snd_soc_unregister_codec(codec);
617 err_regulator_enable:
618 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
620 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
626 static void wm8731_unregister(struct wm8731_priv *wm8731)
628 wm8731_set_bias_level(&wm8731->codec, SND_SOC_BIAS_OFF);
629 snd_soc_unregister_dai(&wm8731_dai);
630 snd_soc_unregister_codec(&wm8731->codec);
631 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
636 #if defined(CONFIG_SPI_MASTER)
637 static int __devinit wm8731_spi_probe(struct spi_device *spi)
639 struct snd_soc_codec *codec;
640 struct wm8731_priv *wm8731;
642 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
646 codec = &wm8731->codec;
647 codec->control_data = spi;
648 codec->dev = &spi->dev;
650 dev_set_drvdata(&spi->dev, wm8731);
652 return wm8731_register(wm8731, SND_SOC_SPI);
655 static int __devexit wm8731_spi_remove(struct spi_device *spi)
657 struct wm8731_priv *wm8731 = dev_get_drvdata(&spi->dev);
659 wm8731_unregister(wm8731);
664 static struct spi_driver wm8731_spi_driver = {
667 .bus = &spi_bus_type,
668 .owner = THIS_MODULE,
670 .probe = wm8731_spi_probe,
671 .remove = __devexit_p(wm8731_spi_remove),
673 #endif /* CONFIG_SPI_MASTER */
675 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
676 static __devinit int wm8731_i2c_probe(struct i2c_client *i2c,
677 const struct i2c_device_id *id)
679 struct wm8731_priv *wm8731;
680 struct snd_soc_codec *codec;
682 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
686 codec = &wm8731->codec;
688 i2c_set_clientdata(i2c, wm8731);
689 codec->control_data = i2c;
691 codec->dev = &i2c->dev;
693 return wm8731_register(wm8731, SND_SOC_I2C);
696 static __devexit int wm8731_i2c_remove(struct i2c_client *client)
698 struct wm8731_priv *wm8731 = i2c_get_clientdata(client);
699 wm8731_unregister(wm8731);
703 static const struct i2c_device_id wm8731_i2c_id[] = {
707 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
709 static struct i2c_driver wm8731_i2c_driver = {
712 .owner = THIS_MODULE,
714 .probe = wm8731_i2c_probe,
715 .remove = __devexit_p(wm8731_i2c_remove),
716 .id_table = wm8731_i2c_id,
720 static int __init wm8731_modinit(void)
723 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
724 ret = i2c_add_driver(&wm8731_i2c_driver);
726 printk(KERN_ERR "Failed to register WM8731 I2C driver: %d\n",
730 #if defined(CONFIG_SPI_MASTER)
731 ret = spi_register_driver(&wm8731_spi_driver);
733 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
739 module_init(wm8731_modinit);
741 static void __exit wm8731_exit(void)
743 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
744 i2c_del_driver(&wm8731_i2c_driver);
746 #if defined(CONFIG_SPI_MASTER)
747 spi_unregister_driver(&wm8731_spi_driver);
750 module_exit(wm8731_exit);
752 MODULE_DESCRIPTION("ASoC WM8731 driver");
753 MODULE_AUTHOR("Richard Purdie");
754 MODULE_LICENSE("GPL");