1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * AD193X Audio Codec driver supporting AD1936/7/8/9
5 * Copyright 2010 Analog Devices Inc.
8 #include <linux/module.h>
9 #include <linux/kernel.h>
10 #include <linux/device.h>
11 #include <linux/regmap.h>
12 #include <linux/slab.h>
13 #include <sound/core.h>
14 #include <sound/pcm.h>
15 #include <sound/pcm_params.h>
16 #include <sound/initval.h>
17 #include <sound/soc.h>
18 #include <sound/tlv.h>
22 /* codec private data */
24 struct regmap *regmap;
25 enum ad193x_type type;
30 * AD193X volume/mute/de-emphasis etc. controls
32 static const char * const ad193x_deemp[] = {"None", "48kHz", "44.1kHz", "32kHz"};
34 static SOC_ENUM_SINGLE_DECL(ad193x_deemp_enum, AD193X_DAC_CTRL2, 1,
37 static const DECLARE_TLV_DB_MINMAX(adau193x_tlv, -9563, 0);
39 static const unsigned int ad193x_sb[] = {32};
41 static struct snd_pcm_hw_constraint_list constr = {
43 .count = ARRAY_SIZE(ad193x_sb),
46 static const struct snd_kcontrol_new ad193x_snd_controls[] = {
47 /* DAC volume control */
48 SOC_DOUBLE_R_TLV("DAC1 Volume", AD193X_DAC_L1_VOL,
49 AD193X_DAC_R1_VOL, 0, 0xFF, 1, adau193x_tlv),
50 SOC_DOUBLE_R_TLV("DAC2 Volume", AD193X_DAC_L2_VOL,
51 AD193X_DAC_R2_VOL, 0, 0xFF, 1, adau193x_tlv),
52 SOC_DOUBLE_R_TLV("DAC3 Volume", AD193X_DAC_L3_VOL,
53 AD193X_DAC_R3_VOL, 0, 0xFF, 1, adau193x_tlv),
54 SOC_DOUBLE_R_TLV("DAC4 Volume", AD193X_DAC_L4_VOL,
55 AD193X_DAC_R4_VOL, 0, 0xFF, 1, adau193x_tlv),
57 /* DAC switch control */
58 SOC_DOUBLE("DAC1 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL1_MUTE,
59 AD193X_DACR1_MUTE, 1, 1),
60 SOC_DOUBLE("DAC2 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL2_MUTE,
61 AD193X_DACR2_MUTE, 1, 1),
62 SOC_DOUBLE("DAC3 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL3_MUTE,
63 AD193X_DACR3_MUTE, 1, 1),
64 SOC_DOUBLE("DAC4 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL4_MUTE,
65 AD193X_DACR4_MUTE, 1, 1),
68 SOC_ENUM("Playback Deemphasis", ad193x_deemp_enum),
71 static const struct snd_kcontrol_new ad193x_adc_snd_controls[] = {
72 /* ADC switch control */
73 SOC_DOUBLE("ADC1 Switch", AD193X_ADC_CTRL0, AD193X_ADCL1_MUTE,
74 AD193X_ADCR1_MUTE, 1, 1),
75 SOC_DOUBLE("ADC2 Switch", AD193X_ADC_CTRL0, AD193X_ADCL2_MUTE,
76 AD193X_ADCR2_MUTE, 1, 1),
78 /* ADC high-pass filter */
79 SOC_SINGLE("ADC High Pass Filter Switch", AD193X_ADC_CTRL0,
80 AD193X_ADC_HIGHPASS_FILTER, 1, 0),
83 static const struct snd_soc_dapm_widget ad193x_dapm_widgets[] = {
84 SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
85 SND_SOC_DAPM_PGA("DAC Output", AD193X_DAC_CTRL0, 0, 1, NULL, 0),
86 SND_SOC_DAPM_SUPPLY("PLL_PWR", AD193X_PLL_CLK_CTRL0, 0, 1, NULL, 0),
87 SND_SOC_DAPM_SUPPLY("SYSCLK", AD193X_PLL_CLK_CTRL0, 7, 0, NULL, 0),
88 SND_SOC_DAPM_VMID("VMID"),
89 SND_SOC_DAPM_OUTPUT("DAC1OUT"),
90 SND_SOC_DAPM_OUTPUT("DAC2OUT"),
91 SND_SOC_DAPM_OUTPUT("DAC3OUT"),
92 SND_SOC_DAPM_OUTPUT("DAC4OUT"),
95 static const struct snd_soc_dapm_widget ad193x_adc_widgets[] = {
96 SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
97 SND_SOC_DAPM_SUPPLY("ADC_PWR", AD193X_ADC_CTRL0, 0, 1, NULL, 0),
98 SND_SOC_DAPM_INPUT("ADC1IN"),
99 SND_SOC_DAPM_INPUT("ADC2IN"),
102 static int ad193x_check_pll(struct snd_soc_dapm_widget *source,
103 struct snd_soc_dapm_widget *sink)
105 struct snd_soc_component *component = snd_soc_dapm_to_component(source->dapm);
106 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(component);
108 return !!ad193x->sysclk;
111 static const struct snd_soc_dapm_route audio_paths[] = {
112 { "DAC", NULL, "SYSCLK" },
113 { "DAC Output", NULL, "DAC" },
114 { "DAC Output", NULL, "VMID" },
115 { "DAC1OUT", NULL, "DAC Output" },
116 { "DAC2OUT", NULL, "DAC Output" },
117 { "DAC3OUT", NULL, "DAC Output" },
118 { "DAC4OUT", NULL, "DAC Output" },
119 { "SYSCLK", NULL, "PLL_PWR", &ad193x_check_pll },
122 static const struct snd_soc_dapm_route ad193x_adc_audio_paths[] = {
123 { "ADC", NULL, "SYSCLK" },
124 { "ADC", NULL, "ADC_PWR" },
125 { "ADC", NULL, "ADC1IN" },
126 { "ADC", NULL, "ADC2IN" },
129 static inline bool ad193x_has_adc(const struct ad193x_priv *ad193x)
131 switch (ad193x->type) {
146 static int ad193x_mute(struct snd_soc_dai *dai, int mute)
148 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(dai->component);
151 regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL2,
152 AD193X_DAC_MASTER_MUTE,
153 AD193X_DAC_MASTER_MUTE);
155 regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL2,
156 AD193X_DAC_MASTER_MUTE, 0);
161 static int ad193x_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
162 unsigned int rx_mask, int slots, int width)
164 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(dai->component);
165 unsigned int channels;
169 channels = AD193X_2_CHANNELS;
172 channels = AD193X_4_CHANNELS;
175 channels = AD193X_8_CHANNELS;
178 channels = AD193X_16_CHANNELS;
184 regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL1,
185 AD193X_DAC_CHAN_MASK, channels << AD193X_DAC_CHAN_SHFT);
186 if (ad193x_has_adc(ad193x))
187 regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL2,
188 AD193X_ADC_CHAN_MASK,
189 channels << AD193X_ADC_CHAN_SHFT);
194 static int ad193x_set_dai_fmt(struct snd_soc_dai *codec_dai,
197 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(codec_dai->component);
198 unsigned int adc_serfmt = 0;
199 unsigned int dac_serfmt = 0;
200 unsigned int adc_fmt = 0;
201 unsigned int dac_fmt = 0;
203 /* At present, the driver only support AUX ADC mode(SND_SOC_DAIFMT_I2S
204 * with TDM), ADC&DAC TDM mode(SND_SOC_DAIFMT_DSP_A) and DAC I2S mode
205 * (SND_SOC_DAIFMT_I2S)
207 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
208 case SND_SOC_DAIFMT_I2S:
209 adc_serfmt |= AD193X_ADC_SERFMT_TDM;
210 dac_serfmt |= AD193X_DAC_SERFMT_STEREO;
212 case SND_SOC_DAIFMT_DSP_A:
213 adc_serfmt |= AD193X_ADC_SERFMT_AUX;
214 dac_serfmt |= AD193X_DAC_SERFMT_TDM;
217 if (ad193x_has_adc(ad193x))
221 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
222 case SND_SOC_DAIFMT_NB_NF: /* normal bit clock + frame */
224 case SND_SOC_DAIFMT_NB_IF: /* normal bclk + invert frm */
225 adc_fmt |= AD193X_ADC_LEFT_HIGH;
226 dac_fmt |= AD193X_DAC_LEFT_HIGH;
228 case SND_SOC_DAIFMT_IB_NF: /* invert bclk + normal frm */
229 adc_fmt |= AD193X_ADC_BCLK_INV;
230 dac_fmt |= AD193X_DAC_BCLK_INV;
232 case SND_SOC_DAIFMT_IB_IF: /* invert bclk + frm */
233 adc_fmt |= AD193X_ADC_LEFT_HIGH;
234 adc_fmt |= AD193X_ADC_BCLK_INV;
235 dac_fmt |= AD193X_DAC_LEFT_HIGH;
236 dac_fmt |= AD193X_DAC_BCLK_INV;
242 /* For DSP_*, LRCLK's polarity must be inverted */
243 if (fmt & SND_SOC_DAIFMT_DSP_A)
244 dac_fmt ^= AD193X_DAC_LEFT_HIGH;
246 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
247 case SND_SOC_DAIFMT_CBM_CFM: /* codec clk & frm master */
248 adc_fmt |= AD193X_ADC_LCR_MASTER;
249 adc_fmt |= AD193X_ADC_BCLK_MASTER;
250 dac_fmt |= AD193X_DAC_LCR_MASTER;
251 dac_fmt |= AD193X_DAC_BCLK_MASTER;
253 case SND_SOC_DAIFMT_CBS_CFM: /* codec clk slave & frm master */
254 adc_fmt |= AD193X_ADC_LCR_MASTER;
255 dac_fmt |= AD193X_DAC_LCR_MASTER;
257 case SND_SOC_DAIFMT_CBM_CFS: /* codec clk master & frame slave */
258 adc_fmt |= AD193X_ADC_BCLK_MASTER;
259 dac_fmt |= AD193X_DAC_BCLK_MASTER;
261 case SND_SOC_DAIFMT_CBS_CFS: /* codec clk & frm slave */
267 if (ad193x_has_adc(ad193x)) {
268 regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL1,
269 AD193X_ADC_SERFMT_MASK, adc_serfmt);
270 regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL2,
271 AD193X_ADC_FMT_MASK, adc_fmt);
273 regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL0,
274 AD193X_DAC_SERFMT_MASK, dac_serfmt);
275 regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL1,
276 AD193X_DAC_FMT_MASK, dac_fmt);
281 static int ad193x_set_dai_sysclk(struct snd_soc_dai *codec_dai,
282 int clk_id, unsigned int freq, int dir)
284 struct snd_soc_component *component = codec_dai->component;
285 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
286 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(component);
288 if (clk_id == AD193X_SYSCLK_MCLK) {
289 /* MCLK must be 512 x fs */
290 if (dir == SND_SOC_CLOCK_OUT || freq != 24576000)
293 regmap_update_bits(ad193x->regmap, AD193X_PLL_CLK_CTRL1,
295 AD193X_PLL_DAC_SRC_MCLK |
296 AD193X_PLL_CLK_SRC_MCLK);
298 snd_soc_dapm_sync(dapm);
306 ad193x->sysclk = freq;
312 static int ad193x_hw_params(struct snd_pcm_substream *substream,
313 struct snd_pcm_hw_params *params,
314 struct snd_soc_dai *dai)
316 int word_len = 0, master_rate = 0;
317 struct snd_soc_component *component = dai->component;
318 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(component);
321 switch (params_width(params)) {
334 switch (ad193x->sysclk) {
336 master_rate = AD193X_PLL_INPUT_256;
339 master_rate = AD193X_PLL_INPUT_384;
342 master_rate = AD193X_PLL_INPUT_512;
345 master_rate = AD193X_PLL_INPUT_768;
349 regmap_update_bits(ad193x->regmap, AD193X_PLL_CLK_CTRL0,
350 AD193X_PLL_INPUT_MASK, master_rate);
352 regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL2,
353 AD193X_DAC_WORD_LEN_MASK,
354 word_len << AD193X_DAC_WORD_LEN_SHFT);
356 if (ad193x_has_adc(ad193x))
357 regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL1,
358 AD193X_ADC_WORD_LEN_MASK, word_len);
363 static int ad193x_startup(struct snd_pcm_substream *substream,
364 struct snd_soc_dai *dai)
366 return snd_pcm_hw_constraint_list(substream->runtime, 0,
367 SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
371 static const struct snd_soc_dai_ops ad193x_dai_ops = {
372 .startup = ad193x_startup,
373 .hw_params = ad193x_hw_params,
374 .digital_mute = ad193x_mute,
375 .set_tdm_slot = ad193x_set_tdm_slot,
376 .set_sysclk = ad193x_set_dai_sysclk,
377 .set_fmt = ad193x_set_dai_fmt,
380 /* codec DAI instance */
381 static struct snd_soc_dai_driver ad193x_dai = {
382 .name = "ad193x-hifi",
384 .stream_name = "Playback",
387 .rates = SNDRV_PCM_RATE_48000,
388 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
389 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
392 .stream_name = "Capture",
395 .rates = SNDRV_PCM_RATE_48000,
396 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
397 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
399 .ops = &ad193x_dai_ops,
402 /* codec DAI instance for DAC only */
403 static struct snd_soc_dai_driver ad193x_no_adc_dai = {
404 .name = "ad193x-hifi",
406 .stream_name = "Playback",
409 .rates = SNDRV_PCM_RATE_48000,
410 .formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
411 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
413 .ops = &ad193x_dai_ops,
416 struct ad193x_reg_default {
421 /* codec register values to set after reset */
422 static void ad193x_reg_default_init(struct ad193x_priv *ad193x)
424 const struct ad193x_reg_default reg_init[] = {
425 { 0, 0x99 }, /* PLL_CLK_CTRL0: pll input: mclki/xi 12.288Mhz */
426 { 1, 0x04 }, /* PLL_CLK_CTRL1: no on-chip Vref */
427 { 2, 0x40 }, /* DAC_CTRL0: TDM mode */
428 { 3, 0x00 }, /* DAC_CTRL1: reset */
429 { 4, 0x1A }, /* DAC_CTRL2: 48kHz de-emphasis, unmute dac */
430 { 5, 0x00 }, /* DAC_CHNL_MUTE: unmute DAC channels */
431 { 6, 0x00 }, /* DAC_L1_VOL: no attenuation */
432 { 7, 0x00 }, /* DAC_R1_VOL: no attenuation */
433 { 8, 0x00 }, /* DAC_L2_VOL: no attenuation */
434 { 9, 0x00 }, /* DAC_R2_VOL: no attenuation */
435 { 10, 0x00 }, /* DAC_L3_VOL: no attenuation */
436 { 11, 0x00 }, /* DAC_R3_VOL: no attenuation */
437 { 12, 0x00 }, /* DAC_L4_VOL: no attenuation */
438 { 13, 0x00 }, /* DAC_R4_VOL: no attenuation */
440 const struct ad193x_reg_default reg_adc_init[] = {
441 { 14, 0x03 }, /* ADC_CTRL0: high-pass filter enable */
442 { 15, 0x43 }, /* ADC_CTRL1: sata delay=1, adc aux mode */
443 { 16, 0x00 }, /* ADC_CTRL2: reset */
447 for (i = 0; i < ARRAY_SIZE(reg_init); i++)
448 regmap_write(ad193x->regmap, reg_init[i].reg, reg_init[i].val);
450 if (ad193x_has_adc(ad193x)) {
451 for (i = 0; i < ARRAY_SIZE(reg_adc_init); i++) {
452 regmap_write(ad193x->regmap, reg_adc_init[i].reg,
453 reg_adc_init[i].val);
458 static int ad193x_component_probe(struct snd_soc_component *component)
460 struct ad193x_priv *ad193x = snd_soc_component_get_drvdata(component);
461 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
464 /* default setting for ad193x */
465 ad193x_reg_default_init(ad193x);
468 if (ad193x_has_adc(ad193x)) {
469 /* add adc controls */
470 num = ARRAY_SIZE(ad193x_adc_snd_controls);
471 ret = snd_soc_add_component_controls(component,
472 ad193x_adc_snd_controls,
477 /* add adc widgets */
478 num = ARRAY_SIZE(ad193x_adc_widgets);
479 ret = snd_soc_dapm_new_controls(dapm,
486 num = ARRAY_SIZE(ad193x_adc_audio_paths);
487 ret = snd_soc_dapm_add_routes(dapm,
488 ad193x_adc_audio_paths,
497 static const struct snd_soc_component_driver soc_component_dev_ad193x = {
498 .probe = ad193x_component_probe,
499 .controls = ad193x_snd_controls,
500 .num_controls = ARRAY_SIZE(ad193x_snd_controls),
501 .dapm_widgets = ad193x_dapm_widgets,
502 .num_dapm_widgets = ARRAY_SIZE(ad193x_dapm_widgets),
503 .dapm_routes = audio_paths,
504 .num_dapm_routes = ARRAY_SIZE(audio_paths),
506 .use_pmdown_time = 1,
508 .non_legacy_dai_naming = 1,
511 const struct regmap_config ad193x_regmap_config = {
512 .max_register = AD193X_NUM_REGS - 1,
514 EXPORT_SYMBOL_GPL(ad193x_regmap_config);
516 int ad193x_probe(struct device *dev, struct regmap *regmap,
517 enum ad193x_type type)
519 struct ad193x_priv *ad193x;
522 return PTR_ERR(regmap);
524 ad193x = devm_kzalloc(dev, sizeof(*ad193x), GFP_KERNEL);
528 ad193x->regmap = regmap;
531 dev_set_drvdata(dev, ad193x);
533 if (ad193x_has_adc(ad193x))
534 return devm_snd_soc_register_component(dev, &soc_component_dev_ad193x,
536 return devm_snd_soc_register_component(dev, &soc_component_dev_ad193x,
537 &ad193x_no_adc_dai, 1);
539 EXPORT_SYMBOL_GPL(ad193x_probe);
541 MODULE_DESCRIPTION("ASoC ad193x driver");
542 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
543 MODULE_LICENSE("GPL");