2 * wm8510.c -- WM8510 ALSA Soc Audio driver
4 * Copyright 2006 Wolfson Microelectronics PLC.
6 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/kernel.h>
16 #include <linux/init.h>
17 #include <linux/delay.h>
19 #include <linux/i2c.h>
20 #include <linux/spi/spi.h>
21 #include <linux/slab.h>
22 #include <linux/of_device.h>
23 #include <linux/regmap.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
27 #include <sound/soc.h>
28 #include <sound/initval.h>
33 * wm8510 register cache
34 * We can't read the WM8510 register space when we are
35 * using 2 wire for device control, so we cache them instead.
37 static const struct reg_default wm8510_reg_defaults[] = {
96 static bool wm8510_volatile(struct device *dev, unsigned int reg)
106 #define WM8510_POWER1_BIASEN 0x08
107 #define WM8510_POWER1_BUFIOEN 0x10
109 #define wm8510_reset(c) snd_soc_write(c, WM8510_RESET, 0)
111 /* codec private data */
113 struct regmap *regmap;
116 static const char *wm8510_companding[] = { "Off", "NC", "u-law", "A-law" };
117 static const char *wm8510_deemp[] = { "None", "32kHz", "44.1kHz", "48kHz" };
118 static const char *wm8510_alc[] = { "ALC", "Limiter" };
120 static const struct soc_enum wm8510_enum[] = {
121 SOC_ENUM_SINGLE(WM8510_COMP, 1, 4, wm8510_companding), /* adc */
122 SOC_ENUM_SINGLE(WM8510_COMP, 3, 4, wm8510_companding), /* dac */
123 SOC_ENUM_SINGLE(WM8510_DAC, 4, 4, wm8510_deemp),
124 SOC_ENUM_SINGLE(WM8510_ALC3, 8, 2, wm8510_alc),
127 static const struct snd_kcontrol_new wm8510_snd_controls[] = {
129 SOC_SINGLE("Digital Loopback Switch", WM8510_COMP, 0, 1, 0),
131 SOC_ENUM("DAC Companding", wm8510_enum[1]),
132 SOC_ENUM("ADC Companding", wm8510_enum[0]),
134 SOC_ENUM("Playback De-emphasis", wm8510_enum[2]),
135 SOC_SINGLE("DAC Inversion Switch", WM8510_DAC, 0, 1, 0),
137 SOC_SINGLE("Master Playback Volume", WM8510_DACVOL, 0, 127, 0),
139 SOC_SINGLE("High Pass Filter Switch", WM8510_ADC, 8, 1, 0),
140 SOC_SINGLE("High Pass Cut Off", WM8510_ADC, 4, 7, 0),
141 SOC_SINGLE("ADC Inversion Switch", WM8510_COMP, 0, 1, 0),
143 SOC_SINGLE("Capture Volume", WM8510_ADCVOL, 0, 127, 0),
145 SOC_SINGLE("DAC Playback Limiter Switch", WM8510_DACLIM1, 8, 1, 0),
146 SOC_SINGLE("DAC Playback Limiter Decay", WM8510_DACLIM1, 4, 15, 0),
147 SOC_SINGLE("DAC Playback Limiter Attack", WM8510_DACLIM1, 0, 15, 0),
149 SOC_SINGLE("DAC Playback Limiter Threshold", WM8510_DACLIM2, 4, 7, 0),
150 SOC_SINGLE("DAC Playback Limiter Boost", WM8510_DACLIM2, 0, 15, 0),
152 SOC_SINGLE("ALC Enable Switch", WM8510_ALC1, 8, 1, 0),
153 SOC_SINGLE("ALC Capture Max Gain", WM8510_ALC1, 3, 7, 0),
154 SOC_SINGLE("ALC Capture Min Gain", WM8510_ALC1, 0, 7, 0),
156 SOC_SINGLE("ALC Capture ZC Switch", WM8510_ALC2, 8, 1, 0),
157 SOC_SINGLE("ALC Capture Hold", WM8510_ALC2, 4, 7, 0),
158 SOC_SINGLE("ALC Capture Target", WM8510_ALC2, 0, 15, 0),
160 SOC_ENUM("ALC Capture Mode", wm8510_enum[3]),
161 SOC_SINGLE("ALC Capture Decay", WM8510_ALC3, 4, 15, 0),
162 SOC_SINGLE("ALC Capture Attack", WM8510_ALC3, 0, 15, 0),
164 SOC_SINGLE("ALC Capture Noise Gate Switch", WM8510_NGATE, 3, 1, 0),
165 SOC_SINGLE("ALC Capture Noise Gate Threshold", WM8510_NGATE, 0, 7, 0),
167 SOC_SINGLE("Capture PGA ZC Switch", WM8510_INPPGA, 7, 1, 0),
168 SOC_SINGLE("Capture PGA Volume", WM8510_INPPGA, 0, 63, 0),
170 SOC_SINGLE("Speaker Playback ZC Switch", WM8510_SPKVOL, 7, 1, 0),
171 SOC_SINGLE("Speaker Playback Switch", WM8510_SPKVOL, 6, 1, 1),
172 SOC_SINGLE("Speaker Playback Volume", WM8510_SPKVOL, 0, 63, 0),
173 SOC_SINGLE("Speaker Boost", WM8510_OUTPUT, 2, 1, 0),
175 SOC_SINGLE("Capture Boost(+20dB)", WM8510_ADCBOOST, 8, 1, 0),
176 SOC_SINGLE("Mono Playback Switch", WM8510_MONOMIX, 6, 1, 1),
179 /* Speaker Output Mixer */
180 static const struct snd_kcontrol_new wm8510_speaker_mixer_controls[] = {
181 SOC_DAPM_SINGLE("Line Bypass Switch", WM8510_SPKMIX, 1, 1, 0),
182 SOC_DAPM_SINGLE("Aux Playback Switch", WM8510_SPKMIX, 5, 1, 0),
183 SOC_DAPM_SINGLE("PCM Playback Switch", WM8510_SPKMIX, 0, 1, 0),
186 /* Mono Output Mixer */
187 static const struct snd_kcontrol_new wm8510_mono_mixer_controls[] = {
188 SOC_DAPM_SINGLE("Line Bypass Switch", WM8510_MONOMIX, 1, 1, 0),
189 SOC_DAPM_SINGLE("Aux Playback Switch", WM8510_MONOMIX, 2, 1, 0),
190 SOC_DAPM_SINGLE("PCM Playback Switch", WM8510_MONOMIX, 0, 1, 0),
193 static const struct snd_kcontrol_new wm8510_boost_controls[] = {
194 SOC_DAPM_SINGLE("Mic PGA Switch", WM8510_INPPGA, 6, 1, 1),
195 SOC_DAPM_SINGLE("Aux Volume", WM8510_ADCBOOST, 0, 7, 0),
196 SOC_DAPM_SINGLE("Mic Volume", WM8510_ADCBOOST, 4, 7, 0),
199 static const struct snd_kcontrol_new wm8510_micpga_controls[] = {
200 SOC_DAPM_SINGLE("MICP Switch", WM8510_INPUT, 0, 1, 0),
201 SOC_DAPM_SINGLE("MICN Switch", WM8510_INPUT, 1, 1, 0),
202 SOC_DAPM_SINGLE("AUX Switch", WM8510_INPUT, 2, 1, 0),
205 static const struct snd_soc_dapm_widget wm8510_dapm_widgets[] = {
206 SND_SOC_DAPM_MIXER("Speaker Mixer", WM8510_POWER3, 2, 0,
207 &wm8510_speaker_mixer_controls[0],
208 ARRAY_SIZE(wm8510_speaker_mixer_controls)),
209 SND_SOC_DAPM_MIXER("Mono Mixer", WM8510_POWER3, 3, 0,
210 &wm8510_mono_mixer_controls[0],
211 ARRAY_SIZE(wm8510_mono_mixer_controls)),
212 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8510_POWER3, 0, 0),
213 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8510_POWER2, 0, 0),
214 SND_SOC_DAPM_PGA("Aux Input", WM8510_POWER1, 6, 0, NULL, 0),
215 SND_SOC_DAPM_PGA("SpkN Out", WM8510_POWER3, 5, 0, NULL, 0),
216 SND_SOC_DAPM_PGA("SpkP Out", WM8510_POWER3, 6, 0, NULL, 0),
217 SND_SOC_DAPM_PGA("Mono Out", WM8510_POWER3, 7, 0, NULL, 0),
219 SND_SOC_DAPM_MIXER("Mic PGA", WM8510_POWER2, 2, 0,
220 &wm8510_micpga_controls[0],
221 ARRAY_SIZE(wm8510_micpga_controls)),
222 SND_SOC_DAPM_MIXER("Boost Mixer", WM8510_POWER2, 4, 0,
223 &wm8510_boost_controls[0],
224 ARRAY_SIZE(wm8510_boost_controls)),
226 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8510_POWER1, 4, 0),
228 SND_SOC_DAPM_INPUT("MICN"),
229 SND_SOC_DAPM_INPUT("MICP"),
230 SND_SOC_DAPM_INPUT("AUX"),
231 SND_SOC_DAPM_OUTPUT("MONOOUT"),
232 SND_SOC_DAPM_OUTPUT("SPKOUTP"),
233 SND_SOC_DAPM_OUTPUT("SPKOUTN"),
236 static const struct snd_soc_dapm_route wm8510_dapm_routes[] = {
237 /* Mono output mixer */
238 {"Mono Mixer", "PCM Playback Switch", "DAC"},
239 {"Mono Mixer", "Aux Playback Switch", "Aux Input"},
240 {"Mono Mixer", "Line Bypass Switch", "Boost Mixer"},
242 /* Speaker output mixer */
243 {"Speaker Mixer", "PCM Playback Switch", "DAC"},
244 {"Speaker Mixer", "Aux Playback Switch", "Aux Input"},
245 {"Speaker Mixer", "Line Bypass Switch", "Boost Mixer"},
248 {"Mono Out", NULL, "Mono Mixer"},
249 {"MONOOUT", NULL, "Mono Out"},
250 {"SpkN Out", NULL, "Speaker Mixer"},
251 {"SpkP Out", NULL, "Speaker Mixer"},
252 {"SPKOUTN", NULL, "SpkN Out"},
253 {"SPKOUTP", NULL, "SpkP Out"},
256 {"Mic PGA", "MICN Switch", "MICN"},
257 {"Mic PGA", "MICP Switch", "MICP"},
258 { "Mic PGA", "AUX Switch", "Aux Input" },
261 {"Boost Mixer", "Mic PGA Switch", "Mic PGA"},
262 {"Boost Mixer", "Mic Volume", "MICP"},
263 {"Boost Mixer", "Aux Volume", "Aux Input"},
265 {"ADC", NULL, "Boost Mixer"},
269 unsigned int pre_div:4; /* prescale - 1 */
274 static struct pll_ pll_div;
276 /* The size in bits of the pll divide multiplied by 10
277 * to allow rounding later */
278 #define FIXED_PLL_SIZE ((1 << 24) * 10)
280 static void pll_factors(unsigned int target, unsigned int source)
282 unsigned long long Kpart;
283 unsigned int K, Ndiv, Nmod;
285 Ndiv = target / source;
289 Ndiv = target / source;
293 if ((Ndiv < 6) || (Ndiv > 12))
295 "WM8510 N value %u outwith recommended range!d\n",
299 Nmod = target % source;
300 Kpart = FIXED_PLL_SIZE * (long long)Nmod;
302 do_div(Kpart, source);
304 K = Kpart & 0xFFFFFFFF;
306 /* Check if we need to round */
310 /* Move down to proper range now rounding is done */
316 static int wm8510_set_dai_pll(struct snd_soc_dai *codec_dai, int pll_id,
317 int source, unsigned int freq_in, unsigned int freq_out)
319 struct snd_soc_codec *codec = codec_dai->codec;
322 if (freq_in == 0 || freq_out == 0) {
323 /* Clock CODEC directly from MCLK */
324 reg = snd_soc_read(codec, WM8510_CLOCK);
325 snd_soc_write(codec, WM8510_CLOCK, reg & 0x0ff);
328 reg = snd_soc_read(codec, WM8510_POWER1);
329 snd_soc_write(codec, WM8510_POWER1, reg & 0x1df);
333 pll_factors(freq_out*4, freq_in);
335 snd_soc_write(codec, WM8510_PLLN, (pll_div.pre_div << 4) | pll_div.n);
336 snd_soc_write(codec, WM8510_PLLK1, pll_div.k >> 18);
337 snd_soc_write(codec, WM8510_PLLK2, (pll_div.k >> 9) & 0x1ff);
338 snd_soc_write(codec, WM8510_PLLK3, pll_div.k & 0x1ff);
339 reg = snd_soc_read(codec, WM8510_POWER1);
340 snd_soc_write(codec, WM8510_POWER1, reg | 0x020);
342 /* Run CODEC from PLL instead of MCLK */
343 reg = snd_soc_read(codec, WM8510_CLOCK);
344 snd_soc_write(codec, WM8510_CLOCK, reg | 0x100);
350 * Configure WM8510 clock dividers.
352 static int wm8510_set_dai_clkdiv(struct snd_soc_dai *codec_dai,
355 struct snd_soc_codec *codec = codec_dai->codec;
359 case WM8510_OPCLKDIV:
360 reg = snd_soc_read(codec, WM8510_GPIO) & 0x1cf;
361 snd_soc_write(codec, WM8510_GPIO, reg | div);
364 reg = snd_soc_read(codec, WM8510_CLOCK) & 0x11f;
365 snd_soc_write(codec, WM8510_CLOCK, reg | div);
368 reg = snd_soc_read(codec, WM8510_ADC) & 0x1f7;
369 snd_soc_write(codec, WM8510_ADC, reg | div);
372 reg = snd_soc_read(codec, WM8510_DAC) & 0x1f7;
373 snd_soc_write(codec, WM8510_DAC, reg | div);
376 reg = snd_soc_read(codec, WM8510_CLOCK) & 0x1e3;
377 snd_soc_write(codec, WM8510_CLOCK, reg | div);
386 static int wm8510_set_dai_fmt(struct snd_soc_dai *codec_dai,
389 struct snd_soc_codec *codec = codec_dai->codec;
391 u16 clk = snd_soc_read(codec, WM8510_CLOCK) & 0x1fe;
393 /* set master/slave audio interface */
394 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
395 case SND_SOC_DAIFMT_CBM_CFM:
398 case SND_SOC_DAIFMT_CBS_CFS:
404 /* interface format */
405 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
406 case SND_SOC_DAIFMT_I2S:
409 case SND_SOC_DAIFMT_RIGHT_J:
411 case SND_SOC_DAIFMT_LEFT_J:
414 case SND_SOC_DAIFMT_DSP_A:
421 /* clock inversion */
422 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
423 case SND_SOC_DAIFMT_NB_NF:
425 case SND_SOC_DAIFMT_IB_IF:
428 case SND_SOC_DAIFMT_IB_NF:
431 case SND_SOC_DAIFMT_NB_IF:
438 snd_soc_write(codec, WM8510_IFACE, iface);
439 snd_soc_write(codec, WM8510_CLOCK, clk);
443 static int wm8510_pcm_hw_params(struct snd_pcm_substream *substream,
444 struct snd_pcm_hw_params *params,
445 struct snd_soc_dai *dai)
447 struct snd_soc_codec *codec = dai->codec;
448 u16 iface = snd_soc_read(codec, WM8510_IFACE) & 0x19f;
449 u16 adn = snd_soc_read(codec, WM8510_ADD) & 0x1f1;
452 switch (params_width(params)) {
466 /* filter coefficient */
467 switch (params_rate(params)) {
488 snd_soc_write(codec, WM8510_IFACE, iface);
489 snd_soc_write(codec, WM8510_ADD, adn);
493 static int wm8510_mute(struct snd_soc_dai *dai, int mute)
495 struct snd_soc_codec *codec = dai->codec;
496 u16 mute_reg = snd_soc_read(codec, WM8510_DAC) & 0xffbf;
499 snd_soc_write(codec, WM8510_DAC, mute_reg | 0x40);
501 snd_soc_write(codec, WM8510_DAC, mute_reg);
505 /* liam need to make this lower power with dapm */
506 static int wm8510_set_bias_level(struct snd_soc_codec *codec,
507 enum snd_soc_bias_level level)
509 struct wm8510_priv *wm8510 = snd_soc_codec_get_drvdata(codec);
510 u16 power1 = snd_soc_read(codec, WM8510_POWER1) & ~0x3;
513 case SND_SOC_BIAS_ON:
514 case SND_SOC_BIAS_PREPARE:
515 power1 |= 0x1; /* VMID 50k */
516 snd_soc_write(codec, WM8510_POWER1, power1);
519 case SND_SOC_BIAS_STANDBY:
520 power1 |= WM8510_POWER1_BIASEN | WM8510_POWER1_BUFIOEN;
522 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_OFF) {
523 regcache_sync(wm8510->regmap);
525 /* Initial cap charge at VMID 5k */
526 snd_soc_write(codec, WM8510_POWER1, power1 | 0x3);
530 power1 |= 0x2; /* VMID 500k */
531 snd_soc_write(codec, WM8510_POWER1, power1);
534 case SND_SOC_BIAS_OFF:
535 snd_soc_write(codec, WM8510_POWER1, 0);
536 snd_soc_write(codec, WM8510_POWER2, 0);
537 snd_soc_write(codec, WM8510_POWER3, 0);
544 #define WM8510_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
545 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
546 SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
548 #define WM8510_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
549 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
551 static const struct snd_soc_dai_ops wm8510_dai_ops = {
552 .hw_params = wm8510_pcm_hw_params,
553 .digital_mute = wm8510_mute,
554 .set_fmt = wm8510_set_dai_fmt,
555 .set_clkdiv = wm8510_set_dai_clkdiv,
556 .set_pll = wm8510_set_dai_pll,
559 static struct snd_soc_dai_driver wm8510_dai = {
560 .name = "wm8510-hifi",
562 .stream_name = "Playback",
565 .rates = WM8510_RATES,
566 .formats = WM8510_FORMATS,},
568 .stream_name = "Capture",
571 .rates = WM8510_RATES,
572 .formats = WM8510_FORMATS,},
573 .ops = &wm8510_dai_ops,
574 .symmetric_rates = 1,
577 static int wm8510_probe(struct snd_soc_codec *codec)
584 static struct snd_soc_codec_driver soc_codec_dev_wm8510 = {
585 .probe = wm8510_probe,
586 .set_bias_level = wm8510_set_bias_level,
587 .suspend_bias_off = true,
589 .controls = wm8510_snd_controls,
590 .num_controls = ARRAY_SIZE(wm8510_snd_controls),
591 .dapm_widgets = wm8510_dapm_widgets,
592 .num_dapm_widgets = ARRAY_SIZE(wm8510_dapm_widgets),
593 .dapm_routes = wm8510_dapm_routes,
594 .num_dapm_routes = ARRAY_SIZE(wm8510_dapm_routes),
597 static const struct of_device_id wm8510_of_match[] = {
598 { .compatible = "wlf,wm8510" },
601 MODULE_DEVICE_TABLE(of, wm8510_of_match);
603 static const struct regmap_config wm8510_regmap = {
606 .max_register = WM8510_MONOMIX,
608 .reg_defaults = wm8510_reg_defaults,
609 .num_reg_defaults = ARRAY_SIZE(wm8510_reg_defaults),
610 .cache_type = REGCACHE_RBTREE,
612 .volatile_reg = wm8510_volatile,
615 #if defined(CONFIG_SPI_MASTER)
616 static int wm8510_spi_probe(struct spi_device *spi)
618 struct wm8510_priv *wm8510;
621 wm8510 = devm_kzalloc(&spi->dev, sizeof(struct wm8510_priv),
626 wm8510->regmap = devm_regmap_init_spi(spi, &wm8510_regmap);
627 if (IS_ERR(wm8510->regmap))
628 return PTR_ERR(wm8510->regmap);
630 spi_set_drvdata(spi, wm8510);
632 ret = snd_soc_register_codec(&spi->dev,
633 &soc_codec_dev_wm8510, &wm8510_dai, 1);
638 static int wm8510_spi_remove(struct spi_device *spi)
640 snd_soc_unregister_codec(&spi->dev);
644 static struct spi_driver wm8510_spi_driver = {
647 .owner = THIS_MODULE,
648 .of_match_table = wm8510_of_match,
650 .probe = wm8510_spi_probe,
651 .remove = wm8510_spi_remove,
653 #endif /* CONFIG_SPI_MASTER */
655 #if IS_ENABLED(CONFIG_I2C)
656 static int wm8510_i2c_probe(struct i2c_client *i2c,
657 const struct i2c_device_id *id)
659 struct wm8510_priv *wm8510;
662 wm8510 = devm_kzalloc(&i2c->dev, sizeof(struct wm8510_priv),
667 wm8510->regmap = devm_regmap_init_i2c(i2c, &wm8510_regmap);
668 if (IS_ERR(wm8510->regmap))
669 return PTR_ERR(wm8510->regmap);
671 i2c_set_clientdata(i2c, wm8510);
673 ret = snd_soc_register_codec(&i2c->dev,
674 &soc_codec_dev_wm8510, &wm8510_dai, 1);
679 static int wm8510_i2c_remove(struct i2c_client *client)
681 snd_soc_unregister_codec(&client->dev);
685 static const struct i2c_device_id wm8510_i2c_id[] = {
689 MODULE_DEVICE_TABLE(i2c, wm8510_i2c_id);
691 static struct i2c_driver wm8510_i2c_driver = {
694 .owner = THIS_MODULE,
695 .of_match_table = wm8510_of_match,
697 .probe = wm8510_i2c_probe,
698 .remove = wm8510_i2c_remove,
699 .id_table = wm8510_i2c_id,
703 static int __init wm8510_modinit(void)
706 #if IS_ENABLED(CONFIG_I2C)
707 ret = i2c_add_driver(&wm8510_i2c_driver);
709 printk(KERN_ERR "Failed to register WM8510 I2C driver: %d\n",
713 #if defined(CONFIG_SPI_MASTER)
714 ret = spi_register_driver(&wm8510_spi_driver);
716 printk(KERN_ERR "Failed to register WM8510 SPI driver: %d\n",
722 module_init(wm8510_modinit);
724 static void __exit wm8510_exit(void)
726 #if IS_ENABLED(CONFIG_I2C)
727 i2c_del_driver(&wm8510_i2c_driver);
729 #if defined(CONFIG_SPI_MASTER)
730 spi_unregister_driver(&wm8510_spi_driver);
733 module_exit(wm8510_exit);
735 MODULE_DESCRIPTION("ASoC WM8510 driver");
736 MODULE_AUTHOR("Liam Girdwood");
737 MODULE_LICENSE("GPL");