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/platform_device.h>
21 #include <linux/regulator/consumer.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>
28 #include <sound/tlv.h>
32 static struct snd_soc_codec
*wm8523_codec
;
33 struct snd_soc_codec_device soc_codec_dev_wm8523
;
35 #define WM8523_NUM_SUPPLIES 2
36 static const char *wm8523_supply_names
[WM8523_NUM_SUPPLIES
] = {
41 #define WM8523_NUM_RATES 7
43 /* codec private data */
45 struct snd_soc_codec codec
;
46 u16 reg_cache
[WM8523_REGISTER_COUNT
];
47 struct regulator_bulk_data supplies
[WM8523_NUM_SUPPLIES
];
49 unsigned int rate_constraint_list
[WM8523_NUM_RATES
];
50 struct snd_pcm_hw_constraint_list rate_constraint
;
53 static const u16 wm8523_reg
[WM8523_REGISTER_COUNT
] = {
54 0x8523, /* R0 - DEVICE_ID */
55 0x0001, /* R1 - REVISION */
56 0x0000, /* R2 - PSCTRL1 */
57 0x1812, /* R3 - AIF_CTRL1 */
58 0x0000, /* R4 - AIF_CTRL2 */
59 0x0001, /* R5 - DAC_CTRL3 */
60 0x0190, /* R6 - DAC_GAINL */
61 0x0190, /* R7 - DAC_GAINR */
62 0x0000, /* R8 - ZERO_DETECT */
65 static int wm8523_volatile_register(unsigned int reg
)
68 case WM8523_DEVICE_ID
:
76 static int wm8523_reset(struct snd_soc_codec
*codec
)
78 return snd_soc_write(codec
, WM8523_DEVICE_ID
, 0);
81 static const DECLARE_TLV_DB_SCALE(dac_tlv
, -10000, 25, 0);
83 static const char *wm8523_zd_count_text
[] = {
88 static const struct soc_enum wm8523_zc_count
=
89 SOC_ENUM_SINGLE(WM8523_ZERO_DETECT
, 0, 2, wm8523_zd_count_text
);
91 static const struct snd_kcontrol_new wm8523_snd_controls
[] = {
92 SOC_DOUBLE_R_TLV("Playback Volume", WM8523_DAC_GAINL
, WM8523_DAC_GAINR
,
94 SOC_SINGLE("ZC Switch", WM8523_DAC_CTRL3
, 4, 1, 0),
95 SOC_SINGLE("Playback Deemphasis Switch", WM8523_AIF_CTRL1
, 8, 1, 0),
96 SOC_DOUBLE("Playback Switch", WM8523_DAC_CTRL3
, 2, 3, 1, 1),
97 SOC_SINGLE("Volume Ramp Up Switch", WM8523_DAC_CTRL3
, 1, 1, 0),
98 SOC_SINGLE("Volume Ramp Down Switch", WM8523_DAC_CTRL3
, 0, 1, 0),
99 SOC_ENUM("Zero Detect Count", wm8523_zc_count
),
102 static const struct snd_soc_dapm_widget wm8523_dapm_widgets
[] = {
103 SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM
, 0, 0),
104 SND_SOC_DAPM_OUTPUT("LINEVOUTL"),
105 SND_SOC_DAPM_OUTPUT("LINEVOUTR"),
108 static const struct snd_soc_dapm_route intercon
[] = {
109 { "LINEVOUTL", NULL
, "DAC" },
110 { "LINEVOUTR", NULL
, "DAC" },
113 static int wm8523_add_widgets(struct snd_soc_codec
*codec
)
115 snd_soc_dapm_new_controls(codec
, wm8523_dapm_widgets
,
116 ARRAY_SIZE(wm8523_dapm_widgets
));
118 snd_soc_dapm_add_routes(codec
, intercon
, ARRAY_SIZE(intercon
));
126 } lrclk_ratios
[WM8523_NUM_RATES
] = {
136 static int wm8523_startup(struct snd_pcm_substream
*substream
,
137 struct snd_soc_dai
*dai
)
139 struct snd_soc_codec
*codec
= dai
->codec
;
140 struct wm8523_priv
*wm8523
= snd_soc_codec_get_drvdata(codec
);
142 /* The set of sample rates that can be supported depends on the
143 * MCLK supplied to the CODEC - enforce this.
145 if (!wm8523
->sysclk
) {
147 "No MCLK configured, call set_sysclk() on init\n");
152 snd_pcm_hw_constraint_list(substream
->runtime
, 0,
153 SNDRV_PCM_HW_PARAM_RATE
,
154 &wm8523
->rate_constraint
);
159 static int wm8523_hw_params(struct snd_pcm_substream
*substream
,
160 struct snd_pcm_hw_params
*params
,
161 struct snd_soc_dai
*dai
)
163 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
164 struct snd_soc_device
*socdev
= rtd
->socdev
;
165 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
166 struct wm8523_priv
*wm8523
= snd_soc_codec_get_drvdata(codec
);
168 u16 aifctrl1
= snd_soc_read(codec
, WM8523_AIF_CTRL1
);
169 u16 aifctrl2
= snd_soc_read(codec
, WM8523_AIF_CTRL2
);
171 /* Find a supported LRCLK ratio */
172 for (i
= 0; i
< ARRAY_SIZE(lrclk_ratios
); i
++) {
173 if (wm8523
->sysclk
/ params_rate(params
) ==
174 lrclk_ratios
[i
].ratio
)
178 /* Should never happen, should be handled by constraints */
179 if (i
== ARRAY_SIZE(lrclk_ratios
)) {
180 dev_err(codec
->dev
, "MCLK/fs ratio %d unsupported\n",
181 wm8523
->sysclk
/ params_rate(params
));
185 aifctrl2
&= ~WM8523_SR_MASK
;
186 aifctrl2
|= lrclk_ratios
[i
].value
;
188 aifctrl1
&= ~WM8523_WL_MASK
;
189 switch (params_format(params
)) {
190 case SNDRV_PCM_FORMAT_S16_LE
:
192 case SNDRV_PCM_FORMAT_S20_3LE
:
195 case SNDRV_PCM_FORMAT_S24_LE
:
198 case SNDRV_PCM_FORMAT_S32_LE
:
203 snd_soc_write(codec
, WM8523_AIF_CTRL1
, aifctrl1
);
204 snd_soc_write(codec
, WM8523_AIF_CTRL2
, aifctrl2
);
209 static int wm8523_set_dai_sysclk(struct snd_soc_dai
*codec_dai
,
210 int clk_id
, unsigned int freq
, int dir
)
212 struct snd_soc_codec
*codec
= codec_dai
->codec
;
213 struct wm8523_priv
*wm8523
= snd_soc_codec_get_drvdata(codec
);
217 wm8523
->sysclk
= freq
;
219 wm8523
->rate_constraint
.count
= 0;
220 for (i
= 0; i
< ARRAY_SIZE(lrclk_ratios
); i
++) {
221 val
= freq
/ lrclk_ratios
[i
].ratio
;
222 /* Check that it's a standard rate since core can't
223 * cope with others and having the odd rates confuses
224 * constraint matching.
239 dev_dbg(codec
->dev
, "Supported sample rate: %dHz\n",
241 wm8523
->rate_constraint_list
[i
] = val
;
242 wm8523
->rate_constraint
.count
++;
245 dev_dbg(codec
->dev
, "Skipping sample rate: %dHz\n",
250 /* Need at least one supported rate... */
251 if (wm8523
->rate_constraint
.count
== 0)
258 static int wm8523_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
261 struct snd_soc_codec
*codec
= codec_dai
->codec
;
262 u16 aifctrl1
= snd_soc_read(codec
, WM8523_AIF_CTRL1
);
264 aifctrl1
&= ~(WM8523_BCLK_INV_MASK
| WM8523_LRCLK_INV_MASK
|
265 WM8523_FMT_MASK
| WM8523_AIF_MSTR_MASK
);
267 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
268 case SND_SOC_DAIFMT_CBM_CFM
:
269 aifctrl1
|= WM8523_AIF_MSTR
;
271 case SND_SOC_DAIFMT_CBS_CFS
:
277 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
278 case SND_SOC_DAIFMT_I2S
:
281 case SND_SOC_DAIFMT_RIGHT_J
:
283 case SND_SOC_DAIFMT_LEFT_J
:
286 case SND_SOC_DAIFMT_DSP_A
:
289 case SND_SOC_DAIFMT_DSP_B
:
296 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
297 case SND_SOC_DAIFMT_NB_NF
:
299 case SND_SOC_DAIFMT_IB_IF
:
300 aifctrl1
|= WM8523_BCLK_INV
| WM8523_LRCLK_INV
;
302 case SND_SOC_DAIFMT_IB_NF
:
303 aifctrl1
|= WM8523_BCLK_INV
;
305 case SND_SOC_DAIFMT_NB_IF
:
306 aifctrl1
|= WM8523_LRCLK_INV
;
312 snd_soc_write(codec
, WM8523_AIF_CTRL1
, aifctrl1
);
317 static int wm8523_set_bias_level(struct snd_soc_codec
*codec
,
318 enum snd_soc_bias_level level
)
320 struct wm8523_priv
*wm8523
= snd_soc_codec_get_drvdata(codec
);
324 case SND_SOC_BIAS_ON
:
327 case SND_SOC_BIAS_PREPARE
:
329 snd_soc_update_bits(codec
, WM8523_PSCTRL1
,
330 WM8523_SYS_ENA_MASK
, 3);
333 case SND_SOC_BIAS_STANDBY
:
334 if (codec
->bias_level
== SND_SOC_BIAS_OFF
) {
335 ret
= regulator_bulk_enable(ARRAY_SIZE(wm8523
->supplies
),
339 "Failed to enable supplies: %d\n",
344 /* Initial power up */
345 snd_soc_update_bits(codec
, WM8523_PSCTRL1
,
346 WM8523_SYS_ENA_MASK
, 1);
348 /* Sync back default/cached values */
349 for (i
= WM8523_AIF_CTRL1
;
350 i
< WM8523_MAX_REGISTER
; i
++)
351 snd_soc_write(codec
, i
, wm8523
->reg_cache
[i
]);
357 /* Power up to mute */
358 snd_soc_update_bits(codec
, WM8523_PSCTRL1
,
359 WM8523_SYS_ENA_MASK
, 2);
363 case SND_SOC_BIAS_OFF
:
364 /* The chip runs through the power down sequence for us. */
365 snd_soc_update_bits(codec
, WM8523_PSCTRL1
,
366 WM8523_SYS_ENA_MASK
, 0);
369 regulator_bulk_disable(ARRAY_SIZE(wm8523
->supplies
),
373 codec
->bias_level
= level
;
377 #define WM8523_RATES SNDRV_PCM_RATE_8000_192000
379 #define WM8523_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
380 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
382 static struct snd_soc_dai_ops wm8523_dai_ops
= {
383 .startup
= wm8523_startup
,
384 .hw_params
= wm8523_hw_params
,
385 .set_sysclk
= wm8523_set_dai_sysclk
,
386 .set_fmt
= wm8523_set_dai_fmt
,
389 struct snd_soc_dai wm8523_dai
= {
392 .stream_name
= "Playback",
393 .channels_min
= 2, /* Mono modes not yet supported */
395 .rates
= WM8523_RATES
,
396 .formats
= WM8523_FORMATS
,
398 .ops
= &wm8523_dai_ops
,
400 EXPORT_SYMBOL_GPL(wm8523_dai
);
403 static int wm8523_suspend(struct platform_device
*pdev
, pm_message_t state
)
405 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
406 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
408 wm8523_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
412 static int wm8523_resume(struct platform_device
*pdev
)
414 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
415 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
417 wm8523_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
422 #define wm8523_suspend NULL
423 #define wm8523_resume NULL
426 static int wm8523_probe(struct platform_device
*pdev
)
428 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
429 struct snd_soc_codec
*codec
;
432 if (wm8523_codec
== NULL
) {
433 dev_err(&pdev
->dev
, "Codec device not registered\n");
437 socdev
->card
->codec
= wm8523_codec
;
438 codec
= wm8523_codec
;
441 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
443 dev_err(codec
->dev
, "failed to create pcms: %d\n", ret
);
447 snd_soc_add_controls(codec
, wm8523_snd_controls
,
448 ARRAY_SIZE(wm8523_snd_controls
));
449 wm8523_add_widgets(codec
);
457 static int wm8523_remove(struct platform_device
*pdev
)
459 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
461 snd_soc_free_pcms(socdev
);
462 snd_soc_dapm_free(socdev
);
467 struct snd_soc_codec_device soc_codec_dev_wm8523
= {
468 .probe
= wm8523_probe
,
469 .remove
= wm8523_remove
,
470 .suspend
= wm8523_suspend
,
471 .resume
= wm8523_resume
,
473 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8523
);
475 static int wm8523_register(struct wm8523_priv
*wm8523
,
476 enum snd_soc_control_type control
)
479 struct snd_soc_codec
*codec
= &wm8523
->codec
;
483 dev_err(codec
->dev
, "Another WM8523 is registered\n");
487 mutex_init(&codec
->mutex
);
488 INIT_LIST_HEAD(&codec
->dapm_widgets
);
489 INIT_LIST_HEAD(&codec
->dapm_paths
);
491 snd_soc_codec_set_drvdata(codec
, wm8523
);
492 codec
->name
= "WM8523";
493 codec
->owner
= THIS_MODULE
;
494 codec
->bias_level
= SND_SOC_BIAS_OFF
;
495 codec
->set_bias_level
= wm8523_set_bias_level
;
496 codec
->dai
= &wm8523_dai
;
498 codec
->reg_cache_size
= WM8523_REGISTER_COUNT
;
499 codec
->reg_cache
= &wm8523
->reg_cache
;
500 codec
->volatile_register
= wm8523_volatile_register
;
502 wm8523
->rate_constraint
.list
= &wm8523
->rate_constraint_list
[0];
503 wm8523
->rate_constraint
.count
=
504 ARRAY_SIZE(wm8523
->rate_constraint_list
);
506 memcpy(codec
->reg_cache
, wm8523_reg
, sizeof(wm8523_reg
));
508 ret
= snd_soc_codec_set_cache_io(codec
, 8, 16, control
);
510 dev_err(codec
->dev
, "Failed to set cache I/O: %d\n", ret
);
514 for (i
= 0; i
< ARRAY_SIZE(wm8523
->supplies
); i
++)
515 wm8523
->supplies
[i
].supply
= wm8523_supply_names
[i
];
517 ret
= regulator_bulk_get(codec
->dev
, ARRAY_SIZE(wm8523
->supplies
),
520 dev_err(codec
->dev
, "Failed to request supplies: %d\n", ret
);
524 ret
= regulator_bulk_enable(ARRAY_SIZE(wm8523
->supplies
),
527 dev_err(codec
->dev
, "Failed to enable supplies: %d\n", ret
);
531 ret
= snd_soc_read(codec
, WM8523_DEVICE_ID
);
533 dev_err(codec
->dev
, "Failed to read ID register\n");
536 if (ret
!= wm8523_reg
[WM8523_DEVICE_ID
]) {
537 dev_err(codec
->dev
, "Device is not a WM8523, ID is %x\n", ret
);
542 ret
= snd_soc_read(codec
, WM8523_REVISION
);
544 dev_err(codec
->dev
, "Failed to read revision register\n");
547 dev_info(codec
->dev
, "revision %c\n",
548 (ret
& WM8523_CHIP_REV_MASK
) + 'A');
550 ret
= wm8523_reset(codec
);
552 dev_err(codec
->dev
, "Failed to issue reset\n");
556 wm8523_dai
.dev
= codec
->dev
;
558 /* Change some default settings - latch VU and enable ZC */
559 wm8523
->reg_cache
[WM8523_DAC_GAINR
] |= WM8523_DACR_VU
;
560 wm8523
->reg_cache
[WM8523_DAC_CTRL3
] |= WM8523_ZC
;
562 wm8523_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
564 /* Bias level configuration will have done an extra enable */
565 regulator_bulk_disable(ARRAY_SIZE(wm8523
->supplies
), wm8523
->supplies
);
567 wm8523_codec
= codec
;
569 ret
= snd_soc_register_codec(codec
);
571 dev_err(codec
->dev
, "Failed to register codec: %d\n", ret
);
575 ret
= snd_soc_register_dai(&wm8523_dai
);
577 dev_err(codec
->dev
, "Failed to register DAI: %d\n", ret
);
578 snd_soc_unregister_codec(codec
);
585 regulator_bulk_disable(ARRAY_SIZE(wm8523
->supplies
), wm8523
->supplies
);
587 regulator_bulk_free(ARRAY_SIZE(wm8523
->supplies
), wm8523
->supplies
);
593 static void wm8523_unregister(struct wm8523_priv
*wm8523
)
595 wm8523_set_bias_level(&wm8523
->codec
, SND_SOC_BIAS_OFF
);
596 regulator_bulk_free(ARRAY_SIZE(wm8523
->supplies
), wm8523
->supplies
);
597 snd_soc_unregister_dai(&wm8523_dai
);
598 snd_soc_unregister_codec(&wm8523
->codec
);
603 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
604 static __devinit
int wm8523_i2c_probe(struct i2c_client
*i2c
,
605 const struct i2c_device_id
*id
)
607 struct wm8523_priv
*wm8523
;
608 struct snd_soc_codec
*codec
;
610 wm8523
= kzalloc(sizeof(struct wm8523_priv
), GFP_KERNEL
);
614 codec
= &wm8523
->codec
;
615 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
617 i2c_set_clientdata(i2c
, wm8523
);
618 codec
->control_data
= i2c
;
620 codec
->dev
= &i2c
->dev
;
622 return wm8523_register(wm8523
, SND_SOC_I2C
);
625 static __devexit
int wm8523_i2c_remove(struct i2c_client
*client
)
627 struct wm8523_priv
*wm8523
= i2c_get_clientdata(client
);
628 wm8523_unregister(wm8523
);
632 static const struct i2c_device_id wm8523_i2c_id
[] = {
636 MODULE_DEVICE_TABLE(i2c
, wm8523_i2c_id
);
638 static struct i2c_driver wm8523_i2c_driver
= {
641 .owner
= THIS_MODULE
,
643 .probe
= wm8523_i2c_probe
,
644 .remove
= __devexit_p(wm8523_i2c_remove
),
645 .id_table
= wm8523_i2c_id
,
649 static int __init
wm8523_modinit(void)
652 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
653 ret
= i2c_add_driver(&wm8523_i2c_driver
);
655 printk(KERN_ERR
"Failed to register WM8523 I2C driver: %d\n",
661 module_init(wm8523_modinit
);
663 static void __exit
wm8523_exit(void)
665 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
666 i2c_del_driver(&wm8523_i2c_driver
);
669 module_exit(wm8523_exit
);
671 MODULE_DESCRIPTION("ASoC WM8523 driver");
672 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
673 MODULE_LICENSE("GPL");