2 * wm8731.c -- WM8731 ALSA SoC Audio driver
4 * Copyright 2005 Openedhand Ltd.
6 * Author: Richard Purdie <richard@openedhand.com>
8 * Based on wm8753.c by Liam Girdwood
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/platform_device.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
31 #define AUDIO_NAME "wm8731"
32 #define WM8731_VERSION "0.13"
34 struct snd_soc_codec_device soc_codec_dev_wm8731
;
36 /* codec private data */
42 * wm8731 register cache
43 * We can't read the WM8731 register space when we are
44 * using 2 wire for device control, so we cache them instead.
45 * There is no point in caching the reset register
47 static const u16 wm8731_reg
[WM8731_CACHEREGNUM
] = {
48 0x0097, 0x0097, 0x0079, 0x0079,
49 0x000a, 0x0008, 0x009f, 0x000a,
54 * read wm8731 register cache
56 static inline unsigned int wm8731_read_reg_cache(struct snd_soc_codec
*codec
,
59 u16
*cache
= codec
->reg_cache
;
60 if (reg
== WM8731_RESET
)
62 if (reg
>= WM8731_CACHEREGNUM
)
68 * write wm8731 register cache
70 static inline void wm8731_write_reg_cache(struct snd_soc_codec
*codec
,
71 u16 reg
, unsigned int value
)
73 u16
*cache
= codec
->reg_cache
;
74 if (reg
>= WM8731_CACHEREGNUM
)
80 * write to the WM8731 register space
82 static int wm8731_write(struct snd_soc_codec
*codec
, unsigned int reg
,
88 * D15..D9 WM8731 register offset
89 * D8...D0 register data
91 data
[0] = (reg
<< 1) | ((value
>> 8) & 0x0001);
92 data
[1] = value
& 0x00ff;
94 wm8731_write_reg_cache(codec
, reg
, value
);
95 if (codec
->hw_write(codec
->control_data
, data
, 2) == 2)
101 #define wm8731_reset(c) wm8731_write(c, WM8731_RESET, 0)
103 static const char *wm8731_input_select
[] = {"Line In", "Mic"};
104 static const char *wm8731_deemph
[] = {"None", "32Khz", "44.1Khz", "48Khz"};
106 static const struct soc_enum wm8731_enum
[] = {
107 SOC_ENUM_SINGLE(WM8731_APANA
, 2, 2, wm8731_input_select
),
108 SOC_ENUM_SINGLE(WM8731_APDIGI
, 1, 4, wm8731_deemph
),
111 static const struct snd_kcontrol_new wm8731_snd_controls
[] = {
113 SOC_DOUBLE_R("Master Playback Volume", WM8731_LOUT1V
, WM8731_ROUT1V
,
115 SOC_DOUBLE_R("Master Playback ZC Switch", WM8731_LOUT1V
, WM8731_ROUT1V
,
118 SOC_DOUBLE_R("Capture Volume", WM8731_LINVOL
, WM8731_RINVOL
, 0, 31, 0),
119 SOC_DOUBLE_R("Line Capture Switch", WM8731_LINVOL
, WM8731_RINVOL
, 7, 1, 1),
121 SOC_SINGLE("Mic Boost (+20dB)", WM8731_APANA
, 0, 1, 0),
122 SOC_SINGLE("Capture Mic Switch", WM8731_APANA
, 1, 1, 1),
124 SOC_SINGLE("Sidetone Playback Volume", WM8731_APANA
, 6, 3, 1),
126 SOC_SINGLE("ADC High Pass Filter Switch", WM8731_APDIGI
, 0, 1, 1),
127 SOC_SINGLE("Store DC Offset Switch", WM8731_APDIGI
, 4, 1, 0),
129 SOC_ENUM("Playback De-emphasis", wm8731_enum
[1]),
132 /* add non dapm controls */
133 static int wm8731_add_controls(struct snd_soc_codec
*codec
)
137 for (i
= 0; i
< ARRAY_SIZE(wm8731_snd_controls
); i
++) {
138 err
= snd_ctl_add(codec
->card
,
139 snd_soc_cnew(&wm8731_snd_controls
[i
],
149 static const struct snd_kcontrol_new wm8731_output_mixer_controls
[] = {
150 SOC_DAPM_SINGLE("Line Bypass Switch", WM8731_APANA
, 3, 1, 0),
151 SOC_DAPM_SINGLE("Mic Sidetone Switch", WM8731_APANA
, 5, 1, 0),
152 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8731_APANA
, 4, 1, 0),
156 static const struct snd_kcontrol_new wm8731_input_mux_controls
=
157 SOC_DAPM_ENUM("Input Select", wm8731_enum
[0]);
159 static const struct snd_soc_dapm_widget wm8731_dapm_widgets
[] = {
160 SND_SOC_DAPM_MIXER("Output Mixer", WM8731_PWR
, 4, 1,
161 &wm8731_output_mixer_controls
[0],
162 ARRAY_SIZE(wm8731_output_mixer_controls
)),
163 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8731_PWR
, 3, 1),
164 SND_SOC_DAPM_OUTPUT("LOUT"),
165 SND_SOC_DAPM_OUTPUT("LHPOUT"),
166 SND_SOC_DAPM_OUTPUT("ROUT"),
167 SND_SOC_DAPM_OUTPUT("RHPOUT"),
168 SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8731_PWR
, 2, 1),
169 SND_SOC_DAPM_MUX("Input Mux", SND_SOC_NOPM
, 0, 0, &wm8731_input_mux_controls
),
170 SND_SOC_DAPM_PGA("Line Input", WM8731_PWR
, 0, 1, NULL
, 0),
171 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8731_PWR
, 1, 1),
172 SND_SOC_DAPM_INPUT("MICIN"),
173 SND_SOC_DAPM_INPUT("RLINEIN"),
174 SND_SOC_DAPM_INPUT("LLINEIN"),
177 static const struct snd_soc_dapm_route intercon
[] = {
179 {"Output Mixer", "Line Bypass Switch", "Line Input"},
180 {"Output Mixer", "HiFi Playback Switch", "DAC"},
181 {"Output Mixer", "Mic Sidetone Switch", "Mic Bias"},
184 {"RHPOUT", NULL
, "Output Mixer"},
185 {"ROUT", NULL
, "Output Mixer"},
186 {"LHPOUT", NULL
, "Output Mixer"},
187 {"LOUT", NULL
, "Output Mixer"},
190 {"Input Mux", "Line In", "Line Input"},
191 {"Input Mux", "Mic", "Mic Bias"},
192 {"ADC", NULL
, "Input Mux"},
195 {"Line Input", NULL
, "LLINEIN"},
196 {"Line Input", NULL
, "RLINEIN"},
197 {"Mic Bias", NULL
, "MICIN"},
200 static int wm8731_add_widgets(struct snd_soc_codec
*codec
)
202 snd_soc_dapm_new_controls(codec
, wm8731_dapm_widgets
,
203 ARRAY_SIZE(wm8731_dapm_widgets
));
205 snd_soc_dapm_add_routes(codec
, intercon
, ARRAY_SIZE(intercon
));
207 snd_soc_dapm_new_widgets(codec
);
220 /* codec mclk clock divider coefficients */
221 static const struct _coeff_div coeff_div
[] = {
223 {12288000, 48000, 256, 0x0, 0x0, 0x0},
224 {18432000, 48000, 384, 0x0, 0x1, 0x0},
225 {12000000, 48000, 250, 0x0, 0x0, 0x1},
228 {12288000, 32000, 384, 0x6, 0x0, 0x0},
229 {18432000, 32000, 576, 0x6, 0x1, 0x0},
230 {12000000, 32000, 375, 0x6, 0x0, 0x1},
233 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
234 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
235 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
236 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
237 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
240 {12288000, 96000, 128, 0x7, 0x0, 0x0},
241 {18432000, 96000, 192, 0x7, 0x1, 0x0},
242 {12000000, 96000, 125, 0x7, 0x0, 0x1},
245 {11289600, 44100, 256, 0x8, 0x0, 0x0},
246 {16934400, 44100, 384, 0x8, 0x1, 0x0},
247 {12000000, 44100, 272, 0x8, 0x1, 0x1},
250 {11289600, 88200, 128, 0xf, 0x0, 0x0},
251 {16934400, 88200, 192, 0xf, 0x1, 0x0},
252 {12000000, 88200, 136, 0xf, 0x1, 0x1},
255 static inline int get_coeff(int mclk
, int rate
)
259 for (i
= 0; i
< ARRAY_SIZE(coeff_div
); i
++) {
260 if (coeff_div
[i
].rate
== rate
&& coeff_div
[i
].mclk
== mclk
)
266 static int wm8731_hw_params(struct snd_pcm_substream
*substream
,
267 struct snd_pcm_hw_params
*params
)
269 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
270 struct snd_soc_device
*socdev
= rtd
->socdev
;
271 struct snd_soc_codec
*codec
= socdev
->codec
;
272 struct wm8731_priv
*wm8731
= codec
->private_data
;
273 u16 iface
= wm8731_read_reg_cache(codec
, WM8731_IFACE
) & 0xfff3;
274 int i
= get_coeff(wm8731
->sysclk
, params_rate(params
));
275 u16 srate
= (coeff_div
[i
].sr
<< 2) |
276 (coeff_div
[i
].bosr
<< 1) | coeff_div
[i
].usb
;
278 wm8731_write(codec
, WM8731_SRATE
, srate
);
281 switch (params_format(params
)) {
282 case SNDRV_PCM_FORMAT_S16_LE
:
284 case SNDRV_PCM_FORMAT_S20_3LE
:
287 case SNDRV_PCM_FORMAT_S24_LE
:
292 wm8731_write(codec
, WM8731_IFACE
, iface
);
296 static int wm8731_pcm_prepare(struct snd_pcm_substream
*substream
)
298 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
299 struct snd_soc_device
*socdev
= rtd
->socdev
;
300 struct snd_soc_codec
*codec
= socdev
->codec
;
303 wm8731_write(codec
, WM8731_ACTIVE
, 0x0001);
308 static void wm8731_shutdown(struct snd_pcm_substream
*substream
)
310 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
311 struct snd_soc_device
*socdev
= rtd
->socdev
;
312 struct snd_soc_codec
*codec
= socdev
->codec
;
315 if (!codec
->active
) {
317 wm8731_write(codec
, WM8731_ACTIVE
, 0x0);
321 static int wm8731_mute(struct snd_soc_dai
*dai
, int mute
)
323 struct snd_soc_codec
*codec
= dai
->codec
;
324 u16 mute_reg
= wm8731_read_reg_cache(codec
, WM8731_APDIGI
) & 0xfff7;
327 wm8731_write(codec
, WM8731_APDIGI
, mute_reg
| 0x8);
329 wm8731_write(codec
, WM8731_APDIGI
, mute_reg
);
333 static int wm8731_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
334 int clk_id
, unsigned int freq
, int dir
)
336 struct snd_soc_codec
*codec
= codec_dai
->codec
;
337 struct wm8731_priv
*wm8731
= codec
->private_data
;
345 wm8731
->sysclk
= freq
;
352 static int wm8731_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
355 struct snd_soc_codec
*codec
= codec_dai
->codec
;
358 /* set master/slave audio interface */
359 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
360 case SND_SOC_DAIFMT_CBM_CFM
:
363 case SND_SOC_DAIFMT_CBS_CFS
:
369 /* interface format */
370 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
371 case SND_SOC_DAIFMT_I2S
:
374 case SND_SOC_DAIFMT_RIGHT_J
:
376 case SND_SOC_DAIFMT_LEFT_J
:
379 case SND_SOC_DAIFMT_DSP_A
:
382 case SND_SOC_DAIFMT_DSP_B
:
389 /* clock inversion */
390 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
391 case SND_SOC_DAIFMT_NB_NF
:
393 case SND_SOC_DAIFMT_IB_IF
:
396 case SND_SOC_DAIFMT_IB_NF
:
399 case SND_SOC_DAIFMT_NB_IF
:
407 wm8731_write(codec
, WM8731_IFACE
, iface
);
411 static int wm8731_set_bias_level(struct snd_soc_codec
*codec
,
412 enum snd_soc_bias_level level
)
414 u16 reg
= wm8731_read_reg_cache(codec
, WM8731_PWR
) & 0xff7f;
417 case SND_SOC_BIAS_ON
:
418 /* vref/mid, osc on, dac unmute */
419 wm8731_write(codec
, WM8731_PWR
, reg
);
421 case SND_SOC_BIAS_PREPARE
:
423 case SND_SOC_BIAS_STANDBY
:
424 /* everything off except vref/vmid, */
425 wm8731_write(codec
, WM8731_PWR
, reg
| 0x0040);
427 case SND_SOC_BIAS_OFF
:
428 /* everything off, dac mute, inactive */
429 wm8731_write(codec
, WM8731_ACTIVE
, 0x0);
430 wm8731_write(codec
, WM8731_PWR
, 0xffff);
433 codec
->bias_level
= level
;
437 #define WM8731_RATES (SNDRV_PCM_RATE_8000 | SNDRV_PCM_RATE_11025 |\
438 SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 |\
439 SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
440 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
441 SNDRV_PCM_RATE_96000)
443 #define WM8731_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
444 SNDRV_PCM_FMTBIT_S24_LE)
446 struct snd_soc_dai wm8731_dai
= {
449 .stream_name
= "Playback",
452 .rates
= WM8731_RATES
,
453 .formats
= WM8731_FORMATS
,},
455 .stream_name
= "Capture",
458 .rates
= WM8731_RATES
,
459 .formats
= WM8731_FORMATS
,},
461 .prepare
= wm8731_pcm_prepare
,
462 .hw_params
= wm8731_hw_params
,
463 .shutdown
= wm8731_shutdown
,
466 .digital_mute
= wm8731_mute
,
467 .set_sysclk
= wm8731_set_dai_sysclk
,
468 .set_fmt
= wm8731_set_dai_fmt
,
471 EXPORT_SYMBOL_GPL(wm8731_dai
);
473 static int wm8731_suspend(struct platform_device
*pdev
, pm_message_t state
)
475 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
476 struct snd_soc_codec
*codec
= socdev
->codec
;
478 wm8731_write(codec
, WM8731_ACTIVE
, 0x0);
479 wm8731_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
483 static int wm8731_resume(struct platform_device
*pdev
)
485 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
486 struct snd_soc_codec
*codec
= socdev
->codec
;
489 u16
*cache
= codec
->reg_cache
;
491 /* Sync reg_cache with the hardware */
492 for (i
= 0; i
< ARRAY_SIZE(wm8731_reg
); i
++) {
493 data
[0] = (i
<< 1) | ((cache
[i
] >> 8) & 0x0001);
494 data
[1] = cache
[i
] & 0x00ff;
495 codec
->hw_write(codec
->control_data
, data
, 2);
497 wm8731_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
498 wm8731_set_bias_level(codec
, codec
->suspend_bias_level
);
503 * initialise the WM8731 driver
504 * register the mixer and dsp interfaces with the kernel
506 static int wm8731_init(struct snd_soc_device
*socdev
)
508 struct snd_soc_codec
*codec
= socdev
->codec
;
511 codec
->name
= "WM8731";
512 codec
->owner
= THIS_MODULE
;
513 codec
->read
= wm8731_read_reg_cache
;
514 codec
->write
= wm8731_write
;
515 codec
->set_bias_level
= wm8731_set_bias_level
;
516 codec
->dai
= &wm8731_dai
;
518 codec
->reg_cache_size
= ARRAY_SIZE(wm8731_reg
);
519 codec
->reg_cache
= kmemdup(wm8731_reg
, sizeof(wm8731_reg
), GFP_KERNEL
);
520 if (codec
->reg_cache
== NULL
)
526 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
528 printk(KERN_ERR
"wm8731: failed to create pcms\n");
532 /* power on device */
533 wm8731_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
535 /* set the update bits */
536 reg
= wm8731_read_reg_cache(codec
, WM8731_LOUT1V
);
537 wm8731_write(codec
, WM8731_LOUT1V
, reg
& ~0x0100);
538 reg
= wm8731_read_reg_cache(codec
, WM8731_ROUT1V
);
539 wm8731_write(codec
, WM8731_ROUT1V
, reg
& ~0x0100);
540 reg
= wm8731_read_reg_cache(codec
, WM8731_LINVOL
);
541 wm8731_write(codec
, WM8731_LINVOL
, reg
& ~0x0100);
542 reg
= wm8731_read_reg_cache(codec
, WM8731_RINVOL
);
543 wm8731_write(codec
, WM8731_RINVOL
, reg
& ~0x0100);
545 wm8731_add_controls(codec
);
546 wm8731_add_widgets(codec
);
547 ret
= snd_soc_register_card(socdev
);
549 printk(KERN_ERR
"wm8731: failed to register card\n");
556 snd_soc_free_pcms(socdev
);
557 snd_soc_dapm_free(socdev
);
559 kfree(codec
->reg_cache
);
563 static struct snd_soc_device
*wm8731_socdev
;
565 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
568 * WM8731 2 wire address is determined by GPIO5
569 * state during powerup.
573 static unsigned short normal_i2c
[] = { 0, I2C_CLIENT_END
};
575 /* Magic definition of all other variables and things */
578 static struct i2c_driver wm8731_i2c_driver
;
579 static struct i2c_client client_template
;
581 /* If the i2c layer weren't so broken, we could pass this kind of data
584 static int wm8731_codec_probe(struct i2c_adapter
*adap
, int addr
, int kind
)
586 struct snd_soc_device
*socdev
= wm8731_socdev
;
587 struct wm8731_setup_data
*setup
= socdev
->codec_data
;
588 struct snd_soc_codec
*codec
= socdev
->codec
;
589 struct i2c_client
*i2c
;
592 if (addr
!= setup
->i2c_address
)
595 client_template
.adapter
= adap
;
596 client_template
.addr
= addr
;
598 i2c
= kmemdup(&client_template
, sizeof(client_template
), GFP_KERNEL
);
603 i2c_set_clientdata(i2c
, codec
);
604 codec
->control_data
= i2c
;
606 ret
= i2c_attach_client(i2c
);
608 pr_err("failed to attach codec at addr %x\n", addr
);
612 ret
= wm8731_init(socdev
);
614 pr_err("failed to initialise WM8731\n");
625 static int wm8731_i2c_detach(struct i2c_client
*client
)
627 struct snd_soc_codec
*codec
= i2c_get_clientdata(client
);
628 i2c_detach_client(client
);
629 kfree(codec
->reg_cache
);
634 static int wm8731_i2c_attach(struct i2c_adapter
*adap
)
636 return i2c_probe(adap
, &addr_data
, wm8731_codec_probe
);
639 /* corgi i2c codec control layer */
640 static struct i2c_driver wm8731_i2c_driver
= {
642 .name
= "WM8731 I2C Codec",
643 .owner
= THIS_MODULE
,
645 .id
= I2C_DRIVERID_WM8731
,
646 .attach_adapter
= wm8731_i2c_attach
,
647 .detach_client
= wm8731_i2c_detach
,
651 static struct i2c_client client_template
= {
653 .driver
= &wm8731_i2c_driver
,
657 static int wm8731_probe(struct platform_device
*pdev
)
659 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
660 struct wm8731_setup_data
*setup
;
661 struct snd_soc_codec
*codec
;
662 struct wm8731_priv
*wm8731
;
665 pr_info("WM8731 Audio Codec %s", WM8731_VERSION
);
667 setup
= socdev
->codec_data
;
668 codec
= kzalloc(sizeof(struct snd_soc_codec
), GFP_KERNEL
);
672 wm8731
= kzalloc(sizeof(struct wm8731_priv
), GFP_KERNEL
);
673 if (wm8731
== NULL
) {
678 codec
->private_data
= wm8731
;
679 socdev
->codec
= codec
;
680 mutex_init(&codec
->mutex
);
681 INIT_LIST_HEAD(&codec
->dapm_widgets
);
682 INIT_LIST_HEAD(&codec
->dapm_paths
);
684 wm8731_socdev
= socdev
;
685 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
686 if (setup
->i2c_address
) {
687 normal_i2c
[0] = setup
->i2c_address
;
688 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
689 ret
= i2c_add_driver(&wm8731_i2c_driver
);
691 printk(KERN_ERR
"can't add i2c driver");
694 /* Add other interfaces here */
699 /* power down chip */
700 static int wm8731_remove(struct platform_device
*pdev
)
702 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
703 struct snd_soc_codec
*codec
= socdev
->codec
;
705 if (codec
->control_data
)
706 wm8731_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
708 snd_soc_free_pcms(socdev
);
709 snd_soc_dapm_free(socdev
);
710 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
711 i2c_del_driver(&wm8731_i2c_driver
);
713 kfree(codec
->private_data
);
719 struct snd_soc_codec_device soc_codec_dev_wm8731
= {
720 .probe
= wm8731_probe
,
721 .remove
= wm8731_remove
,
722 .suspend
= wm8731_suspend
,
723 .resume
= wm8731_resume
,
725 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8731
);
727 MODULE_DESCRIPTION("ASoC WM8731 driver");
728 MODULE_AUTHOR("Richard Purdie");
729 MODULE_LICENSE("GPL");