2 * ALSA SoC TWL4030 codec driver
4 * Author: Steve Sakoman, <steve@sakoman.com>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * version 2 as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 #include <linux/module.h>
23 #include <linux/moduleparam.h>
24 #include <linux/init.h>
25 #include <linux/delay.h>
27 #include <linux/i2c.h>
28 #include <linux/platform_device.h>
29 #include <linux/i2c/twl4030.h>
30 #include <sound/core.h>
31 #include <sound/pcm.h>
32 #include <sound/pcm_params.h>
33 #include <sound/soc.h>
34 #include <sound/soc-dapm.h>
35 #include <sound/initval.h>
36 #include <sound/tlv.h>
41 * twl4030 register cache & default register settings
43 static const u8 twl4030_reg[TWL4030_CACHEREGNUM] = {
44 0x00, /* this register not used */
45 0x93, /* REG_CODEC_MODE (0x1) */
46 0xc3, /* REG_OPTION (0x2) */
47 0x00, /* REG_UNKNOWN (0x3) */
48 0x00, /* REG_MICBIAS_CTL (0x4) */
49 0x24, /* REG_ANAMICL (0x5) */
50 0x04, /* REG_ANAMICR (0x6) */
51 0x0a, /* REG_AVADC_CTL (0x7) */
52 0x00, /* REG_ADCMICSEL (0x8) */
53 0x00, /* REG_DIGMIXING (0x9) */
54 0x0c, /* REG_ATXL1PGA (0xA) */
55 0x0c, /* REG_ATXR1PGA (0xB) */
56 0x00, /* REG_AVTXL2PGA (0xC) */
57 0x00, /* REG_AVTXR2PGA (0xD) */
58 0x01, /* REG_AUDIO_IF (0xE) */
59 0x00, /* REG_VOICE_IF (0xF) */
60 0x00, /* REG_ARXR1PGA (0x10) */
61 0x00, /* REG_ARXL1PGA (0x11) */
62 0x6c, /* REG_ARXR2PGA (0x12) */
63 0x6c, /* REG_ARXL2PGA (0x13) */
64 0x00, /* REG_VRXPGA (0x14) */
65 0x00, /* REG_VSTPGA (0x15) */
66 0x00, /* REG_VRX2ARXPGA (0x16) */
67 0x0c, /* REG_AVDAC_CTL (0x17) */
68 0x00, /* REG_ARX2VTXPGA (0x18) */
69 0x00, /* REG_ARXL1_APGA_CTL (0x19) */
70 0x00, /* REG_ARXR1_APGA_CTL (0x1A) */
71 0x4b, /* REG_ARXL2_APGA_CTL (0x1B) */
72 0x4b, /* REG_ARXR2_APGA_CTL (0x1C) */
73 0x00, /* REG_ATX2ARXPGA (0x1D) */
74 0x00, /* REG_BT_IF (0x1E) */
75 0x00, /* REG_BTPGA (0x1F) */
76 0x00, /* REG_BTSTPGA (0x20) */
77 0x00, /* REG_EAR_CTL (0x21) */
78 0x24, /* REG_HS_SEL (0x22) */
79 0x0a, /* REG_HS_GAIN_SET (0x23) */
80 0x00, /* REG_HS_POPN_SET (0x24) */
81 0x00, /* REG_PREDL_CTL (0x25) */
82 0x00, /* REG_PREDR_CTL (0x26) */
83 0x00, /* REG_PRECKL_CTL (0x27) */
84 0x00, /* REG_PRECKR_CTL (0x28) */
85 0x00, /* REG_HFL_CTL (0x29) */
86 0x00, /* REG_HFR_CTL (0x2A) */
87 0x00, /* REG_ALC_CTL (0x2B) */
88 0x00, /* REG_ALC_SET1 (0x2C) */
89 0x00, /* REG_ALC_SET2 (0x2D) */
90 0x00, /* REG_BOOST_CTL (0x2E) */
91 0x00, /* REG_SOFTVOL_CTL (0x2F) */
92 0x00, /* REG_DTMF_FREQSEL (0x30) */
93 0x00, /* REG_DTMF_TONEXT1H (0x31) */
94 0x00, /* REG_DTMF_TONEXT1L (0x32) */
95 0x00, /* REG_DTMF_TONEXT2H (0x33) */
96 0x00, /* REG_DTMF_TONEXT2L (0x34) */
97 0x00, /* REG_DTMF_TONOFF (0x35) */
98 0x00, /* REG_DTMF_WANONOFF (0x36) */
99 0x00, /* REG_I2S_RX_SCRAMBLE_H (0x37) */
100 0x00, /* REG_I2S_RX_SCRAMBLE_M (0x38) */
101 0x00, /* REG_I2S_RX_SCRAMBLE_L (0x39) */
102 0x16, /* REG_APLL_CTL (0x3A) */
103 0x00, /* REG_DTMF_CTL (0x3B) */
104 0x00, /* REG_DTMF_PGA_CTL2 (0x3C) */
105 0x00, /* REG_DTMF_PGA_CTL1 (0x3D) */
106 0x00, /* REG_MISC_SET_1 (0x3E) */
107 0x00, /* REG_PCMBTMUX (0x3F) */
108 0x00, /* not used (0x40) */
109 0x00, /* not used (0x41) */
110 0x00, /* not used (0x42) */
111 0x00, /* REG_RX_PATH_SEL (0x43) */
112 0x00, /* REG_VDL_APGA_CTL (0x44) */
113 0x00, /* REG_VIBRA_CTL (0x45) */
114 0x00, /* REG_VIBRA_SET (0x46) */
115 0x00, /* REG_VIBRA_PWM_SET (0x47) */
116 0x00, /* REG_ANAMIC_GAIN (0x48) */
117 0x00, /* REG_MISC_SET_2 (0x49) */
121 * read twl4030 register cache
123 static inline unsigned int twl4030_read_reg_cache(struct snd_soc_codec *codec,
126 u8 *cache = codec->reg_cache;
132 * write twl4030 register cache
134 static inline void twl4030_write_reg_cache(struct snd_soc_codec *codec,
137 u8 *cache = codec->reg_cache;
139 if (reg >= TWL4030_CACHEREGNUM)
145 * write to the twl4030 register space
147 static int twl4030_write(struct snd_soc_codec *codec,
148 unsigned int reg, unsigned int value)
150 twl4030_write_reg_cache(codec, reg, value);
151 return twl4030_i2c_write_u8(TWL4030_MODULE_AUDIO_VOICE, value, reg);
154 static void twl4030_clear_codecpdz(struct snd_soc_codec *codec)
158 mode = twl4030_read_reg_cache(codec, TWL4030_REG_CODEC_MODE);
159 twl4030_write(codec, TWL4030_REG_CODEC_MODE,
160 mode & ~TWL4030_CODECPDZ);
162 /* REVISIT: this delay is present in TI sample drivers */
163 /* but there seems to be no TRM requirement for it */
167 static void twl4030_set_codecpdz(struct snd_soc_codec *codec)
171 mode = twl4030_read_reg_cache(codec, TWL4030_REG_CODEC_MODE);
172 twl4030_write(codec, TWL4030_REG_CODEC_MODE,
173 mode | TWL4030_CODECPDZ);
175 /* REVISIT: this delay is present in TI sample drivers */
176 /* but there seems to be no TRM requirement for it */
180 static void twl4030_init_chip(struct snd_soc_codec *codec)
184 /* clear CODECPDZ prior to setting register defaults */
185 twl4030_clear_codecpdz(codec);
187 /* set all audio section registers to reasonable defaults */
188 for (i = TWL4030_REG_OPTION; i <= TWL4030_REG_MISC_SET_2; i++)
189 twl4030_write(codec, i, twl4030_reg[i]);
194 * FGAIN volume control:
195 * from -62 to 0 dB in 1 dB steps (mute instead of -63 dB)
197 static DECLARE_TLV_DB_SCALE(master_tlv, -6300, 100, 1);
200 * CGAIN volume control:
201 * 0 dB to 12 dB in 6 dB steps
202 * value 2 and 3 means 12 dB
204 static DECLARE_TLV_DB_SCALE(master_coarse_tlv, 0, 600, 0);
206 static const struct snd_kcontrol_new twl4030_snd_controls[] = {
207 SOC_DOUBLE_R_TLV("Master Playback Volume",
208 TWL4030_REG_ARXL2PGA, TWL4030_REG_ARXR2PGA,
209 0, 0x3f, 0, master_tlv),
210 SOC_DOUBLE_R_TLV("Master PCM Playback Volume",
211 TWL4030_REG_ARXL2PGA, TWL4030_REG_ARXR2PGA,
212 6, 0x2, 0, master_coarse_tlv),
213 SOC_DOUBLE_R("Capture Volume",
214 TWL4030_REG_ATXL1PGA, TWL4030_REG_ATXR1PGA,
218 /* add non dapm controls */
219 static int twl4030_add_controls(struct snd_soc_codec *codec)
223 for (i = 0; i < ARRAY_SIZE(twl4030_snd_controls); i++) {
224 err = snd_ctl_add(codec->card,
225 snd_soc_cnew(&twl4030_snd_controls[i],
234 static const struct snd_soc_dapm_widget twl4030_dapm_widgets[] = {
235 SND_SOC_DAPM_INPUT("INL"),
236 SND_SOC_DAPM_INPUT("INR"),
238 SND_SOC_DAPM_OUTPUT("OUTL"),
239 SND_SOC_DAPM_OUTPUT("OUTR"),
241 SND_SOC_DAPM_DAC("DACL", "Left Playback", SND_SOC_NOPM, 0, 0),
242 SND_SOC_DAPM_DAC("DACR", "Right Playback", SND_SOC_NOPM, 0, 0),
244 SND_SOC_DAPM_ADC("ADCL", "Left Capture", SND_SOC_NOPM, 0, 0),
245 SND_SOC_DAPM_ADC("ADCR", "Right Capture", SND_SOC_NOPM, 0, 0),
248 static const struct snd_soc_dapm_route intercon[] = {
250 {"OUTL", NULL, "DACL"},
251 {"OUTR", NULL, "DACR"},
254 {"ADCL", NULL, "INL"},
255 {"ADCR", NULL, "INR"},
258 static int twl4030_add_widgets(struct snd_soc_codec *codec)
260 snd_soc_dapm_new_controls(codec, twl4030_dapm_widgets,
261 ARRAY_SIZE(twl4030_dapm_widgets));
263 snd_soc_dapm_add_routes(codec, intercon, ARRAY_SIZE(intercon));
265 snd_soc_dapm_new_widgets(codec);
269 static void twl4030_power_up(struct snd_soc_codec *codec)
271 u8 anamicl, regmisc1, byte, popn, hsgain;
274 /* set CODECPDZ to turn on codec */
275 twl4030_set_codecpdz(codec);
277 /* initiate offset cancellation */
278 anamicl = twl4030_read_reg_cache(codec, TWL4030_REG_ANAMICL);
279 twl4030_write(codec, TWL4030_REG_ANAMICL,
280 anamicl | TWL4030_CNCL_OFFSET_START);
282 /* wait for offset cancellation to complete */
284 /* this takes a little while, so don't slam i2c */
286 twl4030_i2c_read_u8(TWL4030_MODULE_AUDIO_VOICE, &byte,
287 TWL4030_REG_ANAMICL);
288 } while ((i++ < 100) &&
289 ((byte & TWL4030_CNCL_OFFSET_START) ==
290 TWL4030_CNCL_OFFSET_START));
292 /* anti-pop when changing analog gain */
293 regmisc1 = twl4030_read_reg_cache(codec, TWL4030_REG_MISC_SET_1);
294 twl4030_write(codec, TWL4030_REG_MISC_SET_1,
295 regmisc1 | TWL4030_SMOOTH_ANAVOL_EN);
297 /* toggle CODECPDZ as per TRM */
298 twl4030_clear_codecpdz(codec);
299 twl4030_set_codecpdz(codec);
301 /* program anti-pop with bias ramp delay */
302 popn = twl4030_read_reg_cache(codec, TWL4030_REG_HS_POPN_SET);
303 popn &= TWL4030_RAMP_DELAY;
304 popn |= TWL4030_RAMP_DELAY_645MS;
305 twl4030_write(codec, TWL4030_REG_HS_POPN_SET, popn);
306 popn |= TWL4030_VMID_EN;
307 twl4030_write(codec, TWL4030_REG_HS_POPN_SET, popn);
309 /* enable output stage and gain setting */
310 hsgain = TWL4030_HSR_GAIN_0DB | TWL4030_HSL_GAIN_0DB;
311 twl4030_write(codec, TWL4030_REG_HS_GAIN_SET, hsgain);
313 /* enable anti-pop ramp */
314 popn |= TWL4030_RAMP_EN;
315 twl4030_write(codec, TWL4030_REG_HS_POPN_SET, popn);
318 static void twl4030_power_down(struct snd_soc_codec *codec)
322 /* disable anti-pop ramp */
323 popn = twl4030_read_reg_cache(codec, TWL4030_REG_HS_POPN_SET);
324 popn &= ~TWL4030_RAMP_EN;
325 twl4030_write(codec, TWL4030_REG_HS_POPN_SET, popn);
327 /* disable output stage and gain setting */
328 hsgain = TWL4030_HSR_GAIN_PWR_DOWN | TWL4030_HSL_GAIN_PWR_DOWN;
329 twl4030_write(codec, TWL4030_REG_HS_GAIN_SET, hsgain);
331 /* disable bias out */
332 popn &= ~TWL4030_VMID_EN;
333 twl4030_write(codec, TWL4030_REG_HS_POPN_SET, popn);
336 twl4030_clear_codecpdz(codec);
339 static int twl4030_set_bias_level(struct snd_soc_codec *codec,
340 enum snd_soc_bias_level level)
343 case SND_SOC_BIAS_ON:
344 twl4030_power_up(codec);
346 case SND_SOC_BIAS_PREPARE:
347 /* TODO: develop a twl4030_prepare function */
349 case SND_SOC_BIAS_STANDBY:
350 /* TODO: develop a twl4030_standby function */
351 twl4030_power_down(codec);
353 case SND_SOC_BIAS_OFF:
354 twl4030_power_down(codec);
357 codec->bias_level = level;
362 static int twl4030_hw_params(struct snd_pcm_substream *substream,
363 struct snd_pcm_hw_params *params,
364 struct snd_soc_dai *dai)
366 struct snd_soc_pcm_runtime *rtd = substream->private_data;
367 struct snd_soc_device *socdev = rtd->socdev;
368 struct snd_soc_codec *codec = socdev->codec;
369 u8 mode, old_mode, format, old_format;
373 old_mode = twl4030_read_reg_cache(codec,
374 TWL4030_REG_CODEC_MODE) & ~TWL4030_CODECPDZ;
375 mode = old_mode & ~TWL4030_APLL_RATE;
377 switch (params_rate(params)) {
379 mode |= TWL4030_APLL_RATE_8000;
382 mode |= TWL4030_APLL_RATE_11025;
385 mode |= TWL4030_APLL_RATE_12000;
388 mode |= TWL4030_APLL_RATE_16000;
391 mode |= TWL4030_APLL_RATE_22050;
394 mode |= TWL4030_APLL_RATE_24000;
397 mode |= TWL4030_APLL_RATE_32000;
400 mode |= TWL4030_APLL_RATE_44100;
403 mode |= TWL4030_APLL_RATE_48000;
406 printk(KERN_ERR "TWL4030 hw params: unknown rate %d\n",
407 params_rate(params));
411 if (mode != old_mode) {
412 /* change rate and set CODECPDZ */
413 twl4030_write(codec, TWL4030_REG_CODEC_MODE, mode);
414 twl4030_set_codecpdz(codec);
418 old_format = twl4030_read_reg_cache(codec, TWL4030_REG_AUDIO_IF);
420 format &= ~TWL4030_DATA_WIDTH;
421 switch (params_format(params)) {
422 case SNDRV_PCM_FORMAT_S16_LE:
423 format |= TWL4030_DATA_WIDTH_16S_16W;
425 case SNDRV_PCM_FORMAT_S24_LE:
426 format |= TWL4030_DATA_WIDTH_32S_24W;
429 printk(KERN_ERR "TWL4030 hw params: unknown format %d\n",
430 params_format(params));
434 if (format != old_format) {
436 /* clear CODECPDZ before changing format (codec requirement) */
437 twl4030_clear_codecpdz(codec);
440 twl4030_write(codec, TWL4030_REG_AUDIO_IF, format);
442 /* set CODECPDZ afterwards */
443 twl4030_set_codecpdz(codec);
448 static int twl4030_set_dai_sysclk(struct snd_soc_dai *codec_dai,
449 int clk_id, unsigned int freq, int dir)
451 struct snd_soc_codec *codec = codec_dai->codec;
456 infreq = TWL4030_APLL_INFREQ_19200KHZ;
459 infreq = TWL4030_APLL_INFREQ_26000KHZ;
462 infreq = TWL4030_APLL_INFREQ_38400KHZ;
465 printk(KERN_ERR "TWL4030 set sysclk: unknown rate %d\n",
470 infreq |= TWL4030_APLL_EN;
471 twl4030_write(codec, TWL4030_REG_APLL_CTL, infreq);
476 static int twl4030_set_dai_fmt(struct snd_soc_dai *codec_dai,
479 struct snd_soc_codec *codec = codec_dai->codec;
480 u8 old_format, format;
483 old_format = twl4030_read_reg_cache(codec, TWL4030_REG_AUDIO_IF);
486 /* set master/slave audio interface */
487 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
488 case SND_SOC_DAIFMT_CBM_CFM:
489 format &= ~(TWL4030_AIF_SLAVE_EN);
490 format &= ~(TWL4030_CLK256FS_EN);
492 case SND_SOC_DAIFMT_CBS_CFS:
493 format |= TWL4030_AIF_SLAVE_EN;
494 format |= TWL4030_CLK256FS_EN;
500 /* interface format */
501 format &= ~TWL4030_AIF_FORMAT;
502 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
503 case SND_SOC_DAIFMT_I2S:
504 format |= TWL4030_AIF_FORMAT_CODEC;
510 if (format != old_format) {
512 /* clear CODECPDZ before changing format (codec requirement) */
513 twl4030_clear_codecpdz(codec);
516 twl4030_write(codec, TWL4030_REG_AUDIO_IF, format);
518 /* set CODECPDZ afterwards */
519 twl4030_set_codecpdz(codec);
525 #define TWL4030_RATES (SNDRV_PCM_RATE_8000_48000)
526 #define TWL4030_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FORMAT_S24_LE)
528 struct snd_soc_dai twl4030_dai = {
531 .stream_name = "Playback",
534 .rates = TWL4030_RATES,
535 .formats = TWL4030_FORMATS,},
537 .stream_name = "Capture",
540 .rates = TWL4030_RATES,
541 .formats = TWL4030_FORMATS,},
543 .hw_params = twl4030_hw_params,
544 .set_sysclk = twl4030_set_dai_sysclk,
545 .set_fmt = twl4030_set_dai_fmt,
548 EXPORT_SYMBOL_GPL(twl4030_dai);
550 static int twl4030_suspend(struct platform_device *pdev, pm_message_t state)
552 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
553 struct snd_soc_codec *codec = socdev->codec;
555 twl4030_set_bias_level(codec, SND_SOC_BIAS_OFF);
560 static int twl4030_resume(struct platform_device *pdev)
562 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
563 struct snd_soc_codec *codec = socdev->codec;
565 twl4030_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
566 twl4030_set_bias_level(codec, codec->suspend_bias_level);
571 * initialize the driver
572 * register the mixer and dsp interfaces with the kernel
575 static int twl4030_init(struct snd_soc_device *socdev)
577 struct snd_soc_codec *codec = socdev->codec;
580 printk(KERN_INFO "TWL4030 Audio Codec init \n");
582 codec->name = "twl4030";
583 codec->owner = THIS_MODULE;
584 codec->read = twl4030_read_reg_cache;
585 codec->write = twl4030_write;
586 codec->set_bias_level = twl4030_set_bias_level;
587 codec->dai = &twl4030_dai;
589 codec->reg_cache_size = sizeof(twl4030_reg);
590 codec->reg_cache = kmemdup(twl4030_reg, sizeof(twl4030_reg),
592 if (codec->reg_cache == NULL)
596 ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
598 printk(KERN_ERR "twl4030: failed to create pcms\n");
602 twl4030_init_chip(codec);
604 /* power on device */
605 twl4030_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
607 twl4030_add_controls(codec);
608 twl4030_add_widgets(codec);
610 ret = snd_soc_register_card(socdev);
612 printk(KERN_ERR "twl4030: failed to register card\n");
619 snd_soc_free_pcms(socdev);
620 snd_soc_dapm_free(socdev);
622 kfree(codec->reg_cache);
626 static struct snd_soc_device *twl4030_socdev;
628 static int twl4030_probe(struct platform_device *pdev)
630 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
631 struct snd_soc_codec *codec;
633 codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
637 socdev->codec = codec;
638 mutex_init(&codec->mutex);
639 INIT_LIST_HEAD(&codec->dapm_widgets);
640 INIT_LIST_HEAD(&codec->dapm_paths);
642 twl4030_socdev = socdev;
643 twl4030_init(socdev);
648 static int twl4030_remove(struct platform_device *pdev)
650 struct snd_soc_device *socdev = platform_get_drvdata(pdev);
651 struct snd_soc_codec *codec = socdev->codec;
653 printk(KERN_INFO "TWL4030 Audio Codec remove\n");
659 struct snd_soc_codec_device soc_codec_dev_twl4030 = {
660 .probe = twl4030_probe,
661 .remove = twl4030_remove,
662 .suspend = twl4030_suspend,
663 .resume = twl4030_resume,
665 EXPORT_SYMBOL_GPL(soc_codec_dev_twl4030);
667 MODULE_DESCRIPTION("ASoC TWL4030 codec driver");
668 MODULE_AUTHOR("Steve Sakoman");
669 MODULE_LICENSE("GPL");