1 // SPDX-License-Identifier: GPL-2.0-only
3 * ALSA SoC TLV320AIC23 codec driver
6 * Copyright: (C) 2008 Mistral Solutions Pvt Ltd.,
8 * Based on sound/soc/codecs/wm8731.c by Richard Purdie
11 * The AIC23 is a driver for a low power stereo audio
14 * The machine layer should disable unsupported inputs/outputs by
15 * snd_soc_dapm_disable_pin(codec, "LHPOUT"), etc.
18 #include <linux/module.h>
19 #include <linux/moduleparam.h>
20 #include <linux/init.h>
21 #include <linux/delay.h>
23 #include <linux/regmap.h>
24 #include <linux/slab.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/soc.h>
29 #include <sound/tlv.h>
30 #include <sound/initval.h>
32 #include "tlv320aic23.h"
35 * AIC23 register cache
37 static const struct reg_default tlv320aic23_reg[] = {
50 const struct regmap_config tlv320aic23_regmap = {
54 .max_register = TLV320AIC23_RESET,
55 .reg_defaults = tlv320aic23_reg,
56 .num_reg_defaults = ARRAY_SIZE(tlv320aic23_reg),
57 .cache_type = REGCACHE_RBTREE,
59 EXPORT_SYMBOL(tlv320aic23_regmap);
61 static const char *rec_src_text[] = { "Line", "Mic" };
62 static const char *deemph_text[] = {"None", "32Khz", "44.1Khz", "48Khz"};
64 static SOC_ENUM_SINGLE_DECL(rec_src_enum,
65 TLV320AIC23_ANLG, 2, rec_src_text);
67 static const struct snd_kcontrol_new tlv320aic23_rec_src_mux_controls =
68 SOC_DAPM_ENUM("Input Select", rec_src_enum);
70 static SOC_ENUM_SINGLE_DECL(tlv320aic23_deemph,
71 TLV320AIC23_DIGT, 1, deemph_text);
73 static const DECLARE_TLV_DB_SCALE(out_gain_tlv, -12100, 100, 0);
74 static const DECLARE_TLV_DB_SCALE(input_gain_tlv, -1725, 75, 0);
75 static const DECLARE_TLV_DB_SCALE(sidetone_vol_tlv, -1800, 300, 0);
77 static int snd_soc_tlv320aic23_put_volsw(struct snd_kcontrol *kcontrol,
78 struct snd_ctl_elem_value *ucontrol)
80 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
83 val = (ucontrol->value.integer.value[0] & 0x07);
85 /* linear conversion to userspace
92 val = (val >= 4) ? 4 : (3 - val);
94 reg = snd_soc_component_read(component, TLV320AIC23_ANLG) & (~0x1C0);
95 snd_soc_component_write(component, TLV320AIC23_ANLG, reg | (val << 6));
100 static int snd_soc_tlv320aic23_get_volsw(struct snd_kcontrol *kcontrol,
101 struct snd_ctl_elem_value *ucontrol)
103 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
106 val = snd_soc_component_read(component, TLV320AIC23_ANLG) & (0x1C0);
108 val = (val >= 4) ? 4 : (3 - val);
109 ucontrol->value.integer.value[0] = val;
114 static const struct snd_kcontrol_new tlv320aic23_snd_controls[] = {
115 SOC_DOUBLE_R_TLV("Digital Playback Volume", TLV320AIC23_LCHNVOL,
116 TLV320AIC23_RCHNVOL, 0, 127, 0, out_gain_tlv),
117 SOC_SINGLE("Digital Playback Switch", TLV320AIC23_DIGT, 3, 1, 1),
118 SOC_DOUBLE_R("Line Input Switch", TLV320AIC23_LINVOL,
119 TLV320AIC23_RINVOL, 7, 1, 0),
120 SOC_DOUBLE_R_TLV("Line Input Volume", TLV320AIC23_LINVOL,
121 TLV320AIC23_RINVOL, 0, 31, 0, input_gain_tlv),
122 SOC_SINGLE("Mic Input Switch", TLV320AIC23_ANLG, 1, 1, 1),
123 SOC_SINGLE("Mic Booster Switch", TLV320AIC23_ANLG, 0, 1, 0),
124 SOC_SINGLE_EXT_TLV("Sidetone Volume", TLV320AIC23_ANLG, 6, 4, 0,
125 snd_soc_tlv320aic23_get_volsw,
126 snd_soc_tlv320aic23_put_volsw, sidetone_vol_tlv),
127 SOC_ENUM("Playback De-emphasis", tlv320aic23_deemph),
130 /* PGA Mixer controls for Line and Mic switch */
131 static const struct snd_kcontrol_new tlv320aic23_output_mixer_controls[] = {
132 SOC_DAPM_SINGLE("Line Bypass Switch", TLV320AIC23_ANLG, 3, 1, 0),
133 SOC_DAPM_SINGLE("Mic Sidetone Switch", TLV320AIC23_ANLG, 5, 1, 0),
134 SOC_DAPM_SINGLE("Playback Switch", TLV320AIC23_ANLG, 4, 1, 0),
137 static const struct snd_soc_dapm_widget tlv320aic23_dapm_widgets[] = {
138 SND_SOC_DAPM_DAC("DAC", "Playback", TLV320AIC23_PWR, 3, 1),
139 SND_SOC_DAPM_ADC("ADC", "Capture", TLV320AIC23_PWR, 2, 1),
140 SND_SOC_DAPM_MUX("Capture Source", SND_SOC_NOPM, 0, 0,
141 &tlv320aic23_rec_src_mux_controls),
142 SND_SOC_DAPM_MIXER("Output Mixer", TLV320AIC23_PWR, 4, 1,
143 &tlv320aic23_output_mixer_controls[0],
144 ARRAY_SIZE(tlv320aic23_output_mixer_controls)),
145 SND_SOC_DAPM_PGA("Line Input", TLV320AIC23_PWR, 0, 1, NULL, 0),
146 SND_SOC_DAPM_PGA("Mic Input", TLV320AIC23_PWR, 1, 1, NULL, 0),
148 SND_SOC_DAPM_OUTPUT("LHPOUT"),
149 SND_SOC_DAPM_OUTPUT("RHPOUT"),
150 SND_SOC_DAPM_OUTPUT("LOUT"),
151 SND_SOC_DAPM_OUTPUT("ROUT"),
153 SND_SOC_DAPM_INPUT("LLINEIN"),
154 SND_SOC_DAPM_INPUT("RLINEIN"),
156 SND_SOC_DAPM_INPUT("MICIN"),
159 static const struct snd_soc_dapm_route tlv320aic23_intercon[] = {
161 {"Output Mixer", "Line Bypass Switch", "Line Input"},
162 {"Output Mixer", "Playback Switch", "DAC"},
163 {"Output Mixer", "Mic Sidetone Switch", "Mic Input"},
166 {"RHPOUT", NULL, "Output Mixer"},
167 {"LHPOUT", NULL, "Output Mixer"},
168 {"LOUT", NULL, "Output Mixer"},
169 {"ROUT", NULL, "Output Mixer"},
172 {"Line Input", NULL, "LLINEIN"},
173 {"Line Input", NULL, "RLINEIN"},
174 {"Mic Input", NULL, "MICIN"},
177 {"Capture Source", "Line", "Line Input"},
178 {"Capture Source", "Mic", "Mic Input"},
179 {"ADC", NULL, "Capture Source"},
183 /* AIC23 driver data */
185 struct regmap *regmap;
192 * Common Crystals used
193 * 11.2896 Mhz /128 = *88.2k /192 = 58.8k
194 * 12.0000 Mhz /125 = *96k /136 = 88.235K
195 * 12.2880 Mhz /128 = *96k /192 = 64k
196 * 16.9344 Mhz /128 = 132.3k /192 = *88.2k
197 * 18.4320 Mhz /128 = 144k /192 = *96k
201 * Normal BOSR 0-256/2 = 128, 1-384/2 = 192
202 * USB BOSR 0-250/2 = 125, 1-272/2 = 136
204 static const int bosr_usb_divisor_table[] = {
207 #define LOWER_GROUP ((1<<0) | (1<<1) | (1<<2) | (1<<3) | (1<<6) | (1<<7))
208 #define UPPER_GROUP ((1<<8) | (1<<9) | (1<<10) | (1<<11) | (1<<15))
209 static const unsigned short sr_valid_mask[] = {
210 LOWER_GROUP|UPPER_GROUP, /* Normal, bosr - 0*/
211 LOWER_GROUP, /* Usb, bosr - 0*/
212 LOWER_GROUP|UPPER_GROUP, /* Normal, bosr - 1*/
213 UPPER_GROUP, /* Usb, bosr - 1*/
216 * Every divisor is a factor of 11*12
218 #define SR_MULT (11*12)
219 #define A(x) (SR_MULT/x)
220 static const unsigned char sr_adc_mult_table[] = {
221 A(2), A(2), A(12), A(12), 0, 0, A(3), A(1),
222 A(2), A(2), A(11), A(11), 0, 0, 0, A(1)
224 static const unsigned char sr_dac_mult_table[] = {
225 A(2), A(12), A(2), A(12), 0, 0, A(3), A(1),
226 A(2), A(11), A(2), A(11), 0, 0, 0, A(1)
229 static unsigned get_score(int adc, int adc_l, int adc_h, int need_adc,
230 int dac, int dac_l, int dac_h, int need_dac)
232 if ((adc >= adc_l) && (adc <= adc_h) &&
233 (dac >= dac_l) && (dac <= dac_h)) {
234 int diff_adc = need_adc - adc;
235 int diff_dac = need_dac - dac;
236 return abs(diff_adc) + abs(diff_dac);
241 static int find_rate(int mclk, u32 need_adc, u32 need_dac)
247 unsigned best_score = UINT_MAX;
248 int adc_l, adc_h, dac_l, dac_h;
253 * rates given are +/- 1/32
255 adc_l = need_adc - (need_adc >> 5);
256 adc_h = need_adc + (need_adc >> 5);
257 dac_l = need_dac - (need_dac >> 5);
258 dac_h = need_dac + (need_dac >> 5);
259 for (i = 0; i < ARRAY_SIZE(bosr_usb_divisor_table); i++) {
260 int base = mclk / bosr_usb_divisor_table[i];
261 int mask = sr_valid_mask[i];
262 for (j = 0; j < ARRAY_SIZE(sr_adc_mult_table);
269 adc = base * sr_adc_mult_table[j];
270 dac = base * sr_dac_mult_table[j];
271 score = get_score(adc, adc_l, adc_h, need_adc,
272 dac, dac_l, dac_h, need_dac);
273 if (best_score > score) {
279 score = get_score((adc >> 1), adc_l, adc_h, need_adc,
280 (dac >> 1), dac_l, dac_h, need_dac);
281 /* prefer to have a /2 */
282 if ((score != UINT_MAX) && (best_score >= score)) {
290 return (best_j << 2) | best_i | (best_div << TLV320AIC23_CLKIN_SHIFT);
294 static void get_current_sample_rates(struct snd_soc_component *component, int mclk,
295 u32 *sample_rate_adc, u32 *sample_rate_dac)
297 int src = snd_soc_component_read(component, TLV320AIC23_SRATE);
298 int sr = (src >> 2) & 0x0f;
299 int val = (mclk / bosr_usb_divisor_table[src & 3]);
300 int adc = (val * sr_adc_mult_table[sr]) / SR_MULT;
301 int dac = (val * sr_dac_mult_table[sr]) / SR_MULT;
302 if (src & TLV320AIC23_CLKIN_HALF) {
306 *sample_rate_adc = adc;
307 *sample_rate_dac = dac;
311 static int set_sample_rate_control(struct snd_soc_component *component, int mclk,
312 u32 sample_rate_adc, u32 sample_rate_dac)
314 /* Search for the right sample rate */
315 int data = find_rate(mclk, sample_rate_adc, sample_rate_dac);
317 printk(KERN_ERR "%s:Invalid rate %u,%u requested\n",
318 __func__, sample_rate_adc, sample_rate_dac);
321 snd_soc_component_write(component, TLV320AIC23_SRATE, data);
325 get_current_sample_rates(component, mclk, &adc, &dac);
326 printk(KERN_DEBUG "actual samplerate = %u,%u reg=%x\n",
333 static int tlv320aic23_hw_params(struct snd_pcm_substream *substream,
334 struct snd_pcm_hw_params *params,
335 struct snd_soc_dai *dai)
337 struct snd_soc_component *component = dai->component;
340 struct aic23 *aic23 = snd_soc_component_get_drvdata(component);
341 u32 sample_rate_adc = aic23->requested_adc;
342 u32 sample_rate_dac = aic23->requested_dac;
343 u32 sample_rate = params_rate(params);
345 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
346 aic23->requested_dac = sample_rate_dac = sample_rate;
347 if (!sample_rate_adc)
348 sample_rate_adc = sample_rate;
350 aic23->requested_adc = sample_rate_adc = sample_rate;
351 if (!sample_rate_dac)
352 sample_rate_dac = sample_rate;
354 ret = set_sample_rate_control(component, aic23->mclk, sample_rate_adc,
359 iface_reg = snd_soc_component_read(component, TLV320AIC23_DIGT_FMT) & ~(0x03 << 2);
361 switch (params_width(params)) {
365 iface_reg |= (0x01 << 2);
368 iface_reg |= (0x02 << 2);
371 iface_reg |= (0x03 << 2);
374 snd_soc_component_write(component, TLV320AIC23_DIGT_FMT, iface_reg);
379 static int tlv320aic23_pcm_prepare(struct snd_pcm_substream *substream,
380 struct snd_soc_dai *dai)
382 struct snd_soc_component *component = dai->component;
385 snd_soc_component_write(component, TLV320AIC23_ACTIVE, 0x0001);
390 static void tlv320aic23_shutdown(struct snd_pcm_substream *substream,
391 struct snd_soc_dai *dai)
393 struct snd_soc_component *component = dai->component;
394 struct aic23 *aic23 = snd_soc_component_get_drvdata(component);
397 if (!snd_soc_component_active(component)) {
399 snd_soc_component_write(component, TLV320AIC23_ACTIVE, 0x0);
401 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
402 aic23->requested_dac = 0;
404 aic23->requested_adc = 0;
407 static int tlv320aic23_mute(struct snd_soc_dai *dai, int mute, int direction)
409 struct snd_soc_component *component = dai->component;
412 reg = snd_soc_component_read(component, TLV320AIC23_DIGT);
414 reg |= TLV320AIC23_DACM_MUTE;
417 reg &= ~TLV320AIC23_DACM_MUTE;
419 snd_soc_component_write(component, TLV320AIC23_DIGT, reg);
424 static int tlv320aic23_set_dai_fmt(struct snd_soc_dai *codec_dai,
427 struct snd_soc_component *component = codec_dai->component;
430 iface_reg = snd_soc_component_read(component, TLV320AIC23_DIGT_FMT) & (~0x03);
432 /* set master/slave audio interface */
433 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
434 case SND_SOC_DAIFMT_CBM_CFM:
435 iface_reg |= TLV320AIC23_MS_MASTER;
437 case SND_SOC_DAIFMT_CBS_CFS:
438 iface_reg &= ~TLV320AIC23_MS_MASTER;
445 /* interface format */
446 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
447 case SND_SOC_DAIFMT_I2S:
448 iface_reg |= TLV320AIC23_FOR_I2S;
450 case SND_SOC_DAIFMT_DSP_A:
451 iface_reg |= TLV320AIC23_LRP_ON;
453 case SND_SOC_DAIFMT_DSP_B:
454 iface_reg |= TLV320AIC23_FOR_DSP;
456 case SND_SOC_DAIFMT_RIGHT_J:
458 case SND_SOC_DAIFMT_LEFT_J:
459 iface_reg |= TLV320AIC23_FOR_LJUST;
466 snd_soc_component_write(component, TLV320AIC23_DIGT_FMT, iface_reg);
471 static int tlv320aic23_set_dai_sysclk(struct snd_soc_dai *codec_dai,
472 int clk_id, unsigned int freq, int dir)
474 struct aic23 *aic23 = snd_soc_dai_get_drvdata(codec_dai);
479 static int tlv320aic23_set_bias_level(struct snd_soc_component *component,
480 enum snd_soc_bias_level level)
482 u16 reg = snd_soc_component_read(component, TLV320AIC23_PWR) & 0x17f;
485 case SND_SOC_BIAS_ON:
486 /* vref/mid, osc on, dac unmute */
487 reg &= ~(TLV320AIC23_DEVICE_PWR_OFF | TLV320AIC23_OSC_OFF | \
488 TLV320AIC23_DAC_OFF);
489 snd_soc_component_write(component, TLV320AIC23_PWR, reg);
491 case SND_SOC_BIAS_PREPARE:
493 case SND_SOC_BIAS_STANDBY:
494 /* everything off except vref/vmid, */
495 snd_soc_component_write(component, TLV320AIC23_PWR,
496 reg | TLV320AIC23_CLK_OFF);
498 case SND_SOC_BIAS_OFF:
499 /* everything off, dac mute, inactive */
500 snd_soc_component_write(component, TLV320AIC23_ACTIVE, 0x0);
501 snd_soc_component_write(component, TLV320AIC23_PWR, 0x1ff);
507 #define AIC23_RATES SNDRV_PCM_RATE_8000_96000
508 #define AIC23_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
509 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S32_LE)
511 static const struct snd_soc_dai_ops tlv320aic23_dai_ops = {
512 .prepare = tlv320aic23_pcm_prepare,
513 .hw_params = tlv320aic23_hw_params,
514 .shutdown = tlv320aic23_shutdown,
515 .mute_stream = tlv320aic23_mute,
516 .set_fmt = tlv320aic23_set_dai_fmt,
517 .set_sysclk = tlv320aic23_set_dai_sysclk,
518 .no_capture_mute = 1,
521 static struct snd_soc_dai_driver tlv320aic23_dai = {
522 .name = "tlv320aic23-hifi",
524 .stream_name = "Playback",
527 .rates = AIC23_RATES,
528 .formats = AIC23_FORMATS,},
530 .stream_name = "Capture",
533 .rates = AIC23_RATES,
534 .formats = AIC23_FORMATS,},
535 .ops = &tlv320aic23_dai_ops,
538 static int tlv320aic23_resume(struct snd_soc_component *component)
540 struct aic23 *aic23 = snd_soc_component_get_drvdata(component);
541 regcache_mark_dirty(aic23->regmap);
542 regcache_sync(aic23->regmap);
547 static int tlv320aic23_component_probe(struct snd_soc_component *component)
550 snd_soc_component_write(component, TLV320AIC23_RESET, 0);
552 snd_soc_component_write(component, TLV320AIC23_DIGT, TLV320AIC23_DEEMP_44K);
555 snd_soc_component_update_bits(component, TLV320AIC23_LINVOL,
556 TLV320AIC23_LIM_MUTED, TLV320AIC23_LRS_ENABLED);
558 snd_soc_component_update_bits(component, TLV320AIC23_RINVOL,
559 TLV320AIC23_LIM_MUTED, TLV320AIC23_LRS_ENABLED);
561 snd_soc_component_update_bits(component, TLV320AIC23_ANLG,
562 TLV320AIC23_BYPASS_ON | TLV320AIC23_MICM_MUTED,
565 /* Default output volume */
566 snd_soc_component_write(component, TLV320AIC23_LCHNVOL,
567 TLV320AIC23_DEFAULT_OUT_VOL & TLV320AIC23_OUT_VOL_MASK);
568 snd_soc_component_write(component, TLV320AIC23_RCHNVOL,
569 TLV320AIC23_DEFAULT_OUT_VOL & TLV320AIC23_OUT_VOL_MASK);
571 snd_soc_component_write(component, TLV320AIC23_ACTIVE, 0x1);
576 static const struct snd_soc_component_driver soc_component_dev_tlv320aic23 = {
577 .probe = tlv320aic23_component_probe,
578 .resume = tlv320aic23_resume,
579 .set_bias_level = tlv320aic23_set_bias_level,
580 .controls = tlv320aic23_snd_controls,
581 .num_controls = ARRAY_SIZE(tlv320aic23_snd_controls),
582 .dapm_widgets = tlv320aic23_dapm_widgets,
583 .num_dapm_widgets = ARRAY_SIZE(tlv320aic23_dapm_widgets),
584 .dapm_routes = tlv320aic23_intercon,
585 .num_dapm_routes = ARRAY_SIZE(tlv320aic23_intercon),
586 .suspend_bias_off = 1,
588 .use_pmdown_time = 1,
590 .non_legacy_dai_naming = 1,
593 int tlv320aic23_probe(struct device *dev, struct regmap *regmap)
598 return PTR_ERR(regmap);
600 aic23 = devm_kzalloc(dev, sizeof(struct aic23), GFP_KERNEL);
604 aic23->regmap = regmap;
606 dev_set_drvdata(dev, aic23);
608 return devm_snd_soc_register_component(dev,
609 &soc_component_dev_tlv320aic23,
610 &tlv320aic23_dai, 1);
612 EXPORT_SYMBOL(tlv320aic23_probe);
614 MODULE_DESCRIPTION("ASoC TLV320AIC23 codec driver");
616 MODULE_LICENSE("GPL");