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 #define WM8731_VERSION "0.13"
34 struct snd_soc_codec_device soc_codec_dev_wm8731;
36 /* codec private data */
42 * wm8731 register cache
43 * We can't read the WM8731 register space when we are
44 * using 2 wire for device control, so we cache them instead.
45 * There is no point in caching the reset register
47 static const u16 wm8731_reg[WM8731_CACHEREGNUM] = {
48 0x0097, 0x0097, 0x0079, 0x0079,
49 0x000a, 0x0008, 0x009f, 0x000a,
54 * read wm8731 register cache
56 static inline unsigned int wm8731_read_reg_cache(struct snd_soc_codec *codec,
59 u16 *cache = codec->reg_cache;
60 if (reg == WM8731_RESET)
62 if (reg >= WM8731_CACHEREGNUM)
68 * write wm8731 register cache
70 static inline void wm8731_write_reg_cache(struct snd_soc_codec *codec,
71 u16 reg, unsigned int value)
73 u16 *cache = codec->reg_cache;
74 if (reg >= WM8731_CACHEREGNUM)
80 * write to the WM8731 register space
82 static int wm8731_write(struct snd_soc_codec *codec, unsigned int reg,
88 * D15..D9 WM8731 register offset
89 * D8...D0 register data
91 data[0] = (reg << 1) | ((value >> 8) & 0x0001);
92 data[1] = value & 0x00ff;
94 wm8731_write_reg_cache(codec, reg, value);
95 if (codec->hw_write(codec->control_data, data, 2) == 2)
101 #define wm8731_reset(c) wm8731_write(c, WM8731_RESET, 0)
103 static const char *wm8731_input_select[] = {"Line In", "Mic"};
104 static const char *wm8731_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
106 static const struct soc_enum wm8731_enum[] = {
107 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select),
108 SOC_ENUM_SINGLE(WM8731_APDIGI, 1, 4, wm8731_deemph),
111 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
113 SOC_DOUBLE_R("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
115 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
118 SOC_DOUBLE_R("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0),
119 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
121 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA, 0, 1, 0),
122 SOC_SINGLE("Capture Mic Switch", WM8731_APANA, 1, 1, 1),
124 SOC_SINGLE("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1),
126 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
127 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
129 SOC_ENUM("Playback De-emphasis", wm8731_enum[1]),
133 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
134 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
135 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
136 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
140 static const struct snd_kcontrol_new wm8731_input_mux_controls =
141 SOC_DAPM_ENUM("Input Select", wm8731_enum[0]);
143 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
144 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
145 &wm8731_output_mixer_controls[0],
146 ARRAY_SIZE(wm8731_output_mixer_controls)),
147 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
148 SND_SOC_DAPM_OUTPUT("LOUT"),
149 SND_SOC_DAPM_OUTPUT("LHPOUT"),
150 SND_SOC_DAPM_OUTPUT("ROUT"),
151 SND_SOC_DAPM_OUTPUT("RHPOUT"),
152 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
153 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
154 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
155 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
156 SND_SOC_DAPM_INPUT("MICIN"),
157 SND_SOC_DAPM_INPUT("RLINEIN"),
158 SND_SOC_DAPM_INPUT("LLINEIN"),
161 static const struct snd_soc_dapm_route intercon[] = {
163 {"Output Mixer", "Line Bypass Switch", "Line Input"},
164 {"Output Mixer", "HiFi Playback Switch", "DAC"},
165 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
168 {"RHPOUT", NULL, "Output Mixer"},
169 {"ROUT", NULL, "Output Mixer"},
170 {"LHPOUT", NULL, "Output Mixer"},
171 {"LOUT", NULL, "Output Mixer"},
174 {"Input Mux", "Line In", "Line Input"},
175 {"Input Mux", "Mic", "Mic Bias"},
176 {"ADC", NULL, "Input Mux"},
179 {"Line Input", NULL, "LLINEIN"},
180 {"Line Input", NULL, "RLINEIN"},
181 {"Mic Bias", NULL, "MICIN"},
184 static int wm8731_add_widgets(struct snd_soc_codec *codec)
186 snd_soc_dapm_new_controls(codec, wm8731_dapm_widgets,
187 ARRAY_SIZE(wm8731_dapm_widgets));
189 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
191 snd_soc_dapm_new_widgets(codec);
204 /* codec mclk clock divider coefficients */
205 static const struct _coeff_div coeff_div[] = {
207 {12288000, 48000, 256, 0x0, 0x0, 0x0},
208 {18432000, 48000, 384, 0x0, 0x1, 0x0},
209 {12000000, 48000, 250, 0x0, 0x0, 0x1},
212 {12288000, 32000, 384, 0x6, 0x0, 0x0},
213 {18432000, 32000, 576, 0x6, 0x1, 0x0},
214 {12000000, 32000, 375, 0x6, 0x0, 0x1},
217 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
218 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
219 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
220 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
221 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
224 {12288000, 96000, 128, 0x7, 0x0, 0x0},
225 {18432000, 96000, 192, 0x7, 0x1, 0x0},
226 {12000000, 96000, 125, 0x7, 0x0, 0x1},
229 {11289600, 44100, 256, 0x8, 0x0, 0x0},
230 {16934400, 44100, 384, 0x8, 0x1, 0x0},
231 {12000000, 44100, 272, 0x8, 0x1, 0x1},
234 {11289600, 88200, 128, 0xf, 0x0, 0x0},
235 {16934400, 88200, 192, 0xf, 0x1, 0x0},
236 {12000000, 88200, 136, 0xf, 0x1, 0x1},
239 static inline int get_coeff(int mclk, int rate)
243 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
244 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
250 static int wm8731_hw_params(struct snd_pcm_substream *substream,
251 struct snd_pcm_hw_params *params,
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;
257 struct wm8731_priv *wm8731 = codec->private_data;
258 u16 iface = wm8731_read_reg_cache(codec, WM8731_IFACE) & 0xfff3;
259 int i = get_coeff(wm8731->sysclk, params_rate(params));
260 u16 srate = (coeff_div[i].sr << 2) |
261 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
263 wm8731_write(codec, WM8731_SRATE, srate);
266 switch (params_format(params)) {
267 case SNDRV_PCM_FORMAT_S16_LE:
269 case SNDRV_PCM_FORMAT_S20_3LE:
272 case SNDRV_PCM_FORMAT_S24_LE:
277 wm8731_write(codec, WM8731_IFACE, iface);
281 static int wm8731_pcm_prepare(struct snd_pcm_substream *substream,
282 struct snd_soc_dai *dai)
284 struct snd_soc_pcm_runtime *rtd = substream->private_data;
285 struct snd_soc_device *socdev = rtd->socdev;
286 struct snd_soc_codec *codec = socdev->card->codec;
289 wm8731_write(codec, WM8731_ACTIVE, 0x0001);
294 static void wm8731_shutdown(struct snd_pcm_substream *substream,
295 struct snd_soc_dai *dai)
297 struct snd_soc_pcm_runtime *rtd = substream->private_data;
298 struct snd_soc_device *socdev = rtd->socdev;
299 struct snd_soc_codec *codec = socdev->card->codec;
302 if (!codec->active) {
304 wm8731_write(codec, WM8731_ACTIVE, 0x0);
308 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
310 struct snd_soc_codec *codec = dai->codec;
311 u16 mute_reg = wm8731_read_reg_cache(codec, WM8731_APDIGI) & 0xfff7;
314 wm8731_write(codec, WM8731_APDIGI, mute_reg | 0x8);
316 wm8731_write(codec, WM8731_APDIGI, mute_reg);
320 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
321 int clk_id, unsigned int freq, int dir)
323 struct snd_soc_codec *codec = codec_dai->codec;
324 struct wm8731_priv *wm8731 = codec->private_data;
332 wm8731->sysclk = freq;
339 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
342 struct snd_soc_codec *codec = codec_dai->codec;
345 /* set master/slave audio interface */
346 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
347 case SND_SOC_DAIFMT_CBM_CFM:
350 case SND_SOC_DAIFMT_CBS_CFS:
356 /* interface format */
357 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
358 case SND_SOC_DAIFMT_I2S:
361 case SND_SOC_DAIFMT_RIGHT_J:
363 case SND_SOC_DAIFMT_LEFT_J:
366 case SND_SOC_DAIFMT_DSP_A:
369 case SND_SOC_DAIFMT_DSP_B:
376 /* clock inversion */
377 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
378 case SND_SOC_DAIFMT_NB_NF:
380 case SND_SOC_DAIFMT_IB_IF:
383 case SND_SOC_DAIFMT_IB_NF:
386 case SND_SOC_DAIFMT_NB_IF:
394 wm8731_write(codec, WM8731_IFACE, iface);
398 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
399 enum snd_soc_bias_level level)
401 u16 reg = wm8731_read_reg_cache(codec, WM8731_PWR) & 0xff7f;
404 case SND_SOC_BIAS_ON:
405 /* vref/mid, osc on, dac unmute */
406 wm8731_write(codec, WM8731_PWR, reg);
408 case SND_SOC_BIAS_PREPARE:
410 case SND_SOC_BIAS_STANDBY:
411 /* everything off except vref/vmid, */
412 wm8731_write(codec, WM8731_PWR, reg | 0x0040);
414 case SND_SOC_BIAS_OFF:
415 /* everything off, dac mute, inactive */
416 wm8731_write(codec, WM8731_ACTIVE, 0x0);
417 wm8731_write(codec, WM8731_PWR, 0xffff);
420 codec->bias_level = level;
424 #define WM8731_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
425 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
426 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
427 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
428 SNDRV_PCM_RATE_96000)
430 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
431 SNDRV_PCM_FMTBIT_S24_LE)
433 struct snd_soc_dai wm8731_dai = {
436 .stream_name = "Playback",
439 .rates = WM8731_RATES,
440 .formats = WM8731_FORMATS,},
442 .stream_name = "Capture",
445 .rates = WM8731_RATES,
446 .formats = WM8731_FORMATS,},
448 .prepare = wm8731_pcm_prepare,
449 .hw_params = wm8731_hw_params,
450 .shutdown = wm8731_shutdown,
451 .digital_mute = wm8731_mute,
452 .set_sysclk = wm8731_set_dai_sysclk,
453 .set_fmt = wm8731_set_dai_fmt,
456 EXPORT_SYMBOL_GPL(wm8731_dai);
458 static int wm8731_suspend(struct platform_device *pdev, pm_message_t state)
460 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
461 struct snd_soc_codec *codec = socdev->card->codec;
463 wm8731_write(codec, WM8731_ACTIVE, 0x0);
464 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
468 static int wm8731_resume(struct platform_device *pdev)
470 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
471 struct snd_soc_codec *codec = socdev->card->codec;
474 u16 *cache = codec->reg_cache;
476 /* Sync reg_cache with the hardware */
477 for (i = 0; i < ARRAY_SIZE(wm8731_reg); i++) {
478 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
479 data[1] = cache[i] & 0x00ff;
480 codec->hw_write(codec->control_data, data, 2);
482 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
483 wm8731_set_bias_level(codec, codec->suspend_bias_level);
488 * initialise the WM8731 driver
489 * register the mixer and dsp interfaces with the kernel
491 static int wm8731_init(struct snd_soc_device *socdev)
493 struct snd_soc_codec *codec = socdev->card->codec;
496 codec->name = "WM8731";
497 codec->owner = THIS_MODULE;
498 codec->read = wm8731_read_reg_cache;
499 codec->write = wm8731_write;
500 codec->set_bias_level = wm8731_set_bias_level;
501 codec->dai = &wm8731_dai;
503 codec->reg_cache_size = ARRAY_SIZE(wm8731_reg);
504 codec->reg_cache = kmemdup(wm8731_reg, sizeof(wm8731_reg), GFP_KERNEL);
505 if (codec->reg_cache == NULL)
511 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
513 printk(KERN_ERR "wm8731: failed to create pcms\n");
517 /* power on device */
518 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
520 /* set the update bits */
521 reg = wm8731_read_reg_cache(codec, WM8731_LOUT1V);
522 wm8731_write(codec, WM8731_LOUT1V, reg & ~0x0100);
523 reg = wm8731_read_reg_cache(codec, WM8731_ROUT1V);
524 wm8731_write(codec, WM8731_ROUT1V, reg & ~0x0100);
525 reg = wm8731_read_reg_cache(codec, WM8731_LINVOL);
526 wm8731_write(codec, WM8731_LINVOL, reg & ~0x0100);
527 reg = wm8731_read_reg_cache(codec, WM8731_RINVOL);
528 wm8731_write(codec, WM8731_RINVOL, reg & ~0x0100);
530 snd_soc_add_controls(codec, wm8731_snd_controls,
531 ARRAY_SIZE(wm8731_snd_controls));
532 wm8731_add_widgets(codec);
533 ret = snd_soc_init_card(socdev);
535 printk(KERN_ERR "wm8731: failed to register card\n");
542 snd_soc_free_pcms(socdev);
543 snd_soc_dapm_free(socdev);
545 kfree(codec->reg_cache);
549 static struct snd_soc_device *wm8731_socdev;
551 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
554 * WM8731 2 wire address is determined by GPIO5
555 * state during powerup.
560 static int wm8731_i2c_probe(struct i2c_client *i2c,
561 const struct i2c_device_id *id)
563 struct snd_soc_device *socdev = wm8731_socdev;
564 struct snd_soc_codec *codec = socdev->card->codec;
567 i2c_set_clientdata(i2c, codec);
568 codec->control_data = i2c;
570 ret = wm8731_init(socdev);
572 pr_err("failed to initialise WM8731\n");
577 static int wm8731_i2c_remove(struct i2c_client *client)
579 struct snd_soc_codec *codec = i2c_get_clientdata(client);
580 kfree(codec->reg_cache);
584 static const struct i2c_device_id wm8731_i2c_id[] = {
588 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
590 static struct i2c_driver wm8731_i2c_driver = {
592 .name = "WM8731 I2C Codec",
593 .owner = THIS_MODULE,
595 .probe = wm8731_i2c_probe,
596 .remove = wm8731_i2c_remove,
597 .id_table = wm8731_i2c_id,
600 static int wm8731_add_i2c_device(struct platform_device *pdev,
601 const struct wm8731_setup_data *setup)
603 struct i2c_board_info info;
604 struct i2c_adapter *adapter;
605 struct i2c_client *client;
608 ret = i2c_add_driver(&wm8731_i2c_driver);
610 dev_err(&pdev->dev, "can't add i2c driver\n");
614 memset(&info, 0, sizeof(struct i2c_board_info));
615 info.addr = setup->i2c_address;
616 strlcpy(info.type, "wm8731", I2C_NAME_SIZE);
618 adapter = i2c_get_adapter(setup->i2c_bus);
620 dev_err(&pdev->dev, "can't get i2c adapter %d\n",
625 client = i2c_new_device(adapter, &info);
626 i2c_put_adapter(adapter);
628 dev_err(&pdev->dev, "can't add i2c device at 0x%x\n",
629 (unsigned int)info.addr);
636 i2c_del_driver(&wm8731_i2c_driver);
641 #if defined(CONFIG_SPI_MASTER)
642 static int __devinit wm8731_spi_probe(struct spi_device *spi)
644 struct snd_soc_device *socdev = wm8731_socdev;
645 struct snd_soc_codec *codec = socdev->card->codec;
648 codec->control_data = spi;
650 ret = wm8731_init(socdev);
652 dev_err(&spi->dev, "failed to initialise WM8731\n");
657 static int __devexit wm8731_spi_remove(struct spi_device *spi)
662 static struct spi_driver wm8731_spi_driver = {
665 .bus = &spi_bus_type,
666 .owner = THIS_MODULE,
668 .probe = wm8731_spi_probe,
669 .remove = __devexit_p(wm8731_spi_remove),
672 static int wm8731_spi_write(struct spi_device *spi, const char *data, int len)
674 struct spi_transfer t;
675 struct spi_message m;
684 spi_message_init(&m);
685 memset(&t, 0, (sizeof t));
690 spi_message_add_tail(&t, &m);
695 #endif /* CONFIG_SPI_MASTER */
697 static int wm8731_probe(struct platform_device *pdev)
699 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
700 struct wm8731_setup_data *setup;
701 struct snd_soc_codec *codec;
702 struct wm8731_priv *wm8731;
705 pr_info("WM8731 Audio Codec %s", WM8731_VERSION);
707 setup = socdev->codec_data;
708 codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
712 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
713 if (wm8731 == NULL) {
718 codec->private_data = wm8731;
719 socdev->card->codec = codec;
720 mutex_init(&codec->mutex);
721 INIT_LIST_HEAD(&codec->dapm_widgets);
722 INIT_LIST_HEAD(&codec->dapm_paths);
724 wm8731_socdev = socdev;
727 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
728 if (setup->i2c_address) {
729 codec->hw_write = (hw_write_t)i2c_master_send;
730 ret = wm8731_add_i2c_device(pdev, setup);
733 #if defined(CONFIG_SPI_MASTER)
735 codec->hw_write = (hw_write_t)wm8731_spi_write;
736 ret = spi_register_driver(&wm8731_spi_driver);
738 printk(KERN_ERR "can't add spi driver");
743 kfree(codec->private_data);
749 /* power down chip */
750 static int wm8731_remove(struct platform_device *pdev)
752 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
753 struct snd_soc_codec *codec = socdev->card->codec;
755 if (codec->control_data)
756 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
758 snd_soc_free_pcms(socdev);
759 snd_soc_dapm_free(socdev);
760 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
761 i2c_unregister_device(codec->control_data);
762 i2c_del_driver(&wm8731_i2c_driver);
764 #if defined(CONFIG_SPI_MASTER)
765 spi_unregister_driver(&wm8731_spi_driver);
767 kfree(codec->private_data);
773 struct snd_soc_codec_device soc_codec_dev_wm8731 = {
774 .probe = wm8731_probe,
775 .remove = wm8731_remove,
776 .suspend = wm8731_suspend,
777 .resume = wm8731_resume,
779 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731);
781 static int __init wm8731_modinit(void)
783 return snd_soc_register_dai(&wm8731_dai);
785 module_init(wm8731_modinit);
787 static void __exit wm8731_exit(void)
789 snd_soc_unregister_dai(&wm8731_dai);
791 module_exit(wm8731_exit);
793 MODULE_DESCRIPTION("ASoC WM8731 driver");
794 MODULE_AUTHOR("Richard Purdie");
795 MODULE_LICENSE("GPL");