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/soc-dapm.h>
23 #include <sound/initval.h>
25 #include <sound/uda134x.h>
31 #define UDA134X_RATES SNDRV_PCM_RATE_8000_48000
32 #define UDA134X_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE | \
33 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S20_3LE)
39 struct snd_pcm_substream *master_substream;
40 struct snd_pcm_substream *slave_substream;
43 /* In-data addresses are hard-coded into the reg-cache values */
44 static const char uda134x_reg[UDA134X_REGS_NUM] = {
45 /* Extended address registers */
46 0x04, 0x04, 0x04, 0x00, 0x00, 0x00, 0x00, 0x00,
47 /* Status, data regs */
48 0x00, 0x83, 0x00, 0x40, 0x80, 0x00,
52 * The codec has no support for reading its registers except for peak level...
54 static inline unsigned int uda134x_read_reg_cache(struct snd_soc_codec *codec,
57 u8 *cache = codec->reg_cache;
59 if (reg >= UDA134X_REGS_NUM)
65 * Write the register cache
67 static inline void uda134x_write_reg_cache(struct snd_soc_codec *codec,
68 u8 reg, unsigned int value)
70 u8 *cache = codec->reg_cache;
72 if (reg >= UDA134X_REGS_NUM)
78 * Write to the uda134x registers
81 static int uda134x_write(struct snd_soc_codec *codec, unsigned int reg,
87 struct uda134x_platform_data *pd = codec->control_data;
89 pr_debug("%s reg: %02X, value:%02X\n", __func__, reg, value);
91 if (reg >= UDA134X_REGS_NUM) {
92 printk(KERN_ERR "%s unknown register: reg: %u",
97 uda134x_write_reg_cache(codec, reg, value);
100 case UDA134X_STATUS0:
101 case UDA134X_STATUS1:
102 addr = UDA134X_STATUS_ADDR;
104 case UDA134X_DATA000:
105 case UDA134X_DATA001:
106 case UDA134X_DATA010:
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_device *socdev = rtd->socdev;
164 struct snd_soc_codec *codec = socdev->card->codec;
165 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
166 struct snd_pcm_runtime *master_runtime;
168 if (uda134x->master_substream) {
169 master_runtime = uda134x->master_substream->runtime;
171 pr_debug("%s constraining to %d bits at %d\n", __func__,
172 master_runtime->sample_bits,
173 master_runtime->rate);
175 snd_pcm_hw_constraint_minmax(substream->runtime,
176 SNDRV_PCM_HW_PARAM_RATE,
177 master_runtime->rate,
178 master_runtime->rate);
180 snd_pcm_hw_constraint_minmax(substream->runtime,
181 SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
182 master_runtime->sample_bits,
183 master_runtime->sample_bits);
185 uda134x->slave_substream = substream;
187 uda134x->master_substream = substream;
192 static void uda134x_shutdown(struct snd_pcm_substream *substream,
193 struct snd_soc_dai *dai)
195 struct snd_soc_pcm_runtime *rtd = substream->private_data;
196 struct snd_soc_device *socdev = rtd->socdev;
197 struct snd_soc_codec *codec = socdev->card->codec;
198 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
200 if (uda134x->master_substream == substream)
201 uda134x->master_substream = uda134x->slave_substream;
203 uda134x->slave_substream = NULL;
206 static int uda134x_hw_params(struct snd_pcm_substream *substream,
207 struct snd_pcm_hw_params *params,
208 struct snd_soc_dai *dai)
210 struct snd_soc_pcm_runtime *rtd = substream->private_data;
211 struct snd_soc_device *socdev = rtd->socdev;
212 struct snd_soc_codec *codec = socdev->card->codec;
213 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
216 if (substream == uda134x->slave_substream) {
217 pr_debug("%s ignoring hw_params for slave substream\n",
222 hw_params = uda134x_read_reg_cache(codec, UDA134X_STATUS0);
223 hw_params &= STATUS0_SYSCLK_MASK;
224 hw_params &= STATUS0_DAIFMT_MASK;
226 pr_debug("%s sysclk: %d, rate:%d\n", __func__,
227 uda134x->sysclk, params_rate(params));
229 /* set SYSCLK / fs ratio */
230 switch (uda134x->sysclk / params_rate(params)) {
240 printk(KERN_ERR "%s unsupported fs\n", __func__);
244 pr_debug("%s dai_fmt: %d, params_format:%d\n", __func__,
245 uda134x->dai_fmt, params_format(params));
247 /* set DAI format and word length */
248 switch (uda134x->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
249 case SND_SOC_DAIFMT_I2S:
251 case SND_SOC_DAIFMT_RIGHT_J:
252 switch (params_format(params)) {
253 case SNDRV_PCM_FORMAT_S16_LE:
256 case SNDRV_PCM_FORMAT_S18_3LE:
259 case SNDRV_PCM_FORMAT_S20_3LE:
260 hw_params |= ((1<<2) | (1<<1));
263 printk(KERN_ERR "%s unsupported format (right)\n",
268 case SND_SOC_DAIFMT_LEFT_J:
272 printk(KERN_ERR "%s unsupported format\n", __func__);
276 uda134x_write(codec, UDA134X_STATUS0, hw_params);
281 static int uda134x_set_dai_sysclk(struct snd_soc_dai *codec_dai,
282 int clk_id, unsigned int freq, int dir)
284 struct snd_soc_codec *codec = codec_dai->codec;
285 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
287 pr_debug("%s clk_id: %d, freq: %u, dir: %d\n", __func__,
290 /* Anything between 256fs*8Khz and 512fs*48Khz should be acceptable
291 because the codec is slave. Of course limitations of the clock
292 master (the IIS controller) apply.
293 We'll error out on set_hw_params if it's not OK */
294 if ((freq >= (256 * 8000)) && (freq <= (512 * 48000))) {
295 uda134x->sysclk = freq;
299 printk(KERN_ERR "%s unsupported sysclk\n", __func__);
303 static int uda134x_set_dai_fmt(struct snd_soc_dai *codec_dai,
306 struct snd_soc_codec *codec = codec_dai->codec;
307 struct uda134x_priv *uda134x = snd_soc_codec_get_drvdata(codec);
309 pr_debug("%s fmt: %08X\n", __func__, fmt);
311 /* codec supports only full slave mode */
312 if ((fmt & SND_SOC_DAIFMT_MASTER_MASK) != SND_SOC_DAIFMT_CBS_CFS) {
313 printk(KERN_ERR "%s unsupported slave mode\n", __func__);
317 /* no support for clock inversion */
318 if ((fmt & SND_SOC_DAIFMT_INV_MASK) != SND_SOC_DAIFMT_NB_NF) {
319 printk(KERN_ERR "%s unsupported clock inversion\n", __func__);
323 /* We can't setup DAI format here as it depends on the word bit num */
324 /* so let's just store the value for later */
325 uda134x->dai_fmt = fmt;
330 static int uda134x_set_bias_level(struct snd_soc_codec *codec,
331 enum snd_soc_bias_level level)
334 struct uda134x_platform_data *pd = codec->control_data;
336 u8 *cache = codec->reg_cache;
338 pr_debug("%s bias level %d\n", __func__, level);
341 case SND_SOC_BIAS_ON:
343 reg = uda134x_read_reg_cache(codec, UDA134X_STATUS1);
344 uda134x_write(codec, UDA134X_STATUS1, reg | 0x03);
346 case SND_SOC_BIAS_PREPARE:
350 /* Sync reg_cache with the hardware */
351 for (i = 0; i < ARRAY_SIZE(uda134x_reg); i++)
352 codec->write(codec, i, *cache++);
355 case SND_SOC_BIAS_STANDBY:
356 /* ADC, DAC power off */
357 reg = uda134x_read_reg_cache(codec, UDA134X_STATUS1);
358 uda134x_write(codec, UDA134X_STATUS1, reg & ~(0x03));
360 case SND_SOC_BIAS_OFF:
366 codec->bias_level = level;
370 static const char *uda134x_dsp_setting[] = {"Flat", "Minimum1",
371 "Minimum2", "Maximum"};
372 static const char *uda134x_deemph[] = {"None", "32Khz", "44.1Khz", "48Khz"};
373 static const char *uda134x_mixmode[] = {"Differential", "Analog1",
376 static const struct soc_enum uda134x_mixer_enum[] = {
377 SOC_ENUM_SINGLE(UDA134X_DATA010, 0, 0x04, uda134x_dsp_setting),
378 SOC_ENUM_SINGLE(UDA134X_DATA010, 3, 0x04, uda134x_deemph),
379 SOC_ENUM_SINGLE(UDA134X_EA010, 0, 0x04, uda134x_mixmode),
382 static const struct snd_kcontrol_new uda1341_snd_controls[] = {
383 SOC_SINGLE("Master Playback Volume", UDA134X_DATA000, 0, 0x3F, 1),
384 SOC_SINGLE("Capture Volume", UDA134X_EA010, 2, 0x07, 0),
385 SOC_SINGLE("Analog1 Volume", UDA134X_EA000, 0, 0x1F, 1),
386 SOC_SINGLE("Analog2 Volume", UDA134X_EA001, 0, 0x1F, 1),
388 SOC_SINGLE("Mic Sensitivity", UDA134X_EA010, 2, 7, 0),
389 SOC_SINGLE("Mic Volume", UDA134X_EA101, 0, 0x1F, 0),
391 SOC_SINGLE("Tone Control - Bass", UDA134X_DATA001, 2, 0xF, 0),
392 SOC_SINGLE("Tone Control - Treble", UDA134X_DATA001, 0, 3, 0),
394 SOC_ENUM("Sound Processing Filter", uda134x_mixer_enum[0]),
395 SOC_ENUM("PCM Playback De-emphasis", uda134x_mixer_enum[1]),
396 SOC_ENUM("Input Mux", uda134x_mixer_enum[2]),
398 SOC_SINGLE("AGC Switch", UDA134X_EA100, 4, 1, 0),
399 SOC_SINGLE("AGC Target Volume", UDA134X_EA110, 0, 0x03, 1),
400 SOC_SINGLE("AGC Timing", UDA134X_EA110, 2, 0x07, 0),
402 SOC_SINGLE("DAC +6dB Switch", UDA134X_STATUS1, 6, 1, 0),
403 SOC_SINGLE("ADC +6dB Switch", UDA134X_STATUS1, 5, 1, 0),
404 SOC_SINGLE("ADC Polarity Switch", UDA134X_STATUS1, 4, 1, 0),
405 SOC_SINGLE("DAC Polarity Switch", UDA134X_STATUS1, 3, 1, 0),
406 SOC_SINGLE("Double Speed Playback Switch", UDA134X_STATUS1, 2, 1, 0),
407 SOC_SINGLE("DC Filter Enable Switch", UDA134X_STATUS0, 0, 1, 0),
410 static const struct snd_kcontrol_new uda1340_snd_controls[] = {
411 SOC_SINGLE("Master Playback Volume", UDA134X_DATA000, 0, 0x3F, 1),
413 SOC_SINGLE("Tone Control - Bass", UDA134X_DATA001, 2, 0xF, 0),
414 SOC_SINGLE("Tone Control - Treble", UDA134X_DATA001, 0, 3, 0),
416 SOC_ENUM("Sound Processing Filter", uda134x_mixer_enum[0]),
417 SOC_ENUM("PCM Playback De-emphasis", uda134x_mixer_enum[1]),
419 SOC_SINGLE("DC Filter Enable Switch", UDA134X_STATUS0, 0, 1, 0),
422 static const struct snd_kcontrol_new uda1345_snd_controls[] = {
423 SOC_SINGLE("Master Playback Volume", UDA134X_DATA000, 0, 0x3F, 1),
425 SOC_ENUM("PCM Playback De-emphasis", uda134x_mixer_enum[1]),
427 SOC_SINGLE("DC Filter Enable Switch", UDA134X_STATUS0, 0, 1, 0),
430 static struct snd_soc_dai_ops uda134x_dai_ops = {
431 .startup = uda134x_startup,
432 .shutdown = uda134x_shutdown,
433 .hw_params = uda134x_hw_params,
434 .digital_mute = uda134x_mute,
435 .set_sysclk = uda134x_set_dai_sysclk,
436 .set_fmt = uda134x_set_dai_fmt,
439 struct snd_soc_dai uda134x_dai = {
441 /* playback capabilities */
443 .stream_name = "Playback",
446 .rates = UDA134X_RATES,
447 .formats = UDA134X_FORMATS,
449 /* capture capabilities */
451 .stream_name = "Capture",
454 .rates = UDA134X_RATES,
455 .formats = UDA134X_FORMATS,
458 .ops = &uda134x_dai_ops,
460 EXPORT_SYMBOL(uda134x_dai);
463 static int uda134x_soc_probe(struct platform_device *pdev)
465 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
466 struct snd_soc_codec *codec;
467 struct uda134x_priv *uda134x;
468 void *codec_setup_data = socdev->codec_data;
470 struct uda134x_platform_data *pd;
472 printk(KERN_INFO "UDA134X SoC Audio Codec\n");
474 if (!codec_setup_data) {
475 printk(KERN_ERR "UDA134X SoC codec: "
476 "missing L3 bitbang function\n");
480 pd = codec_setup_data;
482 case UDA134X_UDA1340:
483 case UDA134X_UDA1341:
484 case UDA134X_UDA1344:
485 case UDA134X_UDA1345:
488 printk(KERN_ERR "UDA134X SoC codec: "
489 "unsupported model %d\n",
494 socdev->card->codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
495 if (socdev->card->codec == NULL)
498 codec = socdev->card->codec;
500 uda134x = kzalloc(sizeof(struct uda134x_priv), GFP_KERNEL);
503 snd_soc_codec_set_drvdata(codec, uda134x);
505 codec->reg_cache = kmemdup(uda134x_reg, sizeof(uda134x_reg),
507 if (codec->reg_cache == NULL)
510 mutex_init(&codec->mutex);
512 codec->reg_cache_size = sizeof(uda134x_reg);
513 codec->reg_cache_step = 1;
515 codec->name = "UDA134X";
516 codec->owner = THIS_MODULE;
517 codec->dai = &uda134x_dai;
519 codec->read = uda134x_read_reg_cache;
520 codec->write = uda134x_write;
522 INIT_LIST_HEAD(&codec->dapm_widgets);
523 INIT_LIST_HEAD(&codec->dapm_paths);
525 codec->control_data = codec_setup_data;
530 uda134x_reset(codec);
532 if (pd->is_powered_on_standby) {
533 codec->set_bias_level = NULL;
534 uda134x_set_bias_level(codec, SND_SOC_BIAS_ON);
536 codec->set_bias_level = uda134x_set_bias_level;
537 uda134x_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
541 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
543 printk(KERN_ERR "UDA134X: failed to register pcms\n");
548 case UDA134X_UDA1340:
549 case UDA134X_UDA1344:
550 ret = snd_soc_add_controls(codec, uda1340_snd_controls,
551 ARRAY_SIZE(uda1340_snd_controls));
553 case UDA134X_UDA1341:
554 ret = snd_soc_add_controls(codec, uda1341_snd_controls,
555 ARRAY_SIZE(uda1341_snd_controls));
557 case UDA134X_UDA1345:
558 ret = snd_soc_add_controls(codec, uda1345_snd_controls,
559 ARRAY_SIZE(uda1345_snd_controls));
562 printk(KERN_ERR "%s unknown codec type: %d",
563 __func__, pd->model);
568 printk(KERN_ERR "UDA134X: failed to register controls\n");
575 kfree(codec->reg_cache);
577 kfree(snd_soc_codec_get_drvdata(codec));
583 /* power down chip */
584 static int uda134x_soc_remove(struct platform_device *pdev)
586 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
587 struct snd_soc_codec *codec = socdev->card->codec;
589 uda134x_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
590 uda134x_set_bias_level(codec, SND_SOC_BIAS_OFF);
592 snd_soc_free_pcms(socdev);
593 snd_soc_dapm_free(socdev);
595 kfree(snd_soc_codec_get_drvdata(codec));
596 kfree(codec->reg_cache);
602 #if defined(CONFIG_PM)
603 static int uda134x_soc_suspend(struct platform_device *pdev,
606 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
607 struct snd_soc_codec *codec = socdev->card->codec;
609 uda134x_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
610 uda134x_set_bias_level(codec, SND_SOC_BIAS_OFF);
614 static int uda134x_soc_resume(struct platform_device *pdev)
616 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
617 struct snd_soc_codec *codec = socdev->card->codec;
619 uda134x_set_bias_level(codec, SND_SOC_BIAS_PREPARE);
620 uda134x_set_bias_level(codec, SND_SOC_BIAS_ON);
624 #define uda134x_soc_suspend NULL
625 #define uda134x_soc_resume NULL
626 #endif /* CONFIG_PM */
628 struct snd_soc_codec_device soc_codec_dev_uda134x = {
629 .probe = uda134x_soc_probe,
630 .remove = uda134x_soc_remove,
631 .suspend = uda134x_soc_suspend,
632 .resume = uda134x_soc_resume,
634 EXPORT_SYMBOL_GPL(soc_codec_dev_uda134x);
636 static int __init uda134x_init(void)
638 return snd_soc_register_dai(&uda134x_dai);
640 module_init(uda134x_init);
642 static void __exit uda134x_exit(void)
644 snd_soc_unregister_dai(&uda134x_dai);
646 module_exit(uda134x_exit);
648 MODULE_DESCRIPTION("UDA134X ALSA soc codec driver");
649 MODULE_AUTHOR("Zoltan Devai, Christian Pellegrin <chripell@evolware.org>");
650 MODULE_LICENSE("GPL");