2 * wm8523.c -- WM8523 ALSA SoC Audio driver
4 * Copyright 2009 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@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/regulator/consumer.h>
21 #include <linux/slab.h>
22 #include <linux/of_device.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/initval.h>
28 #include <sound/tlv.h>
32 #define WM8523_NUM_SUPPLIES 2
33 static const char *wm8523_supply_names[WM8523_NUM_SUPPLIES] = {
38 #define WM8523_NUM_RATES 7
40 /* codec private data */
42 enum snd_soc_control_type control_type;
43 struct regulator_bulk_data supplies[WM8523_NUM_SUPPLIES];
45 unsigned int rate_constraint_list[WM8523_NUM_RATES];
46 struct snd_pcm_hw_constraint_list rate_constraint;
49 static const u16 wm8523_reg[WM8523_REGISTER_COUNT] = {
50 0x8523, /* R0 - DEVICE_ID */
51 0x0001, /* R1 - REVISION */
52 0x0000, /* R2 - PSCTRL1 */
53 0x1812, /* R3 - AIF_CTRL1 */
54 0x0000, /* R4 - AIF_CTRL2 */
55 0x0001, /* R5 - DAC_CTRL3 */
56 0x0190, /* R6 - DAC_GAINL */
57 0x0190, /* R7 - DAC_GAINR */
58 0x0000, /* R8 - ZERO_DETECT */
61 static int wm8523_volatile_register(struct snd_soc_codec *codec, unsigned int reg)
64 case WM8523_DEVICE_ID:
72 static int wm8523_reset(struct snd_soc_codec *codec)
74 return snd_soc_write(codec, WM8523_DEVICE_ID, 0);
77 static const DECLARE_TLV_DB_SCALE(dac_tlv, -10000, 25, 0);
79 static const char *wm8523_zd_count_text[] = {
84 static const struct soc_enum wm8523_zc_count =
85 SOC_ENUM_SINGLE(WM8523_ZERO_DETECT, 0, 2, wm8523_zd_count_text);
87 static const struct snd_kcontrol_new wm8523_controls[] = {
88 SOC_DOUBLE_R_TLV("Playback Volume", WM8523_DAC_GAINL, WM8523_DAC_GAINR,
90 SOC_SINGLE("ZC Switch", WM8523_DAC_CTRL3, 4, 1, 0),
91 SOC_SINGLE("Playback Deemphasis Switch", WM8523_AIF_CTRL1, 8, 1, 0),
92 SOC_DOUBLE("Playback Switch", WM8523_DAC_CTRL3, 2, 3, 1, 1),
93 SOC_SINGLE("Volume Ramp Up Switch", WM8523_DAC_CTRL3, 1, 1, 0),
94 SOC_SINGLE("Volume Ramp Down Switch", WM8523_DAC_CTRL3, 0, 1, 0),
95 SOC_ENUM("Zero Detect Count", wm8523_zc_count),
98 static const struct snd_soc_dapm_widget wm8523_dapm_widgets[] = {
99 SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
100 SND_SOC_DAPM_OUTPUT("LINEVOUTL"),
101 SND_SOC_DAPM_OUTPUT("LINEVOUTR"),
104 static const struct snd_soc_dapm_route wm8523_dapm_routes[] = {
105 { "LINEVOUTL", NULL, "DAC" },
106 { "LINEVOUTR", NULL, "DAC" },
112 } lrclk_ratios[WM8523_NUM_RATES] = {
122 static int wm8523_startup(struct snd_pcm_substream *substream,
123 struct snd_soc_dai *dai)
125 struct snd_soc_codec *codec = dai->codec;
126 struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
128 /* The set of sample rates that can be supported depends on the
129 * MCLK supplied to the CODEC - enforce this.
131 if (!wm8523->sysclk) {
133 "No MCLK configured, call set_sysclk() on init\n");
137 snd_pcm_hw_constraint_list(substream->runtime, 0,
138 SNDRV_PCM_HW_PARAM_RATE,
139 &wm8523->rate_constraint);
144 static int wm8523_hw_params(struct snd_pcm_substream *substream,
145 struct snd_pcm_hw_params *params,
146 struct snd_soc_dai *dai)
148 struct snd_soc_codec *codec = dai->codec;
149 struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
151 u16 aifctrl1 = snd_soc_read(codec, WM8523_AIF_CTRL1);
152 u16 aifctrl2 = snd_soc_read(codec, WM8523_AIF_CTRL2);
154 /* Find a supported LRCLK ratio */
155 for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
156 if (wm8523->sysclk / params_rate(params) ==
157 lrclk_ratios[i].ratio)
161 /* Should never happen, should be handled by constraints */
162 if (i == ARRAY_SIZE(lrclk_ratios)) {
163 dev_err(codec->dev, "MCLK/fs ratio %d unsupported\n",
164 wm8523->sysclk / params_rate(params));
168 aifctrl2 &= ~WM8523_SR_MASK;
169 aifctrl2 |= lrclk_ratios[i].value;
171 aifctrl1 &= ~WM8523_WL_MASK;
172 switch (params_format(params)) {
173 case SNDRV_PCM_FORMAT_S16_LE:
175 case SNDRV_PCM_FORMAT_S20_3LE:
178 case SNDRV_PCM_FORMAT_S24_LE:
181 case SNDRV_PCM_FORMAT_S32_LE:
186 snd_soc_write(codec, WM8523_AIF_CTRL1, aifctrl1);
187 snd_soc_write(codec, WM8523_AIF_CTRL2, aifctrl2);
192 static int wm8523_set_dai_sysclk(struct snd_soc_dai *codec_dai,
193 int clk_id, unsigned int freq, int dir)
195 struct snd_soc_codec *codec = codec_dai->codec;
196 struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
200 wm8523->sysclk = freq;
202 wm8523->rate_constraint.count = 0;
203 for (i = 0; i < ARRAY_SIZE(lrclk_ratios); i++) {
204 val = freq / lrclk_ratios[i].ratio;
205 /* Check that it's a standard rate since core can't
206 * cope with others and having the odd rates confuses
207 * constraint matching.
222 dev_dbg(codec->dev, "Supported sample rate: %dHz\n",
224 wm8523->rate_constraint_list[i] = val;
225 wm8523->rate_constraint.count++;
228 dev_dbg(codec->dev, "Skipping sample rate: %dHz\n",
233 /* Need at least one supported rate... */
234 if (wm8523->rate_constraint.count == 0)
241 static int wm8523_set_dai_fmt(struct snd_soc_dai *codec_dai,
244 struct snd_soc_codec *codec = codec_dai->codec;
245 u16 aifctrl1 = snd_soc_read(codec, WM8523_AIF_CTRL1);
247 aifctrl1 &= ~(WM8523_BCLK_INV_MASK | WM8523_LRCLK_INV_MASK |
248 WM8523_FMT_MASK | WM8523_AIF_MSTR_MASK);
250 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
251 case SND_SOC_DAIFMT_CBM_CFM:
252 aifctrl1 |= WM8523_AIF_MSTR;
254 case SND_SOC_DAIFMT_CBS_CFS:
260 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
261 case SND_SOC_DAIFMT_I2S:
264 case SND_SOC_DAIFMT_RIGHT_J:
266 case SND_SOC_DAIFMT_LEFT_J:
269 case SND_SOC_DAIFMT_DSP_A:
272 case SND_SOC_DAIFMT_DSP_B:
279 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
280 case SND_SOC_DAIFMT_NB_NF:
282 case SND_SOC_DAIFMT_IB_IF:
283 aifctrl1 |= WM8523_BCLK_INV | WM8523_LRCLK_INV;
285 case SND_SOC_DAIFMT_IB_NF:
286 aifctrl1 |= WM8523_BCLK_INV;
288 case SND_SOC_DAIFMT_NB_IF:
289 aifctrl1 |= WM8523_LRCLK_INV;
295 snd_soc_write(codec, WM8523_AIF_CTRL1, aifctrl1);
300 static int wm8523_set_bias_level(struct snd_soc_codec *codec,
301 enum snd_soc_bias_level level)
303 struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
304 u16 *reg_cache = codec->reg_cache;
308 case SND_SOC_BIAS_ON:
311 case SND_SOC_BIAS_PREPARE:
313 snd_soc_update_bits(codec, WM8523_PSCTRL1,
314 WM8523_SYS_ENA_MASK, 3);
317 case SND_SOC_BIAS_STANDBY:
318 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
319 ret = regulator_bulk_enable(ARRAY_SIZE(wm8523->supplies),
323 "Failed to enable supplies: %d\n",
328 /* Initial power up */
329 snd_soc_update_bits(codec, WM8523_PSCTRL1,
330 WM8523_SYS_ENA_MASK, 1);
332 /* Sync back default/cached values */
333 for (i = WM8523_AIF_CTRL1;
334 i < WM8523_MAX_REGISTER; i++)
335 snd_soc_write(codec, i, reg_cache[i]);
341 /* Power up to mute */
342 snd_soc_update_bits(codec, WM8523_PSCTRL1,
343 WM8523_SYS_ENA_MASK, 2);
347 case SND_SOC_BIAS_OFF:
348 /* The chip runs through the power down sequence for us. */
349 snd_soc_update_bits(codec, WM8523_PSCTRL1,
350 WM8523_SYS_ENA_MASK, 0);
353 regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies),
357 codec->dapm.bias_level = level;
361 #define WM8523_RATES SNDRV_PCM_RATE_8000_192000
363 #define WM8523_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
364 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
366 static const struct snd_soc_dai_ops wm8523_dai_ops = {
367 .startup = wm8523_startup,
368 .hw_params = wm8523_hw_params,
369 .set_sysclk = wm8523_set_dai_sysclk,
370 .set_fmt = wm8523_set_dai_fmt,
373 static struct snd_soc_dai_driver wm8523_dai = {
374 .name = "wm8523-hifi",
376 .stream_name = "Playback",
377 .channels_min = 2, /* Mono modes not yet supported */
379 .rates = WM8523_RATES,
380 .formats = WM8523_FORMATS,
382 .ops = &wm8523_dai_ops,
386 static int wm8523_suspend(struct snd_soc_codec *codec)
388 wm8523_set_bias_level(codec, SND_SOC_BIAS_OFF);
392 static int wm8523_resume(struct snd_soc_codec *codec)
394 wm8523_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
398 #define wm8523_suspend NULL
399 #define wm8523_resume NULL
402 static int wm8523_probe(struct snd_soc_codec *codec)
404 struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
407 wm8523->rate_constraint.list = &wm8523->rate_constraint_list[0];
408 wm8523->rate_constraint.count =
409 ARRAY_SIZE(wm8523->rate_constraint_list);
411 ret = snd_soc_codec_set_cache_io(codec, 8, 16, wm8523->control_type);
413 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
417 for (i = 0; i < ARRAY_SIZE(wm8523->supplies); i++)
418 wm8523->supplies[i].supply = wm8523_supply_names[i];
420 ret = regulator_bulk_get(codec->dev, ARRAY_SIZE(wm8523->supplies),
423 dev_err(codec->dev, "Failed to request supplies: %d\n", ret);
427 ret = regulator_bulk_enable(ARRAY_SIZE(wm8523->supplies),
430 dev_err(codec->dev, "Failed to enable supplies: %d\n", ret);
434 ret = snd_soc_read(codec, WM8523_DEVICE_ID);
436 dev_err(codec->dev, "Failed to read ID register\n");
439 if (ret != wm8523_reg[WM8523_DEVICE_ID]) {
440 dev_err(codec->dev, "Device is not a WM8523, ID is %x\n", ret);
445 ret = snd_soc_read(codec, WM8523_REVISION);
447 dev_err(codec->dev, "Failed to read revision register\n");
450 dev_info(codec->dev, "revision %c\n",
451 (ret & WM8523_CHIP_REV_MASK) + 'A');
453 ret = wm8523_reset(codec);
455 dev_err(codec->dev, "Failed to issue reset\n");
459 /* Change some default settings - latch VU and enable ZC */
460 snd_soc_update_bits(codec, WM8523_DAC_GAINR,
461 WM8523_DACR_VU, WM8523_DACR_VU);
462 snd_soc_update_bits(codec, WM8523_DAC_CTRL3, WM8523_ZC, WM8523_ZC);
464 wm8523_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
466 /* Bias level configuration will have done an extra enable */
467 regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
472 regulator_bulk_disable(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
474 regulator_bulk_free(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
479 static int wm8523_remove(struct snd_soc_codec *codec)
481 struct wm8523_priv *wm8523 = snd_soc_codec_get_drvdata(codec);
483 wm8523_set_bias_level(codec, SND_SOC_BIAS_OFF);
484 regulator_bulk_free(ARRAY_SIZE(wm8523->supplies), wm8523->supplies);
488 static struct snd_soc_codec_driver soc_codec_dev_wm8523 = {
489 .probe = wm8523_probe,
490 .remove = wm8523_remove,
491 .suspend = wm8523_suspend,
492 .resume = wm8523_resume,
493 .set_bias_level = wm8523_set_bias_level,
494 .reg_cache_size = WM8523_REGISTER_COUNT,
495 .reg_word_size = sizeof(u16),
496 .reg_cache_default = wm8523_reg,
497 .volatile_register = wm8523_volatile_register,
499 .controls = wm8523_controls,
500 .num_controls = ARRAY_SIZE(wm8523_controls),
501 .dapm_widgets = wm8523_dapm_widgets,
502 .num_dapm_widgets = ARRAY_SIZE(wm8523_dapm_widgets),
503 .dapm_routes = wm8523_dapm_routes,
504 .num_dapm_routes = ARRAY_SIZE(wm8523_dapm_routes),
507 static const struct of_device_id wm8523_of_match[] = {
508 { .compatible = "wlf,wm8523" },
512 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
513 static __devinit int wm8523_i2c_probe(struct i2c_client *i2c,
514 const struct i2c_device_id *id)
516 struct wm8523_priv *wm8523;
519 wm8523 = kzalloc(sizeof(struct wm8523_priv), GFP_KERNEL);
523 i2c_set_clientdata(i2c, wm8523);
524 wm8523->control_type = SND_SOC_I2C;
526 ret = snd_soc_register_codec(&i2c->dev,
527 &soc_codec_dev_wm8523, &wm8523_dai, 1);
534 static __devexit int wm8523_i2c_remove(struct i2c_client *client)
536 snd_soc_unregister_codec(&client->dev);
537 kfree(i2c_get_clientdata(client));
541 static const struct i2c_device_id wm8523_i2c_id[] = {
545 MODULE_DEVICE_TABLE(i2c, wm8523_i2c_id);
547 static struct i2c_driver wm8523_i2c_driver = {
550 .owner = THIS_MODULE,
551 .of_match_table = wm8523_of_match,
553 .probe = wm8523_i2c_probe,
554 .remove = __devexit_p(wm8523_i2c_remove),
555 .id_table = wm8523_i2c_id,
559 static int __init wm8523_modinit(void)
562 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
563 ret = i2c_add_driver(&wm8523_i2c_driver);
565 printk(KERN_ERR "Failed to register WM8523 I2C driver: %d\n",
571 module_init(wm8523_modinit);
573 static void __exit wm8523_exit(void)
575 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
576 i2c_del_driver(&wm8523_i2c_driver);
579 module_exit(wm8523_exit);
581 MODULE_DESCRIPTION("ASoC WM8523 driver");
582 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
583 MODULE_LICENSE("GPL");