2 * wm8776.c -- WM8776 ALSA SoC Audio driver
4 * Copyright 2009 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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.
12 * TODO: Input ALC/limiter support
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/of_device.h>
22 #include <linux/platform_device.h>
23 #include <linux/spi/spi.h>
24 #include <linux/slab.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/soc.h>
29 #include <sound/initval.h>
30 #include <sound/tlv.h>
34 /* codec private data */
36 enum snd_soc_control_type control_type;
40 static const u16 wm8776_reg[WM8776_CACHEREGNUM] = {
41 0x79, 0x79, 0x79, 0xff, 0xff, /* 4 */
42 0xff, 0x00, 0x90, 0x00, 0x00, /* 9 */
43 0x22, 0x22, 0x22, 0x08, 0xcf, /* 14 */
44 0xcf, 0x7b, 0x00, 0x32, 0x00, /* 19 */
48 static int wm8776_reset(struct snd_soc_codec *codec)
50 return snd_soc_write(codec, WM8776_RESET, 0);
53 static const DECLARE_TLV_DB_SCALE(hp_tlv, -12100, 100, 1);
54 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
55 static const DECLARE_TLV_DB_SCALE(adc_tlv, -10350, 50, 1);
57 static const struct snd_kcontrol_new wm8776_snd_controls[] = {
58 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL, WM8776_HPRVOL,
60 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL, WM8776_DACRVOL,
62 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1, 0, 1, 0),
64 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2, 0, 1, 0),
66 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL, WM8776_ADCRVOL,
68 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX, 7, 6, 1, 1),
69 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL, WM8776_ADCRVOL, 8, 1, 0),
70 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL, 8, 1, 1),
73 static const struct snd_kcontrol_new inmix_controls[] = {
74 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX, 0, 1, 0),
75 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX, 1, 1, 0),
76 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX, 2, 1, 0),
77 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX, 3, 1, 0),
78 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX, 4, 1, 0),
81 static const struct snd_kcontrol_new outmix_controls[] = {
82 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX, 0, 1, 0),
83 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX, 1, 1, 0),
84 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX, 2, 1, 0),
87 static const struct snd_soc_dapm_widget wm8776_dapm_widgets[] = {
88 SND_SOC_DAPM_INPUT("AUX"),
90 SND_SOC_DAPM_INPUT("AIN1"),
91 SND_SOC_DAPM_INPUT("AIN2"),
92 SND_SOC_DAPM_INPUT("AIN3"),
93 SND_SOC_DAPM_INPUT("AIN4"),
94 SND_SOC_DAPM_INPUT("AIN5"),
96 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN, 6, 1,
97 inmix_controls, ARRAY_SIZE(inmix_controls)),
99 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN, 1, 1),
100 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN, 2, 1),
102 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM, 0, 0,
103 outmix_controls, ARRAY_SIZE(outmix_controls)),
105 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN, 3, 1, NULL, 0),
107 SND_SOC_DAPM_OUTPUT("VOUT"),
109 SND_SOC_DAPM_OUTPUT("HPOUTL"),
110 SND_SOC_DAPM_OUTPUT("HPOUTR"),
113 static const struct snd_soc_dapm_route routes[] = {
114 { "Input Mixer", "AIN1 Switch", "AIN1" },
115 { "Input Mixer", "AIN2 Switch", "AIN2" },
116 { "Input Mixer", "AIN3 Switch", "AIN3" },
117 { "Input Mixer", "AIN4 Switch", "AIN4" },
118 { "Input Mixer", "AIN5 Switch", "AIN5" },
120 { "ADC", NULL, "Input Mixer" },
122 { "Output Mixer", "DAC Switch", "DAC" },
123 { "Output Mixer", "AUX Switch", "AUX" },
124 { "Output Mixer", "Bypass Switch", "Input Mixer" },
126 { "VOUT", NULL, "Output Mixer" },
128 { "Headphone PGA", NULL, "Output Mixer" },
130 { "HPOUTL", NULL, "Headphone PGA" },
131 { "HPOUTR", NULL, "Headphone PGA" },
134 static int wm8776_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
136 struct snd_soc_codec *codec = dai->codec;
137 int reg, iface, master;
139 switch (dai->driver->id) {
141 reg = WM8776_DACIFCTRL;
145 reg = WM8776_ADCIFCTRL;
154 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
155 case SND_SOC_DAIFMT_CBM_CFM:
157 case SND_SOC_DAIFMT_CBS_CFS:
164 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
165 case SND_SOC_DAIFMT_I2S:
168 case SND_SOC_DAIFMT_RIGHT_J:
170 case SND_SOC_DAIFMT_LEFT_J:
177 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
178 case SND_SOC_DAIFMT_NB_NF:
180 case SND_SOC_DAIFMT_IB_IF:
183 case SND_SOC_DAIFMT_IB_NF:
186 case SND_SOC_DAIFMT_NB_IF:
193 /* Finally, write out the values */
194 snd_soc_update_bits(codec, reg, 0xf, iface);
195 snd_soc_update_bits(codec, WM8776_MSTRCTRL, 0x180, master);
200 static int mclk_ratios[] = {
209 static int wm8776_hw_params(struct snd_pcm_substream *substream,
210 struct snd_pcm_hw_params *params,
211 struct snd_soc_dai *dai)
213 struct snd_soc_codec *codec = dai->codec;
214 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
215 int iface_reg, iface;
216 int ratio_shift, master;
219 switch (dai->driver->id) {
221 iface_reg = WM8776_DACIFCTRL;
226 iface_reg = WM8776_ADCIFCTRL;
234 /* Set word length */
235 switch (snd_pcm_format_width(params_format(params))) {
248 dev_err(codec->dev, "Unsupported sample size: %i\n",
249 snd_pcm_format_width(params_format(params)));
253 /* Only need to set MCLK/LRCLK ratio if we're master */
254 if (snd_soc_read(codec, WM8776_MSTRCTRL) & master) {
255 for (i = 0; i < ARRAY_SIZE(mclk_ratios); i++) {
256 if (wm8776->sysclk[dai->driver->id] / params_rate(params)
261 if (i == ARRAY_SIZE(mclk_ratios)) {
263 "Unable to configure MCLK ratio %d/%d\n",
264 wm8776->sysclk[dai->driver->id], params_rate(params));
268 dev_dbg(codec->dev, "MCLK is %dfs\n", mclk_ratios[i]);
270 snd_soc_update_bits(codec, WM8776_MSTRCTRL,
271 0x7 << ratio_shift, i << ratio_shift);
273 dev_dbg(codec->dev, "DAI in slave mode\n");
276 snd_soc_update_bits(codec, iface_reg, 0x30, iface);
281 static int wm8776_mute(struct snd_soc_dai *dai, int mute)
283 struct snd_soc_codec *codec = dai->codec;
285 return snd_soc_write(codec, WM8776_DACMUTE, !!mute);
288 static int wm8776_set_sysclk(struct snd_soc_dai *dai,
289 int clk_id, unsigned int freq, int dir)
291 struct snd_soc_codec *codec = dai->codec;
292 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
294 BUG_ON(dai->driver->id >= ARRAY_SIZE(wm8776->sysclk));
296 wm8776->sysclk[dai->driver->id] = freq;
301 static int wm8776_set_bias_level(struct snd_soc_codec *codec,
302 enum snd_soc_bias_level level)
305 case SND_SOC_BIAS_ON:
307 case SND_SOC_BIAS_PREPARE:
309 case SND_SOC_BIAS_STANDBY:
310 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
311 /* Disable the global powerdown; DAPM does the rest */
312 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 0);
316 case SND_SOC_BIAS_OFF:
317 snd_soc_update_bits(codec, WM8776_PWRDOWN, 1, 1);
321 codec->dapm.bias_level = level;
325 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
326 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
327 SNDRV_PCM_RATE_96000)
330 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
331 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
333 static struct snd_soc_dai_ops wm8776_dac_ops = {
334 .digital_mute = wm8776_mute,
335 .hw_params = wm8776_hw_params,
336 .set_fmt = wm8776_set_fmt,
337 .set_sysclk = wm8776_set_sysclk,
340 static struct snd_soc_dai_ops wm8776_adc_ops = {
341 .hw_params = wm8776_hw_params,
342 .set_fmt = wm8776_set_fmt,
343 .set_sysclk = wm8776_set_sysclk,
346 static struct snd_soc_dai_driver wm8776_dai[] = {
348 .name = "wm8776-hifi-playback",
349 .id = WM8776_DAI_DAC,
351 .stream_name = "Playback",
354 .rates = WM8776_RATES,
355 .formats = WM8776_FORMATS,
357 .ops = &wm8776_dac_ops,
360 .name = "wm8776-hifi-capture",
361 .id = WM8776_DAI_ADC,
363 .stream_name = "Capture",
366 .rates = WM8776_RATES,
367 .formats = WM8776_FORMATS,
369 .ops = &wm8776_adc_ops,
374 static int wm8776_suspend(struct snd_soc_codec *codec, pm_message_t state)
376 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
381 static int wm8776_resume(struct snd_soc_codec *codec)
385 u16 *cache = codec->reg_cache;
387 /* Sync reg_cache with the hardware */
388 for (i = 0; i < ARRAY_SIZE(wm8776_reg); i++) {
389 if (cache[i] == wm8776_reg[i])
391 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
392 data[1] = cache[i] & 0x00ff;
393 codec->hw_write(codec->control_data, data, 2);
396 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
401 #define wm8776_suspend NULL
402 #define wm8776_resume NULL
405 static int wm8776_probe(struct snd_soc_codec *codec)
407 struct wm8776_priv *wm8776 = snd_soc_codec_get_drvdata(codec);
408 struct snd_soc_dapm_context *dapm = &codec->dapm;
411 ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8776->control_type);
413 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
417 ret = wm8776_reset(codec);
419 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
423 wm8776_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
425 /* Latch the update bits; right channel only since we always
427 snd_soc_update_bits(codec, WM8776_HPRVOL, 0x100, 0x100);
428 snd_soc_update_bits(codec, WM8776_DACRVOL, 0x100, 0x100);
430 snd_soc_add_controls(codec, wm8776_snd_controls,
431 ARRAY_SIZE(wm8776_snd_controls));
432 snd_soc_dapm_new_controls(dapm, wm8776_dapm_widgets,
433 ARRAY_SIZE(wm8776_dapm_widgets));
434 snd_soc_dapm_add_routes(dapm, routes, ARRAY_SIZE(routes));
439 /* power down chip */
440 static int wm8776_remove(struct snd_soc_codec *codec)
442 wm8776_set_bias_level(codec, SND_SOC_BIAS_OFF);
446 static struct snd_soc_codec_driver soc_codec_dev_wm8776 = {
447 .probe = wm8776_probe,
448 .remove = wm8776_remove,
449 .suspend = wm8776_suspend,
450 .resume = wm8776_resume,
451 .set_bias_level = wm8776_set_bias_level,
452 .reg_cache_size = ARRAY_SIZE(wm8776_reg),
453 .reg_word_size = sizeof(u16),
454 .reg_cache_default = wm8776_reg,
457 static const struct of_device_id wm8776_of_match[] = {
458 { .compatible = "wlf,wm8776", },
461 MODULE_DEVICE_TABLE(of, wm8776_of_match);
463 #if defined(CONFIG_SPI_MASTER)
464 static int __devinit wm8776_spi_probe(struct spi_device *spi)
466 struct wm8776_priv *wm8776;
469 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
473 wm8776->control_type = SND_SOC_SPI;
474 spi_set_drvdata(spi, wm8776);
476 ret = snd_soc_register_codec(&spi->dev,
477 &soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
483 static int __devexit wm8776_spi_remove(struct spi_device *spi)
485 snd_soc_unregister_codec(&spi->dev);
486 kfree(spi_get_drvdata(spi));
490 static struct spi_driver wm8776_spi_driver = {
493 .owner = THIS_MODULE,
494 .of_match_table = wm8776_of_match,
496 .probe = wm8776_spi_probe,
497 .remove = __devexit_p(wm8776_spi_remove),
499 #endif /* CONFIG_SPI_MASTER */
501 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
502 static __devinit int wm8776_i2c_probe(struct i2c_client *i2c,
503 const struct i2c_device_id *id)
505 struct wm8776_priv *wm8776;
508 wm8776 = kzalloc(sizeof(struct wm8776_priv), GFP_KERNEL);
512 i2c_set_clientdata(i2c, wm8776);
513 wm8776->control_type = SND_SOC_I2C;
515 ret = snd_soc_register_codec(&i2c->dev,
516 &soc_codec_dev_wm8776, wm8776_dai, ARRAY_SIZE(wm8776_dai));
522 static __devexit int wm8776_i2c_remove(struct i2c_client *client)
524 snd_soc_unregister_codec(&client->dev);
525 kfree(i2c_get_clientdata(client));
529 static const struct i2c_device_id wm8776_i2c_id[] = {
533 MODULE_DEVICE_TABLE(i2c, wm8776_i2c_id);
535 static struct i2c_driver wm8776_i2c_driver = {
538 .owner = THIS_MODULE,
539 .of_match_table = wm8776_of_match,
541 .probe = wm8776_i2c_probe,
542 .remove = __devexit_p(wm8776_i2c_remove),
543 .id_table = wm8776_i2c_id,
547 static int __init wm8776_modinit(void)
550 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
551 ret = i2c_add_driver(&wm8776_i2c_driver);
553 printk(KERN_ERR "Failed to register wm8776 I2C driver: %d\n",
557 #if defined(CONFIG_SPI_MASTER)
558 ret = spi_register_driver(&wm8776_spi_driver);
560 printk(KERN_ERR "Failed to register wm8776 SPI driver: %d\n",
566 module_init(wm8776_modinit);
568 static void __exit wm8776_exit(void)
570 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
571 i2c_del_driver(&wm8776_i2c_driver);
573 #if defined(CONFIG_SPI_MASTER)
574 spi_unregister_driver(&wm8776_spi_driver);
577 module_exit(wm8776_exit);
579 MODULE_DESCRIPTION("ASoC WM8776 driver");
580 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
581 MODULE_LICENSE("GPL");