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 /* codec private data */
42 struct wm8741_platform_data pdata
;
43 struct regmap
*regmap
;
44 struct regulator_bulk_data supplies
[WM8741_NUM_SUPPLIES
];
46 const struct snd_pcm_hw_constraint_list
*sysclk_constraints
;
49 static const struct reg_default wm8741_reg_defaults
[] = {
50 { 0, 0x0000 }, /* R0 - DACLLSB Attenuation */
51 { 1, 0x0000 }, /* R1 - DACLMSB Attenuation */
52 { 2, 0x0000 }, /* R2 - DACRLSB Attenuation */
53 { 3, 0x0000 }, /* R3 - DACRMSB Attenuation */
54 { 4, 0x0000 }, /* R4 - Volume Control */
55 { 5, 0x000A }, /* R5 - Format Control */
56 { 6, 0x0000 }, /* R6 - Filter Control */
57 { 7, 0x0000 }, /* R7 - Mode Control 1 */
58 { 8, 0x0002 }, /* R8 - Mode Control 2 */
59 { 32, 0x0002 }, /* R32 - ADDITONAL_CONTROL_1 */
62 static int wm8741_reset(struct snd_soc_codec
*codec
)
64 return snd_soc_write(codec
, WM8741_RESET
, 0);
67 static const DECLARE_TLV_DB_SCALE(dac_tlv_fine
, -12700, 13, 0);
68 static const DECLARE_TLV_DB_SCALE(dac_tlv
, -12700, 400, 0);
70 static const struct snd_kcontrol_new wm8741_snd_controls_stereo
[] = {
71 SOC_DOUBLE_R_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION
,
72 WM8741_DACRLSB_ATTENUATION
, 1, 255, 1, dac_tlv_fine
),
73 SOC_DOUBLE_R_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION
,
74 WM8741_DACRMSB_ATTENUATION
, 0, 511, 1, dac_tlv
),
77 static const struct snd_kcontrol_new wm8741_snd_controls_mono_left
[] = {
78 SOC_SINGLE_TLV("Fine Playback Volume", WM8741_DACLLSB_ATTENUATION
,
79 1, 255, 1, dac_tlv_fine
),
80 SOC_SINGLE_TLV("Playback Volume", WM8741_DACLMSB_ATTENUATION
,
84 static const struct snd_kcontrol_new wm8741_snd_controls_mono_right
[] = {
85 SOC_SINGLE_TLV("Fine Playback Volume", WM8741_DACRLSB_ATTENUATION
,
86 1, 255, 1, dac_tlv_fine
),
87 SOC_SINGLE_TLV("Playback Volume", WM8741_DACRMSB_ATTENUATION
,
91 static const struct snd_soc_dapm_widget wm8741_dapm_widgets
[] = {
92 SND_SOC_DAPM_DAC("DACL", "Playback", SND_SOC_NOPM
, 0, 0),
93 SND_SOC_DAPM_DAC("DACR", "Playback", SND_SOC_NOPM
, 0, 0),
94 SND_SOC_DAPM_OUTPUT("VOUTLP"),
95 SND_SOC_DAPM_OUTPUT("VOUTLN"),
96 SND_SOC_DAPM_OUTPUT("VOUTRP"),
97 SND_SOC_DAPM_OUTPUT("VOUTRN"),
100 static const struct snd_soc_dapm_route wm8741_dapm_routes
[] = {
101 { "VOUTLP", NULL
, "DACL" },
102 { "VOUTLN", NULL
, "DACL" },
103 { "VOUTRP", NULL
, "DACR" },
104 { "VOUTRN", NULL
, "DACR" },
107 static const unsigned int rates_11289
[] = {
111 static const struct snd_pcm_hw_constraint_list constraints_11289
= {
112 .count
= ARRAY_SIZE(rates_11289
),
116 static const unsigned int rates_12288
[] = {
120 static const struct snd_pcm_hw_constraint_list constraints_12288
= {
121 .count
= ARRAY_SIZE(rates_12288
),
125 static const unsigned int rates_16384
[] = {
129 static const struct snd_pcm_hw_constraint_list constraints_16384
= {
130 .count
= ARRAY_SIZE(rates_16384
),
134 static const unsigned int rates_16934
[] = {
138 static const struct snd_pcm_hw_constraint_list constraints_16934
= {
139 .count
= ARRAY_SIZE(rates_16934
),
143 static const unsigned int rates_18432
[] = {
147 static const struct snd_pcm_hw_constraint_list constraints_18432
= {
148 .count
= ARRAY_SIZE(rates_18432
),
152 static const unsigned int rates_22579
[] = {
156 static const struct snd_pcm_hw_constraint_list constraints_22579
= {
157 .count
= ARRAY_SIZE(rates_22579
),
161 static const unsigned int rates_24576
[] = {
162 32000, 48000, 96000, 192000
165 static const struct snd_pcm_hw_constraint_list constraints_24576
= {
166 .count
= ARRAY_SIZE(rates_24576
),
170 static const unsigned int rates_36864
[] = {
174 static const struct snd_pcm_hw_constraint_list constraints_36864
= {
175 .count
= ARRAY_SIZE(rates_36864
),
179 static int wm8741_startup(struct snd_pcm_substream
*substream
,
180 struct snd_soc_dai
*dai
)
182 struct snd_soc_codec
*codec
= dai
->codec
;
183 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
186 snd_pcm_hw_constraint_list(substream
->runtime
, 0,
187 SNDRV_PCM_HW_PARAM_RATE
,
188 wm8741
->sysclk_constraints
);
193 static int wm8741_hw_params(struct snd_pcm_substream
*substream
,
194 struct snd_pcm_hw_params
*params
,
195 struct snd_soc_dai
*dai
)
197 struct snd_soc_codec
*codec
= dai
->codec
;
198 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
199 u16 iface
= snd_soc_read(codec
, WM8741_FORMAT_CONTROL
) & 0x1FC;
202 /* The set of sample rates that can be supported depends on the
203 * MCLK supplied to the CODEC - enforce this.
205 if (!wm8741
->sysclk
) {
207 "No MCLK configured, call set_sysclk() on init or in hw_params\n");
211 /* Find a supported LRCLK rate */
212 for (i
= 0; i
< wm8741
->sysclk_constraints
->count
; i
++) {
213 if (wm8741
->sysclk_constraints
->list
[i
] == params_rate(params
))
217 if (i
== wm8741
->sysclk_constraints
->count
) {
218 dev_err(codec
->dev
, "LRCLK %d unsupported with MCLK %d\n",
219 params_rate(params
), wm8741
->sysclk
);
224 switch (params_width(params
)) {
237 dev_dbg(codec
->dev
, "wm8741_hw_params: Unsupported bit size param = %d",
238 params_width(params
));
242 dev_dbg(codec
->dev
, "wm8741_hw_params: bit size param = %d, rate param = %d",
243 params_width(params
), params_rate(params
));
245 snd_soc_write(codec
, WM8741_FORMAT_CONTROL
, iface
);
249 static int wm8741_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
250 int clk_id
, unsigned int freq
, int dir
)
252 struct snd_soc_codec
*codec
= codec_dai
->codec
;
253 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
255 dev_dbg(codec
->dev
, "wm8741_set_dai_sysclk info: freq=%dHz\n", freq
);
259 wm8741
->sysclk_constraints
= NULL
;
262 wm8741
->sysclk_constraints
= &constraints_11289
;
265 wm8741
->sysclk_constraints
= &constraints_12288
;
268 wm8741
->sysclk_constraints
= &constraints_16384
;
271 wm8741
->sysclk_constraints
= &constraints_16934
;
274 wm8741
->sysclk_constraints
= &constraints_18432
;
278 wm8741
->sysclk_constraints
= &constraints_22579
;
281 wm8741
->sysclk_constraints
= &constraints_24576
;
284 wm8741
->sysclk_constraints
= &constraints_36864
;
290 wm8741
->sysclk
= freq
;
294 static int wm8741_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
297 struct snd_soc_codec
*codec
= codec_dai
->codec
;
298 u16 iface
= snd_soc_read(codec
, WM8741_FORMAT_CONTROL
) & 0x1C3;
300 /* check master/slave audio interface */
301 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
302 case SND_SOC_DAIFMT_CBS_CFS
:
308 /* interface format */
309 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
310 case SND_SOC_DAIFMT_I2S
:
313 case SND_SOC_DAIFMT_RIGHT_J
:
315 case SND_SOC_DAIFMT_LEFT_J
:
318 case SND_SOC_DAIFMT_DSP_A
:
321 case SND_SOC_DAIFMT_DSP_B
:
328 /* clock inversion */
329 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
330 case SND_SOC_DAIFMT_NB_NF
:
332 case SND_SOC_DAIFMT_IB_IF
:
335 case SND_SOC_DAIFMT_IB_NF
:
338 case SND_SOC_DAIFMT_NB_IF
:
346 dev_dbg(codec
->dev
, "wm8741_set_dai_fmt: Format=%x, Clock Inv=%x\n",
347 fmt
& SND_SOC_DAIFMT_FORMAT_MASK
,
348 ((fmt
& SND_SOC_DAIFMT_INV_MASK
)));
350 snd_soc_write(codec
, WM8741_FORMAT_CONTROL
, iface
);
354 #define WM8741_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
355 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 | \
356 SNDRV_PCM_RATE_96000 | SNDRV_PCM_RATE_176400 | \
357 SNDRV_PCM_RATE_192000)
359 #define WM8741_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
360 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
362 static const struct snd_soc_dai_ops wm8741_dai_ops
= {
363 .startup
= wm8741_startup
,
364 .hw_params
= wm8741_hw_params
,
365 .set_sysclk
= wm8741_set_dai_sysclk
,
366 .set_fmt
= wm8741_set_dai_fmt
,
369 static struct snd_soc_dai_driver wm8741_dai
= {
372 .stream_name
= "Playback",
375 .rates
= WM8741_RATES
,
376 .formats
= WM8741_FORMATS
,
378 .ops
= &wm8741_dai_ops
,
382 static int wm8741_resume(struct snd_soc_codec
*codec
)
384 snd_soc_cache_sync(codec
);
388 #define wm8741_resume NULL
391 static int wm8741_configure(struct snd_soc_codec
*codec
)
393 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
395 /* Configure differential mode */
396 switch (wm8741
->pdata
.diff_mode
) {
397 case WM8741_DIFF_MODE_STEREO
:
398 case WM8741_DIFF_MODE_STEREO_REVERSED
:
399 case WM8741_DIFF_MODE_MONO_LEFT
:
400 case WM8741_DIFF_MODE_MONO_RIGHT
:
401 snd_soc_update_bits(codec
, WM8741_MODE_CONTROL_2
,
403 wm8741
->pdata
.diff_mode
<< WM8741_DIFF_SHIFT
);
409 /* Change some default settings - latch VU */
410 snd_soc_update_bits(codec
, WM8741_DACLLSB_ATTENUATION
,
411 WM8741_UPDATELL
, WM8741_UPDATELL
);
412 snd_soc_update_bits(codec
, WM8741_DACLMSB_ATTENUATION
,
413 WM8741_UPDATELM
, WM8741_UPDATELM
);
414 snd_soc_update_bits(codec
, WM8741_DACRLSB_ATTENUATION
,
415 WM8741_UPDATERL
, WM8741_UPDATERL
);
416 snd_soc_update_bits(codec
, WM8741_DACRMSB_ATTENUATION
,
417 WM8741_UPDATERM
, WM8741_UPDATERM
);
422 static int wm8741_add_controls(struct snd_soc_codec
*codec
)
424 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
426 switch (wm8741
->pdata
.diff_mode
) {
427 case WM8741_DIFF_MODE_STEREO
:
428 case WM8741_DIFF_MODE_STEREO_REVERSED
:
429 snd_soc_add_codec_controls(codec
,
430 wm8741_snd_controls_stereo
,
431 ARRAY_SIZE(wm8741_snd_controls_stereo
));
433 case WM8741_DIFF_MODE_MONO_LEFT
:
434 snd_soc_add_codec_controls(codec
,
435 wm8741_snd_controls_mono_left
,
436 ARRAY_SIZE(wm8741_snd_controls_mono_left
));
438 case WM8741_DIFF_MODE_MONO_RIGHT
:
439 snd_soc_add_codec_controls(codec
,
440 wm8741_snd_controls_mono_right
,
441 ARRAY_SIZE(wm8741_snd_controls_mono_right
));
450 static int wm8741_probe(struct snd_soc_codec
*codec
)
452 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
455 ret
= regulator_bulk_enable(ARRAY_SIZE(wm8741
->supplies
),
458 dev_err(codec
->dev
, "Failed to enable supplies: %d\n", ret
);
462 ret
= wm8741_reset(codec
);
464 dev_err(codec
->dev
, "Failed to issue reset\n");
468 ret
= wm8741_configure(codec
);
470 dev_err(codec
->dev
, "Failed to change default settings\n");
474 ret
= wm8741_add_controls(codec
);
476 dev_err(codec
->dev
, "Failed to add controls\n");
480 dev_dbg(codec
->dev
, "Successful registration\n");
484 regulator_bulk_disable(ARRAY_SIZE(wm8741
->supplies
), wm8741
->supplies
);
489 static int wm8741_remove(struct snd_soc_codec
*codec
)
491 struct wm8741_priv
*wm8741
= snd_soc_codec_get_drvdata(codec
);
493 regulator_bulk_disable(ARRAY_SIZE(wm8741
->supplies
), wm8741
->supplies
);
498 static const struct snd_soc_codec_driver soc_codec_dev_wm8741
= {
499 .probe
= wm8741_probe
,
500 .remove
= wm8741_remove
,
501 .resume
= wm8741_resume
,
503 .component_driver
= {
504 .dapm_widgets
= wm8741_dapm_widgets
,
505 .num_dapm_widgets
= ARRAY_SIZE(wm8741_dapm_widgets
),
506 .dapm_routes
= wm8741_dapm_routes
,
507 .num_dapm_routes
= ARRAY_SIZE(wm8741_dapm_routes
),
511 static const struct of_device_id wm8741_of_match
[] = {
512 { .compatible
= "wlf,wm8741", },
515 MODULE_DEVICE_TABLE(of
, wm8741_of_match
);
517 static const struct regmap_config wm8741_regmap
= {
520 .max_register
= WM8741_MAX_REGISTER
,
522 .reg_defaults
= wm8741_reg_defaults
,
523 .num_reg_defaults
= ARRAY_SIZE(wm8741_reg_defaults
),
524 .cache_type
= REGCACHE_RBTREE
,
527 static int wm8741_set_pdata(struct device
*dev
, struct wm8741_priv
*wm8741
)
529 const struct wm8741_platform_data
*pdata
= dev_get_platdata(dev
);
533 if (of_property_read_u32(dev
->of_node
, "diff-mode", &diff_mode
)
535 wm8741
->pdata
.diff_mode
= diff_mode
;
538 memcpy(&wm8741
->pdata
, pdata
, sizeof(wm8741
->pdata
));
544 #if IS_ENABLED(CONFIG_I2C)
545 static int wm8741_i2c_probe(struct i2c_client
*i2c
,
546 const struct i2c_device_id
*id
)
548 struct wm8741_priv
*wm8741
;
551 wm8741
= devm_kzalloc(&i2c
->dev
, sizeof(struct wm8741_priv
),
556 for (i
= 0; i
< ARRAY_SIZE(wm8741
->supplies
); i
++)
557 wm8741
->supplies
[i
].supply
= wm8741_supply_names
[i
];
559 ret
= devm_regulator_bulk_get(&i2c
->dev
, ARRAY_SIZE(wm8741
->supplies
),
562 dev_err(&i2c
->dev
, "Failed to request supplies: %d\n", ret
);
566 wm8741
->regmap
= devm_regmap_init_i2c(i2c
, &wm8741_regmap
);
567 if (IS_ERR(wm8741
->regmap
)) {
568 ret
= PTR_ERR(wm8741
->regmap
);
569 dev_err(&i2c
->dev
, "Failed to init regmap: %d\n", ret
);
573 ret
= wm8741_set_pdata(&i2c
->dev
, wm8741
);
575 dev_err(&i2c
->dev
, "Failed to set pdata: %d\n", ret
);
579 i2c_set_clientdata(i2c
, wm8741
);
581 ret
= snd_soc_register_codec(&i2c
->dev
,
582 &soc_codec_dev_wm8741
, &wm8741_dai
, 1);
587 static int wm8741_i2c_remove(struct i2c_client
*client
)
589 snd_soc_unregister_codec(&client
->dev
);
593 static const struct i2c_device_id wm8741_i2c_id
[] = {
597 MODULE_DEVICE_TABLE(i2c
, wm8741_i2c_id
);
599 static struct i2c_driver wm8741_i2c_driver
= {
602 .of_match_table
= wm8741_of_match
,
604 .probe
= wm8741_i2c_probe
,
605 .remove
= wm8741_i2c_remove
,
606 .id_table
= wm8741_i2c_id
,
610 #if defined(CONFIG_SPI_MASTER)
611 static int wm8741_spi_probe(struct spi_device
*spi
)
613 struct wm8741_priv
*wm8741
;
616 wm8741
= devm_kzalloc(&spi
->dev
, sizeof(struct wm8741_priv
),
621 for (i
= 0; i
< ARRAY_SIZE(wm8741
->supplies
); i
++)
622 wm8741
->supplies
[i
].supply
= wm8741_supply_names
[i
];
624 ret
= devm_regulator_bulk_get(&spi
->dev
, ARRAY_SIZE(wm8741
->supplies
),
627 dev_err(&spi
->dev
, "Failed to request supplies: %d\n", ret
);
631 wm8741
->regmap
= devm_regmap_init_spi(spi
, &wm8741_regmap
);
632 if (IS_ERR(wm8741
->regmap
)) {
633 ret
= PTR_ERR(wm8741
->regmap
);
634 dev_err(&spi
->dev
, "Failed to init regmap: %d\n", ret
);
638 ret
= wm8741_set_pdata(&spi
->dev
, wm8741
);
640 dev_err(&spi
->dev
, "Failed to set pdata: %d\n", ret
);
644 spi_set_drvdata(spi
, wm8741
);
646 ret
= snd_soc_register_codec(&spi
->dev
,
647 &soc_codec_dev_wm8741
, &wm8741_dai
, 1);
651 static int wm8741_spi_remove(struct spi_device
*spi
)
653 snd_soc_unregister_codec(&spi
->dev
);
657 static struct spi_driver wm8741_spi_driver
= {
660 .of_match_table
= wm8741_of_match
,
662 .probe
= wm8741_spi_probe
,
663 .remove
= wm8741_spi_remove
,
665 #endif /* CONFIG_SPI_MASTER */
667 static int __init
wm8741_modinit(void)
671 #if IS_ENABLED(CONFIG_I2C)
672 ret
= i2c_add_driver(&wm8741_i2c_driver
);
674 pr_err("Failed to register WM8741 I2C driver: %d\n", ret
);
676 #if defined(CONFIG_SPI_MASTER)
677 ret
= spi_register_driver(&wm8741_spi_driver
);
679 printk(KERN_ERR
"Failed to register wm8741 SPI driver: %d\n",
686 module_init(wm8741_modinit
);
688 static void __exit
wm8741_exit(void)
690 #if defined(CONFIG_SPI_MASTER)
691 spi_unregister_driver(&wm8741_spi_driver
);
693 #if IS_ENABLED(CONFIG_I2C)
694 i2c_del_driver(&wm8741_i2c_driver
);
697 module_exit(wm8741_exit
);
699 MODULE_DESCRIPTION("ASoC WM8741 driver");
700 MODULE_AUTHOR("Ian Lartey <ian@opensource.wolfsonmicro.com>");
701 MODULE_LICENSE("GPL");