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 <linux/of_device.h>
26 #include <sound/core.h>
27 #include <sound/pcm.h>
28 #include <sound/pcm_params.h>
29 #include <sound/soc.h>
30 #include <sound/initval.h>
31 #include <sound/tlv.h>
35 #define WM8731_NUM_SUPPLIES 4
36 static const char *wm8731_supply_names[WM8731_NUM_SUPPLIES] = {
43 /* codec private data */
45 enum snd_soc_control_type control_type;
46 struct regulator_bulk_data supplies[WM8731_NUM_SUPPLIES];
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"};
70 static const struct soc_enum wm8731_insel_enum =
71 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select);
73 static int wm8731_deemph[] = { 0, 32000, 44100, 48000 };
75 static int wm8731_set_deemph(struct snd_soc_codec *codec)
77 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
80 /* If we're using deemphasis select the nearest available sample
85 for (i = 2; i < ARRAY_SIZE(wm8731_deemph); i++) {
86 if (abs(wm8731_deemph[i] - wm8731->playback_fs) <
87 abs(wm8731_deemph[best] - wm8731->playback_fs))
97 dev_dbg(codec->dev, "Set deemphasis %d (%dHz)\n",
98 best, wm8731_deemph[best]);
100 return snd_soc_update_bits(codec, WM8731_APDIGI, 0x6, val);
103 static int wm8731_get_deemph(struct snd_kcontrol *kcontrol,
104 struct snd_ctl_elem_value *ucontrol)
106 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
107 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
109 ucontrol->value.enumerated.item[0] = wm8731->deemph;
114 static int wm8731_put_deemph(struct snd_kcontrol *kcontrol,
115 struct snd_ctl_elem_value *ucontrol)
117 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
118 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
119 int deemph = ucontrol->value.enumerated.item[0];
125 mutex_lock(&codec->mutex);
126 if (wm8731->deemph != deemph) {
127 wm8731->deemph = deemph;
129 wm8731_set_deemph(codec);
133 mutex_unlock(&codec->mutex);
138 static const DECLARE_TLV_DB_SCALE(in_tlv, -3450, 150, 0);
139 static const DECLARE_TLV_DB_SCALE(sidetone_tlv, -1500, 300, 0);
140 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
141 static const DECLARE_TLV_DB_SCALE(mic_tlv, 0, 2000, 0);
143 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
145 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
147 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
150 SOC_DOUBLE_R_TLV("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0,
152 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
154 SOC_SINGLE_TLV("Mic Boost Volume", WM8731_APANA, 0, 1, 0, mic_tlv),
155 SOC_SINGLE("Mic Capture Switch", WM8731_APANA, 1, 1, 1),
157 SOC_SINGLE_TLV("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1,
160 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
161 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
163 SOC_SINGLE_BOOL_EXT("Playback Deemphasis Switch", 0,
164 wm8731_get_deemph, wm8731_put_deemph),
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_insel_enum);
178 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
179 SND_SOC_DAPM_SUPPLY("ACTIVE",WM8731_ACTIVE, 0, 0, NULL, 0),
180 SND_SOC_DAPM_SUPPLY("OSC", WM8731_PWR, 5, 1, NULL, 0),
181 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
182 &wm8731_output_mixer_controls[0],
183 ARRAY_SIZE(wm8731_output_mixer_controls)),
184 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
185 SND_SOC_DAPM_OUTPUT("LOUT"),
186 SND_SOC_DAPM_OUTPUT("LHPOUT"),
187 SND_SOC_DAPM_OUTPUT("ROUT"),
188 SND_SOC_DAPM_OUTPUT("RHPOUT"),
189 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
190 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
191 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
192 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
193 SND_SOC_DAPM_INPUT("MICIN"),
194 SND_SOC_DAPM_INPUT("RLINEIN"),
195 SND_SOC_DAPM_INPUT("LLINEIN"),
198 static int wm8731_check_osc(struct snd_soc_dapm_widget *source,
199 struct snd_soc_dapm_widget *sink)
201 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(source->codec);
203 return wm8731->sysclk_type == WM8731_SYSCLK_XTAL;
206 static const struct snd_soc_dapm_route wm8731_intercon[] = {
207 {"DAC", NULL, "OSC", wm8731_check_osc},
208 {"ADC", NULL, "OSC", wm8731_check_osc},
209 {"DAC", NULL, "ACTIVE"},
210 {"ADC", NULL, "ACTIVE"},
213 {"Output Mixer", "Line Bypass Switch", "Line Input"},
214 {"Output Mixer", "HiFi Playback Switch", "DAC"},
215 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
218 {"RHPOUT", NULL, "Output Mixer"},
219 {"ROUT", NULL, "Output Mixer"},
220 {"LHPOUT", NULL, "Output Mixer"},
221 {"LOUT", NULL, "Output Mixer"},
224 {"Input Mux", "Line In", "Line Input"},
225 {"Input Mux", "Mic", "Mic Bias"},
226 {"ADC", NULL, "Input Mux"},
229 {"Line Input", NULL, "LLINEIN"},
230 {"Line Input", NULL, "RLINEIN"},
231 {"Mic Bias", NULL, "MICIN"},
243 /* codec mclk clock divider coefficients */
244 static const struct _coeff_div coeff_div[] = {
246 {12288000, 48000, 256, 0x0, 0x0, 0x0},
247 {18432000, 48000, 384, 0x0, 0x1, 0x0},
248 {12000000, 48000, 250, 0x0, 0x0, 0x1},
251 {12288000, 32000, 384, 0x6, 0x0, 0x0},
252 {18432000, 32000, 576, 0x6, 0x1, 0x0},
253 {12000000, 32000, 375, 0x6, 0x0, 0x1},
256 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
257 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
258 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
259 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
260 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
263 {12288000, 96000, 128, 0x7, 0x0, 0x0},
264 {18432000, 96000, 192, 0x7, 0x1, 0x0},
265 {12000000, 96000, 125, 0x7, 0x0, 0x1},
268 {11289600, 44100, 256, 0x8, 0x0, 0x0},
269 {16934400, 44100, 384, 0x8, 0x1, 0x0},
270 {12000000, 44100, 272, 0x8, 0x1, 0x1},
273 {11289600, 88200, 128, 0xf, 0x0, 0x0},
274 {16934400, 88200, 192, 0xf, 0x1, 0x0},
275 {12000000, 88200, 136, 0xf, 0x1, 0x1},
278 static inline int get_coeff(int mclk, int rate)
282 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
283 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
289 static int wm8731_hw_params(struct snd_pcm_substream *substream,
290 struct snd_pcm_hw_params *params,
291 struct snd_soc_dai *dai)
293 struct snd_soc_codec *codec = dai->codec;
294 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
295 u16 iface = snd_soc_read(codec, WM8731_IFACE) & 0xfff3;
296 int i = get_coeff(wm8731->sysclk, params_rate(params));
297 u16 srate = (coeff_div[i].sr << 2) |
298 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
300 wm8731->playback_fs = params_rate(params);
302 snd_soc_write(codec, WM8731_SRATE, srate);
305 switch (params_format(params)) {
306 case SNDRV_PCM_FORMAT_S16_LE:
308 case SNDRV_PCM_FORMAT_S20_3LE:
311 case SNDRV_PCM_FORMAT_S24_LE:
316 wm8731_set_deemph(codec);
318 snd_soc_write(codec, WM8731_IFACE, iface);
322 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
324 struct snd_soc_codec *codec = dai->codec;
325 u16 mute_reg = snd_soc_read(codec, WM8731_APDIGI) & 0xfff7;
328 snd_soc_write(codec, WM8731_APDIGI, mute_reg | 0x8);
330 snd_soc_write(codec, WM8731_APDIGI, mute_reg);
334 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
335 int clk_id, unsigned int freq, int dir)
337 struct snd_soc_codec *codec = codec_dai->codec;
338 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
341 case WM8731_SYSCLK_XTAL:
342 case WM8731_SYSCLK_MCLK:
343 wm8731->sysclk_type = clk_id;
355 wm8731->sysclk = freq;
361 snd_soc_dapm_sync(&codec->dapm);
367 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
370 struct snd_soc_codec *codec = codec_dai->codec;
373 /* set master/slave audio interface */
374 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
375 case SND_SOC_DAIFMT_CBM_CFM:
378 case SND_SOC_DAIFMT_CBS_CFS:
384 /* interface format */
385 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
386 case SND_SOC_DAIFMT_I2S:
389 case SND_SOC_DAIFMT_RIGHT_J:
391 case SND_SOC_DAIFMT_LEFT_J:
394 case SND_SOC_DAIFMT_DSP_A:
397 case SND_SOC_DAIFMT_DSP_B:
404 /* clock inversion */
405 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
406 case SND_SOC_DAIFMT_NB_NF:
408 case SND_SOC_DAIFMT_IB_IF:
411 case SND_SOC_DAIFMT_IB_NF:
414 case SND_SOC_DAIFMT_NB_IF:
422 snd_soc_write(codec, WM8731_IFACE, iface);
426 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
427 enum snd_soc_bias_level level)
429 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
434 case SND_SOC_BIAS_ON:
436 case SND_SOC_BIAS_PREPARE:
438 case SND_SOC_BIAS_STANDBY:
439 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
440 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
445 snd_soc_cache_sync(codec);
448 /* Clear PWROFF, gate CLKOUT, everything else as-is */
449 reg = snd_soc_read(codec, WM8731_PWR) & 0xff7f;
450 snd_soc_write(codec, WM8731_PWR, reg | 0x0040);
452 case SND_SOC_BIAS_OFF:
453 snd_soc_write(codec, WM8731_PWR, 0xffff);
454 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies),
456 codec->cache_sync = 1;
459 codec->dapm.bias_level = level;
463 #define WM8731_RATES SNDRV_PCM_RATE_8000_96000
465 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
466 SNDRV_PCM_FMTBIT_S24_LE)
468 static struct snd_soc_dai_ops wm8731_dai_ops = {
469 .hw_params = wm8731_hw_params,
470 .digital_mute = wm8731_mute,
471 .set_sysclk = wm8731_set_dai_sysclk,
472 .set_fmt = wm8731_set_dai_fmt,
475 static struct snd_soc_dai_driver wm8731_dai = {
476 .name = "wm8731-hifi",
478 .stream_name = "Playback",
481 .rates = WM8731_RATES,
482 .formats = WM8731_FORMATS,},
484 .stream_name = "Capture",
487 .rates = WM8731_RATES,
488 .formats = WM8731_FORMATS,},
489 .ops = &wm8731_dai_ops,
490 .symmetric_rates = 1,
494 static int wm8731_suspend(struct snd_soc_codec *codec, pm_message_t state)
496 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
501 static int wm8731_resume(struct snd_soc_codec *codec)
503 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
508 #define wm8731_suspend NULL
509 #define wm8731_resume NULL
512 static int wm8731_probe(struct snd_soc_codec *codec)
514 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
517 ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8731->control_type);
519 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
523 for (i = 0; i < ARRAY_SIZE(wm8731->supplies); i++)
524 wm8731->supplies[i].supply = wm8731_supply_names[i];
526 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8731->supplies),
529 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
533 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
536 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
537 goto err_regulator_get;
540 ret = wm8731_reset(codec);
542 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
543 goto err_regulator_enable;
546 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
548 /* Latch the update bits */
549 snd_soc_update_bits(codec, WM8731_LOUT1V, 0x100, 0);
550 snd_soc_update_bits(codec, WM8731_ROUT1V, 0x100, 0);
551 snd_soc_update_bits(codec, WM8731_LINVOL, 0x100, 0);
552 snd_soc_update_bits(codec, WM8731_RINVOL, 0x100, 0);
554 /* Disable bypass path by default */
555 snd_soc_update_bits(codec, WM8731_APANA, 0x8, 0);
557 snd_soc_add_controls(codec, wm8731_snd_controls,
558 ARRAY_SIZE(wm8731_snd_controls));
560 /* Regulators will have been enabled by bias management */
561 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
565 err_regulator_enable:
566 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
568 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
573 /* power down chip */
574 static int wm8731_remove(struct snd_soc_codec *codec)
576 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
578 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
580 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
581 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
586 static struct snd_soc_codec_driver soc_codec_dev_wm8731 = {
587 .probe = wm8731_probe,
588 .remove = wm8731_remove,
589 .suspend = wm8731_suspend,
590 .resume = wm8731_resume,
591 .set_bias_level = wm8731_set_bias_level,
592 .reg_cache_size = ARRAY_SIZE(wm8731_reg),
593 .reg_word_size = sizeof(u16),
594 .reg_cache_default = wm8731_reg,
595 .dapm_widgets = wm8731_dapm_widgets,
596 .num_dapm_widgets = ARRAY_SIZE(wm8731_dapm_widgets),
597 .dapm_routes = wm8731_intercon,
598 .num_dapm_routes = ARRAY_SIZE(wm8731_intercon),
601 static const struct of_device_id wm8731_of_match[] = {
602 { .compatible = "wlf,wm8731", },
606 MODULE_DEVICE_TABLE(of, wm8731_of_match);
608 #if defined(CONFIG_SPI_MASTER)
609 static int __devinit wm8731_spi_probe(struct spi_device *spi)
611 struct wm8731_priv *wm8731;
614 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
618 wm8731->control_type = SND_SOC_SPI;
619 spi_set_drvdata(spi, wm8731);
621 ret = snd_soc_register_codec(&spi->dev,
622 &soc_codec_dev_wm8731, &wm8731_dai, 1);
628 static int __devexit wm8731_spi_remove(struct spi_device *spi)
630 snd_soc_unregister_codec(&spi->dev);
631 kfree(spi_get_drvdata(spi));
635 static struct spi_driver wm8731_spi_driver = {
638 .owner = THIS_MODULE,
639 .of_match_table = wm8731_of_match,
641 .probe = wm8731_spi_probe,
642 .remove = __devexit_p(wm8731_spi_remove),
644 #endif /* CONFIG_SPI_MASTER */
646 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
647 static __devinit int wm8731_i2c_probe(struct i2c_client *i2c,
648 const struct i2c_device_id *id)
650 struct wm8731_priv *wm8731;
653 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
657 i2c_set_clientdata(i2c, wm8731);
658 wm8731->control_type = SND_SOC_I2C;
660 ret = snd_soc_register_codec(&i2c->dev,
661 &soc_codec_dev_wm8731, &wm8731_dai, 1);
667 static __devexit int wm8731_i2c_remove(struct i2c_client *client)
669 snd_soc_unregister_codec(&client->dev);
670 kfree(i2c_get_clientdata(client));
674 static const struct i2c_device_id wm8731_i2c_id[] = {
678 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
680 static struct i2c_driver wm8731_i2c_driver = {
683 .owner = THIS_MODULE,
684 .of_match_table = wm8731_of_match,
686 .probe = wm8731_i2c_probe,
687 .remove = __devexit_p(wm8731_i2c_remove),
688 .id_table = wm8731_i2c_id,
692 static int __init wm8731_modinit(void)
695 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
696 ret = i2c_add_driver(&wm8731_i2c_driver);
698 printk(KERN_ERR "Failed to register WM8731 I2C driver: %d\n",
702 #if defined(CONFIG_SPI_MASTER)
703 ret = spi_register_driver(&wm8731_spi_driver);
705 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
711 module_init(wm8731_modinit);
713 static void __exit wm8731_exit(void)
715 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
716 i2c_del_driver(&wm8731_i2c_driver);
718 #if defined(CONFIG_SPI_MASTER)
719 spi_unregister_driver(&wm8731_spi_driver);
722 module_exit(wm8731_exit);
724 MODULE_DESCRIPTION("ASoC WM8731 driver");
725 MODULE_AUTHOR("Richard Purdie");
726 MODULE_LICENSE("GPL");