2 * rt298.c -- RT298 ALSA SoC audio codec driver
4 * Copyright 2015 Realtek Semiconductor Corp.
5 * Author: Bard Liao <bardliao@realtek.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
12 #include <linux/module.h>
13 #include <linux/moduleparam.h>
14 #include <linux/init.h>
15 #include <linux/delay.h>
17 #include <linux/i2c.h>
18 #include <linux/platform_device.h>
19 #include <linux/spi/spi.h>
20 #include <linux/acpi.h>
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/pcm_params.h>
24 #include <sound/soc.h>
25 #include <sound/soc-dapm.h>
26 #include <sound/initval.h>
27 #include <sound/tlv.h>
28 #include <sound/jack.h>
29 #include <linux/workqueue.h>
30 #include <sound/rt298.h>
31 #include <sound/hda_verbs.h>
36 #define RT298_VENDOR_ID 0x10ec0298
39 struct reg_default *index_cache;
41 struct regmap *regmap;
42 struct snd_soc_codec *codec;
43 struct rt298_platform_data pdata;
44 struct i2c_client *i2c;
45 struct snd_soc_jack *jack;
46 struct delayed_work jack_detect_work;
52 static struct reg_default rt298_index_def[] = {
75 #define INDEX_CACHE_SIZE ARRAY_SIZE(rt298_index_def)
77 static const struct reg_default rt298_reg[] = {
78 { 0x00170500, 0x00000400 },
79 { 0x00220000, 0x00000031 },
80 { 0x00239000, 0x0000007f },
81 { 0x0023a000, 0x0000007f },
82 { 0x00270500, 0x00000400 },
83 { 0x00370500, 0x00000400 },
84 { 0x00870500, 0x00000400 },
85 { 0x00920000, 0x00000031 },
86 { 0x00935000, 0x000000c3 },
87 { 0x00936000, 0x000000c3 },
88 { 0x00970500, 0x00000400 },
89 { 0x00b37000, 0x00000097 },
90 { 0x00b37200, 0x00000097 },
91 { 0x00b37300, 0x00000097 },
92 { 0x00c37000, 0x00000000 },
93 { 0x00c37100, 0x00000080 },
94 { 0x01270500, 0x00000400 },
95 { 0x01370500, 0x00000400 },
96 { 0x01371f00, 0x411111f0 },
97 { 0x01439000, 0x00000080 },
98 { 0x0143a000, 0x00000080 },
99 { 0x01470700, 0x00000000 },
100 { 0x01470500, 0x00000400 },
101 { 0x01470c00, 0x00000000 },
102 { 0x01470100, 0x00000000 },
103 { 0x01837000, 0x00000000 },
104 { 0x01870500, 0x00000400 },
105 { 0x02050000, 0x00000000 },
106 { 0x02139000, 0x00000080 },
107 { 0x0213a000, 0x00000080 },
108 { 0x02170100, 0x00000000 },
109 { 0x02170500, 0x00000400 },
110 { 0x02170700, 0x00000000 },
111 { 0x02270100, 0x00000000 },
112 { 0x02370100, 0x00000000 },
113 { 0x01870700, 0x00000020 },
114 { 0x00830000, 0x000000c3 },
115 { 0x00930000, 0x000000c3 },
116 { 0x01270700, 0x00000000 },
119 static bool rt298_volatile_register(struct device *dev, unsigned int reg)
123 case RT298_GET_PARAM(AC_NODE_ROOT, AC_PAR_VENDOR_ID):
124 case RT298_GET_HP_SENSE:
125 case RT298_GET_MIC1_SENSE:
126 case RT298_PROC_COEF:
127 case VERB_CMD(AC_VERB_GET_EAPD_BTLENABLE, RT298_MIC1, 0):
128 case VERB_CMD(AC_VERB_GET_EAPD_BTLENABLE, RT298_SPK_OUT, 0):
129 case VERB_CMD(AC_VERB_GET_EAPD_BTLENABLE, RT298_HP_OUT, 0):
138 static bool rt298_readable_register(struct device *dev, unsigned int reg)
142 case RT298_GET_PARAM(AC_NODE_ROOT, AC_PAR_VENDOR_ID):
143 case RT298_GET_HP_SENSE:
144 case RT298_GET_MIC1_SENSE:
145 case RT298_SET_AUDIO_POWER:
146 case RT298_SET_HPO_POWER:
147 case RT298_SET_SPK_POWER:
148 case RT298_SET_DMIC1_POWER:
154 case RT298_SET_PIN_HPO:
155 case RT298_SET_PIN_SPK:
156 case RT298_SET_PIN_DMIC1:
158 case RT298_SET_AMP_GAIN_HPO:
159 case RT298_SET_DMIC2_DEFAULT:
160 case RT298_DACL_GAIN:
161 case RT298_DACR_GAIN:
162 case RT298_ADCL_GAIN:
163 case RT298_ADCR_GAIN:
165 case RT298_SPOL_GAIN:
166 case RT298_SPOR_GAIN:
167 case RT298_HPOL_GAIN:
168 case RT298_HPOR_GAIN:
169 case RT298_F_DAC_SWITCH:
170 case RT298_F_RECMIX_SWITCH:
171 case RT298_REC_MIC_SWITCH:
172 case RT298_REC_I2S_SWITCH:
173 case RT298_REC_LINE_SWITCH:
174 case RT298_REC_BEEP_SWITCH:
175 case RT298_DAC_FORMAT:
176 case RT298_ADC_FORMAT:
177 case RT298_COEF_INDEX:
178 case RT298_PROC_COEF:
179 case RT298_SET_AMP_GAIN_ADC_IN1:
180 case RT298_SET_AMP_GAIN_ADC_IN2:
181 case RT298_SET_POWER(RT298_DAC_OUT1):
182 case RT298_SET_POWER(RT298_DAC_OUT2):
183 case RT298_SET_POWER(RT298_ADC_IN1):
184 case RT298_SET_POWER(RT298_ADC_IN2):
185 case RT298_SET_POWER(RT298_DMIC2):
186 case RT298_SET_POWER(RT298_MIC1):
187 case VERB_CMD(AC_VERB_GET_EAPD_BTLENABLE, RT298_MIC1, 0):
188 case VERB_CMD(AC_VERB_GET_EAPD_BTLENABLE, RT298_SPK_OUT, 0):
189 case VERB_CMD(AC_VERB_GET_EAPD_BTLENABLE, RT298_HP_OUT, 0):
197 static void rt298_index_sync(struct snd_soc_codec *codec)
199 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
202 for (i = 0; i < INDEX_CACHE_SIZE; i++) {
203 snd_soc_write(codec, rt298->index_cache[i].reg,
204 rt298->index_cache[i].def);
209 static int rt298_support_power_controls[] = {
220 #define RT298_POWER_REG_LEN ARRAY_SIZE(rt298_support_power_controls)
222 static int rt298_jack_detect(struct rt298_priv *rt298, bool *hp, bool *mic)
224 struct snd_soc_dapm_context *dapm;
225 unsigned int val, buf;
233 dapm = snd_soc_codec_get_dapm(rt298->codec);
235 if (rt298->pdata.cbj_en) {
236 regmap_read(rt298->regmap, RT298_GET_HP_SENSE, &buf);
237 *hp = buf & 0x80000000;
238 if (*hp == rt298->is_hp_in)
240 rt298->is_hp_in = *hp;
242 /* power on HV,VERF */
243 regmap_update_bits(rt298->regmap,
244 RT298_DC_GAIN, 0x200, 0x200);
246 snd_soc_dapm_force_enable_pin(dapm, "HV");
247 snd_soc_dapm_force_enable_pin(dapm, "VREF");
249 snd_soc_dapm_force_enable_pin(dapm, "LDO1");
250 snd_soc_dapm_sync(dapm);
252 regmap_write(rt298->regmap, RT298_SET_MIC1, 0x24);
255 regmap_update_bits(rt298->regmap,
256 RT298_CBJ_CTRL1, 0xfcc0, 0xd400);
258 regmap_read(rt298->regmap, RT298_CBJ_CTRL2, &val);
260 if (0x0070 == (val & 0x0070)) {
263 regmap_update_bits(rt298->regmap,
264 RT298_CBJ_CTRL1, 0xfcc0, 0xe400);
266 regmap_read(rt298->regmap,
267 RT298_CBJ_CTRL2, &val);
268 if (0x0070 == (val & 0x0070))
273 regmap_update_bits(rt298->regmap,
274 RT298_DC_GAIN, 0x200, 0x0);
278 regmap_write(rt298->regmap, RT298_SET_MIC1, 0x20);
281 regmap_read(rt298->regmap, RT298_GET_HP_SENSE, &buf);
282 *hp = buf & 0x80000000;
283 regmap_read(rt298->regmap, RT298_GET_MIC1_SENSE, &buf);
284 *mic = buf & 0x80000000;
287 snd_soc_dapm_disable_pin(dapm, "HV");
288 snd_soc_dapm_disable_pin(dapm, "VREF");
290 snd_soc_dapm_disable_pin(dapm, "LDO1");
291 snd_soc_dapm_sync(dapm);
293 pr_debug("*hp = %d *mic = %d\n", *hp, *mic);
298 static void rt298_jack_detect_work(struct work_struct *work)
300 struct rt298_priv *rt298 =
301 container_of(work, struct rt298_priv, jack_detect_work.work);
306 if (rt298_jack_detect(rt298, &hp, &mic) < 0)
310 status |= SND_JACK_HEADPHONE;
313 status |= SND_JACK_MICROPHONE;
315 snd_soc_jack_report(rt298->jack, status,
316 SND_JACK_MICROPHONE | SND_JACK_HEADPHONE);
319 int rt298_mic_detect(struct snd_soc_codec *codec, struct snd_soc_jack *jack)
321 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
325 /* Send an initial empty report */
326 snd_soc_jack_report(rt298->jack, 0,
327 SND_JACK_MICROPHONE | SND_JACK_HEADPHONE);
331 EXPORT_SYMBOL_GPL(rt298_mic_detect);
333 static int is_mclk_mode(struct snd_soc_dapm_widget *source,
334 struct snd_soc_dapm_widget *sink)
336 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(source->dapm);
337 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
339 if (rt298->clk_id == RT298_SCLK_S_MCLK)
345 static const DECLARE_TLV_DB_SCALE(out_vol_tlv, -6350, 50, 0);
346 static const DECLARE_TLV_DB_SCALE(mic_vol_tlv, 0, 1000, 0);
348 static const struct snd_kcontrol_new rt298_snd_controls[] = {
349 SOC_DOUBLE_R_TLV("DAC0 Playback Volume", RT298_DACL_GAIN,
350 RT298_DACR_GAIN, 0, 0x7f, 0, out_vol_tlv),
351 SOC_DOUBLE_R_TLV("ADC0 Capture Volume", RT298_ADCL_GAIN,
352 RT298_ADCR_GAIN, 0, 0x7f, 0, out_vol_tlv),
353 SOC_SINGLE_TLV("AMIC Volume", RT298_MIC_GAIN,
354 0, 0x3, 0, mic_vol_tlv),
355 SOC_DOUBLE_R("Speaker Playback Switch", RT298_SPOL_GAIN,
356 RT298_SPOR_GAIN, RT298_MUTE_SFT, 1, 1),
360 static const struct snd_kcontrol_new rt298_front_mix[] = {
361 SOC_DAPM_SINGLE("DAC Switch", RT298_F_DAC_SWITCH,
362 RT298_MUTE_SFT, 1, 1),
363 SOC_DAPM_SINGLE("RECMIX Switch", RT298_F_RECMIX_SWITCH,
364 RT298_MUTE_SFT, 1, 1),
367 /* Analog Input Mixer */
368 static const struct snd_kcontrol_new rt298_rec_mix[] = {
369 SOC_DAPM_SINGLE("Mic1 Switch", RT298_REC_MIC_SWITCH,
370 RT298_MUTE_SFT, 1, 1),
371 SOC_DAPM_SINGLE("I2S Switch", RT298_REC_I2S_SWITCH,
372 RT298_MUTE_SFT, 1, 1),
373 SOC_DAPM_SINGLE("Line1 Switch", RT298_REC_LINE_SWITCH,
374 RT298_MUTE_SFT, 1, 1),
375 SOC_DAPM_SINGLE("Beep Switch", RT298_REC_BEEP_SWITCH,
376 RT298_MUTE_SFT, 1, 1),
379 static const struct snd_kcontrol_new spo_enable_control =
380 SOC_DAPM_SINGLE("Switch", RT298_SET_PIN_SPK,
381 RT298_SET_PIN_SFT, 1, 0);
383 static const struct snd_kcontrol_new hpol_enable_control =
384 SOC_DAPM_SINGLE_AUTODISABLE("Switch", RT298_HPOL_GAIN,
385 RT298_MUTE_SFT, 1, 1);
387 static const struct snd_kcontrol_new hpor_enable_control =
388 SOC_DAPM_SINGLE_AUTODISABLE("Switch", RT298_HPOR_GAIN,
389 RT298_MUTE_SFT, 1, 1);
392 static const char * const rt298_adc_src[] = {
393 "Mic", "RECMIX", "Dmic"
396 static const int rt298_adc_values[] = {
400 static SOC_VALUE_ENUM_SINGLE_DECL(
401 rt298_adc0_enum, RT298_ADC0_MUX, RT298_ADC_SEL_SFT,
402 RT298_ADC_SEL_MASK, rt298_adc_src, rt298_adc_values);
404 static const struct snd_kcontrol_new rt298_adc0_mux =
405 SOC_DAPM_ENUM("ADC 0 source", rt298_adc0_enum);
407 static SOC_VALUE_ENUM_SINGLE_DECL(
408 rt298_adc1_enum, RT298_ADC1_MUX, RT298_ADC_SEL_SFT,
409 RT298_ADC_SEL_MASK, rt298_adc_src, rt298_adc_values);
411 static const struct snd_kcontrol_new rt298_adc1_mux =
412 SOC_DAPM_ENUM("ADC 1 source", rt298_adc1_enum);
414 static const char * const rt298_dac_src[] = {
418 static SOC_ENUM_SINGLE_DECL(rt298_hpo_enum, RT298_HPO_MUX,
421 static const struct snd_kcontrol_new rt298_hpo_mux =
422 SOC_DAPM_ENUM("HPO source", rt298_hpo_enum);
425 static SOC_ENUM_SINGLE_DECL(rt298_spo_enum, RT298_SPK_MUX,
428 static const struct snd_kcontrol_new rt298_spo_mux =
429 SOC_DAPM_ENUM("SPO source", rt298_spo_enum);
431 static int rt298_spk_event(struct snd_soc_dapm_widget *w,
432 struct snd_kcontrol *kcontrol, int event)
434 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
437 case SND_SOC_DAPM_POST_PMU:
439 RT298_SPK_EAPD, RT298_SET_EAPD_HIGH);
441 case SND_SOC_DAPM_PRE_PMD:
443 RT298_SPK_EAPD, RT298_SET_EAPD_LOW);
453 static int rt298_set_dmic1_event(struct snd_soc_dapm_widget *w,
454 struct snd_kcontrol *kcontrol, int event)
456 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
459 case SND_SOC_DAPM_POST_PMU:
460 snd_soc_write(codec, RT298_SET_PIN_DMIC1, 0x20);
462 case SND_SOC_DAPM_PRE_PMD:
463 snd_soc_write(codec, RT298_SET_PIN_DMIC1, 0);
472 static int rt298_adc_event(struct snd_soc_dapm_widget *w,
473 struct snd_kcontrol *kcontrol, int event)
475 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
478 nid = (w->reg >> 20) & 0xff;
481 case SND_SOC_DAPM_POST_PMU:
482 snd_soc_update_bits(codec,
483 VERB_CMD(AC_VERB_SET_AMP_GAIN_MUTE, nid, 0),
486 case SND_SOC_DAPM_PRE_PMD:
487 snd_soc_update_bits(codec,
488 VERB_CMD(AC_VERB_SET_AMP_GAIN_MUTE, nid, 0),
498 static int rt298_mic1_event(struct snd_soc_dapm_widget *w,
499 struct snd_kcontrol *kcontrol, int event)
501 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
504 case SND_SOC_DAPM_PRE_PMU:
505 snd_soc_update_bits(codec,
506 RT298_A_BIAS_CTRL3, 0xc000, 0x8000);
507 snd_soc_update_bits(codec,
508 RT298_A_BIAS_CTRL2, 0xc000, 0x8000);
510 case SND_SOC_DAPM_POST_PMD:
511 snd_soc_update_bits(codec,
512 RT298_A_BIAS_CTRL3, 0xc000, 0x0000);
513 snd_soc_update_bits(codec,
514 RT298_A_BIAS_CTRL2, 0xc000, 0x0000);
523 static int rt298_vref_event(struct snd_soc_dapm_widget *w,
524 struct snd_kcontrol *kcontrol, int event)
526 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
529 case SND_SOC_DAPM_PRE_PMU:
530 snd_soc_update_bits(codec,
531 RT298_CBJ_CTRL1, 0x0400, 0x0000);
541 static const struct snd_soc_dapm_widget rt298_dapm_widgets[] = {
543 SND_SOC_DAPM_SUPPLY_S("HV", 1, RT298_POWER_CTRL1,
545 SND_SOC_DAPM_SUPPLY("VREF", RT298_POWER_CTRL1,
546 0, 1, rt298_vref_event, SND_SOC_DAPM_PRE_PMU),
547 SND_SOC_DAPM_SUPPLY_S("BG_MBIAS", 1, RT298_POWER_CTRL2,
549 SND_SOC_DAPM_SUPPLY_S("LDO1", 1, RT298_POWER_CTRL2,
551 SND_SOC_DAPM_SUPPLY_S("LDO2", 1, RT298_POWER_CTRL2,
553 SND_SOC_DAPM_SUPPLY_S("VREF1", 1, RT298_POWER_CTRL2,
555 SND_SOC_DAPM_SUPPLY_S("LV", 2, RT298_POWER_CTRL1,
559 SND_SOC_DAPM_SUPPLY("MCLK MODE", RT298_PLL_CTRL1,
561 SND_SOC_DAPM_SUPPLY("MIC1 Input Buffer", SND_SOC_NOPM,
562 0, 0, rt298_mic1_event, SND_SOC_DAPM_PRE_PMU |
563 SND_SOC_DAPM_POST_PMD),
566 SND_SOC_DAPM_INPUT("DMIC1 Pin"),
567 SND_SOC_DAPM_INPUT("DMIC2 Pin"),
568 SND_SOC_DAPM_INPUT("MIC1"),
569 SND_SOC_DAPM_INPUT("LINE1"),
570 SND_SOC_DAPM_INPUT("Beep"),
573 SND_SOC_DAPM_PGA_E("DMIC1", RT298_SET_POWER(RT298_DMIC1), 0, 1,
574 NULL, 0, rt298_set_dmic1_event,
575 SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
576 SND_SOC_DAPM_PGA("DMIC2", RT298_SET_POWER(RT298_DMIC2), 0, 1,
578 SND_SOC_DAPM_SUPPLY("DMIC Receiver", SND_SOC_NOPM,
582 SND_SOC_DAPM_MIXER("RECMIX", SND_SOC_NOPM, 0, 0,
583 rt298_rec_mix, ARRAY_SIZE(rt298_rec_mix)),
586 SND_SOC_DAPM_ADC("ADC 0", NULL, SND_SOC_NOPM, 0, 0),
587 SND_SOC_DAPM_ADC("ADC 1", NULL, SND_SOC_NOPM, 0, 0),
590 SND_SOC_DAPM_MUX_E("ADC 0 Mux", RT298_SET_POWER(RT298_ADC_IN1), 0, 1,
591 &rt298_adc0_mux, rt298_adc_event, SND_SOC_DAPM_PRE_PMD |
592 SND_SOC_DAPM_POST_PMU),
593 SND_SOC_DAPM_MUX_E("ADC 1 Mux", RT298_SET_POWER(RT298_ADC_IN2), 0, 1,
594 &rt298_adc1_mux, rt298_adc_event, SND_SOC_DAPM_PRE_PMD |
595 SND_SOC_DAPM_POST_PMU),
597 /* Audio Interface */
598 SND_SOC_DAPM_AIF_IN("AIF1RX", "AIF1 Playback", 0, SND_SOC_NOPM, 0, 0),
599 SND_SOC_DAPM_AIF_OUT("AIF1TX", "AIF1 Capture", 0, SND_SOC_NOPM, 0, 0),
600 SND_SOC_DAPM_AIF_IN("AIF2RX", "AIF2 Playback", 0, SND_SOC_NOPM, 0, 0),
601 SND_SOC_DAPM_AIF_OUT("AIF2TX", "AIF2 Capture", 0, SND_SOC_NOPM, 0, 0),
605 SND_SOC_DAPM_DAC("DAC 0", NULL, SND_SOC_NOPM, 0, 0),
606 SND_SOC_DAPM_DAC("DAC 1", NULL, SND_SOC_NOPM, 0, 0),
609 SND_SOC_DAPM_MUX("SPK Mux", SND_SOC_NOPM, 0, 0, &rt298_spo_mux),
610 SND_SOC_DAPM_MUX("HPO Mux", SND_SOC_NOPM, 0, 0, &rt298_hpo_mux),
612 SND_SOC_DAPM_SUPPLY("HP Power", RT298_SET_PIN_HPO,
613 RT298_SET_PIN_SFT, 0, NULL, 0),
616 SND_SOC_DAPM_MIXER("Front", RT298_SET_POWER(RT298_DAC_OUT1), 0, 1,
617 rt298_front_mix, ARRAY_SIZE(rt298_front_mix)),
618 SND_SOC_DAPM_PGA("Surround", RT298_SET_POWER(RT298_DAC_OUT2), 0, 1,
622 SND_SOC_DAPM_SWITCH_E("SPO", SND_SOC_NOPM, 0, 0,
623 &spo_enable_control, rt298_spk_event,
624 SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
625 SND_SOC_DAPM_SWITCH("HPO L", SND_SOC_NOPM, 0, 0,
626 &hpol_enable_control),
627 SND_SOC_DAPM_SWITCH("HPO R", SND_SOC_NOPM, 0, 0,
628 &hpor_enable_control),
631 SND_SOC_DAPM_OUTPUT("SPOL"),
632 SND_SOC_DAPM_OUTPUT("SPOR"),
633 SND_SOC_DAPM_OUTPUT("HPO Pin"),
634 SND_SOC_DAPM_OUTPUT("SPDIF"),
637 static const struct snd_soc_dapm_route rt298_dapm_routes[] = {
639 {"ADC 0", NULL, "MCLK MODE", is_mclk_mode},
640 {"ADC 1", NULL, "MCLK MODE", is_mclk_mode},
641 {"Front", NULL, "MCLK MODE", is_mclk_mode},
642 {"Surround", NULL, "MCLK MODE", is_mclk_mode},
644 {"HP Power", NULL, "LDO1"},
645 {"HP Power", NULL, "LDO2"},
646 {"HP Power", NULL, "LV"},
647 {"HP Power", NULL, "VREF1"},
648 {"HP Power", NULL, "BG_MBIAS"},
650 {"MIC1", NULL, "LDO1"},
651 {"MIC1", NULL, "LDO2"},
652 {"MIC1", NULL, "HV"},
653 {"MIC1", NULL, "LV"},
654 {"MIC1", NULL, "VREF"},
655 {"MIC1", NULL, "VREF1"},
656 {"MIC1", NULL, "BG_MBIAS"},
657 {"MIC1", NULL, "MIC1 Input Buffer"},
659 {"SPO", NULL, "LDO1"},
660 {"SPO", NULL, "LDO2"},
663 {"SPO", NULL, "VREF"},
664 {"SPO", NULL, "VREF1"},
665 {"SPO", NULL, "BG_MBIAS"},
667 {"DMIC1", NULL, "DMIC1 Pin"},
668 {"DMIC2", NULL, "DMIC2 Pin"},
669 {"DMIC1", NULL, "DMIC Receiver"},
670 {"DMIC2", NULL, "DMIC Receiver"},
672 {"RECMIX", "Beep Switch", "Beep"},
673 {"RECMIX", "Line1 Switch", "LINE1"},
674 {"RECMIX", "Mic1 Switch", "MIC1"},
676 {"ADC 0 Mux", "Dmic", "DMIC1"},
677 {"ADC 0 Mux", "RECMIX", "RECMIX"},
678 {"ADC 0 Mux", "Mic", "MIC1"},
679 {"ADC 1 Mux", "Dmic", "DMIC2"},
680 {"ADC 1 Mux", "RECMIX", "RECMIX"},
681 {"ADC 1 Mux", "Mic", "MIC1"},
683 {"ADC 0", NULL, "ADC 0 Mux"},
684 {"ADC 1", NULL, "ADC 1 Mux"},
686 {"AIF1TX", NULL, "ADC 0"},
687 {"AIF2TX", NULL, "ADC 1"},
689 {"DAC 0", NULL, "AIF1RX"},
690 {"DAC 1", NULL, "AIF2RX"},
692 {"Front", "DAC Switch", "DAC 0"},
693 {"Front", "RECMIX Switch", "RECMIX"},
695 {"Surround", NULL, "DAC 1"},
697 {"SPK Mux", "Front", "Front"},
698 {"SPK Mux", "Surround", "Surround"},
700 {"HPO Mux", "Front", "Front"},
701 {"HPO Mux", "Surround", "Surround"},
703 {"SPO", "Switch", "SPK Mux"},
704 {"HPO L", "Switch", "HPO Mux"},
705 {"HPO R", "Switch", "HPO Mux"},
706 {"HPO L", NULL, "HP Power"},
707 {"HPO R", NULL, "HP Power"},
709 {"SPOL", NULL, "SPO"},
710 {"SPOR", NULL, "SPO"},
711 {"HPO Pin", NULL, "HPO L"},
712 {"HPO Pin", NULL, "HPO R"},
715 static int rt298_hw_params(struct snd_pcm_substream *substream,
716 struct snd_pcm_hw_params *params,
717 struct snd_soc_dai *dai)
719 struct snd_soc_codec *codec = dai->codec;
720 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
721 unsigned int val = 0;
724 switch (params_rate(params)) {
725 /* bit 14 0:48K 1:44.1K */
730 dev_err(codec->dev, "Unsupported sample rate %d\n",
731 params_rate(params));
734 switch (rt298->sys_clk) {
737 if (params_rate(params) != 48000) {
738 dev_err(codec->dev, "Sys_clk is not matched (%d %d)\n",
739 params_rate(params), rt298->sys_clk);
745 if (params_rate(params) != 44100) {
746 dev_err(codec->dev, "Sys_clk is not matched (%d %d)\n",
747 params_rate(params), rt298->sys_clk);
753 if (params_channels(params) <= 16) {
754 /* bit 3:0 Number of Channel */
755 val |= (params_channels(params) - 1);
757 dev_err(codec->dev, "Unsupported channels %d\n",
758 params_channels(params));
763 switch (params_width(params)) {
764 /* bit 6:4 Bits per Sample */
788 snd_soc_update_bits(codec,
789 RT298_I2S_CTRL1, 0x0018, d_len_code << 3);
790 dev_dbg(codec->dev, "format val = 0x%x\n", val);
792 snd_soc_update_bits(codec, RT298_DAC_FORMAT, 0x407f, val);
793 snd_soc_update_bits(codec, RT298_ADC_FORMAT, 0x407f, val);
798 static int rt298_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt)
800 struct snd_soc_codec *codec = dai->codec;
802 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
803 case SND_SOC_DAIFMT_CBM_CFM:
804 snd_soc_update_bits(codec,
805 RT298_I2S_CTRL1, 0x800, 0x800);
807 case SND_SOC_DAIFMT_CBS_CFS:
808 snd_soc_update_bits(codec,
809 RT298_I2S_CTRL1, 0x800, 0x0);
815 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
816 case SND_SOC_DAIFMT_I2S:
817 snd_soc_update_bits(codec,
818 RT298_I2S_CTRL1, 0x300, 0x0);
820 case SND_SOC_DAIFMT_LEFT_J:
821 snd_soc_update_bits(codec,
822 RT298_I2S_CTRL1, 0x300, 0x1 << 8);
824 case SND_SOC_DAIFMT_DSP_A:
825 snd_soc_update_bits(codec,
826 RT298_I2S_CTRL1, 0x300, 0x2 << 8);
828 case SND_SOC_DAIFMT_DSP_B:
829 snd_soc_update_bits(codec,
830 RT298_I2S_CTRL1, 0x300, 0x3 << 8);
835 /* bit 15 Stream Type 0:PCM 1:Non-PCM */
836 snd_soc_update_bits(codec, RT298_DAC_FORMAT, 0x8000, 0);
837 snd_soc_update_bits(codec, RT298_ADC_FORMAT, 0x8000, 0);
842 static int rt298_set_dai_sysclk(struct snd_soc_dai *dai,
843 int clk_id, unsigned int freq, int dir)
845 struct snd_soc_codec *codec = dai->codec;
846 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
848 dev_dbg(codec->dev, "%s freq=%d\n", __func__, freq);
850 if (RT298_SCLK_S_MCLK == clk_id) {
851 snd_soc_update_bits(codec,
852 RT298_I2S_CTRL2, 0x0100, 0x0);
853 snd_soc_update_bits(codec,
854 RT298_PLL_CTRL1, 0x20, 0x20);
856 snd_soc_update_bits(codec,
857 RT298_I2S_CTRL2, 0x0100, 0x0100);
858 snd_soc_update_bits(codec,
859 RT298_PLL_CTRL, 0x4, 0x4);
860 snd_soc_update_bits(codec,
861 RT298_PLL_CTRL1, 0x20, 0x0);
866 if (RT298_SCLK_S_MCLK == clk_id) {
867 dev_err(codec->dev, "Should not use MCLK\n");
870 snd_soc_update_bits(codec,
871 RT298_I2S_CTRL2, 0x40, 0x40);
874 if (RT298_SCLK_S_MCLK == clk_id) {
875 dev_err(codec->dev, "Should not use MCLK\n");
878 snd_soc_update_bits(codec,
879 RT298_I2S_CTRL2, 0x40, 0x0);
883 snd_soc_update_bits(codec,
884 RT298_I2S_CTRL2, 0x8, 0x0);
885 snd_soc_update_bits(codec,
886 RT298_CLK_DIV, 0xfc1e, 0x0004);
890 snd_soc_update_bits(codec,
891 RT298_I2S_CTRL2, 0x8, 0x8);
892 snd_soc_update_bits(codec,
893 RT298_CLK_DIV, 0xfc1e, 0x5406);
896 dev_err(codec->dev, "Unsupported system clock\n");
900 rt298->sys_clk = freq;
901 rt298->clk_id = clk_id;
906 static int rt298_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio)
908 struct snd_soc_codec *codec = dai->codec;
910 dev_dbg(codec->dev, "%s ratio=%d\n", __func__, ratio);
912 snd_soc_update_bits(codec,
913 RT298_I2S_CTRL1, 0x1000, 0x1000);
915 snd_soc_update_bits(codec,
916 RT298_I2S_CTRL1, 0x1000, 0x0);
922 static int rt298_set_bias_level(struct snd_soc_codec *codec,
923 enum snd_soc_bias_level level)
926 case SND_SOC_BIAS_PREPARE:
927 if (SND_SOC_BIAS_STANDBY ==
928 snd_soc_codec_get_bias_level(codec)) {
930 RT298_SET_AUDIO_POWER, AC_PWRST_D0);
931 snd_soc_update_bits(codec, 0x0d, 0x200, 0x200);
932 snd_soc_update_bits(codec, 0x52, 0x80, 0x0);
934 snd_soc_update_bits(codec, 0x0d, 0x200, 0x0);
935 snd_soc_update_bits(codec, 0x52, 0x80, 0x80);
939 case SND_SOC_BIAS_ON:
941 snd_soc_update_bits(codec,
942 RT298_CBJ_CTRL1, 0x0400, 0x0400);
946 case SND_SOC_BIAS_STANDBY:
948 RT298_SET_AUDIO_POWER, AC_PWRST_D3);
949 snd_soc_update_bits(codec,
950 RT298_CBJ_CTRL1, 0x0400, 0x0000);
960 static irqreturn_t rt298_irq(int irq, void *data)
962 struct rt298_priv *rt298 = data;
967 ret = rt298_jack_detect(rt298, &hp, &mic);
970 regmap_update_bits(rt298->regmap, RT298_IRQ_CTRL, 0x1, 0x1);
974 status |= SND_JACK_HEADPHONE;
977 status |= SND_JACK_MICROPHONE;
979 snd_soc_jack_report(rt298->jack, status,
980 SND_JACK_MICROPHONE | SND_JACK_HEADPHONE);
982 pm_wakeup_event(&rt298->i2c->dev, 300);
988 static int rt298_probe(struct snd_soc_codec *codec)
990 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
992 rt298->codec = codec;
994 if (rt298->i2c->irq) {
995 regmap_update_bits(rt298->regmap,
996 RT298_IRQ_CTRL, 0x2, 0x2);
998 INIT_DELAYED_WORK(&rt298->jack_detect_work,
999 rt298_jack_detect_work);
1000 schedule_delayed_work(&rt298->jack_detect_work,
1001 msecs_to_jiffies(1250));
1007 static int rt298_remove(struct snd_soc_codec *codec)
1009 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
1011 cancel_delayed_work_sync(&rt298->jack_detect_work);
1017 static int rt298_suspend(struct snd_soc_codec *codec)
1019 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
1021 rt298->is_hp_in = -1;
1022 regcache_cache_only(rt298->regmap, true);
1023 regcache_mark_dirty(rt298->regmap);
1028 static int rt298_resume(struct snd_soc_codec *codec)
1030 struct rt298_priv *rt298 = snd_soc_codec_get_drvdata(codec);
1032 regcache_cache_only(rt298->regmap, false);
1033 rt298_index_sync(codec);
1034 regcache_sync(rt298->regmap);
1039 #define rt298_suspend NULL
1040 #define rt298_resume NULL
1043 #define RT298_STEREO_RATES (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000)
1044 #define RT298_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
1045 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S8)
1047 static const struct snd_soc_dai_ops rt298_aif_dai_ops = {
1048 .hw_params = rt298_hw_params,
1049 .set_fmt = rt298_set_dai_fmt,
1050 .set_sysclk = rt298_set_dai_sysclk,
1051 .set_bclk_ratio = rt298_set_bclk_ratio,
1054 static struct snd_soc_dai_driver rt298_dai[] = {
1056 .name = "rt298-aif1",
1059 .stream_name = "AIF1 Playback",
1062 .rates = RT298_STEREO_RATES,
1063 .formats = RT298_FORMATS,
1066 .stream_name = "AIF1 Capture",
1069 .rates = RT298_STEREO_RATES,
1070 .formats = RT298_FORMATS,
1072 .ops = &rt298_aif_dai_ops,
1073 .symmetric_rates = 1,
1076 .name = "rt298-aif2",
1079 .stream_name = "AIF2 Playback",
1082 .rates = RT298_STEREO_RATES,
1083 .formats = RT298_FORMATS,
1086 .stream_name = "AIF2 Capture",
1089 .rates = RT298_STEREO_RATES,
1090 .formats = RT298_FORMATS,
1092 .ops = &rt298_aif_dai_ops,
1093 .symmetric_rates = 1,
1098 static struct snd_soc_codec_driver soc_codec_dev_rt298 = {
1099 .probe = rt298_probe,
1100 .remove = rt298_remove,
1101 .suspend = rt298_suspend,
1102 .resume = rt298_resume,
1103 .set_bias_level = rt298_set_bias_level,
1104 .idle_bias_off = true,
1105 .controls = rt298_snd_controls,
1106 .num_controls = ARRAY_SIZE(rt298_snd_controls),
1107 .dapm_widgets = rt298_dapm_widgets,
1108 .num_dapm_widgets = ARRAY_SIZE(rt298_dapm_widgets),
1109 .dapm_routes = rt298_dapm_routes,
1110 .num_dapm_routes = ARRAY_SIZE(rt298_dapm_routes),
1113 static const struct regmap_config rt298_regmap = {
1116 .max_register = 0x02370100,
1117 .volatile_reg = rt298_volatile_register,
1118 .readable_reg = rt298_readable_register,
1119 .reg_write = rl6347a_hw_write,
1120 .reg_read = rl6347a_hw_read,
1121 .cache_type = REGCACHE_RBTREE,
1122 .reg_defaults = rt298_reg,
1123 .num_reg_defaults = ARRAY_SIZE(rt298_reg),
1126 static const struct i2c_device_id rt298_i2c_id[] = {
1130 MODULE_DEVICE_TABLE(i2c, rt298_i2c_id);
1132 static const struct acpi_device_id rt298_acpi_match[] = {
1136 MODULE_DEVICE_TABLE(acpi, rt298_acpi_match);
1138 static int rt298_i2c_probe(struct i2c_client *i2c,
1139 const struct i2c_device_id *id)
1141 struct rt298_platform_data *pdata = dev_get_platdata(&i2c->dev);
1142 struct rt298_priv *rt298;
1143 struct device *dev = &i2c->dev;
1144 const struct acpi_device_id *acpiid;
1147 rt298 = devm_kzalloc(&i2c->dev, sizeof(*rt298),
1152 rt298->regmap = devm_regmap_init(&i2c->dev, NULL, i2c, &rt298_regmap);
1153 if (IS_ERR(rt298->regmap)) {
1154 ret = PTR_ERR(rt298->regmap);
1155 dev_err(&i2c->dev, "Failed to allocate register map: %d\n",
1160 regmap_read(rt298->regmap,
1161 RT298_GET_PARAM(AC_NODE_ROOT, AC_PAR_VENDOR_ID), &ret);
1162 if (ret != RT298_VENDOR_ID) {
1164 "Device with ID register %#x is not rt298\n", ret);
1168 rt298->index_cache = rt298_index_def;
1169 rt298->index_cache_size = INDEX_CACHE_SIZE;
1171 i2c_set_clientdata(i2c, rt298);
1173 /* restore codec default */
1174 for (i = 0; i < INDEX_CACHE_SIZE; i++)
1175 regmap_write(rt298->regmap, rt298->index_cache[i].reg,
1176 rt298->index_cache[i].def);
1177 for (i = 0; i < ARRAY_SIZE(rt298_reg); i++)
1178 regmap_write(rt298->regmap, rt298_reg[i].reg,
1182 rt298->pdata = *pdata;
1184 /* enable jack combo mode on supported devices */
1185 acpiid = acpi_match_device(dev->driver->acpi_match_table, dev);
1187 rt298->pdata = *(struct rt298_platform_data *)
1188 acpiid->driver_data;
1192 regmap_update_bits(rt298->regmap, 0x04, 0x80, 0x80);
1193 regmap_update_bits(rt298->regmap, 0x1b, 0x860, 0x860);
1195 regmap_update_bits(rt298->regmap, 0x08, 0x20, 0x20);
1197 regmap_write(rt298->regmap, RT298_SET_AUDIO_POWER, AC_PWRST_D3);
1199 for (i = 0; i < RT298_POWER_REG_LEN; i++)
1200 regmap_write(rt298->regmap,
1201 RT298_SET_POWER(rt298_support_power_controls[i]),
1204 if (!rt298->pdata.cbj_en) {
1205 regmap_write(rt298->regmap, RT298_CBJ_CTRL2, 0x0000);
1206 regmap_write(rt298->regmap, RT298_MIC1_DET_CTRL, 0x0816);
1207 regmap_update_bits(rt298->regmap,
1208 RT298_CBJ_CTRL1, 0xf000, 0xb000);
1210 regmap_update_bits(rt298->regmap,
1211 RT298_CBJ_CTRL1, 0xf000, 0x5000);
1216 if (!rt298->pdata.gpio2_en)
1217 regmap_write(rt298->regmap, RT298_SET_DMIC2_DEFAULT, 0x4000);
1219 regmap_write(rt298->regmap, RT298_SET_DMIC2_DEFAULT, 0);
1223 regmap_write(rt298->regmap, RT298_MISC_CTRL1, 0x0000);
1224 regmap_update_bits(rt298->regmap,
1225 RT298_WIND_FILTER_CTRL, 0x0082, 0x0082);
1226 regmap_update_bits(rt298->regmap, RT298_IRQ_CTRL, 0x2, 0x2);
1227 rt298->is_hp_in = -1;
1229 if (rt298->i2c->irq) {
1230 ret = request_threaded_irq(rt298->i2c->irq, NULL, rt298_irq,
1231 IRQF_TRIGGER_HIGH | IRQF_ONESHOT, "rt298", rt298);
1234 "Failed to reguest IRQ: %d\n", ret);
1239 ret = snd_soc_register_codec(&i2c->dev, &soc_codec_dev_rt298,
1240 rt298_dai, ARRAY_SIZE(rt298_dai));
1245 static int rt298_i2c_remove(struct i2c_client *i2c)
1247 struct rt298_priv *rt298 = i2c_get_clientdata(i2c);
1250 free_irq(i2c->irq, rt298);
1251 snd_soc_unregister_codec(&i2c->dev);
1257 static struct i2c_driver rt298_i2c_driver = {
1260 .acpi_match_table = ACPI_PTR(rt298_acpi_match),
1262 .probe = rt298_i2c_probe,
1263 .remove = rt298_i2c_remove,
1264 .id_table = rt298_i2c_id,
1267 module_i2c_driver(rt298_i2c_driver);
1269 MODULE_DESCRIPTION("ASoC RT298 driver");
1270 MODULE_AUTHOR("Bard Liao <bardliao@realtek.com>");
1271 MODULE_LICENSE("GPL");