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 wm8741_platform_data pdata
;
45 struct regmap
*regmap
;
46 struct regulator_bulk_data supplies
[WM8741_NUM_SUPPLIES
];
48 const struct snd_pcm_hw_constraint_list
*sysclk_constraints
;
51 static const struct reg_default wm8741_reg_defaults
[] = {
52 { 0, 0x0000 }, /* R0 - DACLLSB Attenuation */
53 { 1, 0x0000 }, /* R1 - DACLMSB Attenuation */
54 { 2, 0x0000 }, /* R2 - DACRLSB Attenuation */
55 { 3, 0x0000 }, /* R3 - DACRMSB Attenuation */
56 { 4, 0x0000 }, /* R4 - Volume Control */
57 { 5, 0x000A }, /* R5 - Format Control */
58 { 6, 0x0000 }, /* R6 - Filter Control */
59 { 7, 0x0000 }, /* R7 - Mode Control 1 */
60 { 8, 0x0002 }, /* R8 - Mode Control 2 */
61 { 32, 0x0002 }, /* R32 - ADDITONAL_CONTROL_1 */
64 static bool wm8741_readable(struct device
*dev
, unsigned int reg
)
67 case WM8741_DACLLSB_ATTENUATION
:
68 case WM8741_DACLMSB_ATTENUATION
:
69 case WM8741_DACRLSB_ATTENUATION
:
70 case WM8741_DACRMSB_ATTENUATION
:
71 case WM8741_VOLUME_CONTROL
:
72 case WM8741_FORMAT_CONTROL
:
73 case WM8741_FILTER_CONTROL
:
74 case WM8741_MODE_CONTROL_1
:
75 case WM8741_MODE_CONTROL_2
:
76 case WM8741_ADDITIONAL_CONTROL_1
:
83 static int wm8741_reset(struct snd_soc_codec
*codec
)
85 return snd_soc_write(codec
, WM8741_RESET
, 0);
88 static const DECLARE_TLV_DB_SCALE(dac_tlv_fine
, -12700, 13, 0);
89 static const DECLARE_TLV_DB_SCALE(dac_tlv
, -12700, 400, 0);
91 static const struct snd_kcontrol_new wm8741_snd_controls_stereo
[] = {
92 SOC_DOUBLE_R_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION
,
93 WM8741_DACRLSB_ATTENUATION
, 1, 255, 1, dac_tlv_fine
),
94 SOC_DOUBLE_R_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION
,
95 WM8741_DACRMSB_ATTENUATION
, 0, 511, 1, dac_tlv
),
98 static const struct snd_kcontrol_new wm8741_snd_controls_mono_left
[] = {
99 SOC_SINGLE_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION
,
100 1, 255, 1, dac_tlv_fine
),
101 SOC_SINGLE_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION
,
105 static const struct snd_kcontrol_new wm8741_snd_controls_mono_right
[] = {
106 SOC_SINGLE_TLV("Fine Playback Volume", WM8741_DACRLSB_ATTENUATION
,
107 1, 255, 1, dac_tlv_fine
),
108 SOC_SINGLE_TLV("Playback Volume", WM8741_DACRMSB_ATTENUATION
,
112 static const struct snd_soc_dapm_widget wm8741_dapm_widgets
[] = {
113 SND_SOC_DAPM_DAC("DACL", "Playback", SND_SOC_NOPM
, 0, 0),
114 SND_SOC_DAPM_DAC("DACR", "Playback", SND_SOC_NOPM
, 0, 0),
115 SND_SOC_DAPM_OUTPUT("VOUTLP"),
116 SND_SOC_DAPM_OUTPUT("VOUTLN"),
117 SND_SOC_DAPM_OUTPUT("VOUTRP"),
118 SND_SOC_DAPM_OUTPUT("VOUTRN"),
121 static const struct snd_soc_dapm_route wm8741_dapm_routes
[] = {
122 { "VOUTLP", NULL
, "DACL" },
123 { "VOUTLN", NULL
, "DACL" },
124 { "VOUTRP", NULL
, "DACR" },
125 { "VOUTRN", NULL
, "DACR" },
128 static const unsigned int rates_11289
[] = {
132 static const struct snd_pcm_hw_constraint_list constraints_11289
= {
133 .count
= ARRAY_SIZE(rates_11289
),
137 static const unsigned int rates_12288
[] = {
141 static const struct snd_pcm_hw_constraint_list constraints_12288
= {
142 .count
= ARRAY_SIZE(rates_12288
),
146 static const unsigned int rates_16384
[] = {
150 static const struct snd_pcm_hw_constraint_list constraints_16384
= {
151 .count
= ARRAY_SIZE(rates_16384
),
155 static const unsigned int rates_16934
[] = {
159 static const struct snd_pcm_hw_constraint_list constraints_16934
= {
160 .count
= ARRAY_SIZE(rates_16934
),
164 static const unsigned int rates_18432
[] = {
168 static const struct snd_pcm_hw_constraint_list constraints_18432
= {
169 .count
= ARRAY_SIZE(rates_18432
),
173 static const unsigned int rates_22579
[] = {
177 static const struct snd_pcm_hw_constraint_list constraints_22579
= {
178 .count
= ARRAY_SIZE(rates_22579
),
182 static const unsigned int rates_24576
[] = {
183 32000, 48000, 96000, 192000
186 static const struct snd_pcm_hw_constraint_list constraints_24576
= {
187 .count
= ARRAY_SIZE(rates_24576
),
191 static const unsigned int rates_36864
[] = {
195 static const struct snd_pcm_hw_constraint_list constraints_36864
= {
196 .count
= ARRAY_SIZE(rates_36864
),
200 static int wm8741_startup(struct snd_pcm_substream
*substream
,
201 struct snd_soc_dai
*dai
)
203 struct snd_soc_codec
*codec
= dai
->codec
;
204 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
207 snd_pcm_hw_constraint_list(substream
->runtime
, 0,
208 SNDRV_PCM_HW_PARAM_RATE
,
209 wm8741
->sysclk_constraints
);
214 static int wm8741_hw_params(struct snd_pcm_substream
*substream
,
215 struct snd_pcm_hw_params
*params
,
216 struct snd_soc_dai
*dai
)
218 struct snd_soc_codec
*codec
= dai
->codec
;
219 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
220 u16 iface
= snd_soc_read(codec
, WM8741_FORMAT_CONTROL
) & 0x1FC;
223 /* The set of sample rates that can be supported depends on the
224 * MCLK supplied to the CODEC - enforce this.
226 if (!wm8741
->sysclk
) {
228 "No MCLK configured, call set_sysclk() on init or in hw_params\n");
232 /* Find a supported LRCLK rate */
233 for (i
= 0; i
< wm8741
->sysclk_constraints
->count
; i
++) {
234 if (wm8741
->sysclk_constraints
->list
[i
] == params_rate(params
))
238 if (i
== wm8741
->sysclk_constraints
->count
) {
239 dev_err(codec
->dev
, "LRCLK %d unsupported with MCLK %d\n",
240 params_rate(params
), wm8741
->sysclk
);
245 switch (params_width(params
)) {
258 dev_dbg(codec
->dev
, "wm8741_hw_params: Unsupported bit size param = %d",
259 params_width(params
));
263 dev_dbg(codec
->dev
, "wm8741_hw_params: bit size param = %d, rate param = %d",
264 params_width(params
), params_rate(params
));
266 snd_soc_write(codec
, WM8741_FORMAT_CONTROL
, iface
);
270 static int wm8741_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
271 int clk_id
, unsigned int freq
, int dir
)
273 struct snd_soc_codec
*codec
= codec_dai
->codec
;
274 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
276 dev_dbg(codec
->dev
, "wm8741_set_dai_sysclk info: freq=%dHz\n", freq
);
280 wm8741
->sysclk_constraints
= NULL
;
281 wm8741
->sysclk
= freq
;
285 wm8741
->sysclk_constraints
= &constraints_11289
;
286 wm8741
->sysclk
= freq
;
290 wm8741
->sysclk_constraints
= &constraints_12288
;
291 wm8741
->sysclk
= freq
;
295 wm8741
->sysclk_constraints
= &constraints_16384
;
296 wm8741
->sysclk
= freq
;
300 wm8741
->sysclk_constraints
= &constraints_16934
;
301 wm8741
->sysclk
= freq
;
305 wm8741
->sysclk_constraints
= &constraints_18432
;
306 wm8741
->sysclk
= freq
;
311 wm8741
->sysclk_constraints
= &constraints_22579
;
312 wm8741
->sysclk
= freq
;
316 wm8741
->sysclk_constraints
= &constraints_24576
;
317 wm8741
->sysclk
= freq
;
321 wm8741
->sysclk_constraints
= &constraints_36864
;
322 wm8741
->sysclk
= freq
;
328 static int wm8741_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
331 struct snd_soc_codec
*codec
= codec_dai
->codec
;
332 u16 iface
= snd_soc_read(codec
, WM8741_FORMAT_CONTROL
) & 0x1C3;
334 /* check master/slave audio interface */
335 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
336 case SND_SOC_DAIFMT_CBS_CFS
:
342 /* interface format */
343 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
344 case SND_SOC_DAIFMT_I2S
:
347 case SND_SOC_DAIFMT_RIGHT_J
:
349 case SND_SOC_DAIFMT_LEFT_J
:
352 case SND_SOC_DAIFMT_DSP_A
:
355 case SND_SOC_DAIFMT_DSP_B
:
362 /* clock inversion */
363 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
364 case SND_SOC_DAIFMT_NB_NF
:
366 case SND_SOC_DAIFMT_IB_IF
:
369 case SND_SOC_DAIFMT_IB_NF
:
372 case SND_SOC_DAIFMT_NB_IF
:
380 dev_dbg(codec
->dev
, "wm8741_set_dai_fmt: Format=%x, Clock Inv=%x\n",
381 fmt
& SND_SOC_DAIFMT_FORMAT_MASK
,
382 ((fmt
& SND_SOC_DAIFMT_INV_MASK
)));
384 snd_soc_write(codec
, WM8741_FORMAT_CONTROL
, iface
);
388 #define WM8741_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
389 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | \
390 SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 | \
391 SNDRV_PCM_RATE_192000)
393 #define WM8741_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
394 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
396 static const struct snd_soc_dai_ops wm8741_dai_ops
= {
397 .startup
= wm8741_startup
,
398 .hw_params
= wm8741_hw_params
,
399 .set_sysclk
= wm8741_set_dai_sysclk
,
400 .set_fmt
= wm8741_set_dai_fmt
,
403 static struct snd_soc_dai_driver wm8741_dai
= {
406 .stream_name
= "Playback",
409 .rates
= WM8741_RATES
,
410 .formats
= WM8741_FORMATS
,
412 .ops
= &wm8741_dai_ops
,
416 static int wm8741_resume(struct snd_soc_codec
*codec
)
418 snd_soc_cache_sync(codec
);
422 #define wm8741_resume NULL
425 static int wm8741_configure(struct snd_soc_codec
*codec
)
427 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
429 /* Configure differential mode */
430 switch (wm8741
->pdata
.diff_mode
) {
431 case WM8741_DIFF_MODE_STEREO
:
432 case WM8741_DIFF_MODE_STEREO_REVERSED
:
433 case WM8741_DIFF_MODE_MONO_LEFT
:
434 case WM8741_DIFF_MODE_MONO_RIGHT
:
435 snd_soc_update_bits(codec
, WM8741_MODE_CONTROL_2
,
437 wm8741
->pdata
.diff_mode
<< WM8741_DIFF_SHIFT
);
443 /* Change some default settings - latch VU */
444 snd_soc_update_bits(codec
, WM8741_DACLLSB_ATTENUATION
,
445 WM8741_UPDATELL
, WM8741_UPDATELL
);
446 snd_soc_update_bits(codec
, WM8741_DACLMSB_ATTENUATION
,
447 WM8741_UPDATELM
, WM8741_UPDATELM
);
448 snd_soc_update_bits(codec
, WM8741_DACRLSB_ATTENUATION
,
449 WM8741_UPDATERL
, WM8741_UPDATERL
);
450 snd_soc_update_bits(codec
, WM8741_DACRMSB_ATTENUATION
,
451 WM8741_UPDATERM
, WM8741_UPDATERM
);
456 static int wm8741_add_controls(struct snd_soc_codec
*codec
)
458 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
460 switch (wm8741
->pdata
.diff_mode
) {
461 case WM8741_DIFF_MODE_STEREO
:
462 case WM8741_DIFF_MODE_STEREO_REVERSED
:
463 snd_soc_add_codec_controls(codec
,
464 wm8741_snd_controls_stereo
,
465 ARRAY_SIZE(wm8741_snd_controls_stereo
));
467 case WM8741_DIFF_MODE_MONO_LEFT
:
468 snd_soc_add_codec_controls(codec
,
469 wm8741_snd_controls_mono_left
,
470 ARRAY_SIZE(wm8741_snd_controls_mono_left
));
472 case WM8741_DIFF_MODE_MONO_RIGHT
:
473 snd_soc_add_codec_controls(codec
,
474 wm8741_snd_controls_mono_right
,
475 ARRAY_SIZE(wm8741_snd_controls_mono_right
));
484 static int wm8741_probe(struct snd_soc_codec
*codec
)
486 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
489 ret
= regulator_bulk_enable(ARRAY_SIZE(wm8741
->supplies
),
492 dev_err(codec
->dev
, "Failed to enable supplies: %d\n", ret
);
496 ret
= wm8741_reset(codec
);
498 dev_err(codec
->dev
, "Failed to issue reset\n");
502 ret
= wm8741_configure(codec
);
504 dev_err(codec
->dev
, "Failed to change default settings\n");
508 ret
= wm8741_add_controls(codec
);
510 dev_err(codec
->dev
, "Failed to add controls\n");
514 dev_dbg(codec
->dev
, "Successful registration\n");
518 regulator_bulk_disable(ARRAY_SIZE(wm8741
->supplies
), wm8741
->supplies
);
523 static int wm8741_remove(struct snd_soc_codec
*codec
)
525 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
527 regulator_bulk_disable(ARRAY_SIZE(wm8741
->supplies
), wm8741
->supplies
);
532 static struct snd_soc_codec_driver soc_codec_dev_wm8741
= {
533 .probe
= wm8741_probe
,
534 .remove
= wm8741_remove
,
535 .resume
= wm8741_resume
,
537 .dapm_widgets
= wm8741_dapm_widgets
,
538 .num_dapm_widgets
= ARRAY_SIZE(wm8741_dapm_widgets
),
539 .dapm_routes
= wm8741_dapm_routes
,
540 .num_dapm_routes
= ARRAY_SIZE(wm8741_dapm_routes
),
543 static const struct of_device_id wm8741_of_match
[] = {
544 { .compatible
= "wlf,wm8741", },
547 MODULE_DEVICE_TABLE(of
, wm8741_of_match
);
549 static const struct regmap_config wm8741_regmap
= {
552 .max_register
= WM8741_MAX_REGISTER
,
554 .reg_defaults
= wm8741_reg_defaults
,
555 .num_reg_defaults
= ARRAY_SIZE(wm8741_reg_defaults
),
556 .cache_type
= REGCACHE_RBTREE
,
558 .readable_reg
= wm8741_readable
,
561 static int wm8741_set_pdata(struct device
*dev
, struct wm8741_priv
*wm8741
)
563 const struct wm8741_platform_data
*pdata
= dev_get_platdata(dev
);
567 if (of_property_read_u32(dev
->of_node
, "diff-mode", &diff_mode
)
569 wm8741
->pdata
.diff_mode
= diff_mode
;
572 memcpy(&wm8741
->pdata
, pdata
, sizeof(wm8741
->pdata
));
578 #if IS_ENABLED(CONFIG_I2C)
579 static int wm8741_i2c_probe(struct i2c_client
*i2c
,
580 const struct i2c_device_id
*id
)
582 struct wm8741_priv
*wm8741
;
585 wm8741
= devm_kzalloc(&i2c
->dev
, sizeof(struct wm8741_priv
),
590 for (i
= 0; i
< ARRAY_SIZE(wm8741
->supplies
); i
++)
591 wm8741
->supplies
[i
].supply
= wm8741_supply_names
[i
];
593 ret
= devm_regulator_bulk_get(&i2c
->dev
, ARRAY_SIZE(wm8741
->supplies
),
596 dev_err(&i2c
->dev
, "Failed to request supplies: %d\n", ret
);
600 wm8741
->regmap
= devm_regmap_init_i2c(i2c
, &wm8741_regmap
);
601 if (IS_ERR(wm8741
->regmap
)) {
602 ret
= PTR_ERR(wm8741
->regmap
);
603 dev_err(&i2c
->dev
, "Failed to init regmap: %d\n", ret
);
607 ret
= wm8741_set_pdata(&i2c
->dev
, wm8741
);
609 dev_err(&i2c
->dev
, "Failed to set pdata: %d\n", ret
);
613 i2c_set_clientdata(i2c
, wm8741
);
615 ret
= snd_soc_register_codec(&i2c
->dev
,
616 &soc_codec_dev_wm8741
, &wm8741_dai
, 1);
621 static int wm8741_i2c_remove(struct i2c_client
*client
)
623 snd_soc_unregister_codec(&client
->dev
);
627 static const struct i2c_device_id wm8741_i2c_id
[] = {
631 MODULE_DEVICE_TABLE(i2c
, wm8741_i2c_id
);
633 static struct i2c_driver wm8741_i2c_driver
= {
636 .owner
= THIS_MODULE
,
637 .of_match_table
= wm8741_of_match
,
639 .probe
= wm8741_i2c_probe
,
640 .remove
= wm8741_i2c_remove
,
641 .id_table
= wm8741_i2c_id
,
645 #if defined(CONFIG_SPI_MASTER)
646 static int wm8741_spi_probe(struct spi_device
*spi
)
648 struct wm8741_priv
*wm8741
;
651 wm8741
= devm_kzalloc(&spi
->dev
, sizeof(struct wm8741_priv
),
656 for (i
= 0; i
< ARRAY_SIZE(wm8741
->supplies
); i
++)
657 wm8741
->supplies
[i
].supply
= wm8741_supply_names
[i
];
659 ret
= devm_regulator_bulk_get(&spi
->dev
, ARRAY_SIZE(wm8741
->supplies
),
662 dev_err(&spi
->dev
, "Failed to request supplies: %d\n", ret
);
666 wm8741
->regmap
= devm_regmap_init_spi(spi
, &wm8741_regmap
);
667 if (IS_ERR(wm8741
->regmap
)) {
668 ret
= PTR_ERR(wm8741
->regmap
);
669 dev_err(&spi
->dev
, "Failed to init regmap: %d\n", ret
);
673 ret
= wm8741_set_pdata(&spi
->dev
, wm8741
);
675 dev_err(&spi
->dev
, "Failed to set pdata: %d\n", ret
);
679 spi_set_drvdata(spi
, wm8741
);
681 ret
= snd_soc_register_codec(&spi
->dev
,
682 &soc_codec_dev_wm8741
, &wm8741_dai
, 1);
686 static int wm8741_spi_remove(struct spi_device
*spi
)
688 snd_soc_unregister_codec(&spi
->dev
);
692 static struct spi_driver wm8741_spi_driver
= {
695 .owner
= THIS_MODULE
,
696 .of_match_table
= wm8741_of_match
,
698 .probe
= wm8741_spi_probe
,
699 .remove
= wm8741_spi_remove
,
701 #endif /* CONFIG_SPI_MASTER */
703 static int __init
wm8741_modinit(void)
707 #if IS_ENABLED(CONFIG_I2C)
708 ret
= i2c_add_driver(&wm8741_i2c_driver
);
710 pr_err("Failed to register WM8741 I2C driver: %d\n", ret
);
712 #if defined(CONFIG_SPI_MASTER)
713 ret
= spi_register_driver(&wm8741_spi_driver
);
715 printk(KERN_ERR
"Failed to register wm8741 SPI driver: %d\n",
722 module_init(wm8741_modinit
);
724 static void __exit
wm8741_exit(void)
726 #if defined(CONFIG_SPI_MASTER)
727 spi_unregister_driver(&wm8741_spi_driver
);
729 #if IS_ENABLED(CONFIG_I2C)
730 i2c_del_driver(&wm8741_i2c_driver
);
733 module_exit(wm8741_exit
);
735 MODULE_DESCRIPTION("ASoC WM8741 driver");
736 MODULE_AUTHOR("Ian Lartey <ian@opensource.wolfsonmicro.com>");
737 MODULE_LICENSE("GPL");