1 // SPDX-License-Identifier: GPL-2.0-only
3 * wm8804.c -- WM8804 S/PDIF transceiver driver
5 * Copyright 2010-11 Wolfson Microelectronics plc
7 * Author: Dimitris Papastamos <dp@opensource.wolfsonmicro.com>
10 #include <linux/module.h>
11 #include <linux/moduleparam.h>
12 #include <linux/init.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/delay.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/of_device.h>
18 #include <linux/regulator/consumer.h>
19 #include <linux/slab.h>
20 #include <sound/core.h>
21 #include <sound/pcm.h>
22 #include <sound/pcm_params.h>
23 #include <sound/soc.h>
24 #include <sound/initval.h>
25 #include <sound/tlv.h>
26 #include <sound/soc-dapm.h>
30 #define WM8804_NUM_SUPPLIES 2
31 static const char *wm8804_supply_names
[WM8804_NUM_SUPPLIES
] = {
36 static const struct reg_default wm8804_reg_defaults
[] = {
37 { 3, 0x21 }, /* R3 - PLL1 */
38 { 4, 0xFD }, /* R4 - PLL2 */
39 { 5, 0x36 }, /* R5 - PLL3 */
40 { 6, 0x07 }, /* R6 - PLL4 */
41 { 7, 0x16 }, /* R7 - PLL5 */
42 { 8, 0x18 }, /* R8 - PLL6 */
43 { 9, 0xFF }, /* R9 - SPDMODE */
44 { 10, 0x00 }, /* R10 - INTMASK */
45 { 18, 0x00 }, /* R18 - SPDTX1 */
46 { 19, 0x00 }, /* R19 - SPDTX2 */
47 { 20, 0x00 }, /* R20 - SPDTX3 */
48 { 21, 0x71 }, /* R21 - SPDTX4 */
49 { 22, 0x0B }, /* R22 - SPDTX5 */
50 { 23, 0x70 }, /* R23 - GPO0 */
51 { 24, 0x57 }, /* R24 - GPO1 */
52 { 26, 0x42 }, /* R26 - GPO2 */
53 { 27, 0x06 }, /* R27 - AIFTX */
54 { 28, 0x06 }, /* R28 - AIFRX */
55 { 29, 0x80 }, /* R29 - SPDRX1 */
56 { 30, 0x07 }, /* R30 - PWRDN */
61 struct regmap
*regmap
;
62 struct regulator_bulk_data supplies
[WM8804_NUM_SUPPLIES
];
63 struct notifier_block disable_nb
[WM8804_NUM_SUPPLIES
];
66 struct gpio_desc
*reset
;
71 static int txsrc_put(struct snd_kcontrol
*kcontrol
,
72 struct snd_ctl_elem_value
*ucontrol
);
74 static int wm8804_aif_event(struct snd_soc_dapm_widget
*w
,
75 struct snd_kcontrol
*kcontrol
, int event
);
78 * We can't use the same notifier block for more than one supply and
79 * there's no way I can see to get from a callback to the caller
80 * except container_of().
82 #define WM8804_REGULATOR_EVENT(n) \
83 static int wm8804_regulator_event_##n(struct notifier_block *nb, \
84 unsigned long event, void *data) \
86 struct wm8804_priv *wm8804 = container_of(nb, struct wm8804_priv, \
88 if (event & REGULATOR_EVENT_DISABLE) { \
89 regcache_mark_dirty(wm8804->regmap); \
94 WM8804_REGULATOR_EVENT(0)
95 WM8804_REGULATOR_EVENT(1)
97 static const char *txsrc_text
[] = { "S/PDIF RX", "AIF" };
98 static SOC_ENUM_SINGLE_DECL(txsrc
, WM8804_SPDTX4
, 6, txsrc_text
);
100 static const struct snd_kcontrol_new wm8804_tx_source_mux
[] = {
101 SOC_DAPM_ENUM_EXT("Input Source", txsrc
,
102 snd_soc_dapm_get_enum_double
, txsrc_put
),
105 static const struct snd_soc_dapm_widget wm8804_dapm_widgets
[] = {
106 SND_SOC_DAPM_OUTPUT("SPDIF Out"),
107 SND_SOC_DAPM_INPUT("SPDIF In"),
109 SND_SOC_DAPM_PGA("SPDIFTX", WM8804_PWRDN
, 2, 1, NULL
, 0),
110 SND_SOC_DAPM_PGA("SPDIFRX", WM8804_PWRDN
, 1, 1, NULL
, 0),
112 SND_SOC_DAPM_MUX("Tx Source", SND_SOC_NOPM
, 6, 0, wm8804_tx_source_mux
),
114 SND_SOC_DAPM_AIF_OUT_E("AIFTX", NULL
, 0, SND_SOC_NOPM
, 0, 0, wm8804_aif_event
,
115 SND_SOC_DAPM_POST_PMU
| SND_SOC_DAPM_POST_PMD
),
116 SND_SOC_DAPM_AIF_IN_E("AIFRX", NULL
, 0, SND_SOC_NOPM
, 0, 0, wm8804_aif_event
,
117 SND_SOC_DAPM_POST_PMU
| SND_SOC_DAPM_POST_PMD
),
120 static const struct snd_soc_dapm_route wm8804_dapm_routes
[] = {
121 { "AIFRX", NULL
, "Playback" },
122 { "Tx Source", "AIF", "AIFRX" },
124 { "SPDIFRX", NULL
, "SPDIF In" },
125 { "Tx Source", "S/PDIF RX", "SPDIFRX" },
127 { "SPDIFTX", NULL
, "Tx Source" },
128 { "SPDIF Out", NULL
, "SPDIFTX" },
130 { "AIFTX", NULL
, "SPDIFRX" },
131 { "Capture", NULL
, "AIFTX" },
134 static int wm8804_aif_event(struct snd_soc_dapm_widget
*w
,
135 struct snd_kcontrol
*kcontrol
, int event
)
137 struct snd_soc_component
*component
= snd_soc_dapm_to_component(w
->dapm
);
138 struct wm8804_priv
*wm8804
= snd_soc_component_get_drvdata(component
);
141 case SND_SOC_DAPM_POST_PMU
:
142 /* power up the aif */
143 if (!wm8804
->aif_pwr
)
144 snd_soc_component_update_bits(component
, WM8804_PWRDN
, 0x10, 0x0);
147 case SND_SOC_DAPM_POST_PMD
:
148 /* power down only both paths are disabled */
150 if (!wm8804
->aif_pwr
)
151 snd_soc_component_update_bits(component
, WM8804_PWRDN
, 0x10, 0x10);
158 static int txsrc_put(struct snd_kcontrol
*kcontrol
,
159 struct snd_ctl_elem_value
*ucontrol
)
161 struct snd_soc_component
*component
= snd_soc_dapm_kcontrol_component(kcontrol
);
162 struct snd_soc_dapm_context
*dapm
= snd_soc_component_get_dapm(component
);
163 struct soc_enum
*e
= (struct soc_enum
*)kcontrol
->private_value
;
164 unsigned int val
= ucontrol
->value
.enumerated
.item
[0] << e
->shift_l
;
165 unsigned int mask
= 1 << e
->shift_l
;
168 if (val
!= 0 && val
!= mask
)
171 snd_soc_dapm_mutex_lock(dapm
);
173 if (snd_soc_component_test_bits(component
, e
->reg
, mask
, val
)) {
174 /* save the current power state of the transmitter */
175 txpwr
= snd_soc_component_read32(component
, WM8804_PWRDN
) & 0x4;
177 /* power down the transmitter */
178 snd_soc_component_update_bits(component
, WM8804_PWRDN
, 0x4, 0x4);
180 /* set the tx source */
181 snd_soc_component_update_bits(component
, e
->reg
, mask
, val
);
183 /* restore the transmitter's configuration */
184 snd_soc_component_update_bits(component
, WM8804_PWRDN
, 0x4, txpwr
);
187 snd_soc_dapm_mutex_unlock(dapm
);
192 static bool wm8804_volatile(struct device
*dev
, unsigned int reg
)
195 case WM8804_RST_DEVID1
:
211 static int wm8804_soft_reset(struct wm8804_priv
*wm8804
)
213 return regmap_write(wm8804
->regmap
, WM8804_RST_DEVID1
, 0x0);
216 static int wm8804_set_fmt(struct snd_soc_dai
*dai
, unsigned int fmt
)
218 struct snd_soc_component
*component
;
219 u16 format
, master
, bcp
, lrp
;
221 component
= dai
->component
;
223 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
224 case SND_SOC_DAIFMT_I2S
:
227 case SND_SOC_DAIFMT_RIGHT_J
:
230 case SND_SOC_DAIFMT_LEFT_J
:
233 case SND_SOC_DAIFMT_DSP_A
:
234 case SND_SOC_DAIFMT_DSP_B
:
238 dev_err(dai
->dev
, "Unknown dai format\n");
242 /* set data format */
243 snd_soc_component_update_bits(component
, WM8804_AIFTX
, 0x3, format
);
244 snd_soc_component_update_bits(component
, WM8804_AIFRX
, 0x3, format
);
246 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
247 case SND_SOC_DAIFMT_CBM_CFM
:
250 case SND_SOC_DAIFMT_CBS_CFS
:
254 dev_err(dai
->dev
, "Unknown master/slave configuration\n");
258 /* set master/slave mode */
259 snd_soc_component_update_bits(component
, WM8804_AIFRX
, 0x40, master
<< 6);
262 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
263 case SND_SOC_DAIFMT_NB_NF
:
265 case SND_SOC_DAIFMT_IB_IF
:
268 case SND_SOC_DAIFMT_IB_NF
:
271 case SND_SOC_DAIFMT_NB_IF
:
275 dev_err(dai
->dev
, "Unknown polarity configuration\n");
279 /* set frame inversion */
280 snd_soc_component_update_bits(component
, WM8804_AIFTX
, 0x10 | 0x20,
281 (bcp
<< 4) | (lrp
<< 5));
282 snd_soc_component_update_bits(component
, WM8804_AIFRX
, 0x10 | 0x20,
283 (bcp
<< 4) | (lrp
<< 5));
287 static int wm8804_hw_params(struct snd_pcm_substream
*substream
,
288 struct snd_pcm_hw_params
*params
,
289 struct snd_soc_dai
*dai
)
291 struct snd_soc_component
*component
;
294 component
= dai
->component
;
296 switch (params_width(params
)) {
307 dev_err(dai
->dev
, "Unsupported word length: %u\n",
308 params_width(params
));
312 /* set word length */
313 snd_soc_component_update_bits(component
, WM8804_AIFTX
, 0xc, blen
<< 2);
314 snd_soc_component_update_bits(component
, WM8804_AIFRX
, 0xc, blen
<< 2);
327 /* PLL rate to output rate divisions */
330 unsigned int freqmode
;
331 unsigned int mclkdiv
;
343 #define FIXED_PLL_SIZE ((1ULL << 22) * 10)
344 static int pll_factors(struct pll_div
*pll_div
, unsigned int target
,
345 unsigned int source
, unsigned int mclk_div
)
348 unsigned long int K
, Ndiv
, Nmod
, tmp
;
352 * Scale the output frequency up; the PLL should run in the
353 * region of 90-100MHz.
355 for (i
= 0; i
< ARRAY_SIZE(post_table
); i
++) {
356 tmp
= target
* post_table
[i
].div
;
357 if ((tmp
>= 90000000 && tmp
<= 100000000) &&
358 (mclk_div
== post_table
[i
].mclkdiv
)) {
359 pll_div
->freqmode
= post_table
[i
].freqmode
;
360 pll_div
->mclkdiv
= post_table
[i
].mclkdiv
;
361 target
*= post_table
[i
].div
;
366 if (i
== ARRAY_SIZE(post_table
)) {
367 pr_err("%s: Unable to scale output frequency: %uHz\n",
372 pll_div
->prescale
= 0;
373 Ndiv
= target
/ source
;
376 pll_div
->prescale
= 1;
377 Ndiv
= target
/ source
;
380 if (Ndiv
< 5 || Ndiv
> 13) {
381 pr_err("%s: WM8804 N value is not within the recommended range: %lu\n",
387 Nmod
= target
% source
;
388 Kpart
= FIXED_PLL_SIZE
* (u64
)Nmod
;
390 do_div(Kpart
, source
);
392 K
= Kpart
& 0xffffffff;
401 static int wm8804_set_pll(struct snd_soc_dai
*dai
, int pll_id
,
402 int source
, unsigned int freq_in
,
403 unsigned int freq_out
)
405 struct snd_soc_component
*component
= dai
->component
;
406 struct wm8804_priv
*wm8804
= snd_soc_component_get_drvdata(component
);
409 if (!freq_in
|| !freq_out
) {
410 /* disable the PLL */
411 regmap_update_bits_check(wm8804
->regmap
, WM8804_PWRDN
,
414 pm_runtime_put(wm8804
->dev
);
417 struct pll_div pll_div
;
419 ret
= pll_factors(&pll_div
, freq_out
, freq_in
,
424 /* power down the PLL before reprogramming it */
425 regmap_update_bits_check(wm8804
->regmap
, WM8804_PWRDN
,
428 pm_runtime_get_sync(wm8804
->dev
);
430 /* set PLLN and PRESCALE */
431 snd_soc_component_update_bits(component
, WM8804_PLL4
, 0xf | 0x10,
432 pll_div
.n
| (pll_div
.prescale
<< 4));
433 /* set mclkdiv and freqmode */
434 snd_soc_component_update_bits(component
, WM8804_PLL5
, 0x3 | 0x8,
435 pll_div
.freqmode
| (pll_div
.mclkdiv
<< 3));
437 snd_soc_component_write(component
, WM8804_PLL1
, pll_div
.k
& 0xff);
438 snd_soc_component_write(component
, WM8804_PLL2
, (pll_div
.k
>> 8) & 0xff);
439 snd_soc_component_write(component
, WM8804_PLL3
, pll_div
.k
>> 16);
441 /* power up the PLL */
442 snd_soc_component_update_bits(component
, WM8804_PWRDN
, 0x1, 0);
448 static int wm8804_set_sysclk(struct snd_soc_dai
*dai
,
449 int clk_id
, unsigned int freq
, int dir
)
451 struct snd_soc_component
*component
;
453 component
= dai
->component
;
456 case WM8804_TX_CLKSRC_MCLK
:
457 if ((freq
>= 10000000 && freq
<= 14400000)
458 || (freq
>= 16280000 && freq
<= 27000000))
459 snd_soc_component_update_bits(component
, WM8804_PLL6
, 0x80, 0x80);
461 dev_err(dai
->dev
, "OSCCLOCK is not within the "
462 "recommended range: %uHz\n", freq
);
466 case WM8804_TX_CLKSRC_PLL
:
467 snd_soc_component_update_bits(component
, WM8804_PLL6
, 0x80, 0);
469 case WM8804_CLKOUT_SRC_CLK1
:
470 snd_soc_component_update_bits(component
, WM8804_PLL6
, 0x8, 0);
472 case WM8804_CLKOUT_SRC_OSCCLK
:
473 snd_soc_component_update_bits(component
, WM8804_PLL6
, 0x8, 0x8);
476 dev_err(dai
->dev
, "Unknown clock source: %d\n", clk_id
);
483 static int wm8804_set_clkdiv(struct snd_soc_dai
*dai
,
486 struct snd_soc_component
*component
;
487 struct wm8804_priv
*wm8804
;
489 component
= dai
->component
;
491 case WM8804_CLKOUT_DIV
:
492 snd_soc_component_update_bits(component
, WM8804_PLL5
, 0x30,
495 case WM8804_MCLK_DIV
:
496 wm8804
= snd_soc_component_get_drvdata(component
);
497 wm8804
->mclk_div
= div
;
500 dev_err(dai
->dev
, "Unknown clock divider: %d\n", div_id
);
506 static const struct snd_soc_dai_ops wm8804_dai_ops
= {
507 .hw_params
= wm8804_hw_params
,
508 .set_fmt
= wm8804_set_fmt
,
509 .set_sysclk
= wm8804_set_sysclk
,
510 .set_clkdiv
= wm8804_set_clkdiv
,
511 .set_pll
= wm8804_set_pll
514 #define WM8804_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
515 SNDRV_PCM_FMTBIT_S24_LE)
517 #define WM8804_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
518 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_64000 | \
519 SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000 | \
520 SNDRV_PCM_RATE_176400 | SNDRV_PCM_RATE_192000)
522 static struct snd_soc_dai_driver wm8804_dai
= {
523 .name
= "wm8804-spdif",
525 .stream_name
= "Playback",
528 .rates
= WM8804_RATES
,
529 .formats
= WM8804_FORMATS
,
532 .stream_name
= "Capture",
535 .rates
= WM8804_RATES
,
536 .formats
= WM8804_FORMATS
,
538 .ops
= &wm8804_dai_ops
,
542 static const struct snd_soc_component_driver soc_component_dev_wm8804
= {
543 .dapm_widgets
= wm8804_dapm_widgets
,
544 .num_dapm_widgets
= ARRAY_SIZE(wm8804_dapm_widgets
),
545 .dapm_routes
= wm8804_dapm_routes
,
546 .num_dapm_routes
= ARRAY_SIZE(wm8804_dapm_routes
),
547 .use_pmdown_time
= 1,
549 .non_legacy_dai_naming
= 1,
552 const struct regmap_config wm8804_regmap_config
= {
556 .max_register
= WM8804_MAX_REGISTER
,
557 .volatile_reg
= wm8804_volatile
,
559 .cache_type
= REGCACHE_RBTREE
,
560 .reg_defaults
= wm8804_reg_defaults
,
561 .num_reg_defaults
= ARRAY_SIZE(wm8804_reg_defaults
),
563 EXPORT_SYMBOL_GPL(wm8804_regmap_config
);
565 int wm8804_probe(struct device
*dev
, struct regmap
*regmap
)
567 struct wm8804_priv
*wm8804
;
568 unsigned int id1
, id2
;
571 wm8804
= devm_kzalloc(dev
, sizeof(*wm8804
), GFP_KERNEL
);
575 dev_set_drvdata(dev
, wm8804
);
578 wm8804
->regmap
= regmap
;
580 wm8804
->reset
= devm_gpiod_get_optional(dev
, "wlf,reset",
582 if (IS_ERR(wm8804
->reset
)) {
583 ret
= PTR_ERR(wm8804
->reset
);
584 dev_err(dev
, "Failed to get reset line: %d\n", ret
);
588 for (i
= 0; i
< ARRAY_SIZE(wm8804
->supplies
); i
++)
589 wm8804
->supplies
[i
].supply
= wm8804_supply_names
[i
];
591 ret
= devm_regulator_bulk_get(dev
, ARRAY_SIZE(wm8804
->supplies
),
594 dev_err(dev
, "Failed to request supplies: %d\n", ret
);
598 wm8804
->disable_nb
[0].notifier_call
= wm8804_regulator_event_0
;
599 wm8804
->disable_nb
[1].notifier_call
= wm8804_regulator_event_1
;
601 /* This should really be moved into the regulator core */
602 for (i
= 0; i
< ARRAY_SIZE(wm8804
->supplies
); i
++) {
603 struct regulator
*regulator
= wm8804
->supplies
[i
].consumer
;
605 ret
= devm_regulator_register_notifier(regulator
,
606 &wm8804
->disable_nb
[i
]);
609 "Failed to register regulator notifier: %d\n",
615 ret
= regulator_bulk_enable(ARRAY_SIZE(wm8804
->supplies
),
618 dev_err(dev
, "Failed to enable supplies: %d\n", ret
);
622 gpiod_set_value_cansleep(wm8804
->reset
, 1);
624 ret
= regmap_read(regmap
, WM8804_RST_DEVID1
, &id1
);
626 dev_err(dev
, "Failed to read device ID: %d\n", ret
);
630 ret
= regmap_read(regmap
, WM8804_DEVID2
, &id2
);
632 dev_err(dev
, "Failed to read device ID: %d\n", ret
);
636 id2
= (id2
<< 8) | id1
;
639 dev_err(dev
, "Invalid device ID: %#x\n", id2
);
644 ret
= regmap_read(regmap
, WM8804_DEVREV
, &id1
);
646 dev_err(dev
, "Failed to read device revision: %d\n",
650 dev_info(dev
, "revision %c\n", id1
+ 'A');
652 if (!wm8804
->reset
) {
653 ret
= wm8804_soft_reset(wm8804
);
655 dev_err(dev
, "Failed to issue reset: %d\n", ret
);
660 ret
= devm_snd_soc_register_component(dev
, &soc_component_dev_wm8804
,
663 dev_err(dev
, "Failed to register CODEC: %d\n", ret
);
667 pm_runtime_set_active(dev
);
668 pm_runtime_enable(dev
);
669 pm_runtime_idle(dev
);
674 regulator_bulk_disable(ARRAY_SIZE(wm8804
->supplies
), wm8804
->supplies
);
677 EXPORT_SYMBOL_GPL(wm8804_probe
);
679 void wm8804_remove(struct device
*dev
)
681 pm_runtime_disable(dev
);
683 EXPORT_SYMBOL_GPL(wm8804_remove
);
685 #if IS_ENABLED(CONFIG_PM)
686 static int wm8804_runtime_resume(struct device
*dev
)
688 struct wm8804_priv
*wm8804
= dev_get_drvdata(dev
);
691 ret
= regulator_bulk_enable(ARRAY_SIZE(wm8804
->supplies
),
694 dev_err(wm8804
->dev
, "Failed to enable supplies: %d\n", ret
);
698 regcache_sync(wm8804
->regmap
);
700 /* Power up OSCCLK */
701 regmap_update_bits(wm8804
->regmap
, WM8804_PWRDN
, 0x8, 0x0);
706 static int wm8804_runtime_suspend(struct device
*dev
)
708 struct wm8804_priv
*wm8804
= dev_get_drvdata(dev
);
710 /* Power down OSCCLK */
711 regmap_update_bits(wm8804
->regmap
, WM8804_PWRDN
, 0x8, 0x8);
713 regulator_bulk_disable(ARRAY_SIZE(wm8804
->supplies
),
720 const struct dev_pm_ops wm8804_pm
= {
721 SET_RUNTIME_PM_OPS(wm8804_runtime_suspend
, wm8804_runtime_resume
, NULL
)
723 EXPORT_SYMBOL_GPL(wm8804_pm
);
725 MODULE_DESCRIPTION("ASoC WM8804 driver");
726 MODULE_AUTHOR("Dimitris Papastamos <dp@opensource.wolfsonmicro.com>");
727 MODULE_LICENSE("GPL");