2 * wm8804.c -- WM8804 S/PDIF transceiver driver
4 * Copyright 2010-11 Wolfson Microelectronics plc
6 * Author: Dimitris Papastamos <dp@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/of_device.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 <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 WM8804_NUM_SUPPLIES 2
34 static const char *wm8804_supply_names[WM8804_NUM_SUPPLIES] = {
39 static const struct reg_default wm8804_reg_defaults[] = {
40 { 3, 0x21 }, /* R3 - PLL1 */
41 { 4, 0xFD }, /* R4 - PLL2 */
42 { 5, 0x36 }, /* R5 - PLL3 */
43 { 6, 0x07 }, /* R6 - PLL4 */
44 { 7, 0x16 }, /* R7 - PLL5 */
45 { 8, 0x18 }, /* R8 - PLL6 */
46 { 9, 0xFF }, /* R9 - SPDMODE */
47 { 10, 0x00 }, /* R10 - INTMASK */
48 { 18, 0x00 }, /* R18 - SPDTX1 */
49 { 19, 0x00 }, /* R19 - SPDTX2 */
50 { 20, 0x00 }, /* R20 - SPDTX3 */
51 { 21, 0x71 }, /* R21 - SPDTX4 */
52 { 22, 0x0B }, /* R22 - SPDTX5 */
53 { 23, 0x70 }, /* R23 - GPO0 */
54 { 24, 0x57 }, /* R24 - GPO1 */
55 { 26, 0x42 }, /* R26 - GPO2 */
56 { 27, 0x06 }, /* R27 - AIFTX */
57 { 28, 0x06 }, /* R28 - AIFRX */
58 { 29, 0x80 }, /* R29 - SPDRX1 */
59 { 30, 0x07 }, /* R30 - PWRDN */
63 struct regmap *regmap;
64 struct regulator_bulk_data supplies[WM8804_NUM_SUPPLIES];
65 struct notifier_block disable_nb[WM8804_NUM_SUPPLIES];
68 static int txsrc_get(struct snd_kcontrol *kcontrol,
69 struct snd_ctl_elem_value *ucontrol);
71 static int txsrc_put(struct snd_kcontrol *kcontrol,
72 struct snd_ctl_elem_value *ucontrol);
75 * We can't use the same notifier block for more than one supply and
76 * there's no way I can see to get from a callback to the caller
77 * except container_of().
79 #define WM8804_REGULATOR_EVENT(n) \
80 static int wm8804_regulator_event_##n(struct notifier_block *nb, \
81 unsigned long event, void *data) \
83 struct wm8804_priv *wm8804 = container_of(nb, struct wm8804_priv, \
85 if (event & REGULATOR_EVENT_DISABLE) { \
86 regcache_mark_dirty(wm8804->regmap); \
91 WM8804_REGULATOR_EVENT(0)
92 WM8804_REGULATOR_EVENT(1)
94 static const char *txsrc_text[] = { "S/PDIF RX", "AIF" };
95 static SOC_ENUM_SINGLE_EXT_DECL(txsrc, txsrc_text);
97 static const struct snd_kcontrol_new wm8804_snd_controls[] = {
98 SOC_ENUM_EXT("Input Source", txsrc, txsrc_get, txsrc_put),
99 SOC_SINGLE("TX Playback Switch", WM8804_PWRDN, 2, 1, 1),
100 SOC_SINGLE("AIF Playback Switch", WM8804_PWRDN, 4, 1, 1)
103 static int txsrc_get(struct snd_kcontrol *kcontrol,
104 struct snd_ctl_elem_value *ucontrol)
106 struct snd_soc_codec *codec;
109 codec = snd_kcontrol_chip(kcontrol);
110 src = snd_soc_read(codec, WM8804_SPDTX4);
112 ucontrol->value.integer.value[0] = 1;
114 ucontrol->value.integer.value[0] = 0;
119 static int txsrc_put(struct snd_kcontrol *kcontrol,
120 struct snd_ctl_elem_value *ucontrol)
122 struct snd_soc_codec *codec;
123 unsigned int src, txpwr;
125 codec = snd_kcontrol_chip(kcontrol);
127 if (ucontrol->value.integer.value[0] != 0
128 && ucontrol->value.integer.value[0] != 1)
131 src = snd_soc_read(codec, WM8804_SPDTX4);
132 switch ((src & 0x40) >> 6) {
134 if (!ucontrol->value.integer.value[0])
138 if (ucontrol->value.integer.value[1])
143 /* save the current power state of the transmitter */
144 txpwr = snd_soc_read(codec, WM8804_PWRDN) & 0x4;
145 /* power down the transmitter */
146 snd_soc_update_bits(codec, WM8804_PWRDN, 0x4, 0x4);
147 /* set the tx source */
148 snd_soc_update_bits(codec, WM8804_SPDTX4, 0x40,
149 ucontrol->value.integer.value[0] << 6);
151 if (ucontrol->value.integer.value[0]) {
152 /* power down the receiver */
153 snd_soc_update_bits(codec, WM8804_PWRDN, 0x2, 0x2);
154 /* power up the AIF */
155 snd_soc_update_bits(codec, WM8804_PWRDN, 0x10, 0);
157 /* don't power down the AIF -- may be used as an output */
158 /* power up the receiver */
159 snd_soc_update_bits(codec, WM8804_PWRDN, 0x2, 0);
162 /* restore the transmitter's configuration */
163 snd_soc_update_bits(codec, WM8804_PWRDN, 0x4, txpwr);
168 static bool wm8804_volatile(struct device *dev, unsigned int reg)
171 case WM8804_RST_DEVID1:
187 static int wm8804_reset(struct snd_soc_codec *codec)
189 return snd_soc_write(codec, WM8804_RST_DEVID1, 0x0);
192 static int wm8804_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
194 struct snd_soc_codec *codec;
195 u16 format, master, bcp, lrp;
199 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
200 case SND_SOC_DAIFMT_I2S:
203 case SND_SOC_DAIFMT_RIGHT_J:
206 case SND_SOC_DAIFMT_LEFT_J:
209 case SND_SOC_DAIFMT_DSP_A:
210 case SND_SOC_DAIFMT_DSP_B:
214 dev_err(dai->dev, "Unknown dai format\n");
218 /* set data format */
219 snd_soc_update_bits(codec, WM8804_AIFTX, 0x3, format);
220 snd_soc_update_bits(codec, WM8804_AIFRX, 0x3, format);
222 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
223 case SND_SOC_DAIFMT_CBM_CFM:
226 case SND_SOC_DAIFMT_CBS_CFS:
230 dev_err(dai->dev, "Unknown master/slave configuration\n");
234 /* set master/slave mode */
235 snd_soc_update_bits(codec, WM8804_AIFRX, 0x40, master << 6);
238 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
239 case SND_SOC_DAIFMT_NB_NF:
241 case SND_SOC_DAIFMT_IB_IF:
244 case SND_SOC_DAIFMT_IB_NF:
247 case SND_SOC_DAIFMT_NB_IF:
251 dev_err(dai->dev, "Unknown polarity configuration\n");
255 /* set frame inversion */
256 snd_soc_update_bits(codec, WM8804_AIFTX, 0x10 | 0x20,
257 (bcp << 4) | (lrp << 5));
258 snd_soc_update_bits(codec, WM8804_AIFRX, 0x10 | 0x20,
259 (bcp << 4) | (lrp << 5));
263 static int wm8804_hw_params(struct snd_pcm_substream *substream,
264 struct snd_pcm_hw_params *params,
265 struct snd_soc_dai *dai)
267 struct snd_soc_codec *codec;
272 switch (params_format(params)) {
273 case SNDRV_PCM_FORMAT_S16_LE:
276 case SNDRV_PCM_FORMAT_S20_3LE:
279 case SNDRV_PCM_FORMAT_S24_LE:
283 dev_err(dai->dev, "Unsupported word length: %u\n",
284 params_format(params));
288 /* set word length */
289 snd_soc_update_bits(codec, WM8804_AIFTX, 0xc, blen << 2);
290 snd_soc_update_bits(codec, WM8804_AIFRX, 0xc, blen << 2);
303 /* PLL rate to output rate divisions */
306 unsigned int freqmode;
307 unsigned int mclkdiv;
319 #define FIXED_PLL_SIZE ((1ULL << 22) * 10)
320 static int pll_factors(struct pll_div *pll_div, unsigned int target,
324 unsigned long int K, Ndiv, Nmod, tmp;
328 * Scale the output frequency up; the PLL should run in the
329 * region of 90-100MHz.
331 for (i = 0; i < ARRAY_SIZE(post_table); i++) {
332 tmp = target * post_table[i].div;
333 if (tmp >= 90000000 && tmp <= 100000000) {
334 pll_div->freqmode = post_table[i].freqmode;
335 pll_div->mclkdiv = post_table[i].mclkdiv;
336 target *= post_table[i].div;
341 if (i == ARRAY_SIZE(post_table)) {
342 pr_err("%s: Unable to scale output frequency: %uHz\n",
347 pll_div->prescale = 0;
348 Ndiv = target / source;
351 pll_div->prescale = 1;
352 Ndiv = target / source;
355 if (Ndiv < 5 || Ndiv > 13) {
356 pr_err("%s: WM8804 N value is not within the recommended range: %lu\n",
362 Nmod = target % source;
363 Kpart = FIXED_PLL_SIZE * (u64)Nmod;
365 do_div(Kpart, source);
367 K = Kpart & 0xffffffff;
376 static int wm8804_set_pll(struct snd_soc_dai *dai, int pll_id,
377 int source, unsigned int freq_in,
378 unsigned int freq_out)
380 struct snd_soc_codec *codec;
383 if (!freq_in || !freq_out) {
384 /* disable the PLL */
385 snd_soc_update_bits(codec, WM8804_PWRDN, 0x1, 0x1);
389 struct pll_div pll_div;
391 ret = pll_factors(&pll_div, freq_out, freq_in);
395 /* power down the PLL before reprogramming it */
396 snd_soc_update_bits(codec, WM8804_PWRDN, 0x1, 0x1);
398 /* set PLLN and PRESCALE */
399 snd_soc_update_bits(codec, WM8804_PLL4, 0xf | 0x10,
400 pll_div.n | (pll_div.prescale << 4));
401 /* set mclkdiv and freqmode */
402 snd_soc_update_bits(codec, WM8804_PLL5, 0x3 | 0x8,
403 pll_div.freqmode | (pll_div.mclkdiv << 3));
405 snd_soc_write(codec, WM8804_PLL1, pll_div.k & 0xff);
406 snd_soc_write(codec, WM8804_PLL2, (pll_div.k >> 8) & 0xff);
407 snd_soc_write(codec, WM8804_PLL3, pll_div.k >> 16);
409 /* power up the PLL */
410 snd_soc_update_bits(codec, WM8804_PWRDN, 0x1, 0);
416 static int wm8804_set_sysclk(struct snd_soc_dai *dai,
417 int clk_id, unsigned int freq, int dir)
419 struct snd_soc_codec *codec;
424 case WM8804_TX_CLKSRC_MCLK:
425 if ((freq >= 10000000 && freq <= 14400000)
426 || (freq >= 16280000 && freq <= 27000000))
427 snd_soc_update_bits(codec, WM8804_PLL6, 0x80, 0x80);
429 dev_err(dai->dev, "OSCCLOCK is not within the "
430 "recommended range: %uHz\n", freq);
434 case WM8804_TX_CLKSRC_PLL:
435 snd_soc_update_bits(codec, WM8804_PLL6, 0x80, 0);
437 case WM8804_CLKOUT_SRC_CLK1:
438 snd_soc_update_bits(codec, WM8804_PLL6, 0x8, 0);
440 case WM8804_CLKOUT_SRC_OSCCLK:
441 snd_soc_update_bits(codec, WM8804_PLL6, 0x8, 0x8);
444 dev_err(dai->dev, "Unknown clock source: %d\n", clk_id);
451 static int wm8804_set_clkdiv(struct snd_soc_dai *dai,
454 struct snd_soc_codec *codec;
458 case WM8804_CLKOUT_DIV:
459 snd_soc_update_bits(codec, WM8804_PLL5, 0x30,
463 dev_err(dai->dev, "Unknown clock divider: %d\n", div_id);
469 static int wm8804_set_bias_level(struct snd_soc_codec *codec,
470 enum snd_soc_bias_level level)
473 struct wm8804_priv *wm8804;
475 wm8804 = snd_soc_codec_get_drvdata(codec);
477 case SND_SOC_BIAS_ON:
479 case SND_SOC_BIAS_PREPARE:
480 /* power up the OSC and the PLL */
481 snd_soc_update_bits(codec, WM8804_PWRDN, 0x9, 0);
483 case SND_SOC_BIAS_STANDBY:
484 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
485 ret = regulator_bulk_enable(ARRAY_SIZE(wm8804->supplies),
489 "Failed to enable supplies: %d\n",
493 regcache_sync(wm8804->regmap);
495 /* power down the OSC and the PLL */
496 snd_soc_update_bits(codec, WM8804_PWRDN, 0x9, 0x9);
498 case SND_SOC_BIAS_OFF:
499 /* power down the OSC and the PLL */
500 snd_soc_update_bits(codec, WM8804_PWRDN, 0x9, 0x9);
501 regulator_bulk_disable(ARRAY_SIZE(wm8804->supplies),
506 codec->dapm.bias_level = level;
511 static int wm8804_suspend(struct snd_soc_codec *codec)
513 wm8804_set_bias_level(codec, SND_SOC_BIAS_OFF);
517 static int wm8804_resume(struct snd_soc_codec *codec)
519 wm8804_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
523 #define wm8804_suspend NULL
524 #define wm8804_resume NULL
527 static int wm8804_remove(struct snd_soc_codec *codec)
529 struct wm8804_priv *wm8804;
532 wm8804 = snd_soc_codec_get_drvdata(codec);
533 wm8804_set_bias_level(codec, SND_SOC_BIAS_OFF);
535 for (i = 0; i < ARRAY_SIZE(wm8804->supplies); ++i)
536 regulator_unregister_notifier(wm8804->supplies[i].consumer,
537 &wm8804->disable_nb[i]);
538 regulator_bulk_free(ARRAY_SIZE(wm8804->supplies), wm8804->supplies);
542 static int wm8804_probe(struct snd_soc_codec *codec)
544 struct wm8804_priv *wm8804;
545 int i, id1, id2, ret;
547 wm8804 = snd_soc_codec_get_drvdata(codec);
549 for (i = 0; i < ARRAY_SIZE(wm8804->supplies); i++)
550 wm8804->supplies[i].supply = wm8804_supply_names[i];
552 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8804->supplies),
555 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
559 wm8804->disable_nb[0].notifier_call = wm8804_regulator_event_0;
560 wm8804->disable_nb[1].notifier_call = wm8804_regulator_event_1;
562 /* This should really be moved into the regulator core */
563 for (i = 0; i < ARRAY_SIZE(wm8804->supplies); i++) {
564 ret = regulator_register_notifier(wm8804->supplies[i].consumer,
565 &wm8804->disable_nb[i]);
568 "Failed to register regulator notifier: %d\n",
573 ret = regulator_bulk_enable(ARRAY_SIZE(wm8804->supplies),
576 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
580 id1 = snd_soc_read(codec, WM8804_RST_DEVID1);
582 dev_err(codec->dev, "Failed to read device ID: %d\n", id1);
587 id2 = snd_soc_read(codec, WM8804_DEVID2);
589 dev_err(codec->dev, "Failed to read device ID: %d\n", id2);
594 id2 = (id2 << 8) | id1;
597 dev_err(codec->dev, "Invalid device ID: %#x\n", id2);
602 ret = snd_soc_read(codec, WM8804_DEVREV);
604 dev_err(codec->dev, "Failed to read device revision: %d\n",
608 dev_info(codec->dev, "revision %c\n", ret + 'A');
610 ret = wm8804_reset(codec);
612 dev_err(codec->dev, "Failed to issue reset: %d\n", ret);
616 wm8804_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
621 regulator_bulk_disable(ARRAY_SIZE(wm8804->supplies), wm8804->supplies);
623 regulator_bulk_free(ARRAY_SIZE(wm8804->supplies), wm8804->supplies);
627 static const struct snd_soc_dai_ops wm8804_dai_ops = {
628 .hw_params = wm8804_hw_params,
629 .set_fmt = wm8804_set_fmt,
630 .set_sysclk = wm8804_set_sysclk,
631 .set_clkdiv = wm8804_set_clkdiv,
632 .set_pll = wm8804_set_pll
635 #define WM8804_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
636 SNDRV_PCM_FMTBIT_S24_LE)
638 #define WM8804_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
639 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_64000 | \
640 SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000 | \
641 SNDRV_PCM_RATE_176400 | SNDRV_PCM_RATE_192000)
643 static struct snd_soc_dai_driver wm8804_dai = {
644 .name = "wm8804-spdif",
646 .stream_name = "Playback",
649 .rates = WM8804_RATES,
650 .formats = WM8804_FORMATS,
653 .stream_name = "Capture",
656 .rates = WM8804_RATES,
657 .formats = WM8804_FORMATS,
659 .ops = &wm8804_dai_ops,
663 static struct snd_soc_codec_driver soc_codec_dev_wm8804 = {
664 .probe = wm8804_probe,
665 .remove = wm8804_remove,
666 .suspend = wm8804_suspend,
667 .resume = wm8804_resume,
668 .set_bias_level = wm8804_set_bias_level,
669 .idle_bias_off = true,
671 .controls = wm8804_snd_controls,
672 .num_controls = ARRAY_SIZE(wm8804_snd_controls),
675 static const struct of_device_id wm8804_of_match[] = {
676 { .compatible = "wlf,wm8804", },
679 MODULE_DEVICE_TABLE(of, wm8804_of_match);
681 static struct regmap_config wm8804_regmap_config = {
685 .max_register = WM8804_MAX_REGISTER,
686 .volatile_reg = wm8804_volatile,
688 .cache_type = REGCACHE_RBTREE,
689 .reg_defaults = wm8804_reg_defaults,
690 .num_reg_defaults = ARRAY_SIZE(wm8804_reg_defaults),
693 #if defined(CONFIG_SPI_MASTER)
694 static int wm8804_spi_probe(struct spi_device *spi)
696 struct wm8804_priv *wm8804;
699 wm8804 = devm_kzalloc(&spi->dev, sizeof *wm8804, GFP_KERNEL);
703 wm8804->regmap = devm_regmap_init_spi(spi, &wm8804_regmap_config);
704 if (IS_ERR(wm8804->regmap)) {
705 ret = PTR_ERR(wm8804->regmap);
709 spi_set_drvdata(spi, wm8804);
711 ret = snd_soc_register_codec(&spi->dev,
712 &soc_codec_dev_wm8804, &wm8804_dai, 1);
717 static int wm8804_spi_remove(struct spi_device *spi)
719 snd_soc_unregister_codec(&spi->dev);
723 static struct spi_driver wm8804_spi_driver = {
726 .owner = THIS_MODULE,
727 .of_match_table = wm8804_of_match,
729 .probe = wm8804_spi_probe,
730 .remove = wm8804_spi_remove
734 #if IS_ENABLED(CONFIG_I2C)
735 static int wm8804_i2c_probe(struct i2c_client *i2c,
736 const struct i2c_device_id *id)
738 struct wm8804_priv *wm8804;
741 wm8804 = devm_kzalloc(&i2c->dev, sizeof *wm8804, GFP_KERNEL);
745 wm8804->regmap = devm_regmap_init_i2c(i2c, &wm8804_regmap_config);
746 if (IS_ERR(wm8804->regmap)) {
747 ret = PTR_ERR(wm8804->regmap);
751 i2c_set_clientdata(i2c, wm8804);
753 ret = snd_soc_register_codec(&i2c->dev,
754 &soc_codec_dev_wm8804, &wm8804_dai, 1);
758 static int wm8804_i2c_remove(struct i2c_client *i2c)
760 snd_soc_unregister_codec(&i2c->dev);
764 static const struct i2c_device_id wm8804_i2c_id[] = {
768 MODULE_DEVICE_TABLE(i2c, wm8804_i2c_id);
770 static struct i2c_driver wm8804_i2c_driver = {
773 .owner = THIS_MODULE,
774 .of_match_table = wm8804_of_match,
776 .probe = wm8804_i2c_probe,
777 .remove = wm8804_i2c_remove,
778 .id_table = wm8804_i2c_id
782 static int __init wm8804_modinit(void)
786 #if IS_ENABLED(CONFIG_I2C)
787 ret = i2c_add_driver(&wm8804_i2c_driver);
789 printk(KERN_ERR "Failed to register wm8804 I2C driver: %d\n",
793 #if defined(CONFIG_SPI_MASTER)
794 ret = spi_register_driver(&wm8804_spi_driver);
796 printk(KERN_ERR "Failed to register wm8804 SPI driver: %d\n",
802 module_init(wm8804_modinit);
804 static void __exit wm8804_exit(void)
806 #if IS_ENABLED(CONFIG_I2C)
807 i2c_del_driver(&wm8804_i2c_driver);
809 #if defined(CONFIG_SPI_MASTER)
810 spi_unregister_driver(&wm8804_spi_driver);
813 module_exit(wm8804_exit);
815 MODULE_DESCRIPTION("ASoC WM8804 driver");
816 MODULE_AUTHOR("Dimitris Papastamos <dp@opensource.wolfsonmicro.com>");
817 MODULE_LICENSE("GPL");