2 * wm8731.c -- WM8731 ALSA SoC Audio driver
4 * Copyright 2005 Openedhand Ltd.
5 * Copyright 2006-12 Wolfson Microelectronics, plc
7 * Author: Richard Purdie <richard@openedhand.com>
9 * Based on wm8753.c by Liam Girdwood
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/init.h>
19 #include <linux/delay.h>
21 #include <linux/i2c.h>
22 #include <linux/slab.h>
23 #include <linux/regmap.h>
24 #include <linux/regulator/consumer.h>
25 #include <linux/spi/spi.h>
26 #include <linux/of_device.h>
27 #include <sound/core.h>
28 #include <sound/pcm.h>
29 #include <sound/pcm_params.h>
30 #include <sound/soc.h>
31 #include <sound/initval.h>
32 #include <sound/tlv.h>
36 #define WM8731_NUM_SUPPLIES 4
37 static const char *wm8731_supply_names[WM8731_NUM_SUPPLIES] = {
44 /* codec private data */
46 struct regmap *regmap;
47 struct regulator_bulk_data supplies[WM8731_NUM_SUPPLIES];
56 * wm8731 register cache
58 static const struct reg_default wm8731_reg_defaults[] = {
71 static bool wm8731_volatile(struct device *dev, unsigned int reg)
73 return reg == WM8731_RESET;
76 static bool wm8731_writeable(struct device *dev, unsigned int reg)
78 return reg <= WM8731_RESET;
81 #define wm8731_reset(c) snd_soc_write(c, WM8731_RESET, 0)
83 static const char *wm8731_input_select[] = {"Line In", "Mic"};
85 static const struct soc_enum wm8731_insel_enum =
86 SOC_ENUM_SINGLE(WM8731_APANA, 2, 2, wm8731_input_select);
88 static int wm8731_deemph[] = { 0, 32000, 44100, 48000 };
90 static int wm8731_set_deemph(struct snd_soc_codec *codec)
92 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
95 /* If we're using deemphasis select the nearest available sample
100 for (i = 2; i < ARRAY_SIZE(wm8731_deemph); i++) {
101 if (abs(wm8731_deemph[i] - wm8731->playback_fs) <
102 abs(wm8731_deemph[best] - wm8731->playback_fs))
112 dev_dbg(codec->dev, "Set deemphasis %d (%dHz)\n",
113 best, wm8731_deemph[best]);
115 return snd_soc_update_bits(codec, WM8731_APDIGI, 0x6, val);
118 static int wm8731_get_deemph(struct snd_kcontrol *kcontrol,
119 struct snd_ctl_elem_value *ucontrol)
121 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
122 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
124 ucontrol->value.enumerated.item[0] = wm8731->deemph;
129 static int wm8731_put_deemph(struct snd_kcontrol *kcontrol,
130 struct snd_ctl_elem_value *ucontrol)
132 struct snd_soc_codec *codec = snd_kcontrol_chip(kcontrol);
133 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
134 int deemph = ucontrol->value.enumerated.item[0];
140 mutex_lock(&codec->mutex);
141 if (wm8731->deemph != deemph) {
142 wm8731->deemph = deemph;
144 wm8731_set_deemph(codec);
148 mutex_unlock(&codec->mutex);
153 static const DECLARE_TLV_DB_SCALE(in_tlv, -3450, 150, 0);
154 static const DECLARE_TLV_DB_SCALE(sidetone_tlv, -1500, 300, 0);
155 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
156 static const DECLARE_TLV_DB_SCALE(mic_tlv, 0, 2000, 0);
158 static const struct snd_kcontrol_new wm8731_snd_controls[] = {
160 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8731_LOUT1V, WM8731_ROUT1V,
162 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V, WM8731_ROUT1V,
165 SOC_DOUBLE_R_TLV("Capture Volume", WM8731_LINVOL, WM8731_RINVOL, 0, 31, 0,
167 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL, WM8731_RINVOL, 7, 1, 1),
169 SOC_SINGLE_TLV("Mic Boost Volume", WM8731_APANA, 0, 1, 0, mic_tlv),
170 SOC_SINGLE("Mic Capture Switch", WM8731_APANA, 1, 1, 1),
172 SOC_SINGLE_TLV("Sidetone Playback Volume", WM8731_APANA, 6, 3, 1,
175 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI, 0, 1, 1),
176 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI, 4, 1, 0),
178 SOC_SINGLE_BOOL_EXT("Playback Deemphasis Switch", 0,
179 wm8731_get_deemph, wm8731_put_deemph),
183 static const struct snd_kcontrol_new wm8731_output_mixer_controls[] = {
184 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA, 3, 1, 0),
185 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA, 5, 1, 0),
186 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA, 4, 1, 0),
190 static const struct snd_kcontrol_new wm8731_input_mux_controls =
191 SOC_DAPM_ENUM("Input Select", wm8731_insel_enum);
193 static const struct snd_soc_dapm_widget wm8731_dapm_widgets[] = {
194 SND_SOC_DAPM_SUPPLY("ACTIVE",WM8731_ACTIVE, 0, 0, NULL, 0),
195 SND_SOC_DAPM_SUPPLY("OSC", WM8731_PWR, 5, 1, NULL, 0),
196 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR, 4, 1,
197 &wm8731_output_mixer_controls[0],
198 ARRAY_SIZE(wm8731_output_mixer_controls)),
199 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR, 3, 1),
200 SND_SOC_DAPM_OUTPUT("LOUT"),
201 SND_SOC_DAPM_OUTPUT("LHPOUT"),
202 SND_SOC_DAPM_OUTPUT("ROUT"),
203 SND_SOC_DAPM_OUTPUT("RHPOUT"),
204 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR, 2, 1),
205 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM, 0, 0, &wm8731_input_mux_controls),
206 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR, 0, 1, NULL, 0),
207 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR, 1, 1),
208 SND_SOC_DAPM_INPUT("MICIN"),
209 SND_SOC_DAPM_INPUT("RLINEIN"),
210 SND_SOC_DAPM_INPUT("LLINEIN"),
213 static int wm8731_check_osc(struct snd_soc_dapm_widget *source,
214 struct snd_soc_dapm_widget *sink)
216 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(source->codec);
218 return wm8731->sysclk_type == WM8731_SYSCLK_XTAL;
221 static const struct snd_soc_dapm_route wm8731_intercon[] = {
222 {"DAC", NULL, "OSC", wm8731_check_osc},
223 {"ADC", NULL, "OSC", wm8731_check_osc},
224 {"DAC", NULL, "ACTIVE"},
225 {"ADC", NULL, "ACTIVE"},
228 {"Output Mixer", "Line Bypass Switch", "Line Input"},
229 {"Output Mixer", "HiFi Playback Switch", "DAC"},
230 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
233 {"RHPOUT", NULL, "Output Mixer"},
234 {"ROUT", NULL, "Output Mixer"},
235 {"LHPOUT", NULL, "Output Mixer"},
236 {"LOUT", NULL, "Output Mixer"},
239 {"Input Mux", "Line In", "Line Input"},
240 {"Input Mux", "Mic", "Mic Bias"},
241 {"ADC", NULL, "Input Mux"},
244 {"Line Input", NULL, "LLINEIN"},
245 {"Line Input", NULL, "RLINEIN"},
246 {"Mic Bias", NULL, "MICIN"},
258 /* codec mclk clock divider coefficients */
259 static const struct _coeff_div coeff_div[] = {
261 {12288000, 48000, 256, 0x0, 0x0, 0x0},
262 {18432000, 48000, 384, 0x0, 0x1, 0x0},
263 {12000000, 48000, 250, 0x0, 0x0, 0x1},
266 {12288000, 32000, 384, 0x6, 0x0, 0x0},
267 {18432000, 32000, 576, 0x6, 0x1, 0x0},
268 {12000000, 32000, 375, 0x6, 0x0, 0x1},
271 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
272 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
273 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
274 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
275 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
278 {12288000, 96000, 128, 0x7, 0x0, 0x0},
279 {18432000, 96000, 192, 0x7, 0x1, 0x0},
280 {12000000, 96000, 125, 0x7, 0x0, 0x1},
283 {11289600, 44100, 256, 0x8, 0x0, 0x0},
284 {16934400, 44100, 384, 0x8, 0x1, 0x0},
285 {12000000, 44100, 272, 0x8, 0x1, 0x1},
288 {11289600, 88200, 128, 0xf, 0x0, 0x0},
289 {16934400, 88200, 192, 0xf, 0x1, 0x0},
290 {12000000, 88200, 136, 0xf, 0x1, 0x1},
293 static inline int get_coeff(int mclk, int rate)
297 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
298 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
304 static int wm8731_hw_params(struct snd_pcm_substream *substream,
305 struct snd_pcm_hw_params *params,
306 struct snd_soc_dai *dai)
308 struct snd_soc_codec *codec = dai->codec;
309 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
310 u16 iface = snd_soc_read(codec, WM8731_IFACE) & 0xfff3;
311 int i = get_coeff(wm8731->sysclk, params_rate(params));
312 u16 srate = (coeff_div[i].sr << 2) |
313 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
315 wm8731->playback_fs = params_rate(params);
317 snd_soc_write(codec, WM8731_SRATE, srate);
320 switch (params_format(params)) {
321 case SNDRV_PCM_FORMAT_S16_LE:
323 case SNDRV_PCM_FORMAT_S20_3LE:
326 case SNDRV_PCM_FORMAT_S24_LE:
331 wm8731_set_deemph(codec);
333 snd_soc_write(codec, WM8731_IFACE, iface);
337 static int wm8731_mute(struct snd_soc_dai *dai, int mute)
339 struct snd_soc_codec *codec = dai->codec;
340 u16 mute_reg = snd_soc_read(codec, WM8731_APDIGI) & 0xfff7;
343 snd_soc_write(codec, WM8731_APDIGI, mute_reg | 0x8);
345 snd_soc_write(codec, WM8731_APDIGI, mute_reg);
349 static int wm8731_set_dai_sysclk(struct snd_soc_dai *codec_dai,
350 int clk_id, unsigned int freq, int dir)
352 struct snd_soc_codec *codec = codec_dai->codec;
353 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
356 case WM8731_SYSCLK_XTAL:
357 case WM8731_SYSCLK_MCLK:
358 wm8731->sysclk_type = clk_id;
370 wm8731->sysclk = freq;
376 snd_soc_dapm_sync(&codec->dapm);
382 static int wm8731_set_dai_fmt(struct snd_soc_dai *codec_dai,
385 struct snd_soc_codec *codec = codec_dai->codec;
388 /* set master/slave audio interface */
389 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
390 case SND_SOC_DAIFMT_CBM_CFM:
393 case SND_SOC_DAIFMT_CBS_CFS:
399 /* interface format */
400 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
401 case SND_SOC_DAIFMT_I2S:
404 case SND_SOC_DAIFMT_RIGHT_J:
406 case SND_SOC_DAIFMT_LEFT_J:
409 case SND_SOC_DAIFMT_DSP_A:
412 case SND_SOC_DAIFMT_DSP_B:
419 /* clock inversion */
420 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
421 case SND_SOC_DAIFMT_NB_NF:
423 case SND_SOC_DAIFMT_IB_IF:
426 case SND_SOC_DAIFMT_IB_NF:
429 case SND_SOC_DAIFMT_NB_IF:
437 snd_soc_write(codec, WM8731_IFACE, iface);
441 static int wm8731_set_bias_level(struct snd_soc_codec *codec,
442 enum snd_soc_bias_level level)
444 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
449 case SND_SOC_BIAS_ON:
451 case SND_SOC_BIAS_PREPARE:
453 case SND_SOC_BIAS_STANDBY:
454 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
455 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
460 regcache_sync(wm8731->regmap);
463 /* Clear PWROFF, gate CLKOUT, everything else as-is */
464 reg = snd_soc_read(codec, WM8731_PWR) & 0xff7f;
465 snd_soc_write(codec, WM8731_PWR, reg | 0x0040);
467 case SND_SOC_BIAS_OFF:
468 snd_soc_write(codec, WM8731_PWR, 0xffff);
469 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies),
471 regcache_mark_dirty(wm8731->regmap);
474 codec->dapm.bias_level = level;
478 #define WM8731_RATES SNDRV_PCM_RATE_8000_96000
480 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
481 SNDRV_PCM_FMTBIT_S24_LE)
483 static const struct snd_soc_dai_ops wm8731_dai_ops = {
484 .hw_params = wm8731_hw_params,
485 .digital_mute = wm8731_mute,
486 .set_sysclk = wm8731_set_dai_sysclk,
487 .set_fmt = wm8731_set_dai_fmt,
490 static struct snd_soc_dai_driver wm8731_dai = {
491 .name = "wm8731-hifi",
493 .stream_name = "Playback",
496 .rates = WM8731_RATES,
497 .formats = WM8731_FORMATS,},
499 .stream_name = "Capture",
502 .rates = WM8731_RATES,
503 .formats = WM8731_FORMATS,},
504 .ops = &wm8731_dai_ops,
505 .symmetric_rates = 1,
509 static int wm8731_suspend(struct snd_soc_codec *codec)
511 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
516 static int wm8731_resume(struct snd_soc_codec *codec)
518 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
523 #define wm8731_suspend NULL
524 #define wm8731_resume NULL
527 static int wm8731_probe(struct snd_soc_codec *codec)
529 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
532 codec->control_data = wm8731->regmap;
533 ret = snd_soc_codec_set_cache_io(codec, 7, 9, SND_SOC_REGMAP);
535 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
539 for (i = 0; i < ARRAY_SIZE(wm8731->supplies); i++)
540 wm8731->supplies[i].supply = wm8731_supply_names[i];
542 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8731->supplies),
545 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
549 ret = regulator_bulk_enable(ARRAY_SIZE(wm8731->supplies),
552 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
553 goto err_regulator_get;
556 ret = wm8731_reset(codec);
558 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
559 goto err_regulator_enable;
562 wm8731_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
564 /* Latch the update bits */
565 snd_soc_update_bits(codec, WM8731_LOUT1V, 0x100, 0);
566 snd_soc_update_bits(codec, WM8731_ROUT1V, 0x100, 0);
567 snd_soc_update_bits(codec, WM8731_LINVOL, 0x100, 0);
568 snd_soc_update_bits(codec, WM8731_RINVOL, 0x100, 0);
570 /* Disable bypass path by default */
571 snd_soc_update_bits(codec, WM8731_APANA, 0x8, 0);
573 /* Regulators will have been enabled by bias management */
574 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
578 err_regulator_enable:
579 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
581 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
586 /* power down chip */
587 static int wm8731_remove(struct snd_soc_codec *codec)
589 struct wm8731_priv *wm8731 = snd_soc_codec_get_drvdata(codec);
591 wm8731_set_bias_level(codec, SND_SOC_BIAS_OFF);
593 regulator_bulk_disable(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
594 regulator_bulk_free(ARRAY_SIZE(wm8731->supplies), wm8731->supplies);
599 static struct snd_soc_codec_driver soc_codec_dev_wm8731 = {
600 .probe = wm8731_probe,
601 .remove = wm8731_remove,
602 .suspend = wm8731_suspend,
603 .resume = wm8731_resume,
604 .set_bias_level = wm8731_set_bias_level,
605 .dapm_widgets = wm8731_dapm_widgets,
606 .num_dapm_widgets = ARRAY_SIZE(wm8731_dapm_widgets),
607 .dapm_routes = wm8731_intercon,
608 .num_dapm_routes = ARRAY_SIZE(wm8731_intercon),
609 .controls = wm8731_snd_controls,
610 .num_controls = ARRAY_SIZE(wm8731_snd_controls),
613 static const struct of_device_id wm8731_of_match[] = {
614 { .compatible = "wlf,wm8731", },
618 MODULE_DEVICE_TABLE(of, wm8731_of_match);
620 static const struct regmap_config wm8731_regmap = {
624 .max_register = WM8731_RESET,
625 .volatile_reg = wm8731_volatile,
626 .writeable_reg = wm8731_writeable,
628 .cache_type = REGCACHE_RBTREE,
629 .reg_defaults = wm8731_reg_defaults,
630 .num_reg_defaults = ARRAY_SIZE(wm8731_reg_defaults),
633 #if defined(CONFIG_SPI_MASTER)
634 static int wm8731_spi_probe(struct spi_device *spi)
636 struct wm8731_priv *wm8731;
639 wm8731 = devm_kzalloc(&spi->dev, sizeof(struct wm8731_priv),
644 wm8731->regmap = devm_regmap_init_spi(spi, &wm8731_regmap);
645 if (IS_ERR(wm8731->regmap)) {
646 ret = PTR_ERR(wm8731->regmap);
647 dev_err(&spi->dev, "Failed to allocate register map: %d\n",
652 spi_set_drvdata(spi, wm8731);
654 ret = snd_soc_register_codec(&spi->dev,
655 &soc_codec_dev_wm8731, &wm8731_dai, 1);
657 dev_err(&spi->dev, "Failed to register CODEC: %d\n", ret);
664 static int wm8731_spi_remove(struct spi_device *spi)
666 snd_soc_unregister_codec(&spi->dev);
670 static struct spi_driver wm8731_spi_driver = {
673 .owner = THIS_MODULE,
674 .of_match_table = wm8731_of_match,
676 .probe = wm8731_spi_probe,
677 .remove = wm8731_spi_remove,
679 #endif /* CONFIG_SPI_MASTER */
681 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
682 static int wm8731_i2c_probe(struct i2c_client *i2c,
683 const struct i2c_device_id *id)
685 struct wm8731_priv *wm8731;
688 wm8731 = devm_kzalloc(&i2c->dev, sizeof(struct wm8731_priv),
693 wm8731->regmap = devm_regmap_init_i2c(i2c, &wm8731_regmap);
694 if (IS_ERR(wm8731->regmap)) {
695 ret = PTR_ERR(wm8731->regmap);
696 dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
701 i2c_set_clientdata(i2c, wm8731);
703 ret = snd_soc_register_codec(&i2c->dev,
704 &soc_codec_dev_wm8731, &wm8731_dai, 1);
706 dev_err(&i2c->dev, "Failed to register CODEC: %d\n", ret);
713 static int wm8731_i2c_remove(struct i2c_client *client)
715 snd_soc_unregister_codec(&client->dev);
719 static const struct i2c_device_id wm8731_i2c_id[] = {
723 MODULE_DEVICE_TABLE(i2c, wm8731_i2c_id);
725 static struct i2c_driver wm8731_i2c_driver = {
728 .owner = THIS_MODULE,
729 .of_match_table = wm8731_of_match,
731 .probe = wm8731_i2c_probe,
732 .remove = wm8731_i2c_remove,
733 .id_table = wm8731_i2c_id,
737 static int __init wm8731_modinit(void)
740 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
741 ret = i2c_add_driver(&wm8731_i2c_driver);
743 printk(KERN_ERR "Failed to register WM8731 I2C driver: %d\n",
747 #if defined(CONFIG_SPI_MASTER)
748 ret = spi_register_driver(&wm8731_spi_driver);
750 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
756 module_init(wm8731_modinit);
758 static void __exit wm8731_exit(void)
760 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
761 i2c_del_driver(&wm8731_i2c_driver);
763 #if defined(CONFIG_SPI_MASTER)
764 spi_unregister_driver(&wm8731_spi_driver);
767 module_exit(wm8731_exit);
769 MODULE_DESCRIPTION("ASoC WM8731 driver");
770 MODULE_AUTHOR("Richard Purdie");
771 MODULE_LICENSE("GPL");