2 * wm8728.c -- WM8728 ALSA SoC Audio driver
4 * Copyright 2008 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.
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
18 #include <linux/i2c.h>
19 #include <linux/platform_device.h>
20 #include <linux/spi/spi.h>
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/pcm_params.h>
24 #include <sound/soc.h>
25 #include <sound/soc-dapm.h>
26 #include <sound/initval.h>
27 #include <sound/tlv.h>
31 struct snd_soc_codec_device soc_codec_dev_wm8728;
34 * We can't read the WM8728 register space so we cache them instead.
35 * Note that the defaults here aren't the physical defaults, we latch
36 * the volume update bits, mute the output and enable infinite zero
39 static const u16 wm8728_reg_defaults[] = {
46 static inline unsigned int wm8728_read_reg_cache(struct snd_soc_codec *codec,
49 u16 *cache = codec->reg_cache;
50 BUG_ON(reg > ARRAY_SIZE(wm8728_reg_defaults));
54 static inline void wm8728_write_reg_cache(struct snd_soc_codec *codec,
55 u16 reg, unsigned int value)
57 u16 *cache = codec->reg_cache;
58 BUG_ON(reg > ARRAY_SIZE(wm8728_reg_defaults));
63 * write to the WM8728 register space
65 static int wm8728_write(struct snd_soc_codec *codec, unsigned int reg,
71 * D15..D9 WM8728 register offset
72 * D8...D0 register data
74 data[0] = (reg << 1) | ((value >> 8) & 0x0001);
75 data[1] = value & 0x00ff;
77 wm8728_write_reg_cache(codec, reg, value);
79 if (codec->hw_write(codec->control_data, data, 2) == 2)
85 static const DECLARE_TLV_DB_SCALE(wm8728_tlv, -12750, 50, 1);
87 static const struct snd_kcontrol_new wm8728_snd_controls[] = {
89 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8728_DACLVOL, WM8728_DACRVOL,
90 0, 255, 0, wm8728_tlv),
92 SOC_SINGLE("Deemphasis", WM8728_DACCTL, 1, 1, 0),
98 static const struct snd_soc_dapm_widget wm8728_dapm_widgets[] = {
99 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", SND_SOC_NOPM, 0, 0),
100 SND_SOC_DAPM_OUTPUT("VOUTL"),
101 SND_SOC_DAPM_OUTPUT("VOUTR"),
104 static const struct snd_soc_dapm_route intercon[] = {
105 {"VOUTL", NULL, "DAC"},
106 {"VOUTR", NULL, "DAC"},
109 static int wm8728_add_widgets(struct snd_soc_codec *codec)
111 snd_soc_dapm_new_controls(codec, wm8728_dapm_widgets,
112 ARRAY_SIZE(wm8728_dapm_widgets));
114 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
116 snd_soc_dapm_new_widgets(codec);
121 static int wm8728_mute(struct snd_soc_dai *dai, int mute)
123 struct snd_soc_codec *codec = dai->codec;
124 u16 mute_reg = wm8728_read_reg_cache(codec, WM8728_DACCTL);
127 wm8728_write(codec, WM8728_DACCTL, mute_reg | 1);
129 wm8728_write(codec, WM8728_DACCTL, mute_reg & ~1);
134 static int wm8728_hw_params(struct snd_pcm_substream *substream,
135 struct snd_pcm_hw_params *params,
136 struct snd_soc_dai *dai)
138 struct snd_soc_pcm_runtime *rtd = substream->private_data;
139 struct snd_soc_device *socdev = rtd->socdev;
140 struct snd_soc_codec *codec = socdev->codec;
141 u16 dac = wm8728_read_reg_cache(codec, WM8728_DACCTL);
145 switch (params_format(params)) {
146 case SNDRV_PCM_FORMAT_S16_LE:
148 case SNDRV_PCM_FORMAT_S20_3LE:
151 case SNDRV_PCM_FORMAT_S24_LE:
158 wm8728_write(codec, WM8728_DACCTL, dac);
163 static int wm8728_set_dai_fmt(struct snd_soc_dai *codec_dai,
166 struct snd_soc_codec *codec = codec_dai->codec;
167 u16 iface = wm8728_read_reg_cache(codec, WM8728_IFCTL);
169 /* Currently only I2S is supported by the driver, though the
170 * hardware is more flexible.
172 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
173 case SND_SOC_DAIFMT_I2S:
180 /* The hardware only support full slave mode */
181 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
182 case SND_SOC_DAIFMT_CBS_CFS:
188 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
189 case SND_SOC_DAIFMT_NB_NF:
192 case SND_SOC_DAIFMT_IB_NF:
196 case SND_SOC_DAIFMT_NB_IF:
200 case SND_SOC_DAIFMT_IB_IF:
207 wm8728_write(codec, WM8728_IFCTL, iface);
211 static int wm8728_set_bias_level(struct snd_soc_codec *codec,
212 enum snd_soc_bias_level level)
218 case SND_SOC_BIAS_ON:
219 case SND_SOC_BIAS_PREPARE:
220 case SND_SOC_BIAS_STANDBY:
221 if (codec->bias_level == SND_SOC_BIAS_OFF) {
222 /* Power everything up... */
223 reg = wm8728_read_reg_cache(codec, WM8728_DACCTL);
224 wm8728_write(codec, WM8728_DACCTL, reg & ~0x4);
226 /* ..then sync in the register cache. */
227 for (i = 0; i < ARRAY_SIZE(wm8728_reg_defaults); i++)
228 wm8728_write(codec, i,
229 wm8728_read_reg_cache(codec, i));
233 case SND_SOC_BIAS_OFF:
234 reg = wm8728_read_reg_cache(codec, WM8728_DACCTL);
235 wm8728_write(codec, WM8728_DACCTL, reg | 0x4);
238 codec->bias_level = level;
242 #define WM8728_RATES (SNDRV_PCM_RATE_8000_192000)
244 #define WM8728_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
245 SNDRV_PCM_FMTBIT_S24_LE)
247 struct snd_soc_dai wm8728_dai = {
250 .stream_name = "Playback",
253 .rates = WM8728_RATES,
254 .formats = WM8728_FORMATS,
257 .hw_params = wm8728_hw_params,
258 .digital_mute = wm8728_mute,
259 .set_fmt = wm8728_set_dai_fmt,
262 EXPORT_SYMBOL_GPL(wm8728_dai);
264 static int wm8728_suspend(struct platform_device *pdev, pm_message_t state)
266 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
267 struct snd_soc_codec *codec = socdev->codec;
269 wm8728_set_bias_level(codec, SND_SOC_BIAS_OFF);
274 static int wm8728_resume(struct platform_device *pdev)
276 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
277 struct snd_soc_codec *codec = socdev->codec;
279 wm8728_set_bias_level(codec, codec->suspend_bias_level);
285 * initialise the WM8728 driver
286 * register the mixer and dsp interfaces with the kernel
288 static int wm8728_init(struct snd_soc_device *socdev)
290 struct snd_soc_codec *codec = socdev->codec;
293 codec->name = "WM8728";
294 codec->owner = THIS_MODULE;
295 codec->read = wm8728_read_reg_cache;
296 codec->write = wm8728_write;
297 codec->set_bias_level = wm8728_set_bias_level;
298 codec->dai = &wm8728_dai;
300 codec->bias_level = SND_SOC_BIAS_OFF;
301 codec->reg_cache_size = ARRAY_SIZE(wm8728_reg_defaults);
302 codec->reg_cache = kmemdup(wm8728_reg_defaults,
303 sizeof(wm8728_reg_defaults),
305 if (codec->reg_cache == NULL)
309 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
311 printk(KERN_ERR "wm8728: failed to create pcms\n");
315 /* power on device */
316 wm8728_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
318 snd_soc_add_controls(codec, wm8728_snd_controls,
319 ARRAY_SIZE(wm8728_snd_controls));
320 wm8728_add_widgets(codec);
321 ret = snd_soc_init_card(socdev);
323 printk(KERN_ERR "wm8728: failed to register card\n");
330 snd_soc_free_pcms(socdev);
331 snd_soc_dapm_free(socdev);
333 kfree(codec->reg_cache);
337 static struct snd_soc_device *wm8728_socdev;
339 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
342 * WM8728 2 wire address is determined by GPIO5
343 * state during powerup.
348 static int wm8728_i2c_probe(struct i2c_client *i2c,
349 const struct i2c_device_id *id)
351 struct snd_soc_device *socdev = wm8728_socdev;
352 struct snd_soc_codec *codec = socdev->codec;
355 i2c_set_clientdata(i2c, codec);
356 codec->control_data = i2c;
358 ret = wm8728_init(socdev);
360 pr_err("failed to initialise WM8728\n");
365 static int wm8728_i2c_remove(struct i2c_client *client)
367 struct snd_soc_codec *codec = i2c_get_clientdata(client);
368 kfree(codec->reg_cache);
372 static const struct i2c_device_id wm8728_i2c_id[] = {
376 MODULE_DEVICE_TABLE(i2c, wm8728_i2c_id);
378 static struct i2c_driver wm8728_i2c_driver = {
380 .name = "WM8728 I2C Codec",
381 .owner = THIS_MODULE,
383 .probe = wm8728_i2c_probe,
384 .remove = wm8728_i2c_remove,
385 .id_table = wm8728_i2c_id,
388 static int wm8728_add_i2c_device(struct platform_device *pdev,
389 const struct wm8728_setup_data *setup)
391 struct i2c_board_info info;
392 struct i2c_adapter *adapter;
393 struct i2c_client *client;
396 ret = i2c_add_driver(&wm8728_i2c_driver);
398 dev_err(&pdev->dev, "can't add i2c driver\n");
402 memset(&info, 0, sizeof(struct i2c_board_info));
403 info.addr = setup->i2c_address;
404 strlcpy(info.type, "wm8728", I2C_NAME_SIZE);
406 adapter = i2c_get_adapter(setup->i2c_bus);
408 dev_err(&pdev->dev, "can't get i2c adapter %d\n",
413 client = i2c_new_device(adapter, &info);
414 i2c_put_adapter(adapter);
416 dev_err(&pdev->dev, "can't add i2c device at 0x%x\n",
417 (unsigned int)info.addr);
424 i2c_del_driver(&wm8728_i2c_driver);
429 #if defined(CONFIG_SPI_MASTER)
430 static int __devinit wm8728_spi_probe(struct spi_device *spi)
432 struct snd_soc_device *socdev = wm8728_socdev;
433 struct snd_soc_codec *codec = socdev->codec;
436 codec->control_data = spi;
438 ret = wm8728_init(socdev);
440 dev_err(&spi->dev, "failed to initialise WM8728\n");
445 static int __devexit wm8728_spi_remove(struct spi_device *spi)
450 static struct spi_driver wm8728_spi_driver = {
453 .bus = &spi_bus_type,
454 .owner = THIS_MODULE,
456 .probe = wm8728_spi_probe,
457 .remove = __devexit_p(wm8728_spi_remove),
460 static int wm8728_spi_write(struct spi_device *spi, const char *data, int len)
462 struct spi_transfer t;
463 struct spi_message m;
472 spi_message_init(&m);
473 memset(&t, 0, (sizeof t));
478 spi_message_add_tail(&t, &m);
483 #endif /* CONFIG_SPI_MASTER */
485 static int wm8728_probe(struct platform_device *pdev)
487 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
488 struct wm8728_setup_data *setup;
489 struct snd_soc_codec *codec;
492 setup = socdev->codec_data;
493 codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
497 socdev->codec = codec;
498 mutex_init(&codec->mutex);
499 INIT_LIST_HEAD(&codec->dapm_widgets);
500 INIT_LIST_HEAD(&codec->dapm_paths);
502 wm8728_socdev = socdev;
505 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
506 if (setup->i2c_address) {
507 codec->hw_write = (hw_write_t)i2c_master_send;
508 ret = wm8728_add_i2c_device(pdev, setup);
511 #if defined(CONFIG_SPI_MASTER)
513 codec->hw_write = (hw_write_t)wm8728_spi_write;
514 ret = spi_register_driver(&wm8728_spi_driver);
516 printk(KERN_ERR "can't add spi driver");
526 /* power down chip */
527 static int wm8728_remove(struct platform_device *pdev)
529 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
530 struct snd_soc_codec *codec = socdev->codec;
532 if (codec->control_data)
533 wm8728_set_bias_level(codec, SND_SOC_BIAS_OFF);
535 snd_soc_free_pcms(socdev);
536 snd_soc_dapm_free(socdev);
537 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
538 i2c_unregister_device(codec->control_data);
539 i2c_del_driver(&wm8728_i2c_driver);
541 #if defined(CONFIG_SPI_MASTER)
542 spi_unregister_driver(&wm8728_spi_driver);
549 struct snd_soc_codec_device soc_codec_dev_wm8728 = {
550 .probe = wm8728_probe,
551 .remove = wm8728_remove,
552 .suspend = wm8728_suspend,
553 .resume = wm8728_resume,
555 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8728);
557 static int __init wm8728_modinit(void)
559 return snd_soc_register_dai(&wm8728_dai);
561 module_init(wm8728_modinit);
563 static void __exit wm8728_exit(void)
565 snd_soc_unregister_dai(&wm8728_dai);
567 module_exit(wm8728_exit);
569 MODULE_DESCRIPTION("ASoC WM8728 driver");
570 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
571 MODULE_LICENSE("GPL");