2 * wm8711.c -- WM8711 ALSA SoC Audio driver
4 * Copyright 2006 Wolfson Microelectronics
6 * Author: Mike Arthur <linux@wolfsonmicro.com>
8 * Based on wm8731.c by Richard Purdie
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 <linux/spi/spi.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc.h>
27 #include <sound/soc-dapm.h>
28 #include <sound/tlv.h>
29 #include <sound/initval.h>
33 static struct snd_soc_codec
*wm8711_codec
;
35 /* codec private data */
37 struct snd_soc_codec codec
;
38 u16 reg_cache
[WM8711_CACHEREGNUM
];
43 * wm8711 register cache
44 * We can't read the WM8711 register space when we are
45 * using 2 wire for device control, so we cache them instead.
46 * There is no point in caching the reset register
48 static const u16 wm8711_reg
[WM8711_CACHEREGNUM
] = {
49 0x0079, 0x0079, 0x000a, 0x0008,
50 0x009f, 0x000a, 0x0000, 0x0000
53 #define wm8711_reset(c) snd_soc_write(c, WM8711_RESET, 0)
55 static const DECLARE_TLV_DB_SCALE(out_tlv
, -12100, 100, 1);
57 static const struct snd_kcontrol_new wm8711_snd_controls
[] = {
59 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8711_LOUT1V
, WM8711_ROUT1V
,
61 SOC_DOUBLE_R("Master Playback ZC Switch", WM8711_LOUT1V
, WM8711_ROUT1V
,
67 static const struct snd_kcontrol_new wm8711_output_mixer_controls
[] = {
68 SOC_DAPM_SINGLE("Line Bypass Switch", WM8711_APANA
, 3, 1, 0),
69 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8711_APANA
, 4, 1, 0),
72 static const struct snd_soc_dapm_widget wm8711_dapm_widgets
[] = {
73 SND_SOC_DAPM_MIXER("Output Mixer", WM8711_PWR
, 4, 1,
74 &wm8711_output_mixer_controls
[0],
75 ARRAY_SIZE(wm8711_output_mixer_controls
)),
76 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8711_PWR
, 3, 1),
77 SND_SOC_DAPM_OUTPUT("LOUT"),
78 SND_SOC_DAPM_OUTPUT("LHPOUT"),
79 SND_SOC_DAPM_OUTPUT("ROUT"),
80 SND_SOC_DAPM_OUTPUT("RHPOUT"),
83 static const struct snd_soc_dapm_route intercon
[] = {
85 {"Output Mixer", "Line Bypass Switch", "Line Input"},
86 {"Output Mixer", "HiFi Playback Switch", "DAC"},
89 {"RHPOUT", NULL
, "Output Mixer"},
90 {"ROUT", NULL
, "Output Mixer"},
91 {"LHPOUT", NULL
, "Output Mixer"},
92 {"LOUT", NULL
, "Output Mixer"},
95 static int wm8711_add_widgets(struct snd_soc_codec
*codec
)
97 snd_soc_dapm_new_controls(codec
, wm8711_dapm_widgets
,
98 ARRAY_SIZE(wm8711_dapm_widgets
));
100 snd_soc_dapm_add_routes(codec
, intercon
, ARRAY_SIZE(intercon
));
102 snd_soc_dapm_new_widgets(codec
);
115 /* codec mclk clock divider coefficients */
116 static const struct _coeff_div coeff_div
[] = {
118 {12288000, 48000, 256, 0x0, 0x0, 0x0},
119 {18432000, 48000, 384, 0x0, 0x1, 0x0},
120 {12000000, 48000, 250, 0x0, 0x0, 0x1},
123 {12288000, 32000, 384, 0x6, 0x0, 0x0},
124 {18432000, 32000, 576, 0x6, 0x1, 0x0},
125 {12000000, 32000, 375, 0x6, 0x0, 0x1},
128 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
129 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
130 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
131 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
132 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
135 {12288000, 96000, 128, 0x7, 0x0, 0x0},
136 {18432000, 96000, 192, 0x7, 0x1, 0x0},
137 {12000000, 96000, 125, 0x7, 0x0, 0x1},
140 {11289600, 44100, 256, 0x8, 0x0, 0x0},
141 {16934400, 44100, 384, 0x8, 0x1, 0x0},
142 {12000000, 44100, 272, 0x8, 0x1, 0x1},
145 {11289600, 88200, 128, 0xf, 0x0, 0x0},
146 {16934400, 88200, 192, 0xf, 0x1, 0x0},
147 {12000000, 88200, 136, 0xf, 0x1, 0x1},
150 static inline int get_coeff(int mclk
, int rate
)
154 for (i
= 0; i
< ARRAY_SIZE(coeff_div
); i
++) {
155 if (coeff_div
[i
].rate
== rate
&& coeff_div
[i
].mclk
== mclk
)
161 static int wm8711_hw_params(struct snd_pcm_substream
*substream
,
162 struct snd_pcm_hw_params
*params
,
163 struct snd_soc_dai
*dai
)
165 struct snd_soc_codec
*codec
= dai
->codec
;
166 struct wm8711_priv
*wm8711
= codec
->private_data
;
167 u16 iface
= snd_soc_read(codec
, WM8711_IFACE
) & 0xfffc;
168 int i
= get_coeff(wm8711
->sysclk
, params_rate(params
));
169 u16 srate
= (coeff_div
[i
].sr
<< 2) |
170 (coeff_div
[i
].bosr
<< 1) | coeff_div
[i
].usb
;
172 snd_soc_write(codec
, WM8711_SRATE
, srate
);
175 switch (params_format(params
)) {
176 case SNDRV_PCM_FORMAT_S16_LE
:
178 case SNDRV_PCM_FORMAT_S20_3LE
:
181 case SNDRV_PCM_FORMAT_S24_LE
:
186 snd_soc_write(codec
, WM8711_IFACE
, iface
);
190 static int wm8711_pcm_prepare(struct snd_pcm_substream
*substream
,
191 struct snd_soc_dai
*dai
)
193 struct snd_soc_codec
*codec
= dai
->codec
;
196 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0001);
201 static void wm8711_shutdown(struct snd_pcm_substream
*substream
,
202 struct snd_soc_dai
*dai
)
204 struct snd_soc_codec
*codec
= dai
->codec
;
207 if (!codec
->active
) {
209 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0);
213 static int wm8711_mute(struct snd_soc_dai
*dai
, int mute
)
215 struct snd_soc_codec
*codec
= dai
->codec
;
216 u16 mute_reg
= snd_soc_read(codec
, WM8711_APDIGI
) & 0xfff7;
219 snd_soc_write(codec
, WM8711_APDIGI
, mute_reg
| 0x8);
221 snd_soc_write(codec
, WM8711_APDIGI
, mute_reg
);
226 static int wm8711_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
227 int clk_id
, unsigned int freq
, int dir
)
229 struct snd_soc_codec
*codec
= codec_dai
->codec
;
230 struct wm8711_priv
*wm8711
= codec
->private_data
;
238 wm8711
->sysclk
= freq
;
244 static int wm8711_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
247 struct snd_soc_codec
*codec
= codec_dai
->codec
;
250 /* set master/slave audio interface */
251 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
252 case SND_SOC_DAIFMT_CBM_CFM
:
255 case SND_SOC_DAIFMT_CBS_CFS
:
261 /* interface format */
262 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
263 case SND_SOC_DAIFMT_I2S
:
266 case SND_SOC_DAIFMT_RIGHT_J
:
268 case SND_SOC_DAIFMT_LEFT_J
:
271 case SND_SOC_DAIFMT_DSP_A
:
274 case SND_SOC_DAIFMT_DSP_B
:
281 /* clock inversion */
282 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
283 case SND_SOC_DAIFMT_NB_NF
:
285 case SND_SOC_DAIFMT_IB_IF
:
288 case SND_SOC_DAIFMT_IB_NF
:
291 case SND_SOC_DAIFMT_NB_IF
:
299 snd_soc_write(codec
, WM8711_IFACE
, iface
);
304 static int wm8711_set_bias_level(struct snd_soc_codec
*codec
,
305 enum snd_soc_bias_level level
)
307 u16 reg
= snd_soc_read(codec
, WM8711_PWR
) & 0xff7f;
310 case SND_SOC_BIAS_ON
:
311 snd_soc_write(codec
, WM8711_PWR
, reg
);
313 case SND_SOC_BIAS_PREPARE
:
315 case SND_SOC_BIAS_STANDBY
:
316 snd_soc_write(codec
, WM8711_PWR
, reg
| 0x0040);
318 case SND_SOC_BIAS_OFF
:
319 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0);
320 snd_soc_write(codec
, WM8711_PWR
, 0xffff);
323 codec
->bias_level
= level
;
327 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000
329 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
330 SNDRV_PCM_FMTBIT_S24_LE)
332 static struct snd_soc_dai_ops wm8711_ops
= {
333 .prepare
= wm8711_pcm_prepare
,
334 .hw_params
= wm8711_hw_params
,
335 .shutdown
= wm8711_shutdown
,
336 .digital_mute
= wm8711_mute
,
337 .set_sysclk
= wm8711_set_dai_sysclk
,
338 .set_fmt
= wm8711_set_dai_fmt
,
341 struct snd_soc_dai wm8711_dai
= {
344 .stream_name
= "Playback",
347 .rates
= WM8711_RATES
,
348 .formats
= WM8711_FORMATS
,
352 EXPORT_SYMBOL_GPL(wm8711_dai
);
354 static int wm8711_suspend(struct platform_device
*pdev
, pm_message_t state
)
356 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
357 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
359 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0);
360 wm8711_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
364 static int wm8711_resume(struct platform_device
*pdev
)
366 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
367 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
370 u16
*cache
= codec
->reg_cache
;
372 /* Sync reg_cache with the hardware */
373 for (i
= 0; i
< ARRAY_SIZE(wm8711_reg
); i
++) {
374 data
[0] = (i
<< 1) | ((cache
[i
] >> 8) & 0x0001);
375 data
[1] = cache
[i
] & 0x00ff;
376 codec
->hw_write(codec
->control_data
, data
, 2);
378 wm8711_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
379 wm8711_set_bias_level(codec
, codec
->suspend_bias_level
);
383 static int wm8711_probe(struct platform_device
*pdev
)
385 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
386 struct snd_soc_codec
*codec
;
389 if (wm8711_codec
== NULL
) {
390 dev_err(&pdev
->dev
, "Codec device not registered\n");
394 socdev
->card
->codec
= wm8711_codec
;
395 codec
= wm8711_codec
;
398 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
400 dev_err(codec
->dev
, "failed to create pcms: %d\n", ret
);
404 snd_soc_add_controls(codec
, wm8711_snd_controls
,
405 ARRAY_SIZE(wm8711_snd_controls
));
406 wm8711_add_widgets(codec
);
407 ret
= snd_soc_init_card(socdev
);
409 dev_err(codec
->dev
, "failed to register card: %d\n", ret
);
416 snd_soc_free_pcms(socdev
);
417 snd_soc_dapm_free(socdev
);
422 /* power down chip */
423 static int wm8711_remove(struct platform_device
*pdev
)
425 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
427 snd_soc_free_pcms(socdev
);
428 snd_soc_dapm_free(socdev
);
433 struct snd_soc_codec_device soc_codec_dev_wm8711
= {
434 .probe
= wm8711_probe
,
435 .remove
= wm8711_remove
,
436 .suspend
= wm8711_suspend
,
437 .resume
= wm8711_resume
,
439 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8711
);
441 static int wm8711_register(struct wm8711_priv
*wm8711
,
442 enum snd_soc_control_type control
)
445 struct snd_soc_codec
*codec
= &wm8711
->codec
;
449 dev_err(codec
->dev
, "Another WM8711 is registered\n");
453 mutex_init(&codec
->mutex
);
454 INIT_LIST_HEAD(&codec
->dapm_widgets
);
455 INIT_LIST_HEAD(&codec
->dapm_paths
);
457 codec
->private_data
= wm8711
;
458 codec
->name
= "WM8711";
459 codec
->owner
= THIS_MODULE
;
460 codec
->bias_level
= SND_SOC_BIAS_OFF
;
461 codec
->set_bias_level
= wm8711_set_bias_level
;
462 codec
->dai
= &wm8711_dai
;
464 codec
->reg_cache_size
= WM8711_CACHEREGNUM
;
465 codec
->reg_cache
= &wm8711
->reg_cache
;
467 memcpy(codec
->reg_cache
, wm8711_reg
, sizeof(wm8711_reg
));
469 ret
= snd_soc_codec_set_cache_io(codec
, 7, 9, control
);
471 dev_err(codec
->dev
, "Failed to set cache I/O: %d\n", ret
);
475 ret
= wm8711_reset(codec
);
477 dev_err(codec
->dev
, "Failed to issue reset\n");
481 wm8711_dai
.dev
= codec
->dev
;
483 wm8711_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
485 /* Latch the update bits */
486 reg
= snd_soc_read(codec
, WM8711_LOUT1V
);
487 snd_soc_write(codec
, WM8711_LOUT1V
, reg
| 0x0100);
488 reg
= snd_soc_read(codec
, WM8711_ROUT1V
);
489 snd_soc_write(codec
, WM8711_ROUT1V
, reg
| 0x0100);
491 wm8711_codec
= codec
;
493 ret
= snd_soc_register_codec(codec
);
495 dev_err(codec
->dev
, "Failed to register codec: %d\n", ret
);
499 ret
= snd_soc_register_dai(&wm8711_dai
);
501 dev_err(codec
->dev
, "Failed to register DAI: %d\n", ret
);
508 snd_soc_unregister_codec(codec
);
514 static void wm8711_unregister(struct wm8711_priv
*wm8711
)
516 wm8711_set_bias_level(&wm8711
->codec
, SND_SOC_BIAS_OFF
);
517 snd_soc_unregister_dai(&wm8711_dai
);
518 snd_soc_unregister_codec(&wm8711
->codec
);
523 #if defined(CONFIG_SPI_MASTER)
524 static int __devinit
wm8711_spi_probe(struct spi_device
*spi
)
526 struct snd_soc_codec
*codec
;
527 struct wm8711_priv
*wm8711
;
529 wm8711
= kzalloc(sizeof(struct wm8711_priv
), GFP_KERNEL
);
533 codec
= &wm8711
->codec
;
534 codec
->control_data
= spi
;
535 codec
->dev
= &spi
->dev
;
537 dev_set_drvdata(&spi
->dev
, wm8711
);
539 return wm8711_register(wm8711
, SND_SOC_SPI
);
542 static int __devexit
wm8711_spi_remove(struct spi_device
*spi
)
544 struct wm8711_priv
*wm8711
= dev_get_drvdata(&spi
->dev
);
546 wm8711_unregister(wm8711
);
552 static int wm8711_spi_suspend(struct spi_device
*spi
, pm_message_t msg
)
554 return snd_soc_suspend_device(&spi
->dev
);
557 static int wm8711_spi_resume(struct spi_device
*spi
)
559 return snd_soc_resume_device(&spi
->dev
);
562 #define wm8711_spi_suspend NULL
563 #define wm8711_spi_resume NULL
566 static struct spi_driver wm8711_spi_driver
= {
569 .bus
= &spi_bus_type
,
570 .owner
= THIS_MODULE
,
572 .probe
= wm8711_spi_probe
,
573 .suspend
= wm8711_spi_suspend
,
574 .resume
= wm8711_spi_resume
,
575 .remove
= __devexit_p(wm8711_spi_remove
),
577 #endif /* CONFIG_SPI_MASTER */
579 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
580 static __devinit
int wm8711_i2c_probe(struct i2c_client
*i2c
,
581 const struct i2c_device_id
*id
)
583 struct wm8711_priv
*wm8711
;
584 struct snd_soc_codec
*codec
;
586 wm8711
= kzalloc(sizeof(struct wm8711_priv
), GFP_KERNEL
);
590 codec
= &wm8711
->codec
;
591 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
593 i2c_set_clientdata(i2c
, wm8711
);
594 codec
->control_data
= i2c
;
596 codec
->dev
= &i2c
->dev
;
598 return wm8711_register(wm8711
, SND_SOC_I2C
);
601 static __devexit
int wm8711_i2c_remove(struct i2c_client
*client
)
603 struct wm8711_priv
*wm8711
= i2c_get_clientdata(client
);
604 wm8711_unregister(wm8711
);
608 static const struct i2c_device_id wm8711_i2c_id
[] = {
612 MODULE_DEVICE_TABLE(i2c
, wm8711_i2c_id
);
614 static struct i2c_driver wm8711_i2c_driver
= {
616 .name
= "WM8711 I2C Codec",
617 .owner
= THIS_MODULE
,
619 .probe
= wm8711_i2c_probe
,
620 .remove
= __devexit_p(wm8711_i2c_remove
),
621 .id_table
= wm8711_i2c_id
,
625 static int __init
wm8711_modinit(void)
628 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
629 ret
= i2c_add_driver(&wm8711_i2c_driver
);
631 printk(KERN_ERR
"Failed to register WM8711 I2C driver: %d\n",
635 #if defined(CONFIG_SPI_MASTER)
636 ret
= spi_register_driver(&wm8711_spi_driver
);
638 printk(KERN_ERR
"Failed to register WM8711 SPI driver: %d\n",
644 module_init(wm8711_modinit
);
646 static void __exit
wm8711_exit(void)
648 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
649 i2c_del_driver(&wm8711_i2c_driver
);
651 #if defined(CONFIG_SPI_MASTER)
652 spi_unregister_driver(&wm8711_spi_driver
);
655 module_exit(wm8711_exit
);
657 MODULE_DESCRIPTION("ASoC WM8711 driver");
658 MODULE_AUTHOR("Mike Arthur");
659 MODULE_LICENSE("GPL");