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"},
179 {"Mic Input", NULL
, "MICIN"},
182 {"Capture Source", "Line", "Line Input"},
183 {"Capture Source", "Mic", "Mic Input"},
184 {"ADC", NULL
, "Capture Source"},
188 /* AIC23 driver data */
190 struct regmap
*regmap
;
197 * Common Crystals used
198 * 11.2896 Mhz /128 = *88.2k /192 = 58.8k
199 * 12.0000 Mhz /125 = *96k /136 = 88.235K
200 * 12.2880 Mhz /128 = *96k /192 = 64k
201 * 16.9344 Mhz /128 = 132.3k /192 = *88.2k
202 * 18.4320 Mhz /128 = 144k /192 = *96k
206 * Normal BOSR 0-256/2 = 128, 1-384/2 = 192
207 * USB BOSR 0-250/2 = 125, 1-272/2 = 136
209 static const int bosr_usb_divisor_table
[] = {
212 #define LOWER_GROUP ((1<<0) | (1<<1) | (1<<2) | (1<<3) | (1<<6) | (1<<7))
213 #define UPPER_GROUP ((1<<8) | (1<<9) | (1<<10) | (1<<11) | (1<<15))
214 static const unsigned short sr_valid_mask
[] = {
215 LOWER_GROUP
|UPPER_GROUP
, /* Normal, bosr - 0*/
216 LOWER_GROUP
, /* Usb, bosr - 0*/
217 LOWER_GROUP
|UPPER_GROUP
, /* Normal, bosr - 1*/
218 UPPER_GROUP
, /* Usb, bosr - 1*/
221 * Every divisor is a factor of 11*12
223 #define SR_MULT (11*12)
224 #define A(x) (SR_MULT/x)
225 static const unsigned char sr_adc_mult_table
[] = {
226 A(2), A(2), A(12), A(12), 0, 0, A(3), A(1),
227 A(2), A(2), A(11), A(11), 0, 0, 0, A(1)
229 static const unsigned char sr_dac_mult_table
[] = {
230 A(2), A(12), A(2), A(12), 0, 0, A(3), A(1),
231 A(2), A(11), A(2), A(11), 0, 0, 0, A(1)
234 static unsigned get_score(int adc
, int adc_l
, int adc_h
, int need_adc
,
235 int dac
, int dac_l
, int dac_h
, int need_dac
)
237 if ((adc
>= adc_l
) && (adc
<= adc_h
) &&
238 (dac
>= dac_l
) && (dac
<= dac_h
)) {
239 int diff_adc
= need_adc
- adc
;
240 int diff_dac
= need_dac
- dac
;
241 return abs(diff_adc
) + abs(diff_dac
);
246 static int find_rate(int mclk
, u32 need_adc
, u32 need_dac
)
252 unsigned best_score
= UINT_MAX
;
253 int adc_l
, adc_h
, dac_l
, dac_h
;
258 * rates given are +/- 1/32
260 adc_l
= need_adc
- (need_adc
>> 5);
261 adc_h
= need_adc
+ (need_adc
>> 5);
262 dac_l
= need_dac
- (need_dac
>> 5);
263 dac_h
= need_dac
+ (need_dac
>> 5);
264 for (i
= 0; i
< ARRAY_SIZE(bosr_usb_divisor_table
); i
++) {
265 int base
= mclk
/ bosr_usb_divisor_table
[i
];
266 int mask
= sr_valid_mask
[i
];
267 for (j
= 0; j
< ARRAY_SIZE(sr_adc_mult_table
);
274 adc
= base
* sr_adc_mult_table
[j
];
275 dac
= base
* sr_dac_mult_table
[j
];
276 score
= get_score(adc
, adc_l
, adc_h
, need_adc
,
277 dac
, dac_l
, dac_h
, need_dac
);
278 if (best_score
> score
) {
284 score
= get_score((adc
>> 1), adc_l
, adc_h
, need_adc
,
285 (dac
>> 1), dac_l
, dac_h
, need_dac
);
286 /* prefer to have a /2 */
287 if ((score
!= UINT_MAX
) && (best_score
>= score
)) {
295 return (best_j
<< 2) | best_i
| (best_div
<< TLV320AIC23_CLKIN_SHIFT
);
299 static void get_current_sample_rates(struct snd_soc_codec
*codec
, int mclk
,
300 u32
*sample_rate_adc
, u32
*sample_rate_dac
)
302 int src
= snd_soc_read(codec
, TLV320AIC23_SRATE
);
303 int sr
= (src
>> 2) & 0x0f;
304 int val
= (mclk
/ bosr_usb_divisor_table
[src
& 3]);
305 int adc
= (val
* sr_adc_mult_table
[sr
]) / SR_MULT
;
306 int dac
= (val
* sr_dac_mult_table
[sr
]) / SR_MULT
;
307 if (src
& TLV320AIC23_CLKIN_HALF
) {
311 *sample_rate_adc
= adc
;
312 *sample_rate_dac
= dac
;
316 static int set_sample_rate_control(struct snd_soc_codec
*codec
, int mclk
,
317 u32 sample_rate_adc
, u32 sample_rate_dac
)
319 /* Search for the right sample rate */
320 int data
= find_rate(mclk
, sample_rate_adc
, sample_rate_dac
);
322 printk(KERN_ERR
"%s:Invalid rate %u,%u requested\n",
323 __func__
, sample_rate_adc
, sample_rate_dac
);
326 snd_soc_write(codec
, TLV320AIC23_SRATE
, data
);
330 get_current_sample_rates(codec
, mclk
, &adc
, &dac
);
331 printk(KERN_DEBUG
"actual samplerate = %u,%u reg=%x\n",
338 static int tlv320aic23_hw_params(struct snd_pcm_substream
*substream
,
339 struct snd_pcm_hw_params
*params
,
340 struct snd_soc_dai
*dai
)
342 struct snd_soc_codec
*codec
= dai
->codec
;
345 struct aic23
*aic23
= snd_soc_codec_get_drvdata(codec
);
346 u32 sample_rate_adc
= aic23
->requested_adc
;
347 u32 sample_rate_dac
= aic23
->requested_dac
;
348 u32 sample_rate
= params_rate(params
);
350 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
) {
351 aic23
->requested_dac
= sample_rate_dac
= sample_rate
;
352 if (!sample_rate_adc
)
353 sample_rate_adc
= sample_rate
;
355 aic23
->requested_adc
= sample_rate_adc
= sample_rate
;
356 if (!sample_rate_dac
)
357 sample_rate_dac
= sample_rate
;
359 ret
= set_sample_rate_control(codec
, aic23
->mclk
, sample_rate_adc
,
364 iface_reg
= snd_soc_read(codec
, TLV320AIC23_DIGT_FMT
) & ~(0x03 << 2);
366 switch (params_width(params
)) {
370 iface_reg
|= (0x01 << 2);
373 iface_reg
|= (0x02 << 2);
376 iface_reg
|= (0x03 << 2);
379 snd_soc_write(codec
, TLV320AIC23_DIGT_FMT
, iface_reg
);
384 static int tlv320aic23_pcm_prepare(struct snd_pcm_substream
*substream
,
385 struct snd_soc_dai
*dai
)
387 struct snd_soc_codec
*codec
= dai
->codec
;
390 snd_soc_write(codec
, TLV320AIC23_ACTIVE
, 0x0001);
395 static void tlv320aic23_shutdown(struct snd_pcm_substream
*substream
,
396 struct snd_soc_dai
*dai
)
398 struct snd_soc_codec
*codec
= dai
->codec
;
399 struct aic23
*aic23
= snd_soc_codec_get_drvdata(codec
);
402 if (!snd_soc_codec_is_active(codec
)) {
404 snd_soc_write(codec
, TLV320AIC23_ACTIVE
, 0x0);
406 if (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
)
407 aic23
->requested_dac
= 0;
409 aic23
->requested_adc
= 0;
412 static int tlv320aic23_mute(struct snd_soc_dai
*dai
, int mute
)
414 struct snd_soc_codec
*codec
= dai
->codec
;
417 reg
= snd_soc_read(codec
, TLV320AIC23_DIGT
);
419 reg
|= TLV320AIC23_DACM_MUTE
;
422 reg
&= ~TLV320AIC23_DACM_MUTE
;
424 snd_soc_write(codec
, TLV320AIC23_DIGT
, reg
);
429 static int tlv320aic23_set_dai_fmt(struct snd_soc_dai
*codec_dai
,
432 struct snd_soc_codec
*codec
= codec_dai
->codec
;
435 iface_reg
= snd_soc_read(codec
, TLV320AIC23_DIGT_FMT
) & (~0x03);
437 /* set master/slave audio interface */
438 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
439 case SND_SOC_DAIFMT_CBM_CFM
:
440 iface_reg
|= TLV320AIC23_MS_MASTER
;
442 case SND_SOC_DAIFMT_CBS_CFS
:
443 iface_reg
&= ~TLV320AIC23_MS_MASTER
;
450 /* interface format */
451 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
452 case SND_SOC_DAIFMT_I2S
:
453 iface_reg
|= TLV320AIC23_FOR_I2S
;
455 case SND_SOC_DAIFMT_DSP_A
:
456 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 const 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");