2 * uda134x.c -- UDA134X ALSA SoC Codec driver
4 * Modifications by Christian Pellegrin <chripell@evolware.org>
6 * Copyright 2007 Dension Audio Systems Ltd.
9 * Based on the WM87xx drivers by Liam Girdwood and Richard Purdie
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
16 #include <linux/module.h>
17 #include <linux/delay.h>
18 #include <linux/slab.h>
19 #include <sound/pcm.h>
20 #include <sound/pcm_params.h>
21 #include <sound/soc.h>
22 #include <sound/initval.h>
24 #include <sound/uda134x.h>
30 #define UDA134X_RATES SNDRV_PCM_RATE_8000_48000
31 #define UDA134X_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE | \
32 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S20_3LE)
38 struct snd_pcm_substream *master_substream;
39 struct snd_pcm_substream *slave_substream;
42 /* In-data addresses are hard-coded into the reg-cache values */
43 static const char uda134x_reg[UDA134X_REGS_NUM] = {
44 /* Extended address registers */
45 0x04, 0x04, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00,
46 /* Status, data regs */
47 0x00, 0x83, 0x00, 0x40, 0x80, 0xC0, 0x00,
51 * The codec has no support for reading its registers except for peak level...
53 static inline unsigned int uda134x_read_reg_cache(struct snd_soc_codec *codec,
56 u8 *cache = codec->reg_cache;
58 if (reg >= UDA134X_REGS_NUM)
64 * Write the register cache
66 static inline void uda134x_write_reg_cache(struct snd_soc_codec *codec,
67 u8 reg, unsigned int value)
69 u8 *cache = codec->reg_cache;
71 if (reg >= UDA134X_REGS_NUM)
77 * Write to the uda134x registers
80 static int uda134x_write(struct snd_soc_codec *codec, unsigned int reg,
86 struct uda134x_platform_data *pd = codec->control_data;
88 pr_debug("%s reg: %02X, value:%02X\n", __func__, reg, value);
90 if (reg >= UDA134X_REGS_NUM) {
91 printk(KERN_ERR "%s unknown register: reg: %u",
96 uda134x_write_reg_cache(codec, reg, value);
100 case UDA134X_STATUS1:
101 addr = UDA134X_STATUS_ADDR;
103 case UDA134X_DATA000:
104 case UDA134X_DATA001:
105 case UDA134X_DATA010:
106 case UDA134X_DATA011:
107 addr = UDA134X_DATA0_ADDR;
110 addr = UDA134X_DATA1_ADDR;
113 /* It's an extended address register */
114 addr = (reg | UDA134X_EXTADDR_PREFIX);
116 ret = l3_write(&pd->l3,
117 UDA134X_DATA0_ADDR, &addr, 1);
121 addr = UDA134X_DATA0_ADDR;
122 data = (value | UDA134X_EXTDATA_PREFIX);
126 ret = l3_write(&pd->l3,
134 static inline void uda134x_reset(struct snd_soc_codec *codec)
136 u8 reset_reg = uda134x_read_reg_cache(codec, UDA134X_STATUS0);
137 uda134x_write(codec, UDA134X_STATUS0, reset_reg | (1<<6));
139 uda134x_write(codec, UDA134X_STATUS0, reset_reg & ~(1<<6));
142 static int uda134x_mute(struct snd_soc_dai *dai, int mute)
144 struct snd_soc_codec *codec = dai->codec;
145 u8 mute_reg = uda134x_read_reg_cache(codec, UDA134X_DATA010);
147 pr_debug("%s mute: %d\n", __func__, mute);
154 uda134x_write(codec, UDA134X_DATA010, mute_reg);
159 static int uda134x_startup(struct snd_pcm_substream *substream,
160 struct snd_soc_dai *dai)
162 struct snd_soc_pcm_runtime *rtd = substream->private_data;
163 struct snd_soc_codec *codec =rtd->codec;
164 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
165 struct snd_pcm_runtime *master_runtime;
167 if (uda134x->master_substream) {
168 master_runtime = uda134x->master_substream->runtime;
170 pr_debug("%s constraining to %d bits at %d\n", __func__,
171 master_runtime->sample_bits,
172 master_runtime->rate);
174 snd_pcm_hw_constraint_minmax(substream->runtime,
175 SNDRV_PCM_HW_PARAM_RATE,
176 master_runtime->rate,
177 master_runtime->rate);
179 snd_pcm_hw_constraint_minmax(substream->runtime,
180 SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
181 master_runtime->sample_bits,
182 master_runtime->sample_bits);
184 uda134x->slave_substream = substream;
186 uda134x->master_substream = substream;
191 static void uda134x_shutdown(struct snd_pcm_substream *substream,
192 struct snd_soc_dai *dai)
194 struct snd_soc_pcm_runtime *rtd = substream->private_data;
195 struct snd_soc_codec *codec = rtd->codec;
196 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
198 if (uda134x->master_substream == substream)
199 uda134x->master_substream = uda134x->slave_substream;
201 uda134x->slave_substream = NULL;
204 static int uda134x_hw_params(struct snd_pcm_substream *substream,
205 struct snd_pcm_hw_params *params,
206 struct snd_soc_dai *dai)
208 struct snd_soc_pcm_runtime *rtd = substream->private_data;
209 struct snd_soc_codec *codec = rtd->codec;
210 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
213 if (substream == uda134x->slave_substream) {
214 pr_debug("%s ignoring hw_params for slave substream\n",
219 hw_params = uda134x_read_reg_cache(codec, UDA134X_STATUS0);
220 hw_params &= STATUS0_SYSCLK_MASK;
221 hw_params &= STATUS0_DAIFMT_MASK;
223 pr_debug("%s sysclk: %d, rate:%d\n", __func__,
224 uda134x->sysclk, params_rate(params));
226 /* set SYSCLK / fs ratio */
227 switch (uda134x->sysclk / params_rate(params)) {
237 printk(KERN_ERR "%s unsupported fs\n", __func__);
241 pr_debug("%s dai_fmt: %d, params_format:%d\n", __func__,
242 uda134x->dai_fmt, params_format(params));
244 /* set DAI format and word length */
245 switch (uda134x->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
246 case SND_SOC_DAIFMT_I2S:
248 case SND_SOC_DAIFMT_RIGHT_J:
249 switch (params_format(params)) {
250 case SNDRV_PCM_FORMAT_S16_LE:
253 case SNDRV_PCM_FORMAT_S18_3LE:
256 case SNDRV_PCM_FORMAT_S20_3LE:
257 hw_params |= ((1<<2) | (1<<1));
260 printk(KERN_ERR "%s unsupported format (right)\n",
265 case SND_SOC_DAIFMT_LEFT_J:
269 printk(KERN_ERR "%s unsupported format\n", __func__);
273 uda134x_write(codec, UDA134X_STATUS0, hw_params);
278 static int uda134x_set_dai_sysclk(struct snd_soc_dai *codec_dai,
279 int clk_id, unsigned int freq, int dir)
281 struct snd_soc_codec *codec = codec_dai->codec;
282 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
284 pr_debug("%s clk_id: %d, freq: %u, dir: %d\n", __func__,
287 /* Anything between 256fs*8Khz and 512fs*48Khz should be acceptable
288 because the codec is slave. Of course limitations of the clock
289 master (the IIS controller) apply.
290 We'll error out on set_hw_params if it's not OK */
291 if ((freq >= (256 * 8000)) && (freq <= (512 * 48000))) {
292 uda134x->sysclk = freq;
296 printk(KERN_ERR "%s unsupported sysclk\n", __func__);
300 static int uda134x_set_dai_fmt(struct snd_soc_dai *codec_dai,
303 struct snd_soc_codec *codec = codec_dai->codec;
304 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
306 pr_debug("%s fmt: %08X\n", __func__, fmt);
308 /* codec supports only full slave mode */
309 if ((fmt & SND_SOC_DAIFMT_MASTER_MASK) != SND_SOC_DAIFMT_CBS_CFS) {
310 printk(KERN_ERR "%s unsupported slave mode\n", __func__);
314 /* no support for clock inversion */
315 if ((fmt & SND_SOC_DAIFMT_INV_MASK) != SND_SOC_DAIFMT_NB_NF) {
316 printk(KERN_ERR "%s unsupported clock inversion\n", __func__);
320 /* We can't setup DAI format here as it depends on the word bit num */
321 /* so let's just store the value for later */
322 uda134x->dai_fmt = fmt;
327 static int uda134x_set_bias_level(struct snd_soc_codec *codec,
328 enum snd_soc_bias_level level)
331 struct uda134x_platform_data *pd = codec->control_data;
333 u8 *cache = codec->reg_cache;
335 pr_debug("%s bias level %d\n", __func__, level);
338 case SND_SOC_BIAS_ON:
341 case UDA134X_UDA1340:
342 case UDA134X_UDA1344:
343 case UDA134X_UDA1345:
344 reg = uda134x_read_reg_cache(codec, UDA134X_DATA011);
345 uda134x_write(codec, UDA134X_DATA011, reg | 0x03);
347 case UDA134X_UDA1341:
348 reg = uda134x_read_reg_cache(codec, UDA134X_STATUS1);
349 uda134x_write(codec, UDA134X_STATUS1, reg | 0x03);
352 printk(KERN_ERR "UDA134X SoC codec: "
353 "unsupported model %d\n", pd->model);
357 case SND_SOC_BIAS_PREPARE:
361 /* Sync reg_cache with the hardware */
362 for (i = 0; i < ARRAY_SIZE(uda134x_reg); i++)
363 codec->driver->write(codec, i, *cache++);
366 case SND_SOC_BIAS_STANDBY:
367 /* ADC, DAC power off */
369 case UDA134X_UDA1340:
370 case UDA134X_UDA1344:
371 case UDA134X_UDA1345:
372 reg = uda134x_read_reg_cache(codec, UDA134X_DATA011);
373 uda134x_write(codec, UDA134X_DATA011, reg & ~(0x03));
375 case UDA134X_UDA1341:
376 reg = uda134x_read_reg_cache(codec, UDA134X_STATUS1);
377 uda134x_write(codec, UDA134X_STATUS1, reg & ~(0x03));
380 printk(KERN_ERR "UDA134X SoC codec: "
381 "unsupported model %d\n", pd->model);
385 case SND_SOC_BIAS_OFF:
391 codec->dapm.bias_level = level;
395 static const char *uda134x_dsp_setting[] = {"Flat", "Minimum1",
396 "Minimum2", "Maximum"};
397 static const char *uda134x_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
398 static const char *uda134x_mixmode[] = {"Differential", "Analog1",
401 static const struct soc_enum uda134x_mixer_enum[] = {
402 SOC_ENUM_SINGLE(UDA134X_DATA010, 0, 0x04, uda134x_dsp_setting),
403 SOC_ENUM_SINGLE(UDA134X_DATA010, 3, 0x04, uda134x_deemph),
404 SOC_ENUM_SINGLE(UDA134X_EA010, 0, 0x04, uda134x_mixmode),
407 static const struct snd_kcontrol_new uda1341_snd_controls[] = {
408 SOC_SINGLE("Master Playback Volume", UDA134X_DATA000, 0, 0x3F, 1),
409 SOC_SINGLE("Capture Volume", UDA134X_EA010, 2, 0x07, 0),
410 SOC_SINGLE("Analog1 Volume", UDA134X_EA000, 0, 0x1F, 1),
411 SOC_SINGLE("Analog2 Volume", UDA134X_EA001, 0, 0x1F, 1),
413 SOC_SINGLE("Mic Sensitivity", UDA134X_EA010, 2, 7, 0),
414 SOC_SINGLE("Mic Volume", UDA134X_EA101, 0, 0x1F, 0),
416 SOC_SINGLE("Tone Control - Bass", UDA134X_DATA001, 2, 0xF, 0),
417 SOC_SINGLE("Tone Control - Treble", UDA134X_DATA001, 0, 3, 0),
419 SOC_ENUM("Sound Processing Filter", uda134x_mixer_enum[0]),
420 SOC_ENUM("PCM Playback De-emphasis", uda134x_mixer_enum[1]),
421 SOC_ENUM("Input Mux", uda134x_mixer_enum[2]),
423 SOC_SINGLE("AGC Switch", UDA134X_EA100, 4, 1, 0),
424 SOC_SINGLE("AGC Target Volume", UDA134X_EA110, 0, 0x03, 1),
425 SOC_SINGLE("AGC Timing", UDA134X_EA110, 2, 0x07, 0),
427 SOC_SINGLE("DAC +6dB Switch", UDA134X_STATUS1, 6, 1, 0),
428 SOC_SINGLE("ADC +6dB Switch", UDA134X_STATUS1, 5, 1, 0),
429 SOC_SINGLE("ADC Polarity Switch", UDA134X_STATUS1, 4, 1, 0),
430 SOC_SINGLE("DAC Polarity Switch", UDA134X_STATUS1, 3, 1, 0),
431 SOC_SINGLE("Double Speed Playback Switch", UDA134X_STATUS1, 2, 1, 0),
432 SOC_SINGLE("DC Filter Enable Switch", UDA134X_STATUS0, 0, 1, 0),
435 static const struct snd_kcontrol_new uda1340_snd_controls[] = {
436 SOC_SINGLE("Master Playback Volume", UDA134X_DATA000, 0, 0x3F, 1),
438 SOC_SINGLE("Tone Control - Bass", UDA134X_DATA001, 2, 0xF, 0),
439 SOC_SINGLE("Tone Control - Treble", UDA134X_DATA001, 0, 3, 0),
441 SOC_ENUM("Sound Processing Filter", uda134x_mixer_enum[0]),
442 SOC_ENUM("PCM Playback De-emphasis", uda134x_mixer_enum[1]),
444 SOC_SINGLE("DC Filter Enable Switch", UDA134X_STATUS0, 0, 1, 0),
447 static const struct snd_kcontrol_new uda1345_snd_controls[] = {
448 SOC_SINGLE("Master Playback Volume", UDA134X_DATA000, 0, 0x3F, 1),
450 SOC_ENUM("PCM Playback De-emphasis", uda134x_mixer_enum[1]),
452 SOC_SINGLE("DC Filter Enable Switch", UDA134X_STATUS0, 0, 1, 0),
455 static struct snd_soc_dai_ops uda134x_dai_ops = {
456 .startup = uda134x_startup,
457 .shutdown = uda134x_shutdown,
458 .hw_params = uda134x_hw_params,
459 .digital_mute = uda134x_mute,
460 .set_sysclk = uda134x_set_dai_sysclk,
461 .set_fmt = uda134x_set_dai_fmt,
464 static struct snd_soc_dai_driver uda134x_dai = {
465 .name = "uda134x-hifi",
466 /* playback capabilities */
468 .stream_name = "Playback",
471 .rates = UDA134X_RATES,
472 .formats = UDA134X_FORMATS,
474 /* capture capabilities */
476 .stream_name = "Capture",
479 .rates = UDA134X_RATES,
480 .formats = UDA134X_FORMATS,
483 .ops = &uda134x_dai_ops,
486 static int uda134x_soc_probe(struct snd_soc_codec *codec)
488 struct uda134x_priv *uda134x;
489 struct uda134x_platform_data *pd = codec->card->dev->platform_data;
493 printk(KERN_INFO "UDA134X SoC Audio Codec\n");
496 printk(KERN_ERR "UDA134X SoC codec: "
497 "missing L3 bitbang function\n");
502 case UDA134X_UDA1340:
503 case UDA134X_UDA1341:
504 case UDA134X_UDA1344:
505 case UDA134X_UDA1345:
508 printk(KERN_ERR "UDA134X SoC codec: "
509 "unsupported model %d\n",
514 uda134x = kzalloc(sizeof(struct uda134x_priv), GFP_KERNEL);
517 snd_soc_codec_set_drvdata(codec, uda134x);
519 codec->control_data = pd;
524 uda134x_reset(codec);
526 if (pd->is_powered_on_standby)
527 uda134x_set_bias_level(codec, SND_SOC_BIAS_ON);
529 uda134x_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
532 case UDA134X_UDA1340:
533 case UDA134X_UDA1344:
534 ret = snd_soc_add_controls(codec, uda1340_snd_controls,
535 ARRAY_SIZE(uda1340_snd_controls));
537 case UDA134X_UDA1341:
538 ret = snd_soc_add_controls(codec, uda1341_snd_controls,
539 ARRAY_SIZE(uda1341_snd_controls));
541 case UDA134X_UDA1345:
542 ret = snd_soc_add_controls(codec, uda1345_snd_controls,
543 ARRAY_SIZE(uda1345_snd_controls));
546 printk(KERN_ERR "%s unknown codec type: %d",
547 __func__, pd->model);
553 printk(KERN_ERR "UDA134X: failed to register controls\n");
561 /* power down chip */
562 static int uda134x_soc_remove(struct snd_soc_codec *codec)
564 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
566 uda134x_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
567 uda134x_set_bias_level(codec, SND_SOC_BIAS_OFF);
573 #if defined(CONFIG_PM)
574 static int uda134x_soc_suspend(struct snd_soc_codec *codec,
577 uda134x_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
578 uda134x_set_bias_level(codec, SND_SOC_BIAS_OFF);
582 static int uda134x_soc_resume(struct snd_soc_codec *codec)
584 uda134x_set_bias_level(codec, SND_SOC_BIAS_PREPARE);
585 uda134x_set_bias_level(codec, SND_SOC_BIAS_ON);
589 #define uda134x_soc_suspend NULL
590 #define uda134x_soc_resume NULL
591 #endif /* CONFIG_PM */
593 static struct snd_soc_codec_driver soc_codec_dev_uda134x = {
594 .probe = uda134x_soc_probe,
595 .remove = uda134x_soc_remove,
596 .suspend = uda134x_soc_suspend,
597 .resume = uda134x_soc_resume,
598 .reg_cache_size = sizeof(uda134x_reg),
599 .reg_word_size = sizeof(u8),
600 .reg_cache_default = uda134x_reg,
602 .read = uda134x_read_reg_cache,
603 .write = uda134x_write,
604 #ifdef POWER_OFF_ON_STANDBY
605 .set_bias_level = uda134x_set_bias_level,
609 static int __devinit uda134x_codec_probe(struct platform_device *pdev)
611 return snd_soc_register_codec(&pdev->dev,
612 &soc_codec_dev_uda134x, &uda134x_dai, 1);
615 static int __devexit uda134x_codec_remove(struct platform_device *pdev)
617 snd_soc_unregister_codec(&pdev->dev);
621 static struct platform_driver uda134x_codec_driver = {
623 .name = "uda134x-codec",
624 .owner = THIS_MODULE,
626 .probe = uda134x_codec_probe,
627 .remove = __devexit_p(uda134x_codec_remove),
630 static int __init uda134x_codec_init(void)
632 return platform_driver_register(&uda134x_codec_driver);
634 module_init(uda134x_codec_init);
636 static void __exit uda134x_codec_exit(void)
638 platform_driver_unregister(&uda134x_codec_driver);
640 module_exit(uda134x_codec_exit);
642 MODULE_DESCRIPTION("UDA134X ALSA soc codec driver");
643 MODULE_AUTHOR("Zoltan Devai, Christian Pellegrin <chripell@evolware.org>");
644 MODULE_LICENSE("GPL");