2 * wm8741.c -- WM8741 ALSA SoC Audio driver
4 * Copyright 2010-1 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/regmap.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/slab.h>
24 #include <linux/of_device.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 #define WM8741_NUM_SUPPLIES 2
35 static const char *wm8741_supply_names[WM8741_NUM_SUPPLIES] = {
40 #define WM8741_NUM_RATES 6
42 /* codec private data */
44 struct regmap *regmap;
45 struct regulator_bulk_data supplies[WM8741_NUM_SUPPLIES];
47 const struct snd_pcm_hw_constraint_list *sysclk_constraints;
50 static const struct reg_default wm8741_reg_defaults[] = {
51 { 0, 0x0000 }, /* R0 - DACLLSB Attenuation */
52 { 1, 0x0000 }, /* R1 - DACLMSB Attenuation */
53 { 2, 0x0000 }, /* R2 - DACRLSB Attenuation */
54 { 3, 0x0000 }, /* R3 - DACRMSB Attenuation */
55 { 4, 0x0000 }, /* R4 - Volume Control */
56 { 5, 0x000A }, /* R5 - Format Control */
57 { 6, 0x0000 }, /* R6 - Filter Control */
58 { 7, 0x0000 }, /* R7 - Mode Control 1 */
59 { 8, 0x0002 }, /* R8 - Mode Control 2 */
60 { 32, 0x0002 }, /* R32 - ADDITONAL_CONTROL_1 */
63 static bool wm8741_readable(struct device *dev, unsigned int reg)
66 case WM8741_DACLLSB_ATTENUATION:
67 case WM8741_DACLMSB_ATTENUATION:
68 case WM8741_DACRLSB_ATTENUATION:
69 case WM8741_DACRMSB_ATTENUATION:
70 case WM8741_VOLUME_CONTROL:
71 case WM8741_FORMAT_CONTROL:
72 case WM8741_FILTER_CONTROL:
73 case WM8741_MODE_CONTROL_1:
74 case WM8741_MODE_CONTROL_2:
75 case WM8741_ADDITIONAL_CONTROL_1:
82 static int wm8741_reset(struct snd_soc_codec *codec)
84 return snd_soc_write(codec, WM8741_RESET, 0);
87 static const DECLARE_TLV_DB_SCALE(dac_tlv_fine, -12700, 13, 0);
88 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12700, 400, 0);
90 static const struct snd_kcontrol_new wm8741_snd_controls[] = {
91 SOC_DOUBLE_R_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION,
92 WM8741_DACRLSB_ATTENUATION, 1, 255, 1, dac_tlv_fine),
93 SOC_DOUBLE_R_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION,
94 WM8741_DACRMSB_ATTENUATION, 0, 511, 1, dac_tlv),
97 static const struct snd_soc_dapm_widget wm8741_dapm_widgets[] = {
98 SND_SOC_DAPM_DAC("DACL", "Playback", SND_SOC_NOPM, 0, 0),
99 SND_SOC_DAPM_DAC("DACR", "Playback", SND_SOC_NOPM, 0, 0),
100 SND_SOC_DAPM_OUTPUT("VOUTLP"),
101 SND_SOC_DAPM_OUTPUT("VOUTLN"),
102 SND_SOC_DAPM_OUTPUT("VOUTRP"),
103 SND_SOC_DAPM_OUTPUT("VOUTRN"),
106 static const struct snd_soc_dapm_route wm8741_dapm_routes[] = {
107 { "VOUTLP", NULL, "DACL" },
108 { "VOUTLN", NULL, "DACL" },
109 { "VOUTRP", NULL, "DACR" },
110 { "VOUTRN", NULL, "DACR" },
116 } lrclk_ratios[WM8741_NUM_RATES] = {
125 static const unsigned int rates_11289[] = {
129 static const struct snd_pcm_hw_constraint_list constraints_11289 = {
130 .count = ARRAY_SIZE(rates_11289),
134 static const unsigned int rates_12288[] = {
138 static const struct snd_pcm_hw_constraint_list constraints_12288 = {
139 .count = ARRAY_SIZE(rates_12288),
143 static const unsigned int rates_16384[] = {
147 static const struct snd_pcm_hw_constraint_list constraints_16384 = {
148 .count = ARRAY_SIZE(rates_16384),
152 static const unsigned int rates_16934[] = {
156 static const struct snd_pcm_hw_constraint_list constraints_16934 = {
157 .count = ARRAY_SIZE(rates_16934),
161 static const unsigned int rates_18432[] = {
165 static const struct snd_pcm_hw_constraint_list constraints_18432 = {
166 .count = ARRAY_SIZE(rates_18432),
170 static const unsigned int rates_22579[] = {
171 44100, 88235, 1764000
174 static const struct snd_pcm_hw_constraint_list constraints_22579 = {
175 .count = ARRAY_SIZE(rates_22579),
179 static const unsigned int rates_24576[] = {
180 32000, 48000, 96000, 192000
183 static const struct snd_pcm_hw_constraint_list constraints_24576 = {
184 .count = ARRAY_SIZE(rates_24576),
188 static const unsigned int rates_36864[] = {
192 static const struct snd_pcm_hw_constraint_list constraints_36864 = {
193 .count = ARRAY_SIZE(rates_36864),
198 static int wm8741_startup(struct snd_pcm_substream *substream,
199 struct snd_soc_dai *dai)
201 struct snd_soc_codec *codec = dai->codec;
202 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
204 /* The set of sample rates that can be supported depends on the
205 * MCLK supplied to the CODEC - enforce this.
207 if (!wm8741->sysclk) {
209 "No MCLK configured, call set_sysclk() on init\n");
213 snd_pcm_hw_constraint_list(substream->runtime, 0,
214 SNDRV_PCM_HW_PARAM_RATE,
215 wm8741->sysclk_constraints);
220 static int wm8741_hw_params(struct snd_pcm_substream *substream,
221 struct snd_pcm_hw_params *params,
222 struct snd_soc_dai *dai)
224 struct snd_soc_codec *codec = dai->codec;
225 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
226 u16 iface = snd_soc_read(codec, WM8741_FORMAT_CONTROL) & 0x1FC;
229 /* Find a supported LRCLK ratio */
230 for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
231 if (wm8741->sysclk / params_rate(params) ==
232 lrclk_ratios[i].ratio)
236 /* Should never happen, should be handled by constraints */
237 if (i == ARRAY_SIZE(lrclk_ratios)) {
238 dev_err(codec->dev, "MCLK/fs ratio %d unsupported\n",
239 wm8741->sysclk / params_rate(params));
244 switch (params_width(params)) {
257 dev_dbg(codec->dev, "wm8741_hw_params: Unsupported bit size param = %d",
258 params_width(params));
262 dev_dbg(codec->dev, "wm8741_hw_params: bit size param = %d",
263 params_width(params));
265 snd_soc_write(codec, WM8741_FORMAT_CONTROL, iface);
269 static int wm8741_set_dai_sysclk(struct snd_soc_dai *codec_dai,
270 int clk_id, unsigned int freq, int dir)
272 struct snd_soc_codec *codec = codec_dai->codec;
273 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
275 dev_dbg(codec->dev, "wm8741_set_dai_sysclk info: freq=%dHz\n", freq);
279 wm8741->sysclk_constraints = &constraints_11289;
280 wm8741->sysclk = freq;
284 wm8741->sysclk_constraints = &constraints_12288;
285 wm8741->sysclk = freq;
289 wm8741->sysclk_constraints = &constraints_16384;
290 wm8741->sysclk = freq;
294 wm8741->sysclk_constraints = &constraints_16934;
295 wm8741->sysclk = freq;
299 wm8741->sysclk_constraints = &constraints_18432;
300 wm8741->sysclk = freq;
305 wm8741->sysclk_constraints = &constraints_22579;
306 wm8741->sysclk = freq;
310 wm8741->sysclk_constraints = &constraints_24576;
311 wm8741->sysclk = freq;
315 wm8741->sysclk_constraints = &constraints_36864;
316 wm8741->sysclk = freq;
322 static int wm8741_set_dai_fmt(struct snd_soc_dai *codec_dai,
325 struct snd_soc_codec *codec = codec_dai->codec;
326 u16 iface = snd_soc_read(codec, WM8741_FORMAT_CONTROL) & 0x1C3;
328 /* check master/slave audio interface */
329 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
330 case SND_SOC_DAIFMT_CBS_CFS:
336 /* interface format */
337 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
338 case SND_SOC_DAIFMT_I2S:
341 case SND_SOC_DAIFMT_RIGHT_J:
343 case SND_SOC_DAIFMT_LEFT_J:
346 case SND_SOC_DAIFMT_DSP_A:
349 case SND_SOC_DAIFMT_DSP_B:
356 /* clock inversion */
357 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
358 case SND_SOC_DAIFMT_NB_NF:
360 case SND_SOC_DAIFMT_IB_IF:
363 case SND_SOC_DAIFMT_IB_NF:
366 case SND_SOC_DAIFMT_NB_IF:
374 dev_dbg(codec->dev, "wm8741_set_dai_fmt: Format=%x, Clock Inv=%x\n",
375 fmt & SND_SOC_DAIFMT_FORMAT_MASK,
376 ((fmt & SND_SOC_DAIFMT_INV_MASK)));
378 snd_soc_write(codec, WM8741_FORMAT_CONTROL, iface);
382 #define WM8741_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
383 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | \
384 SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 | \
385 SNDRV_PCM_RATE_192000)
387 #define WM8741_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
388 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
390 static const struct snd_soc_dai_ops wm8741_dai_ops = {
391 .startup = wm8741_startup,
392 .hw_params = wm8741_hw_params,
393 .set_sysclk = wm8741_set_dai_sysclk,
394 .set_fmt = wm8741_set_dai_fmt,
397 static struct snd_soc_dai_driver wm8741_dai = {
400 .stream_name = "Playback",
401 .channels_min = 2, /* Mono modes not yet supported */
403 .rates = WM8741_RATES,
404 .formats = WM8741_FORMATS,
406 .ops = &wm8741_dai_ops,
410 static int wm8741_resume(struct snd_soc_codec *codec)
412 snd_soc_cache_sync(codec);
416 #define wm8741_suspend NULL
417 #define wm8741_resume NULL
420 static int wm8741_probe(struct snd_soc_codec *codec)
422 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
425 ret = regulator_bulk_enable(ARRAY_SIZE(wm8741->supplies),
428 dev_err(codec->dev, "Failed to enable supplies: %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);
457 static int wm8741_remove(struct snd_soc_codec *codec)
459 struct wm8741_priv *wm8741 = snd_soc_codec_get_drvdata(codec);
461 regulator_bulk_disable(ARRAY_SIZE(wm8741->supplies), wm8741->supplies);
466 static struct snd_soc_codec_driver soc_codec_dev_wm8741 = {
467 .probe = wm8741_probe,
468 .remove = wm8741_remove,
469 .resume = wm8741_resume,
471 .controls = wm8741_snd_controls,
472 .num_controls = ARRAY_SIZE(wm8741_snd_controls),
473 .dapm_widgets = wm8741_dapm_widgets,
474 .num_dapm_widgets = ARRAY_SIZE(wm8741_dapm_widgets),
475 .dapm_routes = wm8741_dapm_routes,
476 .num_dapm_routes = ARRAY_SIZE(wm8741_dapm_routes),
479 static const struct of_device_id wm8741_of_match[] = {
480 { .compatible = "wlf,wm8741", },
483 MODULE_DEVICE_TABLE(of, wm8741_of_match);
485 static const struct regmap_config wm8741_regmap = {
488 .max_register = WM8741_MAX_REGISTER,
490 .reg_defaults = wm8741_reg_defaults,
491 .num_reg_defaults = ARRAY_SIZE(wm8741_reg_defaults),
492 .cache_type = REGCACHE_RBTREE,
494 .readable_reg = wm8741_readable,
497 #if IS_ENABLED(CONFIG_I2C)
498 static int wm8741_i2c_probe(struct i2c_client *i2c,
499 const struct i2c_device_id *id)
501 struct wm8741_priv *wm8741;
504 wm8741 = devm_kzalloc(&i2c->dev, sizeof(struct wm8741_priv),
509 for (i = 0; i < ARRAY_SIZE(wm8741->supplies); i++)
510 wm8741->supplies[i].supply = wm8741_supply_names[i];
512 ret = devm_regulator_bulk_get(&i2c->dev, ARRAY_SIZE(wm8741->supplies),
515 dev_err(&i2c->dev, "Failed to request supplies: %d\n", ret);
519 wm8741->regmap = devm_regmap_init_i2c(i2c, &wm8741_regmap);
520 if (IS_ERR(wm8741->regmap)) {
521 ret = PTR_ERR(wm8741->regmap);
522 dev_err(&i2c->dev, "Failed to init regmap: %d\n", ret);
526 i2c_set_clientdata(i2c, wm8741);
528 ret = snd_soc_register_codec(&i2c->dev,
529 &soc_codec_dev_wm8741, &wm8741_dai, 1);
534 static int wm8741_i2c_remove(struct i2c_client *client)
536 snd_soc_unregister_codec(&client->dev);
540 static const struct i2c_device_id wm8741_i2c_id[] = {
544 MODULE_DEVICE_TABLE(i2c, wm8741_i2c_id);
546 static struct i2c_driver wm8741_i2c_driver = {
549 .owner = THIS_MODULE,
550 .of_match_table = wm8741_of_match,
552 .probe = wm8741_i2c_probe,
553 .remove = wm8741_i2c_remove,
554 .id_table = wm8741_i2c_id,
558 #if defined(CONFIG_SPI_MASTER)
559 static int wm8741_spi_probe(struct spi_device *spi)
561 struct wm8741_priv *wm8741;
564 wm8741 = devm_kzalloc(&spi->dev, sizeof(struct wm8741_priv),
569 for (i = 0; i < ARRAY_SIZE(wm8741->supplies); i++)
570 wm8741->supplies[i].supply = wm8741_supply_names[i];
572 ret = devm_regulator_bulk_get(&spi->dev, ARRAY_SIZE(wm8741->supplies),
575 dev_err(&spi->dev, "Failed to request supplies: %d\n", ret);
579 wm8741->regmap = devm_regmap_init_spi(spi, &wm8741_regmap);
580 if (IS_ERR(wm8741->regmap)) {
581 ret = PTR_ERR(wm8741->regmap);
582 dev_err(&spi->dev, "Failed to init regmap: %d\n", ret);
586 spi_set_drvdata(spi, wm8741);
588 ret = snd_soc_register_codec(&spi->dev,
589 &soc_codec_dev_wm8741, &wm8741_dai, 1);
593 static int wm8741_spi_remove(struct spi_device *spi)
595 snd_soc_unregister_codec(&spi->dev);
599 static struct spi_driver wm8741_spi_driver = {
602 .owner = THIS_MODULE,
603 .of_match_table = wm8741_of_match,
605 .probe = wm8741_spi_probe,
606 .remove = wm8741_spi_remove,
608 #endif /* CONFIG_SPI_MASTER */
610 static int __init wm8741_modinit(void)
614 #if IS_ENABLED(CONFIG_I2C)
615 ret = i2c_add_driver(&wm8741_i2c_driver);
617 pr_err("Failed to register WM8741 I2C driver: %d\n", ret);
619 #if defined(CONFIG_SPI_MASTER)
620 ret = spi_register_driver(&wm8741_spi_driver);
622 printk(KERN_ERR "Failed to register wm8741 SPI driver: %d\n",
629 module_init(wm8741_modinit);
631 static void __exit wm8741_exit(void)
633 #if defined(CONFIG_SPI_MASTER)
634 spi_unregister_driver(&wm8741_spi_driver);
636 #if IS_ENABLED(CONFIG_I2C)
637 i2c_del_driver(&wm8741_i2c_driver);
640 module_exit(wm8741_exit);
642 MODULE_DESCRIPTION("ASoC WM8741 driver");
643 MODULE_AUTHOR("Ian Lartey <ian@opensource.wolfsonmicro.com>");
644 MODULE_LICENSE("GPL");