2 * wm8776.c -- WM8776 ALSA SoC Audio driver
4 * Copyright 2009 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
12 * TODO: Input ALC/limiter support
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 <linux/slab.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
27 #include <sound/soc.h>
28 #include <sound/soc-dapm.h>
29 #include <sound/initval.h>
30 #include <sound/tlv.h>
34 static struct snd_soc_codec
*wm8776_codec
;
35 struct snd_soc_codec_device soc_codec_dev_wm8776
;
37 /* codec private data */
39 struct snd_soc_codec codec
;
40 u16 reg_cache
[WM8776_CACHEREGNUM
];
44 #ifdef CONFIG_SPI_MASTER
45 static int wm8776_spi_write(struct spi_device
*spi
, const char *data
, int len
);
48 static const u16 wm8776_reg
[WM8776_CACHEREGNUM
] = {
49 0x79, 0x79, 0x79, 0xff, 0xff, /* 4 */
50 0xff, 0x00, 0x90, 0x00, 0x00, /* 9 */
51 0x22, 0x22, 0x22, 0x08, 0xcf, /* 14 */
52 0xcf, 0x7b, 0x00, 0x32, 0x00, /* 19 */
56 static int wm8776_reset(struct snd_soc_codec
*codec
)
58 return snd_soc_write(codec
, WM8776_RESET
, 0);
61 static const DECLARE_TLV_DB_SCALE(hp_tlv
, -12100, 100, 1);
62 static const DECLARE_TLV_DB_SCALE(dac_tlv
, -12750, 50, 1);
63 static const DECLARE_TLV_DB_SCALE(adc_tlv
, -10350, 50, 1);
65 static const struct snd_kcontrol_new wm8776_snd_controls
[] = {
66 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8776_HPLVOL
, WM8776_HPRVOL
,
68 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8776_DACLVOL
, WM8776_DACRVOL
,
70 SOC_SINGLE("Digital Playback ZC Switch", WM8776_DACCTRL1
, 0, 1, 0),
72 SOC_SINGLE("Deemphasis Switch", WM8776_DACCTRL2
, 0, 1, 0),
74 SOC_DOUBLE_R_TLV("Capture Volume", WM8776_ADCLVOL
, WM8776_ADCRVOL
,
76 SOC_DOUBLE("Capture Switch", WM8776_ADCMUX
, 7, 6, 1, 1),
77 SOC_DOUBLE_R("Capture ZC Switch", WM8776_ADCLVOL
, WM8776_ADCRVOL
, 8, 1, 0),
78 SOC_SINGLE("Capture HPF Switch", WM8776_ADCIFCTRL
, 8, 1, 1),
81 static const struct snd_kcontrol_new inmix_controls
[] = {
82 SOC_DAPM_SINGLE("AIN1 Switch", WM8776_ADCMUX
, 0, 1, 0),
83 SOC_DAPM_SINGLE("AIN2 Switch", WM8776_ADCMUX
, 1, 1, 0),
84 SOC_DAPM_SINGLE("AIN3 Switch", WM8776_ADCMUX
, 2, 1, 0),
85 SOC_DAPM_SINGLE("AIN4 Switch", WM8776_ADCMUX
, 3, 1, 0),
86 SOC_DAPM_SINGLE("AIN5 Switch", WM8776_ADCMUX
, 4, 1, 0),
89 static const struct snd_kcontrol_new outmix_controls
[] = {
90 SOC_DAPM_SINGLE("DAC Switch", WM8776_OUTMUX
, 0, 1, 0),
91 SOC_DAPM_SINGLE("AUX Switch", WM8776_OUTMUX
, 1, 1, 0),
92 SOC_DAPM_SINGLE("Bypass Switch", WM8776_OUTMUX
, 2, 1, 0),
95 static const struct snd_soc_dapm_widget wm8776_dapm_widgets
[] = {
96 SND_SOC_DAPM_INPUT("AUX"),
98 SND_SOC_DAPM_INPUT("AIN1"),
99 SND_SOC_DAPM_INPUT("AIN2"),
100 SND_SOC_DAPM_INPUT("AIN3"),
101 SND_SOC_DAPM_INPUT("AIN4"),
102 SND_SOC_DAPM_INPUT("AIN5"),
104 SND_SOC_DAPM_MIXER("Input Mixer", WM8776_PWRDOWN
, 6, 1,
105 inmix_controls
, ARRAY_SIZE(inmix_controls
)),
107 SND_SOC_DAPM_ADC("ADC", "Capture", WM8776_PWRDOWN
, 1, 1),
108 SND_SOC_DAPM_DAC("DAC", "Playback", WM8776_PWRDOWN
, 2, 1),
110 SND_SOC_DAPM_MIXER("Output Mixer", SND_SOC_NOPM
, 0, 0,
111 outmix_controls
, ARRAY_SIZE(outmix_controls
)),
113 SND_SOC_DAPM_PGA("Headphone PGA", WM8776_PWRDOWN
, 3, 1, NULL
, 0),
115 SND_SOC_DAPM_OUTPUT("VOUT"),
117 SND_SOC_DAPM_OUTPUT("HPOUTL"),
118 SND_SOC_DAPM_OUTPUT("HPOUTR"),
121 static const struct snd_soc_dapm_route routes
[] = {
122 { "Input Mixer", "AIN1 Switch", "AIN1" },
123 { "Input Mixer", "AIN2 Switch", "AIN2" },
124 { "Input Mixer", "AIN3 Switch", "AIN3" },
125 { "Input Mixer", "AIN4 Switch", "AIN4" },
126 { "Input Mixer", "AIN5 Switch", "AIN5" },
128 { "ADC", NULL
, "Input Mixer" },
130 { "Output Mixer", "DAC Switch", "DAC" },
131 { "Output Mixer", "AUX Switch", "AUX" },
132 { "Output Mixer", "Bypass Switch", "Input Mixer" },
134 { "VOUT", NULL
, "Output Mixer" },
136 { "Headphone PGA", NULL
, "Output Mixer" },
138 { "HPOUTL", NULL
, "Headphone PGA" },
139 { "HPOUTR", NULL
, "Headphone PGA" },
142 static int wm8776_set_fmt(struct snd_soc_dai
*dai
, unsigned int fmt
)
144 struct snd_soc_codec
*codec
= dai
->codec
;
145 int reg
, iface
, master
;
149 reg
= WM8776_DACIFCTRL
;
153 reg
= WM8776_ADCIFCTRL
;
162 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
163 case SND_SOC_DAIFMT_CBM_CFM
:
165 case SND_SOC_DAIFMT_CBS_CFS
:
172 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
173 case SND_SOC_DAIFMT_I2S
:
176 case SND_SOC_DAIFMT_RIGHT_J
:
178 case SND_SOC_DAIFMT_LEFT_J
:
185 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
186 case SND_SOC_DAIFMT_NB_NF
:
188 case SND_SOC_DAIFMT_IB_IF
:
191 case SND_SOC_DAIFMT_IB_NF
:
194 case SND_SOC_DAIFMT_NB_IF
:
201 /* Finally, write out the values */
202 snd_soc_update_bits(codec
, reg
, 0xf, iface
);
203 snd_soc_update_bits(codec
, WM8776_MSTRCTRL
, 0x180, master
);
208 static int mclk_ratios
[] = {
217 static int wm8776_hw_params(struct snd_pcm_substream
*substream
,
218 struct snd_pcm_hw_params
*params
,
219 struct snd_soc_dai
*dai
)
221 struct snd_soc_codec
*codec
= dai
->codec
;
222 struct wm8776_priv
*wm8776
= snd_soc_codec_get_drvdata(codec
);
223 int iface_reg
, iface
;
224 int ratio_shift
, master
;
231 iface_reg
= WM8776_DACIFCTRL
;
236 iface_reg
= WM8776_ADCIFCTRL
;
245 /* Set word length */
246 switch (params_format(params
)) {
247 case SNDRV_PCM_FORMAT_S16_LE
:
249 case SNDRV_PCM_FORMAT_S20_3LE
:
252 case SNDRV_PCM_FORMAT_S24_LE
:
255 case SNDRV_PCM_FORMAT_S32_LE
:
260 /* Only need to set MCLK/LRCLK ratio if we're master */
261 if (snd_soc_read(codec
, WM8776_MSTRCTRL
) & master
) {
262 for (i
= 0; i
< ARRAY_SIZE(mclk_ratios
); i
++) {
263 if (wm8776
->sysclk
[dai
->id
] / params_rate(params
)
268 if (i
== ARRAY_SIZE(mclk_ratios
)) {
270 "Unable to configure MCLK ratio %d/%d\n",
271 wm8776
->sysclk
[dai
->id
], params_rate(params
));
275 dev_dbg(codec
->dev
, "MCLK is %dfs\n", mclk_ratios
[i
]);
277 snd_soc_update_bits(codec
, WM8776_MSTRCTRL
,
278 0x7 << ratio_shift
, i
<< ratio_shift
);
280 dev_dbg(codec
->dev
, "DAI in slave mode\n");
283 snd_soc_update_bits(codec
, iface_reg
, 0x30, iface
);
288 static int wm8776_mute(struct snd_soc_dai
*dai
, int mute
)
290 struct snd_soc_codec
*codec
= dai
->codec
;
292 return snd_soc_write(codec
, WM8776_DACMUTE
, !!mute
);
295 static int wm8776_set_sysclk(struct snd_soc_dai
*dai
,
296 int clk_id
, unsigned int freq
, int dir
)
298 struct snd_soc_codec
*codec
= dai
->codec
;
299 struct wm8776_priv
*wm8776
= snd_soc_codec_get_drvdata(codec
);
301 BUG_ON(dai
->id
>= ARRAY_SIZE(wm8776
->sysclk
));
303 wm8776
->sysclk
[dai
->id
] = freq
;
308 static int wm8776_set_bias_level(struct snd_soc_codec
*codec
,
309 enum snd_soc_bias_level level
)
312 case SND_SOC_BIAS_ON
:
314 case SND_SOC_BIAS_PREPARE
:
316 case SND_SOC_BIAS_STANDBY
:
317 if (codec
->bias_level
== SND_SOC_BIAS_OFF
) {
318 /* Disable the global powerdown; DAPM does the rest */
319 snd_soc_update_bits(codec
, WM8776_PWRDOWN
, 1, 0);
323 case SND_SOC_BIAS_OFF
:
324 snd_soc_update_bits(codec
, WM8776_PWRDOWN
, 1, 1);
328 codec
->bias_level
= level
;
332 #define WM8776_RATES (SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 |\
333 SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_88200 |\
334 SNDRV_PCM_RATE_96000)
337 #define WM8776_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
338 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
340 static struct snd_soc_dai_ops wm8776_dac_ops
= {
341 .digital_mute
= wm8776_mute
,
342 .hw_params
= wm8776_hw_params
,
343 .set_fmt
= wm8776_set_fmt
,
344 .set_sysclk
= wm8776_set_sysclk
,
347 static struct snd_soc_dai_ops wm8776_adc_ops
= {
348 .hw_params
= wm8776_hw_params
,
349 .set_fmt
= wm8776_set_fmt
,
350 .set_sysclk
= wm8776_set_sysclk
,
353 struct snd_soc_dai wm8776_dai
[] = {
355 .name
= "WM8776 Playback",
356 .id
= WM8776_DAI_DAC
,
358 .stream_name
= "Playback",
361 .rates
= WM8776_RATES
,
362 .formats
= WM8776_FORMATS
,
364 .ops
= &wm8776_dac_ops
,
367 .name
= "WM8776 Capture",
368 .id
= WM8776_DAI_ADC
,
370 .stream_name
= "Capture",
373 .rates
= WM8776_RATES
,
374 .formats
= WM8776_FORMATS
,
376 .ops
= &wm8776_adc_ops
,
379 EXPORT_SYMBOL_GPL(wm8776_dai
);
382 static int wm8776_suspend(struct platform_device
*pdev
, pm_message_t state
)
384 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
385 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
387 wm8776_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
392 static int wm8776_resume(struct platform_device
*pdev
)
394 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
395 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
398 u16
*cache
= codec
->reg_cache
;
400 /* Sync reg_cache with the hardware */
401 for (i
= 0; i
< ARRAY_SIZE(wm8776_reg
); i
++) {
402 if (cache
[i
] == wm8776_reg
[i
])
404 data
[0] = (i
<< 1) | ((cache
[i
] >> 8) & 0x0001);
405 data
[1] = cache
[i
] & 0x00ff;
406 codec
->hw_write(codec
->control_data
, data
, 2);
409 wm8776_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
414 #define wm8776_suspend NULL
415 #define wm8776_resume NULL
418 static int wm8776_probe(struct platform_device
*pdev
)
420 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
421 struct snd_soc_codec
*codec
;
424 if (wm8776_codec
== NULL
) {
425 dev_err(&pdev
->dev
, "Codec device not registered\n");
429 socdev
->card
->codec
= wm8776_codec
;
430 codec
= wm8776_codec
;
433 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
435 dev_err(codec
->dev
, "failed to create pcms: %d\n", ret
);
439 snd_soc_add_controls(codec
, wm8776_snd_controls
,
440 ARRAY_SIZE(wm8776_snd_controls
));
441 snd_soc_dapm_new_controls(codec
, wm8776_dapm_widgets
,
442 ARRAY_SIZE(wm8776_dapm_widgets
));
443 snd_soc_dapm_add_routes(codec
, routes
, ARRAY_SIZE(routes
));
451 /* power down chip */
452 static int wm8776_remove(struct platform_device
*pdev
)
454 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
456 snd_soc_free_pcms(socdev
);
457 snd_soc_dapm_free(socdev
);
462 struct snd_soc_codec_device soc_codec_dev_wm8776
= {
463 .probe
= wm8776_probe
,
464 .remove
= wm8776_remove
,
465 .suspend
= wm8776_suspend
,
466 .resume
= wm8776_resume
,
468 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8776
);
470 static int wm8776_register(struct wm8776_priv
*wm8776
,
471 enum snd_soc_control_type control
)
474 struct snd_soc_codec
*codec
= &wm8776
->codec
;
477 dev_err(codec
->dev
, "Another WM8776 is registered\n");
482 mutex_init(&codec
->mutex
);
483 INIT_LIST_HEAD(&codec
->dapm_widgets
);
484 INIT_LIST_HEAD(&codec
->dapm_paths
);
486 snd_soc_codec_set_drvdata(codec
, wm8776
);
487 codec
->name
= "WM8776";
488 codec
->owner
= THIS_MODULE
;
489 codec
->bias_level
= SND_SOC_BIAS_OFF
;
490 codec
->set_bias_level
= wm8776_set_bias_level
;
491 codec
->dai
= wm8776_dai
;
492 codec
->num_dai
= ARRAY_SIZE(wm8776_dai
);
493 codec
->reg_cache_size
= WM8776_CACHEREGNUM
;
494 codec
->reg_cache
= &wm8776
->reg_cache
;
496 memcpy(codec
->reg_cache
, wm8776_reg
, sizeof(wm8776_reg
));
498 ret
= snd_soc_codec_set_cache_io(codec
, 7, 9, control
);
500 dev_err(codec
->dev
, "Failed to set cache I/O: %d\n", ret
);
504 for (i
= 0; i
< ARRAY_SIZE(wm8776_dai
); i
++)
505 wm8776_dai
[i
].dev
= codec
->dev
;
507 ret
= wm8776_reset(codec
);
509 dev_err(codec
->dev
, "Failed to issue reset: %d\n", ret
);
513 wm8776_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
515 /* Latch the update bits; right channel only since we always
517 snd_soc_update_bits(codec
, WM8776_HPRVOL
, 0x100, 0x100);
518 snd_soc_update_bits(codec
, WM8776_DACRVOL
, 0x100, 0x100);
520 wm8776_codec
= codec
;
522 ret
= snd_soc_register_codec(codec
);
524 dev_err(codec
->dev
, "Failed to register codec: %d\n", ret
);
528 ret
= snd_soc_register_dais(wm8776_dai
, ARRAY_SIZE(wm8776_dai
));
530 dev_err(codec
->dev
, "Failed to register DAIs: %d\n", ret
);
537 snd_soc_unregister_codec(codec
);
543 static void wm8776_unregister(struct wm8776_priv
*wm8776
)
545 wm8776_set_bias_level(&wm8776
->codec
, SND_SOC_BIAS_OFF
);
546 snd_soc_unregister_dais(wm8776_dai
, ARRAY_SIZE(wm8776_dai
));
547 snd_soc_unregister_codec(&wm8776
->codec
);
552 #if defined(CONFIG_SPI_MASTER)
553 static int wm8776_spi_write(struct spi_device
*spi
, const char *data
, int len
)
555 struct spi_transfer t
;
556 struct spi_message m
;
565 spi_message_init(&m
);
566 memset(&t
, 0, (sizeof t
));
571 spi_message_add_tail(&t
, &m
);
577 static int __devinit
wm8776_spi_probe(struct spi_device
*spi
)
579 struct snd_soc_codec
*codec
;
580 struct wm8776_priv
*wm8776
;
582 wm8776
= kzalloc(sizeof(struct wm8776_priv
), GFP_KERNEL
);
586 codec
= &wm8776
->codec
;
587 codec
->control_data
= spi
;
588 codec
->hw_write
= (hw_write_t
)wm8776_spi_write
;
589 codec
->dev
= &spi
->dev
;
591 dev_set_drvdata(&spi
->dev
, wm8776
);
593 return wm8776_register(wm8776
, SND_SOC_SPI
);
596 static int __devexit
wm8776_spi_remove(struct spi_device
*spi
)
598 struct wm8776_priv
*wm8776
= dev_get_drvdata(&spi
->dev
);
600 wm8776_unregister(wm8776
);
605 static struct spi_driver wm8776_spi_driver
= {
608 .bus
= &spi_bus_type
,
609 .owner
= THIS_MODULE
,
611 .probe
= wm8776_spi_probe
,
612 .remove
= __devexit_p(wm8776_spi_remove
),
614 #endif /* CONFIG_SPI_MASTER */
616 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
617 static __devinit
int wm8776_i2c_probe(struct i2c_client
*i2c
,
618 const struct i2c_device_id
*id
)
620 struct wm8776_priv
*wm8776
;
621 struct snd_soc_codec
*codec
;
623 wm8776
= kzalloc(sizeof(struct wm8776_priv
), GFP_KERNEL
);
627 codec
= &wm8776
->codec
;
628 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
630 i2c_set_clientdata(i2c
, wm8776
);
631 codec
->control_data
= i2c
;
633 codec
->dev
= &i2c
->dev
;
635 return wm8776_register(wm8776
, SND_SOC_I2C
);
638 static __devexit
int wm8776_i2c_remove(struct i2c_client
*client
)
640 struct wm8776_priv
*wm8776
= i2c_get_clientdata(client
);
641 wm8776_unregister(wm8776
);
645 static const struct i2c_device_id wm8776_i2c_id
[] = {
649 MODULE_DEVICE_TABLE(i2c
, wm8776_i2c_id
);
651 static struct i2c_driver wm8776_i2c_driver
= {
654 .owner
= THIS_MODULE
,
656 .probe
= wm8776_i2c_probe
,
657 .remove
= __devexit_p(wm8776_i2c_remove
),
658 .id_table
= wm8776_i2c_id
,
662 static int __init
wm8776_modinit(void)
665 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
666 ret
= i2c_add_driver(&wm8776_i2c_driver
);
668 printk(KERN_ERR
"Failed to register WM8776 I2C driver: %d\n",
672 #if defined(CONFIG_SPI_MASTER)
673 ret
= spi_register_driver(&wm8776_spi_driver
);
675 printk(KERN_ERR
"Failed to register WM8776 SPI driver: %d\n",
681 module_init(wm8776_modinit
);
683 static void __exit
wm8776_exit(void)
685 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
686 i2c_del_driver(&wm8776_i2c_driver
);
688 #if defined(CONFIG_SPI_MASTER)
689 spi_unregister_driver(&wm8776_spi_driver
);
692 module_exit(wm8776_exit
);
694 MODULE_DESCRIPTION("ASoC WM8776 driver");
695 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
696 MODULE_LICENSE("GPL");