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 <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
31 #define AUDIO_NAME "wm8731"
32 #define WM8731_VERSION "0.13"
38 #define WM8731_DEBUG 0
41 #define dbg(format, arg...) \
42 printk(KERN_DEBUG AUDIO_NAME ": " format "\n" , ## arg)
44 #define dbg(format, arg...) do {} while (0)
46 #define err(format, arg...) \
47 printk(KERN_ERR AUDIO_NAME ": " format "\n" , ## arg)
48 #define info(format, arg...) \
49 printk(KERN_INFO AUDIO_NAME ": " format "\n" , ## arg)
50 #define warn(format, arg...) \
51 printk(KERN_WARNING AUDIO_NAME ": " format "\n" , ## arg)
53 struct snd_soc_codec_device soc_codec_dev_wm8731;
55 /* codec private data */
61 * wm8731 register cache
62 * We can't read the WM8731 register space when we are
63 * using 2 wire for device control, so we cache them instead.
64 * There is no point in caching the reset register
66 static const u16 wm8731_reg[WM8731_CACHEREGNUM] = {
67 0x0097, 0x0097, 0x0079, 0x0079,
68 0x000a, 0x0008, 0x009f, 0x000a,
73 * read wm8731 register cache
75 static inline unsigned int wm8731_read_reg_cache(struct snd_soc_codec *codec,
78 u16 *cache = codec->reg_cache;
79 if (reg == WM8731_RESET)
81 if (reg >= WM8731_CACHEREGNUM)
87 * write wm8731 register cache
89 static inline void wm8731_write_reg_cache(struct snd_soc_codec *codec,
90 u16 reg, unsigned int value)
92 u16 *cache = codec->reg_cache;
93 if (reg >= WM8731_CACHEREGNUM)
99 * write to the WM8731 register space
101 static int wm8731_write(struct snd_soc_codec *codec, unsigned int reg,
107 * D15..D9 WM8731 register offset
108 * D8...D0 register data
110 data[0] = (reg << 1) | ((value >> 8) & 0x0001);
111 data[1] = value & 0x00ff;
113 wm8731_write_reg_cache(codec, reg, value);
114 if (codec->hw_write(codec->control_data, data, 2) == 2)
120 #define wm8731_reset(c) wm8731_write(c, WM8731_RESET, 0)
122 static const char *wm8731_input_select[] = {"Line In", "Mic"};
123 static const char *wm8731_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
125 static const struct soc_enum wm8731_enum[] = {
126 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select),
127 SOC_ENUM_SINGLE(WM8731_APDIGI, 1, 4, wm8731_deemph),
130 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
132 SOC_DOUBLE_R("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
134 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
137 SOC_DOUBLE_R("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0),
138 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
140 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA, 0, 1, 0),
141 SOC_SINGLE("Capture Mic Switch", WM8731_APANA, 1, 1, 1),
143 SOC_SINGLE("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1),
145 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
146 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
148 SOC_ENUM("Playback De-emphasis", wm8731_enum[1]),
151 /* add non dapm controls */
152 static int wm8731_add_controls(struct snd_soc_codec *codec)
156 for (i = 0; i < ARRAY_SIZE(wm8731_snd_controls); i++) {
157 err = snd_ctl_add(codec->card,
158 snd_soc_cnew(&wm8731_snd_controls[i],
168 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
169 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
170 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
171 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
175 static const struct snd_kcontrol_new wm8731_input_mux_controls =
176 SOC_DAPM_ENUM("Input Select", wm8731_enum[0]);
178 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
179 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
180 &wm8731_output_mixer_controls[0],
181 ARRAY_SIZE(wm8731_output_mixer_controls)),
182 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
183 SND_SOC_DAPM_OUTPUT("LOUT"),
184 SND_SOC_DAPM_OUTPUT("LHPOUT"),
185 SND_SOC_DAPM_OUTPUT("ROUT"),
186 SND_SOC_DAPM_OUTPUT("RHPOUT"),
187 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
188 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
189 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
190 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
191 SND_SOC_DAPM_INPUT("MICIN"),
192 SND_SOC_DAPM_INPUT("RLINEIN"),
193 SND_SOC_DAPM_INPUT("LLINEIN"),
196 static const struct snd_soc_dapm_route intercon[] = {
198 {"Output Mixer", "Line Bypass Switch", "Line Input"},
199 {"Output Mixer", "HiFi Playback Switch", "DAC"},
200 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
203 {"RHPOUT", NULL, "Output Mixer"},
204 {"ROUT", NULL, "Output Mixer"},
205 {"LHPOUT", NULL, "Output Mixer"},
206 {"LOUT", NULL, "Output Mixer"},
209 {"Input Mux", "Line In", "Line Input"},
210 {"Input Mux", "Mic", "Mic Bias"},
211 {"ADC", NULL, "Input Mux"},
214 {"Line Input", NULL, "LLINEIN"},
215 {"Line Input", NULL, "RLINEIN"},
216 {"Mic Bias", NULL, "MICIN"},
219 static int wm8731_add_widgets(struct snd_soc_codec *codec)
221 snd_soc_dapm_new_controls(codec, wm8731_dapm_widgets,
222 ARRAY_SIZE(wm8731_dapm_widgets));
224 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
226 snd_soc_dapm_new_widgets(codec);
239 /* codec mclk clock divider coefficients */
240 static const struct _coeff_div coeff_div[] = {
242 {12288000, 48000, 256, 0x0, 0x0, 0x0},
243 {18432000, 48000, 384, 0x0, 0x1, 0x0},
244 {12000000, 48000, 250, 0x0, 0x0, 0x1},
247 {12288000, 32000, 384, 0x6, 0x0, 0x0},
248 {18432000, 32000, 576, 0x6, 0x1, 0x0},
249 {12000000, 32000, 375, 0x6, 0x0, 0x1},
252 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
253 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
254 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
255 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
256 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
259 {12288000, 96000, 128, 0x7, 0x0, 0x0},
260 {18432000, 96000, 192, 0x7, 0x1, 0x0},
261 {12000000, 96000, 125, 0x7, 0x0, 0x1},
264 {11289600, 44100, 256, 0x8, 0x0, 0x0},
265 {16934400, 44100, 384, 0x8, 0x1, 0x0},
266 {12000000, 44100, 272, 0x8, 0x1, 0x1},
269 {11289600, 88200, 128, 0xf, 0x0, 0x0},
270 {16934400, 88200, 192, 0xf, 0x1, 0x0},
271 {12000000, 88200, 136, 0xf, 0x1, 0x1},
274 static inline int get_coeff(int mclk, int rate)
278 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
279 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
285 static int wm8731_hw_params(struct snd_pcm_substream *substream,
286 struct snd_pcm_hw_params *params)
288 struct snd_soc_pcm_runtime *rtd = substream->private_data;
289 struct snd_soc_device *socdev = rtd->socdev;
290 struct snd_soc_codec *codec = socdev->codec;
291 struct wm8731_priv *wm8731 = codec->private_data;
292 u16 iface = wm8731_read_reg_cache(codec, WM8731_IFACE) & 0xfff3;
293 int i = get_coeff(wm8731->sysclk, params_rate(params));
294 u16 srate = (coeff_div[i].sr << 2) |
295 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
297 wm8731_write(codec, WM8731_SRATE, srate);
300 switch (params_format(params)) {
301 case SNDRV_PCM_FORMAT_S16_LE:
303 case SNDRV_PCM_FORMAT_S20_3LE:
306 case SNDRV_PCM_FORMAT_S24_LE:
311 wm8731_write(codec, WM8731_IFACE, iface);
315 static int wm8731_pcm_prepare(struct snd_pcm_substream *substream)
317 struct snd_soc_pcm_runtime *rtd = substream->private_data;
318 struct snd_soc_device *socdev = rtd->socdev;
319 struct snd_soc_codec *codec = socdev->codec;
322 wm8731_write(codec, WM8731_ACTIVE, 0x0001);
327 static void wm8731_shutdown(struct snd_pcm_substream *substream)
329 struct snd_soc_pcm_runtime *rtd = substream->private_data;
330 struct snd_soc_device *socdev = rtd->socdev;
331 struct snd_soc_codec *codec = socdev->codec;
334 if (!codec->active) {
336 wm8731_write(codec, WM8731_ACTIVE, 0x0);
340 static int wm8731_mute(struct snd_soc_codec_dai *dai, int mute)
342 struct snd_soc_codec *codec = dai->codec;
343 u16 mute_reg = wm8731_read_reg_cache(codec, WM8731_APDIGI) & 0xfff7;
346 wm8731_write(codec, WM8731_APDIGI, mute_reg | 0x8);
348 wm8731_write(codec, WM8731_APDIGI, mute_reg);
352 static int wm8731_set_dai_sysclk(struct snd_soc_codec_dai *codec_dai,
353 int clk_id, unsigned int freq, int dir)
355 struct snd_soc_codec *codec = codec_dai->codec;
356 struct wm8731_priv *wm8731 = codec->private_data;
364 wm8731->sysclk = freq;
371 static int wm8731_set_dai_fmt(struct snd_soc_codec_dai *codec_dai,
374 struct snd_soc_codec *codec = codec_dai->codec;
377 /* set master/slave audio interface */
378 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
379 case SND_SOC_DAIFMT_CBM_CFM:
382 case SND_SOC_DAIFMT_CBS_CFS:
388 /* interface format */
389 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
390 case SND_SOC_DAIFMT_I2S:
393 case SND_SOC_DAIFMT_RIGHT_J:
395 case SND_SOC_DAIFMT_LEFT_J:
398 case SND_SOC_DAIFMT_DSP_A:
401 case SND_SOC_DAIFMT_DSP_B:
408 /* clock inversion */
409 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
410 case SND_SOC_DAIFMT_NB_NF:
412 case SND_SOC_DAIFMT_IB_IF:
415 case SND_SOC_DAIFMT_IB_NF:
418 case SND_SOC_DAIFMT_NB_IF:
426 wm8731_write(codec, WM8731_IFACE, iface);
430 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
431 enum snd_soc_bias_level level)
433 u16 reg = wm8731_read_reg_cache(codec, WM8731_PWR) & 0xff7f;
436 case SND_SOC_BIAS_ON:
437 /* vref/mid, osc on, dac unmute */
438 wm8731_write(codec, WM8731_PWR, reg);
440 case SND_SOC_BIAS_PREPARE:
442 case SND_SOC_BIAS_STANDBY:
443 /* everything off except vref/vmid, */
444 wm8731_write(codec, WM8731_PWR, reg | 0x0040);
446 case SND_SOC_BIAS_OFF:
447 /* everything off, dac mute, inactive */
448 wm8731_write(codec, WM8731_ACTIVE, 0x0);
449 wm8731_write(codec, WM8731_PWR, 0xffff);
452 codec->bias_level = level;
456 #define WM8731_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
457 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
458 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
459 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
460 SNDRV_PCM_RATE_96000)
462 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
463 SNDRV_PCM_FMTBIT_S24_LE)
465 struct snd_soc_codec_dai wm8731_dai = {
468 .stream_name = "Playback",
471 .rates = WM8731_RATES,
472 .formats = WM8731_FORMATS,},
474 .stream_name = "Capture",
477 .rates = WM8731_RATES,
478 .formats = WM8731_FORMATS,},
480 .prepare = wm8731_pcm_prepare,
481 .hw_params = wm8731_hw_params,
482 .shutdown = wm8731_shutdown,
485 .digital_mute = wm8731_mute,
486 .set_sysclk = wm8731_set_dai_sysclk,
487 .set_fmt = wm8731_set_dai_fmt,
490 EXPORT_SYMBOL_GPL(wm8731_dai);
492 static int wm8731_suspend(struct platform_device *pdev, pm_message_t state)
494 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
495 struct snd_soc_codec *codec = socdev->codec;
497 wm8731_write(codec, WM8731_ACTIVE, 0x0);
498 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
502 static int wm8731_resume(struct platform_device *pdev)
504 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
505 struct snd_soc_codec *codec = socdev->codec;
508 u16 *cache = codec->reg_cache;
510 /* Sync reg_cache with the hardware */
511 for (i = 0; i < ARRAY_SIZE(wm8731_reg); i++) {
512 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
513 data[1] = cache[i] & 0x00ff;
514 codec->hw_write(codec->control_data, data, 2);
516 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
517 wm8731_set_bias_level(codec, codec->suspend_bias_level);
522 * initialise the WM8731 driver
523 * register the mixer and dsp interfaces with the kernel
525 static int wm8731_init(struct snd_soc_device *socdev)
527 struct snd_soc_codec *codec = socdev->codec;
530 codec->name = "WM8731";
531 codec->owner = THIS_MODULE;
532 codec->read = wm8731_read_reg_cache;
533 codec->write = wm8731_write;
534 codec->set_bias_level = wm8731_set_bias_level;
535 codec->dai = &wm8731_dai;
537 codec->reg_cache_size = ARRAY_SIZE(wm8731_reg);
538 codec->reg_cache = kmemdup(wm8731_reg, sizeof(wm8731_reg), GFP_KERNEL);
539 if (codec->reg_cache == NULL)
545 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
547 printk(KERN_ERR "wm8731: failed to create pcms\n");
551 /* power on device */
552 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
554 /* set the update bits */
555 reg = wm8731_read_reg_cache(codec, WM8731_LOUT1V);
556 wm8731_write(codec, WM8731_LOUT1V, reg & ~0x0100);
557 reg = wm8731_read_reg_cache(codec, WM8731_ROUT1V);
558 wm8731_write(codec, WM8731_ROUT1V, reg & ~0x0100);
559 reg = wm8731_read_reg_cache(codec, WM8731_LINVOL);
560 wm8731_write(codec, WM8731_LINVOL, reg & ~0x0100);
561 reg = wm8731_read_reg_cache(codec, WM8731_RINVOL);
562 wm8731_write(codec, WM8731_RINVOL, reg & ~0x0100);
564 wm8731_add_controls(codec);
565 wm8731_add_widgets(codec);
566 ret = snd_soc_register_card(socdev);
568 printk(KERN_ERR "wm8731: failed to register card\n");
575 snd_soc_free_pcms(socdev);
576 snd_soc_dapm_free(socdev);
578 kfree(codec->reg_cache);
582 static struct snd_soc_device *wm8731_socdev;
584 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
587 * WM8731 2 wire address is determined by GPIO5
588 * state during powerup.
592 static unsigned short normal_i2c[] = { 0, I2C_CLIENT_END };
594 /* Magic definition of all other variables and things */
597 static struct i2c_driver wm8731_i2c_driver;
598 static struct i2c_client client_template;
600 /* If the i2c layer weren't so broken, we could pass this kind of data
603 static int wm8731_codec_probe(struct i2c_adapter *adap, int addr, int kind)
605 struct snd_soc_device *socdev = wm8731_socdev;
606 struct wm8731_setup_data *setup = socdev->codec_data;
607 struct snd_soc_codec *codec = socdev->codec;
608 struct i2c_client *i2c;
611 if (addr != setup->i2c_address)
614 client_template.adapter = adap;
615 client_template.addr = addr;
617 i2c = kmemdup(&client_template, sizeof(client_template), GFP_KERNEL);
622 i2c_set_clientdata(i2c, codec);
623 codec->control_data = i2c;
625 ret = i2c_attach_client(i2c);
627 err("failed to attach codec at addr %x\n", addr);
631 ret = wm8731_init(socdev);
633 err("failed to initialise WM8731\n");
644 static int wm8731_i2c_detach(struct i2c_client *client)
646 struct snd_soc_codec *codec = i2c_get_clientdata(client);
647 i2c_detach_client(client);
648 kfree(codec->reg_cache);
653 static int wm8731_i2c_attach(struct i2c_adapter *adap)
655 return i2c_probe(adap, &addr_data, wm8731_codec_probe);
658 /* corgi i2c codec control layer */
659 static struct i2c_driver wm8731_i2c_driver = {
661 .name = "WM8731 I2C Codec",
662 .owner = THIS_MODULE,
664 .id = I2C_DRIVERID_WM8731,
665 .attach_adapter = wm8731_i2c_attach,
666 .detach_client = wm8731_i2c_detach,
670 static struct i2c_client client_template = {
672 .driver = &wm8731_i2c_driver,
676 static int wm8731_probe(struct platform_device *pdev)
678 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
679 struct wm8731_setup_data *setup;
680 struct snd_soc_codec *codec;
681 struct wm8731_priv *wm8731;
684 info("WM8731 Audio Codec %s", WM8731_VERSION);
686 setup = socdev->codec_data;
687 codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
691 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
692 if (wm8731 == NULL) {
697 codec->private_data = wm8731;
698 socdev->codec = codec;
699 mutex_init(&codec->mutex);
700 INIT_LIST_HEAD(&codec->dapm_widgets);
701 INIT_LIST_HEAD(&codec->dapm_paths);
703 wm8731_socdev = socdev;
704 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
705 if (setup->i2c_address) {
706 normal_i2c[0] = setup->i2c_address;
707 codec->hw_write = (hw_write_t)i2c_master_send;
708 ret = i2c_add_driver(&wm8731_i2c_driver);
710 printk(KERN_ERR "can't add i2c driver");
713 /* Add other interfaces here */
718 /* power down chip */
719 static int wm8731_remove(struct platform_device *pdev)
721 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
722 struct snd_soc_codec *codec = socdev->codec;
724 if (codec->control_data)
725 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
727 snd_soc_free_pcms(socdev);
728 snd_soc_dapm_free(socdev);
729 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
730 i2c_del_driver(&wm8731_i2c_driver);
732 kfree(codec->private_data);
738 struct snd_soc_codec_device soc_codec_dev_wm8731 = {
739 .probe = wm8731_probe,
740 .remove = wm8731_remove,
741 .suspend = wm8731_suspend,
742 .resume = wm8731_resume,
744 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731);
746 MODULE_DESCRIPTION("ASoC WM8731 driver");
747 MODULE_AUTHOR("Richard Purdie");
748 MODULE_LICENSE("GPL");