2 * wm8741.c -- WM8741 ALSA SoC Audio driver
4 * Copyright 2010 Wolfson Microelectronics plc
6 * Author: Ian Lartey <ian@opensource.wolfsonmicro.com>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/module.h>
15 #include <linux/moduleparam.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/regulator/consumer.h>
22 #include <linux/slab.h>
23 #include <linux/of_device.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>
29 #include <sound/tlv.h>
33 #define WM8741_NUM_SUPPLIES 2
34 static const char *wm8741_supply_names[WM8741_NUM_SUPPLIES] = {
39 #define WM8741_NUM_RATES 6
41 /* codec private data */
43 enum snd_soc_control_type control_type;
44 struct regulator_bulk_data supplies[WM8741_NUM_SUPPLIES];
46 struct snd_pcm_hw_constraint_list *sysclk_constraints;
49 static const u16 wm8741_reg_defaults[WM8741_REGISTER_COUNT] = {
50 0x0000, /* R0 - DACLLSB Attenuation */
51 0x0000, /* R1 - DACLMSB Attenuation */
52 0x0000, /* R2 - DACRLSB Attenuation */
53 0x0000, /* R3 - DACRMSB Attenuation */
54 0x0000, /* R4 - Volume Control */
55 0x000A, /* R5 - Format Control */
56 0x0000, /* R6 - Filter Control */
57 0x0000, /* R7 - Mode Control 1 */
58 0x0002, /* R8 - Mode Control 2 */
59 0x0000, /* R9 - Reset */
60 0x0002, /* R32 - ADDITONAL_CONTROL_1 */
64 static int wm8741_reset(struct snd_soc_codec *codec)
66 return snd_soc_write(codec, WM8741_RESET, 0);
69 static const DECLARE_TLV_DB_SCALE(dac_tlv_fine, -12700, 13, 0);
70 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12700, 400, 0);
72 static const struct snd_kcontrol_new wm8741_snd_controls[] = {
73 SOC_DOUBLE_R_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION,
74 WM8741_DACRLSB_ATTENUATION, 1, 255, 1, dac_tlv_fine),
75 SOC_DOUBLE_R_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION,
76 WM8741_DACRMSB_ATTENUATION, 0, 511, 1, dac_tlv),
79 static const struct snd_soc_dapm_widget wm8741_dapm_widgets[] = {
80 SND_SOC_DAPM_DAC("DACL", "Playback", SND_SOC_NOPM, 0, 0),
81 SND_SOC_DAPM_DAC("DACR", "Playback", SND_SOC_NOPM, 0, 0),
82 SND_SOC_DAPM_OUTPUT("VOUTLP"),
83 SND_SOC_DAPM_OUTPUT("VOUTLN"),
84 SND_SOC_DAPM_OUTPUT("VOUTRP"),
85 SND_SOC_DAPM_OUTPUT("VOUTRN"),
88 static const struct snd_soc_dapm_route wm8741_dapm_routes[] = {
89 { "VOUTLP", NULL, "DACL" },
90 { "VOUTLN", NULL, "DACL" },
91 { "VOUTRP", NULL, "DACR" },
92 { "VOUTRN", NULL, "DACR" },
98 } lrclk_ratios[WM8741_NUM_RATES] = {
107 static unsigned int rates_11289[] = {
111 static struct snd_pcm_hw_constraint_list constraints_11289 = {
112 .count = ARRAY_SIZE(rates_11289),
116 static unsigned int rates_12288[] = {
120 static struct snd_pcm_hw_constraint_list constraints_12288 = {
121 .count = ARRAY_SIZE(rates_12288),
125 static unsigned int rates_16384[] = {
129 static struct snd_pcm_hw_constraint_list constraints_16384 = {
130 .count = ARRAY_SIZE(rates_16384),
134 static unsigned int rates_16934[] = {
138 static struct snd_pcm_hw_constraint_list constraints_16934 = {
139 .count = ARRAY_SIZE(rates_16934),
143 static unsigned int rates_18432[] = {
147 static struct snd_pcm_hw_constraint_list constraints_18432 = {
148 .count = ARRAY_SIZE(rates_18432),
152 static unsigned int rates_22579[] = {
153 44100, 88235, 1764000
156 static struct snd_pcm_hw_constraint_list constraints_22579 = {
157 .count = ARRAY_SIZE(rates_22579),
161 static unsigned int rates_24576[] = {
162 32000, 48000, 96000, 192000
165 static struct snd_pcm_hw_constraint_list constraints_24576 = {
166 .count = ARRAY_SIZE(rates_24576),
170 static unsigned int rates_36864[] = {
174 static struct snd_pcm_hw_constraint_list constraints_36864 = {
175 .count = ARRAY_SIZE(rates_36864),
180 static int wm8741_startup(struct snd_pcm_substream *substream,
181 struct snd_soc_dai *dai)
183 struct snd_soc_codec *codec = dai->codec;
184 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
186 /* The set of sample rates that can be supported depends on the
187 * MCLK supplied to the CODEC - enforce this.
189 if (!wm8741->sysclk) {
191 "No MCLK configured, call set_sysclk() on init\n");
195 snd_pcm_hw_constraint_list(substream->runtime, 0,
196 SNDRV_PCM_HW_PARAM_RATE,
197 wm8741->sysclk_constraints);
202 static int wm8741_hw_params(struct snd_pcm_substream *substream,
203 struct snd_pcm_hw_params *params,
204 struct snd_soc_dai *dai)
206 struct snd_soc_pcm_runtime *rtd = substream->private_data;
207 struct snd_soc_codec *codec = rtd->codec;
208 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
209 u16 iface = snd_soc_read(codec, WM8741_FORMAT_CONTROL) & 0x1FC;
212 /* Find a supported LRCLK ratio */
213 for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
214 if (wm8741->sysclk / params_rate(params) ==
215 lrclk_ratios[i].ratio)
219 /* Should never happen, should be handled by constraints */
220 if (i == ARRAY_SIZE(lrclk_ratios)) {
221 dev_err(codec->dev, "MCLK/fs ratio %d unsupported\n",
222 wm8741->sysclk / params_rate(params));
227 switch (params_format(params)) {
228 case SNDRV_PCM_FORMAT_S16_LE:
230 case SNDRV_PCM_FORMAT_S20_3LE:
233 case SNDRV_PCM_FORMAT_S24_LE:
236 case SNDRV_PCM_FORMAT_S32_LE:
240 dev_dbg(codec->dev, "wm8741_hw_params: Unsupported bit size param = %d",
241 params_format(params));
245 dev_dbg(codec->dev, "wm8741_hw_params: bit size param = %d",
246 params_format(params));
248 snd_soc_write(codec, WM8741_FORMAT_CONTROL, iface);
252 static int wm8741_set_dai_sysclk(struct snd_soc_dai *codec_dai,
253 int clk_id, unsigned int freq, int dir)
255 struct snd_soc_codec *codec = codec_dai->codec;
256 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
258 dev_dbg(codec->dev, "wm8741_set_dai_sysclk info: freq=%dHz\n", freq);
262 wm8741->sysclk_constraints = &constraints_11289;
263 wm8741->sysclk = freq;
267 wm8741->sysclk_constraints = &constraints_12288;
268 wm8741->sysclk = freq;
272 wm8741->sysclk_constraints = &constraints_16384;
273 wm8741->sysclk = freq;
277 wm8741->sysclk_constraints = &constraints_16934;
278 wm8741->sysclk = freq;
282 wm8741->sysclk_constraints = &constraints_18432;
283 wm8741->sysclk = freq;
288 wm8741->sysclk_constraints = &constraints_22579;
289 wm8741->sysclk = freq;
293 wm8741->sysclk_constraints = &constraints_24576;
294 wm8741->sysclk = freq;
298 wm8741->sysclk_constraints = &constraints_36864;
299 wm8741->sysclk = freq;
305 static int wm8741_set_dai_fmt(struct snd_soc_dai *codec_dai,
308 struct snd_soc_codec *codec = codec_dai->codec;
309 u16 iface = snd_soc_read(codec, WM8741_FORMAT_CONTROL) & 0x1C3;
311 /* check master/slave audio interface */
312 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
313 case SND_SOC_DAIFMT_CBS_CFS:
319 /* interface format */
320 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
321 case SND_SOC_DAIFMT_I2S:
324 case SND_SOC_DAIFMT_RIGHT_J:
326 case SND_SOC_DAIFMT_LEFT_J:
329 case SND_SOC_DAIFMT_DSP_A:
332 case SND_SOC_DAIFMT_DSP_B:
339 /* clock inversion */
340 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
341 case SND_SOC_DAIFMT_NB_NF:
343 case SND_SOC_DAIFMT_IB_IF:
346 case SND_SOC_DAIFMT_IB_NF:
349 case SND_SOC_DAIFMT_NB_IF:
357 dev_dbg(codec->dev, "wm8741_set_dai_fmt: Format=%x, Clock Inv=%x\n",
358 fmt & SND_SOC_DAIFMT_FORMAT_MASK,
359 ((fmt & SND_SOC_DAIFMT_INV_MASK)));
361 snd_soc_write(codec, WM8741_FORMAT_CONTROL, iface);
365 #define WM8741_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
366 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | \
367 SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 | \
368 SNDRV_PCM_RATE_192000)
370 #define WM8741_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
371 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
373 static const struct snd_soc_dai_ops wm8741_dai_ops = {
374 .startup = wm8741_startup,
375 .hw_params = wm8741_hw_params,
376 .set_sysclk = wm8741_set_dai_sysclk,
377 .set_fmt = wm8741_set_dai_fmt,
380 static struct snd_soc_dai_driver wm8741_dai = {
383 .stream_name = "Playback",
384 .channels_min = 2, /* Mono modes not yet supported */
386 .rates = WM8741_RATES,
387 .formats = WM8741_FORMATS,
389 .ops = &wm8741_dai_ops,
393 static int wm8741_resume(struct snd_soc_codec *codec)
395 snd_soc_cache_sync(codec);
399 #define wm8741_suspend NULL
400 #define wm8741_resume NULL
403 static int wm8741_probe(struct snd_soc_codec *codec)
405 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
409 for (i = 0; i < ARRAY_SIZE(wm8741->supplies); i++)
410 wm8741->supplies[i].supply = wm8741_supply_names[i];
412 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8741->supplies),
415 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
419 ret = regulator_bulk_enable(ARRAY_SIZE(wm8741->supplies),
422 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
426 ret = snd_soc_codec_set_cache_io(codec, 7, 9, wm8741->control_type);
428 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
432 ret = wm8741_reset(codec);
434 dev_err(codec->dev, "Failed to issue reset\n");
438 /* Change some default settings - latch VU */
439 snd_soc_update_bits(codec, WM8741_DACLLSB_ATTENUATION,
440 WM8741_UPDATELL, WM8741_UPDATELL);
441 snd_soc_update_bits(codec, WM8741_DACLMSB_ATTENUATION,
442 WM8741_UPDATELM, WM8741_UPDATELM);
443 snd_soc_update_bits(codec, WM8741_DACRLSB_ATTENUATION,
444 WM8741_UPDATERL, WM8741_UPDATERL);
445 snd_soc_update_bits(codec, WM8741_DACRMSB_ATTENUATION,
446 WM8741_UPDATERM, WM8741_UPDATERM);
448 dev_dbg(codec->dev, "Successful registration\n");
452 regulator_bulk_disable(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
454 regulator_bulk_free(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
459 static int wm8741_remove(struct snd_soc_codec *codec)
461 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
463 regulator_bulk_disable(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
464 regulator_bulk_free(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
469 static struct snd_soc_codec_driver soc_codec_dev_wm8741 = {
470 .probe = wm8741_probe,
471 .remove = wm8741_remove,
472 .resume = wm8741_resume,
473 .reg_cache_size = ARRAY_SIZE(wm8741_reg_defaults),
474 .reg_word_size = sizeof(u16),
475 .reg_cache_default = wm8741_reg_defaults,
477 .controls = wm8741_snd_controls,
478 .num_controls = ARRAY_SIZE(wm8741_snd_controls),
479 .dapm_widgets = wm8741_dapm_widgets,
480 .num_dapm_widgets = ARRAY_SIZE(wm8741_dapm_widgets),
481 .dapm_routes = wm8741_dapm_routes,
482 .num_dapm_routes = ARRAY_SIZE(wm8741_dapm_routes),
485 static const struct of_device_id wm8741_of_match[] = {
486 { .compatible = "wlf,wm8741", },
489 MODULE_DEVICE_TABLE(of, wm8741_of_match);
491 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
492 static int wm8741_i2c_probe(struct i2c_client *i2c,
493 const struct i2c_device_id *id)
495 struct wm8741_priv *wm8741;
498 wm8741 = devm_kzalloc(&i2c->dev, sizeof(struct wm8741_priv),
503 i2c_set_clientdata(i2c, wm8741);
504 wm8741->control_type = SND_SOC_I2C;
506 ret = snd_soc_register_codec(&i2c->dev,
507 &soc_codec_dev_wm8741, &wm8741_dai, 1);
512 static int wm8741_i2c_remove(struct i2c_client *client)
514 snd_soc_unregister_codec(&client->dev);
518 static const struct i2c_device_id wm8741_i2c_id[] = {
522 MODULE_DEVICE_TABLE(i2c, wm8741_i2c_id);
524 static struct i2c_driver wm8741_i2c_driver = {
527 .owner = THIS_MODULE,
528 .of_match_table = wm8741_of_match,
530 .probe = wm8741_i2c_probe,
531 .remove = wm8741_i2c_remove,
532 .id_table = wm8741_i2c_id,
536 #if defined(CONFIG_SPI_MASTER)
537 static int __devinit wm8741_spi_probe(struct spi_device *spi)
539 struct wm8741_priv *wm8741;
542 wm8741 = devm_kzalloc(&spi->dev, sizeof(struct wm8741_priv),
547 wm8741->control_type = SND_SOC_SPI;
548 spi_set_drvdata(spi, wm8741);
550 ret = snd_soc_register_codec(&spi->dev,
551 &soc_codec_dev_wm8741, &wm8741_dai, 1);
555 static int __devexit wm8741_spi_remove(struct spi_device *spi)
557 snd_soc_unregister_codec(&spi->dev);
561 static struct spi_driver wm8741_spi_driver = {
564 .owner = THIS_MODULE,
565 .of_match_table = wm8741_of_match,
567 .probe = wm8741_spi_probe,
568 .remove = __devexit_p(wm8741_spi_remove),
570 #endif /* CONFIG_SPI_MASTER */
572 static int __init wm8741_modinit(void)
576 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
577 ret = i2c_add_driver(&wm8741_i2c_driver);
579 pr_err("Failed to register WM8741 I2C driver: %d\n", ret);
581 #if defined(CONFIG_SPI_MASTER)
582 ret = spi_register_driver(&wm8741_spi_driver);
584 printk(KERN_ERR "Failed to register wm8741 SPI driver: %d\n",
591 module_init(wm8741_modinit);
593 static void __exit wm8741_exit(void)
595 #if defined(CONFIG_SPI_MASTER)
596 spi_unregister_driver(&wm8741_spi_driver);
598 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
599 i2c_del_driver(&wm8741_i2c_driver);
602 module_exit(wm8741_exit);
604 MODULE_DESCRIPTION("ASoC WM8741 driver");
605 MODULE_AUTHOR("Ian Lartey <ian@opensource.wolfsonmicro.com>");
606 MODULE_LICENSE("GPL");