2 * wm8711.c -- WM8711 ALSA SoC Audio driver
4 * Copyright 2006 Wolfson Microelectronics
6 * Author: Mike Arthur <linux@wolfsonmicro.com>
8 * Based on wm8731.c by Richard Purdie
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/platform_device.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
31 static struct snd_soc_codec *wm8711_codec;
33 /* codec private data */
35 struct snd_soc_codec codec;
36 u16 reg_cache[WM8711_CACHEREGNUM];
41 * wm8711 register cache
42 * We can't read the WM8711 register space when we are
43 * using 2 wire for device control, so we cache them instead.
44 * There is no point in caching the reset register
46 static const u16 wm8711_reg[WM8711_CACHEREGNUM] = {
47 0x0079, 0x0079, 0x000a, 0x0008,
48 0x009f, 0x000a, 0x0000, 0x0000
51 #define wm8711_reset(c) snd_soc_write(c, WM8711_RESET, 0)
53 static const struct snd_kcontrol_new wm8711_snd_controls[] = {
55 SOC_DOUBLE_R("Master Playback Volume", WM8711_LOUT1V, WM8711_ROUT1V,
57 SOC_DOUBLE_R("Master Playback ZC Switch", WM8711_LOUT1V, WM8711_ROUT1V,
63 static const struct snd_kcontrol_new wm8711_output_mixer_controls[] = {
64 SOC_DAPM_SINGLE("Line Bypass Switch", WM8711_APANA, 3, 1, 0),
65 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8711_APANA, 4, 1, 0),
68 static const struct snd_soc_dapm_widget wm8711_dapm_widgets[] = {
69 SND_SOC_DAPM_MIXER("Output Mixer", WM8711_PWR, 4, 1,
70 &wm8711_output_mixer_controls[0],
71 ARRAY_SIZE(wm8711_output_mixer_controls)),
72 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8711_PWR, 3, 1),
73 SND_SOC_DAPM_OUTPUT("LOUT"),
74 SND_SOC_DAPM_OUTPUT("LHPOUT"),
75 SND_SOC_DAPM_OUTPUT("ROUT"),
76 SND_SOC_DAPM_OUTPUT("RHPOUT"),
79 static const struct snd_soc_dapm_route intercon[] = {
81 {"Output Mixer", "Line Bypass Switch", "Line Input"},
82 {"Output Mixer", "HiFi Playback Switch", "DAC"},
85 {"RHPOUT", NULL, "Output Mixer"},
86 {"ROUT", NULL, "Output Mixer"},
87 {"LHPOUT", NULL, "Output Mixer"},
88 {"LOUT", NULL, "Output Mixer"},
91 static int wm8711_add_widgets(struct snd_soc_codec *codec)
93 snd_soc_dapm_new_controls(codec, wm8711_dapm_widgets,
94 ARRAY_SIZE(wm8711_dapm_widgets));
96 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
98 snd_soc_dapm_new_widgets(codec);
111 /* codec mclk clock divider coefficients */
112 static const struct _coeff_div coeff_div[] = {
114 {12288000, 48000, 256, 0x0, 0x0, 0x0},
115 {18432000, 48000, 384, 0x0, 0x1, 0x0},
116 {12000000, 48000, 250, 0x0, 0x0, 0x1},
119 {12288000, 32000, 384, 0x6, 0x0, 0x0},
120 {18432000, 32000, 576, 0x6, 0x1, 0x0},
121 {12000000, 32000, 375, 0x6, 0x0, 0x1},
124 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
125 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
126 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
127 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
128 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
131 {12288000, 96000, 128, 0x7, 0x0, 0x0},
132 {18432000, 96000, 192, 0x7, 0x1, 0x0},
133 {12000000, 96000, 125, 0x7, 0x0, 0x1},
136 {11289600, 44100, 256, 0x8, 0x0, 0x0},
137 {16934400, 44100, 384, 0x8, 0x1, 0x0},
138 {12000000, 44100, 272, 0x8, 0x1, 0x1},
141 {11289600, 88200, 128, 0xf, 0x0, 0x0},
142 {16934400, 88200, 192, 0xf, 0x1, 0x0},
143 {12000000, 88200, 136, 0xf, 0x1, 0x1},
146 static inline int get_coeff(int mclk, int rate)
150 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
151 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
157 static int wm8711_hw_params(struct snd_pcm_substream *substream,
158 struct snd_pcm_hw_params *params,
159 struct snd_soc_dai *dai)
161 struct snd_soc_codec *codec = dai->codec;
162 struct wm8711_priv *wm8711 = codec->private_data;
163 u16 iface = snd_soc_read(codec, WM8711_IFACE) & 0xfffc;
164 int i = get_coeff(wm8711->sysclk, params_rate(params));
165 u16 srate = (coeff_div[i].sr << 2) |
166 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
168 snd_soc_write(codec, WM8711_SRATE, srate);
171 switch (params_format(params)) {
172 case SNDRV_PCM_FORMAT_S16_LE:
174 case SNDRV_PCM_FORMAT_S20_3LE:
177 case SNDRV_PCM_FORMAT_S24_LE:
182 snd_soc_write(codec, WM8711_IFACE, iface);
186 static int wm8711_pcm_prepare(struct snd_pcm_substream *substream,
187 struct snd_soc_dai *dai)
189 struct snd_soc_codec *codec = dai->codec;
192 snd_soc_write(codec, WM8711_ACTIVE, 0x0001);
197 static void wm8711_shutdown(struct snd_pcm_substream *substream,
198 struct snd_soc_dai *dai)
200 struct snd_soc_codec *codec = dai->codec;
203 if (!codec->active) {
205 snd_soc_write(codec, WM8711_ACTIVE, 0x0);
209 static int wm8711_mute(struct snd_soc_dai *dai, int mute)
211 struct snd_soc_codec *codec = dai->codec;
212 u16 mute_reg = snd_soc_read(codec, WM8711_APDIGI) & 0xfff7;
215 snd_soc_write(codec, WM8711_APDIGI, mute_reg | 0x8);
217 snd_soc_write(codec, WM8711_APDIGI, mute_reg);
222 static int wm8711_set_dai_sysclk(struct snd_soc_dai *codec_dai,
223 int clk_id, unsigned int freq, int dir)
225 struct snd_soc_codec *codec = codec_dai->codec;
226 struct wm8711_priv *wm8711 = codec->private_data;
234 wm8711->sysclk = freq;
240 static int wm8711_set_dai_fmt(struct snd_soc_dai *codec_dai,
243 struct snd_soc_codec *codec = codec_dai->codec;
246 /* set master/slave audio interface */
247 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
248 case SND_SOC_DAIFMT_CBM_CFM:
251 case SND_SOC_DAIFMT_CBS_CFS:
257 /* interface format */
258 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
259 case SND_SOC_DAIFMT_I2S:
262 case SND_SOC_DAIFMT_RIGHT_J:
264 case SND_SOC_DAIFMT_LEFT_J:
267 case SND_SOC_DAIFMT_DSP_A:
270 case SND_SOC_DAIFMT_DSP_B:
277 /* clock inversion */
278 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
279 case SND_SOC_DAIFMT_NB_NF:
281 case SND_SOC_DAIFMT_IB_IF:
284 case SND_SOC_DAIFMT_IB_NF:
287 case SND_SOC_DAIFMT_NB_IF:
295 snd_soc_write(codec, WM8711_IFACE, iface);
300 static int wm8711_set_bias_level(struct snd_soc_codec *codec,
301 enum snd_soc_bias_level level)
303 u16 reg = snd_soc_read(codec, WM8711_PWR) & 0xff7f;
306 case SND_SOC_BIAS_ON:
307 snd_soc_write(codec, WM8711_PWR, reg);
309 case SND_SOC_BIAS_PREPARE:
311 case SND_SOC_BIAS_STANDBY:
312 snd_soc_write(codec, WM8711_PWR, reg | 0x0040);
314 case SND_SOC_BIAS_OFF:
315 snd_soc_write(codec, WM8711_ACTIVE, 0x0);
316 snd_soc_write(codec, WM8711_PWR, 0xffff);
319 codec->bias_level = level;
323 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000
325 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
326 SNDRV_PCM_FMTBIT_S24_LE)
328 static struct snd_soc_dai_ops wm8711_ops = {
329 .prepare = wm8711_pcm_prepare,
330 .hw_params = wm8711_hw_params,
331 .shutdown = wm8711_shutdown,
332 .digital_mute = wm8711_mute,
333 .set_sysclk = wm8711_set_dai_sysclk,
334 .set_fmt = wm8711_set_dai_fmt,
337 struct snd_soc_dai wm8711_dai = {
340 .stream_name = "Playback",
343 .rates = WM8711_RATES,
344 .formats = WM8711_FORMATS,
348 EXPORT_SYMBOL_GPL(wm8711_dai);
350 static int wm8711_suspend(struct platform_device *pdev, pm_message_t state)
352 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
353 struct snd_soc_codec *codec = socdev->card->codec;
355 snd_soc_write(codec, WM8711_ACTIVE, 0x0);
356 wm8711_set_bias_level(codec, SND_SOC_BIAS_OFF);
360 static int wm8711_resume(struct platform_device *pdev)
362 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
363 struct snd_soc_codec *codec = socdev->card->codec;
366 u16 *cache = codec->reg_cache;
368 /* Sync reg_cache with the hardware */
369 for (i = 0; i < ARRAY_SIZE(wm8711_reg); i++) {
370 data[0] = (i << 1) | ((cache[i] >> 8) & 0x0001);
371 data[1] = cache[i] & 0x00ff;
372 codec->hw_write(codec->control_data, data, 2);
374 wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
375 wm8711_set_bias_level(codec, codec->suspend_bias_level);
379 static int wm8711_probe(struct platform_device *pdev)
381 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
382 struct snd_soc_codec *codec;
385 if (wm8711_codec == NULL) {
386 dev_err(&pdev->dev, "Codec device not registered\n");
390 socdev->card->codec = wm8711_codec;
391 codec = wm8711_codec;
394 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
396 dev_err(codec->dev, "failed to create pcms: %d\n", ret);
400 snd_soc_add_controls(codec, wm8711_snd_controls,
401 ARRAY_SIZE(wm8711_snd_controls));
402 wm8711_add_widgets(codec);
403 ret = snd_soc_init_card(socdev);
405 dev_err(codec->dev, "failed to register card: %d\n", ret);
412 snd_soc_free_pcms(socdev);
413 snd_soc_dapm_free(socdev);
418 /* power down chip */
419 static int wm8711_remove(struct platform_device *pdev)
421 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
423 snd_soc_free_pcms(socdev);
424 snd_soc_dapm_free(socdev);
429 struct snd_soc_codec_device soc_codec_dev_wm8711 = {
430 .probe = wm8711_probe,
431 .remove = wm8711_remove,
432 .suspend = wm8711_suspend,
433 .resume = wm8711_resume,
435 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8711);
437 static int wm8711_register(struct wm8711_priv *wm8711,
438 enum snd_soc_control_type control)
441 struct snd_soc_codec *codec = &wm8711->codec;
445 dev_err(codec->dev, "Another WM8711 is registered\n");
449 mutex_init(&codec->mutex);
450 INIT_LIST_HEAD(&codec->dapm_widgets);
451 INIT_LIST_HEAD(&codec->dapm_paths);
453 codec->private_data = wm8711;
454 codec->name = "WM8711";
455 codec->owner = THIS_MODULE;
456 codec->bias_level = SND_SOC_BIAS_OFF;
457 codec->set_bias_level = wm8711_set_bias_level;
458 codec->dai = &wm8711_dai;
460 codec->reg_cache_size = WM8711_CACHEREGNUM;
461 codec->reg_cache = &wm8711->reg_cache;
463 memcpy(codec->reg_cache, wm8711_reg, sizeof(wm8711_reg));
465 ret = snd_soc_codec_set_cache_io(codec, 7, 9, control);
467 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
471 ret = wm8711_reset(codec);
473 dev_err(codec->dev, "Failed to issue reset\n");
477 wm8711_dai.dev = codec->dev;
479 wm8711_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
481 /* Latch the update bits */
482 reg = snd_soc_read(codec, WM8711_LOUT1V);
483 snd_soc_write(codec, WM8711_LOUT1V, reg | 0x0100);
484 reg = snd_soc_read(codec, WM8711_ROUT1V);
485 snd_soc_write(codec, WM8711_ROUT1V, reg | 0x0100);
487 wm8711_codec = codec;
489 ret = snd_soc_register_codec(codec);
491 dev_err(codec->dev, "Failed to register codec: %d\n", ret);
495 ret = snd_soc_register_dai(&wm8711_dai);
497 dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
504 snd_soc_unregister_codec(codec);
510 static void wm8711_unregister(struct wm8711_priv *wm8711)
512 wm8711_set_bias_level(&wm8711->codec, SND_SOC_BIAS_OFF);
513 snd_soc_unregister_dai(&wm8711_dai);
514 snd_soc_unregister_codec(&wm8711->codec);
519 #if defined(CONFIG_SPI_MASTER)
520 static int __devinit wm8711_spi_probe(struct spi_device *spi)
522 struct snd_soc_codec *codec;
523 struct wm8711_priv *wm8711;
525 wm8711 = kzalloc(sizeof(struct wm8711_priv), GFP_KERNEL);
529 codec = &wm8711->codec;
530 codec->control_data = spi;
531 codec->dev = &spi->dev;
533 dev_set_drvdata(&spi->dev, wm8711);
535 return wm8711_register(wm8711, SND_SOC_SPI);
538 static int __devexit wm8711_spi_remove(struct spi_device *spi)
540 struct wm8711_priv *wm8711 = dev_get_drvdata(&spi->dev);
542 wm8711_unregister(wm8711);
548 static int wm8711_spi_suspend(struct spi_device *spi, pm_message_t msg)
550 return snd_soc_suspend_device(&spi->dev);
553 static int wm8711_spi_resume(struct spi_device *spi)
555 return snd_soc_resume_device(&spi->dev);
558 #define wm8711_spi_suspend NULL
559 #define wm8711_spi_resume NULL
562 static struct spi_driver wm8711_spi_driver = {
565 .bus = &spi_bus_type,
566 .owner = THIS_MODULE,
568 .probe = wm8711_spi_probe,
569 .suspend = wm8711_spi_suspend,
570 .resume = wm8711_spi_resume,
571 .remove = __devexit_p(wm8711_spi_remove),
573 #endif /* CONFIG_SPI_MASTER */
575 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
576 static __devinit int wm8711_i2c_probe(struct i2c_client *i2c,
577 const struct i2c_device_id *id)
579 struct wm8711_priv *wm8711;
580 struct snd_soc_codec *codec;
582 wm8711 = kzalloc(sizeof(struct wm8711_priv), GFP_KERNEL);
586 codec = &wm8711->codec;
587 codec->hw_write = (hw_write_t)i2c_master_send;
589 i2c_set_clientdata(i2c, wm8711);
590 codec->control_data = i2c;
592 codec->dev = &i2c->dev;
594 return wm8711_register(wm8711, SND_SOC_I2C);
597 static __devexit int wm8711_i2c_remove(struct i2c_client *client)
599 struct wm8711_priv *wm8711 = i2c_get_clientdata(client);
600 wm8711_unregister(wm8711);
604 static const struct i2c_device_id wm8711_i2c_id[] = {
608 MODULE_DEVICE_TABLE(i2c, wm8711_i2c_id);
610 static struct i2c_driver wm8711_i2c_driver = {
612 .name = "WM8711 I2C Codec",
613 .owner = THIS_MODULE,
615 .probe = wm8711_i2c_probe,
616 .remove = __devexit_p(wm8711_i2c_remove),
617 .id_table = wm8711_i2c_id,
621 static int __init wm8711_modinit(void)
624 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
625 ret = i2c_add_driver(&wm8711_i2c_driver);
627 printk(KERN_ERR "Failed to register WM8711 I2C driver: %d\n",
631 #if defined(CONFIG_SPI_MASTER)
632 ret = spi_register_driver(&wm8731_spi_driver);
634 printk(KERN_ERR "Failed to register WM8731 SPI driver: %d\n",
640 module_init(wm8711_modinit);
642 static void __exit wm8711_exit(void)
644 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
645 i2c_del_driver(&wm8711_i2c_driver);
647 #if defined(CONFIG_SPI_MASTER)
648 spi_unregister_driver(&wm8731_spi_driver);
651 module_exit(wm8711_exit);
653 MODULE_DESCRIPTION("ASoC WM8711 driver");
654 MODULE_AUTHOR("Mike Arthur");
655 MODULE_LICENSE("GPL");