2 * ALSA SoC TLV320AIC23 codec driver
4 * Author: Arun KS, <arunks@mistralsolutions.com>
5 * Copyright: (C) 2008 Mistral Solutions Pvt Ltd.,
7 * Based on sound/soc/codecs/wm8731.c by Richard Purdie
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 * The AIC23 is a driver for a low power stereo audio
17 * The machine layer should disable unsupported inputs/outputs by
18 * snd_soc_dapm_disable_pin(codec, "LHPOUT"), etc.
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/init.h>
24 #include <linux/delay.h>
26 #include <linux/regmap.h>
27 #include <linux/slab.h>
28 #include <sound/core.h>
29 #include <sound/pcm.h>
30 #include <sound/pcm_params.h>
31 #include <sound/soc.h>
32 #include <sound/tlv.h>
33 #include <sound/initval.h>
35 #include "tlv320aic23.h"
38 * AIC23 register cache
40 static const struct reg_default tlv320aic23_reg[] = {
53 const struct regmap_config tlv320aic23_regmap = {
57 .max_register = TLV320AIC23_RESET,
58 .reg_defaults = tlv320aic23_reg,
59 .num_reg_defaults = ARRAY_SIZE(tlv320aic23_reg),
60 .cache_type = REGCACHE_RBTREE,
62 EXPORT_SYMBOL(tlv320aic23_regmap);
64 static const char *rec_src_text[] = { "Line", "Mic" };
65 static const char *deemph_text[] = {"None", "32Khz", "44.1Khz", "48Khz"};
67 static SOC_ENUM_SINGLE_DECL(rec_src_enum,
68 TLV320AIC23_ANLG, 2, rec_src_text);
70 static const struct snd_kcontrol_new tlv320aic23_rec_src_mux_controls =
71 SOC_DAPM_ENUM("Input Select", rec_src_enum);
73 static SOC_ENUM_SINGLE_DECL(tlv320aic23_rec_src,
74 TLV320AIC23_ANLG, 2, rec_src_text);
75 static SOC_ENUM_SINGLE_DECL(tlv320aic23_deemph,
76 TLV320AIC23_DIGT, 1, deemph_text);
78 static const DECLARE_TLV_DB_SCALE(out_gain_tlv, -12100, 100, 0);
79 static const DECLARE_TLV_DB_SCALE(input_gain_tlv, -1725, 75, 0);
80 static const DECLARE_TLV_DB_SCALE(sidetone_vol_tlv, -1800, 300, 0);
82 static int snd_soc_tlv320aic23_put_volsw(struct snd_kcontrol *kcontrol,
83 struct snd_ctl_elem_value *ucontrol)
85 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
88 val = (ucontrol->value.integer.value[0] & 0x07);
90 /* linear conversion to userspace
97 val = (val >= 4) ? 4 : (3 - val);
99 reg = snd_soc_read(codec, TLV320AIC23_ANLG) & (~0x1C0);
100 snd_soc_write(codec, TLV320AIC23_ANLG, reg | (val << 6));
105 static int snd_soc_tlv320aic23_get_volsw(struct snd_kcontrol *kcontrol,
106 struct snd_ctl_elem_value *ucontrol)
108 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
111 val = snd_soc_read(codec, TLV320AIC23_ANLG) & (0x1C0);
113 val = (val >= 4) ? 4 : (3 - val);
114 ucontrol->value.integer.value[0] = val;
119 static const struct snd_kcontrol_new tlv320aic23_snd_controls[] = {
120 SOC_DOUBLE_R_TLV("Digital Playback Volume", TLV320AIC23_LCHNVOL,
121 TLV320AIC23_RCHNVOL, 0, 127, 0, out_gain_tlv),
122 SOC_SINGLE("Digital Playback Switch", TLV320AIC23_DIGT, 3, 1, 1),
123 SOC_DOUBLE_R("Line Input Switch", TLV320AIC23_LINVOL,
124 TLV320AIC23_RINVOL, 7, 1, 0),
125 SOC_DOUBLE_R_TLV("Line Input Volume", TLV320AIC23_LINVOL,
126 TLV320AIC23_RINVOL, 0, 31, 0, input_gain_tlv),
127 SOC_SINGLE("Mic Input Switch", TLV320AIC23_ANLG, 1, 1, 1),
128 SOC_SINGLE("Mic Booster Switch", TLV320AIC23_ANLG, 0, 1, 0),
129 SOC_SINGLE_EXT_TLV("Sidetone Volume", TLV320AIC23_ANLG, 6, 4, 0,
130 snd_soc_tlv320aic23_get_volsw,
131 snd_soc_tlv320aic23_put_volsw, sidetone_vol_tlv),
132 SOC_ENUM("Playback De-emphasis", tlv320aic23_deemph),
135 /* PGA Mixer controls for Line and Mic switch */
136 static const struct snd_kcontrol_new tlv320aic23_output_mixer_controls[] = {
137 SOC_DAPM_SINGLE("Line Bypass Switch", TLV320AIC23_ANLG, 3, 1, 0),
138 SOC_DAPM_SINGLE("Mic Sidetone Switch", TLV320AIC23_ANLG, 5, 1, 0),
139 SOC_DAPM_SINGLE("Playback Switch", TLV320AIC23_ANLG, 4, 1, 0),
142 static const struct snd_soc_dapm_widget tlv320aic23_dapm_widgets[] = {
143 SND_SOC_DAPM_DAC("DAC", "Playback", TLV320AIC23_PWR, 3, 1),
144 SND_SOC_DAPM_ADC("ADC", "Capture", TLV320AIC23_PWR, 2, 1),
145 SND_SOC_DAPM_MUX("Capture Source", SND_SOC_NOPM, 0, 0,
146 &tlv320aic23_rec_src_mux_controls),
147 SND_SOC_DAPM_MIXER("Output Mixer", TLV320AIC23_PWR, 4, 1,
148 &tlv320aic23_output_mixer_controls[0],
149 ARRAY_SIZE(tlv320aic23_output_mixer_controls)),
150 SND_SOC_DAPM_PGA("Line Input", TLV320AIC23_PWR, 0, 1, NULL, 0),
151 SND_SOC_DAPM_PGA("Mic Input", TLV320AIC23_PWR, 1, 1, NULL, 0),
153 SND_SOC_DAPM_OUTPUT("LHPOUT"),
154 SND_SOC_DAPM_OUTPUT("RHPOUT"),
155 SND_SOC_DAPM_OUTPUT("LOUT"),
156 SND_SOC_DAPM_OUTPUT("ROUT"),
158 SND_SOC_DAPM_INPUT("LLINEIN"),
159 SND_SOC_DAPM_INPUT("RLINEIN"),
161 SND_SOC_DAPM_INPUT("MICIN"),
164 static const struct snd_soc_dapm_route tlv320aic23_intercon[] = {
166 {"Output Mixer", "Line Bypass Switch", "Line Input"},
167 {"Output Mixer", "Playback Switch", "DAC"},
168 {"Output Mixer", "Mic Sidetone Switch", "Mic Input"},
171 {"RHPOUT", NULL, "Output Mixer"},
172 {"LHPOUT", NULL, "Output Mixer"},
173 {"LOUT", NULL, "Output Mixer"},
174 {"ROUT", NULL, "Output Mixer"},
177 {"Line Input", "NULL", "LLINEIN"},
178 {"Line Input", "NULL", "RLINEIN"},
180 {"Mic Input", "NULL", "MICIN"},
183 {"Capture Source", "Line", "Line Input"},
184 {"Capture Source", "Mic", "Mic Input"},
185 {"ADC", NULL, "Capture Source"},
189 /* AIC23 driver data */
191 struct regmap *regmap;
198 * Common Crystals used
199 * 11.2896 Mhz /128 = *88.2k /192 = 58.8k
200 * 12.0000 Mhz /125 = *96k /136 = 88.235K
201 * 12.2880 Mhz /128 = *96k /192 = 64k
202 * 16.9344 Mhz /128 = 132.3k /192 = *88.2k
203 * 18.4320 Mhz /128 = 144k /192 = *96k
207 * Normal BOSR 0-256/2 = 128, 1-384/2 = 192
208 * USB BOSR 0-250/2 = 125, 1-272/2 = 136
210 static const int bosr_usb_divisor_table[] = {
213 #define LOWER_GROUP ((1<<0) | (1<<1) | (1<<2) | (1<<3) | (1<<6) | (1<<7))
214 #define UPPER_GROUP ((1<<8) | (1<<9) | (1<<10) | (1<<11) | (1<<15))
215 static const unsigned short sr_valid_mask[] = {
216 LOWER_GROUP|UPPER_GROUP, /* Normal, bosr - 0*/
217 LOWER_GROUP, /* Usb, bosr - 0*/
218 LOWER_GROUP|UPPER_GROUP, /* Normal, bosr - 1*/
219 UPPER_GROUP, /* Usb, bosr - 1*/
222 * Every divisor is a factor of 11*12
224 #define SR_MULT (11*12)
225 #define A(x) (SR_MULT/x)
226 static const unsigned char sr_adc_mult_table[] = {
227 A(2), A(2), A(12), A(12), 0, 0, A(3), A(1),
228 A(2), A(2), A(11), A(11), 0, 0, 0, A(1)
230 static const unsigned char sr_dac_mult_table[] = {
231 A(2), A(12), A(2), A(12), 0, 0, A(3), A(1),
232 A(2), A(11), A(2), A(11), 0, 0, 0, A(1)
235 static unsigned get_score(int adc, int adc_l, int adc_h, int need_adc,
236 int dac, int dac_l, int dac_h, int need_dac)
238 if ((adc >= adc_l) && (adc <= adc_h) &&
239 (dac >= dac_l) && (dac <= dac_h)) {
240 int diff_adc = need_adc - adc;
241 int diff_dac = need_dac - dac;
242 return abs(diff_adc) + abs(diff_dac);
247 static int find_rate(int mclk, u32 need_adc, u32 need_dac)
253 unsigned best_score = UINT_MAX;
254 int adc_l, adc_h, dac_l, dac_h;
259 * rates given are +/- 1/32
261 adc_l = need_adc - (need_adc >> 5);
262 adc_h = need_adc + (need_adc >> 5);
263 dac_l = need_dac - (need_dac >> 5);
264 dac_h = need_dac + (need_dac >> 5);
265 for (i = 0; i < ARRAY_SIZE(bosr_usb_divisor_table); i++) {
266 int base = mclk / bosr_usb_divisor_table[i];
267 int mask = sr_valid_mask[i];
268 for (j = 0; j < ARRAY_SIZE(sr_adc_mult_table);
275 adc = base * sr_adc_mult_table[j];
276 dac = base * sr_dac_mult_table[j];
277 score = get_score(adc, adc_l, adc_h, need_adc,
278 dac, dac_l, dac_h, need_dac);
279 if (best_score > score) {
285 score = get_score((adc >> 1), adc_l, adc_h, need_adc,
286 (dac >> 1), dac_l, dac_h, need_dac);
287 /* prefer to have a /2 */
288 if ((score != UINT_MAX) && (best_score >= score)) {
296 return (best_j << 2) | best_i | (best_div << TLV320AIC23_CLKIN_SHIFT);
300 static void get_current_sample_rates(struct snd_soc_codec *codec, int mclk,
301 u32 *sample_rate_adc, u32 *sample_rate_dac)
303 int src = snd_soc_read(codec, TLV320AIC23_SRATE);
304 int sr = (src >> 2) & 0x0f;
305 int val = (mclk / bosr_usb_divisor_table[src & 3]);
306 int adc = (val * sr_adc_mult_table[sr]) / SR_MULT;
307 int dac = (val * sr_dac_mult_table[sr]) / SR_MULT;
308 if (src & TLV320AIC23_CLKIN_HALF) {
312 *sample_rate_adc = adc;
313 *sample_rate_dac = dac;
317 static int set_sample_rate_control(struct snd_soc_codec *codec, int mclk,
318 u32 sample_rate_adc, u32 sample_rate_dac)
320 /* Search for the right sample rate */
321 int data = find_rate(mclk, sample_rate_adc, sample_rate_dac);
323 printk(KERN_ERR "%s:Invalid rate %u,%u requested\n",
324 __func__, sample_rate_adc, sample_rate_dac);
327 snd_soc_write(codec, TLV320AIC23_SRATE, data);
331 get_current_sample_rates(codec, mclk, &adc, &dac);
332 printk(KERN_DEBUG "actual samplerate = %u,%u reg=%x\n",
339 static int tlv320aic23_hw_params(struct snd_pcm_substream *substream,
340 struct snd_pcm_hw_params *params,
341 struct snd_soc_dai *dai)
343 struct snd_soc_codec *codec = dai->codec;
346 struct aic23 *aic23 = snd_soc_codec_get_drvdata(codec);
347 u32 sample_rate_adc = aic23->requested_adc;
348 u32 sample_rate_dac = aic23->requested_dac;
349 u32 sample_rate = params_rate(params);
351 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
352 aic23->requested_dac = sample_rate_dac = sample_rate;
353 if (!sample_rate_adc)
354 sample_rate_adc = sample_rate;
356 aic23->requested_adc = sample_rate_adc = sample_rate;
357 if (!sample_rate_dac)
358 sample_rate_dac = sample_rate;
360 ret = set_sample_rate_control(codec, aic23->mclk, sample_rate_adc,
365 iface_reg = snd_soc_read(codec, TLV320AIC23_DIGT_FMT) & ~(0x03 << 2);
367 switch (params_width(params)) {
371 iface_reg |= (0x01 << 2);
374 iface_reg |= (0x02 << 2);
377 iface_reg |= (0x03 << 2);
380 snd_soc_write(codec, TLV320AIC23_DIGT_FMT, iface_reg);
385 static int tlv320aic23_pcm_prepare(struct snd_pcm_substream *substream,
386 struct snd_soc_dai *dai)
388 struct snd_soc_codec *codec = dai->codec;
391 snd_soc_write(codec, TLV320AIC23_ACTIVE, 0x0001);
396 static void tlv320aic23_shutdown(struct snd_pcm_substream *substream,
397 struct snd_soc_dai *dai)
399 struct snd_soc_codec *codec = dai->codec;
400 struct aic23 *aic23 = snd_soc_codec_get_drvdata(codec);
403 if (!snd_soc_codec_is_active(codec)) {
405 snd_soc_write(codec, TLV320AIC23_ACTIVE, 0x0);
407 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
408 aic23->requested_dac = 0;
410 aic23->requested_adc = 0;
413 static int tlv320aic23_mute(struct snd_soc_dai *dai, int mute)
415 struct snd_soc_codec *codec = dai->codec;
418 reg = snd_soc_read(codec, TLV320AIC23_DIGT);
420 reg |= TLV320AIC23_DACM_MUTE;
423 reg &= ~TLV320AIC23_DACM_MUTE;
425 snd_soc_write(codec, TLV320AIC23_DIGT, reg);
430 static int tlv320aic23_set_dai_fmt(struct snd_soc_dai *codec_dai,
433 struct snd_soc_codec *codec = codec_dai->codec;
436 iface_reg = snd_soc_read(codec, TLV320AIC23_DIGT_FMT) & (~0x03);
438 /* set master/slave audio interface */
439 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
440 case SND_SOC_DAIFMT_CBM_CFM:
441 iface_reg |= TLV320AIC23_MS_MASTER;
443 case SND_SOC_DAIFMT_CBS_CFS:
444 iface_reg &= ~TLV320AIC23_MS_MASTER;
451 /* interface format */
452 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
453 case SND_SOC_DAIFMT_I2S:
454 iface_reg |= TLV320AIC23_FOR_I2S;
456 case SND_SOC_DAIFMT_DSP_A:
457 iface_reg |= TLV320AIC23_LRP_ON;
458 case SND_SOC_DAIFMT_DSP_B:
459 iface_reg |= TLV320AIC23_FOR_DSP;
461 case SND_SOC_DAIFMT_RIGHT_J:
463 case SND_SOC_DAIFMT_LEFT_J:
464 iface_reg |= TLV320AIC23_FOR_LJUST;
471 snd_soc_write(codec, TLV320AIC23_DIGT_FMT, iface_reg);
476 static int tlv320aic23_set_dai_sysclk(struct snd_soc_dai *codec_dai,
477 int clk_id, unsigned int freq, int dir)
479 struct aic23 *aic23 = snd_soc_dai_get_drvdata(codec_dai);
484 static int tlv320aic23_set_bias_level(struct snd_soc_codec *codec,
485 enum snd_soc_bias_level level)
487 u16 reg = snd_soc_read(codec, TLV320AIC23_PWR) & 0x17f;
490 case SND_SOC_BIAS_ON:
491 /* vref/mid, osc on, dac unmute */
492 reg &= ~(TLV320AIC23_DEVICE_PWR_OFF | TLV320AIC23_OSC_OFF | \
493 TLV320AIC23_DAC_OFF);
494 snd_soc_write(codec, TLV320AIC23_PWR, reg);
496 case SND_SOC_BIAS_PREPARE:
498 case SND_SOC_BIAS_STANDBY:
499 /* everything off except vref/vmid, */
500 snd_soc_write(codec, TLV320AIC23_PWR,
501 reg | TLV320AIC23_CLK_OFF);
503 case SND_SOC_BIAS_OFF:
504 /* everything off, dac mute, inactive */
505 snd_soc_write(codec, TLV320AIC23_ACTIVE, 0x0);
506 snd_soc_write(codec, TLV320AIC23_PWR, 0x1ff);
512 #define AIC23_RATES SNDRV_PCM_RATE_8000_96000
513 #define AIC23_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
514 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S32_LE)
516 static const struct snd_soc_dai_ops tlv320aic23_dai_ops = {
517 .prepare = tlv320aic23_pcm_prepare,
518 .hw_params = tlv320aic23_hw_params,
519 .shutdown = tlv320aic23_shutdown,
520 .digital_mute = tlv320aic23_mute,
521 .set_fmt = tlv320aic23_set_dai_fmt,
522 .set_sysclk = tlv320aic23_set_dai_sysclk,
525 static struct snd_soc_dai_driver tlv320aic23_dai = {
526 .name = "tlv320aic23-hifi",
528 .stream_name = "Playback",
531 .rates = AIC23_RATES,
532 .formats = AIC23_FORMATS,},
534 .stream_name = "Capture",
537 .rates = AIC23_RATES,
538 .formats = AIC23_FORMATS,},
539 .ops = &tlv320aic23_dai_ops,
542 static int tlv320aic23_resume(struct snd_soc_codec *codec)
544 struct aic23 *aic23 = snd_soc_codec_get_drvdata(codec);
545 regcache_mark_dirty(aic23->regmap);
546 regcache_sync(aic23->regmap);
551 static int tlv320aic23_codec_probe(struct snd_soc_codec *codec)
554 snd_soc_write(codec, TLV320AIC23_RESET, 0);
556 snd_soc_write(codec, TLV320AIC23_DIGT, TLV320AIC23_DEEMP_44K);
559 snd_soc_update_bits(codec, TLV320AIC23_LINVOL,
560 TLV320AIC23_LIM_MUTED, TLV320AIC23_LRS_ENABLED);
562 snd_soc_update_bits(codec, TLV320AIC23_RINVOL,
563 TLV320AIC23_LIM_MUTED, TLV320AIC23_LRS_ENABLED);
565 snd_soc_update_bits(codec, TLV320AIC23_ANLG,
566 TLV320AIC23_BYPASS_ON | TLV320AIC23_MICM_MUTED,
569 /* Default output volume */
570 snd_soc_write(codec, TLV320AIC23_LCHNVOL,
571 TLV320AIC23_DEFAULT_OUT_VOL & TLV320AIC23_OUT_VOL_MASK);
572 snd_soc_write(codec, TLV320AIC23_RCHNVOL,
573 TLV320AIC23_DEFAULT_OUT_VOL & TLV320AIC23_OUT_VOL_MASK);
575 snd_soc_write(codec, TLV320AIC23_ACTIVE, 0x1);
580 static struct snd_soc_codec_driver soc_codec_dev_tlv320aic23 = {
581 .probe = tlv320aic23_codec_probe,
582 .resume = tlv320aic23_resume,
583 .set_bias_level = tlv320aic23_set_bias_level,
584 .suspend_bias_off = true,
586 .component_driver = {
587 .controls = tlv320aic23_snd_controls,
588 .num_controls = ARRAY_SIZE(tlv320aic23_snd_controls),
589 .dapm_widgets = tlv320aic23_dapm_widgets,
590 .num_dapm_widgets = ARRAY_SIZE(tlv320aic23_dapm_widgets),
591 .dapm_routes = tlv320aic23_intercon,
592 .num_dapm_routes = ARRAY_SIZE(tlv320aic23_intercon),
596 int tlv320aic23_probe(struct device *dev, struct regmap *regmap)
601 return PTR_ERR(regmap);
603 aic23 = devm_kzalloc(dev, sizeof(struct aic23), GFP_KERNEL);
607 aic23->regmap = regmap;
609 dev_set_drvdata(dev, aic23);
611 return snd_soc_register_codec(dev, &soc_codec_dev_tlv320aic23,
612 &tlv320aic23_dai, 1);
614 EXPORT_SYMBOL(tlv320aic23_probe);
616 MODULE_DESCRIPTION("ASoC TLV320AIC23 codec driver");
617 MODULE_AUTHOR("Arun KS <arunks@mistralsolutions.com>");
618 MODULE_LICENSE("GPL");