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
));
114 /* codec mclk clock divider coefficients */
115 static const struct _coeff_div coeff_div
[] = {
117 {12288000, 48000, 256, 0x0, 0x0, 0x0},
118 {18432000, 48000, 384, 0x0, 0x1, 0x0},
119 {12000000, 48000, 250, 0x0, 0x0, 0x1},
122 {12288000, 32000, 384, 0x6, 0x0, 0x0},
123 {18432000, 32000, 576, 0x6, 0x1, 0x0},
124 {12000000, 32000, 375, 0x6, 0x0, 0x1},
127 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
128 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
129 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
130 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
131 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
134 {12288000, 96000, 128, 0x7, 0x0, 0x0},
135 {18432000, 96000, 192, 0x7, 0x1, 0x0},
136 {12000000, 96000, 125, 0x7, 0x0, 0x1},
139 {11289600, 44100, 256, 0x8, 0x0, 0x0},
140 {16934400, 44100, 384, 0x8, 0x1, 0x0},
141 {12000000, 44100, 272, 0x8, 0x1, 0x1},
144 {11289600, 88200, 128, 0xf, 0x0, 0x0},
145 {16934400, 88200, 192, 0xf, 0x1, 0x0},
146 {12000000, 88200, 136, 0xf, 0x1, 0x1},
149 static inline int get_coeff(int mclk
, int rate
)
153 for (i
= 0; i
< ARRAY_SIZE(coeff_div
); i
++) {
154 if (coeff_div
[i
].rate
== rate
&& coeff_div
[i
].mclk
== mclk
)
160 static int wm8711_hw_params(struct snd_pcm_substream
*substream
,
161 struct snd_pcm_hw_params
*params
,
162 struct snd_soc_dai
*dai
)
164 struct snd_soc_codec
*codec
= dai
->codec
;
165 struct wm8711_priv
*wm8711
= codec
->private_data
;
166 u16 iface
= snd_soc_read(codec
, WM8711_IFACE
) & 0xfffc;
167 int i
= get_coeff(wm8711
->sysclk
, params_rate(params
));
168 u16 srate
= (coeff_div
[i
].sr
<< 2) |
169 (coeff_div
[i
].bosr
<< 1) | coeff_div
[i
].usb
;
171 snd_soc_write(codec
, WM8711_SRATE
, srate
);
174 switch (params_format(params
)) {
175 case SNDRV_PCM_FORMAT_S16_LE
:
177 case SNDRV_PCM_FORMAT_S20_3LE
:
180 case SNDRV_PCM_FORMAT_S24_LE
:
185 snd_soc_write(codec
, WM8711_IFACE
, iface
);
189 static int wm8711_pcm_prepare(struct snd_pcm_substream
*substream
,
190 struct snd_soc_dai
*dai
)
192 struct snd_soc_codec
*codec
= dai
->codec
;
195 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0001);
200 static void wm8711_shutdown(struct snd_pcm_substream
*substream
,
201 struct snd_soc_dai
*dai
)
203 struct snd_soc_codec
*codec
= dai
->codec
;
206 if (!codec
->active
) {
208 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0);
212 static int wm8711_mute(struct snd_soc_dai
*dai
, int mute
)
214 struct snd_soc_codec
*codec
= dai
->codec
;
215 u16 mute_reg
= snd_soc_read(codec
, WM8711_APDIGI
) & 0xfff7;
218 snd_soc_write(codec
, WM8711_APDIGI
, mute_reg
| 0x8);
220 snd_soc_write(codec
, WM8711_APDIGI
, mute_reg
);
225 static int wm8711_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
226 int clk_id
, unsigned int freq
, int dir
)
228 struct snd_soc_codec
*codec
= codec_dai
->codec
;
229 struct wm8711_priv
*wm8711
= codec
->private_data
;
237 wm8711
->sysclk
= freq
;
243 static int wm8711_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
246 struct snd_soc_codec
*codec
= codec_dai
->codec
;
249 /* set master/slave audio interface */
250 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
251 case SND_SOC_DAIFMT_CBM_CFM
:
254 case SND_SOC_DAIFMT_CBS_CFS
:
260 /* interface format */
261 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
262 case SND_SOC_DAIFMT_I2S
:
265 case SND_SOC_DAIFMT_RIGHT_J
:
267 case SND_SOC_DAIFMT_LEFT_J
:
270 case SND_SOC_DAIFMT_DSP_A
:
273 case SND_SOC_DAIFMT_DSP_B
:
280 /* clock inversion */
281 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
282 case SND_SOC_DAIFMT_NB_NF
:
284 case SND_SOC_DAIFMT_IB_IF
:
287 case SND_SOC_DAIFMT_IB_NF
:
290 case SND_SOC_DAIFMT_NB_IF
:
298 snd_soc_write(codec
, WM8711_IFACE
, iface
);
303 static int wm8711_set_bias_level(struct snd_soc_codec
*codec
,
304 enum snd_soc_bias_level level
)
306 u16 reg
= snd_soc_read(codec
, WM8711_PWR
) & 0xff7f;
309 case SND_SOC_BIAS_ON
:
310 snd_soc_write(codec
, WM8711_PWR
, reg
);
312 case SND_SOC_BIAS_PREPARE
:
314 case SND_SOC_BIAS_STANDBY
:
315 snd_soc_write(codec
, WM8711_PWR
, reg
| 0x0040);
317 case SND_SOC_BIAS_OFF
:
318 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0);
319 snd_soc_write(codec
, WM8711_PWR
, 0xffff);
322 codec
->bias_level
= level
;
326 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000
328 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
329 SNDRV_PCM_FMTBIT_S24_LE)
331 static struct snd_soc_dai_ops wm8711_ops
= {
332 .prepare
= wm8711_pcm_prepare
,
333 .hw_params
= wm8711_hw_params
,
334 .shutdown
= wm8711_shutdown
,
335 .digital_mute
= wm8711_mute
,
336 .set_sysclk
= wm8711_set_dai_sysclk
,
337 .set_fmt
= wm8711_set_dai_fmt
,
340 struct snd_soc_dai wm8711_dai
= {
343 .stream_name
= "Playback",
346 .rates
= WM8711_RATES
,
347 .formats
= WM8711_FORMATS
,
351 EXPORT_SYMBOL_GPL(wm8711_dai
);
353 static int wm8711_suspend(struct platform_device
*pdev
, pm_message_t state
)
355 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
356 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
358 snd_soc_write(codec
, WM8711_ACTIVE
, 0x0);
359 wm8711_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
363 static int wm8711_resume(struct platform_device
*pdev
)
365 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
366 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
369 u16
*cache
= codec
->reg_cache
;
371 /* Sync reg_cache with the hardware */
372 for (i
= 0; i
< ARRAY_SIZE(wm8711_reg
); i
++) {
373 data
[0] = (i
<< 1) | ((cache
[i
] >> 8) & 0x0001);
374 data
[1] = cache
[i
] & 0x00ff;
375 codec
->hw_write(codec
->control_data
, data
, 2);
377 wm8711_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
378 wm8711_set_bias_level(codec
, codec
->suspend_bias_level
);
382 static int wm8711_probe(struct platform_device
*pdev
)
384 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
385 struct snd_soc_codec
*codec
;
388 if (wm8711_codec
== NULL
) {
389 dev_err(&pdev
->dev
, "Codec device not registered\n");
393 socdev
->card
->codec
= wm8711_codec
;
394 codec
= wm8711_codec
;
397 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
399 dev_err(codec
->dev
, "failed to create pcms: %d\n", ret
);
403 snd_soc_add_controls(codec
, wm8711_snd_controls
,
404 ARRAY_SIZE(wm8711_snd_controls
));
405 wm8711_add_widgets(codec
);
413 /* power down chip */
414 static int wm8711_remove(struct platform_device
*pdev
)
416 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
418 snd_soc_free_pcms(socdev
);
419 snd_soc_dapm_free(socdev
);
424 struct snd_soc_codec_device soc_codec_dev_wm8711
= {
425 .probe
= wm8711_probe
,
426 .remove
= wm8711_remove
,
427 .suspend
= wm8711_suspend
,
428 .resume
= wm8711_resume
,
430 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8711
);
432 static int wm8711_register(struct wm8711_priv
*wm8711
,
433 enum snd_soc_control_type control
)
436 struct snd_soc_codec
*codec
= &wm8711
->codec
;
440 dev_err(codec
->dev
, "Another WM8711 is registered\n");
444 mutex_init(&codec
->mutex
);
445 INIT_LIST_HEAD(&codec
->dapm_widgets
);
446 INIT_LIST_HEAD(&codec
->dapm_paths
);
448 codec
->private_data
= wm8711
;
449 codec
->name
= "WM8711";
450 codec
->owner
= THIS_MODULE
;
451 codec
->bias_level
= SND_SOC_BIAS_OFF
;
452 codec
->set_bias_level
= wm8711_set_bias_level
;
453 codec
->dai
= &wm8711_dai
;
455 codec
->reg_cache_size
= WM8711_CACHEREGNUM
;
456 codec
->reg_cache
= &wm8711
->reg_cache
;
458 memcpy(codec
->reg_cache
, wm8711_reg
, sizeof(wm8711_reg
));
460 ret
= snd_soc_codec_set_cache_io(codec
, 7, 9, control
);
462 dev_err(codec
->dev
, "Failed to set cache I/O: %d\n", ret
);
466 ret
= wm8711_reset(codec
);
468 dev_err(codec
->dev
, "Failed to issue reset\n");
472 wm8711_dai
.dev
= codec
->dev
;
474 wm8711_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
476 /* Latch the update bits */
477 reg
= snd_soc_read(codec
, WM8711_LOUT1V
);
478 snd_soc_write(codec
, WM8711_LOUT1V
, reg
| 0x0100);
479 reg
= snd_soc_read(codec
, WM8711_ROUT1V
);
480 snd_soc_write(codec
, WM8711_ROUT1V
, reg
| 0x0100);
482 wm8711_codec
= codec
;
484 ret
= snd_soc_register_codec(codec
);
486 dev_err(codec
->dev
, "Failed to register codec: %d\n", ret
);
490 ret
= snd_soc_register_dai(&wm8711_dai
);
492 dev_err(codec
->dev
, "Failed to register DAI: %d\n", ret
);
499 snd_soc_unregister_codec(codec
);
505 static void wm8711_unregister(struct wm8711_priv
*wm8711
)
507 wm8711_set_bias_level(&wm8711
->codec
, SND_SOC_BIAS_OFF
);
508 snd_soc_unregister_dai(&wm8711_dai
);
509 snd_soc_unregister_codec(&wm8711
->codec
);
514 #if defined(CONFIG_SPI_MASTER)
515 static int __devinit
wm8711_spi_probe(struct spi_device
*spi
)
517 struct snd_soc_codec
*codec
;
518 struct wm8711_priv
*wm8711
;
520 wm8711
= kzalloc(sizeof(struct wm8711_priv
), GFP_KERNEL
);
524 codec
= &wm8711
->codec
;
525 codec
->control_data
= spi
;
526 codec
->dev
= &spi
->dev
;
528 dev_set_drvdata(&spi
->dev
, wm8711
);
530 return wm8711_register(wm8711
, SND_SOC_SPI
);
533 static int __devexit
wm8711_spi_remove(struct spi_device
*spi
)
535 struct wm8711_priv
*wm8711
= dev_get_drvdata(&spi
->dev
);
537 wm8711_unregister(wm8711
);
542 static struct spi_driver wm8711_spi_driver
= {
545 .bus
= &spi_bus_type
,
546 .owner
= THIS_MODULE
,
548 .probe
= wm8711_spi_probe
,
549 .remove
= __devexit_p(wm8711_spi_remove
),
551 #endif /* CONFIG_SPI_MASTER */
553 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
554 static __devinit
int wm8711_i2c_probe(struct i2c_client
*i2c
,
555 const struct i2c_device_id
*id
)
557 struct wm8711_priv
*wm8711
;
558 struct snd_soc_codec
*codec
;
560 wm8711
= kzalloc(sizeof(struct wm8711_priv
), GFP_KERNEL
);
564 codec
= &wm8711
->codec
;
565 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
567 i2c_set_clientdata(i2c
, wm8711
);
568 codec
->control_data
= i2c
;
570 codec
->dev
= &i2c
->dev
;
572 return wm8711_register(wm8711
, SND_SOC_I2C
);
575 static __devexit
int wm8711_i2c_remove(struct i2c_client
*client
)
577 struct wm8711_priv
*wm8711
= i2c_get_clientdata(client
);
578 wm8711_unregister(wm8711
);
582 static const struct i2c_device_id wm8711_i2c_id
[] = {
586 MODULE_DEVICE_TABLE(i2c
, wm8711_i2c_id
);
588 static struct i2c_driver wm8711_i2c_driver
= {
590 .name
= "WM8711 I2C Codec",
591 .owner
= THIS_MODULE
,
593 .probe
= wm8711_i2c_probe
,
594 .remove
= __devexit_p(wm8711_i2c_remove
),
595 .id_table
= wm8711_i2c_id
,
599 static int __init
wm8711_modinit(void)
602 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
603 ret
= i2c_add_driver(&wm8711_i2c_driver
);
605 printk(KERN_ERR
"Failed to register WM8711 I2C driver: %d\n",
609 #if defined(CONFIG_SPI_MASTER)
610 ret
= spi_register_driver(&wm8711_spi_driver
);
612 printk(KERN_ERR
"Failed to register WM8711 SPI driver: %d\n",
618 module_init(wm8711_modinit
);
620 static void __exit
wm8711_exit(void)
622 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
623 i2c_del_driver(&wm8711_i2c_driver
);
625 #if defined(CONFIG_SPI_MASTER)
626 spi_unregister_driver(&wm8711_spi_driver
);
629 module_exit(wm8711_exit
);
631 MODULE_DESCRIPTION("ASoC WM8711 driver");
632 MODULE_AUTHOR("Mike Arthur");
633 MODULE_LICENSE("GPL");