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/regmap.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 struct regmap *regmap;
46 struct regulator_bulk_data supplies[WM8731_NUM_SUPPLIES];
55 * wm8731 register cache
57 static const struct reg_default wm8731_reg_defaults[] = {
70 static bool wm8731_volatile(struct device *dev, unsigned int reg)
72 return reg == WM8731_RESET;
75 static bool wm8731_writeable(struct device *dev, unsigned int reg)
77 return reg <= WM8731_RESET;
80 #define wm8731_reset(c) snd_soc_write(c, WM8731_RESET, 0)
82 static const char *wm8731_input_select[] = {"Line In", "Mic"};
84 static const struct soc_enum wm8731_insel_enum =
85 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select);
87 static int wm8731_deemph[] = { 0, 32000, 44100, 48000 };
89 static int wm8731_set_deemph(struct snd_soc_codec *codec)
91 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
94 /* If we're using deemphasis select the nearest available sample
99 for (i = 2; i < ARRAY_SIZE(wm8731_deemph); i++) {
100 if (abs(wm8731_deemph[i] - wm8731->playback_fs) <
101 abs(wm8731_deemph[best] - wm8731->playback_fs))
111 dev_dbg(codec->dev, "Set deemphasis %d (%dHz)\n",
112 best, wm8731_deemph[best]);
114 return snd_soc_update_bits(codec, WM8731_APDIGI, 0x6, val);
117 static int wm8731_get_deemph(struct snd_kcontrol *kcontrol,
118 struct snd_ctl_elem_value *ucontrol)
120 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
121 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
123 ucontrol->value.enumerated.item[0] = wm8731->deemph;
128 static int wm8731_put_deemph(struct snd_kcontrol *kcontrol,
129 struct snd_ctl_elem_value *ucontrol)
131 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
132 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
133 int deemph = ucontrol->value.enumerated.item[0];
139 mutex_lock(&codec->mutex);
140 if (wm8731->deemph != deemph) {
141 wm8731->deemph = deemph;
143 wm8731_set_deemph(codec);
147 mutex_unlock(&codec->mutex);
152 static const DECLARE_TLV_DB_SCALE(in_tlv, -3450, 150, 0);
153 static const DECLARE_TLV_DB_SCALE(sidetone_tlv, -1500, 300, 0);
154 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
155 static const DECLARE_TLV_DB_SCALE(mic_tlv, 0, 2000, 0);
157 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
159 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
161 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
164 SOC_DOUBLE_R_TLV("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0,
166 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
168 SOC_SINGLE_TLV("Mic Boost Volume", WM8731_APANA, 0, 1, 0, mic_tlv),
169 SOC_SINGLE("Mic Capture Switch", WM8731_APANA, 1, 1, 1),
171 SOC_SINGLE_TLV("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1,
174 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
175 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
177 SOC_SINGLE_BOOL_EXT("Playback Deemphasis Switch", 0,
178 wm8731_get_deemph, wm8731_put_deemph),
182 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
183 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
184 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
185 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
189 static const struct snd_kcontrol_new wm8731_input_mux_controls =
190 SOC_DAPM_ENUM("Input Select", wm8731_insel_enum);
192 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
193 SND_SOC_DAPM_SUPPLY("ACTIVE",WM8731_ACTIVE, 0, 0, NULL, 0),
194 SND_SOC_DAPM_SUPPLY("OSC", WM8731_PWR, 5, 1, NULL, 0),
195 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
196 &wm8731_output_mixer_controls[0],
197 ARRAY_SIZE(wm8731_output_mixer_controls)),
198 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
199 SND_SOC_DAPM_OUTPUT("LOUT"),
200 SND_SOC_DAPM_OUTPUT("LHPOUT"),
201 SND_SOC_DAPM_OUTPUT("ROUT"),
202 SND_SOC_DAPM_OUTPUT("RHPOUT"),
203 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
204 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
205 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
206 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
207 SND_SOC_DAPM_INPUT("MICIN"),
208 SND_SOC_DAPM_INPUT("RLINEIN"),
209 SND_SOC_DAPM_INPUT("LLINEIN"),
212 static int wm8731_check_osc(struct snd_soc_dapm_widget *source,
213 struct snd_soc_dapm_widget *sink)
215 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(source->codec);
217 return wm8731->sysclk_type == WM8731_SYSCLK_XTAL;
220 static const struct snd_soc_dapm_route wm8731_intercon[] = {
221 {"DAC", NULL, "OSC", wm8731_check_osc},
222 {"ADC", NULL, "OSC", wm8731_check_osc},
223 {"DAC", NULL, "ACTIVE"},
224 {"ADC", NULL, "ACTIVE"},
227 {"Output Mixer", "Line Bypass Switch", "Line Input"},
228 {"Output Mixer", "HiFi Playback Switch", "DAC"},
229 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
232 {"RHPOUT", NULL, "Output Mixer"},
233 {"ROUT", NULL, "Output Mixer"},
234 {"LHPOUT", NULL, "Output Mixer"},
235 {"LOUT", NULL, "Output Mixer"},
238 {"Input Mux", "Line In", "Line Input"},
239 {"Input Mux", "Mic", "Mic Bias"},
240 {"ADC", NULL, "Input Mux"},
243 {"Line Input", NULL, "LLINEIN"},
244 {"Line Input", NULL, "RLINEIN"},
245 {"Mic Bias", NULL, "MICIN"},
257 /* codec mclk clock divider coefficients */
258 static const struct _coeff_div coeff_div[] = {
260 {12288000, 48000, 256, 0x0, 0x0, 0x0},
261 {18432000, 48000, 384, 0x0, 0x1, 0x0},
262 {12000000, 48000, 250, 0x0, 0x0, 0x1},
265 {12288000, 32000, 384, 0x6, 0x0, 0x0},
266 {18432000, 32000, 576, 0x6, 0x1, 0x0},
267 {12000000, 32000, 375, 0x6, 0x0, 0x1},
270 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
271 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
272 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
273 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
274 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
277 {12288000, 96000, 128, 0x7, 0x0, 0x0},
278 {18432000, 96000, 192, 0x7, 0x1, 0x0},
279 {12000000, 96000, 125, 0x7, 0x0, 0x1},
282 {11289600, 44100, 256, 0x8, 0x0, 0x0},
283 {16934400, 44100, 384, 0x8, 0x1, 0x0},
284 {12000000, 44100, 272, 0x8, 0x1, 0x1},
287 {11289600, 88200, 128, 0xf, 0x0, 0x0},
288 {16934400, 88200, 192, 0xf, 0x1, 0x0},
289 {12000000, 88200, 136, 0xf, 0x1, 0x1},
292 static inline int get_coeff(int mclk, int rate)
296 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
297 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
303 static int wm8731_hw_params(struct snd_pcm_substream *substream,
304 struct snd_pcm_hw_params *params,
305 struct snd_soc_dai *dai)
307 struct snd_soc_codec *codec = dai->codec;
308 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
309 u16 iface = snd_soc_read(codec, WM8731_IFACE) & 0xfff3;
310 int i = get_coeff(wm8731->sysclk, params_rate(params));
311 u16 srate = (coeff_div[i].sr << 2) |
312 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
314 wm8731->playback_fs = params_rate(params);
316 snd_soc_write(codec, WM8731_SRATE, srate);
319 switch (params_format(params)) {
320 case SNDRV_PCM_FORMAT_S16_LE:
322 case SNDRV_PCM_FORMAT_S20_3LE:
325 case SNDRV_PCM_FORMAT_S24_LE:
330 wm8731_set_deemph(codec);
332 snd_soc_write(codec, WM8731_IFACE, iface);
336 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
338 struct snd_soc_codec *codec = dai->codec;
339 u16 mute_reg = snd_soc_read(codec, WM8731_APDIGI) & 0xfff7;
342 snd_soc_write(codec, WM8731_APDIGI, mute_reg | 0x8);
344 snd_soc_write(codec, WM8731_APDIGI, mute_reg);
348 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
349 int clk_id, unsigned int freq, int dir)
351 struct snd_soc_codec *codec = codec_dai->codec;
352 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
355 case WM8731_SYSCLK_XTAL:
356 case WM8731_SYSCLK_MCLK:
357 wm8731->sysclk_type = clk_id;
369 wm8731->sysclk = freq;
375 snd_soc_dapm_sync(&codec->dapm);
381 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
384 struct snd_soc_codec *codec = codec_dai->codec;
387 /* set master/slave audio interface */
388 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
389 case SND_SOC_DAIFMT_CBM_CFM:
392 case SND_SOC_DAIFMT_CBS_CFS:
398 /* interface format */
399 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
400 case SND_SOC_DAIFMT_I2S:
403 case SND_SOC_DAIFMT_RIGHT_J:
405 case SND_SOC_DAIFMT_LEFT_J:
408 case SND_SOC_DAIFMT_DSP_A:
411 case SND_SOC_DAIFMT_DSP_B:
418 /* clock inversion */
419 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
420 case SND_SOC_DAIFMT_NB_NF:
422 case SND_SOC_DAIFMT_IB_IF:
425 case SND_SOC_DAIFMT_IB_NF:
428 case SND_SOC_DAIFMT_NB_IF:
436 snd_soc_write(codec, WM8731_IFACE, iface);
440 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
441 enum snd_soc_bias_level level)
443 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
448 case SND_SOC_BIAS_ON:
450 case SND_SOC_BIAS_PREPARE:
452 case SND_SOC_BIAS_STANDBY:
453 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
454 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
459 regcache_sync(wm8731->regmap);
462 /* Clear PWROFF, gate CLKOUT, everything else as-is */
463 reg = snd_soc_read(codec, WM8731_PWR) & 0xff7f;
464 snd_soc_write(codec, WM8731_PWR, reg | 0x0040);
466 case SND_SOC_BIAS_OFF:
467 snd_soc_write(codec, WM8731_PWR, 0xffff);
468 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies),
470 regcache_mark_dirty(wm8731->regmap);
473 codec->dapm.bias_level = level;
477 #define WM8731_RATES SNDRV_PCM_RATE_8000_96000
479 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
480 SNDRV_PCM_FMTBIT_S24_LE)
482 static const struct snd_soc_dai_ops wm8731_dai_ops = {
483 .hw_params = wm8731_hw_params,
484 .digital_mute = wm8731_mute,
485 .set_sysclk = wm8731_set_dai_sysclk,
486 .set_fmt = wm8731_set_dai_fmt,
489 static struct snd_soc_dai_driver wm8731_dai = {
490 .name = "wm8731-hifi",
492 .stream_name = "Playback",
495 .rates = WM8731_RATES,
496 .formats = WM8731_FORMATS,},
498 .stream_name = "Capture",
501 .rates = WM8731_RATES,
502 .formats = WM8731_FORMATS,},
503 .ops = &wm8731_dai_ops,
504 .symmetric_rates = 1,
508 static int wm8731_suspend(struct snd_soc_codec *codec)
510 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
515 static int wm8731_resume(struct snd_soc_codec *codec)
517 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
522 #define wm8731_suspend NULL
523 #define wm8731_resume NULL
526 static int wm8731_probe(struct snd_soc_codec *codec)
528 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
531 codec->control_data = wm8731->regmap;
532 ret = snd_soc_codec_set_cache_io(codec, 7, 9, SND_SOC_REGMAP);
534 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
538 for (i = 0; i < ARRAY_SIZE(wm8731->supplies); i++)
539 wm8731->supplies[i].supply = wm8731_supply_names[i];
541 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8731->supplies),
544 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
548 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
551 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
552 goto err_regulator_get;
555 ret = wm8731_reset(codec);
557 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
558 goto err_regulator_enable;
561 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
563 /* Latch the update bits */
564 snd_soc_update_bits(codec, WM8731_LOUT1V, 0x100, 0);
565 snd_soc_update_bits(codec, WM8731_ROUT1V, 0x100, 0);
566 snd_soc_update_bits(codec, WM8731_LINVOL, 0x100, 0);
567 snd_soc_update_bits(codec, WM8731_RINVOL, 0x100, 0);
569 /* Disable bypass path by default */
570 snd_soc_update_bits(codec, WM8731_APANA, 0x8, 0);
572 /* Regulators will have been enabled by bias management */
573 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
577 err_regulator_enable:
578 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
580 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
585 /* power down chip */
586 static int wm8731_remove(struct snd_soc_codec *codec)
588 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
590 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
592 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
593 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
598 static struct snd_soc_codec_driver soc_codec_dev_wm8731 = {
599 .probe = wm8731_probe,
600 .remove = wm8731_remove,
601 .suspend = wm8731_suspend,
602 .resume = wm8731_resume,
603 .set_bias_level = wm8731_set_bias_level,
604 .dapm_widgets = wm8731_dapm_widgets,
605 .num_dapm_widgets = ARRAY_SIZE(wm8731_dapm_widgets),
606 .dapm_routes = wm8731_intercon,
607 .num_dapm_routes = ARRAY_SIZE(wm8731_intercon),
608 .controls = wm8731_snd_controls,
609 .num_controls = ARRAY_SIZE(wm8731_snd_controls),
612 static const struct of_device_id wm8731_of_match[] = {
613 { .compatible = "wlf,wm8731", },
617 MODULE_DEVICE_TABLE(of, wm8731_of_match);
619 static const struct regmap_config wm8731_regmap = {
623 .max_register = WM8731_RESET,
624 .volatile_reg = wm8731_volatile,
625 .writeable_reg = wm8731_writeable,
627 .cache_type = REGCACHE_RBTREE,
628 .reg_defaults = wm8731_reg_defaults,
629 .num_reg_defaults = ARRAY_SIZE(wm8731_reg_defaults),
632 #if defined(CONFIG_SPI_MASTER)
633 static int __devinit wm8731_spi_probe(struct spi_device *spi)
635 struct wm8731_priv *wm8731;
638 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
642 wm8731->regmap = regmap_init_spi(spi, &wm8731_regmap);
643 if (IS_ERR(wm8731->regmap)) {
644 ret = PTR_ERR(wm8731->regmap);
645 dev_err(&spi->dev, "Failed to allocate register map: %d\n",
650 spi_set_drvdata(spi, wm8731);
652 ret = snd_soc_register_codec(&spi->dev,
653 &soc_codec_dev_wm8731, &wm8731_dai, 1);
655 dev_err(&spi->dev, "Failed to register CODEC: %d\n", ret);
662 regmap_exit(wm8731->regmap);
668 static int __devexit wm8731_spi_remove(struct spi_device *spi)
670 struct wm8731_priv *wm8731 = spi_get_drvdata(spi);
672 snd_soc_unregister_codec(&spi->dev);
673 regmap_exit(wm8731->regmap);
678 static struct spi_driver wm8731_spi_driver = {
681 .owner = THIS_MODULE,
682 .of_match_table = wm8731_of_match,
684 .probe = wm8731_spi_probe,
685 .remove = __devexit_p(wm8731_spi_remove),
687 #endif /* CONFIG_SPI_MASTER */
689 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
690 static __devinit int wm8731_i2c_probe(struct i2c_client *i2c,
691 const struct i2c_device_id *id)
693 struct wm8731_priv *wm8731;
696 wm8731 = kzalloc(sizeof(struct wm8731_priv), GFP_KERNEL);
700 wm8731->regmap = regmap_init_i2c(i2c, &wm8731_regmap);
701 if (IS_ERR(wm8731->regmap)) {
702 ret = PTR_ERR(wm8731->regmap);
703 dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
708 i2c_set_clientdata(i2c, wm8731);
710 ret = snd_soc_register_codec(&i2c->dev,
711 &soc_codec_dev_wm8731, &wm8731_dai, 1);
713 dev_err(&i2c->dev, "Failed to register CODEC: %d\n", ret);
720 regmap_exit(wm8731->regmap);
726 static __devexit int wm8731_i2c_remove(struct i2c_client *client)
728 struct wm8731_priv *wm8731 = i2c_get_clientdata(client);
729 snd_soc_unregister_codec(&client->dev);
730 regmap_exit(wm8731->regmap);
735 static const struct i2c_device_id wm8731_i2c_id[] = {
739 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
741 static struct i2c_driver wm8731_i2c_driver = {
744 .owner = THIS_MODULE,
745 .of_match_table = wm8731_of_match,
747 .probe = wm8731_i2c_probe,
748 .remove = __devexit_p(wm8731_i2c_remove),
749 .id_table = wm8731_i2c_id,
753 static int __init wm8731_modinit(void)
756 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
757 ret = i2c_add_driver(&wm8731_i2c_driver);
759 printk(KERN_ERR "Failed to register WM8731 I2C driver: %d\n",
763 #if defined(CONFIG_SPI_MASTER)
764 ret = spi_register_driver(&wm8731_spi_driver);
766 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
772 module_init(wm8731_modinit);
774 static void __exit wm8731_exit(void)
776 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
777 i2c_del_driver(&wm8731_i2c_driver);
779 #if defined(CONFIG_SPI_MASTER)
780 spi_unregister_driver(&wm8731_spi_driver);
783 module_exit(wm8731_exit);
785 MODULE_DESCRIPTION("ASoC WM8731 driver");
786 MODULE_AUTHOR("Richard Purdie");
787 MODULE_LICENSE("GPL");